Merge branch 'develop'

yeasir01 · Feb 17, 2024 · e78a178 · e78a178
2 parents 168cfd5 + eecc878
commit e78a178
Show file tree

Hide file tree

Showing 27 changed files with 399 additions and 211 deletions.
diff --git a/.github/images/auto-cut-chain-print.png b/.github/images/auto-cut-chain-print.png
diff --git a/.github/images/auto-cut-half-chain.png b/.github/images/auto-cut-half-chain.png
diff --git a/.github/images/auto-cut-half-cut.png b/.github/images/auto-cut-half-cut.png
diff --git a/.github/images/auto-cut-no-margin.png b/.github/images/auto-cut-no-margin.png
diff --git a/.github/images/auto-cut.png b/.github/images/auto-cut.png
diff --git a/.github/images/auto-half-chain.png b/.github/images/auto-half-chain.png
diff --git a/.github/images/auto-half-cut.png b/.github/images/auto-half-cut.png
diff --git a/.github/images/chain-print.png b/.github/images/chain-print.png
diff --git a/.github/images/cp-cut-mark.png b/.github/images/cp-cut-mark.png
diff --git a/.github/images/half-cut-chain.png b/.github/images/half-cut-chain.png
diff --git a/.github/images/half-cut.png b/.github/images/half-cut.png
diff --git a/.github/images/ncp-cut-mark.png b/.github/images/ncp-cut-mark.png
diff --git a/.github/images/ncp-no-cut.png b/.github/images/ncp-no-cut.png
diff --git a/.github/images/no-cut-no-margin.png b/.github/images/no-cut-no-margin.png
diff --git a/.github/images/no-cut.png b/.github/images/no-cut.png
diff --git a/.github/images/no-margin-no-cut.png b/.github/images/no-margin-no-cut.png
diff --git a/.github/images/special-tape.png b/.github/images/special-tape.png
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -13,5 +13,8 @@
     "files.eol": "\n",
     "[github-actions-workflow]": {
         "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[markdown]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
     }
 }
diff --git a/docs/options.md b/docs/options.md
@@ -1,33 +1,165 @@
 # Notice
-Properties are applicable exclusively to models that support each respective function. If a model does not support a particular function, the configuration becomes invalid, even if a prop is specified.
+Print options apply exclusively to models that support each respective function. If a model does not support a particular function, the configuration becomes invalid, even if the option is true. 
 
-## Print Config Options
-| **Key** | **Type** | **Default** | **Description** |
-|---|---|:---:|---|
-| copies | number | 1 |Number of copies to print.|
-| printName | string | "BPAC-Document" |Document Name for print queue.|
-| autoCut | boolean | false |Auto cut after print.|
-| cutPause | boolean | false |Pause to cut is applied. Valid only with models not supporting the auto cut function.|
-| cutMark | boolean | false |Cut mark is inserted. Valid only with models not supporting the auto cut function.|
-| halfCut | boolean | false |Performs half cut.|
-| chainPrint | boolean | false |Continuous printing is performed. The final label is not cut, but when the next labels are output, the preceding blank is cut in line with the cut option setting.|
-| tailCut | boolean | false |Whenever a label is output, the trailing end of the form is forcibly cut to leave a leading blank for the next label output|
-| specialTape | boolean | false |No cutting is performed when printing on special tape. Valid only with PT-2430PC.|
-| cutAtEnd | boolean | false |Cut at end is performed.|
-| noCut | boolean | false |Disable auto cut|
-| mirroring | boolean | false |Mirror print label.|
-| quality | boolean | false |Fine quality print.|
-| highSpeed | boolean | false |High speed printing.|
-| highResolution | boolean | false |High resolution printing.|
-| color | boolean | false |Print in color.|
-| mono | boolean | false |Print in monochrome.|
-| continue | boolean | false |Front margin not output.|
-
-## Supported Export Extensions
+If an option is undefined, the default configuration specified in the template file will be applied.
+
+## Supported Ext Types (exporting files)
 | **Description** | **Extension** |
 |---|:---:|
 | LBX type | .lbx |
 | LBL (P-touch Editor 4.2) | .lbl |
 | LBI type | .lbi |
 | BMP Image | .bmp |
 | PAF Type | .paf |
+
+## Print Options
+| **Key** | **Type** | **Default** | **Description** |
+|---|---|:---:|---|
+| copies | number | 1 |Number of copies to print.|
+| printName | string | "BPAC-Document" |Document Name for print queue.|
+| autoCut | boolean | - |Auto cut after print.|
+| cutPause | boolean | - |Pause to cut is applied. Valid only with models not supporting the auto cut function.|
+| cutMark | boolean | - |Cut mark is inserted. Valid only with models not supporting the auto cut function.|
+| halfCut | boolean | - |Performs half cut.|
+| chainPrint | boolean | - |Continuous printing is performed. The final label is not cut, but when the next labels are output, the preceding blank is cut in line with the cut option setting.|
+| tailCut | boolean | - |Whenever a label is output, the trailing end of the form is forcibly cut to leave a leading blank for the next label output|
+| specialTape | boolean | - |No cutting is performed when printing on special tape. Valid only with PT-2430PC.|
+| cutAtEnd | boolean | - |Cut at end is performed.|
+| noCut | boolean | - |Disable auto cut|
+| mirroring | boolean | - |Mirror print label.|
+| quality | boolean | - |Fine quality print.|
+| highSpeed | boolean | - |High speed printing.|
+| highResolution | boolean | - |High resolution printing.|
+| color | boolean | - |Print in color.|
+| mono | boolean | - |Print in monochrome.|
+| fitPage | boolean | - |Specify whether to adjust the size and position of objects in the template in accordance with layout changes resulting from media changes. If set to true, adjustments will be made; otherwise, if set to false or undefined, no adjustments will be applied..|
+
+## PT-9500PC / PT-9600 / PT-3600 
+| **noCut** | **autoCut** | **halfCut**| **chainPrint** | **Result** |
+|:---:|:---:|:---:|:---:|---:|
+|✔️|-|-|-|![noCut](../.github/images/no-cut.png) |
+|-|-|-|✔️|![chainPrint](../.github/images/chain-print.png) |
+|-|-|✔️|-|![halfCut](../.github/images/half-cut.png) |
+|-|-|✔️|✔️|![halfCut chainPrint](../.github/images/half-cut-chain.png) |
+|-|✔️|-|-|![autoCut](../.github/images/auto-cut.png) |
+|-|✔️|-|✔️|![autoCut chainPrint](../.github/images/auto-cut-chain-print.png) |
+|-|✔️|✔️|-|![autoCut halfCut](../.github/images/auto-cut-half-cut.png) |
+|-|✔️|✔️|✔️|![autoCut halfCut chainPrint](../.github/images/auto-cut-half-chain.png) |
+
+## PT-9700PC / PT-9800PCN / PT-P750W / PT-P910BT / PT-E550W 
+| **noCut** | **autoCut** | **halfCut** | **chainPrint** | **specialTape** | **Result** |
+|:---:|:---:|:---:|:---:|:---:|---:|
+|✔️|-|-|-|-|![noCut](../.github/images/no-cut.png) |
+|-|-|-|✔️|-|![chainPrint](../.github/images/chain-print.png) |
+|-|-|✔️|-|-|![halfCut](../.github/images/half-cut.png) |
+|-|-|✔️|✔️|-|![halfCut chainPrint](../.github/images/half-cut-chain.png) |
+|-|✔️|-|-|-|![autoCut](../.github/images/auto-cut.png) |
+|-|✔️|-|✔️|-|![autoCut chainPrint](../.github/images/auto-cut-chain-print.png) |
+|-|✔️|✔️|-|-|![autoCut halfCut](../.github/images/auto-cut-half-cut.png) |
+|-|✔️|✔️|✔️|-|![autoCut halfCut chainPrint](../.github/images/auto-cut-half-chain.png) |
+|-|-|-|-|✔️|![specialTape](../.github/images/special-tape.png) |
+
+## PT-D450
+| **noCut** | **cutMark** | **chainPrint** | **Result** |
+|:---:|:---:|:---:|---:|
+|✔️|-|-|![noCut](../.github/images/ncp-no-cut.png) |
+|-|-|✔️|![chainPrint](../.github/images/chain-print.png) |
+|-|✔️|-|![cutMark](../.github/images/ncp-cut-mark.png) |
+|-|✔️|✔️|![cutMark chainPrint](../.github/images/half-cut-chain.png) | 
+
+## PT-E800T / PT-E800TK / PT-E850TKW
+| **Media** | **noCut** | **autoCut** | **halfCut** | **chainPrint** | **specialTape** | **Result** |
+|:----------|:---:|:---:|:---:|:---:|:---:|---:|
+| TZe       |✔️|-|-|-|-|![noCut](../.github/images/no-cut.png) |
+| TZe       |-|-|-|✔️|-|![chainPrint](../.github/images/chain-print.png) |
+| TZe       |-|-|✔️|-|-|![halfCut](../.github/images/half-cut.png) |
+| TZe       |-|-|✔️|✔️|-|![halfCut chainPrint](../.github/images/half-cut-chain.png) |
+| TZe       |-|✔️|-|-|-|![autoCut](../.github/images/auto-cut.png) |
+| TZe       |-|✔️|-|✔️|-|![autoCut chainPrint](../.github/images/auto-cut-chain-print.png) |
+| TZe       |-|✔️|✔️|-|-|![autoCut halfCut](../.github/images/auto-cut-half-cut.png) |
+| TZe       |-|✔️|✔️|✔️|-|![autoCut halfCut chainPrint](../.github/images/auto-cut-half-chain.png) |
+| TZe       |-|-|-|-|✔️|![specialTape](../.github/images/special-tape.png) |
+| PVC Tube  |✔️|❌|-|❌|❌|![noCut](../.github/images/no-cut.png) |
+| PVC Tube  |-|❌|✔️|❌|❌|![halfCut](../.github/images/half-cut.png) |
+| FLe       |✔️|-|❌|❌|❌|![noCut](../.github/images/no-cut-no-margin.png) |
+| FLe       |-|✔️|❌|❌|❌|![autoCut](../.github/images/auto-cut-no-margin.png) |
+
+## PT-D800W / PT-P900 / PT-P900W / PT-P950NW
+| **Media** | **noCut** | **autoCut** | **halfCut** | **chainPrint** | **specialTape** | **Result** |
+|:----------|:---:|:---:|:---:|:---:|:---:|---:|
+| TZe       |✔️|-|-|-|-|![noCut](../.github/images/no-cut.png) |
+| TZe       |-|-|-|✔️|-|![chainPrint](../.github/images/chain-print.png) |
+| TZe       |-|-|✔️|-|-|![halfCut](../.github/images/half-cut.png) |
+| TZe       |-|-|✔️|✔️|-|![halfCut chainPrint](../.github/images/half-cut-chain.png) |
+| TZe       |-|✔️|-|-|-|![autoCut](../.github/images/auto-cut.png) |
+| TZe       |-|✔️|-|✔️|-|![autoCut chainPrint](../.github/images/auto-cut-chain-print.png) |
+| TZe       |-|✔️|✔️|-|-|![autoCut halfCut](../.github/images/auto-cut-half-cut.png) |
+| TZe       |-|✔️|✔️|✔️|-|![autoCut halfCut chainPrint](../.github/images/auto-cut-half-chain.png) |
+| TZe       |-|-|-|-|✔️|![specialTape](../.github/images/special-tape.png) |
+| FLe       |✔️|-|❌|❌|❌|![noCut](../.github/images/no-cut-no-margin.png) |
+| FLe       |-|✔️|❌|❌|❌|![autoCut](../.github/images/auto-cut-no-margin.png) |
+
+## PT-2100 / PT-2700 / PT-24 / PT-18R / PT-18NR
+| **noCut** | **autoCut** | **chainPrint** | **Result** |
+|:---:|:---:|:---:|---:|
+|✔️|-|-|![noCut](../.github/images/no-cut.png) |
+|-|-|✔️|![chainPrint](../.github/images/chain-print.png) |
+|-|✔️|-|![autoCut](../.github/images/auto-cut.png) |
+|-|✔️|✔️|![autoCut chainPrint](../.github/images/auto-cut-chain-print.png) |
+
+## PT-1950 / PT-1960
+| **noCut** | **cutMark** | **chainPrint** | **Result** |
+|:---:|:---:|:---:|---:|
+|✔️|-|-|![noCut](../.github/images/no-cut.png) |
+|-|-|✔️|![chainPrint](../.github/images/chain-print.png) |
+|-|✔️|-|![cutMark](../.github/images/cp-cut-mark.png) |
+|-|✔️|✔️|![cutMark chainPrint](../.github/images/half-cut-chain.png) | 
+
+## PT-1230PC
+| **noCut** | **cutMark** | **Result** |
+|:---:|:---:|---:|
+|✔️|-|![noCut](../.github/images/ncp-no-cut.png) |
+|-|✔️|![cutMark](../.github/images/ncp-cut-mark.png) |
+
+## PT-2600 / PT-2610
+| **noCut** | **autoCut** | **Result** |
+|:---:|:---:|---:|
+|✔️|-|![noCut](../.github/images/ncp-no-cut.png) |
+|-|✔️|![autoCut](../.github/images/auto-cut.png) |
+
+## PT-2430PC / PT-2730 / PT-P700 / PT-P710BT / PT-P715eBT / PT-H500 / PT-E500 / PT-D600 / PT-D610BT
+| **noCut** | **autoCut** | **chainPrint**| **specialTape** | **Result** |
+|:---:|:---:|:---:|:---:|---:|
+|✔️|-|-|-|![noCut](../.github/images/no-cut.png) |
+|-|-|-|✔️|![specialTape](../.github/images/special-tape.png) |
+|-|-|✔️|-|![chainPrint](../.github/images/chain-print.png) |
+|-|✔️|-|-|![autoCut](../.github/images/auto-cut.png) |
+|-|✔️|✔️|-|![autoCut chainPrint](../.github/images/auto-cut-chain-print.png) |
+
+## PT-D410/PT-D460BT
+| **noCut** | **cutPause** | **chainPrint**| **specialTape** | **Result** |
+|:---:|:---:|:---:|:---:|---:|
+|✔️|-|-|-|![noCut](../.github/images/no-cut.png) |
+|-|-|✔️|-|![chainPrint](../.github/images/chain-print.png) |
+|-|✔️|-|-|![cutPause](../.github/images/auto-cut.png) |
+|-|✔️|✔️|-|![cutPause chainPrint](../.github/images/auto-cut-chain-print.png) |
+|-|-|-|✔️|![specialTape](../.github/images/special-tape.png) |
+
+## MW-100e / MW-120 / MW-140BT / MW-145BT / MW-170 / MW-260 / MW-270 / PJ-623 / PJ-663 / PJ-722 / PJ-723 / PJ-762 / PJ-763 / PJ-763MFi / PJ-773 / RJ-2030 / RJ-2150 / RJ-2140 / RJ-2050 / RJ-3050 / RJ-3050Ai / RJ-3150 / RJ-3150Ai / RJ-3230B / RJ-3250WB / RJ-4030 / RJ-4030Ai / RJ-4040 / RJ-4230B / RJ-4250WB / PJ-822 / PJ-823 / PJ-862 / PJ-863 / PJ-883 / TD-2020 / TD-2120N / TD-2130N / TD-2030A / TD-2125N / TD-2125NWB / TD-2135N / TD-2135NWB
+| **noCut** | **Result** |
+|:---:|---:|
+|✔️|![noCut](../.github/images/no-margin-no-cut.png) |
+
+## QL-550 
+| **noCut** | **autoCut** | **Result** |
+|:---:|:---:|---:|
+|✔️|-|![noCut](../.github/images/no-margin-no-cut.png) |
+|-|✔️|![autoCut](../.github/images/auto-cut-no-margin.png) |
+
+## QL-560 / QL-570 / QL-580N / QL-600 / QL-650TD / QL-700 / QL-710W / QL-720NW / QL-800 / QL-810W / QL-820NWB / QL-1050 / QL-1060N / QL-1100 / QL-1110NWB / QL-1115NWB / TD-4000 / TD-4100N / TD-4410D / TD-4420DN / TD-4510D / TD-4520DN / TD-4550DNWB / TD-4210D / TD-4420TN / TD-4520TN / TD-4650TNWB / TD-4750TNWB / TD-4650TNWBR / TD-4750TNWBR / TJ-4010TN / TJ-4005DN / TJ-4020TN / TJ-4021TN / TJ-4021TNR / TJ-4120TN / TJ-4121TN / TJ-4121TNR / TJ-4420TN / TJ-4422TN / TJ-4520TN / TJ-4522TN / TJ-4620TN
+| **noCut** | **autoCut** | **cutAtEnd** | **Result** |
+|:---:|:---:|:---:|---:|
+|✔️|-|-|![noCut](../.github/images/no-margin-no-cut.png) |
+|-|-|✔️|![cutAtEnd](../.github/images/no-cut-no-margin.png) |
+|-|✔️|-|![autoCut](../.github/images/auto-cut-no-margin.png) |
+|-|✔️|✔️|![autoCut cutAtEnd](../.github/images/auto-cut-no-margin.png) |
diff --git a/docs/usage.md b/docs/usage.md
@@ -6,7 +6,7 @@ Install package
 ```sh
 $ npm install bpac-js
 ```
-Import module - named and defaults ok.
+Import - named or defaults ok.
 
 ```javascript
 import BrotherBrotherSdk from "bpac-js";
@@ -16,7 +16,7 @@ import { BrotherBrotherSdk } from "bpac-js";
 ```
 
 ### CDN
-Include import at the top of your script file. And set type to module in .html (requires live-server or equivalent).
+Include import at the top of your script file, and set script type to module in .html (load using live-server or equivalent).
 
 ```javascript
 import BrotherSdk from "https://cdn.jsdelivr.net/npm/bpac-js@{version#}/dist/index.js";
@@ -31,17 +31,16 @@ import BrotherSdk from "https://cdn.jsdelivr.net/npm/bpac-js@{version#}/dist/ind
 ### Get Printer Name
 ```javascript
 // script.js file
-import BrotherSdk from "https://cdn.jsdelivr.net/npm/bpac-js@latest/dist/index.js";
-
 const getNameBtn = document.getElementById("get-name-btn");
 
 const tag = new BrotherSdk({
     templatePath: "C:/Templates/shoe-template.lbx",
     exportPath: "C:/Users/YourProfile/Desktop/Exported_Labels/",
+    printer: "Brother QL-820NWB"
 });
 
 // Returns the printer associated with the template in string format
-const getName = async () => {
+const getPrinter = async () => {
     try {
         const printer = await tag.getPrinterName();
         console.log({printer}) // Output: {printer: "Brother QL-820NWB"}
@@ -50,18 +49,16 @@ const getName = async () => {
     }
 };
 
-getNameBtn.addEventListener("click", getName);
+getNameBtn.addEventListener("click", getPrinter);
 
 ```
 
 ### Get List Of Printers
 ```javascript
 // script.js file
-import BrotherSdk from "https://cdn.jsdelivr.net/npm/bpac-js@latest/dist/index.js";
-
 const getNameBtn = document.getElementById("get-name-btn");
 
-const getNames = async () => {
+const getPrinters = async () => {
     try {
         const printers = await BrotherSdk.getPrinterList();
         console.log({printers}) // Output: {printers: ["Brother QL-820NWB", "Brother PT-9800PCN"]}
@@ -70,20 +67,19 @@ const getNames = async () => {
     }
 };
 
-getNameBtn.addEventListener("click", getNames);
+getNameBtn.addEventListener("click", getPrinters);
 
 ```
 
 ### Print
 ```javascript
 // script.js file
-import BrotherSdk from "https://cdn.jsdelivr.net/npm/bpac-js@latest/dist/index.js";
-
 const printBtn = document.getElementById("print-btn");
 
 const tag = new BrotherSdk({
     templatePath: "C:/Templates/shoe-template.lbx",
     exportPath: "C:/Users/YourProfile/Desktop/Exported_Labels/",
+    printer: "Brother QL-820NWB"
 });
 
 // The keys and values must match the objects/types in the template file.
@@ -94,14 +90,14 @@ const data = {
     date: new Date("2024-1-20"),
 };
 
-// Docs >> Options >> Print Config Options - for all options
+// Docs >> Options >> Print Options - for all options
 const options = {
     copies: 1,
     printName: "Air Force Label",
     highResolution: true
 }
 
-const sendToPrinter = async () => {
+const handlePrint = async () => {
     try {
         const isPrinted = await tag.print(data, options);
         console.log({isPrinted})
@@ -110,21 +106,20 @@ const sendToPrinter = async () => {
     }
 };
 
-printBtn.addEventListener("click", sendToPrinter);
+printBtn.addEventListener("click", handlePrint);
 
 ```
 
 ### Preview
 ```javascript
 // script.js file
-import BrotherSdk from "https://cdn.jsdelivr.net/npm/bpac-js@latest/dist/index.mjs";
-
 const previewBtn = document.getElementById("preview-btn");
 const imgOutput = document.getElementById("img")
 
 const tag = new BrotherSdk({
     templatePath: "C:/Templates/shoe-template.lbx",
     exportPath: "C:/Users/YourProfile/Desktop/Exported_Labels/",
+    printer: "Brother QL-820NWB"
 });
 
 // The keys and values must match the objects/types in the template file.
@@ -140,7 +135,7 @@ const options = {
     height: 0 // Optional - Defaults to 0
 }
 
-const previewImage = async () => {
+const handlePreview = async () => {
     try {
         const data = await tag.getImageData(data, options); //image data
         imgOutput.src = data;
@@ -149,20 +144,19 @@ const previewImage = async () => {
     }
 };
 
-previewBtn.addEventListener("click", previewImage);
+previewBtn.addEventListener("click", handlePreview);
 
 ```
 
 ### Export
 ```javascript
 // script.js file
-import BrotherSdk from "https://cdn.jsdelivr.net/npm/bpac-js@latest/dist/index.mjs";
-
-const expBtn = document.getElementById("export-btn");
+const exp = document.getElementById("export-btn");
 
 const tag = new BrotherSdk({
     templatePath: "C:/Templates/shoe-template.lbx",
     exportPath: "C:/Users/YourProfile/Desktop/Exported_Labels/",
+    printer: "Brother QL-820NWB"
 });
 
 // The keys and values must match the objects/types in the template file.
@@ -173,16 +167,16 @@ const data = {
     date: new Date("2024-1-20"),
 };
 
-const exportFile = async () => {
+const handleExport = async () => {
     try {
-        // Docs >> Options >> Supported Export Extensions - for support file types
+        // Docs >> Options >> Supported Ext Types - for support file types
         const success = await tag.export(data, "Air-Force.bmp", 300);
         console.log({success}) // Output: {success: true}
     } catch (error) {
         console.log({error})
     }
 };
 
-expBtn.addEventListener("click", exportFile);
+exp.addEventListener("click", handleExport);
 
 ```