@haverstack/wire-types 0.40.0 → 0.41.0

package/dist/records.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Records, types, versions and actors
+ * -------------------------------------------------------
+ * The stored shapes as a response carries them — dates as ISO strings,
+ * optional fields absent rather than undefined — and the envelopes that
+ * page them. See docs/spec/wire-format.md.
+ */
+import type { Actor, ChangeActor, RecordVersion, StackRecord, StackType, AuthorityAssociation, DataAssociation } from '@haverstack/core';
+/**
+ * An Actor on the wire — the same two fields, spelled the same way, so an
+ * alias rather than a second definition to drift.
+ */
+export type WireActor = Actor;
+/** Who performed a change. Never who authored the record. Same shape as core's. */
+export type WireChangeActor = ChangeActor;
+/** Shared by a change frame and a journal entry — one actor encoding, not two. */
+export declare function serializeChangeActor(actor: ChangeActor): WireChangeActor;
+export type WireRecord = {
+    id: string;
+    typeId: string;
+    createdAt: string;
+    updatedAt: string;
+    content: Record<string, unknown>;
+    version: number;
+    parentId?: string;
+    appId?: string;
+    createdBy?: WireActor;
+    updatedBy?: WireActor;
+    deletedAt?: string;
+    unlistedAt?: string;
+    permissions?: AuthorityAssociation[];
+    associations?: DataAssociation[];
+};
+/**
+ * The response envelope of `GET /records` and `POST /records/query`.
+ * `cursor` is the only end-of-results signal — a page may be empty while
+ * it is non-null — and there is no count of the whole match. See
+ * docs/spec/wire-format.md § Response envelope.
+ */
+export type WireQueryResponse = {
+    records: WireRecord[];
+    cursor: string | null;
+};
+export type WireType = {
+    id: string;
+    baseId: string;
+    version: number;
+    name: string;
+    schema: Record<string, unknown>;
+    schemaHash: string;
+    migratesFrom?: string;
+    createdAt: string;
+};
+/**
+ * No `associations`, `permissions`, `parentId` or `unlistedAt`: none of the
+ * four bumps `version`, so no version ever snapshots them. See
+ * docs/spec/wire-format.md § Versions.
+ */
+export type WireVersion = {
+    version: number;
+    typeId: string;
+    content: Record<string, unknown>;
+    updatedAt: string;
+    createdBy?: WireActor;
+    updatedBy?: WireActor;
+};
+export declare function serializeRecord(r: StackRecord): WireRecord;
+export declare function serializeType(t: StackType): WireType;
+export declare function serializeVersion(v: RecordVersion): WireVersion;
+/**
+ * The response envelope of `GET /records/:id/versions`.
+ *
+ * `cursor` is the only end-of-history signal, as on the journal: a server
+ * may cap a page below the `limit` asked for. It carries the `version` to
+ * send as the next `beforeVersion`, and is null once nothing follows.
+ */
+export type WireVersionsResponse = {
+    versions: WireVersion[];
+    cursor: number | null;
+};
+//# sourceMappingURL=records.d.ts.map

package/dist/records.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"records.d.ts","sourceRoot":"","sources":["../src/records.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EACV,KAAK,EACL,WAAW,EACX,aAAa,EACb,WAAW,EACX,SAAS,EACT,oBAAoB,EACpB,eAAe,EAChB,MAAM,kBAAkB,CAAC;AAE1B;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC;AAS9B,mFAAmF;AACnF,MAAM,MAAM,eAAe,GAAG,WAAW,CAAC;AAE1C,kFAAkF;AAClF,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,WAAW,GAAG,eAAe,CAIxE;AAED,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,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACrC,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;CAClC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB,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;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,wBAAgB,eAAe,CAAC,CAAC,EAAE,WAAW,GAAG,UAAU,CAkB1D;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,SAAS,GAAG,QAAQ,CAYpD;AAED,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,aAAa,GAAG,WAAW,CAU9D;AAED;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB,CAAC"}

package/dist/records.js

@@ -0,0 +1,76 @@
+/**
+ * Records, types, versions and actors
+ * -------------------------------------------------------
+ * The stored shapes as a response carries them — dates as ISO strings,
+ * optional fields absent rather than undefined — and the envelopes that
+ * page them. See docs/spec/wire-format.md.
+ */
+/** Copied field by field, so a response never aliases a stored record's object. */
+function serializeActor(a) {
+    const w = { subjectId: a.subjectId };
+    if (a.principalId !== undefined)
+        w.principalId = a.principalId;
+    return w;
+}
+/** Shared by a change frame and a journal entry — one actor encoding, not two. */
+export function serializeChangeActor(actor) {
+    const w = serializeActor(actor);
+    if (actor.appId !== undefined)
+        w.appId = actor.appId;
+    return w;
+}
+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.appId !== undefined)
+        w.appId = r.appId;
+    if (r.createdBy !== undefined)
+        w.createdBy = serializeActor(r.createdBy);
+    if (r.updatedBy !== undefined)
+        w.updatedBy = serializeActor(r.updatedBy);
+    if (r.deletedAt !== undefined)
+        w.deletedAt = r.deletedAt.toISOString();
+    if (r.unlistedAt !== undefined)
+        w.unlistedAt = r.unlistedAt.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,
+        typeId: v.typeId,
+        content: v.content,
+        updatedAt: v.updatedAt.toISOString(),
+    };
+    if (v.createdBy !== undefined)
+        w.createdBy = serializeActor(v.createdBy);
+    if (v.updatedBy !== undefined)
+        w.updatedBy = serializeActor(v.updatedBy);
+    return w;
+}
+//# sourceMappingURL=records.js.map

package/dist/records.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"records.js","sourceRoot":"","sources":["../src/records.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAkBH,mFAAmF;AACnF,SAAS,cAAc,CAAC,CAAQ;IAC9B,MAAM,CAAC,GAAc,EAAE,SAAS,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC;IAChD,IAAI,CAAC,CAAC,WAAW,KAAK,SAAS;QAAE,CAAC,CAAC,WAAW,GAAG,CAAC,CAAC,WAAW,CAAC;IAC/D,OAAO,CAAC,CAAC;AACX,CAAC;AAKD,kFAAkF;AAClF,MAAM,UAAU,oBAAoB,CAAC,KAAkB;IACrD,MAAM,CAAC,GAAoB,cAAc,CAAC,KAAK,CAAC,CAAC;IACjD,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS;QAAE,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;IACrD,OAAO,CAAC,CAAC;AACX,CAAC;AAuDD,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,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,CAAC,CAAC,SAAS,CAAC,CAAC;IACzE,IAAI,CAAC,CAAC,SAAS,KAAK,SAAS;QAAE,CAAC,CAAC,SAAS,GAAG,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACzE,IAAI,CAAC,CAAC,SAAS,KAAK,SAAS;QAAE,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;IACvE,IAAI,CAAC,CAAC,UAAU,KAAK,SAAS;QAAE,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC;IAC1E,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,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,WAAW,EAAE;KACrC,CAAC;IACF,IAAI,CAAC,CAAC,SAAS,KAAK,SAAS;QAAE,CAAC,CAAC,SAAS,GAAG,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACzE,IAAI,CAAC,CAAC,SAAS,KAAK,SAAS;QAAE,CAAC,CAAC,SAAS,GAAG,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACzE,OAAO,CAAC,CAAC;AACX,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@haverstack/wire-types",
-  "version": "0.40.0",
+  "version": "0.41.0",
   "description": "HTTP wire types and serialization for Haverstack",
   "type": "module",
   "exports": {
@@ -21,7 +21,7 @@
   },
   "license": "CC0-1.0",
   "dependencies": {
-    "@haverstack/core": "^0.41.0"
+    "@haverstack/core": "^0.42.0"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",