@kohost/api-client 1.0.0-alpha.4 → 1.0.0-beta.1

package/models/reservation.js

@@ -17,6 +17,53 @@ class Reservation extends Kohost {
   get hasPayment() {
     return this.paymentId?.length > 0;
   }
+
+  range(tz) {
+    const start = new Date(this.checkInDateTime);
+    const end = new Date(this.checkOutDateTime);
+
+    // output Dec 19-23 if same month and year
+    if (
+      start.getMonth() === end.getMonth() &&
+      start.getFullYear() === end.getFullYear()
+    ) {
+      return `${start.toLocaleString("default", {
+        month: "short",
+        timeZone: tz,
+      })} ${start.toLocaleString("default", {
+        timeZone: tz,
+        day: "numeric",
+      })}-${end.toLocaleString("default", {
+        timeZone: tz,
+        day: "numeric",
+      })}`;
+    }
+
+    // output Dec 19 - Jan 2 if different month and year
+    return `${start.toLocaleString("default", {
+      month: "short",
+      timeZone: tz,
+    })} ${start.getDate()} - ${end.toLocaleString("default", {
+      month: "short",
+      timeZone: tz,
+    })} ${end.getDate()}`;
+  }
+
+  checkInTime(tz) {
+    return new Date(this.checkInDateTime).toLocaleString("default", {
+      hour: "numeric",
+      minute: "numeric",
+      timeZone: tz,
+    });
+  }
+
+  checkOutTime(tz) {
+    return new Date(this.checkOutDateTime).toLocaleString("default", {
+      hour: "numeric",
+      minute: "numeric",
+      timeZone: tz,
+    });
+  }
 }
 
 Object.defineProperty(Reservation.prototype, "schema", {

package/models/room.js

@@ -11,7 +11,6 @@ const Thermostat = require("./thermostat");
 const Lock = require("./lock");
 const WindowCovering = require("./windowCovering");
 const Courtesy = require("./courtesy");
-const SceneController = require("./sceneController");
 const Camera = require("./camera");
 const Alarm = require("./alarm");
 const Source = require("./mediaSource");
@@ -37,7 +36,6 @@ class Room extends Kohost {
       "lock",
       "windowCovering",
       "courtesy",
-      "sceneController",
       "camera",
       "source",
       "motionSensor",
@@ -79,10 +77,6 @@ class Room extends Kohost {
     return this.courtesy?.length > 0;
   }
 
-  get hasSceneController() {
-    return this.sceneControllers?.length > 0;
-  }
-
   get hasCamera() {
     return this.cameras?.length > 0;
   }
@@ -135,7 +129,7 @@ function mapRoomData(data) {
   });
 
   roomData.thermostats?.map((thermostat) => {
-    if (thermostat instanceof Thermostat) return thermostat;
+    if (thermostat instanceof Thermostat) return thermostat; 
     else return new Thermostat(thermostat);
   });
 
@@ -154,11 +148,6 @@ function mapRoomData(data) {
     else return new Source(source);
   });
 
-  roomData.sceneControllers?.map((sceneController) => {
-    if (sceneController instanceof SceneController) return sceneController;
-    else return new SceneController(sceneController);
-  });
-
   roomData.cameras?.map((camera) => {
     if (camera instanceof Camera) return camera;
     else return new Camera(camera);

package/models/shortLink.js

@@ -0,0 +1,29 @@
+// Create the Lock Model
+const schemas = require("../utils/schema");
+const schema = require("../schemas/shortLink.json");
+const Kohost = require("./kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class ShortLink extends Kohost {
+  constructor(data) {
+    super(data);
+  }
+}
+
+Object.defineProperty(ShortLink.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(ShortLink.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(ShortLink, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+module.exports = ShortLink;

package/models/space.js

@@ -10,7 +10,7 @@ const Room = require("./room");
 schemas.add(schema);
 const validator = schemas.compile(schema);
 
-class Space extends Kohost {
+class Space extends Kohost { 
   constructor(data) {
     const spaceData = mapSpaceData(data);
     super(spaceData);

package/models/thermostat.js

@@ -11,16 +11,16 @@ class Thermostat extends Kohost {
   }
 
   toCelsius() {
-    if (this.temperatureScale === "farenheit")
+    if (this.temperatureScale === "fahrenheit")
       this.currentTemperature = ((this.currentTemperature - 32) * 5) / 9;
     this.temperatureScale = "celsius";
     return this.currentTemperature;
   }
 
-  toFarenheit() {
+  toFahrenheit() {
     if (this.temperatureScale === "celsius")
       this.currentTemperature = (this.currentTemperature * 9) / 5 + 32;
-    this.temperatureScale = "farenheit";
+    this.temperatureScale = "fahrenheit";
     return this.currentTemperature;
   }
 

package/models/user.js

@@ -1,13 +1,11 @@
 // Create the User Model
 const schemas = require("../utils/schema");
 const schema = require("../schemas/user.json");
-const idSchema = require("../schemas/identification.json");
 const paymentSchema = require("../schemas/payment.json");
 const Kohost = require("./kohost");
 
 const { nanoid } = require("nanoid/async");
 
-schemas.add(idSchema);
 schemas.add(paymentSchema);
 schemas.add(schema);
 

package/models/windowCovering.js

@@ -11,7 +11,7 @@ class WindowCovering extends Kohost {
     super(data);
   }
 
-  static getActionDelta(old, _new) {
+  static getActionDelta(old, _new) {  
     const delta = {};
     for (const action in _new) {
       if (this.actionProperties?.includes(action)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kohost/api-client",
-  "version": "1.0.0-alpha.4",
+  "version": "1.0.0-beta.1",
   "description": "API client for Kohost utils",
   "main": "index.js",
   "module": "index.js",

package/schemas/admin/property.json

@@ -4,7 +4,7 @@
   "title": "Property",
   "type": "object",
   "description": "A property is a physical asset or building",
-  "required": ["id", "name", "type"],
+  "required": ["id", "name", "type", "hostname"],
   "properties": {
     "id": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
@@ -19,6 +19,12 @@
     "timezone": {
       "type": "string"
     },
+    "smsNumber": {
+      "type": "string"
+    },
+    "hostname": {
+      "type": "string"
+    },
     "address": {
       "type": "object",
       "properties": {

package/schemas/camera.json

@@ -11,9 +11,6 @@
     "type": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/type"
     },
-    "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
-    },
     "supportedNotifications": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
     },
@@ -34,6 +31,9 @@
           "type": ["string", "null"]
         }
       }
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
     }
   },
   "additionalProperties": false,

package/schemas/courtesy.json

@@ -11,9 +11,6 @@
     "type": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/type"
     },
-    "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
-    },
     "supportedNotifications": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
     },
@@ -30,6 +27,9 @@
     "state": {
       "type": "string",
       "$ref": "#/properties/supportedStates/items"
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
     }
   },
   "additionalProperties": false,

package/schemas/credential.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/credential.json",
+  "title": "Credential",
+  "type": "object",
+  "required": ["type", "credential", "expires"],
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["verificationCode", "token"]
+    },
+    "credential": {
+      "type": "string"
+    },
+    "user": {
+      "type": "string"
+    },
+    "userAgent": {
+      "type": "string"
+    },
+    "expires": {
+      "string": "string"
+    }
+  }
+}

package/schemas/definitions/common.json

@@ -9,6 +9,10 @@
       "type": "object",
       "default": {}
     },
+    "metadata": {
+      "type": "object",
+      "default": {}
+    },
     "createdAt": {
       "type": ["string", "object"],
       "format": "date-time"
@@ -16,6 +20,55 @@
     "updatedAt": {
       "type": ["string", "object"],
       "format": "date-time"
+    },
+    "file": {
+      "type":"object",
+      "required": ["name", "type", "data"],
+      "properties": {
+        "name": {
+          "type":"string",
+          "description": "Name of the file."
+        },
+        "type": {
+          "type":"string",
+          "description": "MIME type of the file (e.g. application/pdf)."
+        },
+        "data": {
+          "type":"string",
+          "description": "Base64-encoded data of the file."
+        }
+      }
+    },
+    "address": {
+      "type":"object",
+      "properties": {
+        "id": {
+          "type":"string"
+        },
+        "line1": {
+          "type":"string"
+        },
+        "line2": {
+          "type":"string"
+        },
+        "line3": {
+          "type":"string"
+        },
+        "city": {
+          "type":"string"
+        },
+        "state": {
+          "type":"string"
+        },
+        "postalCode": {
+          "type":"string"
+        },
+        "countryCode": {
+          "type":"string",
+          "minLength": 2,
+          "maxLength": 2
+        }
+      }
     }
   }
 }

package/schemas/definitions/device.json

@@ -20,10 +20,11 @@
         "thermostat",
         "lock",
         "courtesy",
-        "sceneController"
+        "sceneController",
+        "gateway"
       ]
     },
-    "name": {
+    "name": { 
       "type": "string"
     },
     "subType": {
@@ -34,6 +35,11 @@
       "uniqueItems": true,
       "items": {
         "enum": [
+          "button 1",
+          "button 2",
+          "button 3",
+          "button 4",
+          "button 5",
           "idle",
           "powerHasBeedApplied",
           "acMainsDisconnected",
@@ -60,6 +66,11 @@
           "minimum": 1655907956593
         }
       }
+    },
+    "batteryLevel": {
+      "type":"number",
+      "minimum": 0,
+      "maximum": 100
     }
   }
 }

package/schemas/dimmer.json

@@ -14,9 +14,6 @@
     "subType": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/subType"
     },
-    "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
-    },
     "supportedNotifications": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
     },
@@ -27,6 +24,9 @@
       "type": "number",
       "minimum": 0,
       "maximum": 100
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
     }
   },
   "additionalProperties": false,

package/schemas/gateway.json

@@ -1,61 +1,30 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "https://api.kohost.app/schemas/v3/gateway.json",
-  "title": "Gateway",
-  "description": "Any Kohost gateway",
+  "$id": "https://api.kohost.app/schemas/v3/iotGateway.json",
+  "title": "IoT Gateway",
+  "description": "Any smart gateway that is an entrypoint for controlling devices",
   "type": "object",
   "properties": {
     "id": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/id"
     },
-    "name": {
-      "type": "string"
-    },
-    "hashedAuthKey": {
-      "type": "string"
+    "type": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/type"
     },
-    "integrations": {
-      "type": "array",
-      "items": {
-        "oneOf": [
-          {
-            "$ref": "https://api.kohost.app/schemas/v3/integration.json"
-          },
-          {
-            "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
-          }
-        ]
-      },
-      "default": []
+
+    "supportedNotifications": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
     },
-    "health": {
-      "type": "object",
-      "properties": {
-        "upSince": {
-          "type": "string",
-          "format": "date-time"
-        },
-        "lastSeen": {
-          "type": "string",
-          "format": "date-time"
-        }
-      },
-      "additionalProperties": false
+    "notification": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/notification"
     },
-    "roles": {
-      "type": "array",
-      "items": {
-        "type": "string"
-      },
-      "default": ["Gateway"]
-    },
-    "createdAt": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/createdAt"
+    "status": {
+      "type": "string"
     },
-    "updatedAt": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/updatedAt"
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
     }
   },
   "additionalProperties": false,
-  "required": ["id", "name", "hashedAuthKey", "integrations", "health"]
+  "required": ["id", "type", "systemData", "status"]
 }

package/schemas/identification.json

@@ -3,26 +3,40 @@
   "$id": "https://api.kohost.app/schemas/v3/identification.json",
   "title": "Identification",
   "type": "object",
-  "required": ["type", "number", "expires", "issuingCountry"],
+  "required": ["type", "number", "expires"],
   "properties": {
     "id": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
     },
     "type": {
       "type": "string",
-      "enum": ["driversLicense", "passport", "identityCard"]
+      "enum": ["driversLicense", "passport", "identityCard", "visa"]  
     },
     "number": {
       "string": "string"
     },
     "issued": {
-      "string": "string",
+      "type": ["string", "object"],
       "format": "date-time"
     },
     "expires": {
-      "string": "string",
+      "type": ["string", "object"],
       "format": "date-time"
     },
+    "verified": {
+      "type": "boolean",
+      "default": false
+    },
+    "matched": {
+      "type": "boolean",
+      "default": false
+    },
+    "firstName": {
+      "type": "string"
+    },
+    "lastName": {
+      "type": "string"
+    },
     "issuingCountry": {
       "string": "string",
       "minLength": 2,

package/schemas/lock.json

@@ -8,15 +8,15 @@
     "id": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/id"
     },
+    "name": {
+      "type": "string"
+    },
     "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/definitions/device.json#/definitions/systemData"
-    },
     "supportedNotifications": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
     },
@@ -26,6 +26,9 @@
     "state": {
       "type": "string",
       "enum": ["locked", "unlocked"]
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
     }
   },
   "additionalProperties": false,

package/schemas/mediaSource.json

@@ -136,14 +136,14 @@
         "mtsSap"
       ]
     },
-    "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
-    },
     "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"
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
     }
   },
   "additionalProperties": false,

package/schemas/motionSensor.json

@@ -12,14 +12,14 @@
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/type"
     },
     "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
-    },
     "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"
-    }
+    },
+    "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
+  }
   },
   "additionalProperties": false,
   "required": ["id", "type", "systemData"]

package/schemas/payment.json

@@ -14,12 +14,14 @@
         "amex",
         "visa",
         "masterCard",
+        "maestro",
         "discover",
         "diners",
         "jcb",
         "applePay",
         "alipay",
-        "chinaUnionPay"
+        "chinaUnionPay",
+        "vpay"
       ]
     },
     "maskedNumber": {

package/schemas/product.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/product.json",
+  "title": "Product",
+  "type": "object",
+  "required": ["name", "description", "price", "currency"], 
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+    },
+    "type": {
+      "type": "string" 
+    },
+    "name": {
+      "type": "string"
+    },
+    "description": {
+      "string": "string"
+    },
+    "price": {
+      "type": "number"
+    },
+    "currency": { 
+      "type": "string",
+      "description": "ISO 4217 format",
+      "minLength": 3,
+      "maxLength": 3
+    },
+    "image": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/file"
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/systemData"
+    }
+  }
+}