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

package/models/integration.js

@@ -1,76 +0,0 @@
-// Create the Driver Model
-const schemas = require("../utils/schema");
-const schema = require("../schemas/integration.json");
-const Kohost = require("./kohost");
-
-schemas.add(schema);
-const validator = schemas.compile(schema);
-class Integration extends Kohost {
-  constructor(data) {
-    super(data);
-  }
-  getDriverDeviceId(kohostDeviceId, type) {
-    const found = this.deviceMap.get(kohostDeviceId);
-    if (found) {
-      if (type && found.type === type) return found.id;
-      else if (!type) return found.id;
-    }
-    return null;
-  }
-
-  getDeviceId(driverDeviceId, type) {
-    const found = this.driverDeviceMap.get(driverDeviceId);
-    if (found) {
-      if (type && found.type === type) return found.id;
-      else if (!type) return found.id;
-    }
-    return null;
-  }
-
-  getRoomId(driverDeviceId, type) {
-    const found = this.driverDeviceMap.get(driverDeviceId);
-    if (found) {
-      if (type && found.type === type) return found.roomId;
-      else if (!type) return found.roomId;
-    }
-    return null;
-  }
-
-  getDeviceData(driverDeviceId, type) {
-    const found = this.driverDeviceMap.get(driverDeviceId);
-    if (found) {
-      if (type && found.type === type)
-        return { id: found.id, roomId: found.roomId };
-      else if (!type) return { id: found.id, roomId: found.roomId };
-    }
-    return null;
-  }
-
-  get deviceMap() {
-    return new Map(Object.entries(this.data?.deviceMap || {}));
-  }
-
-  get driverDeviceMap() {
-    const map = new Map();
-    for (const [id, value] of Object.entries(this.data?.deviceMap || {})) {
-      map.set(value.id, { id, type: value.type, roomId: value.roomId });
-    }
-    return map;
-  }
-}
-
-Object.defineProperty(Integration.prototype, "schema", {
-  value: schema,
-});
-
-Object.defineProperty(Integration.prototype, "validator", {
-  get: function () {
-    return validator;
-  },
-});
-
-Object.defineProperty(Integration, "validProperties", {
-  value: Object.keys(schema.properties),
-});
-
-module.exports = Integration;

package/models/kohost.js

@@ -1,96 +0,0 @@
-const { ValidationError } = require("../errors");
-const { customAlphabet: generate } = require("nanoid");
-
-class Kohost {
-  constructor(data) {
-    if (!this.schema) {
-      throw new Error("Schema is not defined");
-    }
-
-    if (!this.validator) {
-      throw new Error("Validator is not defined");
-    }
-
-    const isNew = data?.id ? false : true;
-
-    this._setId(data);
-    this._validate(data);
-    this._setProperties(data);
-    this._setTimestamps(isNew);
-  }
-
-  static get validProperties() {
-    throw new Error("validProperties is not defined");
-  }
-
-  get schemaProperties() {
-    return Object.keys(this.validator.schema.properties);
-  }
-
-  _setId(data) {
-    if (data._id) data.id = data._id;
-    if (!data.id) {
-      data.id = this.constructor.generateId();
-    }
-    delete data._id;
-  }
-
-  _setProperties(data) {
-    this.schemaProperties.forEach((key) => {
-      if (data[key] !== undefined) this[key] = data[key];
-    });
-  }
-
-  _setTimestamps(isNew) {
-    const now = new Date();
-    if (
-      isNew &&
-      this.schemaProperties.includes("createdAt") &&
-      !this.createdAt
-    ) {
-      this.createdAt = now;
-    }
-  }
-
-  _validate(data) {
-    const valid = this.validator(data);
-    if (!valid) {
-      throw new ValidationError(`Invalid ${this.constructor.name}`, {
-        cause: this.validator.errors,   
-    });    }
-   
-  }
-
-  static generateId() {
-    const length = 8;
-    const characters =
-      "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
-    const id = generate(characters, length)();
-    return id;
-  }
-
-  static getActionDelta(old, _new) {
-    const delta = {};
-    for (const action in _new) {
-      if (this.actionProperties?.includes(action)) {
-        if (old[action] !== _new[action]) {
-          delta[action] = 1;
-        }
-      }
-    }
-    return delta;
-  }
-
-  toObject() {
-    const obj = { ...this };
-    // delete keys if they are not valid properties
-    Object.keys(obj).forEach((key) => {
-      if (!this.constructor.validProperties.includes(key)) {
-        delete obj[key];
-      }
-    });
-    return obj;
-  }
-}
-
-module.exports = Kohost;

package/models/lock.js

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

package/models/mediaSource.js

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

package/models/motionSensor.js

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

package/models/product.js

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

package/models/reservation.js

@@ -1,83 +0,0 @@
-const schemas = require("../utils/schema");
-const schema = require("../schemas/reservation.json");
-const Kohost = require("./kohost");
-
-schemas.add(schema);
-const validator = schemas.compile(schema);
-
-class Reservation extends Kohost {
-  constructor(data) {
-    super(data);
-  }
-
-  get peopleCount() {
-    return this.adultCount + this.childCount;
-  }
-
-  get hasPayment() {
-    return this.paymentId?.length > 0;
-  }
-
-  range(tz) {
-    const start = new Date(this.checkInDateTime);
-    const end = new Date(this.checkOutDateTime);
-
-    // output Dec 19-23 if same month and year
-    if (
-      start.getMonth() === end.getMonth() &&
-      start.getFullYear() === end.getFullYear()
-    ) {
-      return `${start.toLocaleString("default", {
-        month: "short",
-        timeZone: tz,
-      })} ${start.toLocaleString("default", {
-        timeZone: tz,
-        day: "numeric",
-      })}-${end.toLocaleString("default", {
-        timeZone: tz,
-        day: "numeric",
-      })}`;
-    }
-
-    // output Dec 19 - Jan 2 if different month and year
-    return `${start.toLocaleString("default", {
-      month: "short",
-      timeZone: tz,
-    })} ${start.getDate()} - ${end.toLocaleString("default", {
-      month: "short",
-      timeZone: tz,
-    })} ${end.getDate()}`;
-  }
-
-  checkInTime(tz) {
-    return new Date(this.checkInDateTime).toLocaleString("default", {
-      hour: "numeric",
-      minute: "numeric",
-      timeZone: tz,
-    });
-  }
-
-  checkOutTime(tz) {
-    return new Date(this.checkOutDateTime).toLocaleString("default", {
-      hour: "numeric",
-      minute: "numeric",
-      timeZone: tz,
-    });
-  }
-}
-
-Object.defineProperty(Reservation.prototype, "schema", {
-  value: schema,
-});
-
-Object.defineProperty(Reservation.prototype, "validator", {
-  get: function () {
-    return validator;
-  },
-});
-
-Object.defineProperty(Reservation, "validProperties", {
-  value: Object.keys(schema.properties),
-});
-
-module.exports = Reservation;

package/models/room.js

@@ -1,174 +0,0 @@
-// create the Room model
-const schemas = require("../utils/schema");
-const schema = require("../schemas/room.json");
-const Kohost = require("./kohost");
-const cloneDeep = require("lodash.clonedeep");
-
-// device dependencies
-const Switch = require("./switch");
-const Dimmer = require("./dimmer");
-const Thermostat = require("./thermostat");
-const Lock = require("./lock");
-const WindowCovering = require("./windowCovering");
-const Courtesy = require("./courtesy");
-const Camera = require("./camera");
-const Alarm = require("./alarm");
-const Source = require("./mediaSource");
-const MotionSensor = require("./motionSensor");
-
-// other dependencies
-const Scene = require("./scene");
-
-schemas.add(schema);
-const validator = schemas.compile(schema);
-
-class Room extends Kohost {
-  constructor(data) {
-    const roomData = mapRoomData(data);
-    super(roomData);
-  }
-
-  static getDevicePath(type) {
-    const validTypes = [
-      "dimmer",
-      "switch",
-      "thermostat",
-      "lock",
-      "windowCovering",
-      "courtesy",
-      "camera",
-      "source",
-      "motionSensor",
-      "alarm",
-    ];
-    if (!validTypes.includes(type))
-      throw new Error("Invalid device type:" + type);
-    switch (type) {
-      case "courtesy":
-        return type;
-      case "switch":
-        return "switches";
-      default:
-        return `${type}s`;
-    }
-  }
-
-  get hasDimmer() {
-    return this.dimmers?.length > 0;
-  }
-
-  get hasSwitch() {
-    return this.switches?.length > 0;
-  }
-
-  get hasWindowCovering() {
-    return this.windowCoverings?.length > 0;
-  }
-
-  get hasThermostat() {
-    return this.thermostats?.length > 0;
-  }
-
-  get hasLock() {
-    return this.locks?.length > 0;
-  }
-
-  get hasCourtesy() {
-    return this.courtesy?.length > 0;
-  }
-
-  get hasCamera() {
-    return this.cameras?.length > 0;
-  }
-
-  get hasAlarm() {
-    return this.alarms?.length > 0;
-  }
-
-  get hasMedia() {
-    return this.sources?.length > 0;
-  }
-
-  get occupied() {
-    const now = new Date();
-    const lastOccupied = new Date(this.occupiedAt);
-    const diff = now - lastOccupied;
-    // check if the room has been occupied in the last 60 minutes
-    return diff < 60 * 60 * 1000;
-  }
-}
-
-Object.defineProperty(Room.prototype, "schema", {
-  value: schema,
-});
-
-Object.defineProperty(Room.prototype, "validator", {
-  get: function () {
-    return validator;
-  },
-});
-
-Object.defineProperty(Room, "validProperties", {
-  value: Object.keys(schema.properties),
-});
-
-function mapRoomData(data) {
-  const roomData = cloneDeep(data);
-  roomData.dimmers?.map((dimmer) => {
-    if (dimmer instanceof Dimmer) return dimmer;
-    else return new Dimmer(dimmer);
-  });
-  roomData.switches?.map((switch_) => {
-    if (switch_ instanceof Switch) return switch_;
-    else return new Switch(switch_);
-  });
-
-  roomData.windowCoverings?.map((windowCovering) => {
-    if (windowCovering instanceof WindowCovering) return windowCovering;
-    else return new WindowCovering(windowCovering);
-  });
-
-  roomData.thermostats?.map((thermostat) => {
-    if (thermostat instanceof Thermostat) return thermostat; 
-    else return new Thermostat(thermostat);
-  });
-
-  roomData.locks?.map((lock) => {
-    if (lock instanceof Lock) return lock;
-    else return new Lock(lock);
-  });
-
-  roomData.courtesy?.map((courtesy) => {
-    if (courtesy instanceof Courtesy) return courtesy;
-    else return new Courtesy(courtesy);
-  });
-
-  roomData.sources?.map((source) => {
-    if (source instanceof Source) return source;
-    else return new Source(source);
-  });
-
-  roomData.cameras?.map((camera) => {
-    if (camera instanceof Camera) return camera;
-    else return new Camera(camera);
-  });
-
-  roomData.alarms?.map((alarm) => {
-    if (alarm instanceof Alarm) return alarm;
-    else return new Alarm(alarm);
-  });
-
-  roomData.motionSensors?.map((motionSensor) => {
-    if (motionSensor instanceof MotionSensor) return motionSensor;
-    else return new MotionSensor(motionSensor);
-  });
-
-  roomData.scenes?.map((scene) => {
-    if (scene instanceof Scene) return scene;
-    else return new Scene(scene);
-  });
-
-  return roomData;
-}
-
-module.exports = Room;

package/models/scene.js

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

package/models/shortLink.js

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

package/models/space.js

@@ -1,99 +0,0 @@
-// Create the Space Model
-// A group of rooms -> rooms could become a space later...
-const schemas = require("../utils/schema");
-const schema = require("../schemas/space.json");
-const Kohost = require("./kohost");
-const cloneDeep = require("lodash.clonedeep"); 
-
-const Room = require("./room");
-
-schemas.add(schema);
-const validator = schemas.compile(schema);
-
-class Space extends Kohost { 
-  constructor(data) {
-    const spaceData = mapSpaceData(data);
-    super(spaceData);
-  }
-
-  get floor() {
-    const floors = new Set();
-
-    this.room.forEach((room) => {
-      if (room.floor) floors.add(room.floor);
-    });
-
-    return floors.size == 1 ? [...floors][0] : undefined;
-  }
-
-  get hasDimmer() {
-    return this.rooms.some((room) => room.hasDimmer);
-  }
-
-  get hasSwitch() {
-    return this.rooms.some((room) => room.hasSwitch);
-  }
-
-  get hasWindowCovering() {
-    return this.rooms.some((room) => room.hasWindowCovering);
-  }
-
-  get hasThermostat() {
-    return this.rooms.some((room) => room.hasThermostat);
-  }
-
-  get hasLock() {
-    return this.rooms.some((room) => room.hasLock);
-  }
-
-  get hasCourtesy() {
-    return this.rooms.some((room) => room.hasCourtesy);
-  }
-
-  get hasSceneController() {
-    return this.rooms.some((room) => room.hasSceneController);
-  }
-
-  get hasCamera() {
-    return this.rooms.some((room) => room.hasCamera);
-  }
-
-  get hasAlarm() {
-    return this.rooms.some((room) => room.hasAlarm);
-  }
-
-  get hasMedia() {
-    return this.rooms.some((room) => room.hasMedia);
-  }
-  get occupied() {
-    return this.rooms.some((room) => room.occupied);
-  }
-}
-
-Object.defineProperty(Space.prototype, "schema", {
-  value: schema,
-});
-
-Object.defineProperty(Space.prototype, "validator", {
-  get: function () {
-    return validator;
-  },
-});
-
-Object.defineProperty(Space, "validProperties", {
-  value: Object.keys(schema.properties),
-});
-
-function mapSpaceData(data) {
-  const spaceData = cloneDeep(data);
-  if (spaceData.rooms?.length) {
-    spaceData.rooms.map((room) => {
-      if (typeof room === "string") return room;
-      if (room instanceof Room) return room;
-      return new Room(room);
-    });
-  }
-  return spaceData;
-}
-
-module.exports = Space;