feat: enable domain-specific activity

codebytere · codebytere · commit 6d29b24ab964 · 2020-06-10T10:10:29.000-07:00
diff --git a/README.md b/README.md
@@ -11,7 +11,9 @@ This native Node.js module provides an interface to the user&rsquo;s defaults databa
 
 ## API
 
-### `defaults.getAllDefaults()`
+### `defaults.getAllDefaults([domain])`
+
+* `domain` String (optional) - The domain identifier for an `NSUserDefaults` suite.
 
 Returns `Record<string, any>` - An object containing all currently set defaults and their values for the current user.
 
@@ -55,11 +57,12 @@ console.log(allDefaults)
 */
 ``` 
 
-### `defaults.getUserDefault(type, key)`
+### `defaults.getUserDefault(type, key[, domain])`
 
 * `key` String - The `NSUserDefault` to fetch, e.g `AppleInterfaceStyle`.
 * `type` String - Can be one of `string`, `boolean`, `integer`, `float`, `double`,
   `url`, `array` or `dictionary`.
+* `domain` String (optional) - The domain identifier for an `NSUserDefaults` suite.
 
 Returns `any` - The value of `key` in `NSUserDefaults` of type `type`.
 
@@ -72,11 +75,12 @@ const interfaceStyle = getUserDefault('AppleInterfaceStyle', 'string')
 console.log(interfaceStyle) // 'Dark'
 ``` 
 
-### `defaults.setUserDefault(type, key, value)`
+### `defaults.setUserDefault(type, key, value[, domain])`
 
 * `type` String - Can be `string`, `boolean`, `integer`, `float`, `double`, `url`, `array` or `dictionary`.
 * `key` String - The `NSUserDefault` to update, e.g `AppleInterfaceStyle`.
 * `value` any - The new value to set for `key`; must match type of `type`.
+* `domain` String (optional) - The domain identifier for an `NSUserDefaults` suite.
 
 Sets the value of `key` in `NSUserDefaults`.
 
@@ -87,9 +91,10 @@ const { setUserDefault } = require('node-mac-userdefaults')
 setUserDefault('boolean', 'ApplePressAndHoldEnabled', true)
 ```
 
-### `defaults.removeUserDefault(key)`
+### `defaults.removeUserDefault(key[, domain])`
 
 * `key` String - The `NSUserDefault` to remove, e.g `AppleInterfaceStyle`.
+* `domain` String (optional) - The domain identifier for an `NSUserDefaults` suite.
 
 Removes the `key` in `NSUserDefaults`.
 
@@ -102,9 +107,10 @@ const { removeUserDefault } = require('node-mac-userdefaults')
 removeUserDefault('ApplePressAndHoldEnabled')
 ```
 
-###  `defaults.isKeyManaged(key)`
+###  `defaults.isKeyManaged(key[, domain])`
 
 * `key` String - The `NSUserDefault` to check, e.g `AppleInterfaceStyle`.
+* `domain` String (optional) - The domain identifier for an `NSUserDefaults` suite.
 
 Returns a Boolean value indicating whether the specified key is managed by an administrator.
 
diff --git a/index.js b/index.js
@@ -11,49 +11,75 @@ const VALID_TYPES = [
   'dictionary',
 ]
 
-function getUserDefault(type, key) {
-  if (arguments.length !== 2) {
-    throw new Error('Arguments must be (type, key)')
-  } else if (!VALID_TYPES.includes(type)) {
+function getAllDefaults(domain) {
+  if (domain && typeof domain !== 'string') {
+    throw new TypeError('domain must be a valid string')
+  }
+
+  return defaults.getAllDefaults.call(this, domain)
+}
+
+function getUserDefault(type, key, domain) {
+  if (!VALID_TYPES.includes(type)) {
     throw new TypeError(`${type} must be one of ${VALID_TYPES.join(', ')}`)
+  } else if (domain && typeof domain !== 'string') {
+    throw new TypeError('domain must be a valid string')
   }
 
-  return defaults.getUserDefault.call(this, type, key)
+  return defaults.getUserDefault.call(this, type, key, domain)
 }
 
-function setUserDefault(type, key, value) {
+function setUserDefault(type, key, value, domain) {
   if (!VALID_TYPES.includes(type)) {
     throw new TypeError(`${type} must be one of ${VALID_TYPES.join(', ')}`)
+  } else if (domain && typeof domain !== 'string') {
+    throw new TypeError('domain must be a valid string')
   }
 
   const isFloatOrDouble = (n) => !isNaN(parseFloat(n))
   const isObject = (o) => Object.prototype.toString.call(o) === '[object Object]'
 
   if (type === 'string' && typeof value !== 'string') {
-    throw new Error(`${value} must be a valid string`)
+    throw new TypeError('value must be a valid string')
   } else if (type === 'double' && !isFloatOrDouble(value)) {
-    throw new Error(`${value} must be a valid double`)
+    throw new TypeError('value must be a valid double')
   } else if (type === 'float' && !isFloatOrDouble(value)) {
-    throw new Error(`${value} must be a valid float`)
+    throw new TypeError('value must be a valid float')
   } else if (type === 'boolean' && typeof value !== 'boolean') {
-    throw new Error(`${value} must be a valid boolean`)
+    throw new TypeError('value must be a valid boolean')
   } else if (type === 'integer' && !Number.isInteger(value)) {
-    throw new Error(`${value} must be a valid integer`)
+    throw new TypeError('value must be a valid integer')
   } else if (type === 'array' && !Array.isArray(value)) {
-    throw new Error(`${value} must be a valid array`)
+    throw new TypeError('value must be a valid array')
   } else if (type == 'dictionary' && !isObject(value)) {
-    throw new Error(`${value} must be a valid dictionary`)
+    throw new TypeError('value must be a valid dictionary')
   } else if (type === 'url' && typeof value !== 'string') {
-    throw new Error(`${value} must be a valid url`)
+    throw new TypeError('value must be a valid url')
+  }
+
+  return defaults.setUserDefault.call(this, type, key, value, domain)
+}
+
+function isKeyManaged(key, domain) {
+  if (domain && typeof domain !== 'string') {
+    throw new TypeError('domain must be a valid string')
+  }
+
+  return defaults.isKeyManaged.call(this, key, domain)
+}
+
+function removeUserDefault(key, domain) {
+  if (domain && typeof domain !== 'string') {
+    throw new TypeError('domain must be a valid string')
   }
 
-  return defaults.setUserDefault.call(this, type, key, value)
+  return defaults.removeUserDefault.call(this, key, domain)
 }
 
 module.exports = {
-  getAllDefaults: defaults.getAllDefaults,
+  getAllDefaults,
   getUserDefault,
-  isKeyManaged: defaults.isKeyManaged,
+  isKeyManaged,
   setUserDefault,
-  removeUserDefault: defaults.removeUserDefault,
+  removeUserDefault
 }
diff --git a/src/defaults.mm b/src/defaults.mm
@@ -139,21 +139,33 @@
 
 // Returns all NSUserDefaults for the current user.
 Napi::Object GetAllDefaults(const Napi::CallbackInfo &info) {
-  Napi::Env env = info.Env();
+  NSUserDefaults *defaults = [&]() {
+    if (!info[0].IsEmpty()) {
+      const std::string domain = (std::string)info[0].ToString();
+      return [[NSUserDefaults alloc] initWithSuiteName:ToNSString(domain)];
+    }
+    return [NSUserDefaults standardUserDefaults];
+  }();
 
-  NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
   NSDictionary *all_defaults = [defaults dictionaryRepresentation];
-  return NSDictionaryToNapiObject(env, all_defaults);
+  return NSDictionaryToNapiObject(info.Env(), all_defaults);
 }
 
 // Returns the value of 'key' in NSUserDefaults for a specified type.
 Napi::Value GetUserDefault(const Napi::CallbackInfo &info) {
   Napi::Env env = info.Env();
 
-  const std::string type = info[0].As<Napi::String>().Utf8Value();
-  const std::string key = info[1].As<Napi::String>().Utf8Value();
+  const std::string type = (std::string)info[0].ToString();
+  const std::string key = (std::string)info[1].ToString();
+
+  NSUserDefaults *defaults = [&]() {
+    if (!info[2].IsEmpty()) {
+      const std::string domain = (std::string)info[2].ToString();
+      return [[NSUserDefaults alloc] initWithSuiteName:ToNSString(domain)];
+    }
+    return [NSUserDefaults standardUserDefaults];
+  }();
 
-  NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
   NSString *default_key = [NSString stringWithUTF8String:key.c_str()];
 
   if (type == "string") {
@@ -187,12 +199,18 @@
 
 // Sets the value of the NSUserDefault for 'key' in NSUserDefaults.
 void SetUserDefault(const Napi::CallbackInfo &info) {
-  NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
-  const std::string type = info[0].As<Napi::String>().Utf8Value();
-  const std::string key = info[1].As<Napi::String>().Utf8Value();
-
+  const std::string type = (std::string)info[0].ToString();
+  const std::string key = (std::string)info[1].ToString();
   NSString *default_key = ToNSString(key);
 
+  NSUserDefaults *defaults = [&]() {
+    if (!info[3].IsEmpty()) {
+      const std::string domain = (std::string)info[3].ToString();
+      return [[NSUserDefaults alloc] initWithSuiteName:ToNSString(domain)];
+    }
+    return [NSUserDefaults standardUserDefaults];
+  }();
+
   if (type == "string") {
     const std::string value = (std::string)info[2].ToString();
     [defaults setObject:ToNSString(value) forKey:default_key];
@@ -219,32 +237,43 @@ void SetUserDefault(const Napi::CallbackInfo &info) {
     }
   } else if (type == "dictionary") {
     Napi::Value value = info[2].As<Napi::Value>();
-    if (NSDictionary* dict = NapiObjectToNSDictionary(value)) {
+    if (NSDictionary *dict = NapiObjectToNSDictionary(value)) {
       [defaults setObject:dict forKey:default_key];
     }
   }
 }
 
 // Removes the default for 'key' in NSUserDefaults.
 void RemoveUserDefault(const Napi::CallbackInfo &info) {
-  NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
-
-  const std::string key = info[1].As<Napi::String>().Utf8Value();
+  const std::string key = (std::string)info[0].ToString();
   NSString *default_key = ToNSString(key);
 
+  NSUserDefaults *defaults = [&]() {
+    if (!info[1].IsEmpty()) {
+      const std::string domain = (std::string)info[1].ToString();
+      return [[NSUserDefaults alloc] initWithSuiteName:ToNSString(domain)];
+    }
+    return [NSUserDefaults standardUserDefaults];
+  }();
+
   [defaults removeObjectForKey:default_key];
 }
 
 // Returns whether or not an NSUserDefault is managed by an admin.
 Napi::Boolean IsKeyManaged(const Napi::CallbackInfo &info) {
-  Napi::Env env = info.Env();
+  const std::string key = (std::string)info[0].ToString();
 
-  const std::string key = info[0].As<Napi::String>().Utf8Value();
+  NSUserDefaults *defaults = [&]() {
+    if (!info[1].IsEmpty()) {
+      const std::string domain = (std::string)info[1].ToString();
+      return [[NSUserDefaults alloc] initWithSuiteName:ToNSString(domain)];
+    }
+    return [NSUserDefaults standardUserDefaults];
+  }();
 
-  NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
   bool managed = [defaults objectIsForcedForKey:ToNSString(key)];
 
-  return Napi::Boolean::New(env, managed);
+  return Napi::Boolean::New(info.Env(), managed);
 }
 
 // Initializes all functions exposed to JS.
diff --git a/test/module.spec.js b/test/module.spec.js
@@ -3,7 +3,8 @@ const {
   getAllDefaults,
   getUserDefault,
   isKeyManaged,
-  setUserDefault
+  setUserDefault,
+  removeUserDefault
 } = require('../index')
 
 const VALID_TYPES = [
@@ -19,6 +20,12 @@ const VALID_TYPES = [
 
 describe('node-mac-userdefaults', () => {
   describe('getAllDefaults()', () => {
+    it('should throw on a bad domain', () => {
+      expect(() => {
+        getAllDefaults(1)
+      }).to.throw(/domain must be a valid string/)
+    })
+
     it('should return an object containing all current user defaults', () => {
       const allDefaults = getAllDefaults()
       expect(allDefaults).to.be.an.an('object')
@@ -27,10 +34,10 @@ describe('node-mac-userdefaults', () => {
   })
 
   describe('getUserDefault()', () => {
-    it('should throw on extra arguments', () => {
+    it('should throw on a bad domain', () => {
       expect(() => {
-        getUserDefault('bad-type', 'hello-world', 'blah')
-      }).to.throw('Arguments must be (type, key)')
+        getUserDefault('string', 'hello-world', 1)
+      }).to.throw(/domain must be a valid string/)
     })
 
     it('should throw on invalid types', () => {
@@ -60,11 +67,17 @@ describe('node-mac-userdefaults', () => {
       }).to.throw(`bad-type must be one of ${VALID_TYPES.join(', ')}`)
     })
 
+    it('should throw on a bad domain', () => {
+      expect(() => {
+        setUserDefault('string', 'hello', 'world', 1)
+      }).to.throw(/domain must be a valid string/)
+    })
+
     it('should throw on mismatched values for types', () => {
       for (const type of VALID_TYPES) {
         expect(() => {
           setUserDefault(type, 'some-key', undefined)
-        }).to.throw(`undefined must be a valid ${type}`)
+        }).to.throw(`value must be a valid ${type}`)
       }
     })
 
@@ -121,9 +134,23 @@ describe('node-mac-userdefaults', () => {
   })
 
   describe('isKeyManaged()', () => {
+    it('should throw on a bad domain', () => {
+      expect(() => {
+        isKeyManaged('AppleInterfaceStyle', 1)
+      }).to.throw(/domain must be a valid string/)
+    })
+
     it('returns a boolean', () => {
       const managed = isKeyManaged('AppleInterfaceStyle')
       expect(managed).to.be.a('boolean')
     })
   })
+
+  describe('removeUserDefault()', () => {
+    it('should throw on a bad domain', () => {
+      expect(() => {
+        removeUserDefault('i-dont-exist', 1)
+      }).to.throw(/domain must be a valid string/)
+    })
+  })
 })
