@cratestack/cbor-web 0.17.2 → 0.18.0

package/dist/index.d.ts

@@ -18,4 +18,35 @@ import type { CratestackRpcCodec } from "@cratestack/ts-types";
  * ```
  */
 export declare function createCborCodec(): Promise<CratestackRpcCodec>;
+/** Which side of an op a body belongs to. */
+export type CompactDirection = "request" | "response";
+/**
+ * The compact-wire-key tables of one client (`docs/design/compact-wire-keys.md`):
+ * swaps schema field names for integer keys on the wire and back. Pure
+ * functions of bytes; a bad input throws a catchable `Error`.
+ */
+export interface CompactKeys {
+    /** Named CBOR bytes to compact CBOR bytes. */
+    toCompact(named: Uint8Array, op: string, direction: CompactDirection): Uint8Array;
+    /** Compact CBOR bytes back to named CBOR bytes. */
+    fromCompact(compact: Uint8Array, op: string, direction: CompactDirection): Uint8Array;
+    /** Named JSON text to compact JSON text (keys become decimal strings). */
+    toCompactJson(named: string, op: string, direction: CompactDirection): string;
+    /** Compact JSON text back to named JSON text. */
+    fromCompactJson(compact: string, op: string, direction: CompactDirection): string;
+    /** The `Cratestack-Contract` header value of the op's current contract. */
+    selector(op: string): string | undefined;
+}
+/**
+ * Builds the {@link CompactKeys} of a generated client's key-table artifact
+ * (its `KEY_TABLES`). Shares the one-time WASM instantiation with
+ * {@link createCborCodec}; the returned calls are synchronous.
+ *
+ * @example
+ * ```ts
+ * const keys = await createCompactKeys(tables);
+ * const compact = keys.toCompact(codec.encode(body), "model.User.create", "request");
+ * ```
+ */
+export declare function createCompactKeys(tables: Uint8Array): Promise<CompactKeys>;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AA2B/D;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,eAAe,IAAI,OAAO,CAAC,kBAAkB,CAAC,CAqBnE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAgC/D;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,eAAe,IAAI,OAAO,CAAC,kBAAkB,CAAC,CAqBnE;AAED,6CAA6C;AAC7C,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,UAAU,CAAC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,8CAA8C;IAC9C,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,gBAAgB,GAAG,UAAU,CAAC;IAClF,mDAAmD;IACnD,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,gBAAgB,GAAG,UAAU,CAAC;IACtF,0EAA0E;IAC1E,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,gBAAgB,GAAG,MAAM,CAAC;IAC9E,iDAAiD;IACjD,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,gBAAgB,GAAG,MAAM,CAAC;IAClF,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CAC1C;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,iBAAiB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,CAUhF"}

package/dist/index.js

@@ -2,7 +2,7 @@
 // (see `pnpm run wasm:build` / `../../examples/scripts/wasm-build.mjs`) — not
 // hand-written, regenerated on every build, excluded from lint/format (see
 // root `biome.json`) and from git (see `.gitignore`).
-import init, { contentType, decode, encode } from "./wasm-pkg/cratestack_cbor_wasm.js";
+import init, { contentType, decode, encode, CompactKeys as WasmCompactKeys, } from "./wasm-pkg/cratestack_cbor_wasm.js";
 // Memoized across calls so concurrent/repeated `createCborCodec()` callers
 // share one WASM instantiation instead of re-fetching/re-compiling the
 // module. Only a *successful* init is cached — a failed attempt (e.g. the
@@ -60,4 +60,26 @@ export async function createCborCodec() {
         },
     };
 }
+/**
+ * Builds the {@link CompactKeys} of a generated client's key-table artifact
+ * (its `KEY_TABLES`). Shares the one-time WASM instantiation with
+ * {@link createCborCodec}; the returned calls are synchronous.
+ *
+ * @example
+ * ```ts
+ * const keys = await createCompactKeys(tables);
+ * const compact = keys.toCompact(codec.encode(body), "model.User.create", "request");
+ * ```
+ */
+export async function createCompactKeys(tables) {
+    await ensureInitialized();
+    const keys = WasmCompactKeys.fromTables(tables);
+    return {
+        toCompact: (named, op, direction) => keys.toCompact(named, op, direction),
+        fromCompact: (compact, op, direction) => keys.fromCompact(compact, op, direction),
+        toCompactJson: (named, op, direction) => keys.toCompactJson(named, op, direction),
+        fromCompactJson: (compact, op, direction) => keys.fromCompactJson(compact, op, direction),
+        selector: (op) => keys.selector(op),
+    };
+}
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,iFAAiF;AACjF,8EAA8E;AAC9E,2EAA2E;AAC3E,sDAAsD;AACtD,OAAO,IAAI,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAEvF,2EAA2E;AAC3E,uEAAuE;AACvE,0EAA0E;AAC1E,0EAA0E;AAC1E,mEAAmE;AACnE,qBAAqB;AACrB,IAAI,WAAW,GAAyB,IAAI,CAAC;AAE7C,SAAS,iBAAiB;IACxB,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,WAAW,GAAG,IAAI,EAAE;aACjB,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC;aACrB,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;YACxB,WAAW,GAAG,IAAI,CAAC;YACnB,MAAM,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;IACP,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe;IACnC,MAAM,iBAAiB,EAAE,CAAC;IAE1B,OAAO;QACL,WAAW,EAAE,WAAW,EAAE;QAC1B,MAAM,CAAC,KAAc;YACnB,6DAA6D;YAC7D,mEAAmE;YACnE,iEAAiE;YACjE,EAAE;YACF,gEAAgE;YAChE,4DAA4D;YAC5D,mEAAmE;YACnE,mCAAmC;YACnC,wEAAwE;YACxE,OAAO,MAAM,CAAC,KAAK,CAAa,CAAC;QACnC,CAAC;QACD,MAAM,CAAC,KAAiB;YACtB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,iFAAiF;AACjF,8EAA8E;AAC9E,2EAA2E;AAC3E,sDAAsD;AACtD,OAAO,IAAI,EAAE,EACX,WAAW,EACX,MAAM,EACN,MAAM,EACN,WAAW,IAAI,eAAe,GAC/B,MAAM,oCAAoC,CAAC;AAE5C,2EAA2E;AAC3E,uEAAuE;AACvE,0EAA0E;AAC1E,0EAA0E;AAC1E,mEAAmE;AACnE,qBAAqB;AACrB,IAAI,WAAW,GAAyB,IAAI,CAAC;AAE7C,SAAS,iBAAiB;IACxB,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,WAAW,GAAG,IAAI,EAAE;aACjB,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC;aACrB,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;YACxB,WAAW,GAAG,IAAI,CAAC;YACnB,MAAM,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;IACP,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe;IACnC,MAAM,iBAAiB,EAAE,CAAC;IAE1B,OAAO;QACL,WAAW,EAAE,WAAW,EAAE;QAC1B,MAAM,CAAC,KAAc;YACnB,6DAA6D;YAC7D,mEAAmE;YACnE,iEAAiE;YACjE,EAAE;YACF,gEAAgE;YAChE,4DAA4D;YAC5D,mEAAmE;YACnE,mCAAmC;YACnC,wEAAwE;YACxE,OAAO,MAAM,CAAC,KAAK,CAAa,CAAC;QACnC,CAAC;QACD,MAAM,CAAC,KAAiB;YACtB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;KACF,CAAC;AACJ,CAAC;AAuBD;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,MAAkB;IACxD,MAAM,iBAAiB,EAAE,CAAC;IAC1B,MAAM,IAAI,GAAG,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAChD,OAAO;QACL,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,EAAE,SAAS,CAAC;QACzE,WAAW,EAAE,CAAC,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,EAAE,EAAE,SAAS,CAAC;QACjF,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,EAAE,EAAE,SAAS,CAAC;QACjF,eAAe,EAAE,CAAC,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,EAAE,EAAE,SAAS,CAAC;QACzF,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;KACpC,CAAC;AACJ,CAAC"}

package/dist/wasm-pkg/cratestack_cbor_wasm.js

@@ -1,5 +1,167 @@
 /* @ts-self-types="./cratestack_cbor_wasm.d.ts" */
 
+/**
+ * The key tables of one client: swaps field names for integer keys on
+ * the wire and back. Build it with `createCompactKeys` in the JS wrapper.
+ */
+export class CompactKeys {
+    static __wrap(ptr) {
+        const obj = Object.create(CompactKeys.prototype);
+        obj.__wbg_ptr = ptr;
+        CompactKeysFinalization.register(obj, obj.__wbg_ptr, obj);
+        return obj;
+    }
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        CompactKeysFinalization.unregister(this);
+        return ptr;
+    }
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_compactkeys_free(ptr, 0);
+    }
+    /**
+     * Compact JSON text back to named JSON text.
+     * @param {string} compact
+     * @param {string} op
+     * @param {string} direction
+     * @returns {string}
+     */
+    fromCompactJson(compact, op, direction) {
+        let deferred5_0;
+        let deferred5_1;
+        try {
+            const ptr0 = passStringToWasm0(compact, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len0 = WASM_VECTOR_LEN;
+            const ptr1 = passStringToWasm0(op, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len1 = WASM_VECTOR_LEN;
+            const ptr2 = passStringToWasm0(direction, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len2 = WASM_VECTOR_LEN;
+            const ret = wasm.compactkeys_fromCompactJson(this.__wbg_ptr, ptr0, len0, ptr1, len1, ptr2, len2);
+            var ptr4 = ret[0];
+            var len4 = ret[1];
+            if (ret[3]) {
+                ptr4 = 0; len4 = 0;
+                throw takeFromExternrefTable0(ret[2]);
+            }
+            deferred5_0 = ptr4;
+            deferred5_1 = len4;
+            return getStringFromWasm0(ptr4, len4);
+        } finally {
+            wasm.__wbindgen_free(deferred5_0, deferred5_1, 1);
+        }
+    }
+    /**
+     * Compact CBOR bytes back to named CBOR bytes.
+     * @param {Uint8Array} compact
+     * @param {string} op
+     * @param {string} direction
+     * @returns {Uint8Array}
+     */
+    fromCompact(compact, op, direction) {
+        const ptr0 = passArray8ToWasm0(compact, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ptr1 = passStringToWasm0(op, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len1 = WASM_VECTOR_LEN;
+        const ptr2 = passStringToWasm0(direction, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len2 = WASM_VECTOR_LEN;
+        const ret = wasm.compactkeys_fromCompact(this.__wbg_ptr, ptr0, len0, ptr1, len1, ptr2, len2);
+        if (ret[3]) {
+            throw takeFromExternrefTable0(ret[2]);
+        }
+        var v4 = getArrayU8FromWasm0(ret[0], ret[1]).slice();
+        wasm.__wbindgen_free(ret[0], ret[1] * 1, 1);
+        return v4;
+    }
+    /**
+     * Loads the generated key-table artifact.
+     * @param {Uint8Array} tables
+     * @returns {CompactKeys}
+     */
+    static fromTables(tables) {
+        const ptr0 = passArray8ToWasm0(tables, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.compactkeys_fromTables(ptr0, len0);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return CompactKeys.__wrap(ret[0]);
+    }
+    /**
+     * The `Cratestack-Contract` header value of `op`'s current contract,
+     * or `undefined` for an op the tables lack.
+     * @param {string} op
+     * @returns {string | undefined}
+     */
+    selector(op) {
+        const ptr0 = passStringToWasm0(op, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.compactkeys_selector(this.__wbg_ptr, ptr0, len0);
+        let v2;
+        if (ret[0] !== 0) {
+            v2 = getStringFromWasm0(ret[0], ret[1]);
+            wasm.__wbindgen_free(ret[0], ret[1] * 1, 1);
+        }
+        return v2;
+    }
+    /**
+     * Named JSON text to compact JSON text (decimal-string keys).
+     * @param {string} named
+     * @param {string} op
+     * @param {string} direction
+     * @returns {string}
+     */
+    toCompactJson(named, op, direction) {
+        let deferred5_0;
+        let deferred5_1;
+        try {
+            const ptr0 = passStringToWasm0(named, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len0 = WASM_VECTOR_LEN;
+            const ptr1 = passStringToWasm0(op, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len1 = WASM_VECTOR_LEN;
+            const ptr2 = passStringToWasm0(direction, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len2 = WASM_VECTOR_LEN;
+            const ret = wasm.compactkeys_toCompactJson(this.__wbg_ptr, ptr0, len0, ptr1, len1, ptr2, len2);
+            var ptr4 = ret[0];
+            var len4 = ret[1];
+            if (ret[3]) {
+                ptr4 = 0; len4 = 0;
+                throw takeFromExternrefTable0(ret[2]);
+            }
+            deferred5_0 = ptr4;
+            deferred5_1 = len4;
+            return getStringFromWasm0(ptr4, len4);
+        } finally {
+            wasm.__wbindgen_free(deferred5_0, deferred5_1, 1);
+        }
+    }
+    /**
+     * Named CBOR bytes to compact CBOR bytes. `direction` is
+     * `"request"` or `"response"`.
+     * @param {Uint8Array} named
+     * @param {string} op
+     * @param {string} direction
+     * @returns {Uint8Array}
+     */
+    toCompact(named, op, direction) {
+        const ptr0 = passArray8ToWasm0(named, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ptr1 = passStringToWasm0(op, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len1 = WASM_VECTOR_LEN;
+        const ptr2 = passStringToWasm0(direction, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len2 = WASM_VECTOR_LEN;
+        const ret = wasm.compactkeys_toCompact(this.__wbg_ptr, ptr0, len0, ptr1, len1, ptr2, len2);
+        if (ret[3]) {
+            throw takeFromExternrefTable0(ret[2]);
+        }
+        var v4 = getArrayU8FromWasm0(ret[0], ret[1]).slice();
+        wasm.__wbindgen_free(ret[0], ret[1] * 1, 1);
+        return v4;
+    }
+}
+if (Symbol.dispose) CompactKeys.prototype[Symbol.dispose] = CompactKeys.prototype.free;
+
 /**
  * Mirrors `CborCodec::CONTENT_TYPE` ("application/cbor") — kept as a
  * function rather than a duplicated JS-side string literal so there is
@@ -353,6 +515,10 @@ function __wbg_get_imports() {
     };
 }
 
+const CompactKeysFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_compactkeys_free(ptr, 1));
+
 function addToExternrefTable0(obj) {
     const idx = wasm.__externref_table_alloc();
     wasm.__wbindgen_externrefs.set(idx, obj);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cratestack/cbor-web",
-  "version": "0.17.2",
+  "version": "0.18.0",
   "description": "wasm-bindgen CBOR codec for browser CrateStack RPC clients. Async one-time WASM init, synchronous encode/decode after — backed by the same Rust CborCodec the server and Rust client already use.",
   "license": "MIT",
   "repository": {
@@ -43,7 +43,7 @@
     "lint": "biome check ."
   },
   "dependencies": {
-    "@cratestack/ts-types": "0.17.2"
+    "@cratestack/ts-types": "0.18.0"
   },
   "devDependencies": {
     "typescript": "^7.0.2",