@awarevue/api-types 2.0.13 → 2.0.15

package/dist/device-event.js

@@ -1,112 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isDeviceEvent = exports.eventsByDeviceType = exports.eventSchemaByKind = exports.eventKindLabels = exports.sEventHeader = exports.sMotionDetected = void 0;
-const zod_1 = require("zod");
-const alarm_1 = require("./device/alarm");
-const camera_1 = require("./device/camera");
-const door_1 = require("./device/door");
-const intercom_terminal_1 = require("./device/intercom-terminal");
-const io_board_1 = require("./device/io-board");
-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'),
-});
-exports.sEventHeader = zod_1.z.object({
-    id: zod_1.z.string().nonempty(),
-    timestamp: zod_1.z.number().int().positive(),
-    deviceId: zod_1.z.string().nonempty(),
-    observedBy: zod_1.z.string().optional(),
-});
-exports.eventKindLabels = {
-    'door-access': 'Door Access',
-    'door-force': 'Force-Opened',
-    'door-tamper': 'Tampered',
-    'door-left-open': 'Left Open',
-    'alarm-triggered': 'Alarm Triggered',
-    'alarm-acknowledged': 'Alarm Acknowledged',
-    'door-relock': 'Relocked',
-    'door-mains-failed': 'Mains Failed',
-    'door-acu-not-responding': 'ACU Not Responding',
-    'door-acu-online': 'ACU Online',
-    'door-mains-restored': 'Mains Restored',
-    'door-tamper-restored': 'Tamper Restored',
-    'motion-detected': 'Motion Detected',
-    'device-command': 'Device Command',
-    'reader-auth': 'Reader Authorized',
-    'alarm-arm-released': 'Alarm Arm Released',
-    'alarm-rearmed': 'Alarm Rearmed',
-    'alarm-armed': 'Alarm Armed',
-    'alarm-disarmed': 'Alarm Disarmed',
-    'alarm-armed-all': 'Alarm Armed All',
-    'alarm-disarmed-all': 'Alarm Disarmed All',
-    'panic-button-pressed': 'Panic Button Pressed',
-    'device-connected': 'Device Connected',
-    'device-disconnected': 'Device Disconnected',
-    'call-state-changed': 'Call State Changed',
-    'object-created': 'Object Created',
-    'object-updated': 'Object Updated',
-    'object-deleted': 'Object Deleted',
-    'ptz-preset-saved': 'PTZ Preset Saved on Device',
-    'person-in': 'Person Checked In',
-    'person-out': 'Person Checked Out',
-    'object-detection-started': 'Object Detection Started',
-    'object-detection-updated': 'Object Detection Updated',
-    'object-detection-ended': 'Object Detection Ended',
-    'scene-created': 'Scene Created',
-    'scene-updated': 'Scene Updated',
-    'scene-ended': 'Scene Ended',
-    'io-board-input-changed': 'IO Board Input Changed',
-    'agent-started': 'Agent Started',
-    'agent-stopped': 'Agent Stopped',
-    'door-opened': 'Door Opened',
-    '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,
-    ...camera_1.cameraEventSchemasByKind,
-    ...door_1.doorEventSchemaByKind,
-    ...intercom_terminal_1.intercomTerminalEventSchemaByKind,
-    ...io_board_1.ioBoardEventSchemaByKind,
-    ...panic_button_1.panicButtonEventSchemaByKind,
-    ...presence_tracker_1.presenceTrackerEventSchemaByKind,
-    ...index_1.readerEventSchemaByKind,
-    ...nvr_exporter_1.nvrExporterEventSchemasByKind,
-    ...system_1.systemDeviceEventSchemasByKind,
-    'motion-detected': exports.sMotionDetected,
-};
-exports.eventsByDeviceType = {
-    camera: [
-        ...Object.keys(camera_1.cameraEventSchemasByKind),
-        'motion-detected',
-    ],
-    door: Object.keys(door_1.doorEventSchemaByKind),
-    'io-board': Object.keys(io_board_1.ioBoardEventSchemaByKind),
-    'panic-button': Object.keys(panic_button_1.panicButtonEventSchemaByKind),
-    'presence-tracker': Object.keys(presence_tracker_1.presenceTrackerEventSchemaByKind),
-    reader: Object.keys(index_1.readerEventSchemaByKind),
-    'motion-sensor': ['motion-detected'],
-    'nvr-exporter': Object.keys(nvr_exporter_1.nvrExporterEventSchemasByKind),
-};
-const isDeviceEvent = (event) => {
-    if (typeof event !== 'object' || event === null)
-        return false;
-    if (!('kind' in event))
-        return false;
-    if (typeof event.kind !== 'string')
-        return false;
-    const schema = exports.eventSchemaByKind[event.kind];
-    if (!schema)
-        return false;
-    const result = schema.safeParse(event);
-    if (!result.success)
-        return false;
-    return true;
-};
-exports.isDeviceEvent = isDeviceEvent;

package/dist/device-group.d.ts

@@ -10,16 +10,16 @@ export declare const sDeviceGroup: z.ZodObject<{
     code: string | null;
     id: string;
     displayName: string;
+    devices: string[];
     createdOn: string;
     lastModifiedOn: string;
-    devices: string[];
 }, {
     code: string | null;
     id: string;
     displayName: string;
+    devices: string[];
     createdOn: string;
     lastModifiedOn: string;
-    devices: string[];
 }>;
 export type DeviceGroupDto = z.infer<typeof sDeviceGroup>;
 export declare const sAddGroupRequest: z.ZodObject<{

package/dist/device-import.d.ts

@@ -1287,8 +1287,6 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         groups: string[];
         id: string;
-        createdOn: string;
-        lastModifiedOn: string;
         tags: string[];
         relations: z.objectOutputType<{
             id: z.ZodString;
@@ -1303,14 +1301,14 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
             lastModifiedOn: string;
             params?: unknown;
         }[];
+        createdOn: string;
+        lastModifiedOn: string;
         providerAssignedName: string;
         notes: string | null;
         enabled: boolean;
     }, {
         groups: string[];
         id: string;
-        createdOn: string;
-        lastModifiedOn: string;
         tags: string[];
         relations: z.objectInputType<{
             id: z.ZodString;
@@ -1325,6 +1323,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
             lastModifiedOn: string;
             params?: unknown;
         }[];
+        createdOn: string;
+        lastModifiedOn: string;
         providerAssignedName: string;
         notes: string | null;
         enabled: boolean;
@@ -1447,8 +1447,6 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
     }) & {
         groups: string[];
         id: string;
-        createdOn: string;
-        lastModifiedOn: string;
         tags: string[];
         relations: z.objectOutputType<{
             id: z.ZodString;
@@ -1463,6 +1461,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
             lastModifiedOn: string;
             params?: unknown;
         }[];
+        createdOn: string;
+        lastModifiedOn: string;
         providerAssignedName: string;
         notes: string | null;
         enabled: boolean;
@@ -1646,8 +1646,6 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
     }) & {
         groups: string[];
         id: string;
-        createdOn: string;
-        lastModifiedOn: string;
         tags: string[];
         relations: z.objectInputType<{
             id: z.ZodString;
@@ -1662,6 +1660,8 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
             lastModifiedOn: string;
             params?: unknown;
         }[];
+        createdOn: string;
+        lastModifiedOn: string;
         providerAssignedName: string;
         notes: string | null;
         enabled: boolean;

package/dist/events/alarm.d.ts

@@ -0,0 +1,220 @@
+import { z } from 'zod';
+export declare const sAlarmTriggeredEvent: z.ZodObject<{
+    kind: z.ZodLiteral<"alarm-triggered">;
+    alarmId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    kind: "alarm-triggered";
+    alarmId: string;
+}, {
+    kind: "alarm-triggered";
+    alarmId: string;
+}>;
+export declare const sAlarmAcknowledgedEvent: z.ZodObject<{
+    kind: z.ZodLiteral<"alarm-acknowledged">;
+    alarmId: z.ZodString;
+    userId: z.ZodOptional<z.ZodString>;
+    personId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    kind: "alarm-acknowledged";
+    alarmId: string;
+    personId?: string | undefined;
+    userId?: string | undefined;
+}, {
+    kind: "alarm-acknowledged";
+    alarmId: string;
+    personId?: string | undefined;
+    userId?: string | undefined;
+}>;
+export declare const sAlarmArmedAllEvent: z.ZodObject<{
+    kind: z.ZodLiteral<"alarm-armed-all">;
+    userId: z.ZodOptional<z.ZodString>;
+    personId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    kind: "alarm-armed-all";
+    personId?: string | undefined;
+    userId?: string | undefined;
+}, {
+    kind: "alarm-armed-all";
+    personId?: string | undefined;
+    userId?: string | undefined;
+}>;
+export declare const sAlarmDisarmedAllEvent: z.ZodObject<{
+    kind: z.ZodLiteral<"alarm-disarmed-all">;
+    userId: z.ZodOptional<z.ZodString>;
+    personId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    kind: "alarm-disarmed-all";
+    personId?: string | undefined;
+    userId?: string | undefined;
+}, {
+    kind: "alarm-disarmed-all";
+    personId?: string | undefined;
+    userId?: string | undefined;
+}>;
+export declare const sAlarmArmedEvent: z.ZodObject<{
+    kind: z.ZodLiteral<"alarm-armed">;
+    subjects: z.ZodArray<z.ZodString, "many">;
+    userId: z.ZodOptional<z.ZodString>;
+    personId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    kind: "alarm-armed";
+    subjects: string[];
+    personId?: string | undefined;
+    userId?: string | undefined;
+}, {
+    kind: "alarm-armed";
+    subjects: string[];
+    personId?: string | undefined;
+    userId?: string | undefined;
+}>;
+export declare const sAlarmDisarmedEvent: z.ZodObject<{
+    kind: z.ZodLiteral<"alarm-disarmed">;
+    subjects: z.ZodArray<z.ZodString, "many">;
+    userId: z.ZodOptional<z.ZodString>;
+    personId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    kind: "alarm-disarmed";
+    subjects: string[];
+    personId?: string | undefined;
+    userId?: string | undefined;
+}, {
+    kind: "alarm-disarmed";
+    subjects: string[];
+    personId?: string | undefined;
+    userId?: string | undefined;
+}>;
+export declare const sAlarmArmReleasedEvent: z.ZodObject<{
+    kind: z.ZodLiteral<"alarm-arm-released">;
+    userId: z.ZodOptional<z.ZodString>;
+    personId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    kind: "alarm-arm-released";
+    personId?: string | undefined;
+    userId?: string | undefined;
+}, {
+    kind: "alarm-arm-released";
+    personId?: string | undefined;
+    userId?: string | undefined;
+}>;
+export declare const sAlarmRearmedEvent: z.ZodObject<{
+    kind: z.ZodLiteral<"alarm-rearmed">;
+}, "strip", z.ZodTypeAny, {
+    kind: "alarm-rearmed";
+}, {
+    kind: "alarm-rearmed";
+}>;
+export declare const alarmEventSchemasByKind: {
+    readonly 'alarm-triggered': z.ZodObject<{
+        kind: z.ZodLiteral<"alarm-triggered">;
+        alarmId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        kind: "alarm-triggered";
+        alarmId: string;
+    }, {
+        kind: "alarm-triggered";
+        alarmId: string;
+    }>;
+    readonly 'alarm-acknowledged': z.ZodObject<{
+        kind: z.ZodLiteral<"alarm-acknowledged">;
+        alarmId: z.ZodString;
+        userId: z.ZodOptional<z.ZodString>;
+        personId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        kind: "alarm-acknowledged";
+        alarmId: string;
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }, {
+        kind: "alarm-acknowledged";
+        alarmId: string;
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }>;
+    readonly 'alarm-armed-all': z.ZodObject<{
+        kind: z.ZodLiteral<"alarm-armed-all">;
+        userId: z.ZodOptional<z.ZodString>;
+        personId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        kind: "alarm-armed-all";
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }, {
+        kind: "alarm-armed-all";
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }>;
+    readonly 'alarm-disarmed-all': z.ZodObject<{
+        kind: z.ZodLiteral<"alarm-disarmed-all">;
+        userId: z.ZodOptional<z.ZodString>;
+        personId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        kind: "alarm-disarmed-all";
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }, {
+        kind: "alarm-disarmed-all";
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }>;
+    readonly 'alarm-armed': z.ZodObject<{
+        kind: z.ZodLiteral<"alarm-armed">;
+        subjects: z.ZodArray<z.ZodString, "many">;
+        userId: z.ZodOptional<z.ZodString>;
+        personId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        kind: "alarm-armed";
+        subjects: string[];
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }, {
+        kind: "alarm-armed";
+        subjects: string[];
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }>;
+    readonly 'alarm-disarmed': z.ZodObject<{
+        kind: z.ZodLiteral<"alarm-disarmed">;
+        subjects: z.ZodArray<z.ZodString, "many">;
+        userId: z.ZodOptional<z.ZodString>;
+        personId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        kind: "alarm-disarmed";
+        subjects: string[];
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }, {
+        kind: "alarm-disarmed";
+        subjects: string[];
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }>;
+    readonly 'alarm-arm-released': z.ZodObject<{
+        kind: z.ZodLiteral<"alarm-arm-released">;
+        userId: z.ZodOptional<z.ZodString>;
+        personId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        kind: "alarm-arm-released";
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }, {
+        kind: "alarm-arm-released";
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }>;
+    readonly 'alarm-rearmed': z.ZodObject<{
+        kind: z.ZodLiteral<"alarm-rearmed">;
+    }, "strip", z.ZodTypeAny, {
+        kind: "alarm-rearmed";
+    }, {
+        kind: "alarm-rearmed";
+    }>;
+};
+export type AlarmTriggeredEvent = z.infer<typeof sAlarmTriggeredEvent>;
+export type AlarmAcknowledgedEvent = z.infer<typeof sAlarmAcknowledgedEvent>;
+export type AlarmArmedAllEvent = z.infer<typeof sAlarmArmedAllEvent>;
+export type AlarmDisarmedAllEvent = z.infer<typeof sAlarmDisarmedAllEvent>;
+export type AlarmArmedEvent = z.infer<typeof sAlarmArmedEvent>;
+export type AlarmDisarmedEvent = z.infer<typeof sAlarmDisarmedEvent>;
+export type AlarmArmReleasedEvent = z.infer<typeof sAlarmArmReleasedEvent>;
+export type AlarmRearmedEvent = z.infer<typeof sAlarmRearmedEvent>;
+export type AlarmEvent = AlarmTriggeredEvent | AlarmAcknowledgedEvent | AlarmArmedAllEvent | AlarmDisarmedAllEvent | AlarmArmedEvent | AlarmDisarmedEvent | AlarmArmReleasedEvent | AlarmRearmedEvent;

package/dist/events/alarm.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.alarmEventSchemasByKind = exports.sAlarmRearmedEvent = exports.sAlarmArmReleasedEvent = exports.sAlarmDisarmedEvent = exports.sAlarmArmedEvent = exports.sAlarmDisarmedAllEvent = exports.sAlarmArmedAllEvent = exports.sAlarmAcknowledgedEvent = exports.sAlarmTriggeredEvent = void 0;
+const zod_1 = require("zod");
+// EVENTS
+exports.sAlarmTriggeredEvent = zod_1.z.object({
+    kind: zod_1.z.literal('alarm-triggered'),
+    alarmId: zod_1.z.string().nonempty(),
+});
+exports.sAlarmAcknowledgedEvent = zod_1.z.object({
+    kind: zod_1.z.literal('alarm-acknowledged'),
+    alarmId: zod_1.z.string().nonempty(),
+    userId: zod_1.z.string().optional(),
+    personId: zod_1.z.string().optional(),
+});
+exports.sAlarmArmedAllEvent = zod_1.z.object({
+    kind: zod_1.z.literal('alarm-armed-all'),
+    userId: zod_1.z.string().optional(),
+    personId: zod_1.z.string().optional(),
+});
+exports.sAlarmDisarmedAllEvent = zod_1.z.object({
+    kind: zod_1.z.literal('alarm-disarmed-all'),
+    userId: zod_1.z.string().optional(),
+    personId: zod_1.z.string().optional(),
+});
+exports.sAlarmArmedEvent = zod_1.z.object({
+    kind: zod_1.z.literal('alarm-armed'),
+    subjects: zod_1.z.array(zod_1.z.string().nonempty()),
+    userId: zod_1.z.string().optional(),
+    personId: zod_1.z.string().optional(),
+});
+exports.sAlarmDisarmedEvent = zod_1.z.object({
+    kind: zod_1.z.literal('alarm-disarmed'),
+    subjects: zod_1.z.array(zod_1.z.string().nonempty()),
+    userId: zod_1.z.string().optional(),
+    personId: zod_1.z.string().optional(),
+});
+exports.sAlarmArmReleasedEvent = zod_1.z.object({
+    kind: zod_1.z.literal('alarm-arm-released'),
+    userId: zod_1.z.string().optional(),
+    personId: zod_1.z.string().optional(),
+});
+exports.sAlarmRearmedEvent = zod_1.z.object({
+    kind: zod_1.z.literal('alarm-rearmed'),
+});
+exports.alarmEventSchemasByKind = {
+    'alarm-triggered': exports.sAlarmTriggeredEvent,
+    'alarm-acknowledged': exports.sAlarmAcknowledgedEvent,
+    'alarm-armed-all': exports.sAlarmArmedAllEvent,
+    'alarm-disarmed-all': exports.sAlarmDisarmedAllEvent,
+    'alarm-armed': exports.sAlarmArmedEvent,
+    'alarm-disarmed': exports.sAlarmDisarmedEvent,
+    'alarm-arm-released': exports.sAlarmArmReleasedEvent,
+    'alarm-rearmed': exports.sAlarmRearmedEvent,
+};