@kohost/api-client 1.0.0-beta.3 → 1.0.0-beta.4

package/models/switch.js

@@ -1,33 +0,0 @@
-// create the Switch model
-const schemas = require("../utils/schema");
-const schema = require("../schemas/switch.json");
-const Kohost = require("./kohost");
-
-schemas.add(schema);
-const validator = schemas.compile(schema);
-
-class Switch extends Kohost {
-  constructor(data) {
-    super(data);
-  }
-}
-
-Object.defineProperty(Switch.prototype, "schema", {
-  value: schema,
-});
-
-Object.defineProperty(Switch.prototype, "validator", {
-  get: function () {
-    return validator;
-  },
-});
-
-Object.defineProperty(Switch, "validProperties", {
-  value: Object.keys(schema.properties),
-});
-
-Object.defineProperty(Switch, "actionProperties", {
-  value: ["state"],
-});
-
-module.exports = Switch;

package/models/thermostat.js

@@ -1,80 +0,0 @@
-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 {
-  constructor(data) {
-    super(data);
-  }
-
-  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/models/ticket.js

@@ -1,91 +0,0 @@
-// Create the User Model
-const schemas = require("../utils/schema");
-const schema = require("../schemas/ticket.json");
-const Kohost = require("./kohost");
-
-const sortBy = require("lodash.sortby");
-const findLast = require("lodash.findlast");
-
-const { nanoid } = require("nanoid");
-
-schemas.add(schema);
-const validator = schemas.compile(schema);
-
-class Ticket extends Kohost {
-  constructor(data) {
-    super(data);
-  }
-
-  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),
-});
-
-Object.defineProperty(Ticket.prototype, "responseTime", {
-  get: function () {
-    const conversation = this.conversation;
-    const requester = this.requester;
-
-    if (conversation.length === 0) return 0;
-    const mapped = conversation.map((msg) => {
-      if (typeof msg.timestamp === "string")
-        msg.timestamp = new Date(msg.timestamp);
-      return msg;
-    });
-    const sorted = sortBy(mapped, ["timestamp"]);
-    const firstMsg = sorted.find((entry) => entry.user === requester);
-    const firstResponse = sorted.find((entry) => entry.user !== requester);
-
-    if (firstMsg && firstResponse) {
-      const firstMsgTime = firstMsg.timestamp.getTime() / 1000;
-      const firstResponseTime = firstResponse.timestamp.getTime() / 1000;
-      return firstResponseTime - firstMsgTime;
-    }
-
-    return 0;
-  },
-});
-
-Object.defineProperty(Ticket.prototype, "resolutionTime", {
-  get: function () {
-    if (this.status !== "closed") return 0;
-    const createdAt = this.createdAt.getTime() / 1000;
-    const solvedAt = this.solvedAt
-      ? this.solvedAt.getTime() / 1000
-      : this.updatedAt.getTime() / 1000;
-
-    return Math.abs(solvedAt - createdAt);
-  },
-});
-
-Object.defineProperty(Ticket.prototype, "lastResponder", {
-  get: function () {
-    const conversation = this.conversation;
-    const requester = this.requester;
-
-    const sorted = sortBy(conversation, ["timestamp"]);
-
-    const lastFromNonRequester = findLast(sorted, function (c) {
-      return c.user !== requester;
-    });
-
-    if (!lastFromNonRequester) return null;
-    else return lastFromNonRequester.user;
-  },
-});
-
-module.exports = Ticket;

package/models/user.js

@@ -1,56 +0,0 @@
-// 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 { nanoid } = require("nanoid/async");
-
-schemas.add(paymentSchema);
-schemas.add(schema);
-
-const validator = schemas.compile(schema);
-
-class User extends Kohost {
-  constructor(data) {
-    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}`;
-  },
-});
-
-module.exports = User;

package/models/windowCovering.js

@@ -1,49 +0,0 @@
-// 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/prepare.js

@@ -1,4 +0,0 @@
-const isCi = process.env.CI !== undefined;
-if (!isCi) {
-  require("husky").install();
-}

package/schemas/acl.json

@@ -1,111 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "https://api.kohost.app/schemas/v3/acl.json",
-  "title": "Access Control List Schema",
-  "type": "object",
-  "required": ["id", "name", "resource", "resourceFilter", "permissions"],
-  "properties": {
-    "id": {
-      "type": "string"
-    },
-    "name": {
-      "type": "string"
-    },
-    "resourceType": {
-      "type": "string",
-      "enum": [
-        "*",
-        "Guest",
-        "Reservation",
-        "User",
-        "Manager",
-        "Admin",
-        "SuperAdmin",
-        "Ticket",
-        "Group",
-        "HotelRoom",
-        "Room",
-        "Notification",
-        "Image",
-        "EnergyReport",
-        "RoomType",
-        "SceneTemplate",
-        "Setting",
-        "Subscription",
-        "Integration",
-        "PMS",
-        "Source",
-        "ACL"
-      ]
-    },
-    "resource": {
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
-    },
-    "resourceFilter": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "resourceType": {
-            "type": "string",
-            "enum": ["SubSystem"]
-          },
-          "resource": {
-            "type": "array",
-            "items": {
-              "type": "string"
-            }
-          },
-          "permissions": {
-            "type": "array",
-            "uniqueItems": true,
-            "items": {
-              "type": "string",
-              "enum": [
-                "*",
-                "read",
-                "write",
-                "delete",
-                "create",
-                "update",
-                "list",
-                "execute"
-              ]
-            }
-          }
-        }
-      }
-    },
-    "permissions": {
-      "type": "array",
-      "uniqueItems": true,
-      "items": {
-        "type": "string",
-        "enum": [
-          "*",
-          "read",
-          "write",
-          "delete",
-          "create",
-          "update",
-          "list",
-          "execute"
-        ]
-      }
-    },
-    "begins": {
-      "type": ["object", "null"]
-    },
-    "expires": {
-      "type": ["object", "null"]
-    },
-    "global": {
-      "type": "boolean",
-      "default": false
-    }
-  },
-  "definitions": {}
-}

package/schemas/admin/customer.json

@@ -1,32 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "https://api.kohost.app/schemas/v3/admin/customer.json",
-  "title": "Customer",
-  "type": "object",
-  "description": "A Kohost customer",
-  "required": ["accountNumber", "name"],
-  "properties": {
-    "id": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
-    },
-    "accountNumber": {
-      "type": "number",
-      "minimum": 10000
-    },
-    "name": {
-      "type": "string"
-    },
-    "properties": {
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
-    },
-    "createdAt": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/createdAt"
-    },
-    "updatedAt": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/updatedAt"
-    }
-  }
-}

package/schemas/admin/property.json

@@ -1,180 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "https://api.kohost.app/schemas/v3/admin/property.json",
-  "title": "Property",
-  "type": "object",
-  "description": "A property is a physical asset or building",
-  "required": ["id", "name", "type", "hostname"],
-  "properties": {
-    "id": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
-    },
-    "name": {
-      "type": "string"
-    },
-    "type": {
-      "type": "string",
-      "enum": ["hospitality", "education", "commercial"]
-    },
-    "timezone": {
-      "type": "string"
-    },
-    "smsNumber": {
-      "type": "string"
-    },
-    "hostname": {
-      "type": "string"
-    },
-    "address": {
-      "type": "object",
-      "properties": {
-        "street": {
-          "type": "string"
-        },
-        "city": {
-          "type": "string"
-        },
-        "state": {
-          "type": "string"
-        },
-        "zip": {
-          "type": "string"
-        },
-        "country": {
-          "type": "string"
-        }
-      }
-    },
-    "latitude": {
-      "type": "number"
-    },
-    "longitude": {
-      "type": "number"
-    },
-    "appManifest": {
-      "type": "object",
-
-      "properties": {
-        "name": {
-          "type": "string"
-        },
-        "short_name": {
-          "type": "string"
-        },
-        "scope": {
-          "type": "string"
-        },
-        "start_url": {
-          "type": "string"
-        },
-        "themeColor": {
-          "type": "string"
-        },
-        "backgroundColor": {
-          "type": "string"
-        },
-        "display": {
-          "type": "string",
-          "enum": ["fullscreen", "standalone", "minimal-ui", "browser"],
-          "default": "fullscreen"
-        },
-        "orientation": {
-          "type": "string",
-          "enum": ["portrait", "landscape"],
-          "default": "portrait"
-        },
-        "splash": {
-          "type": "object",
-          "properties": {
-            "src": {
-              "type": "string"
-            },
-            "type": {
-              "type": "string"
-            },
-            "sizes": {
-              "type": "string"
-            }
-          }
-        },
-        "icons": {
-          "type": "array",
-          "items": {
-            "type": "object",
-            "properties": {
-              "src": {
-                "type": "string"
-              },
-              "sizes": {
-                "type": "string"
-              },
-              "type": {
-                "type": "string"
-              }
-            }
-          }
-        },
-        "logo": {
-          "type": "object",
-          "properties": {
-            "src": {
-              "type": "string"
-            },
-            "type": {
-              "type": "string"
-            },
-            "sizes": {
-              "type": "string"
-            }
-          }
-        }
-      },
-      "default": {
-        "name": "Kohost",
-        "short_name": "Kohost",
-        "start_url": "/",
-        "scope": "/",
-        "display": "fullscreen",
-        "orientation": "portrait",
-        "theme_color": "#1d1f22",
-        "background_color": "#1d1f22",
-        "icons": [
-          {
-            "src": "https://cdn.kohost.app/defaultIcon.png",
-            "sizes": "512x512",
-            "type": "image/png"
-          }
-        ],
-        "splash": {
-          "src": "https://cdn.kohost.app/defaultSplash.jpg",
-          "sizes": "1500x800",
-          "type": "image/jpg"
-        },
-        "logo": {
-          "src": "https://cdn.kohost.app/defaultLogo.png",
-          "sizes": "300x75",
-          "type": "image/png"
-        }
-      }
-    },
-    "appFeatures": {
-      "type": "object",
-      "properties": {
-        "RoomControl": {},
-        "CheckIn": {},
-        "CheckOut": {},
-        "Concierge": {},
-        "Elevator": {}
-      },
-      "additionalProperties": false,
-      "default": {
-        "RoomControl": {}
-      }
-    },
-    "credentials": {
-      "type": "object",
-      "additionalProperties": true
-    },
-    "additionalProperties": false
-  }
-}