@photon-grove/evt 0.0.0 → 0.1.1

package/dist/errors.js

@@ -0,0 +1,240 @@
+// Every failure evt throws is an EvtError with a code, as the Rust crate returns its Error enum.
+// Domain outcomes (a rejected command, a duplicate) are values, never errors. A failure with
+// details has its own subclass, so `instanceof` narrows to its fields.
+export class EvtError extends Error {
+    name = 'EvtError';
+    code;
+    constructor(code, message, options) {
+        super(message, options);
+        this.code = code;
+    }
+}
+/** Optimistic concurrency failed on a written stream: its sequence or snapshot moved. */
+export class ConflictError extends EvtError {
+    name = 'ConflictError';
+    code = 'conflict';
+    entityId;
+    constructor(entityId, detail) {
+        super('conflict', `conflict on entity ${entityId}: ${detail}`);
+        this.entityId = entityId;
+    }
+}
+/** A commit's first event skips past the stream's head, or a load found a hole. A conflict. */
+export class SequenceGapError extends EvtError {
+    name = 'SequenceGapError';
+    code = 'sequenceGap';
+    entityId;
+    /** The last sequence before the gap. */
+    after;
+    /** The sequence found next, which isn't `after + 1`. */
+    found;
+    constructor(entityId, after, found) {
+        super('sequenceGap', `conflict on entity ${entityId}: the stream skips from sequence ${after} to ${found}: it ` +
+            'was compacted during the load, or events expired');
+        this.entityId = entityId;
+        this.after = after;
+        this.found = found;
+    }
+}
+/**
+ * A stream's head disagrees with its events or snapshot (ADR 0007): a writer appended without
+ * raising the head, events were deleted, a snapshot is ahead of the head, or a stream has data and
+ * no head. It isn't retryable: running the command again fails the same way. Repair is offline.
+ */
+export class StreamHeadDriftError extends EvtError {
+    name = 'StreamHeadDriftError';
+    code = 'streamHeadDrift';
+    entityId;
+    /** The stored head, or null when the stream has no head. */
+    stored;
+    /** The head its events and snapshot imply: the higher of the two. */
+    derived;
+    constructor(entityId, stored, derived) {
+        super('streamHeadDrift', `stream head drift on entity ${entityId}: stored head ${stored ?? 'absent'}, ` +
+            `derived head ${derived}`);
+        this.entityId = entityId;
+        this.stored = stored;
+        this.derived = derived;
+    }
+}
+/** The commit is over the transaction budget: too many actions, bytes, or bytes in one item. */
+export class CommitTooLargeError extends EvtError {
+    name = 'CommitTooLargeError';
+    code = 'commitTooLarge';
+    actions;
+    bytes;
+    largestItem;
+    constructor(actions, bytes, largestItem) {
+        super('commitTooLarge', `commit exceeds transaction budget: ${actions} actions, ${bytes} bytes, ` +
+            `largest item ${largestItem}`);
+        this.actions = actions;
+        this.bytes = bytes;
+        this.largestItem = largestItem;
+    }
+}
+/** Compaction was refused because no snapshot covers the events it would delete. */
+export class CompactionUncoveredError extends EvtError {
+    name = 'CompactionUncoveredError';
+    code = 'compactionUncovered';
+    entityId;
+    through;
+    /** The event sequence the stored snapshot covers, or null with no snapshot. */
+    covered;
+    constructor(entityId, through, covered) {
+        super('compactionUncovered', 'compaction refused: no durable snapshot covers the requested range ' +
+            `(entity ${entityId}, through ${through}, snapshot covers ${covered ?? 'nothing'})`);
+        this.entityId = entityId;
+        this.through = through;
+        this.covered = covered;
+    }
+}
+/** A write to an entity ID in a reserved namespace (`SYSTEM#`, `command-outcome#`). */
+export class ReservedEntityIdError extends EvtError {
+    name = 'ReservedEntityIdError';
+    code = 'reservedEntityId';
+    entityId;
+    constructor(entityId) {
+        super('reservedEntityId', `entity ID ${entityId} is in a reserved namespace (SYSTEM#, command-outcome#)`);
+        this.entityId = entityId;
+    }
+}
+/**
+ * The store's feature manifest declares pairs this package doesn't model, so it refuses to write:
+ * a commit, a snapshot write, compaction or initialization. Nothing was written.
+ */
+export class UnsupportedFeatureError extends EvtError {
+    name = 'UnsupportedFeatureError';
+    code = 'unsupportedFeature';
+    /** Every unsupported pair, sorted by name. */
+    unsupported;
+    constructor(unsupported) {
+        const pairs = unsupported.map((pair) => `${pair.name}@${pair.version}`).join(', ');
+        super('unsupportedFeature', `store declares unsupported features (${pairs}); refusing to write`);
+        this.unsupported = unsupported;
+    }
+}
+/**
+ * The store holds data but its feature manifest doesn't declare stream-heads: its streams may have
+ * no head items, so a head-aware write could fail every stream. Migrate the store with every older
+ * writer stopped. Nothing was written.
+ */
+export class StreamHeadsNotMigratedError extends EvtError {
+    name = 'StreamHeadsNotMigratedError';
+    code = 'streamHeadsNotMigrated';
+    constructor() {
+        super('streamHeadsNotMigrated', 'store does not declare the stream-heads feature and holds data without per-stream head ' +
+            'items; migrate it before writing');
+    }
+}
+/**
+ * The store's feature manifest doesn't declare stream-heads, and this writer doesn't initialize a
+ * store itself (the DynamoDB default), so it refuses rather than scan the table to learn whether
+ * it's fresh. Initialize a fresh store once, at deploy time, or migrate one written before stream
+ * heads. Nothing was written.
+ */
+export class StoreNotInitializedError extends EvtError {
+    name = 'StoreNotInitializedError';
+    code = 'storeNotInitialized';
+    constructor() {
+        super('storeNotInitialized', 'store is not initialized: the feature manifest does not declare stream-heads; initialize ' +
+            'a fresh store, or migrate one written before stream heads, before writing');
+    }
+}
+/**
+ * Another writer changed the store's feature manifest after this one validated it, so the commit's
+ * marker check failed. The writer has validated the new manifest, which it supports. Retryable.
+ * Nothing was written.
+ */
+export class FeatureManifestChangedError extends EvtError {
+    name = 'FeatureManifestChangedError';
+    code = 'featureManifestChanged';
+    constructor(options) {
+        super('featureManifestChanged', 'feature manifest changed under this writer', options);
+    }
+}
+/**
+ * The backend refused the write for now, such as a DynamoDB transaction cancelled for throttling.
+ * Retryable, after a backoff. Nothing was written. The backend's error is its cause.
+ */
+export class TransientError extends EvtError {
+    name = 'TransientError';
+    code = 'transient';
+    constructor(detail, options) {
+        super('transient', `transient failure: ${detail}`, options);
+    }
+}
+/**
+ * A projection rebuild holds the store, or one was force-released and no rebuild has finished
+ * since, so every commit is refused. Retryable: the command can run again once the rebuild ends.
+ */
+export class RebuildInProgressError extends EvtError {
+    name = 'RebuildInProgressError';
+    code = 'rebuildInProgress';
+    constructor() {
+        super('rebuildInProgress', 'a projection rebuild is in progress');
+    }
+}
+/**
+ * Compaction was refused because the store declares the entity's type history-dependent: its
+ * projectors' rebuild replays the events compaction would delete. Nothing was deleted.
+ */
+export class HistoryDependentProjectionError extends EvtError {
+    name = 'HistoryDependentProjectionError';
+    code = 'historyDependentProjection';
+    entityType;
+    entityId;
+    constructor(entityType, entityId) {
+        super('historyDependentProjection', `entity type ${entityType} is declared history-dependent; compaction would delete the ` +
+            `commits its rebuild replays (entity ${entityId})`);
+        this.entityType = entityType;
+        this.entityId = entityId;
+    }
+}
+/** A load failed closed on a stored event: an upcaster threw, or the payload didn't decode. */
+export class ReplayError extends EvtError {
+    name = 'ReplayError';
+    code = 'replay';
+    eventType;
+    /** The stored version, or the version an earlier upcaster produced. */
+    version;
+    phase;
+    constructor(eventType, version, phase, detail, cause) {
+        const doing = phase === 'upcast' ? 'upcasting' : 'decoding';
+        super('replay', `replay failed while ${doing} ${eventType} v${version}: ${detail}`, { cause });
+        this.eventType = eventType;
+        this.version = version;
+        this.phase = phase;
+    }
+}
+/** A load found a stored snapshot whose payload the aggregate's state codec doesn't decode. */
+export class SnapshotError extends EvtError {
+    name = 'SnapshotError';
+    code = 'snapshot';
+    entityId;
+    constructor(entityId, cause) {
+        super('snapshot', `decoding snapshot for entity ${entityId}: ${messageOf(cause)}`, { cause });
+        this.entityId = entityId;
+    }
+}
+/** Whether an error is an optimistic-concurrency conflict: a `conflict` or a `sequenceGap`. */
+export function isConflict(error) {
+    return error instanceof EvtError && (error.code === 'conflict' || error.code === 'sequenceGap');
+}
+/**
+ * Whether reloading and running the command again may succeed: after a conflict, while a rebuild
+ * holds the store, after the feature manifest changed under the writer, or after throttling.
+ */
+export function isRetryable(error) {
+    if (isConflict(error)) {
+        return true;
+    }
+    return (error instanceof EvtError &&
+        (error.code === 'rebuildInProgress' ||
+            error.code === 'featureManifestChanged' ||
+            error.code === 'transient'));
+}
+/** An error's message, or the value itself as text. */
+export function messageOf(error) {
+    return error instanceof Error ? error.message : String(error);
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,iGAAiG;AACjG,6FAA6F;AAC7F,uEAAuE;AAsDvE,MAAM,OAAO,QAAS,SAAQ,KAAK;IACf,IAAI,GAAW,UAAU,CAAA;IAClC,IAAI,CAAc;IAE3B,YAAY,IAAkB,EAAE,OAAe,EAAE,OAA2B;QAC1E,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;CACF;AAED,yFAAyF;AACzF,MAAM,OAAO,aAAc,SAAQ,QAAQ;IACvB,IAAI,GAAG,eAAe,CAAA;IACtB,IAAI,GAAG,UAAU,CAAA;IAC1B,QAAQ,CAAQ;IAEzB,YAAY,QAAgB,EAAE,MAAc;QAC1C,KAAK,CAAC,UAAU,EAAE,sBAAsB,QAAQ,KAAK,MAAM,EAAE,CAAC,CAAA;QAC9D,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC1B,CAAC;CACF;AAED,+FAA+F;AAC/F,MAAM,OAAO,gBAAiB,SAAQ,QAAQ;IAC1B,IAAI,GAAG,kBAAkB,CAAA;IACzB,IAAI,GAAG,aAAa,CAAA;IAC7B,QAAQ,CAAQ;IACzB,wCAAwC;IAC/B,KAAK,CAAQ;IACtB,wDAAwD;IAC/C,KAAK,CAAQ;IAEtB,YAAY,QAAgB,EAAE,KAAa,EAAE,KAAa;QACxD,KAAK,CACH,aAAa,EACb,sBAAsB,QAAQ,oCAAoC,KAAK,OAAO,KAAK,OAAO;YACxF,kDAAkD,CACrD,CAAA;QACD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,oBAAqB,SAAQ,QAAQ;IAC9B,IAAI,GAAG,sBAAsB,CAAA;IAC7B,IAAI,GAAG,iBAAiB,CAAA;IACjC,QAAQ,CAAQ;IACzB,4DAA4D;IACnD,MAAM,CAAe;IAC9B,qEAAqE;IAC5D,OAAO,CAAQ;IAExB,YAAY,QAAgB,EAAE,MAAqB,EAAE,OAAe;QAClE,KAAK,CACH,iBAAiB,EACjB,+BAA+B,QAAQ,iBAAiB,MAAM,IAAI,QAAQ,IAAI;YAC5E,gBAAgB,OAAO,EAAE,CAC5B,CAAA;QACD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;CACF;AAED,gGAAgG;AAChG,MAAM,OAAO,mBAAoB,SAAQ,QAAQ;IAC7B,IAAI,GAAG,qBAAqB,CAAA;IAC5B,IAAI,GAAG,gBAAgB,CAAA;IAChC,OAAO,CAAQ;IACf,KAAK,CAAQ;IACb,WAAW,CAAQ;IAE5B,YAAY,OAAe,EAAE,KAAa,EAAE,WAAmB;QAC7D,KAAK,CACH,gBAAgB,EAChB,sCAAsC,OAAO,aAAa,KAAK,UAAU;YACvE,gBAAgB,WAAW,EAAE,CAChC,CAAA;QACD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAChC,CAAC;CACF;AAED,oFAAoF;AACpF,MAAM,OAAO,wBAAyB,SAAQ,QAAQ;IAClC,IAAI,GAAG,0BAA0B,CAAA;IACjC,IAAI,GAAG,qBAAqB,CAAA;IACrC,QAAQ,CAAQ;IAChB,OAAO,CAAQ;IACxB,+EAA+E;IACtE,OAAO,CAAe;IAE/B,YAAY,QAAgB,EAAE,OAAe,EAAE,OAAsB;QACnE,KAAK,CACH,qBAAqB,EACrB,qEAAqE;YACnE,WAAW,QAAQ,aAAa,OAAO,qBAAqB,OAAO,IAAI,SAAS,GAAG,CACtF,CAAA;QACD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;CACF;AAED,uFAAuF;AACvF,MAAM,OAAO,qBAAsB,SAAQ,QAAQ;IAC/B,IAAI,GAAG,uBAAuB,CAAA;IAC9B,IAAI,GAAG,kBAAkB,CAAA;IAClC,QAAQ,CAAQ;IAEzB,YAAY,QAAgB;QAC1B,KAAK,CACH,kBAAkB,EAClB,aAAa,QAAQ,yDAAyD,CAC/E,CAAA;QACD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC1B,CAAC;CACF;AAQD;;;GAGG;AACH,MAAM,OAAO,uBAAwB,SAAQ,QAAQ;IACjC,IAAI,GAAG,yBAAyB,CAAA;IAChC,IAAI,GAAG,oBAAoB,CAAA;IAC7C,8CAA8C;IACrC,WAAW,CAAwB;IAE5C,YAAY,WAAmC;QAC7C,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClF,KAAK,CAAC,oBAAoB,EAAE,wCAAwC,KAAK,sBAAsB,CAAC,CAAA;QAChG,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAChC,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,2BAA4B,SAAQ,QAAQ;IACrC,IAAI,GAAG,6BAA6B,CAAA;IACpC,IAAI,GAAG,wBAAwB,CAAA;IAEjD;QACE,KAAK,CACH,wBAAwB,EACxB,yFAAyF;YACvF,kCAAkC,CACrC,CAAA;IACH,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,wBAAyB,SAAQ,QAAQ;IAClC,IAAI,GAAG,0BAA0B,CAAA;IACjC,IAAI,GAAG,qBAAqB,CAAA;IAE9C;QACE,KAAK,CACH,qBAAqB,EACrB,2FAA2F;YACzF,2EAA2E,CAC9E,CAAA;IACH,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,2BAA4B,SAAQ,QAAQ;IACrC,IAAI,GAAG,6BAA6B,CAAA;IACpC,IAAI,GAAG,wBAAwB,CAAA;IAEjD,YAAY,OAA2B;QACrC,KAAK,CAAC,wBAAwB,EAAE,4CAA4C,EAAE,OAAO,CAAC,CAAA;IACxF,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,cAAe,SAAQ,QAAQ;IACxB,IAAI,GAAG,gBAAgB,CAAA;IACvB,IAAI,GAAG,WAAW,CAAA;IAEpC,YAAY,MAAc,EAAE,OAA2B;QACrD,KAAK,CAAC,WAAW,EAAE,sBAAsB,MAAM,EAAE,EAAE,OAAO,CAAC,CAAA;IAC7D,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,sBAAuB,SAAQ,QAAQ;IAChC,IAAI,GAAG,wBAAwB,CAAA;IAC/B,IAAI,GAAG,mBAAmB,CAAA;IAE5C;QACE,KAAK,CAAC,mBAAmB,EAAE,qCAAqC,CAAC,CAAA;IACnE,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,+BAAgC,SAAQ,QAAQ;IACzC,IAAI,GAAG,iCAAiC,CAAA;IACxC,IAAI,GAAG,4BAA4B,CAAA;IAC5C,UAAU,CAAQ;IAClB,QAAQ,CAAQ;IAEzB,YAAY,UAAkB,EAAE,QAAgB;QAC9C,KAAK,CACH,4BAA4B,EAC5B,eAAe,UAAU,8DAA8D;YACrF,uCAAuC,QAAQ,GAAG,CACrD,CAAA;QACD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC1B,CAAC;CACF;AAED,+FAA+F;AAC/F,MAAM,OAAO,WAAY,SAAQ,QAAQ;IACrB,IAAI,GAAG,aAAa,CAAA;IACpB,IAAI,GAAG,QAAQ,CAAA;IACxB,SAAS,CAAQ;IAC1B,uEAAuE;IAC9D,OAAO,CAAQ;IACf,KAAK,CAAqB;IAEnC,YACE,SAAiB,EACjB,OAAe,EACf,KAA0B,EAC1B,MAAc,EACd,KAAe;QAEf,MAAM,KAAK,GAAG,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,UAAU,CAAA;QAC3D,KAAK,CAAC,QAAQ,EAAE,uBAAuB,KAAK,IAAI,SAAS,KAAK,OAAO,KAAK,MAAM,EAAE,EAAE,EAAC,KAAK,EAAC,CAAC,CAAA;QAC5F,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;CACF;AAED,+FAA+F;AAC/F,MAAM,OAAO,aAAc,SAAQ,QAAQ;IACvB,IAAI,GAAG,eAAe,CAAA;IACtB,IAAI,GAAG,UAAU,CAAA;IAC1B,QAAQ,CAAQ;IAEzB,YAAY,QAAgB,EAAE,KAAc;QAC1C,KAAK,CAAC,UAAU,EAAE,gCAAgC,QAAQ,KAAK,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,EAAC,KAAK,EAAC,CAAC,CAAA;QAC3F,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC1B,CAAC;CACF;AAED,+FAA+F;AAC/F,MAAM,UAAU,UAAU,CAAC,KAAc;IACvC,OAAO,KAAK,YAAY,QAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,UAAU,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa,CAAC,CAAA;AACjG,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,KAAc;IACxC,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO,CACL,KAAK,YAAY,QAAQ;QACzB,CAAC,KAAK,CAAC,IAAI,KAAK,mBAAmB;YACjC,KAAK,CAAC,IAAI,KAAK,wBAAwB;YACvC,KAAK,CAAC,IAAI,KAAK,WAAW,CAAC,CAC9B,CAAA;AACH,CAAC;AAED,uDAAuD;AACvD,MAAM,UAAU,SAAS,CAAC,KAAc;IACtC,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC/D,CAAC"}

package/dist/event.d.ts

@@ -0,0 +1,47 @@
+import { type JsonObject } from './fields.js';
+import { type Metadata } from './metadata.js';
+/** An event as it is stored. Its JSON is the `detail` of a stream envelope. */
+export interface SerializedEvent {
+    /** `{entityId}:{sequence}`. */
+    id: string;
+    /** The 1-based position of the event in its stream. */
+    sequence: bigint;
+    /** The event kind, such as `account:opened`. */
+    type: string;
+    /** The payload's schema version. */
+    version: number;
+    /** The stream the event belongs to. */
+    entityId: string;
+    /** The aggregate type of the entity. */
+    entityType: string;
+    /**
+     * The payload bytes, stored verbatim. Null only when decoded from a JSON `null`, which is
+     * written back as `null`, as Go does.
+     */
+    payload: Uint8Array | null;
+    metadata: Metadata;
+}
+/** A snapshot of aggregate state. A stream keeps at most one, its latest. */
+export interface SerializedSnapshot {
+    entityType: string;
+    entityId: string;
+    /** 1 for an entity's first snapshot, then one more for each. */
+    sequence: bigint;
+    /** The last event sequence folded into the snapshot. */
+    eventSequence: bigint;
+    /** The state's bytes, stored verbatim. Null only when decoded from a JSON `null`. */
+    payload: Uint8Array | null;
+}
+/** The event ID for a sequence of a stream: `{entityId}:{sequence}`. */
+export declare function eventId(entityId: string, sequence: bigint): string;
+/** Encodes an event as the JSON Go writes for it. */
+export declare function encodeEvent(event: SerializedEvent): string;
+/** Decodes an event's JSON leniently, as Go does. */
+export declare function decodeEvent(json: string): SerializedEvent;
+/** Encodes a snapshot as the JSON Go writes for it. Its entity ID key is `entityID`. */
+export declare function encodeSnapshot(snapshot: SerializedSnapshot): string;
+/** Decodes a snapshot's JSON leniently, as Go does. */
+export declare function decodeSnapshot(json: string): SerializedSnapshot;
+export declare function eventJson(event: SerializedEvent): object;
+export declare function eventFromJson(value: JsonObject | null): SerializedEvent;
+//# sourceMappingURL=event.d.ts.map

package/dist/event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.d.ts","sourceRoot":"","sources":["../src/event.ts"],"names":[],"mappings":"AAGA,OAAO,EASL,KAAK,UAAU,EAChB,MAAM,aAAa,CAAA;AAEpB,OAAO,EAAC,KAAK,QAAQ,EAAiC,MAAM,eAAe,CAAA;AAE3E,+EAA+E;AAC/E,MAAM,WAAW,eAAe;IAC9B,+BAA+B;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,uDAAuD;IACvD,QAAQ,EAAE,MAAM,CAAA;IAChB,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAA;IACZ,oCAAoC;IACpC,OAAO,EAAE,MAAM,CAAA;IACf,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAA;IAChB,wCAAwC;IACxC,UAAU,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,OAAO,EAAE,UAAU,GAAG,IAAI,CAAA;IAC1B,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,6EAA6E;AAC7E,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,gEAAgE;IAChE,QAAQ,EAAE,MAAM,CAAA;IAChB,wDAAwD;IACxD,aAAa,EAAE,MAAM,CAAA;IACrB,qFAAqF;IACrF,OAAO,EAAE,UAAU,GAAG,IAAI,CAAA;CAC3B;AAED,wEAAwE;AACxE,wBAAgB,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAElE;AAED,qDAAqD;AACrD,wBAAgB,WAAW,CAAC,KAAK,EAAE,eAAe,GAAG,MAAM,CAE1D;AAED,qDAAqD;AACrD,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,CAEzD;AAED,wFAAwF;AACxF,wBAAgB,cAAc,CAAC,QAAQ,EAAE,kBAAkB,GAAG,MAAM,CAQnE;AAED,uDAAuD;AACvD,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,kBAAkB,CAU/D;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,eAAe,GAAG,MAAM,CAWxD;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI,GAAG,eAAe,CAavE"}

package/dist/event.js

@@ -0,0 +1,64 @@
+// Serialized events and snapshots: the stored form every repository reads and writes, and their
+// JSON encodings, which match Go's evt.SerializedEvent and evt.SerializedSnapshot.
+import { DOCUMENT, bytesField, int64Argument, int64Field, objectOrNull, safeIntegerArgument, safeIntegerField, stringField, } from './fields.js';
+import { parseJson, stringifyJson } from './json.js';
+import { metadataFromJson, metadataJson } from './metadata.js';
+/** The event ID for a sequence of a stream: `{entityId}:{sequence}`. */
+export function eventId(entityId, sequence) {
+    return `${entityId}:${sequence}`;
+}
+/** Encodes an event as the JSON Go writes for it. */
+export function encodeEvent(event) {
+    return stringifyJson(eventJson(event));
+}
+/** Decodes an event's JSON leniently, as Go does. */
+export function decodeEvent(json) {
+    return eventFromJson(objectOrNull(parseJson(json, DOCUMENT), 'event'));
+}
+/** Encodes a snapshot as the JSON Go writes for it. Its entity ID key is `entityID`. */
+export function encodeSnapshot(snapshot) {
+    return stringifyJson({
+        entityType: snapshot.entityType,
+        entityID: snapshot.entityId,
+        sequence: int64Argument(snapshot.sequence, 'snapshot.sequence'),
+        eventSequence: int64Argument(snapshot.eventSequence, 'snapshot.eventSequence'),
+        payload: snapshot.payload,
+    });
+}
+/** Decodes a snapshot's JSON leniently, as Go does. */
+export function decodeSnapshot(json) {
+    const object = objectOrNull(parseJson(json, DOCUMENT), 'snapshot') ?? new Map();
+    return {
+        entityType: stringField(object, 'entityType', 'snapshot'),
+        entityId: stringField(object, 'entityID', 'snapshot'),
+        sequence: int64Field(object, 'sequence', 'snapshot'),
+        eventSequence: int64Field(object, 'eventSequence', 'snapshot'),
+        payload: bytesField(object, 'payload', 'snapshot'),
+    };
+}
+export function eventJson(event) {
+    return {
+        id: event.id,
+        sequence: int64Argument(event.sequence, 'event.sequence'),
+        type: event.type,
+        version: safeIntegerArgument(event.version, 'event.version'),
+        entityId: event.entityId,
+        entityType: event.entityType,
+        payload: event.payload,
+        metadata: metadataJson(event.metadata),
+    };
+}
+export function eventFromJson(value) {
+    const object = value ?? new Map();
+    return {
+        id: stringField(object, 'id', 'event'),
+        sequence: int64Field(object, 'sequence', 'event'),
+        type: stringField(object, 'type', 'event'),
+        version: safeIntegerField(object, 'version', 'event'),
+        entityId: stringField(object, 'entityId', 'event'),
+        entityType: stringField(object, 'entityType', 'event'),
+        payload: bytesField(object, 'payload', 'event'),
+        metadata: metadataFromJson(object.get('metadata')),
+    };
+}
+//# sourceMappingURL=event.js.map

package/dist/event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.js","sourceRoot":"","sources":["../src/event.ts"],"names":[],"mappings":"AAAA,gGAAgG;AAChG,mFAAmF;AAEnF,OAAO,EACL,QAAQ,EACR,UAAU,EACV,aAAa,EACb,UAAU,EACV,YAAY,EACZ,mBAAmB,EACnB,gBAAgB,EAChB,WAAW,GAEZ,MAAM,aAAa,CAAA;AACpB,OAAO,EAAC,SAAS,EAAE,aAAa,EAAC,MAAM,WAAW,CAAA;AAClD,OAAO,EAAgB,gBAAgB,EAAE,YAAY,EAAC,MAAM,eAAe,CAAA;AAoC3E,wEAAwE;AACxE,MAAM,UAAU,OAAO,CAAC,QAAgB,EAAE,QAAgB;IACxD,OAAO,GAAG,QAAQ,IAAI,QAAQ,EAAE,CAAA;AAClC,CAAC;AAED,qDAAqD;AACrD,MAAM,UAAU,WAAW,CAAC,KAAsB;IAChD,OAAO,aAAa,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;AACxC,CAAC;AAED,qDAAqD;AACrD,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,OAAO,aAAa,CAAC,YAAY,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC,CAAA;AACxE,CAAC;AAED,wFAAwF;AACxF,MAAM,UAAU,cAAc,CAAC,QAA4B;IACzD,OAAO,aAAa,CAAC;QACnB,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,QAAQ,EAAE,QAAQ,CAAC,QAAQ;QAC3B,QAAQ,EAAE,aAAa,CAAC,QAAQ,CAAC,QAAQ,EAAE,mBAAmB,CAAC;QAC/D,aAAa,EAAE,aAAa,CAAC,QAAQ,CAAC,aAAa,EAAE,wBAAwB,CAAC;QAC9E,OAAO,EAAE,QAAQ,CAAC,OAAO;KAC1B,CAAC,CAAA;AACJ,CAAC;AAED,uDAAuD;AACvD,MAAM,UAAU,cAAc,CAAC,IAAY;IACzC,MAAM,MAAM,GAAG,YAAY,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,UAAU,CAAC,IAAI,IAAI,GAAG,EAAE,CAAA;IAE/E,OAAO;QACL,UAAU,EAAE,WAAW,CAAC,MAAM,EAAE,YAAY,EAAE,UAAU,CAAC;QACzD,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC;QACrD,QAAQ,EAAE,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC;QACpD,aAAa,EAAE,UAAU,CAAC,MAAM,EAAE,eAAe,EAAE,UAAU,CAAC;QAC9D,OAAO,EAAE,UAAU,CAAC,MAAM,EAAE,SAAS,EAAE,UAAU,CAAC;KACnD,CAAA;AACH,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAsB;IAC9C,OAAO;QACL,EAAE,EAAE,KAAK,CAAC,EAAE;QACZ,QAAQ,EAAE,aAAa,CAAC,KAAK,CAAC,QAAQ,EAAE,gBAAgB,CAAC;QACzD,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,OAAO,EAAE,mBAAmB,CAAC,KAAK,CAAC,OAAO,EAAE,eAAe,CAAC;QAC5D,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,QAAQ,EAAE,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC;KACvC,CAAA;AACH,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAAwB;IACpD,MAAM,MAAM,GAAG,KAAK,IAAI,IAAI,GAAG,EAAE,CAAA;IAEjC,OAAO;QACL,EAAE,EAAE,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC;QACtC,QAAQ,EAAE,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC;QACjD,IAAI,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC;QAC1C,OAAO,EAAE,gBAAgB,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC;QACrD,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC;QAClD,UAAU,EAAE,WAAW,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC;QACtD,OAAO,EAAE,UAAU,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC;QAC/C,QAAQ,EAAE,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;KACnD,CAAA;AACH,CAAC"}

package/dist/features.d.ts

@@ -0,0 +1,55 @@
+import { type FeaturePair } from './errors.js';
+/** The feature every writer models and requires: per-stream head items (ADR 0007). */
+export declare const STREAM_HEADS_FEATURE = "stream-heads";
+/** The stored-format version of {@link STREAM_HEADS_FEATURE} this package reads and writes. */
+export declare const STREAM_HEADS_VERSION = 1;
+/**
+ * The `(feature, stored-format version)` pairs this package models. The other features the
+ * storage format defines (`journal`, `journal-compaction`, `postgres-views`) are Rust-first, so a
+ * store that declares any of them is refused.
+ */
+export declare const SUPPORTED_FEATURES: readonly FeaturePair[];
+/** The parsed marker row. A store with no marker row has no manifest. */
+export interface FeatureManifest {
+    /** Bumped by exactly one on every declaration. */
+    readonly version: bigint;
+    /** Each declared feature's stored-format version. */
+    readonly features: ReadonlyMap<string, number>;
+    /** The entity types whose commit-wide projectors are history-dependent: never compacted. */
+    readonly historyDependent: readonly string[];
+    /** The entity types configured with retention: never fenced. */
+    readonly retention: readonly string[];
+}
+/**
+ * Refuses a manifest that declares a pair this package doesn't model, listing every such pair,
+ * with an {@link UnsupportedFeatureError}.
+ */
+export declare function checkSupported(manifest: FeatureManifest | null): void;
+/** Whether the manifest declares stream-heads at the version this package models. */
+export declare function declaresStreamHeads(manifest: FeatureManifest | null): boolean;
+/**
+ * Refuses a write to a store whose manifest declares an unsupported pair, or doesn't declare
+ * stream-heads, without declaring anything.
+ */
+export declare function checkWritable(manifest: FeatureManifest | null): void;
+/** The manifest with stream-heads declared and its version bumped: a first writer's declaration. */
+export declare function withStreamHeads(manifest: FeatureManifest | null): FeatureManifest;
+/** A manifest's stored JSON texts, as the marker row holds them. */
+export interface ManifestTexts {
+    /** A JSON object, feature name to stored-format version, keys sorted. `{}` when empty. */
+    features: string;
+    /** A JSON array of entity types, sorted by UTF-8 bytes and deduplicated. `[]` when empty. */
+    historyDependent: string;
+    /** Like `historyDependent`. */
+    retention: string;
+}
+/** Encodes a manifest's declarable parts as the marker row stores them. */
+export declare function encodeManifest(manifest: FeatureManifest): ManifestTexts;
+/**
+ * Decodes a marker row's stored texts. An empty text is an empty map or set, as an absent
+ * attribute is.
+ */
+export declare function decodeManifest(version: bigint, texts: ManifestTexts): FeatureManifest;
+/** An entity-type set in its stored order: sorted by UTF-8 bytes and deduplicated. */
+export declare function entityTypeSet(types: readonly string[]): string[];
+//# sourceMappingURL=features.d.ts.map

package/dist/features.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"features.d.ts","sourceRoot":"","sources":["../src/features.ts"],"names":[],"mappings":"AAKA,OAAO,EAEL,KAAK,WAAW,EAGjB,MAAM,aAAa,CAAA;AAKpB,sFAAsF;AACtF,eAAO,MAAM,oBAAoB,iBAAiB,CAAA;AAElD,+FAA+F;AAC/F,eAAO,MAAM,oBAAoB,IAAI,CAAA;AAErC;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,EAAE,SAAS,WAAW,EAEnD,CAAA;AAKF,yEAAyE;AACzE,MAAM,WAAW,eAAe;IAC9B,kDAAkD;IAClD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,qDAAqD;IACrD,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC9C,4FAA4F;IAC5F,QAAQ,CAAC,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAA;IAC5C,gEAAgE;IAChE,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAA;CACtC;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI,GAAG,IAAI,CAWrE;AAED,qFAAqF;AACrF,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI,GAAG,OAAO,CAE7E;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI,GAAG,IAAI,CAKpE;AAED,oGAAoG;AACpG,wBAAgB,eAAe,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI,GAAG,eAAe,CAUjF;AAED,oEAAoE;AACpE,MAAM,WAAW,aAAa;IAC5B,0FAA0F;IAC1F,QAAQ,EAAE,MAAM,CAAA;IAChB,6FAA6F;IAC7F,gBAAgB,EAAE,MAAM,CAAA;IACxB,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,2EAA2E;AAC3E,wBAAgB,cAAc,CAAC,QAAQ,EAAE,eAAe,GAAG,aAAa,CAMvE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,GAAG,eAAe,CAOrF;AAED,sFAAsF;AACtF,wBAAgB,aAAa,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,EAAE,CAMhE"}

package/dist/features.js

@@ -0,0 +1,126 @@
+// The feature manifest a store keeps on its SYSTEM#FEATURES marker row (storage format, "Feature
+// marker"): the extensions it declares, each at a stored-format version, and the entity types
+// declared history-dependent or retained. A writer refuses a store that declares a pair it doesn't
+// model, and every writer requires stream-heads.
+import { EvtError, StreamHeadsNotMigratedError, UnsupportedFeatureError, } from './errors.js';
+import { DOCUMENT, int64, invalid } from './fields.js';
+import { parseJson, stringifyJson } from './json.js';
+import { compareUtf8 } from './utf8.js';
+/** The feature every writer models and requires: per-stream head items (ADR 0007). */
+export const STREAM_HEADS_FEATURE = 'stream-heads';
+/** The stored-format version of {@link STREAM_HEADS_FEATURE} this package reads and writes. */
+export const STREAM_HEADS_VERSION = 1;
+/**
+ * The `(feature, stored-format version)` pairs this package models. The other features the
+ * storage format defines (`journal`, `journal-compaction`, `postgres-views`) are Rust-first, so a
+ * store that declares any of them is refused.
+ */
+export const SUPPORTED_FEATURES = Object.freeze([
+    Object.freeze({ name: STREAM_HEADS_FEATURE, version: STREAM_HEADS_VERSION }),
+]);
+// What validation reads. Private, so no caller can add a pair to it.
+const supported = new Map(SUPPORTED_FEATURES.map((pair) => [pair.name, pair.version]));
+/**
+ * Refuses a manifest that declares a pair this package doesn't model, listing every such pair,
+ * with an {@link UnsupportedFeatureError}.
+ */
+export function checkSupported(manifest) {
+    const unsupported = [];
+    for (const [name, version] of sortedFeatures(manifest?.features ?? new Map())) {
+        if (supported.get(name) !== version) {
+            unsupported.push({ name, version });
+        }
+    }
+    if (unsupported.length > 0) {
+        throw new UnsupportedFeatureError(unsupported);
+    }
+}
+/** Whether the manifest declares stream-heads at the version this package models. */
+export function declaresStreamHeads(manifest) {
+    return manifest?.features.get(STREAM_HEADS_FEATURE) === STREAM_HEADS_VERSION;
+}
+/**
+ * Refuses a write to a store whose manifest declares an unsupported pair, or doesn't declare
+ * stream-heads, without declaring anything.
+ */
+export function checkWritable(manifest) {
+    checkSupported(manifest);
+    if (!declaresStreamHeads(manifest)) {
+        throw new StreamHeadsNotMigratedError();
+    }
+}
+/** The manifest with stream-heads declared and its version bumped: a first writer's declaration. */
+export function withStreamHeads(manifest) {
+    const features = new Map(manifest?.features);
+    features.set(STREAM_HEADS_FEATURE, STREAM_HEADS_VERSION);
+    return {
+        version: (manifest?.version ?? 0n) + 1n,
+        features,
+        historyDependent: manifest?.historyDependent ?? [],
+        retention: manifest?.retention ?? [],
+    };
+}
+/** Encodes a manifest's declarable parts as the marker row stores them. */
+export function encodeManifest(manifest) {
+    return {
+        features: stringifyJson(new Map(manifest.features)),
+        historyDependent: stringifyJson(entityTypeSet(manifest.historyDependent)),
+        retention: stringifyJson(entityTypeSet(manifest.retention)),
+    };
+}
+/**
+ * Decodes a marker row's stored texts. An empty text is an empty map or set, as an absent
+ * attribute is.
+ */
+export function decodeManifest(version, texts) {
+    return {
+        version,
+        features: texts.features === '' ? new Map() : parseFeatures(texts.features),
+        historyDependent: parseEntityTypes(texts.historyDependent, 'historyDependent'),
+        retention: parseEntityTypes(texts.retention, 'retention'),
+    };
+}
+/** An entity-type set in its stored order: sorted by UTF-8 bytes and deduplicated. */
+export function entityTypeSet(types) {
+    // A fresh array, sorted in place: ES2022 has no toSorted.
+    const set = Array.from(new Set(types));
+    set.sort(compareUtf8);
+    return set;
+}
+function parseFeatures(text) {
+    const parsed = parseStored(text, 'features');
+    if (!(parsed instanceof Map)) {
+        throw invalid('the feature manifest is not a JSON object');
+    }
+    // Go and Rust read a version as an int64. One past the safe integers is no version this
+    // package models, so rounding it changes only the refusal's text.
+    const features = new Map();
+    for (const [name, version] of parsed) {
+        features.set(name, Number(int64(version, `the feature manifest's ${name} version`)));
+    }
+    return features;
+}
+function parseEntityTypes(text, what) {
+    if (text.trim() === '') {
+        return [];
+    }
+    const parsed = parseStored(text, what);
+    if (!Array.isArray(parsed) || parsed.some((entry) => typeof entry !== 'string')) {
+        throw invalid(`the ${what} set is not a JSON array of strings`);
+    }
+    return entityTypeSet(parsed);
+}
+function parseStored(text, what) {
+    try {
+        return parseJson(text, DOCUMENT);
+    }
+    catch (error) {
+        throw new EvtError('invalidRecord', `the stored ${what} is not JSON`, { cause: error });
+    }
+}
+function sortedFeatures(features) {
+    const sorted = Array.from(features);
+    sorted.sort(([a], [b]) => compareUtf8(a, b));
+    return sorted;
+}
+//# sourceMappingURL=features.js.map

package/dist/features.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"features.js","sourceRoot":"","sources":["../src/features.ts"],"names":[],"mappings":"AAAA,iGAAiG;AACjG,8FAA8F;AAC9F,mGAAmG;AACnG,iDAAiD;AAEjD,OAAO,EACL,QAAQ,EAER,2BAA2B,EAC3B,uBAAuB,GACxB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAC,MAAM,aAAa,CAAA;AACpD,OAAO,EAAiB,SAAS,EAAE,aAAa,EAAC,MAAM,WAAW,CAAA;AAClE,OAAO,EAAC,WAAW,EAAC,MAAM,WAAW,CAAA;AAErC,sFAAsF;AACtF,MAAM,CAAC,MAAM,oBAAoB,GAAG,cAAc,CAAA;AAElD,+FAA+F;AAC/F,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAA;AAErC;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAA2B,MAAM,CAAC,MAAM,CAAC;IACtE,MAAM,CAAC,MAAM,CAAC,EAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,EAAE,oBAAoB,EAAC,CAAC;CAC3E,CAAC,CAAA;AAEF,qEAAqE;AACrE,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;AActF;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,QAAgC;IAC7D,MAAM,WAAW,GAAkB,EAAE,CAAA;IACrC,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,cAAc,CAAC,QAAQ,EAAE,QAAQ,IAAI,IAAI,GAAG,EAAE,CAAC,EAAE,CAAC;QAC9E,IAAI,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,OAAO,EAAE,CAAC;YACpC,WAAW,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,OAAO,EAAC,CAAC,CAAA;QACnC,CAAC;IACH,CAAC;IAED,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,uBAAuB,CAAC,WAAW,CAAC,CAAA;IAChD,CAAC;AACH,CAAC;AAED,qFAAqF;AACrF,MAAM,UAAU,mBAAmB,CAAC,QAAgC;IAClE,OAAO,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,oBAAoB,CAAC,KAAK,oBAAoB,CAAA;AAC9E,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,QAAgC;IAC5D,cAAc,CAAC,QAAQ,CAAC,CAAA;IACxB,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,2BAA2B,EAAE,CAAA;IACzC,CAAC;AACH,CAAC;AAED,oGAAoG;AACpG,MAAM,UAAU,eAAe,CAAC,QAAgC;IAC9D,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAC5C,QAAQ,CAAC,GAAG,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CAAA;IAExD,OAAO;QACL,OAAO,EAAE,CAAC,QAAQ,EAAE,OAAO,IAAI,EAAE,CAAC,GAAG,EAAE;QACvC,QAAQ;QACR,gBAAgB,EAAE,QAAQ,EAAE,gBAAgB,IAAI,EAAE;QAClD,SAAS,EAAE,QAAQ,EAAE,SAAS,IAAI,EAAE;KACrC,CAAA;AACH,CAAC;AAYD,2EAA2E;AAC3E,MAAM,UAAU,cAAc,CAAC,QAAyB;IACtD,OAAO;QACL,QAAQ,EAAE,aAAa,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACnD,gBAAgB,EAAE,aAAa,CAAC,aAAa,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;QACzE,SAAS,EAAE,aAAa,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;KAC5D,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,OAAe,EAAE,KAAoB;IAClE,OAAO;QACL,OAAO;QACP,QAAQ,EAAE,KAAK,CAAC,QAAQ,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC3E,gBAAgB,EAAE,gBAAgB,CAAC,KAAK,CAAC,gBAAgB,EAAE,kBAAkB,CAAC;QAC9E,SAAS,EAAE,gBAAgB,CAAC,KAAK,CAAC,SAAS,EAAE,WAAW,CAAC;KAC1D,CAAA;AACH,CAAC;AAED,sFAAsF;AACtF,MAAM,UAAU,aAAa,CAAC,KAAwB;IACpD,0DAA0D;IAC1D,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAA;IACtC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IAErB,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,SAAS,aAAa,CAAC,IAAY;IACjC,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;IAC5C,IAAI,CAAC,CAAC,MAAM,YAAY,GAAG,CAAC,EAAE,CAAC;QAC7B,MAAM,OAAO,CAAC,2CAA2C,CAAC,CAAA;IAC5D,CAAC;IAED,wFAAwF;IACxF,kEAAkE;IAClE,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAkB,CAAA;IAC1C,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,MAAM,EAAE,CAAC;QACrC,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,0BAA0B,IAAI,UAAU,CAAC,CAAC,CAAC,CAAA;IACtF,CAAC;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAY,EAAE,IAAY;IAClD,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACvB,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IACtC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,EAAE,CAAC;QAChF,MAAM,OAAO,CAAC,OAAO,IAAI,qCAAqC,CAAC,CAAA;IACjE,CAAC;IAED,OAAO,aAAa,CAAC,MAAkB,CAAC,CAAA;AAC1C,CAAC;AAED,SAAS,WAAW,CAAC,IAAY,EAAE,IAAY;IAC7C,IAAI,CAAC;QACH,OAAO,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;IAClC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,QAAQ,CAAC,eAAe,EAAE,cAAc,IAAI,cAAc,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAA;IACvF,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,QAAqC;IAC3D,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IACnC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAE5C,OAAO,MAAM,CAAA;AACf,CAAC"}

package/dist/fields.d.ts

@@ -0,0 +1,31 @@
+import { EvtError } from './errors.js';
+import { type JsonValue, type ParseOptions } from './json.js';
+export type JsonObject = Map<string, JsonValue>;
+/** How evt parses its own documents: a repeated key is refused. */
+export declare const DOCUMENT: ParseOptions;
+export declare function invalid(message: string): EvtError;
+/** An object, or null for JSON null. */
+export declare function objectOrNull(value: JsonValue | undefined, what: string): JsonObject | null;
+/** A string field, `""` when missing or null. */
+export declare function stringField(object: JsonObject, name: string, what: string): string;
+/** A string field that may be null (a Go `*string`). */
+export declare function nullableString(object: JsonObject, name: string, what: string): string | null;
+/** An int64 field, `0n` when missing or null. `1.0`, `1e3` and `"1"` are refused, as in Go. */
+export declare function int64Field(object: JsonObject, name: string, what: string): bigint;
+/** A small integer field, `0` when missing or null, refused if it isn't a safe integer. */
+export declare function safeIntegerField(object: JsonObject, name: string, what: string): number;
+/** Reads a JSON number as an int64. */
+export declare function int64(value: JsonValue, what: string): bigint;
+/** Refuses an integer outside int64. */
+export declare function checkInt64(value: bigint, what: string): bigint;
+/** Refuses to write an integer that no reader would read back as an int64. */
+export declare function int64Argument(value: bigint, what: string): bigint;
+/** Refuses to write a small integer that isn't a safe integer, such as 1.5 or NaN. */
+export declare function safeIntegerArgument(value: number, what: string): number;
+/** A base64 field (a Go `[]byte`), null when missing or null. */
+export declare function bytesField(object: JsonObject, name: string, what: string): Uint8Array | null;
+/**
+ * A Go `map[string]string`: null for a missing or null map, and `""` for a null value.
+ */
+export declare function stringMap(value: JsonValue | undefined, what: string): Map<string, string> | null;
+//# sourceMappingURL=fields.d.ts.map

package/dist/fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../src/fields.ts"],"names":[],"mappings":"AAKA,OAAO,EAAC,QAAQ,EAAC,MAAM,aAAa,CAAA;AACpC,OAAO,EAAa,KAAK,SAAS,EAAE,KAAK,YAAY,EAAC,MAAM,WAAW,CAAA;AAEvE,MAAM,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;AAM/C,mEAAmE;AACnE,eAAO,MAAM,QAAQ,EAAE,YAAwC,CAAA;AAE/D,wBAAgB,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ,CAEjD;AAED,wCAAwC;AACxC,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAS1F;AAED,iDAAiD;AACjD,wBAAgB,WAAW,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAElF;AAED,wDAAwD;AACxD,wBAAgB,cAAc,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAU5F;AAED,+FAA+F;AAC/F,wBAAgB,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAOjF;AAED,2FAA2F;AAC3F,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAOvF;AAED,uCAAuC;AACvC,wBAAgB,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAM5D;AAED,wCAAwC;AACxC,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAM9D;AAED,8EAA8E;AAC9E,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAMjE;AAED,sFAAsF;AACtF,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAMvE;AAED,iEAAiE;AACjE,wBAAgB,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAI5F;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAgBhG"}