@cogenta/schema 0.2.0 → 0.4.1

package/dist/store/menu-store.d.ts

@@ -0,0 +1,146 @@
+import { type DatabaseHandle } from '@cogenta/core';
+/**
+ * The persistence layer of navigation menus.
+ *
+ * Structurally a menu is the same shape as a taxonomy — a named tree,
+ * maintained with a materialised path so that "everything under this item" is
+ * one `like`, portable across the three dialects (ADR-0006) — but it is not a
+ * `TaxonomyStore`: a menu is not declared in the site's schema, it is created
+ * and edited at runtime from the admin, so it gets one fixed pair of tables
+ * (`menu-tables.ts`) rather than a table per declared name.
+ *
+ * A menu is deliberately **not** content (contract A): it carries a `locale`
+ * and nothing else contract A gives an entry — no `version`, no trash, no
+ * `translationOf`. Grafting that model on by symmetry would be solving a
+ * problem navigation does not have.
+ */
+export type MenuItemKind = 'entry' | 'url' | 'submenu-placeholder' | 'taxonomy' | 'home';
+/** Deep enough for any real navigation; the path column is bounded to match. */
+export declare const MAX_MENU_DEPTH = 8;
+export interface Menu {
+    readonly id: string;
+    readonly name: string;
+    readonly locale: string;
+    readonly label: string;
+    /**
+     * Where this menu renders on the public site (`primary`, `footer`, …), or
+     * `null` while it is not slotted anywhere (fiche 09, task 3). An arbitrary
+     * string the *menu* carries, not a value drawn from a vocabulary this
+     * package or contract D declares — a theme decides what locations it
+     * offers and a site assigns menus to them from the admin; a second theme
+     * with a different set of locations needs no migration, since nothing here
+     * ever validates this string against a known set.
+     */
+    readonly location: string | null;
+    readonly createdAt: string;
+    readonly updatedAt: string;
+}
+export interface MenuItem {
+    readonly id: string;
+    readonly menuId: string;
+    readonly parent: string | null;
+    readonly label: string;
+    readonly kind: MenuItemKind;
+    readonly targetCollection: string | null;
+    readonly targetEntryId: string | null;
+    /** The taxonomy a `kind: 'taxonomy'` item links to. */
+    readonly targetTaxonomy: string | null;
+    /** The term a `kind: 'taxonomy'` item links to. */
+    readonly targetTermId: string | null;
+    readonly url: string | null;
+    /** The HTML `title` attribute — a tooltip, never this item's `label`. */
+    readonly title: string | null;
+    readonly position: number;
+    readonly depth: number;
+    readonly openInNewTab: boolean;
+    readonly createdAt: string;
+    readonly updatedAt: string;
+}
+export interface CreateMenuInput {
+    readonly id?: string;
+    readonly name: string;
+    readonly locale: string;
+    readonly label: string;
+    readonly location?: string | null;
+}
+export interface UpdateMenuInput {
+    readonly label?: string;
+    /** Absent leaves it untouched; `null` clears it; a string reassigns it. */
+    readonly location?: string | null;
+}
+export interface ListMenusOptions {
+    readonly locale?: string;
+}
+export interface CreateMenuItemInput {
+    readonly id?: string;
+    readonly label: string;
+    readonly kind: MenuItemKind;
+    readonly parent?: string | null;
+    readonly targetCollection?: string | null;
+    readonly targetEntryId?: string | null;
+    readonly targetTaxonomy?: string | null;
+    readonly targetTermId?: string | null;
+    readonly url?: string | null;
+    readonly title?: string | null;
+    readonly position?: number;
+    readonly openInNewTab?: boolean;
+}
+export interface UpdateMenuItemInput {
+    readonly label?: string;
+    readonly kind?: MenuItemKind;
+    readonly targetCollection?: string | null;
+    readonly targetEntryId?: string | null;
+    readonly targetTaxonomy?: string | null;
+    readonly targetTermId?: string | null;
+    readonly url?: string | null;
+    readonly title?: string | null;
+    readonly openInNewTab?: boolean;
+}
+/** One item's place in the tree, as `reorderItems` accepts it. */
+export interface ReorderUpdate {
+    readonly id: string;
+    readonly parent: string | null;
+    readonly position: number;
+}
+export interface MenuStoreOptions {
+    readonly db: DatabaseHandle;
+    /** Injectable so tests can pin time; nothing else should pass it. */
+    readonly now?: () => Date;
+    readonly newId?: () => string;
+}
+export interface MenuStore {
+    create(input: CreateMenuInput): Promise<Menu>;
+    read(id: string): Promise<Menu | null>;
+    byName(name: string, locale: string): Promise<Menu | null>;
+    /** The menu assigned to this location, for this locale — at most one, enforced at write time. */
+    byLocation(location: string, locale: string): Promise<Menu | null>;
+    update(id: string, input: UpdateMenuInput): Promise<Menu>;
+    /** Refuses while the menu still has items, unless `cascade` is asked for. */
+    delete(id: string, options?: {
+        readonly cascade?: boolean;
+    }): Promise<boolean>;
+    list(options?: ListMenusOptions): Promise<readonly Menu[]>;
+    createItem(menuId: string, input: CreateMenuItemInput): Promise<MenuItem>;
+    readItem(id: string): Promise<MenuItem | null>;
+    updateItem(id: string, input: UpdateMenuItemInput): Promise<MenuItem>;
+    /** Re-parents an item and rewrites the whole subtree's paths. */
+    moveItem(id: string, parent: string | null): Promise<MenuItem>;
+    /** Swaps this item's position with the sibling immediately before/after it. */
+    reorderItem(id: string, direction: 'up' | 'down'): Promise<MenuItem>;
+    /**
+     * Rewrites `parent`/`position` for any number of items of this menu, in
+     * one transaction — the batch form task 2 asks for, so a drag-and-drop
+     * session (possibly touching a moved item, its old siblings and its new
+     * siblings at once) commits or fails as a single unit. An item of the
+     * menu left out of `updates` keeps its own `parent`/`position`, but its
+     * stored `path` is still rewritten if one of its ancestors moved.
+     */
+    reorderItems(menuId: string, updates: readonly ReorderUpdate[]): Promise<readonly MenuItem[]>;
+    deleteItem(id: string, options?: {
+        readonly cascade?: boolean;
+    }): Promise<boolean>;
+    /** Every item of the menu, in tree order. */
+    listItems(menuId: string): Promise<readonly MenuItem[]>;
+}
+export declare function createMenuStore(options: MenuStoreOptions): MenuStore;
+//# sourceMappingURL=menu-store.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"menu-store.d.ts","sourceRoot":"","sources":["../../src/store/menu-store.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,cAAc,EAKpB,MAAM,eAAe,CAAA;AAMtB;;;;;;;;;;;;;;GAcG;AAEH,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,KAAK,GAAG,qBAAqB,GAAG,UAAU,GAAG,MAAM,CAAA;AAExF,gFAAgF;AAChF,eAAO,MAAM,cAAc,IAAI,CAAA;AAE/B,MAAM,WAAW,IAAI;IACnB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB;;;;;;;;OAQG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAA;IAC3B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAA;IACxC,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IACrC,uDAAuD;IACvD,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,mDAAmD;IACnD,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IACpC,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,yEAAyE;IACzE,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAA;IAC9B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAClC;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,2EAA2E;IAC3E,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAClC;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAA;IAC3B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC/B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzC,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrC,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAA;CAChC;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,YAAY,CAAA;IAC5B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzC,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrC,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAA;CAChC;AAED,kEAAkE;AAClE,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,EAAE,cAAc,CAAA;IAC3B,qEAAqE;IACrE,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,IAAI,CAAA;IACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,MAAM,CAAA;CAC9B;AAED,MAAM,WAAW,SAAS;IACxB,MAAM,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC7C,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,CAAA;IACtC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,CAAA;IAC1D,iGAAiG;IACjG,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,CAAA;IAClE,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzD,6EAA6E;IAC7E,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAC9E,IAAI,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAAA;IAE1D,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IACzE,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAA;IAC9C,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IACrE,iEAAiE;IACjE,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IAC9D,+EAA+E;IAC/E,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,GAAG,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IACpE;;;;;;;OAOG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,aAAa,EAAE,GAAG,OAAO,CAAC,SAAS,QAAQ,EAAE,CAAC,CAAA;IAC7F,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAClF,6CAA6C;IAC7C,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,QAAQ,EAAE,CAAC,CAAA;CACxD;AAqBD,wBAAgB,eAAe,CAAC,OAAO,EAAE,gBAAgB,GAAG,SAAS,CAivBpE"}