@m430/capacitor-label-printer 0.1.0

package/dist/docs.json

@@ -0,0 +1,443 @@
+{
+  "api": {
+    "name": "LabelPrinterPlugin",
+    "slug": "labelprinterplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "isSupported",
+        "signature": "() => Promise<{ supported: boolean; }>",
+        "parameters": [],
+        "returns": "Promise<{ supported: boolean; }>",
+        "tags": [],
+        "docs": "判断当前运行环境是否支持原生标签打印。",
+        "complexTypes": [],
+        "slug": "issupported"
+      },
+      {
+        "name": "checkPermissions",
+        "signature": "() => Promise<PrinterPermissionResult>",
+        "parameters": [],
+        "returns": "Promise<PrinterPermissionResult>",
+        "tags": [],
+        "docs": "查询当前蓝牙访问权限状态。",
+        "complexTypes": [
+          "PrinterPermissionResult"
+        ],
+        "slug": "checkpermissions"
+      },
+      {
+        "name": "ensurePermissions",
+        "signature": "() => Promise<PrinterPermissionResult>",
+        "parameters": [],
+        "returns": "Promise<PrinterPermissionResult>",
+        "tags": [],
+        "docs": "确保蓝牙访问权限已就绪。",
+        "complexTypes": [
+          "PrinterPermissionResult"
+        ],
+        "slug": "ensurepermissions"
+      },
+      {
+        "name": "discoverDevices",
+        "signature": "(options?: DiscoverDevicesOptions | undefined) => Promise<{ devices: PrinterDevice[]; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "DiscoverDevicesOptions | undefined"
+          }
+        ],
+        "returns": "Promise<{ devices: PrinterDevice[]; }>",
+        "tags": [],
+        "docs": "发现可用于连接的打印机列表。",
+        "complexTypes": [
+          "PrinterDevice",
+          "DiscoverDevicesOptions"
+        ],
+        "slug": "discoverdevices"
+      },
+      {
+        "name": "connect",
+        "signature": "(options: ConnectOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ConnectOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "连接指定打印机。",
+        "complexTypes": [
+          "ConnectOptions"
+        ],
+        "slug": "connect"
+      },
+      {
+        "name": "disconnect",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "断开当前打印机连接。",
+        "complexTypes": [],
+        "slug": "disconnect"
+      },
+      {
+        "name": "getConnectionState",
+        "signature": "() => Promise<{ state: PrinterConnectionState; }>",
+        "parameters": [],
+        "returns": "Promise<{ state: PrinterConnectionState; }>",
+        "tags": [],
+        "docs": "查询当前连接状态。",
+        "complexTypes": [
+          "PrinterConnectionState"
+        ],
+        "slug": "getconnectionstate"
+      },
+      {
+        "name": "print",
+        "signature": "(options: PrintOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PrintOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "发送原始打印负载到打印机。",
+        "complexTypes": [
+          "PrintOptions"
+        ],
+        "slug": "print"
+      },
+      {
+        "name": "getStatus",
+        "signature": "() => Promise<PrinterStatus>",
+        "parameters": [],
+        "returns": "Promise<PrinterStatus>",
+        "tags": [],
+        "docs": "查询当前打印机状态。",
+        "complexTypes": [
+          "PrinterStatus"
+        ],
+        "slug": "getstatus"
+      },
+      {
+        "name": "openAppSettings",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "跳转到应用系统设置页。",
+        "complexTypes": [],
+        "slug": "openappsettings"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "PrinterPermissionResult",
+      "slug": "printerpermissionresult",
+      "docs": "插件统一输出的权限状态。",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "granted",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "canPrompt",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "shouldOpenSettings",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "permissions",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "PermissionState"
+          ],
+          "type": "{ bluetoothConnect?: PermissionState | undefined; bluetoothScan?: PermissionState | undefined; bluetooth?: PermissionState | undefined; }"
+        }
+      ]
+    },
+    {
+      "name": "PrinterDevice",
+      "slug": "printerdevice",
+      "docs": "扫描或枚举到的标签打印机设备。",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "name",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "address",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "transport",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "PrinterTransport"
+          ],
+          "type": "PrinterTransport"
+        },
+        {
+          "name": "bonded",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "rssi",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "DiscoverDevicesOptions",
+      "slug": "discoverdevicesoptions",
+      "docs": "发现设备时使用的过滤参数。",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "timeout",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "namePrefixes",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string[] | undefined"
+        }
+      ]
+    },
+    {
+      "name": "ConnectOptions",
+      "slug": "connectoptions",
+      "docs": "连接指定设备时使用的参数。",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "deviceId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "PrintOptions",
+      "slug": "printoptions",
+      "docs": "打印任务参数。",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "payload",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "language",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "PrinterLanguage"
+          ],
+          "type": "PrinterLanguage"
+        },
+        {
+          "name": "copies",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PrinterStatus",
+      "slug": "printerstatus",
+      "docs": "插件统一输出的打印机状态。",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "connected",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "ready",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "paperOut",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "coverOpen",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "overheating",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "message",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "raw",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "unknown"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "PermissionState",
+      "slug": "permissionstate",
+      "docs": "",
+      "types": [
+        {
+          "text": "\"denied\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"granted\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"prompt\"",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "PrinterTransport",
+      "slug": "printertransport",
+      "docs": "插件内部约定的连接通道类型。",
+      "types": [
+        {
+          "text": "'classic'",
+          "complexTypes": []
+        },
+        {
+          "text": "'ble'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "PrinterConnectionState",
+      "slug": "printerconnectionstate",
+      "docs": "统一连接状态枚举。",
+      "types": [
+        {
+          "text": "'disconnected'",
+          "complexTypes": []
+        },
+        {
+          "text": "'connecting'",
+          "complexTypes": []
+        },
+        {
+          "text": "'connected'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "PrinterLanguage",
+      "slug": "printerlanguage",
+      "docs": "打印负载的协议类型。",
+      "types": [
+        {
+          "text": "'tspl'",
+          "complexTypes": []
+        },
+        {
+          "text": "'cpcl'",
+          "complexTypes": []
+        },
+        {
+          "text": "'raw'",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}

package/dist/esm/cpcl/builder.d.ts

@@ -0,0 +1,10 @@
+export declare class CpclBuilder {
+    private readonly lines;
+    page(height: number, copies?: number, offset?: number, horizontalDpi?: number, verticalDpi?: number): this;
+    pageWidth(width: number): this;
+    text(font: number, rotation: number, x: number, y: number, value: string): this;
+    barcode128(x: number, y: number, height: number, value: string, narrow?: number, wide?: number): this;
+    form(): this;
+    print(): this;
+    build(): string;
+}

package/dist/esm/cpcl/builder.js

@@ -0,0 +1,35 @@
+function escapeCpclText(value) {
+    return value.replace(/[\r\n]+/g, ' ').trim();
+}
+export class CpclBuilder {
+    constructor() {
+        this.lines = [];
+    }
+    page(height, copies = 1, offset = 0, horizontalDpi = 200, verticalDpi = 200) {
+        this.lines.push(`! ${offset} ${horizontalDpi} ${verticalDpi} ${height} ${copies}`);
+        return this;
+    }
+    pageWidth(width) {
+        this.lines.push(`PAGE-WIDTH ${width}`);
+        return this;
+    }
+    text(font, rotation, x, y, value) {
+        this.lines.push(`TEXT ${font} ${rotation} ${x} ${y} ${escapeCpclText(value)}`);
+        return this;
+    }
+    barcode128(x, y, height, value, narrow = 1, wide = 1) {
+        this.lines.push(`BARCODE 128 ${narrow} ${wide} ${height} ${x} ${y} ${escapeCpclText(value)}`);
+        return this;
+    }
+    form() {
+        this.lines.push('FORM');
+        return this;
+    }
+    print() {
+        this.lines.push('PRINT');
+        return this;
+    }
+    build() {
+        return `${this.lines.join('\n')}\n`;
+    }
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,107 @@
+import type { PermissionState } from '@capacitor/core';
+import type { PrinterConnectionState, PrinterLanguage, PrinterTransport } from './types';
+/**
+ * 扫描或枚举到的标签打印机设备。
+ */
+export interface PrinterDevice {
+    id: string;
+    name: string;
+    address?: string;
+    transport: PrinterTransport;
+    bonded?: boolean;
+    rssi?: number;
+}
+/**
+ * 发现设备时使用的过滤参数。
+ */
+export interface DiscoverDevicesOptions {
+    timeout?: number;
+    namePrefixes?: string[];
+}
+/**
+ * 连接指定设备时使用的参数。
+ */
+export interface ConnectOptions {
+    deviceId: string;
+}
+/**
+ * 打印任务参数。
+ */
+export interface PrintOptions {
+    payload: string;
+    language?: PrinterLanguage;
+    copies?: number;
+}
+/**
+ * 插件统一输出的打印机状态。
+ */
+export interface PrinterStatus {
+    connected: boolean;
+    ready?: boolean;
+    paperOut?: boolean;
+    coverOpen?: boolean;
+    overheating?: boolean;
+    message?: string;
+    raw?: unknown;
+}
+/**
+ * 插件统一输出的权限状态。
+ */
+export interface PrinterPermissionResult {
+    granted: boolean;
+    canPrompt: boolean;
+    shouldOpenSettings: boolean;
+    permissions: {
+        bluetoothConnect?: PermissionState;
+        bluetoothScan?: PermissionState;
+        bluetooth?: PermissionState;
+    };
+}
+export interface LabelPrinterPlugin {
+    /**
+     * 判断当前运行环境是否支持原生标签打印。
+     */
+    isSupported(): Promise<{
+        supported: boolean;
+    }>;
+    /**
+     * 查询当前蓝牙访问权限状态。
+     */
+    checkPermissions(): Promise<PrinterPermissionResult>;
+    /**
+     * 确保蓝牙访问权限已就绪。
+     */
+    ensurePermissions(): Promise<PrinterPermissionResult>;
+    /**
+     * 发现可用于连接的打印机列表。
+     */
+    discoverDevices(options?: DiscoverDevicesOptions): Promise<{
+        devices: PrinterDevice[];
+    }>;
+    /**
+     * 连接指定打印机。
+     */
+    connect(options: ConnectOptions): Promise<void>;
+    /**
+     * 断开当前打印机连接。
+     */
+    disconnect(): Promise<void>;
+    /**
+     * 查询当前连接状态。
+     */
+    getConnectionState(): Promise<{
+        state: PrinterConnectionState;
+    }>;
+    /**
+     * 发送原始打印负载到打印机。
+     */
+    print(options: PrintOptions): Promise<void>;
+    /**
+     * 查询当前打印机状态。
+     */
+    getStatus(): Promise<PrinterStatus>;
+    /**
+     * 跳转到应用系统设置页。
+     */
+    openAppSettings(): Promise<void>;
+}

package/dist/esm/definitions.js

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

package/dist/esm/errors.d.ts

@@ -0,0 +1 @@
+export declare const UNSUPPORTED_WEB_ERROR = "Label printing is not supported on web.";

package/dist/esm/errors.js

@@ -0,0 +1 @@
+export const UNSUPPORTED_WEB_ERROR = 'Label printing is not supported on web.';

package/dist/esm/index.d.ts

@@ -0,0 +1,9 @@
+import type { LabelPrinterPlugin } from './definitions';
+declare const LabelPrinter: LabelPrinterPlugin;
+export * from './definitions';
+export * from './errors';
+export * from './types';
+export * from './cpcl/builder';
+export * from './tspl/builder';
+export * from './tspl/helpers';
+export { LabelPrinter };

package/dist/esm/index.js

@@ -0,0 +1,11 @@
+import { registerPlugin } from '@capacitor/core';
+const LabelPrinter = registerPlugin('LabelPrinter', {
+    web: () => import('./web').then(m => new m.LabelPrinterWeb())
+});
+export * from './definitions';
+export * from './errors';
+export * from './types';
+export * from './cpcl/builder';
+export * from './tspl/builder';
+export * from './tspl/helpers';
+export { LabelPrinter };

package/dist/esm/tspl/builder.d.ts

@@ -0,0 +1,13 @@
+export declare class TsplBuilder {
+    private readonly lines;
+    sizeMm(width: number, height: number): this;
+    gapMm(gap: number, offset: number): this;
+    density(level: number): this;
+    speed(level: number): this;
+    cls(): this;
+    text(x: number, y: number, font: string, rotation: number, xScale: number, yScale: number, value: string): this;
+    barcode128(x: number, y: number, height: number, value: string): this;
+    qrcode(x: number, y: number, cellWidth: number, value: string): this;
+    printCopies(copies: number): this;
+    build(): string;
+}

package/dist/esm/tspl/builder.js

@@ -0,0 +1,45 @@
+import { escapeTsplText } from './helpers';
+export class TsplBuilder {
+    constructor() {
+        this.lines = [];
+    }
+    sizeMm(width, height) {
+        this.lines.push(`SIZE ${width} mm,${height} mm`);
+        return this;
+    }
+    gapMm(gap, offset) {
+        this.lines.push(`GAP ${gap} mm,${offset} mm`);
+        return this;
+    }
+    density(level) {
+        this.lines.push(`DENSITY ${level}`);
+        return this;
+    }
+    speed(level) {
+        this.lines.push(`SPEED ${level}`);
+        return this;
+    }
+    cls() {
+        this.lines.push('CLS');
+        return this;
+    }
+    text(x, y, font, rotation, xScale, yScale, value) {
+        this.lines.push(`TEXT ${x},${y},"${font}",${rotation},${xScale},${yScale},"${escapeTsplText(value)}"`);
+        return this;
+    }
+    barcode128(x, y, height, value) {
+        this.lines.push(`BARCODE ${x},${y},"128",${height},1,0,2,2,"${escapeTsplText(value)}"`);
+        return this;
+    }
+    qrcode(x, y, cellWidth, value) {
+        this.lines.push(`QRCODE ${x},${y},L,${cellWidth},A,0,"${escapeTsplText(value)}"`);
+        return this;
+    }
+    printCopies(copies) {
+        this.lines.push(`PRINT 1,${copies}`);
+        return this;
+    }
+    build() {
+        return `${this.lines.join('\n')}\n`;
+    }
+}

package/dist/esm/tspl/helpers.d.ts

@@ -0,0 +1,2 @@
+export declare function mmToDots(mm: number, dpi?: number): number;
+export declare function escapeTsplText(value: string): string;

package/dist/esm/tspl/helpers.js

@@ -0,0 +1,6 @@
+export function mmToDots(mm, dpi = 203) {
+    return Math.round((mm / 25.4) * dpi);
+}
+export function escapeTsplText(value) {
+    return value.replace(/"/g, '\\"');
+}