Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
ts-japi - npm Package Compare versions
Comparing version 1.2.5 to 1.2.6
@@ -8,2 +8,9 @@ # Changelog | ||
| ## [1.2.6] - 2020-06-19 | ||
| ### Changed | ||
| * Changed user-level repo to org-level repo. | ||
| * Links have been fixed in docs and README | ||
| ## [1.2.5] - 2020-06-19 | ||
@@ -10,0 +17,0 @@ |
| { | ||
| "name": "ts-japi", | ||
| "version": "1.2.5", | ||
| "version": "1.2.6", | ||
| "description": "A highly-modular (typescript-friendly)-framework agnostic library for serializing data to the JSON:API specification", | ||
@@ -24,3 +24,7 @@ "main": "lib/index.js", | ||
| }, | ||
| "author": "Randolf Chung <rjung@jeongjh.com>", | ||
| "publishConfig": { | ||
| "access": "public", | ||
| "registry": "https://registry.npmjs.org/" | ||
| }, | ||
| "author": "mu.io <dev@mathematic.io>", | ||
| "license": "MIT", | ||
@@ -40,3 +44,3 @@ "keywords": [ | ||
| ], | ||
| "repository": "junsheaf/ts-japi", | ||
| "repository": "mu-io/ts-japi", | ||
| "engines": { | ||
@@ -47,4 +51,4 @@ "node": ">=10" | ||
| "devDependencies": { | ||
| "@babel/cli": "^7.10.4", | ||
| "@babel/core": "^7.10.4", | ||
| "@babel/cli": "^7.10.5", | ||
| "@babel/core": "^7.10.5", | ||
| "@babel/plugin-proposal-class-properties": "^7.10.4", | ||
@@ -56,7 +60,7 @@ "@babel/plugin-proposal-export-namespace-from": "^7.10.4", | ||
| "@types/benchmark": "^1.0.33", | ||
| "@types/jest": "^26.0.3", | ||
| "@types/jest": "^26.0.4", | ||
| "@types/lodash": "^4.14.157", | ||
| "@types/uuid": "^8.0.0", | ||
| "@typescript-eslint/eslint-plugin": "^3.5.0", | ||
| "@typescript-eslint/parser": "^3.5.0", | ||
| "@typescript-eslint/eslint-plugin": "^3.6.1", | ||
| "@typescript-eslint/parser": "^3.6.1", | ||
| "babel-jest": "^26.1.0", | ||
@@ -69,6 +73,6 @@ "benchmark": "^2.1.4", | ||
| "jest": "^26.1.0", | ||
| "lodash": "^4.17.15", | ||
| "lodash": "^4.17.19", | ||
| "prettier": "^2.0.5", | ||
| "regenerator-runtime": "^0.13.5", | ||
| "snyk": "^1.360.0", | ||
| "snyk": "^1.362.0", | ||
| "ts-node": "^8.10.2", | ||
@@ -75,0 +79,0 @@ "typedoc": "^0.17.0-3", |
114
README.md
| <br /> | ||
| <img src="https://raw.githubusercontent.com/jun-sheaf/ts-japi/master/docs/assets/images/logo.svg?token=AIIY45SPCCNXBN5X7P36DU26ZK2AY" alt="{ts:japi}" width="350"/> | ||
| <img src="https://raw.githubusercontent.com/mu-io/ts-japi/master/docs/assets/images/logo.svg" alt="{ts:japi}" width="350"/> | ||
| <br/><br/> | ||
| [](https://travis-ci.com/github/jun-sheaf/ts-japi) | ||
| [](https://codecov.io/gh/jun-sheaf/ts-japi) | ||
| [](https://snyk.io/test/github/jun-sheaf/ts-japi) | ||
| [](https://travis-ci.com/github/mu-io/ts-japi) | ||
| [](https://codecov.io/gh/mu-io/ts-japi) | ||
| [](https://snyk.io/test/github/mu-io/ts-japi) | ||
|  | ||
@@ -13,19 +13,19 @@ [](https://opensource.org/licenses/Apache-2.0) | ||
| - [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) | ||
| - [Contributing](#contributing) | ||
| - [License](#license) | ||
| * [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) | ||
| * [Contributing](#contributing) | ||
| * [License](#license) | ||
@@ -44,3 +44,3 @@ ## Features | ||
| The [documentation](https://jun-sheaf.github.io/ts-japi) has everything that is covered here and more. | ||
| The [documentation](https://mu-io.github.io/ts-japi) has everything that is covered here and more. | ||
@@ -59,21 +59,21 @@ ## Installation | ||
| - [`Serializer`](https://jun-sheaf.github.io/ts-japi/classes/serializer.html) with [`SerializerOptions`](https://jun-sheaf.github.io/ts-japi/interfaces/serializeroptions.html) | ||
| - [`Relator`](https://jun-sheaf.github.io/ts-japi/classes/relator.html) with [`RelatorOptions`](https://jun-sheaf.github.io/ts-japi/interfaces/relatoroptions.html) | ||
| - [`Linker`](https://jun-sheaf.github.io/ts-japi/classes/linker.html) with [`LinkerOptions`](https://jun-sheaf.github.io/ts-japi/interfaces/linkeroptions.html) | ||
| - [`Metaizer`](https://jun-sheaf.github.io/ts-japi/classes/metaizer.html) | ||
| - [`Paginator`](https://jun-sheaf.github.io/ts-japi/classes/paginator.html) | ||
| - [`ErrorSerializer`](https://jun-sheaf.github.io/ts-japi/classes/errorserializer.html) with [`ErrorSerializerOptions`](https://jun-sheaf.github.io/ts-japi/interfaces/errorserializeroptions.html) | ||
| - **NEW** [`Cache`](https://jun-sheaf.github.io/ts-japi/classes/cache.html) with [`CacheOptions`](https://jun-sheaf.github.io/ts-japi/interfaces/cacheoptions.html) | ||
| - [`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://jun-sheaf.github.io/ts-japi) for a deeper insight into the usage. | ||
| You can check the [documentation](https://mu-io.github.io/ts-japi) for a deeper insight into the usage. | ||
| ### Examples | ||
| You can check the [examples](https://github.com/jun-sheaf/ts-japi/tree/master/examples) and the [test](https://github.com/jun-sheaf/ts-japi/tree/master/test) folders to see some examples (such as the ones below). You can check [this example](https://github.com/jun-sheaf/ts-japi/blob/master/examples/full.example.ts) to see almost every option of [`Serializer`](https://jun-sheaf.github.io/ts-japi/classes/serializer.html) exhausted. | ||
| 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. | ||
| ## Serialization | ||
| The [`Serializer`](https://jun-sheaf.github.io/ts-japi/classes/serializer.html) class is the only class required for basic serialization. | ||
| The [`Serializer`](https://mu-io.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://jun-sheaf.github.io/ts-japi/classes/serializer.html): (Note the `await`) | ||
| The following example constructs the most basic [`Serializer`](https://mu-io.github.io/ts-japi/classes/serializer.html): (Note the `await`) | ||
@@ -110,5 +110,5 @@ ```typescript | ||
| The [`Linker`](https://jun-sheaf.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://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 following example constructs a [`Linker`](https://jun-sheaf.github.io/ts-japi/classes/linker.html) for `User`s and `Article`s: | ||
| The following example constructs a [`Linker`](https://mu-io.github.io/ts-japi/classes/linker.html) for `User`s and `Article`s: | ||
@@ -142,5 +142,5 @@ ```typescript | ||
| The [`Paginator`](https://jun-sheaf.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://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 following example constructs a [`Paginator`](https://jun-sheaf.github.io/ts-japi/classes/paginator.html): | ||
| The following example constructs a [`Paginator`](https://mu-io.github.io/ts-japi/classes/paginator.html): | ||
@@ -185,7 +185,7 @@ ```typescript | ||
| The [`Relator`](https://jun-sheaf.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://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. | ||
| [`Relator`](https://jun-sheaf.github.io/ts-japi/classes/relator.html)s may also take optional [`Linker`](https://jun-sheaf.github.io/ts-japi/classes/linker.html)s (using the [`linker`](https://jun-sheaf.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://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). | ||
| The following example constructs a [`Relator`](https://jun-sheaf.github.io/ts-japi/classes/relator.html) for `User`s and `Article`s: | ||
| The following example constructs a [`Relator`](https://mu-io.github.io/ts-japi/classes/relator.html) for `User`s and `Article`s: | ||
@@ -219,12 +219,12 @@ ```typescript | ||
| The [`Metaizer`](https://jun-sheaf.github.io/ts-japi/classes/metaizer.html) class is used to construct generate metadata given some dependencies. There are several locations [`Metaizer`](https://jun-sheaf.github.io/ts-japi/classes/metaizer.html) can be used: | ||
| 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: | ||
| - [`ErrorSerializerOptions.metaizers`](https://jun-sheaf.github.io/ts-japi/interfaces/errorserializeroptions.html#metaizers) | ||
| - [`RelatorOptions.metaizer`](https://jun-sheaf.github.io/ts-japi/interfaces/relatoroptions.html#optional-metaizer) | ||
| - [`SerializerOptions.metaizers`](https://jun-sheaf.github.io/ts-japi/interfaces/serializeroptions.html#metaizers) | ||
| - [`LinkerOptions.metaizer`](https://jun-sheaf.github.io/ts-japi/interfaces/linkeroptions.html#optional-metaizer) | ||
| - [`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#optional-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#optional-metaizer) | ||
| Like [`Linker`](https://jun-sheaf.github.io/ts-japi/classes/linker.html), its methods are not meant to be called. | ||
| Like [`Linker`](https://mu-io.github.io/ts-japi/classes/linker.html), its methods are not meant to be called. | ||
| The following example constructs a [`Metaizer`](https://jun-sheaf.github.io/ts-japi/classes/metaizer.html): | ||
| The following example constructs a [`Metaizer`](https://mu-io.github.io/ts-japi/classes/metaizer.html): | ||
@@ -261,7 +261,7 @@ ```typescript | ||
| The [`ErrorSerializer`](https://jun-sheaf.github.io/ts-japi/classes/errorserializer.html) class is used to serialize any object considered an error (the [`attributes`](https://jun-sheaf.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://jun-sheaf.github.io/ts-japi/classes/japierror.html) class and use those for all server-to-client 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 [error serializer test](https://github.com/jun-sheaf/ts-japi/tree/master/test/error-serializer.test.ts) includes an example of the alternative solution. | ||
| 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 following example constructs the most basic [`ErrorSerializer`](https://jun-sheaf.github.io/ts-japi/classes/errorserializer.html): (Note the lack of `await`) | ||
| The following example constructs the most basic [`ErrorSerializer`](https://mu-io.github.io/ts-japi/classes/errorserializer.html): (Note the lack of `await`) | ||
@@ -289,5 +289,5 @@ ```typescript | ||
| The [`Cache`](https://jun-sheaf.github.io/ts-japi/classes/cache.html) class can be placed in a [`Serializer`](https://jun-sheaf.github.io/ts-japi/classes/serializer.html)'s [`cache`](https://jun-sheaf.github.io/ts-japi/interfaces/serializeroptions.html#cache) option. Alternatively, setting that option to `true` will provide a default [`Cache`](https://jun-sheaf.github.io/ts-japi/classes/cache.html). | ||
| 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 default [`Cache`](https://jun-sheaf.github.io/ts-japi/classes/cache.html) uses the basic [`Object.is`](https://jun-sheaf.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://jun-sheaf.github.io/ts-japi/classes/cache.html) with a [`resolver`](https://jun-sheaf.github.io/ts-japi/interfaces/cacheoptions.html#resolver). | ||
| 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). | ||
@@ -318,7 +318,7 @@ ## Deserialization | ||
| 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 what the primary data gives. This is not preferable and should be done with caution (see [`SerializerOptions.depth`](https://jun-sheaf.github.io/ts-japi/interfaces/serializeroptions.html#depth) and [this example](https://github.com/jun-sheaf/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 what the primary data gives. This is not preferable and 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)) | ||
| > Is the "zero dependencies" a gimmick?<a id="zdg"></a> | ||
| In general, some packages obtain "zero dependencies" by simply hardcoding packages into their libraries. This can sometimes lead to an undesirable bulk for final consumers of the package. For us, we just couldn't find a package that can do what we do faster. For example, even [`is-plain-object`](https://jun-sheaf.github.io/ts-japi/https://www.npmjs.com/package/is-plain-object) (which is useful, e.g., for identifying classes over "plain" objects) has some unnecessary comparisons that we optimized upon. | ||
| In general, some packages obtain "zero dependencies" by simply hardcoding packages into their libraries. This can sometimes lead to an undesirable bulk for final consumers of the package. For us, we just couldn't find a package that can do what we do faster. For example, even [`is-plain-object`](https://mu-io.github.io/ts-japi/https://www.npmjs.com/package/is-plain-object) (which is useful, e.g., for identifying classes over "plain" objects) has some unnecessary comparisons that we optimized upon. | ||
@@ -328,11 +328,11 @@ ## Contributing | ||
| This project is maintained by the author, however contributions are welcome and appreciated. | ||
| You can find TS:JAPI on GitHub: [https://github.com/jun-sheaf/ts-japi](https://github.com/jun-sheaf/ts-japi) | ||
| You can find TS:JAPI on GitHub: [https://github.com/mu-io/ts-japi](https://github.com/mu-io/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/jun-sheaf/ts-japi/blob/master/CONTRIBUTING.html). | ||
| For more information, read the [contribution guide](https://github.com/mu-io/ts-japi/blob/master/CONTRIBUTING.html). | ||
| ## License | ||
| Copyright © 2020 [jun-sheaf](https://github.com/jun-sheaf). | ||
| Copyright © 2020 [mu-io](https://github.com/mu-io). | ||
| Licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0). |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-0.05%
189441
No dependency changes