@seedprotocol/sdk 0.7.7 → 0.7.8-next.1066.gac32194

package/dist/src/outbox/itemAppliers.d.ts

@@ -0,0 +1,153 @@
+import { BaseDb } from '../db/Db/BaseDb';
+import { type NewSeedFields } from '../db/write/createSeed';
+import { type MetadataType } from '../seedSchema';
+import type { PropertyType } from '../types';
+import { type OutboxOp } from './outbox';
+/**
+ * A plain value (Text, Number, Boolean, Date, List, a Relation's seed id) for one item property,
+ * as `updateItemPropertyValue` takes it: the value already in its stored string form, and the
+ * schema uid already resolved (applying runs in a transaction and mustn't wait on EAS).
+ */
+export type SetPropertyValueOp = {
+    newValue: string | null;
+    /** The property's metadata row the edit was made against, if it had one. */
+    localId?: string | null;
+    versionLocalId?: string | null;
+    versionUid?: string | null;
+    modelName?: string | null;
+    schemaUid?: string | null;
+    dataType?: string;
+    refValueType?: string;
+};
+/** The row a `set` op wrote (updateItemPropertyValue's result). */
+export type SetPropertyValueResult = {
+    localId: string;
+    uid: string | null;
+    schemaUid: string;
+} | null;
+/**
+ * An Html, File or Image value: a new storage seed whose file is already written (named after the
+ * seed, so nothing else uses it), and the property row that points at it. Applying it creates the
+ * storage seed and its version and writes the row, all in the op's transaction.
+ */
+export type StorageValueOp = {
+    storageSeed: {
+        /** Chosen when the file was written, so the file could be named after it. */
+        localId: string;
+        type: 'html' | 'file' | 'image';
+        modelFileId: string;
+        fields: NewSeedFields;
+    };
+    /** The file written for this value, deleted if the op never applies. Absent for a reference to a file that was already there. */
+    ownedFilePath?: string;
+    /** The row when the property has none yet (createMetadata). */
+    create: {
+        values: Partial<MetadataType> & {
+            modelName?: string;
+        };
+        propertyRecordSchema?: PropertyType;
+    };
+    /** The update when it has one (updateItemPropertyValue); its `localId` is filled in when applied. */
+    update: Record<string, unknown>;
+};
+/**
+ * Writes a storage value's rows on `db`. The property's row is looked up here, on `db`, rather than
+ * taken from the edit: two quick edits of a property that had no row would otherwise both create one.
+ */
+export declare function applyStorageValue(seedLocalId: string, propertyName: string, value: StorageValueOp, db: ReturnType<typeof BaseDb.getAppDb>): Promise<SetPropertyValueResult>;
+/**
+ * An ItemStorage value: content kept in the item's own file (`<seedId><extension>`), written to a
+ * staging file first. Applying it moves the staged file into place and points the property's
+ * local draft row at it (a new draft when there is none), under the file's lock.
+ */
+export type ItemStorageValueOp = {
+    itemStorage: {
+        stagedPath: string;
+        seedUid?: string | null;
+        versionLocalId?: string | null;
+        versionUid?: string | null;
+        modelType?: string | null;
+        propertyRecordSchema: PropertyType;
+    };
+};
+/** The row an ItemStorage op wrote, and where its file is. */
+export type ItemStorageValueResult = NonNullable<SetPropertyValueResult> & {
+    fileName: string;
+    localStorageDir: string;
+};
+/**
+ * Writes an ItemStorage value on `db`: the edit goes into the property's current local draft, or a
+ * new one when there is none or a published row is newer (readers show the newest row). A synced
+ * or derived row is published content and is never written to.
+ */
+export declare function applyItemStorageValue(seedLocalId: string, propertyName: string, op: ItemStorageValueOp, db: ReturnType<typeof BaseDb.getAppDb>): Promise<ItemStorageValueResult>;
+/**
+ * A new item (Item.create): its seed, its first version and a row per property, applied in one
+ * transaction, so a failure leaves nothing. The seed's local id is the op's `seedLocalId`.
+ * ItemStorage initial values are staged files, moved into the item's files when applied.
+ */
+export type CreateItemOp = {
+    modelName: string;
+    seed: {
+        type: string;
+        modelFileId?: string;
+        fields: NewSeedFields;
+    };
+    rows: Array<{
+        propertyName: string;
+        propertyValue?: unknown;
+        /** EAS schema uid, resolved before the transaction. */
+        schemaUid?: string;
+        propertyRecordSchema?: PropertyType;
+        /** An ItemStorage initial value: its staged file, moved to the item's file. */
+        itemStorage?: {
+            stagedPath: string;
+            fileName: string;
+            localStorageDir: string;
+        };
+    }>;
+};
+export type CreateItemResult = {
+    seedLocalId: string;
+    versionLocalId: string;
+};
+/** Writes a new item's rows on `db` (see CreateItemOp). */
+export declare function applyCreateItem(seedLocalId: string, value: CreateItemOp, db: ReturnType<typeof BaseDb.getAppDb>): Promise<CreateItemResult>;
+/**
+ * Removes an item: `discard` hard-deletes a draft Item.create made and couldn't finish (the seed,
+ * its versions and rows, the storage seeds its rows point at), `item` soft-deletes the seed
+ * (Item.destroy), `property` deletes a property's rows (ItemProperty.destroy).
+ */
+export type DeleteOp = {
+    mode: 'discard';
+} | {
+    mode: 'item';
+} | {
+    mode: 'property';
+    propertyNames: string[];
+}
+/** The properties' local draft rows only, so their newest attested rows show again. */
+ | {
+    mode: 'drafts';
+    propertyNames: string[];
+};
+/** Files a discarded draft's rows named, deleted once the op applied. */
+export type DeleteResult = {
+    filePaths: string[];
+};
+export declare function applyDelete(op: Pick<OutboxOp, 'opId' | 'seedLocalId'>, value: DeleteOp, db: ReturnType<typeof BaseDb.getAppDb>): Promise<DeleteResult>;
+/** Deletes files after the op that removed their rows applied; best-effort. */
+export declare function deleteFiles(filePaths: string[]): Promise<void>;
+/** A Relation value names a local seed that doesn't exist. */
+export declare class RelationTargetError extends Error {
+    readonly targets: string[];
+    constructor(targets: string[]);
+}
+/**
+ * Rethrows a failed item op's error as its caller expects it: OwnershipError when the drainer
+ * refused the op for ownership, else the OutboxOpFailedError as is.
+ */
+export declare function throwItemWriteError(error: unknown): never;
+/** Registers the item appliers and starts draining. Safe to call more than once. */
+export declare function startItemOutbox(): void;
+//# sourceMappingURL=itemAppliers.d.ts.map

package/dist/src/outbox/itemAppliers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"itemAppliers.d.ts","sourceRoot":"","sources":["../../../src/outbox/itemAppliers.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAEvC,OAAO,EAAc,KAAK,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAItE,OAAO,EAAmB,KAAK,YAAY,EAAE,MAAM,cAAc,CAAA;AACjE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAW3C,OAAO,EAML,KAAK,QAAQ,EACd,MAAM,UAAU,CAAA;AAGjB;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,4EAA4E;IAC5E,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,mEAAmE;AACnE,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;CAClB,GAAG,IAAI,CAAA;AAER;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,WAAW,EAAE;QACX,6EAA6E;QAC7E,OAAO,EAAE,MAAM,CAAA;QACf,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;QAC/B,WAAW,EAAE,MAAM,CAAA;QACnB,MAAM,EAAE,aAAa,CAAA;KACtB,CAAA;IACD,iIAAiI;IACjI,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,+DAA+D;IAC/D,MAAM,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG;YAAE,SAAS,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;QAAC,oBAAoB,CAAC,EAAE,YAAY,CAAA;KAAE,CAAA;IACvG,qGAAqG;IACrG,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAChC,CAAA;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CACrC,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,EACpB,KAAK,EAAE,cAAc,EACrB,EAAE,EAAE,UAAU,CAAC,OAAO,MAAM,CAAC,QAAQ,CAAC,GACrC,OAAO,CAAC,sBAAsB,CAAC,CAuCjC;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,EAAE;QACX,UAAU,EAAE,MAAM,CAAA;QAClB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACvB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAC9B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACzB,oBAAoB,EAAE,YAAY,CAAA;KACnC,CAAA;CACF,CAAA;AAED,8DAA8D;AAC9D,MAAM,MAAM,sBAAsB,GAAG,WAAW,CAAC,sBAAsB,CAAC,GAAG;IACzE,QAAQ,EAAE,MAAM,CAAA;IAChB,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA;AA6BD;;;;GAIG;AACH,wBAAsB,qBAAqB,CACzC,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,EACpB,EAAE,EAAE,kBAAkB,EACtB,EAAE,EAAE,UAAU,CAAC,OAAO,MAAM,CAAC,QAAQ,CAAC,GACrC,OAAO,CAAC,sBAAsB,CAAC,CAmDjC;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,aAAa,CAAA;KAAE,CAAA;IACnE,IAAI,EAAE,KAAK,CAAC;QACV,YAAY,EAAE,MAAM,CAAA;QACpB,aAAa,CAAC,EAAE,OAAO,CAAA;QACvB,uDAAuD;QACvD,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,oBAAoB,CAAC,EAAE,YAAY,CAAA;QACnC,+EAA+E;QAC/E,WAAW,CAAC,EAAE;YAAE,UAAU,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAC;YAAC,eAAe,EAAE,MAAM,CAAA;SAAE,CAAA;KAChF,CAAC,CAAA;CACH,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,cAAc,EAAE,MAAM,CAAA;CAAE,CAAA;AAE9E,2DAA2D;AAC3D,wBAAsB,eAAe,CACnC,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,YAAY,EACnB,EAAE,EAAE,UAAU,CAAC,OAAO,MAAM,CAAC,QAAQ,CAAC,GACrC,OAAO,CAAC,gBAAgB,CAAC,CA8B3B;AAED;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAChB;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,aAAa,EAAE,MAAM,EAAE,CAAA;CAAE;AAC/C,uFAAuF;GACrF;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,aAAa,EAAE,MAAM,EAAE,CAAA;CAAE,CAAA;AAE/C,yEAAyE;AACzE,MAAM,MAAM,YAAY,GAAG;IAAE,SAAS,EAAE,MAAM,EAAE,CAAA;CAAE,CAAA;AAKlD,wBAAsB,WAAW,CAC/B,EAAE,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,aAAa,CAAC,EAC1C,KAAK,EAAE,QAAQ,EACf,EAAE,EAAE,UAAU,CAAC,OAAO,MAAM,CAAC,QAAQ,CAAC,GACrC,OAAO,CAAC,YAAY,CAAC,CA6CvB;AAED,+EAA+E;AAC/E,wBAAsB,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAYpE;AAwBD,8DAA8D;AAC9D,qBAAa,mBAAoB,SAAQ,KAAK;IAChC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE;gBAAjB,OAAO,EAAE,MAAM,EAAE;CAIvC;AAwCD;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,CAKzD;AAID,oFAAoF;AACpF,wBAAgB,eAAe,IAAI,IAAI,CA+DtC"}

package/dist/src/outbox/outbox.d.ts

@@ -0,0 +1,143 @@
+import { BaseDb } from '../db/Db/BaseDb';
+import { type PendingWriteType } from '../seedSchema/PendingWriteSchema';
+export type OutboxOpKind = 'create' | 'set' | 'delete' | 'storage';
+export type OutboxOpStatus = 'pending' | 'applied' | 'superseded' | 'failed';
+export type OutboxOp = PendingWriteType;
+export type AppendOutboxOpInput = {
+    seedLocalId: string;
+    /** Null for ops on the seed itself. */
+    propertyName?: string | null;
+    kind: OutboxOpKind;
+    /** Stored as JSON. */
+    value?: unknown;
+    /** A staged file the value was written to (`storage` ops). */
+    valueRef?: string | null;
+    /** The stored metadata row the edit was made against. */
+    baseRowId?: string | null;
+    baseUid?: string | null;
+    /** Ops sharing a group id apply in one transaction. */
+    groupId?: string | null;
+};
+/** Applies ops of one kind. Registered by the code that defines the kind. */
+export type OutboxApplier<Prepared = unknown> = {
+    /**
+     * Runs before the transaction, for lookups that may call EAS or the app. Must not write.
+     */
+    prepare?: (op: OutboxOp) => Promise<Prepared>;
+    /**
+     * Writes the op on `tx`, inside the transaction that marks it applied. Must read and write only
+     * through `tx` (see BaseDb.transaction). Errors fail the op, except busy database or file errors
+     * and OutboxOpRetryableError, which are retried. What it returns is stored as the op's `result`
+     * (JSON).
+     */
+    apply: (op: OutboxOp, tx: ReturnType<typeof BaseDb.getAppDb>, prepared: Prepared) => Promise<unknown>;
+    /**
+     * Wraps the op's transaction, for locks that must be taken before it: an ItemStorage file's
+     * lock, whose other writers take it before touching the database. Calls `run` once, or throws
+     * OutboxOpDeferredError without calling it when the lock is held, so the drainer isn't kept
+     * waiting while other ops could apply.
+     */
+    around?: <T>(op: OutboxOp, run: () => Promise<T>) => Promise<T>;
+    /**
+     * Cleans up after an op that will never apply (superseded or failed): a file written for it,
+     * say. Runs after the op is settled; errors are logged and ignored.
+     */
+    discard?: (op: OutboxOp) => Promise<void>;
+};
+/** A failure worth retrying (a file the browser had locked, say). Other errors fail the op at once. */
+export declare class OutboxOpRetryableError extends Error {
+    constructor(message: string, options?: {
+        cause?: unknown;
+    });
+}
+/**
+ * An op that can't apply yet for a reason that will pass without counting as a failure: an applier's
+ * `around` found a lock held. The drainer sets the op (and its property's queue) aside for
+ * OUTBOX_DEFER_MS and goes on with other ops; its attempts aren't counted.
+ */
+export declare class OutboxOpDeferredError extends Error {
+    constructor(message: string);
+}
+/** How long a deferred op waits before the drainer tries it again. */
+export declare const OUTBOX_DEFER_MS = 50;
+/** An op that can never apply (a broken rule, an item the client doesn't own). Not retried. */
+export declare class OutboxOpRejectedError extends Error {
+    constructor(message: string, options?: {
+        cause?: unknown;
+    });
+}
+/** Rejects `waitForOutboxOp` for an op that failed, or that a failed op superseded. */
+export declare class OutboxOpFailedError extends Error {
+    readonly opId: string;
+    /** The name of the error that failed the op, when it was recorded. */
+    readonly errorName: string | null;
+    readonly code = "OUTBOX_OP_FAILED";
+    constructor(opId: string, message: string, 
+    /** The name of the error that failed the op, when it was recorded. */
+    errorName?: string | null);
+}
+/** Waits before each retry of an op that failed with a retryable error; the last is reused. */
+export declare const OUTBOX_RETRY_DELAYS_MS: number[];
+/** Attempts before a retryable error fails the op. */
+export declare const OUTBOX_MAX_ATTEMPTS = 8;
+/** Applied and superseded ops are kept this long, then pruned. */
+export declare const OUTBOX_PRUNE_AFTER_MS: number;
+/** Failed ops are kept longer, so a refused write can still be looked into. */
+export declare const OUTBOX_PRUNE_FAILED_AFTER_MS: number;
+/** Registers the applier for one op kind; returns a function that removes it. */
+export declare function registerOutboxApplier<Prepared>(kind: OutboxOpKind, applier: OutboxApplier<Prepared>): () => void;
+/**
+ * Appends one op, or several that apply together (they share a new group id unless they carry
+ * one), and tells the leader to drain. Returns the op ids in order.
+ */
+export declare function appendOutboxOps(inputs: AppendOutboxOpInput[]): Promise<string[]>;
+/** Appends one op; see appendOutboxOps. */
+export declare function appendOutboxOp(input: AppendOutboxOpInput): Promise<string>;
+/**
+ * Appends one op and waits until it settles: its applier's result once applied, or `superseded`
+ * when a newer op of its property replaced it. Rejects with OutboxOpFailedError when it fails.
+ */
+export declare function appendOutboxOpAndWait<Result = unknown>(input: AppendOutboxOpInput): Promise<{
+    superseded: false;
+    result: Result | undefined;
+} | {
+    superseded: true;
+}>;
+/** An op's stored value, decoded. */
+export declare function outboxOpValue<T = unknown>(op: Pick<OutboxOp, 'value'>): T | undefined;
+/** What an applied op's applier returned, decoded. */
+export declare function outboxOpResult<T = unknown>(op: Pick<OutboxOp, 'result'>): T | undefined;
+/**
+ * Starts draining in this tab once it is the leader, resuming ops left pending (a reload, a closed
+ * leader tab), and listens for other tabs' nudges and settled ops. Safe to call more than once.
+ */
+export declare function startOutbox(): void;
+/**
+ * Deletes settled ops older than their retention: applied and superseded ops after
+ * OUTBOX_PRUNE_AFTER_MS, failed ones after OUTBOX_PRUNE_FAILED_AFTER_MS. An applied op with an
+ * unresolved conflict stays until the conflict is resolved. Pending ops are never pruned. The
+ * leader runs it after a drain, at most hourly. Returns how many ops it deleted.
+ */
+export declare function pruneOutbox(now?: number): Promise<number>;
+/**
+ * Applies every pending op that is due, in order. Exported for tests and for code that must see
+ * the outbox applied before it continues; normally the leader drains on its own.
+ */
+export declare function drainOutbox(): Promise<void>;
+/**
+ * Resolves once the op is applied, or superseded by a newer op that applied; rejects with
+ * OutboxOpFailedError when it, or the op that superseded it, failed.
+ */
+export declare function waitForOutboxOp(opId: string): Promise<void>;
+/**
+ * Resolves once every op pending when it was called has settled (applied, superseded or failed),
+ * so a reader of `metadata` sees every edit made before. Publish waits on this before it reads.
+ */
+export declare function waitForPendingOutboxOps(): Promise<void>;
+/** The status of each op, by id; ops not found are left out. */
+export declare function getOutboxOps(opIds: string[]): Promise<OutboxOp[]>;
+/** Tests only: stops automatic drains (drainOutbox still runs) until unpaused. */
+export declare function pauseOutboxDrainForTests(pause: boolean): void;
+/** Tests only: resolves when no drain is running. */
+export declare function outboxIdleForTests(): Promise<void>;
+//# sourceMappingURL=outbox.d.ts.map

package/dist/src/outbox/outbox.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"outbox.d.ts","sourceRoot":"","sources":["../../../src/outbox/outbox.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAAiB,KAAK,gBAAgB,EAAE,MAAM,iCAAiC,CAAA;AAOtF,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,GAAG,SAAS,CAAA;AAClE,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,SAAS,GAAG,YAAY,GAAG,QAAQ,CAAA;AAC5E,MAAM,MAAM,QAAQ,GAAG,gBAAgB,CAAA;AAEvC,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,MAAM,CAAA;IACnB,uCAAuC;IACvC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,IAAI,EAAE,YAAY,CAAA;IAClB,sBAAsB;IACtB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,uDAAuD;IACvD,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACxB,CAAA;AAED,6EAA6E;AAC7E,MAAM,MAAM,aAAa,CAAC,QAAQ,GAAG,OAAO,IAAI;IAC9C;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,EAAE,EAAE,QAAQ,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;IAC7C;;;;;OAKG;IACH,KAAK,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,UAAU,CAAC,OAAO,MAAM,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IACrG;;;;;OAKG;IACH,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;IAC/D;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,EAAE,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CAC1C,CAAA;AAED,uGAAuG;AACvG,qBAAa,sBAAuB,SAAQ,KAAK;gBACnC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE;CAI3D;AAeD;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,KAAK;gBAClC,OAAO,EAAE,MAAM;CAI5B;AAED,sEAAsE;AACtE,eAAO,MAAM,eAAe,KAAK,CAAA;AAEjC,+FAA+F;AAC/F,qBAAa,qBAAsB,SAAQ,KAAK;gBAClC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE;CAI3D;AAED,uFAAuF;AACvF,qBAAa,mBAAoB,SAAQ,KAAK;IAG1C,QAAQ,CAAC,IAAI,EAAE,MAAM;IAErB,sEAAsE;IACtE,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IALnC,QAAQ,CAAC,IAAI,sBAAqB;gBAEvB,IAAI,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM;IACf,sEAAsE;IAC7D,SAAS,GAAE,MAAM,GAAG,IAAW;CAK3C;AAED,+FAA+F;AAC/F,eAAO,MAAM,sBAAsB,UAA+B,CAAA;AAClE,sDAAsD;AACtD,eAAO,MAAM,mBAAmB,IAAI,CAAA;AAKpC,kEAAkE;AAClE,eAAO,MAAM,qBAAqB,QAAsB,CAAA;AACxD,+EAA+E;AAC/E,eAAO,MAAM,4BAA4B,QAA0B,CAAA;AAMnE,iFAAiF;AACjF,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,GAAG,MAAM,IAAI,CAKhH;AAED;;;GAGG;AACH,wBAAsB,eAAe,CAAC,MAAM,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAwBtF;AAED,2CAA2C;AAC3C,wBAAsB,cAAc,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,CAGhF;AAED;;;GAGG;AACH,wBAAsB,qBAAqB,CAAC,MAAM,GAAG,OAAO,EAC1D,KAAK,EAAE,mBAAmB,GACzB,OAAO,CAAC;IAAE,UAAU,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG;IAAE,UAAU,EAAE,IAAI,CAAA;CAAE,CAAC,CAMnF;AAED,qCAAqC;AACrC,wBAAgB,aAAa,CAAC,CAAC,GAAG,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,SAAS,CAErF;AAED,sDAAsD;AACtD,wBAAgB,cAAc,CAAC,CAAC,GAAG,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,SAAS,CAEvF;AAYD;;;GAGG;AACH,wBAAgB,WAAW,IAAI,IAAI,CAQlC;AA6BD;;;;;GAKG;AACH,wBAAsB,WAAW,CAAC,GAAG,SAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAoBnE;AAED;;;GAGG;AACH,wBAAsB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAgBjD;AAoPD;;;GAGG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAmC3D;AAED;;;GAGG;AACH,wBAAsB,uBAAuB,IAAI,OAAO,CAAC,IAAI,CAAC,CAY7D;AAED,gEAAgE;AAChE,wBAAsB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAGvE;AAID,kFAAkF;AAClF,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAG7D;AAED,qDAAqD;AACrD,wBAAsB,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CAExD"}

package/dist/src/outbox/pendingValues.d.ts

@@ -0,0 +1,27 @@
+import type { MetadataType } from '../seedSchema';
+/**
+ * What a property's row will hold once its pending value ops apply (ADR 0019's read overlay): the
+ * newest pending `set` or `storage` op's fields. A reader puts these over the stored row, so a value
+ * assigned before a reload, or in another tab, shows while its op waits.
+ */
+export type PendingPropertyRow = Partial<Pick<MetadataType, 'propertyValue' | 'refSeedType' | 'refResolvedValue' | 'refResolvedDisplayValue' | 'localStorageDir'>> & {
+    /** An ItemStorage value's staged file, which holds the content until the op moves it into place. */
+    stagedPath?: string;
+};
+/** Html, Image, File and Relation rows are stored as `<name>Id`; match either spelling. */
+export declare const propertyNameVariants: (name: string) => string[];
+/**
+ * The pending row of each of the seed's properties that has a pending value op, keyed by the op's
+ * property name. Only `propertyNames` (either spelling) when given.
+ */
+export declare function getPendingPropertyRows(seedLocalId: string | null | undefined, propertyNames?: string[]): Promise<Map<string, PendingPropertyRow>>;
+/** One property's pending row (see getPendingPropertyRows); undefined when it has none. */
+export declare function getPendingPropertyRow(seedLocalId: string | null | undefined, propertyName: string | null | undefined): Promise<PendingPropertyRow | undefined>;
+/**
+ * The value an item property will have once its pending `set` ops apply, in its stored string form.
+ * Undefined when its newest pending value op is not a `set`, or it has none.
+ */
+export declare function getPendingSetValue(seedLocalId: string | null | undefined, propertyName: string | null | undefined): Promise<string | null | undefined>;
+/** Puts a pending row's fields over a stored row (not `stagedPath`, which isn't a column). */
+export declare function applyPendingRow<Row extends Partial<MetadataType>>(row: Row, pending: PendingPropertyRow): Row;
+//# sourceMappingURL=pendingValues.d.ts.map

package/dist/src/outbox/pendingValues.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pendingValues.d.ts","sourceRoot":"","sources":["../../../src/outbox/pendingValues.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAIhD;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,CACtC,IAAI,CACF,YAAY,EACZ,eAAe,GAAG,aAAa,GAAG,kBAAkB,GAAG,yBAAyB,GAAG,iBAAiB,CACrG,CACF,GAAG;IACF,oGAAoG;IACpG,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAuBD,2FAA2F;AAC3F,eAAO,MAAM,oBAAoB,GAAI,MAAM,MAAM,KAAG,MAAM,EACa,CAAA;AAEvE;;;GAGG;AACH,wBAAsB,sBAAsB,CAC1C,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EACtC,aAAa,CAAC,EAAE,MAAM,EAAE,GACvB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAyB1C;AAED,2FAA2F;AAC3F,wBAAsB,qBAAqB,CACzC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EACtC,YAAY,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GACtC,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAQzC;AAED;;;GAGG;AACH,wBAAsB,kBAAkB,CACtC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EACtC,YAAY,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GACtC,OAAO,CAAC,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,CAIpC;AAED,8FAA8F;AAC9F,wBAAgB,eAAe,CAAC,GAAG,SAAS,OAAO,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,kBAAkB,GAAG,GAAG,CAG7G"}