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

package/.eslintrc.js

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

package/bitbucket-pipelines.yml

@@ -0,0 +1,39 @@
+image: node:14
+
+pipelines:
+  pull-requests:
+    "**":
+      - step:
+          name: Install dependencies and build
+          caches:
+            - node
+          script:
+            - npm install
+            - npm version prerelease --preid=alpha -m "Upgrade to %s [skip ci]"
+            - git push && git push --tags
+            - pipe: atlassian/npm-publish:0.2.6
+              variables:
+                NPM_TOKEN: $NPM_TOKEN
+  branches:
+    master:
+      - step:
+          name: Build and publish to NPM
+          caches:
+            - node
+          script:
+            - npm install
+            - pipe: atlassian/npm-publish:0.2.6
+              variables:
+                NPM_TOKEN: $NPM_TOKEN
+    dev:
+      - step:
+          name: Build and publish to NPM
+          caches:
+            - node
+          script:
+            - npm install
+            - npm version prerelease --preid=beta -m "Upgrade to %s [skip ci]"
+            - git push && git push --tags
+            - pipe: atlassian/npm-publish:0.2.6
+              variables:
+                NPM_TOKEN: $NPM_TOKEN

package/commands/Command.js

@@ -0,0 +1,38 @@
+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/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/SetAlarmCommand.js

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,21 @@
+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/VerifyDocumentCommand.js

@@ -0,0 +1,24 @@
+const Command = require("./Command");
+const RequestError = require("../errors/RequestError");
+
+class VerifyDocumentCommand 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 "VerifyDocument";
+  }
+
+  get routingKey() {
+    return `document.${this.data.type}.verify`;
+  }
+
+  get replyTo() {
+    return "system.response.documents";
+  }
+}
+
+module.exports = VerifyDocumentCommand;

package/commands/index.js

@@ -0,0 +1,25 @@
+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 VerifyDocumentCommand = require("./VerifyDocumentCommand");
+
+module.exports = {
+  SetAlarmCommand,
+  SetDimmerCommand,
+  SetSwitchCommand,
+  SetThermostatCommand,
+  SetLockCommand,
+  SetSceneControllerCommand,
+  SetWindowCoveringCommand,
+  SetCourtesyCommand,
+  VerifyDocumentCommand,
+  DiscoverUsersCommand,
+};

package/defs/deviceTypes.js

@@ -0,0 +1,15 @@
+const types = [
+  "dimmer",
+  "switch",
+  "thermostat",
+  "lock",
+  "windowCovering",
+  "sceneController",
+  "courtesy",
+  "alarm",
+  "camera",
+  "source",
+  "motionSensor",
+];
+
+module.exports = types;

package/defs/formalDeviceTypes.js

@@ -0,0 +1,6 @@
+const deviceTypes = require("./deviceTypes");
+const formalDeviceTypes = deviceTypes.map(
+  (type) => type.charAt(0).toUpperCase() + type.slice(1)
+);
+
+module.exports = formalDeviceTypes;

package/defs/http.js

@@ -0,0 +1,7 @@
+const http = {
+  authTokenHeader: "X-Auth-Token",
+  refreshTokenHeader: "X-Refresh-Token",
+  tenantHeader: "X-Tenant-Id",
+};
+
+module.exports = http;

package/defs/index.js

@@ -0,0 +1,11 @@
+const http = require("./http");
+const deviceTypes = require("./deviceTypes");
+const formalDeviceTypes = require("./formalDeviceTypes");
+
+const defs = {
+  http,
+  deviceTypes,
+  formalDeviceTypes,
+};
+
+module.exports = defs;

package/errors/AppError.js

@@ -0,0 +1,8 @@
+module.exports = class AppError extends Error {
+  constructor(message = "Internal Server Error", options) {
+    super(message, options);
+    this.type = this.constructor.name;
+    this.statusCode = 500;
+    Object.setPrototypeOf(this, AppError.prototype);
+  }
+};

package/errors/AuthenticationError.js

@@ -0,0 +1,9 @@
+const AppError = require("./AppError");
+
+module.exports = class AuthenticationError extends AppError {
+  constructor(message = "Authentication Error", options = {}) {
+    super(message, options);
+    this.statusCode = 401;
+    Object.setPrototypeOf(this, AuthenticationError.prototype);
+  }
+};

package/errors/AuthorizationError.js

@@ -0,0 +1,9 @@
+const AppError = require("./AppError");
+
+module.exports = class AuthorizationError extends AppError {
+  constructor(message = "Authorization Error", options = {}) {
+    super(message, options);
+    this.statusCode = 403;
+    Object.setPrototypeOf(this, AuthorizationError.prototype);
+  }
+};

package/errors/DeviceCommError.js

@@ -0,0 +1,9 @@
+const AppError = require("./AppError");
+
+module.exports = class DeviceCommError extends AppError {
+  constructor(message = "Device Communication Error", options = {}) {
+    super(message, options);
+    this.statusCode = 503;
+    Object.setPrototypeOf(this, DeviceCommError.prototype);
+  }
+};

package/errors/LoginError.js

@@ -0,0 +1,9 @@
+const AppError = require("./AppError");
+
+module.exports = class LoginError extends AppError {
+  constructor(message = "Invalid Login information provided", options = {}) {
+    super(message, options);
+    this.statusCode = 401;
+    Object.setPrototypeOf(this, LoginError.prototype);
+  }
+};

package/errors/NotFoundError.js

@@ -0,0 +1,9 @@
+const AppError = require("./AppError");
+
+module.exports = class NotFoundError extends AppError {
+  constructor(message = "Resource Not Found", options = {}) {
+    super(message, options);
+    this.statusCode = 404;
+    Object.setPrototypeOf(this, NotFoundError.prototype);
+  }
+};

package/errors/RequestError.js

@@ -0,0 +1,9 @@
+const AppError = require("./AppError");
+
+module.exports = class RequestError extends AppError {
+  constructor(message = "Bad Request", options = {}) {
+    super(message, options);
+    this.statusCode = 400;
+    Object.setPrototypeOf(this, RequestError.prototype);
+  }
+};

package/errors/SystemCommError.js

@@ -0,0 +1,9 @@
+const AppError = require("./AppError");
+
+module.exports = class SystemCommError extends AppError {
+  constructor(message = "System Communication Error", options = {}) {
+    super(message, options);
+    this.statusCode = 503;
+    Object.setPrototypeOf(this, SystemCommError.prototype);
+  }
+};

package/errors/TokenExpiredError.js

@@ -0,0 +1,9 @@
+const AppError = require("./AppError");
+
+module.exports = class TokenExpiredError extends AppError {
+  constructor(message = "Token Expired", options = {}) {
+    super(message, options);
+    this.statusCode = 401;
+    Object.setPrototypeOf(this, TokenExpiredError.prototype);
+  }
+};

package/errors/UnprocessableRequestError.js

@@ -0,0 +1,9 @@
+const AppError = require("./AppError");
+
+module.exports = class UnprocessableRequestError extends AppError {
+  constructor(message = "Unprocessable Request Error", options = {}) {
+    super(message, options);
+    this.statusCode = 422;
+    Object.setPrototypeOf(this, UnprocessableRequestError.prototype);
+  }
+};

package/errors/ValidationError.js

@@ -0,0 +1,9 @@
+const AppError = require("./AppError");
+
+module.exports = class ValidationError extends AppError {
+  constructor(message = "Validation Error", options = {}) {
+    super(message, options);
+    this.statusCode = 400;
+    Object.setPrototypeOf(this, ValidationError.prototype);
+  }
+};

package/errors/index.js

@@ -0,0 +1,15 @@
+const Errors = {
+  AppError: require("./AppError"),
+  AuthenticationError: require("./AuthenticationError"),
+  AuthorizationError: require("./AuthorizationError"),
+  DeviceCommError: require("./DeviceCommError"),
+  LoginError: require("./LoginError"),
+  NotFoundError: require("./NotFoundError"),
+  RequestError: require("./RequestError"),
+  SystemCommError: require("./SystemCommError"),
+  TokenExpiredError: require("./TokenExpiredError"),
+  UnprocessableRequestError: require("./UnprocessableRequestError"),
+  ValidationError: require("./ValidationError"),
+};
+
+module.exports = Errors;

package/events/Event.js

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

package/events/SystemCameraUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemCameraUpdatedEvent extends Event {
+  constructor(camera) {
+    super(camera);
+  }
+
+  get name() {
+    return "SystemCameraUpdated";
+  }
+
+  get routingKey() {
+    return `camera.${this.data.id}.updated`;
+  }
+}
+
+module.exports = SystemCameraUpdatedEvent;

package/events/SystemCourtesyUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemCourtesyUpdatedEvent extends Event {
+  constructor(courtesy) {
+    super(courtesy);
+  }
+
+  get name() {
+    return "SystemCourtesyUpdated";
+  }
+
+  get routingKey() {
+    return `courtesy.${this.data.id}.updated`;
+  }
+}
+
+module.exports = SystemCourtesyUpdatedEvent;

package/events/SystemDimmerUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemDimmerUpdatedEvent extends Event {
+  constructor(dimmer) {
+    super(dimmer);
+  }
+
+  get name() {
+    return "SystemDimmerUpdated";
+  }
+
+  get routingKey() {
+    return `dimmer.${this.data.id}.updated`;
+  }
+}
+
+module.exports = SystemDimmerUpdatedEvent;

package/events/SystemLockUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemLockUpdatedEvent extends Event {
+  constructor(lock) {
+    super(lock);
+  }
+
+  get name() {
+    return "SystemLockUpdated";
+  }
+
+  get routingKey() {
+    return `lock.${this.data.id}.updated`;
+  }
+}
+
+module.exports = SystemLockUpdatedEvent;

package/events/SystemReservationUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemReservationUpdatedEvent extends Event {
+  constructor(reservation) {
+    super(reservation);
+  }
+
+  get name() {
+    return "SystemReservationUpdated";
+  }
+
+  get routingKey() {
+    return `reservation.${this.data.id}.updated`;
+  }
+}
+
+module.exports = SystemReservationUpdatedEvent;

package/events/SystemSceneControllerUpdatedEvent.js

@@ -0,0 +1,17 @@
+const Event = require("./Event");
+
+class SystemSceneControllerUpdatedEvent extends Event {
+  constructor(sceneController) {
+    super(sceneController);
+  }
+
+  get name() {
+    return "SystemSceneControllerUpdated";
+  }
+
+  get routingKey() {
+    return `sceneController.${this.data.id}.updated`;
+  }
+}
+
+module.exports = SystemSceneControllerUpdatedEvent;