@kohost/api-client 0.6.5-alpha.4 → 0.6.5-alpha.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kohost/api-client",
-  "version": "0.6.5-alpha.4",
+  "version": "0.6.5-alpha.5",
   "description": "HTTP client to interact with Kohost APIs",
   "main": "dist/bundle.node.js",
   "module": "dist/bundle.js",
@@ -21,6 +21,9 @@
     "kohost",
     "api"
   ],
+  "files": [
+    "dist/*.js"
+  ],
   "author": "Ian Rogers",
   "license": "ISC",
   "dependencies": {

package/bitbucket-pipelines.yml

@@ -1,24 +0,0 @@
-image: node:12.14.1
-
-pipelines:
-  pull-requests:
-    "**":
-      - step:
-          name: Install dependencies and build
-          caches:
-            - node
-          script:
-            - npm install
-            - npm run build
-  branches:
-    master:
-      - step:
-          name: Build and publish to NPM
-          caches:
-            - node
-          script:
-            - npm install
-            - npm run prepare
-            - pipe: atlassian/npm-publish:0.2.6
-              variables:
-                NPM_TOKEN: $NPM_TOKEN

package/src/client.js

@@ -1,263 +0,0 @@
-import merge from "lodash/merge";
-import axios from "axios";
-import interceptors from "./interceptors";
-import Admin from "./methods/Admin";
-import Auth from "./methods/Auth";
-import Concierge from "./methods/Concierge";
-import Controllers from "./methods/Controller";
-import Commands from "./methods/Commands";
-import Group from "./methods/Group";
-import Guest from "./methods/Guest";
-import HotelRoom from "./methods/HotelRoom";
-import Integrations from "./methods/Integrations";
-import Image from "./methods/Image";
-import Light from "./methods/Light";
-import Privacy from "./methods/Privacy";
-import Lock from "./methods/Lock";
-import Manager from "./methods/Manager";
-import Manifest from "./methods/Manifest";
-import Media from "./methods/Media";
-import Notifications from "./methods/Notifications";
-import Reports from "./methods/Reports";
-import Room from "./methods/Room";
-import Settings from "./methods/Settings";
-import Shade from "./methods/Shade";
-import Source from "./methods/Source";
-import Structure from "./methods/Structure";
-import Subscriptions from "./methods/Subscriptions";
-import Thermostat from "./methods/Thermostat";
-import User from "./methods/User";
-
-class KohostAPIClient {
-  constructor(url) {
-    this.config = {
-      url: url,
-      version: 2,
-      lsAuthTokenKey: "x-auth-token",
-      lsRefreshTokenKey: "x-refresh-token",
-      lsUserKey: "current-user",
-      clientId: undefined,
-      secretKey: undefined,
-      autoRefreshTokens: true,
-      tenant: null,
-      onNewToken: function () {},
-      onLoginRequired: function () {
-        throw new Error("API Client - login required");
-      },
-    };
-    this.isBrowser = typeof window !== "undefined";
-    this.authTokenKey = "x-auth-token";
-    this.refreshTokenKey = "x-refresh-token";
-    this.http = undefined;
-    this.authToken = "";
-    this.currentUser = undefined;
-    this.logger = console;
-    // bind methods
-    this.config.update = this.updateConfig.bind(this);
-    this.handleHTTPResponseError = interceptors.handleHTTPError.bind(this);
-    this.handleHTTPResponseSuccess = interceptors.handleHTTPResponse.bind(this);
-    this.handleHTTPRequestConfig = interceptors.handleGenerateConfig.bind(this);
-
-    this.Admin = this.bindMethods(Admin);
-    this.Auth = this.bindMethods(Auth);
-
-    this.Guest = this.bindMethods(Guest);
-    this.User = this.bindMethods(User);
-
-    this.Group = this.bindMethods(Group);
-    this.Group.Integrations = this.bindMethods(Group.Integrations);
-    this.Group.Room = this.bindMethods(Group.Room);
-    this.Group.Room.Light = this.bindMethods(Group.Room.Light);
-    this.Group.Room.Shade = this.bindMethods(Group.Room.Shade);
-    this.Group.Room.Thermostat = this.bindMethods(Group.Room.Thermostat);
-    this.Group.Room.Media = this.bindMethods(Group.Room.Media);
-    this.Group.Room.Privacy = this.bindMethods(Group.Room.Privacy);
-    this.Group.Room.Security = this.bindMethods(Group.Room.Security);
-    this.Group.Room.Security.Locks = this.bindMethods(
-      Group.Room.Security.Locks
-    );
-    this.Group.Room.Security.Cameras = this.bindMethods(
-      Group.Room.Security.Cameras
-    );
-    this.Group.Room.Security.Alarms = this.bindMethods(
-      Group.Room.Security.Alarms
-    );
-    this.HotelRoom = this.bindMethods(HotelRoom);
-
-    this.HotelRoom.Room = this.bindMethods(HotelRoom.Room);
-    this.HotelRoom.Guest = this.bindMethods(HotelRoom.Guest);
-    this.HotelRoom.Alarms = this.bindMethods(HotelRoom.Alarms);
-    this.HotelRoom.Scenes = this.bindMethods(HotelRoom.Scenes);
-    this.HotelRoom.Integrations = this.bindMethods(HotelRoom.Integrations);
-
-    this.Room = this.bindMethods(Room);
-    this.Room.Light = this.bindMethods(Light);
-    this.Room.Shade = this.bindMethods(Shade);
-    this.Room.Thermostat = this.bindMethods(Thermostat);
-    this.Room.Lock = this.bindMethods(Lock);
-    this.Room.Privacy = this.bindMethods(Privacy);
-    this.Room.Scenes = this.bindMethods(Room.Scenes);
-    this.Room.Media = this.bindMethods(Room.Media);
-    this.Room.Security = this.bindMethods(Room.Security);
-    this.Room.Security.Locks = this.bindMethods(Room.Security.Locks);
-    this.Room.Security.Cameras = this.bindMethods(Room.Security.Cameras);
-
-    this.Settings = this.bindMethods(Settings);
-    this.Subscriptions = this.bindMethods(Subscriptions);
-    this.Reports = this.bindMethods(Reports);
-    this.Controllers = this.bindMethods(Controllers);
-
-    this.Integrations = this.bindMethods(Integrations);
-    this.Integrations.Types = this.bindMethods(Integrations.Types);
-    this.Integrations.RoomMap = this.bindMethods(Integrations.RoomMap);
-    this.Integrations.Metadata = this.bindMethods(Integrations.Metadata);
-    this.Integrations.DeviceMap = this.bindMethods(Integrations.DeviceMap);
-    this.Concierge = this.bindMethods(Concierge);
-    this.Commands = this.bindMethods(Commands);
-    this.Image = this.bindMethods(Image);
-    this.Source = this.bindMethods(Source);
-    this.Source.browse = this.bindMethods(Source.browse);
-    this.Source.browse.genres = this.bindMethods(Source.browse.genres);
-    this.Source.browse.stations = this.bindMethods(Source.browse.stations);
-    this.Structure = this.bindMethods(Structure);
-    this.Structure.Images = this.bindMethods(Image);
-    this.Media = this.bindMethods(Media);
-    this.Manifest = this.bindMethods(Manifest);
-    this.Manager = this.bindMethods(Manager);
-
-    this.Notifications = this.bindMethods(Notifications);
-
-    this.createHTTPClient();
-  }
-
-  bindMethods(funcObject) {
-    const bindMethod = (func) => {
-      return func.bind(this);
-    };
-    const boundMethods = {};
-    Object.keys(funcObject).forEach((method) => {
-      if (typeof funcObject[method] !== "function") return;
-      boundMethods[method] = bindMethod(funcObject[method]);
-    });
-    return boundMethods;
-  }
-
-  updateConfig(config) {
-    this.config = merge(this.config, config);
-    this.createHTTPClient();
-  }
-
-  createHTTPClient() {
-    this.http = axios.create({
-      baseURL: this.config.url,
-      headers: {
-        "Content-Type": "application/json; charset=utf-8",
-        "x-tenant-id": this.config.tenant,
-      },
-    });
-
-    this.http.interceptors.response.use(
-      this.handleHTTPResponseSuccess,
-      this.handleHTTPResponseError
-    );
-    this.http.interceptors.request.use(this.handleHTTPRequestConfig, null);
-  }
-
-  getItem(key) {
-    if (this.isBrowser) {
-      try {
-        return JSON.parse(localStorage.getItem(key));
-      } catch (error) {
-        return localStorage.getItem(key);
-      }
-    }
-  }
-
-  saveItem(key, data) {
-    if (this.isBrowser) {
-      if (typeof data === "object") data = JSON.stringify(data);
-      localStorage.setItem(key, data);
-    }
-  }
-
-  removeItem(key) {
-    if (this.isBrowser) {
-      localStorage.removeItem(key);
-    }
-  }
-
-  setAuthToken(token) {
-    this.authToken = token;
-    this.saveItem(this.config.lsAuthTokenKey, token);
-  }
-
-  setRefreshToken(token) {
-    this.refreshToken = token;
-    this.saveItem(this.config.lsRefreshTokenKey, token);
-  }
-
-  setCurrentUser(user) {
-    this.currentUser = user;
-    this.saveItem(this.config.lsUserKey, user);
-  }
-
-  getAuthToken() {
-    if (this.isBrowser) return this.getItem(this.config.lsAuthTokenKey);
-    return this.authToken;
-  }
-
-  getRefreshToken() {
-    if (this.isBrowser) return this.getItem(this.config.lsRefreshTokenKey);
-    return this.refreshToken;
-  }
-
-  getCurrentUser() {
-    if (this.isBrowser) return this.getItem(this.config.lsUserKey);
-    return this.currentUser;
-  }
-
-  handleLoginRequired() {
-    return this.config.onLoginRequired();
-  }
-
-  handleNewToken(token) {
-    return this.config.onNewToken(token);
-  }
-
-  handleLogAndNotifyError(error) {
-    this.logger.log(error);
-  }
-
-  get(url, options = {}) {
-    return this.http.get(url, options);
-  }
-
-  post(url, body, options = {}) {
-    return this.http.post(url, body, options);
-  }
-
-  put(url, body, options = {}) {
-    return this.http.put(url, body, options);
-  }
-
-  delete(url, body, options = {}) {
-    options.data = body;
-    return this.http.delete(url, options);
-  }
-
-  uploadFile(url, formData, uploadHandler = function () {}) {
-    return this.http({
-      method: "POST",
-      url,
-      data: formData,
-      onUploadProgress: uploadHandler,
-      headers: {
-        "Content-Type": `multipart/form-data; boundary=${formData._boundary}`,
-      },
-    });
-  }
-}
-
-const API = new KohostAPIClient();
-
-export default API;

package/src/interceptors.js

@@ -1,71 +0,0 @@
-function handleHTTPError(error) {
-  const { config: originalReq } = error;
-  if (!error.response) return Promise.reject(error);
-  const { status, data } = error.response;
-  const errorCode = data && data.error && data.error.code;
-  const errorMessage = data && data.error && data.error.message;
-
-  try {
-    const expectedError = status >= 400 && status < 500;
-    if (!expectedError) this.handleLogAndNotifyError(error);
-
-    if (errorMessage && errorMessage === "Login Required") {
-      this.handleLoginRequired();
-      return Promise.reject(error);
-    }
-
-    // prettier-ignore
-    const newTokensNeeded = expectedError && errorCode === 1004 && status === 401
-
-    if (status === 401 && !newTokensNeeded) {
-      return Promise.reject(error);
-    }
-    if (status === 400 && errorCode === 1010) {
-      this.handleLoginRequired();
-      return Promise.reject(error);
-    }
-
-    if (newTokensNeeded) {
-      return this.Auth.requestNewTokens().then((response) => {
-        // update headers with the new tokens
-        if (
-          response &&
-          response.headers &&
-          response.headers[this.authTokenKey]
-        ) {
-          const newToken = response.headers[this.authTokenKey];
-          originalReq.headers[this.authTokenKey] = newToken;
-          this.handleNewToken(newToken);
-          return this.http(originalReq);
-        }
-      });
-    }
-  } catch (error) {
-    this.handleLogAndNotifyError(error);
-  }
-
-  return Promise.reject(error);
-}
-
-function handleHTTPResponse(response) {
-  if (response && response.data && response.data.data) {
-    response.query = response.data.query;
-    response.pagination = response.data.pagination;
-    response.data = response.data.data;
-  }
-  return response;
-}
-
-function handleGenerateConfig(config) {
-  if (this.config.secretKey && this.config.clientId) {
-    config.headers["clientId"] = this.config.clientId;
-    config.headers["secretKey"] = this.config.secretKey;
-  } else config.headers[this.authTokenKey] = this.getAuthToken();
-  return config;
-}
-
-export default {
-  handleHTTPError,
-  handleHTTPResponse,
-  handleGenerateConfig,
-};

package/src/methods/Admin.js

@@ -1,3 +0,0 @@
-import generateFunctions from "../utils/generate";
-
-export default generateFunctions("/admins");

package/src/methods/Auth.js

@@ -1,149 +0,0 @@
-const base = "/auth";
-
-function setTokensFromResponse(response) {
-  if (response && response.headers) {
-    const authToken = response.headers[this.authTokenKey];
-    const refreshToken = response.headers[this.refreshTokenKey];
-    if (authToken) this.setAuthToken(authToken);
-    if (refreshToken) this.setRefreshToken(refreshToken);
-  }
-}
-
-async function requestNewTokens() {
-  const setTokens = setTokensFromResponse.bind(this);
-  if (!this.getRefreshToken()) return this.handleLoginRequired();
-  return this.post(
-    `${base}/token`,
-    {},
-    {
-      headers: {
-        [this.refreshTokenKey]: this.getRefreshToken(),
-      },
-    }
-  ).then((response) => {
-    setTokens(response);
-    return response;
-  });
-}
-
-function loginUser(email, password) {
-  const setTokens = setTokensFromResponse.bind(this);
-  const url = `${base}/user`;
-  return this.post(url, { email: email.toLowerCase(), password }).then(
-    (response) => {
-      setTokens(response);
-      const user = response && response.data && response.data[0];
-      if (user) this.setCurrentUser(user);
-      return response;
-    }
-  );
-}
-
-function loginGuest(lastName, roomNumber, phone) {
-  const setTokens = setTokensFromResponse.bind(this);
-  const url = `${base}/guest`;
-  return this.post(url, { lastName, roomNumber, phone }).then((response) => {
-    setTokens(response);
-    const user = response && response.data && response.data[0];
-    if (user) this.setCurrentUser(user);
-    return response;
-  });
-}
-
-function resetPassword(userID, password, token) {
-  const url = base + `/${userID}/set-password`;
-  let options = {};
-  if (token) {
-    options.headers = {
-      "x-reset-token": token,
-    };
-  }
-
-  return this.post(url, { password }, options).then((response) => {
-    if (response.status >= 400 && response.status <= 500) {
-      body.error = response.data.error;
-      return body;
-    } else {
-      return true;
-    }
-  });
-}
-
-function verifyToken(token) {
-  const url = base + `/verifyToken`;
-  return this.post(url, { token }).then((response) => {
-    if (response.status >= 400 && response.status <= 500) {
-      body.error = response.data.error;
-      return body;
-    } else {
-      return response;
-    }
-  });
-}
-
-function sendResetPasswordLink(userId) {
-  const url = base + `/${userId}/sendResetPasswordLink`;
-  return this.post(url, {}).then((response) => {
-    if (response.status >= 400 && response.status <= 500) {
-      body.error = response.data.error;
-      return body;
-    } else {
-      return response;
-    }
-  });
-}
-
-function forgotPassword(email) {
-  const url = `/users/forgot-password`;
-  return this.post(url, { email }).then((response) => {
-    if (response.status >= 400 && response.status <= 500) {
-      body.error = response.data.error;
-      return body;
-    } else {
-      return response;
-    }
-  });
-}
-
-function getNewControllerAuthToken(authKey, controllerId) {
-  const setTokens = setTokensFromResponse.bind(this);
-  const url = `${base}/controller`;
-
-  return this.post(url, { authKey, controllerId })
-    .then((response) => {
-      if (response.status >= 400 && response.status <= 500) {
-        body.error = response.data.error;
-        return body;
-      } else {
-        setTokens(response);
-        return response;
-      }
-    })
-    .catch((error) => {
-      console.log("error", error);
-    });
-}
-
-function logout() {
-  this.setAuthToken(null);
-  this.setRefreshToken(null);
-  this.setCurrentUser(null);
-  this.removeItem(this.config.lsAuthTokenKey);
-  this.removeItem(this.config.lsRefreshTokenKey);
-  this.removeItem(this.config.lsUserKey);
-}
-
-const Auth = {
-  requestNewTokens,
-  loginUser,
-  loginGuest,
-  resetPassword,
-  verifyToken,
-  sendResetPasswordLink,
-  forgotPassword,
-  getNewControllerAuthToken,
-  logout,
-  setTokensFromResponse,
-};
-
-export default Auth;

package/src/methods/Commands.js

@@ -1,12 +0,0 @@
-let base = "/commands";
-
-function post(body) {
-  const url = base;
-  return this.post(url, body);
-}
-
-const command = {
-  post,
-};
-
-export default command;

package/src/methods/Concierge.js

@@ -1,50 +0,0 @@
-import generateFunctions from "../utils/generate";
-
-const base = "/concierge";
-
-function getTickets(body) {
-  const url = `${base}/tickets`;
-  return this.get(url, body);
-}
-function createTicket(body) {
-    const url = `${base}/tickets`;
-    return this.post(url, body);
-  }
-function getPendingTickets(body) {
-    const url = `${base}/tickets/pending`;
-    return this.post(url, body);
-  }
-
-  function closeTickets(body) {
-    const url = `${base}/tickets/close`;
-    return this.post(url, body);
-  }
-
-  function updateTicket(ticketId,body) {
-    const url = `${base}/tickets/${ticketId}`;
-    return this.put(url, body);
-  }
-
-  function markAsRead(ticketId,body) {
-    const url = `${base}/tickets/${ticketId}/read`;
-    return this.post(url, body);
-  }
-
-  function postMessage(ticketId,body) {
-    const url = `${base}/tickets/${ticketId}/message`;
-    return this.post(url, body);
-  }
-  
-
-const Concierge = generateFunctions(base);
-
-
-Concierge.getTickets = getTickets;
-Concierge.createTicket = createTicket;
-Concierge.getPendingTickets = getPendingTickets;
-Concierge.closeTickets = closeTickets;
-Concierge.updateTicket = updateTicket;
-Concierge.markAsRead = markAsRead;
-Concierge.postMessage = postMessage;
-
-export default Concierge;

package/src/methods/Controller.js

@@ -1,3 +0,0 @@
-import generateFunctions from "../utils/generate";
-
-export default generateFunctions("/controllers");

package/src/methods/Group.js

@@ -1,49 +0,0 @@
-import generateFunctions, {
-  generateGroupRoomFunctions,
-  generateGroupDeviceFunctions,
-} from "../utils/generate";
-
-const base = "/groups";
-const Group = generateFunctions(base);
-
-Group.Room = generateGroupRoomFunctions();
-Group.Room.Light = generateGroupDeviceFunctions("lights");
-Group.Room.Shade = generateGroupDeviceFunctions("shades");
-Group.Room.Thermostat = generateGroupDeviceFunctions("thermostats");
-Group.Room.Privacy = generateGroupDeviceFunctions("privacy");
-Group.Room.Media = {
-  get: function (groupId, roomId) {
-    const url = `${base}/${groupId}/rooms/${roomId}/media`;
-    return this.get(url);
-  },
-  update: function (groupId, roomId, body) {
-    const url = `${base}/${groupId}/rooms/${roomId}/media`;
-    return this.put(url, body);
-  },
-};
-Group.Room.Security = {
-  get: function (groupId, roomId) {
-    const url = `${base}/${groupId}/rooms/${roomId}/security`;
-    return this.get(url);
-  },
-  Locks: generateGroupDeviceFunctions("security/locks"),
-  Cameras: generateGroupDeviceFunctions("security/cameras"),
-  Alarms: generateGroupDeviceFunctions("security/alarms"),
-};
-
-Group.Integrations = {
-  getAll: function (groupId) {
-    const url = `${base}/${groupId}/integrations`;
-    return this.get(url);
-  },
-  add: function (groupId, body) {
-    const url = `${base}/${groupId}/integrations`;
-    return this.post(url, body);
-  },
-  delete: function (groupId, integrationId) {
-    const url = `${base}/${groupId}/integrations/${integrationId}`;
-    return this.delete(url);
-  },
-};
-
-export default Group;

package/src/methods/Guest.js

@@ -1,25 +0,0 @@
-import generateFunctions from "../utils/generate";
-
-const base = "/guests";
-
-function checkInGuest(id, body) {
-  const url = `${base}/${id}/checkin`;
-  return this.post(url, body);
-}
-
-function checkOutGuest(id, body) {
-  const url = `${base}/${id}/checkout`;
-  return this.post(url, body);
-}
-
-function invite(id) {
-  const url = `${base}/${id}/invite`;
-  return this.post(url);
-}
-
-const Guest = generateFunctions(base);
-Guest.checkIn = checkInGuest;
-Guest.checkOut = checkOutGuest;
-Guest.invite = invite;
-
-export default Guest;