Source model API · Text Diagram

Signatures and descriptions are extracted from public exports and JSDoc. Chinese explanations are checked against current source. See Embed in Vue for the component integration.

Create and validate

createTextDiagram

@quirekit/text-diagram

@param id - Host identity. @param language - Initial grammar. @param source - Initial exact source. @returns An unsaved source-backed object.

function createTextDiagram(id: string, language?: TextDiagramLanguage, source?: string): TextDiagramEmbed

readTextDiagram

@quirekit/text-diagram

@param input - Untrusted persisted value. @returns Detached immutable canonical source.

function readTextDiagram(input: unknown): TextDiagramEmbed

serializeTextDiagram

@quirekit/text-diagram

@param value - Portable object. @returns Stable source identity for atomic comparisons.

function serializeTextDiagram(value: TextDiagramEmbed): string

Save and Markdown

prepareTextDiagramSave

@quirekit/text-diagram

@param original - Captured host baseline. @param snapshot - Exact source-bound PNG. @param title - Plain accessible name. @returns One proposed revision.

function prepareTextDiagramSave(original: TextDiagramEmbed, snapshot: TextDiagramRaster, title?: string): TextDiagramEmbed

textDiagramLanguage

@quirekit/text-diagram

@param input - Code fence language. @returns Supported grammar or null; no prefix guessing.

function textDiagramLanguage(input: string): TextDiagramLanguage | null

textDiagramMarkdown

@quirekit/text-diagram

@param language - Canonical grammar. @param source - Exact source. @returns A standard code fence that cannot be closed by its body.

function textDiagramMarkdown(language: TextDiagramLanguage, source: string): string

textDiagramTemplates

@quirekit/text-diagram

@param locale - Language of newly created labels, never of existing source. @returns Real local-engine examples shared by every editor.

function textDiagramTemplates(locale?: string): readonly TextDiagramTemplate[]

Public data types

TextDiagramLanguage

@quirekit/text-diagram

Built-in local diagram languages.

export type TextDiagramLanguage = "mermaid" | "plantuml" | "dot";

TextDiagramSource

@quirekit/text-diagram

Source is the sole editable authority; preview pixels are derived.

export interface TextDiagramSource {
    readonly language: TextDiagramLanguage;
    readonly source: string;
    readonly revision: number;
}

Member	Description
`language`	Accepted grammar, never inferred from source text.
`source`	Exact Unicode source, including user whitespace.
`revision`	Host revision incremented once per accepted save.

TextDiagramEmbed

@quirekit/text-diagram

Versioned object retained by structured document hosts.

export interface TextDiagramEmbed {
    readonly type: "quirekit-text-diagram";
    readonly version: 1;
    readonly id: string;
    readonly title: string;
    readonly document: TextDiagramSource;
    readonly preview: TextDiagramPreview | null;
}

Member	Description
`type`	Stable protocol discriminator.
`version`	Envelope version.
`id`	Host object identity.
`title`	Plain accessible name.
`document`	Editable source and its host revision.
`preview`	Exact-source preview; absent on an uncommitted new draft.

TextDiagramPreview

@quirekit/text-diagram

Portable inert image, suitable for document content and fixed layout.

export interface TextDiagramPreview {
    readonly dataUrl: string;
    readonly width: number;
    readonly height: number;
}

Member	Description
`dataUrl`	Self-contained PNG, without network access.
`width`	Intrinsic raster width.
`height`	Intrinsic raster height.

TextDiagramSnapshot

@quirekit/text-diagram

SVG bound to an immutable source snapshot.

export interface TextDiagramSnapshot {
    readonly language: TextDiagramLanguage;
    readonly source: string;
    readonly svg: string;
    readonly width: number;
    readonly height: number;
}

Member	Description
`language`	Exact rendered grammar.
`source`	Exact rendered source.
`svg`	Sanitized static SVG.
`width`	Natural width in CSS pixels.
`height`	Natural height in CSS pixels.

TextDiagramRaster

@quirekit/text-diagram

Frozen source and its raster; hosts commit both together.

export interface TextDiagramRaster extends TextDiagramPreview {
    readonly language: TextDiagramLanguage;
    readonly source: string;
}

Member	Description
`language`	Exact rendered grammar.
`source`	Exact rendered source.
`dataUrl`	Self-contained PNG, without network access.
`width`	Intrinsic raster width.
`height`	Intrinsic raster height.

TextDiagramTemplate

@quirekit/text-diagram

A real editable example in a named grammar.

export interface TextDiagramTemplate {
    readonly id: string;
    readonly label: string;
    readonly language: TextDiagramLanguage;
    readonly source: string;
}

Member	Description
`id`	Stable template identity.
`label`	Visible name in the requested language.
`language`	Diagram grammar.
`source`	Actual source consumed by the rendering engine.

TextDiagramEditRequest

@quirekit/text-diagram

A mapped host target; UI never writes the host directly.

export interface TextDiagramEditRequest {
    readonly document: TextDiagramEmbed;
    readonly commit: (document: TextDiagramEmbed) => TextDiagramCommitResult;
    readonly release: () => void;
}

Member	Description
`document`	Detached baseline.
`commit`	@param document - Complete proposed source and preview. @returns Atomic acceptance.
`release`	Releases the mapped target without modifying content.

TextDiagramCommitResult

@quirekit/text-diagram

A host's atomic acceptance decision.

export type TextDiagramCommitResult = "saved" | "conflict" | "readonly" | "missing";