@kohost/api-client 3.0.0-beta.7 → 3.0.0-beta.70

package/dist/cjs/Models/Alarm.js

@@ -0,0 +1,35 @@
+// create the Alarm Model
+const schemas = require("../utils/schema");
+const schema = require("../schemas/alarm.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class Alarm extends Kohost {
+  /**
+   * @typedef {import("../schemas/AlarmSchema").Alarm} AlarmType
+   * Create a Alarm instance.
+   * @constructor
+   * @param {AlarmType} alarm - The alarm object of type Alarm.
+   */
+  constructor(alarm) {
+    super(alarm);
+  }
+}
+
+Object.defineProperty(Alarm.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(Alarm.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(Alarm, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+module.exports = Alarm;

package/dist/cjs/Models/Camera.js

@@ -0,0 +1,35 @@
+// create the Camera Model
+const schemas = require("../utils/schema");
+const schema = require("../schemas/camera.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class Camera extends Kohost {
+  /**
+   * @typedef {import("../schemas/CameraSchema").Camera} CameraType
+   * Create a Camera instance.
+   * @constructor
+   * @param {CameraType} camera - The camera object of type Camera.
+   */
+  constructor(camera) {
+    super(camera);
+  }
+}
+
+Object.defineProperty(Camera.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(Camera.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(Camera, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+module.exports = Camera;

package/dist/cjs/Models/Category.js

@@ -0,0 +1,36 @@
+// Create the Category Model
+// Originally used for hotel room category e.g. Double Queen
+const schemas = require("../utils/schema");
+const schema = require("../schemas/category.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class Category extends Kohost {
+  /**
+   * @typedef {import("../schemas/CategorySchema").Category} CategoryType
+   * Create a Category instance.
+   * @constructor
+   * @param {CategoryType} category - The category object of type SpaceType.
+   */
+  constructor(category) {
+    super(category);
+  }
+}
+
+Object.defineProperty(Category.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(Category.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(Category, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+module.exports = Category;

package/dist/cjs/Models/Courtesy.js

@@ -0,0 +1,39 @@
+// create the Courtesy Model
+const schemas = require("../utils/schema");
+const schema = require("../schemas/courtesy.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class Courtesy extends Kohost {
+  /**
+   * @typedef {import("../schemas/CourtesySchema").Courtesy} CourtesyType
+   * Create a Courtesy instance.
+   * @constructor
+   * @param {CourtesyType} courtesy - The courtesy object of type Courtesy.
+   */
+  constructor(courtesy) {
+    super(courtesy);
+  }
+}
+
+Object.defineProperty(Courtesy.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(Courtesy.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(Courtesy, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+Object.defineProperty(Courtesy, "actionProperties", {
+  value: ["state"],
+});
+
+module.exports = Courtesy;

package/dist/cjs/Models/Credential.js

@@ -0,0 +1,35 @@
+// create the Credential Model
+const schemas = require("../utils/schema");
+const schema = require("../schemas/credential.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class Credential extends Kohost {
+  /**
+   * @typedef {import("../schemas/CredentialSchema").Credential} CredentialType
+   * Create a Credential instance.
+   * @constructor
+   * @param {CredentialType} credential - The credential object of type Credential.
+   */
+  constructor(credential) {
+    super(credential);
+  }
+}
+
+Object.defineProperty(Credential.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(Credential.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(Credential, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+module.exports = Credential;

package/dist/cjs/Models/Dimmer.js

@@ -0,0 +1,61 @@
+// Create the Dimmer Model
+const schemas = require("../utils/schema");
+const schema = require("../schemas/dimmer.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+/**
+ * Represents a Dimmer device.
+ * @class
+ * @extends Kohost
+ */
+
+class Dimmer extends Kohost {
+  /**
+   * @typedef {import("../schemas/DimmerSchema").Dimmer} DimmerType
+   * Create a Dimmer instance.
+   * @constructor
+   * @param {DimmerType} dimmer - The dimmer object of type Dimmer.
+   */
+  constructor(dimmer) {
+    super(dimmer);
+  }
+
+  static getActionDelta(old, _new) {
+    const delta = {};
+    for (const action in _new) {
+      if (this.actionProperties?.includes(action)) {
+        if (action === "level") {
+          const oldLevel = old[action];
+          const newLevel = _new[action];
+          delta[action] = newLevel - oldLevel / 100;
+        } else {
+          delta[action] = 1;
+        }
+      }
+    }
+    return delta;
+  }
+}
+
+Object.defineProperty(Dimmer.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(Dimmer.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(Dimmer, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+Object.defineProperty(Dimmer, "actionProperties", {
+  value: ["level"],
+});
+
+module.exports = Dimmer;

package/dist/cjs/Models/DiscoveredDevice.js

@@ -0,0 +1,36 @@
+// Create the Discovered Device Model
+const schemas = require("../utils/schema");
+const schema = require("../schemas/discoveredDevice.json");
+
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class DiscoveredDevice extends Kohost {
+  /**
+   * @typedef {import("../schemas/DiscoveredDeviceSchema").DiscoveredDevice} DiscoveredDeviceType
+   * Create a DiscoveredDevice instance.
+   * @constructor
+   * @param {DiscoveredDeviceType} device - The dd object of type DiscoveredDevice.
+   */
+  constructor(device) {
+    super(device);
+  }
+}
+
+Object.defineProperty(DiscoveredDevice.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(DiscoveredDevice.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(DiscoveredDevice, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+module.exports = DiscoveredDevice;

package/dist/cjs/Models/EmailMessage.js

@@ -0,0 +1,35 @@
+// Create the SMS Message Model
+const schemas = require("../utils/schema");
+const schema = require("../schemas/emailMessage.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class EmailMessage extends Kohost {
+  /**
+   * @typedef {import("../schemas/EmailMessageSchema").EmailMessage} EmailMessageType
+   * Create a EmailMessage instance.
+   * @constructor
+   * @param {EmailMessageType} message - The message object of type EmailMessage.
+   */
+  constructor(message) {
+    super(message);
+  }
+}
+
+Object.defineProperty(EmailMessage.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(EmailMessage.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(EmailMessage, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+module.exports = EmailMessage;

package/dist/cjs/Models/EnergyReport.js

@@ -0,0 +1,35 @@
+// create the energyReportDaily Model
+const schemas = require("../utils/schema");
+const schema = require("../schemas/energyReport.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class EnergyReport extends Kohost {
+  /**
+   * @typedef {import("../schemas/EnergyReportSchema").EnergyReport} EnergyReportType
+   * Create a EnergyReport instance.
+   * @constructor
+   * @param {EnergyReportType} energyReport - The energyReport object of type EnergyReport.
+   */
+  constructor(energyReport) {
+    super(energyReport);
+  }
+}
+
+Object.defineProperty(EnergyReport.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(EnergyReport.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(EnergyReport, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+module.exports = EnergyReport;

package/dist/cjs/Models/EnergyReportShard.js

@@ -0,0 +1,35 @@
+// create the energyReportShard Model
+const schemas = require("../utils/schema");
+const schema = require("../schemas/energyReportShard.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class EnergyReportShard extends Kohost {
+  /**
+   * @typedef {import("../schemas/EnergyReportShardSchema").EnergyReportShard} EnergyReportShardType
+   * Create a EnergyReportShard instance.
+   * @constructor
+   * @param {EnergyReportShardType} energyReportShard - The energyReportShard object of type EnergyReportShard.
+   */
+  constructor(energyReportShard) {
+    super(energyReportShard);
+  }
+}
+
+Object.defineProperty(EnergyReportShard.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(EnergyReportShard.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(EnergyReportShard, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+module.exports = EnergyReportShard;

package/dist/cjs/Models/Gateway.js

@@ -0,0 +1,35 @@
+// Create the Gateway Model
+const schemas = require("../utils/schema");
+const schema = require("../schemas/gateway.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class Gateway extends Kohost {
+  /**
+   * @typedef {import("../schemas/GatewaySchema").Gateway} GatewayType
+   * Create a Gateway instance.
+   * @constructor
+   * @param {GatewayType} gateway - The gateway object of type Gateway.
+   */
+  constructor(gateway) {
+    super(gateway);
+  }
+}
+
+Object.defineProperty(Gateway.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(Gateway.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(Gateway, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+module.exports = Gateway;

package/dist/cjs/Models/Identification.js

@@ -0,0 +1,38 @@
+const schemas = require("../utils/schema");
+const schema = require("../schemas/identification.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class Identification extends Kohost {
+  /**
+   * @typedef {import("../schemas/IdentificationSchema").Identification} IdentificationType
+   * Create a Identification instance.
+   * @constructor
+   * @param {IdentificationType} identification - The identification object of type Identification.
+   */
+  constructor(identification) {
+    super(identification);
+  }
+
+  get isExpired() {
+    return new Date(this.expires) < new Date();
+  }
+}
+
+Object.defineProperty(Identification.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(Identification.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(Identification, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+module.exports = Identification;

package/dist/cjs/Models/Kohost.js

@@ -0,0 +1,96 @@
+const { ValidationError } = require("../Errors");
+const { customAlphabet: generate } = require("nanoid");
+
+class Kohost {
+  constructor(data) {
+    if (!this.schema) {
+      throw new Error("Schema is not defined");
+    }
+
+    if (!this.validator) {
+      throw new Error("Validator is not defined");
+    }
+
+    const isNew = data?.id ? false : true;
+
+    this.#_setId(data);
+    this.#_validate(data);
+    this.#_setProperties(data);
+    this.#_setTimestamps(isNew);
+  }
+
+  static get validProperties() {
+    throw new Error("validProperties is not defined");
+  }
+
+  get schemaProperties() {
+    return Object.keys(this.validator.schema.properties);
+  }
+
+  #_setId(data) {
+    if (data._id) data.id = data._id;
+    if (!data.id) {
+      data.id = this.constructor.generateId();
+    }
+    delete data._id;
+  }
+
+  #_setProperties(data) {
+    this.schemaProperties.forEach((key) => {
+      if (data[key] !== undefined) this[key] = data[key];
+    });
+  }
+
+  #_setTimestamps(isNew) {
+    const now = new Date();
+    if (
+      isNew &&
+      this.schemaProperties.includes("createdAt") &&
+      !this.createdAt
+    ) {
+      this.createdAt = now;
+    }
+  }
+
+  #_validate(data) {
+    const valid = this.validator(data);
+    if (!valid) {
+      throw new ValidationError(`Invalid ${this.constructor.name}`, {
+        cause: this.validator.errors,
+      });
+    }
+  }
+
+  static generateId() {
+    const length = 8;
+    const characters =
+      "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
+    const id = generate(characters, length)();
+    return id;
+  }
+
+  static getActionDelta(old, _new) {
+    const delta = {};
+    for (const action in _new) {
+      if (this.actionProperties?.includes(action)) {
+        if (old[action] !== _new[action]) {
+          delta[action] = 1;
+        }
+      }
+    }
+    return delta;
+  }
+
+  toObject() {
+    const obj = { ...this };
+    // delete keys if they are not valid properties
+    Object.keys(obj).forEach((key) => {
+      if (!this.constructor.validProperties.includes(key)) {
+        delete obj[key];
+      }
+    });
+    return obj;
+  }
+}
+
+module.exports = Kohost;

package/dist/cjs/Models/Lock.js

@@ -0,0 +1,39 @@
+// Create the Lock Model
+const schemas = require("../utils/schema");
+const schema = require("../schemas/lock.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class Lock extends Kohost {
+  /**
+   * @typedef {import("../schemas/LockSchema").Lock} LockType
+   * Create a Lock instance.
+   * @constructor
+   * @param {LockType} lock - The lock object of type Lock.
+   */
+  constructor(lock) {
+    super(lock);
+  }
+}
+
+Object.defineProperty(Lock.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(Lock.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(Lock, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+Object.defineProperty(Lock, "actionProperties", {
+  value: ["state"],
+});
+
+module.exports = Lock;

package/dist/cjs/Models/MediaFile.js

@@ -0,0 +1,48 @@
+const schemas = require("../utils/schema");
+const schema = require("../schemas/mediaFile.json");
+const Kohost = require("./Kohost");
+const { RequestError } = require("../Errors");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class MediaFile extends Kohost {
+  /**
+   * @typedef {import("../schemas/MediaFileSchema").MediaFile} MediaFileType
+   * Create a MediaFile instance.
+   * @constructor
+   * @param {MediaFileType} mediaFile - The mediaFile object of type MediaFile.
+   */
+  constructor(mediaFile) {
+    super(mediaFile);
+  }
+
+  createImageVariant(params) {
+    if (this.mimeType != "image/*")
+      throw new RequestError("Only dynamic images can have variants");
+    if (!this.url) throw new RequestError("MediaFile has no url");
+    // convert params to "key=value" pairs
+    const query = Object.keys(params)
+      .map((key) => `${key}=${params[key]}`)
+      .join(",");
+
+    // replace the final /public with the query above
+    return this.url.replace(/\/public$/, `/${query}`);
+  }
+}
+
+Object.defineProperty(MediaFile.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(MediaFile.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(MediaFile, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+module.exports = MediaFile;

package/dist/cjs/Models/MediaSource.js

@@ -0,0 +1,35 @@
+// create the Media Source Model
+const schemas = require("../utils/schema");
+const schema = require("../schemas/mediaSource.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class MediaSource extends Kohost {
+  /**
+   * @typedef {import("../schemas/MediaSourceSchema").MediaSource} MediaSourceType
+   * Create a MediaSource instance.
+   * @constructor
+   * @param {MediaSourceType} mediaSource - The mediaSource object of type MediaSource.
+   */
+  constructor(mediaSource) {
+    super(mediaSource);
+  }
+}
+
+Object.defineProperty(MediaSource.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(MediaSource.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(MediaSource, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+module.exports = MediaSource;