kitsu - npm Package Compare versions

Comparing version 9.1.2 to 9.1.3

CHANGELOG.md

@@ -6,2 +6,18 @@ # Change Log
 
+## [9.1.3](https://github.com/wopian/kitsu/tree/master/packages/kitsu/compare/v9.1.2...v9.1.3) (2020-05-21)
+
+
+### Chores
+
+* **release:** update documentation ([de730f2](https://github.com/wopian/kitsu/tree/master/packages/kitsu/commit/de730f2))
+
+
+### Documentation Changes
+
+* **kitsu:** add clearing of to-one/to-many relationships to api.patch examples ([113e60f](https://github.com/wopian/kitsu/tree/master/packages/kitsu/commit/113e60f))
+
+
+
+
+
 ## [9.1.2](https://github.com/wopian/kitsu/tree/master/packages/kitsu/compare/v9.1.1...v9.1.2) (2020-05-21)
@@ -8,0 +24,0 @@

package.json

 {
-  "version": "9.1.2",
+  "version": "9.1.3",
   "name": "kitsu",
@@ -51,3 +51,3 @@ "description": "Simple & lightweight JSON-API client for Kitsu and other compliant APIs",
     "axios": "^0.19.0",
-    "kitsu-core": "^9.1.2",
+    "kitsu-core": "^9.1.3",
     "pluralize": "^8.0.0"
@@ -65,3 +65,3 @@ },
   ],
-  "gitHead": "dd4bc433ae7bc4e620fd057db7eb1613fdb30752",
+  "gitHead": "f231b36c3985820fdbb6e43d75aea512df4e8cab",
   "devDependencies": {
@@ -68,0 +68,0 @@ "@size-limit/preset-small-lib": "~4.5.0"

README.md

@@ -216,3 +216,3 @@ <h1 align=center>Kitsu</h1>
 
-[packages/kitsu/src/index.js:30-447](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L30-L447 "Source code on GitHub")
+[packages/kitsu/src/index.js:30-459](https://github.com/wopian/kitsu/blob/113e60fa60d3029df81c36741703748635470cd6/packages/kitsu/src/index.js#L30-L459 "Source code on GitHub")
 
@@ -264,3 +264,3 @@ Creates a new `kitsu` instance
 
-[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
+[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/113e60fa60d3029df81c36741703748635470cd6/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
 
@@ -287,3 +287,3 @@ -   **See: <https://www.npmjs.com/package/pluralize> for documentation
 
-[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
+[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/113e60fa60d3029df81c36741703748635470cd6/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
 
@@ -319,3 +319,3 @@ Get the current headers or add additional headers
 
-[packages/kitsu/src/index.js:112-112](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L112-L112 "Source code on GitHub")
+[packages/kitsu/src/index.js:112-112](https://github.com/wopian/kitsu/blob/113e60fa60d3029df81c36741703748635470cd6/packages/kitsu/src/index.js#L112-L112 "Source code on GitHub")
 
@@ -371,3 +371,3 @@ -   **See: <https://github.com/axios/axios#interceptors> for documentation
 
-[packages/kitsu/src/index.js:185-204](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L185-L204 "Source code on GitHub")
+[packages/kitsu/src/index.js:185-204](https://github.com/wopian/kitsu/blob/113e60fa60d3029df81c36741703748635470cd6/packages/kitsu/src/index.js#L185-L204 "Source code on GitHub")
 
@@ -484,3 +484,3 @@ Fetch resources (alias `fetch`)
 
-[packages/kitsu/src/index.js:225-245](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L225-L245 "Source code on GitHub")
+[packages/kitsu/src/index.js:237-257](https://github.com/wopian/kitsu/blob/113e60fa60d3029df81c36741703748635470cd6/packages/kitsu/src/index.js#L237-L257 "Source code on GitHub")
 
@@ -497,3 +497,3 @@ Update a resource (alias `update`)
 
-Update a post
+Update a resource
 
@@ -508,2 +508,29 @@
 
+Update a resource with relationships
+
+
+```javascript
+api.update('posts', {
+  content: 'Hello World',
+  uploads: {
+    id: '167585',
+    type: 'uploads'
+  }
+})
+```
+
+Clear to-one relationships from a resource
+
+
+```javascript
+api.update('posts/1/relationships/uploads', null)
+```
+
+Clear to-many relationships from a resource
+
+
+```javascript
+api.update('posts/1/relationships/uploads', [])
+```
+
 Update multiple resources (API must support the Bulk Extension)
@@ -523,3 +550,3 @@
 
-[packages/kitsu/src/index.js:273-292](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L273-L292 "Source code on GitHub")
+[packages/kitsu/src/index.js:285-304](https://github.com/wopian/kitsu/blob/113e60fa60d3029df81c36741703748635470cd6/packages/kitsu/src/index.js#L285-L304 "Source code on GitHub")
 
@@ -567,3 +594,3 @@ Create a new resource (alias `create`)
 
-[packages/kitsu/src/index.js:307-336](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L307-L336 "Source code on GitHub")
+[packages/kitsu/src/index.js:319-348](https://github.com/wopian/kitsu/blob/113e60fa60d3029df81c36741703748635470cd6/packages/kitsu/src/index.js#L319-L348 "Source code on GitHub")
 
@@ -598,3 +625,3 @@ Remove a resource (alias `remove`)
 
-[packages/kitsu/src/index.js:358-365](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L358-L365 "Source code on GitHub")
+[packages/kitsu/src/index.js:370-377](https://github.com/wopian/kitsu/blob/113e60fa60d3029df81c36741703748635470cd6/packages/kitsu/src/index.js#L370-L377 "Source code on GitHub")
 
@@ -636,3 +663,3 @@ Get the authenticated user's data
 
-[packages/kitsu/src/index.js:426-446](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L426-L446 "Source code on GitHub")
+[packages/kitsu/src/index.js:438-458](https://github.com/wopian/kitsu/blob/113e60fa60d3029df81c36741703748635470cd6/packages/kitsu/src/index.js#L438-L458 "Source code on GitHub")
 
@@ -639,0 +666,0 @@ Send arbitrary requests

types/index.d.ts

@@ -181,3 +181,3 @@ /**
      * @returns {Object|Object[]} JSON-parsed response
-     * @example <caption>Update a post</caption>
+     * @example <caption>Update a resource</caption>
      * api.update('posts', {
@@ -187,2 +187,14 @@ *   id: '1',
      * })
+     * @example <caption>Update a resource with relationships</caption>
+     * api.update('posts', {
+     *   content: 'Hello World',
+     *   uploads: {
+     *     id: '167585',
+     *     type: 'uploads'
+     *   }
+     * })
+     * @example <caption>Clear to-one relationships from a resource</caption>
+     * api.update('posts/1/relationships/uploads', null)
+     * @example <caption>Clear to-many relationships from a resource</caption>
+     * api.update('posts/1/relationships/uploads', [])
      * @example <caption>Update multiple resources (API must support the Bulk Extension)</caption>
@@ -189,0 +201,0 @@ * api.update('posts', [

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

626908

increased by0.22%

Lines of code

366

increased by3.39%

Number of lines in readme file

770

increased by3.63%

Number of medium supply chain risk alerts

0

decreased by-100%

Dependency changes

• Updatedkitsu-core@^9.1.3