@os-team-11/editor 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,721 @@
+import { z } from 'zod';
+import * as react from 'react';
+import { ComponentType, ReactNode, CSSProperties, Ref } from 'react';
+
+/** AI 输出 / 编辑器消费的中间格式 */
+interface BidMeta {
+    title: string;
+    docNo: string;
+    tenderer: string;
+    version: string;
+    generatedAt: string;
+    generator?: string;
+}
+interface BidPageMargins {
+    top: number;
+    right: number;
+    bottom: number;
+    left: number;
+}
+interface BidPageHeader {
+    template: string;
+    showOnFirstPage: boolean;
+}
+interface BidPageFooter {
+    template: string;
+}
+interface BidPageWatermark {
+    text: string;
+    opacity: number;
+}
+type BidPageSize = 'A4' | 'Letter' | {
+    width: number;
+    height: number;
+};
+interface BidPage {
+    size: BidPageSize;
+    margins: BidPageMargins;
+    header?: BidPageHeader;
+    footer?: BidPageFooter;
+    watermark?: BidPageWatermark;
+}
+/** Milestone 1 支持的 block 类型子集 */
+type BidBlock = {
+    type: 'heading';
+    level: 2 | 3 | 4;
+    text: string;
+} | {
+    type: 'paragraph';
+    text: string;
+} | {
+    type: 'list';
+    ordered: boolean;
+    items: string[];
+} | {
+    type: 'table';
+    rows: string[][];
+    caption?: string;
+} | {
+    type: 'image';
+    src: string;
+    alt?: string;
+    caption?: string;
+};
+interface BidSection {
+    id: string;
+    title: string;
+    level: 1 | 2 | 3;
+    blocks: BidBlock[];
+}
+interface BidSchema {
+    meta: BidMeta;
+    page: BidPage;
+    sections: BidSection[];
+}
+
+declare const bidSchema: z.ZodObject<{
+    meta: z.ZodObject<{
+        title: z.ZodString;
+        docNo: z.ZodString;
+        tenderer: z.ZodString;
+        version: z.ZodString;
+        generatedAt: z.ZodString;
+        generator: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        docNo: string;
+        tenderer: string;
+        version: string;
+        generatedAt: string;
+        generator?: string | undefined;
+    }, {
+        title: string;
+        docNo: string;
+        tenderer: string;
+        version: string;
+        generatedAt: string;
+        generator?: string | undefined;
+    }>;
+    page: z.ZodObject<{
+        size: z.ZodUnion<[z.ZodLiteral<"A4">, z.ZodLiteral<"Letter">, z.ZodObject<{
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            width: number;
+            height: number;
+        }, {
+            width: number;
+            height: number;
+        }>]>;
+        margins: z.ZodObject<{
+            top: z.ZodNumber;
+            right: z.ZodNumber;
+            bottom: z.ZodNumber;
+            left: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            top: number;
+            right: number;
+            bottom: number;
+            left: number;
+        }, {
+            top: number;
+            right: number;
+            bottom: number;
+            left: number;
+        }>;
+        header: z.ZodOptional<z.ZodObject<{
+            template: z.ZodString;
+            showOnFirstPage: z.ZodBoolean;
+        }, "strip", z.ZodTypeAny, {
+            template: string;
+            showOnFirstPage: boolean;
+        }, {
+            template: string;
+            showOnFirstPage: boolean;
+        }>>;
+        footer: z.ZodOptional<z.ZodObject<{
+            template: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            template: string;
+        }, {
+            template: string;
+        }>>;
+        watermark: z.ZodOptional<z.ZodObject<{
+            text: z.ZodString;
+            opacity: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            text: string;
+            opacity: number;
+        }, {
+            text: string;
+            opacity: number;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        size: "A4" | "Letter" | {
+            width: number;
+            height: number;
+        };
+        margins: {
+            top: number;
+            right: number;
+            bottom: number;
+            left: number;
+        };
+        header?: {
+            template: string;
+            showOnFirstPage: boolean;
+        } | undefined;
+        footer?: {
+            template: string;
+        } | undefined;
+        watermark?: {
+            text: string;
+            opacity: number;
+        } | undefined;
+    }, {
+        size: "A4" | "Letter" | {
+            width: number;
+            height: number;
+        };
+        margins: {
+            top: number;
+            right: number;
+            bottom: number;
+            left: number;
+        };
+        header?: {
+            template: string;
+            showOnFirstPage: boolean;
+        } | undefined;
+        footer?: {
+            template: string;
+        } | undefined;
+        watermark?: {
+            text: string;
+            opacity: number;
+        } | undefined;
+    }>;
+    sections: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+        level: z.ZodUnion<[z.ZodLiteral<1>, z.ZodLiteral<2>, z.ZodLiteral<3>]>;
+        blocks: z.ZodArray<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+            type: z.ZodLiteral<"heading">;
+            level: z.ZodUnion<[z.ZodLiteral<2>, z.ZodLiteral<3>, z.ZodLiteral<4>]>;
+            text: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: "heading";
+            text: string;
+            level: 2 | 3 | 4;
+        }, {
+            type: "heading";
+            text: string;
+            level: 2 | 3 | 4;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"paragraph">;
+            text: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: "paragraph";
+            text: string;
+        }, {
+            type: "paragraph";
+            text: string;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"list">;
+            ordered: z.ZodBoolean;
+            items: z.ZodArray<z.ZodString, "many">;
+        }, "strip", z.ZodTypeAny, {
+            type: "list";
+            ordered: boolean;
+            items: string[];
+        }, {
+            type: "list";
+            ordered: boolean;
+            items: string[];
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"table">;
+            rows: z.ZodArray<z.ZodArray<z.ZodString, "many">, "many">;
+            caption: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            type: "table";
+            rows: string[][];
+            caption?: string | undefined;
+        }, {
+            type: "table";
+            rows: string[][];
+            caption?: string | undefined;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"image">;
+            src: z.ZodString;
+            alt: z.ZodOptional<z.ZodString>;
+            caption: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            type: "image";
+            src: string;
+            caption?: string | undefined;
+            alt?: string | undefined;
+        }, {
+            type: "image";
+            src: string;
+            caption?: string | undefined;
+            alt?: string | undefined;
+        }>]>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        id: string;
+        level: 2 | 3 | 1;
+        blocks: ({
+            type: "heading";
+            text: string;
+            level: 2 | 3 | 4;
+        } | {
+            type: "paragraph";
+            text: string;
+        } | {
+            type: "list";
+            ordered: boolean;
+            items: string[];
+        } | {
+            type: "table";
+            rows: string[][];
+            caption?: string | undefined;
+        } | {
+            type: "image";
+            src: string;
+            caption?: string | undefined;
+            alt?: string | undefined;
+        })[];
+    }, {
+        title: string;
+        id: string;
+        level: 2 | 3 | 1;
+        blocks: ({
+            type: "heading";
+            text: string;
+            level: 2 | 3 | 4;
+        } | {
+            type: "paragraph";
+            text: string;
+        } | {
+            type: "list";
+            ordered: boolean;
+            items: string[];
+        } | {
+            type: "table";
+            rows: string[][];
+            caption?: string | undefined;
+        } | {
+            type: "image";
+            src: string;
+            caption?: string | undefined;
+            alt?: string | undefined;
+        })[];
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    meta: {
+        title: string;
+        docNo: string;
+        tenderer: string;
+        version: string;
+        generatedAt: string;
+        generator?: string | undefined;
+    };
+    page: {
+        size: "A4" | "Letter" | {
+            width: number;
+            height: number;
+        };
+        margins: {
+            top: number;
+            right: number;
+            bottom: number;
+            left: number;
+        };
+        header?: {
+            template: string;
+            showOnFirstPage: boolean;
+        } | undefined;
+        footer?: {
+            template: string;
+        } | undefined;
+        watermark?: {
+            text: string;
+            opacity: number;
+        } | undefined;
+    };
+    sections: {
+        title: string;
+        id: string;
+        level: 2 | 3 | 1;
+        blocks: ({
+            type: "heading";
+            text: string;
+            level: 2 | 3 | 4;
+        } | {
+            type: "paragraph";
+            text: string;
+        } | {
+            type: "list";
+            ordered: boolean;
+            items: string[];
+        } | {
+            type: "table";
+            rows: string[][];
+            caption?: string | undefined;
+        } | {
+            type: "image";
+            src: string;
+            caption?: string | undefined;
+            alt?: string | undefined;
+        })[];
+    }[];
+}, {
+    meta: {
+        title: string;
+        docNo: string;
+        tenderer: string;
+        version: string;
+        generatedAt: string;
+        generator?: string | undefined;
+    };
+    page: {
+        size: "A4" | "Letter" | {
+            width: number;
+            height: number;
+        };
+        margins: {
+            top: number;
+            right: number;
+            bottom: number;
+            left: number;
+        };
+        header?: {
+            template: string;
+            showOnFirstPage: boolean;
+        } | undefined;
+        footer?: {
+            template: string;
+        } | undefined;
+        watermark?: {
+            text: string;
+            opacity: number;
+        } | undefined;
+    };
+    sections: {
+        title: string;
+        id: string;
+        level: 2 | 3 | 1;
+        blocks: ({
+            type: "heading";
+            text: string;
+            level: 2 | 3 | 4;
+        } | {
+            type: "paragraph";
+            text: string;
+        } | {
+            type: "list";
+            ordered: boolean;
+            items: string[];
+        } | {
+            type: "table";
+            rows: string[][];
+            caption?: string | undefined;
+        } | {
+            type: "image";
+            src: string;
+            caption?: string | undefined;
+            alt?: string | undefined;
+        })[];
+    }[];
+}>;
+declare function validateBid(input: unknown): z.SafeParseReturnType<{
+    meta: {
+        title: string;
+        docNo: string;
+        tenderer: string;
+        version: string;
+        generatedAt: string;
+        generator?: string | undefined;
+    };
+    page: {
+        size: "A4" | "Letter" | {
+            width: number;
+            height: number;
+        };
+        margins: {
+            top: number;
+            right: number;
+            bottom: number;
+            left: number;
+        };
+        header?: {
+            template: string;
+            showOnFirstPage: boolean;
+        } | undefined;
+        footer?: {
+            template: string;
+        } | undefined;
+        watermark?: {
+            text: string;
+            opacity: number;
+        } | undefined;
+    };
+    sections: {
+        title: string;
+        id: string;
+        level: 2 | 3 | 1;
+        blocks: ({
+            type: "heading";
+            text: string;
+            level: 2 | 3 | 4;
+        } | {
+            type: "paragraph";
+            text: string;
+        } | {
+            type: "list";
+            ordered: boolean;
+            items: string[];
+        } | {
+            type: "table";
+            rows: string[][];
+            caption?: string | undefined;
+        } | {
+            type: "image";
+            src: string;
+            caption?: string | undefined;
+            alt?: string | undefined;
+        })[];
+    }[];
+}, {
+    meta: {
+        title: string;
+        docNo: string;
+        tenderer: string;
+        version: string;
+        generatedAt: string;
+        generator?: string | undefined;
+    };
+    page: {
+        size: "A4" | "Letter" | {
+            width: number;
+            height: number;
+        };
+        margins: {
+            top: number;
+            right: number;
+            bottom: number;
+            left: number;
+        };
+        header?: {
+            template: string;
+            showOnFirstPage: boolean;
+        } | undefined;
+        footer?: {
+            template: string;
+        } | undefined;
+        watermark?: {
+            text: string;
+            opacity: number;
+        } | undefined;
+    };
+    sections: {
+        title: string;
+        id: string;
+        level: 2 | 3 | 1;
+        blocks: ({
+            type: "heading";
+            text: string;
+            level: 2 | 3 | 4;
+        } | {
+            type: "paragraph";
+            text: string;
+        } | {
+            type: "list";
+            ordered: boolean;
+            items: string[];
+        } | {
+            type: "table";
+            rows: string[][];
+            caption?: string | undefined;
+        } | {
+            type: "image";
+            src: string;
+            caption?: string | undefined;
+            alt?: string | undefined;
+        })[];
+    }[];
+}>;
+
+interface BidEditorElement {
+    value: string;
+    type?: string;
+    level?: number;
+    listType?: 'ol' | 'ul';
+    listId?: string;
+    valueList?: Array<{
+        value: string;
+        [k: string]: unknown;
+    }>;
+    alt?: string;
+    tableId?: string;
+    trList?: unknown;
+    colspan?: number;
+    rowspan?: number;
+}
+declare function bidToEditorElements(sections: BidSection[]): BidEditorElement[];
+
+declare function editorElementsToSections(elements: BidEditorElement[]): BidSection[];
+
+declare class BidEditor$1 {
+    private readonly editor;
+    private readonly container;
+    private meta;
+    private page;
+    constructor(container: HTMLElement, bid: BidSchema);
+    load(bid: BidSchema): void;
+    getBid(): BidSchema;
+    getCommand(): unknown;
+    /** 直接暴露 canvas-editor 的 command，便于 hooks 模式访问 */
+    get command(): unknown;
+    destroy(): void;
+}
+
+/**
+ * 触发浏览器打印对话框，由用户选择"另存为 PDF"完成导出。
+ *
+ * canvas-editor 0.9.x 没有公开的 PDF 生成 API；
+ * M2 会评估接入 feature/pdf 实验分支或服务端生成方案。
+ */
+declare function printBid(): void;
+
+type Breakpoint = 'mobile' | 'tablet' | 'desktop';
+/** 36 个工具栏按钮的 ID */
+type ToolbarButtonId = 'font-family' | 'font-size' | 'bold' | 'italic' | 'underline' | 'strikeout' | 'superscript' | 'subscript' | 'color' | 'highlight' | 'align-left' | 'align-center' | 'align-right' | 'align-justify' | 'line-height' | 'h1' | 'h2' | 'h3' | 'h4' | 'list-ol' | 'list-ul' | 'indent' | 'outdent' | 'undo' | 'redo' | 'format-painter' | 'clear-format' | 'table' | 'image' | 'hyperlink' | 'separator' | 'page-break' | 'math' | 'control' | 'date' | 'comment';
+type ToolbarDivider = '|';
+type ToolbarItem = ToolbarButtonId | ToolbarDivider;
+interface ToolbarGroupConfig {
+    id: string;
+    buttons: ToolbarItem[];
+}
+type ToolbarConfig = true | ToolbarItem[] | {
+    hide?: ToolbarButtonId[];
+    groups?: ToolbarGroupConfig[];
+};
+interface ThemeColors {
+    primary: string;
+    text: string;
+    border: string;
+    background: string;
+    hover: string;
+    active: string;
+}
+interface Theme {
+    colors: ThemeColors;
+    radius: {
+        button: number;
+        container: number;
+    };
+    spacing: {
+        button: number;
+        group: number;
+    };
+    fontSize: number;
+    fontFamily: string;
+    dark?: boolean;
+}
+interface ButtonRendererProps {
+    id: ToolbarButtonId;
+    active: boolean;
+    disabled: boolean;
+    onClick: () => void;
+    icon?: ReactNode;
+    label?: string;
+    shortcut?: string;
+}
+interface DropdownRendererProps {
+    children: ReactNode;
+    trigger: ReactNode;
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+}
+interface Renderers {
+    button?: Partial<Record<ToolbarButtonId, ComponentType<ButtonRendererProps>>>;
+    divider?: ComponentType;
+    dropdown?: ComponentType<DropdownRendererProps>;
+    toolbarContainer?: ComponentType<{
+        children: ReactNode;
+    }>;
+    aiDialog?: ComponentType<AIDialogRendererProps>;
+}
+interface BidEditorHandle {
+    getBid: () => BidSchema;
+    getCommand: () => unknown;
+    print: () => void;
+    focus: () => void;
+}
+interface BidEditorProps {
+    bid: BidSchema;
+    onChange?: (bid: BidSchema) => void;
+    readOnly?: boolean;
+    toolbar?: ToolbarConfig | false;
+    theme?: Partial<Theme>;
+    renderers?: Renderers;
+    fieldPanel?: boolean;
+    ai?: AIConfig;
+    breakpoint?: Breakpoint;
+    className?: string;
+    style?: CSSProperties;
+    ref?: Ref<BidEditorHandle>;
+}
+type AskFunction = (params: {
+    selectedText: string;
+    question: string;
+    fullDocument?: string;
+}) => Promise<string>;
+interface AIConfig {
+    /** 是否启用，默认 true。但 ask 未传时强制视为 false */
+    enabled?: boolean;
+    /** AI 调用函数。必传，否则菜单项不显示 */
+    ask: AskFunction;
+    /** 菜单项文字，默认 "AI 问答" */
+    label?: string;
+    /** 菜单项 icon（HTML 字符串，canvas-editor 菜单需要） */
+    iconHtml?: string;
+    /** 问题输入框 placeholder，默认 "问 AI 任何问题..." */
+    placeholder?: string;
+    /** 是否把整个文档纯文本作为上下文，默认 false */
+    includeFullDocument?: boolean;
+}
+type AIState = {
+    phase: 'closed';
+} | {
+    phase: 'open';
+    selectedText: string;
+} | {
+    phase: 'loading';
+    selectedText: string;
+    question: string;
+} | {
+    phase: 'answered';
+    selectedText: string;
+    question: string;
+    answer: string;
+} | {
+    phase: 'error';
+    selectedText: string;
+    question: string;
+    error: string;
+};
+interface AIDialogRendererProps {
+    state: AIState;
+    placeholder?: string;
+    onAsk: (question: string) => void;
+    onInsert: () => void;
+    onReplace: () => void;
+    onCopy: () => void;
+    onClose: () => void;
+}
+
+declare const BidEditor: react.ForwardRefExoticComponent<Omit<BidEditorProps, "ref"> & react.RefAttributes<BidEditorHandle>>;
+
+export { type BidBlock, BidEditor, BidEditor$1 as BidEditorCore, type BidEditorElement, type BidEditorHandle, type BidEditorProps, type BidMeta, type BidPage, type BidPageFooter, type BidPageHeader, type BidPageMargins, type BidPageSize, type BidPageWatermark, type BidSchema, type BidSection, type Renderers, type Theme, type ToolbarButtonId, type ToolbarConfig, bidSchema, bidToEditorElements, editorElementsToSections, printBid, validateBid };