npm - @anvilkit/contracts - Versions diffs - 0.1.18 - Mend

@anvilkit/contracts 0.1.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (44) hide show

package/dist/export.d.cts ADDED Viewed

@@ -0,0 +1,240 @@
+/**
+ * @file Export format contract — the shape every exporter plugin
+ * (HTML, React, JSON, …) registers with the Studio runtime.
+ *
+ * ### Why `run(ir, options)` and not `run(data, options)`?
+ *
+ * All exports normalize through {@link PageIR} first. This invariant
+ * is enforced at the **type** level here — {@link
+ * ExportFormatDefinition.run} accepts a `PageIR`, not a Puck `Data`.
+ * Authors of new exporters cannot accidentally skip IR normalization;
+ * they physically cannot type-check a function that takes `Data`.
+ *
+ * The normalization step (Puck `Data` → `PageIR`) lives in
+ * `@anvilkit/ir` (Phase 3) and is called once by the export pipeline
+ * before any registered format runs.
+ *
+ * ### Design rules
+ *
+ * 1. **Types only.** This file has zero runtime code.
+ * 2. **Generic options.** {@link ExportOptions} is an identity type
+ *    with a `Record<string, unknown>` constraint, so format authors
+ *    can declare a strongly-typed option bag while the runtime
+ *    treats all formats uniformly.
+ * 3. **Unicode or bytes.** {@link ExportResult.content} is
+ *    `string | Uint8Array` so text formats (HTML, JSON, Markdown)
+ *    stay strings and binary formats (PDF, ZIP) stay bytes — no
+ *    base64 round-tripping.
+ *
+ * @see {@link https://github.com/anvilkit/studio/blob/main/docs/tasks/core-006-types-domain.md | core-006}
+ */
+import type { IRAssetResolver } from "./assets.js";
+import type { PageIR } from "./ir.js";
+/**
+ * Severity of a warning produced during an export run.
+ *
+ * - `"info"` — advisory; nothing wrong, just worth noting.
+ * - `"warn"` — non-fatal concern (e.g. missing alt text, unused
+ *   prop).
+ * - `"error"` — the export succeeded but emitted output the user
+ *   should almost certainly fix (e.g. unresolved asset url). An
+ *   exporter that cannot produce output at all should `throw` with
+ *   a `StudioExportError`, not return an `"error"` warning.
+ */
+export type ExportWarningLevel = "info" | "warn" | "error";
+/**
+ * A single diagnostic emitted by an exporter.
+ *
+ * Warnings are advisory — they do not abort the export. Host apps
+ * typically surface them in a toast or a dev console. Hard failures
+ * should throw `StudioExportError` (see `core-008`), not return a
+ * warning with `level: "error"`.
+ */
+export interface ExportWarning {
+    /**
+     * Severity of this warning. See {@link ExportWarningLevel}.
+     */
+    readonly level: ExportWarningLevel;
+    /**
+     * Machine-readable warning code (e.g. `"missing-alt-text"`).
+     *
+     * Stable across releases so host apps can filter or localize.
+     * Codes are plugin-defined; Core does not maintain a registry.
+     */
+    readonly code: string;
+    /**
+     * Human-readable warning message suitable for developer-facing
+     * surfaces (dev console, toast, logs).
+     */
+    readonly message: string;
+    /**
+     * Optional {@link PageIRNode.id} the warning is attached to.
+     *
+     * When present, host UIs may highlight the offending node in the
+     * editor.
+     */
+    readonly nodeId?: string;
+}
+/**
+ * Generic bag of format-specific options passed to
+ * {@link ExportFormatDefinition.run}.
+ *
+ * Declared as a constrained identity type rather than a bare
+ * `Record<string, unknown>` so format authors can parameterize their
+ * own `run()` signature with a strongly-typed option shape while the
+ * runtime's dispatch layer treats every format's options uniformly.
+ *
+ * @example
+ * ```ts
+ * interface HtmlExportOptions extends Record<string, unknown> {
+ *   readonly inlineStyles: boolean;
+ *   readonly minify?: boolean;
+ * }
+ *
+ * const htmlFormat: ExportFormatDefinition<HtmlExportOptions> = {
+ *   id: "html",
+ *   label: "HTML",
+ *   extension: "html",
+ *   mimeType: "text/html",
+ *   async run(ir, options) {
+ *     //        ^? options: ExportOptions<HtmlExportOptions>
+ *     //        ^? options.inlineStyles is typed as boolean
+ *     return { content: "<!doctype html>…", filename: "page.html" };
+ *   },
+ * };
+ * ```
+ *
+ * @typeParam T - Format-specific option shape. Defaults to an
+ * unconstrained `Record<string, unknown>` so formats that don't care
+ * about options can omit the type parameter entirely.
+ */
+export type ExportOptions<T extends Record<string, unknown> = Record<string, unknown>> = T;
+/**
+ * Per-run context handed to {@link ExportFormatDefinition.run} for
+ * formats that opt into asset-URL rewriting (review finding TS-c).
+ *
+ * `assetResolvers` is the runtime's registration-ordered resolver list
+ * (sourced from `StudioRuntime.assetResolvers`): a format consults each
+ * resolver in order and stops at the first that returns a non-null
+ * rewrite. Absent or empty ⇒ no rewriting is applied; how a format then
+ * treats a reference no resolver handles is its own policy — the bundled
+ * HTML / React exporters omit unresolved `asset://` / `design://` refs and
+ * emit an `ASSET_UNRESOLVED` warning rather than passing them through.
+ */
+export interface ExportFormatRunContext {
+    readonly assetResolvers?: readonly IRAssetResolver[];
+}
+/**
+ * The return value of a successful {@link ExportFormatDefinition.run}
+ * call.
+ *
+ * Text formats (HTML, JSON, Markdown, React source) should set
+ * {@link content} to a `string`. Binary formats (PDF, ZIP, images)
+ * should set it to a `Uint8Array`. Host apps dispatch on the type at
+ * download time — a `string` becomes a `Blob` with the format's
+ * `mimeType`, a `Uint8Array` becomes a `Blob` wrapping the raw bytes.
+ */
+export interface ExportResult {
+    /**
+     * The serialized output.
+     *
+     * Use `string` for text formats and `Uint8Array` for binary
+     * formats. Do not base64-encode binary content into a string;
+     * host apps handle the two cases differently.
+     */
+    readonly content: string | Uint8Array;
+    /**
+     * The suggested filename for the download, including the
+     * extension (e.g. `"page.html"`, `"page.pdf"`).
+     *
+     * Host apps may override this at the download step, but the
+     * exporter is expected to provide a sensible default.
+     */
+    readonly filename: string;
+    /**
+     * Optional non-fatal diagnostics emitted during the export run.
+     *
+     * See {@link ExportWarning}. Host apps may surface these in a
+     * dev console or toast; the export itself is still considered
+     * successful.
+     */
+    readonly warnings?: readonly ExportWarning[];
+}
+/**
+ * The descriptor every exporter plugin contributes to Studio.
+ *
+ * Registered via `StudioPluginRegistration.exportFormats` (part of
+ * the plugin surface that stays in `@anvilkit/core`).
+ * The runtime collects every registered definition into the export
+ * registry (`core-009`) and dispatches to the matching `id` when the
+ * host calls `exportAs(formatId, options)`.
+ *
+ * ### `run(ir, options, ctx?)` contract
+ *
+ * The `run` callback receives a fully-normalized {@link PageIR}, not
+ * a Puck `Data`. The IR normalization step (Puck `Data` → `PageIR`)
+ * is performed exactly once by the export pipeline before any format
+ * runs, ensuring every exporter sees the same input regardless of
+ * how the page was authored.
+ *
+ * Format authors should treat the `ir` argument as deeply read-only.
+ * Mutating it has no effect on the runtime and may break other
+ * exporters in the same pipeline.
+ *
+ * @typeParam Opts - Optional format-specific option shape. See
+ * {@link ExportOptions} for an example of how to parameterize a
+ * concrete format. Defaults to an unconstrained
+ * `Record<string, unknown>`.
+ */
+export interface ExportFormatDefinition<Opts extends Record<string, unknown> = Record<string, unknown>> {
+    /**
+     * Stable, globally-unique format identifier (e.g. `"html"`,
+     * `"react"`, `"json"`).
+     *
+     * The runtime rejects duplicate ids at `createExportRegistry()`
+     * time. Convention: lowercase, hyphen-separated, no namespace
+     * prefix — host apps refer to formats by id in their UI.
+     */
+    readonly id: string;
+    /**
+     * Human-readable label surfaced in export menus and dialogs
+     * (e.g. `"HTML"`, `"React source"`, `"JSON snapshot"`).
+     */
+    readonly label: string;
+    /**
+     * Optional i18n message key for the label, resolved by the chrome via
+     * `useMsg(labelKey, label)` at render — so the export menu localizes
+     * with the active locale. When present it wins; `label` is the
+     * missing-key fallback. Plugins contribute the key via
+     * `ctx.registerMessages` under their own namespace.
+     */
+    readonly labelKey?: string;
+    /**
+     * File extension (without the leading dot) for downloads in this
+     * format (e.g. `"html"`, `"jsx"`, `"json"`, `"pdf"`).
+     */
+    readonly extension: string;
+    /**
+     * MIME type for the exported content (e.g. `"text/html"`,
+     * `"application/json"`, `"application/pdf"`).
+     *
+     * Used by host apps to set the correct `Blob` type at download
+     * time and to populate the `Content-Type` header when sending
+     * exports over the network.
+     */
+    readonly mimeType: string;
+    /**
+     * Produce the serialized output for a page.
+     *
+     * Receives a normalized {@link PageIR} and a format-specific
+     * {@link ExportOptions} bag. Returns a `Promise<ExportResult>`
+     * — always async so the contract is uniform regardless of
+     * whether a given format happens to run synchronously.
+     *
+     * @param ir - The normalized page IR. Deeply read-only.
+     * @param options - Format-specific option bag.
+     * @param ctx - Optional runtime context for additive export hooks.
+     */
+    readonly run: (ir: PageIR, options: ExportOptions<Opts>, ctx?: ExportFormatRunContext) => Promise<ExportResult>;
+}
+//# sourceMappingURL=export.d.cts.map

package/dist/export.d.cts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"export.d.cts","sourceRoot":"","sources":["../src/export.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEtC;;;;;;;;;;GAUG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAE3D;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAC;IACnC;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,MAAM,aAAa,CACxB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACxD,CAAC,CAAC;AAEN;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,sBAAsB;IACtC,QAAQ,CAAC,cAAc,CAAC,EAAE,SAAS,eAAe,EAAE,CAAC;CACrD;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,YAAY;IAC5B;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,CAAC;IACtC;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,aAAa,EAAE,CAAC;CAC7C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,sBAAsB,CACtC,IAAI,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAE9D;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,GAAG,EAAE,CACb,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,aAAa,CAAC,IAAI,CAAC,EAC5B,GAAG,CAAC,EAAE,sBAAsB,KACxB,OAAO,CAAC,YAAY,CAAC,CAAC;CAC3B"}

package/dist/export.d.ts ADDED Viewed

@@ -0,0 +1,240 @@
+/**
+ * @file Export format contract — the shape every exporter plugin
+ * (HTML, React, JSON, …) registers with the Studio runtime.
+ *
+ * ### Why `run(ir, options)` and not `run(data, options)`?
+ *
+ * All exports normalize through {@link PageIR} first. This invariant
+ * is enforced at the **type** level here — {@link
+ * ExportFormatDefinition.run} accepts a `PageIR`, not a Puck `Data`.
+ * Authors of new exporters cannot accidentally skip IR normalization;
+ * they physically cannot type-check a function that takes `Data`.
+ *
+ * The normalization step (Puck `Data` → `PageIR`) lives in
+ * `@anvilkit/ir` (Phase 3) and is called once by the export pipeline
+ * before any registered format runs.
+ *
+ * ### Design rules
+ *
+ * 1. **Types only.** This file has zero runtime code.
+ * 2. **Generic options.** {@link ExportOptions} is an identity type
+ *    with a `Record<string, unknown>` constraint, so format authors
+ *    can declare a strongly-typed option bag while the runtime
+ *    treats all formats uniformly.
+ * 3. **Unicode or bytes.** {@link ExportResult.content} is
+ *    `string | Uint8Array` so text formats (HTML, JSON, Markdown)
+ *    stay strings and binary formats (PDF, ZIP) stay bytes — no
+ *    base64 round-tripping.
+ *
+ * @see {@link https://github.com/anvilkit/studio/blob/main/docs/tasks/core-006-types-domain.md | core-006}
+ */
+import type { IRAssetResolver } from "./assets.js";
+import type { PageIR } from "./ir.js";
+/**
+ * Severity of a warning produced during an export run.
+ *
+ * - `"info"` — advisory; nothing wrong, just worth noting.
+ * - `"warn"` — non-fatal concern (e.g. missing alt text, unused
+ *   prop).
+ * - `"error"` — the export succeeded but emitted output the user
+ *   should almost certainly fix (e.g. unresolved asset url). An
+ *   exporter that cannot produce output at all should `throw` with
+ *   a `StudioExportError`, not return an `"error"` warning.
+ */
+export type ExportWarningLevel = "info" | "warn" | "error";
+/**
+ * A single diagnostic emitted by an exporter.
+ *
+ * Warnings are advisory — they do not abort the export. Host apps
+ * typically surface them in a toast or a dev console. Hard failures
+ * should throw `StudioExportError` (see `core-008`), not return a
+ * warning with `level: "error"`.
+ */
+export interface ExportWarning {
+    /**
+     * Severity of this warning. See {@link ExportWarningLevel}.
+     */
+    readonly level: ExportWarningLevel;
+    /**
+     * Machine-readable warning code (e.g. `"missing-alt-text"`).
+     *
+     * Stable across releases so host apps can filter or localize.
+     * Codes are plugin-defined; Core does not maintain a registry.
+     */
+    readonly code: string;
+    /**
+     * Human-readable warning message suitable for developer-facing
+     * surfaces (dev console, toast, logs).
+     */
+    readonly message: string;
+    /**
+     * Optional {@link PageIRNode.id} the warning is attached to.
+     *
+     * When present, host UIs may highlight the offending node in the
+     * editor.
+     */
+    readonly nodeId?: string;
+}
+/**
+ * Generic bag of format-specific options passed to
+ * {@link ExportFormatDefinition.run}.
+ *
+ * Declared as a constrained identity type rather than a bare
+ * `Record<string, unknown>` so format authors can parameterize their
+ * own `run()` signature with a strongly-typed option shape while the
+ * runtime's dispatch layer treats every format's options uniformly.
+ *
+ * @example
+ * ```ts
+ * interface HtmlExportOptions extends Record<string, unknown> {
+ *   readonly inlineStyles: boolean;
+ *   readonly minify?: boolean;
+ * }
+ *
+ * const htmlFormat: ExportFormatDefinition<HtmlExportOptions> = {
+ *   id: "html",
+ *   label: "HTML",
+ *   extension: "html",
+ *   mimeType: "text/html",
+ *   async run(ir, options) {
+ *     //        ^? options: ExportOptions<HtmlExportOptions>
+ *     //        ^? options.inlineStyles is typed as boolean
+ *     return { content: "<!doctype html>…", filename: "page.html" };
+ *   },
+ * };
+ * ```
+ *
+ * @typeParam T - Format-specific option shape. Defaults to an
+ * unconstrained `Record<string, unknown>` so formats that don't care
+ * about options can omit the type parameter entirely.
+ */
+export type ExportOptions<T extends Record<string, unknown> = Record<string, unknown>> = T;
+/**
+ * Per-run context handed to {@link ExportFormatDefinition.run} for
+ * formats that opt into asset-URL rewriting (review finding TS-c).
+ *
+ * `assetResolvers` is the runtime's registration-ordered resolver list
+ * (sourced from `StudioRuntime.assetResolvers`): a format consults each
+ * resolver in order and stops at the first that returns a non-null
+ * rewrite. Absent or empty ⇒ no rewriting is applied; how a format then
+ * treats a reference no resolver handles is its own policy — the bundled
+ * HTML / React exporters omit unresolved `asset://` / `design://` refs and
+ * emit an `ASSET_UNRESOLVED` warning rather than passing them through.
+ */
+export interface ExportFormatRunContext {
+    readonly assetResolvers?: readonly IRAssetResolver[];
+}
+/**
+ * The return value of a successful {@link ExportFormatDefinition.run}
+ * call.
+ *
+ * Text formats (HTML, JSON, Markdown, React source) should set
+ * {@link content} to a `string`. Binary formats (PDF, ZIP, images)
+ * should set it to a `Uint8Array`. Host apps dispatch on the type at
+ * download time — a `string` becomes a `Blob` with the format's
+ * `mimeType`, a `Uint8Array` becomes a `Blob` wrapping the raw bytes.
+ */
+export interface ExportResult {
+    /**
+     * The serialized output.
+     *
+     * Use `string` for text formats and `Uint8Array` for binary
+     * formats. Do not base64-encode binary content into a string;
+     * host apps handle the two cases differently.
+     */
+    readonly content: string | Uint8Array;
+    /**
+     * The suggested filename for the download, including the
+     * extension (e.g. `"page.html"`, `"page.pdf"`).
+     *
+     * Host apps may override this at the download step, but the
+     * exporter is expected to provide a sensible default.
+     */
+    readonly filename: string;
+    /**
+     * Optional non-fatal diagnostics emitted during the export run.
+     *
+     * See {@link ExportWarning}. Host apps may surface these in a
+     * dev console or toast; the export itself is still considered
+     * successful.
+     */
+    readonly warnings?: readonly ExportWarning[];
+}
+/**
+ * The descriptor every exporter plugin contributes to Studio.
+ *
+ * Registered via `StudioPluginRegistration.exportFormats` (part of
+ * the plugin surface that stays in `@anvilkit/core`).
+ * The runtime collects every registered definition into the export
+ * registry (`core-009`) and dispatches to the matching `id` when the
+ * host calls `exportAs(formatId, options)`.
+ *
+ * ### `run(ir, options, ctx?)` contract
+ *
+ * The `run` callback receives a fully-normalized {@link PageIR}, not
+ * a Puck `Data`. The IR normalization step (Puck `Data` → `PageIR`)
+ * is performed exactly once by the export pipeline before any format
+ * runs, ensuring every exporter sees the same input regardless of
+ * how the page was authored.
+ *
+ * Format authors should treat the `ir` argument as deeply read-only.
+ * Mutating it has no effect on the runtime and may break other
+ * exporters in the same pipeline.
+ *
+ * @typeParam Opts - Optional format-specific option shape. See
+ * {@link ExportOptions} for an example of how to parameterize a
+ * concrete format. Defaults to an unconstrained
+ * `Record<string, unknown>`.
+ */
+export interface ExportFormatDefinition<Opts extends Record<string, unknown> = Record<string, unknown>> {
+    /**
+     * Stable, globally-unique format identifier (e.g. `"html"`,
+     * `"react"`, `"json"`).
+     *
+     * The runtime rejects duplicate ids at `createExportRegistry()`
+     * time. Convention: lowercase, hyphen-separated, no namespace
+     * prefix — host apps refer to formats by id in their UI.
+     */
+    readonly id: string;
+    /**
+     * Human-readable label surfaced in export menus and dialogs
+     * (e.g. `"HTML"`, `"React source"`, `"JSON snapshot"`).
+     */
+    readonly label: string;
+    /**
+     * Optional i18n message key for the label, resolved by the chrome via
+     * `useMsg(labelKey, label)` at render — so the export menu localizes
+     * with the active locale. When present it wins; `label` is the
+     * missing-key fallback. Plugins contribute the key via
+     * `ctx.registerMessages` under their own namespace.
+     */
+    readonly labelKey?: string;
+    /**
+     * File extension (without the leading dot) for downloads in this
+     * format (e.g. `"html"`, `"jsx"`, `"json"`, `"pdf"`).
+     */
+    readonly extension: string;
+    /**
+     * MIME type for the exported content (e.g. `"text/html"`,
+     * `"application/json"`, `"application/pdf"`).
+     *
+     * Used by host apps to set the correct `Blob` type at download
+     * time and to populate the `Content-Type` header when sending
+     * exports over the network.
+     */
+    readonly mimeType: string;
+    /**
+     * Produce the serialized output for a page.
+     *
+     * Receives a normalized {@link PageIR} and a format-specific
+     * {@link ExportOptions} bag. Returns a `Promise<ExportResult>`
+     * — always async so the contract is uniform regardless of
+     * whether a given format happens to run synchronously.
+     *
+     * @param ir - The normalized page IR. Deeply read-only.
+     * @param options - Format-specific option bag.
+     * @param ctx - Optional runtime context for additive export hooks.
+     */
+    readonly run: (ir: PageIR, options: ExportOptions<Opts>, ctx?: ExportFormatRunContext) => Promise<ExportResult>;
+}
+//# sourceMappingURL=export.d.ts.map

package/dist/export.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"export.d.ts","sourceRoot":"","sources":["../src/export.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEtC;;;;;;;;;;GAUG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAE3D;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAC;IACnC;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,MAAM,aAAa,CACxB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACxD,CAAC,CAAC;AAEN;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,sBAAsB;IACtC,QAAQ,CAAC,cAAc,CAAC,EAAE,SAAS,eAAe,EAAE,CAAC;CACrD;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,YAAY;IAC5B;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,CAAC;IACtC;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,aAAa,EAAE,CAAC;CAC7C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,sBAAsB,CACtC,IAAI,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAE9D;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,GAAG,EAAE,CACb,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,aAAa,CAAC,IAAI,CAAC,EAC5B,GAAG,CAAC,EAAE,sBAAsB,KACxB,OAAO,CAAC,YAAY,CAAC,CAAC;CAC3B"}

package/dist/export.js ADDED Viewed

	@@ -0,0 +1 @@
1	+ export { };

package/dist/index.cjs ADDED Viewed

@@ -0,0 +1,18 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ("u" > typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+for(var __rspack_i in __webpack_exports__)exports[__rspack_i] = __webpack_exports__[__rspack_i];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/index.d.cts ADDED Viewed

@@ -0,0 +1,45 @@
+/**
+ * @file Barrel for `@anvilkit/contracts` — the shared, type-only
+ * contract layer of the AnvilKit workspace.
+ *
+ * ### What lives here
+ *
+ * The serializable data contracts passed **between** packages: the
+ * Page IR (`ir.ts`), the AI generation + validation DTOs (`ai.ts`,
+ * `ai-section.ts`), the export format contract (`export.ts`), the
+ * pages-source host contract (`page.ts`), and asset resolution
+ * (`assets.ts`).
+ *
+ * ### What deliberately does NOT live here
+ *
+ * Runtime logic of any kind. Transforms (`puckDataToIR`,
+ * `configToAiContext`, …), Zod validators, migrations, React hooks,
+ * Puck overrides, and the Studio plugin registration surface stay in
+ * their owning packages. This package must remain runtime-free: it
+ * has no `dependencies`, its only peer is a **type-only** import from
+ * `@puckeditor/core`, and every module compiles to an empty runtime
+ * output under `verbatimModuleSyntax`.
+ *
+ * ### Dependency direction
+ *
+ * ```
+ * @anvilkit/contracts
+ *       ↓
+ * @anvilkit/ir · @anvilkit/schema · @anvilkit/validator
+ *       ↓
+ * @anvilkit/core
+ *       ↓
+ * plugins / apps
+ * ```
+ *
+ * `@anvilkit/core/types` re-exports everything below as a
+ * compatibility shim, so existing consumers keep working; new code
+ * should import from `@anvilkit/contracts` directly.
+ */
+export type { AiComponentSchema, AiFieldSchema, AiFieldType, AiGenerationContext, AiThemeHint, AiValidationIssue, AiValidationResult, } from "./ai.js";
+export type { AiSectionContext, AiSectionPatch, AiSectionSelection, ConfigToAiSectionContextOptions, } from "./ai-section.js";
+export type { AssetResolution, IRAssetResolver } from "./assets.js";
+export type { ExportFormatDefinition, ExportFormatRunContext, ExportOptions, ExportResult, ExportWarning, ExportWarningLevel, } from "./export.js";
+export type { PageIR, PageIRAsset, PageIRMetadata, PageIRNode, PageIRNodeMeta, } from "./ir.js";
+export type { StudioPage, StudioPageCreateInput, StudioPageRenameInput, StudioPageReorderInput, StudioPageSeo, StudioPageSettingsInput, StudioPagesSource, } from "./page.js";
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH,YAAY,EACX,iBAAiB,EACjB,aAAa,EACb,WAAW,EACX,mBAAmB,EACnB,WAAW,EACX,iBAAiB,EACjB,kBAAkB,GAClB,MAAM,SAAS,CAAC;AACjB,YAAY,EACX,gBAAgB,EAChB,cAAc,EACd,kBAAkB,EAClB,+BAA+B,GAC/B,MAAM,iBAAiB,CAAC;AACzB,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACpE,YAAY,EACX,sBAAsB,EACtB,sBAAsB,EACtB,aAAa,EACb,YAAY,EACZ,aAAa,EACb,kBAAkB,GAClB,MAAM,aAAa,CAAC;AACrB,YAAY,EACX,MAAM,EACN,WAAW,EACX,cAAc,EACd,UAAU,EACV,cAAc,GACd,MAAM,SAAS,CAAC;AACjB,YAAY,EACX,UAAU,EACV,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,EACtB,aAAa,EACb,uBAAuB,EACvB,iBAAiB,GACjB,MAAM,WAAW,CAAC"}

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,45 @@
+/**
+ * @file Barrel for `@anvilkit/contracts` — the shared, type-only
+ * contract layer of the AnvilKit workspace.
+ *
+ * ### What lives here
+ *
+ * The serializable data contracts passed **between** packages: the
+ * Page IR (`ir.ts`), the AI generation + validation DTOs (`ai.ts`,
+ * `ai-section.ts`), the export format contract (`export.ts`), the
+ * pages-source host contract (`page.ts`), and asset resolution
+ * (`assets.ts`).
+ *
+ * ### What deliberately does NOT live here
+ *
+ * Runtime logic of any kind. Transforms (`puckDataToIR`,
+ * `configToAiContext`, …), Zod validators, migrations, React hooks,
+ * Puck overrides, and the Studio plugin registration surface stay in
+ * their owning packages. This package must remain runtime-free: it
+ * has no `dependencies`, its only peer is a **type-only** import from
+ * `@puckeditor/core`, and every module compiles to an empty runtime
+ * output under `verbatimModuleSyntax`.
+ *
+ * ### Dependency direction
+ *
+ * ```
+ * @anvilkit/contracts
+ *       ↓
+ * @anvilkit/ir · @anvilkit/schema · @anvilkit/validator
+ *       ↓
+ * @anvilkit/core
+ *       ↓
+ * plugins / apps
+ * ```
+ *
+ * `@anvilkit/core/types` re-exports everything below as a
+ * compatibility shim, so existing consumers keep working; new code
+ * should import from `@anvilkit/contracts` directly.
+ */
+export type { AiComponentSchema, AiFieldSchema, AiFieldType, AiGenerationContext, AiThemeHint, AiValidationIssue, AiValidationResult, } from "./ai.js";
+export type { AiSectionContext, AiSectionPatch, AiSectionSelection, ConfigToAiSectionContextOptions, } from "./ai-section.js";
+export type { AssetResolution, IRAssetResolver } from "./assets.js";
+export type { ExportFormatDefinition, ExportFormatRunContext, ExportOptions, ExportResult, ExportWarning, ExportWarningLevel, } from "./export.js";
+export type { PageIR, PageIRAsset, PageIRMetadata, PageIRNode, PageIRNodeMeta, } from "./ir.js";
+export type { StudioPage, StudioPageCreateInput, StudioPageRenameInput, StudioPageReorderInput, StudioPageSeo, StudioPageSettingsInput, StudioPagesSource, } from "./page.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH,YAAY,EACX,iBAAiB,EACjB,aAAa,EACb,WAAW,EACX,mBAAmB,EACnB,WAAW,EACX,iBAAiB,EACjB,kBAAkB,GAClB,MAAM,SAAS,CAAC;AACjB,YAAY,EACX,gBAAgB,EAChB,cAAc,EACd,kBAAkB,EAClB,+BAA+B,GAC/B,MAAM,iBAAiB,CAAC;AACzB,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACpE,YAAY,EACX,sBAAsB,EACtB,sBAAsB,EACtB,aAAa,EACb,YAAY,EACZ,aAAa,EACb,kBAAkB,GAClB,MAAM,aAAa,CAAC;AACrB,YAAY,EACX,MAAM,EACN,WAAW,EACX,cAAc,EACd,UAAU,EACV,cAAc,GACd,MAAM,SAAS,CAAC;AACjB,YAAY,EACX,UAAU,EACV,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,EACtB,aAAa,EACb,uBAAuB,EACvB,iBAAiB,GACjB,MAAM,WAAW,CAAC"}

package/dist/index.js ADDED Viewed

	@@ -0,0 +1 @@
1	+ export { };

package/dist/ir.cjs ADDED Viewed

@@ -0,0 +1,18 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ("u" > typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+for(var __rspack_i in __webpack_exports__)exports[__rspack_i] = __webpack_exports__[__rspack_i];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});