brother-smooth-print-uri 1.0.0

package/README.md

@@ -0,0 +1,28 @@
+# Brother Smooth Print URI Generator
+
+This is a simple URI generator for printing using the Brother Smooth Print app.
+
+Learn more about Brother Smooth Print [here](https://support.brother.com/g/s/es/dev/en/specific/smooth_print/index.html).
+
+## Usage
+
+```typescript
+import { generatePrintUri } from "brother-smooth-print-uri";
+
+const uri = generatePrintUri({
+  filename: "https://example.com/Simple.lbx",
+  size: "https://example.com/26x76.bin",
+});
+```
+
+See more examples in the tests: [src/uri-generator.test.ts](src/uri-generator.test.ts).
+
+This package only creates the URI, it does not initiate the actual print job.
+
+## Limitations
+
+- It doesn't include all parameters.
+- It only supports single layout printing.
+- Does not describe which printer series supports what.
+
+Feel free to contribute.

package/dist/index.d.mts

@@ -0,0 +1,123 @@
+/**
+ * Brother Smooth Print arguments as defined here: https://support.brother.com/g/s/es/dev/en/specific/smooth_print/index.html?c=eu_ot&lang=en&comple=on&redirect=on
+ */
+interface BrotherArgs {
+    /**
+     * Single layout template file (.lbx)
+     * @example https://example.com/Simple.lbx
+     */
+    filename: string;
+    /**
+     * Media settings file (bin)
+     * @example https://example.com/26x76.bin
+     */
+    size: string;
+    /**
+     * Number of copies to print
+     * @example 1
+     * @default 1
+     */
+    copies?: number;
+    /**
+     * Set one of the following options:
+     * threshold (Binary)
+     * pattern_dither (Dither)
+     * error_difusion (Error Diffusion)
+     * @default pattern_dither
+     */
+    halftone?: "threshold" | "pattern_dither" | "error_diffusion";
+    /**
+     * Set the brightness between -5 (light) and 5 (dark).
+     * @default 0
+     */
+    rjDensity?: -5 | -4 | -3 | -2 | -1 | 0 | 1 | 2 | 3 | 4 | 5;
+    /**
+     * Rotate the printed image 180 degrees.
+     * @default false
+     */
+    rotate180?: boolean;
+    /**
+     * Automatically peel labels while printing.
+     * @default false
+     */
+    peelMode?: boolean;
+    /**
+     * Set one of the following options:
+     * normal = higher quality, but slower printing.
+     * double_speed = lower quality, but faster printing.
+     * @default normal
+     */
+    printQuality?: "normal" | "double_speed";
+    /**
+     * Set the paper orientation
+     * Defaults to the settings in the LBX file.
+     * @default landscape
+     */
+    orientation?: "portrait" | "landscape";
+    /**
+     * Set one of the print sizes:
+     * original = actual print size
+     * fit_to_page = adjust to the page size
+     * scale = increase or decrease the print ratio
+     * fit_to_paper = adjust the paper size
+     * @default fit_to_page
+     */
+    printMode?: "original" | "fit_to_page" | "scale" | "fit_to_paper";
+    /**
+     * Set a numeric value to scale the print out.
+     * Valid when printMode is set to "scale"
+     * Set 1 or less for PDF printing
+     * @default 1
+     */
+    scaleValue?: number;
+    /**
+     * Type an object name you specified for the text in P-touch Editor.
+     * (single layout)
+     *
+     * For "text_object_name" and "barcode_object_name", type the name you assigned to the text
+     * or barcode specified in the P-touch Editor layout file.
+     * For example, if you want to print a text string with the object name "TEXT",
+     * the parameter name must be "text_TEXT".
+     */
+    text_object_name?: string;
+    /**
+     * Type an object name you specified for the barcode in P-touch Editor.
+     * (single layout)
+     *
+     * For "text_object_name" and "barcode_object_name", type the name you assigned to the text
+     * or barcode specified in the P-touch Editor layout file.
+     * For example, if you want to print a text string with the object name "TEXT",
+     * the parameter name must be "text_TEXT".
+     */
+    barcode_object_name?: string;
+    /**
+     * Type an object name you specified for the image in P-touch Editor.
+     * (single layout)
+     * Supported format: jpg, jpeg, bmp, png
+     */
+    image_object_name?: string;
+    /**
+     * Set the base64 data as a print file to attach to a URL scheme.
+     * (single layout)
+     */
+    fileattach?: string;
+    /**
+     * Set the base64 data as a media information file to attach to a URL scheme.
+     */
+    sizeattach?: string;
+    /**
+     * Update and save files.
+     * @default false
+     */
+    formatarchiveupdate?: boolean;
+    /**
+     * Set a value (in pixels) to extend the length of the print area.
+     * When "formatarchiveupdate" is set to 1 (=On) and the attached file name is the same as the name of the existing file, newer files will overwrite the existing files.
+     * @default false
+     */
+    forceStretchPrintableArea?: boolean;
+}
+
+declare const generatePrintUri: (args: BrotherArgs) => URL;
+
+export { type BrotherArgs, generatePrintUri };

package/dist/index.d.ts

@@ -0,0 +1,123 @@
+/**
+ * Brother Smooth Print arguments as defined here: https://support.brother.com/g/s/es/dev/en/specific/smooth_print/index.html?c=eu_ot&lang=en&comple=on&redirect=on
+ */
+interface BrotherArgs {
+    /**
+     * Single layout template file (.lbx)
+     * @example https://example.com/Simple.lbx
+     */
+    filename: string;
+    /**
+     * Media settings file (bin)
+     * @example https://example.com/26x76.bin
+     */
+    size: string;
+    /**
+     * Number of copies to print
+     * @example 1
+     * @default 1
+     */
+    copies?: number;
+    /**
+     * Set one of the following options:
+     * threshold (Binary)
+     * pattern_dither (Dither)
+     * error_difusion (Error Diffusion)
+     * @default pattern_dither
+     */
+    halftone?: "threshold" | "pattern_dither" | "error_diffusion";
+    /**
+     * Set the brightness between -5 (light) and 5 (dark).
+     * @default 0
+     */
+    rjDensity?: -5 | -4 | -3 | -2 | -1 | 0 | 1 | 2 | 3 | 4 | 5;
+    /**
+     * Rotate the printed image 180 degrees.
+     * @default false
+     */
+    rotate180?: boolean;
+    /**
+     * Automatically peel labels while printing.
+     * @default false
+     */
+    peelMode?: boolean;
+    /**
+     * Set one of the following options:
+     * normal = higher quality, but slower printing.
+     * double_speed = lower quality, but faster printing.
+     * @default normal
+     */
+    printQuality?: "normal" | "double_speed";
+    /**
+     * Set the paper orientation
+     * Defaults to the settings in the LBX file.
+     * @default landscape
+     */
+    orientation?: "portrait" | "landscape";
+    /**
+     * Set one of the print sizes:
+     * original = actual print size
+     * fit_to_page = adjust to the page size
+     * scale = increase or decrease the print ratio
+     * fit_to_paper = adjust the paper size
+     * @default fit_to_page
+     */
+    printMode?: "original" | "fit_to_page" | "scale" | "fit_to_paper";
+    /**
+     * Set a numeric value to scale the print out.
+     * Valid when printMode is set to "scale"
+     * Set 1 or less for PDF printing
+     * @default 1
+     */
+    scaleValue?: number;
+    /**
+     * Type an object name you specified for the text in P-touch Editor.
+     * (single layout)
+     *
+     * For "text_object_name" and "barcode_object_name", type the name you assigned to the text
+     * or barcode specified in the P-touch Editor layout file.
+     * For example, if you want to print a text string with the object name "TEXT",
+     * the parameter name must be "text_TEXT".
+     */
+    text_object_name?: string;
+    /**
+     * Type an object name you specified for the barcode in P-touch Editor.
+     * (single layout)
+     *
+     * For "text_object_name" and "barcode_object_name", type the name you assigned to the text
+     * or barcode specified in the P-touch Editor layout file.
+     * For example, if you want to print a text string with the object name "TEXT",
+     * the parameter name must be "text_TEXT".
+     */
+    barcode_object_name?: string;
+    /**
+     * Type an object name you specified for the image in P-touch Editor.
+     * (single layout)
+     * Supported format: jpg, jpeg, bmp, png
+     */
+    image_object_name?: string;
+    /**
+     * Set the base64 data as a print file to attach to a URL scheme.
+     * (single layout)
+     */
+    fileattach?: string;
+    /**
+     * Set the base64 data as a media information file to attach to a URL scheme.
+     */
+    sizeattach?: string;
+    /**
+     * Update and save files.
+     * @default false
+     */
+    formatarchiveupdate?: boolean;
+    /**
+     * Set a value (in pixels) to extend the length of the print area.
+     * When "formatarchiveupdate" is set to 1 (=On) and the attached file name is the same as the name of the existing file, newer files will overwrite the existing files.
+     * @default false
+     */
+    forceStretchPrintableArea?: boolean;
+}
+
+declare const generatePrintUri: (args: BrotherArgs) => URL;
+
+export { type BrotherArgs, generatePrintUri };

package/dist/index.js

@@ -0,0 +1,61 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  generatePrintUri: () => generatePrintUri
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/uri-generator.ts
+var generatePrintUri = (args) => {
+  const searchParams = convertArgsToSearchParams(args);
+  return new URL(`brotherwebprint://print?${searchParams.toString()}`);
+};
+var convertArgsToSearchParams = (args) => {
+  const searchParams = new URLSearchParams();
+  let property;
+  for (property in args) {
+    const value = convertValueToString(args[property]);
+    if (value) {
+      searchParams.append(property, value);
+    }
+  }
+  return searchParams;
+};
+var convertValueToString = (value) => {
+  switch (typeof value) {
+    case "string":
+      return value;
+    case "number":
+      return value.toString();
+    case "boolean":
+      return value ? "1" : "0";
+    case "undefined":
+      return null;
+    default:
+      throw new Error(`Unsupported type: ${typeof value}`);
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  generatePrintUri
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/uri-generator.ts"],"sourcesContent":["export * from \"./types\";\nexport * from \"./uri-generator\";\n","import { BrotherArgs } from \"./types\";\n\nexport const generatePrintUri = (args: BrotherArgs): URL => {\n  const searchParams = convertArgsToSearchParams(args);\n  return new URL(`brotherwebprint://print?${searchParams.toString()}`);\n};\n\nconst convertArgsToSearchParams = (args: BrotherArgs): URLSearchParams => {\n  const searchParams = new URLSearchParams();\n\n  let property: keyof typeof args;\n  for (property in args) {\n    const value = convertValueToString(args[property]);\n    if (value) {\n      searchParams.append(property, value);\n    }\n  }\n\n  return searchParams;\n};\n\nconst convertValueToString = (\n  value: BrotherArgs[keyof BrotherArgs]\n): string | null => {\n  switch (typeof value) {\n    case \"string\":\n      return value;\n    case \"number\":\n      return value.toString();\n    case \"boolean\":\n      return value ? \"1\" : \"0\";\n    case \"undefined\":\n      return null;\n    default:\n      throw new Error(`Unsupported type: ${typeof value}`);\n  }\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACEO,IAAM,mBAAmB,CAAC,SAA2B;AAC1D,QAAM,eAAe,0BAA0B,IAAI;AACnD,SAAO,IAAI,IAAI,2BAA2B,aAAa,SAAS,CAAC,EAAE;AACrE;AAEA,IAAM,4BAA4B,CAAC,SAAuC;AACxE,QAAM,eAAe,IAAI,gBAAgB;AAEzC,MAAI;AACJ,OAAK,YAAY,MAAM;AACrB,UAAM,QAAQ,qBAAqB,KAAK,QAAQ,CAAC;AACjD,QAAI,OAAO;AACT,mBAAa,OAAO,UAAU,KAAK;AAAA,IACrC;AAAA,EACF;AAEA,SAAO;AACT;AAEA,IAAM,uBAAuB,CAC3B,UACkB;AAClB,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO,MAAM,SAAS;AAAA,IACxB,KAAK;AACH,aAAO,QAAQ,MAAM;AAAA,IACvB,KAAK;AACH,aAAO;AAAA,IACT;AACE,YAAM,IAAI,MAAM,qBAAqB,OAAO,KAAK,EAAE;AAAA,EACvD;AACF;","names":[]}

package/dist/index.mjs

@@ -0,0 +1,34 @@
+// src/uri-generator.ts
+var generatePrintUri = (args) => {
+  const searchParams = convertArgsToSearchParams(args);
+  return new URL(`brotherwebprint://print?${searchParams.toString()}`);
+};
+var convertArgsToSearchParams = (args) => {
+  const searchParams = new URLSearchParams();
+  let property;
+  for (property in args) {
+    const value = convertValueToString(args[property]);
+    if (value) {
+      searchParams.append(property, value);
+    }
+  }
+  return searchParams;
+};
+var convertValueToString = (value) => {
+  switch (typeof value) {
+    case "string":
+      return value;
+    case "number":
+      return value.toString();
+    case "boolean":
+      return value ? "1" : "0";
+    case "undefined":
+      return null;
+    default:
+      throw new Error(`Unsupported type: ${typeof value}`);
+  }
+};
+export {
+  generatePrintUri
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/uri-generator.ts"],"sourcesContent":["import { BrotherArgs } from \"./types\";\n\nexport const generatePrintUri = (args: BrotherArgs): URL => {\n  const searchParams = convertArgsToSearchParams(args);\n  return new URL(`brotherwebprint://print?${searchParams.toString()}`);\n};\n\nconst convertArgsToSearchParams = (args: BrotherArgs): URLSearchParams => {\n  const searchParams = new URLSearchParams();\n\n  let property: keyof typeof args;\n  for (property in args) {\n    const value = convertValueToString(args[property]);\n    if (value) {\n      searchParams.append(property, value);\n    }\n  }\n\n  return searchParams;\n};\n\nconst convertValueToString = (\n  value: BrotherArgs[keyof BrotherArgs]\n): string | null => {\n  switch (typeof value) {\n    case \"string\":\n      return value;\n    case \"number\":\n      return value.toString();\n    case \"boolean\":\n      return value ? \"1\" : \"0\";\n    case \"undefined\":\n      return null;\n    default:\n      throw new Error(`Unsupported type: ${typeof value}`);\n  }\n};\n"],"mappings":";AAEO,IAAM,mBAAmB,CAAC,SAA2B;AAC1D,QAAM,eAAe,0BAA0B,IAAI;AACnD,SAAO,IAAI,IAAI,2BAA2B,aAAa,SAAS,CAAC,EAAE;AACrE;AAEA,IAAM,4BAA4B,CAAC,SAAuC;AACxE,QAAM,eAAe,IAAI,gBAAgB;AAEzC,MAAI;AACJ,OAAK,YAAY,MAAM;AACrB,UAAM,QAAQ,qBAAqB,KAAK,QAAQ,CAAC;AACjD,QAAI,OAAO;AACT,mBAAa,OAAO,UAAU,KAAK;AAAA,IACrC;AAAA,EACF;AAEA,SAAO;AACT;AAEA,IAAM,uBAAuB,CAC3B,UACkB;AAClB,UAAQ,OAAO,OAAO;AAAA,IACpB,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO,MAAM,SAAS;AAAA,IACxB,KAAK;AACH,aAAO,QAAQ,MAAM;AAAA,IACvB,KAAK;AACH,aAAO;AAAA,IACT;AACE,YAAM,IAAI,MAAM,qBAAqB,OAAO,KAAK,EAAE;AAAA,EACvD;AACF;","names":[]}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "brother-smooth-print-uri",
+  "version": "1.0.0",
+  "description": "URI Generator for Brother Smooth Print",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "test": "jest",
+    "prepublishOnly": "npm run build && npm test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lajtmaN/brother-smooth-print-uri.git"
+  },
+  "bugs": {
+    "url": "https://github.com/lajtmaN/brother-smooth-print-uri/issues"
+  },
+  "homepage": "https://github.com/lajtmaN/brother-smooth-print-uri#readme",
+  "keywords": [
+    "brother",
+    "printer",
+    "label",
+    "smooth-print",
+    "uri",
+    "generator",
+    "printing"
+  ],
+  "author": "Tim Gjøderum",
+  "license": "ISC",
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.0.2",
+    "typescript": "^5.4.4"
+  }
+}