@awarevue/api-types 1.0.1

package/dist/device-event.d.ts

@@ -0,0 +1,682 @@
+import { z } from 'zod';
+import { AlarmEvent } from './device/alarm';
+import { CameraEvent } from './device/camera';
+import { DeviceGatewayEvent } from './device/device-gateway';
+import { DoorEvent } from './device/door';
+import { IntercomTerminalEvent } from './device/intercom-terminal';
+import { IoBoardEvent } from './device/io-board';
+import { PanicButtonEvent } from './device/panic-button';
+import { PresenceTrackerEvent } from './device/presence-tracker';
+import { ReaderEvent } from './device/reader/index';
+import { ServerEvent } from './device/server';
+export interface DeviceCommandTriggered {
+    kind: 'device-command';
+    userId?: string;
+    command: string;
+    args: object;
+}
+export interface MotionDetectedEvent {
+    kind: 'motion-detected';
+}
+export interface DeviceConnectedEvent {
+    kind: 'device-connected';
+    clientId?: number;
+}
+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;
+export declare const sEventHeader: z.ZodObject<{
+    id: z.ZodString;
+    timestamp: z.ZodNumber;
+    deviceId: z.ZodString;
+    observedBy: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    deviceId: string;
+    timestamp: number;
+    observedBy?: string | undefined;
+}, {
+    id: string;
+    deviceId: string;
+    timestamp: number;
+    observedBy?: string | undefined;
+}>;
+type EventHeader = z.infer<typeof sEventHeader>;
+export type DeviceEvent<TEvent extends AnyDeviceEvent = AnyDeviceEvent> = EventHeader & TEvent;
+export declare const eventKindLabels: Record<DeviceEvent['kind'], string>;
+export declare const eventSchemaByKind: {
+    'reader-auth': z.ZodObject<{
+        kind: z.ZodLiteral<"reader-auth">;
+        token: z.ZodNullable<z.ZodString>;
+        personId: z.ZodOptional<z.ZodString>;
+        allowed: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        kind: "reader-auth";
+        token: string | null;
+        allowed: boolean;
+        personId?: string | undefined;
+    }, {
+        kind: "reader-auth";
+        token: string | null;
+        allowed: boolean;
+        personId?: string | undefined;
+    }>;
+    'person-in': z.ZodObject<{
+        kind: z.ZodLiteral<"person-in">;
+        personId: z.ZodString;
+        personFirstName: z.ZodString;
+        personLastName: z.ZodString;
+        personAvatarId: z.ZodNullable<z.ZodString>;
+        zoneId: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        kind: "person-in";
+        personId: string;
+        zoneId: string | null;
+        personFirstName: string;
+        personLastName: string;
+        personAvatarId: string | null;
+    }, {
+        kind: "person-in";
+        personId: string;
+        zoneId: string | null;
+        personFirstName: string;
+        personLastName: string;
+        personAvatarId: string | null;
+    }>;
+    'person-out': z.ZodObject<{
+        kind: z.ZodLiteral<"person-out">;
+        personId: z.ZodString;
+        personFirstName: z.ZodString;
+        personLastName: z.ZodString;
+        personAvatarId: z.ZodNullable<z.ZodString>;
+        isLeave: z.ZodBoolean;
+        zoneId: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        kind: "person-out";
+        personId: string;
+        isLeave: boolean;
+        zoneId: string | null;
+        personFirstName: string;
+        personLastName: string;
+        personAvatarId: string | null;
+    }, {
+        kind: "person-out";
+        personId: string;
+        isLeave: boolean;
+        zoneId: string | null;
+        personFirstName: string;
+        personLastName: string;
+        personAvatarId: string | null;
+    }>;
+    'panic-button-pressed': z.ZodObject<{
+        kind: z.ZodLiteral<"panic-button-pressed">;
+    }, "strip", z.ZodTypeAny, {
+        kind: "panic-button-pressed";
+    }, {
+        kind: "panic-button-pressed";
+    }>;
+    'io-board-input-changed': z.ZodObject<{
+        kind: z.ZodLiteral<"io-board-input-changed">;
+        inputName: z.ZodString;
+        value: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        value: boolean;
+        kind: "io-board-input-changed";
+        inputName: string;
+    }, {
+        value: boolean;
+        kind: "io-board-input-changed";
+        inputName: string;
+    }>;
+    'intercom-call': z.ZodObject<{
+        kind: z.ZodLiteral<"intercom-call">;
+        userId: z.ZodOptional<z.ZodString>;
+        personId: z.ZodOptional<z.ZodString>;
+        callId: z.ZodString;
+        offerSdp: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        kind: "intercom-call";
+        callId: string;
+        offerSdp: string;
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }, {
+        kind: "intercom-call";
+        callId: string;
+        offerSdp: string;
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }>;
+    'intercom-call-cancelled': z.ZodObject<{
+        kind: z.ZodLiteral<"intercom-call-cancelled">;
+        userId: z.ZodOptional<z.ZodString>;
+        callId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        kind: "intercom-call-cancelled";
+        callId: string;
+        userId?: string | undefined;
+    }, {
+        kind: "intercom-call-cancelled";
+        callId: string;
+        userId?: string | undefined;
+    }>;
+    'intercom-call-answered': z.ZodObject<{
+        kind: z.ZodLiteral<"intercom-call-answered">;
+        userId: z.ZodOptional<z.ZodString>;
+        userAgentId: z.ZodString;
+        callId: z.ZodString;
+        answerSdp: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        kind: "intercom-call-answered";
+        callId: string;
+        userAgentId: string;
+        answerSdp: string;
+        userId?: string | undefined;
+    }, {
+        kind: "intercom-call-answered";
+        callId: string;
+        userAgentId: string;
+        answerSdp: string;
+        userId?: string | undefined;
+    }>;
+    'intercom-call-ended': z.ZodObject<{
+        kind: z.ZodLiteral<"intercom-call-ended">;
+        callId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        kind: "intercom-call-ended";
+        callId: string;
+    }, {
+        kind: "intercom-call-ended";
+        callId: string;
+    }>;
+    'door-access': z.ZodObject<{
+        kind: z.ZodLiteral<"door-access">;
+        personId: z.ZodOptional<z.ZodString>;
+        token: z.ZodNullable<z.ZodString>;
+        tokenType: z.ZodNullable<z.ZodEnum<["card", "pin", "login-password"]>>;
+        allowed: z.ZodBoolean;
+        doorExit: z.ZodBoolean;
+        description: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        description: string;
+        kind: "door-access";
+        token: string | null;
+        tokenType: "card" | "pin" | "login-password" | null;
+        allowed: boolean;
+        doorExit: boolean;
+        personId?: string | undefined;
+    }, {
+        description: string;
+        kind: "door-access";
+        token: string | null;
+        tokenType: "card" | "pin" | "login-password" | null;
+        allowed: boolean;
+        doorExit: boolean;
+        personId?: string | undefined;
+    }>;
+    'door-force': z.ZodObject<{
+        kind: z.ZodLiteral<"door-force">;
+    }, "strip", z.ZodTypeAny, {
+        kind: "door-force";
+    }, {
+        kind: "door-force";
+    }>;
+    'door-tamper': z.ZodObject<{
+        kind: z.ZodLiteral<"door-tamper">;
+    }, "strip", z.ZodTypeAny, {
+        kind: "door-tamper";
+    }, {
+        kind: "door-tamper";
+    }>;
+    'door-left-open': z.ZodObject<{
+        kind: z.ZodLiteral<"door-left-open">;
+    }, "strip", z.ZodTypeAny, {
+        kind: "door-left-open";
+    }, {
+        kind: "door-left-open";
+    }>;
+    'door-relock': z.ZodObject<{
+        kind: z.ZodLiteral<"door-relock">;
+    }, "strip", z.ZodTypeAny, {
+        kind: "door-relock";
+    }, {
+        kind: "door-relock";
+    }>;
+    'door-mains-failed': z.ZodObject<{
+        kind: z.ZodLiteral<"door-mains-failed">;
+    }, "strip", z.ZodTypeAny, {
+        kind: "door-mains-failed";
+    }, {
+        kind: "door-mains-failed";
+    }>;
+    'door-acu-not-responding': z.ZodObject<{
+        kind: z.ZodLiteral<"door-acu-not-responding">;
+    }, "strip", z.ZodTypeAny, {
+        kind: "door-acu-not-responding";
+    }, {
+        kind: "door-acu-not-responding";
+    }>;
+    'door-mains-restored': z.ZodObject<{
+        kind: z.ZodLiteral<"door-mains-restored">;
+    }, "strip", z.ZodTypeAny, {
+        kind: "door-mains-restored";
+    }, {
+        kind: "door-mains-restored";
+    }>;
+    'door-acu-online': z.ZodObject<{
+        kind: z.ZodLiteral<"door-acu-online">;
+    }, "strip", z.ZodTypeAny, {
+        kind: "door-acu-online";
+    }, {
+        kind: "door-acu-online";
+    }>;
+    'door-tamper-restored': z.ZodObject<{
+        kind: z.ZodLiteral<"door-tamper-restored">;
+    }, "strip", z.ZodTypeAny, {
+        kind: "door-tamper-restored";
+    }, {
+        kind: "door-tamper-restored";
+    }>;
+    'ptz-preset-saved': z.ZodObject<{
+        kind: z.ZodLiteral<"ptz-preset-saved">;
+        presetId: z.ZodString;
+        presetInfo: z.ZodObject<{
+            name: z.ZodString;
+            isDefault: z.ZodBoolean;
+            values: z.ZodUnknown;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            isDefault: boolean;
+            values?: unknown;
+        }, {
+            name: string;
+            isDefault: boolean;
+            values?: unknown;
+        }>;
+        assignedRef: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        kind: "ptz-preset-saved";
+        presetId: string;
+        presetInfo: {
+            name: string;
+            isDefault: boolean;
+            values?: unknown;
+        };
+        assignedRef: string | null;
+    }, {
+        kind: "ptz-preset-saved";
+        presetId: string;
+        presetInfo: {
+            name: string;
+            isDefault: boolean;
+            values?: unknown;
+        };
+        assignedRef: string | null;
+    }>;
+    'object-detection-started': z.ZodIntersection<z.ZodObject<{
+        kind: z.ZodLiteral<"object-detection-started">;
+        providerAssignedRef: z.ZodString;
+        detectionProvider: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        kind: "object-detection-started";
+        providerAssignedRef: string;
+        detectionProvider: string;
+    }, {
+        kind: "object-detection-started";
+        providerAssignedRef: string;
+        detectionProvider: string;
+    }>, z.ZodIntersection<z.ZodObject<{
+        objectKind: z.ZodNullable<z.ZodString>;
+        probability: z.ZodNumber;
+        identifiedObjectId: z.ZodNullable<z.ZodString>;
+        frameTime: z.ZodNumber;
+        startTime: z.ZodNumber;
+        endTime: z.ZodNullable<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        endTime: number | null;
+        startTime: number;
+        objectKind: string | null;
+        probability: number;
+        identifiedObjectId: string | null;
+        frameTime: number;
+    }, {
+        endTime: number | null;
+        startTime: number;
+        objectKind: string | null;
+        probability: number;
+        identifiedObjectId: string | null;
+        frameTime: number;
+    }>, z.ZodObject<{
+        locatorKind: z.ZodLiteral<"box">;
+        x1: z.ZodNumber;
+        y1: z.ZodNumber;
+        x2: z.ZodNumber;
+        y2: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        locatorKind: "box";
+        x1: number;
+        y1: number;
+        x2: number;
+        y2: number;
+    }, {
+        locatorKind: "box";
+        x1: number;
+        y1: number;
+        x2: number;
+        y2: number;
+    }>>>;
+    'object-detection-updated': z.ZodIntersection<z.ZodObject<{
+        kind: z.ZodLiteral<"object-detection-updated">;
+        providerAssignedRef: z.ZodString;
+        detectionProvider: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        kind: "object-detection-updated";
+        providerAssignedRef: string;
+        detectionProvider: string;
+    }, {
+        kind: "object-detection-updated";
+        providerAssignedRef: string;
+        detectionProvider: string;
+    }>, z.ZodIntersection<z.ZodObject<{
+        objectKind: z.ZodNullable<z.ZodString>;
+        probability: z.ZodNumber;
+        identifiedObjectId: z.ZodNullable<z.ZodString>;
+        frameTime: z.ZodNumber;
+        startTime: z.ZodNumber;
+        endTime: z.ZodNullable<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        endTime: number | null;
+        startTime: number;
+        objectKind: string | null;
+        probability: number;
+        identifiedObjectId: string | null;
+        frameTime: number;
+    }, {
+        endTime: number | null;
+        startTime: number;
+        objectKind: string | null;
+        probability: number;
+        identifiedObjectId: string | null;
+        frameTime: number;
+    }>, z.ZodObject<{
+        locatorKind: z.ZodLiteral<"box">;
+        x1: z.ZodNumber;
+        y1: z.ZodNumber;
+        x2: z.ZodNumber;
+        y2: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        locatorKind: "box";
+        x1: number;
+        y1: number;
+        x2: number;
+        y2: number;
+    }, {
+        locatorKind: "box";
+        x1: number;
+        y1: number;
+        x2: number;
+        y2: number;
+    }>>>;
+    'object-detection-ended': z.ZodIntersection<z.ZodObject<{
+        kind: z.ZodLiteral<"object-detection-ended">;
+        providerAssignedRef: z.ZodString;
+        detectionProvider: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        kind: "object-detection-ended";
+        providerAssignedRef: string;
+        detectionProvider: string;
+    }, {
+        kind: "object-detection-ended";
+        providerAssignedRef: string;
+        detectionProvider: string;
+    }>, z.ZodIntersection<z.ZodObject<{
+        objectKind: z.ZodNullable<z.ZodString>;
+        probability: z.ZodNumber;
+        identifiedObjectId: z.ZodNullable<z.ZodString>;
+        frameTime: z.ZodNumber;
+        startTime: z.ZodNumber;
+        endTime: z.ZodNullable<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        endTime: number | null;
+        startTime: number;
+        objectKind: string | null;
+        probability: number;
+        identifiedObjectId: string | null;
+        frameTime: number;
+    }, {
+        endTime: number | null;
+        startTime: number;
+        objectKind: string | null;
+        probability: number;
+        identifiedObjectId: string | null;
+        frameTime: number;
+    }>, z.ZodObject<{
+        locatorKind: z.ZodLiteral<"box">;
+        x1: z.ZodNumber;
+        y1: z.ZodNumber;
+        x2: z.ZodNumber;
+        y2: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        locatorKind: "box";
+        x1: number;
+        y1: number;
+        x2: number;
+        y2: number;
+    }, {
+        locatorKind: "box";
+        x1: number;
+        y1: number;
+        x2: number;
+        y2: number;
+    }>>>;
+    'scene-created': z.ZodIntersection<z.ZodObject<{
+        kind: z.ZodLiteral<"scene-created">;
+        providerAssignedRef: z.ZodString;
+        detectionProvider: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        kind: "scene-created";
+        providerAssignedRef: string;
+        detectionProvider: string;
+    }, {
+        kind: "scene-created";
+        providerAssignedRef: string;
+        detectionProvider: string;
+    }>, z.ZodObject<{
+        detections: z.ZodArray<z.ZodString, "many">;
+        clipUrl: z.ZodOptional<z.ZodString>;
+        startTime: z.ZodNumber;
+        endTime: z.ZodNullable<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        endTime: number | null;
+        startTime: number;
+        detections: string[];
+        clipUrl?: string | undefined;
+    }, {
+        endTime: number | null;
+        startTime: number;
+        detections: string[];
+        clipUrl?: string | undefined;
+    }>>;
+    'scene-updated': z.ZodIntersection<z.ZodObject<{
+        kind: z.ZodLiteral<"scene-updated">;
+        providerAssignedRef: z.ZodString;
+        detectionProvider: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        kind: "scene-updated";
+        providerAssignedRef: string;
+        detectionProvider: string;
+    }, {
+        kind: "scene-updated";
+        providerAssignedRef: string;
+        detectionProvider: string;
+    }>, z.ZodObject<{
+        detections: z.ZodArray<z.ZodString, "many">;
+        clipUrl: z.ZodOptional<z.ZodString>;
+        startTime: z.ZodNumber;
+        endTime: z.ZodNullable<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        endTime: number | null;
+        startTime: number;
+        detections: string[];
+        clipUrl?: string | undefined;
+    }, {
+        endTime: number | null;
+        startTime: number;
+        detections: string[];
+        clipUrl?: string | undefined;
+    }>>;
+    'scene-ended': z.ZodIntersection<z.ZodObject<{
+        kind: z.ZodLiteral<"scene-ended">;
+        providerAssignedRef: z.ZodString;
+        detectionProvider: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        kind: "scene-ended";
+        providerAssignedRef: string;
+        detectionProvider: string;
+    }, {
+        kind: "scene-ended";
+        providerAssignedRef: string;
+        detectionProvider: string;
+    }>, z.ZodObject<{
+        detections: z.ZodArray<z.ZodString, "many">;
+        clipUrl: z.ZodOptional<z.ZodString>;
+        startTime: z.ZodNumber;
+        endTime: z.ZodNullable<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        endTime: number | null;
+        startTime: number;
+        detections: string[];
+        clipUrl?: string | undefined;
+    }, {
+        endTime: number | null;
+        startTime: number;
+        detections: string[];
+        clipUrl?: string | undefined;
+    }>>;
+    '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;
+    }>;
+    '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;
+    }>;
+    '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;
+    }>;
+    '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;
+    }>;
+    '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;
+    }>;
+    '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;
+    }>;
+    '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;
+    }>;
+    'alarm-rearmed': z.ZodObject<{
+        kind: z.ZodLiteral<"alarm-rearmed">;
+    }, "strip", z.ZodTypeAny, {
+        kind: "alarm-rearmed";
+    }, {
+        kind: "alarm-rearmed";
+    }>;
+};
+export declare const isDeviceEvent: (event: unknown) => event is AnyDeviceEvent;
+export interface EventSearchQueryDto {
+    deviceId?: string[];
+    kind?: string[];
+    userId?: string[];
+    personId?: string[];
+    timeFrom?: number;
+    timeTo?: number;
+    offset?: number;
+    limit?: number;
+    alarmTriggersOnly?: boolean;
+}
+export type EventSearchItemDto<TEvent extends AnyDeviceEvent = AnyDeviceEvent> = {
+    id: string;
+    timestamp: number;
+    deviceId?: string;
+    observedBy?: string;
+    alarmId: string | null;
+} & TEvent;
+export {};