@kohost/api-client 3.1.23 → 3.2.0

package/dist/cjs/Models/Policy.js

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

package/dist/cjs/Models/User.js

@@ -5,6 +5,7 @@ const paymentSchema = require("../schemas/payment.json");
 const Entity = require("./Entity");
 const MediaFile = require("./MediaFile");
 const Reservation = require("./Reservation");
+const Policy = require("./Policy");
 const Identification = require("./Identification");
 
 const { nanoid } = require("nanoid/async");
@@ -23,12 +24,26 @@ class User extends Entity {
    */
   constructor(user) {
     if (user.photo) user.photo = new MediaFile(user.photo);
-    if (user.reservations)
+    if (user.reservations) {
       user.reservations = user.reservations.map((res) => new Reservation(res));
-    if (user.identifications)
+    }
+
+    if (user.identifications) {
       user.identifications = user.identifications.map(
         (id) => new Identification(id)
       );
+    }
+
+    if (user.permissions) {
+      user.permissions = user.permissions.map((permission) => {
+        if (permission.policies && Array.isArray(permission.policies)) {
+          permission.policies = permission.policies.map(
+            (policy) => new Policy(policy)
+          );
+        }
+        return permission;
+      });
+    }
 
     super(user);
   }

package/dist/cjs/Models/index.js

@@ -7,6 +7,7 @@ const Lock = require("./Lock");
 const Thermostat = require("./Thermostat");
 const WindowCovering = require("./WindowCovering");
 const Identification = require("./Identification");
+const Policy = require("./Policy");
 const User = require("./User");
 const SystemUser = require("./SystemUser");
 const Courtesy = require("./Courtesy");
@@ -14,10 +15,8 @@ const Camera = require("./Camera");
 const MotionSensor = require("./MotionSensor");
 const MediaSource = require("./MediaSource");
 const Room = require("./Room");
-
 const Space = require("./Space");
 const Category = require("./Category");
-
 const Ticket = require("./Ticket");
 const Scene = require("./Scene");
 const Gateway = require("./Gateway");
@@ -76,4 +75,5 @@ module.exports = {
   Order,
   Announcement,
   TimeSheet,
+  Policy,
 };

package/dist/cjs/SocketIoClient/index.js

@@ -81,6 +81,10 @@ module.exports = class SocketIoClient extends EventEmitter {
     this.socket.off(event, callback);
   }
 
+  getSubscriptions(event) {
+    return this.socket.listeners(event);
+  }
+
   send(event, { data = {}, query = {}, ...rest }) {
     this.socket.emit(event, { data, query, ...rest });
   }

package/dist/cjs/index.js

@@ -17,7 +17,7 @@ const Kohost = {
   SocketIoClient,
   AMQPClient,
   defs,
-  utils: utils,
+  utils,
 };
 
 module.exports = Kohost;

package/dist/cjs/schemas/AnnouncementSchema.d.ts

@@ -34,7 +34,7 @@ export interface Announcement {
  */
 export interface MediaFile {
   id?: string;
-  type: string;
+  type: "mediaFile";
   name?: string;
   fileHash?: string;
   /**

package/dist/cjs/schemas/CategorySchema.d.ts

@@ -59,7 +59,7 @@ export interface Category {
  */
 export interface MediaFile {
   id?: string;
-  type: string;
+  type: "mediaFile";
   name?: string;
   fileHash?: string;
   /**

package/dist/cjs/schemas/CredentialSchema.d.ts

@@ -42,9 +42,9 @@ export interface Credential {
     | "insperia-privacy";
   discriminator?: "verificationCode" | "token" | "mobileKey" | "pin" | "publicKey" | "passkeyChallenge";
   credential: string;
-  user?: string;
-  organization?: string;
-  property?: string;
+  userId?: string;
+  organizationId?: string;
+  propertyId?: string;
   deviceId?: string;
   userAgent?: string;
   expires:

package/dist/cjs/schemas/DeviceRouterSchema.d.ts

@@ -10,7 +10,7 @@
  */
 export interface DeviceRouter {
   id?: string;
-  type?: string;
+  type?: "deviceRouter";
   driver: string;
   /**
    * Reference (id) to the organization that owns this router

package/dist/cjs/schemas/EmailMessageSchema.d.ts

@@ -13,7 +13,7 @@ export type Date =
 
 export interface EmailMessage {
   id?: string;
-  type?: string;
+  type?: "emailMessage";
   to: string;
   /**
    * Must be in the format of 'Sender <email@example.com>

package/dist/cjs/schemas/MediaFileSchema.d.ts

@@ -16,7 +16,7 @@ export type Date =
  */
 export interface MediaFile {
   id?: string;
-  type: string;
+  type: "mediaFile";
   name?: string;
   fileHash?: string;
   /**

package/dist/cjs/schemas/MediaSourceSchema.d.ts

@@ -96,7 +96,7 @@ export type Notification = {
  */
 export interface MediaSource {
   id: string;
-  type: string;
+  type: "mediaSource";
   discriminator: "tv" | "dvr" | "appleTv" | "discPlayer" | "mediaPlayer" | "paSystem" | "uncontrolledDevice";
   playlists?: {
     id?: string;
@@ -168,10 +168,15 @@ export interface MediaSource {
         | "display"
         | "favoriteChannel"
         | "play"
+        | "playing"
         | "stop"
+        | "stopped"
         | "pause"
+        | "paused"
         | "fastForward"
+        | "fastForwarding"
         | "rewind"
+        | "rewinding"
         | "instantReplay"
         | "record"
         | "ac3"

package/dist/cjs/schemas/OrderSchema.d.ts

@@ -16,7 +16,7 @@ export type Date =
  */
 export interface Order {
   id?: string;
-  type: string;
+  type: "order";
   orderNumber?: string;
   status:
     | "draft"
@@ -30,7 +30,11 @@ export interface Order {
   /**
    * User id of purchaser
    */
-  user?: string;
+  userId?: string;
+  /**
+   * Reservation id if the order is for a reservation
+   */
+  reservationId?: string;
   date?: Date;
   items?: {
     additionalProperties?: never;
@@ -40,6 +44,7 @@ export interface Order {
     price: number;
     taxClass?: string;
     deliveryClass?: string;
+    productId?: string;
     [k: string]: unknown;
   }[];
   taxes?: {

package/dist/cjs/schemas/OrganizationSchema.d.ts

@@ -21,7 +21,7 @@ export type UpdatedAt =
  */
 export interface Organization {
   id?: string;
-  type?: string;
+  type?: "organization";
   accountNumber: number | null;
   name: string;
   properties?: string[];

package/dist/cjs/schemas/PolicySchema.d.ts

@@ -0,0 +1,25 @@
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * A policy is a set of permissions that can be applied to a user to limit their access to resources.
+ */
+export interface Policy {
+  id?: string;
+  type: "policy";
+  discriminator: "user";
+  name: string;
+  description?: string;
+  organizationId: string;
+  propertyId: string;
+  permissions: {
+    entities: string[];
+    effect: "Allow" | "Deny";
+    [k: string]: unknown;
+  }[];
+  [k: string]: unknown;
+}

package/dist/cjs/schemas/ProductSchema.d.ts

@@ -13,7 +13,7 @@ export type Date =
 
 export interface Product {
   id?: string;
-  type?: string;
+  type?: "product";
   name: string;
   driver:
     | "aws-kinesis"
@@ -64,7 +64,7 @@ export interface Product {
  */
 export interface MediaFile {
   id?: string;
-  type: string;
+  type: "mediaFile";
   name?: string;
   fileHash?: string;
   /**

package/dist/cjs/schemas/PropertySchema.d.ts

@@ -11,7 +11,7 @@
 export interface Property {
   id: string;
   name: string;
-  type: string;
+  type: "property";
   discriminator?: "hospitality" | "education" | "commercial";
   /**
    * Reference (id) to the organization that owns this property
@@ -71,7 +71,7 @@ export interface Property {
       };
       roomUpgrades?: unknown;
       pet?: unknown;
-      promo?: unknown;
+      promos?: unknown;
       [k: string]: unknown;
     };
     CheckOut?: {

package/dist/cjs/schemas/ReservationSchema.d.ts

@@ -54,7 +54,7 @@ export interface Reservation {
     | "cloudflare-stream"
     | "insperia-privacy";
   primaryGuest?: string;
-  type: string;
+  type: "reservation";
   sharedGuests?: string[];
   spaceCategory?: string;
   space?: string | null;

package/dist/cjs/schemas/RoomSchema.d.ts

@@ -106,6 +106,7 @@ export type UpdatedAt =
  */
 export interface Room {
   id?: string;
+  type?: "room";
   name?: string;
   floor?: string;
   dimmers?: Dimmer[];
@@ -788,7 +789,7 @@ export interface Camera {
  */
 export interface MediaSource {
   id: string;
-  type: string;
+  type: "mediaSource";
   discriminator: "tv" | "dvr" | "appleTv" | "discPlayer" | "mediaPlayer" | "paSystem" | "uncontrolledDevice";
   playlists?: {
     id?: string;
@@ -860,10 +861,15 @@ export interface MediaSource {
         | "display"
         | "favoriteChannel"
         | "play"
+        | "playing"
         | "stop"
+        | "stopped"
         | "pause"
+        | "paused"
         | "fastForward"
+        | "fastForwarding"
         | "rewind"
+        | "rewinding"
         | "instantReplay"
         | "record"
         | "ac3"

package/dist/cjs/schemas/SceneSchema.d.ts

@@ -12,6 +12,7 @@ export interface Scene {
   id?: string;
   name?: string;
   description?: string;
+  type?: "scene";
   devices?: {
     switches?: {
       id?: string;

package/dist/cjs/schemas/ShortLinkSchema.d.ts

@@ -7,7 +7,7 @@
 
 export interface ShortLink {
   id?: string;
-  type?: string;
+  type?: "shortLink";
   title?: string;
   destination: {
     [k: string]: unknown;

package/dist/cjs/schemas/SmsMessageSchema.d.ts

@@ -13,7 +13,7 @@ export type Date =
 
 export interface SMSMessage {
   id?: string;
-  type?: string;
+  type?: "smsMessage";
   to: string;
   from: string;
   media?: string;

package/dist/cjs/schemas/SpaceSchema.d.ts

@@ -8,7 +8,7 @@
 export interface Space {
   id?: string;
   name?: string;
-  type?: string;
+  type?: "space";
   discriminator?:
     | "classRoom"
     | "hotelRoom"

package/dist/cjs/schemas/SystemUserSchema.d.ts

@@ -42,7 +42,7 @@ export type UpdatedAt =
  */
 export interface SystemUser {
   id?: string;
-  type?: string;
+  type?: "systemUser";
   driver?:
     | "aws-kinesis"
     | "butler"
@@ -84,7 +84,7 @@ export interface SystemUser {
   jobTitle?: string;
   dob?: string;
   gender?: "male" | "female";
-  roles?: ("Guest" | "User" | "Manager" | "Administrator" | "SuperAdmin")[];
+  roles?: ("Guest" | "User" | "Manager" | "Maintenance" | "Administrator" | "SuperAdmin")[];
   nationality?: string;
   notes?: string[];
   files?: MediaFile[];
@@ -112,7 +112,7 @@ export interface Address {
  */
 export interface MediaFile {
   id?: string;
-  type: string;
+  type: "mediaFile";
   name?: string;
   fileHash?: string;
   /**

package/dist/cjs/schemas/TicketSchema.d.ts

@@ -50,6 +50,7 @@ export interface Ticket {
     [k: string]: unknown;
   };
   status: "open" | "pending" | "solved" | "closed";
+  priority?: "low" | "normal" | "high";
   tags: string[];
   rating?: number;
   ratingComment?: string;
@@ -65,7 +66,7 @@ export interface Ticket {
  */
 export interface MediaFile {
   id?: string;
-  type: string;
+  type: "mediaFile";
   name?: string;
   fileHash?: string;
   /**

package/dist/cjs/schemas/TimeSheetSchema.d.ts

@@ -20,7 +20,7 @@ export interface TimeSheet {
   locked?: boolean;
   timeEntries?: {
     id?: string;
-    discriminator: "working" | "driving" | "meeting";
+    discriminator: "working" | "driving" | "meeting" | "break";
     start:
       | string
       | {

package/dist/cjs/schemas/UserSchema.d.ts

@@ -57,18 +57,14 @@ export interface User {
     /**
      * The ID of the organization the permission is applies to.
      */
-    organization: string;
+    organizationId: string;
     /**
      * The ID of the property the permission is applies to.
      */
-    property: string;
-    role: "Guest" | "User" | "Manager" | "Administrator" | "SuperAdmin";
-    customPermissions?: {
-      discriminator?: "RoomControl.spaces" | "Concierge.timeTracking";
-      onlyIncludeIds?: string[];
-      excludeSubSystems?: string[];
-      [k: string]: unknown;
-    }[];
+    propertyId: string;
+    role: "Guest" | "User" | "Manager" | "Maintenance" | "Administrator" | "SuperAdmin";
+    policyIds?: string[];
+    policies?: Policy[];
   }[];
   notes?: string[];
   files?: MediaFile[];
@@ -87,7 +83,7 @@ export interface User {
   updatedAt?: UpdatedAt;
   systems?: {
     systemId: string;
-    property: string;
+    propertyId: string;
     driver: string;
   }[];
   [k: string]: unknown;
@@ -108,7 +104,7 @@ export interface Address {
  */
 export interface MediaFile {
   id?: string;
-  type: string;
+  type: "mediaFile";
   name?: string;
   fileHash?: string;
   /**
@@ -137,6 +133,24 @@ export interface MediaFile {
   createdBy?: string;
   systemId?: string;
 }
+/**
+ * A policy object populated from the policyIds array.
+ */
+export interface Policy {
+  id?: string;
+  type: "policy";
+  discriminator: "user";
+  name: string;
+  description?: string;
+  organizationId: string;
+  propertyId: string;
+  permissions: {
+    entities: string[];
+    effect: "Allow" | "Deny";
+    [k: string]: unknown;
+  }[];
+  [k: string]: unknown;
+}
 export interface Identification1 {
   id?: string;
   type: "driversLicense" | "passport" | "identityCard" | "visa";
@@ -231,7 +245,7 @@ export interface Reservation {
     | "cloudflare-stream"
     | "insperia-privacy";
   primaryGuest?: string;
-  type: string;
+  type: "reservation";
   sharedGuests?: string[];
   spaceCategory?: string;
   space?: string | null;

package/dist/cjs/schemas/camera.json

@@ -12,7 +12,8 @@
       "type": "string"
     },
     "type": {
-      "$ref": "definitions.json#/definitions/type"
+      "$ref": "definitions.json#/definitions/type",
+      "default": "camera"
     },
     "supportedNotifications": {
       "$ref": "definitions.json#/definitions/supportedNotifications"

package/dist/cjs/schemas/credential.json

@@ -29,13 +29,13 @@
     "credential": {
       "type": "string"
     },
-    "user": {
+    "userId": {
       "type": "string"
     },
-    "organization": {
+    "organizationId": {
       "type": "string"
     },
-    "property": {
+    "propertyId": {
       "type": "string"
     },
     "deviceId": {

package/dist/cjs/schemas/deviceRouter.json

@@ -11,7 +11,8 @@
     },
     "type": {
       "type": "string",
-      "default": "deviceRouter"
+      "default": "deviceRouter",
+      "enum": ["deviceRouter"]
     },
     "driver": {
       "type": "string"

package/dist/cjs/schemas/emailMessage.json

@@ -10,7 +10,8 @@
     },
     "type": {
       "type": "string",
-      "default": "emailMessage"
+      "default": "emailMessage",
+      "enum": ["emailMessage"]
     },
     "to": {
       "type": "string",

package/dist/cjs/schemas/mediaFile.json

@@ -10,7 +10,8 @@
     },
     "type": {
       "type": "string",
-      "default": "mediaFile"
+      "default": "mediaFile",
+      "enum": ["mediaFile"]
     },
     "name": {
       "type": "string"

package/dist/cjs/schemas/mediaSource.json

@@ -11,7 +11,8 @@
     },
     "type": {
       "type": "string",
-      "default": "mediaSource"
+      "default": "mediaSource",
+      "enum": ["mediaSource"]
     },
     "discriminator": {
       "type": "string",
@@ -107,10 +108,15 @@
         "display",
         "favoriteChannel",
         "play",
+        "playing",
         "stop",
+        "stopped",
         "pause",
+        "paused",
         "fastForward",
+        "fastForwarding",
         "rewind",
+        "rewinding",
         "instantReplay",
         "record",
         "ac3",

package/dist/cjs/schemas/order.json

@@ -11,7 +11,8 @@
     },
     "type": {
       "type": "string",
-      "default": "order"
+      "default": "order",
+      "enum": ["order"]
     },
     "orderNumber": {
       "type": "string"
@@ -29,10 +30,14 @@
         "refunded"
       ]
     },
-    "user": {
+    "userId": {
       "$ref": "definitions.json#/definitions/id",
       "description": "User id of purchaser"
     },
+    "reservationId": {
+      "$ref": "definitions.json#/definitions/id",
+      "description": "Reservation id if the order is for a reservation"
+    },
     "date": {
       "$ref": "definitions.json#/definitions/date"
     },
@@ -62,6 +67,9 @@
           },
           "deliveryClass": {
             "type": "string"
+          },
+          "productId": {
+            "type": "string"
           }
         }
       }

package/dist/cjs/schemas/organization.json

@@ -11,7 +11,8 @@
     },
     "type": {
       "type": "string",
-      "default": "organization"
+      "default": "organization",
+      "enum": ["organization"]
     },
     "accountNumber": {
       "type": ["number", "null"],