@quillmark/svelte 0.22.0 → 0.23.0

package/dist/core/codec/cap.d.ts

@@ -0,0 +1,21 @@
+import type { Node as PMNode } from 'prosemirror-model';
+import { Plugin } from 'prosemirror-state';
+/** A leaf's character cap: the schema's `max:`, and whether the count drops trailing
+ *  whitespace, which a one-line `text` does and nothing else. */
+export interface TextCap {
+    max: number;
+    trimEnd?: boolean;
+    /** The count, at mount and after every change to the document. */
+    onCount?: (count: number) => void;
+}
+/** The characters `doc` holds as `FieldSchema::char_count` counts them: Unicode scalar
+ *  values of the plain projection, islands counting nothing and trailing line breaks
+ *  none. */
+export declare function capCount(doc: PMNode, trimEnd?: boolean): number;
+/**
+ * Refuses a transaction leaving the leaf past `max`, so a keystroke at the cap lands
+ * nothing, and cuts a paste to what fits. Past the cap, a transaction passes where it
+ * leaves the count no higher, so a value stored over the cap still edits down; undo and
+ * redo pass, each restoring a state the leaf already held.
+ */
+export declare function capPlugin(cap: TextCap): Plugin;

package/dist/core/codec/cap.js

@@ -0,0 +1,63 @@
+import { isHistoryTransaction } from 'prosemirror-history';
+import { Plugin } from 'prosemirror-state';
+import { usvLength } from './decode.js';
+import { scanDoc } from './encode.js';
+import { ISLAND_SLOT } from './islands.js';
+/** The characters `doc` holds as `FieldSchema::char_count` counts them: Unicode scalar
+ *  values of the plain projection, islands counting nothing and trailing line breaks
+ *  none. */
+export function capCount(doc, trimEnd = false) {
+    const text = scanDoc(doc).text.replaceAll(ISLAND_SLOT, '');
+    return usvLength(trimEnd ? text.trimEnd() : text.replace(/[\n\r]+$/, ''));
+}
+/**
+ * Refuses a transaction leaving the leaf past `max`, so a keystroke at the cap lands
+ * nothing, and cuts a paste to what fits. Past the cap, a transaction passes where it
+ * leaves the count no higher, so a value stored over the cap still edits down; undo and
+ * redo pass, each restoring a state the leaf already held.
+ */
+export function capPlugin(cap) {
+    const count = (doc) => capCount(doc, cap.trimEnd);
+    return new Plugin({
+        filterTransaction: (tr) => {
+            if (!tr.docChanged || isHistoryTransaction(tr))
+                return true;
+            const after = count(tr.doc);
+            return after <= cap.max || after <= count(tr.before);
+        },
+        props: {
+            handlePaste: (view, _event, slice) => {
+                const { state } = view;
+                const pasted = () => state.tr.replaceSelection(slice);
+                if (count(pasted().doc) <= cap.max)
+                    return false;
+                const tr = pasted();
+                const start = tr.mapping.map(state.selection.from, -1);
+                const end = tr.mapping.map(state.selection.to, 1);
+                const fits = (cut) => count(pasted().delete(cut, end).doc) <= cap.max;
+                if (!fits(start))
+                    return true;
+                let lo = start;
+                let hi = end;
+                while (hi - lo > 1) {
+                    const mid = (lo + hi) >> 1;
+                    if (fits(mid))
+                        lo = mid;
+                    else
+                        hi = mid;
+                }
+                view.dispatch(tr.delete(lo, end).scrollIntoView().setMeta('uiEvent', 'paste'));
+                return true;
+            }
+        },
+        view: (v) => {
+            cap.onCount?.(count(v.state.doc));
+            return {
+                update: (next, prev) => {
+                    if (next.state.doc !== prev.doc)
+                        cap.onCount?.(count(next.state.doc));
+                }
+            };
+        }
+    });
+}

package/dist/core/codec/field.d.ts

@@ -3,6 +3,7 @@ import { Plugin } from 'prosemirror-state';
 import { EditorView } from 'prosemirror-view';
 import type { Document, Content, Addr, Quill } from '@quillmark/wasm';
 import type { EditorErrorHandler } from '../errors.js';
+import { type TextCap } from './cap.js';
 import { type TableChromeStrings } from './table-view.js';
 import { type SlashState, type SlashStrings } from './slash.js';
 /** Options for {@link createField}. */
@@ -75,6 +76,9 @@ export interface CreateFieldOpts {
      * a body's invitation. The initial value; {@link FieldController.setPlaceholder}
      * moves it after mount. Empty/absent shows no ghost. */
     placeholder?: string;
+    /** The schema's `max:` on the field: a character count no edit takes the leaf past
+     *  (`cap.ts`). */
+    cap?: TextCap;
     /** The placeholder goes at the leaf's first edit: the edit answers the leaf, and
      * emptied it holds an empty answer, which prints empty. Absent, the placeholder
      * returns whenever the leaf is empty. */
@@ -224,5 +228,8 @@ export declare function proseLeafPlugins(schema: Schema, opts: {
     placeholder?: () => string | undefined;
     /** {@link CreateFieldOpts.placeholderUntilEdit}. */
     placeholderUntilEdit?: boolean;
+    /** {@link CreateFieldOpts.cap}. Ahead of every other paste handler, which a paste
+     *  it cuts never reaches. */
+    cap?: TextCap;
     afterHistory?: Plugin[];
 }): Plugin[];

package/dist/core/codec/field.js

@@ -24,6 +24,7 @@ import { reportError, errorMessage } from '../errors.js';
 import { decode, fitsLeaf } from './decode.js';
 import { usvToPM, pmToUsv, buildLineIndex, lineIndexOf } from './positions.js';
 import { lower, pmToContent, scanContent, scanDoc, contentEdit } from './encode.js';
+import { capPlugin } from './cap.js';
 import { islandPastePlugin } from './islands.js';
 import { anchorsFromContent } from './marks.js';
 import { contentEqual, createReconciler } from './reconcile.js';
@@ -282,6 +283,7 @@ export function createField(opts) {
                 // given one later; the plugin draws nothing while the text is empty.
                 placeholder: () => placeholderText,
                 placeholderUntilEdit: opts.placeholderUntilEdit,
+                cap: opts.cap,
                 afterHistory: [anchorPlugin(seededAnchors)]
             })
         });
@@ -547,7 +549,12 @@ export function createField(opts) {
  * its author typed without a second rule saying so.
  */
 export function proseLeafPlugins(schema, opts) {
-    const list = [history(), ...(opts.afterHistory ?? []), linebreakPlugin(schema)];
+    const list = [
+        history(),
+        ...(opts.cap ? [capPlugin(opts.cap)] : []),
+        ...(opts.afterHistory ?? []),
+        linebreakPlugin(schema)
+    ];
     if (opts.slash)
         list.push(slashPlugin(opts.slash, opts.slashHint));
     if (!opts.noInputRules)

package/dist/core/codec/index.d.ts

@@ -2,6 +2,8 @@ export { rangeAnchor } from './anchor.js';
 export type { RangeAnchor } from './anchor.js';
 export { createField, emptyContent, heldAttributes, isEmptyContent, proseAttributes, proseLeafPlugins } from './field.js';
 export type { CreateFieldOpts, FieldController, LeafViews } from './field.js';
+export { capCount } from './cap.js';
+export type { TextCap } from './cap.js';
 export { DEFAULT_TABLE_STRINGS } from './table-view.js';
 export type { TableChromeStrings } from './table-view.js';
 export { DEFAULT_SLASH_STRINGS } from './slash.js';

package/dist/core/codec/index.js

@@ -14,6 +14,7 @@ import './prose.css';
 export { rangeAnchor } from './anchor.js';
 // The prose leaf.
 export { createField, emptyContent, heldAttributes, isEmptyContent, proseAttributes, proseLeafPlugins } from './field.js';
+export { capCount } from './cap.js';
 // The table island's chrome vocabulary: the visual tier's `strings` set extends it,
 // so the island's wording is overridden beside every other key.
 export { DEFAULT_TABLE_STRINGS } from './table-view.js';

package/dist/visual/ArrayField.svelte

@@ -74,6 +74,7 @@
 		literalText,
 		rowSummary,
 		schemaAt,
+		textCap,
 		type ArrayLayout
 	} from './structure.js';
 	import { splitDeep, unrouted, type DeepDiagnostic } from './diagnostics.js';
@@ -800,6 +801,7 @@
 							content={() => readAt([k])}
 							value={arr[k]}
 							plaintext={items != null && literalText(items)}
+							cap={textCap(items)}
 							label={rowName(k)}
 							onChange={(rt) => commitElement(k, rt)}
 							onKey={(e) => onElementKey(e, k)}

package/dist/visual/Field.svelte

@@ -40,6 +40,7 @@
 		printedText,
 		renderedBoolean,
 		stringifyGhost,
+		textCap,
 		titleText
 	} from './structure.js';
 	import { wording } from './strings.js';
@@ -163,6 +164,14 @@
 	// reference must vanish with it: `aria-describedby` pointing at nothing describes
 	// nothing, and silently.
 	const describedBy = $derived(field.description ? domIds.description : undefined);
+	// A capped prose leaf reports its count, and the count describes it too: a keystroke
+	// the cap refuses changes nothing else a reader can perceive.
+	let chars = $state<number>();
+	const cap = $derived(field.control === 'prose' ? textCap(field.schema) : undefined);
+	const countId = $derived(`${domIds.control}-count`);
+	const proseDescribedBy = $derived(
+		cap ? [describedBy, countId].filter(Boolean).join(' ') : describedBy
+	);
 	// Two controls own their label row, the add chip and the held count sharing it.
 	const ownsLabel = $derived(field.control === 'array' || field.control === 'matrix');
 	const flat = $derived(flatObject(field.schema));
@@ -285,6 +294,8 @@
 			descriptionId={domIds.description}
 			{onActivate}
 			description={field.description}
+			count={cap && chars != null ? t.strings.textCount(chars, cap.max) : undefined}
+			{countId}
 		/>
 	{/if}
 	<!-- The control and what hangs under it, in one grid cell: the diagnostics stack
@@ -305,7 +316,8 @@
 					placeholder={none}
 					emptyUnsets={optional}
 					labelledBy={domIds.label}
-					{describedBy}
+					describedBy={proseDescribedBy}
+					cap={cap && { ...cap, onCount: (n) => (chars = n) }}
 					{leafKey}
 					{onFocus}
 					{onCaretMove}

package/dist/visual/FieldLabel.svelte

@@ -40,8 +40,13 @@
 		onActivate?: () => void;
 		/** Schema `description`, or undefined: the affordance renders only when set. */
 		description?: string;
+		/** A capped field's character count, drawn at the row's end. */
+		count?: string;
+		/** The count's own id, for the control's `aria-describedby`. */
+		countId?: string;
 	}
-	let { label, controlId, id, descriptionId, onActivate, description }: Props = $props();
+	let { label, controlId, id, descriptionId, onActivate, description, count, countId }: Props =
+		$props();
 </script>
 
 <div class="qm-field-label-row">
@@ -68,6 +73,9 @@
 		<FieldHint {description} {label} describedBy={descriptionId} />
 		<span class="qm-visually-hidden" id={descriptionId}>{description}</span>
 	{/if}
+	{#if count != null}
+		<span class="qm-field-count" id={countId}>{count}</span>
+	{/if}
 </div>
 
 <style>
@@ -91,6 +99,12 @@
 		color: var(--_qm-ink-label);
 		min-width: 0;
 	}
+	.qm-field-count {
+		margin-inline-start: auto;
+		font-size: var(--_qm-text-label);
+		color: var(--_qm-ink-label);
+		font-variant-numeric: tabular-nums;
+	}
 	/* A label that lands focus says so. Only when it has somewhere to land: an
 	   `ObjectField` property's label names a subform, not one control. */
 	.qm-field-label.targeted {

package/dist/visual/FieldLabel.svelte.d.ts

@@ -11,6 +11,10 @@ interface Props {
     onActivate?: () => void;
     /** Schema `description`, or undefined: the affordance renders only when set. */
     description?: string;
+    /** A capped field's character count, drawn at the row's end. */
+    count?: string;
+    /** The count's own id, for the control's `aria-describedby`. */
+    countId?: string;
 }
 declare const FieldLabel: import("svelte").Component<Props, {}, "">;
 type FieldLabel = ReturnType<typeof FieldLabel>;

package/dist/visual/ObjectField.svelte

@@ -51,7 +51,8 @@
 		placeFields,
 		printedText,
 		renderedBoolean,
-		shortCell
+		shortCell,
+		textCap
 	} from './structure.js';
 	import { splitDeep, unrouted, type DeepDiagnostic } from './diagnostics.js';
 	import type { LandingBox } from './leaves.js';
@@ -136,6 +137,8 @@
 	}: Props = $props();
 
 	const t = wording();
+	/** A capped prose cell's character count, by property. */
+	const counts: Record<string, number> = $state({});
 	const entries = $derived(Object.entries(properties ?? {}));
 	const obj = $derived((value ?? {}) as Record<string, unknown>);
 	const has = (key: string): boolean => Object.hasOwn(properties ?? {}, key);
@@ -298,6 +301,8 @@
 			     (`packable`). A block prose cell spans it too, and keeps its label row, as
 			     does a placed cell `placeFields` gives the whole row. -->
 			{@const block = kind === 'prose' && !shortCell(sub)}
+			{@const cap = kind === 'prose' ? textCap(sub) : undefined}
+			{@const countId = cap && ids ? `${ids.control}-count` : undefined}
 			<div
 				class={[
 					'qm-object-prop',
@@ -316,6 +321,10 @@
 						descriptionId={describes}
 						onActivate={labelable ? undefined : () => focusProp(key)}
 						description={sub.description}
+						count={cap && counts[key] != null
+							? t.strings.textCount(counts[key], cap.max)
+							: undefined}
+						{countId}
 					/>
 				{/if}
 				{#if kind === 'enum'}
@@ -385,7 +394,8 @@
 						{block}
 						label={named}
 						labelledBy={ids?.label}
-						describedBy={describes}
+						describedBy={countId ? [describes, countId].filter(Boolean).join(' ') : describes}
+						cap={cap && { ...cap, onCount: (n) => (counts[key] = n) }}
 						onChange={(rt) =>
 							commitProp(key, optionalCell(sub) && isEmptyContent(rt) ? undefined : rt)}
 						onKey={onCellKey ? (e) => onCellKey(e, key) : undefined}

package/dist/visual/ProseField.svelte

@@ -6,7 +6,12 @@
 -->
 <script lang="ts">
 	import { untrack } from 'svelte';
-	import { createField, type FieldController, type SlashState } from '../core/codec/index.js';
+	import {
+		createField,
+		type FieldController,
+		type SlashState,
+		type TextCap
+	} from '../core/codec/index.js';
 	import type { LeafRegistry } from './leaves.js';
 	import SlashMenu from './SlashMenu.svelte';
 	import { wording } from './strings.js';
@@ -48,6 +53,8 @@
 		placeholderUntilEdit?: boolean;
 		/** An emptied leaf removes the field (`createField`). */
 		emptyUnsets?: boolean;
+		/** The declared `max:`, a character count no edit takes the leaf past. */
+		cap?: TextCap;
 		/** Registry identity, stamped on the DOM node so a remount is visible as one. */
 		leafKey: string;
 		onFocus?: (addr: Addr) => void;
@@ -77,6 +84,7 @@
 		placeholder,
 		placeholderUntilEdit,
 		emptyUnsets,
+		cap,
 		leafKey,
 		onFocus,
 		onCaretMove,
@@ -127,6 +135,7 @@
 				placeholder,
 				placeholderUntilEdit,
 				emptyUnsets,
+				cap,
 				tableStrings: () => t.strings,
 				slashStrings: () => t.strings,
 				onSlash: (next) => {

package/dist/visual/ProseField.svelte.d.ts

@@ -1,3 +1,4 @@
+import { type TextCap } from '../core/codec/index.js';
 import type { LeafRegistry } from './leaves.js';
 import type { Document, Quill, Addr, Content, Diagnostic } from '@quillmark/wasm';
 import type { EditorErrorHandler } from '../core/errors.js';
@@ -35,6 +36,8 @@ interface Props {
     placeholderUntilEdit?: boolean;
     /** An emptied leaf removes the field (`createField`). */
     emptyUnsets?: boolean;
+    /** The declared `max:`, a character count no edit takes the leaf past. */
+    cap?: TextCap;
     /** Registry identity, stamped on the DOM node so a remount is visible as one. */
     leafKey: string;
     onFocus?: (addr: Addr) => void;

package/dist/visual/ProseValue.svelte

@@ -60,7 +60,8 @@
 		pmToUsv,
 		usvToPM,
 		valueEqual,
-		type LeafViews
+		type LeafViews,
+		type TextCap
 	} from '../core/codec/index.js';
 	import { valueLeafSeat } from './leaves.js';
 	import { wording } from './strings.js';
@@ -99,6 +100,8 @@
 		/** The empty leaf's ghost, a subform cell's: the `none` an optional cell prints
 		 *  unset. Read per decoration pass. */
 		placeholder?: string;
+		/** The declared `max:`, a character count no edit takes the leaf past. */
+		cap?: TextCap;
 		onChange: (rt: Content) => void;
 		/** Raw keydown, for a container whose own keys run through this leaf: the
 		 * array repeater's Enter/Backspace (`ArrayField`). Fires before the view's own
@@ -115,6 +118,7 @@
 		labelledBy,
 		describedBy,
 		placeholder,
+		cap,
 		onChange,
 		onKey
 	}: Props = $props();
@@ -190,7 +194,8 @@
 						? []
 						: proseLeafPlugins(schema, {
 								inline,
-								placeholder: () => placeholder
+								placeholder: () => placeholder,
+								cap
 							})
 				});
 			};

package/dist/visual/ProseValue.svelte.d.ts

@@ -1,3 +1,4 @@
+import { type TextCap } from '../core/codec/index.js';
 import type { Content } from '@quillmark/wasm';
 interface Props {
     /** This leaf's content (the parent's boundary read), `undefined` where nothing is
@@ -31,6 +32,8 @@ interface Props {
     /** The empty leaf's ghost, a subform cell's: the `none` an optional cell prints
      *  unset. Read per decoration pass. */
     placeholder?: string;
+    /** The declared `max:`, a character count no edit takes the leaf past. */
+    cap?: TextCap;
     onChange: (rt: Content) => void;
     /** Raw keydown, for a container whose own keys run through this leaf: the
      * array repeater's Enter/Backspace (`ArrayField`). Fires before the view's own

package/dist/visual/strings.d.ts

@@ -35,6 +35,12 @@ export interface VisualStrings extends TableChromeStrings, SlashStrings {
      * spells the separator.
      */
     arrayCount: (count: number, max: number) => string;
+    /**
+     * The count beside the label of a `text` or `richtext` field declaring `max:`, the
+     * carrier of a keystroke the cap refuses: `12 / 40`. Parametric, so a translator
+     * spells the separator.
+     */
+    textCount: (count: number, max: number) => string;
     /**
      * A collapsed array element with nothing to summarize itself by: the label and the
      * 1-based index, which is what its accessible name already says. Parametric, so

package/dist/visual/strings.js

@@ -41,6 +41,7 @@ export const DEFAULT_VISUAL_STRINGS = {
     arrayDrag: 'Drag to move',
     arrayRowAction: (action, row) => `${action} ${row}`,
     arrayCount: (count, max) => `${count} / ${max}`,
+    textCount: (count, max) => `${count} / ${max}`,
     elementUntitled: (label, index) => `${label} ${index}`,
     enumUnsetTag: 'Default',
     enumUnsetTagNone: 'Unset',

package/dist/visual/structure.d.ts

@@ -1,4 +1,5 @@
 import { type Content, type PathStep, type PayloadItem, type QuillCardSchema, type QuillFieldSchema, type QuillFieldType, type ResolvedField, type Resolved } from '@quillmark/wasm';
+import type { TextCap } from '../core/codec/index.js';
 /** The control a field type maps to (VISUAL_EDITOR §"Structure mirrors the schema"). */
 export type ControlKind = 'prose' | 'text' | 'enum' | 'variant' | 'number' | 'boolean' | 'date' | 'array' | 'object' | 'matrix';
 /** The container controls: the ones a nested address walks into and a deep
@@ -161,6 +162,8 @@ export declare function baseType(f: QuillFieldSchema): QuillFieldType;
 export declare function oneLine(f: QuillFieldSchema): boolean;
 /** Whether a content field's codec is the literal one, its value text with no marks: `text`. */
 export declare function literalText(f: QuillFieldSchema): boolean;
+/** The character cap a content field's `max:` declares, `undefined` on any other. */
+export declare function textCap(f: QuillFieldSchema | undefined): TextCap | undefined;
 /**
  * A scalar `default:` as the text an unset control holds, where it prints: as
  * declared, `undefined` for none, a blank or a non-scalar. A default of spaces prints
@@ -175,9 +178,10 @@ export declare function printedText(v: unknown): string | undefined;
  * a blank or a non-scalar.
  */
 export declare function declaredContent(v: unknown, markdown: boolean): Content | undefined;
-/** A field's `{#each}` key: its name and what a mounted leaf reads once, its type and
- *  {@link oneLine} and its elements'. A retype or a quill swap that changes any of them
- *  under a name remounts the field, where a kept leaf would commit on the old schema. */
+/** A field's `{#each}` key: its name and what a mounted leaf reads once, its type,
+ *  {@link oneLine} and `max:`, and its elements'. A retype or a quill swap that changes
+ *  any of them under a name remounts the field, where a kept leaf would commit on the old
+ *  schema. */
 export declare function mountKey(name: string, f: QuillFieldSchema): string;
 /** 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. */

package/dist/visual/structure.js

@@ -93,6 +93,12 @@ export function oneLine(f) {
 export function literalText(f) {
     return baseType(f) === 'text';
 }
+/** The character cap a content field's `max:` declares, `undefined` on any other. */
+export function textCap(f) {
+    if (f?.max == null || controlKind(f) !== 'prose')
+        return undefined;
+    return { max: f.max, trimEnd: literalText(f) && oneLine(f) };
+}
 /**
  * A scalar `default:` as the text an unset control holds, where it prints: as
  * declared, `undefined` for none, a blank or a non-scalar. A default of spaces prints
@@ -126,12 +132,21 @@ export function declaredContent(v, markdown) {
         islands: []
     };
 }
-/** A field's `{#each}` key: its name and what a mounted leaf reads once, its type and
- *  {@link oneLine} and its elements'. A retype or a quill swap that changes any of them
- *  under a name remounts the field, where a kept leaf would commit on the old schema. */
+/** A field's `{#each}` key: its name and what a mounted leaf reads once, its type,
+ *  {@link oneLine} and `max:`, and its elements'. A retype or a quill swap that changes
+ *  any of them under a name remounts the field, where a kept leaf would commit on the old
+ *  schema. */
 export function mountKey(name, f) {
     const items = f.items;
-    return `${name}\u0000${f.type}\u0000${oneLine(f)}\u0000${items?.type ?? ''}\u0000${items ? oneLine(items) : ''}`;
+    return [
+        name,
+        f.type,
+        oneLine(f),
+        f.max ?? '',
+        items?.type ?? '',
+        items ? oneLine(items) : '',
+        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. */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@quillmark/svelte",
-	"version": "0.22.0",
+	"version": "0.23.0",
 	"description": "Editor, live-preview and source surfaces over a Quillmark WASM session.",
 	"repository": {
 		"type": "git",