docs(kitsu-core): add 9.0.0 migration guide

Author: wopian

packages/kitsu-core/MIGRATING.md

@@ -1,7 +1,131 @@
 # Migration Guides
 
+## Migrating to `9.0.0`
+
+### Deserialising
+
+`deserialise` and `linkRelationships` have been refactored. They now preserve `link` objects from relationships and match the structure of the root `data` object/array.
+- Root `data` self links are avaiable as `data.links` or `data[].links`
+- Relationship objects are now `relationshipName.data.id` from `relationshipName.id`
+- Relationship arrays are now `relationshipName.data[].id` from `relationshipName[].id`
+- Relationship links are avaiable as `relationshipName.links`
+
+For the full change in behaviour, see the legacy and new outputs below.
+
+#### Legacy Behaviour
+
+Input:
+
+```js
+data: {
+  id: '1',
+  type: 'libraryEntries'
+  links: {
+    self: 'https://kitsu.io/api/edge/library-entries/1'
+  },
+  attributes: {
+    ratingTwenty: 10
+  },
+  relationships: {
+    user: {
+      links: {
+        self: 'https://kitsu.io/api/edge/library-entries/1/relationships/user',
+        related: 'https://kitsu.io/api/edge/library-entries/1/user'
+      },
+      data: {
+        id: '2',
+        type: 'users'
+      }
+    }
+  }
+},
+included: [
+  {
+    id: '2',
+    type: 'users',
+    links: {
+      self: 'https://kitsu.io/api/edge/users/2'
+    },
+    attributes: {
+      name: 'Example'
+    }
+  }
+```
+
+Output:
+
+```js
+data: {
+  id: '1',
+  type: 'libraryEntries',
+  ratingTwenty: 10,
+  user: {
+    id: '2',
+    type: 'users',
+    name: 'Example'
+  }
+}
+```
+
+#### New Behaviour
+
+
+Output with same input data as legacy behaviour:
+
+```js
+data: {
+  id: '1',
+  type: 'libraryEntries',
+  links: {
+    self: 'https://kitsu.io/api/edge/library-entries/1'
+  },
+  ratingTwenty: 10,
+  user: {
+    links: {
+      self: 'https://kitsu.io/api/edge/library-entries/1/relationships/user',
+      related: 'https://kitsu.io/api/edge/library-entries/1/user'
+    }
+    data: {
+      id: '2',
+      type: 'users',
+      links: {
+        self: 'https://kitsu.io/api/edge/users/2'
+      },
+      name: 'Example'
+    }
+  }
+}
+```
+
+### Serialising
+
+`serialise` has been refactored. It now passes camel case and pluralisation options as argument options. Options are 100% optional and will default to no conversion or pluralisation (e.g libraryEntry -> libraryEntry).
+
+#### Legacy Syntax
+
+```js
+import { serialise, camel, kebab } from 'kitsu-core'
+import plural from 'pluralize'
+
+serialise.apply({ camel, resCase: kebab, plural }, [ model, obj, 'PATCH' ])
+```
+
+#### New Syntax
+
+```js
+import { serialise, camel } from 'kitsu-core'
+import plural from 'pluralize'
+
+serialise(model, obj, 'PATCH', {
+  camelCaseTypes: camel,
+  pluralTypes: plural
+})
+```
+
 ## Migrating to `8.0.0`
 
+Dropped Node 8 support. Lowest supported version is now Node 10.
+
 `kitsu-core/node` has been removed as it is now identical to`kitsu-core`.
 
 - Replace `kitsu-core/node` imports with `kitsu-core`

packages/kitsu-core/README.md

@@ -38,7 +38,7 @@
 
 |       Package | Package<br> Size\* | Node | Chrome | Firefox | Safari | Edge |
 | ------------: | :----------------: | :--: | :----: | :-----: | :----: | :--: |
-| `kitsu-core`† |      ≤ 1.3 kb      |  10+ |   79+  |   68+   |  12.1+ |  18+ |
+| `kitsu-core`† |      ≤ 1.4 kb      |  10+ |   79+  |   68+   |  12.1+ |  18+ |
 
 \* Including all dependencies, minified & gzipped<br>
 

packages/kitsu-core/package.json

@@ -41,15 +41,15 @@
   "size-limit": [
     {
       "path": "./lib/index.js",
-      "limit": "1.4 kb"
+      "limit": "1.5 kb"
     },
     {
       "path": "./lib/index.mjs",
-      "limit": "1.4 kb"
+      "limit": "1.5 kb"
     },
     {
       "path": "./lib/index.browser.js",
-      "limit": "1.4 kb"
+      "limit": "1.5 kb"
     }
   ],
   "gitHead": "5c9778d191d17d7c9790cfc6d0f4e983b4742a53",