@kohost/api-client 3.0.0-beta.5 → 3.0.0-beta.51

package/dist/cjs/Errors/DeviceCommError.js

@@ -0,0 +1,9 @@
+const AppError = require("./AppError");
+
+module.exports = class DeviceCommError extends AppError {
+  constructor(message = "Device Communication Error", options = {}) {
+    super(message, options);
+    this.statusCode = 503;
+    Object.setPrototypeOf(this, DeviceCommError.prototype);
+  }
+};

package/dist/cjs/Errors/LoginError.js

@@ -0,0 +1,9 @@
+const AppError = require("./AppError");
+
+module.exports = class LoginError extends AppError {
+  constructor(message = "Invalid Login information provided", options = {}) {
+    super(message, options);
+    this.statusCode = 401;
+    Object.setPrototypeOf(this, LoginError.prototype);
+  }
+};

package/dist/cjs/Errors/NotFoundError.js

@@ -0,0 +1,9 @@
+const AppError = require("./AppError");
+
+module.exports = class NotFoundError extends AppError {
+  constructor(message = "Resource Not Found", options = {}) {
+    super(message, options);
+    this.statusCode = 404;
+    Object.setPrototypeOf(this, NotFoundError.prototype);
+  }
+};

package/dist/cjs/Errors/RequestError.js

@@ -0,0 +1,9 @@
+const AppError = require("./AppError");
+
+module.exports = class RequestError extends AppError {
+  constructor(message = "Bad Request", options = {}) {
+    super(message, options);
+    this.statusCode = 400;
+    Object.setPrototypeOf(this, RequestError.prototype);
+  }
+};

package/dist/cjs/Errors/SystemCommError.js

@@ -0,0 +1,9 @@
+const AppError = require("./AppError");
+
+module.exports = class SystemCommError extends AppError {
+  constructor(message = "System Communication Error", options = {}) {
+    super(message, options);
+    this.statusCode = 503;
+    Object.setPrototypeOf(this, SystemCommError.prototype);
+  }
+};

package/dist/cjs/Errors/TokenExpiredError.js

@@ -0,0 +1,9 @@
+const AppError = require("./AppError");
+
+module.exports = class TokenExpiredError extends AppError {
+  constructor(message = "Token Expired", options = {}) {
+    super(message, options);
+    this.statusCode = 401;
+    Object.setPrototypeOf(this, TokenExpiredError.prototype);
+  }
+};

package/dist/cjs/Errors/UnprocessableRequestError.js

@@ -0,0 +1,9 @@
+const AppError = require("./AppError");
+
+module.exports = class UnprocessableRequestError extends AppError {
+  constructor(message = "Unprocessable Request Error", options = {}) {
+    super(message, options);
+    this.statusCode = 422;
+    Object.setPrototypeOf(this, UnprocessableRequestError.prototype);
+  }
+};

package/dist/cjs/Errors/ValidationError.js

@@ -0,0 +1,9 @@
+const AppError = require("./AppError");
+
+module.exports = class ValidationError extends AppError {
+  constructor(message = "Validation Error", options = {}) {
+    super(message, options);
+    this.statusCode = 400;
+    Object.setPrototypeOf(this, ValidationError.prototype);
+  }
+};

package/dist/cjs/Errors/index.js

@@ -0,0 +1,15 @@
+const Errors = {
+  AppError: require("./AppError"),
+  AuthenticationError: require("./AuthenticationError"),
+  AuthorizationError: require("./AuthorizationError"),
+  DeviceCommError: require("./DeviceCommError"),
+  LoginError: require("./LoginError"),
+  NotFoundError: require("./NotFoundError"),
+  RequestError: require("./RequestError"),
+  SystemCommError: require("./SystemCommError"),
+  TokenExpiredError: require("./TokenExpiredError"),
+  UnprocessableRequestError: require("./UnprocessableRequestError"),
+  ValidationError: require("./ValidationError"),
+};
+
+module.exports = Errors;

package/dist/cjs/Events/ApplicationInUseEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class ApplicationInUseEvent extends Event {
+  constructor({ propertyId }) {
+    super({ propertyId });
+  }
+
+  get name() {
+    return "ApplicationInUse";
+  }
+
+  get routingKey() {
+    return `app.${this.data[0].propertyId}.inUse`;
+  }
+}
+
+module.exports = ApplicationInUseEvent;

package/dist/cjs/Events/ApplicationOutOfUseEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class ApplicationOutOfUseEvent extends Event {
+  constructor({ propertyId }) {
+    super({ propertyId });
+  }
+
+  get name() {
+    return "ApplicationOutOfUse";
+  }
+
+  get routingKey() {
+    return `app.${this.data[0].propertyId}.notInUse`;
+  }
+}
+
+module.exports = ApplicationOutOfUseEvent;

package/dist/cjs/Events/EmailEvent.js

@@ -0,0 +1,18 @@
+const Event = require("./Event");
+
+class EmailEvent extends Event {
+  constructor(email, context) {
+    super(email, context);
+    this.status = email.status;
+  }
+
+  get name() {
+    return "EmailEvent";
+  }
+
+  get routingKey() {
+    return `comm.email.${this.status}`;
+  }
+}
+
+module.exports = EmailEvent;

package/dist/cjs/Events/Event.js

@@ -0,0 +1,55 @@
+class Event {
+  constructor(data, context) {
+    this.data = [];
+    this.context = {};
+    if (!data) throw new Error("Event data is required");
+    if (typeof data !== "object" && !Array.isArray(data))
+      throw new Error("Event data must be an object or array");
+
+    if (!Array.isArray(data)) this.data = [data];
+    else this.data = data;
+
+    this.data = this.data.map((d) => {
+      if (d.eventData) {
+        if (!d.eventData.timestamp) d.eventData.timestamp = new Date();
+        if (!d.eventData.name) d.eventData.name = this.name;
+        if (!d.eventData.type) d.eventData.type = this.type;
+      }
+      return d;
+    });
+
+    if (context) {
+      for (const key in context) {
+        this.context[key] = context[key];
+      }
+    }
+  }
+
+  get keyId() {
+    if (Array.isArray(this.data)) return "batch";
+    if (this.data.id) return this.data.id;
+    return "unknown";
+  }
+
+  get name() {
+    throw new Error("Event name is required");
+  }
+
+  get type() {
+    return "Event";
+  }
+
+  get routingKey() {
+    return "";
+  }
+
+  get exchange() {
+    return "Events";
+  }
+
+  build() {
+    return { data: { ...this.data } };
+  }
+}
+
+module.exports = Event;

package/dist/cjs/Events/SMSEvent.js

@@ -0,0 +1,18 @@
+const Event = require("./Event");
+
+class SMSEvent extends Event {
+  constructor(sms, context) {
+    super(sms, context);
+    this.status = sms.status;
+  }
+
+  get name() {
+    return "SMSEvent";
+  }
+
+  get routingKey() {
+    return `comm.sms.${this.status}`;
+  }
+}
+
+module.exports = SMSEvent;

package/dist/cjs/Events/SMSSentEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SMSSentEvent extends Event {
+  constructor(sms, context) {
+    super(sms, context);
+  }
+
+  get name() {
+    return "SMSSent";
+  }
+
+  get routingKey() {
+    return "comm.sms.sent";
+  }
+}
+
+module.exports = SMSSentEvent;

package/dist/cjs/Events/ShortLinkCreatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class ShortLinkCreatedEvent extends Event {
+  constructor(shortLink, context) {
+    super(shortLink, context);
+  }
+
+  get name() {
+    return "ShortLinkCreated";
+  }
+
+  get routingKey() {
+    return `shortlink.${this.keyId}.created`;
+  }
+}
+
+module.exports = ShortLinkCreatedEvent;

package/dist/cjs/Events/SystemAlarmUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemAlarmUpdatedEvent extends Event {
+  constructor(alarm) {
+    super(alarm);
+  }
+
+  get name() {
+    return "SystemAlarmUpdated";
+  }
+
+  get routingKey() {
+    return `alarm.${this.keyId}.updated`;
+  }
+}
+
+module.exports = SystemAlarmUpdatedEvent;

package/dist/cjs/Events/SystemCameraUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemCameraUpdatedEvent extends Event {
+  constructor(camera) {
+    super(camera);
+  }
+
+  get name() {
+    return "SystemCameraUpdated";
+  }
+
+  get routingKey() {
+    return `camera.${this.keyId}.updated`;
+  }
+}
+
+module.exports = SystemCameraUpdatedEvent;

package/dist/cjs/Events/SystemCourtesyUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemCourtesyUpdatedEvent extends Event {
+  constructor(courtesy) {
+    super(courtesy);
+  }
+
+  get name() {
+    return "SystemCourtesyUpdated";
+  }
+
+  get routingKey() {
+    return `courtesy.${this.keyId}.updated`;
+  }
+}
+
+module.exports = SystemCourtesyUpdatedEvent;

package/dist/cjs/Events/SystemDimmerUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemDimmerUpdatedEvent extends Event {
+  constructor(dimmer) {
+    super(dimmer);
+  }
+
+  get name() {
+    return "SystemDimmerUpdated";
+  }
+
+  get routingKey() {
+    return `dimmer.${this.keyId}.updated`;
+  }
+}
+
+module.exports = SystemDimmerUpdatedEvent;

package/dist/cjs/Events/SystemGatewayUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemGatewayUpdatedEvent extends Event {
+  constructor(space) {
+    super(space);
+  }
+
+  get name() {
+    return "SystemGatewayUpdated";
+  }
+
+  get routingKey() {
+    return `gateway.${this.keyId}.updated`;
+  }
+}
+
+module.exports = SystemGatewayUpdatedEvent;

package/dist/cjs/Events/SystemLockUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemLockUpdatedEvent extends Event {
+  constructor(lock) {
+    super(lock);
+  }
+
+  get name() {
+    return "SystemLockUpdated";
+  }
+
+  get routingKey() {
+    return `lock.${this.keyId}.updated`;
+  }
+}
+
+module.exports = SystemLockUpdatedEvent;

package/dist/cjs/Events/SystemMediaSourceUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemMediaSourceUpdatedEvent extends Event {
+  constructor(mediaSource) {
+    super(mediaSource);
+  }
+
+  get name() {
+    return "SystemMediaSourceUpdated";
+  }
+
+  get routingKey() {
+    return `mediaSource.${this.keyId}.updated`;
+  }
+}
+ 
+module.exports = SystemMediaSourceUpdatedEvent;

package/dist/cjs/Events/SystemMotionSensorUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemMotionSensorUpdatedEvent extends Event {
+  constructor(mediaSource) {
+    super(mediaSource);
+  }
+
+  get name() {
+    return "SystemMotionSensorUpdated";
+  }
+
+  get routingKey() {
+    return `mediaSource.${this.keyId}.updated`;
+  }
+}
+
+module.exports = SystemMotionSensorUpdatedEvent;

package/dist/cjs/Events/SystemProductUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemProductUpdatedEvent extends Event {
+  constructor(product) {
+    super(product);
+  }
+
+  get name() {
+    return "SystemProductUpdated";
+  }
+
+  get routingKey() {
+    return `product.${this.keyId}.updated`;
+  }
+}
+
+module.exports = SystemProductUpdatedEvent;

package/dist/cjs/Events/SystemReservationUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemReservationUpdatedEvent extends Event {
+  constructor(reservation) {
+    super(reservation);
+  }
+
+  get name() {
+    return "SystemReservationUpdated";
+  }
+
+  get routingKey() {
+    return `reservation.${this.keyId}.updated`;
+  }
+}
+
+module.exports = SystemReservationUpdatedEvent;

package/dist/cjs/Events/SystemSceneControllerUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemSceneControllerUpdatedEvent extends Event {
+  constructor(sceneController) {
+    super(sceneController);
+  }
+
+  get name() {
+    return "SystemSceneControllerUpdated";
+  }
+
+  get routingKey() {
+    return `sceneController.${this.keyId}.updated`;
+  }
+}
+
+module.exports = SystemSceneControllerUpdatedEvent;

package/dist/cjs/Events/SystemSpaceTypeUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemSpaceTypeUpdatedEvent extends Event {
+  constructor(space) {
+    super(space);
+  }
+
+  get name() {
+    return "SystemSpaceTypeUpdated";
+  }
+
+  get routingKey() {
+    return `spaceType.${this.keyId}.updated`;
+  }
+}
+
+module.exports = SystemSpaceTypeUpdatedEvent;

package/dist/cjs/Events/SystemSpaceUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemSpaceUpdatedEvent extends Event {
+  constructor(space) {
+    super(space);
+  }
+
+  get name() {
+    return "SystemSpaceUpdated";
+  }
+
+  get routingKey() {
+    return `space.${this.keyId}.updated`;
+  }
+}
+
+module.exports = SystemSpaceUpdatedEvent;

package/dist/cjs/Events/SystemSwitchUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemSwitchUpdatedEvent extends Event {
+  constructor(_switch) {
+    super(_switch);
+  }
+
+  get name() {
+    return "SystemSwitchUpdated";
+  }
+
+  get routingKey() {
+    return `switch.${this.keyId}.updated`;  
+  }
+}
+
+module.exports = SystemSwitchUpdatedEvent;

package/dist/cjs/Events/SystemThermostatUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemThermostatUpdatedEvent extends Event {
+  constructor(thermostat) {
+    super(thermostat);
+  }
+
+  get name() {
+    return "SystemThermostatUpdated";
+  }
+
+  get routingKey() {
+    return `thermostat.${this.keyId}.updated`;
+  }
+}
+
+module.exports = SystemThermostatUpdatedEvent;

package/dist/cjs/Events/SystemUserUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemUserUpdatedEvent extends Event {
+  constructor(user) {
+    super(user);
+  }
+
+  get name() {
+    return "SystemUserUpdated";
+  }
+
+  get routingKey() {
+    return `user.${this.keyId}.updated`;
+  }
+}
+
+module.exports = SystemUserUpdatedEvent;

package/dist/cjs/Events/SystemWindowCoveringUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemWindowCoveringUpdatedEvent extends Event {
+  constructor(wc) {
+    super(wc);
+  }
+
+  get name() {
+    return "SystemWindowCoveringUpdated";
+  }
+
+  get routingKey() {
+    return `windowCovering.${this.keyId}.updated`;
+  }
+}
+
+module.exports = SystemWindowCoveringUpdatedEvent;

package/dist/cjs/Events/index.js

@@ -0,0 +1,51 @@
+const SystemGatewayUpdatedEvent = require("./SystemGatewayUpdatedEvent");
+const SystemThermostatUpdatedEvent = require("./SystemThermostatUpdatedEvent");
+const SystemDimmerUpdatedEvent = require("./SystemDimmerUpdatedEvent");
+const SystemSwitchUpdatedEvent = require("./SystemSwitchUpdatedEvent");
+const SystemLockUpdatedEvent = require("./SystemLockUpdatedEvent");
+const SystemCameraUpdatedEvent = require("./SystemCameraUpdatedEvent");
+const SystemSceneControllerUpdatedEvent = require("./SystemSceneControllerUpdatedEvent");
+const SystemWindowCoveringUpdatedEvent = require("./SystemWindowCoveringUpdatedEvent");
+const SystemMediaSourceUpdatedEvent = require("./SystemMediaSourceUpdatedEvent");
+const SystemCourtesyUpdatedEvent = require("./SystemCourtesyUpdatedEvent");
+const SystemAlarmUpdatedEvent = require("./SystemAlarmUpdatedEvent");
+const SystemMotionSensorUpdatedEvent = require("./SystemMotionSensorUpdatedEvent");
+
+const SystemUserUpdatedEvent = require("./SystemUserUpdatedEvent");
+const SystemSpaceUpdatedEvent = require("./SystemSpaceUpdatedEvent");
+const SystemSpaceTypeUpdatedEvent = require("./SystemSpaceTypeUpdatedEvent");
+const SystemProductUpdatedEvent = require("./SystemProductUpdatedEvent");
+
+const SystemReservationUpdatedEvent = require("./SystemReservationUpdatedEvent");
+
+const SMSEvent = require("./SMSEvent");
+const EmailEvent = require("./EmailEvent");
+const ShortLinkCreatedEvent = require("./ShortLinkCreatedEvent");
+
+const ApplicationInUseEvent = require("./ApplicationInUseEvent");
+const ApplicationOutOfUseEvent = require("./ApplicationOutOfUseEvent");
+
+module.exports = {
+  SystemAlarmUpdatedEvent,
+  SystemGatewayUpdatedEvent,
+  SystemThermostatUpdatedEvent,
+  SystemDimmerUpdatedEvent,
+  SystemSwitchUpdatedEvent,
+  SystemLockUpdatedEvent,
+  SystemCameraUpdatedEvent,
+  SystemSceneControllerUpdatedEvent,
+  SystemWindowCoveringUpdatedEvent,
+  SystemMediaSourceUpdatedEvent,
+  SystemMotionSensorUpdatedEvent,
+  SystemCourtesyUpdatedEvent,
+  SystemUserUpdatedEvent,
+  SystemSpaceUpdatedEvent,
+  SystemSpaceTypeUpdatedEvent,
+  SystemProductUpdatedEvent,
+  SystemReservationUpdatedEvent,
+  SMSEvent,
+  EmailEvent,
+  ShortLinkCreatedEvent,
+  ApplicationInUseEvent,
+  ApplicationOutOfUseEvent,
+};

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;