@quillmark/svelte 0.26.2 → 0.28.0

package/dist/visual/structure.js

@@ -1,9 +1,5 @@
-// The schema × payload join, done by the editor (VISUAL_EDITOR §Structure). Pure
-// functions only (no runes, no Document reads) so the ordering, control
-// dispatch, group layout, titles, ghosts, and session-identity bookkeeping
-// are unit-testable in isolation (tests/visual/structure.test.ts). The reactive
-// orchestration (revision counter, live doc reads) lives in VisualEditor.svelte;
-// this module is the projection math it feeds.
+// The schema × payload join, as pure functions (VISUAL_EDITOR §Structure). The reactive
+// orchestration lives in VisualEditor.svelte.
 import { VARIANT_DISCRIMINANT_KEY } from '@quillmark/wasm';
 import { core } from '../core/lifecycle.js';
 /** The container controls: the ones a nested address walks into and a deep
@@ -11,25 +7,15 @@ import { core } from '../core/lifecycle.js';
 export function isContainer(kind) {
     return kind === 'array' || kind === 'object' || kind === 'variant' || kind === 'matrix';
 }
-/**
- * A card's resolved rows keyed by field name: the provenance channel parallel to
- * {@link CardModel.values}. `resolve` returns rows in declaration order; the
- * editor keys them the same way `values` keys its payload walk, so a field's value
- * and its provenance resolve under one name.
- */
+/** A card's resolved rows keyed by field name, parallel to {@link CardModel.values}. */
 export function provenanceMap(fields) {
     return Object.fromEntries(fields.map((f) => [f.name, f]));
 }
-/** The empty rows a card with no resolve entry reads: a shared constant so the
- * per-card miss allocates nothing. */
+/** Shared so a per-card miss allocates nothing. */
 export const NO_RESOLVED_ROWS = { fields: [], body: null };
 /**
- * Composable cards' resolved rows keyed by document index (`ResolvedCard.index`,
- * not array position, so it holds whatever order the resolve view returns): built
- * once per derive, so the per-card provenance join is O(1). Both channels ride one
- * entry: a card reads its fields and its body from a single lookup. Empty map when
- * `resolved` is absent (a `resolve` failure degrades to no ghosts, never a blank
- * form).
+ * Resolved rows keyed by `ResolvedCard.index`, not array position. Empty when `resolved` is absent:
+ * a `resolve` failure degrades to no ghosts, never a blank form.
  */
 export function resolvedByCardIndex(resolved) {
     return new Map((resolved?.cards ?? []).map((c) => [c.index, { fields: c.fields, body: c.body }]));
@@ -40,9 +26,10 @@ export function resolvedByCardIndex(resolved) {
 export function ghostDefault(row) {
     return row?.source === 'default' ? row.value : undefined;
 }
-/** A stored `boolean` cell as the render reads it: a boolean, `true` or `false` in any
- * case, or a number by whether it is non-zero; undefined where the render refuses the
- * value. Quillmark's coercion, restated, so the suite holds it to `reader.resolve()`. */
+/**
+ * A stored `boolean` cell as the render reads it (Quillmark's coercion, held to `reader.resolve()`
+ * by the suite); undefined where the render refuses it.
+ */
 export function renderedBoolean(value) {
     if (typeof value === 'boolean')
         return value;
@@ -52,10 +39,10 @@ export function renderedBoolean(value) {
         return value.toLowerCase() === 'true';
     return undefined;
 }
-/** A ghost value's string form, or undefined for null/object (only text ghosts
- * render a placeholder). A scalar's resolved default reads through it; a content
- * field's resolves as `Content`, which a prose leaf reads by its text instead
- * ({@link titleText}). */
+/**
+ * A ghost value's string form, or undefined for null/object. A content field's default resolves as
+ * `Content` and is read by its text ({@link titleText}).
+ */
 export function stringifyGhost(ghost) {
     return ghost != null && typeof ghost !== 'object' ? String(ghost) : undefined;
 }
@@ -74,8 +61,10 @@ export function resolveBodyGhost(resolvedDefault, custom, builtIn) {
 export function optionalCell(f) {
     return f.type.endsWith('?');
 }
-/** The type a cell's control reads: the declared one, an optional cell's `?` stripped.
- *  The `?` moves the render floor and nothing else, so every read of a type is this. */
+/**
+ * The declared type with an optional cell's `?` stripped; the `?` moves the render floor and
+ * nothing else.
+ */
 export function baseType(f) {
     return (optionalCell(f) ? f.type.slice(0, -1) : f.type);
 }
@@ -84,7 +73,7 @@ export function baseType(f) {
 export function oneLine(f) {
     return f.multiline !== true;
 }
-/** Whether a content field's codec is the literal one, its value text with no marks: `text`. */
+/** Whether a content field's codec is the literal one: `text`. */
 export function literalText(f) {
     return baseType(f) === 'text';
 }
@@ -143,8 +132,7 @@ export function mountKey(name, f) {
         items?.max ?? ''
     ].join('\u0000');
 }
-/** Map a field schema to its control. An array's element control is this over `items`;
- *  a type this build does not know takes the text input. */
+/** An array's element control is this over `items`; an unknown type takes the text input. */
 export function controlKind(f) {
     switch (baseType(f)) {
         case 'richtext':
@@ -260,7 +248,6 @@ export function memberWrite(columns, title) {
 export function matrixId(id) {
     return /^[a-z][a-z0-9_]*$/.test(id);
 }
-/** Whether `id` is on the roster. */
 export function onRoster(matrix, id) {
     return matrix.members != null && Object.hasOwn(matrix.members, id);
 }
@@ -377,8 +364,9 @@ function stepInto(schema, step) {
     }
 }
 // ── Row summaries and layouts ────────────────────────────────────────────────
-/** Whether a cell is one line tall by declaration: the shape a table column and a row
- *  summary can hold. A prose cell is one where it is {@link oneLine}. */
+/**
+ * Whether a cell is one line tall by declaration: what a table column and a row summary can hold.
+ */
 export function shortCell(sub) {
     const kind = controlKind(sub);
     if (kind === 'prose')
@@ -386,11 +374,8 @@ export function shortCell(sub) {
     return (kind === 'text' || kind === 'enum' || kind === 'number' || kind === 'boolean' || kind === 'date');
 }
 /**
- * The first short text cell's words — the first one-line `text` or `richtext`, in
- * declaration order — read through {@link titleText}; `undefined` where
- * there is no such cell or it is empty. The cell is picked by the schema alone, so an
- * instance is named by one cell whatever the others hold. What names an instance from
- * its own values: a collapsed row, and a card whose kind declares no `title`.
+ * The words of the first one-line `text` or `richtext` cell in declaration order, picked by schema
+ * alone so one cell names an instance whatever the others hold.
  */
 function firstShortText(cells, values) {
     const named = Object.entries(cells ?? {}).find(([, sub]) => {
@@ -401,8 +386,7 @@ function firstShortText(cells, values) {
         return undefined;
     return titleText(ownValue(values, named[0])).trim() || undefined;
 }
-/** A collapsed row's own words ({@link firstShortText}); `undefined` while the row has
- *  nothing to say for itself. */
+/** A collapsed row's own words ({@link firstShortText}). */
 export function rowSummary(items, row) {
     return firstShortText(items?.properties, (row ?? {}));
 }
@@ -451,7 +435,7 @@ export function commitDiscriminant(value, member) {
     delete next[VARIANT_DISCRIMINANT];
     return Object.keys(next).length ? next : undefined;
 }
-/** `foo_bar` → `Foo bar`: the label fallback when a field declares no `title`. */
+/** `foo_bar` → `Foo bar`. */
 export function humanize(name) {
     const spaced = name.replace(/_/g, ' ').trim();
     return spaced ? spaced[0].toUpperCase() + spaced.slice(1) : spaced;
@@ -483,10 +467,8 @@ export function fieldModels(cardSchema) {
     });
 }
 /**
- * Group-section order (VISUAL_EDITOR §"Structure mirrors the schema"): the schema's `ui.groups` registry
- * key order when present: `QuillCardUi.groups` is a typed `Record` at the
- * boundary, so this reads it uncast: else the first-appearance order of each
- * field's `ui.group`.
+ * Group-section order (VISUAL_EDITOR §"Structure mirrors the schema"): the `ui.groups` key order,
+ * else first appearance of each field's `ui.group`.
  */
 export function groupOrder(cardSchema) {
     const groups = cardSchema.ui?.groups;
@@ -500,20 +482,13 @@ export function groupOrder(cardSchema) {
     }
     return order;
 }
-/**
- * A group's display label: the `ui.groups[g].title` override when the registry
- * declares one, else the humanized id (`memo_for` → "Memo for"): the same
- * id-derives-the-label rule a field's key follows.
- */
+/** A group's `ui.groups[g].title`, else the humanized id. */
 export function groupLabel(cardSchema, group) {
     return cardSchema.ui?.groups?.[group]?.title ?? humanize(group);
 }
 /**
- * Sort field models into ordered group sections. Declared groups first (in
- * `order`), each carrying its fields in declaration order; then any remaining
- * groups (including the ungrouped bucket) in first-appearance order. `labelFor`
- * resolves a group id to its display label: always {@link groupLabel} bound to
- * the card schema, which falls back to {@link humanize} itself.
+ * Declared groups first (in `order`), then any remaining groups, including the ungrouped bucket, in
+ * first-appearance order.
  */
 export function groupSections(fields, order, labelFor) {
     const sections = [];
@@ -568,18 +543,9 @@ export function cardSections(cardSchema) {
     return [...panels, ...groupSections(grouped, order, (g) => groupLabel(cardSchema, g))];
 }
 /**
- * The group section a card's accordion opens on first mount: the first in
- * order, or `null` when the card declares none. Ungrouped fields render outside
- * the accordion, so only `group != null` sections count.
- *
- * A card opens on fields. All-collapsed paints as a stack of chevrons that name
- * their sections and disclose nothing of what is behind them, and a body leaf is
- * no substitute: on a card carrying both, the fields are what the card is for.
- * The first section is the one `ui.groups` already ranks highest, and it is the
- * same section on every mount: a rule keyed on document state would move the
- * opening under a user as they fill.
- *
- * State is ephemeral session state the Card owns; this only seeds it.
+ * The group section a card's accordion opens on first mount, or `null` when the card declares none.
+ * All-collapsed would disclose nothing of what is behind the chevrons, and a rule keyed on document
+ * state would move the opening under a user as they fill.
  */
 export function initialExpandedGroup(sections) {
     return sections.find((s) => s.group != null)?.group ?? null;
@@ -613,15 +579,9 @@ function packable(f) {
     return f.control !== 'prose' || f.inline;
 }
 /**
- * Assign each field its span in the section grid. Consecutive packable fields are
- * `cell`s the grid auto-places: capacity and wrapping are the container query's
- * business, so a trailing orphan keeps its column width rather than growing to fill.
- * A run of one is stranded — nothing packed beside it, and no row above to align to —
- * so it is `full` like the shapes that declined: a lone narrow track reads as truncated
- * against the width it leaves empty, and sharing was the whole of what asked for it.
- * Everything else is `full`.
- *
- * Pure, and stays pure: no width, no measurement, nothing to re-derive on resize.
+ * Consecutive packable fields are `cell`s the grid auto-places; a trailing orphan keeps its column
+ * width. A run of one is `full`: a lone narrow track reads as truncated against the width it leaves
+ * empty. Everything else is `full`. No width is measured.
  */
 export function placeFields(fields) {
     const out = [];
@@ -693,7 +653,6 @@ export function cardTitle(cardSchema, kind, values, extTitle) {
         return t;
     return firstShortText(cardSchema?.fields, values) ?? humanize(kind);
 }
-/** Whether a card kind renders a body leaf: gated by `body.enabled !== false`. */
 export function bodyEnabled(cardSchema) {
     return cardSchema?.body?.enabled !== false;
 }
@@ -702,10 +661,10 @@ export function bodyEnabled(cardSchema) {
 // so a stable card-instance key cannot be the card object (a fresh object every
 // derive): it is a session id held in a parallel array, reordered in lockstep
 // with the structure ops and resolved to an index only at the mutation boundary.
-/** A monotonic per-session id source. Ids are opaque strings, stable for the
- * session; a fresh array for N existing instances is `seq.take(N)`, and an id
- * resolves to its current index by `ids.indexOf(id)` (-1 once the instance is
- * gone): read at the mutation boundary, never cached. */
+/**
+ * A monotonic per-session id source of opaque strings. An id resolves to its index by
+ * `ids.indexOf(id)` at the mutation boundary, never cached.
+ */
 export class IdSeq {
     #n = 0;
     next() {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@quillmark/svelte",
-	"version": "0.26.2",
+	"version": "0.28.0",
 	"description": "Editor, live-preview and source surfaces over a Quillmark WASM session.",
 	"repository": {
 		"type": "git",
@@ -69,7 +69,7 @@
 		"check": "svelte-check --tsconfig ./tsconfig.json --fail-on-warnings"
 	},
 	"peerDependencies": {
-		"@quillmark/wasm": ">=0.129.0-0",
+		"@quillmark/wasm": ">=0.133.0-0",
 		"svelte": "^5.33.0"
 	},
 	"dependencies": {