@kohost/api-client 3.0.0-beta.9 → 3.0.0-beta.91

package/dist/cjs/Models/Thermostat.js

@@ -0,0 +1,86 @@
+const schemas = require("../utils/schema");
+const schema = require("../schemas/thermostat.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class Thermostat extends Kohost {
+  /**
+   * @typedef {import("../schemas/ThermostatSchema").Thermostat} ThermostatType
+   * Create a Thermostat instance.
+   * @constructor
+   * @param {ThermostatType} thermostat - The thermostat object of type Thermostat.
+   */
+  constructor(thermostat) {
+    super(thermostat);
+  }
+
+  toCelsius() {
+    if (this.temperatureScale === "fahrenheit")
+      this.currentTemperature = ((this.currentTemperature - 32) * 5) / 9;
+    this.temperatureScale = "celsius";
+    return this.currentTemperature;
+  }
+
+  toFahrenheit() {
+    if (this.temperatureScale === "celsius")
+      this.currentTemperature = (this.currentTemperature * 9) / 5 + 32;
+    this.temperatureScale = "fahrenheit";
+    return this.currentTemperature;
+  }
+
+  static getActionDelta(old, _new) {
+    const delta = {};
+    for (const action in _new) {
+      if (this.actionProperties.includes(action)) {
+        switch (action) {
+          case "hvacMode":
+          case "fanMode": {
+            if (old[action] !== _new[action]) delta[action] = 1;
+            break;
+          }
+          case "setpoints": {
+            const setpoints = _new[action];
+            for (const setpoint in setpoints) {
+              if (old[action][setpoint].value !== setpoints[setpoint].value) {
+                const min =
+                  setpoints[setpoint].min || old[action][setpoint].min;
+                const max =
+                  setpoints[setpoint].max || old[action][setpoint].max;
+                const oldValue = old[action][setpoint].value;
+                const value = setpoints[setpoint].value;
+                // get percentage change relative to min and max
+                const percentChange = (value - oldValue) / (max - min);
+                // get the delta
+                delta[`setpoints.${setpoint}`] = percentChange;
+              }
+            }
+          }
+        }
+      }
+    }
+
+    return delta;
+  }
+}
+
+Object.defineProperty(Thermostat.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(Thermostat.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(Thermostat, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+Object.defineProperty(Thermostat, "actionProperties", {
+  value: ["hvacMode", "fanMode", "setpoints"],
+});
+
+module.exports = Thermostat;

package/dist/cjs/Models/Ticket.js

@@ -0,0 +1,55 @@
+// Create the User Model
+const schemas = require("../utils/schema");
+const schema = require("../schemas/ticket.json");
+const Kohost = require("./Kohost");
+const MediaFile = require("./MediaFile");
+
+const { nanoid } = require("nanoid");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class Ticket extends Kohost {
+  /**
+   * @typedef {import("../schemas/TicketSchema").Ticket} TicketType
+   * Create a Ticket instance.
+   * @constructor
+   * @param {TicketType} ticket - The ticket object of type Ticket.
+   */
+  constructor(ticket) {
+    const ticketData = mapConversationData(ticket);
+    super(ticketData);
+  }
+
+  static generateMessageId(len = 16) {
+    return nanoid(len);
+  }
+}
+
+Object.defineProperty(Ticket.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(Ticket.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(Ticket, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+function mapConversationData(data) {
+  const ticketData = structuredClone(data);
+  if (!ticketData.conversation) ticketData.conversation = [];
+  ticketData.conversation = ticketData.conversation.map((msg) => {
+    if (msg.media) {
+      msg.media = new MediaFile(msg.media);
+    }
+    return msg;
+  });
+  return ticketData;
+}
+
+module.exports = Ticket;

package/dist/cjs/Models/User.js

@@ -0,0 +1,115 @@
+// Create the User Model
+const schemas = require("../utils/schema");
+const schema = require("../schemas/user.json");
+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");
+
+schemas.add(paymentSchema);
+schemas.add(schema);
+
+const validator = schemas.compile(schema);
+
+class User extends Kohost {
+  /**
+   * @typedef {import("../schemas/UserSchema").User} UserType
+   * Create a User instance.
+   * @constructor
+   * @param {UserType} user - The user object of type User.
+   */
+  constructor(user) {
+    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);
+  }
+
+  static validatePhone(phoneNumber) {
+    const regex = /^\+?[1-9]\d{1,14}$/;
+    return regex.test(phoneNumber);
+  }
+
+  static validateEmail(email) {
+    //eslint-disable-next-line no-useless-escape
+    const regex =
+      /^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
+    return regex.test(email);
+  }
+
+  static async generatePassword(len = 16) {
+    return await nanoid(len);
+  }
+}
+
+Object.defineProperty(User.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(User.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(User, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+Object.defineProperty(User.prototype, "fullName", {
+  get: function () {
+    return `${this.firstName} ${this.lastName}`;
+  },
+});
+
+Object.defineProperty(User.prototype, "roles", {
+  get: function () {
+    const roles = new Set();
+    if (this.permissions) {
+      for (const permission of this.permissions) {
+        roles.add(permission.role);
+      }
+    }
+    return Array.from(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/WindowCovering.js

@@ -0,0 +1,55 @@
+// Create the WindowCovering Model
+const schemas = require("../utils/schema");
+const schema = require("../schemas/windowCovering.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class WindowCovering extends Kohost {
+  /**
+   * @typedef {import("../schemas/WindowCoveringSchema").WindowCovering} WindowCoveringType
+   * Create a WindowCovering instance.
+   * @constructor
+   * @param {WindowCoveringType} windowCovering - The windowCovering object of type WindowCovering.
+   */
+  constructor(windowCovering) {
+    super(windowCovering);
+  }
+
+  static getActionDelta(old, _new) {
+    const delta = {};
+    for (const action in _new) {
+      if (this.actionProperties?.includes(action)) {
+        if (action === "position") {
+          const oldPos = old[action];
+          const newPos = _new[action];
+          delta[action] = newPos - oldPos / 100;
+        } else if (old[action] !== _new[action]) {
+          delta[action] = 1;
+        }
+      }
+    }
+    return delta;
+  }
+}
+
+Object.defineProperty(WindowCovering.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(WindowCovering.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(WindowCovering, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+Object.defineProperty(WindowCovering, "actionProperties", {
+  value: ["position"],
+});
+
+module.exports = WindowCovering;

package/dist/cjs/Models/index.js

@@ -0,0 +1,72 @@
+const Reservation = require("./Reservation");
+const MediaFile = require("./MediaFile");
+const Switch = require("./Switch");
+const Alarm = require("./Alarm");
+const Dimmer = require("./Dimmer");
+const Lock = require("./Lock");
+const Thermostat = require("./Thermostat");
+const WindowCovering = require("./WindowCovering");
+const Identification = require("./Identification");
+const User = require("./User");
+const SystemUser = require("./SystemUser");
+const Courtesy = require("./Courtesy");
+const Camera = require("./Camera");
+const MotionSensor = require("./MotionSensor");
+const MediaSource = require("./MediaSource");
+const Room = require("./Room");
+
+const Space = require("./Space");
+const Category = require("./Category");
+
+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");
+const EnergyReportShard = require("./EnergyReportShard");
+const EnergyReport = require("./EnergyReport");
+const SMSMessage = require("./SmsMessage");
+const EmailMessage = require("./EmailMessage");
+const Announcement = require("./Announcement");
+
+const Property = require("./Property");
+const Organization = require("./Organization");
+
+module.exports = {
+  Organization,
+  Property,
+  MediaFile,
+  Gateway,
+  Switch,
+  Alarm,
+  Dimmer,
+  Lock,
+  Courtesy,
+  Camera,
+  MotionSensor,
+  Thermostat,
+  WindowCovering,
+  MediaSource,
+  Identification,
+  Product,
+  User,
+  SystemUser,
+  Room,
+  Space,
+  Category,
+  Ticket,
+  Scene,
+  DiscoveredDevice,
+  Reservation,
+  Credential,
+  ShortLink,
+  EnergyReportShard,
+  EnergyReport,
+  SMSMessage,
+  EmailMessage,
+  Order,
+  Announcement,
+};

package/dist/cjs/SocketIoClient/index.js

@@ -0,0 +1,74 @@
+const io = require("socket.io-client");
+const { EventEmitter } = require("events");
+
+module.exports = class SocketIoClient extends EventEmitter {
+  constructor(config = { url: null, propertyId: null, options: {} }) {
+    super();
+    if (!config.url) throw new Error("Websocket URL / endpoint not provided");
+    if (!config.propertyId) throw new Error("Property ID not provided");
+    this.url = config.url;
+    this.propertyId = config.propertyId;
+    this.options = {
+      autoConnect: false,
+      forceNew: false,
+      reconnection: true,
+      reconnectionAttempts: Infinity,
+      reconnectionDelay: 1000,
+      withCredentials: true,
+      transports: ["websocket", "polling"],
+      upgrade: true,
+      ...config.options,
+    };
+
+    this.socket = io(this.url, this.options);
+
+    this.socket.on("connect", () => {
+      this.emit("connect", this.socket);
+    });
+
+    this.socket.on("disconnect", (reason) => {
+      this.emit("disconnect", reason);
+    });
+
+    this.socket.on("reconnect_attempt", (data) => {
+      this.emit("reconnect_attempt", data);
+    });
+
+    this.socket.on("connect_error", (error) => {
+      this.emit("connect_error", error);
+    });
+  }
+
+  get connected() {
+    return this.socket?.connected || false;
+  }
+
+  get disconnected() {
+    return this.socket?.disconnected || false;
+  }
+
+  connect() {
+    this.socket.connect();
+  }
+
+  disconnect() {
+    this.socket.disconnect();
+  }
+
+  reconnect() {
+    this.disconnect();
+    this.connect();
+  }
+
+  subscribe(event, callback) {
+    this.socket.on(event, callback);
+  }
+
+  unsubscribe(event, callback) {
+    this.socket.off(event, callback);
+  }
+
+  send(event, { data = {}, query = {}, ...rest }) {
+    this.socket.emit(event, { data, query, ...rest });
+  }
+};

package/dist/cjs/defs/deviceTypes.js

@@ -0,0 +1,15 @@
+const types = [
+  "dimmer",
+  "switch",
+  "thermostat",
+  "lock",
+  "windowCovering",
+  "courtesy",
+  "alarm",
+  "camera",
+  "mediaSource",
+  "motionSensor",
+  "gateway",
+];
+
+module.exports = types;

package/dist/cjs/defs/formalDeviceTypes.js

@@ -0,0 +1,6 @@
+const deviceTypes = require("./deviceTypes");
+const formalDeviceTypes = deviceTypes.map(
+  (type) => type.charAt(0).toUpperCase() + type.slice(1)
+);
+
+module.exports = formalDeviceTypes;

package/dist/cjs/defs/index.js

@@ -0,0 +1,11 @@
+const deviceTypes = require("./deviceTypes");
+const formalDeviceTypes = require("./formalDeviceTypes");
+const { defs: httpDefs } = require("../Client");
+
+const defs = {
+  http: httpDefs,
+  deviceTypes,
+  formalDeviceTypes,
+};
+
+module.exports = defs;

package/dist/cjs/{index.cjs.js → index.js}

@@ -5,13 +5,19 @@ const Events = require("./Events");
 const defs = require("./defs");
 const utils = require("./utils");
 const Client = require("./Client");
+const SocketIoClient = require("./SocketIoClient");
+const AMQPClient = require("./AMQPClient");
+
 const Kohost = {
   Models,
   Errors,
   Commands,
   Events,
   Client,
+  SocketIoClient,
+  AMQPClient,
   defs,
-  utils
+  utils: utils,
 };
+
 module.exports = Kohost;

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

@@ -0,0 +1,158 @@
+/* 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"
+  | "airFilterNeedsReplaced"
+  | "smokeDetected"
+  | "outsideSafeTemperatureRange"
+  | "outsideSafeHumidityRange"
+  | "scheduleMaintenance"
+)[];
+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"
+    | "airFilterNeedsReplaced"
+    | "smokeDetected"
+    | "outsideSafeTemperatureRange"
+    | "outsideSafeHumidityRange"
+    | "scheduleMaintenance";
+  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"
+    | "airFilterNeedsReplaced"
+    | "smokeDetected"
+    | "outsideSafeTemperatureRange"
+    | "outsideSafeHumidityRange"
+    | "scheduleMaintenance";
+  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";
+  systemId?: string;
+  supportedNotifications?: SupportedNotifications;
+  notification?: Notification;
+  driver:
+    | "aws-kinesis"
+    | "butler"
+    | "crestron"
+    | "dmp"
+    | "dormakaba"
+    | "dsc"
+    | "ecobee"
+    | "igor"
+    | "inncom"
+    | "kohost-k7"
+    | "kohost-pms"
+    | "lg"
+    | "lirc"
+    | "mews"
+    | "mht"
+    | "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;
+  [k: string]: unknown;
+}