@kohost/api-client 1.0.0-beta.5 → 3.0.0-beta.100

package/dist/cjs/schemas/thermostat.json

@@ -0,0 +1,150 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "thermostat.json",
+  "title": "Thermostat",
+  "description": "Any smart thermostat",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "name": {
+      "$ref": "definitions.json#/definitions/name"
+    },
+    "type": {
+      "$ref": "definitions.json#/definitions/type",
+      "default": "thermostat"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "offline": {
+      "type": "boolean"
+    },
+    "supportedNotifications": {
+      "$ref": "definitions.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "definitions.json#/definitions/notification"
+    },
+    "currentTemperature": {
+      "type": "number"
+    },
+    "currentHumidity": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 99
+    },
+    "hvacMode": {
+      "type": "string",
+      "$ref": "#/properties/supportedHvacModes/items"
+    },
+    "hvacState": {
+      "type": ["string", "null"],
+      "enum": ["cooling", "heating", "off", null]
+    },
+    "fanMode": {
+      "type": "string",
+      "$ref": "#/properties/supportedFanModes/items"
+    },
+    "fanState": {
+      "type": ["string", "null"],
+      "enum": ["off", "low", "medium", "high", "on", null]
+    },
+    "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", "on"]
+      }
+    },
+    "setpoints": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "cool": {
+          "$ref": "#/$defs/setpoint"
+        },
+        "heat": {
+          "$ref": "#/$defs/setpoint"
+        },
+        "auto": {
+          "$ref": "#/$defs/setpoint"
+        }
+      }
+    },
+    "minAutoDelta": {
+      "type": "number",
+      "default": 3
+    },
+    "cycleRate": {
+      "type": "number"
+    },
+    "batteryLevel": {
+      "$ref": "definitions.json#/definitions/batteryLevel"
+    },
+    "systemId": {
+      "$ref": "definitions.json#/definitions/systemId"
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "$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",
+    "hvacMode",
+    "fanMode",
+    "hvacState",
+    "fanState",
+    "setpoints",
+    "temperatureScale",
+    "supportedHvacModes",
+    "supportedFanModes",
+    "driver"
+  ]
+}

package/dist/cjs/schemas/ticket.json

@@ -0,0 +1,181 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "ticket.json",
+  "title": "Ticket",
+  "description": "A ticket is a request from a user.",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["ticket"],
+      "default": "ticket"
+    },
+    "conversation": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "userId": {
+            "type": "string"
+          },
+          "userName": {
+            "type": "string"
+          },
+          "systemId": {
+            "type": "string"
+          },
+          "systemName": {
+            "type": "string"
+          },
+          "timestamp": {
+            "$ref": "definitions.json#/definitions/createdAt"
+          },
+          "body": {
+            "type": "string"
+          },
+          "readBy": {
+            "type": "array",
+            "default": [],
+            "items": {
+              "type": "string"
+            }
+          },
+          "media": {
+            "anyOf": [{ "$ref": "mediaFile.json" }, { "type": "null" }]
+          }
+        },
+        "anyOf": [
+          {
+            "required": ["id", "userId", "timestamp", "body"]
+          },
+          {
+            "required": ["id", "systemId", "timestamp", "body"]
+          }
+        ]
+      }
+    },
+
+    "openedBy": {
+      "type": "object",
+      "properties": {
+        "userId": {
+          "type": "string"
+        }
+      }
+    },
+    "requester": {
+      "type": "object",
+      "properties": {
+        "systemId": {
+          "type": "string"
+        },
+        "systemName": {
+          "type": "string"
+        },
+        "systemPhoto": {
+          "anyOf": [
+            { "$ref": "mediaFile.json" },
+            { "type": "null" },
+            { "type": "string" }
+          ]
+        },
+        "userId": {
+          "type": "string"
+        },
+        "userName": {
+          "type": "string"
+        },
+        "userPhoto": {
+          "anyOf": [
+            { "$ref": "mediaFile.json" },
+            { "type": "null" },
+            { "type": "string" }
+          ]
+        },
+        "deviceId": {
+          "type": "string"
+        },
+        "roomId": {
+          "type": "string"
+        },
+        "spaceId": {
+          "type": "string"
+        },
+        "spaceName": {
+          "type": "string"
+        }
+      }
+    },
+    "assignedTo": {
+      "type": "object",
+      "properties": {
+        "userId": {
+          "type": "string"
+        },
+        "userName": {
+          "type": "string"
+        },
+        "userPhoto": {
+          "anyOf": [
+            { "$ref": "mediaFile.json" },
+            { "type": "null" },
+            { "type": "string" }
+          ]
+        }
+      }
+    },
+    "status": {
+      "type": "string",
+      "enum": ["open", "pending", "solved", "closed"],
+      "default": "open"
+    },
+    "tags": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "type": "string"
+      }
+    },
+    "rating": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 5
+    },
+    "ratingComment": {
+      "type": "string"
+    },
+    "tipAmount": {
+      "type": "string"
+    },
+    "createdAt": {
+      "$ref": "definitions.json#/definitions/date"
+    },
+    "updatedAt": {
+      "$ref": "definitions.json#/definitions/date"
+    },
+    "solvedAt": {
+      "$ref": "definitions.json#/definitions/date"
+    },
+    "closedAt": {
+      "$ref": "definitions.json#/definitions/date"
+    }
+  },
+  "required": [
+    "id",
+    "conversation",
+    "requester",
+    "status",
+    "tags",
+    "createdAt",
+    "updatedAt"
+  ],
+  "additionalProperties": false
+}

package/dist/cjs/schemas/user.json

@@ -0,0 +1,170 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "user.json",
+  "title": "User",
+  "type": "object",
+  "required": ["firstName", "lastName"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "default": "user"
+    },
+    "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": "definitions.json#/definitions/address"
+    },
+    "secretKey": {
+      "type": "string"
+    },
+    "photo": {
+      "$ref": "mediaFile.json#"
+    },
+    "jobTitle": {
+      "type": "string"
+    },
+    "dob": {
+      "type": "string"
+    },
+    "gender": {
+      "type": "string",
+      "enum": ["male", "female"]
+    },
+    "nationality": {
+      "type": "string",
+      "minLength": 2,
+      "maxLength": 2
+    },
+    "permissions": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "type": "object",
+        "required": ["organization", "property", "role"],
+        "properties": {
+          "organization": {
+            "type": "string",
+            "description": "The ID of the organization the permission is applies to."
+          },
+          "property": {
+            "type": "string",
+            "description": "The ID of the property the permission is applies to."
+          },
+          "role": {
+            "type": "string",
+            "enum": ["Guest", "User", "Manager", "Administrator", "SuperAdmin"]
+          },
+          "customPermissions": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "additionalProperties": false
+      }
+    },
+    "notes": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "files": {
+      "type": "array",
+      "items": {
+        "$ref": "mediaFile.json#"
+      }
+    },
+    "identifications": {
+      "type": "array",
+      "items": {
+        "$ref": "identification.json#"
+      }
+    },
+    "payments": {
+      "type": "array",
+      "items": {
+        "$ref": "payment.json#"
+      }
+    },
+    "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"]
+        }
+      }
+    },
+    "reservations": {
+      "type": "array",
+      "items": {
+        "$ref": "reservation.json"
+      }
+    },
+    "spaceName": {
+      "type": "string"
+    },
+    "revenue": {
+      "$ref": "definitions.json#/definitions/revenue"
+    },
+    "createdAt": {
+      "$ref": "definitions.json#/definitions/createdAt"
+    },
+    "updatedAt": {
+      "$ref": "definitions.json#/definitions/updatedAt"
+    },
+    "systems": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "type": "object",
+        "properties": {
+          "systemId": {
+            "type": "string"
+          },
+          "property": {
+            "type": "string"
+          },
+          "driver": {
+            "type": "string"
+          }
+        },
+        "required": ["systemId", "property", "driver"],
+        "additionalProperties": false
+      }
+    }
+  }
+}

package/dist/cjs/schemas/windowCovering.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "windowCovering.json",
+  "title": "Window Covering",
+  "description": "Any smart window covering",
+  "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"
+    },
+    "offline": {
+      "type": "boolean"
+    },
+    "position": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100
+    },
+    "systemId": {
+      "$ref": "definitions.json#/definitions/systemId"
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "required": ["id", "type", "position", "driver"]
+}

package/dist/cjs/utils/errorFactory.js

@@ -0,0 +1,8 @@
+const Errors = require("../Errors");
+
+module.exports = function errorFactory(errName) {
+  const AllErrors = Object.values(Errors);
+  const TheError = AllErrors.find((E) => E.prototype.name === errName);
+  if (!TheError) return new Error("Invalid error name: " + errName);
+  return TheError;
+};

package/dist/cjs/utils/eventFactory.js

@@ -0,0 +1,10 @@
+const Events = require("../Events");
+
+function eventFactory(eventName) {
+  const AllEvents = Object.values(Events);
+  const Event = AllEvents.find((E) => E.prototype.name === eventName);
+  if (!Event) throw new Error("Invalid event name: " + eventName);
+  return Event;
+}
+
+module.exports = eventFactory;

package/dist/cjs/utils/getDeviceTypes.js

@@ -0,0 +1,7 @@
+const deviceTypes = require("../defs/deviceTypes");
+
+function getDeviceTypes() {
+  return deviceTypes;
+}
+
+module.exports = getDeviceTypes;

package/dist/cjs/utils/getFormalDeviceType.js

@@ -0,0 +1,5 @@
+function getFormalDeviceType(deviceType) {
+  return deviceType.charAt(0).toUpperCase() + deviceType.slice(1);
+}
+
+module.exports = getFormalDeviceType;

package/dist/cjs/utils/index.js

@@ -0,0 +1,11 @@
+const getFormalDeviceType = require("./getFormalDeviceType");
+const getDeviceTypes = require("./getDeviceTypes");
+const schema = require("./schema");
+const errorFactory = require("./errorFactory");
+
+module.exports = {
+  getFormalDeviceType: getFormalDeviceType,
+  getDeviceTypes: getDeviceTypes,
+  schema: schema,
+  errorFactory: errorFactory,
+};

package/dist/cjs/utils/schema.js

@@ -0,0 +1,25 @@
+const Ajv = require("ajv");
+const ajv = new Ajv({
+  allErrors: true,
+  useDefaults: true,
+  strict: false,
+  allowMatchingProperties: true,
+  allowUnionTypes: true,
+  strictRequired: false,
+});
+const addFormats = require("ajv-formats");
+
+const defininitions = require("../schemas/definitions.json");
+
+addFormats(ajv);
+
+ajv.addSchema(defininitions);
+
+module.exports = {
+  add: function add(schema) {
+    ajv.addSchema(schema);
+  },
+  compile: function compile(schema) {
+    return ajv.compile(schema);
+  },
+};