@quillmark/wasm 0.132.0 → 0.134.0

package/render/wasm_bg.wasm.d.ts

@@ -5,15 +5,24 @@ export const __wbg_document_free: (a: number, b: number) => void;
 export const __wbg_engine_free: (a: number, b: number) => void;
 export const __wbg_livesession_free: (a: number, b: number) => void;
 export const __wbg_quill_free: (a: number, b: number) => void;
+export const deleteRange: (a: number, b: number, c: number, d: number) => void;
+export const diff: (a: number, b: number, c: number) => void;
 export const document__addCard: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => void;
 export const document__commitField: (a: number, b: number, c: number, d: number, e: number) => void;
 export const document__commitFields: (a: number, b: number, c: number, d: number, e: number) => void;
+export const document__hash: (a: number, b: number, c: number) => void;
+export const document__hashAt: (a: number, b: number, c: number, d: number) => void;
 export const document__readerGet: (a: number, b: number, c: number, d: number) => void;
 export const document__readerGetContent: (a: number, b: number, c: number, d: number) => void;
 export const document__readerGetContentAt: (a: number, b: number, c: number, d: number, e: number) => void;
-export const document__reviseDocument: (a: number, b: number, c: number, d: number, e: number) => void;
-export const document__reviseField: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
-export const document_applyChange: (a: number, b: number, c: number, d: number) => void;
+export const document__revise: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+export const document__reviseDocument: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+export const document__reviseField: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+export const document_anchorContext: (a: number, b: number, c: number, d: number) => void;
+export const document_anchorContexts: (a: number, b: number) => void;
+export const document_annotated: (a: number, b: number, c: number) => void;
+export const document_annotatedAt: (a: number, b: number, c: number) => void;
+export const document_apply: (a: number, b: number, c: number, d: number, e: number) => void;
 export const document_bodyMarkdown: (a: number, b: number, c: number) => void;
 export const document_card: (a: number, b: number, c: number) => void;
 export const document_cardCount: (a: number) => number;
@@ -26,27 +35,28 @@ export const document_fromMarkdown: (a: number, b: number, c: number) => void;
 export const document_fromStored: (a: number, b: number, c: number) => void;
 export const document_getExt: (a: number, b: number, c: number) => void;
 export const document_getStored: (a: number, b: number, c: number) => void;
+export const document_hash: (a: number, b: number, c: number) => void;
+export const document_hashAt: (a: number, b: number, c: number) => void;
 export const document_insertCard: (a: number, b: number, c: number, d: number) => void;
-export const document_loadStored: (a: number, b: number, c: number, d: number) => void;
 export const document_main: (a: number, b: number) => void;
-export const document_markdownRules: (a: number) => void;
 export const document_moveCard: (a: number, b: number, c: number, d: number) => void;
 export const document_new: (a: number, b: number, c: number) => void;
-export const document_overwrite: (a: number, b: number, c: number, d: number) => void;
 export const document_pathFor: (a: number, b: number, c: number) => void;
 export const document_quillRef: (a: number, b: number) => void;
 export const document_quillRefHint: (a: number) => void;
+export const document_read: (a: number, b: number, c: number) => void;
+export const document_reattach: (a: number, b: number, c: number, d: number) => void;
 export const document_removeCard: (a: number, b: number, c: number) => void;
 export const document_removeExt: (a: number, b: number, c: number) => void;
 export const document_removeField: (a: number, b: number, c: number) => void;
 export const document_removeSeedOverlay: (a: number, b: number, c: number, d: number) => void;
-export const document_revise: (a: number, b: number, c: number, d: number, e: number) => void;
+export const document_replace: (a: number, b: number, c: number, d: number, e: number) => void;
+export const document_revise: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
 export const document_seedOverlay: (a: number, b: number, c: number, d: number) => void;
 export const document_setQuillRef: (a: number, b: number, c: number, d: number) => void;
 export const document_storageVersionOf: (a: number, b: number, c: number) => void;
 export const document_storeExt: (a: number, b: number, c: number, d: number) => void;
 export const document_storeField: (a: number, b: number, c: number, d: number) => void;
-export const document_storeFields: (a: number, b: number, c: number, d: number) => void;
 export const document_storeSeedOverlay: (a: number, b: number, c: number, d: number, e: number) => void;
 export const document_toAnnotatedMarkdown: (a: number, b: number) => void;
 export const document_toMarkdown: (a: number, b: number) => void;
@@ -61,9 +71,12 @@ export const exportMarkdown: (a: number, b: number) => void;
 export const formatDiagnostic: (a: number, b: number) => void;
 export const formatDocPath: (a: number, b: number) => void;
 export const importMarkdown: (a: number, b: number, c: number) => void;
+export const indent: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+export const inheritedMarks: (a: number, b: number, c: number) => void;
+export const invert: (a: number, b: number, c: number) => void;
 export const isInline: (a: number, b: number) => void;
 export const isPlain: (a: number, b: number) => void;
-export const livesession_backendId: (a: number, b: number) => void;
+export const joinBlocks: (a: number, b: number, c: number, d: number) => void;
 export const livesession_coverage: (a: number, b: number) => void;
 export const livesession_fieldAt: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
 export const livesession_fieldBoxes: (a: number, b: number, c: number, d: number) => void;
@@ -76,15 +89,17 @@ export const livesession_regions: (a: number, b: number) => void;
 export const livesession_render: (a: number, b: number, c: number) => void;
 export const livesession_update: (a: number, b: number, c: number) => void;
 export const livesession_warnings: (a: number, b: number) => void;
-export const mapMarks: (a: number, b: number, c: number) => void;
 export const mapPos: (a: number, b: number, c: number, d: number) => void;
+export const normalize: (a: number, b: number) => void;
+export const outdent: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
 export const parseDocPath: (a: number, b: number, c: number) => void;
 export const quill__resolve: (a: number, b: number, c: number, d: number, e: number) => void;
+export const quill_authoringSchema: (a: number, b: number) => void;
 export const quill_backendId: (a: number, b: number) => void;
-export const quill_blueprint: (a: number, b: number) => void;
 export const quill_conform: (a: number, b: number, c: number) => void;
 export const quill_emptyDocument: (a: number) => number;
-export const quill_exampleDocument: (a: number, b: number) => void;
+export const quill_exampleDocument: (a: number) => number;
+export const quill_fromAuthoring: (a: number, b: number, c: number) => void;
 export const quill_fromBundle: (a: number, b: number, c: number) => void;
 export const quill_fromTree: (a: number, b: number) => void;
 export const quill_metadata: (a: number, b: number) => void;
@@ -92,13 +107,14 @@ export const quill_parse: (a: number, b: number, c: number, d: number) => void;
 export const quill_schema: (a: number, b: number) => void;
 export const quill_seedCard: (a: number, b: number, c: number, d: number, e: number) => void;
 export const quill_seedDocument: (a: number) => number;
-export const quill_seedMain: (a: number, b: number) => void;
+export const quill_toAuthoring: (a: number, b: number, c: number) => void;
 export const quill_toBundle: (a: number, b: number) => void;
 export const quill_toTree: (a: number) => number;
 export const quill_validate: (a: number, b: number, c: number) => void;
 export const quill_warnings: (a: number, b: number) => void;
-export const rebase: (a: number, b: number, c: number, d: number) => void;
+export const splitBlock: (a: number, b: number, c: number, d: number, e: number) => void;
 export const start: () => void;
+export const wrap: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
 export const __wbindgen_export: (a: number, b: number) => number;
 export const __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
 export const __wbindgen_export3: (a: number) => void;

package/runtime/runtime.d.ts

@@ -18,9 +18,17 @@ import type {
 	Document as CoreDocument,
 	importMarkdown,
 	exportMarkdown,
-	rebase,
+	normalize,
+	invert,
+	diff,
+	splitBlock,
+	joinBlocks,
+	deleteRange,
+	indent,
+	outdent,
+	wrap,
+	inheritedMarks,
 	mapPos,
-	mapMarks,
 	isInline,
 	isPlain,
 	parseDocPath,
@@ -40,9 +48,17 @@ export interface CoreSurface {
 	Document: typeof CoreDocument;
 	importMarkdown: typeof importMarkdown;
 	exportMarkdown: typeof exportMarkdown;
-	rebase: typeof rebase;
+	normalize: typeof normalize;
+	invert: typeof invert;
+	diff: typeof diff;
+	splitBlock: typeof splitBlock;
+	joinBlocks: typeof joinBlocks;
+	deleteRange: typeof deleteRange;
+	indent: typeof indent;
+	outdent: typeof outdent;
+	wrap: typeof wrap;
+	inheritedMarks: typeof inheritedMarks;
 	mapPos: typeof mapPos;
-	mapMarks: typeof mapMarks;
 	isInline: typeof isInline;
 	isPlain: typeof isPlain;
 	parseDocPath: typeof parseDocPath;
@@ -113,44 +129,44 @@ export type {
 	QuillFieldUi,
 	QuillCardUi,
 	QuillGroupUi,
-	QuillMetadata
+	QuillMetadata,
+	AuthoringDocument,
+	AuthoringCard
 } from '../core/wasm.js';
 
-// Content edit vocabulary: the op-grained content model `Document`'s methods
-// speak (`applyChange(addr, bundle)`, `overwrite(addr, rt)`, `revise(…) => Revised`).
-// `ContentLineKind` is the shared half of `ContentLine` and `setKind`, and
-// `ContentMarkKind` of `ContentMark` and a mark op's `add` / `remove`: lifting a
-// read value's kind whole — destructure off the envelope, spread the rest into
-// the op — is the version-proof spelling of the op, and naming the type is what
-// makes that spelling type-check without a cast.
+// The content model `Document`'s write primitive and readers speak
+// (`apply(addr, change)`, `revise(addr, md)`, `replace(addr, content)`,
+// `read(addr)`), offsets in UTF-16 code units. `ContentBlockKind` and `ContentMarkKind` are the shared halves of a
+// read value and a step: destructure the kind off the envelope and spread it
+// into the step.
 export type {
 	Content,
-	ContentLine,
-	ContentLineKind,
+	ContentBlock,
+	ContentBlockKind,
 	ContentContainer,
 	ContentMark,
 	ContentMarkKind,
+	ContentAnchor,
 	ContentIsland,
 	TableProps,
-	ImageProps,
-	FootnoteProps,
-	MathProps,
-	TableCell,
+	Change,
+	Step,
+	Receipt,
+	DroppedAnchor,
+	WriteOptions,
 	CardInput,
 	PathStep,
 	Addr,
 	CardAddr,
 	Delta,
 	Revised,
+	BaseOptions,
 	DocumentRevised,
 	AnnotatedMarkdown,
 	DocumentAnchor,
+	AnchorContext,
+	Reattached,
 	Imported,
-	Assoc,
-	IslandOp,
-	LineOp,
-	MarkOp,
-	ChangeBundle,
 	DocPathSeg
 } from '../core/wasm.js';
 
@@ -193,43 +209,11 @@ export interface QuillmarkError extends Error {
  */
 export declare function isQuillmarkError(e: unknown): e is QuillmarkError;
 
-import type { ContentContainer } from '../core/wasm.js';
-
 // `ContentIsland.type`, `ContentMark.type`, `ContentLine.kind` and
 // `ContentContainer.container` are closed sets, so a bare discriminant check
 // narrows the payload on its own:
 // `line.kind === 'heading'` reaches `line.attrs.level`, with no guard to call.
 
-/**
- * Stamp `instance` across one parent's blocks at one depth, in document order,
- * returning containers ready to write.
- *
- * One entry per container RUN — a list, not a list item — and `null` for a
- * block carrying no container at this depth. A bare paragraph between two lists
- * is such a block, and separates them on its own. Every line of a run then
- * carries that run's returned container, `ordinal` varying per item and
- * `instance` held.
- *
- * The `instance` it stamps is canonical, so a document reads back the value it
- * was written — a `0` as an absent key, which decodes to the same value.
- * `ordinal` stays the caller's, and a write is renumbered to a gapless index
- * within its run.
- *
- * Which fields decide a weld is coarser than equality for a list: CommonMark
- * reads only a list's first number, so `1. a` beside `3. b` welds despite the
- * differing `start`.
- *
- * ```js
- * const [outer, , inner] = assignInstances([listA, null, listB]);
- * // outer.instance === 0, inner.instance === 0 — the paragraph parts them
- * const [a, b] = assignInstances([listA, listB]);
- * // a.instance === 0, b.instance === 1 — adjacent, one shape
- * ```
- */
-export declare function assignInstances(
-	runs: (ContentContainer | null)[]
-): (ContentContainer | null)[];
-
 // The backend-neutral render contract, defined here rather than re-exported from
 // one private backend because no single backend owns the canonical API's types.
 // The render build must satisfy these shapes; `runtime.types.test-d.ts` keeps
@@ -287,7 +271,7 @@ export interface RenderOptions {
  */
 export type HitGranularity = 'cluster' | 'segment';
 
-/** A click resolved to a field and USV offset into its Content. */
+/** A click resolved to a field and a UTF-16 offset into its Content. */
 export interface ContentHit {
 	/**
 	 * The field's canonical `DocPath` address (`parseDocPath`-routable): the same
@@ -340,7 +324,7 @@ export interface FieldRegion {
 	/** `[x0, y0, x1, y1]` in PDF points (1/72″), bottom-left origin. */
 	rect: [number, number, number, number];
 	/**
-	 * The content slice this box covers: USV `[start, end)` into the field's
+	 * The content slice this box covers: UTF-16 `[start, end)` into the field's
 	 * `Content` for content ink (one segment), absent for a scalar's or a
 	 * date's ink, a claim or a widget. Consumers key segment highlights on it;
 	 * {@link LiveSession.fieldBoxes} unions same-page segments for the
@@ -410,7 +394,7 @@ export interface BackendDescriptor {
 	formats: OutputFormat[];
 }
 
-/** Options for `new Engine(...)`, as a plain object. A key other than `backends` throws. */
+/** Options for `new Engine(...)`, as a plain object. A key other than `backends` or `fonts` throws. */
 export interface EngineOptions {
 	/**
 	 * Extra or overriding backend descriptors, merged over the built-ins. Keys are
@@ -544,7 +528,6 @@ export declare class Engine {
 export declare class LiveSession {
 	private constructor();
 	readonly pageCount: number;
-	readonly backendId: string;
 	readonly warnings: Diagnostic[];
 	/**
 	 * Recompile the session against `doc`: the edit verb of a live preview.
@@ -613,7 +596,8 @@ export declare class LiveSession {
 	positionAt(page: number, x: number, y: number, tolPt?: number): ContentHit | undefined;
 	/**
 	 * Content position → caret rect: reverse of {@link positionAt}. `field` is a
-	 * canonical `DocPath` address (`parseDocPath`-routable), as {@link regions} keys.
+	 * canonical `DocPath` address (`parseDocPath`-routable), as {@link regions} keys;
+	 * `pos` a UTF-16 offset into its `Content`, `undefined` inside a character.
 	 */
 	locate(field: string, pos: number): FieldRegion | undefined;
 	/** Page geometry in points (1/72″). */
@@ -669,7 +653,7 @@ declare module '../core/wasm.js' {
 	}
 }
 
-import type { Addr, Content, DocumentRevised, PathStep, Resolved, Revised } from '../core/wasm.js';
+import type { Addr, BaseOptions, Content, DocumentRevised, PathStep, Resolved, Revised } from '../core/wasm.js';
 
 /**
  * A `Document` bound to its `Quill` for typed writes, from {@link Quill.writer}.
@@ -679,14 +663,28 @@ import type { Addr, Content, DocumentRevised, PathStep, Resolved, Revised } from
  *
  * Typed commit is the default whenever a quill is in hand: it resolves each
  * field's schema type and strict-commits it, throwing `UnknownField` for an
- * undeclared name rather than falling back. The raw `Document.storeField` /
- * `storeFields` verbs remain the deliberate quill-free primitive (standalone
+ * undeclared name rather than falling back. The raw `Document.storeField`
+ * verb remains the deliberate quill-free primitive (standalone
  * data, storage/migration infra, or not-yet-conforming in-progress input).
  */
 export declare class DocumentWriter {
 	constructor(quill: Quill, doc: Document);
-	/** The bound document: the instance passed in, mutated in place. */
-	readonly document: Document;
+	/**
+	 * The hash of the document as this quill conforms it: the `baseHash`
+	 * {@link reviseDocument} checks. A document loaded without its quill
+	 * hashes as its conformed self, so a conform between the read and the
+	 * write does not stale the base. Throws when the document declares a
+	 * `$quill` this quill does not answer to.
+	 */
+	hash(): string;
+	/**
+	 * The hash of the body or field at `addr` through its schema: the
+	 * `baseHash` {@link reviseBody} and {@link reviseField} check. A
+	 * `richtext` field hashes its content however it rests, a `text` field its
+	 * literal text, any other type its stored value, an absent field as
+	 * `null`. Throws `UnknownField` for an undeclared name.
+	 */
+	hashAt(addr: Addr | string): string;
 	/**
 	 * Typed-commit one main-card field (strict coerce, mismatch throws now).
 	 * Throws `UnknownField` for a name the schema does not declare. Returns a
@@ -703,11 +701,13 @@ export declare class DocumentWriter {
 	setAll(fields: Record<string, unknown>): Diagnostic[];
 	/**
 	 * Revise the main body from markdown; anchors rebase. Returns the
-	 * `Revised` receipt, its warnings at `main.body`: a body carries no field
-	 * schema to type against, so this is the content lane's `revise` reached
-	 * through the writer.
+	 * `Revised` receipt, its warnings at `main.body` and `droppedAnchors`
+	 * naming each anchor the diff dropped: a body carries no field schema to
+	 * type against. `opts` names what the writer read: a stale
+	 * `baseHash` (from {@link hashAt}) throws `edit::stale_base`, and a
+	 * `baseMarkdown` merges.
 	 */
-	reviseBody(markdown: string): Revised;
+	reviseBody(markdown: string, opts?: BaseOptions): Revised;
 	/**
 	 * Revise the content main-card field `name` from authored text: typed *and*
 	 * anchor-preserving. Surviving anchors rebase, then the diffed result is
@@ -718,19 +718,28 @@ export declare class DocumentWriter {
 	 * The codec comes from the declared type: `richtext` diffs markdown, while
 	 * `text` diffs the literal text and never imports markdown, so a
 	 * byte-identical revise of a value carrying escapes is a byte no-op.
+	 *
+	 * `opts` names what the writer read, as on {@link reviseBody}; a `text`
+	 * field's `baseMarkdown` is the literal text it read.
 	 */
-	reviseField(name: string, text: string): Revised;
+	reviseField(name: string, text: string, opts?: BaseOptions): Revised;
 	/**
 	 * Replace the bound document with `markdown`, then conform it. Composable
 	 * cards align to the stored ones by `$kind` and text similarity, an aligned
 	 * card's body and stored content fields revise, their anchors rebasing as
 	 * {@link reviseBody}'s do, and every declared content field lands at rest.
-	 * Returns the `DocumentRevised` receipt, its `warnings` ending with the
+	 * Returns the `DocumentRevised` receipt, its `from` naming the stored card
+	 * each composable card revises and its `warnings` ending with the
 	 * `conform::*` ones, and clears `doc.warnings`. Throws when `markdown`
 	 * declares a `$quill` this quill does not answer to, or does not parse,
 	 * leaving the document unchanged.
+	 *
+	 * `opts` names what the writer read: `baseHash` is {@link hash}, and
+	 * `baseMarkdown` the whole document's markdown (`toMarkdown` or
+	 * `toAnnotatedMarkdown`), merged by line onto what changed since. A stale
+	 * or conflicting write throws before any mutation.
 	 */
-	reviseDocument(markdown: string): DocumentRevised;
+	reviseDocument(markdown: string, opts?: BaseOptions): DocumentRevised;
 	/**
 	 * Build a composable card of `kind`, typed-commit `fields` onto it, set its
 	 * body from optional markdown, and place it. `at` omitted appends, a number
@@ -760,25 +769,20 @@ export declare class DocumentWriter {
  */
 export declare class CardWriter {
 	constructor(quill: Quill, doc: Document, index: number);
-	/** The bound card index. */
-	readonly index: number;
-	/**
-	 * The bound card's `$kind`. Throws `IndexOutOfRange` for a bad bound
-	 * index.
-	 */
-	readonly kind: string;
+	/** The card twin of {@link DocumentWriter.hashAt}; no `field` reads the body. */
+	hashAt(field?: string): string;
 	set(name: string, value: unknown): Diagnostic[];
 	setAll(fields: Record<string, unknown>): Diagnostic[];
 	/**
 	 * Revise this card's body from markdown (edit semantics), returning the
 	 * `Revised` receipt, its warnings at the card's body.
 	 */
-	reviseBody(markdown: string): Revised;
+	reviseBody(markdown: string, opts?: BaseOptions): Revised;
 	/**
 	 * The card twin of {@link DocumentWriter.reviseField}. Throws `UnknownField`
 	 * for an undeclared name and `IndexOutOfRange` for a bad bound index.
 	 */
-	reviseField(name: string, text: string): Revised;
+	reviseField(name: string, text: string, opts?: BaseOptions): Revised;
 }
 
 /**
@@ -801,8 +805,6 @@ export declare class CardWriter {
  */
 export declare class DocumentReader {
 	constructor(quill: Quill, doc: Document);
-	/** The bound document: the instance passed in. */
-	readonly document: Document;
 	/**
 	 * Read the value at `addr`, interpreted by its declared type: a richtext field
 	 * to markdown, every other type verbatim. A bare string is `Addr` shorthand for
@@ -853,42 +855,4 @@ export declare class DocumentReader {
 	 * pairing it with a session passes the session's opening date.
 	 */
 	resolve(today?: string): Resolved;
-	/**
-	 * A {@link CardReader} for the composable card at `index`. Index validity is
-	 * checked lazily at read time, so an out-of-range index does not throw here.
-	 * The cursor is ephemeral: a `removeCard`/`addCard` between binding and reading
-	 * silently retargets it.
-	 */
-	card(index: number): CardReader;
-}
-
-/**
- * A composable card bound to its `Quill` for interpreted reads, from
- * {@link DocumentReader.card}. Same verbs as {@link DocumentReader}, reading the card
- * at its bound index; each read throws `IndexOutOfRange` if that index is out of
- * range.
- */
-export declare class CardReader {
-	constructor(quill: Quill, doc: Document, index: number);
-	/** The bound card index. */
-	readonly index: number;
-	/**
-	 * The bound card's `$kind`. Throws `IndexOutOfRange` if the bound index is
-	 * out of range.
-	 */
-	readonly kind: string;
-	/**
-	 * Read the field `name` on this card, interpreted by its declared type.
-	 * `undefined` when absent; throws `UnknownField` for an undeclared name and
-	 * `IndexOutOfRange` for a bad index.
-	 */
-	get(name: string): unknown;
-	/**
-	 * The card twin of {@link DocumentReader.getContent}.
-	 */
-	getContent(name: string): Content | undefined;
-	/** The card twin of {@link DocumentReader.getContentAt}. */
-	getContentAt(name: string, path: PathStep[]): Content | undefined;
-	/** This card's body markdown: the card twin of {@link DocumentReader.bodyMarkdown}. */
-	bodyMarkdown(): string;
 }