@kohost/api-client 3.0.0-beta.8 → 3.0.0-beta.81

package/dist/cjs/Models/MediaFile.js

@@ -0,0 +1,48 @@
+const schemas = require("../utils/schema");
+const schema = require("../schemas/mediaFile.json");
+const Kohost = require("./Kohost");
+const { RequestError } = require("../Errors");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class MediaFile extends Kohost {
+  /**
+   * @typedef {import("../schemas/MediaFileSchema").MediaFile} MediaFileType
+   * Create a MediaFile instance.
+   * @constructor
+   * @param {MediaFileType} mediaFile - The mediaFile object of type MediaFile.
+   */
+  constructor(mediaFile) {
+    super(mediaFile);
+  }
+
+  createImageVariant(params) {
+    if (this.mimeType != "image/*")
+      throw new RequestError("Only dynamic images can have variants");
+    if (!this.url) throw new RequestError("MediaFile has no url");
+    // convert params to "key=value" pairs
+    const query = Object.keys(params)
+      .map((key) => `${key}=${params[key]}`)
+      .join(",");
+
+    // replace the final /public with the query above
+    return this.url.replace(/\/public$/, `/${query}`);
+  }
+}
+
+Object.defineProperty(MediaFile.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(MediaFile.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(MediaFile, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+module.exports = MediaFile;

package/dist/cjs/Models/MediaSource.js

@@ -0,0 +1,35 @@
+// 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 {
+  /**
+   * @typedef {import("../schemas/MediaSourceSchema").MediaSource} MediaSourceType
+   * Create a MediaSource instance.
+   * @constructor
+   * @param {MediaSourceType} mediaSource - The mediaSource object of type MediaSource.
+   */
+  constructor(mediaSource) {
+    super(mediaSource);
+  }
+}
+
+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/dist/cjs/Models/MotionSensor.js

@@ -0,0 +1,35 @@
+// 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 {
+  /**
+   * @typedef {import("../schemas/MotionSensorSchema").MotionSensor} MotionSensorType
+   * Create a MotionSensor instance.
+   * @constructor
+   * @param {MotionSensorType} motionSensor - The motionSensor object of type MotionSensor.
+   */
+  constructor(motionSensor) {
+    super(motionSensor);
+  }
+}
+
+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/dist/cjs/Models/Notification.js

@@ -0,0 +1,34 @@
+const schemas = require("../utils/schema");
+const schema = require("../schemas/notification.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class Notification extends Kohost {
+  /**
+   * @typedef {import("../schemas/NotificationSchema").Notification} NotificationType
+   * Create a Notification instance.
+   * @constructor
+   * @param {NotificationType} property - The property object of type Notification.
+   */
+  constructor(notification) {
+    super(notification);
+  }
+}
+
+Object.defineProperty(Notification.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(Notification.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(Notification, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+module.exports = Notification;

package/dist/cjs/Models/Order.js

@@ -0,0 +1,97 @@
+const schemas = require("../utils/schema");
+const schema = require("../schemas/order.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class Order extends Kohost {
+  /**
+   * @typedef {import("../schemas/OrderSchema").Order} OrderType
+   * Create a Order instance.
+   * @constructor
+   * @param {OrderType} order - The order object of type Order.
+   */
+  constructor(order) {
+    super(order);
+  }
+
+  getSubTotal() {
+    return this.items.reduce((acc, item) => {
+      const qty = item.quantity || 1;
+      return acc + item.price * qty;
+    }, 0);
+  }
+
+  getTaxTotal() {
+    const taxes = this.taxes;
+    if (!taxes) return 0;
+    return this.items.reduce((acc, item) => {
+      if (!item.taxClass) return acc;
+      const tax = taxes.find((t) => t.class === item.taxClass);
+      if (!tax) return acc;
+      const { rateType, rate } = tax;
+      if (rateType === "percentage") {
+        return acc + item.price * rate;
+      }
+      return acc + rate;
+    }, 0);
+  }
+
+  getDeliveryTotal() {
+    const delivery = this.delivery;
+    if (!delivery) return 0;
+    return this.items.reduce((acc, item) => {
+      if (!item.deliveryClass) return acc;
+      const d = delivery.find((d) => d.class === item.deliveryClass);
+      if (!d) return acc;
+      const { rateType, rate } = d;
+      if (rateType === "percentage") {
+        return acc + item.price * rate;
+      }
+      return acc + rate;
+    }, 0);
+  }
+
+  getFeesTotal() {
+    const fees = this.fees;
+    return fees.reduce((acc, fee) => {
+      return acc + fee.price;
+    }, 0);
+  }
+
+  getTotal() {
+    return (
+      this.getSubTotal() +
+      this.getTaxTotal() +
+      this.getDeliveryTotal() +
+      this.getFeesTotal()
+    );
+  }
+
+  getPaymentsTotal() {
+    return this.payments.reduce((acc, payment) => {
+      return acc + payment.amount;
+    }, 0);
+  }
+
+  getBalance() {
+    return this.getTotal() - this.getPaymentsTotal();
+  }
+}
+
+Object.defineProperty(Order.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(Order.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(Order, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+module.exports = Order;

package/dist/cjs/Models/Organization.js

@@ -0,0 +1,34 @@
+const schemas = require("../utils/schema");
+const schema = require("../schemas/organization.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class Organization extends Kohost {
+  /**
+   * @typedef {import("../schemas/OrganizationSchema").Organization} OrganizationType
+   * Create a Organization instance.
+   * @constructor
+   * @param {OrganizationType} organization - The organization object of type Organization.
+   */
+  constructor(organization) {
+    super(organization);
+  }
+}
+
+Object.defineProperty(Organization.prototype, "schema", {
+  value: schema,
+});
+
+Object.defineProperty(Organization.prototype, "validator", {
+  get: function () {
+    return validator;
+  },
+});
+
+Object.defineProperty(Organization, "validProperties", {
+  value: Object.keys(schema.properties),
+});
+
+module.exports = Organization;

package/dist/cjs/Models/Product.js

@@ -0,0 +1,35 @@
+// 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 {
+  /**
+   * @typedef {import("../schemas/ProductSchema").Product} ProductType
+   * Create a Product instance.
+   * @constructor
+   * @param {ProductType} product - The product object of type Product.
+   */
+  constructor(product) {
+    super(product);
+  }
+}
+
+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/dist/cjs/Models/Property.js

@@ -0,0 +1,34 @@
+const schemas = require("../utils/schema");
+const schema = require("../schemas/property.json");
+const Kohost = require("./Kohost");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class Property extends Kohost {
+  /**
+   * @typedef {import("../schemas/PropertySchema").Property} PropertyType
+   * Create a Property instance.
+   * @constructor
+   * @param {PropertyType} property - The property object of type Property.
+   */
+  constructor(property) {
+    super(property);
+  }
+}
+
+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/dist/cjs/Models/Reservation.js

@@ -0,0 +1,114 @@
+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 {
+  /**
+   * @typedef {import("../schemas/ReservationSchema").Reservation} ReservationType
+   * Create a Reservation instance.
+   * @constructor
+   * @param {ReservationType} reservation - The reservation object of type Reservation.
+   */
+  constructor(reservation) {
+    super(reservation);
+  }
+
+  get peopleCount() {
+    return this.adultCount + this.childCount;
+  }
+
+  get hasPayment() {
+    return this.paymentId?.length > 0;
+  }
+
+  get nights() {
+    const start = new Date(this.checkInDateTime);
+    const end = new Date(this.checkOutDateTime);
+    let nights = Math.round((end - start) / (1000 * 60 * 60 * 24));
+    if (nights <= 0) {
+      nights = 1;
+    }
+    return nights;
+  }
+
+  range(tz) {
+    const start = new Date(this.checkInDateTime);
+    const end = new Date(this.checkOutDateTime);
+
+    // output Dec 19 if same day in timezone
+
+    if (
+      start.getDate() === end.getDate() &&
+      start.getMonth() === end.getMonth() &&
+      start.getFullYear() === end.getFullYear()
+    ) {
+      return `${start.toLocaleString("default", {
+        month: "short",
+        timeZone: tz,
+      })} ${start.toLocaleString("default", {
+        timeZone: tz,
+        day: "numeric",
+      })}`;
+    }
+    // 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/dist/cjs/Models/Room.js

@@ -0,0 +1,218 @@
+// create the Room model
+const schemas = require("../utils/schema");
+const schema = require("../schemas/room.json");
+const deviceSchema = require("../schemas/definitions.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 MediaSource = require("./MediaSource");
+const MotionSensor = require("./MotionSensor");
+
+// other dependencies
+const Scene = require("./Scene");
+
+schemas.add(schema);
+const validator = schemas.compile(schema);
+
+class Room extends Kohost {
+  /**
+   * @typedef {import("../schemas/RoomSchema").Room} RoomType
+   * Create a Room instance.
+   * @constructor
+   * @param {RoomType} room - The room object of type Room.
+   */
+  constructor(room) {
+    const roomData = mapRoomData(room);
+    super(roomData);
+  }
+
+  static getDevicePath(type) {
+    const validTypes = deviceSchema.definitions.type.enum;
+    if (!validTypes.includes(type))
+      throw new Error("Invalid device type:" + type);
+    switch (type) {
+      case "tv":
+      case "dvr":
+      case "appleTv":
+      case "discPlayer":
+      case "mediaPlayer":
+      case "uncontrolledDevice":
+      case "mediaSource":
+        return "mediaSources";
+      case "courtesy":
+        return type;
+      case "switch":
+        return "switches";
+      default:
+        return `${type}s`;
+    }
+  }
+
+  static getDeviceTypeFromPath(path) {
+    const validPaths = [
+      "dimmers",
+      "switches",
+      "thermostats",
+      "locks",
+      "windowCoverings",
+      "courtesy",
+      "cameras",
+      "mediaSources",
+      "motionSensors",
+      "alarms",
+    ];
+    if (!validPaths.includes(path))
+      throw new Error("Invalid device path:" + path);
+    switch (path) {
+      case "courtesy":
+        return path;
+      case "switches":
+        return "switch";
+      default:
+        return path.slice(0, -1);
+    }
+  }
+
+  get hasDimmer() {
+    return this.dimmers?.length > 0;
+  }
+
+  get hasSwitch() {
+    return this.switches?.length > 0;
+  }
+
+  get hasWindowCovering() {
+    return this.windowCoverings?.length > 0;
+  }
+
+  get hasShade() {
+    return this.hasWindowCovering;
+  }
+
+  get hasThermostat() {
+    return this.thermostats?.length > 0;
+  }
+
+  get hasClimate() {
+    return this.hasThermostat;
+  }
+
+  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.mediaSources?.length > 0;
+  }
+
+  get hasLight() {
+    const hasSubTypeLight = this.switches?.some((sw) => {
+      return sw.subType === "light" || sw.subType === "fan";
+    });
+    return this.hasDimmer || hasSubTypeLight;
+  }
+
+  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.mediaSources?.map((source) => {
+    if (source instanceof MediaSource) return source;
+    else return new MediaSource(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;