@deconz-community/ddf-validator 2.16.0 → 2.18.0

package/dist/ddf-validator.mjs

@@ -1,11 +1,12 @@
 import { z as e } from "zod";
-const E = "2.16.0", y = {
+const E = "2.18.0", y = {
   "devcap1.schema.json": [
     O,
     _,
     $,
     w,
-    C
+    C,
+    A
   ],
   "constants2.schema.json": [
     T
@@ -15,8 +16,8 @@ function O(t, a, u) {
   const n = typeof t.manufacturername == "string" && typeof t.modelid == "string";
   if (n)
     return;
-  const c = Array.isArray(t.manufacturername) && Array.isArray(t.modelid);
-  if (c && t.manufacturername.length !== t.modelid.length) {
+  const d = Array.isArray(t.manufacturername) && Array.isArray(t.modelid);
+  if (d && t.manufacturername.length !== t.modelid.length) {
     a.addIssue({
       code: e.ZodIssueCode.invalid_intersection_types,
       message: "When 'manufacturername' and 'modelid' are both arrays they should be the same length",
@@ -24,7 +25,7 @@ function O(t, a, u) {
     });
     return;
   }
-  (n || c) === !1 && a.addIssue({
+  (n || d) === !1 && a.addIssue({
     code: e.ZodIssueCode.invalid_intersection_types,
     message: "Invalid properties 'manufacturername' and 'modelid' should have the same type",
     path: ["manufacturername", "modelid"]
@@ -33,22 +34,22 @@ function O(t, a, u) {
 function _(t, a, u) {
   if (!t.bindings)
     return;
-  const n = (s) => `0x${(typeof s == "number" ? s : Number.parseInt(s, 16)).toString(16)}`, c = {};
-  t.bindings.forEach((s) => {
-    s.bind === "unicast" && s.report && s.report.forEach((d) => {
-      d.max !== 65535 && (c[`${n(s["src.ep"])}.${n(s.cl)}.${n(d.at)}`] = d.max);
+  const n = (i) => `0x${(typeof i == "number" ? i : Number.parseInt(i, 16)).toString(16)}`, d = {};
+  t.bindings.forEach((i) => {
+    i.bind === "unicast" && i.report && i.report.forEach((l) => {
+      l.max !== 65535 && (d[`${n(i["src.ep"])}.${n(i.cl)}.${n(l.at)}`] = l.max);
     });
-  }), t.subdevices.forEach((s, d) => {
-    s.items.forEach((i, o) => {
-      var l;
-      if (i["refresh.interval"] && i.read && i.read.fn === "zcl") {
-        const h = n(i.read.ep ?? ((l = s.fingerprint) == null ? void 0 : l.endpoint) ?? s.uuid[1]), b = Array.isArray(i.read.at) ? i.read.at : [i.read.at];
-        for (let v = 0; v < b.length; v++) {
-          const g = `${h}.${n(i.read.cl)}.${n(b[v])}`;
-          c[g] !== void 0 && i["refresh.interval"] - 60 < c[g] && a.addIssue({
+  }), t.subdevices.forEach((i, l) => {
+    i.items.forEach((s, o) => {
+      var c;
+      if (s["refresh.interval"] && s.read && s.read.fn === "zcl") {
+        const b = n(s.read.ep ?? ((c = i.fingerprint) == null ? void 0 : c.endpoint) ?? i.uuid[1]), h = Array.isArray(s.read.at) ? s.read.at : [s.read.at];
+        for (let v = 0; v < h.length; v++) {
+          const g = `${b}.${n(s.read.cl)}.${n(h[v])}`;
+          d[g] !== void 0 && s["refresh.interval"] - 60 < d[g] && a.addIssue({
             code: e.ZodIssueCode.custom,
-            message: `The refresh interval (${i["refresh.interval"]} - 60 = ${i["refresh.interval"] - 60}) should be greater than the binding max refresh value (${c[g]}) with a margin of 60 seconds`,
-            path: ["subdevices", d, "items", o, "refresh.interval"]
+            message: `The refresh interval (${s["refresh.interval"]} - 60 = ${s["refresh.interval"] - 60}) should be greater than the binding max refresh value (${d[g]}) with a margin of 60 seconds`,
+            path: ["subdevices", l, "items", o, "refresh.interval"]
           });
         }
       }
@@ -146,41 +147,41 @@ function $(t, a, u) {
         }
       }
     }
-  ], c = (s, d) => typeof s == "string" ? d(s) : Array.isArray(s) ? s.every((i) => c(i, d)) : "and" in s ? s.and.every((i) => c(i, d)) : "or" in s ? s.or.some((i) => c(i, d)) : !1;
-  t.subdevices.forEach((s, d) => {
-    const i = s.items.map((o) => o.name);
+  ], d = (i, l) => typeof i == "string" ? l(i) : Array.isArray(i) ? i.every((s) => d(s, l)) : "and" in i ? i.and.every((s) => d(s, l)) : "or" in i ? i.or.some((s) => d(s, l)) : !1;
+  t.subdevices.forEach((i, l) => {
+    const s = i.items.map((o) => o.name);
     n.forEach((o) => {
-      (Object.keys(o.if).length === 0 || Object.entries(o.if).some(([l, h]) => {
-        switch (l) {
+      (Object.keys(o.if).length === 0 || Object.entries(o.if).some(([c, b]) => {
+        switch (c) {
           case "type":
-            return c(h, (b) => b === s.type);
+            return d(b, (h) => h === i.type);
           case "item":
-            return c(h, (b) => i.includes(b));
+            return d(b, (h) => s.includes(h));
           default:
             return !1;
         }
-      })) && (c(o.need.item, (l) => i.includes(l)) || a.addIssue({
+      })) && (d(o.need.item, (c) => s.includes(c)) || a.addIssue({
         code: e.ZodIssueCode.custom,
         message: `The device is missing some items because ${o.description}`,
-        path: ["subdevices", d, "items"]
+        path: ["subdevices", l, "items"]
       }));
     });
   });
 }
 function w(t, a, u) {
   const n = ["parse", "write"];
-  t.subdevices.forEach((c, s) => {
-    c.items.forEach((d, i) => {
+  t.subdevices.forEach((d, i) => {
+    d.items.forEach((l, s) => {
       n.forEach((o) => {
-        const l = d[o];
-        l !== void 0 && (l.fn === void 0 || l.fn === "zcl" || l.fn === "zcl:attr" || l.fn === "zcl:cmd") && (l.eval === void 0 && l.script === void 0 && a.addIssue({
+        const c = l[o];
+        c !== void 0 && (c.fn === void 0 || c.fn === "zcl" || c.fn === "zcl:attr" || c.fn === "zcl:cmd") && (c.eval === void 0 && c.script === void 0 && a.addIssue({
           code: e.ZodIssueCode.custom,
           message: `The '${o}' function is missing 'eval' or 'script' option.`,
-          path: ["subdevices", s, "items", i, o]
-        }), l.eval !== void 0 && l.script !== void 0 && a.addIssue({
+          path: ["subdevices", i, "items", s, o]
+        }), c.eval !== void 0 && c.script !== void 0 && a.addIssue({
           code: e.ZodIssueCode.custom,
           message: `The '${o}' function is having both 'eval' and 'script' option.`,
-          path: ["subdevices", s, "items", i, o]
+          path: ["subdevices", i, "items", s, o]
         }));
       });
     });
@@ -188,46 +189,58 @@ function w(t, a, u) {
 }
 function T(t, a, u) {
   const n = I();
-  Object.keys(t).forEach((c) => {
-    if (!Object.keys(n.shape).includes(c)) {
-      if (!["$MF_", "$TYPE_"].some((s) => c.startsWith(s))) {
+  Object.keys(t).forEach((d) => {
+    if (!Object.keys(n.shape).includes(d)) {
+      if (!["$MF_", "$TYPE_"].some((i) => d.startsWith(i))) {
         a.addIssue({
           code: e.ZodIssueCode.custom,
           message: "The constant key should start with '$MF_' or '$TYPE_'",
-          path: [c]
+          path: [d]
         });
         return;
       }
-      typeof t[c] != "string" && a.addIssue({
+      typeof t[d] != "string" && a.addIssue({
         code: e.ZodIssueCode.custom,
         message: "The constant value should be a string",
-        path: [c]
+        path: [d]
       });
     }
   });
 }
 function C(t, a, u) {
-  t.subdevices.forEach((n, c) => {
-    const s = u.subDevices[n.type];
-    if (!s) {
+  t.subdevices.forEach((n, d) => {
+    const i = u.subDevices[n.type];
+    if (!i) {
       a.addIssue({
         code: e.ZodIssueCode.custom,
         message: `The device is missing the device definition for the type "${n.type}"`,
-        path: ["subdevices", c, "items"]
+        path: ["subdevices", d, "items"]
       });
       return;
     }
-    let d = s.items;
-    s.items_optional && (d = d.filter((i) => !s.items_optional.includes(i))), d.forEach((i) => {
-      n.items.find((o) => o.name === i) || a.addIssue({
+    let l = i.items;
+    i.items_optional && (l = l.filter((s) => !i.items_optional.includes(s))), l.forEach((s) => {
+      n.items.find((o) => o.name === s) || a.addIssue({
         code: e.ZodIssueCode.custom,
-        message: `The device should have the item "${i}" because it is mandatory for devices of type "${n.type}"`,
-        path: ["subdevices", c, "items"]
+        message: `The device should have the item "${s}" because it is mandatory for devices of type "${n.type}"`,
+        path: ["subdevices", d, "items"]
       });
     });
   });
 }
-function A(t) {
+function A(t, a, u) {
+  t.subdevices.forEach((n, d) => {
+    const i = n.items.map((l) => l.name);
+    n.items.forEach((l, s) => {
+      l.parse && l.parse.fn === "numtostr" && (i.includes(l.parse.srcitem) || a.addIssue({
+        code: e.ZodIssueCode.custom,
+        message: `The device should have the item "${l.parse.srcitem}" because it is used in the 'numtostr' function`,
+        path: ["subdevices", d, "items", s, "parse", "srcitem"]
+      }));
+    });
+  });
+}
+function M(t) {
   return e.strictObject({
     $schema: e.optional(e.string()),
     schema: e.literal("constants1.schema.json"),
@@ -241,7 +254,7 @@ function I(t) {
     schema: e.literal("constants2.schema.json")
   }).passthrough();
 }
-function M() {
+function S() {
   return e.string().regex(
     // Regex for AAAA-MM-JJ
     /^(\d{4})-(?:(?:0[1-9])|(?:1[0-2]))-(?:(?:0[1-9])|(?:[12][0-9])|(?:3[01]))$/,
@@ -258,7 +271,7 @@ function m() {
     e.number().min(0).max(255)
   ]);
 }
-function S() {
+function J() {
   return e.custom((t) => {
     if (!Array.isArray(t) || t.length % 2 !== 0)
       return !1;
@@ -289,7 +302,7 @@ function f() {
 function p() {
   return e.string();
 }
-function J() {
+function Z() {
   return e.discriminatedUnion("fn", [
     e.strictObject({
       fn: e.literal("none")
@@ -337,7 +350,7 @@ function J() {
     message: "eval and script should not both be present"
   });
 }
-function Z() {
+function G(t) {
   return e.discriminatedUnion("fn", [
     e.strictObject({
       fn: e.undefined().describe("Generic function to parse ZCL attributes and commands."),
@@ -385,10 +398,11 @@ function Z() {
     }),
     e.strictObject({
       fn: e.literal("numtostr").describe("Generic function to to convert number to string."),
-      // TODO use generic
-      srcitem: e.enum(["state/airqualityppb", "state/pm2_5"]).describe("The source item holding the number."),
+      srcitem: e.enum(t.attributes, {
+        errorMap: (a, u) => a.code === "invalid_enum_value" ? { message: `Invalid enum value. Expected item from generic attributes definition, received '${a.received}'` } : { message: u.defaultError }
+      }).describe("The source item holding the number."),
       op: e.enum(["lt", "le", "eq", "gt", "ge"]).describe("Comparison operator (lt | le | eq | gt | ge)"),
-      to: S().describe("Array of (num, string) mappings")
+      to: J().describe("Array of (num, string) mappings")
     }),
     e.strictObject({
       fn: e.literal("time").describe("Specialized function to parse time, local and last set time from read/report commands of the time cluster and auto-sync time if needed.")
@@ -408,11 +422,11 @@ function Z() {
       eval: e.optional(p()).describe("Javascript expression to transform the raw value."),
       script: e.optional(f()).describe("Relative path of a Javascript .js file.")
     })
-  ]).refine((t) => !("eval" in t && "script" in t), {
+  ]).refine((a) => !("eval" in a && "script" in a), {
     message: "eval and script should not both be present"
   });
 }
-function G() {
+function R() {
   return e.discriminatedUnion("fn", [
     e.strictObject({
       fn: e.literal("none")
@@ -480,7 +494,7 @@ function D(t) {
     id: e.string(),
     description: e.optional(e.string()).describe("Item description, better to do not use it."),
     comment: e.optional(e.string()).describe("TODO: What is this ? What the difference with description ?"),
-    deprecated: e.optional(M()).describe("Date of deprecation, if the item is deprecated, it's better to use the new one."),
+    deprecated: e.optional(S()).describe("Date of deprecation, if the item is deprecated, it's better to use the new one."),
     datatype: e.optional(e.enum([
       "String",
       "Bool",
@@ -505,9 +519,9 @@ function D(t) {
     static: e.optional(e.union([e.string(), e.number(), e.boolean()])).describe("A static default value is fixed and can be not changed."),
     range: e.optional(e.tuple([e.number(), e.number()])).describe("Values range limit."),
     virtual: e.optional(e.boolean()).describe("TODO: What is this ?"),
-    read: e.optional(J()).describe("Fonction used to read value."),
-    parse: e.optional(Z()).describe("Fonction used to parse incoming values."),
-    write: e.optional(G()).describe("Fonction used to write value."),
+    read: e.optional(Z()).describe("Fonction used to read value."),
+    parse: e.optional(G(t)).describe("Fonction used to parse incoming values."),
+    write: e.optional(R()).describe("Fonction used to write value."),
     "refresh.interval": e.optional(e.number()).describe("Refresh interval used for read fonction, NEED to be superior at value used in binding part."),
     // TODO Validate this
     values: e.optional(e.unknown()).describe("TODO: What is this ?"),
@@ -515,7 +529,7 @@ function D(t) {
     default: e.optional(e.unknown()).describe("Defaut value.")
   });
 }
-function R(t) {
+function F(t) {
   return e.strictObject({
     $schema: e.optional(e.string()),
     schema: e.literal("devcap1.schema.json"),
@@ -544,11 +558,11 @@ function R(t) {
     sleeper: e.optional(e.boolean()).describe("Sleeping devices can only receive when awake."),
     supportsMgmtBind: e.optional(e.boolean()),
     status: e.enum(["Draft", "Bronze", "Silver", "Gold"]).describe("The code quality of the DDF file."),
-    subdevices: e.array(F(t)).describe("Devices section."),
-    bindings: e.optional(e.array(k())).describe("Bindings section.")
+    subdevices: e.array(z(t)).describe("Devices section."),
+    bindings: e.optional(e.array(L())).describe("Bindings section.")
   });
 }
-function F(t) {
+function z(t) {
   return e.strictObject({
     type: e.union([
       e.enum(Object.keys(t.deviceTypes), {
@@ -574,12 +588,12 @@ function F(t) {
     buttons: e.optional(e.any()),
     // TODO validate this
     buttonevents: e.optional(e.any()),
-    items: e.array(z(t)),
+    items: e.array(k(t)),
     example: e.optional(e.unknown())
   });
 }
-function z(t) {
-  return D().omit({
+function k(t) {
+  return D(t).omit({
     $schema: !0,
     schema: !0,
     id: !0
@@ -589,7 +603,7 @@ function z(t) {
     }).describe("Item name.")
   });
 }
-function k(t) {
+function L(t) {
   return e.discriminatedUnion("bind", [
     e.strictObject({
       bind: e.literal("unicast"),
@@ -615,7 +629,7 @@ function k(t) {
     })
   ]);
 }
-function L(t) {
+function W(t) {
   const a = e.array(
     e.enum(t.attributes, {
       errorMap: (u, n) => u.code === "invalid_enum_value" ? { message: `Invalid enum value. Expected item from generic attributes definition, received '${u.received}'` } : { message: n.defaultError }
@@ -640,11 +654,11 @@ function L(t) {
 }
 function x(t) {
   return e.discriminatedUnion("schema", [
-    R(t),
-    A(),
+    F(t),
+    M(),
     I(),
-    D(),
-    L(t)
+    D(t),
+    W(t)
   ]).superRefine((a, u) => {
     switch (a.schema) {
       case "devcap1.schema.json":
@@ -656,7 +670,7 @@ function x(t) {
     }
   });
 }
-function P(t = {
+function B(t = {
   attributes: [],
   manufacturers: {},
   deviceTypes: {},
@@ -667,47 +681,47 @@ function P(t = {
   const u = () => {
     a = x(t);
   };
-  return { generics: t, loadGeneric: (d) => {
-    const i = a.parse(d);
-    switch (i.schema) {
+  return { generics: t, loadGeneric: (s) => {
+    const o = a.parse(s);
+    switch (o.schema) {
       case "constants1.schema.json":
         t.manufacturers = {
           ...t.manufacturers,
-          ...i.manufacturers
+          ...o.manufacturers
         }, t.deviceTypes = {
           ...t.deviceTypes,
-          ...i["device-types"]
+          ...o["device-types"]
         };
         break;
       case "constants2.schema.json": {
-        Object.keys(i).filter((o) => o.startsWith("$MF_")).forEach((o) => {
-          t.manufacturers[o] = i[o];
-        }), Object.keys(i).filter((o) => o.startsWith("$TYPE_")).forEach((o) => {
-          t.deviceTypes[o] = i[o];
+        Object.keys(o).filter((c) => c.startsWith("$MF_")).forEach((c) => {
+          t.manufacturers[c] = o[c];
+        }), Object.keys(o).filter((c) => c.startsWith("$TYPE_")).forEach((c) => {
+          t.deviceTypes[c] = o[c];
         });
         break;
       }
       case "resourceitem1.schema.json": {
-        if (t.attributes.includes(i.id))
-          throw new Error(`Got duplicate resource item with attribute id '${i.id}'.`);
-        const o = i, l = i.id;
-        delete o.$schema, delete o.schema, delete o.id, t.resources[l] = o, t.attributes.push(l);
+        if (t.attributes.includes(o.id))
+          throw new Error(`Got duplicate resource item with attribute id '${o.id}'.`);
+        const c = o, b = o.id;
+        delete c.$schema, delete c.schema, delete c.id, t.resources[b] = c, t.attributes.push(b);
         break;
       }
       case "subdevice1.schema.json":
-        t.subDevices[i.type] = i, t.subDevices[i.name] = i;
+        t.subDevices[o.type] = o, t.subDevices[o.name] = o;
         break;
       default:
-        throw new Error(`Got invalid generic file, got data with schema '${i.schema}'.`);
+        throw new Error(`Got invalid generic file, got data with schema '${o.schema}'.`);
     }
     return u(), !0;
-  }, validate: (d) => a.parse(d), getSchema: () => a, version: E, isGeneric: (d) => [
+  }, validate: (s) => a.parse(s), getSchema: () => a, version: E, isGeneric: (s) => [
     "constants1.schema.json",
     "constants2.schema.json",
     "resourceitem1.schema.json",
     "subdevice1.schema.json"
-  ].includes(d) };
+  ].includes(s), isDDF: (s) => s === "devcap1.schema.json" };
 }
 export {
-  P as createValidator
+  B as createValidator
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deconz-community/ddf-validator",
-  "version": "2.16.0",
+  "version": "2.18.0",
   "description": "Validating DDF files for deconz",
   "keywords": [
     "deconz",
@@ -53,13 +53,13 @@
     "pnpm": ">=8.6.8",
     "node": ">=16.0.0"
   },
-  "packageManager": "pnpm@8.7.4",
+  "packageManager": "pnpm@8.7.5",
   "devDependencies": {
-    "@types/jsdom": "^21.1.2",
-    "@types/node": "^20.6.0",
+    "@types/jsdom": "^21.1.3",
+    "@types/node": "^20.6.2",
     "@types/pako": "^2.0.0",
-    "@typescript-eslint/eslint-plugin": "^6.6.0",
-    "@typescript-eslint/parser": "^6.6.0",
+    "@typescript-eslint/eslint-plugin": "^6.7.0",
+    "@typescript-eslint/parser": "^6.7.0",
     "degit": "^2.8.4",
     "eslint": "^8.49.0",
     "glob": "^10.3.4",