@awarevue/api-types 1.0.108 → 1.0.109

package/dist/device/door.d.ts

@@ -1,23 +1,108 @@
 import { z } from 'zod';
 export declare const DOOR: "door";
-export declare const sDoorSpecs: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+export declare const sDoorSpecs: z.ZodObject<{
+    canReportOpenState: z.ZodBoolean;
+    canReportLockState: z.ZodBoolean;
+    canControlLock: z.ZodBoolean;
+    canRelease: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    canReportOpenState: boolean;
+    canReportLockState: boolean;
+    canControlLock: boolean;
+    canRelease: boolean;
+}, {
+    canReportOpenState: boolean;
+    canReportLockState: boolean;
+    canControlLock: boolean;
+    canRelease: boolean;
+}>;
 export type DoorSpecs = z.infer<typeof sDoorSpecs>;
-export interface DoorUnlockCommand {
-    command: 'door.unlock';
-    params: object;
-}
-export interface DoorLockCommand {
-    command: 'door.lock';
-    params: object;
-}
-export interface DoorReleaseCommand {
-    command: 'door.release';
-    params: object;
-}
-export interface DoorAlarmAckCommand {
-    command: 'door.alarm-ack';
-    params: object;
-}
+export declare const sDoorUnlockCommand: z.ZodObject<{
+    command: z.ZodLiteral<"door.unlock">;
+    params: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+}, "strip", z.ZodTypeAny, {
+    params: {};
+    command: "door.unlock";
+}, {
+    params: {};
+    command: "door.unlock";
+}>;
+export type DoorUnlockCommand = z.infer<typeof sDoorUnlockCommand>;
+export declare const sDoorLockCommand: z.ZodObject<{
+    command: z.ZodLiteral<"door.lock">;
+    params: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+}, "strip", z.ZodTypeAny, {
+    params: {};
+    command: "door.lock";
+}, {
+    params: {};
+    command: "door.lock";
+}>;
+export type DoorLockCommand = z.infer<typeof sDoorLockCommand>;
+export declare const sDoorReleaseCommand: z.ZodObject<{
+    command: z.ZodLiteral<"door.release">;
+    params: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+}, "strip", z.ZodTypeAny, {
+    params: {};
+    command: "door.release";
+}, {
+    params: {};
+    command: "door.release";
+}>;
+export type DoorReleaseCommand = z.infer<typeof sDoorReleaseCommand>;
+export declare const sDoorAlarmAckCommand: z.ZodObject<{
+    command: z.ZodLiteral<"door.alarm-ack">;
+    params: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+}, "strip", z.ZodTypeAny, {
+    params: {};
+    command: "door.alarm-ack";
+}, {
+    params: {};
+    command: "door.alarm-ack";
+}>;
+export type DoorAlarmAckCommand = z.infer<typeof sDoorAlarmAckCommand>;
+export declare const doorCommands: {
+    readonly 'door.unlock': z.ZodObject<{
+        command: z.ZodLiteral<"door.unlock">;
+        params: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+    }, "strip", z.ZodTypeAny, {
+        params: {};
+        command: "door.unlock";
+    }, {
+        params: {};
+        command: "door.unlock";
+    }>;
+    readonly 'door.lock': z.ZodObject<{
+        command: z.ZodLiteral<"door.lock">;
+        params: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+    }, "strip", z.ZodTypeAny, {
+        params: {};
+        command: "door.lock";
+    }, {
+        params: {};
+        command: "door.lock";
+    }>;
+    readonly 'door.release': z.ZodObject<{
+        command: z.ZodLiteral<"door.release">;
+        params: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+    }, "strip", z.ZodTypeAny, {
+        params: {};
+        command: "door.release";
+    }, {
+        params: {};
+        command: "door.release";
+    }>;
+    readonly 'door.alarm-ack': z.ZodObject<{
+        command: z.ZodLiteral<"door.alarm-ack">;
+        params: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+    }, "strip", z.ZodTypeAny, {
+        params: {};
+        command: "door.alarm-ack";
+    }, {
+        params: {};
+        command: "door.alarm-ack";
+    }>;
+};
 export type DoorCommand = DoorUnlockCommand | DoorLockCommand | DoorReleaseCommand | DoorAlarmAckCommand;
 export interface DoorStateDto {
     locked: boolean;

package/dist/device/door.js

@@ -1,11 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.doorEventSchemaByKind = exports.sDoorTamperRestoredEvent = exports.sDoorAcuOnlineEvent = exports.sDoorMainsRestoredEvent = exports.sDoorAcuNotRespondingEvent = exports.sDoorMainsFailedEvent = exports.sDoorRelockEvent = exports.sDoorLeftOpenEvent = exports.sDoorTamperEvent = exports.sDoorForceEvent = exports.sDoorClosed = exports.sDoorOpened = exports.sDoorAccessEvent = exports.sDoorSpecs = exports.DOOR = void 0;
+exports.doorEventSchemaByKind = exports.sDoorTamperRestoredEvent = exports.sDoorAcuOnlineEvent = exports.sDoorMainsRestoredEvent = exports.sDoorAcuNotRespondingEvent = exports.sDoorMainsFailedEvent = exports.sDoorRelockEvent = exports.sDoorLeftOpenEvent = exports.sDoorTamperEvent = exports.sDoorForceEvent = exports.sDoorClosed = exports.sDoorOpened = exports.sDoorAccessEvent = exports.doorCommands = exports.sDoorAlarmAckCommand = exports.sDoorReleaseCommand = exports.sDoorLockCommand = exports.sDoorUnlockCommand = exports.sDoorSpecs = exports.DOOR = void 0;
 const access_control_1 = require("../access-control");
 const zod_1 = require("zod");
 exports.DOOR = 'door';
 // SPECS
-exports.sDoorSpecs = zod_1.z.object({});
+exports.sDoorSpecs = zod_1.z.object({
+    canReportOpenState: zod_1.z.boolean(),
+    canReportLockState: zod_1.z.boolean(),
+    canControlLock: zod_1.z.boolean(),
+    canRelease: zod_1.z.boolean(),
+});
+// COMMANDS
+exports.sDoorUnlockCommand = zod_1.z.object({
+    command: zod_1.z.literal('door.unlock'),
+    params: zod_1.z.object({}),
+});
+exports.sDoorLockCommand = zod_1.z.object({
+    command: zod_1.z.literal('door.lock'),
+    params: zod_1.z.object({}),
+});
+exports.sDoorReleaseCommand = zod_1.z.object({
+    command: zod_1.z.literal('door.release'),
+    params: zod_1.z.object({}),
+});
+exports.sDoorAlarmAckCommand = zod_1.z.object({
+    command: zod_1.z.literal('door.alarm-ack'),
+    params: zod_1.z.object({}),
+});
+exports.doorCommands = {
+    'door.unlock': exports.sDoorUnlockCommand,
+    'door.lock': exports.sDoorLockCommand,
+    'door.release': exports.sDoorReleaseCommand,
+    'door.alarm-ack': exports.sDoorAlarmAckCommand,
+};
 // EVENTS
 exports.sDoorAccessEvent = zod_1.z.object({
     kind: zod_1.z.literal('door-access'),

package/dist/device/intercom-terminal.d.ts

@@ -112,14 +112,14 @@ export declare const sIntercomTerminalState: z.ZodObject<{
     peer: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     connected: boolean;
+    callState: "connected" | "connecting" | "ringing" | "terminated" | null;
     callId: string | null;
     peer: string | null;
-    callState: "connected" | "connecting" | "ringing" | "terminated" | null;
 }, {
     connected: boolean;
+    callState: "connected" | "connecting" | "ringing" | "terminated" | null;
     callId: string | null;
     peer: string | null;
-    callState: "connected" | "connecting" | "ringing" | "terminated" | null;
 }>;
 export type IntercomTerminalStateDto = z.infer<typeof sIntercomTerminalState>;
 export declare const sCallStateChanged: z.ZodObject<{

package/dist/device/io-board.d.ts

@@ -11,13 +11,59 @@ export declare const sIoBoardSpecs: z.ZodObject<{
     outputs: string[];
 }>;
 export type IoBoardSpecs = z.infer<typeof sIoBoardSpecs>;
-export interface IoBoardSetOutputCommand {
-    command: 'io-board.set-output';
+export declare const sIoBoardSetOutputCommand: z.ZodObject<{
+    command: z.ZodLiteral<"io-board.set-output">;
+    params: z.ZodObject<{
+        output: z.ZodString;
+        value: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        value: boolean;
+        output: string;
+    }, {
+        value: boolean;
+        output: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
     params: {
+        value: boolean;
         output: string;
+    };
+    command: "io-board.set-output";
+}, {
+    params: {
         value: boolean;
+        output: string;
     };
-}
+    command: "io-board.set-output";
+}>;
+export declare const ioBoardCommands: {
+    readonly 'io-board.set-output': z.ZodObject<{
+        command: z.ZodLiteral<"io-board.set-output">;
+        params: z.ZodObject<{
+            output: z.ZodString;
+            value: z.ZodBoolean;
+        }, "strip", z.ZodTypeAny, {
+            value: boolean;
+            output: string;
+        }, {
+            value: boolean;
+            output: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        params: {
+            value: boolean;
+            output: string;
+        };
+        command: "io-board.set-output";
+    }, {
+        params: {
+            value: boolean;
+            output: string;
+        };
+        command: "io-board.set-output";
+    }>;
+};
+export type IoBoardSetOutputCommand = z.infer<typeof sIoBoardSetOutputCommand>;
 export type IoBoardCommand = IoBoardSetOutputCommand;
 export interface IoBoardStateDto {
     connected: boolean;

package/dist/device/io-board.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ioBoardEventSchemaByKind = exports.sIoBoardInputChangedEvent = exports.sIoBoardSpecs = exports.IO_BOARD = void 0;
+exports.ioBoardEventSchemaByKind = exports.sIoBoardInputChangedEvent = exports.ioBoardCommands = exports.sIoBoardSetOutputCommand = exports.sIoBoardSpecs = exports.IO_BOARD = void 0;
 const zod_1 = require("zod");
 exports.IO_BOARD = 'io-board';
 // SPECS
@@ -8,6 +8,17 @@ exports.sIoBoardSpecs = zod_1.z.object({
     inputs: zod_1.z.array(zod_1.z.string().nonempty()),
     outputs: zod_1.z.array(zod_1.z.string().nonempty()),
 });
+// COMMANDS
+exports.sIoBoardSetOutputCommand = zod_1.z.object({
+    command: zod_1.z.literal('io-board.set-output'),
+    params: zod_1.z.object({
+        output: zod_1.z.string().nonempty(),
+        value: zod_1.z.boolean(),
+    }),
+});
+exports.ioBoardCommands = {
+    'io-board.set-output': exports.sIoBoardSetOutputCommand,
+};
 // EVENTS
 exports.sIoBoardInputChangedEvent = zod_1.z.object({
     kind: zod_1.z.literal('io-board-input-changed'),

package/dist/device/pbx.d.ts

@@ -8,13 +8,77 @@ export declare const sPbxSpecs: z.ZodObject<{
     sipWsUrl: string;
 }>;
 export type PbxSpecs = z.infer<typeof sPbxSpecs>;
-export interface PbxCallCommand {
-    command: 'pbx.call';
+export declare const sPbxCallCommand: z.ZodObject<{
+    command: z.ZodLiteral<"pbx.call">;
+    params: z.ZodObject<{
+        endpoint: z.ZodString;
+        soundFile: z.ZodString;
+        context: z.ZodOptional<z.ZodString>;
+        callerId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        endpoint: string;
+        soundFile: string;
+        context?: string | undefined;
+        callerId?: string | undefined;
+    }, {
+        endpoint: string;
+        soundFile: string;
+        context?: string | undefined;
+        callerId?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
     params: {
         endpoint: string;
         soundFile: string;
-        context?: string;
-        callerId?: string;
+        context?: string | undefined;
+        callerId?: string | undefined;
     };
-}
+    command: "pbx.call";
+}, {
+    params: {
+        endpoint: string;
+        soundFile: string;
+        context?: string | undefined;
+        callerId?: string | undefined;
+    };
+    command: "pbx.call";
+}>;
+export declare const pbxCommands: {
+    readonly 'pbx.call': z.ZodObject<{
+        command: z.ZodLiteral<"pbx.call">;
+        params: z.ZodObject<{
+            endpoint: z.ZodString;
+            soundFile: z.ZodString;
+            context: z.ZodOptional<z.ZodString>;
+            callerId: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            endpoint: string;
+            soundFile: string;
+            context?: string | undefined;
+            callerId?: string | undefined;
+        }, {
+            endpoint: string;
+            soundFile: string;
+            context?: string | undefined;
+            callerId?: string | undefined;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        params: {
+            endpoint: string;
+            soundFile: string;
+            context?: string | undefined;
+            callerId?: string | undefined;
+        };
+        command: "pbx.call";
+    }, {
+        params: {
+            endpoint: string;
+            soundFile: string;
+            context?: string | undefined;
+            callerId?: string | undefined;
+        };
+        command: "pbx.call";
+    }>;
+};
+export type PbxCallCommand = z.infer<typeof sPbxCallCommand>;
 export type PbxCommand = PbxCallCommand;

package/dist/device/pbx.js

@@ -1,11 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sPbxSpecs = exports.PBX = void 0;
+exports.pbxCommands = exports.sPbxCallCommand = exports.sPbxSpecs = exports.PBX = void 0;
 const zod_1 = require("zod");
 exports.PBX = 'pbx';
 // SPECS
 exports.sPbxSpecs = zod_1.z.object({
     sipWsUrl: zod_1.z.string(),
 });
+// COMMANDS
+exports.sPbxCallCommand = zod_1.z.object({
+    command: zod_1.z.literal('pbx.call'),
+    params: zod_1.z.object({
+        endpoint: zod_1.z.string().nonempty(),
+        soundFile: zod_1.z.string().nonempty(),
+        context: zod_1.z.string().optional(),
+        callerId: zod_1.z.string().optional(),
+    }),
+});
+exports.pbxCommands = {
+    'pbx.call': exports.sPbxCallCommand,
+};
 // STATE
 // EVENTS

package/dist/device/presence-tracker.d.ts

@@ -3,28 +3,171 @@ export declare const PRESENCE_TRACKER = "presence-tracker";
 export interface PresenceTrackerState {
     zonePeople: Record<string, string[]>;
 }
-export interface CheckInPerson {
-    command: 'presence-tracker.check-in';
+export declare const sCheckInPersonCommand: z.ZodObject<{
+    command: z.ZodLiteral<"presence-tracker.check-in">;
+    params: z.ZodObject<{
+        personId: z.ZodString;
+        zoneId: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        personId: string;
+        zoneId: string | null;
+    }, {
+        personId: string;
+        zoneId: string | null;
+    }>;
+}, "strip", z.ZodTypeAny, {
     params: {
         personId: string;
         zoneId: string | null;
     };
-}
-export interface CheckOutPerson {
-    command: 'presence-tracker.check-out';
+    command: "presence-tracker.check-in";
+}, {
+    params: {
+        personId: string;
+        zoneId: string | null;
+    };
+    command: "presence-tracker.check-in";
+}>;
+export type CheckInPerson = z.infer<typeof sCheckInPersonCommand>;
+export declare const sCheckOutPersonCommand: z.ZodObject<{
+    command: z.ZodLiteral<"presence-tracker.check-out">;
+    params: z.ZodObject<{
+        personId: z.ZodString;
+        zoneId: z.ZodNullable<z.ZodString>;
+        leave: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        personId: string;
+        zoneId: string | null;
+        leave: boolean;
+    }, {
+        personId: string;
+        zoneId: string | null;
+        leave: boolean;
+    }>;
+}, "strip", z.ZodTypeAny, {
     params: {
         personId: string;
         zoneId: string | null;
         leave: boolean;
     };
-}
-export interface TogglePresence {
-    command: 'presence-tracker.toggle-presence';
+    command: "presence-tracker.check-out";
+}, {
     params: {
         personId: string;
         zoneId: string | null;
+        leave: boolean;
     };
-}
+    command: "presence-tracker.check-out";
+}>;
+export type CheckOutPerson = z.infer<typeof sCheckOutPersonCommand>;
+export declare const sTogglePresenceCommand: z.ZodObject<{
+    command: z.ZodLiteral<"presence-tracker.toggle-presence">;
+    params: z.ZodObject<{
+        personId: z.ZodString;
+        zoneId: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        personId: string;
+        zoneId: string | null;
+    }, {
+        personId: string;
+        zoneId: string | null;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    params: {
+        personId: string;
+        zoneId: string | null;
+    };
+    command: "presence-tracker.toggle-presence";
+}, {
+    params: {
+        personId: string;
+        zoneId: string | null;
+    };
+    command: "presence-tracker.toggle-presence";
+}>;
+export type TogglePresence = z.infer<typeof sTogglePresenceCommand>;
+export declare const presenceTrackerCommands: {
+    readonly 'presence-tracker.check-in': z.ZodObject<{
+        command: z.ZodLiteral<"presence-tracker.check-in">;
+        params: z.ZodObject<{
+            personId: z.ZodString;
+            zoneId: z.ZodNullable<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            personId: string;
+            zoneId: string | null;
+        }, {
+            personId: string;
+            zoneId: string | null;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        params: {
+            personId: string;
+            zoneId: string | null;
+        };
+        command: "presence-tracker.check-in";
+    }, {
+        params: {
+            personId: string;
+            zoneId: string | null;
+        };
+        command: "presence-tracker.check-in";
+    }>;
+    readonly 'presence-tracker.check-out': z.ZodObject<{
+        command: z.ZodLiteral<"presence-tracker.check-out">;
+        params: z.ZodObject<{
+            personId: z.ZodString;
+            zoneId: z.ZodNullable<z.ZodString>;
+            leave: z.ZodBoolean;
+        }, "strip", z.ZodTypeAny, {
+            personId: string;
+            zoneId: string | null;
+            leave: boolean;
+        }, {
+            personId: string;
+            zoneId: string | null;
+            leave: boolean;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        params: {
+            personId: string;
+            zoneId: string | null;
+            leave: boolean;
+        };
+        command: "presence-tracker.check-out";
+    }, {
+        params: {
+            personId: string;
+            zoneId: string | null;
+            leave: boolean;
+        };
+        command: "presence-tracker.check-out";
+    }>;
+    readonly 'presence-tracker.toggle-presence': z.ZodObject<{
+        command: z.ZodLiteral<"presence-tracker.toggle-presence">;
+        params: z.ZodObject<{
+            personId: z.ZodString;
+            zoneId: z.ZodNullable<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            personId: string;
+            zoneId: string | null;
+        }, {
+            personId: string;
+            zoneId: string | null;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        params: {
+            personId: string;
+            zoneId: string | null;
+        };
+        command: "presence-tracker.toggle-presence";
+    }, {
+        params: {
+            personId: string;
+            zoneId: string | null;
+        };
+        command: "presence-tracker.toggle-presence";
+    }>;
+};
 export type PresenceTrackerCommand = CheckInPerson | CheckOutPerson | TogglePresence;
 export declare const sPersonIn: z.ZodObject<{
     kind: z.ZodLiteral<"person-in">;
@@ -36,17 +179,17 @@ export declare const sPersonIn: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     kind: "person-in";
     personId: string;
+    zoneId: string | null;
     personFirstName: string;
     personLastName: string;
     personAvatarId: string | null;
-    zoneId: string | null;
 }, {
     kind: "person-in";
     personId: string;
+    zoneId: string | null;
     personFirstName: string;
     personLastName: string;
     personAvatarId: string | null;
-    zoneId: string | null;
 }>;
 export declare const sPersonOut: z.ZodObject<{
     kind: z.ZodLiteral<"person-out">;
@@ -59,19 +202,19 @@ export declare const sPersonOut: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     kind: "person-out";
     personId: string;
+    isLeave: boolean;
+    zoneId: string | null;
     personFirstName: string;
     personLastName: string;
     personAvatarId: string | null;
-    zoneId: string | null;
-    isLeave: boolean;
 }, {
     kind: "person-out";
     personId: string;
+    isLeave: boolean;
+    zoneId: string | null;
     personFirstName: string;
     personLastName: string;
     personAvatarId: string | null;
-    zoneId: string | null;
-    isLeave: boolean;
 }>;
 export declare const presenceTrackerEventSchemaByKind: {
     readonly 'person-in': z.ZodObject<{
@@ -84,17 +227,17 @@ export declare const presenceTrackerEventSchemaByKind: {
     }, "strip", z.ZodTypeAny, {
         kind: "person-in";
         personId: string;
+        zoneId: string | null;
         personFirstName: string;
         personLastName: string;
         personAvatarId: string | null;
-        zoneId: string | null;
     }, {
         kind: "person-in";
         personId: string;
+        zoneId: string | null;
         personFirstName: string;
         personLastName: string;
         personAvatarId: string | null;
-        zoneId: string | null;
     }>;
     readonly 'person-out': z.ZodObject<{
         kind: z.ZodLiteral<"person-out">;
@@ -107,19 +250,19 @@ export declare const presenceTrackerEventSchemaByKind: {
     }, "strip", z.ZodTypeAny, {
         kind: "person-out";
         personId: string;
+        isLeave: boolean;
+        zoneId: string | null;
         personFirstName: string;
         personLastName: string;
         personAvatarId: string | null;
-        zoneId: string | null;
-        isLeave: boolean;
     }, {
         kind: "person-out";
         personId: string;
+        isLeave: boolean;
+        zoneId: string | null;
         personFirstName: string;
         personLastName: string;
         personAvatarId: string | null;
-        zoneId: string | null;
-        isLeave: boolean;
     }>;
 };
 export type PersonIn = z.infer<typeof sPersonIn>;