libniimai 0.5.0 → 0.7.0

package/dist/routed.d.ts

@@ -0,0 +1,54 @@
+import type { ClientLike } from './client.js';
+/**
+ * A client that picks the real client when it connects, then passes
+ * everything through to it: the Bluetooth and USB printers behind the
+ * Connect buttons.
+ */
+export declare abstract class RoutedClient implements ClientLike {
+    protected inner: ClientLike | null;
+    abstract connect(): Promise<{
+        deviceName?: string;
+    }>;
+    protected get client(): ClientLike;
+    disconnect(): Promise<void>;
+    isConnected(): boolean;
+    on(event: string, fn: (e: any) => void): unknown;
+    off(event: string, fn: (e: any) => void): unknown;
+    getPrinterInfo(): {
+        batteryPercents?: number;
+        modelId?: number;
+        printheadWidth?: number;
+        protocolVersion?: number;
+    };
+    getModelMetadata(): import("@mmote/niimbluelib").PrinterModelMeta | undefined;
+    getPrintTaskType(): "B1" | "B21_L2B" | "B21_V1" | "D110" | "D110M_V4" | "D11_V1" | "H1S" | undefined;
+    getRfidInfo(): {
+        labelRfidInfo?: {
+            tagPresent?: boolean;
+            barCode?: string;
+            allPaper?: number;
+            usedPaper?: number;
+            consumablesType?: number;
+        };
+        paperInfo?: {
+            valid?: boolean;
+            paperWidth?: number;
+            paperHeight?: number;
+            paperType?: number;
+        };
+    };
+    fetchRfidInfo(): Promise<unknown>;
+    startHeartbeat(): void;
+    stopHeartbeat(): void;
+    isHeartbeatStarted(): boolean;
+    get protocol(): {
+        newPrintTask(name: import("@mmote/niimbluelib").PrintTaskName, options: Record<string, unknown>): import("./client.js").PrintTaskLike;
+        printEnd(): Promise<boolean>;
+    };
+    get encodePage(): ((canvas: HTMLCanvasElement) => unknown) | undefined;
+    get rollKey(): (() => string) | undefined;
+    get feedPaper(): ((dots: number) => Promise<void>) | undefined;
+    get headUnknown(): boolean | undefined;
+    get setHeadDots(): ((dots: number) => void) | undefined;
+    get feedsBack(): boolean | undefined;
+}

package/dist/service.d.ts

@@ -34,6 +34,10 @@ export interface PrinterStatus {
     canFeed?: boolean;
     /** `feed()` can also move the paper back. */
     canRetract?: boolean;
+    /** The head's width is a guess: `setPrintWidth()` sets it, from the paper loaded. */
+    headUnknown?: boolean;
+    /** The printer was matched by its services, as this family: keep it with `rememberMatches()` so it skips the NIIMBOT handshake next time. */
+    matchedAs?: 'escpos' | 'cat';
 }
 /** Nudges the printed image, in mm: positive x moves right, positive y moves down. */
 export interface PrintOffset {
@@ -100,6 +104,14 @@ export declare class PrinterService {
     private set;
     /** Swaps the whole status, so fields from an earlier connection never linger. */
     private replace;
+    private matches;
+    /**
+     * Printers matched by their services on earlier connections, by Bluetooth
+     * name (from `status.matchedAs` and `status.deviceName`). They connect
+     * straight to that client, skipping the NIIMBOT handshake, whose bytes a
+     * receipt printer would print as text.
+     */
+    rememberMatches(matches: Record<string, 'escpos' | 'cat'>): void;
     setManualProfile(id: string | null): void;
     private currentProfile;
     private readRfid;
@@ -112,6 +124,11 @@ export declare class PrinterService {
      * already done. That task polls here instead.
      */
     private waitForFinished;
+    /**
+     * Sets the print width, in mm, on a printer whose head width is not known
+     * (`status.headUnknown`); the profile follows. Other printers keep theirs.
+     */
+    setPrintWidth(mm: number): void;
     /**
      * Moves the paper by `mm`, out of the printer when positive and back in when
      * negative, to line it up on printers that cannot sense it.

package/dist/thermal.d.ts

@@ -23,6 +23,8 @@ export interface ThermalModel {
     brand?: string;
     /** Dots across the head, where it differs from the family's usual one: 576 on 80 mm receipt printers. */
     headDots?: number;
+    /** USB vendor and product IDs, for printers that also connect by cable as a standard USB printer. */
+    usbIds?: [vendorId: number, productId: number][];
 }
 /** The name a printer shows: its model, or its own Bluetooth name when the model entry is only a brand or a stock name. */
 export declare const shownName: (model: ThermalModel | null, transport: {
@@ -39,9 +41,11 @@ export declare const THERMAL_DEFAULT_SIZE: LabelSize;
  * the highest.
  */
 export declare function packRows(data: ArrayLike<number>, width: number, height: number, order: 'lsb' | 'msb', head?: number): Uint8Array[];
-/** The Bluetooth link, kept narrow so tests can stand in for it. */
+/** The Bluetooth or USB link, kept narrow so tests can stand in for it. */
 export interface ThermalTransport {
     name?: string;
+    /** Bytes per write, for links that take more than Bluetooth's cautious start. */
+    chunkBytes?: number;
     write(chunk: Uint8Array): Promise<void>;
     onNotify(fn: (data: Uint8Array) => void): void;
     onDisconnect(fn: () => void): void;

package/dist/usb.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Label and receipt printers on a USB cable that show up as standard USB
+ * printers (interface class 7), which Web Serial cannot see. They take the
+ * same TSPL or ESC/POS bytes as over Bluetooth, through WebUSB. NIIMBOT
+ * printers show up as serial ports and keep using Web Serial.
+ */
+import { type PrinterFamily } from './catalog.js';
+import type { ThermalTransport } from './thermal.js';
+import { RoutedClient } from './routed.js';
+export declare const USB_PRINTER_CLASS = 7;
+/**
+ * The fields of an IEEE 1284 device ID, keys in capitals:
+ * "MFG:ACME;COMMAND SET:TSC/ESC/POS;MODEL:CC390;" → { MFG, 'COMMAND SET', MODEL }.
+ */
+export declare function parseDeviceId(text: string): Record<string, string>;
+/** The printer languages a device ID names, TSPL first: label printers often take ESC/POS as well. */
+export declare function familiesFromDeviceId(text: string): PrinterFamily[];
+/** USB printers this site may already use that are plugged in. */
+export declare function rememberedUsbPrinters(): Promise<USBDevice[]>;
+/** Opens a USB printer and claims its printer interface. Also reads the printer's device ID. */
+export declare function usbTransport(device: USBDevice): Promise<{
+    transport: ThermalTransport;
+    deviceId: string;
+}>;
+/**
+ * The USB printer behind the USB button for label and receipt printers. A
+ * printer this site already uses connects straight away when it is the only
+ * one plugged in; otherwise the browser lists USB printers. The printer's
+ * language comes from the catalog, then from the type picked under Advanced
+ * when the printer speaks it (or does not say), then from the device ID the
+ * printer reports.
+ */
+export declare class UsbPrinter extends RoutedClient {
+    private fallback;
+    unrecognisedAs(typeId: string | null): void;
+    connect(): Promise<{
+        deviceName?: string;
+    }>;
+}

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "libniimai",
-  "version": "0.5.0",
-  "description": "Print to NIIMBOT, TSPL, ESC/POS and cat printers from the browser over Web Bluetooth and Web Serial.",
+  "version": "0.7.0",
+  "description": "Print to NIIMBOT, TSPL, ESC/POS and cat printers from the browser over Web Bluetooth, Web Serial and WebUSB.",
   "keywords": [
     "niimbot",
     "label printer",
     "thermal printer",
     "web bluetooth",
     "web serial",
+    "webusb",
     "tspl",
     "esc/pos",
     "cat printer"
@@ -47,6 +48,7 @@
   "dependencies": {
     "@mmote/niimbluelib": "^0.48.0",
     "@types/w3c-web-serial": "^1.0.8",
+    "@types/w3c-web-usb": "^1.0.10",
     "@types/web-bluetooth": "^0.0.22"
   }
 }