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

package/schemas/space.json

@@ -1,111 +0,0 @@
-{
-  "$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

@@ -1,33 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "https://api.kohost.app/schemas/v3/switch.json",
-  "title": "Switch",
-  "description": "Any smart switch",
-  "type": "object",
-  "properties": {
-    "id": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/id"
-    },
-    "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"
-    },
-    "supportedNotifications": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
-    },
-    "notification": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/notification"
-    },
-    "state": {
-      "type": "string",
-      "enum": ["on", "off"]
-    },
-    "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
-    }
-  },
-  "additionalProperties": false,
-  "required": ["id", "type", "systemData", "state"]
-}

package/schemas/thermostat.json

@@ -1,139 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "https://api.kohost.app/schemas/v3/thermostat.json",
-  "title": "Thermostat",
-  "description": "Any smart thermostat",
-  "type": "object",
-  "properties": {
-    "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/definitions/device.json#/definitions/type",
-      "default": "thermostat"
-    },
-    "subType": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/subType"
-    },
-    "supportedNotifications": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
-    },
-    "notification": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/notification"
-    },
-    "currentTemperature": {
-      "type": "number"
-    },
-    "currentHumidity": {
-      "type": "number",
-      "minimum": 0,
-      "maximum": 99
-    },
-    "hvacMode": {
-      "type": "string",
-      "$ref": "#/properties/supportedHvacModes/items"
-    },
-    "hvacState": {
-      "type": "string",
-      "enum": ["cooling", "heating", "off"]
-    },
-    "fanMode": {
-      "type": "string",
-      "$ref": "#/properties/supportedFanModes/items"
-    },
-    "fanState": {
-      "type": "string",
-      "enum": ["off", "low", "medium", "high"]
-    },
-    "temperatureScale": {
-      "type": "string",
-      "enum": ["celsius", "fahrenheit"],
-      "default": "fahrenheit"
-    },
-    "humidityScale": {
-      "type": ["string", "null"],
-      "enum": ["absolute", "relative", null]
-    },
-    "supportedHvacModes": {
-      "type": "array",
-      "uniqueItems": true,
-      "minItems": 2,
-      "items": {
-        "enum": ["cool", "heat", "auto", "off"]
-      }
-    },
-    "supportedFanModes": {
-      "type": "array",
-      "uniqueItems": true,
-      "items": {
-        "enum": ["auto", "low", "medium", "high", "off"]
-      }
-    },
-    "setpoints": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "cool": {
-          "$ref": "#/$defs/setpoint"
-        },
-        "heat": {
-          "$ref": "#/$defs/setpoint"
-        },
-        "auto": {
-          "$ref": "#/$defs/setpoint"
-        }
-      }
-    },
-    "batteryLevel": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/batteryLevel"
-    },
-    "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData",
-      "default": {}
-    }
-  },
-  "additionalProperties": false,
-  "$defs": {
-    "setpoint": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "value": {
-          "$ref": "#/$defs/setpointValue"
-        },
-        "min": {
-          "$ref": "#/$defs/setpointMinMax"
-        },
-        "max": {
-          "$ref": "#/$defs/setpointMinMax"
-        }
-      }
-    },
-    "setpointValue": {
-      "type": "number",
-      "minimum": 0,
-      "maximum": 99
-    },
-    "setpointMinMax": {
-      "type": ["number", "null"],
-      "minimum": 0,
-      "maximum": 99
-    }
-  },
-  "required": [
-    "id",
-    "type",
-    "systemData",
-    "hvacMode",
-    "fanMode",
-    "hvacState",
-    "fanState",
-    "setpoints",
-    "temperatureScale",
-    "supportedHvacModes",
-    "supportedFanModes" 
-  ]
-}

package/schemas/ticket.json

@@ -1,82 +0,0 @@
-{
-  "$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

@@ -1,176 +0,0 @@
-{
-  "$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}$"
-    },
-    "phoneVerified": {
-      "type": "boolean"
-    },
-    "email": {
-      "type": ["string", "null"],
-      "format": "email"
-    },
-    "emailVerified": {
-      "type": "boolean"
-    },
-    "address": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/address"
-    },
-    "secretKey": {
-      "type": "string"
-    },
-    "photo": {
-      "type": "string"
-    },
-    "jobTitle": {
-      "type": "string"
-    },
-    "dob": {
-      "type": "string"
-    },
-    "gender": {
-      "type": "string",
-      "enum": ["male", "female"]
-    },
-    "nationality": {
-      "type": "string",
-      "minLength": 2,
-      "maxLength": 2
-    },
-    "notes": {
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
-    },
-    "files": {
-      "type": "array",
-      "items": {
-        "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/file"
-      }
-    },
-    "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"]
-        }
-      }
-    },
-    "registeredDevices": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "userAgent": {
-            "type": "string"
-          },
-          "fingerPrint": {
-            "type": "string"
-          },
-          "ip": {
-            "type": "string"
-          },
-          "registeredAt": {
-            "type": "string",
-            "format": "date-time"
-          },
-          "expiresAt": {
-            "type": "string",
-            "format": "date-time"
-          }
-        }
-      }
-    },
-    "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

@@ -1,34 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "https://api.kohost.app/schemas/v3/windowCovering.json",
-  "title": "Window Covering",
-  "description": "Any smart window covering",
-  "type": "object",
-  "properties": {
-    "id": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/id"
-    },
-    "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"
-    },
-    "supportedNotifications": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
-    },
-    "notification": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/notification"
-    },
-    "position": {
-      "type": "number",
-      "minimum": 0,
-      "maximum": 100
-    },
-    "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
-    }
-  },
-  "additionalProperties": false,
-  "required": ["id", "type", "systemData", "position"]
-}

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

@@ -1,31 +0,0 @@
-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");
-});