@cogenta/schema 0.1.2 → 0.3.0

package/dist/store/search-indexing.js

@@ -0,0 +1,65 @@
+import { searchDocumentFor } from '../search/extract.js';
+/**
+ * Re-derives the indexed document for one entry.
+ *
+ * The published face is asked for **first**, and it is the one indexed
+ * whenever it exists. That ordering is the whole safety property: with drafts
+ * enabled, `update()` returns the working face of an entry whose `status` is
+ * still `published`, and indexing *that* would file unreviewed text under a
+ * status a public search is allowed to reach. Reading back through
+ * `state: 'published'` makes it structurally impossible — the store only
+ * returns a row there when its status really is `published`.
+ *
+ * When there is no published face, the working one is indexed under its real
+ * status (`draft`, `scheduled`, `archived`), which is what lets the admin
+ * find a draft while `SearchQuery`'s `published` default keeps it away from
+ * anyone who did not explicitly ask for it and hold the permission to.
+ */
+async function reindex(store, options, id) {
+    const { collection, index } = options;
+    try {
+        const published = await store.read(id, { state: 'published' });
+        if (published !== null) {
+            await index.index(searchDocumentFor(collection, published));
+            return;
+        }
+        const working = await store.read(id, { state: 'working' });
+        if (working === null) {
+            await index.remove({ id, collection: collection.name });
+            return;
+        }
+        await index.index(searchDocumentFor(collection, working));
+    }
+    catch (error) {
+        options.onError?.(error);
+    }
+}
+export function withSearchIndexing(store, options) {
+    async function after(entry) {
+        await reindex(store, options, entry.id);
+        return entry;
+    }
+    return {
+        ...store,
+        create: async (input) => after(await store.create(input)),
+        update: async (id, input) => after(await store.update(id, input)),
+        publish: async (id, input) => after(await store.publish(id, input)),
+        unpublish: async (id, input) => after(await store.unpublish(id, input)),
+        restore: async (id, version, input) => after(await store.restore(id, version, input)),
+        delete: async (id) => {
+            const removed = await store.delete(id);
+            // Unconditionally, not only on `removed`: an entry the store says was
+            // already gone may still have a stale row in the index — that is exactly
+            // the state a crash between the two writes leaves behind, and the
+            // cheapest place to repair it is the next delete.
+            try {
+                await options.index.remove({ id, collection: options.collection.name });
+            }
+            catch (error) {
+                options.onError?.(error);
+            }
+            return removed;
+        },
+    };
+}
+//# sourceMappingURL=search-indexing.js.map

package/dist/store/search-indexing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-indexing.js","sourceRoot":"","sources":["../../src/store/search-indexing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAoCxD;;;;;;;;;;;;;;;GAeG;AACH,KAAK,UAAU,OAAO,CACpB,KAA4B,EAC5B,OAA8B,EAC9B,EAAU;IAEV,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,OAAO,CAAA;IACrC,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAA;QAC9D,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;YACvB,MAAM,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAA;YAC3D,OAAM;QACR,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAA;QAC1D,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACrB,MAAM,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,UAAU,CAAC,IAAI,EAAE,CAAC,CAAA;YACvD,OAAM;QACR,CAAC;QACD,MAAM,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAA;IAC3D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAA;IAC1B,CAAC;AACH,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,KAA4B,EAC5B,OAA8B;IAE9B,KAAK,UAAU,KAAK,CAAyC,KAAa;QACxE,MAAM,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,CAAA;QACvC,OAAO,KAAK,CAAA;IACd,CAAC;IAED,OAAO;QACL,GAAG,KAAK;QACR,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACzD,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QACjE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QACnE,SAAS,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QACvE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACrF,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE;YACnB,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;YACtC,sEAAsE;YACtE,yEAAyE;YACzE,kEAAkE;YAClE,kDAAkD;YAClD,IAAI,CAAC;gBACH,MAAM,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAA;YACzE,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAA;YAC1B,CAAC;YACD,OAAO,OAAO,CAAA;QAChB,CAAC;KACF,CAAA;AACH,CAAC"}

package/dist/store/store.d.ts

@@ -1,7 +1,7 @@
 import { type DatabaseHandle } from '@cogenta/core';
-import type { CollectionDefinition } from '../types.js';
+import { type CollectionDefinition } from '../types.js';
 import { type ContentDiff } from './diff.js';
-import type { ContentEntry, ContentValues, CreateInput, EntryState, ListOptions, LocaleResolution, Page, ResolveLocaleOptions, UpdateInput, VersionSummary } from './types.js';
+import type { ContentEntry, ContentValues, CreateInput, DuplicateInput, ListOptions, LocaleResolution, Page, PurgeReport, ReadOptions, ResolveLocaleOptions, TrashOptions, UpdateInput, VersionSummary } from './types.js';
 /**
  * The persistence layer of a collection.
  *
@@ -21,6 +21,18 @@ import type { ContentEntry, ContentValues, CreateInput, EntryState, ListOptions,
 export interface ContentStoreOptions {
     readonly db: DatabaseHandle;
     readonly collection: CollectionDefinition;
+    /**
+     * The other collections of the site, so `delete()` can enforce `restrict`.
+     *
+     * Trashing is not a `DELETE`, so the foreign key cannot refuse it any more
+     * (ADR-0022) — the check has to be made in application code, and this is
+     * what makes it possible: a store only knows its own collection otherwise.
+     *
+     * Left out, only self-references are checked. That degrades honestly rather
+     * than silently: nothing is destroyed, since `purge()` still meets the real
+     * foreign key. Every real runtime (`serve.ts`) passes the whole set.
+     */
+    readonly siblings?: readonly CollectionDefinition[];
     /** The locale an entry gets when the caller does not say. */
     readonly defaultLocale?: string;
     /** Injectable so tests can pin time; nothing else should pass it. */
@@ -29,23 +41,48 @@ export interface ContentStoreOptions {
 }
 export interface ContentStore<TValues extends ContentValues = ContentValues> {
     create(input: CreateInput<TValues>): Promise<ContentEntry<TValues>>;
-    read(id: string, options?: {
-        readonly state?: EntryState;
-    }): Promise<ContentEntry<TValues> | null>;
+    /** Copies an entry into a new, independent draft. See the implementation for what is deliberately not copied. */
+    duplicate(id: string, input?: DuplicateInput<TValues>): Promise<ContentEntry<TValues>>;
+    read(id: string, options?: ReadOptions): Promise<ContentEntry<TValues> | null>;
     update(id: string, input: UpdateInput<TValues>): Promise<ContentEntry<TValues>>;
+    /**
+     * Moves an entry to the trash (`schema@2.0`, ADR-0022).
+     *
+     * **This used to be a hard `DELETE`.** It now writes `deletedAt` and leaves
+     * every row — versions, blocks, join rows, the `translation_of` of its
+     * translations — exactly where it was, which is the only way `untrash()` can
+     * give back precisely what was taken.
+     *
+     * A collection declared `trash: false` keeps the old behaviour: `delete()`
+     * is `purge()`.
+     */
     delete(id: string): Promise<boolean>;
+    /** Takes an entry back out of the trash, with the status it went in with. */
+    untrash(id: string): Promise<ContentEntry<TValues>>;
+    /** The real `DELETE`, and the only one. What `delete()` did before 2.0. */
+    purge(id: string): Promise<boolean>;
+    /** Purges what has sat in the trash longer than `trash.retainDays`. */
+    purgeExpired(): Promise<PurgeReport>;
     list(options?: ListOptions): Promise<Page<ContentEntry<TValues>>>;
     publish(id: string, input?: {
         readonly publishedBy?: string | null;
     }): Promise<ContentEntry<TValues>>;
     unpublish(id: string, input?: {
-        readonly status?: 'draft' | 'archived';
+        readonly status?: 'draft' | 'archived' | 'scheduled';
+        /**
+         * Required, and only meaningful, when `status` is `'scheduled'`: the
+         * future instant this entry becomes public. A `Date`, an ISO 8601
+         * string, or epoch milliseconds — the same three forms
+         * `schedulePublication` accepts, since this is the write that puts an
+         * entry into the state that function's caller later queues a job for.
+         */
+        readonly publishedAt?: Date | string | number;
     }): Promise<ContentEntry<TValues>>;
-    history(id: string): Promise<readonly VersionSummary[]>;
+    history(id: string, options?: TrashOptions): Promise<readonly VersionSummary[]>;
     readVersion(id: string, version: number): Promise<ContentEntry<TValues> | null>;
     restore(id: string, version: number, input?: UpdateInput<TValues>): Promise<ContentEntry<TValues>>;
     diff(id: string, from: number, to: number): Promise<ContentDiff>;
-    translations(id: string): Promise<readonly ContentEntry<TValues>[]>;
+    translations(id: string, options?: TrashOptions): Promise<readonly ContentEntry<TValues>[]>;
     resolveLocale(id: string, locale: string, options: ResolveLocaleOptions): Promise<LocaleResolution<TValues>>;
 }
 export declare function createContentStore<TValues extends ContentValues = ContentValues>(options: ContentStoreOptions): ContentStore<TValues>;

package/dist/store/store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../src/store/store.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,cAAc,EAMpB,MAAM,eAAe,CAAA;AAEtB,OAAO,KAAK,EAAE,oBAAoB,EAA6B,MAAM,aAAa,CAAA;AAGlF,OAAO,EAAE,KAAK,WAAW,EAAe,MAAM,WAAW,CAAA;AAIzD,OAAO,KAAK,EAGV,YAAY,EACZ,aAAa,EACb,WAAW,EACX,UAAU,EACV,WAAW,EACX,gBAAgB,EAChB,IAAI,EACJ,oBAAoB,EAEpB,WAAW,EACX,cAAc,EACf,MAAM,YAAY,CAAA;AAGnB;;;;;;;;;;;;;;;GAeG;AAEH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,EAAE,cAAc,CAAA;IAC3B,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAA;IACzC,6DAA6D;IAC7D,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,qEAAqE;IACrE,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,IAAI,CAAA;IACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,MAAM,CAAA;CAC9B;AAED,MAAM,WAAW,YAAY,CAAC,OAAO,SAAS,aAAa,GAAG,aAAa;IACzE,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;IACnE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAA;IAClG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;IAC/E,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IACpC,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;IACjE,OAAO,CACL,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE;QAAE,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,GAC/C,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;IACjC,SAAS,CACP,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE;QAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,UAAU,CAAA;KAAE,GACjD,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;IACjC,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,cAAc,EAAE,CAAC,CAAA;IACvD,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAA;IAC/E,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;IAClG,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;IAChE,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACnE,aAAa,CACX,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAA;CACtC;AA2CD,wBAAgB,kBAAkB,CAAC,OAAO,SAAS,aAAa,GAAG,aAAa,EAC9E,OAAO,EAAE,mBAAmB,GAC3B,YAAY,CAAC,OAAO,CAAC,CAw4BvB"}
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../src/store/store.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,cAAc,EAMpB,MAAM,eAAe,CAAA;AAEtB,OAAO,EACL,KAAK,oBAAoB,EAI1B,MAAM,aAAa,CAAA;AAGpB,OAAO,EAAE,KAAK,WAAW,EAAe,MAAM,WAAW,CAAA;AAIzD,OAAO,KAAK,EAGV,YAAY,EACZ,aAAa,EACb,WAAW,EACX,cAAc,EAEd,WAAW,EACX,gBAAgB,EAChB,IAAI,EACJ,WAAW,EACX,WAAW,EACX,oBAAoB,EAGpB,YAAY,EACZ,WAAW,EACX,cAAc,EACf,MAAM,YAAY,CAAA;AAGnB;;;;;;;;;;;;;;;GAeG;AAEH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,EAAE,cAAc,CAAA;IAC3B,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAA;IACzC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,oBAAoB,EAAE,CAAA;IACnD,6DAA6D;IAC7D,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,qEAAqE;IACrE,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,IAAI,CAAA;IACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,MAAM,CAAA;CAC9B;AAED,MAAM,WAAW,YAAY,CAAC,OAAO,SAAS,aAAa,GAAG,aAAa;IACzE,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;IACnE,iHAAiH;IACjH,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;IACtF,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAA;IAC9E,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;IAC/E;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IACpC,6EAA6E;IAC7E,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;IACnD,2EAA2E;IAC3E,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IACnC,uEAAuE;IACvE,YAAY,IAAI,OAAO,CAAC,WAAW,CAAC,CAAA;IACpC,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;IACjE,OAAO,CACL,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE;QAAE,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,GAC/C,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;IACjC,SAAS,CACP,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE;QACN,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,UAAU,GAAG,WAAW,CAAA;QACpD;;;;;;WAMG;QACH,QAAQ,CAAC,WAAW,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAAA;KAC9C,GACA,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;IACjC,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,SAAS,cAAc,EAAE,CAAC,CAAA;IAC/E,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAA;IAC/E,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;IAClG,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;IAChE,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,SAAS,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IAC3F,aAAa,CACX,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAA;CACtC;AA4CD,wBAAgB,kBAAkB,CAAC,OAAO,SAAS,aAAa,GAAG,aAAa,EAC9E,OAAO,EAAE,mBAAmB,GAC3B,YAAY,CAAC,OAAO,CAAC,CA+zCvB"}