Merge branch 'master' into fix(kitsu-core)/meta-object-merge

Author: wopian

.github/workflows/ci.yml

@@ -54,7 +54,7 @@ jobs:
 
     - name: Upload test coverage to Code Climate
       if: ${{ matrix.node_version == 18 }}
-      uses: paambaati/codeclimate-action@v3.2.0
+      uses: paambaati/codeclimate-action@v4.0.0
       env:
         CC_TEST_REPORTER_ID: 7a4b78747587abb295ccb41439d7d067b9de2d885a766e7e88d5e8409599d2ea
 

CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [10.1.0](https://github.com/wopian/kitsu/compare/v10.0.5...v10.1.0) (2023-02-28)
+
+
+### Features
+
+* **kitsu:** Configurable modern query serializer ([ef94ae0](https://github.com/wopian/kitsu/commit/ef94ae0483bbe051f86faf47069168772b6cd5ac))
+
+
+
+
+
+## [10.0.5](https://github.com/wopian/kitsu/compare/v10.0.4...v10.0.5) (2023-02-28)
+
+
+### Bug Fixes
+
+* **kitsu-core:** Allow empty POST body ([16cd20d](https://github.com/wopian/kitsu/commit/16cd20d74bf028deaed7a219c590f24a85adc752))
+
+
+
+
+
 ## [10.0.4](https://github.com/wopian/kitsu/compare/v10.0.3...v10.0.4) (2022-10-30)
 
 **Note:** Version bump only for package kitsujs

lerna.json

@@ -1,5 +1,5 @@
 {
-  "version": "10.0.4",
+  "version": "10.1.0",
   "npmClient": "yarn",
   "useWorkspaces": true,
   "command": {

package.json

@@ -36,26 +36,26 @@
   "devDependencies": {
     "@babel/cli": "~7.21.0",
     "@babel/core": "~7.21.0",
-    "@babel/preset-env": "~7.20.0",
+    "@babel/preset-env": "~7.21.0",
     "@rollup/plugin-babel": "~6.0.0",
     "axios": "~0.27.0",
     "axios-mock-adapter": "~1.21.0",
-    "babel-jest": "~29.4.0",
+    "babel-jest": "~29.5.0",
     "browserslist": "~4.21.0",
     "conventional-changelog-angular": "~5.0.12",
     "cross-env": "~7.0.0",
     "documentation": "~14.0.0",
-    "eslint": "~8.35.0",
+    "eslint": "~8.39.0",
     "eslint-config-wopian": "~3.0.0",
-    "jest": "~29.4.0",
+    "jest": "~29.5.0",
     "jest-environment-jsdom": "^29.0.0",
     "json-stringify-safe": "~5.0.1",
     "lerna": "^3.0.0",
     "rollup": "~2.79.0",
     "rollup-plugin-delete": "~2.0.0",
     "rollup-plugin-local-resolve": "~1.0.7",
     "size-limit": "~8.2.0",
-    "typescript": "~4.9.0"
+    "typescript": "~5.0.0"
   },
   "jest": {
     "coverageThreshold": {

packages/kitsu-core/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [10.1.0](https://github.com/wopian/kitsu/compare/v10.0.5...v10.1.0) (2023-02-28)
+
+
+### Features
+
+* **kitsu:** Configurable modern query serializer ([ef94ae0](https://github.com/wopian/kitsu/commit/ef94ae0483bbe051f86faf47069168772b6cd5ac))
+
+
+
+
+
+## [10.0.5](https://github.com/wopian/kitsu/compare/v10.0.4...v10.0.5) (2023-02-28)
+
+
+### Bug Fixes
+
+* **kitsu-core:** Allow empty POST body ([16cd20d](https://github.com/wopian/kitsu/commit/16cd20d74bf028deaed7a219c590f24a85adc752))
+
+
+
+
+
 ## [10.0.4](https://github.com/wopian/kitsu/compare/v10.0.3...v10.0.4) (2022-10-30)
 
 **Note:** Version bump only for package kitsu-core

packages/kitsu-core/README.md

@@ -137,7 +137,7 @@ All code released under [MIT]
 
 ### camel
 
-[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
+[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/feedef8ad5594ee55351dda1136c097c8667a4cd/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
 
 Converts kebab-case and snake\_case into camelCase
 
@@ -163,7 +163,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### deattribute
 
-[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
+[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/feedef8ad5594ee55351dda1136c097c8667a4cd/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
 
 Hoists attributes to be top-level
 
@@ -205,7 +205,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 ### deserialise
 
-[packages/kitsu-core/src/deserialise/index.js:62-77](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/deserialise/index.js#L62-L77 "Source code on GitHub")
+[packages/kitsu-core/src/deserialise/index.js:62-77](https://github.com/wopian/kitsu/blob/feedef8ad5594ee55351dda1136c097c8667a4cd/packages/kitsu-core/src/deserialise/index.js#L62-L77 "Source code on GitHub")
 
 Deserialises a JSON-API response
 
@@ -255,7 +255,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### error
 
-[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
+[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/feedef8ad5594ee55351dda1136c097c8667a4cd/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
 
 Uniform error handling for Axios, JSON:API and internal package errors. Mutated Error object is rethrown to the caller.
 
@@ -292,7 +292,7 @@ error({
 
 ### filterIncludes
 
-[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
+[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/feedef8ad5594ee55351dda1136c097c8667a4cd/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
 
 Filters includes for the specific relationship requested
 
@@ -332,7 +332,7 @@ Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Gl
 
 ### kebab
 
-[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
+[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/feedef8ad5594ee55351dda1136c097c8667a4cd/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
 
 Converts camelCase into kebab-case
 
@@ -350,7 +350,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### linkRelationships
 
-[packages/kitsu-core/src/linkRelationships/index.js:144-164](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/linkRelationships/index.js#L144-L164 "Source code on GitHub")
+[packages/kitsu-core/src/linkRelationships/index.js:144-164](https://github.com/wopian/kitsu/blob/feedef8ad5594ee55351dda1136c097c8667a4cd/packages/kitsu-core/src/linkRelationships/index.js#L144-L164 "Source code on GitHub")
 
 Links relationships to included data
 
@@ -390,7 +390,7 @@ Returns **any** Parsed data
 
 ### isDeepEqual
 
-[packages/kitsu-core/src/deepEqual/index.js:18-42](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/deepEqual/index.js#L18-L42 "Source code on GitHub")
+[packages/kitsu-core/src/deepEqual/index.js:18-42](https://github.com/wopian/kitsu/blob/feedef8ad5594ee55351dda1136c097c8667a4cd/packages/kitsu-core/src/deepEqual/index.js#L18-L42 "Source code on GitHub")
 
 Compare two objects equality
 
@@ -419,14 +419,15 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 ### query
 
-[packages/kitsu-core/src/query/index.js:34-43](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/query/index.js#L34-L43 "Source code on GitHub")
+[packages/kitsu-core/src/query/index.js:55-64](https://github.com/wopian/kitsu/blob/feedef8ad5594ee55351dda1136c097c8667a4cd/packages/kitsu-core/src/query/index.js#L55-L64 "Source code on GitHub")
 
 Constructs a URL query string for JSON:API parameters
 
 #### Parameters
 
 *   `params` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Parameters to parse
 *   `prefix` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Prefix for nested parameters - used internally (optional, default `null`)
+*   `traditional` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Use the traditional (default) or modern param serializer. Set to false if your server is running Ruby on Rails or other modern web frameworks (optional, default `true`)
 
 #### Examples
 
@@ -447,7 +448,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### serialise
 
-[packages/kitsu-core/src/serialise/index.js:213-224](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/serialise/index.js#L213-L224 "Source code on GitHub")
+[packages/kitsu-core/src/serialise/index.js:213-224](https://github.com/wopian/kitsu/blob/feedef8ad5594ee55351dda1136c097c8667a4cd/packages/kitsu-core/src/serialise/index.js#L213-L224 "Source code on GitHub")
 
 Serialises an object into a JSON-API structure
 
@@ -492,7 +493,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### snake
 
-[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
+[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/feedef8ad5594ee55351dda1136c097c8667a4cd/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
 
 Converts camelCase into snake\_case
 
@@ -510,7 +511,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### splitModel
 
-[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/55f31c666be1b67ae2eb7d5d16fecd181c0028db/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
+[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/feedef8ad5594ee55351dda1136c097c8667a4cd/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
 
 Split model name from the model's resource URL
 

packages/kitsu-core/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "10.0.4",
+  "version": "10.1.0",
   "name": "kitsu-core",
   "description": "Simple, lightweight & framework agnostic JSON:API (de)serialsation components",
   "author": "James Harris <wopian@wopian.me>",

packages/kitsu-core/src/query/index.js

@@ -3,20 +3,40 @@
  *
  * @param {string} value Right-hand side of the query
  * @param {string} key Left-hand side of the query
+ * @param {boolean} traditional use traditional array key serializer
+ *
  * @returns {string} URL query string
  * @private
  */
-function queryFormat (value, key) {
-  if (value !== null && Array.isArray(value)) return value.map(v => queryFormat(v, key)).join('&')
-  else if (value !== null && typeof value === 'object') return query(value, key)
+function queryFormat (value, key, traditional) {
+  if (traditional && value !== null && Array.isArray(value)) return value.map(v => queryFormat(v, key, traditional)).join('&')
+  if (!traditional && value !== null && Array.isArray(value)) return value.map(v => queryFormat(v, `${key}[]`, traditional)).join('&')
+  else if (value !== null && typeof value === 'object') return query(value, key, traditional)
   else return encodeURIComponent(key) + '=' + encodeURIComponent(value)
 }
 
+/**
+ * Formats key names to correct array syntax
+ *
+ * @param {string} [param] Parameter name to parse
+ *
+ * @returns {string} Key name in nested query-param format with optional array style suffix
+ * @private
+ */
+export function paramKeyName (param) {
+  if ([ '[]', '][' ].includes(param.slice(-2))) {
+    return `[${param.slice(0, -2)}][]`
+  }
+
+  return `[${param}]`
+}
+
 /**
  * Constructs a URL query string for JSON:API parameters
  *
  * @param {Object} [params] Parameters to parse
  * @param {string} [prefix] Prefix for nested parameters - used internally
+ * @param {boolean} [traditional=true] Use the traditional (default) or modern param serializer. Set to false if your server is running Ruby on Rails or other modern web frameworks
  * @returns {string} URL query string
  *
  * @example
@@ -31,12 +51,13 @@ function queryFormat (value, key) {
  * })
  * // filter%5Bslug%5D=cowboy-bebop&filter%5Btitle%5D%5Bvalue%5D=foo&sort=-id
  */
-export function query (params, prefix = null) {
+
+export function query (params, prefix = null, traditional = true) {
   const str = []
 
   for (const param in params) {
     str.push(
-      queryFormat(params[param], prefix ? `${prefix}[${param}]` : param)
+      queryFormat(params[param], prefix ? `${prefix}${paramKeyName(param)}` : param, traditional)
     )
   }
   return str.join('&')

packages/kitsu-core/src/query/index.spec.js

@@ -59,7 +59,7 @@ describe('kitsu-core', () => {
       })).toEqual('fields%5Babc%5D%5Bdef%5D%5Bghi%5D%5Bjkl%5D=mno')
     })
 
-    it('builds list parameters', () => {
+    it('builds list parameters in traditional mode', () => {
       expect.assertions(1)
       expect(query({
         filter: {
@@ -68,13 +68,50 @@ describe('kitsu-core', () => {
       })).toEqual('filter%5Bid_in%5D=1&filter%5Bid_in%5D=2&filter%5Bid_in%5D=3')
     })
 
-    it('builds nested list parameters', () => {
+    it('builds nested list parameters in traditional mode', () => {
       expect.assertions(1)
       expect(query({
         filter: {
           users: [ { id: 1, type: 'users' }, { id: 2, type: 'users' } ]
         }
       })).toEqual('filter%5Busers%5D%5Bid%5D=1&filter%5Busers%5D%5Btype%5D=users&filter%5Busers%5D%5Bid%5D=2&filter%5Busers%5D%5Btype%5D=users')
     })
+
+    it('builds list parameters in modern mode', () => {
+      expect.assertions(1)
+      expect(query({
+        filter: {
+          id_in: [ 1, 2, 3 ]
+        }
+      }, null, false)).toEqual('filter%5Bid_in%5D%5B%5D=1&filter%5Bid_in%5D%5B%5D=2&filter%5Bid_in%5D%5B%5D=3')
+    })
+
+    it('builds nested list parameters in modern mode', () => {
+      expect.assertions(1)
+      expect(query({
+        filter: {
+          users: [ { id: 1, type: 'users' }, { id: 2, type: 'users' } ]
+        }
+      }, null, false)).toEqual('filter%5Busers%5D%5B%5D%5Bid%5D=1&filter%5Busers%5D%5B%5D%5Btype%5D=users&filter%5Busers%5D%5B%5D%5Bid%5D=2&filter%5Busers%5D%5B%5D%5Btype%5D=users')
+    })
+
+    it('parses list-style keys', () => {
+      expect.assertions(1)
+      expect(query({
+        filter: {
+          'id_in[]': [ 1, 2 ],
+          'parent_id_in][': [ 3, 4 ]
+        }
+      })).toEqual('filter%5Bid_in%5D%5B%5D=1&filter%5Bid_in%5D%5B%5D=2&filter%5Bparent_id_in%5D%5B%5D=3&filter%5Bparent_id_in%5D%5B%5D=4')
+    })
+
+    it('preserves square-brackets in key names in modern mode', () => {
+      expect.assertions(1)
+      expect(query({
+        filter: {
+          'id_in[]': [ 1, 2 ]
+        }
+      }, null, false)).toEqual('filter%5Bid_in%5D%5B%5D%5B%5D=1&filter%5Bid_in%5D%5B%5D%5B%5D=2')
+    })
   })
 })

packages/kitsu-core/src/serialise/index.js

@@ -24,7 +24,7 @@ function isValid (isArray, type, payload, method) {
       }
     }
   } else {
-    if (typeof payload !== 'object' || Object.keys(payload).length === 0) {
+    if (typeof payload !== 'object' || (method !== 'POST' && Object.keys(payload).length === 0)) {
       throw new Error(`${method} requires an object or array body`)
     }
     // A POST request is the only request to not require an ID in spec