thermalkit 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,95 @@
+/**
+ * Shared types for the public API.
+ */
+export type FontFamily = string;
+export type Align = 'left' | 'center' | 'right';
+export interface TextOptions {
+    /** X coordinate, or shorthand for alignment relative to the content area. */
+    x?: number;
+    /** Override Y (default: current cursor). */
+    y?: number;
+    /** Text anchor — overrides the alignment derived from `x`. */
+    anchor?: 'start' | 'middle' | 'end';
+    /** Font family stack. Common shorthands: `'georgia'`, `'helvetica'`, `'mono'`. */
+    family?: FontFamily;
+    /** Font size in pixels. Default 14. */
+    size?: number;
+    /** Numeric font weight (100..900). Default 400. */
+    weight?: number;
+    /** `'italic'` or `'oblique'`. */
+    style?: 'normal' | 'italic' | 'oblique';
+    /** Letter-spacing in pixels. */
+    spacing?: number;
+    /** Fill colour. Defaults to black; usually no reason to change. */
+    fill?: string;
+}
+export interface IconOptions {
+    /** Override X coordinate (default: page padding). */
+    x?: number;
+    /** Y offset from the current cursor (default 0). Use negative values to align an icon with text. */
+    dy?: number;
+    /** Fill colour. Defaults to black. */
+    fill?: string;
+}
+export interface RuleOptions {
+    /** Override start X. */
+    x1?: number;
+    /** Override end X. */
+    x2?: number;
+    /** Stroke width in pixels. Default 1. */
+    stroke?: number;
+    /** Dash pattern (e.g. `'4,2'` for dashed). */
+    dasharray?: string;
+}
+export interface RowOptions {
+    /** Horizontal gap between row items (defaults to 0). */
+    gap?: number;
+    /** How much to advance the cursor after the row (default: nothing — caller advances). */
+    advance?: number;
+}
+export interface ImageOptions {
+    /** X coordinate (default: page padding). */
+    x?: number;
+    /** Y coordinate (default: current cursor). */
+    y?: number;
+    /** Width override. Defaults to the PNG's native width. */
+    width?: number;
+    /** Height override. Defaults to the PNG's native height. */
+    height?: number;
+}
+export interface PageOptions {
+    /** Output width in pixels. Default 504 (TM-T88VI printable area at 180 dpi). Must be a multiple of 8. */
+    width?: number;
+    /** Horizontal padding around the content area. Default 22. */
+    padding?: number;
+    /** Map of icon name → inner SVG string, OR a list of names to load from Phosphor. */
+    icons?: string[] | Record<string, string>;
+    /** Default font family stack used by `text()` when no family is given. */
+    defaultFontFamily?: FontFamily;
+}
+export interface RenderOptions {
+    /** Sharp rasterisation density (DPI). Default 240. */
+    density?: number;
+    /** Output width in pixels (default: page.width). */
+    width?: number;
+    /** Threshold for 1-bit conversion (0..255). Default 140. */
+    threshold?: number;
+}
+export type DitherAlgorithm = 'atkinson' | 'fs' | 'bayer' | 'none';
+export interface PosterOptions {
+    /** Target display width in pixels (default 100). */
+    width?: number;
+    /** Dithering algorithm. Default `'atkinson'`. */
+    dither?: DitherAlgorithm;
+    /** Local-contrast boost. `'clahe'` works best for posters; `'normalize'` only stretches the global range. */
+    contrast?: 'clahe' | 'normalize' | 'none';
+    /** User-Agent header for the download request. */
+    userAgent?: string;
+}
+export interface PreparedImage {
+    /** PNG bytes (greyscale, exactly 0/255 pixels for dithered output). */
+    data: Buffer;
+    width: number;
+    height: number;
+}
+//# 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;;GAEG;AAEH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAChC,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;AAEhD,MAAM,WAAW,WAAW;IAC1B,6EAA6E;IAC7E,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,4CAA4C;IAC5C,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,8DAA8D;IAC9D,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAC;IACpC,kFAAkF;IAClF,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,uCAAuC;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,KAAK,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;IACxC,gCAAgC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mEAAmE;IACnE,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,qDAAqD;IACrD,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,oGAAoG;IACpG,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,wBAAwB;IACxB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,sBAAsB;IACtB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,yCAAyC;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8CAA8C;IAC9C,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,wDAAwD;IACxD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,yFAAyF;IACzF,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,4CAA4C;IAC5C,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,8CAA8C;IAC9C,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,0DAA0D;IAC1D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,WAAW;IAC1B,yGAAyG;IACzG,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8DAA8D;IAC9D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qFAAqF;IACrF,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,0EAA0E;IAC1E,iBAAiB,CAAC,EAAE,UAAU,CAAC;CAChC;AAED,MAAM,WAAW,aAAa;IAC5B,sDAAsD;IACtD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oDAAoD;IACpD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,CAAC;AAEnE,MAAM,WAAW,aAAa;IAC5B,oDAAoD;IACpD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iDAAiD;IACjD,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,6GAA6G;IAC7G,QAAQ,CAAC,EAAE,OAAO,GAAG,WAAW,GAAG,MAAM,CAAC;IAC1C,kDAAkD;IAClD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,uEAAuE;IACvE,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB"}

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "thermalkit",
+  "version": "0.1.0",
+  "description": "Compose nicely-typeset images for thermal receipt printers (Epson TM-T88VI and friends).",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./printer": {
+      "types": "./dist/printer.d.ts",
+      "import": "./dist/printer.js"
+    },
+    "./icons": {
+      "types": "./dist/icons.d.ts",
+      "import": "./dist/icons.js"
+    },
+    "./dither": {
+      "types": "./dist/dither.d.ts",
+      "import": "./dist/dither.js"
+    }
+  },
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "rolldown -c rolldown.config.ts && tsc --emitDeclarationOnly -p tsconfig.build.json",
+    "dev": "rolldown -c rolldown.config.ts --watch",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "thermal-printer",
+    "escpos",
+    "epson",
+    "receipt",
+    "image",
+    "halftone",
+    "dithering",
+    "atkinson",
+    "phosphor-icons"
+  ],
+  "author": "NTag",
+  "license": "MIT",
+  "homepage": "https://github.com/NTag/thermalkit#readme",
+  "bugs": {
+    "url": "https://github.com/NTag/thermalkit/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/NTag/thermalkit.git"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@phosphor-icons/core": "^2.1.1",
+    "node-thermal-printer": "^4.6.0",
+    "sharp": "^0.34.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.9.1",
+    "rolldown": "^1.0.0-beta.21",
+    "typescript": "^5.5.0"
+  }
+}