tigertag 1.0.5 → 1.0.6

package/CHANGELOG.md

@@ -3,6 +3,33 @@
 All notable changes to this project will be documented in this file.
 Format based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [1.0.6] — 2026-05-22
+
+### Fixed
+- `toRawDict()` — `color_r2/g2/b2` and `color_r3/g3/b3` are forced to `0` when
+  `num_colors < 2/3`. Consumers always receive clean, zero-padded values for inactive
+  color slots; EEPROM garbage from the chip can never leak through to callers of
+  `toRawDict()`.
+- Playground `SDK Input` — `color2R/G/B` and `color3R/G/B` are omitted from the
+  `TigerTag.create()` call when the aspect indicates fewer than 2 or 3 active colors.
+  The SDK's natural default of `0` handles the zeroing; no spurious color bytes are
+  passed.
+- `_baseUnitFields()` — unrecognised `id_unit` values now return
+  `{ measure_gr: 0, measure_available_gr: 0 }` instead of `{}`. Consumers always receive a
+  defined, zero-safe value; chips with corrupt or unknown units no longer propagate garbage
+  weight values.
+
+### Added
+- `create()` now validates required fields and throws a descriptive `Error` listing every
+  missing field: `idMaterial`, `idAspect1`, `idType`, `idBrand`, `color1R`, `color1G`,
+  `color1B`, `color1A`, `measure`, `idUnit`. Validation checks **presence only** — any value
+  including `0` is accepted once the field is explicitly provided.
+- `toRawDict()` exposes two new fields derived from the aspect DB:
+  - `num_colors` — number of active color slots (1 for Basic/Silk/etc., 2 for Bicolor, 3 for
+    Tricolor/Rainbow). Aspect 2 is checked first; falls back to Aspect 1.
+  - `color_list` — `string[]` of `#RRGGBB` hex strings, one per active slot only. Consumers
+    no longer need to filter inactive slots themselves.
+
 ## [1.0.5] — 2026-05-22
 
 ### Added

package/README.md

@@ -268,6 +268,9 @@ tag.toDict(db)                         // → object   JSON-serializable, all la
                                        //            .measure includes measure_gr/ml/mm/mm2 + measure_available_*
 tag.toRawDict()                        // → object   raw protocol fields, no resolution
                                        //            includes measure_gr/ml/mm/mm2 + measure_available_* (base-unit)
+                                       //            color_r2/g2/b2 and color_r3/g3/b3 are zeroed for inactive slots
+                                       //            num_colors — active color slot count from aspect DB (1/2/3)
+                                       //            color_list — string[] of #RRGGBB for active slots only
 tag.toBytes(includeSignature = false)  // → Buffer   re-serialize to chip bytes
 tag.validate()                         // → string[] sanity check — list of warnings
 tag.verify(db)                         // → SignatureResult

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tigertag",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "JavaScript SDK for TigerTag RFID material identification",
   "main": "src/index.js",
   "bin": {

package/src/tag.js

@@ -424,17 +424,17 @@ class TigerTag {
   static create({
     productId     = MAKER_PRODUCT_ID,
     uid           = null,
-    idMaterial    = 0,
-    idAspect1     = 0,
+    idMaterial    = undefined,   // required
+    idAspect1     = undefined,   // required
     idAspect2     = 0,
-    idType        = 0,
+    idType        = undefined,   // required
     idDiameter    = 0,
-    idBrand       = 0,
-    color1R       = 0, color1G = 0, color1B = 0, color1A = 255,
+    idBrand       = undefined,   // required
+    color1R       = undefined, color1G = undefined, color1B = undefined, color1A = undefined, // required
     color2R       = 0, color2G = 0, color2B = 0,
     color3R       = 0, color3G = 0, color3B = 0,
-    measure       = 0,
-    idUnit        = 0,
+    measure       = undefined,   // required
+    idUnit        = undefined,   // required
     nozzleTempMin = 0,
     nozzleTempMax = 0,
     dryTemp       = 0,
@@ -455,6 +455,24 @@ class TigerTag {
       productId  = MAKER_PRODUCT_ID;
     }
 
+    // ── Required field validation ────────────────────────────────────────────
+    // Check presence only — any value (including 0) is accepted once provided.
+    const _missing = [];
+    if (idMaterial === undefined) _missing.push('idMaterial');
+    if (idAspect1  === undefined) _missing.push('idAspect1');
+    if (idType     === undefined) _missing.push('idType');
+    if (idBrand    === undefined) _missing.push('idBrand');
+    if (measure    === undefined) _missing.push('measure');
+    if (idUnit     === undefined) _missing.push('idUnit');
+    if (color1R    === undefined) _missing.push('color1R');
+    if (color1G    === undefined) _missing.push('color1G');
+    if (color1B    === undefined) _missing.push('color1B');
+    if (color1A    === undefined) _missing.push('color1A');
+    if (_missing.length > 0) {
+      throw new Error(
+        `TigerTag.create() — missing required field(s): ${_missing.join(', ')}`
+      );
+    }
     if (timestamp == null) {
       timestamp = Math.max(0, Math.floor((Date.now() - _TIGERTAG_EPOCH_MS) / 1000));
     }
@@ -1007,7 +1025,9 @@ class TigerTag {
       };
     }
 
-    return {};
+    // Unknown unit — no conversion available; return zero base-unit fields so
+    // consumers always get a defined, safe value instead of undefined/garbage.
+    return { measure_gr: 0, measure_available_gr: 0 };
   }
 
   /**
@@ -1016,6 +1036,14 @@ class TigerTag {
    * @returns {object}
    */
   toRawDict() {
+    // Active color count: aspect2 takes priority for multi-color modes
+    // (Bicolor → 2, Tricolor/Rainbow → 3). Falls back to aspect1 (Basic → 1).
+    const _db = this.db;
+    const _a2cc = (_db.aspect(this.idAspect2) || {}).color_count || 0;
+    const _a1cc = (_db.aspect(this.idAspect1) || {}).color_count || 1;
+    const numColors = _a2cc > 0 ? _a2cc : _a1cc;
+    const colorList = [this.color1Hex, this.color2Hex, this.color3Hex].slice(0, numColors);
+
     return {
       id_tigertag:        this.idTigertag,
       id_product:         this.idProduct,
@@ -1038,16 +1066,18 @@ class TigerTag {
       bed_min:            this.bedTempMin,
       bed_max:            this.bedTempMax,
       timestamp:          this.timestamp,
-      color_r2:           this.color2R,
-      color_g2:           this.color2G,
-      color_b2:           this.color2B,
-      color_r3:           this.color3R,
-      color_g3:           this.color3G,
-      color_b3:           this.color3B,
+      color_r2:           numColors >= 2 ? this.color2R : 0,
+      color_g2:           numColors >= 2 ? this.color2G : 0,
+      color_b2:           numColors >= 2 ? this.color2B : 0,
+      color_r3:           numColors >= 3 ? this.color3R : 0,
+      color_g3:           numColors >= 3 ? this.color3G : 0,
+      color_b3:           numColors >= 3 ? this.color3B : 0,
       td_raw:             this.tdRaw,
       message:            this.customMessage,
       measure_available:  this.measureAvailable,
       ...TigerTag._baseUnitFields(this.measure, this.measureAvailable, this.idUnit),
+      num_colors:         numColors,
+      color_list:         colorList,
       uid:                this.uidHex,
       product_page_url:   this.productPageUrl,
       api_url:            this.apiUrl,