@bendyline/squisq 2.0.1 → 2.2.0

package/src/schemas/CustomTemplates.ts

@@ -1,126 +0,0 @@
-/**
- * Custom Templates Schema
- *
- * User-defined block layout templates. The author designs a visual
- * layout once (in the editor's TemplateDesigner) and saves it as a
- * `CustomTemplateDefinition`. The definition lives either in the
- * document's frontmatter (per-doc, portable, ships with the markdown)
- * or in the user's local library (cross-doc reuse via localStorage).
- *
- * A custom template's content is just a `Layer[]` — the same shape that
- * built-in templates emit at expansion time. The novel bit is
- * *placeholder tokens*: TextLayer / ImageLayer content fields may carry
- * strings like `{title}`, `{content}`, `{children}`, or `{image:N}`
- * that the resolver (see `doc/templates/tokens/resolveTokens.ts`)
- * substitutes against the source Block at render time.
- *
- * Responsiveness model: every numeric position field in `layers` is
- * stored as a `%`-string relative to `viewport`, so the same template
- * renders correctly at any of Squisq's viewport presets (landscape,
- * portrait, square). The `viewport` field itself is purely an
- * authoring-time reference — it tells the designer canvas which aspect
- * ratio to mount with, and the thumbnail renderer which viewBox to use.
- */
-
-import type { Layer } from './Doc.js';
-
-/**
- * Iteration directive for a custom-template layer.
- *
- * A layer that carries a `repeat` is cloned once per item of a source
- * collection at render time (see `resolveTokens`). The clones are laid
- * out in a row or column, offset from the base position by the layer's
- * own width/height plus `gap`, and each clone resolves per-item tokens
- * (`{item}`, `{item:src}`, `{item:label}`, `{index}`) against its item.
- */
-export interface LayerRepeat {
-  /**
-   * Which of the source Block's collections to iterate:
-   *   - `images`    — every image in the block body (alt + url)
-   *   - `children`  — child block titles
-   *   - `listItems` — top-level list-item text in the block body
-   */
-  source: 'images' | 'children' | 'listItems';
-
-  /**
-   * Layout axis for the clones. `column` (default) stacks them
-   * vertically (offsets `position.y`); `row` lays them out horizontally
-   * (offsets `position.x`).
-   */
-  direction?: 'row' | 'column';
-
-  /**
-   * Extra spacing added between consecutive clones, in the same unit as
-   * the layer's `width`/`height`. Defaults to 24.
-   */
-  gap?: number;
-
-  /** Cap on the number of clones rendered (omit for "all items"). */
-  max?: number;
-}
-
-/**
- * A custom-template layer: a normal render `Layer` that may additionally
- * carry a `repeat` directive. This is a strict superset of the core
- * `Layer` type used only inside `CustomTemplateDefinition.layers`; the
- * resolver strips `repeat` before emitting the final `Layer[]`, so the
- * core `Layer` type is never widened.
- */
-export type CustomTemplateLayer = Layer & { repeat?: LayerRepeat };
-
-/**
- * A single user-defined template. Stored in `Doc.customTemplates`
- * (frontmatter-backed) or in the user's local library.
- */
-export interface CustomTemplateDefinition {
-  /**
-   * Stable id used in heading annotations (`### Foo {[name]}`). Must be
-   * a slug — lowercase alphanumerics, hyphens. The picker enforces
-   * uniqueness within a (doc + library) merged namespace.
-   */
-  name: string;
-
-  /** Human-readable label shown in the template picker. */
-  label: string;
-
-  /** Optional one-sentence description for the picker card. */
-  description?: string;
-
-  /**
-   * Authoring viewport — the canvas size the designer drew against.
-   * Stored so the designer and thumbnail renderer can reproduce the
-   * same canvas. Layer positions are stored as `%`-strings, so the
-   * actual render-time viewport can differ from this without breaking
-   * the layout. Defaults to 1920×1080 landscape.
-   */
-  viewport: {
-    width: number;
-    height: number;
-  };
-
-  /**
-   * The visual content. Every `position.x` / `position.y` /
-   * `position.width` / `position.height` should be a `%`-string at
-   * save time (the designer's normalizePositions step enforces this).
-   *
-   * Tokens supported (grammar v2):
-   *   - TextLayer.content.text — `{title}`, `{content}`, `{children}`,
-   *     `{image:N}` (Nth image's alt text), `{attr:key}` (block
-   *     attribute), plus a pipe default on any token
-   *     (`{attr:subtitle|Untitled}`).
-   *   - ImageLayer.content.src — `{image:N}` (the URL) and `{attr:key}`,
-   *     with pipe defaults (`{image:1|fallback.jpg}`).
-   *   - Inside a layer with `repeat`, per-item tokens: `{item}`,
-   *     `{item:src}`, `{item:label}`, `{index}` (1-based).
-   *
-   * A layer may carry a `repeat` directive (see {@link LayerRepeat}) to
-   * be cloned once per item of a source collection.
-   */
-  layers: CustomTemplateLayer[];
-}
-
-/**
- * Tag value for the YAML frontmatter key that carries inlined custom
- * template definitions. Exported so the markdown bridge stays in sync.
- */
-export const FRONTMATTER_CUSTOM_TEMPLATES_KEY = 'squisq-custom-templates';