@bobfrankston/brother-label 1.0.14 → 1.1.2

package/README.md

@@ -61,21 +61,35 @@ brother-print config -p "Brother PT-P710BT"  # Set default printer
 brother-print list                       # List Brother printers
 ```
 
+### Print clipboard contents
+```bash
+brother-print -clip                  # auto-detect: image if present, else text
+```
+
 ### Options
 | Option | Description |
 |--------|-------------|
 | `-t, --text` | Force input as literal text; repeatable for multi-segment labels |
-| `-q, --qr` | QR code segment; repeatable for multi-segment labels |
-| `-s, --tape <size>` | Tape size: 6, 9, 12, 18, 24 (mm) |
+| `-qr <data>` | QR code segment; repeatable for multi-segment labels |
+| `-tape <size>` | Tape size: 6, 9, 12, 18, 24 (mm); auto-detected if omitted |
 | `-p, --printer <name>` | Printer name |
 | `-o, --output <file>` | Save to file instead of printing |
 | `-a, --aspect <ratio>` | Aspect ratio width:height for HTML (e.g., 3.5:2) |
 | `-H, --height <size>` | Text height: 12mm, .5in, or 50% (of tape height) |
+| `-s, --space <size>` | Space between segments: 12px, 1mm, .2in |
 | `-w, --html` | Force input as HTML file path |
 | `-i, --image` | Force input as image file path |
+| `-c, --clip` | Read content from clipboard (image preferred, then text) |
+| `-no-wait` | Fail immediately if printer is offline (default: wait) |
+| `-timeout <secs>` | Max wait time when printer is offline |
+| `-interval <secs>` | Polling interval while waiting (default: 2) |
 
 Single-hyphen long options are supported: `-text` works the same as `--text`, `-tape` as `--tape`, etc. Single letters are strict: `-t` means `--text`, not the start of `-tape`.
 
+### Offline handling
+
+By default `print()` waits for the printer to come online if it's asleep. Use `-no-wait` to fail immediately, or `-timeout <secs>` to bound the wait. Use `brother-print status` to check the current online state. The wait reports any other Brother printers that are online as alternatives.
+
 ## API Usage
 
 ### Print text
@@ -129,6 +143,35 @@ await print({ imagePath: "photo.png" });
 await print({ imageBuffer: fs.readFileSync("photo.png") });
 ```
 
+### Print clipboard contents
+```typescript
+await print({ clip: true });          // image if present, else text
+```
+
+### Offline handling
+```typescript
+await print({
+    text: "Hello",
+    onWaiting: (status, elapsedMs, alternatives) => {
+        console.log(`waiting on ${status.name} (${Math.floor(elapsedMs/1000)}s)`);
+    },
+    waitTimeoutMs: 60_000,
+});
+
+await print({ text: "Hello", wait: false });  // fail immediately if offline
+```
+
+### Cross-driver code
+```typescript
+import type { LabelPrinter } from "@bobfrankston/label-core";
+import { brotherPrinter } from "@bobfrankston/brother-label";
+import { dymoPrinter }    from "@bobfrankston/dymo-print";
+
+async function printOn(p: LabelPrinter, text: string) {
+    await p.print({ text });
+}
+```
+
 ### Configuration
 ```typescript
 import { getConfig, setConfig, listPrinters } from "@bobfrankston/brother-label";

package/api.d.ts

@@ -1,9 +1,17 @@
 /**
  * Brother Label Printer API
- * Programmatic interface for printing labels on Brother P-touch printers
+ * Programmatic interface for printing labels on Brother P-touch printers.
+ *
+ * Implements the unified LabelPrinter interface from @bobfrankston/label-core.
+ * All printer-agnostic logic (rendering, segments, clipboard, CLI primitives,
+ * online-wait) lives in label-core. This file holds the Brother-specific bits:
+ * TAPE_SIZES catalog, MEDIA_OPTIONS (CustomMediaSize* names), XPS PrintTicket
+ * builder with the Brother namespace, and detectTapeSize.
  */
+import type { LabelPrinter, PrintOptions as CorePrintOptions, SegmentOptions as CoreSegmentOptions, Segment } from "@bobfrankston/label-core";
 export type TapeSize = 6 | 9 | 12 | 18 | 24;
 export type Orientation = "landscape" | "portrait";
+/** Backward-compat: brother-label's config kept the `defaultTape` name. */
 export interface PrinterConfig {
     defaultTape?: TapeSize;
     defaultPrinter?: string;
@@ -11,41 +19,33 @@ export interface PrinterConfig {
 export interface PrinterInfo {
     name: string;
 }
-export interface PrintOptions {
-    text?: string;
-    html?: string;
-    htmlPath?: string;
-    textFile?: string;
-    imagePath?: string;
-    imageBuffer?: Buffer;
-    qr?: string;
+/** Brother-specific PrintOptions: same as core but with tape alias for media. */
+export interface PrintOptions extends Omit<CorePrintOptions, "media"> {
+    tape?: TapeSize; /** Tape size in mm — alias for core.media */
+    orientation?: Orientation; /** Reserved (Brother PT prints landscape only) */
+    length?: number; /** Reserved — explicit length in mm */
+}
+export interface SegmentOptions extends Omit<CoreSegmentOptions, "media"> {
     tape?: TapeSize;
-    printer?: string;
-    orientation?: Orientation;
-    length?: number;
-    basePath?: string;
-    aspect?: string;
-    qrLabel?: string;
-    textHeight?: string;
 }
 export interface PrintResult {
     image: Buffer;
 }
-export interface Segment {
-    type: "text" | "qr";
-    value: string;
-}
+export type { Segment };
 export declare function getConfig(): PrinterConfig;
 export declare function setConfig(config: Partial<PrinterConfig>): void;
 export declare function getConfigPath(): string;
 export declare function listPrinters(): Promise<PrinterInfo[]>;
+/**
+ * Auto-detect tape size from printer's default print ticket. Returns null if
+ * detection fails. Brother's driver embeds the loaded tape's CustomMediaSize
+ * name in the default PrintTicket XML.
+ */
+export declare function detectTapeSize(printerName?: string): Promise<TapeSize>;
+/** Public Brother singleton (implements LabelPrinter). */
+export declare const brotherPrinter: LabelPrinter;
 export declare function render(options: PrintOptions): Promise<Buffer>;
 export declare function print(options: PrintOptions): Promise<PrintResult>;
 export declare function renderSegments(segments: Segment[], tape?: TapeSize, textHeight?: string, space?: string): Promise<Buffer>;
-export declare function printSegments(segments: Segment[], options?: {
-    tape?: TapeSize;
-    printer?: string;
-    textHeight?: string;
-    space?: string;
-}): Promise<PrintResult>;
+export declare function printSegments(segments: Segment[], options?: SegmentOptions): Promise<PrintResult>;
 //# sourceMappingURL=api.d.ts.map

package/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["api.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAYH,MAAM,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AAC5C,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,UAAU,CAAC;AAEnD,MAAM,WAAW,aAAa;IAC1B,WAAW,CAAC,EAAE,QAAQ,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAEzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,EAAE,CAAC,EAAE,MAAM,CAAC;IAGZ,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,WAAW;IACxB,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,OAAO;IACpB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;CACjB;AA0BD,wBAAgB,SAAS,IAAI,aAAa,CAczC;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI,CAI9D;AAED,wBAAgB,aAAa,IAAI,MAAM,CAEtC;AAGD,wBAAsB,YAAY,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,CAuB3D;AA2YD,wBAAsB,MAAM,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAInE;AAED,wBAAsB,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,CAMvE;AAGD,wBAAsB,cAAc,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CA+D/H;AAGD,wBAAsB,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE;IAAE,IAAI,CAAC,EAAE,QAAQ,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,WAAW,CAAC,CAOnK"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["api.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAgBH,OAAO,KAAK,EACR,YAAY,EACZ,YAAY,IAAI,gBAAgB,EAChC,cAAc,IAAI,kBAAkB,EAMpC,OAAO,EAEV,MAAM,0BAA0B,CAAC;AAIlC,MAAM,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AAC5C,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,UAAU,CAAC;AAEnD,2EAA2E;AAC3E,MAAM,WAAW,aAAa;IAC1B,WAAW,CAAC,EAAE,QAAQ,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,iFAAiF;AACjF,MAAM,WAAW,YAAa,SAAQ,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACjE,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAY,6CAA6C;IACzE,WAAW,CAAC,EAAE,WAAW,CAAC,CAAE,kDAAkD;IAC9E,MAAM,CAAC,EAAE,MAAM,CAAC,CAAY,uCAAuC;CACtE;AAED,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,kBAAkB,EAAE,OAAO,CAAC;IACrE,IAAI,CAAC,EAAE,QAAQ,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IACxB,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,YAAY,EAAE,OAAO,EAAE,CAAC;AA8BxB,wBAAgB,SAAS,IAAI,aAAa,CAMzC;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI,CAE9D;AAED,wBAAgB,aAAa,IAAI,MAAM,CAEtC;AAID,wBAAsB,YAAY,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,CAG3D;AAED;;;;GAIG;AACH,wBAAsB,cAAc,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAyB5E;AAuGD,0DAA0D;AAC1D,eAAO,MAAM,cAAc,EAAE,YAAuC,CAAC;AAsBrE,wBAAsB,MAAM,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAEnE;AAED,wBAAsB,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,CAGvE;AAED,wBAAsB,cAAc,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAK/H;AAED,wBAAsB,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,CAGvG"}