@procedures/client 0.14.0 → 0.15.0

package/dist/procedures/collection/patch-in-parts.js

@@ -0,0 +1,47 @@
+/**
+ * The patch of an item of a storage (roadmap CLI-14): `patch()` of the storage, or a read, a merge
+ * and a write for a storage without it.
+ */
+import { applyPatch } from "./query.js";
+/**
+ * The patches of a storage without `patch()` that run, for each id. A patch of an id waits for the
+ * patch before it, so two patches of one process keep each field. A write of another writer
+ * between the read and the write of a patch is lost: give the storage a `patch()` for one step.
+ */
+const PATCHES = new WeakMap();
+/**
+ * This function patches an item of a storage without `patch()`: a read, a merge and a write. The
+ * check gets the stored item and the merged item before the write. An error of the check stops
+ * the patch, and the storage does not change.
+ */
+export function patchInParts(storage, id, fields, options, check) {
+    let running = PATCHES.get(storage);
+    if (!running) {
+        running = new Map();
+        PATCHES.set(storage, running);
+    }
+    const queue = running;
+    const before = queue.get(id) ?? Promise.resolve();
+    const patch = before.then(async () => {
+        const current = await storage.get(id);
+        if (current === undefined)
+            return undefined;
+        const next = applyPatch(current, fields);
+        if (check)
+            await check(current, next);
+        await storage.set(id, next, options);
+        return next;
+    });
+    const settled = patch.then(() => undefined, () => undefined);
+    queue.set(id, settled);
+    void settled.then(() => {
+        if (queue.get(id) === settled)
+            queue.delete(id);
+    });
+    return patch;
+}
+/** This function patches an item: with `patch()` of the storage, or in parts. It gives the new item, or undefined for a missing id. */
+export function patchItem(storage, id, fields, options) {
+    return storage.patch ? storage.patch(id, fields, options) : patchInParts(storage, id, fields, options);
+}
+//# sourceMappingURL=patch-in-parts.js.map

package/dist/procedures/collection/patch-in-parts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch-in-parts.js","sourceRoot":"","sources":["../../../src/procedures/collection/patch-in-parts.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,UAAU,EAAqB,MAAM,YAAY,CAAC;AAG3D;;;;GAIG;AACH,MAAM,OAAO,GAAG,IAAI,OAAO,EAAyC,CAAC;AAErE;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAmC,EACnC,EAAU,EACV,MAAoB,EACpB,OAA6B,EAC7B,KAAuD;IAEvD,IAAI,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACnC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,GAAG,IAAI,GAAG,EAAE,CAAC;QACpB,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAChC,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,CAAC;IACtB,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAClD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE;QACnC,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACtC,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,SAAS,CAAC;QAC5C,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACzC,IAAI,KAAK;YAAE,MAAM,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACtC,MAAM,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CACxB,GAAG,EAAE,CAAC,SAAS,EACf,GAAG,EAAE,CAAC,SAAS,CAChB,CAAC;IACF,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IACvB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE;QACrB,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,OAAO;YAAE,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACf,CAAC;AAED,uIAAuI;AACvI,MAAM,UAAU,SAAS,CAAC,OAAmC,EAAE,EAAU,EAAE,MAAoB,EAAE,OAA6B;IAC5H,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AACzG,CAAC"}

package/dist/procedures/collection/precondition.d.ts

@@ -0,0 +1,111 @@
+/**
+ * The precondition of a collection write (roadmap CLI-16, decision D11).
+ *
+ * - `set` and `delete` take `expectedVersion`. `setBatch` takes `expectedVersions`, with one
+ *   expected version for each id. The value is the version of the current item that the write
+ *   expects. `null` expects no item.
+ * - The version of an item is the value that the function `versionOf` of the storage gives for
+ *   the item, for example a revision field. `HybridStorage` reads the same versions with its own
+ *   `versionOf`, so its queue can send the base version of a write as the expected version.
+ * - The storage tests the precondition and writes in one step. When the version of the current
+ *   item is not the expected version, the write changes nothing, and it rejects with
+ *   `VersionConflictError`.
+ * - The error has the code `VERSION_CONFLICT` (HTTP 409). It has the current item and its version
+ *   for each conflict. On the wire, the conflicts go in the metadata key `conflicts`.
+ * - A storage without `versionOf` cannot test a precondition. It rejects such a write with a
+ *   `TypeError`, and changes nothing. It never ignores a precondition.
+ * - A write without a precondition is the same as before: the last write wins.
+ *
+ * This module has no imports: `@procedures/client/query` exports it for the storage packages.
+ */
+/** One conflict of a write with a precondition (roadmap CLI-16). The data is JSON. */
+export interface VersionConflict {
+    /** The id of the item. */
+    readonly id: string;
+    /** The version that the write expected. `null`: the write expected no item. */
+    readonly expected: string | null;
+    /** True when the id has an item now. */
+    readonly found: boolean;
+    /** The current item, when `found` is true. */
+    readonly value?: unknown;
+    /**
+     * The version of the current item: `null` when the id has no item. When the current item has no
+     * version, the field is absent.
+     */
+    readonly version?: string | null;
+}
+/** The function that gives the version of an item, or undefined for an item without a version. */
+export type VersionOf<T> = (item: T) => string | undefined;
+/** The current state of an id: no item, or an item. */
+export type CurrentItem<T> = {
+    readonly found: false;
+} | {
+    readonly found: true;
+    readonly value: T;
+};
+/** The metadata key of the conflicts of a `VERSION_CONFLICT` error on the wire. */
+export declare const VERSION_CONFLICTS_METADATA_KEY = "conflicts";
+/** The longest expected version, in characters. */
+export declare const MAX_EXPECTED_VERSION_LENGTH = 1024;
+/**
+ * A write with a precondition found an item with another version (roadmap CLI-16). The write
+ * changed nothing. `conflicts` has the current item and its version for each id of a conflict.
+ */
+export declare class VersionConflictError extends Error {
+    readonly name = "VersionConflictError";
+    /** The error code of the protocol: HTTP 409, not retryable. */
+    readonly code = "VERSION_CONFLICT";
+    /** A retry of the same write fails again: the caller reads the current item first. */
+    readonly retryable = false;
+    /** The conflicts, one for each id whose current item does not have the expected version. */
+    readonly conflicts: readonly VersionConflict[];
+    constructor(conflicts: readonly VersionConflict[], message?: string);
+}
+/**
+ * This function gives the conflict of one id, or undefined when the current item has the expected
+ * version. `null` expects no item. An item without a version never has an expected string version.
+ *
+ * @param id - The id of the item
+ * @param expected - The expected version, or `null` for no item
+ * @param current - The current state of the id
+ * @param versionOf - The version of an item
+ */
+export declare function versionConflict<T>(id: string, expected: string | null, current: CurrentItem<T>, versionOf: VersionOf<T>): VersionConflict | undefined;
+/**
+ * This function tests the preconditions of a write against the current items, and gives the
+ * conflicts. The list is empty when each precondition holds.
+ *
+ * @param expected - The expected version of each id
+ * @param currentOf - The current state of an id, before the write
+ * @param versionOf - The version of an item
+ */
+export declare function versionConflicts<T>(expected: Iterable<readonly [string, string | null]>, currentOf: (id: string) => CurrentItem<T>, versionOf: VersionOf<T>): VersionConflict[];
+/** The code of the error of a write with a precondition on a storage that cannot test it. */
+export declare const PRECONDITION_NOT_SUPPORTED = "PRECONDITION_NOT_SUPPORTED";
+/**
+ * The error of a write with a precondition on a storage that cannot test it: a storage without
+ * `versionOf`. The storage changes nothing. The error is a `TypeError` with the code
+ * `PRECONDITION_NOT_SUPPORTED`, so a sync does not take it for a network failure.
+ *
+ * @param storage - The name of the storage, for the message
+ * @param remedy - What makes the test possible
+ */
+export declare function preconditionNotSupported(storage: string, remedy?: string): TypeError & {
+    readonly code: string;
+    readonly retryable: false;
+};
+/** True for a value that a precondition can expect: a string of at most 1024 characters, or `null`. */
+export declare function isExpectedVersion(value: unknown): value is string | null;
+/**
+ * This function gives the conflicts of an error with the code `VERSION_CONFLICT`: the `conflicts`
+ * of a `VersionConflictError`, or the metadata key `conflicts` of an error from the wire (a
+ * `ClientError`). It gives undefined for another error. A `VERSION_CONFLICT` error without
+ * readable conflicts gives an empty list.
+ */
+export declare function versionConflictsOf(error: unknown): readonly VersionConflict[] | undefined;
+/**
+ * This function gives a `VersionConflictError` for an error with the code `VERSION_CONFLICT`, with
+ * its conflicts and its message. It gives undefined for another error.
+ */
+export declare function asVersionConflictError(error: unknown): VersionConflictError | undefined;
+//# sourceMappingURL=precondition.d.ts.map

package/dist/procedures/collection/precondition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"precondition.d.ts","sourceRoot":"","sources":["../../../src/procedures/collection/precondition.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,sFAAsF;AACtF,MAAM,WAAW,eAAe;IAC9B,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,+EAA+E;IAC/E,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,wCAAwC;IACxC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,8CAA8C;IAC9C,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,kGAAkG;AAClG,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,GAAG,SAAS,CAAC;AAE3D,uDAAuD;AACvD,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAAE,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC;AAErG,mFAAmF;AACnF,eAAO,MAAM,8BAA8B,cAAc,CAAC;AAE1D,mDAAmD;AACnD,eAAO,MAAM,2BAA2B,OAAO,CAAC;AAShD;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,KAAK;IAC7C,SAAkB,IAAI,0BAA0B;IAChD,+DAA+D;IAC/D,QAAQ,CAAC,IAAI,sBAAsB;IACnC,sFAAsF;IACtF,QAAQ,CAAC,SAAS,SAAS;IAC3B,4FAA4F;IAC5F,QAAQ,CAAC,SAAS,EAAE,SAAS,eAAe,EAAE,CAAC;IAE/C,YAAY,SAAS,EAAE,SAAS,eAAe,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,EAGlE;CACF;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,eAAe,GAAG,SAAS,CAKrJ;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,QAAQ,EAAE,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC,EACpD,SAAS,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,EACzC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GACtB,eAAe,EAAE,CAOnB;AAED,6FAA6F;AAC7F,eAAO,MAAM,0BAA0B,+BAA+B,CAAC;AAEvE;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,SAAiC,GAAG,SAAS,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAA;CAAE,CAEnK;AAED,uGAAuG;AACvG,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,GAAG,IAAI,CAExE;AAuBD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,SAAS,eAAe,EAAE,GAAG,SAAS,CAOzF;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,OAAO,GAAG,oBAAoB,GAAG,SAAS,CAMvF"}

package/dist/procedures/collection/precondition.js

@@ -0,0 +1,153 @@
+/**
+ * The precondition of a collection write (roadmap CLI-16, decision D11).
+ *
+ * - `set` and `delete` take `expectedVersion`. `setBatch` takes `expectedVersions`, with one
+ *   expected version for each id. The value is the version of the current item that the write
+ *   expects. `null` expects no item.
+ * - The version of an item is the value that the function `versionOf` of the storage gives for
+ *   the item, for example a revision field. `HybridStorage` reads the same versions with its own
+ *   `versionOf`, so its queue can send the base version of a write as the expected version.
+ * - The storage tests the precondition and writes in one step. When the version of the current
+ *   item is not the expected version, the write changes nothing, and it rejects with
+ *   `VersionConflictError`.
+ * - The error has the code `VERSION_CONFLICT` (HTTP 409). It has the current item and its version
+ *   for each conflict. On the wire, the conflicts go in the metadata key `conflicts`.
+ * - A storage without `versionOf` cannot test a precondition. It rejects such a write with a
+ *   `TypeError`, and changes nothing. It never ignores a precondition.
+ * - A write without a precondition is the same as before: the last write wins.
+ *
+ * This module has no imports: `@procedures/client/query` exports it for the storage packages.
+ */
+/** The metadata key of the conflicts of a `VERSION_CONFLICT` error on the wire. */
+export const VERSION_CONFLICTS_METADATA_KEY = "conflicts";
+/** The longest expected version, in characters. */
+export const MAX_EXPECTED_VERSION_LENGTH = 1024;
+/** The message of an error with some conflicts. */
+function conflictMessage(conflicts) {
+    const ids = conflicts.slice(0, 10).map((conflict) => JSON.stringify(conflict.id)).join(", ");
+    const more = conflicts.length > 10 ? ` and ${conflicts.length - 10} more` : "";
+    return `The version of the current item is not the expected version: ${ids}${more}`;
+}
+/**
+ * A write with a precondition found an item with another version (roadmap CLI-16). The write
+ * changed nothing. `conflicts` has the current item and its version for each id of a conflict.
+ */
+export class VersionConflictError extends Error {
+    name = "VersionConflictError";
+    /** The error code of the protocol: HTTP 409, not retryable. */
+    code = "VERSION_CONFLICT";
+    /** A retry of the same write fails again: the caller reads the current item first. */
+    retryable = false;
+    /** The conflicts, one for each id whose current item does not have the expected version. */
+    conflicts;
+    constructor(conflicts, message) {
+        super(message ?? conflictMessage(conflicts));
+        this.conflicts = conflicts;
+    }
+}
+/**
+ * This function gives the conflict of one id, or undefined when the current item has the expected
+ * version. `null` expects no item. An item without a version never has an expected string version.
+ *
+ * @param id - The id of the item
+ * @param expected - The expected version, or `null` for no item
+ * @param current - The current state of the id
+ * @param versionOf - The version of an item
+ */
+export function versionConflict(id, expected, current, versionOf) {
+    if (!current.found)
+        return expected === null ? undefined : { id, expected, found: false, version: null };
+    const version = versionOf(current.value);
+    if (expected !== null && version === expected)
+        return undefined;
+    return version === undefined ? { id, expected, found: true, value: current.value } : { id, expected, found: true, value: current.value, version };
+}
+/**
+ * This function tests the preconditions of a write against the current items, and gives the
+ * conflicts. The list is empty when each precondition holds.
+ *
+ * @param expected - The expected version of each id
+ * @param currentOf - The current state of an id, before the write
+ * @param versionOf - The version of an item
+ */
+export function versionConflicts(expected, currentOf, versionOf) {
+    const conflicts = [];
+    for (const [id, version] of expected) {
+        const conflict = versionConflict(id, version, currentOf(id), versionOf);
+        if (conflict)
+            conflicts.push(conflict);
+    }
+    return conflicts;
+}
+/** The code of the error of a write with a precondition on a storage that cannot test it. */
+export const PRECONDITION_NOT_SUPPORTED = "PRECONDITION_NOT_SUPPORTED";
+/**
+ * The error of a write with a precondition on a storage that cannot test it: a storage without
+ * `versionOf`. The storage changes nothing. The error is a `TypeError` with the code
+ * `PRECONDITION_NOT_SUPPORTED`, so a sync does not take it for a network failure.
+ *
+ * @param storage - The name of the storage, for the message
+ * @param remedy - What makes the test possible
+ */
+export function preconditionNotSupported(storage, remedy = "give it the option versionOf") {
+    return Object.assign(new TypeError(`${storage} cannot test expectedVersion: ${remedy}`), { code: PRECONDITION_NOT_SUPPORTED, retryable: false });
+}
+/** True for a value that a precondition can expect: a string of at most 1024 characters, or `null`. */
+export function isExpectedVersion(value) {
+    return value === null || (typeof value === "string" && value.length <= MAX_EXPECTED_VERSION_LENGTH);
+}
+/** The conflicts of untrusted data from the wire, or undefined when the data is not a list of conflicts. */
+function conflictsOfData(data) {
+    if (!Array.isArray(data))
+        return undefined;
+    const conflicts = [];
+    for (const entry of data) {
+        if (typeof entry !== "object" || entry === null)
+            return undefined;
+        const record = entry;
+        const { id, expected, found, version } = record;
+        if (typeof id !== "string" || typeof found !== "boolean" || !(expected === null || typeof expected === "string"))
+            return undefined;
+        if (!(version === undefined || version === null || typeof version === "string"))
+            return undefined;
+        conflicts.push({
+            id,
+            expected,
+            found,
+            ...(found && Object.prototype.hasOwnProperty.call(record, "value") && { value: record["value"] }),
+            ...(version !== undefined && { version }),
+        });
+    }
+    return conflicts;
+}
+/**
+ * This function gives the conflicts of an error with the code `VERSION_CONFLICT`: the `conflicts`
+ * of a `VersionConflictError`, or the metadata key `conflicts` of an error from the wire (a
+ * `ClientError`). It gives undefined for another error. A `VERSION_CONFLICT` error without
+ * readable conflicts gives an empty list.
+ */
+export function versionConflictsOf(error) {
+    if (typeof error !== "object" || error === null)
+        return undefined;
+    if (error instanceof VersionConflictError)
+        return error.conflicts;
+    const { code, conflicts, metadata } = error;
+    if (code !== "VERSION_CONFLICT")
+        return undefined;
+    const fromMetadata = typeof metadata === "object" && metadata !== null ? metadata[VERSION_CONFLICTS_METADATA_KEY] : undefined;
+    return conflictsOfData(conflicts) ?? conflictsOfData(fromMetadata) ?? [];
+}
+/**
+ * This function gives a `VersionConflictError` for an error with the code `VERSION_CONFLICT`, with
+ * its conflicts and its message. It gives undefined for another error.
+ */
+export function asVersionConflictError(error) {
+    if (error instanceof VersionConflictError)
+        return error;
+    const conflicts = versionConflictsOf(error);
+    if (conflicts === undefined)
+        return undefined;
+    const message = error instanceof Error ? error.message : undefined;
+    return new VersionConflictError(conflicts, message);
+}
+//# sourceMappingURL=precondition.js.map

package/dist/procedures/collection/precondition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"precondition.js","sourceRoot":"","sources":["../../../src/procedures/collection/precondition.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAyBH,mFAAmF;AACnF,MAAM,CAAC,MAAM,8BAA8B,GAAG,WAAW,CAAC;AAE1D,mDAAmD;AACnD,MAAM,CAAC,MAAM,2BAA2B,GAAG,IAAI,CAAC;AAEhD,mDAAmD;AACnD,SAAS,eAAe,CAAC,SAAqC;IAC5D,MAAM,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7F,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC,QAAQ,SAAS,CAAC,MAAM,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/E,OAAO,gEAAgE,GAAG,GAAG,IAAI,EAAE,CAAC;AACtF,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAC3B,IAAI,GAAG,sBAAsB,CAAC;IAChD,+DAA+D;IACtD,IAAI,GAAG,kBAAkB,CAAC;IACnC,sFAAsF;IAC7E,SAAS,GAAG,KAAK,CAAC;IAC3B,4FAA4F;IACnF,SAAS,CAA6B;IAE/C,YAAY,SAAqC,EAAE,OAAgB;QACjE,KAAK,CAAC,OAAO,IAAI,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAAI,EAAU,EAAE,QAAuB,EAAE,OAAuB,EAAE,SAAuB;IACtH,IAAI,CAAC,OAAO,CAAC,KAAK;QAAE,OAAO,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACzG,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACzC,IAAI,QAAQ,KAAK,IAAI,IAAI,OAAO,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IAChE,OAAO,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC;AACpJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAC9B,QAAoD,EACpD,SAAyC,EACzC,SAAuB;IAEvB,MAAM,SAAS,GAAsB,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,QAAQ,EAAE,CAAC;QACrC,MAAM,QAAQ,GAAG,eAAe,CAAC,EAAE,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC;QACxE,IAAI,QAAQ;YAAE,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,6FAA6F;AAC7F,MAAM,CAAC,MAAM,0BAA0B,GAAG,4BAA4B,CAAC;AAEvE;;;;;;;GAOG;AACH,MAAM,UAAU,wBAAwB,CAAC,OAAe,EAAE,MAAM,GAAG,8BAA8B;IAC/F,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC,GAAG,OAAO,iCAAiC,MAAM,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,0BAA0B,EAAE,SAAS,EAAE,KAAc,EAAE,CAAC,CAAC;AAC5J,CAAC;AAED,uGAAuG;AACvG,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,OAAO,KAAK,KAAK,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,IAAI,2BAA2B,CAAC,CAAC;AACtG,CAAC;AAED,4GAA4G;AAC5G,SAAS,eAAe,CAAC,IAAa;IACpC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,SAAS,CAAC;IAC3C,MAAM,SAAS,GAAsB,EAAE,CAAC;IACxC,KAAK,MAAM,KAAK,IAAI,IAAI,EAAE,CAAC;QACzB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;YAAE,OAAO,SAAS,CAAC;QAClE,MAAM,MAAM,GAAG,KAAgC,CAAC;QAChD,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAChD,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,SAAS,IAAI,CAAC,CAAC,QAAQ,KAAK,IAAI,IAAI,OAAO,QAAQ,KAAK,QAAQ,CAAC;YAAE,OAAO,SAAS,CAAC;QACnI,IAAI,CAAC,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ,CAAC;YAAE,OAAO,SAAS,CAAC;QAClG,SAAS,CAAC,IAAI,CAAC;YACb,EAAE;YACF,QAAQ;YACR,KAAK;YACL,GAAG,CAAC,KAAK,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YACjG,GAAG,CAAC,OAAO,KAAK,SAAS,IAAI,EAAE,OAAO,EAAE,CAAC;SAC1C,CAAC,CAAC;IACL,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAc;IAC/C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,SAAS,CAAC;IAClE,IAAI,KAAK,YAAY,oBAAoB;QAAE,OAAO,KAAK,CAAC,SAAS,CAAC;IAClE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,KAAoE,CAAC;IAC3G,IAAI,IAAI,KAAK,kBAAkB;QAAE,OAAO,SAAS,CAAC;IAClD,MAAM,YAAY,GAAG,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAE,QAAoC,CAAC,8BAA8B,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3J,OAAO,eAAe,CAAC,SAAS,CAAC,IAAI,eAAe,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;AAC3E,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CAAC,KAAc;IACnD,IAAI,KAAK,YAAY,oBAAoB;QAAE,OAAO,KAAK,CAAC;IACxD,MAAM,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAC5C,IAAI,SAAS,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC9C,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IACnE,OAAO,IAAI,oBAAoB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;AACtD,CAAC"}

package/dist/procedures/collection/procedures.d.ts

@@ -6,6 +6,7 @@
  */
 import type { ProcedureContext, AnyProcedure } from "../types.js";
 import { type StorageQueryPolicy } from "./query.js";
+import { type CollectionAdmission } from "./admission.js";
 /** The options of the change events of the collection procedures (roadmap CLI-15). */
 export interface CollectionChangeEventsOptions {
     /**
@@ -40,6 +41,13 @@ export interface CollectionProceduresOptions {
      * @default true, with the topic `collections.<name>` and no values
      */
     changeEvents?: boolean | CollectionChangeEventsOptions | undefined;
+    /**
+     * The rules of the rows (roadmap CLI-41). `admit` examines each row of each read and of each
+     * change event with values. `guard` examines each write before the storage changes, and a
+     * refused write gets `FORBIDDEN` (reason `write-not-allowed`). Without it, the procedures check
+     * only the partition.
+     */
+    admission?: CollectionAdmission | undefined;
 }
 /**
  * Create collection procedures for a specific collection name.

package/dist/procedures/collection/procedures.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"procedures.d.ts","sourceRoot":"","sources":["../../../src/procedures/collection/procedures.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAkDlE,OAAO,EAA6F,KAAK,kBAAkB,EAAE,MAAM,YAAY,CAAC;AA+BhJ,sFAAsF;AACtF,MAAM,WAAW,6BAA6B;IAC5C;;;;OAIG;IACH,KAAK,CAAC,EAAE,CAAC,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,GAAG,SAAS,KAAK,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;IACvH;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC9B;AAED,gDAAgD;AAChD,MAAM,WAAW,2BAA2B;IAC1C;;;;;OAKG;IACH,WAAW,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC7C;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,6BAA6B,GAAG,SAAS,CAAC;CACpE;AA6CD;;;;;;;;;;;;GAYG;AACH,wBAAgB,0BAA0B,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,GAAE,2BAAgC,GAAG,YAAY,EAAE,CAyT5H"}
+{"version":3,"file":"procedures.d.ts","sourceRoot":"","sources":["../../../src/procedures/collection/procedures.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAkDlE,OAAO,EAA8D,KAAK,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAIjH,OAAO,EAA8B,KAAK,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AA6BtF,sFAAsF;AACtF,MAAM,WAAW,6BAA6B;IAC5C;;;;OAIG;IACH,KAAK,CAAC,EAAE,CAAC,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,GAAG,SAAS,KAAK,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;IACvH;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC9B;AAED,gDAAgD;AAChD,MAAM,WAAW,2BAA2B;IAC1C;;;;;OAKG;IACH,WAAW,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC7C;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,6BAA6B,GAAG,SAAS,CAAC;IACnE;;;;;OAKG;IACH,SAAS,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC;CAC7C;AAwBD;;;;;;;;;;;;GAYG;AACH,wBAAgB,0BAA0B,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,GAAE,2BAAgC,GAAG,YAAY,EAAE,CA4T5H"}