skir-client 0.0.1

package/README.md

@@ -0,0 +1,17 @@
+[![npm](https://img.shields.io/npm/v/skir)](https://www.npmjs.com/package/skir)
+[![build](https://github.com/gepheum/skir-typescript-client/workflows/Build/badge.svg)](https://github.com/gepheum/skir-typescript-client/actions)
+
+# Skir TypeScript Client
+
+Library imported from TypeScript code generated from skir files.
+
+Install with:
+```shell
+npm i skir
+```
+
+See:
+
+*   [skir](https://github.com/gepheum/skir): home of the skir compiler
+*   [skir-typescript-gen](https://github.com/gepheum/skir-typescript-gen): skir to TypeScript code generator
+*   [skir-typescript-example](https://github.com/gepheum/skir-typescript-example): example showing how to use skir's TypeScript code generator in a project

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/cjs/serializer_tester.d.ts

@@ -0,0 +1,18 @@
+import { type Json, type MutableForm, type Serializer } from "./skir-client.js";
+export declare class SerializerTester<T> {
+    readonly serializer: Serializer<T>;
+    constructor(serializer: Serializer<T>);
+    reserializeAndAssert(input: T | MutableForm<T>, expected: {
+        denseJson: Json;
+        /** Defaults to `denseJson`. */
+        readableJson?: Json;
+        bytesAsBase16: string;
+        /** Defaults to `denseJson`. */
+        denseJsonFromReserialized?: Json;
+        lossy?: true;
+    }, description?: string): void;
+    deserializeZeroAndAssert(isDefaultFn: (input: T) => boolean): void;
+    reserializeTypeAdapterAndAssertNoLoss(): void;
+}
+export declare function toBase16(buffer: ArrayBuffer): string;
+//# sourceMappingURL=serializer_tester.d.ts.map

package/dist/cjs/serializer_tester.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializer_tester.d.ts","sourceRoot":"","sources":["../../src/serializer_tester.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,KAAK,IAAI,EAET,KAAK,WAAW,EAChB,KAAK,UAAU,EAEhB,MAAM,kBAAkB,CAAC;AAE1B,qBAAa,gBAAgB,CAAC,CAAC;IACjB,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;gBAAzB,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;IAE9C,oBAAoB,CAClB,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,EACzB,QAAQ,EAAE;QACR,SAAS,EAAE,IAAI,CAAC;QAChB,+BAA+B;QAC/B,YAAY,CAAC,EAAE,IAAI,CAAC;QACpB,aAAa,EAAE,MAAM,CAAC;QACtB,+BAA+B;QAC/B,yBAAyB,CAAC,EAAE,IAAI,CAAC;QACjC,KAAK,CAAC,EAAE,IAAI,CAAC;KACd,EACD,WAAW,CAAC,EAAE,MAAM,GACnB,IAAI;IA8HP,wBAAwB,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,GAAG,IAAI;IAelE,qCAAqC,IAAI,IAAI;CAQ9C;AAED,wBAAgB,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAOpD"}

package/dist/cjs/serializer_tester.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toBase16 = exports.SerializerTester = void 0;
+const buckwheat_1 = require("buckwheat");
+const mocha_1 = require("mocha");
+const skir_client_js_1 = require("./skir-client.js");
+class SerializerTester {
+    constructor(serializer) {
+        this.serializer = serializer;
+    }
+    reserializeAndAssert(input, expected, description) {
+        const { serializer } = this;
+        (0, mocha_1.describe)(description !== null && description !== void 0 ? description : `reserialize ${input}`, () => {
+            var _a;
+            // Test JSON serialization.
+            const jsonFlavors = ["dense", "readable"];
+            for (const flavor of jsonFlavors) {
+                const expectedJson = flavor === "dense"
+                    ? expected.denseJson
+                    : (_a = expected.readableJson) !== null && _a !== void 0 ? _a : expected.denseJson;
+                (0, mocha_1.describe)(`${flavor} JSON`, () => {
+                    const actualJson = serializer.toJson(input, flavor);
+                    (0, mocha_1.it)("#toJson()", () => {
+                        (0, buckwheat_1.expect)(actualJson).toMatch(expectedJson);
+                    });
+                    (0, mocha_1.it)("#toJsonCode()", () => {
+                        const actualJsonCode = serializer.toJsonCode(input, flavor);
+                        const expectedJsonCode = JSON.stringify(expectedJson, undefined, flavor === "dense" ? "" : "  ");
+                        (0, buckwheat_1.expect)(actualJsonCode).toBe(expectedJsonCode);
+                    });
+                    (0, mocha_1.it)("#toJson() -> #fromJson() -> #toJson()", () => {
+                        serializer.fromJson(actualJson);
+                        const reserialized = serializer.fromJson(actualJson, "keep-unrecognized-values");
+                        (0, buckwheat_1.expect)(serializer.toJson(reserialized, flavor)).toMatch(expectedJson);
+                    });
+                    (0, mocha_1.it)("#toJsonCode() -> #fromJsonCode() -> #toJson()", () => {
+                        const reserialized = serializer.fromJsonCode(serializer.toJsonCode(input, flavor), "keep-unrecognized-values");
+                        (0, buckwheat_1.expect)(serializer.toJson(reserialized, flavor)).toMatch(expectedJson);
+                    });
+                });
+            }
+            // Test binary serialization.
+            const actualBytes = serializer.toBytes(input).toBuffer();
+            (0, mocha_1.it)("#toBytes()", () => {
+                const actualBase16 = toBase16(actualBytes);
+                (0, buckwheat_1.expect)(actualBase16).toBe(expected.bytesAsBase16);
+            });
+            serializer.fromBytes(actualBytes);
+            const reserialized = serializer.fromBytes(actualBytes, "keep-unrecognized-values");
+            (0, mocha_1.it)("#toBytes() -> #fromBytes() -> #toBytes()", () => {
+                const actualBase16 = toBase16(serializer.toBytes(reserialized).toBuffer());
+                (0, buckwheat_1.expect)(actualBase16).toBe(expected.bytesAsBase16);
+            });
+            (0, mocha_1.it)("#toBytes() -> #fromBytes() -> #toJson()", () => {
+                var _a;
+                const actualDenseJson = serializer.toJson(reserialized, "dense");
+                const expectedDenseJson = (_a = expected.denseJsonFromReserialized) !== null && _a !== void 0 ? _a : expected.denseJson;
+                (0, buckwheat_1.expect)(actualDenseJson).toMatch(expectedDenseJson);
+            });
+            // Test the #transform method of TypeDescriptor.
+            if (!expected.lossy) {
+                const transformAndAssert = (reparse, sourceFormat, targetFormat) => {
+                    let typeDescriptor = serializer.typeDescriptor;
+                    if (reparse) {
+                        typeDescriptor = (0, skir_client_js_1.parseTypeDescriptorFromJson)(typeDescriptor.asJson());
+                    }
+                    const serialize = (format) => format === "bytes"
+                        ? serializer.toBytes(input).toBuffer()
+                        : serializer.toJson(input, format);
+                    const source = serialize(sourceFormat);
+                    const target = serialize(targetFormat);
+                    const transformed = typeDescriptor.transform(source, targetFormat);
+                    const arrayBufferToBase16 = (a) => a instanceof ArrayBuffer ? toBase16(a) : a;
+                    const parsedPrefix = reparse ? "parseTypeDescriptor then " : "";
+                    (0, mocha_1.it)(`${parsedPrefix}transform ${sourceFormat} -> ${targetFormat}`, () => {
+                        (0, buckwheat_1.expect)(arrayBufferToBase16(transformed)).toMatch(arrayBufferToBase16(target));
+                    });
+                };
+                const formats = ["dense", "readable", "bytes"];
+                for (const reparse of [false, true]) {
+                    for (const source of formats) {
+                        for (const target of formats) {
+                            transformAndAssert(reparse, source, target);
+                        }
+                    }
+                }
+            }
+            serializer.fromJson(serializer.toJson(input));
+            return serializer.fromJson(serializer.toJson(input), "keep-unrecognized-values");
+        });
+    }
+    deserializeZeroAndAssert(isDefaultFn) {
+        const { serializer } = this;
+        (0, mocha_1.describe)("deserialize zero", () => {
+            (0, mocha_1.it)("from JSON", () => {
+                (0, buckwheat_1.expect)(isDefaultFn(serializer.fromJson(0))).toBe(true);
+            });
+            (0, mocha_1.it)("from bytes", () => {
+                const bytes = new ArrayBuffer(5);
+                new TextEncoder().encodeInto("skir", new Uint8Array(bytes, 0, 4));
+                (0, buckwheat_1.expect)(isDefaultFn(serializer.fromBytes(bytes))).toBe(true);
+            });
+        });
+    }
+    reserializeTypeAdapterAndAssertNoLoss() {
+        (0, mocha_1.it)("reserialize type adapter", () => {
+            const json = this.serializer.typeDescriptor.asJson();
+            const reserialized = (0, skir_client_js_1.parseTypeDescriptorFromJson)(json);
+            (0, buckwheat_1.expect)(reserialized.asJson()).toMatch(json);
+            (0, buckwheat_1.expect)(json).toMatch(reserialized.asJson());
+        });
+    }
+}
+exports.SerializerTester = SerializerTester;
+function toBase16(buffer) {
+    const prefix = new TextDecoder().decode(new Uint8Array(buffer).slice(0, 4));
+    (0, buckwheat_1.expect)(prefix).toBe("skir");
+    return [...new Uint8Array(buffer)]
+        .slice(4)
+        .map((x) => x.toString(16).padStart(2, "0"))
+        .join("");
+}
+exports.toBase16 = toBase16;
+//# sourceMappingURL=serializer_tester.js.map

package/dist/cjs/serializer_tester.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializer_tester.js","sourceRoot":"","sources":["../../src/serializer_tester.ts"],"names":[],"mappings":";;;AAAA,yCAAmC;AACnC,iCAAqC;AACrC,qDAO0B;AAE1B,MAAa,gBAAgB;IAC3B,YAAqB,UAAyB;QAAzB,eAAU,GAAV,UAAU,CAAe;IAAG,CAAC;IAElD,oBAAoB,CAClB,KAAyB,EACzB,QAQC,EACD,WAAoB;QAEpB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QAE5B,IAAA,gBAAQ,EAAC,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,eAAe,KAAK,EAAE,EAAE,GAAG,EAAE;;YACnD,2BAA2B;YAC3B,MAAM,WAAW,GAAiB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YACxD,KAAK,MAAM,MAAM,IAAI,WAAW,EAAE,CAAC;gBACjC,MAAM,YAAY,GAChB,MAAM,KAAK,OAAO;oBAChB,CAAC,CAAC,QAAQ,CAAC,SAAS;oBACpB,CAAC,CAAC,MAAA,QAAQ,CAAC,YAAY,mCAAI,QAAQ,CAAC,SAAS,CAAC;gBAElD,IAAA,gBAAQ,EAAC,GAAG,MAAM,OAAO,EAAE,GAAG,EAAE;oBAC9B,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;oBAEpD,IAAA,UAAE,EAAC,WAAW,EAAE,GAAG,EAAE;wBACnB,IAAA,kBAAM,EAAC,UAAU,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;oBAC3C,CAAC,CAAC,CAAC;oBAEH,IAAA,UAAE,EAAC,eAAe,EAAE,GAAG,EAAE;wBACvB,MAAM,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;wBAC5D,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CACrC,YAAY,EACZ,SAAS,EACT,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAC/B,CAAC;wBACF,IAAA,kBAAM,EAAC,cAAc,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;oBAChD,CAAC,CAAC,CAAC;oBAEH,IAAA,UAAE,EAAC,uCAAuC,EAAE,GAAG,EAAE;wBAC/C,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;wBAChC,MAAM,YAAY,GAAM,UAAU,CAAC,QAAQ,CACzC,UAAU,EACV,0BAA0B,CAC3B,CAAC;wBACF,IAAA,kBAAM,EAAC,UAAU,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CACrD,YAAY,CACb,CAAC;oBACJ,CAAC,CAAC,CAAC;oBAEH,IAAA,UAAE,EAAC,+CAA+C,EAAE,GAAG,EAAE;wBACvD,MAAM,YAAY,GAAG,UAAU,CAAC,YAAY,CAC1C,UAAU,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,EACpC,0BAA0B,CAC3B,CAAC;wBACF,IAAA,kBAAM,EAAC,UAAU,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CACrD,YAAY,CACb,CAAC;oBACJ,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;YACL,CAAC;YAED,6BAA6B;YAC7B,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;YACzD,IAAA,UAAE,EAAC,YAAY,EAAE,GAAG,EAAE;gBACpB,MAAM,YAAY,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;gBAC3C,IAAA,kBAAM,EAAC,YAAY,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;YACpD,CAAC,CAAC,CAAC;YACH,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YAClC,MAAM,YAAY,GAAG,UAAU,CAAC,SAAS,CACvC,WAAW,EACX,0BAA0B,CAC3B,CAAC;YACF,IAAA,UAAE,EAAC,0CAA0C,EAAE,GAAG,EAAE;gBAClD,MAAM,YAAY,GAAG,QAAQ,CAC3B,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,CAC5C,CAAC;gBACF,IAAA,kBAAM,EAAC,YAAY,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;YACpD,CAAC,CAAC,CAAC;YACH,IAAA,UAAE,EAAC,yCAAyC,EAAE,GAAG,EAAE;;gBACjD,MAAM,eAAe,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;gBACjE,MAAM,iBAAiB,GACrB,MAAA,QAAQ,CAAC,yBAAyB,mCAAI,QAAQ,CAAC,SAAS,CAAC;gBAC3D,IAAA,kBAAM,EAAC,eAAe,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;YACrD,CAAC,CAAC,CAAC;YAEH,gDAAgD;YAChD,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;gBAEpB,MAAM,kBAAkB,GAAG,CACzB,OAAgB,EAChB,YAAoB,EACpB,YAAoB,EACd,EAAE;oBACR,IAAI,cAAc,GAAmB,UAAU,CAAC,cAAc,CAAC;oBAC/D,IAAI,OAAO,EAAE,CAAC;wBACZ,cAAc,GAAG,IAAA,4CAA2B,EAC1C,cAAc,CAAC,MAAM,EAAE,CACxB,CAAC;oBACJ,CAAC;oBACD,MAAM,SAAS,GAAG,CAChB,MAA4B,EACR,EAAE,CACtB,MAAM,KAAK,OAAO;wBAChB,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE;wBACtC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;oBACvC,MAAM,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC;oBACvC,MAAM,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC;oBACvC,MAAM,WAAW,GAAG,cAAc,CAAC,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;oBACnE,MAAM,mBAAmB,GAAG,CAAC,CAAqB,EAAQ,EAAE,CAC1D,CAAC,YAAY,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC7C,MAAM,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC,2BAA2B,CAAC,CAAC,CAAC,EAAE,CAAC;oBAChE,IAAA,UAAE,EAAC,GAAG,YAAY,aAAa,YAAY,OAAO,YAAY,EAAE,EAAE,GAAG,EAAE;wBACrE,IAAA,kBAAM,EAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAC9C,mBAAmB,CAAC,MAAM,CAAC,CAC5B,CAAC;oBACJ,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC;gBACF,MAAM,OAAO,GAAa,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;gBACzD,KAAK,MAAM,OAAO,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;oBACpC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;wBAC7B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;4BAC7B,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;wBAC9C,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YAED,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC9C,OAAO,UAAU,CAAC,QAAQ,CACxB,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,EACxB,0BAA0B,CAC3B,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,wBAAwB,CAAC,WAAkC;QACzD,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QAE5B,IAAA,gBAAQ,EAAC,kBAAkB,EAAE,GAAG,EAAE;YAChC,IAAA,UAAE,EAAC,WAAW,EAAE,GAAG,EAAE;gBACnB,IAAA,kBAAM,EAAC,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACzD,CAAC,CAAC,CAAC;YACH,IAAA,UAAE,EAAC,YAAY,EAAE,GAAG,EAAE;gBACpB,MAAM,KAAK,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;gBACjC,IAAI,WAAW,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBAClE,IAAA,kBAAM,EAAC,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,qCAAqC;QACnC,IAAA,UAAE,EAAC,0BAA0B,EAAE,GAAG,EAAE;YAClC,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;YACrD,MAAM,YAAY,GAAG,IAAA,4CAA2B,EAAC,IAAI,CAAC,CAAC;YACvD,IAAA,kBAAM,EAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC5C,IAAA,kBAAM,EAAC,IAAI,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AApKD,4CAoKC;AAED,SAAgB,QAAQ,CAAC,MAAmB;IAC1C,MAAM,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC5E,IAAA,kBAAM,EAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC5B,OAAO,CAAC,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;SAC/B,KAAK,CAAC,CAAC,CAAC;SACR,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;SAC3C,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC;AAPD,4BAOC"}