@drghaliasri/butex 3.2.2

package/dist/document.d.ts

@@ -0,0 +1,307 @@
+type ArabicNodeJson = {
+    node_type: string;
+    expr?: string;
+    name?: string;
+    superscript?: ChainJson | null;
+    subscript?: ChainJson | null;
+    left_delim_expr?: string;
+    right_delim_expr?: string;
+    inner_expr?: ChainJson;
+    optional_args?: ChainJson[];
+    mandatory_args?: ChainJson[];
+    opening?: string;
+    closing?: string;
+    lines?: ChainJson[];
+};
+type ChainJson = {
+    node_type: 'ChainClass';
+    chain: ArabicNodeJson[];
+};
+declare class State {
+}
+declare class BaseAstNode {
+    state: State;
+    superscript: ChainNode | null;
+    subscript: ChainNode | null;
+    nodeType: string;
+    constructor(state?: State | null);
+    latex(): string;
+    arabicLatex(): string;
+    toArabicLatex(): string;
+    /** Latin-style scripts: `^{...}` and `_{...}` for english_json rendering. */
+    latexScripts(): string;
+    /**
+     * Arabic scripts use \\prescript{sup}{sub}{content} (matches reference Python output).
+     * Call with rendered strings for sup/sub chains (may be empty strings).
+     */
+    arabicLatexScripts(sup: string, sub: string, content: string): string;
+}
+declare class ChainNode {
+    chain: BaseAstNode[];
+    constructor(chain?: BaseAstNode[]);
+    latex(): string;
+    toEnglishLatex(): string;
+    /** RTL: reverse order relative to Latin chain (see test/ref_tests.txt). */
+    arabicLatex(): string;
+    toArabicLatex(): string;
+}
+
+type DocumentParseMode = 'english' | 'arabic';
+type MathObjectJson = {
+    node_type: 'MathObject';
+    math_mode: string;
+    lines: ChainJson[];
+    closing: string;
+};
+type DocumentJson = {
+    node_type: 'DocumentObject';
+    blocks: DocumentBlockJson[];
+};
+type DocumentBlockJson = {
+    command: string;
+    value?: string;
+    math_objects?: MathObjectJson[];
+    options?: Record<string, string>;
+    closing?: string;
+    items?: DocumentListItemJson[];
+    rows?: string[][];
+    columns?: string;
+};
+type DocumentListItemJson = {
+    value: string;
+    math_objects?: MathObjectJson[];
+    blocks?: DocumentBlockJson[];
+};
+type DocumentCommand = '\\section' | '\\subsection' | '\\subsubsection' | '\\paragraph' | '\\begin{itemize}' | '\\begin{enumerate}' | '\\begin{tabular}' | '\\includegraphics' | '\\raw';
+type MathNode = {
+    nodeType: 'MathObject';
+    mathMode: string;
+    lines: ChainNode[];
+    closing: string;
+};
+type TextInline = {
+    kind: 'text';
+    text: string;
+};
+type MathInline = {
+    kind: 'math';
+    source: string;
+    math: MathNode | null;
+};
+type DocumentInline = TextInline | MathInline;
+type TextBlockNode = {
+    kind: 'textBlock';
+    command: '\\section' | '\\subsection' | '\\subsubsection' | '\\paragraph';
+    value: string;
+    inlines: DocumentInline[];
+};
+type ListItemNode = {
+    value: string;
+    inlines: DocumentInline[];
+    blocks: DocumentBlockNode[];
+};
+type ListBlockNode = {
+    kind: 'list';
+    command: '\\begin{itemize}' | '\\begin{enumerate}';
+    closing: '\\end{itemize}' | '\\end{enumerate}';
+    items: ListItemNode[];
+};
+type TableBlockNode = {
+    kind: 'table';
+    command: '\\begin{tabular}';
+    closing: '\\end{tabular}';
+    columns: string;
+    rows: DocumentInline[][][];
+};
+type ImageBlockNode = {
+    kind: 'image';
+    command: '\\includegraphics';
+    value: string;
+    options: Record<string, string>;
+};
+type RawBlockNode = {
+    kind: 'raw';
+    command: '\\raw';
+    value: string;
+};
+type DocumentBlockNode = TextBlockNode | ListBlockNode | TableBlockNode | ImageBlockNode | RawBlockNode;
+type DocumentNode = {
+    nodeType: 'DocumentObject';
+    blocks: DocumentBlockNode[];
+};
+type DetectedMathSpan = {
+    start: number;
+    end: number;
+    source: string;
+    mathMode: string;
+    closing: string;
+};
+type DocumentPreviewMathIsland = {
+    id: string;
+    tex: string;
+    display: boolean;
+};
+type DocumentPreview = {
+    html: string;
+    mathIslands: DocumentPreviewMathIsland[];
+};
+
+declare function fromDocumentJson(json: unknown, mode?: DocumentParseMode): DocumentNode;
+declare function createEmptyDocument(): DocumentNode;
+declare function createTextBlock(command: TextBlockNode['command'], value?: string): TextBlockNode;
+declare function createRawBlock(value?: string): RawBlockNode;
+declare function createListBlock(command: ListBlockNode['command'], items?: string[]): ListBlockNode;
+declare function createTableBlock(rows?: string[][], columns?: string): TableBlockNode;
+declare function createImageBlock(value?: string, options?: Record<string, string>): ImageBlockNode;
+declare function isSupportedDocumentCommand(command: string): command is DocumentCommand;
+
+declare function fromMathObjectJson(json: unknown, mode?: DocumentParseMode): MathNode;
+declare function renderMathNodeLatex(math: MathNode): string;
+declare function isDisplayMathNode(math: MathNode): boolean;
+
+type EditorSide = 'english' | 'arabic';
+type EditorNodeKind = 'char' | 'number' | 'operator' | 'delimiter' | 'frac' | 'sqrt' | 'env' | 'atomicCommand' | 'atomicOperatorCommand';
+type MatrixEnvStyle = 'matrix' | 'pmatrix' | 'bmatrix' | 'Bmatrix' | 'vmatrix' | 'Vmatrix';
+type GridEnvName = MatrixEnvStyle | 'array' | 'aligned';
+type EnvColumnAlignment = 'l' | 'c' | 'r';
+type CharacterFontId = 'default' | 'takween' | 'diwani' | 'diwaniOutline';
+type DigitFormId = 'western' | 'arabicIndic' | 'persianIndic';
+type EditorSyncState = 'synced' | 'diverged';
+type EditorChain = {
+    id: string;
+    nodes: EditorNode[];
+};
+type EditorNode = {
+    id: string;
+    kind: EditorNodeKind;
+    expr: string;
+    characterFont?: CharacterFontId;
+    superscript: EditorChain | null;
+    subscript: EditorChain | null;
+    leftDelimExpr: string;
+    rightDelimExpr: string;
+    innerExpr: EditorChain | null;
+    numerator: EditorChain | null;
+    denominator: EditorChain | null;
+    radicand: EditorChain | null;
+    rootIndex: EditorChain | null;
+    envName: GridEnvName | null;
+    matrixStyle: MatrixEnvStyle | null;
+    matrixRows: EditorChain[][] | null;
+    columnAlignments: EnvColumnAlignment[] | null;
+};
+type EditorCaret = {
+    chainId: string;
+    index: number;
+};
+type EditorSelectionRange = {
+    chainId: string;
+    anchorIndex: number;
+    focusIndex: number;
+};
+type EditorSyncMap = Record<string, {
+    expr: EditorSyncState;
+}>;
+type EditorDebugEntry = {
+    timestamp: string;
+    command: string;
+    activeSide: EditorSide;
+    englishLatex: string;
+    arabicLatex: string;
+    renderOk: boolean;
+    renderError: string | null;
+    note: string;
+};
+type EditorSession = {
+    englishTree: EditorChain;
+    arabicTree: EditorChain;
+    activeSide: EditorSide;
+    /** When true, each typed letter/digit inserts a new char/number leaf; when false, merge into adjacent same-kind leaves. */
+    splitLeafTyping: boolean;
+    /** One-shot: when true, the next insertChar/insertNumber bypasses leaf-merge (used by Space in merge mode). */
+    forceSplitNextLeaf: boolean;
+    /** When true and active side is Arabic, merged number typing prepends digits (RTL-style); still mirrored on EN/AR. */
+    arabicReverseNumberTyping: boolean;
+    /** Font applied to newly typed char nodes. */
+    currentCharacterFont: CharacterFontId;
+    /** Digit glyph form used for editor display and LaTeX preview output. */
+    currentDigitForm: DigitFormId;
+    caret: EditorCaret;
+    /** Whole-node range selection inside a single chain (anchor==focus means no selection). */
+    selection: EditorSelectionRange | null;
+    selectedNodeId: string | null;
+    selectedStructureNodeId: string | null;
+    sync: EditorSyncMap;
+    debugLog: EditorDebugEntry[];
+};
+
+type MathNodeFromEditorResult = {
+    ok: true;
+    math: MathNode;
+} | {
+    ok: false;
+    reason: string;
+};
+declare function mathNodeFromEditorSession(session: EditorSession, mathMode?: string, closing?: string): MathNodeFromEditorResult;
+/** Delimited Arabic TeX for document text/preview — matches `<ButexEditor />` arabic output. */
+declare function mathSourceFromEditorSession(session: EditorSession, mathMode?: string, closing?: string): string;
+
+declare function detectMathSpans(value: string): DetectedMathSpan[];
+declare function buildInlines(value: string, mathObjects?: MathObjectJson[], mode?: DocumentParseMode): DocumentInline[];
+
+declare function renderDocumentLatex(document: DocumentNode): string;
+declare function buildDocumentPreview(document: DocumentNode): DocumentPreview;
+
+type NewDocumentBlockKind = 'section' | 'subsection' | 'subsubsection' | 'paragraph' | 'itemize' | 'enumerate' | 'table' | 'image' | 'raw';
+type DocumentMathTarget = {
+    scope: 'block';
+    blockIndex: number;
+    spanIndex: number;
+} | {
+    scope: 'listItem';
+    blockIndex: number;
+    itemIndex: number;
+    spanIndex: number;
+} | {
+    scope: 'tableCell';
+    blockIndex: number;
+    rowIndex: number;
+    columnIndex: number;
+    spanIndex: number;
+};
+type DocumentInlineTarget = {
+    scope: 'block';
+    blockIndex: number;
+} | {
+    scope: 'listItem';
+    blockIndex: number;
+    itemIndex: number;
+} | {
+    scope: 'tableCell';
+    blockIndex: number;
+    rowIndex: number;
+    columnIndex: number;
+};
+declare function createDocumentBlock(kind: NewDocumentBlockKind): DocumentBlockNode;
+declare function addDocumentBlock(document: DocumentNode, kind: NewDocumentBlockKind): DocumentNode;
+declare function removeDocumentBlock(document: DocumentNode, blockIndex: number): DocumentNode;
+declare function moveDocumentBlock(document: DocumentNode, blockIndex: number, direction: -1 | 1): DocumentNode;
+declare function updateTextBlockValue(document: DocumentNode, blockIndex: number, value: string): DocumentNode;
+declare function updateRawBlockValue(document: DocumentNode, blockIndex: number, value: string): DocumentNode;
+declare function updateImageBlock(document: DocumentNode, blockIndex: number, value: string, options: Record<string, string>): DocumentNode;
+declare function updateListItemValue(document: DocumentNode, blockIndex: number, itemIndex: number, value: string): DocumentNode;
+declare function addListItem(document: DocumentNode, blockIndex: number): DocumentNode;
+declare function removeListItem(document: DocumentNode, blockIndex: number, itemIndex: number): DocumentNode;
+declare function addNestedListBlock(document: DocumentNode, blockIndex: number, itemIndex: number, kind: 'itemize' | 'enumerate'): DocumentNode;
+declare function updateTableCell(document: DocumentNode, blockIndex: number, rowIndex: number, columnIndex: number, value: string): DocumentNode;
+declare function updateTableColumns(document: DocumentNode, blockIndex: number, columns: string): DocumentNode;
+declare function addTableRow(document: DocumentNode, blockIndex: number): DocumentNode;
+declare function removeTableRow(document: DocumentNode, blockIndex: number): DocumentNode;
+declare function addTableColumn(document: DocumentNode, blockIndex: number): DocumentNode;
+declare function removeTableColumn(document: DocumentNode, blockIndex: number): DocumentNode;
+declare function replaceMathSpanSource(document: DocumentNode, target: DocumentMathTarget, source: string): DocumentNode;
+declare function replaceMathSpanFromEditor(document: DocumentNode, target: DocumentMathTarget, math: MathNode, source?: string): DocumentNode;
+declare function insertMathSpanFromEditor(document: DocumentNode, target: DocumentInlineTarget, insertAt: number, math: MathNode, source?: string): DocumentNode;
+declare function documentInlineText(inlines: DocumentInline[]): string;
+
+export { type DetectedMathSpan, type DocumentBlockJson, type DocumentBlockNode, type DocumentCommand, type DocumentInline, type DocumentInlineTarget, type DocumentJson, type DocumentListItemJson, type DocumentMathTarget, type DocumentNode, type DocumentParseMode, type DocumentPreview, type DocumentPreviewMathIsland, type ImageBlockNode, type ListBlockNode, type ListItemNode, type MathInline, type MathNode, type MathObjectJson, type NewDocumentBlockKind, type RawBlockNode, type TableBlockNode, type TextBlockNode, type TextInline, addDocumentBlock, addListItem, addNestedListBlock, addTableColumn, addTableRow, buildDocumentPreview, buildInlines, createDocumentBlock, createEmptyDocument, createImageBlock, createListBlock, createRawBlock, createTableBlock, createTextBlock, detectMathSpans, documentInlineText, fromDocumentJson, fromMathObjectJson, insertMathSpanFromEditor, isDisplayMathNode, isSupportedDocumentCommand, mathNodeFromEditorSession, mathSourceFromEditorSession, moveDocumentBlock, removeDocumentBlock, removeListItem, removeTableColumn, removeTableRow, renderDocumentLatex, renderMathNodeLatex, replaceMathSpanFromEditor, replaceMathSpanSource, updateImageBlock, updateListItemValue, updateRawBlockValue, updateTableCell, updateTableColumns, updateTextBlockValue };