@awarevue/api-types 1.0.108 → 1.0.109

package/dist/device-command.js

@@ -1,6 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.commandDescriptions = void 0;
+exports.commandDescriptions = exports.commandSchemas = void 0;
+const alarm_1 = require("./device/alarm");
+const camera_1 = require("./device/camera");
+const camera_lift_1 = require("./device/camera-lift");
+const display_1 = require("./device/display");
+const door_1 = require("./device/door");
+const io_board_1 = require("./device/io-board");
+const pbx_1 = require("./device/pbx");
+const presence_tracker_1 = require("./device/presence-tracker");
+exports.commandSchemas = {
+    ...alarm_1.alarmCommandSchemas,
+    ...camera_1.cameraCommands,
+    ...camera_lift_1.cameraLiftCommands,
+    ...door_1.doorCommands,
+    ...io_board_1.ioBoardCommands,
+    ...pbx_1.pbxCommands,
+    ...presence_tracker_1.presenceTrackerCommands,
+    ...display_1.displayCommands,
+};
 exports.commandDescriptions = {
     'camera.ptz-set': { description: 'PTZ Set', permission: 'camera:ptz' },
     'camera.ptz-move': { description: 'PTZ Move', permission: 'camera:ptz' },

package/dist/device-event.d.ts

@@ -40,13 +40,13 @@ export declare const sEventHeader: z.ZodObject<{
     observedBy: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     id: string;
-    timestamp: number;
     deviceId: string;
+    timestamp: number;
     observedBy?: string | undefined;
 }, {
     id: string;
-    timestamp: number;
     deviceId: string;
+    timestamp: number;
     observedBy?: string | undefined;
 }>;
 type EventHeader = z.infer<typeof sEventHeader>;
@@ -86,17 +86,17 @@ export declare const eventSchemaByKind: {
     }, "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;
     }>;
     'person-out': z.ZodObject<{
         kind: z.ZodLiteral<"person-out">;
@@ -109,19 +109,19 @@ export declare const eventSchemaByKind: {
     }, "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;
     }>;
     'panic-button-pressed': z.ZodObject<{
         kind: z.ZodLiteral<"panic-button-pressed">;
@@ -567,13 +567,13 @@ export declare const eventSchemaByKind: {
     }, "strip", z.ZodTypeAny, {
         kind: "alarm-acknowledged";
         alarmId: string;
-        personId?: string | undefined;
         userId?: string | undefined;
+        personId?: string | undefined;
     }, {
         kind: "alarm-acknowledged";
         alarmId: string;
-        personId?: string | undefined;
         userId?: string | undefined;
+        personId?: string | undefined;
     }>;
     'alarm-armed-all': z.ZodObject<{
         kind: z.ZodLiteral<"alarm-armed-all">;
@@ -581,12 +581,12 @@ export declare const eventSchemaByKind: {
         personId: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         kind: "alarm-armed-all";
-        personId?: string | undefined;
         userId?: string | undefined;
+        personId?: string | undefined;
     }, {
         kind: "alarm-armed-all";
-        personId?: string | undefined;
         userId?: string | undefined;
+        personId?: string | undefined;
     }>;
     'alarm-disarmed-all': z.ZodObject<{
         kind: z.ZodLiteral<"alarm-disarmed-all">;
@@ -594,12 +594,12 @@ export declare const eventSchemaByKind: {
         personId: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         kind: "alarm-disarmed-all";
-        personId?: string | undefined;
         userId?: string | undefined;
+        personId?: string | undefined;
     }, {
         kind: "alarm-disarmed-all";
-        personId?: string | undefined;
         userId?: string | undefined;
+        personId?: string | undefined;
     }>;
     'alarm-armed': z.ZodObject<{
         kind: z.ZodLiteral<"alarm-armed">;
@@ -609,13 +609,13 @@ export declare const eventSchemaByKind: {
     }, "strip", z.ZodTypeAny, {
         kind: "alarm-armed";
         subjects: string[];
-        personId?: string | undefined;
         userId?: string | undefined;
+        personId?: string | undefined;
     }, {
         kind: "alarm-armed";
         subjects: string[];
-        personId?: string | undefined;
         userId?: string | undefined;
+        personId?: string | undefined;
     }>;
     'alarm-disarmed': z.ZodObject<{
         kind: z.ZodLiteral<"alarm-disarmed">;
@@ -625,13 +625,13 @@ export declare const eventSchemaByKind: {
     }, "strip", z.ZodTypeAny, {
         kind: "alarm-disarmed";
         subjects: string[];
-        personId?: string | undefined;
         userId?: string | undefined;
+        personId?: string | undefined;
     }, {
         kind: "alarm-disarmed";
         subjects: string[];
-        personId?: string | undefined;
         userId?: string | undefined;
+        personId?: string | undefined;
     }>;
     'alarm-arm-released': z.ZodObject<{
         kind: z.ZodLiteral<"alarm-arm-released">;
@@ -639,12 +639,12 @@ export declare const eventSchemaByKind: {
         personId: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         kind: "alarm-arm-released";
-        personId?: string | undefined;
         userId?: string | undefined;
+        personId?: string | undefined;
     }, {
         kind: "alarm-arm-released";
-        personId?: string | undefined;
         userId?: string | undefined;
+        personId?: string | undefined;
     }>;
     'alarm-rearmed': z.ZodObject<{
         kind: z.ZodLiteral<"alarm-rearmed">;

package/dist/device-import.d.ts

@@ -100,11 +100,24 @@ export declare const sImportedDevice: z.ZodIntersection<z.ZodIntersection<z.ZodO
     } & Record<string, unknown>) | null;
     defaultStreamId: string;
 }>, z.ZodObject<{
+    canReportOpenState: z.ZodBoolean;
+    canReportLockState: z.ZodBoolean;
+    canControlLock: z.ZodBoolean;
+    canRelease: z.ZodBoolean;
+} & {
     type: z.ZodLiteral<"door">;
 }, "strip", z.ZodTypeAny, {
     type: "door";
+    canReportOpenState: boolean;
+    canReportLockState: boolean;
+    canControlLock: boolean;
+    canRelease: boolean;
 }, {
     type: "door";
+    canReportOpenState: boolean;
+    canReportLockState: boolean;
+    canControlLock: boolean;
+    canRelease: boolean;
 }>, z.ZodObject<{
     inputs: z.ZodArray<z.ZodString, "many">;
     outputs: z.ZodArray<z.ZodString, "many">;
@@ -315,11 +328,24 @@ export declare const sDeviceDiscoveryDto: z.ZodObject<{
         } & Record<string, unknown>) | null;
         defaultStreamId: string;
     }>, z.ZodObject<{
+        canReportOpenState: z.ZodBoolean;
+        canReportLockState: z.ZodBoolean;
+        canControlLock: z.ZodBoolean;
+        canRelease: z.ZodBoolean;
+    } & {
         type: z.ZodLiteral<"door">;
     }, "strip", z.ZodTypeAny, {
         type: "door";
+        canReportOpenState: boolean;
+        canReportLockState: boolean;
+        canControlLock: boolean;
+        canRelease: boolean;
     }, {
         type: "door";
+        canReportOpenState: boolean;
+        canReportLockState: boolean;
+        canControlLock: boolean;
+        canRelease: boolean;
     }>, z.ZodObject<{
         inputs: z.ZodArray<z.ZodString, "many">;
         outputs: z.ZodArray<z.ZodString, "many">;
@@ -471,6 +497,10 @@ export declare const sDeviceDiscoveryDto: z.ZodObject<{
         defaultStreamId: string;
     } | {
         type: "door";
+        canReportOpenState: boolean;
+        canReportLockState: boolean;
+        canControlLock: boolean;
+        canRelease: boolean;
     } | {
         type: "io-board";
         inputs: string[];
@@ -545,6 +575,10 @@ export declare const sDeviceDiscoveryDto: z.ZodObject<{
         defaultStreamId: string;
     } | {
         type: "door";
+        canReportOpenState: boolean;
+        canReportLockState: boolean;
+        canControlLock: boolean;
+        canRelease: boolean;
     } | {
         type: "io-board";
         inputs: string[];
@@ -688,11 +722,24 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
         } & Record<string, unknown>) | null;
         defaultStreamId: string;
     }>, z.ZodObject<{
+        canReportOpenState: z.ZodBoolean;
+        canReportLockState: z.ZodBoolean;
+        canControlLock: z.ZodBoolean;
+        canRelease: z.ZodBoolean;
+    } & {
         type: z.ZodLiteral<"door">;
     }, "strip", z.ZodTypeAny, {
         type: "door";
+        canReportOpenState: boolean;
+        canReportLockState: boolean;
+        canControlLock: boolean;
+        canRelease: boolean;
     }, {
         type: "door";
+        canReportOpenState: boolean;
+        canReportLockState: boolean;
+        canControlLock: boolean;
+        canRelease: boolean;
     }>, z.ZodObject<{
         inputs: z.ZodArray<z.ZodString, "many">;
         outputs: z.ZodArray<z.ZodString, "many">;
@@ -880,11 +927,24 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
         } & Record<string, unknown>) | null;
         defaultStreamId: string;
     }>, z.ZodObject<{
+        canReportOpenState: z.ZodBoolean;
+        canReportLockState: z.ZodBoolean;
+        canControlLock: z.ZodBoolean;
+        canRelease: z.ZodBoolean;
+    } & {
         type: z.ZodLiteral<"door">;
     }, "strip", z.ZodTypeAny, {
         type: "door";
+        canReportOpenState: boolean;
+        canReportLockState: boolean;
+        canControlLock: boolean;
+        canRelease: boolean;
     }, {
         type: "door";
+        canReportOpenState: boolean;
+        canReportLockState: boolean;
+        canControlLock: boolean;
+        canRelease: boolean;
     }>, z.ZodObject<{
         inputs: z.ZodArray<z.ZodString, "many">;
         outputs: z.ZodArray<z.ZodString, "many">;
@@ -1132,6 +1192,10 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
         defaultStreamId: string;
     } | {
         type: "door";
+        canReportOpenState: boolean;
+        canReportLockState: boolean;
+        canControlLock: boolean;
+        canRelease: boolean;
     } | {
         type: "io-board";
         inputs: string[];
@@ -1228,6 +1292,10 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
         defaultStreamId: string;
     } | {
         type: "door";
+        canReportOpenState: boolean;
+        canReportLockState: boolean;
+        canControlLock: boolean;
+        canRelease: boolean;
     } | {
         type: "io-board";
         inputs: string[];
@@ -1293,6 +1361,10 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
         defaultStreamId: string;
     } | {
         type: "door";
+        canReportOpenState: boolean;
+        canReportLockState: boolean;
+        canControlLock: boolean;
+        canRelease: boolean;
     } | {
         type: "io-board";
         inputs: string[];
@@ -1389,6 +1461,10 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
         defaultStreamId: string;
     } | {
         type: "door";
+        canReportOpenState: boolean;
+        canReportLockState: boolean;
+        canControlLock: boolean;
+        canRelease: boolean;
     } | {
         type: "io-board";
         inputs: string[];

package/dist/macros.d.ts

@@ -8,14 +8,14 @@ export declare const sMacroItemDto: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     id: string | null;
     params: Record<string, unknown>;
-    deviceId: string;
     command: string;
+    deviceId: string;
     stepId: string;
 }, {
     id: string | null;
     params: Record<string, unknown>;
-    deviceId: string;
     command: string;
+    deviceId: string;
     stepId: string;
 }>;
 export declare const sMacroDto: z.ZodObject<{
@@ -36,14 +36,14 @@ export declare const sMacroDto: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         id: string | null;
         params: Record<string, unknown>;
-        deviceId: string;
         command: string;
+        deviceId: string;
         stepId: string;
     }, {
         id: string | null;
         params: Record<string, unknown>;
-        deviceId: string;
         command: string;
+        deviceId: string;
         stepId: string;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
@@ -54,8 +54,8 @@ export declare const sMacroDto: z.ZodObject<{
     items: {
         id: string | null;
         params: Record<string, unknown>;
-        deviceId: string;
         command: string;
+        deviceId: string;
         stepId: string;
     }[];
     displayName: string;
@@ -70,8 +70,8 @@ export declare const sMacroDto: z.ZodObject<{
     items: {
         id: string | null;
         params: Record<string, unknown>;
-        deviceId: string;
         command: string;
+        deviceId: string;
         stepId: string;
     }[];
     displayName: string;
@@ -97,14 +97,14 @@ export declare const sAddMacroRequest: z.ZodObject<Omit<{
     }, "strip", z.ZodTypeAny, {
         id: string | null;
         params: Record<string, unknown>;
-        deviceId: string;
         command: string;
+        deviceId: string;
         stepId: string;
     }, {
         id: string | null;
         params: Record<string, unknown>;
-        deviceId: string;
         command: string;
+        deviceId: string;
         stepId: string;
     }>, "many">;
 }, "id" | "createdOn" | "lastModifiedOn" | "createdBy">, "strip", z.ZodTypeAny, {
@@ -114,8 +114,8 @@ export declare const sAddMacroRequest: z.ZodObject<Omit<{
     items: {
         id: string | null;
         params: Record<string, unknown>;
-        deviceId: string;
         command: string;
+        deviceId: string;
         stepId: string;
     }[];
     displayName: string;
@@ -126,8 +126,8 @@ export declare const sAddMacroRequest: z.ZodObject<Omit<{
     items: {
         id: string | null;
         params: Record<string, unknown>;
-        deviceId: string;
         command: string;
+        deviceId: string;
         stepId: string;
     }[];
     displayName: string;
@@ -145,14 +145,14 @@ export declare const sUpdateMacroRequest: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         id: string | null;
         params: Record<string, unknown>;
-        deviceId: string;
         command: string;
+        deviceId: string;
         stepId: string;
     }, {
         id: string | null;
         params: Record<string, unknown>;
-        deviceId: string;
         command: string;
+        deviceId: string;
         stepId: string;
     }>, "many">>;
     displayName: z.ZodOptional<z.ZodString>;
@@ -163,8 +163,8 @@ export declare const sUpdateMacroRequest: z.ZodObject<{
     items?: {
         id: string | null;
         params: Record<string, unknown>;
-        deviceId: string;
         command: string;
+        deviceId: string;
         stepId: string;
     }[] | undefined;
     displayName?: string | undefined;
@@ -175,8 +175,8 @@ export declare const sUpdateMacroRequest: z.ZodObject<{
     items?: {
         id: string | null;
         params: Record<string, unknown>;
-        deviceId: string;
         command: string;
+        deviceId: string;
         stepId: string;
     }[] | undefined;
     displayName?: string | undefined;

package/dist/messages/device-communication.d.ts

@@ -34,23 +34,23 @@ export declare const sStateUpdate: z.ZodObject<{
     state: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
 }, "strip", z.ZodTypeAny, {
     state: {};
-    timestamp: number;
     deviceId: string;
+    timestamp: number;
 }, {
     state: {};
-    timestamp: number;
     deviceId: string;
+    timestamp: number;
 }>;
 export type StateUpdatePayload = z.infer<typeof sStateUpdate>;
 export declare const sStateUnavailable: z.ZodObject<{
     timestamp: z.ZodNumber;
     deviceId: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    timestamp: number;
     deviceId: string;
-}, {
     timestamp: number;
+}, {
     deviceId: string;
+    timestamp: number;
 }>;
 export type StateUnavailablePayload = z.infer<typeof sStateUnavailable>;
 export declare const sStateUpdateError: z.ZodObject<{
@@ -59,12 +59,12 @@ export declare const sStateUpdateError: z.ZodObject<{
     error: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
 }, "strip", z.ZodTypeAny, {
     error: {};
-    timestamp: number;
     deviceId: string;
+    timestamp: number;
 }, {
     error: {};
-    timestamp: number;
     deviceId: string;
+    timestamp: number;
 }>;
 export type StateUpdateErrorPayload = z.infer<typeof sStateUpdateError>;
 export declare const sStateSubscribe: z.ZodObject<{
@@ -72,12 +72,12 @@ export declare const sStateSubscribe: z.ZodObject<{
     requestId: z.ZodString;
     deviceId: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    timestamp: number;
     deviceId: string;
+    timestamp: number;
     requestId: string;
 }, {
-    timestamp: number;
     deviceId: string;
+    timestamp: number;
     requestId: string;
 }>;
 export type StateSubscribePayload = z.infer<typeof sStateSubscribe>;
@@ -86,12 +86,12 @@ export declare const sStateUnsubscribe: z.ZodObject<{
     requestId: z.ZodString;
     deviceId: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    timestamp: number;
     deviceId: string;
+    timestamp: number;
     requestId: string;
 }, {
-    timestamp: number;
     deviceId: string;
+    timestamp: number;
     requestId: string;
 }>;
 export type StateUnsubscribePayload = z.infer<typeof sStateUnsubscribe>;

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awarevue/api-types",
-  "version": "1.0.108",
+  "version": "1.0.109",
   "description": "Common types between backend, agent(s) and frontend(s)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/primitives.d.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+export declare const sDeviceId: z.ZodString;
+export declare const sPresetId: z.ZodString;
+export declare const sDeviceEvent: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+export declare const sPersonId: z.ZodString;
+export declare const sZoneId: z.ZodString;
+export declare const sMacroId: z.ZodString;
+export declare const sDuration: z.ZodNumber;
+export declare const sUrl: z.ZodString;

package/dist/primitives.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sUrl = exports.sDuration = exports.sMacroId = exports.sZoneId = exports.sPersonId = exports.sDeviceEvent = exports.sPresetId = exports.sDeviceId = void 0;
+const zod_1 = require("zod");
+exports.sDeviceId = zod_1.z.string().uuid().nonempty();
+exports.sPresetId = zod_1.z.string().uuid().nonempty();
+exports.sDeviceEvent = zod_1.z.record(zod_1.z.unknown());
+exports.sPersonId = zod_1.z.string().uuid().nonempty();
+exports.sZoneId = zod_1.z.string().uuid().nonempty();
+exports.sMacroId = zod_1.z.string().uuid().nonempty();
+// general
+exports.sDuration = zod_1.z.number().min(0).describe('Duration in milliseconds');
+exports.sUrl = zod_1.z.string().url().describe('A valid URL');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awarevue/api-types",
-  "version": "1.0.108",
+  "version": "1.0.109",
   "description": "Common types between backend, agent(s) and frontend(s)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",