@extend-ai/react-docx 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,433 @@
+import * as React from 'react';
+import { DocModel, ImageRunNode, FormFieldRunNode, ParagraphNode, TextRunNode, ParagraphStyleDefinition, HeadingLevel, ParagraphAlignment } from '@extend-ai/react-docx-doc-model';
+import { LayoutOptions } from '@extend-ai/react-docx-layout-engine';
+
+interface DocumentLayoutMetrics {
+    pageWidthPx: number;
+    pageHeightPx: number;
+    marginsPx: {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+    };
+    headerDistancePx: number;
+    footerDistancePx: number;
+    docGridLinePitchPx?: number;
+}
+declare function parseSectionLayout(sectionPropertiesXml?: string): DocumentLayoutMetrics;
+declare function resolveDocumentLayout(model: DocModel): DocumentLayoutMetrics;
+
+type DocxDocumentTheme = "light" | "dark";
+type DocxHeadingStyleMap = Partial<Record<HeadingLevel, React.CSSProperties>>;
+type LetterheadFloatSide = "left" | "right";
+declare function paragraphLetterheadFloatSideAtNodeIndex(nodes: DocModel["nodes"], nodeIndex: number): LetterheadFloatSide | undefined;
+type DocxImageWrapMode = "inline" | "square" | "tight" | "through" | "topAndBottom" | "behindText" | "inFrontOfText";
+interface DocxImageWrapState {
+    mode: DocxImageWrapMode;
+    moveWithText: boolean;
+    fixedPositionOnPage: boolean;
+}
+interface DocxImageWrapMenuOption {
+    actionId: DocxContextMenuActionId | (string & {});
+    label: string;
+    checked: boolean;
+    disabled?: boolean;
+    onSelect: () => void;
+}
+interface UseDocxImageWrapMenuResult {
+    state: DocxImageWrapState;
+    wrapOptions: DocxImageWrapMenuOption[];
+    positioningOptions: DocxImageWrapMenuOption[];
+    editWrapBoundaryOption: DocxImageWrapMenuOption;
+    moreLayoutOptionsOption: DocxImageWrapMenuOption;
+    setMode: (mode: DocxImageWrapMode) => void;
+    setMoveWithText: (moveWithText: boolean) => void;
+}
+type DocxListType = "unordered" | "ordered";
+type DocxEditorSelection = {
+    kind: "paragraph";
+    nodeIndex: number;
+} | {
+    kind: "table-cell";
+    tableIndex: number;
+    rowIndex: number;
+    cellIndex: number;
+};
+interface ParagraphLocationInBody {
+    kind: "paragraph";
+    nodeIndex: number;
+}
+interface ParagraphLocationInCell {
+    kind: "table-cell";
+    tableIndex: number;
+    rowIndex: number;
+    cellIndex: number;
+    paragraphIndex: number;
+}
+type DocxTextRangeLocation = ParagraphLocationInBody | ParagraphLocationInCell;
+interface DocxTextRangeBoundary {
+    location: DocxTextRangeLocation;
+    offset: number;
+}
+interface DocxTextRange {
+    start: DocxTextRangeBoundary;
+    end: DocxTextRangeBoundary;
+}
+interface DocxHistoryRestoreRequest {
+    nonce: number;
+    selection: DocxEditorSelection;
+    activeTextRange?: DocxTextRange;
+}
+type ParagraphLocation = DocxTextRangeLocation;
+type DocxImageLocation = ParagraphLocation & {
+    childIndex: number;
+};
+type DocxSectionRegion = "header" | "footer";
+interface DocxSectionParagraphLocation {
+    region: DocxSectionRegion;
+    partName: string;
+    nodeIndex: number;
+    rowIndex?: number;
+    cellIndex?: number;
+    paragraphIndex?: number;
+}
+type DocxSectionImageLocation = DocxSectionParagraphLocation & {
+    childIndex: number;
+};
+type DocxFormFieldLocation = ParagraphLocation & {
+    childIndex: number;
+};
+interface DocxSelectedFormField {
+    location: DocxFormFieldLocation;
+    field: FormFieldRunNode;
+}
+type DocxImageDropTarget = ParagraphLocation & {
+    childIndex: number;
+};
+type DocxTrackedChangeKind = "insertion" | "deletion" | "move-from" | "move-to" | "format-change" | "paragraph-format-change";
+interface DocxTrackedChange {
+    id: string;
+    kind: DocxTrackedChangeKind;
+    author?: string;
+    date?: string;
+    text?: string;
+    nodeIndex: number;
+    location: DocxTextRangeLocation;
+}
+type DocxLineSpacingRule = "auto" | "exact" | "atLeast";
+type DocxSelectionSessionKind = "idle" | "pointer" | "keyboard" | "composition" | "command" | "history-restore";
+interface DocxLineSpacingInfo {
+    lineRule: DocxLineSpacingRule;
+    lineTwips?: number;
+    multiple: number;
+}
+type DocxBorderContext = "paragraph" | "table";
+type DocxBorderPreset = "bottom" | "top" | "left" | "right" | "none" | "all" | "outside" | "inside" | "inside-horizontal" | "inside-vertical" | "diagonal-down" | "diagonal-up" | "horizontal-line";
+type DocxBorderPresetState = Record<DocxBorderPreset, boolean>;
+interface UseDocxEditorOptions {
+    starterModel?: DocModel;
+    initialFileName?: string;
+    initialStatus?: string;
+    initialDocumentTheme?: DocxDocumentTheme;
+    initialShowTrackedChanges?: boolean;
+}
+interface DocxEditorController {
+    model: DocModel;
+    documentLoadNonce: number;
+    fileName: string;
+    status: string;
+    documentTheme: DocxDocumentTheme;
+    selection: DocxEditorSelection;
+    activeTextRange?: DocxTextRange;
+    historyRestoreRequest?: DocxHistoryRestoreRequest;
+    selectedFormField?: DocxSelectedFormField;
+    selectedParagraph?: ParagraphNode;
+    selectedRunStyle?: TextRunNode["style"];
+    selectedLink?: string;
+    pendingRunStyle?: TextRunNode["style"];
+    selectionSessionKind: DocxSelectionSessionKind;
+    suppressNextDomSelectionRestore: () => void;
+    beginSelectionSession: (kind: Exclude<DocxSelectionSessionKind, "idle">, options?: {
+        settleAfterMs?: number;
+    }) => void;
+    clearSelectionSession: (expectedKind?: DocxSelectionSessionKind) => void;
+    selectedParagraphStyleId?: string;
+    selectedLineSpacing: DocxLineSpacingInfo;
+    selectedBorderContext: DocxBorderContext;
+    activeBorderPresets: DocxBorderPresetState;
+    availableParagraphStyles: ParagraphStyleDefinition[];
+    trackedChanges: DocxTrackedChange[];
+    showTrackedChanges: boolean;
+    currentPage: number;
+    totalPages: number;
+    hasUnorderedList: boolean;
+    hasOrderedList: boolean;
+    canUndo: boolean;
+    canRedo: boolean;
+    registerPendingExportModelTransformer: (transformer?: (model: DocModel) => DocModel) => void;
+    setStatus: React.Dispatch<React.SetStateAction<string>>;
+    setDocumentTheme: (theme: DocxDocumentTheme) => void;
+    setShowTrackedChanges: (showTrackedChanges: boolean) => void;
+    syncPaginationInfo: (pagination: DocxPaginationInfo) => void;
+    toggleShowTrackedChanges: () => void;
+    importDocxFile: (file: File) => Promise<void>;
+    newDocument: () => void;
+    exportDocx: () => void;
+    undo: () => void;
+    redo: () => void;
+    setHeading: (heading?: HeadingLevel) => void;
+    setParagraphStyle: (styleId?: string) => void;
+    setLineSpacing: (lineMultiple: number) => void;
+    setFontFamily: (fontFamily: string) => void;
+    setFontSize: (fontSizePt: number) => void;
+    toggleBold: () => void;
+    toggleItalic: () => void;
+    toggleUnderline: () => void;
+    toggleStrike: () => void;
+    toggleSuperscript: () => void;
+    toggleSubscript: () => void;
+    setHighlight: (highlight?: string) => void;
+    setTextColor: (color?: string) => void;
+    setLink: (link?: string) => void;
+    selectFormField: (location?: DocxFormFieldLocation) => void;
+    toggleFormCheckbox: (location: DocxFormFieldLocation) => void;
+    setFormFieldValue: (location: DocxFormFieldLocation, value: string) => void;
+    updateFormFieldWidget: (location: DocxFormFieldLocation, patch: Partial<NonNullable<FormFieldRunNode["widget"]>>) => void;
+    applyBorderPreset: (preset: DocxBorderPreset) => void;
+    setAlignment: (align?: ParagraphAlignment) => void;
+    toggleList: (listType: DocxListType) => void;
+    adjustSelectedListDepth: (levelDelta: number, draftText?: string) => boolean;
+    insertListItemAfterSelection: (draftText: string, startOffset: number, endOffset?: number, targetLocation?: ParagraphLocation) => {
+        paragraphIndex: number;
+        caretOffset: number;
+    } | undefined;
+    splitParagraphAtSelection: (draftText: string, startOffset: number, endOffset?: number, targetLocation?: ParagraphLocation) => {
+        paragraphIndex: number;
+        caretOffset: number;
+    } | undefined;
+    insertTable: () => void;
+    insertImageFile: (file: File) => Promise<void>;
+    appendParagraph: (text?: string) => number;
+    resizeImage: (location: DocxImageLocation, widthPx: number, heightPx: number) => void;
+    setSyntheticTextBoxText: (location: DocxImageLocation, text: string) => void;
+    setImageWrapMode: (location: DocxImageLocation, mode: DocxImageWrapMode, seedFloating?: Partial<NonNullable<ImageRunNode["floating"]>>) => void;
+    moveFloatingImage: (location: DocxImageLocation, patch: Partial<NonNullable<ImageRunNode["floating"]>>) => void;
+    moveSectionFloatingImage: (location: DocxSectionImageLocation, patch: Partial<NonNullable<ImageRunNode["floating"]>>) => void;
+    moveParagraphDropCap: (nodeIndex: number, patch: Partial<NonNullable<NonNullable<ParagraphNode["style"]>["dropCap"]>>) => void;
+    setParagraphDropCapFontSizePt: (nodeIndex: number, fontSizePt: number) => void;
+    setParagraphDropCapText: (nodeIndex: number, text: string) => void;
+    moveImage: (source: DocxImageLocation, target: DocxImageDropTarget) => void;
+    setActiveTextRange: (range?: DocxTextRange) => void;
+    selectParagraph: (nodeIndex: number) => void;
+    selectTableCell: (tableIndex: number, rowIndex: number, cellIndex: number) => void;
+    clearTableCellContents: (tableIndex: number, cells: Array<{
+        rowIndex: number;
+        cellIndex: number;
+    }>) => void;
+    insertTableRow: (tableIndex: number, rowIndex: number, direction: "above" | "below") => void;
+    insertTableColumn: (tableIndex: number, cellIndex: number, direction: "left" | "right", rowIndex?: number) => void;
+    deleteTableRow: (tableIndex: number, rowIndex: number) => void;
+    deleteTableColumn: (tableIndex: number, cellIndex: number, rowIndex?: number) => void;
+    deleteTable: (tableIndex: number) => void;
+    moveTable: (tableIndex: number, targetNodeIndex: number) => void;
+    moveEmbeddedTableToBody: (tableRuntimeKey: string, targetNodeIndex: number) => void;
+    replaceExpandedSelection: (text: string, range?: DocxTextRange) => DocxTextRange | undefined;
+    deleteExpandedSelection: (range?: DocxTextRange) => DocxTextRange | undefined;
+    commitParagraphText: (nodeIndex: number, text: string) => void;
+    commitTableCellText: (tableIndex: number, rowIndex: number, cellIndex: number, text: string) => void;
+    commitTableCellParagraphTextRecursive: (tableIndex: number, rowIndex: number, cellIndex: number, paragraphIndex: number, text: string) => void;
+    commitSectionParagraphText: (location: DocxSectionParagraphLocation, text: string) => void;
+}
+type DocxTableContextMenuActionId = "insert-row-above" | "insert-row-below" | "insert-column-left" | "insert-column-right" | "delete-row" | "delete-column" | "delete-table";
+type DocxContextMenuActionId = DocxTableContextMenuActionId | "cut" | "copy" | "paste" | "image-wrap-inline" | "image-wrap-square" | "image-wrap-tight" | "image-wrap-through" | "image-wrap-top-and-bottom" | "image-wrap-behind-text" | "image-wrap-in-front-of-text" | "image-edit-wrap-boundary" | "image-move-with-text" | "image-fix-position-on-page" | "image-more-layout-options" | "image-bring-to-front" | "image-bring-forward" | "image-in-front-of-text" | "image-send-to-back" | "image-send-backward" | "image-behind-text";
+interface DocxTableContextMenuContext {
+    tableIndex: number;
+    rowIndex: number;
+    cellIndex: number;
+}
+interface DocxTableContextMenuAction {
+    id: DocxTableContextMenuActionId;
+    label: string;
+    destructive?: boolean;
+}
+interface DocxContextMenuAction {
+    id: DocxContextMenuActionId | (string & {});
+    label: string;
+    shortcut?: string;
+    destructive?: boolean;
+    disabled?: boolean;
+    checked?: boolean;
+    separatorBefore?: boolean;
+    children?: DocxContextMenuAction[];
+}
+interface DocxTableContextMenuRenderProps {
+    context: DocxTableContextMenuContext;
+    actions: DocxTableContextMenuAction[];
+    runAction: (actionId: DocxTableContextMenuActionId) => void;
+    closeMenu: () => void;
+    position: {
+        x: number;
+        y: number;
+    };
+    documentTheme: DocxDocumentTheme;
+}
+interface DocxContextMenuContext {
+    kind: "text" | "table" | "image";
+    activeTextRange?: DocxTextRange;
+    location?: DocxTextRangeLocation;
+    tableContext?: DocxTableContextMenuContext;
+    image?: {
+        location: DocxImageLocation;
+        floating?: NonNullable<ImageRunNode["floating"]>;
+        wrap?: DocxImageWrapState;
+    } | undefined;
+}
+interface DocxContextMenuRenderProps {
+    context: DocxContextMenuContext;
+    actions: DocxContextMenuAction[];
+    runAction: (actionId: DocxContextMenuActionId | (string & {})) => void;
+    closeMenu: () => void;
+    position: {
+        x: number;
+        y: number;
+    };
+    documentTheme: DocxDocumentTheme;
+}
+interface DocxEditorViewerProps {
+    editor: DocxEditorController;
+    className?: string;
+    style?: React.CSSProperties;
+    pageGapBackgroundColor?: string;
+    deferInitialPaginationPaint?: boolean;
+    loadingState?: React.ReactNode;
+    pageVirtualization?: {
+        enabled?: boolean;
+        overscan?: number;
+        settleDelayMs?: number;
+    };
+    visiblePageRange?: {
+        startPageIndex: number;
+        endPageIndex: number;
+    };
+    onPageCountChange?: (pageCount: number) => void;
+    onRequestPageReveal?: (pageIndex: number) => void;
+    headingStyles?: DocxHeadingStyleMap;
+    mode?: DocxEditorViewerMode;
+    showTrackedChanges?: boolean;
+    renderTrackedChangeCard?: (props: DocxTrackedChangeCardRenderProps) => React.ReactNode;
+    renderTableContextMenu?: (props: DocxTableContextMenuRenderProps) => React.ReactNode;
+    renderContextMenu?: (props: DocxContextMenuRenderProps) => React.ReactNode;
+    onFormFieldDoubleClick?: (location: DocxFormFieldLocation) => void;
+}
+interface DocxTrackedChangeCardRenderProps {
+    change: DocxTrackedChange;
+    kindLabel: string;
+    snippet: string;
+    formattedDate?: string;
+    accentColor: string;
+    documentTheme: DocxDocumentTheme;
+    pageIndex: number;
+    style: React.CSSProperties;
+}
+type DocxEditorViewerMode = "edit" | "read-only";
+interface UseDocxDocumentThemeResult {
+    documentTheme: DocxDocumentTheme;
+    isDarkDocument: boolean;
+    setDocumentTheme: (theme: DocxDocumentTheme) => void;
+    toggleDocumentTheme: () => void;
+}
+interface UseDocxParagraphStylesResult {
+    paragraphStyles: ParagraphStyleDefinition[];
+    selectedParagraphStyleId?: string;
+    setParagraphStyle: (styleId?: string) => void;
+}
+interface UseDocxLineSpacingResult {
+    lineSpacing: DocxLineSpacingInfo;
+    setLineSpacing: (lineMultiple: number) => void;
+}
+interface UseDocxBordersResult {
+    borderContext: DocxBorderContext;
+    activeBorderPresets: DocxBorderPresetState;
+    applyBorderPreset: (preset: DocxBorderPreset) => void;
+}
+interface UseDocxFormFieldsResult {
+    formFields: DocxSelectedFormField[];
+    selectedFormField?: DocxSelectedFormField;
+    selectFormField: (location?: DocxFormFieldLocation) => void;
+    setFormFieldValue: (location: DocxFormFieldLocation, value: string) => void;
+    toggleFormCheckbox: (location: DocxFormFieldLocation) => void;
+    updateFormFieldWidget: (location: DocxFormFieldLocation, patch: Partial<NonNullable<FormFieldRunNode["widget"]>>) => void;
+    updateSelectedFormFieldWidget: (patch: Partial<NonNullable<FormFieldRunNode["widget"]>>) => void;
+}
+interface UseDocxTrackChangesResult {
+    trackedChanges: DocxTrackedChange[];
+    showTrackedChanges: boolean;
+    setShowTrackedChanges: (showTrackedChanges: boolean) => void;
+    toggleShowTrackedChanges: () => void;
+    changesByLocation: Map<string, DocxTrackedChange[]>;
+    getChangesForLocation: (location: DocxTextRangeLocation) => DocxTrackedChange[];
+}
+interface DocxSectionColumnLayout {
+    count: number;
+    gapPx: number;
+}
+interface DocxPageLayoutInfo {
+    pageWidthPx: number;
+    pageHeightPx: number;
+    contentWidthPx: number;
+    contentHeightPx: number;
+    marginsPx: {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+    };
+    headerDistancePx: number;
+    footerDistancePx: number;
+    pageNumberStart: number;
+    columns?: DocxSectionColumnLayout;
+    viewportDefaults: {
+        zoomPercent: number;
+        pageGapPx: number;
+    };
+}
+interface UseDocxPageLayoutResult {
+    layout: DocxPageLayoutInfo;
+}
+interface DocxPaginationInfo {
+    currentPage: number;
+    totalPages: number;
+}
+interface UseDocxPaginationResult {
+    pagination: DocxPaginationInfo;
+}
+declare const defaultStarterModel: DocModel;
+declare function useDocxEditor(options?: UseDocxEditorOptions): DocxEditorController;
+declare function useDocxDocumentTheme(editor: Pick<DocxEditorController, "documentTheme" | "setDocumentTheme">): UseDocxDocumentThemeResult;
+declare function useDocxParagraphStyles(editor: Pick<DocxEditorController, "availableParagraphStyles" | "selectedParagraphStyleId" | "setParagraphStyle">): UseDocxParagraphStylesResult;
+declare function useDocxImageWrapMenu(menu: Pick<DocxContextMenuRenderProps, "context" | "runAction">): UseDocxImageWrapMenuResult | undefined;
+declare function useDocxLineSpacing(editor: Pick<DocxEditorController, "selectedLineSpacing" | "setLineSpacing">): UseDocxLineSpacingResult;
+declare function useDocxBorders(editor: Pick<DocxEditorController, "selectedBorderContext" | "activeBorderPresets" | "applyBorderPreset">): UseDocxBordersResult;
+declare function useDocxFormFields(editor: Pick<DocxEditorController, "model" | "selectedFormField" | "selectFormField" | "setFormFieldValue" | "toggleFormCheckbox" | "updateFormFieldWidget">): UseDocxFormFieldsResult;
+declare function useDocxTrackChanges(editor: Pick<DocxEditorController, "trackedChanges" | "showTrackedChanges" | "setShowTrackedChanges" | "toggleShowTrackedChanges">): UseDocxTrackChangesResult;
+declare function useDocxPageLayout(editor: Pick<DocxEditorController, "model">): UseDocxPageLayoutResult;
+declare function useDocxPagination(editor: Pick<DocxEditorController, "currentPage" | "totalPages">): UseDocxPaginationResult;
+declare function DocxEditorViewer({ editor, className, style, pageGapBackgroundColor, deferInitialPaginationPaint, loadingState, pageVirtualization, visiblePageRange, onPageCountChange, onRequestPageReveal, headingStyles, showTrackedChanges, renderTrackedChangeCard, renderTableContextMenu, renderContextMenu, onFormFieldDoubleClick, mode, }: DocxEditorViewerProps): React.JSX.Element;
+
+interface ReactDocxViewerProps {
+    file?: ArrayBuffer;
+    model?: DocModel;
+    className?: string;
+    layoutOptions?: LayoutOptions;
+    emptyState?: React.ReactNode;
+}
+interface UseDocxModelState {
+    model?: DocModel;
+    isLoading: boolean;
+    error?: Error;
+}
+declare function useDocxModel(file?: ArrayBuffer): UseDocxModelState;
+declare function ReactDocxViewer({ file, model, className, layoutOptions, emptyState }: ReactDocxViewerProps): React.JSX.Element;
+
+export { type DocxBorderContext, type DocxBorderPreset, type DocxBorderPresetState, type DocxContextMenuAction, type DocxContextMenuActionId, type DocxContextMenuContext, type DocxContextMenuRenderProps, type DocxDocumentTheme, type DocxEditorController, type DocxEditorSelection, DocxEditorViewer, type DocxEditorViewerMode, type DocxEditorViewerProps, type DocxFormFieldLocation, type DocxHeadingStyleMap, type DocxImageDropTarget, type DocxImageLocation, type DocxImageWrapMenuOption, type DocxImageWrapMode, type DocxImageWrapState, type DocxLineSpacingInfo, type DocxListType, type DocxPageLayoutInfo, type DocxPaginationInfo, type DocxSectionColumnLayout, type DocxSelectedFormField, type DocxTableContextMenuAction, type DocxTableContextMenuActionId, type DocxTableContextMenuContext, type DocxTableContextMenuRenderProps, type DocxTextRange, type DocxTextRangeLocation, type DocxTrackedChange, type DocxTrackedChangeCardRenderProps, type DocxTrackedChangeKind, ReactDocxViewer, type ReactDocxViewerProps, type UseDocxBordersResult, type UseDocxDocumentThemeResult, type UseDocxEditorOptions, type UseDocxFormFieldsResult, type UseDocxImageWrapMenuResult, type UseDocxLineSpacingResult, type UseDocxModelState, type UseDocxPageLayoutResult, type UseDocxPaginationResult, type UseDocxParagraphStylesResult, type UseDocxTrackChangesResult, defaultStarterModel, paragraphLetterheadFloatSideAtNodeIndex, parseSectionLayout, resolveDocumentLayout, useDocxBorders, useDocxDocumentTheme, useDocxEditor, useDocxFormFields, useDocxImageWrapMenu, useDocxLineSpacing, useDocxModel, useDocxPageLayout, useDocxPagination, useDocxParagraphStyles, useDocxTrackChanges };