@awarevue/api-types 2.0.6 → 2.0.8

package/dist/device/nvr-recorder.d.ts

@@ -258,6 +258,12 @@ export declare const sRecordingsByTimeRangeArgs: z.ZodObject<{
         type: "nvr-analytics-server";
     }, {
         type: "nvr-analytics-server";
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"system">;
+    }, "strip", z.ZodTypeAny, {
+        type: "system";
+    }, {
+        type: "system";
     }>]>>]>;
     timeFrom: z.ZodNumber;
     timeTo: z.ZodNumber;
@@ -339,6 +345,8 @@ export declare const sRecordingsByTimeRangeArgs: z.ZodObject<{
         type: "nvr-exporter";
     } | {
         type: "nvr-analytics-server";
+    } | {
+        type: "system";
     }));
     timeFrom: number;
     timeTo: number;
@@ -420,6 +428,8 @@ export declare const sRecordingsByTimeRangeArgs: z.ZodObject<{
         type: "nvr-exporter";
     } | {
         type: "nvr-analytics-server";
+    } | {
+        type: "system";
     }));
     timeFrom: number;
     timeTo: number;
@@ -690,6 +700,12 @@ export declare const sPreviewImageArgs: z.ZodObject<{
         type: "nvr-analytics-server";
     }, {
         type: "nvr-analytics-server";
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"system">;
+    }, "strip", z.ZodTypeAny, {
+        type: "system";
+    }, {
+        type: "system";
     }>]>>]>;
     time: z.ZodNumber;
     height: z.ZodNumber;
@@ -773,6 +789,8 @@ export declare const sPreviewImageArgs: z.ZodObject<{
         type: "nvr-exporter";
     } | {
         type: "nvr-analytics-server";
+    } | {
+        type: "system";
     }));
 }, {
     time: number;
@@ -854,6 +872,8 @@ export declare const sPreviewImageArgs: z.ZodObject<{
         type: "nvr-exporter";
     } | {
         type: "nvr-analytics-server";
+    } | {
+        type: "system";
     }));
 }>;
 export declare const sPreviewImageResponse: z.ZodNullable<z.ZodObject<{
@@ -1116,6 +1136,12 @@ export declare const sCameraLatestFrameArgs: z.ZodObject<{
         type: "nvr-analytics-server";
     }, {
         type: "nvr-analytics-server";
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"system">;
+    }, "strip", z.ZodTypeAny, {
+        type: "system";
+    }, {
+        type: "system";
     }>]>>]>;
     width: z.ZodNumber;
     height: z.ZodNumber;
@@ -1199,6 +1225,8 @@ export declare const sCameraLatestFrameArgs: z.ZodObject<{
         type: "nvr-exporter";
     } | {
         type: "nvr-analytics-server";
+    } | {
+        type: "system";
     }));
 }, {
     height: number;
@@ -1280,6 +1308,8 @@ export declare const sCameraLatestFrameArgs: z.ZodObject<{
         type: "nvr-exporter";
     } | {
         type: "nvr-analytics-server";
+    } | {
+        type: "system";
     }));
 }>;
 export declare const sCameraLatestFrameResponse: z.ZodNullable<z.ZodObject<{
@@ -1542,6 +1572,12 @@ export declare const nvrRecorderRequestSchemas: {
             type: "nvr-analytics-server";
         }, {
             type: "nvr-analytics-server";
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"system">;
+        }, "strip", z.ZodTypeAny, {
+            type: "system";
+        }, {
+            type: "system";
         }>]>>]>;
         timeFrom: z.ZodNumber;
         timeTo: z.ZodNumber;
@@ -1623,6 +1659,8 @@ export declare const nvrRecorderRequestSchemas: {
             type: "nvr-exporter";
         } | {
             type: "nvr-analytics-server";
+        } | {
+            type: "system";
         }));
         timeFrom: number;
         timeTo: number;
@@ -1704,6 +1742,8 @@ export declare const nvrRecorderRequestSchemas: {
             type: "nvr-exporter";
         } | {
             type: "nvr-analytics-server";
+        } | {
+            type: "system";
         }));
         timeFrom: number;
         timeTo: number;
@@ -1955,6 +1995,12 @@ export declare const nvrRecorderRequestSchemas: {
             type: "nvr-analytics-server";
         }, {
             type: "nvr-analytics-server";
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"system">;
+        }, "strip", z.ZodTypeAny, {
+            type: "system";
+        }, {
+            type: "system";
         }>]>>]>;
         time: z.ZodNumber;
         height: z.ZodNumber;
@@ -2038,6 +2084,8 @@ export declare const nvrRecorderRequestSchemas: {
             type: "nvr-exporter";
         } | {
             type: "nvr-analytics-server";
+        } | {
+            type: "system";
         }));
     }, {
         time: number;
@@ -2119,6 +2167,8 @@ export declare const nvrRecorderRequestSchemas: {
             type: "nvr-exporter";
         } | {
             type: "nvr-analytics-server";
+        } | {
+            type: "system";
         }));
     }>;
     readonly "cctv:latest-frame": z.ZodObject<{
@@ -2368,6 +2418,12 @@ export declare const nvrRecorderRequestSchemas: {
             type: "nvr-analytics-server";
         }, {
             type: "nvr-analytics-server";
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"system">;
+        }, "strip", z.ZodTypeAny, {
+            type: "system";
+        }, {
+            type: "system";
         }>]>>]>;
         width: z.ZodNumber;
         height: z.ZodNumber;
@@ -2451,6 +2507,8 @@ export declare const nvrRecorderRequestSchemas: {
             type: "nvr-exporter";
         } | {
             type: "nvr-analytics-server";
+        } | {
+            type: "system";
         }));
     }, {
         height: number;
@@ -2532,6 +2590,8 @@ export declare const nvrRecorderRequestSchemas: {
             type: "nvr-exporter";
         } | {
             type: "nvr-analytics-server";
+        } | {
+            type: "system";
         }));
     }>;
 };

package/dist/device/system.d.ts

@@ -0,0 +1,48 @@
+import { z } from 'zod';
+export declare const SYSTEM: "system";
+export declare const sSystemDeviceSpecs: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+export type SystemDeviceSpecs = z.infer<typeof sSystemDeviceSpecs>;
+export declare const sSystemDeviceStateDto: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+export type SystemDeviceStateDto = z.infer<typeof sSystemDeviceStateDto>;
+export declare const sNotificationCreated: z.ZodObject<{
+    kind: z.ZodLiteral<"notification-created">;
+    notificationRef: z.ZodOptional<z.ZodString>;
+    severity: z.ZodEnum<["info", "warning", "critical"]>;
+    message: z.ZodString;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    kind: "notification-created";
+    severity: "info" | "warning" | "critical";
+    metadata?: Record<string, unknown> | undefined;
+    notificationRef?: string | undefined;
+}, {
+    message: string;
+    kind: "notification-created";
+    severity: "info" | "warning" | "critical";
+    metadata?: Record<string, unknown> | undefined;
+    notificationRef?: string | undefined;
+}>;
+export declare const systemDeviceEventSchemasByKind: {
+    readonly 'notification-created': z.ZodObject<{
+        kind: z.ZodLiteral<"notification-created">;
+        notificationRef: z.ZodOptional<z.ZodString>;
+        severity: z.ZodEnum<["info", "warning", "critical"]>;
+        message: z.ZodString;
+        metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        kind: "notification-created";
+        severity: "info" | "warning" | "critical";
+        metadata?: Record<string, unknown> | undefined;
+        notificationRef?: string | undefined;
+    }, {
+        message: string;
+        kind: "notification-created";
+        severity: "info" | "warning" | "critical";
+        metadata?: Record<string, unknown> | undefined;
+        notificationRef?: string | undefined;
+    }>;
+};
+export type NotificationCreated = z.infer<typeof sNotificationCreated>;
+export type SystemDeviceEvent = NotificationCreated;

package/dist/device/system.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.systemDeviceEventSchemasByKind = exports.sNotificationCreated = exports.sSystemDeviceStateDto = exports.sSystemDeviceSpecs = exports.SYSTEM = void 0;
+const primitives_1 = require("../primitives");
+const zod_1 = require("zod");
+exports.SYSTEM = 'system';
+// SPECS
+exports.sSystemDeviceSpecs = zod_1.z.object({});
+// STATE
+exports.sSystemDeviceStateDto = zod_1.z.record(zod_1.z.unknown());
+// EVENTS
+exports.sNotificationCreated = zod_1.z.object({
+    kind: zod_1.z.literal('notification-created'),
+    notificationRef: zod_1.z.string().optional(),
+    severity: primitives_1.sNotificationSeverity,
+    message: zod_1.z.string().nonempty(),
+    metadata: zod_1.z.record(zod_1.z.unknown()).optional(),
+});
+exports.systemDeviceEventSchemasByKind = {
+    'notification-created': exports.sNotificationCreated,
+};

package/dist/device-command.d.ts

@@ -270,6 +270,12 @@ export declare const commandSchemas: {
                 type: "nvr-analytics-server";
             }, {
                 type: "nvr-analytics-server";
+            }>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"system">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "system";
+            }, {
+                type: "system";
             }>]>>]>;
             timeFrom: import("zod").ZodNumber;
             timeTo: import("zod").ZodNumber;
@@ -354,6 +360,8 @@ export declare const commandSchemas: {
                 type: "nvr-exporter";
             } | {
                 type: "nvr-analytics-server";
+            } | {
+                type: "system";
             }));
             timeFrom: number;
             timeTo: number;
@@ -437,6 +445,8 @@ export declare const commandSchemas: {
                 type: "nvr-exporter";
             } | {
                 type: "nvr-analytics-server";
+            } | {
+                type: "system";
             }));
             timeFrom: number;
             timeTo: number;
@@ -522,6 +532,8 @@ export declare const commandSchemas: {
                 type: "nvr-exporter";
             } | {
                 type: "nvr-analytics-server";
+            } | {
+                type: "system";
             }));
             timeFrom: number;
             timeTo: number;
@@ -608,6 +620,8 @@ export declare const commandSchemas: {
                 type: "nvr-exporter";
             } | {
                 type: "nvr-analytics-server";
+            } | {
+                type: "system";
             }));
             timeFrom: number;
             timeTo: number;

package/dist/device-event.d.ts

@@ -11,6 +11,7 @@ import { ReaderEvent } from './device/reader/index';
 import { ServerEvent } from './device/server';
 import { DeviceType } from './device/any-device';
 import { NvrExporterEvent } from './device/nvr-exporter';
+import { SystemDeviceEvent } from './device/system';
 export interface DeviceCommandTriggered {
     kind: 'device-command';
     userId?: string;
@@ -33,7 +34,7 @@ export interface DeviceDisconnectedEvent {
     kind: 'device-disconnected';
     clientId?: number;
 }
-export type AnyDeviceEvent = DeviceCommandTriggered | CameraEvent | DoorEvent | AlarmEvent | MotionDetectedEvent | ReaderEvent | PanicButtonEvent | DeviceConnectedEvent | DeviceDisconnectedEvent | IntercomTerminalEvent | ServerEvent | DeviceGatewayEvent | PresenceTrackerEvent | IoBoardEvent | NvrExporterEvent;
+export type AnyDeviceEvent = DeviceCommandTriggered | CameraEvent | DoorEvent | AlarmEvent | MotionDetectedEvent | ReaderEvent | PanicButtonEvent | DeviceConnectedEvent | DeviceDisconnectedEvent | IntercomTerminalEvent | ServerEvent | DeviceGatewayEvent | PresenceTrackerEvent | IoBoardEvent | NvrExporterEvent | SystemDeviceEvent;
 export declare const sEventHeader: z.ZodObject<{
     id: z.ZodString;
     timestamp: z.ZodNumber;
@@ -61,6 +62,25 @@ export declare const eventSchemaByKind: {
     }, {
         kind: "motion-detected";
     }>;
+    'notification-created': z.ZodObject<{
+        kind: z.ZodLiteral<"notification-created">;
+        notificationRef: z.ZodOptional<z.ZodString>;
+        severity: z.ZodEnum<["info", "warning", "critical"]>;
+        message: z.ZodString;
+        metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        kind: "notification-created";
+        severity: "info" | "warning" | "critical";
+        metadata?: Record<string, unknown> | undefined;
+        notificationRef?: string | undefined;
+    }, {
+        message: string;
+        kind: "notification-created";
+        severity: "info" | "warning" | "critical";
+        metadata?: Record<string, unknown> | undefined;
+        notificationRef?: string | undefined;
+    }>;
     'nvr-export-started': z.ZodObject<{
         kind: z.ZodLiteral<"nvr-export-started">;
         exportId: z.ZodString;

package/dist/device-event.js

@@ -11,6 +11,7 @@ const panic_button_1 = require("./device/panic-button");
 const presence_tracker_1 = require("./device/presence-tracker");
 const index_1 = require("./device/reader/index");
 const nvr_exporter_1 = require("./device/nvr-exporter");
+const system_1 = require("./device/system");
 exports.sMotionDetected = zod_1.z.object({
     kind: zod_1.z.literal('motion-detected'),
 });
@@ -65,6 +66,7 @@ exports.eventKindLabels = {
     'door-closed': 'Door Closed',
     'nvr-export-started': 'NVR Export Started',
     'nvr-export-deleted': 'NVR Export Deleted',
+    'notification-created': 'Notification Created',
 };
 exports.eventSchemaByKind = {
     ...alarm_1.alarmEventSchemasByKind,
@@ -76,6 +78,7 @@ exports.eventSchemaByKind = {
     ...presence_tracker_1.presenceTrackerEventSchemaByKind,
     ...index_1.readerEventSchemaByKind,
     ...nvr_exporter_1.nvrExporterEventSchemasByKind,
+    ...system_1.systemDeviceEventSchemasByKind,
     'motion-detected': exports.sMotionDetected,
 };
 exports.eventsByDeviceType = {

package/dist/device-import.d.ts

@@ -253,6 +253,12 @@ export declare const sImportedDevice: z.ZodIntersection<z.ZodIntersection<z.ZodO
     type: "nvr-analytics-server";
 }, {
     type: "nvr-analytics-server";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"system">;
+}, "strip", z.ZodTypeAny, {
+    type: "system";
+}, {
+    type: "system";
 }>]>>;
 export declare const sDuplicateDevice: z.ZodObject<{
     name: z.ZodString;
@@ -517,6 +523,12 @@ export declare const sDeviceDiscoveryDto: z.ZodObject<{
         type: "nvr-analytics-server";
     }, {
         type: "nvr-analytics-server";
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"system">;
+    }, "strip", z.ZodTypeAny, {
+        type: "system";
+    }, {
+        type: "system";
     }>]>>, "many">;
     relations: z.ZodArray<z.ZodIntersection<z.ZodObject<{
         leftId: z.ZodString;
@@ -617,6 +629,8 @@ export declare const sDeviceDiscoveryDto: z.ZodObject<{
         type: "nvr-exporter";
     } | {
         type: "nvr-analytics-server";
+    } | {
+        type: "system";
     }))[];
     relations: ({
         kind: "parent" | "attachedTo" | "child" | "holds" | "isHeldBy" | "observes" | "isObservedBy" | "sendsInputTo" | "receivesInputFrom" | "sendsOutputTo" | "receivesOutputFrom" | "unlocks" | "isUnlockedBy" | "controls" | "isControlledBy" | "records" | "isRecordedBy" | "reads" | "isReadBy";
@@ -707,6 +721,8 @@ export declare const sDeviceDiscoveryDto: z.ZodObject<{
         type: "nvr-exporter";
     } | {
         type: "nvr-analytics-server";
+    } | {
+        type: "system";
     }))[];
     relations: ({
         kind: "parent" | "attachedTo" | "child" | "holds" | "isHeldBy" | "observes" | "isObservedBy" | "sendsInputTo" | "receivesInputFrom" | "sendsOutputTo" | "receivesOutputFrom" | "unlocks" | "isUnlockedBy" | "controls" | "isControlledBy" | "records" | "isRecordedBy" | "reads" | "isReadBy";
@@ -971,6 +987,12 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
         type: "nvr-analytics-server";
     }, {
         type: "nvr-analytics-server";
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"system">;
+    }, "strip", z.ZodTypeAny, {
+        type: "system";
+    }, {
+        type: "system";
     }>]>>, "many">;
     updated: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
@@ -1212,6 +1234,12 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
         type: "nvr-analytics-server";
     }, {
         type: "nvr-analytics-server";
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"system">;
+    }, "strip", z.ZodTypeAny, {
+        type: "system";
+    }, {
+        type: "system";
     }>]>, z.ZodObject<{
         id: z.ZodString;
         presets: z.ZodArray<z.ZodObject<{
@@ -1414,6 +1442,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
         type: "nvr-exporter";
     } | {
         type: "nvr-analytics-server";
+    } | {
+        type: "system";
     }) & {
         groups: string[];
         id: string;
@@ -1528,6 +1558,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
         type: "nvr-exporter";
     } | {
         type: "nvr-analytics-server";
+    } | {
+        type: "system";
     }))[];
     updated: z.objectOutputType<{
         id: z.ZodString;
@@ -1609,6 +1641,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
         type: "nvr-exporter";
     } | {
         type: "nvr-analytics-server";
+    } | {
+        type: "system";
     }) & {
         groups: string[];
         id: string;
@@ -1723,6 +1757,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
         type: "nvr-exporter";
     } | {
         type: "nvr-analytics-server";
+    } | {
+        type: "system";
     }))[];
     updated: z.objectInputType<{
         id: z.ZodString;

package/dist/notifications.d.ts

@@ -0,0 +1,29 @@
+import { z } from 'zod';
+export declare const sNotificationDto: z.ZodObject<{
+    id: z.ZodString;
+    source: z.ZodOptional<z.ZodString>;
+    message: z.ZodString;
+    severity: z.ZodEnum<["info", "warning", "critical"]>;
+    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    createdOn: z.ZodNumber;
+    acknowledgedBy: z.ZodNullable<z.ZodString>;
+    acknowledgedOn: z.ZodNullable<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    id: string;
+    metadata: Record<string, unknown>;
+    createdOn: number;
+    severity: "info" | "warning" | "critical";
+    acknowledgedBy: string | null;
+    acknowledgedOn: number | null;
+    source?: string | undefined;
+}, {
+    message: string;
+    id: string;
+    metadata: Record<string, unknown>;
+    createdOn: number;
+    severity: "info" | "warning" | "critical";
+    acknowledgedBy: string | null;
+    acknowledgedOn: number | null;
+    source?: string | undefined;
+}>;

package/dist/notifications.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sNotificationDto = void 0;
+const zod_1 = require("zod");
+const primitives_1 = require("./primitives");
+exports.sNotificationDto = zod_1.z.object({
+    id: zod_1.z.string().nonempty(),
+    source: primitives_1.sDeviceId.optional(),
+    message: zod_1.z.string().nonempty(),
+    severity: primitives_1.sNotificationSeverity,
+    metadata: zod_1.z.record(zod_1.z.unknown()),
+    createdOn: zod_1.z.number().int().nonnegative(),
+    acknowledgedBy: zod_1.z.string().nonempty().nullable(),
+    acknowledgedOn: zod_1.z.number().int().nonnegative().nullable(),
+});

package/dist/package.json

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

package/dist/permissions.d.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
-export declare const sPermissionId: z.ZodUnion<[z.ZodLiteral<"layout:read">, z.ZodLiteral<"layout:update">, z.ZodLiteral<"layout:delete">, z.ZodLiteral<"layout:create">, z.ZodLiteral<"camera:live">, z.ZodLiteral<"camera:playback">, z.ZodLiteral<"camera:playback-export">, z.ZodLiteral<"camera:ptz">, z.ZodLiteral<"camera:privacy-mode">, z.ZodLiteral<"camera:assign">, z.ZodLiteral<"camera:detection">, z.ZodLiteral<"preset:read">, z.ZodLiteral<"preset:update">, z.ZodLiteral<"preset:delete">, z.ZodLiteral<"preset:create">, z.ZodLiteral<"door:release">, z.ZodLiteral<"door:lock">, z.ZodLiteral<"camera-lift:activate">, z.ZodLiteral<"io-board:activate">, z.ZodLiteral<"public-view:read">, z.ZodLiteral<"public-view:update">, z.ZodLiteral<"public-view:delete">, z.ZodLiteral<"public-view:create">, z.ZodLiteral<"private-view:read">, z.ZodLiteral<"private-view:update">, z.ZodLiteral<"private-view:delete">, z.ZodLiteral<"private-view:create">, z.ZodLiteral<"person:read">, z.ZodLiteral<"person:update">, z.ZodLiteral<"person:delete">, z.ZodLiteral<"person:create">, z.ZodLiteral<"person:assign">, z.ZodLiteral<"person:print">, z.ZodLiteral<"door-group:read">, z.ZodLiteral<"door-group:update">, z.ZodLiteral<"door-group:delete">, z.ZodLiteral<"door-group:create">, z.ZodLiteral<"access-rule:read">, z.ZodLiteral<"access-rule:update">, z.ZodLiteral<"access-rule:delete">, z.ZodLiteral<"access-rule:create">, z.ZodLiteral<"schedule:read">, z.ZodLiteral<"schedule:update">, z.ZodLiteral<"schedule:delete">, z.ZodLiteral<"schedule:create">, z.ZodLiteral<"presence:read">, z.ZodLiteral<"presence:update">, z.ZodLiteral<"presence:update-reader">, z.ZodLiteral<"factory:read">, z.ZodLiteral<"factory:update">, z.ZodLiteral<"factory:delete">, z.ZodLiteral<"factory:create">, z.ZodLiteral<"event:read">, z.ZodLiteral<"event:purge">, z.ZodLiteral<"alarm:read">, z.ZodLiteral<"alarm:acknowlede">, z.ZodLiteral<"alarm:arm">, z.ZodLiteral<"alarm:trigger">, z.ZodLiteral<"alarm:bypass">, z.ZodLiteral<"user:read">, z.ZodLiteral<"user:change-password">, z.ZodLiteral<"user:change-username">, z.ZodLiteral<"user:change-name">, z.ZodLiteral<"user:change-email">, z.ZodLiteral<"user:activate">, z.ZodLiteral<"user:delete">, z.ZodLiteral<"user:change-roles">, z.ZodLiteral<"user:create">, z.ZodLiteral<"role:read">, z.ZodLiteral<"role:create">, z.ZodLiteral<"role:delete">, z.ZodLiteral<"role:update">, z.ZodLiteral<"module:read">, z.ZodLiteral<"module:update">, z.ZodLiteral<"module:enable">, z.ZodLiteral<"device:discover">, z.ZodLiteral<"device:import">, z.ZodLiteral<"device:override-specs">, z.ZodLiteral<"device:notes">, z.ZodLiteral<"device:alarms">, z.ZodLiteral<"device:adjacent-cameras">, z.ZodLiteral<"automation:read">, z.ZodLiteral<"automation:update">, z.ZodLiteral<"automation:delete">, z.ZodLiteral<"automation:create">, z.ZodLiteral<"device-group:read">, z.ZodLiteral<"device-group:update">, z.ZodLiteral<"device-group:delete">, z.ZodLiteral<"device-group:create">, z.ZodLiteral<"macro:read">, z.ZodLiteral<"macro:update">, z.ZodLiteral<"macro:delete">, z.ZodLiteral<"macro:create">, z.ZodLiteral<"macro:run">, z.ZodLiteral<"template:read">, z.ZodLiteral<"template:update">, z.ZodLiteral<"template:delete">, z.ZodLiteral<"template:create">, z.ZodLiteral<"custom-field:read">, z.ZodLiteral<"custom-field:update">, z.ZodLiteral<"custom-field:delete">, z.ZodLiteral<"custom-field:create">, z.ZodLiteral<"media:read">, z.ZodLiteral<"about:read">, z.ZodLiteral<"intercom:read">, z.ZodLiteral<"display:read">, ...(z.ZodLiteral<"device:camera"> | z.ZodLiteral<"device:door"> | z.ZodLiteral<"device:motion-sensor"> | z.ZodLiteral<"device:panic-button"> | z.ZodLiteral<"device:intercom-terminal"> | z.ZodLiteral<"device:display"> | z.ZodLiteral<"device:nvr-recorder"> | z.ZodLiteral<"device:nvr-exporter"> | z.ZodLiteral<"device:nvr-analytics-server">)[], z.ZodLiteral<"security-level:read">, z.ZodLiteral<"security-level:update">, z.ZodLiteral<"security-level:delete">, z.ZodLiteral<"security-level:create">, z.ZodLiteral<"citadel-mode:toggle">, z.ZodLiteral<"token-conversion:read">, z.ZodLiteral<"token-conversion:update">, z.ZodLiteral<"token-conversion:delete">, z.ZodLiteral<"token-conversion:create">, z.ZodLiteral<"bookmark:read">, z.ZodLiteral<"bookmark:create">, z.ZodLiteral<"bookmark:update">, z.ZodLiteral<"bookmark:delete">, z.ZodLiteral<"access-path:read">, z.ZodLiteral<"access-path:create">, z.ZodLiteral<"access-path:update">, z.ZodLiteral<"access-path:delete">, z.ZodLiteral<"person-type:create">, z.ZodLiteral<"person-type:update">, z.ZodLiteral<"person-type:delete">, z.ZodLiteral<"agreement:create">, z.ZodLiteral<"agreement:update">, z.ZodLiteral<"agreement:delete">, z.ZodLiteral<"api-key:create">, z.ZodLiteral<"api-key:revoke">]>;
+export declare const sPermissionId: z.ZodUnion<[z.ZodLiteral<"layout:read">, z.ZodLiteral<"layout:update">, z.ZodLiteral<"layout:delete">, z.ZodLiteral<"layout:create">, z.ZodLiteral<"camera:live">, z.ZodLiteral<"camera:playback">, z.ZodLiteral<"camera:playback-export">, z.ZodLiteral<"camera:ptz">, z.ZodLiteral<"camera:privacy-mode">, z.ZodLiteral<"camera:assign">, z.ZodLiteral<"camera:detection">, z.ZodLiteral<"preset:read">, z.ZodLiteral<"preset:update">, z.ZodLiteral<"preset:delete">, z.ZodLiteral<"preset:create">, z.ZodLiteral<"door:release">, z.ZodLiteral<"door:lock">, z.ZodLiteral<"camera-lift:activate">, z.ZodLiteral<"io-board:activate">, z.ZodLiteral<"public-view:read">, z.ZodLiteral<"public-view:update">, z.ZodLiteral<"public-view:delete">, z.ZodLiteral<"public-view:create">, z.ZodLiteral<"private-view:read">, z.ZodLiteral<"private-view:update">, z.ZodLiteral<"private-view:delete">, z.ZodLiteral<"private-view:create">, z.ZodLiteral<"person:read">, z.ZodLiteral<"person:update">, z.ZodLiteral<"person:delete">, z.ZodLiteral<"person:create">, z.ZodLiteral<"person:assign">, z.ZodLiteral<"person:print">, z.ZodLiteral<"door-group:read">, z.ZodLiteral<"door-group:update">, z.ZodLiteral<"door-group:delete">, z.ZodLiteral<"door-group:create">, z.ZodLiteral<"access-rule:read">, z.ZodLiteral<"access-rule:update">, z.ZodLiteral<"access-rule:delete">, z.ZodLiteral<"access-rule:create">, z.ZodLiteral<"schedule:read">, z.ZodLiteral<"schedule:update">, z.ZodLiteral<"schedule:delete">, z.ZodLiteral<"schedule:create">, z.ZodLiteral<"presence:read">, z.ZodLiteral<"presence:update">, z.ZodLiteral<"presence:update-reader">, z.ZodLiteral<"factory:read">, z.ZodLiteral<"factory:update">, z.ZodLiteral<"factory:delete">, z.ZodLiteral<"factory:create">, z.ZodLiteral<"event:read">, z.ZodLiteral<"event:purge">, z.ZodLiteral<"alarm:read">, z.ZodLiteral<"alarm:acknowlede">, z.ZodLiteral<"alarm:arm">, z.ZodLiteral<"alarm:trigger">, z.ZodLiteral<"alarm:bypass">, z.ZodLiteral<"user:read">, z.ZodLiteral<"user:change-password">, z.ZodLiteral<"user:change-username">, z.ZodLiteral<"user:change-name">, z.ZodLiteral<"user:change-email">, z.ZodLiteral<"user:activate">, z.ZodLiteral<"user:delete">, z.ZodLiteral<"user:change-roles">, z.ZodLiteral<"user:create">, z.ZodLiteral<"role:read">, z.ZodLiteral<"role:create">, z.ZodLiteral<"role:delete">, z.ZodLiteral<"role:update">, z.ZodLiteral<"module:read">, z.ZodLiteral<"module:update">, z.ZodLiteral<"module:enable">, z.ZodLiteral<"device:discover">, z.ZodLiteral<"device:import">, z.ZodLiteral<"device:override-specs">, z.ZodLiteral<"device:notes">, z.ZodLiteral<"device:alarms">, z.ZodLiteral<"device:adjacent-cameras">, z.ZodLiteral<"automation:read">, z.ZodLiteral<"automation:update">, z.ZodLiteral<"automation:delete">, z.ZodLiteral<"automation:create">, z.ZodLiteral<"device-group:read">, z.ZodLiteral<"device-group:update">, z.ZodLiteral<"device-group:delete">, z.ZodLiteral<"device-group:create">, z.ZodLiteral<"macro:read">, z.ZodLiteral<"macro:update">, z.ZodLiteral<"macro:delete">, z.ZodLiteral<"macro:create">, z.ZodLiteral<"macro:run">, z.ZodLiteral<"template:read">, z.ZodLiteral<"template:update">, z.ZodLiteral<"template:delete">, z.ZodLiteral<"template:create">, z.ZodLiteral<"custom-field:read">, z.ZodLiteral<"custom-field:update">, z.ZodLiteral<"custom-field:delete">, z.ZodLiteral<"custom-field:create">, z.ZodLiteral<"media:read">, z.ZodLiteral<"about:read">, z.ZodLiteral<"intercom:read">, z.ZodLiteral<"display:read">, ...(z.ZodLiteral<"device:camera"> | z.ZodLiteral<"device:door"> | z.ZodLiteral<"device:motion-sensor"> | z.ZodLiteral<"device:panic-button"> | z.ZodLiteral<"device:intercom-terminal"> | z.ZodLiteral<"device:display"> | z.ZodLiteral<"device:nvr-recorder"> | z.ZodLiteral<"device:nvr-exporter"> | z.ZodLiteral<"device:nvr-analytics-server"> | z.ZodLiteral<"device:system">)[], z.ZodLiteral<"security-level:read">, z.ZodLiteral<"security-level:update">, z.ZodLiteral<"security-level:delete">, z.ZodLiteral<"security-level:create">, z.ZodLiteral<"citadel-mode:toggle">, z.ZodLiteral<"token-conversion:read">, z.ZodLiteral<"token-conversion:update">, z.ZodLiteral<"token-conversion:delete">, z.ZodLiteral<"token-conversion:create">, z.ZodLiteral<"bookmark:read">, z.ZodLiteral<"bookmark:create">, z.ZodLiteral<"bookmark:update">, z.ZodLiteral<"bookmark:delete">, z.ZodLiteral<"access-path:read">, z.ZodLiteral<"access-path:create">, z.ZodLiteral<"access-path:update">, z.ZodLiteral<"access-path:delete">, z.ZodLiteral<"person-type:create">, z.ZodLiteral<"person-type:update">, z.ZodLiteral<"person-type:delete">, z.ZodLiteral<"agreement:create">, z.ZodLiteral<"agreement:update">, z.ZodLiteral<"agreement:delete">, z.ZodLiteral<"api-key:create">, z.ZodLiteral<"api-key:revoke">]>;
 export type PermissionArea = 'layout' | 'camera' | 'preset' | 'door' | 'public-view' | 'private-view' | 'person' | 'door-group' | 'access-rule' | 'schedule' | 'presence' | 'factory' | 'event' | 'alarm' | 'user' | 'role' | 'device' | 'module' | 'automation' | 'device-group' | 'macro' | 'template' | 'custom-field' | 'media' | 'about' | 'intercom' | 'device' | 'display' | 'security-level' | 'citadel-mode' | 'token-conversion' | 'bookmark' | 'access-path' | 'person-type' | 'agreement' | 'api-key';
-export declare const permissions: Record<"device:camera" | "device:door" | "device:motion-sensor" | "device:panic-button" | "device:intercom-terminal" | "device:display" | "device:nvr-recorder" | "device:nvr-exporter" | "device:nvr-analytics-server" | "layout:read" | "layout:update" | "layout:delete" | "layout:create" | "camera:live" | "camera:playback" | "camera:playback-export" | "camera:ptz" | "camera:privacy-mode" | "camera:assign" | "camera:detection" | "preset:read" | "preset:update" | "preset:delete" | "preset:create" | "door:release" | "door:lock" | "camera-lift:activate" | "io-board:activate" | "public-view:read" | "public-view:update" | "public-view:delete" | "public-view:create" | "private-view:read" | "private-view:update" | "private-view:delete" | "private-view:create" | "person:read" | "person:update" | "person:delete" | "person:create" | "person:assign" | "person:print" | "door-group:read" | "door-group:update" | "door-group:delete" | "door-group:create" | "access-rule:read" | "access-rule:update" | "access-rule:delete" | "access-rule:create" | "schedule:read" | "schedule:update" | "schedule:delete" | "schedule:create" | "presence:read" | "presence:update" | "presence:update-reader" | "factory:read" | "factory:update" | "factory:delete" | "factory:create" | "event:read" | "event:purge" | "alarm:read" | "alarm:acknowlede" | "alarm:arm" | "alarm:trigger" | "alarm:bypass" | "user:read" | "user:change-password" | "user:change-username" | "user:change-name" | "user:change-email" | "user:activate" | "user:delete" | "user:change-roles" | "user:create" | "role:read" | "role:create" | "role:delete" | "role:update" | "module:read" | "module:update" | "module:enable" | "device:discover" | "device:import" | "device:override-specs" | "device:notes" | "device:alarms" | "device:adjacent-cameras" | "automation:read" | "automation:update" | "automation:delete" | "automation:create" | "device-group:read" | "device-group:update" | "device-group:delete" | "device-group:create" | "macro:read" | "macro:update" | "macro:delete" | "macro:create" | "macro:run" | "template:read" | "template:update" | "template:delete" | "template:create" | "custom-field:read" | "custom-field:update" | "custom-field:delete" | "custom-field:create" | "media:read" | "about:read" | "intercom:read" | "display:read" | "security-level:read" | "security-level:update" | "security-level:delete" | "security-level:create" | "citadel-mode:toggle" | "token-conversion:read" | "token-conversion:update" | "token-conversion:delete" | "token-conversion:create" | "bookmark:read" | "bookmark:create" | "bookmark:update" | "bookmark:delete" | "access-path:read" | "access-path:create" | "access-path:update" | "access-path:delete" | "person-type:create" | "person-type:update" | "person-type:delete" | "agreement:create" | "agreement:update" | "agreement:delete" | "api-key:create" | "api-key:revoke", string>;
-export declare const permissionsArray: ("device:camera" | "device:door" | "device:motion-sensor" | "device:panic-button" | "device:intercom-terminal" | "device:display" | "device:nvr-recorder" | "device:nvr-exporter" | "device:nvr-analytics-server" | "layout:read" | "layout:update" | "layout:delete" | "layout:create" | "camera:live" | "camera:playback" | "camera:playback-export" | "camera:ptz" | "camera:privacy-mode" | "camera:assign" | "camera:detection" | "preset:read" | "preset:update" | "preset:delete" | "preset:create" | "door:release" | "door:lock" | "camera-lift:activate" | "io-board:activate" | "public-view:read" | "public-view:update" | "public-view:delete" | "public-view:create" | "private-view:read" | "private-view:update" | "private-view:delete" | "private-view:create" | "person:read" | "person:update" | "person:delete" | "person:create" | "person:assign" | "person:print" | "door-group:read" | "door-group:update" | "door-group:delete" | "door-group:create" | "access-rule:read" | "access-rule:update" | "access-rule:delete" | "access-rule:create" | "schedule:read" | "schedule:update" | "schedule:delete" | "schedule:create" | "presence:read" | "presence:update" | "presence:update-reader" | "factory:read" | "factory:update" | "factory:delete" | "factory:create" | "event:read" | "event:purge" | "alarm:read" | "alarm:acknowlede" | "alarm:arm" | "alarm:trigger" | "alarm:bypass" | "user:read" | "user:change-password" | "user:change-username" | "user:change-name" | "user:change-email" | "user:activate" | "user:delete" | "user:change-roles" | "user:create" | "role:read" | "role:create" | "role:delete" | "role:update" | "module:read" | "module:update" | "module:enable" | "device:discover" | "device:import" | "device:override-specs" | "device:notes" | "device:alarms" | "device:adjacent-cameras" | "automation:read" | "automation:update" | "automation:delete" | "automation:create" | "device-group:read" | "device-group:update" | "device-group:delete" | "device-group:create" | "macro:read" | "macro:update" | "macro:delete" | "macro:create" | "macro:run" | "template:read" | "template:update" | "template:delete" | "template:create" | "custom-field:read" | "custom-field:update" | "custom-field:delete" | "custom-field:create" | "media:read" | "about:read" | "intercom:read" | "display:read" | "security-level:read" | "security-level:update" | "security-level:delete" | "security-level:create" | "citadel-mode:toggle" | "token-conversion:read" | "token-conversion:update" | "token-conversion:delete" | "token-conversion:create" | "bookmark:read" | "bookmark:create" | "bookmark:update" | "bookmark:delete" | "access-path:read" | "access-path:create" | "access-path:update" | "access-path:delete" | "person-type:create" | "person-type:update" | "person-type:delete" | "agreement:create" | "agreement:update" | "agreement:delete" | "api-key:create" | "api-key:revoke")[];
+export declare const permissions: Record<"device:camera" | "device:door" | "device:motion-sensor" | "device:panic-button" | "device:intercom-terminal" | "device:display" | "device:nvr-recorder" | "device:nvr-exporter" | "device:nvr-analytics-server" | "device:system" | "layout:read" | "layout:update" | "layout:delete" | "layout:create" | "camera:live" | "camera:playback" | "camera:playback-export" | "camera:ptz" | "camera:privacy-mode" | "camera:assign" | "camera:detection" | "preset:read" | "preset:update" | "preset:delete" | "preset:create" | "door:release" | "door:lock" | "camera-lift:activate" | "io-board:activate" | "public-view:read" | "public-view:update" | "public-view:delete" | "public-view:create" | "private-view:read" | "private-view:update" | "private-view:delete" | "private-view:create" | "person:read" | "person:update" | "person:delete" | "person:create" | "person:assign" | "person:print" | "door-group:read" | "door-group:update" | "door-group:delete" | "door-group:create" | "access-rule:read" | "access-rule:update" | "access-rule:delete" | "access-rule:create" | "schedule:read" | "schedule:update" | "schedule:delete" | "schedule:create" | "presence:read" | "presence:update" | "presence:update-reader" | "factory:read" | "factory:update" | "factory:delete" | "factory:create" | "event:read" | "event:purge" | "alarm:read" | "alarm:acknowlede" | "alarm:arm" | "alarm:trigger" | "alarm:bypass" | "user:read" | "user:change-password" | "user:change-username" | "user:change-name" | "user:change-email" | "user:activate" | "user:delete" | "user:change-roles" | "user:create" | "role:read" | "role:create" | "role:delete" | "role:update" | "module:read" | "module:update" | "module:enable" | "device:discover" | "device:import" | "device:override-specs" | "device:notes" | "device:alarms" | "device:adjacent-cameras" | "automation:read" | "automation:update" | "automation:delete" | "automation:create" | "device-group:read" | "device-group:update" | "device-group:delete" | "device-group:create" | "macro:read" | "macro:update" | "macro:delete" | "macro:create" | "macro:run" | "template:read" | "template:update" | "template:delete" | "template:create" | "custom-field:read" | "custom-field:update" | "custom-field:delete" | "custom-field:create" | "media:read" | "about:read" | "intercom:read" | "display:read" | "security-level:read" | "security-level:update" | "security-level:delete" | "security-level:create" | "citadel-mode:toggle" | "token-conversion:read" | "token-conversion:update" | "token-conversion:delete" | "token-conversion:create" | "bookmark:read" | "bookmark:create" | "bookmark:update" | "bookmark:delete" | "access-path:read" | "access-path:create" | "access-path:update" | "access-path:delete" | "person-type:create" | "person-type:update" | "person-type:delete" | "agreement:create" | "agreement:update" | "agreement:delete" | "api-key:create" | "api-key:revoke", string>;
+export declare const permissionsArray: ("device:camera" | "device:door" | "device:motion-sensor" | "device:panic-button" | "device:intercom-terminal" | "device:display" | "device:nvr-recorder" | "device:nvr-exporter" | "device:nvr-analytics-server" | "device:system" | "layout:read" | "layout:update" | "layout:delete" | "layout:create" | "camera:live" | "camera:playback" | "camera:playback-export" | "camera:ptz" | "camera:privacy-mode" | "camera:assign" | "camera:detection" | "preset:read" | "preset:update" | "preset:delete" | "preset:create" | "door:release" | "door:lock" | "camera-lift:activate" | "io-board:activate" | "public-view:read" | "public-view:update" | "public-view:delete" | "public-view:create" | "private-view:read" | "private-view:update" | "private-view:delete" | "private-view:create" | "person:read" | "person:update" | "person:delete" | "person:create" | "person:assign" | "person:print" | "door-group:read" | "door-group:update" | "door-group:delete" | "door-group:create" | "access-rule:read" | "access-rule:update" | "access-rule:delete" | "access-rule:create" | "schedule:read" | "schedule:update" | "schedule:delete" | "schedule:create" | "presence:read" | "presence:update" | "presence:update-reader" | "factory:read" | "factory:update" | "factory:delete" | "factory:create" | "event:read" | "event:purge" | "alarm:read" | "alarm:acknowlede" | "alarm:arm" | "alarm:trigger" | "alarm:bypass" | "user:read" | "user:change-password" | "user:change-username" | "user:change-name" | "user:change-email" | "user:activate" | "user:delete" | "user:change-roles" | "user:create" | "role:read" | "role:create" | "role:delete" | "role:update" | "module:read" | "module:update" | "module:enable" | "device:discover" | "device:import" | "device:override-specs" | "device:notes" | "device:alarms" | "device:adjacent-cameras" | "automation:read" | "automation:update" | "automation:delete" | "automation:create" | "device-group:read" | "device-group:update" | "device-group:delete" | "device-group:create" | "macro:read" | "macro:update" | "macro:delete" | "macro:create" | "macro:run" | "template:read" | "template:update" | "template:delete" | "template:create" | "custom-field:read" | "custom-field:update" | "custom-field:delete" | "custom-field:create" | "media:read" | "about:read" | "intercom:read" | "display:read" | "security-level:read" | "security-level:update" | "security-level:delete" | "security-level:create" | "citadel-mode:toggle" | "token-conversion:read" | "token-conversion:update" | "token-conversion:delete" | "token-conversion:create" | "bookmark:read" | "bookmark:create" | "bookmark:update" | "bookmark:delete" | "access-path:read" | "access-path:create" | "access-path:update" | "access-path:delete" | "person-type:create" | "person-type:update" | "person-type:delete" | "agreement:create" | "agreement:update" | "agreement:delete" | "api-key:create" | "api-key:revoke")[];
 export type PermissionId = z.infer<typeof sPermissionId>;

package/dist/permissions.js

@@ -25,6 +25,7 @@ const deviceTypePermissions = {
     'nvr-analytics-server': zod_1.z
         .literal('device:nvr-analytics-server')
         .describe('View NVR analytics servers'),
+    system: zod_1.z.literal('device:system').describe('View system devices'),
 };
 const sDeviceTypePermissions = Object.values(deviceTypePermissions);
 exports.sPermissionId = zod_1.z.union([

package/dist/primitives.d.ts

@@ -263,6 +263,12 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
     type: "nvr-analytics-server";
 }, {
     type: "nvr-analytics-server";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"system">;
+}, "strip", z.ZodTypeAny, {
+    type: "system";
+}, {
+    type: "system";
 }>]>>;
 export declare const sDeviceParam: z.ZodUnion<[z.ZodString, z.ZodIntersection<z.ZodObject<{
     name: z.ZodString;
@@ -510,4 +516,12 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodString, z.ZodIntersection<z.
     type: "nvr-analytics-server";
 }, {
     type: "nvr-analytics-server";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"system">;
+}, "strip", z.ZodTypeAny, {
+    type: "system";
+}, {
+    type: "system";
 }>]>>]>;
+export declare const sNotificationSeverity: z.ZodEnum<["info", "warning", "critical"]>;
+export type NotificationSeverity = z.infer<typeof sNotificationSeverity>;

package/dist/primitives.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sDeviceParam = exports.sAgentDeviceInfo = exports.sFileResponse = exports.sUrl = exports.sDuration = exports.sMacroId = exports.sZoneId = exports.sPersonId = exports.sDeviceEvent = exports.sPresetId = exports.sDeviceId = void 0;
+exports.sNotificationSeverity = exports.sDeviceParam = exports.sAgentDeviceInfo = exports.sFileResponse = exports.sUrl = exports.sDuration = exports.sMacroId = exports.sZoneId = exports.sPersonId = exports.sDeviceEvent = exports.sPresetId = exports.sDeviceId = void 0;
 const zod_1 = require("zod");
 const device_1 = require("./device");
 exports.sDeviceId = zod_1.z.string().uuid().nonempty();
@@ -23,3 +23,4 @@ exports.sAgentDeviceInfo = zod_1.z.intersection(device_1.sForeignDeviceInfo, dev
 }));
 // reusable device argument. This schema can be checked at runtime to see if it's a device ID or full device info and substituted accordingly.
 exports.sDeviceParam = exports.sDeviceId.or(exports.sAgentDeviceInfo);
+exports.sNotificationSeverity = zod_1.z.enum(['info', 'warning', 'critical']);