hprint-designer 0.1.0

package/README.md

@@ -0,0 +1,45 @@
+# hprint-designer
+
+A Vue 2 print-template designer wrapping [vue-plugin-hiprint](https://github.com/CcSimple/vue-plugin-hiprint) — for designing paper scenic-ticket & invitation print templates, with custom fonts, field-schema third-party binding, and Electron silent-print client detection.
+
+## Install
+
+```bash
+npm install hprint-designer
+# or taobao mirror:
+cnpm install hprint-designer
+```
+
+Peer dependencies: `vue@^2.6.0`, `ant-design-vue@^1.7.2`.
+
+## Usage
+
+```js
+import Vue from 'vue'
+import HPrintDesigner from 'hprint-designer'
+import 'hprint-designer/dist/style.css'
+
+Vue.use(HPrintDesigner, { baseURL: 'https://your-server/api' })
+```
+
+```html
+<print-designer
+  :template-id="id"
+  host="http://localhost:17521"
+  @save="onSave"
+  @print="onPrint" />
+```
+
+## Backend contract
+
+Implement a REST backend matching `BackendAdapter`. See `src/contract/adapter.ts`:
+
+- `GET/POST/PUT/DELETE /templates` (PUT uses `If-Match` header for optimistic lock)
+- `GET/POST/DELETE /fonts`, `PUT /fonts/:id`
+- `GET /client-release` — returns `{ officialUrl, selfHostedUrl?, minCompatibleVersion, ... }` for the Electron client download guide.
+
+## License
+
+MIT. This library depends on `vue-plugin-hiprint` (hiprint 2.5.4, LGPL). The library
+references hiprint as a class library without modifying its source, per the LGPL
+class-library exemption. See hiprint's LICENSE for its terms.

package/dist/adapters/http.d.ts

@@ -0,0 +1,7 @@
+export interface HttpOptions {
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    body?: any;
+    headers?: Record<string, string>;
+    signal?: AbortSignal;
+}
+export declare function http(baseURL: string, path: string, opts?: HttpOptions): Promise<any>;

package/dist/adapters/mock.d.ts

@@ -0,0 +1,33 @@
+import { BackendAdapter } from '../contract/adapter';
+import { PrintTemplate, NewPrintTemplate, PrintFont, ClientRelease } from '../contract/types';
+
+export declare class MockAdapter implements BackendAdapter {
+    private templates;
+    private fonts;
+    listTemplates(filter?: {
+        keyword?: string;
+        [k: string]: any;
+    }): Promise<{
+        items: PrintTemplate[];
+        total: number;
+    }>;
+    getTemplate(id: string): Promise<PrintTemplate>;
+    createTemplate(input: NewPrintTemplate): Promise<PrintTemplate>;
+    updateTemplate(id: string, patch: Partial<PrintTemplate>, ifVersion?: number): Promise<PrintTemplate>;
+    deleteTemplate(id: string): Promise<void>;
+    listFonts(): Promise<PrintFont[]>;
+    uploadFont(file: File | File[], meta: {
+        name: string;
+        family: string;
+    }): Promise<PrintFont>;
+    updateFont(id: string, patch: Partial<Pick<PrintFont, 'name' | 'family'>>): Promise<{
+        name: string;
+        family: string;
+        id: string;
+        files: import('../contract/types').FontFile[];
+        uploader?: string | undefined;
+        createdAt: string;
+    }>;
+    deleteFont(id: string): Promise<void>;
+    getClientRelease(): Promise<ClientRelease>;
+}

package/dist/adapters/rest.d.ts

@@ -0,0 +1,29 @@
+import { BackendAdapter } from '../contract/adapter';
+import { PrintTemplate, NewPrintTemplate, PrintFont, ClientRelease } from '../contract/types';
+
+export interface RestAdapterOptions {
+    baseURL: string;
+}
+export declare class RestAdapter implements BackendAdapter {
+    private opts;
+    constructor(opts: RestAdapterOptions);
+    listTemplates(filter?: {
+        keyword?: string;
+        [k: string]: any;
+    }): Promise<{
+        items: PrintTemplate[];
+        total: number;
+    }>;
+    getTemplate(id: string): Promise<PrintTemplate>;
+    createTemplate(input: NewPrintTemplate): Promise<PrintTemplate>;
+    updateTemplate(id: string, patch: Partial<PrintTemplate>, ifVersion?: number): Promise<PrintTemplate>;
+    deleteTemplate(id: string): Promise<void>;
+    listFonts(): Promise<PrintFont[]>;
+    uploadFont(file: File | File[], meta: {
+        name: string;
+        family: string;
+    }): Promise<PrintFont>;
+    updateFont(id: string, patch: Partial<Pick<PrintFont, 'name' | 'family'>>): Promise<PrintFont>;
+    deleteFont(id: string): Promise<void>;
+    getClientRelease(): Promise<ClientRelease>;
+}

package/dist/client/detection.d.ts

@@ -0,0 +1,4 @@
+import { PrintClientInfo } from '../contract/types';
+
+export declare function isClientOpen(): boolean;
+export declare function getClientInfo(): PrintClientInfo;

package/dist/client/platform.d.ts

@@ -0,0 +1,2 @@
+export type Platform = 'win' | 'mac' | 'linux';
+export declare function detectPlatform(userAgentPlatform?: string): Platform;

package/dist/client/version.d.ts

@@ -0,0 +1,2 @@
+export declare function compareVersions(a: string, b: string): number;
+export declare function isVersionBelow(version: string, min: string): boolean;

package/dist/contract/adapter.d.ts

@@ -0,0 +1,23 @@
+import { PrintTemplate, NewPrintTemplate, PrintFont, ClientRelease } from './types';
+
+export interface BackendAdapter {
+    listTemplates(filter?: {
+        keyword?: string;
+        [k: string]: any;
+    }): Promise<{
+        items: PrintTemplate[];
+        total: number;
+    }>;
+    getTemplate(id: string): Promise<PrintTemplate>;
+    createTemplate(input: NewPrintTemplate): Promise<PrintTemplate>;
+    updateTemplate(id: string, patch: Partial<PrintTemplate>, ifVersion?: number): Promise<PrintTemplate>;
+    deleteTemplate(id: string): Promise<void>;
+    listFonts(): Promise<PrintFont[]>;
+    uploadFont(file: File | File[], meta: {
+        name: string;
+        family: string;
+    }): Promise<PrintFont>;
+    updateFont(id: string, patch: Partial<Pick<PrintFont, 'name' | 'family'>>): Promise<PrintFont>;
+    deleteFont(id: string): Promise<void>;
+    getClientRelease(): Promise<ClientRelease>;
+}

package/dist/contract/types.d.ts

@@ -0,0 +1,63 @@
+export type FieldType = 'string' | 'number' | 'date' | 'datetime' | 'image' | 'qrcode' | 'barcode' | 'longtext';
+export interface FieldSchema {
+    key: string;
+    label: string;
+    type: FieldType;
+    required?: boolean;
+    group?: string;
+    sample: any;
+    formatter?: string;
+    enum?: {
+        label: string;
+        value: any;
+    }[];
+    description?: string;
+}
+export interface PrintTemplate {
+    id: string;
+    name: string;
+    paper?: {
+        widthMm: number;
+        heightMm: number;
+        orientation?: 'portrait' | 'landscape';
+    };
+    panels: any[];
+    fields: FieldSchema[];
+    status: 'draft' | 'published';
+    version: number;
+    updatedAt: string;
+    updatedBy?: string;
+}
+export type NewPrintTemplate = Omit<PrintTemplate, 'id' | 'version' | 'updatedAt'>;
+export interface FontFile {
+    format: 'woff2' | 'woff' | 'ttf';
+    url: string;
+    size?: number;
+}
+export interface PrintFont {
+    id: string;
+    name: string;
+    family: string;
+    files: FontFile[];
+    uploader?: string;
+    createdAt: string;
+}
+export interface PrintClientInfo {
+    opened: boolean;
+    hostname?: string;
+    version?: string;
+    platform?: string;
+    mac?: string;
+    ip?: string;
+    clientUrl?: string;
+    nickName?: string;
+}
+export interface ClientRelease {
+    version: string;
+    officialUrl: string;
+    selfHostedUrl?: string;
+    minCompatibleVersion: string;
+    releaseNotes?: string;
+    os?: string[];
+    publishedAt: string;
+}

package/dist/core/facade.d.ts

@@ -0,0 +1,15 @@
+import { BackendAdapter } from '../contract/adapter';
+
+export interface HPrintDesignerOptions {
+    adapter?: BackendAdapter;
+    host?: string;
+    token?: string;
+    lang?: 'cn' | 'en' | 'de' | 'es' | 'fr' | 'it' | 'ja' | 'ru' | 'cn_tw';
+}
+export declare class HPrintDesigner {
+    private _hiprint;
+    private opts;
+    constructor(opts?: HPrintDesignerOptions);
+    load(): Promise<any>;
+    get raw(): any;
+}

package/dist/core/plugin.d.ts

@@ -0,0 +1,11 @@
+import { HPrintDesignerOptions } from './facade';
+import { BackendAdapter } from '../contract/adapter';
+
+export interface PluginOptions extends HPrintDesignerOptions {
+    componentName?: string;
+    baseURL?: string;
+    adapter?: BackendAdapter;
+}
+export declare const HprintPlugin: {
+    install(Vue: any, options?: PluginOptions): void;
+};

package/dist/core/print-lock-inject.d.ts

@@ -0,0 +1,2 @@
+export declare const PRINT_LOCK_LINK_ID = "hprint-print-lock";
+export declare function injectPrintLockCss(): void;

package/dist/designer/provider.d.ts

@@ -0,0 +1,10 @@
+export interface DragItem {
+    tid: string;
+    label: string;
+    icon: string;
+}
+export interface DragGroup {
+    title: string;
+    items: DragItem[];
+}
+export declare function getDragGroups(): DragGroup[];

package/dist/fields/formatters.d.ts

@@ -0,0 +1,6 @@
+export interface FormatterPreset {
+    label: string;
+    value: string;
+}
+export declare function getFormatterPresets(): FormatterPreset[];
+export declare function resolveFormatter(name?: string): (v: any) => string;

package/dist/fields/sample-data.d.ts

@@ -0,0 +1,3 @@
+import { FieldSchema } from '../contract/types';
+
+export declare function buildPreviewData(fields: FieldSchema[]): Record<string, any>;

package/dist/fonts/font-face.d.ts

@@ -0,0 +1,8 @@
+import { PrintFont } from '../contract/types';
+
+export declare function buildFontFaceCss(fonts: PrintFont[]): string;
+export declare function buildStyleHandlerCss(fonts: PrintFont[]): string;
+export declare function toHiprintFontList(fonts: PrintFont[]): {
+    title: string;
+    value: string;
+}[];

package/dist/fonts/font-manager.d.ts

@@ -0,0 +1,7 @@
+import { PrintFont } from '../contract/types';
+
+export declare class FontManager {
+    private el;
+    inject(fonts: PrintFont[]): void;
+    cleanup(): void;
+}