@kohost/api-client 1.0.0-alpha.1 → 1.0.0-alpha.2

package/index.js

@@ -1,73 +1,6 @@
-const Ajv = require("ajv");
-const ajv = new Ajv({ allErrors: true });
-
-const deviceSchema = require("./schemas/device.json");
-const switchSchema = require("./schemas/switch.json");
-const alarmSchema = require("./schemas/alarm.json");
-const dimmerSchema = require("./schemas/dimmer.json");
-const gatewaySchema = require("./schemas/gateway.json");
-const lockSchema = require("./schemas/lock.json");
-const sceneControllerSchema = require("./schemas/sceneController.json");
-const thermostatSchema = require("./schemas/thermostat.json");
-const windowCoveringSchema = require("./schemas/windowCovering.json");
-
-ajv.addSchema(deviceSchema);
-
-// compile all schemas
-const Switch = createClass(ajv.compile(switchSchema), "Switch");
-const Alarm = createClass(ajv.compile(alarmSchema), "Alarm");
-const Dimmer = createClass(ajv.compile(dimmerSchema), "Dimmer");
-const Gateway = createClass(ajv.compile(gatewaySchema), "Gateway");
-const Lock = createClass(ajv.compile(lockSchema), "Lock");
-const SceneController = createClass(
-  ajv.compile(sceneControllerSchema),
-  "SceneController"
-);
-const Thermostat = createClass(ajv.compile(thermostatSchema), "Thermostat");
-const WindowCovering = createClass(
-  ajv.compile(windowCoveringSchema),
-  "WindowCovering"
-);
-
-function createClass(validator, name) {
-  class Generic {
-    constructor(data) {
-      // apply schema properties to the class
-      //this._validator = validator;
-      this.validate(data);
-      Object.keys(validator.schema.properties).forEach((key) => {
-        if (data[key] !== undefined) this[key] = data[key];
-      });
-    }
-
-    validate(data) {
-      const valid = this._validator(data);
-      if (!valid)
-        throw new Error(`Invalid ${name}`, { cause: this._validator.errors });
-    }
-  }
-
-  // change the name of the class
-  Object.defineProperty(Generic, "name", { value: name });
-  Generic.prototype._validator = validator;
-  return Generic;
-}
-
-// Thermostat.prototype.toCelsius = function () {
-//   if (this.temperatureScale === "farenheit")
-//     this.currentTemperature = ((this.currentTemperature - 32) * 5) / 9;
-// };
+const Models = require("./models");
 
 // export all classes on the Models object
 module.exports = {
-  Models: {
-    Switch,
-    Alarm,
-    Dimmer,
-    Gateway,
-    Lock,
-    SceneController,
-    Thermostat,
-    WindowCovering,
-  },
+  Models,
 };

package/models/alarm.js

@@ -0,0 +1,7 @@
+// create the Alarm Model
+const { createModel } = require("../utils/compiler");
+const alarmSchema = require("../schemas/alarm.json");
+
+const Alarm = createModel({ schema: alarmSchema, name: "Alarm" });
+
+module.exports = Alarm;

package/models/courtesy.js

@@ -0,0 +1,7 @@
+// create the Courtesy Model
+const { createModel } = require("../utils/compiler");
+const courtesySchema = require("../schemas/courtesy.json");
+
+const Courtesy = createModel({ schema: courtesySchema, name: "Courtesy" });
+
+module.exports = Courtesy;

package/models/dimmer.js

@@ -0,0 +1,7 @@
+// Create the Dimmer Model
+const { createModel } = require("../utils/compiler");
+const dimmerSchema = require("../schemas/dimmer.json");
+
+const Dimmer = createModel({ schema: dimmerSchema, name: "Dimmer" });
+
+module.exports = Dimmer;

package/models/gateway.js

@@ -0,0 +1,7 @@
+// Create the Gateway Model
+const { createModel } = require("../utils/compiler");
+const gatewaySchema = require("../schemas/gateway.json");
+
+const Gateway = createModel({ schema: gatewaySchema, name: "Gateway" });
+
+module.exports = Gateway;

package/models/index.js

@@ -0,0 +1,19 @@
+const Gateway = require("./gateway");
+const Switch = require("./switch");
+const Alarm = require("./alarm");
+const Dimmer = require("./dimmer");
+const Lock = require("./lock");
+const SceneController = require("./sceneController");
+const Thermostat = require("./thermostat");
+const WindowCovering = require("./windowCovering");
+
+module.exports = {
+  Gateway,
+  Switch,
+  Alarm,
+  Dimmer,
+  Lock,
+  SceneController,
+  Thermostat,
+  WindowCovering,
+};

package/models/lock.js

@@ -0,0 +1,7 @@
+// Create the Lock Model
+const { createModel } = require("../utils/compiler");
+const lockSchema = require("../schemas/lock.json");
+
+const Lock = createModel({ schema: lockSchema, name: "Lock" });
+
+module.exports = Lock;

package/models/sceneController.js

@@ -0,0 +1,10 @@
+// Create the SceneController Model
+const { createModel } = require("../utils/compiler");
+const sceneControllerSchema = require("../schemas/sceneController.json");
+
+const SceneController = createModel({
+  schema: sceneControllerSchema,
+  name: "SceneController",
+});
+
+module.exports = SceneController;

package/models/switch.js

@@ -0,0 +1,7 @@
+// create the Switch model
+const { createModel } = require("../utils/compiler");
+const switchSchema = require("../schemas/switch.json");
+
+const Switch = createModel({ schema: switchSchema, name: "Switch" });
+
+module.exports = Switch;

package/models/thermostat.js

@@ -0,0 +1,40 @@
+const { createModel } = require("../utils/compiler");
+const thermostatSchema = require("../schemas/thermostat.json");
+
+function toCelsius() {
+  if (this.temperatureScale === "farenheit")
+    this.currentTemperature = ((this.currentTemperature - 32) * 5) / 9;
+  return this.currentTemperature;
+}
+
+const Thermostat = createModel({
+  schema: thermostatSchema,
+  name: "Thermostat",
+  methods: [toCelsius],
+});
+
+const data = {
+  id: "123",
+  type: "thermostat",
+  supportedNotifications: ["idle", "motionDetection"],
+  systemData: {},
+  currentTemperature: 20,
+  hvacMode: "off",
+  fanMode: "off",
+  fanState: "off",
+  hvacState: "off",
+  setpoints: {
+    heat: {
+      value: 60,
+      min: 0,
+      max: 99,
+    },
+  },
+  temperatureScale: "farenheit",
+  supportedHvacModes: ["off", "heat", "cool"],
+  supportedFanModes: ["off", "low", "medium", "high"],
+};
+
+console.log(new Thermostat(data));
+
+module.exports = Thermostat;

package/models/windowCovering.js

@@ -0,0 +1,10 @@
+// Create the WindowCovering Model
+const { createModel } = require("../utils/compiler");
+const windowCoveringSchema = require("../schemas/windowCovering.json");
+
+const WindowCovering = createModel({
+  schema: windowCoveringSchema,
+  name: "WindowCovering",
+});
+
+module.exports = WindowCovering;

package/package.json

@@ -3,7 +3,7 @@
     "ajv": "^8.11.0"
   },
   "name": "@kohost/api-client",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.2",
   "description": "API client for Kohost utils",
   "main": "index.js",
   "devDependencies": {},

package/schemas/{device.json → definitions/device.json}

@@ -31,7 +31,7 @@
       }
     },
     "notification": {
-      "type": "object",
+      "type": ["object", "null"],
       "properties": {
         "name": {
           "type": "string",

package/schemas/sceneController.json

@@ -20,6 +20,9 @@
     "notification": {
       "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/notification"
     },
+    "subType": {
+      "type": ["string", "null"]
+    },
     "supportedScenes": {
       "type": "array",
       "uniqueItems": true,
@@ -28,7 +31,7 @@
       }
     },
     "scene": {
-      "type": "object",
+      "type": ["object", "null"],
       "properties": {
         "name": {
           "type": "string",
@@ -39,8 +42,17 @@
           "minimum": 1655907956593
         }
       }
+    },
+    "level": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100
+    },
+    "state": {
+      "type": "string",
+      "enum": ["on", "off"]
     }
   },
-  "additionalProperties": false,
+  "additionalProperties": true,
   "required": ["id", "type", "systemData", "supportedScenes", "scene"]
 }

package/utils/compiler.js

@@ -0,0 +1,40 @@
+const Ajv = require("ajv");
+const ajv = new Ajv({ allErrors: true });
+
+// load definitions
+const deviceSchema = require("../schemas/definitions/device.json");
+
+ajv.addSchema(deviceSchema);
+
+function createModel({ schema, name, methods = [] }) {
+  const validator = ajv.compile(schema);
+  class Model {
+    constructor(data) {
+      // apply schema properties to the class
+      this.validate(data);
+      Object.keys(validator.schema.properties).forEach((key) => {
+        if (data[key] !== undefined) this[key] = data[key];
+      });
+    }
+
+    validate(data) {
+      const valid = this._validator(data);
+      if (!valid)
+        throw new Error(`Invalid ${name}`, { cause: this._validator.errors });
+    }
+  }
+
+  // change the name of the class
+  Object.defineProperty(Model, "name", { value: name });
+  Model.prototype._validator = validator;
+  Model.prototype.schema = schema;
+  methods.forEach((method) => {
+    const methodName = method.name;
+    Model.prototype[methodName] = method;
+  });
+  return Model;
+}
+
+module.exports = {
+  createModel,
+};