@haverstack/core 0.40.0 → 0.42.0

package/dist/type-handle.js

@@ -2,130 +2,63 @@
  * Stack — Type handles
  * -------------------------------------------------------
  * A Type's schema written once as a literal, from which the compiler derives
- * the content type: `ContentOf` for a read or a create, `PatchOf` for a
- * `contentPatch`. A handle is a plain value, so `StackClient` code can use it
- * wherever it has no `defineType()` result.
+ * the content type: `ContentOf` for a create, `StoredContentOf` for a read.
+ * A handle is a plain value, so `StackClient`
+ * code can use it wherever it has no `defineType()` result.
  *
  * The derived types layer over runtime validation, which stays the guarantee.
- * What a typed read adds is a runtime check that the record is the handle's
- * Type. See docs/spec/data-model.md § Type handles.
+ * A handle reaches records through `client.collection(handle)`; see
+ * collection.ts and docs/spec/data-model.md § Type handles.
  */
-import { StackBadRequestError, StackValidationError } from './errors.js';
-import { parseTypeId } from './schema.js';
+import { StackBadRequestError, StackMigrationError } from './errors.js';
+import { lineageProblem, parseTypeId } from './schema.js';
+import { applySteps, fieldOrigins, recordOrigins } from './migration-steps.js';
 /**
- * Name a Type and its schema in one literal. Pass the result to
- * `defineType({ ...handle, name })` and to the typed overloads of
- * `StackClient`. A handle names exactly one version: `Book.baseId` is the
- * argument a call about the whole family takes.
+ * Name a Type, its display name, its schema and the version it migrates
+ * from in one literal. Pass the result to `defineType()`, a manifest's
+ * `types` and `StackClient.collection()`. A handle names exactly
+ * one version: `Book.baseId` is the argument a call about the whole family
+ * takes.
  */
-export const typeHandle = (id, schema) => {
+export const typeHandle = ({ id, name, schema, migratesFrom, }) => {
     const parsed = parseTypeId(id);
     if (!parsed) {
         throw new StackBadRequestError(`Invalid TypeId format: "${id}". Expected "namespace/name@version", e.g. "com.example.myapp/note@1".`);
     }
-    return Object.freeze({ id, baseId: parsed.baseId, schema });
-};
-export const isTypeHandle = (value) => typeof value === 'object' &&
-    value !== null &&
-    typeof value.id === 'string' &&
-    typeof value.baseId === 'string' &&
-    typeof value.schema === 'object';
-// -------------------------------------------------------
-// Runtime narrowing
-// -------------------------------------------------------
-/**
- * Enum values the record holds that the handle's schema does not list. An
- * enum may gain values within a version, so a reader older than the writer
- * can meet one; throwing keeps the derived union exact.
- */
-const unknownEnumValues = (value, def, path, errors) => {
-    if (value === undefined || value === null)
-        return;
-    if (def.kind === 'string') {
-        if (def.enum && typeof value === 'string' && !def.enum.includes(value)) {
-            errors.push({
-                path,
-                message: `Expected one of ${def.enum.map((v) => JSON.stringify(v)).join(', ')}, got ${JSON.stringify(value)}`,
-            });
-        }
-        return;
-    }
-    if (def.kind === 'array' && !def.open && Array.isArray(value)) {
-        value.forEach((item, i) => unknownEnumValues(item, def.items, `${path}[${i}]`, errors));
-        return;
-    }
-    if (def.kind === 'object' && !def.open && typeof value === 'object' && !Array.isArray(value)) {
-        walkEnums(value, def.properties, path, errors);
-    }
-};
-const walkEnums = (content, schema, prefix, errors) => {
-    for (const key of Object.keys(schema)) {
-        unknownEnumValues(content[key], schema[key], prefix ? `${prefix}.${key}` : key, errors);
-    }
+    const from = typeof migratesFrom === 'object' && migratesFrom !== null ? migratesFrom.id : migratesFrom;
+    const problem = lineageProblem(id, from);
+    if (problem)
+        throw new StackBadRequestError(problem);
+    return Object.freeze({
+        id,
+        baseId: parsed.baseId,
+        name,
+        schema,
+        ...(from !== undefined && { migratesFrom: from }),
+    });
 };
 /**
- * Narrow a record to a handle's content type: it must be exactly the
- * handle's Type, and every enum field must hold a value the handle lists.
- * A record of another Type throws, and so does one whose family has moved
- * past the handle's version.
+ * Build the migration from `from` to `to` out of declared steps, checked
+ * against both schemas here so a step the target would refuse fails before
+ * any record is written. Within a family, `to` must name `from` as its
+ * `migratesFrom`. See docs/spec/data-model.md § Migration steps.
  */
-export const narrowRecord = (handle, record) => {
-    if (record.typeId !== handle.id) {
-        throw new StackBadRequestError(`Record "${record.id}" is ${record.typeId}, not ${handle.id}`);
+export const migration = (from, to, steps) => {
+    const refuse = (problem) => new StackMigrationError(`Cannot migrate "${from.id}" to "${to.id}": ${problem}.`);
+    if (to.baseId === from.baseId && to.migratesFrom !== from.id) {
+        throw refuse(`"${to.id}" migrates from ${to.migratesFrom ? `"${to.migratesFrom}"` : 'nothing'}`);
     }
-    const errors = [];
-    walkEnums(record.content, handle.schema, '', errors);
-    if (errors.length > 0)
-        throw new StackValidationError(errors);
-    return record;
-};
-/** The ways a typed read can be asked to see a tombstone. */
-export const assertLiveFilter = (filter) => {
-    if (filter?.includeDeleted) {
-        throw new StackBadRequestError('A typed read sees live records only; use the untyped read to include soft-deleted records.');
-    }
-};
-export const typedGet = async (client, handle, id) => {
-    const record = await client.get(id, { presentAt: 'latest' });
-    return record && narrowRecord(handle, record);
-};
-export const typedQuery = async (client, handle, query = {}) => {
-    assertLiveFilter(query.filter);
-    // The family, not the handle's version: a record still at an older
-    // version must be migrated up, or refused as stale, never skipped.
-    const result = await client.query({
-        ...query,
-        filter: { ...query.filter, baseId: handle.baseId },
-        presentAt: 'latest',
+    const frozen = Object.freeze([...steps]);
+    const origins = fieldOrigins(frozen, from.schema, to.schema);
+    if (typeof origins === 'string')
+        throw refuse(origins);
+    const built = Object.freeze({
+        from: from.id,
+        to: to.id,
+        steps: frozen,
+        migrate: (content) => applySteps(frozen, content),
     });
-    return { ...result, records: result.records.map((r) => narrowRecord(handle, r)) };
+    recordOrigins(built, origins);
+    return built;
 };
-export const typedCreate = async (client, handle, content, opts) => client.create(handle.id, content, opts);
-export const typedMutate = async (client, handle, id, changes, opts) => {
-    // A patch is validated against the record's own stored Type, so one made
-    // through a handle for another version would be checked by a schema it
-    // was not written for. A missing, unreadable or deleted record is left to
-    // mutate(), which refuses it in its own words.
-    const current = await client.get(id, { includeDeleted: true });
-    if (current && current.typeId !== handle.id) {
-        throw new StackBadRequestError(`Record "${id}" is ${current.typeId}, not ${handle.id}`);
-    }
-    return narrowRecord(handle, await client.mutate(id, changes, opts));
-};
-export const typedSubscribe = (client, handle, handler, opts = {}) => 
-// Exactly the handle's version: an event carries its record as stored, so
-// a subscription cannot migrate it the way a typed read does, and a
-// record of another version has no honest typing here.
-client.subscribe((change) => {
-    const { record, ...rest } = change;
-    let narrowed;
-    try {
-        narrowed = record && narrowRecord(handle, record);
-    }
-    catch (err) {
-        if (!(err instanceof StackValidationError))
-            throw err;
-    }
-    handler(narrowed ? { ...rest, record: narrowed } : rest);
-}, { ...opts, filter: { ...opts.filter, typeId: handle.id } });
 //# sourceMappingURL=type-handle.js.map

package/dist/type-handle.js.map

@@ -1 +1 @@
-{"version":3,"file":"type-handle.js","sourceRoot":"","sources":["../src/type-handle.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AA+H1C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,EAAU,EACV,MAAS,EACM,EAAE;IACjB,MAAM,MAAM,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC;IAC/B,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,oBAAoB,CAC5B,2BAA2B,EAAE,wEAAwE,CACtG,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;AAC9D,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,KAAc,EAAuB,EAAE,CAClE,OAAO,KAAK,KAAK,QAAQ;IACzB,KAAK,KAAK,IAAI;IACd,OAAQ,KAAoB,CAAC,EAAE,KAAK,QAAQ;IAC5C,OAAQ,KAAoB,CAAC,MAAM,KAAK,QAAQ;IAChD,OAAQ,KAAoB,CAAC,MAAM,KAAK,QAAQ,CAAC;AAkCnD,0DAA0D;AAC1D,oBAAoB;AACpB,0DAA0D;AAE1D;;;;GAIG;AACH,MAAM,iBAAiB,GAAG,CACxB,KAAc,EACd,GAAqB,EACrB,IAAY,EACZ,MAAyB,EACnB,EAAE;IACR,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO;IAClD,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC1B,IAAI,GAAG,CAAC,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACvE,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI;gBACJ,OAAO,EAAE,mBAAmB,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;aAC9G,CAAC,CAAC;QACL,CAAC;QACD,OAAO;IACT,CAAC;IACD,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9D,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC;QACxF,OAAO;IACT,CAAC;IACD,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7F,SAAS,CAAC,KAAgC,EAAE,GAAG,CAAC,UAAU,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAChB,OAAgC,EAChC,MAA0B,EAC1B,MAAc,EACd,MAAyB,EACnB,EAAE;IACR,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACtC,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC1F,CAAC;AACH,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,MAAqB,EACrB,MAAmB,EACH,EAAE;IAClB,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,EAAE,EAAE,CAAC;QAChC,MAAM,IAAI,oBAAoB,CAAC,WAAW,MAAM,CAAC,EAAE,QAAQ,MAAM,CAAC,MAAM,SAAS,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;IAChG,CAAC;IACD,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IACrD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,IAAI,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAC9D,OAAO,MAAwB,CAAC;AAClC,CAAC,CAAC;AAEF,6DAA6D;AAC7D,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAA0B,EAAQ,EAAE;IACnE,IAAK,MAAmC,EAAE,cAAc,EAAE,CAAC;QACzD,MAAM,IAAI,oBAAoB,CAC5B,4FAA4F,CAC7F,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAQF,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,EAC3B,MAAgB,EAChB,MAAqB,EACrB,EAAY,EACoB,EAAE;IAClC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC7D,OAAO,MAAM,IAAI,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAC7B,MAAgB,EAChB,MAAqB,EACrB,QAAoB,EAAE,EACyC,EAAE;IACjE,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/B,mEAAmE;IACnE,mEAAmE;IACnE,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC;QAChC,GAAG,KAAK;QACR,MAAM,EAAE,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE;QAClD,SAAS,EAAE,QAAQ;KACpB,CAAC,CAAC;IACH,OAAO,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AACpF,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,EAC9B,MAAgB,EAChB,MAAqB,EACrB,OAAqB,EACrB,IAA0B,EACD,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,CAA4B,CAAC;AAEjG,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,EAC9B,MAAgB,EAChB,MAAqB,EACrB,EAAY,EACZ,OAA0B,EAC1B,IAAuB,EACE,EAAE;IAC3B,yEAAyE;IACzE,uEAAuE;IACvE,0EAA0E;IAC1E,+CAA+C;IAC/C,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/D,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,CAAC,EAAE,EAAE,CAAC;QAC5C,MAAM,IAAI,oBAAoB,CAAC,WAAW,EAAE,QAAQ,OAAO,CAAC,MAAM,SAAS,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;IAC1F,CAAC;IACD,OAAO,YAAY,CAAC,MAAM,EAAE,MAAM,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;AACtE,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,MAAgB,EAChB,MAAqB,EACrB,OAAyC,EACzC,OAA8B,EAAE,EACV,EAAE;AACxB,0EAA0E;AAC1E,oEAAoE;AACpE,uDAAuD;AACvD,MAAM,CAAC,SAAS,CACd,CAAC,MAAM,EAAE,EAAE;IACT,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACnC,IAAI,QAAoC,CAAC;IACzC,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,IAAI,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,CAAC,GAAG,YAAY,oBAAoB,CAAC;YAAE,MAAM,GAAG,CAAC;IACxD,CAAC;IACD,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAC3D,CAAC,EACD,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,EAAE,CAC3D,CAAC"}
+{"version":3,"file":"type-handle.js","sourceRoot":"","sources":["../src/type-handle.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACxE,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1D,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AA4H/E;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAqC,EAC7D,EAAE,EACF,IAAI,EACJ,MAAM,EACN,YAAY,GAMb,EAAiB,EAAE;IAClB,MAAM,MAAM,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC;IAC/B,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,oBAAoB,CAC5B,2BAA2B,EAAE,wEAAwE,CACtG,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GACR,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,KAAK,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC;IAC7F,MAAM,OAAO,GAAG,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IACzC,IAAI,OAAO;QAAE,MAAM,IAAI,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACrD,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,EAAE;QACF,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,IAAI;QACJ,MAAM;QACN,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;KAClD,CAAC,CAAC;AACL,CAAC,CAAC;AAoBF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CACvB,IAAmB,EACnB,EAAiB,EACjB,KAA4D,EACT,EAAE;IACrD,MAAM,MAAM,GAAG,CAAC,OAAe,EAAE,EAAE,CACjC,IAAI,mBAAmB,CAAC,mBAAmB,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,MAAM,OAAO,GAAG,CAAC,CAAC;IACpF,IAAI,EAAE,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,YAAY,KAAK,IAAI,CAAC,EAAE,EAAE,CAAC;QAC7D,MAAM,MAAM,CACV,IAAI,EAAE,CAAC,EAAE,mBAAmB,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,CACnF,CAAC;IACJ,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAA6B,CAAC;IACrE,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC;IAC7D,IAAI,OAAO,OAAO,KAAK,QAAQ;QAAE,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC;IACvD,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;QAC1B,IAAI,EAAE,IAAI,CAAC,EAAE;QACb,EAAE,EAAE,EAAE,CAAC,EAAE;QACT,KAAK,EAAE,MAAM;QACb,OAAO,EAAE,CAAC,OAAgC,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC;KAC3E,CAAiE,CAAC;IACnE,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC9B,OAAO,KAAK,CAAC;AACf,CAAC,CAAC"}

package/dist/types/adapter.d.ts

@@ -0,0 +1,223 @@
+/**
+ * The storage adapter interfaces and the per-call options Stack hands them.
+ */
+import type { AssociationEdit, RecordChangeSet } from './associations.js';
+import type { StackCapabilities } from './capabilities.js';
+import type { RecordChange, Unsubscribe, SubscribeOptions } from './events.js';
+import type { RecordId, TypeId, FileId, AppId, EntityId, Actor } from './ids.js';
+import type { JournalEntryInput, RecordJournalEntry, JournalQuery } from './journal.js';
+import type { StackQuery, QueryResult } from './query.js';
+import type { StackRecord, RecordVersion, VersionsQuery } from './records.js';
+import type { StackType } from './schema.js';
+/**
+ * Opt-in optimistic-concurrency precondition. On mismatch the mutation
+ * throws StackVersionConflictError and changes nothing; an adapter checks
+ * it atomically inside its write. See docs/spec/versioning.md § Optimistic
+ * concurrency (`ifVersion`).
+ */
+export type IfVersionOptions = {
+    ifVersion?: number;
+};
+/**
+ * Accepted by every mutating StackRecordAdapter method. The adapter
+ * persists this prior-state snapshot as part of the SAME atomic write as
+ * the mutation, so a crash between the two can't leave an orphan versions
+ * row. Server-backed adapters (already atomic per-request) can ignore it.
+ */
+export type SnapshotOptions = {
+    snapshot?: RecordVersion;
+};
+/**
+ * Whether a mutateRecord() call advances `version`/`updatedAt`. `Stack`
+ * computes it from what the change set moves; absent means `true`.
+ * See docs/spec/versioning.md § Version history.
+ */
+export type BumpVersionOptions = {
+    bumpsVersion?: boolean;
+};
+/**
+ * Who is performing a mutation, stamped onto the record in the same write.
+ * `ScopedStack` supplies it from the request's identities; a caller of
+ * plain `Stack` supplies it only when reconstructing an attributed write.
+ * See docs/spec/data-model.md § Authorship and attribution.
+ */
+export type ActorOptions = {
+    actor?: Actor;
+};
+/**
+ * Accepted by every mutating StackRecordAdapter method. The adapter
+ * appends the entry, allocating its `seq`, inside the SAME write as the
+ * mutation, so a crash cannot leave a change unjournaled.
+ */
+export type JournalOptions = {
+    journal?: JournalEntryInput;
+};
+/**
+ * What every mutating StackRecordAdapter method that bumps `version` takes.
+ * mutateRecord() adds BumpVersionOptions and deleteRecord() adds `purge`.
+ */
+export type MutateOptions = IfVersionOptions & SnapshotOptions & ActorOptions & JournalOptions;
+/** The metadata an upload's `_attachment@1` record carries beside its bytes. */
+export type PutAttachmentOptions = {
+    mimeType: string;
+    filename?: string;
+    /** Attribution for the metadata record, as create()'s `appId`. */
+    appId?: AppId;
+};
+/**
+ * The record-storage half of an adapter: structured data, queries,
+ * associations, versioning, type definitions, and stack identity.
+ */
+export interface StackRecordAdapter {
+    readonly capabilities: StackCapabilities;
+    /** DID of the stack owner. Set during adapter initialization. */
+    readonly ownerEntityId: EntityId;
+    /**
+     * IANA timezone string for this stack, or undefined if never set.
+     * Passthrough app metadata with no default — see docs/spec.md § The
+     * `_config` record.
+     */
+    readonly timezone: string | undefined;
+    /**
+     * Throws StackConflictError if `record.id` already exists — never a
+     * silent overwrite. The check must be atomic with the write (a PK/unique
+     * constraint or equivalent); Stack itself doesn't pre-check, so a raw
+     * adapter that skips this enforces nothing.
+     */
+    createRecord(record: StackRecord, opts?: JournalOptions): Promise<StackRecord>;
+    getRecord(id: RecordId): Promise<StackRecord | null>;
+    /**
+     * Apply a change set in one write — the only multi-aspect atomic write a
+     * record has, so a publish cannot half-land. Never touches `typeId`; see
+     * commitMigration(). `Stack` validates it and computes `bumpsVersion`,
+     * and never hands an adapter a change set that changes nothing.
+     * See docs/spec/data-model.md § Mutations.
+     */
+    mutateRecord(id: RecordId, changes: RecordChangeSet, opts?: MutateOptions & BumpVersionOptions): Promise<StackRecord>;
+    /**
+     * Returns the record this call acted on: as it now stands after a soft
+     * delete, and as it stood immediately before destruction after a
+     * purge — captured inside the same write, so nothing can observe or alter
+     * it in between. Null when there was no record to delete, which is the
+     * only case that mutates nothing.
+     */
+    deleteRecord(id: RecordId, opts?: {
+        purge?: boolean;
+    } & MutateOptions): Promise<StackRecord | null>;
+    /** Reverse a soft delete. Returns the record as it now stands. */
+    undeleteRecord(id: RecordId, opts?: MutateOptions): Promise<StackRecord>;
+    /**
+     * `query.sort`, when present, always carries a `direction`: `Stack`
+     * resolves the defaults before any adapter sees the query.
+     */
+    queryRecords(query: StackQuery): Promise<QueryResult>;
+    /**
+     * Apply a list of adds and removes as one write, all or none, removes
+     * before adds. Never bumps `version`/`updatedAt` and never snapshots — a
+     * set-add composes regardless of write order. A list mixing authority
+     * and data elements is refused.
+     * See docs/spec/adapters.md § Amending associations.
+     */
+    amendAssociations(id: RecordId, changes: AssociationEdit[], opts?: JournalOptions): Promise<StackRecord>;
+    /**
+     * Snapshots newest first; omitting `query` reads every version.
+     * See docs/spec/versioning.md § Version history.
+     */
+    getVersions(id: RecordId, query?: VersionsQuery): Promise<RecordVersion[]>;
+    getVersion(id: RecordId, version: number): Promise<RecordVersion | null>;
+    /**
+     * Standalone snapshot write, outside of a mutation's own atomic path.
+     * Mutating methods above take a `snapshot` option instead, so the
+     * snapshot and the mutation land in one write — see SnapshotOptions.
+     */
+    saveVersion(id: RecordId, version: RecordVersion): Promise<void>;
+    /**
+     * Read a record's change journal, oldest first — required, on the same
+     * footing as getVersions(). A recovery mechanism an app cannot rely on is
+     * most of the way to no mechanism at all, so an adapter with no journal
+     * refuses the call rather than declining to have the method.
+     * See docs/spec/journal.md § Reading it.
+     */
+    getJournal(id: RecordId, query?: JournalQuery): Promise<RecordJournalEntry[]>;
+    /**
+     * Restore a record to a previous version's `content` and `typeId` —
+     * everything a snapshot carries. Containment, listing and associations
+     * are left where they stand, there being nothing to restore them *from*.
+     * Bumps version internally; throws StackNotFoundError if the version
+     * doesn't exist.
+     */
+    restoreVersion(id: RecordId, version: number, opts?: MutateOptions): Promise<StackRecord>;
+    /**
+     * Commit a migration: write new content under a new typeId in one step.
+     * This is the only way a record's typeId changes after creation — used by
+     * Stack.commitMigration() and Stack.migrateAll(); Stack.mutate() never
+     * changes typeId as a side effect. Bumps version internally.
+     */
+    commitMigration(id: RecordId, toTypeId: TypeId, content: Record<string, unknown>, opts?: MutateOptions): Promise<StackRecord>;
+    saveType(type: StackType): Promise<void>;
+    getType(id: TypeId): Promise<StackType | null>;
+    listTypes(): Promise<StackType[]>;
+    /**
+     * Atomically verify fileId is unreferenced and purge its metadata
+     * records, returning them; StackConflictError if still referenced.
+     * Optional — Stack.deleteAttachment() has a non-atomic fallback.
+     * `metadataTypeIds` is the resolved `_attachment` family, so an adapter
+     * needs no baseId concept. See docs/spec/attachments.md § Deleting attachments.
+     */
+    deleteUnreferencedAttachmentRecords?(fileId: FileId, metadataTypeIds: TypeId[]): Promise<StackRecord[]>;
+    /**
+     * Relay changes that originated elsewhere — the inverse direction from
+     * `Stack`, which emits every change made through it. Optional, and
+     * absent on every local adapter: exactly one process owns a stack's
+     * storage, so locally there is no third party whose writes could have
+     * been missed. See docs/spec/events.md § Where events come from.
+     */
+    subscribeChanges?(opts: SubscribeOptions, handler: (change: RecordChange) => void): Promise<Unsubscribe>;
+    flush?(): Promise<void>;
+    close?(): Promise<void>;
+}
+/** One stored blob, as reported by StackBlobAdapter.listBlobs(). */
+export type BlobInfo = {
+    fileId: FileId;
+    size: number;
+    /** When the blob was written. Used to apply a GC grace period to fresh, not-yet-associated uploads. */
+    modifiedAt: Date;
+};
+/**
+ * The blob-storage half of an adapter. Handles raw binary data only;
+ * attachment metadata lives on _attachment@1 records in the record adapter.
+ */
+export interface StackBlobAdapter {
+    putBlob(data: Uint8Array): Promise<FileId>;
+    /**
+     * Returns a plain `Uint8Array` (never a subclass such as `Buffer`) that the
+     * caller owns: changing it never changes the stored bytes.
+     */
+    getBlob(fileId: FileId): Promise<Uint8Array>;
+    deleteBlob(fileId: FileId): Promise<void>;
+    /**
+     * Enumerate every blob currently in storage. Optional — without it,
+     * garbage collection can't find bare-bytes orphans (bytes with no
+     * metadata record at all). See docs/spec/attachments.md § Garbage
+     * collection.
+     */
+    listBlobs?(): Promise<BlobInfo[]>;
+    flush?(): Promise<void>;
+    close?(): Promise<void>;
+}
+/**
+ * A complete adapter: record storage and blob storage combined.
+ * Pass this to Stack.open(). Build one with combineAdapters() when you
+ * want different backends for records and blobs (e.g. SQLite + S3).
+ */
+export type StackAdapter = StackRecordAdapter & StackBlobAdapter & {
+    /**
+     * Store bytes and create the accompanying _attachment@1 record as one
+     * atomic operation. Optional; implement only when bytes and records
+     * live behind a single boundary (today: APIAdapter alone), and never
+     * synthesized by combineAdapters(). A security boundary, not an
+     * efficiency shortcut — see docs/spec/adapters.md § Interface split.
+     */
+    putAttachmentWithMetadata?(data: Uint8Array, opts: PutAttachmentOptions): Promise<StackRecord>;
+};
+//# sourceMappingURL=adapter.d.ts.map

package/dist/types/adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../src/types/adapter.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjF,OAAO,KAAK,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACxF,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC9E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,CAAC,EAAE,aAAa,CAAC;CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,CAAC,EAAE,iBAAiB,CAAC;CAC7B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,gBAAgB,GAAG,eAAe,GAAG,YAAY,GAAG,cAAc,CAAC;AAE/F,gFAAgF;AAChF,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kEAAkE;IAClE,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,YAAY,EAAE,iBAAiB,CAAC;IAEzC,iEAAiE;IACjE,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC;IACjC;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAGtC;;;;;OAKG;IACH,YAAY,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC/E,SAAS,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;IACrD;;;;;;OAMG;IACH,YAAY,CACV,EAAE,EAAE,QAAQ,EACZ,OAAO,EAAE,eAAe,EACxB,IAAI,CAAC,EAAE,aAAa,GAAG,kBAAkB,GACxC,OAAO,CAAC,WAAW,CAAC,CAAC;IACxB;;;;;;OAMG;IACH,YAAY,CACV,EAAE,EAAE,QAAQ,EACZ,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,aAAa,GACzC,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;IAC/B,kEAAkE;IAClE,cAAc,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACzE;;;OAGG;IACH,YAAY,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAGtD;;;;;;OAMG;IACH,iBAAiB,CACf,EAAE,EAAE,QAAQ,EACZ,OAAO,EAAE,eAAe,EAAE,EAC1B,IAAI,CAAC,EAAE,cAAc,GACpB,OAAO,CAAC,WAAW,CAAC,CAAC;IAGxB;;;OAGG;IACH,WAAW,CAAC,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IAC3E,UAAU,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IACzE;;;;OAIG;IACH,WAAW,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjE;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAC9E;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAE1F;;;;;OAKG;IACH,eAAe,CACb,EAAE,EAAE,QAAQ,EACZ,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,IAAI,CAAC,EAAE,aAAa,GACnB,OAAO,CAAC,WAAW,CAAC,CAAC;IAGxB,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;IAC/C,SAAS,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAElC;;;;;;OAMG;IACH,mCAAmC,CAAC,CAClC,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAE1B;;;;;;OAMG;IACH,gBAAgB,CAAC,CACf,IAAI,EAAE,gBAAgB,EACtB,OAAO,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,GACtC,OAAO,CAAC,WAAW,CAAC,CAAC;IAGxB,KAAK,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACxB,KAAK,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB;AAED,oEAAoE;AACpE,MAAM,MAAM,QAAQ,GAAG;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,uGAAuG;IACvG,UAAU,EAAE,IAAI,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAE/B,OAAO,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3C;;;OAGG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC7C,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1C;;;;;OAKG;IACH,SAAS,CAAC,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAGlC,KAAK,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACxB,KAAK,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,kBAAkB,GAC3C,gBAAgB,GAAG;IACjB;;;;;;OAMG;IACH,yBAAyB,CAAC,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CAChG,CAAC"}

package/dist/types/adapter.js

@@ -0,0 +1,5 @@
+/**
+ * The storage adapter interfaces and the per-call options Stack hands them.
+ */
+export {};
+//# sourceMappingURL=adapter.js.map

package/dist/types/adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../../src/types/adapter.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/dist/types/associations.d.ts

@@ -0,0 +1,156 @@
+/**
+ * Associations: the edges a Record carries, authority and data alike,
+ * and the change shapes that move them.
+ */
+import type { RecordId, FileId, EntityId } from './ids.js';
+export type TagAssociation = {
+    kind: 'tag';
+    label: string;
+};
+/**
+ * `attachmentRecordId` names the `_attachment` record whose upload
+ * established this reference — annotation, not identity, since `fileId`
+ * alone is what GC, the `referencesFileId` filter and file access ask
+ * about. See docs/spec/attachments.md § Naming the upload a reference came from.
+ */
+export type AttachmentAssociation = {
+    kind: 'attachment';
+    label: string;
+    fileId: FileId;
+    attachmentRecordId?: RecordId;
+};
+/**
+ * A Record in this stack, or in another one. `stackUrl` is what makes a
+ * RecordId meaningful outside the stack that minted it — absent means this
+ * stack. See docs/spec/data-model.md § Associations.
+ */
+export type RecordTarget = {
+    kind: 'record';
+    recordId: RecordId;
+    stackUrl?: string;
+};
+/**
+ * A "who" — a DID, which means the same thing in every stack. Group
+ * rosters are the canonical use: membership names identities, not records.
+ * See docs/spec/identity.md § Group.
+ */
+export type EntityTarget = {
+    kind: 'entity';
+    entityId: EntityId;
+};
+/**
+ * Something outside the stack entirely. `ns` names the scheme that
+ * interprets `id` — e.g. "atproto", "activitypub", "email", "url" — so an
+ * app selects on it rather than sniffing the identifier.
+ * See docs/spec/data-model.md § Relationship targets.
+ */
+export type ExternalTarget = {
+    kind: 'external';
+    ns: string;
+    id: string;
+};
+/** What a relationship association points at. */
+export type RelationshipTarget = RecordTarget | EntityTarget | ExternalTarget;
+export type RelationshipAssociation = {
+    kind: 'relationship';
+    label: string;
+    target: RelationshipTarget;
+};
+/**
+ * A grant of access to the Record carrying it. The bit is the label, so
+ * granting and revoking are a plain add and remove and the element's
+ * identity carries its whole meaning. Its grantee shape is its own rather
+ * than a `RelationshipTarget`: a target names no role and has no group
+ * arm. See docs/spec/access-control.md § Record-level permissions.
+ */
+export type PermissionAssociation = {
+    kind: 'permission';
+    label: 'read' | 'write';
+    grantee: Grantee;
+};
+/** An entity's standing within a `_group` Record's roster. `admin` implies `member` for ACL purposes. */
+export type GroupRole = 'member' | 'admin';
+/**
+ * The grantee arms both permission layers share, spelled identically so a
+ * value built for one is valid for the other. `role` is required — `member`
+ * is the wider set, `admin` the narrower, matching the roster labels where
+ * admin implies member. See docs/spec/access-control.md § Who a grant reaches.
+ */
+export type Grantee = {
+    kind: 'entity';
+    entityId: EntityId;
+} | {
+    kind: 'group';
+    groupId: RecordId;
+    role: GroupRole;
+};
+/**
+ * Reach to the world, spelled affirmatively: it names no grantee and
+ * carries no bit beyond `read`, so no dropped field on a
+ * `PermissionAssociation` can produce it.
+ * See docs/spec/access-control.md § Record-level permissions.
+ */
+export type AnyoneAssociation = {
+    kind: 'anyone';
+    label: 'read';
+};
+/**
+ * The authority half of the association table — what the `permissions`
+ * field projects. See docs/spec/access-control.md § Record-level
+ * permissions.
+ */
+export type AuthorityAssociation = PermissionAssociation | AnyoneAssociation;
+/**
+ * The data half — what the `associations` field projects, and the only
+ * kinds `associate()`/`dissociate()` accept.
+ * See docs/spec/data-model.md § Associations.
+ */
+export type DataAssociation = TagAssociation | AttachmentAssociation | RelationshipAssociation;
+/**
+ * Every edge a Record carries, authority and data alike. One shape, one
+ * delta and one durability tier; the two halves stay separate call
+ * surfaces because they carry different authority.
+ * See docs/spec/access-control.md § Record-level permissions.
+ */
+export type Association = DataAssociation | AuthorityAssociation;
+/**
+ * One association a write moved, and what it moved from. Each inverse is
+ * local to one element, so there is no join key to get wrong; `previous`
+ * is carried in full, which is what makes a `repoint` undoable.
+ * See docs/spec/journal.md § The entry.
+ */
+export type AssociationChange = {
+    op: 'add';
+    association: Association;
+} | {
+    op: 'repoint';
+    association: Association;
+    previous: Association;
+} | {
+    op: 'remove';
+    association: Association;
+};
+/**
+ * What a caller sends: the journal's shape without `repoint`, which the
+ * journal records and no caller requests. See docs/spec/journal.md § The entry.
+ */
+export type AssociationEdit = Exclude<AssociationChange, {
+    op: 'repoint';
+}>;
+/**
+ * The aspects of an existing record one mutate() call may move, in any
+ * combination. Keys are read for presence: `unlisted: false` is a change,
+ * an omitted key is untouched. Each key replaces its aspect whole except
+ * `contentPatch`, which merges at the top level (`null` removes).
+ * See docs/spec/data-model.md § Mutations.
+ */
+export type RecordChangeSet = {
+    contentPatch?: Record<string, unknown | null>;
+    parentId?: RecordId | null;
+    permissions?: AuthorityAssociation[];
+    associations?: DataAssociation[];
+    unlisted?: boolean;
+};
+/** The keys of a change set, for presence checks that must not miss one. */
+export declare const RECORD_CHANGE_SET_KEYS: readonly ["contentPatch", "parentId", "permissions", "associations", "unlisted"];
+//# sourceMappingURL=associations.d.ts.map

package/dist/types/associations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"associations.d.ts","sourceRoot":"","sources":["../../src/types/associations.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAE3D,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,KAAK,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,kBAAkB,CAAC,EAAE,QAAQ,CAAC;CAC/B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,QAAQ,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,QAAQ,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,UAAU,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,iDAAiD;AACjD,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG,YAAY,GAAG,cAAc,CAAC;AAE9E,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;IACxB,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,yGAAyG;AACzG,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GACf;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,EAAE,QAAQ,CAAA;CAAE,GACtC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC;AAE1D;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,qBAAqB,GAAG,iBAAiB,CAAC;AAE7E;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,cAAc,GAAG,qBAAqB,GAAG,uBAAuB,CAAC;AAE/F;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,eAAe,GAAG,oBAAoB,CAAC;AAEjE;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GACzB;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,WAAW,EAAE,WAAW,CAAA;CAAE,GACvC;IAAE,EAAE,EAAE,SAAS,CAAC;IAAC,WAAW,EAAE,WAAW,CAAC;IAAC,QAAQ,EAAE,WAAW,CAAA;CAAE,GAClE;IAAE,EAAE,EAAE,QAAQ,CAAC;IAAC,WAAW,EAAE,WAAW,CAAA;CAAE,CAAC;AAE/C;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC,iBAAiB,EAAE;IAAE,EAAE,EAAE,SAAS,CAAA;CAAE,CAAC,CAAC;AAE5E;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC,CAAC;IAC9C,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC3B,WAAW,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACrC,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;IACjC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,4EAA4E;AAC5E,eAAO,MAAM,sBAAsB,kFAMoB,CAAC"}

package/dist/types/associations.js

@@ -0,0 +1,13 @@
+/**
+ * Associations: the edges a Record carries, authority and data alike,
+ * and the change shapes that move them.
+ */
+/** The keys of a change set, for presence checks that must not miss one. */
+export const RECORD_CHANGE_SET_KEYS = [
+    'contentPatch',
+    'parentId',
+    'permissions',
+    'associations',
+    'unlisted',
+];
+//# sourceMappingURL=associations.js.map

package/dist/types/associations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"associations.js","sourceRoot":"","sources":["../../src/types/associations.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA2JH,4EAA4E;AAC5E,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,cAAc;IACd,UAAU;IACV,aAAa;IACb,cAAc;IACd,UAAU;CAC2C,CAAC"}