@kywi-software/core 0.14.0 → 0.15.1

package/dist/db/component-instance-queries.d.ts

@@ -1,4 +1,4 @@
-import type { KywiComponentRow } from '../schema/components.js';
+import type { KywiComponentRow, ComponentHolderKind } from '../schema/components.js';
 import type { KywiDb } from './client.js';
 import type { LayoutDocument } from '../layout/types.js';
 import type { ComponentDefinitionLookup } from '../layout/module-permissions.js';
@@ -35,11 +35,28 @@ export declare function isIndexableComponentId(componentId: string): boolean;
  * not a miss), so they contribute nothing but a failed request.
  */
 export declare function buildAddedComponentLookup(db: KywiDb, incoming: LayoutDocument, stored: LayoutDocument | null | undefined, siteId: string | undefined): Promise<ComponentDefinitionLookup | undefined>;
-export interface SyncComponentInstancesParams {
-    siteId: string;
+/**
+ * What holds the layout document being indexed (kywi-cms#156).
+ *
+ * A layout lives in one of exactly two places — a page's `kywi_content.layout`
+ * or a blueprint's `kywi_section_templates.definition` — and every index row
+ * names one of them. Passing the holder as a discriminated union rather than
+ * three loose fields is what makes "a content row with a blueprint id" (or the
+ * reverse) unrepresentable in the caller, above the CHECK that makes it
+ * unrepresentable in the table.
+ */
+export type ComponentInstanceHolder = {
+    kind: 'content';
     contentId: string;
     /** `kywi_content.content_type_name`, denormalised onto each row. */
     contentType: string;
+} | {
+    kind: 'blueprint';
+    blueprintId: string;
+};
+export interface SyncComponentInstancesParams {
+    siteId: string;
+    holder: ComponentInstanceHolder;
     before: LayoutDocument | null | undefined;
     after: LayoutDocument | null | undefined;
 }
@@ -48,7 +65,8 @@ export interface SyncComponentInstancesResult {
     removed: number;
 }
 /**
- * Bring the index rows for one content document in line with its new layout.
+ * Bring the index rows for ONE HOLDER — a page or a blueprint — in line with
+ * its new layout document.
  *
  * Only the difference is written: moving a linked node around a page is not a
  * change of placement, so a save that reshuffles a layout writes nothing here.
@@ -64,12 +82,16 @@ export interface ComponentUsageItem {
     title: string | null;
     nodeIds: string[];
 }
+export interface ComponentUsageBlueprint {
+    blueprintId: string;
+    name: string | null;
+}
 export interface ComponentUsage {
-    /** Total placements on LIVE (not soft-deleted) documents. */
+    /** Total placements on LIVE (not soft-deleted) PAGES. */
     instances: number;
-    /** Distinct live documents holding at least one placement. */
+    /** Distinct live pages holding at least one placement. */
     pages: number;
-    /** Live documents only — what a "N instances across M pages" dialog names. */
+    /** Live pages only — what a "N instances across M pages" dialog names. */
     items: ComponentUsageItem[];
     /**
      * Placements held by soft-deleted (trashed) documents, counted separately.
@@ -83,14 +105,30 @@ export interface ComponentUsage {
      */
     trashedInstances: number;
     trashedPages: number;
+    /**
+     * Placements held by saved layouts / blueprints (kywi-cms#156), in their own
+     * partition for exactly the reason trashed pages have one: "used on 4 pages"
+     * must keep meaning four pages a reader can open, and a blueprint is not one.
+     *
+     * They are counted, not dropped. A blueprint holding the link is a real
+     * dependency — deleting the component would leave that blueprint rendering
+     * the node's fallback copy forever — so the delete gate adds these in and
+     * detach-all rewrites blueprints alongside pages.
+     */
+    blueprints: number;
+    /** Total placements across those blueprints (a blueprint may hold several). */
+    blueprintInstances: number;
+    /** One entry per blueprint, for the group the usage dialog links to. */
+    blueprintItems: ComponentUsageBlueprint[];
 }
 /**
- * Where a component is placed, with the page titles the confirm dialogs name.
- * One indexed read plus a join — the shape both the admin library and the save
- * fork consume.
+ * Where a component is placed, with the page titles and blueprint names the
+ * confirm dialogs name. One indexed read plus two joins — the shape both the
+ * admin library and the save fork consume.
  *
- * Trashed documents are partitioned out of the headline numbers rather than
- * dropped: see {@link ComponentUsage.trashedInstances}.
+ * Trashed pages and blueprints are each partitioned out of the headline numbers
+ * rather than dropped: see {@link ComponentUsage.trashedInstances} and
+ * {@link ComponentUsage.blueprints}.
  */
 export declare function getComponentUsage(db: KywiDb, componentId: string, siteId: string): Promise<ComponentUsage>;
 export interface ComponentUsageCount {
@@ -98,31 +136,47 @@ export interface ComponentUsageCount {
     instances: number;
     pages: number;
     trashedInstances: number;
+    /** Distinct saved layouts holding a placement (kywi-cms#156). */
+    blueprints: number;
 }
 /**
  * Per-component placement counts for a whole site — one grouped read, so the
  * library list doesn't fan out into a usage query per row.
  *
- * The live/trashed split matches {@link getComponentUsage} exactly, so the
- * number in the library list is the same number the component's own usage
+ * The live/trashed/blueprint split matches {@link getComponentUsage} exactly, so
+ * the number in the library list is the same number the component's own usage
  * dialog shows.
  */
 export declare function listComponentUsageCounts(db: KywiDb, siteId: string): Promise<ComponentUsageCount[]>;
 /** Why one document was left alone by {@link detachComponentEverywhere}. */
 export type DetachSkipReason = 'invalidLayout' | 'adminOnlyModule';
 export interface DetachSkippedPage {
+    /**
+     * The holder's id — a `kywi_content` id, or a `kywi_section_templates` id when
+     * {@link holderKind} is `'blueprint'`. Read `holderKind` before linking to it.
+     */
     contentId: string;
+    /**
+     * The holder's content type, or {@link BLUEPRINT_CONTENT_TYPE} on a blueprint
+     * (kywi-cms#156). A blueprint has no content type — this field is the sentinel
+     * rather than a plausible-looking lie, and `holderKind` is what a reader
+     * should branch on.
+     */
     contentType: string;
+    /** Which table {@link contentId} points into (kywi-cms#156). */
+    holderKind: ComponentHolderKind;
     reason: DetachSkipReason;
     detail: string;
 }
 export interface DetachEverywhereResult {
-    /** Documents rewritten. */
+    /** Pages rewritten. */
     pages: number;
-    /** Placements materialised into independent copies. */
+    /** Saved layouts rewritten (kywi-cms#156). */
+    blueprints: number;
+    /** Placements materialised into independent copies, across both holders. */
     instances: number;
     /**
-     * Documents deliberately left untouched, each with the reason. Empty on the
+     * Holders deliberately left untouched, each with the reason. Empty on the
      * happy path; when it is not empty the component still has instances and
      * must not be deleted.
      */
@@ -177,7 +231,10 @@ export interface DetachEverywhereOptions {
  */
 export declare function detachComponentEverywhere(db: KywiDb, component: Pick<KywiComponentRow, 'id' | 'siteId' | 'type' | 'moduleType' | 'definition'>, options: DetachEverywhereOptions): Promise<DetachEverywhereResult>;
 export interface ReindexResult {
+    /** Pages (`kywi_content`) parsed. */
     documentsScanned: number;
+    /** Saved layouts (`kywi_section_templates`) parsed (kywi-cms#156). */
+    blueprintsScanned: number;
     instances: number;
 }
 /**
@@ -189,9 +246,12 @@ export interface ReindexResult {
  * It is idempotent (it clears the scope it is about to rebuild) and doubles as
  * the repair path if the index is ever suspected of drift.
  *
+ * Both holders are rebuilt: pages (`kywi_content.layout`) and blueprints
+ * (`kywi_section_templates.definition`, kywi-cms#156).
+ *
  * Only documents whose layout mentions a known component id are parsed, so the
- * cost is one indexed-free scan plus a parse of the pages that actually use
- * components — not a parse of every layout in the database.
+ * cost is one index-free scan per holder table plus a parse of the documents
+ * that actually use components — not a parse of every layout in the database.
  */
 export declare function reindexComponentInstances(db: KywiDb, siteId?: string): Promise<ReindexResult>;
 //# sourceMappingURL=component-instance-queries.d.ts.map

package/dist/db/component-instance-queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"component-instance-queries.d.ts","sourceRoot":"","sources":["../../src/db/component-instance-queries.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAA;AAE/D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAGxD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAA;AA0ChF;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAEnE;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,yBAAyB,CAC7C,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,cAAc,EACxB,MAAM,EAAE,cAAc,GAAG,IAAI,GAAG,SAAS,EACzC,MAAM,EAAE,MAAM,GAAG,SAAS,GACzB,OAAO,CAAC,yBAAyB,GAAG,SAAS,CAAC,CAOhD;AAID,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,oEAAoE;IACpE,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,cAAc,GAAG,IAAI,GAAG,SAAS,CAAA;IACzC,KAAK,EAAE,cAAc,GAAG,IAAI,GAAG,SAAS,CAAA;CACzC;AAED,MAAM,WAAW,4BAA4B;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;;GASG;AACH,wBAAsB,sBAAsB,CAC1C,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,4BAA4B,GACnC,OAAO,CAAC,4BAA4B,CAAC,CAgCvC;AAqBD,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,6DAA6D;IAC7D,SAAS,EAAE,MAAM,CAAA;IACjB,8DAA8D;IAC9D,KAAK,EAAE,MAAM,CAAA;IACb,8EAA8E;IAC9E,KAAK,EAAE,kBAAkB,EAAE,CAAA;IAC3B;;;;;;;;;OASG;IACH,gBAAgB,EAAE,MAAM,CAAA;IACxB,YAAY,EAAE,MAAM,CAAA;CACrB;AAED;;;;;;;GAOG;AACH,wBAAsB,iBAAiB,CACrC,EAAE,EAAE,MAAM,EACV,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,cAAc,CAAC,CAoDzB;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,gBAAgB,EAAE,MAAM,CAAA;CACzB;AAED;;;;;;;GAOG;AACH,wBAAsB,wBAAwB,CAC5C,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAmBhC;AAID,4EAA4E;AAC5E,MAAM,MAAM,gBAAgB,GAAG,eAAe,GAAG,iBAAiB,CAAA;AAElE,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,gBAAgB,CAAA;IACxB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,sBAAsB;IACrC,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAA;IACb,uDAAuD;IACvD,SAAS,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,OAAO,EAAE,iBAAiB,EAAE,CAAA;CAC7B;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;;;OAMG;IACH,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAsB,yBAAyB,CAC7C,EAAE,EAAE,MAAM,EACV,SAAS,EAAE,IAAI,CAAC,gBAAgB,EAAE,IAAI,GAAG,QAAQ,GAAG,MAAM,GAAG,YAAY,GAAG,YAAY,CAAC,EACzF,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,sBAAsB,CAAC,CA+GjC;AAID,MAAM,WAAW,aAAa;IAC5B,gBAAgB,EAAE,MAAM,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,yBAAyB,CAC7C,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,aAAa,CAAC,CAsExB"}
+{"version":3,"file":"component-instance-queries.d.ts","sourceRoot":"","sources":["../../src/db/component-instance-queries.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAA4B,mBAAmB,EAAE,MAAM,yBAAyB,CAAA;AAE9G,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAGxD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAA;AA+ChF;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAEnE;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,yBAAyB,CAC7C,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,cAAc,EACxB,MAAM,EAAE,cAAc,GAAG,IAAI,GAAG,SAAS,EACzC,MAAM,EAAE,MAAM,GAAG,SAAS,GACzB,OAAO,CAAC,yBAAyB,GAAG,SAAS,CAAC,CAOhD;AAID;;;;;;;;;GASG;AACH,MAAM,MAAM,uBAAuB,GAC/B;IACE,IAAI,EAAE,SAAS,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,oEAAoE;IACpE,WAAW,EAAE,MAAM,CAAA;CACpB,GACD;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAAA;AAE9C,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,uBAAuB,CAAA;IAC/B,MAAM,EAAE,cAAc,GAAG,IAAI,GAAG,SAAS,CAAA;IACzC,KAAK,EAAE,cAAc,GAAG,IAAI,GAAG,SAAS,CAAA;CACzC;AAgCD,MAAM,WAAW,4BAA4B;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,sBAAsB,CAC1C,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,4BAA4B,GACnC,OAAO,CAAC,4BAA4B,CAAC,CAiCvC;AAqBD,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,uBAAuB;IACtC,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,yDAAyD;IACzD,SAAS,EAAE,MAAM,CAAA;IACjB,0DAA0D;IAC1D,KAAK,EAAE,MAAM,CAAA;IACb,0EAA0E;IAC1E,KAAK,EAAE,kBAAkB,EAAE,CAAA;IAC3B;;;;;;;;;OASG;IACH,gBAAgB,EAAE,MAAM,CAAA;IACxB,YAAY,EAAE,MAAM,CAAA;IACpB;;;;;;;;;OASG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB,+EAA+E;IAC/E,kBAAkB,EAAE,MAAM,CAAA;IAC1B,wEAAwE;IACxE,cAAc,EAAE,uBAAuB,EAAE,CAAA;CAC1C;AAaD;;;;;;;;GAQG;AACH,wBAAsB,iBAAiB,CACrC,EAAE,EAAE,MAAM,EACV,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,cAAc,CAAC,CAyEzB;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,gBAAgB,EAAE,MAAM,CAAA;IACxB,iEAAiE;IACjE,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;;;;;GAOG;AACH,wBAAsB,wBAAwB,CAC5C,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAyBhC;AAID,4EAA4E;AAC5E,MAAM,MAAM,gBAAgB,GAAG,eAAe,GAAG,iBAAiB,CAAA;AAElE,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB,gEAAgE;IAChE,UAAU,EAAE,mBAAmB,CAAA;IAC/B,MAAM,EAAE,gBAAgB,CAAA;IACxB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,sBAAsB;IACrC,uBAAuB;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,8CAA8C;IAC9C,UAAU,EAAE,MAAM,CAAA;IAClB,4EAA4E;IAC5E,SAAS,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,OAAO,EAAE,iBAAiB,EAAE,CAAA;CAC7B;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;;;OAMG;IACH,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAsB,yBAAyB,CAC7C,EAAE,EAAE,MAAM,EACV,SAAS,EAAE,IAAI,CAAC,gBAAgB,EAAE,IAAI,GAAG,QAAQ,GAAG,MAAM,GAAG,YAAY,GAAG,YAAY,CAAC,EACzF,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,sBAAsB,CAAC,CA8LjC;AAID,MAAM,WAAW,aAAa;IAC5B,qCAAqC;IACrC,gBAAgB,EAAE,MAAM,CAAA;IACxB,sEAAsE;IACtE,iBAAiB,EAAE,MAAM,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,yBAAyB,CAC7C,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,aAAa,CAAC,CAoHxB"}