@awarevue/api-types 2.0.137 → 2.0.139

package/dist/api/agent-protocol/protocol.d.ts

@@ -704,6 +704,7 @@ export declare const sGetAvailableDevicesRs: z.ZodObject<{
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>, z.ZodObject<{
         provider: z.ZodString;

package/dist/api/commands/all.d.ts

@@ -798,6 +798,7 @@ export declare const commandSchemas: {
             rtspUrl: import("zod").ZodString;
             retentionHours: import("zod").ZodOptional<import("zod").ZodNumber>;
             prebufferSeconds: import("zod").ZodOptional<import("zod").ZodNumber>;
+            isRecording: import("zod").ZodOptional<import("zod").ZodBoolean>;
         }, import("zod/v4/core").$strip>;
     }, import("zod/v4/core").$strip>;
     readonly 'nvr-recorder.unmount-stream': import("zod").ZodObject<{

package/dist/api/commands/nvr-recorder.d.ts

@@ -122,6 +122,7 @@ export declare const sMountStreamCommand: z.ZodObject<{
         rtspUrl: z.ZodString;
         retentionHours: z.ZodOptional<z.ZodNumber>;
         prebufferSeconds: z.ZodOptional<z.ZodNumber>;
+        isRecording: z.ZodOptional<z.ZodBoolean>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 export type MountStreamCommand = z.infer<typeof sMountStreamCommand>;
@@ -863,6 +864,7 @@ export declare const nvrRecorderCommandSchemas: {
             rtspUrl: z.ZodString;
             retentionHours: z.ZodOptional<z.ZodNumber>;
             prebufferSeconds: z.ZodOptional<z.ZodNumber>;
+            isRecording: z.ZodOptional<z.ZodBoolean>;
         }, z.core.$strip>;
     }, z.core.$strip>;
     readonly 'nvr-recorder.unmount-stream': z.ZodObject<{

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

@@ -12,6 +12,8 @@ exports.sMountStreamCommand = zod_1.z.object({
         rtspUrl: zod_1.z.string().nonempty(),
         retentionHours: zod_1.z.number().int().positive().optional(),
         prebufferSeconds: zod_1.z.number().int().nonnegative().optional(),
+        /** Whether the stream should be recording once mounted. Absent means true. */
+        isRecording: zod_1.z.boolean().optional(),
     }),
 });
 exports.sUnmountStreamCommand = zod_1.z.object({

package/dist/api/rest/device.d.ts

@@ -31,6 +31,7 @@ export declare const sAddDeviceRequest: z.ZodObject<{
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     type: z.ZodEnum<{
@@ -91,6 +92,7 @@ export declare const sUpdateDeviceRequest: z.ZodObject<{
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>>;
     enabled: z.ZodOptional<z.ZodBoolean>;
@@ -132,6 +134,7 @@ export declare const sApplyDeviceChangesRequest: z.ZodObject<{
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         type: z.ZodEnum<{
@@ -192,6 +195,7 @@ export declare const sApplyDeviceChangesRequest: z.ZodObject<{
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>>;
         enabled: z.ZodOptional<z.ZodBoolean>;
@@ -223,6 +227,7 @@ export declare const sApplyDeviceChangesRequest: z.ZodObject<{
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>;
         action: z.ZodEnum<{
@@ -291,6 +296,7 @@ export declare const sSetUnsetRelationRequest: z.ZodObject<{
         isReadBy: "isReadBy";
         isIngestedBy: "isIngestedBy";
         ingests: "ingests";
+        is: "is";
     }>;
 }, z.core.$catchall<z.ZodUnknown>>;
 export type AddDeviceRequest = z.infer<typeof sAddDeviceRequest>;
@@ -448,6 +454,7 @@ export declare const sPendingDeviceWrite: z.ZodObject<{
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;

package/dist/api/rest/view.d.ts

@@ -40,6 +40,10 @@ export declare const sAddViewRequest: z.ZodObject<{
                 deviceId: z.ZodString;
                 streamId: z.ZodString;
             }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            area: z.ZodString;
+            type: z.ZodLiteral<"image">;
+            fileId: z.ZodUUID;
         }, z.core.$strip>]>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
@@ -84,6 +88,10 @@ export declare const sUpdateViewRequest: z.ZodObject<{
                 deviceId: z.ZodString;
                 streamId: z.ZodString;
             }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            area: z.ZodString;
+            type: z.ZodLiteral<"image">;
+            fileId: z.ZodUUID;
         }, z.core.$strip>]>>;
     }, z.core.$strip>>;
 }, z.core.$strip>;

package/dist/objects/device/any-device.d.ts

@@ -215,6 +215,7 @@ export declare const sDeviceMgmtInfo: z.ZodObject<{
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -368,6 +369,7 @@ export declare const sDeviceDto: z.ZodIntersection<z.ZodIntersection<z.ZodDiscri
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -455,6 +457,7 @@ export declare const sCameraDto: z.ZodIntersection<z.ZodIntersection<z.ZodObject
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -512,6 +515,7 @@ export declare const sDoorDto: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -572,6 +576,7 @@ export declare const sReaderDto: z.ZodIntersection<z.ZodIntersection<z.ZodObject
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -627,6 +632,7 @@ export declare const sIoBoardDto: z.ZodIntersection<z.ZodIntersection<z.ZodObjec
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -680,6 +686,7 @@ export declare const sCameraLiftDto: z.ZodIntersection<z.ZodIntersection<z.ZodOb
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -733,6 +740,7 @@ export declare const sMotionSensorDto: z.ZodIntersection<z.ZodIntersection<z.Zod
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -786,6 +794,7 @@ export declare const sGenericSensorDto: z.ZodIntersection<z.ZodIntersection<z.Zo
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -839,6 +848,7 @@ export declare const sPanicButtonDto: z.ZodIntersection<z.ZodIntersection<z.ZodO
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -897,6 +907,7 @@ export declare const sIntercomTerminalDto: z.ZodIntersection<z.ZodIntersection<z
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -951,6 +962,7 @@ export declare const sPbxDto: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -1004,6 +1016,7 @@ export declare const sDeviceGatewayDto: z.ZodIntersection<z.ZodIntersection<z.Zo
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -1057,6 +1070,7 @@ export declare const sPresenceTrackerDto: z.ZodIntersection<z.ZodIntersection<z.
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -1110,6 +1124,7 @@ export declare const sServerDto: z.ZodIntersection<z.ZodIntersection<z.ZodObject
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -1163,6 +1178,7 @@ export declare const sAlarmDto: z.ZodIntersection<z.ZodIntersection<z.ZodObject<
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -1216,6 +1232,7 @@ export declare const sIntercomOperatorDto: z.ZodIntersection<z.ZodIntersection<z
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -1269,6 +1286,7 @@ export declare const sDisplayDto: z.ZodIntersection<z.ZodIntersection<z.ZodObjec
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -1322,6 +1340,7 @@ export declare const sRecorderDto: z.ZodIntersection<z.ZodIntersection<z.ZodObje
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -1375,6 +1394,7 @@ export declare const sNvrExporterDto: z.ZodIntersection<z.ZodIntersection<z.ZodO
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -1434,6 +1454,7 @@ export declare const sNvrAnalyticsServerDto: z.ZodIntersection<z.ZodIntersection
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -1487,6 +1508,7 @@ export declare const sSystemDeviceDto: z.ZodIntersection<z.ZodIntersection<z.Zod
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -1540,6 +1562,7 @@ export declare const sPositionTrackerDto: z.ZodIntersection<z.ZodIntersection<z.
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>>;
     groups: z.ZodArray<z.ZodString>;
@@ -1661,6 +1684,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -1748,6 +1772,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -1805,6 +1830,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -1865,6 +1891,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -1920,6 +1947,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -1973,6 +2001,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -2026,6 +2055,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -2079,6 +2109,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -2132,6 +2163,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -2185,6 +2217,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -2243,6 +2276,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -2297,6 +2331,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -2350,6 +2385,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -2403,6 +2439,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -2456,6 +2493,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -2509,6 +2547,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -2562,6 +2601,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -2615,6 +2655,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -2674,6 +2715,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -2727,6 +2769,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -2780,6 +2823,7 @@ export declare const deviceDtoSchemaMap: {
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -2793,3 +2837,25 @@ export declare const deviceDtoSchemaMap: {
         providerMetadata: z.ZodObject<{}, z.core.$catchall<z.ZodUnknown>>;
     }, z.core.$strip>>;
 };
+/**
+ * Desired whole-device configuration by device type. Each type declares its
+ * own `s<Type>Config` in full next to its specs and state; a type not listed
+ * here has nothing configurable yet and its `is` relation must stay empty.
+ *
+ * Optionality is applied here, once, to the whole object rather than to each
+ * key: the `is` relation may be missing altogether, and a key it does not
+ * carry is "unmanaged" -- nothing is planned for it and clients show the
+ * actual state -- which is how existing deployments migrate without a backfill.
+ */
+export declare const deviceConfigSchemaMap: {
+    readonly camera: z.ZodObject<{
+        privacyMode: z.ZodBoolean;
+    }, z.core.$strip>;
+};
+/** Given a device type, the type of its `is` relation data (every key optional). */
+export type DeviceConfigMap = {
+    [T in DeviceType]: T extends keyof typeof deviceConfigSchemaMap ? Partial<z.infer<(typeof deviceConfigSchemaMap)[T]>> : Record<string, never>;
+};
+export type AnyDeviceConfig = DeviceConfigMap[DeviceType];
+/** The schema an `is` relation's data must satisfy, chosen by the owning device's type. */
+export declare const deviceConfigSchema: (type: DeviceType) => z.ZodObject;

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deviceDtoSchemaMap = exports.sEventDescription = exports.sEventVariantDescription = exports.sPositionTrackerDto = exports.sSystemDeviceDto = exports.sNvrAnalyticsServerDto = exports.sNvrExporterDto = exports.sRecorderDto = exports.sDisplayDto = exports.sIntercomOperatorDto = exports.sAlarmDto = exports.sServerDto = exports.sPresenceTrackerDto = exports.sDeviceGatewayDto = exports.sPbxDto = exports.sIntercomTerminalDto = exports.sPanicButtonDto = exports.sGenericSensorDto = exports.sMotionSensorDto = exports.sCameraLiftDto = exports.sIoBoardDto = exports.sReaderDto = exports.sDoorDto = exports.sCameraDto = exports.sDeviceDto = exports.sForeignDeviceInfo = exports.sDeviceMgmtInfo = exports.sPresetDto = exports.sProviderMetadata = exports.sAnyDeviceSpecs = exports.sSystemDeviceSpecsWithType = exports.sNvrAnalyticsServerSpecsWithType = exports.sNvrExporterSpecsWithType = exports.sRecorderSpecsWithType = exports.sDisplaySpecsWithType = exports.sDeviceType = exports.DEVICE_TYPES = void 0;
+exports.deviceConfigSchema = exports.deviceConfigSchemaMap = exports.deviceDtoSchemaMap = exports.sEventDescription = exports.sEventVariantDescription = exports.sPositionTrackerDto = exports.sSystemDeviceDto = exports.sNvrAnalyticsServerDto = exports.sNvrExporterDto = exports.sRecorderDto = exports.sDisplayDto = exports.sIntercomOperatorDto = exports.sAlarmDto = exports.sServerDto = exports.sPresenceTrackerDto = exports.sDeviceGatewayDto = exports.sPbxDto = exports.sIntercomTerminalDto = exports.sPanicButtonDto = exports.sGenericSensorDto = exports.sMotionSensorDto = exports.sCameraLiftDto = exports.sIoBoardDto = exports.sReaderDto = exports.sDoorDto = exports.sCameraDto = exports.sDeviceDto = exports.sForeignDeviceInfo = exports.sDeviceMgmtInfo = exports.sPresetDto = exports.sProviderMetadata = exports.sAnyDeviceSpecs = exports.sSystemDeviceSpecsWithType = exports.sNvrAnalyticsServerSpecsWithType = exports.sNvrExporterSpecsWithType = exports.sRecorderSpecsWithType = exports.sDisplaySpecsWithType = exports.sDeviceType = exports.DEVICE_TYPES = void 0;
 const zod_1 = require("zod");
 const camera_1 = require("./camera");
 const door_1 = require("./door");
@@ -253,3 +253,22 @@ exports.deviceDtoSchemaMap = {
     [system_1.SYSTEM]: exports.sSystemDeviceDto,
     [position_tracker_1.POSITION_TRACKER]: exports.sPositionTrackerDto,
 };
+// CONFIG (the `is` self relation)
+/**
+ * Desired whole-device configuration by device type. Each type declares its
+ * own `s<Type>Config` in full next to its specs and state; a type not listed
+ * here has nothing configurable yet and its `is` relation must stay empty.
+ *
+ * Optionality is applied here, once, to the whole object rather than to each
+ * key: the `is` relation may be missing altogether, and a key it does not
+ * carry is "unmanaged" -- nothing is planned for it and clients show the
+ * actual state -- which is how existing deployments migrate without a backfill.
+ */
+exports.deviceConfigSchemaMap = {
+    [camera_1.CAMERA]: camera_1.sCameraConfig,
+};
+const sEmptyDeviceConfig = zod_1.z.object({});
+/** The schema an `is` relation's data must satisfy, chosen by the owning device's type. */
+const deviceConfigSchema = (type) => (exports.deviceConfigSchemaMap[type] ??
+    sEmptyDeviceConfig).partial();
+exports.deviceConfigSchema = deviceConfigSchema;

package/dist/objects/device/camera.d.ts

@@ -58,6 +58,19 @@ export declare const sCameraSpecs: z.ZodObject<{
 }, z.core.$strip>;
 export type WebRtcPlaybackSource = z.infer<typeof sWebRtcPlaybackSource>;
 export type CameraSpecs = z.infer<typeof sCameraSpecs>;
+/**
+ * What we WANT for the camera as a whole, carried on its own `is` relation.
+ *
+ * Specs describe what a camera is (discovery may rewrite them) and state
+ * reports what the outside world says is the case; this is the desired value
+ * the changeset pipeline converges the world towards. Declared in full here;
+ * `deviceConfigSchema` makes the whole object partial, because the relation
+ * may be missing and any key absent from it is "unmanaged".
+ */
+export declare const sCameraConfig: z.ZodObject<{
+    privacyMode: z.ZodBoolean;
+}, z.core.$strip>;
+export type CameraConfig = z.infer<typeof sCameraConfig>;
 export declare const sMotionDetectionConfiguration: z.ZodObject<{
     threshold: z.ZodOptional<z.ZodNumber>;
     fps: z.ZodOptional<z.ZodNumber>;

package/dist/objects/device/camera.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sCameraState = exports.sRecordingState = exports.sRecorderStreamStateDto = exports.sAnalyticsConfigData = exports.sAiCapability = exports.sAiStreamConfiguration = exports.sAiSemanticSearchConfiguration = exports.sAiFaceRecognitionConfiguration = exports.sAiDetectionConfiguration = exports.sAiLabelConfiguration = exports.sMotionDetectionConfiguration = exports.sCameraSpecs = exports.sStreamInfo = exports.sWebRtcPlaybackSource = exports.CAMERA = void 0;
+exports.sCameraState = exports.sRecordingState = exports.sRecorderStreamStateDto = exports.sAnalyticsConfigData = exports.sAiCapability = exports.sAiStreamConfiguration = exports.sAiSemanticSearchConfiguration = exports.sAiFaceRecognitionConfiguration = exports.sAiDetectionConfiguration = exports.sAiLabelConfiguration = exports.sMotionDetectionConfiguration = exports.sCameraConfig = exports.sCameraSpecs = exports.sStreamInfo = exports.sWebRtcPlaybackSource = exports.CAMERA = void 0;
 const zod_1 = require("zod");
 exports.CAMERA = 'camera';
 // SPECS
@@ -35,6 +35,20 @@ exports.sCameraSpecs = zod_1.z.object({
     autoSwitchStreams: zod_1.z.boolean(),
     streamNaming: zod_1.z.enum(['cameraStreamNo', 'cameraStream', 'stream']),
 });
+// CONFIG
+/**
+ * What we WANT for the camera as a whole, carried on its own `is` relation.
+ *
+ * Specs describe what a camera is (discovery may rewrite them) and state
+ * reports what the outside world says is the case; this is the desired value
+ * the changeset pipeline converges the world towards. Declared in full here;
+ * `deviceConfigSchema` makes the whole object partial, because the relation
+ * may be missing and any key absent from it is "unmanaged".
+ */
+exports.sCameraConfig = zod_1.z.object({
+    /** Privacy mode on: feed hidden, streams unmounted, recording paused. */
+    privacyMode: zod_1.z.boolean(),
+});
 // STATE
 exports.sMotionDetectionConfiguration = zod_1.z.object({
     threshold: zod_1.z.number().min(0).max(1).optional(),

package/dist/objects/device/device-import.d.ts

@@ -248,6 +248,7 @@ export declare const sDeviceDiscoveryDto: z.ZodObject<{
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>, z.ZodObject<{
         provider: z.ZodString;
@@ -279,6 +280,7 @@ export declare const sRelationDeltaDto: z.ZodObject<{
             isReadBy: "isReadBy";
             isIngestedBy: "isIngestedBy";
             ingests: "ingests";
+            is: "is";
         }>;
     }, z.core.$catchall<z.ZodUnknown>>;
     action: z.ZodEnum<{
@@ -543,6 +545,7 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>>;
         groups: z.ZodArray<z.ZodString>;
@@ -581,6 +584,7 @@ export declare const sDeviceGetChangesDto: z.ZodObject<{
                 isReadBy: "isReadBy";
                 isIngestedBy: "isIngestedBy";
                 ingests: "ingests";
+                is: "is";
             }>;
         }, z.core.$catchall<z.ZodUnknown>>;
         action: z.ZodEnum<{

package/dist/objects/device/device-relation.d.ts

@@ -21,7 +21,14 @@ export declare const sDeviceRelationKind: z.ZodEnum<{
     isReadBy: "isReadBy";
     isIngestedBy: "isIngestedBy";
     ingests: "ingests";
+    is: "is";
 }>;
+/**
+ * `kind === 'is'` if and only if `leftId === rightId`. Enforced by the
+ * server (and a database constraint); not expressed here because the
+ * relation as seen from one side (`sDeviceRelationSide`) does not know its
+ * owner's id.
+ */
 export declare const sDeviceRelationDto: z.ZodObject<{
     leftId: z.ZodString;
     rightId: z.ZodString;
@@ -47,6 +54,7 @@ export declare const sDeviceRelationDto: z.ZodObject<{
         isReadBy: "isReadBy";
         isIngestedBy: "isIngestedBy";
         ingests: "ingests";
+        is: "is";
     }>;
 }, z.core.$catchall<z.ZodUnknown>>;
 export declare const sDeviceRelationSide: z.ZodObject<{
@@ -73,6 +81,7 @@ export declare const sDeviceRelationSide: z.ZodObject<{
         isReadBy: "isReadBy";
         isIngestedBy: "isIngestedBy";
         ingests: "ingests";
+        is: "is";
     }>;
 }, z.core.$catchall<z.ZodUnknown>>;
 export type DeviceRelationKind = z.infer<typeof sDeviceRelationKind>;
@@ -83,11 +92,13 @@ export type DeviceRelationSide = z.infer<typeof sDeviceRelationSide>;
 export declare const sStreamRecorderSettings: z.ZodObject<{
     retentionHours: z.ZodOptional<z.ZodNumber>;
     prebufferSeconds: z.ZodOptional<z.ZodNumber>;
+    enabled: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
 export declare const sRecordingRelationData: z.ZodObject<{
     streams: z.ZodRecord<z.ZodString, z.ZodObject<{
         retentionHours: z.ZodOptional<z.ZodNumber>;
         prebufferSeconds: z.ZodOptional<z.ZodNumber>;
+        enabled: z.ZodOptional<z.ZodBoolean>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
 export type StreamRecorderSettings = z.infer<typeof sStreamRecorderSettings>;
@@ -129,6 +140,12 @@ export interface DeviceRelationDataMap {
     isReadBy: Record<string, never>;
     ingests: AiInferenceRelationData;
     isIngestedBy: AiInferenceRelationData;
+    /**
+     * Shaped by the owning device's type, which a kind-keyed map cannot know:
+     * `DeviceConfigMap[T]` is the precise type and `deviceConfigSchema(type)`
+     * the schema to validate with (any-device.ts).
+     */
+    is: Record<string, unknown>;
 }
 /** Runtime map: relation kind → Zod schema for its data. */
 export declare const sDeviceRelationDataMap: {

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

@@ -25,7 +25,20 @@ exports.sDeviceRelationKind = zod_1.z.enum([
     'isReadBy',
     'isIngestedBy',
     'ingests',
+    /**
+     * The self relation: a device's relation to itself, and the only kind that
+     * may have both ends on one device. Its data is the device's desired
+     * whole-device configuration, shaped by the device's type (see
+     * `deviceConfigSchema` in any-device.ts).
+     */
+    'is',
 ]);
+/**
+ * `kind === 'is'` if and only if `leftId === rightId`. Enforced by the
+ * server (and a database constraint); not expressed here because the
+ * relation as seen from one side (`sDeviceRelationSide`) does not know its
+ * owner's id.
+ */
 exports.sDeviceRelationDto = zod_1.z
     .object({
     leftId: zod_1.z.string(),
@@ -61,6 +74,7 @@ exports.relationKinds = {
     isReadBy: 'isReadBy',
     ingests: 'ingests',
     isIngestedBy: 'isIngestedBy',
+    is: 'is',
 };
 exports.inverseRelationKinds = {
     attachedTo: 'attachedTo',
@@ -84,11 +98,18 @@ exports.inverseRelationKinds = {
     isReadBy: 'reads',
     ingests: 'isIngestedBy',
     isIngestedBy: 'ingests',
+    is: 'is',
 };
 // RECORDING RELATION DATA
 exports.sStreamRecorderSettings = zod_1.z.object({
     retentionHours: zod_1.z.number().int().positive().optional(),
     prebufferSeconds: zod_1.z.number().int().nonnegative().optional(),
+    /**
+     * Whether we WANT this stream recorded. Absent means true, which is what
+     * every binding written before this key existed has always meant; the
+     * recorder's own `isRecording` state says whether it actually is.
+     */
+    enabled: zod_1.z.boolean().optional(),
 });
 exports.sRecordingRelationData = zod_1.z.object({
     streams: zod_1.z.record(zod_1.z.string(), exports.sStreamRecorderSettings),
@@ -127,4 +148,6 @@ exports.sDeviceRelationDataMap = {
     isReadBy: sEmptyRelationData,
     ingests: exports.sAiInferenceRelationData,
     isIngestedBy: exports.sAiInferenceRelationData,
+    // Validate with deviceConfigSchema(device.type) instead; see DeviceRelationDataMap.
+    is: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()),
 };

package/dist/objects/view.d.ts

@@ -40,7 +40,13 @@ export declare const sPlaybackTrackArea: z.ZodObject<{
     }, z.core.$strip>;
 }, z.core.$strip>;
 export type PlaybackTrackArea = z.infer<typeof sPlaybackTrackArea>;
-export type ViewAreaContents = LayoutArea | LayoutSelectorArea | DeviceArea | DeviceCarouselArea | PlaybackTrackArea;
+export declare const sImageArea: z.ZodObject<{
+    area: z.ZodString;
+    type: z.ZodLiteral<"image">;
+    fileId: z.ZodUUID;
+}, z.core.$strip>;
+export type ImageArea = z.infer<typeof sImageArea>;
+export type ViewAreaContents = LayoutArea | LayoutSelectorArea | DeviceArea | DeviceCarouselArea | PlaybackTrackArea | ImageArea;
 export declare const sViewAreaContents: z.ZodUnion<readonly [z.ZodObject<{
     area: z.ZodString;
     type: z.ZodLiteral<"layout">;
@@ -72,6 +78,10 @@ export declare const sViewAreaContents: z.ZodUnion<readonly [z.ZodObject<{
         deviceId: z.ZodString;
         streamId: z.ZodString;
     }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    area: z.ZodString;
+    type: z.ZodLiteral<"image">;
+    fileId: z.ZodUUID;
 }, z.core.$strip>]>;
 export declare const sViewConfig: z.ZodObject<{
     rows: z.ZodNumber;
@@ -109,6 +119,10 @@ export declare const sViewConfig: z.ZodObject<{
             deviceId: z.ZodString;
             streamId: z.ZodString;
         }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        area: z.ZodString;
+        type: z.ZodLiteral<"image">;
+        fileId: z.ZodUUID;
     }, z.core.$strip>]>>;
 }, z.core.$strip>;
 export type ViewConfig = z.infer<typeof sViewConfig>;
@@ -153,6 +167,10 @@ export declare const sViewInfo: z.ZodIntersection<z.ZodObject<{
             deviceId: z.ZodString;
             streamId: z.ZodString;
         }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        area: z.ZodString;
+        type: z.ZodLiteral<"image">;
+        fileId: z.ZodUUID;
     }, z.core.$strip>]>>;
 }, z.core.$strip>>;
 export type ViewInfo = z.infer<typeof sViewInfo>;
@@ -201,6 +219,10 @@ export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
             deviceId: z.ZodString;
             streamId: z.ZodString;
         }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        area: z.ZodString;
+        type: z.ZodLiteral<"image">;
+        fileId: z.ZodUUID;
     }, z.core.$strip>]>>;
 }, z.core.$strip>>;
 export type ViewDto = z.infer<typeof sViewDto>;

package/dist/objects/view.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sViewDto = exports.sViewInfo = exports.sViewConfig = exports.sViewAreaContents = exports.sPlaybackTrackArea = exports.sDeviceCarouselArea = exports.sDeviceArea = exports.sLayoutSelectorArea = exports.sLayoutArea = void 0;
+exports.sViewDto = exports.sViewInfo = exports.sViewConfig = exports.sViewAreaContents = exports.sImageArea = exports.sPlaybackTrackArea = exports.sDeviceCarouselArea = exports.sDeviceArea = exports.sLayoutSelectorArea = exports.sLayoutArea = void 0;
 const zod_1 = require("zod");
 exports.sLayoutArea = zod_1.z.object({
     area: zod_1.z.string().nonempty(),
@@ -43,12 +43,18 @@ exports.sPlaybackTrackArea = zod_1.z.object({
             .describe('The track within the controller. It is the stream ID for the camera in the track.'),
     }),
 });
+exports.sImageArea = zod_1.z.object({
+    area: zod_1.z.string().nonempty(),
+    type: zod_1.z.literal('image'),
+    fileId: zod_1.z.uuid(),
+});
 exports.sViewAreaContents = zod_1.z.union([
     exports.sLayoutArea,
     exports.sLayoutSelectorArea,
     exports.sDeviceArea,
     exports.sDeviceCarouselArea,
     exports.sPlaybackTrackArea,
+    exports.sImageArea,
 ]);
 exports.sViewConfig = zod_1.z.object({
     rows: zod_1.z.number(),

package/dist/package.json

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

package/package.json

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