@haverstack/wire-types 0.5.0

package/LICENSE

@@ -0,0 +1,7 @@
+CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
+
+To the extent possible under law, the Haverstack contributors have waived all
+copyright and related or neighboring rights to Haverstack. This work is
+published from the United States.
+
+https://creativecommons.org/publicdomain/zero/1.0/

package/README.md

@@ -0,0 +1,50 @@
+# @haverstack/wire-types
+
+HTTP wire types and serialization utilities for the Haverstack API.
+
+This package defines the JSON-safe representations of Haverstack's core domain types — `Date` fields become ISO strings — and provides functions to serialize domain objects into that format and parse dates back out. It is the shared contract between `haverstack/server` (which serializes responses) and `@haverstack/adapter-api` (which parses them).
+
+> **Status:** Early development. APIs are unstable.
+
+## Installation
+
+```sh
+npm install @haverstack/wire-types
+```
+
+## Wire types
+
+Each wire type mirrors a domain type from `@haverstack/core` with `Date` fields replaced by ISO 8601 strings.
+
+| Wire type | Domain type |
+|-----------|-------------|
+| `WireRecord` | `StackRecord` |
+| `WireType` | `StackType` |
+| `WireVersion` | `RecordVersion` |
+
+## Serialization
+
+```ts
+import {
+  serializeRecord,
+  serializeType,
+  serializeVersion,
+  parseDate,
+} from '@haverstack/wire-types';
+
+// Server side — convert domain objects before sending as JSON
+const body = JSON.stringify(serializeRecord(record));
+
+// Client side — convert ISO strings back to Dates after parsing JSON
+const createdAt = parseDate(raw.createdAt); // Date | undefined
+```
+
+`parseDate` accepts `unknown` and returns `undefined` for missing or unparseable values, making it safe to use directly on unvalidated response fields.
+
+## License
+
+[CC0 1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/) — public domain.
+
+## Monorepo
+
+Part of [haverstack/core](https://github.com/haverstack/core).

package/dist/index.d.ts

@@ -0,0 +1,37 @@
+import type { StackRecord, StackType, RecordVersion, Association, Permission } from '@haverstack/core';
+export type WireRecord = {
+    id: string;
+    typeId: string;
+    createdAt: string;
+    updatedAt: string;
+    content: Record<string, unknown>;
+    version: number;
+    parentId?: string;
+    entityId?: string;
+    appId?: string;
+    deletedAt?: string;
+    permissions?: Permission[];
+    associations?: Association[];
+};
+export type WireType = {
+    id: string;
+    baseId: string;
+    version: number;
+    name: string;
+    schema: Record<string, unknown>;
+    schemaHash: string;
+    migratesFrom?: string;
+    createdAt: string;
+};
+export type WireVersion = {
+    version: number;
+    content: Record<string, unknown>;
+    updatedAt: string;
+    entityId?: string;
+};
+export declare function serializeRecord(r: StackRecord): WireRecord;
+export declare function serializeType(t: StackType): WireType;
+export declare function serializeVersion(v: RecordVersion): WireVersion;
+/** Parse an ISO date string from a wire body, returns undefined if absent or invalid. */
+export declare function parseDate(val: unknown): Date | undefined;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,SAAS,EACT,aAAa,EACb,WAAW,EACX,UAAU,EACX,MAAM,kBAAkB,CAAC;AAE1B,MAAM,MAAM,UAAU,GAAG;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;IAC3B,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,wBAAgB,eAAe,CAAC,CAAC,EAAE,WAAW,GAAG,UAAU,CAgB1D;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,SAAS,GAAG,QAAQ,CAYpD;AAED,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,aAAa,GAAG,WAAW,CAQ9D;AAED,yFAAyF;AACzF,wBAAgB,SAAS,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAIxD"}

package/dist/index.js

@@ -0,0 +1,55 @@
+export function serializeRecord(r) {
+    const w = {
+        id: r.id,
+        typeId: r.typeId,
+        createdAt: r.createdAt.toISOString(),
+        updatedAt: r.updatedAt.toISOString(),
+        content: r.content,
+        version: r.version,
+    };
+    if (r.parentId !== undefined)
+        w.parentId = r.parentId;
+    if (r.entityId !== undefined)
+        w.entityId = r.entityId;
+    if (r.appId !== undefined)
+        w.appId = r.appId;
+    if (r.deletedAt !== undefined)
+        w.deletedAt = r.deletedAt.toISOString();
+    if (r.permissions !== undefined)
+        w.permissions = r.permissions;
+    if (r.associations !== undefined)
+        w.associations = r.associations;
+    return w;
+}
+export function serializeType(t) {
+    const w = {
+        id: t.id,
+        baseId: t.baseId,
+        version: t.version,
+        name: t.name,
+        schema: t.schema,
+        schemaHash: t.schemaHash,
+        createdAt: t.createdAt.toISOString(),
+    };
+    if (t.migratesFrom !== undefined)
+        w.migratesFrom = t.migratesFrom;
+    return w;
+}
+export function serializeVersion(v) {
+    const w = {
+        version: v.version,
+        content: v.content,
+        updatedAt: v.updatedAt.toISOString(),
+    };
+    if (v.entityId !== undefined)
+        w.entityId = v.entityId;
+    return w;
+}
+/** Parse an ISO date string from a wire body, returns undefined if absent or invalid. */
+export function parseDate(val) {
+    if (typeof val !== 'string')
+        return undefined;
+    const d = new Date(val);
+    return isNaN(d.getTime()) ? undefined : d;
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAyCA,MAAM,UAAU,eAAe,CAAC,CAAc;IAC5C,MAAM,CAAC,GAAe;QACpB,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,WAAW,EAAE;QACpC,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,WAAW,EAAE;QACpC,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,OAAO,EAAE,CAAC,CAAC,OAAO;KACnB,CAAC;IACF,IAAI,CAAC,CAAC,QAAQ,KAAK,SAAS;QAAE,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC;IACtD,IAAI,CAAC,CAAC,QAAQ,KAAK,SAAS;QAAE,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC;IACtD,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS;QAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;IAC7C,IAAI,CAAC,CAAC,SAAS,KAAK,SAAS;QAAE,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;IACvE,IAAI,CAAC,CAAC,WAAW,KAAK,SAAS;QAAE,CAAC,CAAC,WAAW,GAAG,CAAC,CAAC,WAAW,CAAC;IAC/D,IAAI,CAAC,CAAC,YAAY,KAAK,SAAS;QAAE,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,YAAY,CAAC;IAClE,OAAO,CAAC,CAAC;AACX,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,CAAY;IACxC,MAAM,CAAC,GAAa;QAClB,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,MAAM,EAAE,CAAC,CAAC,MAAiC;QAC3C,UAAU,EAAE,CAAC,CAAC,UAAU;QACxB,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,WAAW,EAAE;KACrC,CAAC;IACF,IAAI,CAAC,CAAC,YAAY,KAAK,SAAS;QAAE,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,YAAY,CAAC;IAClE,OAAO,CAAC,CAAC;AACX,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,CAAgB;IAC/C,MAAM,CAAC,GAAgB;QACrB,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,WAAW,EAAE;KACrC,CAAC;IACF,IAAI,CAAC,CAAC,QAAQ,KAAK,SAAS;QAAE,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC;IACtD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,yFAAyF;AACzF,MAAM,UAAU,SAAS,CAAC,GAAY;IACpC,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IAC9C,MAAM,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC;IACxB,OAAO,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5C,CAAC"}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@haverstack/wire-types",
+  "version": "0.5.0",
+  "description": "HTTP wire types and serialization for Haverstack",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@haverstack/core": "0.5.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "typescript": "^5.5.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src"
+  }
+}