@automate.ax/codec 0.86.2 → 0.87.1

package/dist/rpc.d.ts

@@ -0,0 +1,41 @@
+import type { StandardRPCCustomJsonSerializer } from "@orpc/client/standard";
+import * as z from "zod";
+import { type Encodable } from "./index.js";
+/** Opaque codec bytes carried through oRPC's native Blob transport. */
+export declare class CodecEnvelope {
+    readonly blob: Blob;
+    /**
+     * Creates an opaque encoded value.
+     *
+     * @param blob - Msgpack bytes represented as a transport-safe Blob.
+     */
+    constructor(blob: Blob);
+}
+/** Schema for one opaque codec transport value. */
+export declare const codecEnvelopeSchema: z.ZodCustom<CodecEnvelope, CodecEnvelope>;
+/**
+ * Wraps already encoded codec bytes without decoding or re-encoding them.
+ *
+ * @param bytes - Exact persisted or freshly encoded codec bytes.
+ */
+export declare function createCodecEnvelope(bytes: Uint8Array): CodecEnvelope;
+/**
+ * Reads the exact codec bytes carried by an envelope.
+ *
+ * @param envelope - Opaque bytes received from oRPC.
+ */
+export declare function readCodecEnvelope(envelope: CodecEnvelope): Promise<Uint8Array<ArrayBuffer>>;
+/**
+ * Encodes one runtime value before it crosses an oRPC boundary.
+ *
+ * @param value - Codec-supported value to transport.
+ */
+export declare function encodeCodecEnvelope(value: Encodable): Promise<CodecEnvelope>;
+/**
+ * Decodes one runtime value after it crosses an oRPC boundary.
+ *
+ * @param envelope - Opaque bytes received from oRPC.
+ */
+export declare function decodeCodecEnvelope(envelope: CodecEnvelope): Promise<Encodable>;
+/** Symmetric oRPC serializer for opaque codec envelopes. */
+export declare const codecEnvelopeSerializer: StandardRPCCustomJsonSerializer;

package/dist/rpc.js

@@ -0,0 +1,60 @@
+import * as z from "zod";
+import { decode, encode } from "./index.js";
+/** Opaque codec bytes carried through oRPC's native Blob transport. */
+export class CodecEnvelope {
+    blob;
+    /**
+     * Creates an opaque encoded value.
+     *
+     * @param blob - Msgpack bytes represented as a transport-safe Blob.
+     */
+    constructor(blob) {
+        this.blob = blob;
+    }
+}
+const BLOB_SCHEMA = z.instanceof(Blob);
+/** Schema for one opaque codec transport value. */
+export const codecEnvelopeSchema = z
+    .instanceof(CodecEnvelope)
+    .refine((envelope) => envelope.blob instanceof Blob, {
+    message: "Codec envelope must contain Blob bytes",
+});
+/**
+ * Wraps already encoded codec bytes without decoding or re-encoding them.
+ *
+ * @param bytes - Exact persisted or freshly encoded codec bytes.
+ */
+export function createCodecEnvelope(bytes) {
+    return new CodecEnvelope(new Blob([Uint8Array.from(bytes)]));
+}
+/**
+ * Reads the exact codec bytes carried by an envelope.
+ *
+ * @param envelope - Opaque bytes received from oRPC.
+ */
+export async function readCodecEnvelope(envelope) {
+    return new Uint8Array(await envelope.blob.arrayBuffer());
+}
+/**
+ * Encodes one runtime value before it crosses an oRPC boundary.
+ *
+ * @param value - Codec-supported value to transport.
+ */
+export async function encodeCodecEnvelope(value) {
+    return createCodecEnvelope(await encode(value));
+}
+/**
+ * Decodes one runtime value after it crosses an oRPC boundary.
+ *
+ * @param envelope - Opaque bytes received from oRPC.
+ */
+export async function decodeCodecEnvelope(envelope) {
+    return await decode(await readCodecEnvelope(envelope));
+}
+/** Symmetric oRPC serializer for opaque codec envelopes. */
+export const codecEnvelopeSerializer = {
+    type: 21,
+    condition: (data) => data instanceof CodecEnvelope,
+    serialize: (data) => data.blob,
+    deserialize: (blob) => new CodecEnvelope(BLOB_SCHEMA.parse(blob)),
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automate.ax/codec",
-  "version": "0.86.2",
+  "version": "0.87.1",
   "description": "Msgpack-based encoding helpers for Automate.ax runtime data.",
   "license": "MIT",
   "repository": {
@@ -20,6 +20,7 @@
     "exports": {
       ".": "./src/index.ts",
       "./http": "./src/http.ts",
+      "./rpc": "./src/rpc.ts",
       "./*": "./src/*"
     },
     "cjs": false,
@@ -38,6 +39,11 @@
       "types": "./dist/http.d.ts",
       "default": "./dist/http.js"
     },
+    "./rpc": {
+      "bun": "./src/rpc.ts",
+      "types": "./dist/rpc.d.ts",
+      "default": "./dist/rpc.js"
+    },
     "./*": {
       "bun": "./src/*",
       "types": "./dist/*",
@@ -74,6 +80,7 @@
     "zshy": "^0.7.2"
   },
   "dependencies": {
+    "@orpc/client": "1.15.0",
     "@remix-run/multipart-parser": "^0.16.4",
     "@standard-schema/spec": "^1.1.0",
     "content-type": "^3.0.0",

package/src/rpc.ts

@@ -0,0 +1,66 @@
+import type { StandardRPCCustomJsonSerializer } from "@orpc/client/standard"
+import * as z from "zod"
+import { decode, encode, type Encodable } from "./index"
+
+/** Opaque codec bytes carried through oRPC's native Blob transport. */
+export class CodecEnvelope {
+  /**
+   * Creates an opaque encoded value.
+   *
+   * @param blob - Msgpack bytes represented as a transport-safe Blob.
+   */
+  constructor(public readonly blob: Blob) {}
+}
+
+const BLOB_SCHEMA = z.instanceof(Blob)
+
+/** Schema for one opaque codec transport value. */
+export const codecEnvelopeSchema = z
+  .instanceof(CodecEnvelope)
+  .refine((envelope) => envelope.blob instanceof Blob, {
+    message: "Codec envelope must contain Blob bytes",
+  })
+
+/**
+ * Wraps already encoded codec bytes without decoding or re-encoding them.
+ *
+ * @param bytes - Exact persisted or freshly encoded codec bytes.
+ */
+export function createCodecEnvelope(bytes: Uint8Array) {
+  return new CodecEnvelope(new Blob([Uint8Array.from(bytes)]))
+}
+
+/**
+ * Reads the exact codec bytes carried by an envelope.
+ *
+ * @param envelope - Opaque bytes received from oRPC.
+ */
+export async function readCodecEnvelope(envelope: CodecEnvelope) {
+  return new Uint8Array(await envelope.blob.arrayBuffer())
+}
+
+/**
+ * Encodes one runtime value before it crosses an oRPC boundary.
+ *
+ * @param value - Codec-supported value to transport.
+ */
+export async function encodeCodecEnvelope(value: Encodable) {
+  return createCodecEnvelope(await encode(value))
+}
+
+/**
+ * Decodes one runtime value after it crosses an oRPC boundary.
+ *
+ * @param envelope - Opaque bytes received from oRPC.
+ */
+export async function decodeCodecEnvelope(envelope: CodecEnvelope) {
+  return await decode(await readCodecEnvelope(envelope))
+}
+
+/** Symmetric oRPC serializer for opaque codec envelopes. */
+export const codecEnvelopeSerializer: StandardRPCCustomJsonSerializer = {
+  type: 21,
+  condition: (data) => data instanceof CodecEnvelope,
+  serialize: (data) => data.blob,
+  deserialize: (blob) => new CodecEnvelope(BLOB_SCHEMA.parse(blob)),
+}