@awarevue/api-types 2.0.136 → 2.0.137

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

@@ -95,6 +95,143 @@ export declare const sUpdateDeviceRequest: z.ZodObject<{
     }, z.core.$catchall<z.ZodUnknown>>>>;
     enabled: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
+/**
+ * A set of device changes applied as one changeset: PUT /devices/changes.
+ * Validated, planned and committed as one; 202 with the changeset while it
+ * is being applied, 409 if any touched device is held by a pending one.
+ */
+export declare const sApplyDeviceChangesRequest: z.ZodObject<{
+    added: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        foreignRef: z.ZodString;
+        notes: z.ZodNullable<z.ZodString>;
+        provider: z.ZodString;
+        providerMetadata: z.ZodObject<{}, z.core.$catchall<z.ZodUnknown>>;
+        tags: z.ZodArray<z.ZodString>;
+        relations: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            kind: z.ZodEnum<{
+                attachedTo: "attachedTo";
+                parent: "parent";
+                child: "child";
+                holds: "holds";
+                isHeldBy: "isHeldBy";
+                observes: "observes";
+                isObservedBy: "isObservedBy";
+                sendsInputTo: "sendsInputTo";
+                receivesInputFrom: "receivesInputFrom";
+                sendsOutputTo: "sendsOutputTo";
+                receivesOutputFrom: "receivesOutputFrom";
+                unlocks: "unlocks";
+                isUnlockedBy: "isUnlockedBy";
+                controls: "controls";
+                isControlledBy: "isControlledBy";
+                records: "records";
+                isRecordedBy: "isRecordedBy";
+                reads: "reads";
+                isReadBy: "isReadBy";
+                isIngestedBy: "isIngestedBy";
+                ingests: "ingests";
+            }>;
+        }, z.core.$catchall<z.ZodUnknown>>>;
+        type: z.ZodEnum<{
+            camera: "camera";
+            door: "door";
+            "io-board": "io-board";
+            "camera-lift": "camera-lift";
+            "motion-sensor": "motion-sensor";
+            "panic-button": "panic-button";
+            "intercom-operator": "intercom-operator";
+            "intercom-terminal": "intercom-terminal";
+            pbx: "pbx";
+            server: "server";
+            alarm: "alarm";
+            "position-tracker": "position-tracker";
+            "device-gateway": "device-gateway";
+            "presence-tracker": "presence-tracker";
+            display: "display";
+            "nvr-recorder": "nvr-recorder";
+            "nvr-exporter": "nvr-exporter";
+            "nvr-analytics-server": "nvr-analytics-server";
+            system: "system";
+            reader: "reader";
+            "generic-sensor": "generic-sensor";
+        }>;
+        specs: z.ZodOptional<z.ZodObject<{}, z.core.$catchall<z.ZodUnknown>>>;
+        displaySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strip>>;
+    updated: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        notes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        providerMetadata: z.ZodOptional<z.ZodObject<{}, z.core.$catchall<z.ZodUnknown>>>;
+        displaySettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        specs: z.ZodOptional<z.ZodObject<{}, z.core.$catchall<z.ZodUnknown>>>;
+        tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        relations: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            kind: z.ZodEnum<{
+                attachedTo: "attachedTo";
+                parent: "parent";
+                child: "child";
+                holds: "holds";
+                isHeldBy: "isHeldBy";
+                observes: "observes";
+                isObservedBy: "isObservedBy";
+                sendsInputTo: "sendsInputTo";
+                receivesInputFrom: "receivesInputFrom";
+                sendsOutputTo: "sendsOutputTo";
+                receivesOutputFrom: "receivesOutputFrom";
+                unlocks: "unlocks";
+                isUnlockedBy: "isUnlockedBy";
+                controls: "controls";
+                isControlledBy: "isControlledBy";
+                records: "records";
+                isRecordedBy: "isRecordedBy";
+                reads: "reads";
+                isReadBy: "isReadBy";
+                isIngestedBy: "isIngestedBy";
+                ingests: "ingests";
+            }>;
+        }, z.core.$catchall<z.ZodUnknown>>>>;
+        enabled: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    removed: z.ZodArray<z.ZodString>;
+    relations: z.ZodArray<z.ZodObject<{
+        relation: z.ZodObject<{
+            leftId: z.ZodString;
+            rightId: z.ZodString;
+            kind: z.ZodEnum<{
+                attachedTo: "attachedTo";
+                parent: "parent";
+                child: "child";
+                holds: "holds";
+                isHeldBy: "isHeldBy";
+                observes: "observes";
+                isObservedBy: "isObservedBy";
+                sendsInputTo: "sendsInputTo";
+                receivesInputFrom: "receivesInputFrom";
+                sendsOutputTo: "sendsOutputTo";
+                receivesOutputFrom: "receivesOutputFrom";
+                unlocks: "unlocks";
+                isUnlockedBy: "isUnlockedBy";
+                controls: "controls";
+                isControlledBy: "isControlledBy";
+                records: "records";
+                isRecordedBy: "isRecordedBy";
+                reads: "reads";
+                isReadBy: "isReadBy";
+                isIngestedBy: "isIngestedBy";
+                ingests: "ingests";
+            }>;
+        }, z.core.$catchall<z.ZodUnknown>>;
+        action: z.ZodEnum<{
+            added: "added";
+            updated: "updated";
+            removed: "removed";
+        }>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
 export declare const sOverrideDeviceSpecsRequest: z.ZodObject<{
     id: z.ZodString;
     specs: z.ZodObject<{}, z.core.$catchall<z.ZodUnknown>>;
@@ -158,6 +295,7 @@ export declare const sSetUnsetRelationRequest: z.ZodObject<{
 }, z.core.$catchall<z.ZodUnknown>>;
 export type AddDeviceRequest = z.infer<typeof sAddDeviceRequest>;
 export type UpdateDeviceRequest = z.infer<typeof sUpdateDeviceRequest>;
+export type ApplyDeviceChangesRequest = z.infer<typeof sApplyDeviceChangesRequest>;
 export type OverrideDeviceSpecsRequest = z.infer<typeof sOverrideDeviceSpecsRequest>;
 export type AddDevicePresetRequest = z.infer<typeof sAddDevicePresetRequest>;
 export type UpdateDevicePresetRequest = z.infer<typeof sUpdateDevicePresetRequest>;

package/dist/api/rest/device.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sPendingDeviceWrite = exports.sSetUnsetRelationRequest = exports.sGetEventCatalogResponse = exports.sRemoveDevicePresetRequest = exports.sUpdateDevicePresetRequest = exports.sAddDevicePresetRequest = exports.sOverrideDeviceSpecsRequest = exports.sUpdateDeviceRequest = exports.sAddDeviceRequest = void 0;
+exports.sPendingDeviceWrite = exports.sSetUnsetRelationRequest = exports.sGetEventCatalogResponse = exports.sRemoveDevicePresetRequest = exports.sUpdateDevicePresetRequest = exports.sAddDevicePresetRequest = exports.sOverrideDeviceSpecsRequest = exports.sApplyDeviceChangesRequest = exports.sUpdateDeviceRequest = exports.sAddDeviceRequest = void 0;
 const zod_1 = require("zod");
 const objects_1 = require("../../objects");
 exports.sAddDeviceRequest = zod_1.z.object({
@@ -26,6 +26,19 @@ exports.sUpdateDeviceRequest = zod_1.z.object({
     relations: zod_1.z.array(objects_1.sDeviceRelationSide).optional(),
     enabled: zod_1.z.boolean().optional(),
 });
+/**
+ * A set of device changes applied as one changeset: PUT /devices/changes.
+ * Validated, planned and committed as one; 202 with the changeset while it
+ * is being applied, 409 if any touched device is held by a pending one.
+ */
+exports.sApplyDeviceChangesRequest = zod_1.z.object({
+    /** No id: the server assigns one. */
+    added: zod_1.z.array(exports.sAddDeviceRequest),
+    updated: zod_1.z.array(exports.sUpdateDeviceRequest),
+    removed: zod_1.z.array(zod_1.z.string().nonempty()),
+    /** Both ends by device id. */
+    relations: zod_1.z.array(objects_1.sRelationDeltaDto),
+});
 exports.sOverrideDeviceSpecsRequest = zod_1.z.object({
     id: zod_1.z.string(),
     specs: zod_1.z.object({}).catchall(zod_1.z.unknown()),

package/dist/package.json

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