@awarevue/api-types 2.0.97 → 2.0.99

package/dist/objects/device/device-relation.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sDeviceRelationDataMap = exports.sIoBoardRelationData = exports.sRecordingRelationData = exports.sStreamRecorderSettings = exports.inverseRelationKinds = exports.relationKinds = exports.sDeviceRelationSide = exports.sDeviceRelationDto = exports.sDeviceRelationKind = void 0;
+exports.sDeviceRelationDataMap = exports.sIoBoardRelationData = exports.sAiInferenceRelationData = exports.sAiCapability = exports.sAiStreamConfiguration = exports.sAiSemanticSearchConfiguration = exports.sAiFaceRecognitionConfiguration = exports.sAiDetectionConfiguration = exports.sAiLabelConfiguration = exports.sMotionDetectionConfiguration = exports.sRecordingRelationData = exports.sStreamRecorderSettings = exports.inverseRelationKinds = exports.relationKinds = exports.sDeviceRelationSide = exports.sDeviceRelationDto = exports.sDeviceRelationKind = void 0;
 const zod_1 = require("zod");
 exports.sDeviceRelationKind = zod_1.z.enum([
     'attachedTo',
@@ -22,6 +22,8 @@ exports.sDeviceRelationKind = zod_1.z.enum([
     'isRecordedBy',
     'reads',
     'isReadBy',
+    'isIngestedBy',
+    'ingests',
 ]);
 exports.sDeviceRelationDto = zod_1.z
     .object({
@@ -56,6 +58,8 @@ exports.relationKinds = {
     isRecordedBy: 'isRecordedBy',
     reads: 'reads',
     isReadBy: 'isReadBy',
+    ingests: 'ingests',
+    isIngestedBy: 'isIngestedBy',
 };
 exports.inverseRelationKinds = {
     attachedTo: 'attachedTo',
@@ -77,15 +81,63 @@ exports.inverseRelationKinds = {
     isRecordedBy: 'records',
     reads: 'isReadBy',
     isReadBy: 'reads',
+    ingests: 'isIngestedBy',
+    isIngestedBy: 'ingests',
 };
+// RECORDING RELATION DATA
 exports.sStreamRecorderSettings = zod_1.z.object({
-    streamId: zod_1.z.string(),
     retentionHours: zod_1.z.number().int().positive().optional(),
     prebufferSeconds: zod_1.z.number().int().nonnegative().optional(),
 });
 exports.sRecordingRelationData = zod_1.z.object({
     streams: zod_1.z.record(zod_1.z.string(), exports.sStreamRecorderSettings),
 });
+// AI INFERENCE RELATION DATA
+// --- motion detection module ---
+exports.sMotionDetectionConfiguration = zod_1.z.object({
+    threshold: zod_1.z.number().min(0).max(1).optional(),
+    enabled: zod_1.z.boolean(),
+    fps: zod_1.z.number().int().positive().optional(),
+});
+// --- label detection module ---
+exports.sAiLabelConfiguration = zod_1.z.object({
+    threshold: zod_1.z.number().min(0).max(1).optional(),
+    enabled: zod_1.z.boolean(),
+});
+exports.sAiDetectionConfiguration = zod_1.z.object({
+    labels: zod_1.z.record(zod_1.z.string(), exports.sAiLabelConfiguration),
+    enabled: zod_1.z.boolean(),
+    fps: zod_1.z.number().int().positive().optional(),
+});
+// --- face recognition module ---
+exports.sAiFaceRecognitionConfiguration = zod_1.z.object({
+    threshold: zod_1.z.number().min(0).max(1).optional(),
+    enabled: zod_1.z.boolean(),
+    fps: zod_1.z.number().int().positive().optional(),
+});
+// --- semantic search module ---
+exports.sAiSemanticSearchConfiguration = zod_1.z.object({
+    enabled: zod_1.z.boolean(),
+    fps: zod_1.z.number().int().positive().optional(),
+});
+// --- stream configuration ---
+exports.sAiStreamConfiguration = zod_1.z.object({
+    motionDetection: exports.sMotionDetectionConfiguration.optional(),
+    labelDetection: exports.sAiDetectionConfiguration.optional(),
+    faceRecognition: exports.sAiFaceRecognitionConfiguration.optional(),
+    semanticSearch: exports.sAiSemanticSearchConfiguration.optional(),
+});
+exports.sAiCapability = zod_1.z.enum([
+    'motionDetection',
+    'labelDetection',
+    'faceRecognition',
+    'semanticSearch',
+]);
+// all together now: AI inference relation data
+exports.sAiInferenceRelationData = zod_1.z.object({
+    streams: zod_1.z.record(zod_1.z.string(), exports.sAiStreamConfiguration),
+});
+// IO BOARD CONNECTIONS RELATION DATA
 exports.sIoBoardRelationData = zod_1.z.object({
     slots: zod_1.z.record(zod_1.z.string(), zod_1.z.string()),
     invertedSlots: zod_1.z.array(zod_1.z.string()),
@@ -112,4 +164,6 @@ exports.sDeviceRelationDataMap = {
     isControlledBy: sEmptyRelationData,
     reads: sEmptyRelationData,
     isReadBy: sEmptyRelationData,
+    ingests: exports.sAiInferenceRelationData,
+    isIngestedBy: exports.sAiInferenceRelationData,
 };

package/dist/objects/device/nvr-analytics-server.d.ts

@@ -1,6 +1,13 @@
 import { z } from 'zod';
 export declare const NVR_ANALYTICS_SERVER = "nvr-analytics-server";
-export declare const sAnalyticsServerSpecs: z.ZodObject<{}, z.core.$strip>;
+export declare const sAnalyticsServerSpecs: z.ZodObject<{
+    capabilities: z.ZodArray<z.ZodEnum<{
+        motionDetection: "motionDetection";
+        labelDetection: "labelDetection";
+        faceRecognition: "faceRecognition";
+        semanticSearch: "semanticSearch";
+    }>>;
+}, z.core.$strip>;
 export type AnalyticsServerSpecs = z.infer<typeof sAnalyticsServerSpecs>;
 export declare const sAnalyticsServerStateDto: z.ZodObject<{
     connected: z.ZodBoolean;

package/dist/objects/device/nvr-analytics-server.js

@@ -2,8 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sAnalyticsServerStateDto = exports.sAnalyticsServerSpecs = exports.NVR_ANALYTICS_SERVER = void 0;
 const zod_1 = require("zod");
+const device_relation_1 = require("./device-relation");
 exports.NVR_ANALYTICS_SERVER = 'nvr-analytics-server';
-exports.sAnalyticsServerSpecs = zod_1.z.object({});
+exports.sAnalyticsServerSpecs = zod_1.z.object({
+    capabilities: zod_1.z.array(device_relation_1.sAiCapability),
+});
 exports.sAnalyticsServerStateDto = zod_1.z.object({
     connected: zod_1.z.boolean(),
 });

package/dist/objects/device/reader.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sReaderSpecs = exports.READER = void 0;
 const zod_1 = require("zod");
-const credential_type_1 = require("../../primitives/credential-type");
+const primitives_1 = require("../../primitives");
 exports.READER = 'reader';
 // SPECS
 exports.sReaderSpecs = zod_1.z.object({
-    credentialTypes: zod_1.z.array(credential_type_1.sCredentialType).optional(),
+    credentialTypes: zod_1.z.array(primitives_1.sCredentialType).optional(),
 });

package/dist/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "git+https://github.com/Linc-Security-Systems/aware-essentials.git"
   },
-  "version": "2.0.97",
+  "version": "2.0.99",
   "description": "Common types between backend, agent(s) and frontend(s)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/primitives.d.ts

@@ -138,6 +138,12 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
 }, z.core.$strip>, z.ZodObject<{
     type: z.ZodLiteral<"nvr-exporter">;
 }, z.core.$strip>, z.ZodObject<{
+    capabilities: z.ZodArray<z.ZodEnum<{
+        motionDetection: "motionDetection";
+        labelDetection: "labelDetection";
+        faceRecognition: "faceRecognition";
+        semanticSearch: "semanticSearch";
+    }>>;
     type: z.ZodLiteral<"nvr-analytics-server">;
 }, z.core.$strip>, z.ZodObject<{
     type: z.ZodLiteral<"system">;
@@ -257,6 +263,12 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodInt
 }, z.core.$strip>, z.ZodObject<{
     type: z.ZodLiteral<"nvr-exporter">;
 }, z.core.$strip>, z.ZodObject<{
+    capabilities: z.ZodArray<z.ZodEnum<{
+        motionDetection: "motionDetection";
+        labelDetection: "labelDetection";
+        faceRecognition: "faceRecognition";
+        semanticSearch: "semanticSearch";
+    }>>;
     type: z.ZodLiteral<"nvr-analytics-server">;
 }, z.core.$strip>, z.ZodObject<{
     type: z.ZodLiteral<"system">;
@@ -286,4 +298,11 @@ export declare const sCallDirection: z.ZodEnum<{
     incoming: "incoming";
     outgoing: "outgoing";
 }>;
-export { sCredentialType, type CredentialType, } from './primitives/credential-type';
+export declare const sCredentialType: z.ZodEnum<{
+    card: "card";
+    pin: "pin";
+    fingerprint: "fingerprint";
+    face: "face";
+    retina: "retina";
+}>;
+export type CredentialType = z.infer<typeof sCredentialType>;

package/dist/primitives.js

@@ -53,5 +53,10 @@ exports.sCallState = zod_1.z.enum([
     'terminated',
 ]);
 exports.sCallDirection = zod_1.z.enum(['incoming', 'outgoing']);
-var credential_type_1 = require("./primitives/credential-type");
-Object.defineProperty(exports, "sCredentialType", { enumerable: true, get: function () { return credential_type_1.sCredentialType; } });
+exports.sCredentialType = zod_1.z.enum([
+    'card',
+    'pin',
+    'fingerprint',
+    'face',
+    'retina',
+]);

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "git+https://github.com/Linc-Security-Systems/aware-essentials.git"
   },
-  "version": "2.0.97",
+  "version": "2.0.99",
   "description": "Common types between backend, agent(s) and frontend(s)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/primitives/credential-type.d.ts

@@ -1,9 +0,0 @@
-import { z } from 'zod';
-export declare const sCredentialType: z.ZodEnum<{
-    card: "card";
-    pin: "pin";
-    fingerprint: "fingerprint";
-    face: "face";
-    retina: "retina";
-}>;
-export type CredentialType = z.infer<typeof sCredentialType>;

package/dist/primitives/credential-type.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sCredentialType = void 0;
-const zod_1 = require("zod");
-exports.sCredentialType = zod_1.z.enum([
-    'card',
-    'pin',
-    'fingerprint',
-    'face',
-    'retina',
-]);

package/dist/primitives/index.d.ts

@@ -1 +0,0 @@
-export * from './credential-type';

package/dist/primitives/index.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./credential-type"), exports);