extensions instead of customExtensions (#75)

README.md

@@ -62,6 +62,8 @@ yarn install
 * `dist/mobx-async-store.umd.js`
     a UMD build, suitable for use in any environment (including the browser, as a `<script>` tag), that includes the external dependency. This corresponds to the `"browser"` field in package.json
 
+`yarn run yuidoc` updates the documentation, located in `docs`.
+
 ## Installation
 
 ```

dist/mobx-async-store.cjs.js

@@ -917,6 +917,9 @@ var Model = (_class = (_temp = /*#__PURE__*/function () {
      * todo.title = 'Buy Cheese'
      * todo.dirtyAttributes
      * => ['title']
+     * todo.note = note1
+     * todo.dirtyAttributes
+     * => ['title', 'relationships.note']
      * ```
      * @method dirtyAttributes
      * @return {Array} dirty attribute paths
@@ -1448,7 +1451,7 @@ var Store = (_class$1 = (_temp$1 = /*#__PURE__*/function () {
       var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(type, records) {
         var options,
             queryParams,
-            customExtensions,
+            extensions,
             url,
             recordAttributes,
             body,
@@ -1460,7 +1463,7 @@ var Store = (_class$1 = (_temp$1 = /*#__PURE__*/function () {
             switch (_context.prev = _context.next) {
               case 0:
                 options = _args.length > 2 && _args[2] !== undefined ? _args[2] : {};
-                queryParams = options.queryParams, customExtensions = options.customExtensions; // get url for record type
+                queryParams = options.queryParams, extensions = options.extensions; // get url for record type
 
                 url = _this.fetchUrl(type, queryParams, null); // convert records to an appropriate jsonapi attribute/relationship format
 
@@ -1472,7 +1475,7 @@ var Store = (_class$1 = (_temp$1 = /*#__PURE__*/function () {
                   data: recordAttributes
                 }); // build the json api extension string
 
-                extensionStr = customExtensions !== null && customExtensions !== void 0 && customExtensions.length ? "ext=\"bulk,".concat(customExtensions.join(), "\"") : 'ext="bulk"'; // send request
+                extensionStr = extensions !== null && extensions !== void 0 && extensions.length ? "ext=\"bulk,".concat(extensions.join(), "\"") : 'ext="bulk"'; // send request
 
                 response = _this.fetch(url, {
                   headers: _objectSpread$2(_objectSpread$2({}, _this.defaultFetchOptions.headers), {}, {

dist/mobx-async-store.esm.js

@@ -911,6 +911,9 @@ var Model = (_class = (_temp = /*#__PURE__*/function () {
      * todo.title = 'Buy Cheese'
      * todo.dirtyAttributes
      * => ['title']
+     * todo.note = note1
+     * todo.dirtyAttributes
+     * => ['title', 'relationships.note']
      * ```
      * @method dirtyAttributes
      * @return {Array} dirty attribute paths
@@ -1442,7 +1445,7 @@ var Store = (_class$1 = (_temp$1 = /*#__PURE__*/function () {
       var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(type, records) {
         var options,
             queryParams,
-            customExtensions,
+            extensions,
             url,
             recordAttributes,
             body,
@@ -1454,7 +1457,7 @@ var Store = (_class$1 = (_temp$1 = /*#__PURE__*/function () {
             switch (_context.prev = _context.next) {
               case 0:
                 options = _args.length > 2 && _args[2] !== undefined ? _args[2] : {};
-                queryParams = options.queryParams, customExtensions = options.customExtensions; // get url for record type
+                queryParams = options.queryParams, extensions = options.extensions; // get url for record type
 
                 url = _this.fetchUrl(type, queryParams, null); // convert records to an appropriate jsonapi attribute/relationship format
 
@@ -1466,7 +1469,7 @@ var Store = (_class$1 = (_temp$1 = /*#__PURE__*/function () {
                   data: recordAttributes
                 }); // build the json api extension string
 
-                extensionStr = customExtensions !== null && customExtensions !== void 0 && customExtensions.length ? "ext=\"bulk,".concat(customExtensions.join(), "\"") : 'ext="bulk"'; // send request
+                extensionStr = extensions !== null && extensions !== void 0 && extensions.length ? "ext=\"bulk,".concat(extensions.join(), "\"") : 'ext="bulk"'; // send request
 
                 response = _this.fetch(url, {
                   headers: _objectSpread$2(_objectSpread$2({}, _this.defaultFetchOptions.headers), {}, {

docs/classes/Model.html

@@ -17,7 +17,7 @@
                 <h1><img src="../assets/css/logo.png" title="mobx-async-store" width="117" height="52"></h1>
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 3.1.1</em>
+            <em>API Docs for: 3.2.0</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">
@@ -1065,15 +1065,15 @@ <h3 class="name"><code>previousSnapshot</code></h3>
     <div class="meta">
                 <p>
                 Defined in
-        <a href="../files/src_Model.js.html#l491"><code>src&#x2F;Model.js:491</code></a>
+        <a href="../files/src_Model.js.html#l502"><code>src&#x2F;Model.js:502</code></a>
         </p>
 
 
 
     </div>
 
     <div class="description">
-        <p>the latest snapshot</p>
+        <p>the latest persisted snapshot or the first snapshot if the model was never persisted</p>
 
     </div>
 
@@ -1096,15 +1096,15 @@ <h3 class="name"><code>previousSnapshot</code></h3>
     <div class="meta">
                 <p>
                 Defined in
-        <a href="../files/src_Model.js.html#l502"><code>src&#x2F;Model.js:502</code></a>
+        <a href="../files/src_Model.js.html#l491"><code>src&#x2F;Model.js:491</code></a>
         </p>
 
 
 
     </div>
 
     <div class="description">
-        <p>the latest persisted snapshot or the first snapshot if the model was never persisted</p>
+        <p>the latest snapshot</p>
 
     </div>
 

docs/classes/RelatedRecordsArray.html

@@ -17,7 +17,7 @@
                 <h1><img src="../assets/css/logo.png" title="mobx-async-store" width="117" height="52"></h1>
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 3.1.1</em>
+            <em>API Docs for: 3.2.0</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

docs/classes/Schema.html

@@ -17,7 +17,7 @@
                 <h1><img src="../assets/css/logo.png" title="mobx-async-store" width="117" height="52"></h1>
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 3.1.1</em>
+            <em>API Docs for: 3.2.0</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

docs/classes/Store.html

@@ -17,7 +17,7 @@
                 <h1><img src="../assets/css/logo.png" title="mobx-async-store" width="117" height="52"></h1>
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 3.1.1</em>
+            <em>API Docs for: 3.2.0</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">
@@ -708,7 +708,7 @@ <h4>Parameters:</h4>
 
 
                     <div class="param-description">
-                        <p>{queryParams, customExtensions}</p>
+                        <p>{queryParams, extensions}</p>
 
                     </div>
 
@@ -2666,7 +2666,7 @@ <h3 class="name"><code>initializeNetworkConfiguration</code></h3>
     <div class="meta">
                 <p>
                 Defined in
-        <a href="../files/src_Store.js.html#l470"><code>src&#x2F;Store.js:470</code></a>
+        <a href="../files/src_Store.js.html#l481"><code>src&#x2F;Store.js:481</code></a>
         </p>
 
 
@@ -2720,7 +2720,7 @@ <h3 class="name"><code>initializeNetworkConfiguration</code></h3>
     <div class="meta">
                 <p>
                 Defined in
-        <a href="../files/src_Store.js.html#l481"><code>src&#x2F;Store.js:481</code></a>
+        <a href="../files/src_Store.js.html#l470"><code>src&#x2F;Store.js:470</code></a>
         </p>
 
 

docs/data.json

@@ -3,7 +3,7 @@
         "name": "mobx-async-store",
         "description": "Asyc Data Store for mobx",
         "url": "https://github.com/artemis-ag/mobx-async-store",
-        "version": "3.1.1"
+        "version": "3.2.0"
     },
     "files": {
         "src/decorators/attributes.js": {
@@ -890,7 +890,7 @@
                 },
                 {
                     "name": "options",
-                    "description": "{queryParams, customExtensions}",
+                    "description": "{queryParams, extensions}",
                     "type": "Object"
                 }
             ],

docs/files/src_Model.js.html

@@ -17,7 +17,7 @@
                 <h1><img src="../assets/css/logo.png" title="mobx-async-store" width="117" height="52"></h1>
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 3.1.1</em>
+            <em>API Docs for: 3.2.0</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

docs/files/src_Store.js.html

@@ -17,7 +17,7 @@
                 <h1><img src="../assets/css/logo.png" title="mobx-async-store" width="117" height="52"></h1>
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 3.1.1</em>
+            <em>API Docs for: 3.2.0</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">
@@ -190,10 +190,10 @@ <h1 class="file-heading">File: src/Store.js</h1>
    * @method bulkSave
    * @param {String} type
    * @param {Array} records
-   * @param {Object} options {queryParams, customExtensions}
+   * @param {Object} options {queryParams, extensions}
    */
   bulkSave = async (type, records, options = {}) =&gt; {
-    const { queryParams, customExtensions } = options
+    const { queryParams, extensions } = options
 
     // get url for record type
     const url = this.fetchUrl(type, queryParams, null)
@@ -205,8 +205,8 @@ <h1 class="file-heading">File: src/Store.js</h1>
     const body = JSON.stringify({ data: recordAttributes })
 
     // build the json api extension string
-    const extensionStr = customExtensions?.length
-      ? &#x60;ext=&quot;bulk,${customExtensions.join()}&quot;&#x60;
+    const extensionStr = extensions?.length
+      ? &#x60;ext=&quot;bulk,${extensions.join()}&quot;&#x60;
       : &#x27;ext=&quot;bulk&quot;&#x27;
 
     // send request

docs/files/src_decorators_attributes.js.html

@@ -17,7 +17,7 @@
                 <h1><img src="../assets/css/logo.png" title="mobx-async-store" width="117" height="52"></h1>
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 3.1.1</em>
+            <em>API Docs for: 3.2.0</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

docs/files/src_decorators_relationships.js.html

@@ -17,7 +17,7 @@
                 <h1><img src="../assets/css/logo.png" title="mobx-async-store" width="117" height="52"></h1>
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 3.1.1</em>
+            <em>API Docs for: 3.2.0</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

docs/files/src_schema.js.html

@@ -17,7 +17,7 @@
                 <h1><img src="../assets/css/logo.png" title="mobx-async-store" width="117" height="52"></h1>
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 3.1.1</em>
+            <em>API Docs for: 3.2.0</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

docs/files/src_utils.js.html

@@ -17,7 +17,7 @@
                 <h1><img src="../assets/css/logo.png" title="mobx-async-store" width="117" height="52"></h1>
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 3.1.1</em>
+            <em>API Docs for: 3.2.0</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

docs/index.html

@@ -17,7 +17,7 @@
                 <h1><img src="./assets/css/logo.png" title="mobx-async-store" width="117" height="52"></h1>
         </div>
         <div class="yui3-u-1-4 version">
-            <em>API Docs for: 3.1.1</em>
+            <em>API Docs for: 3.2.0</em>
         </div>
     </div>
     <div id="bd" class="yui3-g">

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@artemisag/mobx-async-store",
-  "version": "3.1.1",
+  "version": "3.2.0",
   "module": "dist/mobx-async-store.esm.js",
   "browser": "dist/mobx-async-store.cjs.js",
   "main": "dist/mobx-async-store.cjs.js",

spec/Store.spec.js

@@ -296,9 +296,9 @@ describe('Store', () => {
         .toEqual('application/vnd.api+json; ext="bulk"')
     })
 
-    it('adds the customExtensions to the request header', async () => {
+    it('adds the extensions to the request header', async () => {
       const todo1 = store.add('todos', { title: 'Pet Dog' })
-      const customExtensions = ['artemis/group', 'artemis/extendDaThings']
+      const extensions = ['artemis/group', 'artemis/extendDaThings']
       const mockTodosData = {
         data: [
           {
@@ -312,15 +312,15 @@ describe('Store', () => {
       const mockTodosResponse = JSON.stringify(mockTodosData)
       fetch.mockResponse(mockTodosResponse)
 
-      await store.bulkSave('todos', [todo1], {customExtensions})
+      await store.bulkSave('todos', [todo1], {extensions})
 
       expect(fetch.mock.calls[0][1].headers['Content-Type'])
         .toEqual('application/vnd.api+json; ext="bulk,artemis/group,artemis/extendDaThings"')
     })
 
-    it('ignores empty customExtensions in the request header', async () => {
+    it('ignores empty extensions in the request header', async () => {
       const todo1 = store.add('todos', { title: 'Pet Dog' })
-      const customExtensions = []
+      const extensions = []
       const mockTodosData = {
         data: [
           {
@@ -334,7 +334,7 @@ describe('Store', () => {
       const mockTodosResponse = JSON.stringify(mockTodosData)
       fetch.mockResponse(mockTodosResponse)
 
-      await store.bulkSave('todos', [todo1], {customExtensions})
+      await store.bulkSave('todos', [todo1], {extensions})
 
       expect(fetch.mock.calls[0][1].headers['Content-Type'])
         .toEqual('application/vnd.api+json; ext="bulk"')

src/Store.js

@@ -105,10 +105,10 @@ class Store {
    * @method bulkSave
    * @param {String} type
    * @param {Array} records
-   * @param {Object} options {queryParams, customExtensions}
+   * @param {Object} options {queryParams, extensions}
    */
   bulkSave = async (type, records, options = {}) => {
-    const { queryParams, customExtensions } = options
+    const { queryParams, extensions } = options
 
     // get url for record type
     const url = this.fetchUrl(type, queryParams, null)
@@ -120,8 +120,8 @@ class Store {
     const body = JSON.stringify({ data: recordAttributes })
 
     // build the json api extension string
-    const extensionStr = customExtensions?.length
-      ? `ext="bulk,${customExtensions.join()}"`
+    const extensionStr = extensions?.length
+      ? `ext="bulk,${extensions.join()}"`
       : 'ext="bulk"'
 
     // send request