kitsu - npm Package Compare versions

Comparing version 9.1.13 to 9.1.14

CHANGELOG.md

@@ -6,2 +6,21 @@ # Change Log
 
+## [9.1.14](https://github.com/wopian/kitsu/tree/master/packages/kitsu/compare/v9.1.13...v9.1.14) (2020-08-04)
+
+
+### Chores
+
+* **release:** update documentation ([61dc405](https://github.com/wopian/kitsu/tree/master/packages/kitsu/commit/61dc405))
+* **release:** update documentation ([c08f33a](https://github.com/wopian/kitsu/tree/master/packages/kitsu/commit/c08f33a))
+* add funding to package.json ([2125de7](https://github.com/wopian/kitsu/tree/master/packages/kitsu/commit/2125de7))
+
+
+### Documentation Changes
+
+* fix markdown links on npm ([0f971ed](https://github.com/wopian/kitsu/tree/master/packages/kitsu/commit/0f971ed))
+* **kitsu:** document the expected structure of the model parameters ([b981f31](https://github.com/wopian/kitsu/tree/master/packages/kitsu/commit/b981f31))
+
+
+
+
+
 ## [9.1.13](https://github.com/wopian/kitsu/tree/master/packages/kitsu/compare/v9.1.12...v9.1.13) (2020-07-26)
@@ -8,0 +27,0 @@

package.json

 {
-  "version": "9.1.13",
+  "version": "9.1.14",
   "name": "kitsu",
@@ -22,2 +22,3 @@ "description": "A simple, lightweight & framework agnostic JSON:API client using Axios",
   },
+  "funding": "https://github.com/sponsors/wopian",
   "engines": {
@@ -51,3 +52,3 @@ "node": ">= 10"
     "axios": "^0.19.0",
-    "kitsu-core": "^9.1.13",
+    "kitsu-core": "^9.1.14",
     "pluralize": "^8.0.0"
@@ -67,3 +68,3 @@ },
   ],
-  "gitHead": "2ba5df8100027662ab55efdffc041813e22a5321",
+  "gitHead": "6f6a017b1a638f587700c150b75885bec758c2c9",
   "devDependencies": {
@@ -70,0 +71,0 @@ "@size-limit/preset-small-lib": "~4.5.0"

README.md

@@ -212,3 +212,3 @@ <h1 align=center>Kitsu</h1>
 
-[packages/kitsu/src/index.js:30-464](https://github.com/wopian/kitsu/blob/4b9e7a9ad43911a4d6a89b8bdc21babfc50a9239/packages/kitsu/src/index.js#L30-L464 "Source code on GitHub")
+[packages/kitsu/src/index.js:30-464](https://github.com/wopian/kitsu/blob/0f971ed3ac43c77265611d07eaadabf961baf066/packages/kitsu/src/index.js#L30-L464 "Source code on GitHub")
 
@@ -260,3 +260,3 @@ Creates a new `kitsu` instance
 
-[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/4b9e7a9ad43911a4d6a89b8bdc21babfc50a9239/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
+[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/0f971ed3ac43c77265611d07eaadabf961baf066/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
 
@@ -283,3 +283,3 @@ -   **See: <https://www.npmjs.com/package/pluralize> for documentation
 
-[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/4b9e7a9ad43911a4d6a89b8bdc21babfc50a9239/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
+[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/0f971ed3ac43c77265611d07eaadabf961baf066/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
 
@@ -315,3 +315,3 @@ Get the current headers or add additional headers
 
-[packages/kitsu/src/index.js:112-112](https://github.com/wopian/kitsu/blob/4b9e7a9ad43911a4d6a89b8bdc21babfc50a9239/packages/kitsu/src/index.js#L112-L112 "Source code on GitHub")
+[packages/kitsu/src/index.js:112-112](https://github.com/wopian/kitsu/blob/0f971ed3ac43c77265611d07eaadabf961baf066/packages/kitsu/src/index.js#L112-L112 "Source code on GitHub")
 
@@ -367,3 +367,3 @@ -   **See: <https://github.com/axios/axios#interceptors> for documentation
 
-[packages/kitsu/src/index.js:189-208](https://github.com/wopian/kitsu/blob/4b9e7a9ad43911a4d6a89b8bdc21babfc50a9239/packages/kitsu/src/index.js#L189-L208 "Source code on GitHub")
+[packages/kitsu/src/index.js:189-208](https://github.com/wopian/kitsu/blob/0f971ed3ac43c77265611d07eaadabf961baf066/packages/kitsu/src/index.js#L189-L208 "Source code on GitHub")
 
@@ -374,3 +374,3 @@ Fetch resources (alias `fetch`)
 
--   `model` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Model to fetch data from
+-   `model` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Resource to fetch data from. Expected formats are [`:resource`](https://jsonapi.org/format/#document-resource-objects), [`:resource/:id`](https://jsonapi.org/format/#document-resource-objects), [`:resource/:id/:relationship`](https://jsonapi.org/format/#document-resource-object-relationships) or [`:resource/:id/relationships/:relationship`](https://jsonapi.org/format/#document-resource-object-linkage)
 -   `params` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** JSON-API request queries. Any JSON:API query parameter not mentioned below is supported out of the box. (optional, default `{}`)
@@ -485,3 +485,3 @@ -   `params.page` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** [JSON:API Pagination](http://jsonapi.org/format/#fetching-pagination). All pagination strategies are supported, even if they are not listed below.
 
-[packages/kitsu/src/index.js:241-262](https://github.com/wopian/kitsu/blob/4b9e7a9ad43911a4d6a89b8bdc21babfc50a9239/packages/kitsu/src/index.js#L241-L262 "Source code on GitHub")
+[packages/kitsu/src/index.js:241-262](https://github.com/wopian/kitsu/blob/0f971ed3ac43c77265611d07eaadabf961baf066/packages/kitsu/src/index.js#L241-L262 "Source code on GitHub")
 
@@ -492,3 +492,3 @@ Update a resource (alias `update`)
 
--   `model` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Model to update data in
+-   `model` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Resource to update data in. Expected formats are [`:resource`](https://jsonapi.org/format/#document-resource-objects), [`:resource/:id`](https://jsonapi.org/format/#document-resource-objects), [`:resource/:id/:relationship`](https://jsonapi.org/format/#document-resource-object-relationships) or [`:resource/:id/relationships/:relationship`](https://jsonapi.org/format/#document-resource-object-linkage)
 -   `body` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) \| [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>)** Data to send in the request
@@ -550,3 +550,3 @@ -   `headers` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Additional headers to send with the request (optional, default `{}`)
 
-[packages/kitsu/src/index.js:290-309](https://github.com/wopian/kitsu/blob/4b9e7a9ad43911a4d6a89b8bdc21babfc50a9239/packages/kitsu/src/index.js#L290-L309 "Source code on GitHub")
+[packages/kitsu/src/index.js:290-309](https://github.com/wopian/kitsu/blob/0f971ed3ac43c77265611d07eaadabf961baf066/packages/kitsu/src/index.js#L290-L309 "Source code on GitHub")
 
@@ -557,3 +557,3 @@ Create a new resource (alias `create`)
 
--   `model` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Model to create a resource under
+-   `model` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Resource to create. Expected formats are [`:resource`](https://jsonapi.org/format/#document-resource-objects), [`:resource/:id`](https://jsonapi.org/format/#document-resource-objects), [`:resource/:id/:relationship`](https://jsonapi.org/format/#document-resource-object-relationships) or [`:resource/:id/relationships/:relationship`](https://jsonapi.org/format/#document-resource-object-linkage)
 -   `body` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) \| [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>)** Data to send in the request
@@ -595,3 +595,3 @@ -   `headers` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Additional headers to send with the request (optional, default `{}`)
 
-[packages/kitsu/src/index.js:324-353](https://github.com/wopian/kitsu/blob/4b9e7a9ad43911a4d6a89b8bdc21babfc50a9239/packages/kitsu/src/index.js#L324-L353 "Source code on GitHub")
+[packages/kitsu/src/index.js:324-353](https://github.com/wopian/kitsu/blob/0f971ed3ac43c77265611d07eaadabf961baf066/packages/kitsu/src/index.js#L324-L353 "Source code on GitHub")
 
@@ -602,3 +602,3 @@ Remove a resource (alias `remove`)
 
--   `model` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Model to remove data from
+-   `model` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Resource to remove. Expected formats are [`:resource`](https://jsonapi.org/format/#document-resource-objects), [`:resource/:id/:relationship`](https://jsonapi.org/format/#document-resource-object-relationships) or [`:resource/:id/relationships/:relationship`](https://jsonapi.org/format/#document-resource-object-linkage)
 -   `id` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) \| [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) \| [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)>)** Resource ID to remove. Pass an array of IDs to delete multiple resources (Bulk Extension)
@@ -627,3 +627,3 @@ -   `headers` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Additional headers to send with the request (optional, default `{}`)
 
-[packages/kitsu/src/index.js:375-382](https://github.com/wopian/kitsu/blob/4b9e7a9ad43911a4d6a89b8bdc21babfc50a9239/packages/kitsu/src/index.js#L375-L382 "Source code on GitHub")
+[packages/kitsu/src/index.js:375-382](https://github.com/wopian/kitsu/blob/0f971ed3ac43c77265611d07eaadabf961baf066/packages/kitsu/src/index.js#L375-L382 "Source code on GitHub")
 
@@ -665,3 +665,3 @@ Get the authenticated user's data
 
-[packages/kitsu/src/index.js:443-463](https://github.com/wopian/kitsu/blob/4b9e7a9ad43911a4d6a89b8bdc21babfc50a9239/packages/kitsu/src/index.js#L443-L463 "Source code on GitHub")
+[packages/kitsu/src/index.js:443-463](https://github.com/wopian/kitsu/blob/0f971ed3ac43c77265611d07eaadabf961baf066/packages/kitsu/src/index.js#L443-L463 "Source code on GitHub")
 
@@ -769,4 +769,2 @@ Send arbitrary requests
 
-[json:api]: http://jsonapi.org
-
 [promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises
@@ -778,4 +776,2 @@
 
-[migration guide]: https://github.com/wopian/kitsu/blob/master/packages/kitsu/MIGRATING.md
-
 [changelog]: https://github.com/wopian/kitsu/blob/master/packages/kitsu/CHANGELOG.md
@@ -782,0 +778,0 @@

types/index.d.ts

@@ -101,3 +101,3 @@ /**
      * @memberof Kitsu
-     * @param {string} model Model to fetch data from
+     * @param {string} model Resource to fetch data from. Expected formats are [`:resource`](https://jsonapi.org/format/#document-resource-objects), [`:resource/:id`](https://jsonapi.org/format/#document-resource-objects), [`:resource/:id/:relationship`](https://jsonapi.org/format/#document-resource-object-relationships) or [`:resource/:id/relationships/:relationship`](https://jsonapi.org/format/#document-resource-object-linkage)
      * @param {Object} [params] JSON-API request queries. Any JSON:API query parameter not mentioned below is supported out of the box.
@@ -190,3 +190,3 @@ * @param {Object} [params.page] [JSON:API Pagination](http://jsonapi.org/format/#fetching-pagination). All pagination strategies are supported, even if they are not listed below.
      * @memberof Kitsu
-     * @param {string} model Model to update data in
+     * @param {string} model Resource to update data in. Expected formats are [`:resource`](https://jsonapi.org/format/#document-resource-objects), [`:resource/:id`](https://jsonapi.org/format/#document-resource-objects), [`:resource/:id/:relationship`](https://jsonapi.org/format/#document-resource-object-relationships) or [`:resource/:id/relationships/:relationship`](https://jsonapi.org/format/#document-resource-object-linkage)
      * @param {Object|Object[]} body Data to send in the request
@@ -223,3 +223,3 @@ * @param {Object} [headers] Additional headers to send with the request
      * @memberof Kitsu
-     * @param {string} model Model to create a resource under
+     * @param {string} model Resource to create. Expected formats are [`:resource`](https://jsonapi.org/format/#document-resource-objects), [`:resource/:id`](https://jsonapi.org/format/#document-resource-objects), [`:resource/:id/:relationship`](https://jsonapi.org/format/#document-resource-object-relationships) or [`:resource/:id/relationships/:relationship`](https://jsonapi.org/format/#document-resource-object-linkage)
      * @param {Object|Object[]} body Data to send in the request
@@ -251,3 +251,3 @@ * @param {Object} [headers] Additional headers to send with the request
      * @memberof Kitsu
-     * @param {string} model Model to remove data from
+     * @param {string} model Resource to remove. Expected formats are [`:resource`](https://jsonapi.org/format/#document-resource-objects), [`:resource/:id/:relationship`](https://jsonapi.org/format/#document-resource-object-relationships) or [`:resource/:id/relationships/:relationship`](https://jsonapi.org/format/#document-resource-object-linkage)
      * @param {string|number|number[]} id Resource ID to remove. Pass an array of IDs to delete multiple resources (Bulk Extension)
@@ -254,0 +254,0 @@ * @param {Object} [headers] Additional headers to send with the request

No alert changes

Improved metrics

Total package byte prevSize

67773

increased by5.54%

Lines of code

382

increased by1.06%

Worsened metrics

Number of lines in readme file

766

decreased by-0.52%

Dependency changes

• Updatedkitsu-core@^9.1.14