@byline/core 0.9.3

package/dist/@types/collection-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collection-types.d.ts","sourceRoot":"","sources":["../../src/@types/collection-types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAElD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,KAAK,EAAE,YAAY,EAAE,sBAAsB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAClG,OAAO,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AACzF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAM/C,wDAAwD;AACxD,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAA;AAE1D;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAA;AAE1E;;;;;;;;GAQG;AACH,MAAM,WAAW,SAAS;IACxB,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAA;IACZ,wEAAwE;IACxE,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,wEAAwE;IACxE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,kDAAkD;IAClD,GAAG,CAAC,EAAE,QAAQ,CAAA;IACd,qEAAqE;IACrE,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB,qDAAqD;IACrD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,KAAK,CAAC,EAAE,SAAS,EAAE,CAAA;IACnB;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAC1B;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,EAAE,WAAW,CAAA;CACpB;AAMD;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,EAAG,OAAgB,CAAA;AACrD,eAAO,MAAM,yBAAyB,EAAG,WAAoB,CAAA;AAC7D,eAAO,MAAM,wBAAwB,EAAG,UAAmB,CAAA;AAC3D,eAAO,MAAM,0BAA0B,6CAI7B,CAAA;AACV,MAAM,MAAM,0BAA0B,GAAG,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,CAAC,CAAA;AAEpF;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,cAAc,EAAE,CAAA;IAC1B,mFAAmF;IACnF,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,mBAAmB;IAClC,qFAAqF;IACrF,KAAK,CAAC,EAAE,oBAAoB,CAAA;IAC5B,sGAAsG;IACtG,SAAS,CAAC,EAAE,oBAAoB,CAAA;IAChC,0FAA0F;IAC1F,QAAQ,CAAC,EAAE,oBAAoB,CAAA;IAC/B,4EAA4E;IAC5E,cAAc,CAAC,EAAE,cAAc,EAAE,CAAA;IACjC;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,cAM9B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,sBAAsB,EAAE,cAGpC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,wBAAgB,cAAc,CAAC,KAAK,GAAE,mBAAwB,GAAG,cAAc,CAqC9E;AAQD;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACzB,cAAc,EAAE,MAAM,CAAA;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACzB,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,iBAAiB,EAAE,MAAM,CAAA;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACzB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACjC,cAAc,EAAE,MAAM,CAAA;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACzB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACjC,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,iBAAiB,EAAE,MAAM,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAA;IAClB,iBAAiB,EAAE,MAAM,CAAA;IACzB,cAAc,EAAE,MAAM,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAA;IAClB,cAAc,EAAE,MAAM,CAAA;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAA;IAClB,cAAc,EAAE,MAAM,CAAA;IACtB,aAAa,EAAE,MAAM,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,MAAM,CAAA;IAClB,cAAc,EAAE,MAAM,CAAA;CACvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,kBAAkB;IACjC,0DAA0D;IAC1D,SAAS,EAAE,MAAM,CAAA;IACjB,4GAA4G;IAC5G,KAAK,EAAE,UAAU,GAAG,SAAS,CAAA;IAC7B,sDAAsD;IACtD,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC9B,cAAc,EAAE,MAAM,CAAA;IACtB,uFAAuF;IACvF,cAAc,EAAE,cAAc,CAAA;CAC/B;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,GACzB,MAAM,GACN;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAAE,GACxC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,SAAS,CAAA;CAAE,GACvC,IAAI,CAAA;AAER;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAC9B,GAAG,EAAE,kBAAkB,KACpB,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAA;AAEnD;;;;;;;;;;GAUG;AACH,MAAM,WAAW,iBAAiB;IAChC,8DAA8D;IAC9D,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,UAAU,GAAG,SAAS,CAAA;IAC7B;;;;OAIG;IACH,UAAU,EAAE,eAAe,CAAA;IAC3B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC9B,cAAc,EAAE,MAAM,CAAA;IACtB,cAAc,EAAE,cAAc,CAAA;CAC/B;AAED,oDAAoD;AACpD,MAAM,MAAM,gBAAgB,GAAG,CAAC,GAAG,EAAE,iBAAiB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;AAE/E;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,WAAW,CAAC,EAAE,iBAAiB,GAAG,iBAAiB,EAAE,CAAA;IACrD,UAAU,CAAC,EAAE,gBAAgB,GAAG,gBAAgB,EAAE,CAAA;CACnD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,gBAAgB;IAC/B,yEAAyE;IACzE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACxB,cAAc,EAAE,MAAM,CAAA;IACtB,2DAA2D;IAC3D,WAAW,EAAE,WAAW,CAAA;CACzB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,WAAW,iBAAiB;IAChC,cAAc,EAAE,MAAM,CAAA;IACtB,cAAc,EAAE,cAAc,CAAA;IAC9B,WAAW,EAAE,WAAW,CAAA;CACzB;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAC7B,GAAG,EAAE,iBAAiB,KACnB,cAAc,GAAG,IAAI,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;AAE3D;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG,gBAAgB,EAAE,CAAA;AAItE;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;AAEtE;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,GAAG,IAAI,gBAAgB,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAA;AAErF,qFAAqF;AACrF,wBAAgB,uBAAuB,CAAC,GAAG,EACzC,IAAI,EAAE,kBAAkB,CAAC,GAAG,CAAC,GAAG,SAAS,GACxC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAGzB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,eAAe;IAE9B,gEAAgE;IAChE,YAAY,CAAC,EAAE,kBAAkB,CAAC,mBAAmB,CAAC,CAAA;IACtD,4CAA4C;IAC5C,WAAW,CAAC,EAAE,kBAAkB,CAAC,kBAAkB,CAAC,CAAA;IAGpD,qFAAqF;IACrF,YAAY,CAAC,EAAE,kBAAkB,CAAC,mBAAmB,CAAC,CAAA;IACtD,kDAAkD;IAClD,WAAW,CAAC,EAAE,kBAAkB,CAAC,kBAAkB,CAAC,CAAA;IAGpD,2DAA2D;IAC3D,kBAAkB,CAAC,EAAE,kBAAkB,CAAC,mBAAmB,CAAC,CAAA;IAC5D,gEAAgE;IAChE,iBAAiB,CAAC,EAAE,kBAAkB,CAAC,mBAAmB,CAAC,CAAA;IAG3D,kEAAkE;IAClE,eAAe,CAAC,EAAE,kBAAkB,CAAC,sBAAsB,CAAC,CAAA;IAC5D,6DAA6D;IAC7D,cAAc,CAAC,EAAE,kBAAkB,CAAC,qBAAqB,CAAC,CAAA;IAG1D,yCAAyC;IACzC,YAAY,CAAC,EAAE,kBAAkB,CAAC,aAAa,CAAC,CAAA;IAChD,wCAAwC;IACxC,WAAW,CAAC,EAAE,kBAAkB,CAAC,aAAa,CAAC,CAAA;IAG/C;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAA;IAC/B;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,CAAA;CAMjD;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE;QACN,QAAQ,EAAE,MAAM,CAAA;QAChB,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,KAAK,EAAE,CAAA;IACf,oFAAoF;IACpF,QAAQ,CAAC,EAAE,cAAc,CAAA;IACzB,2DAA2D;IAC3D,KAAK,CAAC,EAAE,eAAe,CAAA;IACvB;;;;OAIG;IACH,MAAM,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,EAAE,CAAA;KAAE,CAAA;IAC7B;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;;;;;;;;OAUG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;;;;;;;;OASG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,CAAC,CAAC,SAAS,oBAAoB,EACnE,UAAU,EAAE,CAAC,GAAG,oBAAoB,GACnC,CAAC,CAEH;AAED,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,oBAAoB,IAAI,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAA;AAC3F,MAAM,MAAM,6BAA6B,CAAC,CAAC,SAAS,oBAAoB,IAAI,sBAAsB,CAChG,CAAC,CAAC,QAAQ,CAAC,CACZ,CAAA;AAMD;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,KAAK,CAAC,CAAC,SAAS,KAAK,EAAE,UAAU,EAAE,CAAC,GAAG,KAAK,GAAG,CAAC,CAE3E;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,KAAK,IAAI,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAA;AACvE,MAAM,MAAM,wBAAwB,CAAC,CAAC,SAAS,KAAK,IAAI,sBAAsB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAA;AAE3F;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,KAAK,IAAI,QAAQ,CAC/C;IACE,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,CAAC,CAAC,WAAW,CAAC,CAAA;CACtB,GAAG,cAAc,CAAC,CAAC,CAAC,CACtB,CAAA;AAED;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,WAAW,CAAC,EAAE,SAAS,SAAS,KAAK,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,GAC7E,CAAC,SAAS,KAAK,GACb,SAAS,CAAC,CAAC,CAAC,GACZ,KAAK,GACP,KAAK,CAAA;AAET,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,oBAAoB,IAAI,QAAQ,CACnE;IACE,WAAW,EAAE,MAAM,CAAA;IACnB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;CACjB,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAC3B,CAAA;AACD,MAAM,MAAM,wBAAwB,CAAC,CAAC,SAAS,oBAAoB,IAAI,QAAQ,CAC7E;IACE,WAAW,EAAE,MAAM,CAAA;IACnB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;CACjB,GAAG,6BAA6B,CAAC,CAAC,CAAC,CACrC,CAAA;AAMD;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAClC,KAAK,EACL,UAAU,GAAG,OAAO,GAAG,cAAc,GAAG,QAAQ,GAAG,QAAQ,CAC5D,GAAG;IACF,6EAA6E;IAC7E,YAAY,CAAC,EAAE,OAAO,CAAC,YAAY,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IAC7D,6DAA6D;IAC7D,MAAM,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAC5B,sDAAsD;IACtD,MAAM,CAAC,EAAE,iBAAiB,EAAE,CAAA;CAC7B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,GAAG,QAAQ,CAAC,GAAG;IAC7E,MAAM,EAAE,iBAAiB,EAAE,CAAA;CAC5B,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,gCAAgC,GAAG,IAAI,CAAC,oBAAoB,EAAE,OAAO,GAAG,QAAQ,CAAC,GAAG;IAC9F,MAAM,EAAE,iBAAiB,EAAE,CAAA;CAC5B,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,wBAAwB,CACtC,GAAG,EAAE,oBAAoB,GACxB,gCAAgC,CAqClC"}

package/dist/@types/collection-types.js

@@ -0,0 +1,217 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+// ---------------------------------------------------------------------------
+// Workflow
+// ---------------------------------------------------------------------------
+/**
+ * The three status names that every workflow must contain.
+ *
+ * Storage, versioning, and API logic depend on these statuses being present.
+ * `defineWorkflow()` enforces their existence and ordering automatically:
+ *
+ *   `[draft, ...customStatuses, published, archived]`
+ */
+export const WORKFLOW_STATUS_DRAFT = 'draft';
+export const WORKFLOW_STATUS_PUBLISHED = 'published';
+export const WORKFLOW_STATUS_ARCHIVED = 'archived';
+export const REQUIRED_WORKFLOW_STATUSES = [
+    WORKFLOW_STATUS_DRAFT,
+    WORKFLOW_STATUS_PUBLISHED,
+    WORKFLOW_STATUS_ARCHIVED,
+];
+/**
+ * The built-in default workflow used when a collection does not define its own.
+ */
+export const DEFAULT_WORKFLOW = {
+    statuses: [
+        { name: 'draft', label: 'Draft' },
+        { name: 'published', label: 'Published' },
+        { name: 'archived', label: 'Archived' },
+    ],
+};
+/**
+ * Single-status workflow for collections that have no editorial lifecycle —
+ * typically lookup or reference data such as categories, tags, taxonomies,
+ * and facets where a draft → review → publish flow adds friction without
+ * value.
+ *
+ * Effects of using this workflow:
+ *   - Every save lands as `'published'` immediately, so public clients
+ *     reading via `readMode: 'published'` see new rows right away.
+ *   - The form renderer hides workflow controls and shows only Save / Close.
+ *   - The list view's status filter is hidden.
+ *   - `changeDocumentStatus()` and `unpublishDocument()` reject server-side
+ *     because there is no other status to transition to.
+ *
+ * For editorial collections that should keep the draft/published/archived
+ * lifecycle but skip the draft step on save, prefer
+ * `defineWorkflow({ ..., defaultStatus: 'published' })` instead.
+ *
+ * @example
+ * ```ts
+ * import { SINGLE_STATUS_WORKFLOW } from '@byline/core'
+ *
+ * export const DocsCategories: CollectionDefinition = {
+ *   path: 'docs-categories',
+ *   workflow: SINGLE_STATUS_WORKFLOW,
+ *   // ...
+ * }
+ * ```
+ */
+export const SINGLE_STATUS_WORKFLOW = {
+    statuses: [{ name: 'published', label: 'Published' }],
+    defaultStatus: 'published',
+};
+/**
+ * Type-safe factory for creating a `WorkflowConfig`.
+ *
+ * Guarantees that the three required statuses (`draft`, `published`, `archived`)
+ * are always present and correctly ordered:
+ *
+ *   `[draft, ...customStatuses, published, archived]`
+ *
+ * Custom statuses are inserted between `draft` and `published`. If a custom
+ * status uses a reserved name (`draft`, `published`, or `archived`) this
+ * function throws at initialization time.
+ *
+ * @example
+ * ```ts
+ * // Minimal — uses default labels for all three required statuses:
+ * defineWorkflow({})
+ *
+ * // With custom labels/verbs on the required statuses:
+ * defineWorkflow({
+ *   draft:     { label: 'Draft',     verb: 'Revert to Draft' },
+ *   published: { label: 'Published', verb: 'Publish' },
+ *   archived:  { label: 'Archived',  verb: 'Archive' },
+ * })
+ *
+ * // With additional statuses between draft and published:
+ * defineWorkflow({
+ *   draft:     { label: 'Draft',     verb: 'Revert to Draft' },
+ *   published: { label: 'Published', verb: 'Publish' },
+ *   archived:  { label: 'Archived',  verb: 'Archive' },
+ *   customStatuses: [
+ *     { name: 'needs_review', label: 'Needs Review', verb: 'Request Review' },
+ *   ],
+ * })
+ *
+ * // Publish-on-save: keep the full lifecycle, but new versions land
+ * // directly as `published` instead of `draft`.
+ * defineWorkflow({
+ *   defaultStatus: 'published',
+ * })
+ * ```
+ *
+ * For collections that have no editorial lifecycle at all (categories,
+ * tags, taxonomies), use `SINGLE_STATUS_WORKFLOW` instead.
+ */
+export function defineWorkflow(input = {}) {
+    const reserved = new Set(REQUIRED_WORKFLOW_STATUSES);
+    // Validate that no custom status uses a reserved name.
+    if (input.customStatuses) {
+        for (const s of input.customStatuses) {
+            if (reserved.has(s.name)) {
+                throw new Error(`defineWorkflow: custom status '${s.name}' conflicts with a required status name. ` +
+                    `Use the top-level '${s.name}' property to customize its label/verb instead.`);
+            }
+        }
+    }
+    const draft = {
+        name: WORKFLOW_STATUS_DRAFT,
+        label: 'Draft',
+        ...input.draft,
+    };
+    const published = {
+        name: WORKFLOW_STATUS_PUBLISHED,
+        label: 'Published',
+        ...input.published,
+    };
+    const archived = {
+        name: WORKFLOW_STATUS_ARCHIVED,
+        label: 'Archived',
+        ...input.archived,
+    };
+    const statuses = [draft, ...(input.customStatuses ?? []), published, archived];
+    return {
+        statuses,
+        ...(input.defaultStatus ? { defaultStatus: input.defaultStatus } : {}),
+    };
+}
+/** Normalise a collection-hook slot (single function or array) into a flat array. */
+export function normalizeCollectionHook(hook) {
+    if (!hook)
+        return [];
+    return Array.isArray(hook) ? hook : [hook];
+}
+/**
+ * Type-safe factory for creating a CollectionDefinition.
+ * Returns the definition as-is but provides type checking.
+ */
+export function defineCollection(definition) {
+    return definition;
+}
+// ---------------------------------------------------------------------------
+// Block helpers — mirrors of defineCollection / CollectionFieldData / etc.
+// ---------------------------------------------------------------------------
+/**
+ * Type-safe factory for creating a Block. Returns the definition as-is,
+ * but locks in literal types for `blockType`, field names, and select
+ * option values — so `BlockFieldData<typeof MyBlock>` and the
+ * `_type: B['blockType']` discriminant resolve precisely. Replaces the
+ * `as const satisfies Block` pattern.
+ */
+export function defineBlock(definition) {
+    return definition;
+}
+/**
+ * Strips all function-valued properties from a `CollectionDefinition`,
+ * producing a version safe for JSON serialization.
+ *
+ * @example
+ * ```ts
+ * // In an API route:
+ * return Response.json(toSerializableCollection(collectionDef))
+ *
+ * // In an SSR loader:
+ * return { schema: toSerializableCollection(collectionDef), document: data }
+ * ```
+ */
+export function toSerializableCollection(def) {
+    function serializeField(field) {
+        // biome-ignore lint/suspicious/noExplicitAny: intentional structural spread
+        const { validate: _v, hooks: _h, defaultValue, fields, blocks, ...rest } = field;
+        const serialized = { ...rest };
+        // Keep defaultValue only when it is a literal (not a factory function)
+        if (defaultValue !== undefined && typeof defaultValue !== 'function') {
+            serialized.defaultValue = defaultValue;
+        }
+        // Recurse into nested child fields (group / array)
+        if (Array.isArray(fields)) {
+            serialized.fields = fields.map(serializeField);
+        }
+        // Recurse into blocks (blocks field)
+        if (Array.isArray(blocks)) {
+            serialized.blocks = blocks.map(serializeBlock);
+        }
+        return serialized;
+    }
+    function serializeBlock(block) {
+        const { validate: _v, hooks: _h, fields, ...rest } = block;
+        return {
+            ...rest,
+            fields: fields.map(serializeField),
+        };
+    }
+    const { hooks: _hooks, fields, ...rest } = def;
+    return {
+        ...rest,
+        fields: fields.map(serializeField),
+    };
+}
+//# sourceMappingURL=collection-types.js.map

package/dist/@types/collection-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collection-types.js","sourceRoot":"","sources":["../../src/@types/collection-types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAsIH,8EAA8E;AAC9E,WAAW;AACX,8EAA8E;AAE9E;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,OAAgB,CAAA;AACrD,MAAM,CAAC,MAAM,yBAAyB,GAAG,WAAoB,CAAA;AAC7D,MAAM,CAAC,MAAM,wBAAwB,GAAG,UAAmB,CAAA;AAC3D,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,qBAAqB;IACrB,yBAAyB;IACzB,wBAAwB;CAChB,CAAA;AAsFV;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAmB;IAC9C,QAAQ,EAAE;QACR,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE;QACjC,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE;QACzC,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE;KACxC;CACF,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAmB;IACpD,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;IACrD,aAAa,EAAE,WAAW;CAC3B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,UAAU,cAAc,CAAC,QAA6B,EAAE;IAC5D,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAS,0BAA0B,CAAC,CAAA;IAE5D,uDAAuD;IACvD,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;QACzB,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;YACrC,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CACb,kCAAkC,CAAC,CAAC,IAAI,2CAA2C;oBACjF,sBAAsB,CAAC,CAAC,IAAI,iDAAiD,CAChF,CAAA;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,KAAK,GAAmB;QAC5B,IAAI,EAAE,qBAAqB;QAC3B,KAAK,EAAE,OAAO;QACd,GAAG,KAAK,CAAC,KAAK;KACf,CAAA;IACD,MAAM,SAAS,GAAmB;QAChC,IAAI,EAAE,yBAAyB;QAC/B,KAAK,EAAE,WAAW;QAClB,GAAG,KAAK,CAAC,SAAS;KACnB,CAAA;IACD,MAAM,QAAQ,GAAmB;QAC/B,IAAI,EAAE,wBAAwB;QAC9B,KAAK,EAAE,UAAU;QACjB,GAAG,KAAK,CAAC,QAAQ;KAClB,CAAA;IAED,MAAM,QAAQ,GAAqB,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,cAAc,IAAI,EAAE,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;IAEhG,OAAO;QACL,QAAQ;QACR,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACvE,CAAA;AACH,CAAC;AAiTD,qFAAqF;AACrF,MAAM,UAAU,uBAAuB,CACrC,IAAyC;IAEzC,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAA;IACpB,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;AAC5C,CAAC;AA+ID;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAC9B,UAAoC;IAEpC,OAAO,UAAU,CAAA;AACnB,CAAC;AAOD,8EAA8E;AAC9E,2EAA2E;AAC3E,8EAA8E;AAE9E;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAwB,UAAqB;IACtE,OAAO,UAAU,CAAA;AACnB,CAAC;AAkHD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,wBAAwB,CACtC,GAAyB;IAEzB,SAAS,cAAc,CAAC,KAAY;QAClC,4EAA4E;QAC5E,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,KAAY,CAAA;QACvF,MAAM,UAAU,GAAsB,EAAE,GAAG,IAAI,EAAE,CAAA;QAEjD,uEAAuE;QACvE,IAAI,YAAY,KAAK,SAAS,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE,CAAC;YACrE,UAAU,CAAC,YAAY,GAAG,YAAY,CAAA;QACxC,CAAC;QAED,mDAAmD;QACnD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;QAChD,CAAC;QAED,qCAAqC;QACrC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;QAChD,CAAC;QAED,OAAO,UAAU,CAAA;IACnB,CAAC;IAED,SAAS,cAAc,CAAC,KAAY;QAClC,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAA;QAC1D,OAAO;YACL,GAAG,IAAI;YACP,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC;SACnC,CAAA;IACH,CAAC;IAED,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,GAAG,CAAA;IAC9C,OAAO;QACL,GAAG,IAAI;QACP,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC;KACnC,CAAA;AACH,CAAC"}