@kohost/api-client 1.0.0-alpha.2 → 1.0.0-alpha.4

package/schemas/space.json

@@ -0,0 +1,111 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/space.json",
+  "title": "Space",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "type": {
+      "type": ["string"],
+      "enum": [
+        "classRoom",
+        "hotelRoom",
+        "office",
+        "building",
+        "commonArea",
+        "other"
+      ]
+    },
+    "rooms": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "subGroups": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "eco": {
+      "type": "object",
+      "additionalProperties": false,
+      "default": {
+        "active": false,
+        "allowed": false
+      },
+      "properties": {
+        "active": {
+          "type": "boolean",
+          "default": false
+        },
+        "activatedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "allowed": {
+          "type": "boolean",
+          "default": false
+        }
+      }
+    },
+    "features": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "maximumOccupancy": {
+      "type": "number",
+      "minimum": 1
+    },
+    "housekeepingStatus": {
+      "type": "string",
+      "enum": ["clean", "dirty", "inspected", "pickup"]
+    },
+    "serviceStatus": {
+      "type": "string",
+      "enum": ["inService", "outOfOrder", "outOfService"]
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/systemData"
+    }
+  },
+  "if": {
+    "properties": { "type": { "const": "hotelRoom" } }
+  },
+  "then": {
+    "required": [
+      "name",
+      "type",
+      "features",
+      "maximumOccupancy",
+      "housekeepingStatus",
+      "serviceStatus"
+    ],
+    "properties": {
+      "features": {
+        "default": []
+      },
+      "maximumOccupancy": {
+        "default": 2
+      },
+      "housekeepingStatus": {
+        "default": "dirty"
+      },
+      "serviceStatus": {
+        "default": "inService"
+      }
+    }
+  },
+  "else": {
+    "required": ["name", "type"]
+  }
+}

package/schemas/switch.json

@@ -6,19 +6,22 @@
   "type": "object",
   "properties": {
     "id": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/id"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/id"
     },
     "type": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/type"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/type"
+    },
+    "subType": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/subType"
     },
     "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/systemData"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
     },
     "supportedNotifications": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/supportedNotifications"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
     },
     "notification": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/notification"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/notification"
     },
     "state": {
       "type": "string",

package/schemas/thermostat.json

@@ -6,27 +6,35 @@
   "type": "object",
   "properties": {
     "id": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/id"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/id"
+    },
+    "name": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/name"
     },
     "type": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/type"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/type",
+      "default": "thermostat"
+    },
+    "subType": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/subType"
     },
     "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/systemData"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData",
+      "default": {}
     },
     "supportedNotifications": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/supportedNotifications"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
     },
     "notification": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/notification"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/notification"
     },
     "currentTemperature": {
       "type": "number",
       "minimum": 0,
-      "maximum": 99
+      "maximum": 130
     },
     "currentHumidity": {
-      "type": "number",
+      "type": ["number", "null"],
       "minimum": 0,
       "maximum": 99
     },
@@ -48,11 +56,12 @@
     },
     "temperatureScale": {
       "type": "string",
-      "enum": ["celcius", "farenheit"]
+      "enum": ["celsius", "fahrenheit"],
+      "default": "fahrenheit"
     },
     "humidityScale": {
-      "type": "string",
-      "enum": ["absolute", "relative"]
+      "type": ["string", "null"],
+      "enum": ["absolute", "relative", null]
     },
     "supportedHvacModes": {
       "type": "array",

package/schemas/ticket.json

@@ -0,0 +1,82 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/ticket.json",
+  "title": "Ticket",
+  "description": "A ticket is a request for help from a user.",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+    },
+    "conversation": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "user": {
+            "type": "string"
+          },
+          "timestamp": {
+            "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/createdAt"
+          },
+          "body": {
+            "type": "string"
+          },
+          "readBy": {
+            "type": "array",
+            "default": [],
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "required": ["user", "id", "timestamp", "body"]
+      }
+    },
+    "requester": {
+      "type": "string"
+    },
+    "assignedTo": {
+      "type": ["string", "null"]
+    },
+    "status": {
+      "type": "string",
+      "enum": ["open", "pending", "solved", "closed"],
+      "default": "open"
+    },
+    "tags": {
+      "type": "array",
+      "default": [],
+      "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/createdAt"
+    },
+    "solvedAt": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/createdAt"
+    },
+    "closedAt": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/createdAt"
+    }
+  },
+  "required": [
+    "id",
+    "conversation",
+    "requester",
+    "status",
+    "tags",
+    "createdAt",
+    "updatedAt"
+  ],
+  "additionalProperties": false
+}

package/schemas/user.json

@@ -0,0 +1,124 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/user.json",
+  "title": "User",
+  "type": "object",
+  "required": ["active", "lastName", "roles"],
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "default": "user"
+    },
+    "active": {
+      "type": "boolean",
+      "default": true
+    },
+    "firstName": {
+      "type": "string"
+    },
+    "lastName": {
+      "type": "string"
+    },
+    "phone": {
+      "type": ["string", "null"],
+      "pattern": "^\\+?[0-9]{1,14}$"
+    },
+    "email": {
+      "type": ["string", "null"],
+      "format": "email"
+    },
+    "hashedPassword": {
+      "type": "string"
+    },
+    "photo": {
+      "type": "string"
+    },
+    "jobTitle": {
+      "type": "string"
+    },
+    "dob": {
+      "type": "string"
+    },
+    "gender": {
+      "type": "string"
+    },
+    "roles": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "Guest",
+          "Staff",
+          "Faculty",
+          "Student",
+          "Visitor",
+          "Manager",
+          "Administrator",
+          "SuperAdmin"
+        ]
+      }
+    },
+    "identifications": {
+      "type": "array",
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/identification.json"
+      }
+    },
+    "payments": {
+      "type": "array",
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/payment.json"
+      }
+    },
+    "preferences": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "notifications": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "examples": [["roomControl", "marketing"]]
+        },
+        "location": {
+          "title": "The location Schema",
+          "type": "boolean",
+          "default": false,
+          "examples": [true]
+        }
+      }
+    },
+    "location": {
+      "type": "object",
+      "required": ["accuracy", "latitude", "longitude", "timestamp"],
+      "additionalProperties": false,
+      "properties": {
+        "accuracy": {
+          "type": ["number", "null"]
+        },
+        "latitude": {
+          "type": ["number", "null"]
+        },
+        "longitude": {
+          "type": ["number", "null"]
+        },
+        "timestamp": {
+          "type": ["number", "null"]
+        }
+      }
+    },
+    "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"
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/systemData"
+    }
+  }
+}

package/schemas/windowCovering.json

@@ -6,19 +6,22 @@
   "type": "object",
   "properties": {
     "id": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/id"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/id"
     },
     "type": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/type"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/type"
+    },
+    "subType": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/subType"
     },
     "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/systemData"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
     },
     "supportedNotifications": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/supportedNotifications"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
     },
     "notification": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/notification"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/notification"
     },
     "position": {
       "type": "number",

package/tests/unit/models/space.test.js

@@ -0,0 +1,31 @@
+const Space = require("../../../models/space");
+
+const valid = {
+  name: "Test Space",
+};
+
+test("throws error if invalid name provided ", () => {
+  const data = { ...valid };
+  data.name = "";
+  expect(() => new Space(data)).toThrow();
+});
+
+test("sets defaults based on hotelRoom type ", () => {
+  const data = { ...valid, type: "hotelRoom" };
+  const space = new Space(data);
+  expect(space).toHaveProperty("type", "hotelRoom");
+  expect(space).toHaveProperty("maximumOccupancy", 2);
+  expect(space).toHaveProperty("housekeepingStatus", "dirty");
+  expect(space).toHaveProperty("serviceStatus", "inService");
+  expect(space).toHaveProperty("features");
+});
+
+test("only sets defaults based on hotelRoom type ", () => {
+  const data = { ...valid, type: "classRoom" };
+  const space = new Space(data);
+  expect(space).not.toHaveProperty("type", "hotelRoom");
+  expect(space).not.toHaveProperty("maximumOccupancy");
+  expect(space).not.toHaveProperty("housekeepingStatus");
+  expect(space).not.toHaveProperty("serviceStatus");
+  expect(space).not.toHaveProperty("features");
+});

package/tests/unit/models/thermostat.test.js

@@ -0,0 +1,146 @@
+const Thermostat = require("../../../models/thermostat");
+
+const valid = {
+  id: "1",
+  type: "thermostat",
+  name: "Test Thermostat",
+  hvacMode: "cool",
+  hvacState: "off",
+  fanMode: "auto",
+  fanState: "off",
+  temperatureScale: "fahrenheit",
+  supportedHvacModes: ["cool", "heat"],
+  supportedFanModes: ["auto", "low"],
+  currentTemperature: 72,
+  systemData: {},
+  setpoints: {
+    cool: {
+      min: 60,
+      max: 85,
+      value: 72,
+    },
+    heat: {
+      value: 68,
+      min: 60,
+      max: 85,
+    },
+  },
+};
+
+test("Thermostat properties exist", () => {
+  expect(Thermostat.name).toBe("Thermostat");
+  expect(Thermostat.actionProperties).toBeDefined();
+  expect(Thermostat.actionProperties).toBeInstanceOf(Array);
+  expect(Thermostat.actionProperties).toEqual(
+    expect.arrayContaining(["hvacMode", "fanMode", "setpoints"])
+  );
+  expect(Thermostat.validProperties).toBeDefined();
+});
+
+test("Thermostat validator exists", () => {
+  const thermostat = new Thermostat(valid);
+  const validator = thermostat.validator;
+  expect(validator).toBeDefined();
+  expect(validator).toBeInstanceOf(Function);
+});
+
+test("Thermostat schema exists", () => {
+  const thermostat = new Thermostat(valid);
+  const schema = thermostat.schema;
+  expect(schema).toBeDefined();
+  expect(schema).toBeInstanceOf(Object);
+});
+
+test("throws error if missing all required properties", () => {
+  expect(() => new Thermostat()).toThrow();
+});
+
+test("throws error if missing any required property", () => {
+  const data = {
+    id: "1",
+    name: "Test Thermostat",
+  };
+  expect(() => new Thermostat(data)).toThrow();
+});
+
+test("throws error if invalid hvacMode provided ", () => {
+  const data = { ...valid };
+  data.hvacMode = "a";
+  expect(() => new Thermostat(data)).toThrow();
+});
+
+test("throws error if unsupported hvacMode provided ", () => {
+  const data = { ...valid };
+  data.supportedHvacModes = ["cool"];
+  data.hvacMode = "heat";
+  expect(() => new Thermostat(data)).toThrow();
+});
+
+test("throws error if invalid hvacState provided ", () => {
+  const data = { ...valid };
+  data.hvacState = "a";
+  expect(() => new Thermostat(data)).toThrow();
+});
+
+test("throws error if invalid temperatureScale provided ", () => {
+  const data = { ...valid };
+  data.temperatureScale = "a";
+  expect(() => new Thermostat(data)).toThrow();
+});
+
+test("throws error if invalid humidityScale provided ", () => {
+  const data = { ...valid };
+  data.humidityScale = "a";
+  expect(() => new Thermostat(data)).toThrow();
+});
+
+test("throws error if invalid fanState provided ", () => {
+  const data = { ...valid };
+  data.fanState = "a";
+  expect(() => new Thermostat(data)).toThrow();
+});
+
+test("throws error if currentTemperature is out of range ", () => {
+  const data = { ...valid };
+  const data2 = { ...valid };
+  data.currentTemperature = 131;
+  data2.currentTemperature = -1;
+  expect(() => new Thermostat(data)).toThrow();
+  expect(() => new Thermostat(data2)).toThrow();
+});
+
+test("throws error if currentHumidity is out of range ", () => {
+  const data = { ...valid };
+  const data2 = { ...valid };
+  data.currentHumidity = 100;
+  data2.currentHumidity = -1;
+  expect(() => new Thermostat(data)).toThrow();
+  expect(() => new Thermostat(data2)).toThrow();
+});
+
+test("returns deltas", () => {
+  const thermostat = new Thermostat({ ...valid });
+
+  const delta1 = Thermostat.getActionDelta(thermostat, {
+    hvacMode: "heat",
+    setpoints: {
+      cool: {
+        value: 71,
+      },
+    },
+  });
+
+  const delta2 = Thermostat.getActionDelta(thermostat, {
+    setpoints: {
+      heat: {
+        value: 71,
+      },
+    },
+  });
+
+  expect(delta1.hvacMode).toBe(1);
+  expect(delta1["setpoints.cool"]).toBeLessThan(0);
+  expect(delta1["setpoints.cool"]).toBeGreaterThan(-1);
+  expect(delta2["setpoints.heat"]).toBeGreaterThan(0);
+  expect(delta2["setpoints.heat"]).toBeLessThan(1);
+});

package/tests/unit/models/user.test.js

@@ -0,0 +1,28 @@
+const User = require("../../../models/user");
+
+const valid = {
+  firstName: "Ian",
+  lastName: "Rogers",
+  active: true,
+  type: "user",
+  email: "a3@bc.com",
+  phone: "+15555555555",
+  roles: ["Guest"],
+};
+
+test("does not throw error if invalid name provided ", () => {
+  const data = { ...valid };
+  expect(() => new User(data)).not.toThrow();
+});
+
+test("allows email to be empty", () => {
+  const data = { ...valid };
+  delete data.email;
+  expect(() => new User(data)).not.toThrow();
+});
+
+test("allows phone to be empty", () => {
+  const data = { ...valid };
+  delete data.phone;
+  expect(() => new User(data)).not.toThrow();
+});