@kohost/api-client 3.0.0-beta.47 → 3.0.0-beta.50

package/dist/cjs/Models/User.js

@@ -0,0 +1,73 @@
+// 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 { nanoid } = require("nanoid/async");
+
+schemas.add(paymentSchema);
+schemas.add(schema);
+
+const validator = schemas.compile(schema);
+
+class User extends Kohost {
+  constructor(data) {
+    if (data.photo) data.photo = new MediaFile(data.photo);
+    if (data.reservations)
+      data.reservations = data.reservations.map((res) => new Reservation(res));
+    super(data);
+  }
+
+  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);
+  },
+});
+
+module.exports = User;

package/dist/cjs/Models/WindowCovering.js

@@ -0,0 +1,49 @@
+// 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 {
+  constructor(data) {
+    super(data);
+  }
+
+  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,68 @@
+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 SpaceType = require("./SpaceType");
+
+const Ticket = require("./Ticket");
+const Scene = require("./Scene");
+const Gateway = require("./Gateway");
+const Product = require("./Product");
+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 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,
+  SpaceType,
+  Ticket,
+  Scene,
+  DiscoveredDevice,
+  Reservation,
+  Credential,
+  ShortLink,
+  EnergyReportShard,
+  EnergyReport,
+  SMSMessage,
+  EmailMessage,
+};

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

@@ -1,19 +1,11 @@
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+const io = require("socket.io-client");
+const { EventEmitter } = require("events");
 
-// src/SocketIoClient/index.js
-var io = require("socket.io-client");
-var { EventEmitter } = require("events");
 module.exports = class SocketIoClient extends EventEmitter {
-  static {
-    __name(this, "SocketIoClient");
-  }
   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");
+    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 = {
@@ -21,48 +13,61 @@ module.exports = class SocketIoClient extends EventEmitter {
       forceNew: false,
       reconnection: true,
       reconnectionAttempts: Infinity,
-      reconnectionDelay: 1e3,
+      reconnectionDelay: 1000,
       withCredentials: true,
       transports: ["websocket", "polling"],
       upgrade: true,
-      ...config.options
+      ...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.js

@@ -0,0 +1,23 @@
+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: utils,
+};
+
+module.exports = Kohost;

package/dist/cjs/schemas/alarm.json

@@ -0,0 +1,103 @@
+{
+  "$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"
+    },
+    "type": {
+      "$ref": "definitions.json#/definitions/type"
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    },
+    "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",
+            "enum": ["arming", "disarming", "armed", "disarmed", "alarm"]
+          },
+          "readyToArm": {
+            "type": "boolean"
+          }
+        },
+        "additionalProperties": false
+      }
+    },
+    "zones": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "number": {
+            "type": "number",
+            "minimum": 0
+          },
+          "name": {
+            "type": "string"
+          },
+          "secure": {
+            "type": "boolean"
+          },
+          "bypassed": {
+            "type": "boolean"
+          }
+        },
+        "additionalProperties": false
+      }
+    },
+    "supportedTroubles": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "type": "string",
+        "enum": ["battery", "ac", "phone", "bell", "fire"]
+      }
+    },
+    "troubles": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/properties/supportedTroubles/items"
+      }
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "id",
+    "type",
+    "systemData",
+    "areas",
+    "zones",
+    "supportedTroubles",
+    "troubles",
+    "driver"
+  ]
+}

package/dist/cjs/schemas/camera.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "camera.json",
+  "title": "Camera",
+  "description": "Any smart camera",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "name": {
+      "type": "string"
+    },
+    "type": {
+      "$ref": "definitions.json#/definitions/type"
+    },
+    "supportedNotifications": {
+      "$ref": "definitions.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "definitions.json#/definitions/notification"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "liveStreams": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "iframe": {
+          "type": ["string", "null"]
+        },
+        "hls": {
+          "type": ["string", "null"]
+        },
+        "webRTC": {
+          "type": ["string", "null"]
+        }
+      }
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "type", "systemData", "streams", "driver"]
+}

package/dist/cjs/schemas/courtesy.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "courtesy.json",
+  "title": "Courtesy",
+  "description": "Any smart courtesy system",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "name": {
+      "type": "string"
+    },
+    "type": {
+      "$ref": "definitions.json#/definitions/type"
+    },
+    "supportedNotifications": {
+      "$ref": "definitions.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "definitions.json#/definitions/notification"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "supportedStates": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "enum": ["privacy", "service", "none"]
+      }
+    },
+    "state": {
+      "type": "string",
+      "$ref": "#/properties/supportedStates/items"
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "type", "driver", "supportedStates", "state"]
+}

package/dist/cjs/schemas/credential.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "credential.json",
+  "title": "Credential",
+  "type": "object",
+  "required": ["type", "credential", "expires"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["verificationCode", "token", "mobileKey"]
+    },
+    "credential": {
+      "type": "string"
+    },
+    "user": {
+      "type": "string"
+    },
+    "userAgent": {
+      "type": "string"
+    },
+    "expires": {
+      "string": "string"
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    }
+  }
+}