@bluechaine/print-designer 0.1.0

package/dist/types/src/core/designer-utils.d.ts

@@ -0,0 +1,209 @@
+import { PluginManager } from './plugins';
+import { HistoryController } from './history';
+import { ShortcutsController } from './shortcuts';
+import type { PrintDataEditorModalHost } from './print-data-editor-modal';
+import type { DesignOptions, DesignerPrintTemplateOptions, Events, PluginOptions, Provider, ProviderMap } from '../types';
+export interface DesignerUtilsOptions {
+    connect?: boolean;
+    config?: any;
+    paperList?: import('../types').PaperType[];
+    providers?: Provider[];
+    providerMap?: ProviderMap | ProviderMap[];
+    plugins?: PluginOptions[];
+    tags?: string[];
+    templateKey?: string;
+    title?: string;
+    printData?: any;
+    events?: Events;
+    designOptions?: DesignOptions;
+}
+/**
+ * Façade exposed to Vue components & plugins. Mirrors the public API of
+ * sv-print's `DesignerUtils` so that templates and plugins port cleanly.
+ */
+export default class DesignerUtils {
+    static instance: DesignerUtils | null;
+    options: DesignerUtilsOptions;
+    printTemplate: any;
+    printData: any;
+    plugins: PluginManager;
+    history: HistoryController;
+    shortcuts: ShortcutsController;
+    /** Sub-component refs registered by Vue components on mount. */
+    ruler: any;
+    preview: any;
+    toolbar: any;
+    miniMap: any;
+    mobilePanel: any;
+    pageHistory: any;
+    editor: any;
+    printDataEditor: PrintDataEditorModalHost | null;
+    /** Reactive state shared with the UI. */
+    state: {
+        theme: string;
+        themeList: (string | {
+            theme?: string | undefined;
+            primaryColor: string;
+            primaryContent?: string | undefined;
+            secondaryColor?: string | undefined;
+            secondaryContent?: string | undefined;
+            accentColor?: string | undefined;
+            accentContent?: string | undefined;
+            neutralColor?: string | undefined;
+            neutralContent?: string | undefined;
+            base100?: string | undefined;
+            base200?: string | undefined;
+            base300?: string | undefined;
+            baseContent?: string | undefined;
+            info?: string | undefined;
+            infoContent?: string | undefined;
+            success?: string | undefined;
+            successContent?: string | undefined;
+            warning?: string | undefined;
+            warningContent?: string | undefined;
+            error?: string | undefined;
+            errorContent?: string | undefined;
+        })[];
+        lang: string;
+        zoom: number;
+        panels: {
+            draggableEls: boolean;
+            miniMap: boolean;
+            pageStructure: boolean;
+            pageHistory: boolean;
+            properties: boolean;
+        };
+        selection: {
+            count: number;
+            ids: string[];
+            elements: unknown[];
+        };
+        history: {
+            index: number;
+            total: number;
+            capacity: number;
+            canUndo: boolean;
+            canRedo: boolean;
+        };
+        isMobile: boolean;
+        uiPulse: number;
+    };
+    /** Clipboard for cut / copy / paste shortcuts. */
+    private clipboard;
+    private pasteOffsetStep;
+    private selectionEventCleanup;
+    private zoomEventCleanup;
+    /** Optional hooks set by `<Designer>` after template / print-data edits. */
+    onTemplateChange?: (json: any) => void;
+    onPrintDataChange?: (data: any) => void;
+    constructor();
+    private afterHistoryApply;
+    static getInstance(): DesignerUtils;
+    static setInstance(u: DesignerUtils): void;
+    setRuler(ruler: any): void;
+    setPreview(preview: any): void;
+    setToolBar(toolbar: any): void;
+    setMiniMap(miniMap: any): void;
+    setMobilePanel(panel: any): void;
+    setPageHistory(history: any): void;
+    setEditor(editor: any): void;
+    setPrintDataEditor(editor: PrintDataEditorModalHost | null): void;
+    setPrintData(data: any): void;
+    setPlugins(plugins?: PluginOptions[]): void;
+    setConfig(config?: any): void;
+    setConnect(connect?: boolean, _callback?: (status?: boolean, msg?: any) => void): void;
+    initProviders(providers?: Provider[]): void;
+    buildByProvider(map?: ProviderMap | ProviderMap[], _clear?: boolean): void;
+    buildByHtml(tags?: string[]): void;
+    newPrintTemplate(template: any): any;
+    newDesigner(options: DesignerPrintTemplateOptions, designOptions?: DesignOptions): any;
+    private unbindSelectionEvents;
+    private unbindZoomEvents;
+    /** Keep store/ruler in sync when hiprint paper scale changes (e.g. zoom toolbar). */
+    private bindZoomEvents;
+    private syncZoomFromTemplate;
+    private readTemplateScale;
+    /** Sync Vue selection state when hiprint selects / deselects print elements. */
+    private bindSelectionEvents;
+    refreshPrintTemplate(): void;
+    private getElementTransformParts;
+    private buildTransformValue;
+    private getTransformTarget;
+    private applyElementTransform;
+    private reapplyElementTransforms;
+    refreshSelection(): void;
+    /** Select a print element from auxiliary panels (page structure, etc.). */
+    selectPrintElement(item: any): void;
+    /** Re-apply hiprint selection UI after toolbar actions that would clear it. */
+    private restoreSelection;
+    getTemplateJson(): any;
+    private templateStorageKey;
+    save(): void;
+    loadSaved(): any | null;
+    private openJsonEditor;
+    edit(): Promise<void>;
+    editData(): Promise<void>;
+    editFunction(option: any, printElement: any, event: any): void;
+    export(): void;
+    import(): void;
+    /** Import onto existing paper(s) without creating extra panels. */
+    private applyImportTemplateJson;
+    applyTemplateJson(json: any): void;
+    getPrinterList(): any[];
+    setZoom(value: number): void;
+    getZoom(): number;
+    zoomIn(): void;
+    zoomOut(): void;
+    canZoomIn(): boolean;
+    canZoomOut(): boolean;
+    adaptToSize(): void;
+    hasSelection(): boolean;
+    /** Elements on the active design panel (shallow copy for Vue reactivity). */
+    getPageElements(): any[];
+    private getSelectedElements;
+    private getPanelElements;
+    private getExplicitZIndex;
+    private setElementZIndex;
+    private updateElementOption;
+    private getElementFontSize;
+    private resolveElementTid;
+    private serializeElement;
+    private offsetElementEntity;
+    private insertElementEntity;
+    /** Insert a new canvas element by hiprint `tid` (e.g. `defaultModule.text`). */
+    addElementByTid(tid: string, options?: {
+        left?: number;
+        top?: number;
+    }): any;
+    /** Clone a live print element using hiprint's native clone path. */
+    private duplicateElement;
+    private setElementDraggable;
+    private buildOrderWithSelectedAtEnd;
+    private buildOrderWithSelectedAtStart;
+    private syncPanelElementOrder;
+    private getPanelSizePt;
+    private getElementRect;
+    private applyElementPosition;
+    private markTemplateChanged;
+    align(side: 'left' | 'center' | 'right' | 'top' | 'middle' | 'bottom'): void;
+    private callOnSelection;
+    moveZ(action: 'top' | 'up' | 'down' | 'bottom'): void;
+    flip(axis: 'h' | 'v'): void;
+    changeFont(delta: number): void;
+    setBold(bold: boolean): void;
+    isSelectionLocked(): boolean;
+    isSelectionUnlocked(): boolean;
+    setLock(locked: boolean): void;
+    clone(): void;
+    copy(): void;
+    cut(): void;
+    paste(): void;
+    delete(): void;
+    /** Delete a single element from the structure panel or other auxiliary UI. */
+    deletePrintElement(item: any): void;
+    rotate(deg?: number): void;
+    clearPanel(): void;
+    private bindShortcuts;
+}
+/** Reactive wrapper, so consumers can `import { utils }` and read state. */
+export declare const reactiveDesignerUtils: () => DesignerUtils;

package/dist/types/src/core/hiprint-bridge.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Thin wrapper around `vue-plugin-hiprint` so the rest of the codebase
+ * only needs to touch a stable surface.
+ */
+import { hiprint, defaultElementTypeProvider } from 'vue-plugin-hiprint';
+import type { PaperType, Provider } from '../types';
+export interface InitOptions {
+    providers?: Provider[];
+    autoConnect?: boolean;
+    config?: any;
+    paperList?: PaperType[];
+    onPaperApplied?: (tpl: any) => void;
+}
+/**
+ * Initialise hiprint with at least one provider. Idempotent.
+ */
+export declare function initHiprint(options?: InitOptions): typeof hiprint;
+/**
+ * Bind a selector list (e.g. `.ep-draggable-item`) into hiprint so the
+ * elements become draggable. `vue-plugin-hiprint` exposes this via
+ * `PrintElementTypeManager.buildByHtml`.
+ */
+export declare function buildByHtml(selectors: string[] | string): void;
+export { hiprint, defaultElementTypeProvider };

package/dist/types/src/core/hiprint-paper-list.d.ts

@@ -0,0 +1,20 @@
+import type { PaperType } from '../types';
+export interface PaperListValue {
+    type: string;
+    width: number;
+    height: number;
+}
+export declare function registerPrintTemplate(tpl: any): void;
+export declare function nearMm(a: number, b: number, eps?: number): boolean;
+export declare function detectPaperType(width: number, height: number, list?: PaperType[]): string;
+export declare function getTemplatePaperList(tpl?: any): PaperType[];
+export declare function applyPaperList(tpl: any, value: PaperListValue, onApplied?: () => void): void;
+export declare function applyPanelBackgroundColor(panel: any, color?: string): void;
+/**
+ * Register paper-list panel options into hiprint (sv-print compatible).
+ * Call once during hiprint init.
+ */
+export declare function setupHiprintPaperList(paperList?: PaperType[], onPaperApplied?: (tpl: any) => void): void;
+export declare function assignTemplatePaperList(tpl: any, paperList?: PaperType[]): void;
+/** Open panel-level hiprint settings (same as clicking blank paper). */
+export declare function openPanelSetting(): void;

package/dist/types/src/core/history-labels.d.ts

@@ -0,0 +1,8 @@
+/** Canonical history labels stored in hiprint `historyList[].type`. */
+export declare const HISTORY_MOVE = "\u79FB\u52A8";
+export declare const HISTORY_ALIGN = "\u5143\u7D20\u5BF9\u9F50";
+export declare const HISTORY_PARAM = "\u53C2\u6570\u4FEE\u6539";
+export declare const HISTORY_INITIAL = "\u521D\u59CB";
+export declare const HISTORY_ZOOM = "\u7F29\u653E";
+/** Map hiprint / toolbar raw types to one of the three user-facing categories. */
+export declare function normalizeHistoryLabel(type: string | undefined): string;

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

@@ -0,0 +1,24 @@
+export interface HistoryStep {
+    index: number;
+    type: string;
+    label: string;
+    json?: unknown;
+}
+export type HistoryChangedHook = () => void;
+export declare class HistoryController {
+    private getTpl;
+    private onChanged?;
+    steps: HistoryStep[];
+    constructor(getTemplate: () => any, onChanged?: HistoryChangedHook);
+    private applySnapshot;
+    refreshFromTemplate(): void;
+    canUndo(): boolean;
+    canRedo(): boolean;
+    undo(): void;
+    redo(): void;
+    jump(index: number): void;
+    clear(): void;
+    /** Remove one history entry. Index 0 (initial) cannot be deleted. */
+    remove(index: number): void;
+    private finishChange;
+}

package/dist/types/src/core/json-editor-modal.d.ts

@@ -0,0 +1,15 @@
+export interface JsonEditorModalOptions {
+    title: string;
+    value: unknown;
+    confirmText?: string;
+    cancelText?: string;
+    invalidText?: string;
+    clearText?: string;
+    copyText?: string;
+    variant?: 'template' | 'default';
+}
+export type JsonEditorModalHost = {
+    open: (options: JsonEditorModalOptions) => Promise<unknown | null>;
+};
+/** Imperative fallback when Vue host is unavailable. */
+export declare function openJsonEditorModal(options: JsonEditorModalOptions): Promise<unknown | null>;

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

@@ -0,0 +1,17 @@
+import type { Hook, PluginOptions } from '../types';
+/**
+ * Hook manager: stores plugin-provided callbacks keyed by hook name,
+ * runs them sequentially in priority order.
+ */
+export declare class PluginManager {
+    private hooks;
+    private plugins;
+    setPlugins(plugins?: PluginOptions[]): void;
+    register(plugin: PluginOptions): void;
+    list(): PluginOptions[];
+    has(hook: Hook): boolean;
+    /** Run all callbacks sequentially. Returns the array of results. */
+    run(hook: Hook, ...args: any[]): Promise<unknown[]>;
+    /** Synchronous variant — useful for shortcut handlers that must return quickly. */
+    runSync(hook: Hook, ...args: any[]): unknown[];
+}

package/dist/types/src/core/preview-html.d.ts

@@ -0,0 +1,2 @@
+/** Normalize hiprint `getHtml()` output (jQuery / array-like) to an HTML string. */
+export declare function resolvePreviewHtml(value: unknown): string;

package/dist/types/src/core/print-data-editor-modal.d.ts

@@ -0,0 +1,19 @@
+import type { TemplateFieldSchema } from './template-fields';
+export interface PrintDataEditorModalOptions {
+    title: string;
+    schema: TemplateFieldSchema;
+    value: Record<string, unknown>;
+    confirmText?: string;
+    cancelText?: string;
+    clearText?: string;
+    copyText?: string;
+    basicSectionTitle?: string;
+    tableSectionTitle?: string;
+    emptyHint?: string;
+    addRowText?: string;
+    deleteRowText?: string;
+    tableFieldLabel?: string;
+}
+export type PrintDataEditorModalHost = {
+    open: (options: PrintDataEditorModalOptions) => Promise<Record<string, unknown> | null>;
+};

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

@@ -0,0 +1,5 @@
+import type { Provider, ProviderMap } from '../types';
+export { defaultElementTypeProvider } from 'vue-plugin-hiprint';
+export { SvpElementTypeProvider } from './svp-element-provider';
+export declare function ensureProviders(providers?: Provider[]): Provider[];
+export declare function normalizeProviderMap(map?: ProviderMap | ProviderMap[]): ProviderMap[];

package/dist/types/src/core/register-icons.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,20 @@
+export interface ShortcutBinding {
+    combo: string;
+    description?: string;
+    run: (e: KeyboardEvent) => void | boolean;
+}
+export interface ShortcutOptions {
+    /** Receives every keydown event before bindings are evaluated; return false to block. */
+    beforeDispatch?: (e: KeyboardEvent) => boolean | void;
+}
+export declare class ShortcutsController {
+    private bindings;
+    private handler;
+    private options;
+    constructor(options?: ShortcutOptions);
+    add(binding: ShortcutBinding | ShortcutBinding[]): void;
+    remove(combo: string): void;
+    list(): ShortcutBinding[];
+    mount(): void;
+    unmount(): void;
+}

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

@@ -0,0 +1,3 @@
+export declare function readJSON<T = unknown>(key: string, fallback: T): T;
+export declare function writeJSON(key: string, value: unknown): void;
+export declare function removeKey(key: string): void;

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

@@ -0,0 +1,77 @@
+import { type Ref } from 'vue-demi';
+export interface PanelVisibility {
+    draggableEls: boolean;
+    miniMap: boolean;
+    pageStructure: boolean;
+    pageHistory: boolean;
+    properties: boolean;
+}
+export interface SelectionInfo {
+    count: number;
+    ids: string[];
+    /** Active hiprint elements. */
+    elements: unknown[];
+}
+export interface HistoryInfo {
+    index: number;
+    total: number;
+    capacity: number;
+    canUndo: boolean;
+    canRedo: boolean;
+}
+export declare const designerStore: {
+    theme: string;
+    themeList: (string | {
+        theme?: string | undefined;
+        primaryColor: string;
+        primaryContent?: string | undefined;
+        secondaryColor?: string | undefined;
+        secondaryContent?: string | undefined;
+        accentColor?: string | undefined;
+        accentContent?: string | undefined;
+        neutralColor?: string | undefined;
+        neutralContent?: string | undefined;
+        base100?: string | undefined;
+        base200?: string | undefined;
+        base300?: string | undefined;
+        baseContent?: string | undefined;
+        info?: string | undefined;
+        infoContent?: string | undefined;
+        success?: string | undefined;
+        successContent?: string | undefined;
+        warning?: string | undefined;
+        warningContent?: string | undefined;
+        error?: string | undefined;
+        errorContent?: string | undefined;
+    })[];
+    lang: string;
+    zoom: number;
+    panels: {
+        draggableEls: boolean;
+        miniMap: boolean;
+        pageStructure: boolean;
+        pageHistory: boolean;
+        properties: boolean;
+    };
+    selection: {
+        count: number;
+        ids: string[];
+        elements: unknown[];
+    };
+    history: {
+        index: number;
+        total: number;
+        capacity: number;
+        canUndo: boolean;
+        canRedo: boolean;
+    };
+    isMobile: boolean;
+    uiPulse: number;
+};
+export type DesignerStore = typeof designerStore;
+export declare const designerStoreRef: Ref<DesignerStore>;
+export declare function setZoom(value: number): void;
+export declare function setPanelVisibility(key: keyof PanelVisibility, show: boolean): void;
+export declare function togglePanel(key: keyof PanelVisibility): void;
+export declare function toggleAllPanels(forceShow?: boolean): void;
+export declare function setSelection(info: Partial<SelectionInfo>): void;

package/dist/types/src/core/svp-element-provider.d.ts

@@ -0,0 +1,8 @@
+import { Provider } from '../types';
+/**
+ * Hiprint provider: built-in element types, with `defaultModule.table`
+ * replaced by the project default table layout (`template.json`).
+ */
+export declare class SvpElementTypeProvider extends Provider {
+    addElementTypes(context: any): void;
+}

package/dist/types/src/core/template-fields.d.ts

@@ -0,0 +1,28 @@
+export interface BasicFieldDef {
+    field: string;
+    label: string;
+    testData?: string;
+}
+export interface TableColumnDef {
+    field: string;
+    label: string;
+}
+export interface TableFieldDef {
+    /** Print data key, e.g. `table`. */
+    field: string;
+    label: string;
+    columns: TableColumnDef[];
+}
+export interface TemplateFieldSchema {
+    basicFields: BasicFieldDef[];
+    tables: TableFieldDef[];
+}
+/** Extract bindable fields from a hiprint template JSON. */
+export declare function extractTemplateFields(template: unknown): TemplateFieldSchema;
+export declare function createEmptyTableRow(columns: TableColumnDef[]): Record<string, string>;
+export declare function normalizeTableRows(value: unknown, columns: TableColumnDef[]): Record<string, string>[];
+export declare function buildPrintDataFromForm(schema: TemplateFieldSchema, basicValues: Record<string, string>, tableValues: Record<string, Record<string, string>[]>, existing?: Record<string, unknown>): Record<string, unknown>;
+export declare function createPrintDataFormState(schema: TemplateFieldSchema, printData?: Record<string, unknown>): {
+    basicValues: Record<string, string>;
+    tableValues: Record<string, Record<string, string>[]>;
+};

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

@@ -0,0 +1 @@
+export declare function injectThemes(theme: unknown): void;

package/dist/types/src/i18n/en-US.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/i18n/index.d.ts

@@ -0,0 +1,12 @@
+import type { Lang } from '../types';
+type Dict = Record<string, any>;
+export declare function setLocale(lang: Lang, messages?: Dict): void;
+export declare function getLocaleList(): Lang[];
+export declare function useI18n(): {
+    t: (key: string, fallback?: string) => string;
+    lang: import("vue").ComputedRef<Lang>;
+    setLocale: typeof setLocale;
+};
+/** Non-component i18n lookup (core utilities, modals, etc.). */
+export declare function translate(key: string, fallback?: string): string;
+export {};