@thermal-label/brother-ql-node 0.0.1

package/dist/transport.js

@@ -0,0 +1,120 @@
+import net from 'node:net';
+import usb from 'usb';
+export class UsbTransport {
+    outEndpoint;
+    inEndpoint;
+    iface;
+    device;
+    constructor(device) {
+        this.device = device;
+        device.open();
+        const iface = device.interface(0);
+        // On Linux the usblp kernel driver claims printer-class interfaces
+        // automatically — detach it before claiming with libusb.
+        if (process.platform === 'linux' && iface.isKernelDriverActive()) {
+            iface.detachKernelDriver();
+        }
+        iface.claim();
+        this.iface = iface;
+        const outEp = iface.endpoints.find((e) => e.direction === 'out');
+        const inEp = iface.endpoints.find((e) => e.direction === 'in');
+        if (!outEp)
+            throw new Error('USB device has no bulk OUT endpoint');
+        if (!inEp)
+            throw new Error('USB device has no bulk IN endpoint');
+        this.outEndpoint = outEp;
+        this.inEndpoint = inEp;
+    }
+    static open(vid, pid) {
+        const device = usb
+            .getDeviceList()
+            .find(d => d.deviceDescriptor.idVendor === vid && d.deviceDescriptor.idProduct === pid);
+        if (!device)
+            return Promise.reject(new Error(`USB device ${vid.toString(16)}:${pid.toString(16)} not found`));
+        return Promise.resolve(new UsbTransport(device));
+    }
+    async write(data) {
+        await this.outEndpoint.transferAsync(Buffer.from(data));
+    }
+    async read(byteCount) {
+        const buf = await this.inEndpoint.transferAsync(byteCount);
+        return buf ? new Uint8Array(buf) : new Uint8Array(0);
+    }
+    async close() {
+        await this.iface.releaseAsync();
+        this.device.close();
+    }
+}
+export class TcpTransport {
+    socket;
+    chunks = [];
+    resolveRead = null;
+    needed = 0;
+    constructor(socket) {
+        this.socket = socket;
+        socket.on('data', (chunk) => {
+            this.chunks.push(chunk);
+            this.tryResolveRead();
+        });
+    }
+    static async connect(host, port = 9100) {
+        return new Promise((resolve, reject) => {
+            const socket = new net.Socket();
+            socket.once('error', reject);
+            socket.connect(port, host, () => {
+                socket.removeListener('error', reject);
+                resolve(new TcpTransport(socket));
+            });
+        });
+    }
+    buffered() {
+        return this.chunks.reduce((sum, c) => sum + c.length, 0);
+    }
+    tryResolveRead() {
+        if (this.resolveRead && this.buffered() >= this.needed) {
+            const combined = Buffer.concat(this.chunks);
+            this.chunks.length = 0;
+            const result = combined.subarray(0, this.needed);
+            const remainder = combined.subarray(this.needed);
+            if (remainder.length > 0)
+                this.chunks.push(Buffer.from(remainder));
+            const resolve = this.resolveRead;
+            this.resolveRead = null;
+            this.needed = 0;
+            resolve(new Uint8Array(result));
+        }
+    }
+    async write(data) {
+        return new Promise((resolve, reject) => {
+            this.socket.write(Buffer.from(data), err => {
+                if (err)
+                    reject(err);
+                else
+                    resolve();
+            });
+        });
+    }
+    async read(byteCount) {
+        if (this.buffered() >= byteCount) {
+            const combined = Buffer.concat(this.chunks);
+            this.chunks.length = 0;
+            const result = combined.subarray(0, byteCount);
+            const remainder = combined.subarray(byteCount);
+            if (remainder.length > 0)
+                this.chunks.push(Buffer.from(remainder));
+            return new Uint8Array(result);
+        }
+        return new Promise(resolve => {
+            this.resolveRead = resolve;
+            this.needed = byteCount;
+        });
+    }
+    async close() {
+        return new Promise(resolve => {
+            this.socket.end(() => {
+                resolve();
+            });
+        });
+    }
+}
+//# sourceMappingURL=transport.js.map

package/dist/transport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transport.js","sourceRoot":"","sources":["../src/transport.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,GAAG,MAAM,KAAK,CAAC;AAQtB,MAAM,OAAO,YAAY;IACN,WAAW,CAAkB;IAC7B,UAAU,CAAiB;IAC3B,KAAK,CAAgB;IACrB,MAAM,CAAa;IAEpC,YAAY,MAAkB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,MAAM,CAAC,IAAI,EAAE,CAAC;QACd,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAClC,mEAAmE;QACnE,yDAAyD;QACzD,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,IAAI,KAAK,CAAC,oBAAoB,EAAE,EAAE,CAAC;YACjE,KAAK,CAAC,kBAAkB,EAAE,CAAC;QAC7B,CAAC;QACD,KAAK,CAAC,KAAK,EAAE,CAAC;QACd,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QAEnB,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAwB,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,KAAK,CAAC,CAAC;QACvF,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAuB,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC;QAEpF,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACnE,IAAI,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QAEjE,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IACzB,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,GAAW,EAAE,GAAW;QAClC,MAAM,MAAM,GAAG,GAAG;aACf,aAAa,EAAE;aACf,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,QAAQ,KAAK,GAAG,IAAI,CAAC,CAAC,gBAAgB,CAAC,SAAS,KAAK,GAAG,CAAC,CAAC;QAC1F,IAAI,CAAC,MAAM;YACT,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,KAAK,CAAC,cAAc,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,YAAY,CAAC,CAC1E,CAAC;QACJ,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,IAAgB;QAC1B,MAAM,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,SAAiB;QAC1B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAC3D,OAAO,GAAG,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IACvD,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;QAChC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;CACF;AAED,MAAM,OAAO,YAAY;IACN,MAAM,CAAa;IACnB,MAAM,GAAa,EAAE,CAAC;IAC/B,WAAW,GAAuC,IAAI,CAAC;IACvD,MAAM,GAAG,CAAC,CAAC;IAEnB,YAAY,MAAkB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACxB,IAAI,CAAC,cAAc,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAY,EAAE,IAAI,GAAG,IAAI;QAC5C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAC7B,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE;gBAC9B,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;gBACvC,OAAO,CAAC,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YACpC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,QAAQ;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC3D,CAAC;IAEO,cAAc;QACpB,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,QAAQ,EAAE,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACvD,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC5C,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;YACvB,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YACjD,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACjD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC;gBAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;YACnE,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC;YACjC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;YACxB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;YAChB,OAAO,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,IAAgB;QAC1B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,EAAE;gBACzC,IAAI,GAAG;oBAAE,MAAM,CAAC,GAAG,CAAC,CAAC;;oBAChB,OAAO,EAAE,CAAC;YACjB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,SAAiB;QAC1B,IAAI,IAAI,CAAC,QAAQ,EAAE,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC5C,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;YACvB,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;YAC/C,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;YAC/C,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC;gBAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;YACnE,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QAChC,CAAC;QACD,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;YAC3B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC;YAC3B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,KAAK;QACT,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;YAC3B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;gBACnB,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/types.d.ts

@@ -0,0 +1,13 @@
+import { type DeviceDescriptor } from '@thermal-label/brother-ql-core';
+export interface OpenOptions {
+    vid?: number;
+    pid?: number;
+    serialNumber?: string;
+}
+export interface PrinterInfo {
+    device: DeviceDescriptor;
+    serialNumber: string | undefined;
+    path: string;
+    transport: 'usb';
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAEvE,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,gBAAgB,CAAC;IACzB,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,KAAK,CAAC;CAClB"}

package/dist/types.js

@@ -0,0 +1,2 @@
+import {} from '@thermal-label/brother-ql-core';
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,MAAM,gCAAgC,CAAC"}

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@thermal-label/brother-ql-node",
+  "version": "0.0.1",
+  "description": "Node.js USB and TCP driver for Brother QL label printers",
+  "keywords": [
+    "brother",
+    "brother-ql",
+    "label-printer",
+    "thermal-label",
+    "usb",
+    "tcp",
+    "node"
+  ],
+  "type": "module",
+  "author": "Mannes Brak",
+  "license": "MIT",
+  "homepage": "https://thermal-label.github.io/brother-ql/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/thermal-label/brother-ql.git",
+    "directory": "packages/node"
+  },
+  "bugs": {
+    "url": "https://github.com/thermal-label/brother-ql/issues"
+  },
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/mannes"
+    },
+    {
+      "type": "ko-fi",
+      "url": "https://ko-fi.com/mannes"
+    }
+  ],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./src/index.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./src/index.ts"
+    }
+  },
+  "dependencies": {
+    "@mbtech-nl/bitmap": "^0.1.0",
+    "usb": "^2.0.0",
+    "@thermal-label/brother-ql-core": "0.0.1"
+  },
+  "optionalDependencies": {
+    "@napi-rs/canvas": "^0.1.0"
+  },
+  "devDependencies": {
+    "@mbtech-nl/tsconfig": "^1.0.0",
+    "@types/node": "^22.0.0",
+    "@vitest/coverage-v8": "^2.1.9",
+    "typescript": "~5.5.0",
+    "vitest": "^2.0.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage"
+  }
+}