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

package/http/handleResponseError.js

@@ -1,33 +0,0 @@
-module.exports = function handleResponseError(error) {
-  const { config: originalReq } = error;
-  if (!error.response) return Promise.reject(error);
-  const { status, data } = error.response;
-  const errorType = data?.error?.type;
-  const errorMessage = data?.error?.message;
-
-  try {
-    const expectedError = status >= 400 && status < 500;
-    const newTokensNeeded = expectedError && errorType === "TokenExpiredError";
-
-    if (expectedError && errorMessage === "Login Required") {
-      this.onLoginRequired();
-      return Promise.reject(error);
-    }
-
-    if (expectedError && errorMessage === "No token provided") {
-      this.onLoginRequired();
-      return Promise.reject(error);
-    }
-
-    if (expectedError && newTokensNeeded) {
-      return this.RefreshToken().then(() => {
-        // retry the original request with the new token
-        return this.http(originalReq);
-      });
-    }
-  } catch (error) {
-    console.log(error);
-  }
-
-  return Promise.reject(error);
-};

package/http/handleResponseSuccess.js

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

package/http/index.js

@@ -1,169 +0,0 @@
-const { EventEmitter } = require("events");
-const defs = require("../defs").http;
-const handleResponseError = require("./handleResponseError");
-const handleResponseSuccess = require("./handleResponseSuccess");
-
-const useCases = require("../useCases/http.json");
-
-/*
-Creates methods for each use case in the API
-
-@param {Object} Client - The client class
-@returns undefined
-*/
-
-function useCaseMethodFactory(Client) {
-  const map = new Map(useCases);
-  for (const [useCase, data] of map.entries()) {
-    if (data.http) {
-      const { method, path } = data.http;
-
-      /* 
-        Creates a method for each use case in the API
-        @param {Object} options - The options to send to the API
-        @param {Object} options.headers - The headers to send to the API
-        @param {Object} options.params - The params for the reuquest to build the URL
-        @param {Object} options.data - The body to send to the API. Valid for POST and PUT requests
-        @parms {Object} options.query - The query for the request to build the URL
-        @returns {Promise} The response from the API
-      */
-
-      //eslint-disable-next-line no-inner-declarations
-      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, query, headers } = requestData;
-
-        // replace path parameters with values from params
-        let url = path;
-        if (pathParams && data) {
-          for (const param of pathParams) {
-            const paramName = param.replace(":", "");
-            url = url.replace(param, data[paramName]);
-          }
-        }
-
-        // make sure all parameters have been replaced
-        if (url.match(/:[a-zA-Z0-9]+/g)) {
-          const missingParams = url.match(/:[a-zA-Z0-9]+/g);
-          // remove the colon from the parameter name
-          const missing = missingParams.map((param) => param.replace(":", ""));
-          return Promise.reject(
-            new Error(`Missing parameters: ${missing.join(", ")}`)
-          );
-        }
-
-        const config = {
-          method: method.toLowerCase(),
-          url: url,
-          ...options,
-        };
-
-        if (data) config.data = data;
-        if (query) config.params = query;
-        if (headers) config.headers = headers;
-
-        return this._http.request(config);
-      }
-
-      Client.prototype[useCase] = UseCase;
-    }
-  }
-}
-
-class KohostApiClient extends EventEmitter {
-  /* 
-  @param {Object} options - The options to create the client
-  @param {String} options.propertyId - The property ID
-  @param {String} options.url - The base URL for the API endpint
-  @param {Object} options.headers - Additional headers to send with each request
-
-  */
-  constructor(
-    options = {
-      url: "",
-      propertyId: "",
-      headers: {},
-    }
-  ) {
-    super();
-    if (!options.url) throw new Error("options.url is required");
-    if (!options.propertyId) throw new Error("options.property is required");
-    this.options = options;
-    // eslint-disable-next-line no-undef
-    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.propertyHeader]: options.propertyId,
-          ...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;
-    });
-  }
-
-  get authTokenHeaderKey() {
-    return defs.authTokenHeader.toLowerCase();
-  }
-
-  get refreshTokenHeaderKey() {
-    return defs.refreshTokenHeader.toLowerCase();
-  }
-
-  get lsTokenKey() {
-    return `${this.options.propertyId}_${defs.authTokenHeader}`;
-  }
-
-  get authToken() {
-    return this._authToken;
-  }
-
-  /* 
-  @param {String} token - The token to set
-  @returns undefined
-  */
-
-  set authToken(token) {
-    this._authToken = token;
-  }
-
-  onLoginRequired() {
-    this.emit("LoginRequired");
-  }
-}
-
-useCaseMethodFactory(KohostApiClient);
-
-module.exports = KohostApiClient;

package/index.js

@@ -1,23 +0,0 @@
-const Models = require("./models");
-const Errors = require("./errors");
-const Commands = require("./commands");
-const Events = require("./events");
-const HttpClient = require("./http");
-const defs = require("./defs");
-const getFormalDeviceType = require("./utils/getFormalDeviceType");
-const getDeviceTypes = require("./utils/getDeviceTypes");
-
-const Kohost = {
-  Models,
-  Errors,
-  Commands,
-  Events,
-  defs,
-  Client: HttpClient,
-  utils: {
-    getFormalDeviceType: getFormalDeviceType,
-    getDeviceTypes: getDeviceTypes,
-  },
-};
-
-module.exports = Kohost;

package/models/acl.js

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

package/models/admin/customer.js

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

package/models/admin/property.js

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

package/models/alarm.js

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

package/models/application.js

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

package/models/camera.js

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

package/models/courtesy.js

@@ -1,33 +0,0 @@
-// create the Courtesy Model
-const schemas = require("../utils/schema");
-const schema = require("../schemas/courtesy.json");
-const Kohost = require("./kohost");
-
-schemas.add(schema);
-const validator = schemas.compile(schema);
-
-class Courtesy extends Kohost {
-  constructor(data) {
-    super(data);
-  }
-}
-
-Object.defineProperty(Courtesy.prototype, "schema", {
-  value: schema,
-});
-
-Object.defineProperty(Courtesy.prototype, "validator", {
-  get: function () {
-    return validator;
-  },
-});
-
-Object.defineProperty(Courtesy, "validProperties", {
-  value: Object.keys(schema.properties),
-});
-
-Object.defineProperty(Courtesy, "actionProperties", {
-  value: ["state"],
-});
-
-module.exports = Courtesy;

package/models/credential.js

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

package/models/dimmer.js

@@ -1,49 +0,0 @@
-// Create the Dimmer Model
-const schemas = require("../utils/schema");
-const schema = require("../schemas/dimmer.json");
-const Kohost = require("./kohost");
-
-schemas.add(schema);
-const validator = schemas.compile(schema);
-
-class Dimmer extends Kohost {
-  constructor(data) {
-    super(data);
-  }
-
-  static getActionDelta(old, _new) {
-    const delta = {};
-    for (const action in _new) {
-      if (this.actionProperties?.includes(action)) {
-        if (action === "level") {
-          const oldLevel = old[action];
-          const newLevel = _new[action];
-          delta[action] = newLevel - oldLevel / 100;
-        } else {
-          delta[action] = 1;
-        }
-      }
-    }
-    return delta;
-  }
-}
-
-Object.defineProperty(Dimmer.prototype, "schema", {
-  value: schema,
-});
-
-Object.defineProperty(Dimmer.prototype, "validator", {
-  get: function () {
-    return validator;
-  },
-});
-
-Object.defineProperty(Dimmer, "validProperties", {
-  value: Object.keys(schema.properties),
-});
-
-Object.defineProperty(Dimmer, "actionProperties", {
-  value: ["level"],
-});
-
-module.exports = Dimmer;

package/models/discoveredDevice.js

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

package/models/gateway.js

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

package/models/identification.js

@@ -1,32 +0,0 @@
-const schemas = require("../utils/schema");
-const schema = require("../schemas/identification.json");
-const Kohost = require("./kohost");
-
-schemas.add(schema);
-const validator = schemas.compile(schema);
-
-class Identification extends Kohost {
-  constructor(data) {
-    super(data);
-  }
-
-  get isExpired() {
-    return new Date(this.expirationDate) < new Date();
-  }
-}
-
-Object.defineProperty(Identification.prototype, "schema", {
-  value: schema,
-});
-
-Object.defineProperty(Identification.prototype, "validator", {
-  get: function () {
-    return validator;
-  },
-});
-
-Object.defineProperty(Identification, "validProperties", {
-  value: Object.keys(schema.properties),
-});
-
-module.exports = Identification;

package/models/index.js

@@ -1,56 +0,0 @@
-const Switch = require("./switch");
-const Alarm = require("./alarm");
-const Dimmer = require("./dimmer");
-const Lock = require("./lock");
-const Thermostat = require("./thermostat");
-const WindowCovering = require("./windowCovering");
-const Identification = require("./identification");
-const User = require("./user");
-const Courtesy = require("./courtesy");
-const Camera = require("./camera");
-const MotionSensor = require("./motionSensor");
-const MediaSource = require("./mediaSource");
-const Room = require("./room");
-const Reservation = require("./reservation");
-const Application = require("./application");
-const Space = require("./space");
-const Ticket = require("./ticket");
-const Scene = require("./scene");
-const Gateway = require("./gateway");
-const Product = require("./product");
-const DiscoveredDevice = require("./discoveredDevice");
-const Credential = require("./credential");
-const ShortLink = require("./shortLink");
-
-const AdminCustomer = require("./admin/customer");
-const AdminProperty = require("./admin/property");
-
-module.exports = {
-  Admin: {
-    Customer: AdminCustomer,
-    Property: AdminProperty,
-  },
-  Gateway,
-  Switch,
-  Alarm,
-  Dimmer,
-  Lock,
-  Courtesy,
-  Camera,
-  MotionSensor,
-  Thermostat,
-  WindowCovering,
-  MediaSource,
-  Identification,
-  Product,
-  User,
-  Room,
-  Application,
-  Space,
-  Ticket,
-  Scene,
-  DiscoveredDevice,
-  Reservation,
-  Credential,
-  ShortLink,
-};