@deconz-community/ddf-validator 0.2.0 → 0.2.1

package/dist/ddf-validator.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("zod"),m=["$TYPE_AIR_PURIFIER","$TYPE_AIR_QUALITY_SENSOR","$TYPE_ALARM_SENSOR","$TYPE_BATTERY_SENSOR","$TYPE_COLOR_DIMMABLE_LIGHT","$TYPE_COLOR_LIGHT","$TYPE_COLOR_TEMPERATURE_LIGHT","$TYPE_CONSUMPTION_SENSOR","$TYPE_DIMMABLE_LIGHT","$TYPE_DIMMABLE_PLUGIN_UNIT","$TYPE_DIMMER_SWITCH","$TYPE_DOOR_LOCK_CONTROLLER","$TYPE_DOOR_LOCK","$TYPE_EXTENDED_COLOR_LIGHT","$TYPE_FIRE_SENSOR","$TYPE_HUMIDITY_SENSOR","$TYPE_LIGHT_LEVEL_SENSOR","$TYPE_ON_OFF_LIGHT","$TYPE_ON_OFF_OUTPUT","$TYPE_ON_OFF_PLUGIN_UNIT","$TYPE_OPEN_CLOSE_SENSOR","$TYPE_POWER_SENSOR","$TYPE_PRESENCE_SENSOR","$TYPE_PRESSURE_SENSOR","$TYPE_RANGE_EXTENDER","$TYPE_RELATIVE_ROTARY","$TYPE_SMART_PLUG","$TYPE_SPECTRAL_SENSOR","$TYPE_SWITCH","$TYPE_TEMPERATURE_SENSOR","$TYPE_THERMOSTAT","$TYPE_VIBRATION_SENSOR","$TYPE_WARNING_DEVICE","$TYPE_WATER_LEAK_SENSOR","$TYPE_WINDOW_COVERING_DEVICE","$TYPE_ZGP_SWITCH","ZHAAirPurifier","ZHAAirQuality","ZHAAlarm","ZHABattery","Color dimmable light","Color light","Color temperature light","ZHAConsumption","Dimmable light","Dimmable plug-in unit","Dimmer switch","Door lock controller","Door Lock","Extended color light","ZHAFire","ZHAHumidity","ZHALightLevel","On/Off light","On/Off output","On/Off plug-in unit","ZHAOpenClose","ZHAPower","ZHAPresence","ZHAPressure","Range extender","ZHARelativeRotary","Smart plug","ZHASpectral","ZHASwitch","ZHATemperature","ZHAThermostat","ZHAVibration","Warning device","ZHAWater","Window covering device","ZGPSwitch","ZHAAncillaryControl","ZHATime","ZHACarbonMonoxide","ZHADoorLock"];function e(n=void 0){return n===void 0?t.z.string():t.z.string().length(2+n)}function o(){return t.z.string()}function d(){return t.z.string()}function i(){return t.z.union([e(2),t.z.number().min(0).max(255)])}function r(){return t.z.string()}function E(){return t.z.custom(n=>{if(!Array.isArray(n)||n.length%2!==0)return!1;for(let a=0;a<n.length;a+=2){const c=n[a],u=n[a+1];if(typeof c!="number"||typeof u!="string")return!1}return!0},"The value must be an array with an even number of values and alternating between number and string.")}function b(n){return l().parse(n)}function T(){return t.z.discriminatedUnion("schema",[l().innerType()])}function l(){return t.z.strictObject({schema:t.z.literal("devcap1.schema.json"),"doc:path":t.z.optional(t.z.string()),"doc:hdr":t.z.optional(t.z.string()),"md:known_issues":t.z.optional(t.z.array(t.z.string())),manufacturername:t.z.string().or(t.z.array(t.z.string())),modelid:t.z.string().or(t.z.array(t.z.string())),vendor:t.z.optional(t.z.string()),comment:t.z.optional(t.z.string()),matchexpr:t.z.optional(o()),path:t.z.optional(r()),product:t.z.optional(t.z.string()),sleeper:t.z.optional(t.z.boolean()),supportsMgmtBind:t.z.optional(t.z.boolean()),status:t.z.enum(["Draft","Bronze","Silver","Gold"]),subdevices:t.z.array(z()),bindings:t.z.optional(t.z.array(p()))}).refine(n=>typeof n.manufacturername=="string"&&typeof n.modelid=="string"||Array.isArray(n.manufacturername)&&Array.isArray(n.modelid)&&n.manufacturername.length===n.modelid.length,{message:"manufacturername and modelid should be both strings or arrays with the same length.",path:["manufacturername","modelid"]})}function z(){return t.z.strictObject({type:t.z.enum(m),restapi:t.z.enum(["/lights","/sensors"]),uuid:t.z.union([t.z.tuple([t.z.literal("$address.ext"),e(2)]),t.z.tuple([t.z.literal("$address.ext"),e(2),e(4)])]),fingerprint:t.z.optional(t.z.strictObject({profile:e(4),device:e(4),endpoint:i(),in:t.z.optional(t.z.array(e(4))),out:t.z.optional(t.z.array(e(4)))})),meta:t.z.optional(t.z.strictObject({values:t.z.any(),"group.endpoints":t.z.optional(t.z.array(t.z.number()))})),buttons:t.z.optional(t.z.any()),buttonevents:t.z.optional(t.z.any()),items:t.z.array(s()),example:t.z.optional(t.z.unknown())})}function s(){return t.z.strictObject({name:t.z.string(),description:t.z.optional(t.z.string()),comment:t.z.optional(t.z.string()),public:t.z.optional(t.z.boolean()),static:t.z.optional(t.z.union([t.z.string(),t.z.number(),t.z.boolean()])),range:t.z.optional(t.z.tuple([t.z.number(),t.z.number()])),deprecated:t.z.optional(d()),access:t.z.optional(t.z.literal("R")),read:t.z.optional(t.z.discriminatedUnion("fn",[t.z.strictObject({fn:t.z.literal("none")}),t.z.strictObject({fn:t.z.undefined(),at:t.z.optional(e(4).or(t.z.array(e(4)))),cl:e(4),ep:t.z.optional(i()),mf:t.z.optional(e(4)),eval:t.z.optional(o())}),t.z.strictObject({fn:t.z.literal("zcl"),at:t.z.optional(e(4).or(t.z.array(e(4)))),cl:e(4),ep:t.z.optional(i()),mf:t.z.optional(e(4)),eval:t.z.optional(o())}),t.z.strictObject({fn:t.z.literal("tuya")})])),parse:t.z.optional(t.z.discriminatedUnion("fn",[t.z.strictObject({fn:t.z.undefined(),at:t.z.optional(e(4)),cl:e(4),ep:t.z.optional(i()),cmd:t.z.optional(e(2)),mf:t.z.optional(e(4)),eval:t.z.optional(o()),script:t.z.optional(r())}).refine(n=>!("eval"in n&&"script"in n),{message:"eval and script should not both be present"}).innerType(),t.z.strictObject({fn:t.z.literal("zcl"),at:t.z.optional(e(4)),cl:e(4),ep:t.z.optional(i()),cmd:t.z.optional(e(2)),mf:t.z.optional(e(4)),eval:t.z.optional(o()),script:t.z.optional(r())}).refine(n=>!("eval"in n&&"script"in n),{message:"eval and script should not both be present"}).innerType(),t.z.strictObject({fn:t.z.literal("ias:zonestatus"),mask:t.z.enum(["alarm1","alarm2"])}),t.z.strictObject({fn:t.z.literal("numtostr"),srcitem:t.z.enum(["state/airqualityppb","state/pm2_5"]),op:t.z.literal("le"),to:E()}),t.z.strictObject({fn:t.z.literal("xiaomi:special"),ep:t.z.optional(i()),at:t.z.optional(e(4)),idx:e(2),eval:t.z.optional(o()),script:t.z.optional(r())}).refine(n=>!("eval"in n&&"script"in n),{message:"eval and script should not both be present"}).innerType(),t.z.strictObject({fn:t.z.literal("tuya"),dpid:t.z.number(),eval:t.z.optional(o()),script:t.z.optional(r())}).refine(n=>!("eval"in n&&"script"in n),{message:"eval and script should not both be present"}).innerType()])),write:t.z.optional(t.z.discriminatedUnion("fn",[t.z.strictObject({fn:t.z.literal("none")}),t.z.strictObject({fn:t.z.undefined(),at:t.z.optional(e(4).or(t.z.array(e(4)))),"state.timeout":t.z.optional(t.z.number()),"change.timeout":t.z.optional(t.z.number()),cl:e(4),dt:e(2),ep:t.z.optional(i()),mf:t.z.optional(e(4)),eval:t.z.optional(o()),script:t.z.optional(r())}).refine(n=>!("eval"in n&&"script"in n),{message:"eval and script should not both be present"}).innerType(),t.z.strictObject({fn:t.z.literal("zcl"),at:t.z.optional(e(4).or(t.z.array(e(4)))),"state.timeout":t.z.optional(t.z.number()),"change.timeout":t.z.optional(t.z.number()),cl:e(4),dt:e(2),ep:t.z.optional(i()),mf:t.z.optional(e(4)),eval:t.z.optional(o()),script:t.z.optional(r())}).refine(n=>!("eval"in n&&"script"in n),{message:"eval and script should not both be present"}).innerType(),t.z.strictObject({fn:t.z.literal("tuya"),dpid:t.z.number(),dt:e(2),eval:t.z.optional(o()),script:t.z.optional(r())}).refine(n=>!("eval"in n&&"script"in n),{message:"eval and script should not both be present"}).innerType()])),awake:t.z.optional(t.z.boolean()),default:t.z.optional(t.z.unknown()),values:t.z.optional(t.z.unknown()),"refresh.interval":t.z.optional(t.z.number())})}function p(){return t.z.discriminatedUnion("bind",[t.z.strictObject({bind:t.z.literal("unicast"),"src.ep":i(),"dst.ep":t.z.optional(i()),cl:e(4),report:t.z.optional(t.z.array(t.z.strictObject({at:e(4),dt:e(2),mf:t.z.optional(e(4)),min:t.z.number(),max:t.z.number(),change:t.z.optional(e().or(t.z.number()))})))}),t.z.strictObject({bind:t.z.literal("groupcast"),"src.ep":i(),cl:e(4),"config.group":t.z.number()})])}exports.ddfSchema=l;exports.mainSchema=T;exports.subBindingSchema=p;exports.subDeviceItemSchema=s;exports.subDeviceSchema=z;exports.validate=b;

package/dist/ddf-validator.mjs

@@ -0,0 +1,349 @@
+import { z as t } from "zod";
+const c = [
+  "$TYPE_AIR_PURIFIER",
+  "$TYPE_AIR_QUALITY_SENSOR",
+  "$TYPE_ALARM_SENSOR",
+  "$TYPE_BATTERY_SENSOR",
+  "$TYPE_COLOR_DIMMABLE_LIGHT",
+  "$TYPE_COLOR_LIGHT",
+  "$TYPE_COLOR_TEMPERATURE_LIGHT",
+  "$TYPE_CONSUMPTION_SENSOR",
+  "$TYPE_DIMMABLE_LIGHT",
+  "$TYPE_DIMMABLE_PLUGIN_UNIT",
+  "$TYPE_DIMMER_SWITCH",
+  "$TYPE_DOOR_LOCK_CONTROLLER",
+  "$TYPE_DOOR_LOCK",
+  "$TYPE_EXTENDED_COLOR_LIGHT",
+  "$TYPE_FIRE_SENSOR",
+  "$TYPE_HUMIDITY_SENSOR",
+  "$TYPE_LIGHT_LEVEL_SENSOR",
+  "$TYPE_ON_OFF_LIGHT",
+  "$TYPE_ON_OFF_OUTPUT",
+  "$TYPE_ON_OFF_PLUGIN_UNIT",
+  "$TYPE_OPEN_CLOSE_SENSOR",
+  "$TYPE_POWER_SENSOR",
+  "$TYPE_PRESENCE_SENSOR",
+  "$TYPE_PRESSURE_SENSOR",
+  "$TYPE_RANGE_EXTENDER",
+  "$TYPE_RELATIVE_ROTARY",
+  "$TYPE_SMART_PLUG",
+  "$TYPE_SPECTRAL_SENSOR",
+  "$TYPE_SWITCH",
+  "$TYPE_TEMPERATURE_SENSOR",
+  "$TYPE_THERMOSTAT",
+  "$TYPE_VIBRATION_SENSOR",
+  "$TYPE_WARNING_DEVICE",
+  "$TYPE_WATER_LEAK_SENSOR",
+  "$TYPE_WINDOW_COVERING_DEVICE",
+  "$TYPE_ZGP_SWITCH",
+  "ZHAAirPurifier",
+  "ZHAAirQuality",
+  "ZHAAlarm",
+  "ZHABattery",
+  "Color dimmable light",
+  "Color light",
+  "Color temperature light",
+  "ZHAConsumption",
+  "Dimmable light",
+  "Dimmable plug-in unit",
+  "Dimmer switch",
+  "Door lock controller",
+  "Door Lock",
+  "Extended color light",
+  "ZHAFire",
+  "ZHAHumidity",
+  "ZHALightLevel",
+  "On/Off light",
+  "On/Off output",
+  "On/Off plug-in unit",
+  "ZHAOpenClose",
+  "ZHAPower",
+  "ZHAPresence",
+  "ZHAPressure",
+  "Range extender",
+  "ZHARelativeRotary",
+  "Smart plug",
+  "ZHASpectral",
+  "ZHASwitch",
+  "ZHATemperature",
+  "ZHAThermostat",
+  "ZHAVibration",
+  "Warning device",
+  "ZHAWater",
+  "Window covering device",
+  "ZGPSwitch",
+  "ZHAAncillaryControl",
+  "ZHATime",
+  "ZHACarbonMonoxide",
+  "ZHADoorLock"
+];
+function n(e = void 0) {
+  return e === void 0 ? t.string() : t.string().length(2 + e);
+}
+function o() {
+  return t.string();
+}
+function u() {
+  return t.string();
+}
+function i() {
+  return t.union([
+    n(2),
+    t.number().min(0).max(255)
+  ]);
+}
+function r() {
+  return t.string();
+}
+function m() {
+  return t.custom((e) => {
+    if (!Array.isArray(e) || e.length % 2 !== 0)
+      return !1;
+    for (let a = 0; a < e.length; a += 2) {
+      const s = e[a], p = e[a + 1];
+      if (typeof s != "number" || typeof p != "string")
+        return !1;
+    }
+    return !0;
+  }, "The value must be an array with an even number of values and alternating between number and string.");
+}
+function b(e) {
+  return l().parse(e);
+}
+function f() {
+  return t.discriminatedUnion("schema", [
+    l().innerType()
+  ]);
+}
+function l() {
+  return t.strictObject({
+    schema: t.literal("devcap1.schema.json"),
+    "doc:path": t.optional(t.string()),
+    "doc:hdr": t.optional(t.string()),
+    "md:known_issues": t.optional(t.array(t.string())),
+    manufacturername: t.string().or(t.array(t.string())),
+    modelid: t.string().or(t.array(t.string())),
+    vendor: t.optional(t.string()),
+    comment: t.optional(t.string()),
+    matchexpr: t.optional(o()),
+    path: t.optional(r()),
+    product: t.optional(t.string()),
+    sleeper: t.optional(t.boolean()),
+    supportsMgmtBind: t.optional(t.boolean()),
+    status: t.enum(["Draft", "Bronze", "Silver", "Gold"]),
+    subdevices: t.array(E()),
+    bindings: t.optional(t.array(_()))
+  }).refine((e) => typeof e.manufacturername == "string" && typeof e.modelid == "string" || Array.isArray(e.manufacturername) && Array.isArray(e.modelid) && e.manufacturername.length === e.modelid.length, {
+    message: "manufacturername and modelid should be both strings or arrays with the same length.",
+    path: ["manufacturername", "modelid"]
+  });
+}
+function E() {
+  return t.strictObject({
+    type: t.enum(c),
+    restapi: t.enum(["/lights", "/sensors"]),
+    uuid: t.union([
+      t.tuple([
+        t.literal("$address.ext"),
+        n(2)
+      ]),
+      t.tuple([
+        t.literal("$address.ext"),
+        n(2),
+        n(4)
+      ])
+    ]),
+    fingerprint: t.optional(t.strictObject({
+      profile: n(4),
+      device: n(4),
+      endpoint: i(),
+      in: t.optional(t.array(n(4))),
+      out: t.optional(t.array(n(4)))
+    })),
+    meta: t.optional(t.strictObject({
+      // TODO validate this
+      values: t.any(),
+      "group.endpoints": t.optional(t.array(t.number()))
+    })),
+    // TODO validate this
+    buttons: t.optional(t.any()),
+    // TODO validate this
+    buttonevents: t.optional(t.any()),
+    items: t.array(d()),
+    example: t.optional(t.unknown())
+  });
+}
+function d() {
+  return t.strictObject({
+    name: t.string(),
+    description: t.optional(t.string()),
+    comment: t.optional(t.string()),
+    public: t.optional(t.boolean()),
+    static: t.optional(t.union([t.string(), t.number(), t.boolean()])),
+    range: t.optional(t.tuple([t.number(), t.number()])),
+    deprecated: t.optional(u()),
+    access: t.optional(t.literal("R")),
+    read: t.optional(
+      t.discriminatedUnion("fn", [
+        t.strictObject({
+          fn: t.literal("none")
+        }),
+        t.strictObject({
+          fn: t.undefined(),
+          at: t.optional(n(4).or(t.array(n(4)))),
+          cl: n(4),
+          ep: t.optional(i()),
+          mf: t.optional(n(4)),
+          eval: t.optional(o())
+        }),
+        t.strictObject({
+          fn: t.literal("zcl"),
+          at: t.optional(n(4).or(t.array(n(4)))),
+          cl: n(4),
+          ep: t.optional(i()),
+          mf: t.optional(n(4)),
+          eval: t.optional(o())
+        }),
+        t.strictObject({
+          fn: t.literal("tuya")
+        })
+      ])
+    ),
+    parse: t.optional(
+      t.discriminatedUnion("fn", [
+        t.strictObject({
+          fn: t.undefined(),
+          at: t.optional(n(4)),
+          cl: n(4),
+          ep: t.optional(i()),
+          cmd: t.optional(n(2)),
+          mf: t.optional(n(4)),
+          eval: t.optional(o()),
+          script: t.optional(r())
+        }).refine((e) => !("eval" in e && "script" in e), {
+          message: "eval and script should not both be present"
+        }).innerType(),
+        t.strictObject({
+          fn: t.literal("zcl"),
+          at: t.optional(n(4)),
+          cl: n(4),
+          ep: t.optional(i()),
+          cmd: t.optional(n(2)),
+          mf: t.optional(n(4)),
+          eval: t.optional(o()),
+          script: t.optional(r())
+        }).refine((e) => !("eval" in e && "script" in e), {
+          message: "eval and script should not both be present"
+        }).innerType(),
+        t.strictObject({
+          fn: t.literal("ias:zonestatus"),
+          mask: t.enum(["alarm1", "alarm2"])
+        }),
+        t.strictObject({
+          fn: t.literal("numtostr"),
+          srcitem: t.enum(["state/airqualityppb", "state/pm2_5"]),
+          op: t.literal("le"),
+          to: m()
+        }),
+        t.strictObject({
+          fn: t.literal("xiaomi:special"),
+          ep: t.optional(i()),
+          at: t.optional(n(4)),
+          idx: n(2),
+          eval: t.optional(o()),
+          script: t.optional(r())
+        }).refine((e) => !("eval" in e && "script" in e), {
+          message: "eval and script should not both be present"
+        }).innerType(),
+        t.strictObject({
+          fn: t.literal("tuya"),
+          dpid: t.number(),
+          eval: t.optional(o()),
+          script: t.optional(r())
+        }).refine((e) => !("eval" in e && "script" in e), {
+          message: "eval and script should not both be present"
+        }).innerType()
+      ])
+    ),
+    write: t.optional(
+      t.discriminatedUnion("fn", [
+        t.strictObject({
+          fn: t.literal("none")
+        }),
+        t.strictObject({
+          fn: t.undefined(),
+          at: t.optional(n(4).or(t.array(n(4)))),
+          "state.timeout": t.optional(t.number()),
+          "change.timeout": t.optional(t.number()),
+          cl: n(4),
+          dt: n(2),
+          ep: t.optional(i()),
+          mf: t.optional(n(4)),
+          eval: t.optional(o()),
+          script: t.optional(r())
+        }).refine((e) => !("eval" in e && "script" in e), {
+          message: "eval and script should not both be present"
+        }).innerType(),
+        t.strictObject({
+          fn: t.literal("zcl"),
+          at: t.optional(n(4).or(t.array(n(4)))),
+          "state.timeout": t.optional(t.number()),
+          "change.timeout": t.optional(t.number()),
+          cl: n(4),
+          dt: n(2),
+          ep: t.optional(i()),
+          mf: t.optional(n(4)),
+          eval: t.optional(o()),
+          script: t.optional(r())
+        }).refine((e) => !("eval" in e && "script" in e), {
+          message: "eval and script should not both be present"
+        }).innerType(),
+        t.strictObject({
+          fn: t.literal("tuya"),
+          dpid: t.number(),
+          dt: n(2),
+          eval: t.optional(o()),
+          script: t.optional(r())
+        }).refine((e) => !("eval" in e && "script" in e), {
+          message: "eval and script should not both be present"
+        }).innerType()
+      ])
+    ),
+    awake: t.optional(t.boolean()),
+    default: t.optional(t.unknown()),
+    values: t.optional(t.unknown()),
+    "refresh.interval": t.optional(t.number())
+  });
+}
+function _() {
+  return t.discriminatedUnion("bind", [
+    t.strictObject({
+      bind: t.literal("unicast"),
+      "src.ep": i(),
+      "dst.ep": t.optional(i()),
+      cl: n(4),
+      report: t.optional(t.array(t.strictObject({
+        at: n(4),
+        dt: n(2),
+        mf: t.optional(n(4)),
+        min: t.number(),
+        max: t.number(),
+        change: t.optional(n().or(t.number()))
+      })))
+    }),
+    t.strictObject({
+      bind: t.literal("groupcast"),
+      "src.ep": i(),
+      cl: n(4),
+      "config.group": t.number()
+    })
+  ]);
+}
+export {
+  l as ddfSchema,
+  f as mainSchema,
+  _ as subBindingSchema,
+  d as subDeviceItemSchema,
+  E as subDeviceSchema,
+  b as validate
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deconz-community/ddf-validator",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Validating DDF files for deconz",
   "keywords": [
     "deconz",
@@ -35,7 +35,8 @@
     "url": "https://github.com/sponsors/Zehir"
   },
   "files": [
-    "./dist/"
+    "./dist/ddf-validator.cjs",
+    "./dist/ddf-validator.mjs"
   ],
   "main": "./dist/ddf-validator.cjs",
   "module": "./dist/ddf-validator.mjs",
@@ -76,11 +77,10 @@
     "build": "vite build",
     "build:cleanup": "rimraf ./dist",
     "build:vite": "vite build",
-    "build:dts": "dts-bundle-generator --config ./dts-bundle-generator.config.ts",
     "lint": "eslint",
     "test": "vitest run",
     "test:watch": "vitest",
-    "test:download-sample": "rimraf ./test-data && degit dresden-elektronik/deconz-rest-plugin ./test-data",
+    "test:download-sample": "rimraf ./test-data && degit dresden-elektronik/deconz-rest-plugin /tmp/test-data && mv /tmp/test-data/devices ./test-data && rimraf /tmp/test-data",
     "up": "taze major -I"
   }
 }