@bluechaine/print-designer 0.1.0

package/dist/types/src/i18n/zh-CN.d.ts

@@ -0,0 +1,104 @@
+declare const _default: {
+    designer: {
+        save: string;
+        preview: string;
+        editTemplate: string;
+        editPrintData: string;
+        exportFile: string;
+        importFile: string;
+        print: string;
+        pdf: string;
+        image: string;
+        close: string;
+        confirm: string;
+        apply: string;
+        clear: string;
+        copy: string;
+        cancel: string;
+        invalidJson: string;
+        printDataBasic: string;
+        printDataTable: string;
+        printDataEmpty: string;
+        printDataAddRow: string;
+        printDataDeleteRow: string;
+        printDataFieldKey: string;
+        paper: string;
+    };
+    header: {
+        title: string;
+    };
+    panel: {
+        draggableEls: string;
+        miniMap: string;
+        pageStructure: string;
+        pageHistory: string;
+        properties: string;
+        fold: string;
+        expand: string;
+        minimize: string;
+        show: string;
+        hide: string;
+        empty: string;
+        add: string;
+    };
+    history: {
+        move: string;
+        align: string;
+        param: string;
+        initial: string;
+        deleteRecord: string;
+        zoom: string;
+    };
+    tool: {
+        undo: string;
+        redo: string;
+        alignLeft: string;
+        alignCenter: string;
+        alignRight: string;
+        alignTop: string;
+        alignMiddle: string;
+        alignBottom: string;
+        moveTop: string;
+        moveUp: string;
+        moveDown: string;
+        moveBottom: string;
+        flipH: string;
+        flipV: string;
+        fontInc: string;
+        fontDec: string;
+        fontBold: string;
+        fontUnbold: string;
+        lock: string;
+        unlock: string;
+        clone: string;
+        copy: string;
+        cut: string;
+        paste: string;
+        delete: string;
+        zoomOut: string;
+        zoomIn: string;
+        rotate: string;
+        clear: string;
+        togglePanels: string;
+    };
+    category: {
+        base: string;
+        text: string;
+        image: string;
+        qrcode: string;
+        barcode: string;
+        longText: string;
+        table: string;
+        html: string;
+    };
+    group: {
+        regular: string;
+        helper: string;
+    };
+    locale: {
+        switch: string;
+        zhCN: string;
+        enUS: string;
+    };
+};
+export default _default;

package/dist/types/src/index.d.ts

@@ -0,0 +1,52 @@
+/**
+ * vue3-print-designer — public entry.
+ *
+ * The package ships two builds (`dist/vue2/` and `dist/vue3/`); both compile
+ * from this same source file thanks to `vue-demi`.
+ */
+import './core/register-icons';
+import './styles/app.scss';
+export { default as Designer } from './components/Designer.vue';
+export { default as Header } from './components/Header.vue';
+export { default as Toolbar } from './components/Toolbar.vue';
+export { default as Preview } from './components/Preview.vue';
+export { default as Ruler } from './components/Ruler.vue';
+export { default as DragBox } from './components/DragBox.vue';
+export { default as SvpIcon } from './components/SvpIcon.vue';
+export { default as DraggableElsPanel } from './components/panels/DraggableElsPanel.vue';
+export { default as MiniMapPanel } from './components/panels/MiniMapPanel.vue';
+export { default as PageStructurePanel } from './components/panels/PageStructurePanel.vue';
+export { default as PageHistoryPanel } from './components/panels/PageHistoryPanel.vue';
+export { default as PropertiesPanel } from './components/panels/PropertiesPanel.vue';
+export { default as DesignerUtils } from './core/designer-utils';
+export { PluginManager } from './core/plugins';
+export { HistoryController } from './core/history';
+export { HISTORY_MOVE, HISTORY_ALIGN, HISTORY_PARAM, HISTORY_INITIAL, normalizeHistoryLabel, } from './core/history-labels';
+export { ShortcutsController } from './core/shortcuts';
+export { hiprint, initHiprint, buildByHtml, defaultElementTypeProvider, } from './core/hiprint-bridge';
+export { SvpElementTypeProvider } from './core/svp-element-provider';
+export { applyStyleOption, resolveShowOption, DESIGNER_UI_INJECTION_KEY, } from './core/designer-options';
+export { extractTemplateFields, buildPrintDataFromForm, createPrintDataFormState, type TemplateFieldSchema, type BasicFieldDef, type TableFieldDef, } from './core/template-fields';
+export { headerElementsFromCatalogue } from './constants/header-elements';
+export { DEFAULT_TABLE_COLUMNS, DEFAULT_TABLE_ELEMENT_TYPE, DEFAULT_TABLE_FIELDS, } from './constants/default-table-element';
+export { designerStore, setZoom, setPanelVisibility, togglePanel, toggleAllPanels, setSelection, } from './core/stores';
+export { readJSON, writeJSON, removeKey } from './core/storage';
+export { useDesigner, provideDesigner, DESIGNER_INJECTION_KEY } from './composables/useDesigner';
+export { useDesignerUi } from './composables/useDesignerUi';
+export { useDragBox } from './composables/useDragBox';
+export { useRuler } from './composables/useRuler';
+export { useI18n, setLocale, getLocaleList } from './i18n';
+export { default as zhCN } from './i18n/zh-CN';
+export { default as enUS } from './i18n/en-US';
+export * from './constants';
+export * from './constants/icons';
+export * from './types';
+export { pluginApiPdf } from '../plugins/plugin-api-pdf/src';
+export { pluginApiImage } from '../plugins/plugin-api-image/src';
+export { pluginViewCodeEdit } from '../plugins/plugin-view-code-edit/src';
+/** Convenience Vue plugin: `app.use(Vue3PrintDesigner)`. */
+import type { App as Vue3App } from 'vue-demi';
+declare const _default: {
+    install(app: Vue3App): void;
+};
+export default _default;

package/dist/types/src/types.d.ts

@@ -0,0 +1,229 @@
+/**
+ * Public types for vue3-print-designer.
+ *
+ * These mirror the shape of the sv-print component contract so that
+ * existing templates and plugin authors can migrate with minimal friction.
+ */
+/** A daisyUI-style theme descriptor. */
+export interface ThemeType {
+    /** Theme name. When omitted a stable hash of the colors is used. */
+    theme?: string;
+    primaryColor: string;
+    primaryContent?: string;
+    secondaryColor?: string;
+    secondaryContent?: string;
+    accentColor?: string;
+    accentContent?: string;
+    neutralColor?: string;
+    neutralContent?: string;
+    base100?: string;
+    base200?: string;
+    base300?: string;
+    baseContent?: string;
+    info?: string;
+    infoContent?: string;
+    success?: string;
+    successContent?: string;
+    warning?: string;
+    warningContent?: string;
+    error?: string;
+    errorContent?: string;
+}
+/** Configures how a single floating panel (DragBox) shows up. */
+export type DragBoxMode = 'default' | 'top' | 'left' | 'bottom' | 'right' | 'fixed';
+export interface DragBoxStyleOptions {
+    mode?: DragBoxMode;
+    /** Inline css string. */
+    style?: string;
+    /** Initial visibility. */
+    show?: boolean;
+    /** Title shown in the header. */
+    title?: string;
+    /** Other free-form payload available in slots. */
+    other?: Record<string, unknown>;
+}
+/** Per-panel style/visibility overrides. */
+export interface StyleOption {
+    paperBox?: DragBoxStyleOptions;
+    panels?: DragBoxStyleOptions;
+    draggableEls?: DragBoxStyleOptions;
+    options?: DragBoxStyleOptions;
+    pageStructure?: DragBoxStyleOptions;
+    history?: DragBoxStyleOptions;
+    miniMap?: DragBoxStyleOptions;
+    editableTools?: DragBoxStyleOptions;
+    zIndexTools?: DragBoxStyleOptions;
+    fontTools?: DragBoxStyleOptions;
+    zoomTools?: DragBoxStyleOptions;
+    rotateTools?: DragBoxStyleOptions;
+}
+/** Header / toolbar / footer visibility switches. */
+export interface ShowOption {
+    showHeader?: boolean;
+    showToolbar?: boolean;
+    showFooter?: boolean;
+    showPower?: boolean;
+}
+export interface PaperType {
+    type: string;
+    width: number;
+    height: number;
+}
+export interface ProviderMap {
+    /** CSS selector hiprint should fill with draggable items. */
+    container: string;
+    /** Provider value (typically the tid prefix). */
+    value: string;
+    render?: (e: any[]) => any;
+}
+export interface PreviewOptions {
+    showPdf?: boolean;
+    showImg?: boolean;
+    showPrint2?: boolean;
+}
+export type Hook = 'init' | 'ready' | 'documentShortcutKeys' | 'shortcutKeys' | 'createPrintElement' | 'beforePrint' | 'beforePrint2' | 'getOptionItem' | 'onDesigned' | 'onPreview' | 'newPrintTemplate' | 'newPanel' | (string & {});
+export interface HookOptions {
+    hook: Hook;
+    name: string;
+    description?: string;
+    priority?: number;
+    run: (...args: any[]) => any | Promise<any>;
+}
+export interface PluginOptions {
+    name: string;
+    description?: string;
+    init?: (input: any) => any;
+    hooks: HookOptions[];
+    config?: Record<string, unknown>;
+    leastHiprintVersion?: string;
+}
+/** Convenience factory typing for plugin authors. */
+export type PluginFactory<T = unknown> = (opts?: T) => PluginOptions;
+/** A `Provider` adds custom draggable element types into hiprint. */
+export declare abstract class Provider {
+    abstract addElementTypes(ctx: any): void;
+}
+export interface Events {
+    onSave?: (key: string, data: any) => boolean | void;
+    onEdit?: (data: any) => boolean | void;
+    onEditData?: (data: any) => boolean | void;
+    onKeyDownEvent?: (e: KeyboardEvent, utils: any) => boolean | void;
+}
+export interface DesignOptions {
+    grid?: boolean;
+    activePanel?: boolean;
+    adaptToSize?: boolean;
+}
+export interface DesignerPrintTemplateOptions {
+    template: any;
+    fontList?: any[];
+    fields?: any[];
+    onImageChooseClick?: (target: any) => void;
+    onZoomChange?: (scale: number) => void;
+    onPanelAddClick?: (panel: any, createPanel: any) => void;
+    onFunctionClick?: (option: any, printElement: any, event: any) => void;
+    dataMode?: 1 | 2;
+    history?: boolean;
+    onDataChanged?: (type: string, json: any) => void;
+    onUpdateError?: (e: any) => void;
+    settingContainer?: string;
+    designContainer?: string;
+    paginationContainer?: string;
+}
+export interface RulerStyle {
+    show?: boolean;
+    scale?: number;
+    backgroundColor?: string;
+    fontColor?: string;
+    fontSize?: number;
+    tickColor?: string;
+    paperRectColor?: string;
+}
+/** Public props accepted by <Designer />. */
+export interface DesignerProps {
+    autoConnect?: boolean;
+    config?: any;
+    providers?: Provider[];
+    providerMap?: ProviderMap | ProviderMap[];
+    plugins?: PluginOptions[];
+    /** Either a template JSON or template options object. */
+    template?: any;
+    templateOptions?: DesignerPrintTemplateOptions;
+    designOptions?: DesignOptions;
+    printData?: any;
+    templateKey?: string;
+    title?: string;
+    authKey?: string;
+    headerLogoHtml?: string;
+    headerTitle?: string;
+    headerNewEle?: boolean;
+    headerEleList?: HeaderEle[];
+    headerNewMenu?: boolean;
+    headerMenuList?: HeaderMenu[];
+    events?: Events;
+    tags?: string[];
+    styleOption?: StyleOption;
+    showOption?: ShowOption;
+    paperList?: PaperType[];
+    theme?: string | ThemeType | ThemeType[];
+    themeList?: string[];
+    pageStructureGridMode?: boolean;
+    miniMapOriginMode?: boolean;
+    rulerStyle?: RulerStyle;
+    previewOptions?: PreviewOptions;
+    onPreviewClick?: (e: MouseEvent) => boolean | void;
+    onZoomChange?: (scale: number) => void;
+    onImageChooseClick?: (target: any) => void;
+    customDataFun?: (data: any, field: string, printData?: any) => string | number | object;
+    onPanelAddClick?: (panel: any, createPanel: any) => void;
+    onFunctionClick?: (option: any, printElement: any, event: any) => void;
+    onBeforeDragIn?: (printTemplate: any, panel: any, printElement: any) => boolean | void;
+}
+/** Custom item inside the Header element-category bar. */
+export interface HeaderEle {
+    key: string;
+    label: string;
+    /** Iconify icon id or legacy inline SVG. */
+    icon?: string;
+    tid?: string;
+    onClick?: (e: MouseEvent) => void;
+}
+/** Header dropdown menu entry. */
+export interface HeaderMenu {
+    key: string;
+    label: string;
+    icon?: string;
+    onClick?: () => void;
+    children?: HeaderMenu[];
+}
+/** Internal: tool descriptor used by Toolbar.vue. */
+export interface ToolDescriptor {
+    key: string;
+    /** i18n key for tooltip. */
+    i18n?: string;
+    /** Direct label, takes precedence over `i18n`. */
+    label?: string;
+    /** Iconify icon id (e.g. `lucide:copy`) or legacy inline SVG markup. */
+    icon: string;
+    /** When true the tool is rendered as a separator. */
+    separator?: boolean;
+    /** Hide the tool. */
+    hidden?: boolean;
+    /** Disabled when there is no current selection. */
+    needSelection?: boolean;
+    /** Only on mobile. */
+    mobileOnly?: boolean;
+    /** Hidden on mobile. */
+    desktopOnly?: boolean;
+    /** Toggle a floating panel's visibility. */
+    panelKey?: 'draggableEls' | 'miniMap' | 'pageStructure' | 'pageHistory' | 'properties';
+    /** Render as a read-only label instead of a button. */
+    display?: 'zoomPercent' | 'langSelect' | 'lockToggle';
+    /** Click handler runs against DesignerUtils. */
+    onClick?: (utils: any, ev: MouseEvent) => void;
+}
+export type Lang = 'zh-CN' | 'en-US' | (string & {});
+export interface DesignedEventPayload {
+    hiprint: any;
+    designerUtils: any;
+}