@mimasu/tdt 3.0.0-beta.1 → 3.0.3

package/LICENSE.md

@@ -0,0 +1,58 @@
+# TagDataTranslation -- Licensing
+
+TagDataTranslation is licensed under the **Business Source License 1.1** (BSL 1.1).
+
+## What This Means
+
+The BSL 1.1 allows you to freely copy, modify, create derivative works, redistribute, and make **non-production use** of the library. Production use requires a commercial license.
+
+This is the same licensing model used by HashiCorp (Terraform), MariaDB, Sentry, and CockroachDB.
+
+## Non-Production Use (Free)
+
+You may use TagDataTranslation without a commercial license for:
+
+- Development and testing
+- Evaluation and proof-of-concept
+- Academic and educational purposes
+- Personal non-commercial projects
+- Contributing to the project
+
+## Production Use (Commercial License Required)
+
+Any production deployment requires a commercial license. This includes:
+
+- Production internal tools and services
+- Products sold to customers
+- Production mobile apps (Android, iOS, MAUI)
+- Production APIs and network services
+
+See `TagDataTranslation/Licenses/COMMERCIAL-LICENSE.md` for details, or contact:
+
+- **Email:** tdt@mimasu.nl
+- **Web:** https://www.mimasu.nl
+
+## Change Date
+
+Each version of the Licensed Work automatically converts to **Apache License 2.0** four years after its initial publication. At that point, all production-use restrictions are removed for that version.
+
+## GS1 Artifacts
+
+The included JSON scheme definitions and XSD artifacts are (c) GS1 and are subject to GS1's terms of use. See https://www.gs1.org/standards/epc-rfid/tdt.
+
+## FAQ
+
+**Q: Can I use TagDataTranslation in a commercial product?**
+Yes, with a commercial license. Contact tdt@mimasu.nl.
+
+**Q: Can I use it for testing and development?**
+Yes, non-production use is free under BSL 1.1.
+
+**Q: What about internal production tools?**
+Internal production use also requires a commercial license.
+
+**Q: When does it become fully open source?**
+Each version converts to Apache 2.0 four years after its release date.
+
+**Q: Can I fork the code?**
+Yes, you can copy and modify the code. The BSL 1.1 terms apply to your derivative work as well -- non-production use is free, production use requires a commercial license (until the Change Date).

package/README.md

@@ -50,6 +50,17 @@ Convert hexadecimal to binary string.
 
 Convert binary string to hexadecimal.
 
+## 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.
+
+| Operation | .NET native |
+|-----------|-------------|
+| SGTIN-96 encode | 7.8 us |
+| SGTIN-96 decode | 7.7 us |
+| HexToBinary (96-bit) | 99 ns |
+| BinaryToHex (96-bit) | 54 ns |
+
 ## License
 
 Business Source License 1.1. Production use requires a commercial license -- contact tdt@mimasu.nl.

package/dist/index.d.ts

@@ -19,13 +19,22 @@ export interface TDTEngine {
    */
   tryTranslate(epcIdentifier: string, parameterList: string, outputFormat: string): string | null;
 
+  /**
+   * Translate an EPC identifier and return detailed results including all decoded fields.
+   * @returns JSON object with output string and fields dictionary, or null if translation failed
+   */
+  translateDetails(epcIdentifier: string, parameterList: string, outputFormat: string): { output: string; fields: Record<string, string> } | null;
+
   /** Convert hexadecimal string to binary string */
   hexToBinary(hex: string): string;
 
   /** Convert binary string to hexadecimal string */
   binaryToHex(binary: string): string;
 
-  /** Get any errors encountered while loading scheme files */
+  /**
+   * Get any errors encountered while loading scheme files.
+   * Returns a newline-delimited string of error messages, or "" if none.
+   */
   getLoadErrors(): string;
 }
 

package/dist/index.js

@@ -37,6 +37,11 @@ async function createEngine() {
     tryTranslate: (epcIdentifier, parameterList, outputFormat) =>
       interop.TryTranslate(epcIdentifier, parameterList, outputFormat),
 
+    translateDetails: (epcIdentifier, parameterList, outputFormat) => {
+      const json = interop.TranslateDetails(epcIdentifier, parameterList, outputFormat);
+      return json ? JSON.parse(json) : null;
+    },
+
     hexToBinary: (hex) => interop.HexToBinary(hex),
 
     binaryToHex: (binary) => interop.BinaryToHex(binary),