@mimasu/tdt 3.0.5 → 3.0.6

package/README.md

@@ -1,8 +1,12 @@
 # @mimasu/tdt
 
-GS1 EPC Tag Data Translation for JavaScript and TypeScript, powered by WebAssembly.
+**Encode and decode GS1 EPC identifiers for RAIN (UHF) RFID in JavaScript and TypeScript.** Convert between GTIN, SSCC, SGLN, and 50+ other formats — from barcode to EPC hex and back.
 
-Encode and decode all EPC schemes: SGTIN, SSCC, SGLN, GRAI, GIAI, GSRN, GDTI, and more. Supports TDS 2.3 with Digital Link URIs and '++' hostname encoding.
+Powered by WebAssembly. No native dependencies. Works in Node.js and browsers.
+
+Implements the **GS1 EPC Tag Data Standard (TDS) 2.3** and **Tag Data Translation (TDT) 2.2** specifications.
+
+**Try it online**: https://www.mimasu.nl/tag-data-translation/try-online
 
 ## Installation
 
@@ -12,50 +16,86 @@ npm install @mimasu/tdt
 
 ## Quick Start
 
+### Encode a GTIN to EPC Hex
+
+```javascript
+import { createEngine } from "@mimasu/tdt";
+
+const engine = await createEngine();
+
+// encode GTIN + serial to SGTIN-96 binary
+const epc = engine.translate(
+  "gtin=00037000302414;serial=10419703",
+  "filter=3;gs1companyprefixlength=7;tagLength=96",
+  "BINARY"
+);
+const hex = engine.binaryToHex(epc);
+console.log(hex);
+// 30340242201d8840009efdf7
+```
+
+### Decode EPC Hex to GTIN
+
+```javascript
+const binary = engine.hexToBinary("30340242201d8840009efdf7");
+const uri = engine.translate(binary, "tagLength=96", "PURE_IDENTITY");
+console.log(uri);
+// urn:epc:id:sgtin:0037000.030241.10419703
+```
+
+### CommonJS
+
 ```javascript
 const { createEngine } = require("@mimasu/tdt");
 
 async function main() {
   const engine = await createEngine();
-
-  // decode hex to pure identity URI
-  const binary = engine.hexToBinary("30340242201d8840009efdf7");
-  const uri = engine.translate(binary, "tagLength=96", "PURE_IDENTITY");
-  console.log(uri);
-  // urn:epc:id:sgtin:0037000.030241.10419703
+  // ...
 }
-
 main();
 ```
 
+## Use Cases
+
+- **Tag programming**: Encode GTINs and SSCCs to EPC hex for writing to RFID tags
+- **Tag reading**: Decode EPC hex from RFID readers back to human-readable identifiers
+- **Inventory systems**: Translate between barcode and RFID representations
+- **Supply chain apps**: Convert between GS1 Digital Link URIs and EPC binary
+
 ## API
 
 ### `createEngine(): Promise<TDTEngine>`
 
-Initialize the WASM engine. Must be called once before using translation methods.
+Initialize the WASM engine. Call once, reuse the engine instance for all translations.
 
 ### `engine.translate(epcIdentifier, parameterList, outputFormat): string`
 
-Translate an EPC between encoding levels. Throws on error.
+Translate an EPC between encoding levels. Output formats: `BINARY`, `LEGACY`, `LEGACY_AI`, `TAG_ENCODING`, `PURE_IDENTITY`.
+
+Throws on invalid input.
 
 ### `engine.tryTranslate(epcIdentifier, parameterList, outputFormat): string | null`
 
-Translate without throwing. Returns null on failure.
+Same as `translate`, but returns `null` instead of throwing. Use this for high-throughput scenarios.
 
 ### `engine.hexToBinary(hex): string`
 
-Convert hexadecimal to binary string.
+Convert hexadecimal string to binary string.
 
 ### `engine.binaryToHex(binary): string`
 
-Convert binary string to hexadecimal.
+Convert binary string to hexadecimal string.
+
+## Supported Schemes
+
+SGTIN-96, SGTIN-198, SSCC-96, SGLN-96, SGLN-195, GRAI-96, GRAI-170, GIAI-96, GIAI-202, GSRN-96, GSRNP-96, GDTI-96, GDTI-113, GDTI-174, SGCN-96, ITIP-110, ITIP-212, GID-96, CPI-96, CPI-var, ADI-var, USDOD-96, plus all TDS 2.3 '+' and '++' variants with Digital Link URI support.
 
 ## Performance
 
-The underlying .NET engine translates a typical SGTIN-96 in ~8 us. Hex/binary conversion completes in under 100 ns. The WASM bridge adds minimal overhead on top of the native .NET performance.
+The underlying .NET engine runs as compiled WebAssembly — no interpretation overhead.
 
-| Operation | .NET native |
-|-----------|-------------|
+| Operation | Time |
+|-----------|------|
 | SGTIN-96 encode | 7.8 us |
 | SGTIN-96 decode | 7.7 us |
 | HexToBinary (96-bit) | 99 ns |
@@ -63,4 +103,6 @@ The underlying .NET engine translates a typical SGTIN-96 in ~8 us. Hex/binary co
 
 ## License
 
-Business Source License 1.1. Production use requires a commercial license -- contact tdt@mimasu.nl.
+Business Source License 1.1 (BSL-1.1). Non-production use (development, testing, evaluation) is free. Production use requires a commercial license — contact tdt@mimasu.nl.
+
+See [LICENSING.md](https://github.com/dannyhaak/TagDataTranslation/blob/master/LICENSING.md) for full details.

package/dist/wasm/dotnet.boot.js

@@ -1,7 +1,7 @@
 export const config = /*json-start*/{
   "mainAssemblyName": "TagDataTranslation.Wasm.dll",
   "resources": {
-    "hash": "sha256-wAPo6Z0Zh9u4AxY1HsvmsV4judL6WL4JTwSHowySJwk=",
+    "hash": "sha256-+KTKJVkpDuUZLLbjjNmCCEOfzrBnRYXR/QKo1RSQiXE=",
     "jsModuleNative": [
       {
         "name": "dotnet.native.js"
@@ -879,12 +879,12 @@ export const config = /*json-start*/{
       {
         "virtualPath": "TagDataTranslation.wasm",
         "name": "TagDataTranslation.wasm",
-        "integrity": "sha256-VB+xhcCro/H46aiauAUUwgLShnZRaG97M1I+L9R6OxE="
+        "integrity": "sha256-3YlhafOJYNGsWlSEBxNV8jiBlOrHiiJ7BbVhP9UlcrM="
       },
       {
         "virtualPath": "TagDataTranslation.Wasm.wasm",
         "name": "TagDataTranslation.Wasm.wasm",
-        "integrity": "sha256-tBGAQEyQcwaLD0rbzUaSn+iTc5nWh5foC7sm08knDmM="
+        "integrity": "sha256-m8QfYTTomKZ6pUobndpMCoZy4AdgxpVOZem1n/lSeEk="
       },
       {
         "virtualPath": "WindowsBase.wasm",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimasu/tdt",
-  "version": "3.0.5",
+  "version": "3.0.6",
   "description": "GS1 EPC Tag Data Translation for JavaScript/TypeScript and RAIN (UHF) RFID via WebAssembly. Encode and decode SGTIN, SSCC, SGLN, GRAI, and all EPC schemes.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",