@awarevue/api-types 1.0.75 → 1.0.77

package/dist/alarm-automation.d.ts

@@ -17,7 +17,8 @@ export declare const sAlarmAutomationCriteria: z.ZodObject<{
 export declare const sAlarmAutomationMetadata: z.ZodObject<{
     behavior: z.ZodEnum<["ignore", "trigger-always", "trigger-when-armed"]>;
     level: z.ZodEnum<["by-device", "by-type"]>;
-    eventKind: z.ZodOptional<z.ZodString>;
+    eventKind: z.ZodString;
+    eventVariant: z.ZodNullable<z.ZodString>;
     eventCriteria: z.ZodArray<z.ZodObject<{
         field: z.ZodString;
         value: z.ZodUnknown;
@@ -31,39 +32,59 @@ export declare const sAlarmAutomationMetadata: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     behavior: "ignore" | "trigger-always" | "trigger-when-armed";
     level: "by-device" | "by-type";
+    eventKind: string;
+    eventVariant: string | null;
     eventCriteria: {
         field: string;
         value?: unknown;
     }[];
-    eventKind?: string | undefined;
 }, {
     behavior: "ignore" | "trigger-always" | "trigger-when-armed";
     level: "by-device" | "by-type";
+    eventKind: string;
+    eventVariant: string | null;
     eventCriteria: {
         field: string;
         value?: unknown;
     }[];
-    eventKind?: string | undefined;
 }>;
 export type AlarmBehavior = z.infer<typeof sAlarmBehavior>;
 export type AlarmAutomationLevel = z.infer<typeof sAlarmAutomationLevel>;
 export type AlarmAutomationMetadata = z.infer<typeof sAlarmAutomationMetadata>;
+export type AlarmAutomationCriteria = z.infer<typeof sAlarmAutomationCriteria>;
 export declare const isAlarmAutomationMetadata: (metadata: unknown) => metadata is AlarmAutomationMetadata;
-export declare const formatByDeviceAutomationCode: (eventKind: DeviceEvent["kind"], deviceId: string) => string;
-export declare const formatByTypeAutomationCode: (eventKind: DeviceEvent["kind"], deviceType: DeviceType) => string;
+export declare const formatByDeviceAutomationCode: (eventKind: DeviceEvent["kind"], deviceId: string, variant?: string | null) => string;
+export declare const formatByTypeAutomationCode: (eventKind: DeviceEvent["kind"], deviceType: DeviceType, variant?: string | null) => string;
 export declare const isByDeviceAutomationCode: (code: string) => boolean;
 export declare const isByTypeAutomationCode: (code: string) => boolean;
 export type ParsedByDeviceAutomationCode = {
     type: 'by-device';
     value: string;
     eventKind: DeviceEvent['kind'];
+    eventVariant: string | null;
 };
 export type ParsedByTypeAutomationCode = {
     type: 'by-type';
     value: DeviceType;
     eventKind: DeviceEvent['kind'];
+    eventVariant: string | null;
 };
 export type ParsedAlarmAutomationCode = ParsedByDeviceAutomationCode | ParsedByTypeAutomationCode;
 export declare const parseAlarmAutomationCode: (code: string) => ParsedAlarmAutomationCode | null;
 export declare const createAlarmRuleBody: (eventKind: DeviceEvent["kind"], behavior: AlarmBehavior, deviceType: DeviceType, eventCriteria: AlarmAutomationMetadata["eventCriteria"], deviceId?: string) => AutomationRuleBody;
 export declare const resolveAlarmExclusivityGroup: (deviceType: DeviceType) => string;
+export type DeviceEventVariant = {
+    name: string;
+    label: string;
+    criteria: AlarmAutomationCriteria[];
+};
+export declare const alarmEventVariants: {
+    'door-access': DeviceEventVariant[];
+    'object-detection-started': DeviceEventVariant[];
+    'object-detection-ended': never[];
+    'object-detection-updated': never[];
+    'scene-created': never[];
+    'scene-updated': never[];
+    'scene-ended': never[];
+    'ptz-preset-saved': never[];
+};

package/dist/alarm-automation.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveAlarmExclusivityGroup = exports.createAlarmRuleBody = exports.parseAlarmAutomationCode = exports.isByTypeAutomationCode = exports.isByDeviceAutomationCode = exports.formatByTypeAutomationCode = exports.formatByDeviceAutomationCode = exports.isAlarmAutomationMetadata = exports.sAlarmAutomationMetadata = exports.sAlarmAutomationCriteria = exports.sAlarmAutomationLevel = exports.sAlarmBehavior = void 0;
+exports.alarmEventVariants = exports.resolveAlarmExclusivityGroup = exports.createAlarmRuleBody = exports.parseAlarmAutomationCode = exports.isByTypeAutomationCode = exports.isByDeviceAutomationCode = exports.formatByTypeAutomationCode = exports.formatByDeviceAutomationCode = exports.isAlarmAutomationMetadata = exports.sAlarmAutomationMetadata = exports.sAlarmAutomationCriteria = exports.sAlarmAutomationLevel = exports.sAlarmBehavior = void 0;
 const zod_1 = require("zod");
+const world_objects_1 = require("./world-objects");
 exports.sAlarmBehavior = zod_1.z.enum([
     'ignore',
     'trigger-always',
@@ -15,7 +16,11 @@ exports.sAlarmAutomationCriteria = zod_1.z.object({
 exports.sAlarmAutomationMetadata = zod_1.z.object({
     behavior: exports.sAlarmBehavior,
     level: exports.sAlarmAutomationLevel,
-    eventKind: zod_1.z.string().optional().describe('The kind of event to match'),
+    eventKind: zod_1.z.string().describe('The kind of event to match'),
+    eventVariant: zod_1.z
+        .string()
+        .nullable()
+        .describe('Optional variant for specific device events'),
     eventCriteria: zod_1.z.array(exports.sAlarmAutomationCriteria),
 });
 const isAlarmAutomationMetadata = (metadata) => {
@@ -29,12 +34,12 @@ exports.isAlarmAutomationMetadata = isAlarmAutomationMetadata;
 // Alarm assigns automation rules with code that is either:
 // [by-event]:[event-kind]
 // [by-device]:[device-id]
-const formatByDeviceAutomationCode = (eventKind, deviceId) => {
-    return `by-device:${deviceId}:${eventKind}`;
+const formatByDeviceAutomationCode = (eventKind, deviceId, variant = null) => {
+    return `by-device:${deviceId}:${eventKind}${variant ? `:${variant}` : ''}`;
 };
 exports.formatByDeviceAutomationCode = formatByDeviceAutomationCode;
-const formatByTypeAutomationCode = (eventKind, deviceType) => {
-    return `by-type:${deviceType}:${eventKind}`;
+const formatByTypeAutomationCode = (eventKind, deviceType, variant = null) => {
+    return `by-type:${deviceType}:${eventKind}${variant ? `:${variant}` : ''}`;
 };
 exports.formatByTypeAutomationCode = formatByTypeAutomationCode;
 const isByDeviceAutomationCode = (code) => {
@@ -48,46 +53,31 @@ exports.isByTypeAutomationCode = isByTypeAutomationCode;
 const parseAlarmAutomationCode = (code) => {
     if ((0, exports.isByDeviceAutomationCode)(code)) {
         const parts = code.replace('by-device:', '').split(':');
-        if (parts.length !== 2) {
+        if (parts.length < 2) {
             return null; // Invalid format
         }
         return {
             type: 'by-device',
             value: parts[0], // deviceId
             eventKind: parts[1], // eventKind
+            eventVariant: parts[2] || null, // Optional variant for specific device events
         };
     }
     if ((0, exports.isByTypeAutomationCode)(code)) {
         const parts = code.replace('by-type:', '').split(':');
-        if (parts.length !== 2) {
+        if (parts.length < 2) {
             return null; // Invalid format
         }
         return {
             type: 'by-type',
             value: parts[0], // deviceType
             eventKind: parts[1], // eventKind
+            eventVariant: parts[2] || null, // Optional variant for specific device events
         };
     }
     return null;
 };
 exports.parseAlarmAutomationCode = parseAlarmAutomationCode;
-// {
-//     "displayName": "Trigger alarm on force-open door events",
-//     "enabled": true,
-//     "body": {
-//         "onEvent": "door-force",
-//         "commands": [
-//             {
-//                 "command": "alarm.set-trigger",
-//                 "target": "target.type ==\"alarm\"",
-//                 "params": {
-//                     "event": "{{event}}",
-//                     "onlyIfArmed": "{{device.provider ==\"paxton\"}}"
-//                 }
-//             }
-//         ]
-//     }
-// }
 const encodeValue = (value) => {
     if (typeof value === 'string') {
         return `${JSON.stringify(value)}`;
@@ -137,3 +127,34 @@ const createAlarmRuleBody = (eventKind, behavior, deviceType, eventCriteria, dev
 exports.createAlarmRuleBody = createAlarmRuleBody;
 const resolveAlarmExclusivityGroup = (deviceType) => `alarm-${deviceType}`;
 exports.resolveAlarmExclusivityGroup = resolveAlarmExclusivityGroup;
+const sorted = (specs) => {
+    return specs.sort((a, b) => a.label.localeCompare(b.label));
+};
+exports.alarmEventVariants = {
+    'door-access': sorted([
+        {
+            name: 'allowed',
+            label: 'Door Access Granted',
+            criteria: [{ field: 'allowed', value: true }],
+        },
+        {
+            name: 'denied',
+            label: 'Door Access Denied',
+            criteria: [{ field: 'allowed', value: false }],
+        },
+    ]),
+    'object-detection-started': sorted([
+        // TODO - add criteria for object detection started
+        ...world_objects_1.worldObjects.map((object) => ({
+            name: object.id,
+            label: `${object.label} Detected`,
+            criteria: [{ field: 'objectKind', value: object.id }],
+        })),
+    ]),
+    'object-detection-ended': [],
+    'object-detection-updated': [],
+    'scene-created': [],
+    'scene-updated': [],
+    'scene-ended': [],
+    'ptz-preset-saved': [],
+};

package/dist/index.d.ts

@@ -30,3 +30,4 @@ export * from './agent-communication';
 export * from './cast';
 export * from './security-level';
 export * from './token-conversion';
+export * from './world-objects';

package/dist/index.js

@@ -46,3 +46,4 @@ __exportStar(require("./agent-communication"), exports);
 __exportStar(require("./cast"), exports);
 __exportStar(require("./security-level"), exports);
 __exportStar(require("./token-conversion"), exports);
+__exportStar(require("./world-objects"), exports);

package/dist/package.json

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

package/dist/world-objects.d.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+export declare const sWorldObject: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    label: string;
+}, {
+    id: string;
+    label: string;
+}>;
+export type WorldObject = z.infer<typeof sWorldObject>;
+export declare const worldObjects: WorldObject[];

package/dist/world-objects.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.worldObjects = exports.sWorldObject = void 0;
+const zod_1 = require("zod");
+exports.sWorldObject = zod_1.z.object({
+    id: zod_1.z.string().describe('The unique identifier of the world object'),
+    label: zod_1.z.string().describe('The label of the world object'),
+});
+exports.worldObjects = [
+    {
+        id: 'person',
+        label: 'Person',
+    },
+    {
+        id: 'backpack',
+        label: 'Backpack',
+    },
+    {
+        id: 'cell-phone',
+        label: 'Cell Phone',
+    },
+    {
+        id: 'handbag',
+        label: 'Handbag',
+    },
+    {
+        id: 'laptop',
+        label: 'Laptop',
+    },
+    {
+        id: 'bicycle',
+        label: 'Bicycle',
+    },
+];

package/package.json

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