@awarevue/api-types 1.1.14 → 2.0.1

package/dist/device/nvr-recorder.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nvrRecorderResponseSchemas = exports.nvrRecorderRequestSchemas = exports.sCameraLatestFrameResponse = exports.sCameraLatestFrameArgs = exports.QUERY_CAMERA_LATEST_FRAME = exports.sPreviewImageResponse = exports.sPreviewImageArgs = exports.QUERY_PREVIEW_IMAGE = exports.sRecordingsResponse = exports.sRecordingsByTimeRangeArgs = exports.QUERY_RECORDINGS_BY_TIME_RANGE = exports.sRecorderStateDto = exports.sRecorderSpecs = exports.NVR_RECORDER = void 0;
+const api_1 = require("../api");
+const primitives_1 = require("../primitives");
+const zod_1 = require("zod");
+exports.NVR_RECORDER = 'nvr-recorder';
+exports.sRecorderSpecs = zod_1.z.object({});
+exports.sRecorderStateDto = zod_1.z.object({
+    connected: zod_1.z.boolean(),
+});
+// QUERIES
+// -- Recordings by Time Range
+exports.QUERY_RECORDINGS_BY_TIME_RANGE = 'cctv:recordings-by-time-range';
+exports.sRecordingsByTimeRangeArgs = zod_1.z.object({
+    device: primitives_1.sDeviceParam,
+    timeFrom: zod_1.z.number(),
+    timeTo: zod_1.z.number(),
+});
+exports.sRecordingsResponse = zod_1.z.array(api_1.sRecordingSequence);
+// -- Preview Image
+exports.QUERY_PREVIEW_IMAGE = 'cctv:preview-image';
+exports.sPreviewImageArgs = zod_1.z.object({
+    device: primitives_1.sDeviceParam,
+    time: zod_1.z.number(),
+    height: zod_1.z.number(),
+});
+exports.sPreviewImageResponse = primitives_1.sFileResponse;
+// -- Camera Latest Frame
+exports.QUERY_CAMERA_LATEST_FRAME = 'cctv:latest-frame';
+exports.sCameraLatestFrameArgs = zod_1.z.object({
+    device: primitives_1.sDeviceParam,
+    width: zod_1.z.number(),
+    height: zod_1.z.number(),
+});
+exports.sCameraLatestFrameResponse = primitives_1.sFileResponse;
+exports.nvrRecorderRequestSchemas = {
+    [exports.QUERY_RECORDINGS_BY_TIME_RANGE]: exports.sRecordingsByTimeRangeArgs,
+    [exports.QUERY_PREVIEW_IMAGE]: exports.sPreviewImageArgs,
+    [exports.QUERY_CAMERA_LATEST_FRAME]: exports.sCameraLatestFrameArgs,
+};
+// Dictionary of response schemas by query type
+exports.nvrRecorderResponseSchemas = {
+    [exports.QUERY_RECORDINGS_BY_TIME_RANGE]: exports.sRecordingsResponse,
+    [exports.QUERY_PREVIEW_IMAGE]: exports.sPreviewImageResponse,
+    [exports.QUERY_CAMERA_LATEST_FRAME]: exports.sCameraLatestFrameResponse,
+};

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

@@ -184,20 +184,20 @@ export declare const sPersonIn: z.ZodObject<{
     personId: string;
     securityChecked: boolean;
     zoneId: string | null;
+    personType: string;
     personFirstName: string;
     personLastName: string;
     personAvatarId: string | null;
-    personType: string;
     personPosition: string | null;
 }, {
     kind: "person-in";
     personId: string;
     securityChecked: boolean;
     zoneId: string | null;
+    personType: string;
     personFirstName: string;
     personLastName: string;
     personAvatarId: string | null;
-    personType: string;
     personPosition: string | null;
 }>;
 export declare const sPersonOut: z.ZodObject<{
@@ -217,10 +217,10 @@ export declare const sPersonOut: z.ZodObject<{
     securityChecked: boolean;
     isLeave: boolean;
     zoneId: string | null;
+    personType: string;
     personFirstName: string;
     personLastName: string;
     personAvatarId: string | null;
-    personType: string;
     personPosition: string | null;
 }, {
     kind: "person-out";
@@ -228,10 +228,10 @@ export declare const sPersonOut: z.ZodObject<{
     securityChecked: boolean;
     isLeave: boolean;
     zoneId: string | null;
+    personType: string;
     personFirstName: string;
     personLastName: string;
     personAvatarId: string | null;
-    personType: string;
     personPosition: string | null;
 }>;
 export declare const presenceTrackerEventSchemaByKind: {
@@ -250,20 +250,20 @@ export declare const presenceTrackerEventSchemaByKind: {
         personId: string;
         securityChecked: boolean;
         zoneId: string | null;
+        personType: string;
         personFirstName: string;
         personLastName: string;
         personAvatarId: string | null;
-        personType: string;
         personPosition: string | null;
     }, {
         kind: "person-in";
         personId: string;
         securityChecked: boolean;
         zoneId: string | null;
+        personType: string;
         personFirstName: string;
         personLastName: string;
         personAvatarId: string | null;
-        personType: string;
         personPosition: string | null;
     }>;
     readonly 'person-out': z.ZodObject<{
@@ -283,10 +283,10 @@ export declare const presenceTrackerEventSchemaByKind: {
         securityChecked: boolean;
         isLeave: boolean;
         zoneId: string | null;
+        personType: string;
         personFirstName: string;
         personLastName: string;
         personAvatarId: string | null;
-        personType: string;
         personPosition: string | null;
     }, {
         kind: "person-out";
@@ -294,10 +294,10 @@ export declare const presenceTrackerEventSchemaByKind: {
         securityChecked: boolean;
         isLeave: boolean;
         zoneId: string | null;
+        personType: string;
         personFirstName: string;
         personLastName: string;
         personAvatarId: string | null;
-        personType: string;
         personPosition: string | null;
     }>;
 };

package/dist/device-event.d.ts

@@ -10,6 +10,7 @@ import { PresenceTrackerEvent } from './device/presence-tracker';
 import { ReaderEvent } from './device/reader/index';
 import { ServerEvent } from './device/server';
 import { DeviceType } from './device/any-device';
+import { NvrExporterEvent } from './device/nvr-exporter';
 export interface DeviceCommandTriggered {
     kind: 'device-command';
     userId?: string;
@@ -32,7 +33,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;
+export type AnyDeviceEvent = DeviceCommandTriggered | CameraEvent | DoorEvent | AlarmEvent | MotionDetectedEvent | ReaderEvent | PanicButtonEvent | DeviceConnectedEvent | DeviceDisconnectedEvent | IntercomTerminalEvent | ServerEvent | DeviceGatewayEvent | PresenceTrackerEvent | IoBoardEvent | NvrExporterEvent;
 export declare const sEventHeader: z.ZodObject<{
     id: z.ZodString;
     timestamp: z.ZodNumber;
@@ -60,6 +61,29 @@ export declare const eventSchemaByKind: {
     }, {
         kind: "motion-detected";
     }>;
+    'nvr-export-started': z.ZodObject<{
+        kind: z.ZodLiteral<"nvr-export-started">;
+        exportId: z.ZodString;
+        requestId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        kind: "nvr-export-started";
+        requestId: string;
+        exportId: string;
+    }, {
+        kind: "nvr-export-started";
+        requestId: string;
+        exportId: string;
+    }>;
+    'nvr-export-deleted': z.ZodObject<{
+        kind: z.ZodLiteral<"nvr-export-deleted">;
+        exportId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        kind: "nvr-export-deleted";
+        exportId: string;
+    }, {
+        kind: "nvr-export-deleted";
+        exportId: string;
+    }>;
     'reader-auth': z.ZodObject<{
         kind: z.ZodLiteral<"reader-auth">;
         token: z.ZodNullable<z.ZodString>;
@@ -91,20 +115,20 @@ export declare const eventSchemaByKind: {
         personId: string;
         securityChecked: boolean;
         zoneId: string | null;
+        personType: string;
         personFirstName: string;
         personLastName: string;
         personAvatarId: string | null;
-        personType: string;
         personPosition: string | null;
     }, {
         kind: "person-in";
         personId: string;
         securityChecked: boolean;
         zoneId: string | null;
+        personType: string;
         personFirstName: string;
         personLastName: string;
         personAvatarId: string | null;
-        personType: string;
         personPosition: string | null;
     }>;
     'person-out': z.ZodObject<{
@@ -124,10 +148,10 @@ export declare const eventSchemaByKind: {
         securityChecked: boolean;
         isLeave: boolean;
         zoneId: string | null;
+        personType: string;
         personFirstName: string;
         personLastName: string;
         personAvatarId: string | null;
-        personType: string;
         personPosition: string | null;
     }, {
         kind: "person-out";
@@ -135,10 +159,10 @@ export declare const eventSchemaByKind: {
         securityChecked: boolean;
         isLeave: boolean;
         zoneId: string | null;
+        personType: string;
         personFirstName: string;
         personLastName: string;
         personAvatarId: string | null;
-        personType: string;
         personPosition: string | null;
     }>;
     'panic-button-pressed': z.ZodObject<{
@@ -175,8 +199,8 @@ export declare const eventSchemaByKind: {
         direction: "incoming" | "outgoing";
         kind: "call-state-changed";
         callId: string;
-        userId?: string | undefined;
         peer?: string | undefined;
+        userId?: string | undefined;
         sipAccount?: string | undefined;
         sipCallId?: string | undefined;
     }, {
@@ -184,8 +208,8 @@ export declare const eventSchemaByKind: {
         direction: "incoming" | "outgoing";
         kind: "call-state-changed";
         callId: string;
-        userId?: string | undefined;
         peer?: string | undefined;
+        userId?: string | undefined;
         sipAccount?: string | undefined;
         sipCallId?: string | undefined;
     }>;
@@ -585,13 +609,13 @@ export declare const eventSchemaByKind: {
     }, "strip", z.ZodTypeAny, {
         kind: "alarm-acknowledged";
         alarmId: string;
-        userId?: string | undefined;
         personId?: string | undefined;
+        userId?: string | undefined;
     }, {
         kind: "alarm-acknowledged";
         alarmId: string;
-        userId?: string | undefined;
         personId?: string | undefined;
+        userId?: string | undefined;
     }>;
     'alarm-armed-all': z.ZodObject<{
         kind: z.ZodLiteral<"alarm-armed-all">;
@@ -599,12 +623,12 @@ export declare const eventSchemaByKind: {
         personId: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         kind: "alarm-armed-all";
-        userId?: string | undefined;
         personId?: string | undefined;
+        userId?: string | undefined;
     }, {
         kind: "alarm-armed-all";
-        userId?: string | undefined;
         personId?: string | undefined;
+        userId?: string | undefined;
     }>;
     'alarm-disarmed-all': z.ZodObject<{
         kind: z.ZodLiteral<"alarm-disarmed-all">;
@@ -612,12 +636,12 @@ export declare const eventSchemaByKind: {
         personId: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         kind: "alarm-disarmed-all";
-        userId?: string | undefined;
         personId?: string | undefined;
+        userId?: string | undefined;
     }, {
         kind: "alarm-disarmed-all";
-        userId?: string | undefined;
         personId?: string | undefined;
+        userId?: string | undefined;
     }>;
     'alarm-armed': z.ZodObject<{
         kind: z.ZodLiteral<"alarm-armed">;
@@ -627,13 +651,13 @@ export declare const eventSchemaByKind: {
     }, "strip", z.ZodTypeAny, {
         kind: "alarm-armed";
         subjects: string[];
-        userId?: string | undefined;
         personId?: string | undefined;
+        userId?: string | undefined;
     }, {
         kind: "alarm-armed";
         subjects: string[];
-        userId?: string | undefined;
         personId?: string | undefined;
+        userId?: string | undefined;
     }>;
     'alarm-disarmed': z.ZodObject<{
         kind: z.ZodLiteral<"alarm-disarmed">;
@@ -643,13 +667,13 @@ export declare const eventSchemaByKind: {
     }, "strip", z.ZodTypeAny, {
         kind: "alarm-disarmed";
         subjects: string[];
-        userId?: string | undefined;
         personId?: string | undefined;
+        userId?: string | undefined;
     }, {
         kind: "alarm-disarmed";
         subjects: string[];
-        userId?: string | undefined;
         personId?: string | undefined;
+        userId?: string | undefined;
     }>;
     'alarm-arm-released': z.ZodObject<{
         kind: z.ZodLiteral<"alarm-arm-released">;
@@ -657,12 +681,12 @@ export declare const eventSchemaByKind: {
         personId: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         kind: "alarm-arm-released";
-        userId?: string | undefined;
         personId?: string | undefined;
+        userId?: string | undefined;
     }, {
         kind: "alarm-arm-released";
-        userId?: string | undefined;
         personId?: string | undefined;
+        userId?: string | undefined;
     }>;
     'alarm-rearmed': z.ZodObject<{
         kind: z.ZodLiteral<"alarm-rearmed">;

package/dist/device-event.js

@@ -10,6 +10,7 @@ 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");
 exports.sMotionDetected = zod_1.z.object({
     kind: zod_1.z.literal('motion-detected'),
 });
@@ -62,6 +63,8 @@ exports.eventKindLabels = {
     'agent-stopped': 'Agent Stopped',
     'door-opened': 'Door Opened',
     'door-closed': 'Door Closed',
+    'nvr-export-started': 'NVR Export Started',
+    'nvr-export-deleted': 'NVR Export Deleted',
 };
 exports.eventSchemaByKind = {
     ...alarm_1.alarmEventSchemasByKind,
@@ -72,6 +75,7 @@ exports.eventSchemaByKind = {
     ...panic_button_1.panicButtonEventSchemaByKind,
     ...presence_tracker_1.presenceTrackerEventSchemaByKind,
     ...index_1.readerEventSchemaByKind,
+    ...nvr_exporter_1.nvrExporterEventSchemasByKind,
     'motion-detected': exports.sMotionDetected,
 };
 exports.eventsByDeviceType = {
@@ -85,6 +89,7 @@ exports.eventsByDeviceType = {
     '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)