feat: implement add/remove domain

Author: codebytere

README.md

@@ -73,7 +73,7 @@ const { getUserDefault } = require('node-mac-userdefaults')
 const interfaceStyle = getUserDefault('AppleInterfaceStyle', 'string')
 
 console.log(interfaceStyle) // 'Dark'
-``` 
+```
 
 ### `defaults.setUserDefault(type, key, value[, domain])`
 
@@ -91,6 +91,8 @@ const { setUserDefault } = require('node-mac-userdefaults')
 setUserDefault('boolean', 'ApplePressAndHoldEnabled', true)
 ```
 
+Note: `NSGlobalDomain` is an invalid domain name because it isn't writeable by apps.
+
 ### `defaults.removeUserDefault(key[, domain])`
 
 * `key` String - The `NSUserDefault` to remove, e.g `AppleInterfaceStyle`.
@@ -107,6 +109,8 @@ const { removeUserDefault } = require('node-mac-userdefaults')
 removeUserDefault('ApplePressAndHoldEnabled')
 ```
 
+Note: `NSGlobalDomain` is an invalid domain name because it isn't writeable by apps.
+
 ###  `defaults.isKeyManaged(key[, domain])`
 
 * `key` String - The `NSUserDefault` to check, e.g `AppleInterfaceStyle`.
@@ -123,6 +127,34 @@ const managed = isKeyManaged('ApplePressAndHoldEnabled')
 console.log(managed) // false
 ```
 
+###  `defaults.addDomain(name)`
+
+* `name` String - The name of the domain to insert into the user’s domain hierarchy.
+
+Inserts the specified domain name into the user’s domain hierarchy.
+
+Example:
+```js
+const { addDomain } = require('node-mac-userdefaults')
+
+addDomain('DomainForMyApp')
+```
+
+###  `defaults.removeDomain(name)`
+
+* `name` String - The name of the domain to remove from the user’s domain hierarchy.
+
+Removed the specified domain name into the user’s domain hierarchy.
+
+Example:
+```js
+const { removeDomain } = require('node-mac-userdefaults')
+
+removeDomain('DomainForMyApp')
+```
+
+Note: Passing `NSGlobalDomain` is unsupported.
+
 ## FAQ
 
 ### What are domains?
@@ -131,12 +163,8 @@ The `NSUserDefaults` database consists of a hierarchy or domains. Whenever you r
 
 | Domain Name | Description  | State |
 |---|---|---|
-| `NSArgumentDomain` | This is the highest priority domain - it can be used to temporarily override any preference | volatile |
-| `Application` | This domain is where your app’s settings are stored when you invoke `setUserDefault` methods without specifying a domain | persistent |
-| `NSGlobalDomain` | This domain is where system-wide settings are stored | persistent |
-| `Languages` | This domain contains regional preferences such as month names or date formats for each locale | volatile |
-| `NSRegistrationDomain` | This domain serves as a fallback for any value that is not found in the Application domain  | volatile |
-
-You can also specify custom domains to store a set of preferences.
+| `NSArgumentDomain` | The domain consisting of defaults parsed from the application’s arguments | volatile |
+| `NSGlobalDomain` | The domain consisting of defaults meant to be seen by all applications | persistent |
+| `NSRegistrationDomain` | The domain consisting of a set of temporary defaults whose values can be set by the application to ensure that searches will always be successful | volatile |
 
-See [this resource](https://oleb.net/blog/2014/02/nsuserdefaults-handling-default-values/) for more information.
+You can also specify custom domains to store a set of preferences.

index.js

@@ -76,10 +76,28 @@ function removeUserDefault(key, domain) {
   return defaults.removeUserDefault.call(this, key, domain)
 }
 
+function addDomain(name) {
+  if (typeof name !== 'string') {
+    throw new TypeError('domain name must be a valid string')
+  }
+
+  return defaults.addDomain.call(this, name)
+}
+
+function removeDomain(name) {
+  if (typeof name !== 'string') {
+    throw new TypeError('domain name must be a valid string')
+  }
+
+  return defaults.removeDomain.call(this, name)
+}
+
 module.exports = {
+  addDomain,
   getAllDefaults,
   getUserDefault,
   isKeyManaged,
   setUserDefault,
-  removeUserDefault
+  removeDomain,
+  removeUserDefault,
 }

src/defaults.mm

@@ -276,6 +276,22 @@ void RemoveUserDefault(const Napi::CallbackInfo &info) {
   return Napi::Boolean::New(info.Env(), managed);
 }
 
+// Inserts the specified domain name into the user’s domain hierarchy.
+void AddDomain(const Napi::CallbackInfo &info) {
+  const std::string name = (std::string)info[0].ToString();
+
+  NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
+  [defaults addSuiteNamed:ToNSString(name)];
+}
+
+// Removes the specified domain name from the user’s domain hierarchy.
+void RemoveDomain(const Napi::CallbackInfo &info) {
+  const std::string name = (std::string)info[0].ToString();
+
+  NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
+  [defaults removeSuiteNamed:ToNSString(name)];
+}
+
 // Initializes all functions exposed to JS.
 Napi::Object Init(Napi::Env env, Napi::Object exports) {
   exports.Set(Napi::String::New(env, "isKeyManaged"),
@@ -288,6 +304,10 @@ void RemoveUserDefault(const Napi::CallbackInfo &info) {
               Napi::Function::New(env, SetUserDefault));
   exports.Set(Napi::String::New(env, "removeUserDefault"),
               Napi::Function::New(env, RemoveUserDefault));
+  exports.Set(Napi::String::New(env, "addDomain"),
+            Napi::Function::New(env, AddDomain));
+  exports.Set(Napi::String::New(env, "removeDomain"),
+            Napi::Function::New(env, RemoveDomain));
 
   return exports;
 }

test/module.spec.js

@@ -4,7 +4,9 @@ const {
   getUserDefault,
   isKeyManaged,
   setUserDefault,
-  removeUserDefault
+  removeUserDefault,
+  addDomain,
+  removeDomain
 } = require('../index')
 
 const VALID_TYPES = [
@@ -153,4 +155,20 @@ describe('node-mac-userdefaults', () => {
       }).to.throw(/domain must be a valid string/)
     })
   })
+
+  describe('addDomain()', () => {
+    it('should throw on a bad domain', () => {
+      expect(() => {
+        addDomain(1)
+      }).to.throw(/name must be a valid string/)
+    })
+  })
+
+  describe('removeDomain()', () => {
+    it('should throw on a bad domain', () => {
+      expect(() => {
+        removeDomain(1)
+      }).to.throw(/name must be a valid string/)
+    })
+  })
 })