@kohost/api-client 1.0.0-alpha.3 → 1.0.0-beta.0

package/useCases/http.json

@@ -17,6 +17,33 @@
       }
     }
   ],
+  [
+    "AdminUpdateProperty",
+    {
+      "http": {
+        "method": "PUT",
+        "path": "/admin/properties/:id"
+      }
+    }
+  ],
+  [
+    "AdminDescribeProperty",
+    {
+      "http": {
+        "method": "GET",
+        "path": "/admin/properties/:id"
+      }
+    }
+  ],
+  [
+    "AdminCreateProperty",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/admin/properties"
+      }
+    }
+  ],
   [
     "LoginUser",
     {
@@ -47,6 +74,16 @@
       }
     }
   ],
+  [
+    "RequestLoginLink",
+    {
+      "http": {
+        "disableAuth": true,
+        "method": "POST",
+        "path": "/auth/loginToken"
+      }
+    }
+  ],
   [
     "DescribeSelf",
     {
@@ -84,128 +121,129 @@
     }
   ],
   [
-    "UpdateUser",
+    "UpdateSelf",
     {
       "http": {
         "method": "PUT",
-        "path": "/users/:id"
+        "path": "/users/me"
       }
     }
   ],
   [
-    "DeleteUser",
+    "UpdateUser",
     {
       "http": {
-        "method": "DELETE",
+        "method": "PUT",
         "path": "/users/:id"
       }
     }
   ],
   [
-    "DescribeGateway",
+    "DeleteUser",
     {
       "http": {
-        "method": "GET",
-        "path": "/gateways/:gatewayId"
+        "method": "DELETE",
+        "path": "/users/:id"
       }
     }
   ],
   [
-    "ListGateways",
+    "SendVerificationCode",
     {
       "http": {
-        "method": "GET",
-        "path": "/gateways"
+        "method": "POST",
+        "path": "/users/:id/sendVerificationCode"
       }
     }
   ],
   [
-    "CreateGateway",
+    "CheckVerificationCode",
     {
       "http": {
         "method": "POST",
-        "path": "/gateways"
+        "path": "/users/:id/checkVerificationCode"
       }
     }
   ],
   [
-    "UpdateGateway",
+    "MatchUserIdentification",
     {
       "http": {
-        "method": "PUT",
-        "path": "/gateways/:gatewayId"
+        "method": "POST",
+        "path": "/users/:id/identifications/match",
+        "maxSize": "2mb"
       }
     }
   ],
   [
-    "DeleteGateway",
+    "ListSpaces",
     {
       "http": {
-        "method": "DELETE",
-        "path": "/gateways/:gatewayId"
+        "method": "GET",
+        "path": "/spaces"
       }
     }
   ],
   [
-    "EmailUserAccountSetup",
+    "ListMySpaces",
     {
       "http": {
-        "method": "POST",
-        "path": "/users/:id/email/setup"
+        "method": "GET",
+        "path": "/spaces/mine"
       }
     }
   ],
   [
-    "ListGroups",
+    "ListRoomsInSpace",
     {
       "http": {
         "method": "GET",
-        "path": "/groups"
+        "path": "/spaces/:id/rooms"
       }
     }
   ],
   [
-    "CreateGroup",
+    "CreateSpace",
     {
       "http": {
         "method": "POST",
-        "path": "/groups"
+        "path": "/spaces"
       }
     }
   ],
   [
-    "DescribeGroup",
+    "DescribeSpace",
     {
       "http": {
         "method": "GET",
-        "path": "/groups/:id"
+        "path": "/spaces/:id"
       }
     }
   ],
   [
-    "DeleteGroup",
+    "DeleteSpace",
     {
       "http": {
         "method": "DELETE",
-        "path": "/groups/:id"
+        "path": "/spaces/:id"
       }
     }
   ],
   [
-    "UpdateGroup",
+    "UpdateSpace",
     {
       "http": {
         "method": "PUT",
-        "path": "/groups/:id"
+        "path": "/spaces/:id"
       }
     }
   ],
   [
-    "CreateRoomInGroup",
+    "CreateRoomInSpace",
     {
       "http": {
         "method": "POST",
-        "path": "/groups/:groupId/rooms"
+        "path": "/spaces/:id/rooms"
       }
     }
   ],
@@ -299,6 +337,15 @@
       }
     }
   ],
+  [
+    "SetLock",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/rooms/:roomId/locks/:id"
+      }
+    }
+  ],
   [
     "CreateCamera",
     {
@@ -344,6 +391,15 @@
       }
     }
   ],
+  [
+    "SetCamera",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/rooms/:roomId/cameras/:id"
+      }
+    }
+  ],
   [
     "CreateCourtesy",
     {
@@ -389,6 +445,15 @@
       }
     }
   ],
+  [
+    "SetCourtesy",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/rooms/:roomId/courtesy/:id"
+      }
+    }
+  ],
   [
     "CreateDimmer",
     {
@@ -524,6 +589,15 @@
       }
     }
   ],
+  [
+    "SetSwitch",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/rooms/:roomId/switches/:id"
+      }
+    }
+  ],
   [
     "CreateSceneController",
     {
@@ -569,6 +643,15 @@
       }
     }
   ],
+  [
+    "SetSceneController",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/rooms/:roomId/sceneControllers/:id"
+      }
+    }
+  ],
   [
     "CreateSource",
     {
@@ -614,6 +697,15 @@
       }
     }
   ],
+  [
+    "SetSource",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/rooms/:roomId/sources/:id"
+      }
+    }
+  ],
   [
     "CreateThermostat",
     {
@@ -659,6 +751,15 @@
       }
     }
   ],
+  [
+    "SetThermostat",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/rooms/:roomId/thermostats/:id"
+      }
+    }
+  ],
   [
     "CreateWindowCovering",
     {
@@ -704,12 +805,21 @@
       }
     }
   ],
+  [
+    "SetWindowCovering",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/rooms/:roomId/windowCoverings/:id"
+      }
+    }
+  ],
   [
     "AddScenesToRoom",
     {
       "http": {
         "method": "POST",
-        "path": "/rooms/:roomId/scenes"
+        "path": "/rooms/:id/scenes"
       }
     }
   ],
@@ -736,7 +846,7 @@
     {
       "http": {
         "method": "POST",
-        "path": "/tickets/:ticketId/messages"
+        "path": "/tickets/:id/messages"
       }
     }
   ],
@@ -745,7 +855,7 @@
     {
       "http": {
         "method": "DELETE",
-        "path": "/tickets/:ticketId"
+        "path": "/tickets/:id"
       }
     }
   ],
@@ -754,7 +864,7 @@
     {
       "http": {
         "method": "GET",
-        "path": "/tickets/:ticketId"
+        "path": "/tickets/:id"
       }
     }
   ],
@@ -772,7 +882,7 @@
     {
       "http": {
         "method": "POST",
-        "path": "/tickets/:ticketId/readAll"
+        "path": "/tickets/:id/readAll"
       }
     }
   ],
@@ -781,7 +891,7 @@
     {
       "http": {
         "method": "PUT",
-        "path": "/tickets/:ticketId"
+        "path": "/tickets/:id"
       }
     }
   ],
@@ -790,7 +900,7 @@
     {
       "http": {
         "method": "PUT",
-        "path": "/tickets/:ticketId/status"
+        "path": "/tickets/:id/status"
       }
     }
   ],
@@ -804,7 +914,7 @@
     }
   ],
   [
-    "ScheduleGroupEcoScenes",
+    "ScheduleSpaceEcoScenes",
     {
       "http": false
     }
@@ -898,5 +1008,199 @@
         "path": "/integrations/:id/deviceMap"
       }
     }
+  ],
+  [
+    "DescribeIntegration",
+    {
+      "http": {
+        "method": "GET",
+        "path": "/integrations/:id"
+      }
+    }
+  ],
+  [
+    "DeleteIntegration",
+    {
+      "http": {
+        "method": "GET",
+        "path": "/integrations/:id"
+      }
+    }
+  ],
+  [
+    "ListIntegrations",
+    {
+      "http": {
+        "method": "GET",
+        "path": "/integrations/"
+      }
+    }
+  ],
+  [
+    "UpsertSystemDevice",
+    {
+      "http": false
+    }
+  ],
+  [
+    "UpsertSystemSpace",
+    {
+      "http": false
+    }
+  ],
+  [
+    "UpsertSystemUser",
+    {
+      "http": false
+    }
+  ],
+  [
+    "DiscoverReservations",
+    {
+      "http": {
+        "method": "GET",
+        "path": "/reservations/discover"
+      }
+    }
+  ],
+  [
+    "CreateReservation",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/reservations"
+      }
+    }
+  ],
+  [
+    "DeleteReservation",
+    {
+      "http": {
+        "method": "DELETE",
+        "path": "/reservations/:id"
+      }
+    }
+  ],
+  [
+    "ListReservations",
+    {
+      "http": {
+        "method": "GET",
+        "path": "/reservations"
+      }
+    }
+  ],
+  [
+    "ListMyReservations",
+    {
+      "http": {
+        "method": "GET",
+        "path": "/reservations/mine"
+      }
+    }
+  ],
+  [
+    "UpdateReservation",
+    {
+      "http": {
+        "method": "PUT",
+        "path": "/reservations/:id"
+      }
+    }
+  ],
+  [
+    "DescribeReservation",
+    {
+      "http": {
+        "method": "GET",
+        "path": "/reservations/:id"
+      }
+    }
+  ],
+  [
+    "DescribeReservationCheckinStatus",
+    {
+      "http": {
+        "method": "GET",
+        "path": "/reservations/:id/checkinStatus"
+      }
+    }
+  ],
+  [
+    "CheckInReservation",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/reservations/:id/checkin"
+      }
+    }
+  ],
+  [
+    "SendPreArrivalSMS",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/reservations/:id/sendPreArrivalSMS"
+      }
+    }
+  ],
+  [
+    "SendPreArrivalEmail",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/reservations/:id/sendPreArrivalEmail"
+      }
+    }
+  ],
+  [
+    "BatchNotifyPreArrival",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/reservations/batchNotifyPreArrival"
+      }
+    }
+  ],
+  [
+    "UpsertSystemReservation",
+    {
+      "http": false
+    }
+  ],
+  [
+    "OCRDocument",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/documents/ocr",
+        "maxSize": "2mb"
+      }
+    }
+  ],
+  [
+    "DescribeMyProperty",
+    {
+      "http": {
+        "method": "GET",
+        "path": "/properties/mine",
+        "disableAuth": true
+      }
+    }
+  ],
+  [
+    "EmailUserAccountSetup",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/users/:id/email/setup"
+      }
+    }
+  ],
+  [
+    "LogEvent",
+    {
+      "http": false
+    }
   ]
 ]

package/utils/schema.js

@@ -16,13 +16,13 @@ addFormats(ajv);
 
 ajv.addSchema(commonDefs);
 
-ajv.addSchema(deviceDefs);
+ajv.addSchema(deviceDefs); 
 
 module.exports = {
   add: function add(schema) {
     ajv.addSchema(schema);
   },
-  compile: function compile(schema) { 
+  compile: function compile(schema) {  
     return ajv.compile(schema);
   },
 };

package/vite.config.js

@@ -0,0 +1,22 @@
+/** @type {import('vite').UserConfig} */
+
+import { resolve } from "path";
+import { defineConfig } from "vite";
+
+export default defineConfig({
+  build: {
+    lib: {
+      // Could also be a dictionary or array of multiple entry points
+      entry: resolve(__dirname, "index.js"),
+      name: "Kohost",
+      // the proper extensions will be added
+      fileName: "kohost",
+    },
+    // commonjsOptions: {
+    //   include: "**/*.js",
+    //   transformMixedEsModules: true,
+    //   esmExternals: true,
+    //   requireReturnsDefault: false,
+    // },
+  },
+});

package/models/iotGateway.js

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

package/models/sceneController.js

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