@awarevue/api-types 2.0.21 → 2.0.23

package/dist/{commands → api/commands}/all.d.ts

@@ -9,7 +9,7 @@ import { NvrExporterCommand } from './nvr-exporter';
 import { PbxCommand } from './pbx';
 import { PresenceTrackerCommand } from './presence-tracker';
 import { ServerCommand } from './server';
-import { PermissionId } from '../permissions';
+import { PermissionId } from '../../permissions';
 export type AnyDeviceCommand = ServerCommand | CameraCommand | DoorCommand | IoBoardCommand | CameraLiftCommand | AlarmCommand | IntercomTerminalCommand | PbxCommand | PresenceTrackerCommand | DisplayCommand | NvrExporterCommand;
 export type CommandRun<TCommand extends AnyDeviceCommand = AnyDeviceCommand> = {
     timestamp: number;
@@ -58,52 +58,52 @@ export declare const commandSchemas: {
                 }, "strip", import("zod").ZodTypeAny, {
                     name: string;
                     id: string;
-                    isDefault: boolean;
-                    assignedRef: string | null;
                     createdOn: string;
                     lastModifiedOn: string;
+                    isDefault: boolean;
+                    assignedRef: string | null;
                     params?: unknown;
                 }, {
                     name: string;
                     id: string;
-                    isDefault: boolean;
-                    assignedRef: string | null;
                     createdOn: string;
                     lastModifiedOn: string;
+                    isDefault: boolean;
+                    assignedRef: string | null;
                     params?: unknown;
                 }>, "many">;
             }, "strip", import("zod").ZodTypeAny, {
                 name: string;
                 foreignRef: string;
-                provider: string;
-                providerMetadata: {} & {
-                    [k: string]: unknown;
-                };
                 presets: {
                     name: string;
                     id: string;
-                    isDefault: boolean;
-                    assignedRef: string | null;
                     createdOn: string;
                     lastModifiedOn: string;
+                    isDefault: boolean;
+                    assignedRef: string | null;
                     params?: unknown;
                 }[];
-            }, {
-                name: string;
-                foreignRef: string;
                 provider: string;
                 providerMetadata: {} & {
                     [k: string]: unknown;
                 };
+            }, {
+                name: string;
+                foreignRef: string;
                 presets: {
                     name: string;
                     id: string;
-                    isDefault: boolean;
-                    assignedRef: string | null;
                     createdOn: string;
                     lastModifiedOn: string;
+                    isDefault: boolean;
+                    assignedRef: string | null;
                     params?: unknown;
                 }[];
+                provider: string;
+                providerMetadata: {} & {
+                    [k: string]: unknown;
+                };
             }>, import("zod").ZodDiscriminatedUnion<"type", [import("zod").ZodObject<{
                 type: import("zod").ZodLiteral<"alarm">;
             }, "strip", import("zod").ZodTypeAny, {
@@ -353,19 +353,19 @@ export declare const commandSchemas: {
             source: string | [string, string] | ({
                 name: string;
                 foreignRef: string;
-                provider: string;
-                providerMetadata: {} & {
-                    [k: string]: unknown;
-                };
                 presets: {
                     name: string;
                     id: string;
-                    isDefault: boolean;
-                    assignedRef: string | null;
                     createdOn: string;
                     lastModifiedOn: string;
+                    isDefault: boolean;
+                    assignedRef: string | null;
                     params?: unknown;
                 }[];
+                provider: string;
+                providerMetadata: {} & {
+                    [k: string]: unknown;
+                };
             } & ({
                 type: "alarm";
             } | {
@@ -449,19 +449,19 @@ export declare const commandSchemas: {
             source: string | [string, string] | ({
                 name: string;
                 foreignRef: string;
-                provider: string;
-                providerMetadata: {} & {
-                    [k: string]: unknown;
-                };
                 presets: {
                     name: string;
                     id: string;
-                    isDefault: boolean;
-                    assignedRef: string | null;
                     createdOn: string;
                     lastModifiedOn: string;
+                    isDefault: boolean;
+                    assignedRef: string | null;
                     params?: unknown;
                 }[];
+                provider: string;
+                providerMetadata: {} & {
+                    [k: string]: unknown;
+                };
             } & ({
                 type: "alarm";
             } | {
@@ -547,19 +547,19 @@ export declare const commandSchemas: {
             source: string | [string, string] | ({
                 name: string;
                 foreignRef: string;
-                provider: string;
-                providerMetadata: {} & {
-                    [k: string]: unknown;
-                };
                 presets: {
                     name: string;
                     id: string;
-                    isDefault: boolean;
-                    assignedRef: string | null;
                     createdOn: string;
                     lastModifiedOn: string;
+                    isDefault: boolean;
+                    assignedRef: string | null;
                     params?: unknown;
                 }[];
+                provider: string;
+                providerMetadata: {} & {
+                    [k: string]: unknown;
+                };
             } & ({
                 type: "alarm";
             } | {
@@ -646,19 +646,19 @@ export declare const commandSchemas: {
             source: string | [string, string] | ({
                 name: string;
                 foreignRef: string;
-                provider: string;
-                providerMetadata: {} & {
-                    [k: string]: unknown;
-                };
                 presets: {
                     name: string;
                     id: string;
-                    isDefault: boolean;
-                    assignedRef: string | null;
                     createdOn: string;
                     lastModifiedOn: string;
+                    isDefault: boolean;
+                    assignedRef: string | null;
                     params?: unknown;
                 }[];
+                provider: string;
+                providerMetadata: {} & {
+                    [k: string]: unknown;
+                };
             } & ({
                 type: "alarm";
             } | {
@@ -761,52 +761,52 @@ export declare const commandSchemas: {
                 }, "strip", import("zod").ZodTypeAny, {
                     name: string;
                     id: string;
-                    isDefault: boolean;
-                    assignedRef: string | null;
                     createdOn: string;
                     lastModifiedOn: string;
+                    isDefault: boolean;
+                    assignedRef: string | null;
                     params?: unknown;
                 }, {
                     name: string;
                     id: string;
-                    isDefault: boolean;
-                    assignedRef: string | null;
                     createdOn: string;
                     lastModifiedOn: string;
+                    isDefault: boolean;
+                    assignedRef: string | null;
                     params?: unknown;
                 }>, "many">;
             }, "strip", import("zod").ZodTypeAny, {
                 name: string;
                 foreignRef: string;
-                provider: string;
-                providerMetadata: {} & {
-                    [k: string]: unknown;
-                };
                 presets: {
                     name: string;
                     id: string;
-                    isDefault: boolean;
-                    assignedRef: string | null;
                     createdOn: string;
                     lastModifiedOn: string;
+                    isDefault: boolean;
+                    assignedRef: string | null;
                     params?: unknown;
                 }[];
-            }, {
-                name: string;
-                foreignRef: string;
                 provider: string;
                 providerMetadata: {} & {
                     [k: string]: unknown;
                 };
+            }, {
+                name: string;
+                foreignRef: string;
                 presets: {
                     name: string;
                     id: string;
-                    isDefault: boolean;
-                    assignedRef: string | null;
                     createdOn: string;
                     lastModifiedOn: string;
+                    isDefault: boolean;
+                    assignedRef: string | null;
                     params?: unknown;
                 }[];
+                provider: string;
+                providerMetadata: {} & {
+                    [k: string]: unknown;
+                };
             }>, import("zod").ZodDiscriminatedUnion<"type", [import("zod").ZodObject<{
                 type: import("zod").ZodLiteral<"alarm">;
             }, "strip", import("zod").ZodTypeAny, {
@@ -1051,23 +1051,22 @@ export declare const commandSchemas: {
             name: import("zod").ZodString;
         }, "strip", import("zod").ZodTypeAny, {
             name: string;
-            requestId: string;
             device: string | [string, string] | ({
                 name: string;
                 foreignRef: string;
-                provider: string;
-                providerMetadata: {} & {
-                    [k: string]: unknown;
-                };
                 presets: {
                     name: string;
                     id: string;
-                    isDefault: boolean;
-                    assignedRef: string | null;
                     createdOn: string;
                     lastModifiedOn: string;
+                    isDefault: boolean;
+                    assignedRef: string | null;
                     params?: unknown;
                 }[];
+                provider: string;
+                providerMetadata: {} & {
+                    [k: string]: unknown;
+                };
             } & ({
                 type: "alarm";
             } | {
@@ -1142,27 +1141,27 @@ export declare const commandSchemas: {
             } | {
                 type: "system";
             }));
+            requestId: string;
             timeFrom: number;
             timeTo: number;
         }, {
             name: string;
-            requestId: string;
             device: string | [string, string] | ({
                 name: string;
                 foreignRef: string;
-                provider: string;
-                providerMetadata: {} & {
-                    [k: string]: unknown;
-                };
                 presets: {
                     name: string;
                     id: string;
-                    isDefault: boolean;
-                    assignedRef: string | null;
                     createdOn: string;
                     lastModifiedOn: string;
+                    isDefault: boolean;
+                    assignedRef: string | null;
                     params?: unknown;
                 }[];
+                provider: string;
+                providerMetadata: {} & {
+                    [k: string]: unknown;
+                };
             } & ({
                 type: "alarm";
             } | {
@@ -1237,29 +1236,29 @@ export declare const commandSchemas: {
             } | {
                 type: "system";
             }));
+            requestId: string;
             timeFrom: number;
             timeTo: number;
         }>;
     }, "strip", import("zod").ZodTypeAny, {
         params: {
             name: string;
-            requestId: string;
             device: string | [string, string] | ({
                 name: string;
                 foreignRef: string;
-                provider: string;
-                providerMetadata: {} & {
-                    [k: string]: unknown;
-                };
                 presets: {
                     name: string;
                     id: string;
-                    isDefault: boolean;
-                    assignedRef: string | null;
                     createdOn: string;
                     lastModifiedOn: string;
+                    isDefault: boolean;
+                    assignedRef: string | null;
                     params?: unknown;
                 }[];
+                provider: string;
+                providerMetadata: {} & {
+                    [k: string]: unknown;
+                };
             } & ({
                 type: "alarm";
             } | {
@@ -1334,6 +1333,7 @@ export declare const commandSchemas: {
             } | {
                 type: "system";
             }));
+            requestId: string;
             timeFrom: number;
             timeTo: number;
         };
@@ -1341,23 +1341,22 @@ export declare const commandSchemas: {
     }, {
         params: {
             name: string;
-            requestId: string;
             device: string | [string, string] | ({
                 name: string;
                 foreignRef: string;
-                provider: string;
-                providerMetadata: {} & {
-                    [k: string]: unknown;
-                };
                 presets: {
                     name: string;
                     id: string;
-                    isDefault: boolean;
-                    assignedRef: string | null;
                     createdOn: string;
                     lastModifiedOn: string;
+                    isDefault: boolean;
+                    assignedRef: string | null;
                     params?: unknown;
                 }[];
+                provider: string;
+                providerMetadata: {} & {
+                    [k: string]: unknown;
+                };
             } & ({
                 type: "alarm";
             } | {
@@ -1432,6 +1431,7 @@ export declare const commandSchemas: {
             } | {
                 type: "system";
             }));
+            requestId: string;
             timeFrom: number;
             timeTo: number;
         };

package/dist/{commands → api/commands}/all.js

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

package/dist/api/commands/camera-lift.js

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+// COMMANDS
+export const sCameraLiftRaiseCommand = z.object({
+    command: z.literal('camera-lift.raise'),
+    params: z.object({}),
+});
+export const sCameraLiftLowerCommand = z.object({
+    command: z.literal('camera-lift.lower'),
+    params: z.object({}),
+});
+export const cameraLiftCommands = {
+    'camera-lift.raise': sCameraLiftRaiseCommand,
+    'camera-lift.lower': sCameraLiftLowerCommand,
+};

package/dist/api/commands/camera.js

@@ -0,0 +1,93 @@
+import { sCameraPresetInfo, sPresetId } from '../../primitives';
+import { z } from 'zod';
+export const isPtzParams = (params) => typeof params.pan === 'number' &&
+    typeof params.tilt === 'number' &&
+    typeof params.zoom === 'number';
+// COMMANDS
+export const sCameraPresetSaveCommand = z.object({
+    command: z.literal('camera.preset-save'),
+    params: z.object({
+        presetId: sPresetId,
+        presetInfo: sCameraPresetInfo,
+    }),
+});
+export const sCameraPresetActivateCommand = z.object({
+    command: z.literal('camera.preset-activate'),
+    params: z.object({
+        presetId: sPresetId,
+    }),
+});
+export const sCameraPresetDeleteCommand = z.object({
+    command: z.literal('camera.preset-delete'),
+    params: z.object({
+        presetId: sPresetId,
+        assignedRef: z.string().nullable(),
+    }),
+});
+export const sCameraPtzSetCommand = z.object({
+    command: z.literal('camera.ptz-set'),
+    params: z.object({
+        pan: z.number(),
+        tilt: z.number(),
+        zoom: z.number(),
+    }),
+});
+export const sPtzDirection = z.enum([
+    'Up',
+    'Down',
+    'Left',
+    'Right',
+    'ZoomIn',
+    'ZoomOut',
+    'UpLeft',
+    'UpRight',
+    'DownLeft',
+    'DownRight',
+]);
+export const sCameraPtzMoveCommand = z.object({
+    command: z.literal('camera.ptz-move'),
+    params: z.object({
+        direction: sPtzDirection,
+    }),
+});
+export const sCameraPtzBeginMoveCommand = z.object({
+    command: z.literal('camera.ptz-begin-move'),
+    params: z.object({
+        pan: z.number(),
+        tilt: z.number(),
+        zoom: z.number(),
+    }),
+});
+export const sCameraPtzEndMoveCommand = z.object({
+    command: z.literal('camera.ptz-end-move'),
+    params: z.object({}),
+});
+export const sCameraEnableCommand = z.object({
+    command: z.literal('camera.enable'),
+    params: z.object({}),
+});
+export const sCameraDisableCommand = z.object({
+    command: z.literal('camera.disable'),
+    params: z.object({}),
+});
+export const sCameraEnableDetectionCommand = z.object({
+    command: z.literal('camera.enable-detection'),
+    params: z.object({}),
+});
+export const sCameraDisableDetectionCommand = z.object({
+    command: z.literal('camera.disable-detection'),
+    params: z.object({}),
+});
+export const cameraCommands = {
+    'camera.ptz-set': sCameraPtzSetCommand,
+    'camera.ptz-move': sCameraPtzMoveCommand,
+    'camera.enable': sCameraEnableCommand,
+    'camera.disable': sCameraDisableCommand,
+    'camera.preset-save': sCameraPresetSaveCommand,
+    'camera.preset-activate': sCameraPresetActivateCommand,
+    'camera.preset-delete': sCameraPresetDeleteCommand,
+    'camera.ptz-begin-move': sCameraPtzBeginMoveCommand,
+    'camera.ptz-end-move': sCameraPtzEndMoveCommand,
+    'camera.enable-detection': sCameraEnableDetectionCommand,
+    'camera.disable-detection': sCameraDisableDetectionCommand,
+};

package/dist/api/commands/display.js

@@ -0,0 +1,34 @@
+import { z } from 'zod';
+// COMMANDS
+export const sDisplayTileItemCamera = z.object({
+    type: z.literal('camera'),
+    name: z.string().nonempty(),
+    username: z.string().nonempty(),
+    password: z.string().nonempty(),
+    streams: z
+        .array(z.object({
+        streamId: z.string().nonempty(),
+        displayName: z.string().nonempty(),
+        resolution: z.string().nullable(),
+        rtspUrl: z.string().nonempty(),
+    }))
+        .min(1),
+});
+export const sDisplayTileItemEmpty = z.object({
+    type: z.literal('empty'),
+});
+export const sDisplayTileItem = z.union([
+    sDisplayTileItemCamera,
+    sDisplayTileItemEmpty,
+]);
+export const sDisplaySetViewCommand = z.object({
+    command: z.literal('display.set-view'),
+    params: z.object({
+        tiles: z.array(z.object({
+            items: z.array(sDisplayTileItem),
+        })),
+    }),
+});
+export const displayCommands = {
+    'display.set-view': sDisplaySetViewCommand,
+};

package/dist/api/commands/door.js

@@ -0,0 +1,24 @@
+import { z } from 'zod';
+// COMMANDS
+export const sDoorUnlockCommand = z.object({
+    command: z.literal('door.unlock'),
+    params: z.object({}),
+});
+export const sDoorLockCommand = z.object({
+    command: z.literal('door.lock'),
+    params: z.object({}),
+});
+export const sDoorReleaseCommand = z.object({
+    command: z.literal('door.release'),
+    params: z.object({}),
+});
+export const sDoorAlarmAckCommand = z.object({
+    command: z.literal('door.alarm-ack'),
+    params: z.object({}),
+});
+export const doorCommands = {
+    'door.unlock': sDoorUnlockCommand,
+    'door.lock': sDoorLockCommand,
+    'door.release': sDoorReleaseCommand,
+    'door.alarm-ack': sDoorAlarmAckCommand,
+};

package/dist/api/commands/index.js

@@ -0,0 +1,12 @@
+export * from './camera';
+export * from './door';
+export * from './io-board';
+export * from './intercom-terminal';
+export * from './server';
+export * from './alarm';
+export * from './presence-tracker';
+export * from './display';
+export * from './nvr-exporter';
+export * from './camera-lift';
+export * from './pbx';
+export * from './all';

package/dist/api/commands/intercom-terminal.js

@@ -0,0 +1,2 @@
+// COMMANDS
+export {};

package/dist/api/commands/io-board.js

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+// COMMANDS
+export const sIoBoardSetOutputCommand = z.object({
+    command: z.literal('io-board.set-output'),
+    params: z.object({
+        output: z.string().nonempty(),
+        value: z.boolean(),
+    }),
+});
+export const ioBoardCommands = {
+    'io-board.set-output': sIoBoardSetOutputCommand,
+};

package/dist/api/commands/nvr-exporter.js

@@ -0,0 +1,23 @@
+import { sDeviceParam } from '../../primitives';
+import { z } from 'zod';
+// COMMANDS
+export const sStartExportCommand = z.object({
+    command: z.literal('nvr-exporter.start-export'),
+    params: z.object({
+        requestId: z.string().nonempty(),
+        device: sDeviceParam,
+        timeFrom: z.number().int().nonnegative(),
+        timeTo: z.number().int().nonnegative(),
+        name: z.string().nonempty(),
+    }),
+});
+export const sDeleteExportCommand = z.object({
+    command: z.literal('nvr-exporter.delete-export'),
+    params: z.object({
+        exportId: z.string().nonempty(),
+    }),
+});
+export const nvrExporterCommandSchemas = {
+    'nvr-exporter.start-export': sStartExportCommand,
+    'nvr-exporter.delete-export': sDeleteExportCommand,
+};

package/dist/api/commands/pbx.js

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+// COMMANDS
+export const sPbxCallCommand = z.object({
+    command: z.literal('pbx.call'),
+    params: z.object({
+        endpoint: z.string().nonempty(),
+        soundFile: z.string().nonempty(),
+        context: z.string().optional(),
+        callerId: z.string().optional(),
+    }),
+});
+export const pbxCommands = {
+    'pbx.call': sPbxCallCommand,
+};