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

package/commands/DiscoverUsersCommand.js

@@ -0,0 +1,21 @@
+const Command = require("./Command");
+
+class SetAlarmCommand extends Command {
+  constructor({ id }) {
+    super({ id });
+  }
+
+  get name() {
+    return "DiscoverUsers";
+  }
+
+  get routingKey() {
+    return `users.${this.data.id}.get`;
+  }
+
+  get replyTo() {
+    return "system.response.users";
+  }
+}
+
+module.exports = SetAlarmCommand;

package/commands/index.js

@@ -6,6 +6,9 @@ const SetLockCommand = require("./SetLockCommand");
 const SetSceneControllerCommand = require("./SetSceneControllerCommand");
 const SetWindowCoveringCommand = require("./SetWindowCoveringCommand");
 const SetCourtesyCommand = require("./SetCourtesyCommand");
+
+const DiscoverUsersCommand = require("./DiscoverUsersCommand");
+
 const VerifyDocumentCommand = require("./VerifyDocumentCommand");
 
 module.exports = {
@@ -18,4 +21,5 @@ module.exports = {
   SetWindowCoveringCommand,
   SetCourtesyCommand,
   VerifyDocumentCommand,
+  DiscoverUsersCommand,
 };

package/http/handleResponseSuccess.js

@@ -4,11 +4,11 @@ module.exports = function handleResponseSuccess(response) {
     response.pagination = response.data.pagination;
     response.data = response.data.data;
   }
-  if (response.headers[this.authTokenHeaderKey]) {
+  if (!this.isBrowser && response.headers[this.authTokenHeaderKey]) {
     this.authToken = response.headers[this.authTokenHeaderKey];
   }
 
-  if (response.headers[this.refreshTokenHeaderKey]) {
+  if (!this.isBrowser && response.headers[this.refreshTokenHeaderKey]) {
     this.refreshToken = response.headers[this.refreshTokenHeaderKey];
   }
   return response;

package/http/index.js

@@ -1,5 +1,4 @@
 const { EventEmitter } = require("events");
-const axios = require("axios");
 const defs = require("../defs").http;
 const handleResponseError = require("./handleResponseError");
 const handleResponseSuccess = require("./handleResponseSuccess");
@@ -30,13 +29,21 @@ function useCaseMethodFactory(Client) {
       */
 
       //eslint-disable-next-line no-inner-declarations
-      function UseCase(options) {
-        if (!options) options = {};
+      function UseCase(requestData, options = {}) {
+        if (!this._init) {
+          // wait a second for the client to initialize
+          return new Promise((resolve) => {
+            setTimeout(() => {
+              resolve(UseCase.call(this, requestData));
+            }, 500);
+          });
+        }
+        if (!requestData) requestData = {};
 
         // get parameters from path
         const pathParams = path.match(/:[a-zA-Z0-9]+/g);
 
-        const { data, params, query, headers } = options;
+        const { data, params, query, headers } = requestData;
 
         // replace path parameters with values from params
         let url = path;
@@ -60,6 +67,7 @@ function useCaseMethodFactory(Client) {
         const config = {
           method: method.toLowerCase(),
           url: url,
+          ...options,
         };
 
         if (data) config.data = data;
@@ -94,26 +102,35 @@ class KohostApiClient extends EventEmitter {
     if (!options.tenantId) throw new Error("options.tenant is required");
     this.options = options;
     // eslint-disable-next-line no-undef
-    this.isBrower = typeof window !== "undefined";
-    this._http = axios.create({
-      baseURL: options.url,
-      responseType: "json",
-      headers: {
-        "Content-Type": "application/json",
-        Accept: "application/json",
-        [defs.tenantHeader]: options.tenantId,
-        ...options.headers,
-      },
-    });
-
-    this._http.interceptors.response.use(
-      handleResponseSuccess.bind(this),
-      handleResponseError.bind(this)
-    );
-
-    this._http.interceptors.request.use((config) => {
-      config.headers[defs.authTokenHeader] = this.authToken;
-      return config;
+    this.isBrowser = typeof window !== "undefined";
+    this._init = false;
+
+    import("axios").then((axiosModule) => {
+      const axios = axiosModule.default;
+      this._http = axios.create({
+        baseURL: options.url,
+        responseType: "json",
+        withCredentials: true,
+        headers: {
+          "Content-Type": "application/json",
+          Accept: "application/json",
+          [defs.tenantHeader]: options.tenantId,
+          ...options.headers,
+        },
+      });
+
+      this._http.interceptors.response.use(
+        handleResponseSuccess.bind(this),
+        handleResponseError.bind(this)
+      );
+
+      this._http.interceptors.request.use((config) => {
+        if (!this.isBrowser) {
+          config.headers[defs.authTokenHeader] = this.authToken;
+        }
+        return config;
+      });
+      this._init = true;
     });
   }
 
@@ -130,13 +147,7 @@ class KohostApiClient extends EventEmitter {
   }
 
   get authToken() {
-    if (this.isBrower) {
-      // get token from localStorage
-      // eslint-disable-next-line no-undef
-      return window.localStorage.getItem(this.lsTokenKey);
-    } else {
-      return this._authToken;
-    }
+    return this._authToken;
   }
 
   /* 
@@ -145,12 +156,7 @@ class KohostApiClient extends EventEmitter {
   */
 
   set authToken(token) {
-    if (this.isBrower) {
-      // eslint-disable-next-line no-undef
-      window.localStorage.setItem(this.lsTokenKey, token);
-    } else {
-      this._authToken = token;
-    }
+    this._authToken = token;
   }
 }
 

package/index.js

@@ -15,8 +15,8 @@ const Kohost = {
   defs,
   Client: HttpClient,
   utils: {
-    getFormalDeviceType,
-    getDeviceTypes,
+    getFormalDeviceType: getFormalDeviceType,
+    getDeviceTypes: getDeviceTypes,
   },
 };
 

package/package.json

@@ -1,17 +1,9 @@
 {
-  "dependencies": {
-    "ajv": "^8.11.0",
-    "ajv-formats": "^2.1.1",
-    "axios": "^1.0.0",
-    "lodash.clonedeep": "^4.5.0",
-    "lodash.findlast": "^4.6.0",
-    "lodash.sortby": "^4.7.0",
-    "nanoid": "^3.3.4"
-  },
   "name": "@kohost/api-client",
-  "version": "1.0.0-alpha.3",
+  "version": "1.0.0-alpha.4",
   "description": "API client for Kohost utils",
   "main": "index.js",
+  "module": "index.js",
   "scripts": {
     "test": "jest",
     "test:watch": "jest --watchAll",
@@ -30,6 +22,15 @@
     "lint-staged": "^13.0.3",
     "prettier": "^2.5.1"
   },
+  "dependencies": {
+    "ajv": "^8.11.0",
+    "ajv-formats": "^2.1.1",
+    "axios": "^1.0.0",
+    "lodash.clonedeep": "^4.5.0",
+    "lodash.findlast": "^4.6.0",
+    "lodash.sortby": "^4.7.0",
+    "nanoid": "^3.3.4"
+  },
   "lint-staged": {
     "*.js": "eslint --cache --fix",
     "*.{js,css,md,json}": "prettier --write"

package/schemas/admin/property.json

@@ -45,6 +45,126 @@
     "longitude": {
       "type": "number"
     },
+    "appManifest": {
+      "type": "object",
+
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "short_name": {
+          "type": "string"
+        },
+        "scope": {
+          "type": "string"
+        },
+        "start_url": {
+          "type": "string"
+        },
+        "themeColor": {
+          "type": "string"
+        },
+        "backgroundColor": {
+          "type": "string"
+        },
+        "display": {
+          "type": "string",
+          "enum": ["fullscreen", "standalone", "minimal-ui", "browser"],
+          "default": "fullscreen"
+        },
+        "orientation": {
+          "type": "string",
+          "enum": ["portrait", "landscape"],
+          "default": "portrait"
+        },
+        "splash": {
+          "type": "object",
+          "properties": {
+            "src": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string"
+            },
+            "sizes": {
+              "type": "string"
+            }
+          }
+        },
+        "icons": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "src": {
+                "type": "string"
+              },
+              "sizes": {
+                "type": "string"
+              },
+              "type": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "logo": {
+          "type": "object",
+          "properties": {
+            "src": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string"
+            },
+            "sizes": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "default": {
+        "name": "Kohost",
+        "short_name": "Kohost",
+        "start_url": "/",
+        "scope": "/",
+        "display": "fullscreen",
+        "orientation": "portrait",
+        "theme_color": "#1d1f22",
+        "background_color": "#1d1f22",
+        "icons": [
+          {
+            "src": "https://cdn.kohost.app/defaultIcon.png",
+            "sizes": "512x512",
+            "type": "image/png"
+          }
+        ],
+        "splash": {
+          "src": "https://cdn.kohost.app/defaultSplash.jpg",
+          "sizes": "1500x800",
+          "type": "image/jpg"
+        },
+        "logo": {
+          "src": "https://cdn.kohost.app/defaultLogo.png",
+          "sizes": "300x75",
+          "type": "image/png"
+        }
+      }
+    },
+    "appFeatures": {
+      "type": "object",
+      "properties": {
+        "RoomControl": {},
+        "CheckIn": {},
+        "CheckOut": {},
+        "Concierge": {},
+        "Elevator": {}
+      },
+      "additionalProperties": false,
+      "default": {
+        "RoomControl": {}
+      }
+    },
     "credentials": {
       "type": "object",
       "additionalProperties": true

package/schemas/reservation.json

@@ -31,12 +31,12 @@
       "type": "string"
     },
     "checkInDateTime": {
-      "type": "string",
+      "type": ["string", "object"],
       "format": "date-time"
     },
     "checkOutDateTime": {
-      "type": "string",
-      "format": "date-time" 
+      "type": ["string", "object"],
+      "format": "date-time"
     },
     "adultCount": {
       "type": "number",

package/schemas/user.json

@@ -13,7 +13,7 @@
       "default": "user"
     },
     "active": {
-      "type": "boolean", 
+      "type": "boolean",
       "default": true
     },
     "firstName": {
@@ -23,11 +23,11 @@
       "type": "string"
     },
     "phone": {
-      "type": "string",
-      "pattern": "^\\+?[0-9]{1,14}$"  
+      "type": ["string", "null"],
+      "pattern": "^\\+?[0-9]{1,14}$"
     },
     "email": {
-      "type": "string",
+      "type": ["string", "null"],
       "format": "email"
     },
     "hashedPassword": {
@@ -62,20 +62,20 @@
       }
     },
     "identifications": {
-      "type":"array",
+      "type": "array",
       "items": {
         "$ref": "https://api.kohost.app/schemas/v3/identification.json"
       }
-    },    
+    },
     "payments": {
-      "type":"array",
+      "type": "array",
       "items": {
         "$ref": "https://api.kohost.app/schemas/v3/payment.json"
       }
     },
     "preferences": {
       "type": "object",
-      "additionalProperties": false, 
+      "additionalProperties": false,
       "properties": {
         "notifications": {
           "type": "array",
@@ -110,7 +110,7 @@
           "type": ["number", "null"]
         }
       }
-    },   
+    },
     "createdAt": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/createdAt"
     },

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();
+});

package/useCases/http.json

@@ -156,56 +156,56 @@
     }
   ],
   [
-    "ListGroups",
+    "ListSpaces",
     {
       "http": {
         "method": "GET",
-        "path": "/groups"
+        "path": "/spaces"
       }
     }
   ],
   [
-    "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 +299,15 @@
       }
     }
   ],
+  [
+    "SetLocks",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/rooms/:roomId/locks/:id"
+      }
+    }
+  ],
   [
     "CreateCamera",
     {
@@ -344,6 +353,15 @@
       }
     }
   ],
+  [
+    "SetCameras",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/rooms/:roomId/cameras/:id"
+      }
+    }
+  ],
   [
     "CreateCourtesy",
     {
@@ -389,6 +407,15 @@
       }
     }
   ],
+  [
+    "SetCourtesy",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/rooms/:roomId/courtesy/:id"
+      }
+    }
+  ],
   [
     "CreateDimmer",
     {
@@ -524,6 +551,15 @@
       }
     }
   ],
+  [
+    "SetSwitches",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/rooms/:roomId/switches/:id"
+      }
+    }
+  ],
   [
     "CreateSceneController",
     {
@@ -569,6 +605,15 @@
       }
     }
   ],
+  [
+    "SetSceneControllers",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/rooms/:roomId/sceneControllers/:id"
+      }
+    }
+  ],
   [
     "CreateSource",
     {
@@ -614,6 +659,15 @@
       }
     }
   ],
+  [
+    "SetSources",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/rooms/:roomId/sources/:id"
+      }
+    }
+  ],
   [
     "CreateThermostat",
     {
@@ -659,6 +713,15 @@
       }
     }
   ],
+  [
+    "SetThermostats",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/rooms/:roomId/thermostats/:id"
+      }
+    }
+  ],
   [
     "CreateWindowCovering",
     {
@@ -704,6 +767,15 @@
       }
     }
   ],
+  [
+    "SetWindowCoverings",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/rooms/:roomId/windowCoverings/:id"
+      }
+    }
+  ],
   [
     "AddScenesToRoom",
     {
@@ -804,7 +876,7 @@
     }
   ],
   [
-    "ScheduleGroupEcoScenes",
+    "ScheduleSpaceEcoScenes",
     {
       "http": false
     }
@@ -898,5 +970,129 @@
         "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
+    }
+  ],
+  [
+    "UpsertSystemReservation",
+    {
+      "http": false
+    }
+  ],
+  [
+    "UpsertSystemSpace",
+    {
+      "http": false
+    }
+  ],
+  [
+    "UpsertSystemUser",
+    {
+      "http": false
+    }
+  ],
+  [
+    "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"
+      }
+    }
+  ],
+  [
+    "VerifyDocument",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/documents/verify",
+        "maxSize": "2mb"
+      }
+    }
+  ],
+  [
+    "DescribeMyProperty",
+    {
+      "http": {
+        "method": "GET",
+        "path": "/properties/mine"
+      }
+    }
   ]
 ]

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,
+    // },
+  },
+});