ts-japi 1.8.1 → 1.9.0

package/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.8.1"
+  ".": "1.9.0"
 }

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.9.0](https://github.com/mathematic-inc/ts-japi/compare/v1.8.1...v1.9.0) (2023-09-04)
+
+
+### Features
+
+* add polymprphic serializer ([#66](https://github.com/mathematic-inc/ts-japi/issues/66)) ([d440f87](https://github.com/mathematic-inc/ts-japi/commit/d440f87d7241cc2b52db1440b66f87112e0a3807))
+
 ## [1.8.1](https://github.com/mathematic-inc/ts-japi/compare/v1.8.0...v1.8.1) (2023-08-10)
 
 

package/lib/classes/polymorphic-serialiser.d.ts

@@ -0,0 +1,19 @@
+import { DataDocument } from '../interfaces/json-api.interface';
+import { SerializerOptions } from '../interfaces/serializer.interface';
+import ResourceIdentifier from '../models/resource-identifier.model';
+import Resource from '../models/resource.model';
+import { Dictionary, nullish, SingleOrArray } from '../types/global.types';
+import { Helpers } from '../utils/serializer.utils';
+import Relator from './relator';
+import Serializer from './serializer';
+export default class PolymorphicSerializer<PrimaryType extends Dictionary<any>> extends Serializer<PrimaryType> {
+    private serialisers;
+    private key;
+    constructor(commonName: string, key: keyof PrimaryType, serializers: Record<string, Serializer>);
+    serialize(data: SingleOrArray<PrimaryType> | nullish, options?: Partial<SerializerOptions<PrimaryType>>): Promise<Partial<DataDocument<PrimaryType>>>;
+    createIdentifier(data: PrimaryType, options?: SerializerOptions<PrimaryType>): ResourceIdentifier;
+    createResource(data: PrimaryType, options?: Partial<SerializerOptions<PrimaryType>>, helpers?: Helpers<PrimaryType>, relatorDataCache?: Map<Relator<any>, Dictionary<any>[]>): Promise<Resource<PrimaryType>>;
+    private serializeSingle;
+    private getSerializerForData;
+}
+//# sourceMappingURL=polymorphic-serialiser.d.ts.map

package/lib/classes/polymorphic-serialiser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"polymorphic-serialiser.d.ts","sourceRoot":"","sources":["../../src/classes/polymorphic-serialiser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,kBAAkB,MAAM,qCAAqC,CAAC;AACrE,OAAO,QAAQ,MAAM,0BAA0B,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,UAAU,MAAM,cAAc,CAAC;AAEtC,MAAM,CAAC,OAAO,OAAO,qBAAqB,CACxC,WAAW,SAAS,UAAU,CAAC,GAAG,CAAC,CACnC,SAAQ,UAAU,CAAC,WAAW,CAAC;IAC/B,OAAO,CAAC,WAAW,CAA6B;IAEhD,OAAO,CAAC,GAAG,CAAoB;gBAG7B,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,MAAM,WAAW,EACtB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC;IAO5B,SAAS,CACpB,IAAI,EAAE,aAAa,CAAC,WAAW,CAAC,GAAG,OAAO,EAC1C,OAAO,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,GAChD,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC;IAYvC,gBAAgB,CACrB,IAAI,EAAE,WAAW,EACjB,OAAO,CAAC,EAAE,iBAAiB,CAAC,WAAW,CAAC,GACvC,kBAAkB;IAQR,cAAc,CACzB,IAAI,EAAE,WAAW,EACjB,OAAO,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,EACjD,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,EAC9B,gBAAgB,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,GACtD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;YAQnB,eAAe;IAW7B,OAAO,CAAC,oBAAoB;CAO7B"}

package/lib/classes/polymorphic-serialiser.js

@@ -0,0 +1,55 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const serializer_1 = __importDefault(require("./serializer"));
+class PolymorphicSerializer extends serializer_1.default {
+    serialisers;
+    key;
+    constructor(commonName, key, serializers) {
+        super(commonName);
+        this.serialisers = serializers;
+        this.key = key;
+    }
+    async serialize(data, options) {
+        if (Array.isArray(data)) {
+            data.map((d) => {
+                return this.serializeSingle(d, options);
+            });
+        }
+        else if (data) {
+            return this.serializeSingle(data, options);
+        }
+        return Object.values(this.serialisers)[0].serialize(data, options);
+    }
+    createIdentifier(data, options) {
+        const serializer = this.getSerializerForData(data);
+        if (serializer) {
+            return serializer.createIdentifier(data, options);
+        }
+        return super.createIdentifier(data, options);
+    }
+    async createResource(data, options, helpers, relatorDataCache) {
+        const serializer = this.getSerializerForData(data);
+        if (serializer) {
+            return serializer.createResource(data, options, helpers, relatorDataCache);
+        }
+        return super.createResource(data, options, helpers, relatorDataCache);
+    }
+    async serializeSingle(data, options) {
+        const serializer = this.getSerializerForData(data);
+        if (serializer) {
+            return serializer.serialize(data, options);
+        }
+        return super.serialize(data, options);
+    }
+    getSerializerForData(data) {
+        if (this.serialisers[data[this.key]]) {
+            return this.serialisers[data[this.key]];
+        }
+        return null;
+    }
+}
+exports.default = PolymorphicSerializer;
+//# sourceMappingURL=polymorphic-serialiser.js.map

package/lib/classes/polymorphic-serialiser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"polymorphic-serialiser.js","sourceRoot":"","sources":["../../src/classes/polymorphic-serialiser.ts"],"names":[],"mappings":";;;;;AAOA,8DAAsC;AAEtC,MAAqB,qBAEnB,SAAQ,oBAAuB;IACvB,WAAW,CAA6B;IAExC,GAAG,CAAoB;IAE/B,YACE,UAAkB,EAClB,GAAsB,EACtB,WAAuC;QAEvC,KAAK,CAAC,UAAU,CAAC,CAAC;QAClB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAEM,KAAK,CAAC,SAAS,CACpB,IAA0C,EAC1C,OAAiD;QAEjD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACvB,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;gBACb,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;SACJ;aAAM,IAAI,IAAI,EAAE;YACf,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;SAC5C;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAEM,gBAAgB,CACrB,IAAiB,EACjB,OAAwC;QAExC,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,UAAU,EAAE;YACd,OAAO,UAAU,CAAC,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;SACnD;QACD,OAAO,KAAK,CAAC,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAEM,KAAK,CAAC,cAAc,CACzB,IAAiB,EACjB,OAAiD,EACjD,OAA8B,EAC9B,gBAAuD;QAEvD,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,UAAU,EAAE;YACd,OAAO,UAAU,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAC;SAC5E;QACD,OAAO,KAAK,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAC;IACxE,CAAC;IAEO,KAAK,CAAC,eAAe,CAC3B,IAAiB,EACjB,OAAiD;QAEjD,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,UAAU,EAAE;YACd,OAAO,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;SAC5C;QACD,OAAO,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAEO,oBAAoB,CAAC,IAAiB;QAC5C,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE;YACpC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;SACzC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA1ED,wCA0EC"}

package/lib/index.d.ts

@@ -6,6 +6,7 @@ export { default as Relator } from './classes/relator';
 export { default as JapiError } from './models/error.model';
 export { default as ErrorSerializer } from './classes/error-serializer';
 export { default as Serializer } from './classes/serializer';
+export { default as PolymorphicSerializer } from './classes/polymorphic-serialiser';
 export * from './interfaces/cache.interface';
 export * from './interfaces/error-serializer.interface';
 export * from './interfaces/error.interface';

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAC7D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yCAAyC,CAAC;AACxD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kCAAkC,CAAC;AACjD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mCAAmC,CAAC;AAClD,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAE,OAAO,IAAI,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AACpF,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yCAAyC,CAAC;AACxD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kCAAkC,CAAC;AACjD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mCAAmC,CAAC;AAClD,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC"}

package/lib/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Serializer = exports.ErrorSerializer = exports.JapiError = exports.Relator = exports.Paginator = exports.Metaizer = exports.Linker = exports.Cache = void 0;
+exports.PolymorphicSerializer = exports.Serializer = exports.ErrorSerializer = exports.JapiError = exports.Relator = exports.Paginator = exports.Metaizer = exports.Linker = exports.Cache = void 0;
 var cache_1 = require("./classes/cache");
 Object.defineProperty(exports, "Cache", { enumerable: true, get: function () { return __importDefault(cache_1).default; } });
 var linker_1 = require("./classes/linker");
@@ -34,6 +34,8 @@ var error_serializer_1 = require("./classes/error-serializer");
 Object.defineProperty(exports, "ErrorSerializer", { enumerable: true, get: function () { return __importDefault(error_serializer_1).default; } });
 var serializer_1 = require("./classes/serializer");
 Object.defineProperty(exports, "Serializer", { enumerable: true, get: function () { return __importDefault(serializer_1).default; } });
+var polymorphic_serialiser_1 = require("./classes/polymorphic-serialiser");
+Object.defineProperty(exports, "PolymorphicSerializer", { enumerable: true, get: function () { return __importDefault(polymorphic_serialiser_1).default; } });
 __exportStar(require("./interfaces/cache.interface"), exports);
 __exportStar(require("./interfaces/error-serializer.interface"), exports);
 __exportStar(require("./interfaces/error.interface"), exports);

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,yCAAmD;AAA1C,+GAAA,OAAO,OAAS;AACzB,2CAAqD;AAA5C,iHAAA,OAAO,OAAU;AAC1B,+CAAyD;AAAhD,qHAAA,OAAO,OAAY;AAC5B,iDAA2D;AAAlD,uHAAA,OAAO,OAAa;AAC7B,6CAAuD;AAA9C,mHAAA,OAAO,OAAW;AAC3B,oDAA4D;AAAnD,yHAAA,OAAO,OAAa;AAC7B,+DAAwE;AAA/D,oIAAA,OAAO,OAAmB;AACnC,mDAA6D;AAApD,yHAAA,OAAO,OAAc;AAC9B,+DAA6C;AAC7C,0EAAwD;AACxD,+DAA6C;AAC7C,kEAAgD;AAChD,gEAA8C;AAC9C,mEAAiD;AACjD,iEAA+C;AAC/C,oEAAkD;AAClD,uDAAqC;AACrC,4DAA0C;AAC1C,0DAAwC;AACxC,oDAAkC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,yCAAmD;AAA1C,+GAAA,OAAO,OAAS;AACzB,2CAAqD;AAA5C,iHAAA,OAAO,OAAU;AAC1B,+CAAyD;AAAhD,qHAAA,OAAO,OAAY;AAC5B,iDAA2D;AAAlD,uHAAA,OAAO,OAAa;AAC7B,6CAAuD;AAA9C,mHAAA,OAAO,OAAW;AAC3B,oDAA4D;AAAnD,yHAAA,OAAO,OAAa;AAC7B,+DAAwE;AAA/D,oIAAA,OAAO,OAAmB;AACnC,mDAA6D;AAApD,yHAAA,OAAO,OAAc;AAC9B,2EAAoF;AAA3E,gJAAA,OAAO,OAAyB;AACzC,+DAA6C;AAC7C,0EAAwD;AACxD,+DAA6C;AAC7C,kEAAgD;AAChD,gEAA8C;AAC9C,mEAAiD;AACjD,iEAA+C;AAC/C,oEAAkD;AAClD,uDAAqC;AACrC,4DAA0C;AAC1C,0DAAwC;AACxC,oDAAkC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-japi",
-  "version": "1.8.1",
+  "version": "1.9.0",
   "description": "A highly-modular (typescript-friendly)-framework agnostic library for serializing data to the JSON:API specification",
   "main": "lib/index.js",
   "scripts": {
@@ -19,7 +19,8 @@
     "lint:eslint": "eslint .",
     "playground": "ts-node ./benchmarks/playground.benchmark",
     "prepare": "husky install",
-    "test": "jest --runInBand --verbose --coverage"
+    "test": "jest --runInBand --verbose --coverage",
+    "test:watch": "jest --runInBand --verbose --watch"
   },
   "publishConfig": {
     "access": "public",