@kohost/api-client 3.0.0-beta.9 → 3.0.0-beta.90

package/dist/cjs/Models/Kohost.js

@@ -0,0 +1,96 @@
+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/dist/cjs/Models/Lock.js

@@ -0,0 +1,39 @@
+// 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 {
+  /**
+   * @typedef {import("../schemas/LockSchema").Lock} LockType
+   * Create a Lock instance.
+   * @constructor
+   * @param {LockType} lock - The lock object of type Lock.
+   */
+  constructor(lock) {
+    super(lock);
+  }
+}
+
+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/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/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;