@kohost/api-client 3.9.11 → 4.0.4

package/dist/cjs/Models/Thermostat.js

@@ -1,86 +0,0 @@
-const schemas = require("../utils/schema");
-const schema = require("../schemas/thermostat.json");
-const Entity = require("./Entity");
-
-schemas.add(schema);
-const validator = schemas.compile(schema);
-
-class Thermostat extends Entity {
-  /**
-   * @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

@@ -1,55 +0,0 @@
-// Create the User Model
-const schemas = require("../utils/schema");
-const schema = require("../schemas/ticket.json");
-const Entity = require("./Entity");
-const MediaFile = require("./MediaFile");
-
-const { nanoid } = require("nanoid");
-
-schemas.add(schema);
-const validator = schemas.compile(schema);
-
-class Ticket extends Entity {
-  /**
-   * @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/TimeSheet.js

@@ -1,60 +0,0 @@
-// Create the TimeSheet Model
-const schemas = require("../utils/schema");
-const schema = require("../schemas/timeSheet.json");
-const Entity = require("./Entity");
-
-const { nanoid } = require("nanoid");
-
-schemas.add(schema);
-const validator = schemas.compile(schema);
-
-class TimeSheet extends Entity {
-  /**
-   * @typedef {import("../schemas/TimeSheetSchema").TimeSheet} TimeSheetType
-   * Create a TimeSheet instance.
-   * @constructor
-   * @param {TimeSheetType} timesheet - The timesheet object of type TimeSheet.
-   */
-  constructor(timesheet) {
-    if (timesheet.day) {
-      timesheet.day = new Date(timesheet.day);
-    }
-
-    if (timesheet.timeEntries && Array.isArray(timesheet.timeEntries)) {
-      timesheet.timeEntries = timesheet.timeEntries.map((t) => {
-        if (!t.id) t.id = TimeSheet.generateTimeEntryId();
-        if (t.start) t.start = new Date(t.start);
-        if (t.end) t.end = new Date(t.end);
-        return t;
-      });
-
-      // sort by start time
-      timesheet.timeEntries.sort((a, b) => {
-        if (a.start < b.start) return -1;
-        if (a.start > b.start) return 1;
-        return 0;
-      });
-    }
-    super(timesheet);
-  }
-
-  static generateTimeEntryId(len = 16) {
-    return nanoid(len);
-  }
-}
-
-Object.defineProperty(TimeSheet.prototype, "schema", {
-  value: schema,
-});
-
-Object.defineProperty(TimeSheet.prototype, "validator", {
-  get: function () {
-    return validator;
-  },
-});
-
-Object.defineProperty(TimeSheet, "validProperties", {
-  value: Object.keys(schema.properties),
-});
-
-module.exports = TimeSheet;

package/dist/cjs/Models/User.js

@@ -1,130 +0,0 @@
-// Create the User Model
-const schemas = require("../utils/schema");
-const schema = require("../schemas/user.json");
-const paymentSchema = require("../schemas/payment.json");
-const Entity = require("./Entity");
-const MediaFile = require("./MediaFile");
-const Reservation = require("./Reservation");
-const Policy = require("./Policy");
-const Identification = require("./Identification");
-
-const { nanoid } = require("nanoid/async");
-
-schemas.add(paymentSchema);
-schemas.add(schema);
-
-const validator = schemas.compile(schema);
-
-class User extends Entity {
-  /**
-   * @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)
-      );
-    }
-
-    if (user.permissions) {
-      user.permissions = user.permissions.map((permission) => {
-        if (permission.policies && Array.isArray(permission.policies)) {
-          permission.policies = permission.policies.map(
-            (policy) => new Policy(policy)
-          );
-        }
-        return permission;
-      });
-    }
-
-    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/Vendor.js

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

package/dist/cjs/Models/WindowCovering.js

@@ -1,55 +0,0 @@
-// Create the WindowCovering Model
-const schemas = require("../utils/schema");
-const schema = require("../schemas/windowCovering.json");
-const Entity = require("./Entity");
-
-schemas.add(schema);
-const validator = schemas.compile(schema);
-
-class WindowCovering extends Entity {
-  /**
-   * @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

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

package/dist/cjs/defs/deviceTypes.js

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

package/dist/cjs/defs/formalDeviceTypes.js

@@ -1,6 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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.js

@@ -1,23 +0,0 @@
-const Models = require("./Models");
-const Errors = require("./Errors");
-const Commands = require("./Commands");
-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,
-};
-
-module.exports = Kohost;

package/dist/cjs/schemas/alarm.json

@@ -1,85 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "alarm.json",
-  "title": "Alarm",
-  "description": "Any smart alarm system",
-  "type": "object",
-  "properties": {
-    "id": {
-      "$ref": "definitions.json#/definitions/id"
-    },
-    "name": {
-      "type": "string"
-    },
-    "offline": {
-      "type": "boolean"
-    },
-    "type": {
-      "$ref": "definitions.json#/definitions/type"
-    },
-    "systemId": {
-      "$ref": "definitions.json#/definitions/systemId"
-    },
-    "supportedNotifications": {
-      "$ref": "definitions.json#/definitions/supportedNotifications"
-    },
-    "notification": {
-      "$ref": "definitions.json#/definitions/notification"
-    },
-    "driver": {
-      "$ref": "definitions.json#/definitions/driver"
-    },
-    "areas": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "number": {
-            "type": "number"
-          },
-          "name": {
-            "type": "string"
-          },
-          "securityMode": {
-            "type": ["string", "null"],
-            "enum": ["arming", "disarming", "armed", "disarmed", "alarm", null]
-          }
-        },
-        "additionalProperties": false
-      }
-    },
-    "zones": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "number": {
-            "type": "number",
-            "minimum": 0
-          },
-          "name": {
-            "type": "string"
-          },
-          "secure": {
-            "type": ["boolean", "null"]
-          },
-          "bypassed": {
-            "type": ["boolean", "null"]
-          }
-        },
-        "additionalProperties": false
-      }
-    },
-    "chime": {
-      "type": "boolean",
-      "description": "Reflects whether console chime is enabled"
-    },
-    "watts": {
-      "$ref": "definitions.json#/definitions/watts"
-    },
-    "address": {
-      "$ref": "definitions.json#/definitions/address"
-    }
-  },
-  "required": ["id", "type", "areas", "zones", "driver"]
-}