ts-japi 1.6.0 → 1.6.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 1.6.2
+
+### Patch Changes
+
+- c5a8201: Add customisable relationship names
+
+## 1.6.1
+
+### Patch Changes
+
+- d5cd4d1: Updated dependencies
+
 ## 1.6.0
 
 ### Minor Changes
@@ -18,7 +30,7 @@
 
 ### Minor Changes
 
-- Fixes https://github.com/mu-io/ts-japi/issues/23
+- Fixes https://github.com/mathematic-inc/ts-japi/issues/23
 
 ## 1.4.0
 

package/Makefile

@@ -1,33 +1,7 @@
 PATH:=$(PATH):$(PWD)/node_modules/.bin
 SHELL:=env PATH=$(PATH) /bin/bash
 
-all: lib docs README.md
-
-lib: $(shell find src -name '*.ts')
-	@echo 'Building library...'
-	@tsc
-
-docs: $(shell find src -name '*.ts')
-	@echo 'Building documentation...'
-	@typedoc
-	@rsync -a ./src/docs/assets ./docs
-
-README.md: src/docs/README.md
-	@echo 'Building README...'
-	@typedoc --plugin typedoc-plugin-markdown --out ./md-docs --theme markdown
-	@mv md-docs/README.md README.md
-	@rm -rf md-docs
-	@ts-node scripts/readme-postbuild.ts
-
-clean: clean-docs clean-readme clean-build clean-coverage
-
-clean-docs:
-	@echo 'Cleaning documentation...'
-	@rm -rf ./docs
-
-clean-readme:
-	@echo 'Cleaning README...'
-	@rm -rf ./readme
+clean: clean-build clean-coverage
 
 clean-lib:
 	@echo 'Cleaning build artifacts...'

package/README.md

@@ -1,46 +1,51 @@
-ts-japi / [Exports](modules.html)
+# ts:japi
 
-<br />
-<img src="https://raw.githubusercontent.com/mu-io/ts-japi/master/docs/assets/images/logo.svg" alt="{ts:japi}" width="350"/>
-<br/><br/>
+<br/>
+<img src="https://raw.githubusercontent.com/mathematic-inc/ts-japi/master/docs/assets/images/logo.svg" alt="{ts:japi}" width="350"/>
+<br/>
 
 ![node-current](https://img.shields.io/node/v/ts-japi)
 [![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
-> A highly-modular (typescript-friendly)-framework agnostic library for serializing data to the JSON:API specification
-
-- [Features](#features)
-- [Documentation](#documentation)
-- [Installation](#installation)
-- [Getting Started](#getting-started)
-  - [Examples](#examples)
-- [Serialization](#serialization)
-  - [Links](#links)
-    - [Pagination](#pagination)
-  - [Relationships](#relationships)
-  - [Metadata](#metadata)
-  - [Serializing Errors](#serializing-errors)
-  - [Caching](#caching)
-- [Deserialization](#deserialization)
-- [Remarks](#remarks)
-- [FAQ](#faq)
-- [For Developers](#for-developers)
-- [Contributing](#contributing)
-- [License](#license)
+> A highly-modular (typescript-friendly)-framework agnostic library for serializing data to the
+> JSON:API specification
+
+- [ts:japi](#tsjapi)
+  - [Features](#features)
+  - [Documentation](#documentation)
+  - [Installation](#installation)
+  - [Getting Started](#getting-started)
+    - [Examples](#examples)
+  - [Serialization](#serialization)
+    - [Links](#links)
+      - [Pagination](#pagination)
+    - [Relationships](#relationships)
+    - [Metadata](#metadata)
+    - [Serializing Errors](#serializing-errors)
+    - [Caching](#caching)
+  - [Deserialization](#deserialization)
+  - [Remarks](#remarks)
+  - [FAQ](#faq)
+  - [For Developers](#for-developers)
+  - [Contributing](#contributing)
+  - [License](#license)
 
 ## Features
 
-- This is the **only** typescript-compatible library that fully types the JSON:API specification and performs *proper* serialization. 
+- This is the **only** typescript-compatible library that fully types the JSON:API specification and
+  performs _proper_ serialization.
 - [**Zero dependencies**](#zdg).
 - This is the **only** library with [resource recursion](#wirr).
-- The modular framework laid out here *highly promotes* the specifications intentions:
+- The modular framework laid out here _highly promotes_ the specifications intentions:
   - Using links is no longer obfuscated.
   - Meta can truly be placed anywhere with possible dependencies laid out visibly.
-- This library is designed to adhere to the specifications "never remove, only add" policy, so we will remain backwards-compatible.
+- This library is designed to adhere to the specifications "never remove, only add" policy, so we
+  will remain backwards-compatible.
 
 ## Documentation
 
-The [documentation](https://mu-io.github.io/ts-japi) has everything that is covered here and more.
+The [documentation](https://mathematic-inc.github.io/ts-japi/) has everything that is covered here
+and more.
 
 ## Installation
 
@@ -54,25 +59,38 @@ npm install ts-japi
 
 There are fives classes that are used to serialize data (only one of which is necessarily required).
 
-- [`Serializer`](https://mu-io.github.io/ts-japi/classes/serializer.html) with [`SerializerOptions`](https://mu-io.github.io/ts-japi/interfaces/serializeroptions.html)
-- [`Relator`](https://mu-io.github.io/ts-japi/classes/relator.html) with [`RelatorOptions`](https://mu-io.github.io/ts-japi/interfaces/relatoroptions.html)
-- [`Linker`](https://mu-io.github.io/ts-japi/classes/linker.html) with [`LinkerOptions`](https://mu-io.github.io/ts-japi/interfaces/linkeroptions.html)
-- [`Metaizer`](https://mu-io.github.io/ts-japi/classes/metaizer.html)
-- [`Paginator`](https://mu-io.github.io/ts-japi/classes/paginator.html)
-- [`ErrorSerializer`](https://mu-io.github.io/ts-japi/classes/errorserializer.html) with [`ErrorSerializerOptions`](https://mu-io.github.io/ts-japi/interfaces/errorserializeroptions.html)
-- **NEW** [`Cache`](https://mu-io.github.io/ts-japi/classes/cache.html) with [`CacheOptions`](https://mu-io.github.io/ts-japi/interfaces/cacheoptions.html)
-
-You can check the [documentation](https://mu-io.github.io/ts-japi) for a deeper insight into the usage.
+- [`Serializer`](https://mathematic-inc.github.io/ts-japi/classes/serializer.html) with
+  [`SerializerOptions`](https://mathematic-inc.github.io/ts-japi/interfaces/serializeroptions.html)
+- [`Relator`](https://mathematic-inc.github.io/ts-japi/classes/relator.html) with
+  [`RelatorOptions`](https://mathematic-inc.github.io/ts-japi/interfaces/relatoroptions.html)
+- [`Linker`](https://mathematic-inc.github.io/ts-japi/classes/linker.html) with
+  [`LinkerOptions`](https://mathematic-inc.github.io/ts-japi/interfaces/linkeroptions.html)
+- [`Metaizer`](https://mathematic-inc.github.io/ts-japi/classes/metaizer.html)
+- [`Paginator`](https://mathematic-inc.github.io/ts-japi/classes/paginator.html)
+- [`ErrorSerializer`](https://mathematic-inc.github.io/ts-japi/classes/errorserializer.html) with
+  [`ErrorSerializerOptions`](https://mathematic-inc.github.io/ts-japi/interfaces/errorserializeroptions.html)
+- [`Cache`](https://mathematic-inc.github.io/ts-japi/classes/cache.html) with
+  [`CacheOptions`](https://mathematic-inc.github.io/ts-japi/interfaces/cacheoptions.html)
+
+You can check the [documentation](https://mathematic-inc.github.io/ts-japi) for a deeper insight
+into the usage.
 
 ### Examples
 
-You can check the [examples](https://github.com/mu-io/ts-japi/tree/master/examples) and the [test](https://github.com/mu-io/ts-japi/tree/master/test) folders to see some examples (such as the ones below). You can check [this example](https://github.com/mu-io/ts-japi/blob/master/examples/full.example.ts) to see almost every option of [`Serializer`](https://mu-io.github.io/ts-japi/classes/serializer.html) exhausted.
+You can check the [examples](https://github.com/mathematic-inc/ts-japi/tree/master/examples) and the
+[test](https://github.com/mathematic-inc/ts-japi/tree/master/test) folders to see some examples
+(such as the ones below). You can check
+[this example](https://github.com/mathematic-inc/ts-japi/blob/master/examples/full.example.ts) to
+see almost every option of
+[`Serializer`](https://mathematic-inc.github.io/ts-japi/classes/serializer.html) exhausted.
 
 ## Serialization
 
-The [`Serializer`](https://mu-io.github.io/ts-japi/classes/serializer.html) class is the only class required for basic serialization.
+The [`Serializer`](https://mathematic-inc.github.io/ts-japi/classes/serializer.html) class is the
+only class required for basic serialization.
 
-The following example constructs the most basic [`Serializer`](https://mu-io.github.io/ts-japi/classes/serializer.html): (Note the `await`)
+The following example constructs the most basic
+[`Serializer`](https://mathematic-inc.github.io/ts-japi/classes/serializer.html): (Note the `await`)
 
 ```typescript
 import { Serializer } from '../src';
@@ -99,14 +117,16 @@ const UserSerializer = new Serializer('users');
   //  }
   // }
 })();
-
 ```
 
 ### Links
 
-The [`Linker`](https://mu-io.github.io/ts-japi/classes/linker.html) class is used to generate a normalized [document link](https://jsonapi.org/format/#document-links). Its methods are not meant to be called. See the [FAQ](#faq) for reasons.
+The [`Linker`](https://mathematic-inc.github.io/ts-japi/classes/linker.html) class is used to
+generate a normalized [document link](https://jsonapi.org/format/#document-links). Its methods are
+not meant to be called. See the [FAQ](#faq) for reasons.
 
-The following example constructs a [`Linker`](https://mu-io.github.io/ts-japi/classes/linker.html) for `User`s and `Article`s:
+The following example constructs a
+[`Linker`](https://mathematic-inc.github.io/ts-japi/classes/linker.html) for `User`s and `Article`s:
 
 ```typescript
 import { Linker } from '../src';
@@ -130,14 +150,16 @@ const UserArticleLinker = new Linker((user: User, articles: Article | Article[])
 
   // Output: https://www.example.com/users/sample_user_id/articles/same_article_id
 })();
-
 ```
 
 #### Pagination
 
-The [`Paginator`](https://mu-io.github.io/ts-japi/classes/paginator.html) class is used to generate [pagination links](https://jsonapi.org/format/#fetching-pagination). Its methods are not meant to be called.
+The [`Paginator`](https://mathematic-inc.github.io/ts-japi/classes/paginator.html) class is used to
+generate [pagination links](https://jsonapi.org/format/#fetching-pagination). Its methods are not
+meant to be called.
 
-The following example constructs a [`Paginator`](https://mu-io.github.io/ts-japi/classes/paginator.html):
+The following example constructs a
+[`Paginator`](https://mathematic-inc.github.io/ts-japi/classes/paginator.html):
 
 ```typescript
 import { Paginator } from '../src';
@@ -172,16 +194,25 @@ const ArticlePaginator = new Paginator((articles: Article | Article[]) => {
   //  next: null
   // }
 })();
-
 ```
 
 ### Relationships
 
-The [`Relator`](https://mu-io.github.io/ts-japi/classes/relator.html) class is used to generate top-level [included data](https://jsonapi.org/format/#document-top-level) as well as resource-level [relationships](https://jsonapi.org/format/#document-resource-object-relationships). Its methods are not meant to be called.
+The [`Relator`](https://mathematic-inc.github.io/ts-japi/classes/relator.html) class is used to
+generate top-level [included data](https://jsonapi.org/format/#document-top-level) as well as
+resource-level [relationships](https://jsonapi.org/format/#document-resource-object-relationships).
+Its methods are not meant to be called.
 
-[`Relator`](https://mu-io.github.io/ts-japi/classes/relator.html)s may also take optional [`Linker`](https://mu-io.github.io/ts-japi/classes/linker.html)s (using the [`linker`](https://mu-io.github.io/ts-japi/interfaces/relatoroptions.html#linkers) option) to define [relationship links](https://jsonapi.org/format/#document-resource-object-relationships) and [related resource links](https://jsonapi.org/format/#document-resource-object-related-resource-links).
+[`Relator`](https://mathematic-inc.github.io/ts-japi/classes/relator.html)s may also take optional
+[`Linker`](https://mathematic-inc.github.io/ts-japi/classes/linker.html)s (using the
+[`linker`](https://mathematic-inc.github.io/ts-japi/interfaces/relatoroptions.html#linkers) option)
+to define [relationship links](https://jsonapi.org/format/#document-resource-object-relationships)
+and
+[related resource links](https://jsonapi.org/format/#document-resource-object-related-resource-links).
 
-The following example constructs a [`Relator`](https://mu-io.github.io/ts-japi/classes/relator.html) for `User`s and `Article`s:
+The following example constructs a
+[`Relator`](https://mathematic-inc.github.io/ts-japi/classes/relator.html) for `User`s and
+`Article`s:
 
 ```typescript
 import { Serializer, Relator } from '../src';
@@ -205,21 +236,24 @@ const UserArticleRelator = new Relator<User, Article>(
 
   // Output: { data: [ { type: 'articles', id: 'same_article_id' } ] }
 })();
-
 ```
 
 ### Metadata
 
-The [`Metaizer`](https://mu-io.github.io/ts-japi/classes/metaizer.html) class is used to construct generate metadata given some dependencies. There are several locations [`Metaizer`](https://mu-io.github.io/ts-japi/classes/metaizer.html) can be used:
+The [`Metaizer`](https://mathematic-inc.github.io/ts-japi/classes/metaizer.html) class is used to
+construct generate metadata given some dependencies. There are several locations
+[`Metaizer`](https://mathematic-inc.github.io/ts-japi/classes/metaizer.html) can be used:
 
-- [`ErrorSerializerOptions.metaizers`](https://mu-io.github.io/ts-japi/interfaces/errorserializeroptions.html#metaizers)
-- [`RelatorOptions.metaizer`](https://mu-io.github.io/ts-japi/interfaces/relatoroptions.html#metaizer)
-- [`SerializerOptions.metaizers`](https://mu-io.github.io/ts-japi/interfaces/serializeroptions.html#metaizers)
-- [`LinkerOptions.metaizer`](https://mu-io.github.io/ts-japi/interfaces/linkeroptions.html#metaizer)
+- [`ErrorSerializerOptions.metaizers`](https://mathematic-inc.github.io/ts-japi/interfaces/errorserializeroptions.html#metaizers)
+- [`RelatorOptions.metaizer`](https://mathematic-inc.github.io/ts-japi/interfaces/relatoroptions.html#metaizer)
+- [`SerializerOptions.metaizers`](https://mathematic-inc.github.io/ts-japi/interfaces/serializeroptions.html#metaizers)
+- [`LinkerOptions.metaizer`](https://mathematic-inc.github.io/ts-japi/interfaces/linkeroptions.html#metaizer)
 
-Like [`Linker`](https://mu-io.github.io/ts-japi/classes/linker.html), its methods are not meant to be called.
+Like [`Linker`](https://mathematic-inc.github.io/ts-japi/classes/linker.html), its methods are not
+meant to be called.
 
-The following example constructs a [`Metaizer`](https://mu-io.github.io/ts-japi/classes/metaizer.html):
+The following example constructs a
+[`Metaizer`](https://mathematic-inc.github.io/ts-japi/classes/metaizer.html):
 
 ```typescript
 import { User, Article } from '../test/models';
@@ -246,16 +280,25 @@ const UserArticleMetaizer = new Metaizer((user: User, articles: Article | Articl
   //  article_created: '2020-05-20T15:39:43.277Z'
   // }
 })();
-
 ```
 
 ### Serializing Errors
 
-The [`ErrorSerializer`](https://mu-io.github.io/ts-japi/classes/errorserializer.html) class is used to serialize any object considered an error (the [`attributes`](https://mu-io.github.io/ts-japi/interfaces/errorserializeroptions.html#attributes) option allows you to choose what attributes to use during serialization). *Alternatively* (**recommended**), you can construct custom errors by extending the [`JapiError`](https://mu-io.github.io/ts-japi/classes/japierror.html) class and use those for all server-to-client errors.
+The [`ErrorSerializer`](https://mathematic-inc.github.io/ts-japi/classes/errorserializer.html) class
+is used to serialize any object considered an error (the
+[`attributes`](https://mathematic-inc.github.io/ts-japi/interfaces/errorserializeroptions.html#attributes)
+option allows you to choose what attributes to use during serialization). _Alternatively_
+(**recommended**), you can construct custom errors by extending the
+[`JapiError`](https://mathematic-inc.github.io/ts-japi/classes/japierror.html) class and use those
+for all server-to-client errors.
 
-The [error serializer test](https://github.com/mu-io/ts-japi/tree/master/test/error-serializer.test.ts) includes an example of the alternative solution.
+The
+[error serializer test](https://github.com/mathematic-inc/ts-japi/tree/master/test/error-serializer.test.ts)
+includes an example of the alternative solution.
 
-The following example constructs the most basic [`ErrorSerializer`](https://mu-io.github.io/ts-japi/classes/errorserializer.html): (Note the lack of `await`)
+The following example constructs the most basic
+[`ErrorSerializer`](https://mathematic-inc.github.io/ts-japi/classes/errorserializer.html): (Note
+the lack of `await`)
 
 ```typescript
 import { ErrorSerializer } from '../src';
@@ -273,28 +316,45 @@ const PrimitiveErrorSerializer = new ErrorSerializer();
   //  jsonapi: { version: '1.0' }
   // }
 })();
-
 ```
 
 ### Caching
 
-The [`Cache`](https://mu-io.github.io/ts-japi/classes/cache.html) class can be placed in a [`Serializer`](https://mu-io.github.io/ts-japi/classes/serializer.html)'s [`cache`](https://mu-io.github.io/ts-japi/interfaces/serializeroptions.html#cache) option. Alternatively, setting that option to `true` will provide a default [`Cache`](https://mu-io.github.io/ts-japi/classes/cache.html).
+The [`Cache`](https://mathematic-inc.github.io/ts-japi/classes/cache.html) class can be placed in a
+[`Serializer`](https://mathematic-inc.github.io/ts-japi/classes/serializer.html)'s
+[`cache`](https://mathematic-inc.github.io/ts-japi/interfaces/serializeroptions.html#cache) option.
+Alternatively, setting that option to `true` will provide a default
+[`Cache`](https://mathematic-inc.github.io/ts-japi/classes/cache.html).
 
-The default [`Cache`](https://mu-io.github.io/ts-japi/classes/cache.html) uses the basic [`Object.is`](https://mu-io.github.io/ts-japi/https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/is) function to determine if input data are the same. If you want to adjust this, instantiate a new [`Cache`](https://mu-io.github.io/ts-japi/classes/cache.html) with a [`resolver`](https://mu-io.github.io/ts-japi/interfaces/cacheoptions.html#resolver).
+The default [`Cache`](https://mathematic-inc.github.io/ts-japi/classes/cache.html) uses the basic
+[`Object.is`](https://mathematic-inc.github.io/ts-japi/https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/is)
+function to determine if input data are the same. If you want to adjust this, instantiate a new
+[`Cache`](https://mathematic-inc.github.io/ts-japi/classes/cache.html) with a
+[`resolver`](https://mathematic-inc.github.io/ts-japi/interfaces/cacheoptions.html#resolver).
 
 ## Deserialization
 
-We stress the following: Given that there are many clients readily built to consume JSON:API endpoints (see [here](https://jsonapi.org/implementations/)), we do not provide deserialization. In particular, since unmarshalling data is strongly related to the code it will be used in (e.g. React), tighter integration is recommended over an unnecessary abstraction.
+We stress the following: Given that there are many clients readily built to consume JSON:API
+endpoints (see [here](https://jsonapi.org/implementations/)), we do not provide deserialization. In
+particular, since unmarshalling data is strongly related to the code it will be used in (e.g.
+React), tighter integration is recommended over an unnecessary abstraction.
 
 ## Remarks
 
-There are several model classes used inside TS:JAPI such as `Resource` and `Relationships`. These models are used for normalization as well as traversing a JSON:API document. If you plan to fork this repo, you can extend these models and reimplement them to create your own custom (non-standard, extended) serializer.
+There are several model classes used inside TS:JAPI such as `Resource` and `Relationships`. These
+models are used for normalization as well as traversing a JSON:API document. If you plan to fork
+this repo, you can extend these models and reimplement them to create your own custom (non-standard,
+extended) serializer.
 
 ## FAQ
 
-> Why not just allow optional functions that return the internal `Link` Class (or just a URI `string`)?
+> Why not just allow optional functions that return the internal `Link` Class (or just a URI
+> `string`)?
 
-The `Link` class is defined to be as general as possible in case of changes in the specification. In particular, the implementation of metadata and the types in our library rely on the generality of the `Link` class. Relying on user arguments will generate a lot of overhead for both us and users whenever the specs change.
+The `Link` class is defined to be as general as possible in case of changes in the specification. In
+particular, the implementation of metadata and the types in our library rely on the generality of
+the `Link` class. Relying on user arguments will generate a lot of overhead for both us and users
+whenever the specs change.
 
 > Why does the `Meta` class exist if it is essentially just a plain object?
 
@@ -302,22 +362,32 @@ In case the specification is updated to change the meta objects in some function
 
 > What is "resource recursion"?<a id="wirr"></a>
 
-Due to [compound documents](https://jsonapi.org/format/#document-compound-documents), it is possible to recurse through related resources via their [resource linkages](https://jsonapi.org/format/#document-resource-object-linkage) and obtain [included resources](https://jsonapi.org/format/#document-top-level) beyond primary data relations. This is should be done with caution (see [`SerializerOptions.depth`](https://mu-io.github.io/ts-japi/interfaces/serializeroptions.html#depth) and [this example](https://github.com/mu-io/ts-japi/blob/master/examples/resource-recursion.example.ts))
+Due to [compound documents](https://jsonapi.org/format/#document-compound-documents), it is possible
+to recurse through related resources via their
+[resource linkages](https://jsonapi.org/format/#document-resource-object-linkage) and obtain
+[included resources](https://jsonapi.org/format/#document-top-level) beyond primary data relations.
+This is should be done with caution (see
+[`SerializerOptions.depth`](https://mathematic-inc.github.io/ts-japi/interfaces/serializeroptions.html#depth)
+and
+[this example](https://github.com/mathematic-inc/ts-japi/blob/master/examples/resource-recursion.example.ts))
 
 ## For Developers
 
-To get started in developing this library, run `yarn install`, `yarn build` and `yarn test` (in this precise order) to assure everything is in working order.
+To get started in developing this library, run `yarn install`, `yarn build` and `yarn test` (in this
+precise order) to assure everything is in working order.
 
 ## Contributing
 
-This project is maintained by the author, however contributions are welcome and appreciated.
-You can find TS:JAPI on GitHub: [https://github.com/mu-io/ts-japi](https://github.com/mu-io/ts-japi)
+This project is maintained by the author, however contributions are welcome and appreciated. You can
+find TS:JAPI on GitHub:
+[https://github.com/mathematic-inc/ts-japi](https://github.com/mathematic-inc/ts-japi)
 
 Feel free to submit an issue, but please do not submit pull requests unless it is to fix some issue.
-For more information, read the [contribution guide](https://github.com/mu-io/ts-japi/blob/master/CONTRIBUTING.html).
+For more information, read the
+[contribution guide](https://github.com/mathematic-inc/ts-japi/blob/master/CONTRIBUTING.html).
 
 ## License
 
-Copyright © 2020 [mu-io](https://github.com/mu-io).
+Copyright © 2020 [mathematic-inc](https://github.com/mathematic-inc).
 
 Licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0).

package/api-extractor.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts",
+  "apiReport": {
+    "enabled": false
+  },
+  "docModel": {
+    "enabled": true,
+    "apiJsonFilePath": "<projectFolder>/docs/<unscopedPackageName>.api.json"
+  },
+  "dtsRollup": {
+    "enabled": false
+  }
+}

package/lib/classes/cache.d.ts

@@ -18,9 +18,9 @@ export default class Cache<PrimaryType> {
      */
     private resolver;
     /**
-     * Creates a {@linkcode Cache}
+     * Creates a {@link Cache}
      *
-     * @param limit The maximum amount of documents that can be stored before erasure.
+     * @param limit - The maximum amount of documents that can be stored before erasure.
      */
     constructor(options?: Partial<CacheOptions<PrimaryType>>);
     /** @internal Gets a document in the cache */

package/lib/classes/cache.js

@@ -1,69 +1,47 @@
 "use strict";
-var __read = (this && this.__read) || function (o, n) {
-    var m = typeof Symbol === "function" && o[Symbol.iterator];
-    if (!m) return o;
-    var i = m.call(o), r, ar = [], e;
-    try {
-        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
-    }
-    catch (error) { e = { error: error }; }
-    finally {
-        try {
-            if (r && !r.done && (m = i["return"])) m.call(i);
-        }
-        finally { if (e) throw e.error; }
-    }
-    return ar;
-};
-exports.__esModule = true;
-var Cache = /** @class */ (function () {
+Object.defineProperty(exports, "__esModule", { value: true });
+class Cache {
+    /**
+     * The default max for document storage
+     */
+    static defaultLimit = 10;
+    /** @internal The storage for the cache */
+    storage = [];
+    /**
+     * The maximum amount of documents that can be storage before erasure.
+     */
+    limit = Cache.defaultLimit;
     /**
-     * Creates a {@linkcode Cache}
+     * The method to use in determining data equality
+     */
+    resolver = Object.is;
+    /**
+     * Creates a {@link Cache}
      *
-     * @param limit The maximum amount of documents that can be stored before erasure.
+     * @param limit - The maximum amount of documents that can be stored before erasure.
      */
-    function Cache(options) {
-        if (options === void 0) { options = {}; }
-        /** @internal The storage for the cache */
-        this.storage = [];
-        /**
-         * The maximum amount of documents that can be storage before erasure.
-         */
-        this.limit = Cache.defaultLimit;
-        /**
-         * The method to use in determining data equality
-         */
-        this.resolver = Object.is;
+    constructor(options = {}) {
         if (options.limit)
             this.limit = options.limit;
         if (options.resolver)
             this.resolver = options.resolver;
     }
     /** @internal Gets a document in the cache */
-    Cache.prototype.get = function (data, options) {
-        var _this = this;
-        var document = this.storage.find(function (_a) {
-            var _b = __read(_a, 2), storedData = _b[0], storedOptions = _b[1];
-            return _this.resolver(storedData, data) && Object.is(storedOptions, options);
-        });
+    get(data, options) {
+        const document = this.storage.find(([storedData, storedOptions]) => this.resolver(storedData, data) && Object.is(storedOptions, options));
         if (document)
             return document[2];
         else
             return false;
-    };
+    }
     /** @internal Sets a document in the cache */
-    Cache.prototype.set = function (data, document, options) {
+    set(data, document, options) {
         if (this.storage.length > this.limit) {
             this.storage.shift();
         }
         this.storage.push([data, options, document]);
         return document;
-    };
-    /**
-     * The default max for document storage
-     */
-    Cache.defaultLimit = 10;
-    return Cache;
-}());
-exports["default"] = Cache;
+    }
+}
+exports.default = Cache;
 //# sourceMappingURL=cache.js.map

package/lib/classes/cache.js.map

@@ -1 +1 @@
-{"version":3,"file":"cache.js","sourceRoot":"","sources":["../../src/classes/cache.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAKA;IA4BE;;;;OAIG;IACH,eAAmB,OAAgD;QAAhD,wBAAA,EAAA,YAAgD;QA3BnE,0CAA0C;QAClC,YAAO,GAMX,EAAE,CAAC;QAEP;;WAEG;QACK,UAAK,GAAW,KAAK,CAAC,YAAY,CAAC;QAE3C;;WAEG;QACK,aAAQ,GAGD,MAAM,CAAC,EAAE,CAAC;QAQvB,IAAI,OAAO,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC9C,IAAI,OAAO,CAAC,QAAQ;YAAE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IACzD,CAAC;IAED,6CAA6C;IACtC,mBAAG,GAAV,UACE,IAA0C,EAC1C,OAAiD;QAFnD,iBAUC;QANC,IAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAChC,UAAC,EAA2B;gBAA3B,KAAA,aAA2B,EAA1B,UAAU,QAAA,EAAE,aAAa,QAAA;YACzB,OAAA,KAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,aAAa,EAAE,OAAO,CAAC;QAApE,CAAoE,CACvE,CAAC;QACF,IAAI,QAAQ;YAAE,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC;;YAC5B,OAAO,KAAK,CAAC;IACpB,CAAC;IAED,6CAA6C;IACtC,mBAAG,GAAV,UACE,IAA0C,EAC1C,QAA4C,EAC5C,OAAiD;QAEjD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,EAAE;YACpC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;SACtB;QACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC7C,OAAO,QAAQ,CAAC;IAClB,CAAC;IA7DD;;OAEG;IACW,kBAAY,GAAG,EAAE,CAAC;IA2DlC,YAAC;CAAA,AA/DD,IA+DC;qBA/DoB,KAAK"}
+{"version":3,"file":"cache.js","sourceRoot":"","sources":["../../src/classes/cache.ts"],"names":[],"mappings":";;AAKA,MAAqB,KAAK;IACxB;;OAEG;IACI,MAAM,CAAC,YAAY,GAAG,EAAE,CAAC;IAEhC,0CAA0C;IAClC,OAAO,GAMX,EAAE,CAAC;IAEP;;OAEG;IACK,KAAK,GAAW,KAAK,CAAC,YAAY,CAAC;IAE3C;;OAEG;IACK,QAAQ,GAGD,MAAM,CAAC,EAAE,CAAC;IAEzB;;;;OAIG;IACH,YAAmB,UAA8C,EAAE;QACjE,IAAI,OAAO,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC9C,IAAI,OAAO,CAAC,QAAQ;YAAE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IACzD,CAAC;IAED,6CAA6C;IACtC,GAAG,CACR,IAA0C,EAC1C,OAAiD;QAEjD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAChC,CAAC,CAAC,UAAU,EAAE,aAAa,CAAC,EAAE,EAAE,CAC9B,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,aAAa,EAAE,OAAO,CAAC,CACvE,CAAC;QACF,IAAI,QAAQ;YAAE,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC;;YAC5B,OAAO,KAAK,CAAC;IACpB,CAAC;IAED,6CAA6C;IACtC,GAAG,CACR,IAA0C,EAC1C,QAA4C,EAC5C,OAAiD;QAEjD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,EAAE;YACpC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;SACtB;QACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC7C,OAAO,QAAQ,CAAC;IAClB,CAAC;;AA9DH,wBA+DC"}

package/lib/classes/error-serializer.d.ts

@@ -2,7 +2,7 @@ import { ErrorSerializerOptions } from '../interfaces/error-serializer.interface
 import { ErrorDocument } from '../interfaces/json-api.interface';
 import { SingleOrArray } from '../types/global.types';
 /**
- * The {@linkcode ErrorSerializer} class is used to serialize errors.
+ * The {@link ErrorSerializer} class is used to serialize errors.
  *
  * Example:
  * ```typescript
@@ -34,17 +34,17 @@ export default class ErrorSerializer<ErrorType> {
      */
     private options;
     /**
-     * Creates a {@linkcode Serializer}.
+     * Creates a {@link Serializer}.
      *
-     * @param collectionName The name of the collection of objects.
-     * @param options Options for the serializer.
+     * @param collectionName - The name of the collection of objects.
+     * @param options - Options for the serializer.
      */
     constructor(options?: Partial<ErrorSerializerOptions<ErrorType>>);
     /**
      * The actual serialization function.
      *
-     * @param errors Errors to serialize.
-     * @param options Options to use at runtime.
+     * @param errors - Errors to serialize.
+     * @param options - Options to use at runtime.
      */
     serialize(errors: SingleOrArray<ErrorType>, options?: Partial<ErrorSerializerOptions<ErrorType>>): ErrorDocument;
 }