@kohost/api-client 1.0.0-beta.3 → 1.0.0-beta.5

package/dist/useCases/UpdateTicketStatus.js

@@ -0,0 +1,32 @@
+module.exports = function UpdateTicketStatus(requestData, options = {}) {
+  if (!requestData)
+    requestData = {};
+  const pathParams = [":id"];
+  const { data, query, headers } = requestData;
+  let url = "/tickets/:id/status";
+  if (pathParams && data) {
+    for (const param of pathParams) {
+      const paramName = param.replace(":", "");
+      url = url.replace(param, data[paramName]);
+    }
+  }
+  if (url.match(/:[a-zA-Z0-9]+/g)) {
+    const missingParams = url.match(/:[a-zA-Z0-9]+/g);
+    const missing = missingParams.map((param) => param.replace(":", ""));
+    return Promise.reject(
+      new Error("Missing parameters: " + missing.join(", "))
+    );
+  }
+  const config = {
+    method: "put",
+    url,
+    ...options
+  };
+  if (data)
+    config.data = data;
+  if (query)
+    config.params = query;
+  if (headers)
+    config.headers = headers;
+  return this._http.request(config);
+};

package/dist/useCases/UpdateUser.js

@@ -0,0 +1,32 @@
+module.exports = function UpdateUser(requestData, options = {}) {
+  if (!requestData)
+    requestData = {};
+  const pathParams = [":id"];
+  const { data, query, headers } = requestData;
+  let url = "/users/:id";
+  if (pathParams && data) {
+    for (const param of pathParams) {
+      const paramName = param.replace(":", "");
+      url = url.replace(param, data[paramName]);
+    }
+  }
+  if (url.match(/:[a-zA-Z0-9]+/g)) {
+    const missingParams = url.match(/:[a-zA-Z0-9]+/g);
+    const missing = missingParams.map((param) => param.replace(":", ""));
+    return Promise.reject(
+      new Error("Missing parameters: " + missing.join(", "))
+    );
+  }
+  const config = {
+    method: "put",
+    url,
+    ...options
+  };
+  if (data)
+    config.data = data;
+  if (query)
+    config.params = query;
+  if (headers)
+    config.headers = headers;
+  return this._http.request(config);
+};

package/dist/useCases/UpdateWindowCovering.js

@@ -0,0 +1,32 @@
+module.exports = function UpdateWindowCovering(requestData, options = {}) {
+  if (!requestData)
+    requestData = {};
+  const pathParams = [":roomId", ":id"];
+  const { data, query, headers } = requestData;
+  let url = "/rooms/:roomId/windowCoverings/:id";
+  if (pathParams && data) {
+    for (const param of pathParams) {
+      const paramName = param.replace(":", "");
+      url = url.replace(param, data[paramName]);
+    }
+  }
+  if (url.match(/:[a-zA-Z0-9]+/g)) {
+    const missingParams = url.match(/:[a-zA-Z0-9]+/g);
+    const missing = missingParams.map((param) => param.replace(":", ""));
+    return Promise.reject(
+      new Error("Missing parameters: " + missing.join(", "))
+    );
+  }
+  const config = {
+    method: "put",
+    url,
+    ...options
+  };
+  if (data)
+    config.data = data;
+  if (query)
+    config.params = query;
+  if (headers)
+    config.headers = headers;
+  return this._http.request(config);
+};

package/dist/useCases/UpsertDiscoveredDevice.js

@@ -0,0 +1,32 @@
+module.exports = function UpsertDiscoveredDevice(requestData, options = {}) {
+  if (!requestData)
+    requestData = {};
+  const pathParams = null;
+  const { data, query, headers } = requestData;
+  let url = "/discoveredDevices/upsert";
+  if (pathParams && data) {
+    for (const param of pathParams) {
+      const paramName = param.replace(":", "");
+      url = url.replace(param, data[paramName]);
+    }
+  }
+  if (url.match(/:[a-zA-Z0-9]+/g)) {
+    const missingParams = url.match(/:[a-zA-Z0-9]+/g);
+    const missing = missingParams.map((param) => param.replace(":", ""));
+    return Promise.reject(
+      new Error("Missing parameters: " + missing.join(", "))
+    );
+  }
+  const config = {
+    method: "post",
+    url,
+    ...options
+  };
+  if (data)
+    config.data = data;
+  if (query)
+    config.params = query;
+  if (headers)
+    config.headers = headers;
+  return this._http.request(config);
+};

package/package.json

@@ -1,20 +1,35 @@
 {
   "name": "@kohost/api-client",
-  "version": "1.0.0-beta.3",
-  "description": "API client for Kohost utils",
-  "main": "index.js",
-  "module": "index.js",
+  "version": "1.0.0-beta.5",
+  "description": "API client, models, schemas, commands, and events for Kohost applications",
+  "author": "Ian Rogers",
+  "main": "dist/cjs/index.cjs.js",
+  "module": "dist/esm/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.cjs.js"
+    },
+    "./*": {
+      "import": "./dist/esm/*.js",
+      "require": "./dist/cjs/*.js"
+    }
+  },
   "scripts": {
     "test": "jest",
     "test:watch": "jest --watchAll",
     "lint": "eslint ./",
     "lint:fix": "eslint --fix ./",
-    "prepare": "node prepare.js"
+    "prepare": "node prepare.js",
+    "build": "node scripts/build.js",
+    "clean": "rm -rf ./dist"
   },
-  "author": "Ian Rogers",
-  "license": "ISC",
+  "files": [
+    "dist"
+  ],
   "devDependencies": {
     "@kohost/eslint-config": "^1.0.0",
+    "esbuild": "^0.17.2",
     "eslint": "^8.6.0",
     "eslint-plugin-jest": "^27.1.3",
     "husky": "^8.0.1",
@@ -26,11 +41,15 @@
     "ajv": "^8.11.0",
     "ajv-formats": "^2.1.1",
     "axios": "^1.0.0",
+    "events": "^3.3.0",
     "lodash.clonedeep": "^4.5.0",
     "lodash.findlast": "^4.6.0",
     "lodash.sortby": "^4.7.0",
     "nanoid": "^3.3.4"
   },
+  "browser": {
+    "events": "events"
+  },
   "lint-staged": {
     "*.js": "eslint --cache --fix",
     "*.{js,css,md,json}": "prettier --write"

package/.eslintrc.js

@@ -1,10 +0,0 @@
-module.exports = {
-  env: {
-    "jest/globals": true,
-  },
-  plugins: ["jest"],
-  extends: ["@kohost"],
-  parserOptions: {
-    ecmaVersion: 2020,
-  },
-};

package/bitbucket-pipelines.yml

@@ -1,71 +0,0 @@
-image: node:16.17.1
-
-definitions:
-  install-aws-cli: &install-aws-cli |
-    curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
-    unzip awscliv2.zip
-    ./aws/install
-
-pipelines:
-  custom:
-    publish-use-cases:
-      - variables:
-          - name: USE_CASE_HASH
-      - step:
-          image: atlassian/default-image:3
-          name: Fetch use cases
-          script:
-            - *install-aws-cli
-            ## fetch use cases from s3
-            - aws s3 cp s3://cloud-v3-data/useCases/useCases-${USE_CASE_HASH}.json ./useCases/http.json
-            ## commit the result
-            - git commit -am "Update use cases"
-            - git push
-
-  pull-requests:
-    "**":
-      - step:
-          name: Install dependencies and build
-          caches:
-            - node
-          script:
-            - npm ci
-            - npm rum lint
-  branches:
-    master:
-      - step:
-          name: Build and publish to NPM
-          caches:
-            - node
-          script:
-            - npm ci
-            - pipe: atlassian/npm-publish:0.3.2
-              variables:
-                NPM_TOKEN: $NPM_TOKEN
-    dev:
-      - step:
-          name: Build and publish to NPM
-          caches:
-            - node
-          script:
-            - npm ci
-            - npm version prerelease --preid=beta -m "Upgrade to %s [skip ci]"
-            - git push && git push --tags
-            - pipe: atlassian/npm-publish:0.3.2
-              variables:
-                NPM_TOKEN: $NPM_TOKEN
-                EXTRA_ARGS: --tag next
-
-    v1:
-      - step:
-          name: Build and publish to NPM
-          caches:
-            - node
-          script:
-            - npm ci
-            - npm version prerelease --preid=beta -m "Upgrade to %s [skip ci]"
-            - git push && git push --tags
-            - pipe: atlassian/npm-publish:0.3.2
-              variables:
-                NPM_TOKEN: $NPM_TOKEN
-                EXTRA_ARGS: --tag next-v1

package/commands/CheckInReservationCommand.js

@@ -1,23 +0,0 @@
-const Command = require("./Command");
-const RequestError = require("../errors/RequestError");
-
-class CheckInReservationCommand extends Command {
-  constructor({ id }) {
-    if (!id) throw new RequestError("document type is required");
-    super({ id });
-  }
-
-  get name() {
-    return "CheckInReservation";
-  }
-
-  get routingKey() {
-    return `reservation.${this.data.id}.checkin`;
-  }
-
-  get replyTo() {
-    return "system.response.reservations";
-  }
-}
-
-module.exports = CheckInReservationCommand;

package/commands/Command.js

@@ -1,38 +0,0 @@
-class Command {
-  constructor(data) {
-    this.data = {};
-    if (!data) throw new Error("Command data is required");
-    if (typeof data !== "object")
-      throw new Error("Command data must be an object");
-
-    for (const key in data) {
-      this.data[key] = data[key];
-    }
-  }
-
-  get name() {
-    throw new Error("Command name is required");
-  }
-
-  get type() {
-    return "Command";
-  }
-
-  get routingKey() {
-    return "";
-  }
-
-  get exchange() {
-    return "Commands";
-  }
-
-  get replyTo() {
-    return "amq.rabbitmq.reply-to";
-  }
-
-  build() {
-    return { data: { ...this.data } };
-  }
-}
-
-module.exports = Command;

package/commands/DiscoverReservationsCommand.js

@@ -1,24 +0,0 @@
-const { RequestError } = require("../errors");
-const Command = require("./Command");
-
-class DiscoverReservationsCommand extends Command {
-  constructor(options) {
-    if (!options) throw new RequestError("options are required");
-    const { id, startDate, endDate, status } = options;
-    super({ id, startDate, endDate, status });
-  }
-
-  get name() {
-    return "DiscoverReservations";
-  }
-
-  get routingKey() {
-    return "reservation.discover";
-  }
-
-  get replyTo() {
-    return "system.response.reservations";
-  }
-}
-
-module.exports = DiscoverReservationsCommand;

package/commands/DiscoverRoomsCommand.js

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

package/commands/DiscoverUsersCommand.js

@@ -1,21 +0,0 @@
-const Command = require("./Command");
-
-class DiscoverUsersCommand 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 = DiscoverUsersCommand;

package/commands/OCRDocumentCommand.js

@@ -1,20 +0,0 @@
-const Command = require("./Command");
-const RequestError = require("../errors/RequestError");
-
-class OCRDocumentCommand extends Command {
-  constructor({ type, image }) {
-    if (!type) throw new RequestError("document type is required");
-    if (!image) throw new RequestError("document image is required");
-    super({ type, image });
-  }
-
-  get name() {
-    return "OCRDocument";
-  }
-
-  get routingKey() {
-    return `document.${this.data.type}.ocr`;
-  }
-}
-
-module.exports = OCRDocumentCommand;

package/commands/SendEmailCommand.js

@@ -1,24 +0,0 @@
-const Command = require("./Command");
-const RequestError = require("../errors/RequestError");
-
-class SendEmailCommand extends Command {
-  constructor({ text, html, to, from, subject, eventData }) {
-    if (!to) throw new RequestError("email to is required");
-    if (!from) throw new RequestError("email from is required");
-    if (!subject) throw new RequestError("email subject is required");
-    if (!text && !html)
-      throw new RequestError("email text or html is required");
-
-    super({ text, html, to, from, subject, eventData });
-  }
-
-  get name() {
-    return "SendEmail";
-  }
-
-  get routingKey() {
-    return "comm.email.send";
-  }
-}
-
-module.exports = SendEmailCommand;

package/commands/SendSMSCommand.js

@@ -1,21 +0,0 @@
-const Command = require("./Command");
-const RequestError = require("../errors/RequestError");
-
-class SendSMSCommand extends Command {
-  constructor({ body, to, from, metaData }) {
-    if (!body) throw new RequestError("sms body is required");
-    if (!to) throw new RequestError("sms to is required");
-    if (!from) throw new RequestError("sms from is required");
-    super({ body, to, from, metaData });
-  }
-
-  get name() {
-    return "SendSMS";
-  }
-
-  get routingKey() {
-    return "comm.sms.send";
-  }
-}
-
-module.exports = SendSMSCommand;

package/commands/SetAlarmCommand.js

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

package/commands/SetCourtesyCommand.js

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

package/commands/SetDimmerCommand.js

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

package/commands/SetLockCommand.js

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

package/commands/SetSceneControllerCommand.js

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

package/commands/SetSwitchCommand.js

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

package/commands/SetThermostatCommand.js

@@ -1,21 +0,0 @@
-const Command = require("./Command");
-
-class SetThermostatCommand extends Command {
-  constructor({ id, setpoints, hvacMode, fanMode }) {
-    super({ id, setpoints, hvacMode, fanMode });
-  }
-
-  get name() {
-    return "SetThermostat";
-  }
-
-  get routingKey() {
-    return `thermostat.${this.data.id}.set`;
-  }
-
-  get replyTo() {
-    return "system.response.devices";
-  }
-}
-
-module.exports = SetThermostatCommand;

package/commands/SetWindowCoveringCommand.js

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

package/commands/index.js

@@ -1,31 +0,0 @@
-const SetAlarmCommand = require("./SetAlarmCommand");
-const SetDimmerCommand = require("./SetDimmerCommand");
-const SetSwitchCommand = require("./SetSwitchCommand");
-const SetThermostatCommand = require("./SetThermostatCommand");
-const SetLockCommand = require("./SetLockCommand");
-const SetSceneControllerCommand = require("./SetSceneControllerCommand");
-const SetWindowCoveringCommand = require("./SetWindowCoveringCommand");
-const SetCourtesyCommand = require("./SetCourtesyCommand");
-const DiscoverUsersCommand = require("./DiscoverUsersCommand");
-const OCRDocumentCommand = require("./OCRDocumentCommand");
-const CheckInReservationCommand = require("./CheckInReservationCommand");
-const SendSMSCommand = require("./SendSMSCommand");
-const DiscoverReservationsCommand = require("./DiscoverReservationsCommand");
-const DiscoverRoomsCommand = require("./DiscoverRoomsCommand");
-
-module.exports = {
-  SetAlarmCommand,
-  SetDimmerCommand,
-  SetSwitchCommand,
-  SetThermostatCommand,
-  SetLockCommand,
-  SetSceneControllerCommand,
-  SetWindowCoveringCommand,
-  SetCourtesyCommand,
-  OCRDocumentCommand,
-  DiscoverUsersCommand,
-  CheckInReservationCommand,
-  SendSMSCommand,
-  DiscoverReservationsCommand,
-  DiscoverRoomsCommand,
-};