@kohost/api-client 3.0.0-beta.54 → 3.0.0-beta.56

package/dist/cjs/AMQPClient/index.js

@@ -225,6 +225,7 @@ class Message {
     this.content = content;
     this.options = {
       contentType: "application/json",
+      timestamp: Date.now(),
     };
     this.routingKey = "";
   }

package/dist/cjs/Client/index.js

@@ -157,6 +157,44 @@ var require_RequestMyKeyToken = __commonJS({
   }
 });
 
+// dist/useCases/RequestPWAToken.js
+var require_RequestPWAToken = __commonJS({
+  "dist/useCases/RequestPWAToken.js"(exports2, module2) {
+    module2.exports = /* @__PURE__ */ __name(function RequestPWAToken2(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
+      if (!requestData)
+        requestData = {};
+      const pathParams = null;
+      const { data, query, headers } = requestData;
+      let url = "/auth/pwaToken";
+      if (pathParams && data) {
+        for (const param of pathParams) {
+          const paramName = param.replace(":", "");
+          url = url.replace(param, data[paramName]);
+        }
+      }
+      if (url.match(/:[a-zA-Z0-9]+/g)) {
+        const missingParams = url.match(/:[a-zA-Z0-9]+/g);
+        const missing = missingParams.map((param) => param.replace(":", ""));
+        return Promise.reject(
+          new Error("Missing parameters: " + missing.join(", "))
+        );
+      }
+      const config = {
+        method: "get",
+        url,
+        ...httpConfigOptions
+      };
+      if (data)
+        config.data = data;
+      if (query)
+        config.params = query;
+      if (headers)
+        config.headers = headers;
+      return this._http.request(config);
+    }, "RequestPWAToken");
+  }
+});
+
 // dist/useCases/LogoutUser.js
 var require_LogoutUser = __commonJS({
   "dist/useCases/LogoutUser.js"(exports2, module2) {
@@ -5596,6 +5634,7 @@ var LoginUser = require_LoginUser();
 var RefreshToken = require_RefreshToken();
 var RequestLoginLink = require_RequestLoginLink();
 var RequestMyKeyToken = require_RequestMyKeyToken();
+var RequestPWAToken = require_RequestPWAToken();
 var LogoutUser = require_LogoutUser();
 var DescribeSelf = require_DescribeSelf();
 var DescribeUser = require_DescribeUser();
@@ -5855,6 +5894,7 @@ KohostApiClient.prototype.LoginUser = LoginUser;
 KohostApiClient.prototype.RefreshToken = RefreshToken;
 KohostApiClient.prototype.RequestLoginLink = RequestLoginLink;
 KohostApiClient.prototype.RequestMyKeyToken = RequestMyKeyToken;
+KohostApiClient.prototype.RequestPWAToken = RequestPWAToken;
 KohostApiClient.prototype.LogoutUser = LogoutUser;
 KohostApiClient.prototype.DescribeSelf = DescribeSelf;
 KohostApiClient.prototype.DescribeUser = DescribeUser;

package/dist/cjs/Errors/ConflictError.js

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

package/dist/cjs/Errors/index.js

@@ -2,6 +2,7 @@ const Errors = {
   AppError: require("./AppError"),
   AuthenticationError: require("./AuthenticationError"),
   AuthorizationError: require("./AuthorizationError"),
+  ConflictError: require("./ConflictError"),
   DeviceCommError: require("./DeviceCommError"),
   LoginError: require("./LoginError"),
   NotFoundError: require("./NotFoundError"),

package/dist/cjs/Events/SceneSetEvent.js

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

package/dist/cjs/Events/index.js

@@ -11,6 +11,8 @@ const SystemCourtesyUpdatedEvent = require("./SystemCourtesyUpdatedEvent");
 const SystemAlarmUpdatedEvent = require("./SystemAlarmUpdatedEvent");
 const SystemMotionSensorUpdatedEvent = require("./SystemMotionSensorUpdatedEvent");
 
+const SceneSetEvent = require("./SceneSetEvent");
+
 const SystemUserUpdatedEvent = require("./SystemUserUpdatedEvent");
 const SystemSpaceUpdatedEvent = require("./SystemSpaceUpdatedEvent");
 const SystemSpaceTypeUpdatedEvent = require("./SystemSpaceTypeUpdatedEvent");
@@ -43,6 +45,7 @@ module.exports = {
   SystemSpaceTypeUpdatedEvent,
   SystemProductUpdatedEvent,
   SystemReservationUpdatedEvent,
+  SceneSetEvent,
   SMSEvent,
   EmailEvent,
   ShortLinkCreatedEvent,

package/dist/cjs/Models/Identification.js

@@ -17,7 +17,7 @@ class Identification extends Kohost {
   }
 
   get isExpired() {
-    return new Date(this.expirationDate) < new Date();
+    return new Date(this.expires) < new Date();
   }
 }
 

package/dist/cjs/Models/Notification.js

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

package/dist/cjs/Models/Order.js

@@ -0,0 +1,48 @@
+const schemas = require("../utils/schema");
+const schema = require("../schemas/order.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class Order extends Kohost {
+  /**
+   * @typedef {import("../schemas/OrderSchema").Order} OrderType
+   * Create a Order instance.
+   * @constructor
+   * @param {OrderType} order - The order object of type Order.
+   */
+  constructor(order) {
+    super(order);
+  }
+
+  getSubTotal() {
+    return this.items.reduce((acc, item) => {
+      return acc + item.price;
+    }, 0);
+  }
+
+  getTaxTotal() {}
+
+  getTotal() {}
+
+  getDeliveryTotal() {}
+
+  getFeesTotal() {}
+}
+
+Object.defineProperty(Order.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(Order.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(Order, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+module.exports = Order;

package/dist/cjs/Models/Reservation.js

@@ -24,6 +24,16 @@ class Reservation extends Kohost {
     return this.paymentId?.length > 0;
   }
 
+  get nights() {
+    const start = new Date(this.checkInDateTime);
+    const end = new Date(this.checkOutDateTime);
+    let nights = Math.round((end - start) / (1000 * 60 * 60 * 24));
+    if (nights <= 0) {
+      nights = 1;
+    }
+    return nights;
+  }
+
   range(tz) {
     const start = new Date(this.checkInDateTime);
     const end = new Date(this.checkOutDateTime);

package/dist/cjs/Models/Scene.js

@@ -1,7 +1,6 @@
 const schemas = require("../utils/schema");
 const schema = require("../schemas/scene.json");
 const Kohost = require("./Kohost");
-const SetSceneCommand = require("../Commands/SetSceneCommand");
 
 schemas.add(schema);
 const validator = schemas.compile(schema);
@@ -17,8 +16,8 @@ class Scene extends Kohost {
     super(scene);
   }
 
-  static createSceneCommandPayload(room, scene, restore) {
-    const commandsByDriver = [];
+  static getRoomSceneDeviceData(room, scene, restore) {
+    const deviceData = [];
 
     const sceneDevices = scene?.devices || {};
     const sceneId = scene.id;
@@ -34,9 +33,12 @@ class Scene extends Kohost {
         const { id, ...deviceProps } = data;
         if (id === "*") {
           for (const device of roomDevices) {
-            const driver = device.driver;
             const deviceCmd = {
-              id: device.systemData?.id,
+              id: device.id,
+              systemId: device.systemData?.id,
+              type: device.type,
+              driver: device.driver,
+              commandData: {},
             };
             for (const prop in deviceProps) {
               if (prop === "setpointDelta") {
@@ -59,7 +61,7 @@ class Scene extends Kohost {
                     );
                   }
 
-                  deviceCmd.setpoints = {
+                  deviceCmd.commandData.setpoints = {
                     heat: {
                       value: setpointValue,
                     },
@@ -77,7 +79,7 @@ class Scene extends Kohost {
                       currentSetpoint.value - delta
                     );
                   }
-                  deviceCmd.setpoints = {
+                  deviceCmd.commandData.setpoints = {
                     cool: {
                       value: setpointValue,
                     },
@@ -113,7 +115,7 @@ class Scene extends Kohost {
                       continue;
                     }
 
-                    deviceCmd.setpoints = {
+                    deviceCmd.commandData.setpoints = {
                       heat: {
                         value: heatSetpoint,
                       },
@@ -129,29 +131,16 @@ class Scene extends Kohost {
                   continue;
                 }
               } else {
-                deviceCmd[prop] = deviceProps[prop];
+                deviceCmd.commandData[prop] = deviceProps[prop];
               }
             }
 
-            // move to next loop if the only key in deviceCmd is id
-            if (Object.keys(deviceCmd).length === 1) {
+            // move to next loop if no keys in command data
+            if (Object.keys(deviceCmd.commandData).length === 0) {
               continue;
             }
 
-            const driverIndex = commandsByDriver.findIndex(
-              (c) => c.driver === driver
-            );
-            if (driverIndex >= 0) {
-              commandsByDriver[driverIndex].command.devices.push(deviceCmd);
-            } else {
-              commandsByDriver.push({
-                driver,
-                command: {
-                  id: sceneId,
-                  devices: [deviceCmd],
-                },
-              });
-            }
+            deviceData.push(deviceCmd);
           }
         }
         /**
@@ -159,16 +148,7 @@ class Scene extends Kohost {
          */
       }
     }
-
-    const commands = commandsByDriver.map((c) => {
-      const command = new SetSceneCommand(c.command);
-      return {
-        driver: c.driver,
-        command,
-      };
-    });
-
-    return commands;
+    return deviceData;
   }
 }
 

package/dist/cjs/Models/User.js

@@ -5,6 +5,7 @@ const paymentSchema = require("../schemas/payment.json");
 const Kohost = require("./Kohost");
 const MediaFile = require("./MediaFile");
 const Reservation = require("./Reservation");
+const Identification = require("./Identification");
 
 const { nanoid } = require("nanoid/async");
 
@@ -24,6 +25,11 @@ class User extends Kohost {
     if (user.photo) user.photo = new MediaFile(user.photo);
     if (user.reservations)
       user.reservations = user.reservations.map((res) => new Reservation(res));
+    if (user.identifications)
+      user.identifications = user.identifications.map(
+        (id) => new Identification(id)
+      );
+
     super(user);
   }
 
@@ -76,4 +82,34 @@ Object.defineProperty(User.prototype, "roles", {
   },
 });
 
+Object.defineProperty(User.prototype, "isSuperAdmin", {
+  get: function () {
+    return this.roles.includes("SuperAdmin");
+  },
+});
+
+Object.defineProperty(User.prototype, "isAdmin", {
+  get: function () {
+    return this.roles.includes("Admin") || this.roles.includes("Administrator");
+  },
+});
+
+Object.defineProperty(User.prototype, "isManager", {
+  get: function () {
+    return this.roles.includes("Manager");
+  },
+});
+
+Object.defineProperty(User.prototype, "isUser", {
+  get: function () {
+    return this.roles.includes("User");
+  },
+});
+
+Object.defineProperty(User.prototype, "isGuest", {
+  get: function () {
+    return this.roles.includes("Guest");
+  },
+});
+
 module.exports = User;

package/dist/cjs/Models/index.js

@@ -22,6 +22,7 @@ const Ticket = require("./Ticket");
 const Scene = require("./Scene");
 const Gateway = require("./Gateway");
 const Product = require("./Product");
+const Order = require("./Order");
 const DiscoveredDevice = require("./DiscoveredDevice");
 const Credential = require("./Credential");
 const ShortLink = require("./ShortLink");
@@ -29,6 +30,7 @@ const EnergyReportShard = require("./EnergyReportShard");
 const EnergyReport = require("./EnergyReport");
 const SMSMessage = require("./SmsMessage");
 const EmailMessage = require("./EmailMessage");
+const Notification = require("./Notification");
 
 const Property = require("./Property");
 const Organization = require("./Organization");
@@ -65,4 +67,6 @@ module.exports = {
   EnergyReport,
   SMSMessage,
   EmailMessage,
+  Order,
+  Notification,
 };

package/dist/cjs/schemas/AlarmSchema.d.ts

@@ -0,0 +1,150 @@
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export type SupportedNotifications = (
+  | "button 1"
+  | "button 2"
+  | "button 3"
+  | "button 4"
+  | "button 5"
+  | "idle"
+  | "powerHasBeedApplied"
+  | "acMainsDisconnected"
+  | "acMainsReconnected"
+  | "replaceBatterySoon"
+  | "replaceBatteryNow"
+  | "hardwareFailure"
+  | "softwareFailure"
+  | "hardwareFailureWithCode"
+  | "softwareFailureWithCode"
+  | "motionDetection"
+  | "airFilterNeedsCleaned"
+  | "smokeDetected"
+  | "outsideSafeTemperatureRange"
+  | "outsideSafeHumidityRange"
+)[];
+export type Notification = {
+  name?:
+    | "button 1"
+    | "button 2"
+    | "button 3"
+    | "button 4"
+    | "button 5"
+    | "idle"
+    | "powerHasBeedApplied"
+    | "acMainsDisconnected"
+    | "acMainsReconnected"
+    | "replaceBatterySoon"
+    | "replaceBatteryNow"
+    | "hardwareFailure"
+    | "softwareFailure"
+    | "hardwareFailureWithCode"
+    | "softwareFailureWithCode"
+    | "motionDetection"
+    | "airFilterNeedsCleaned"
+    | "smokeDetected"
+    | "outsideSafeTemperatureRange"
+    | "outsideSafeHumidityRange";
+  timestamp?: number;
+  description?: string;
+  [k: string]: unknown;
+} & ({
+  name?:
+    | "button 1"
+    | "button 2"
+    | "button 3"
+    | "button 4"
+    | "button 5"
+    | "idle"
+    | "powerHasBeedApplied"
+    | "acMainsDisconnected"
+    | "acMainsReconnected"
+    | "replaceBatterySoon"
+    | "replaceBatteryNow"
+    | "hardwareFailure"
+    | "softwareFailure"
+    | "hardwareFailureWithCode"
+    | "softwareFailureWithCode"
+    | "motionDetection"
+    | "airFilterNeedsCleaned"
+    | "smokeDetected"
+    | "outsideSafeTemperatureRange"
+    | "outsideSafeHumidityRange";
+  timestamp?: number;
+  description?: string;
+  [k: string]: unknown;
+} | null);
+
+/**
+ * Any smart alarm system
+ */
+export interface Alarm {
+  id: string;
+  name?: string;
+  offline?: boolean;
+  type:
+    | "alarm"
+    | "dimmer"
+    | "switch"
+    | "motionSensor"
+    | "windowCovering"
+    | "camera"
+    | "mediaSource"
+    | "thermostat"
+    | "lock"
+    | "courtesy"
+    | "gateway"
+    | "tv"
+    | "dvr"
+    | "appleTv"
+    | "discPlayer"
+    | "mediaPlayer"
+    | "uncontrolledDevice";
+  systemData: SystemData;
+  supportedNotifications?: SupportedNotifications;
+  notification?: Notification;
+  driver:
+    | "aws-kinesis"
+    | "butler"
+    | "crestron"
+    | "ecobee"
+    | "igor"
+    | "inncom"
+    | "kohost-k7"
+    | "kohost-pms"
+    | "lg"
+    | "lirc"
+    | "mews"
+    | "paxton"
+    | "pelican-wireless"
+    | "rebrandly"
+    | "salto"
+    | "salto-irn"
+    | "se"
+    | "sendgrid"
+    | "stay-n-touch"
+    | "twilio"
+    | "cloudflare-images"
+    | "cloudflare-stream"
+    | "insperia-privacy";
+  areas: {
+    number?: number;
+    name?: string;
+    securityMode?: "arming" | "disarming" | "armed" | "disarmed" | "alarm" | null;
+    readyToArm?: boolean | null;
+  }[];
+  zones: {
+    number?: number;
+    name?: string;
+    secure?: boolean;
+    bypassed?: boolean | null;
+  }[];
+  watts?: number;
+}
+export interface SystemData {
+  [k: string]: unknown;
+}