@awarevue/api-types 2.0.135 → 2.0.137

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

@@ -76,11 +76,11 @@ export declare const sRegisterRq: z.ZodObject<{
             maxPerPerson: z.ZodOptional<z.ZodNumber>;
         }, z.core.$strip>>;
         accessObjects: z.ZodArray<z.ZodEnum<{
+            accessRule: "accessRule";
+            schedule: "schedule";
             person: "person";
             zone: "zone";
-            schedule: "schedule";
             device: "device";
-            accessRule: "accessRule";
         }>>;
         oneSchedulePerDoor: z.ZodBoolean;
     }, z.core.$strip>>>;
@@ -1490,11 +1490,11 @@ export declare const sChangeIssueCode: z.ZodEnum<{
 export declare const sChangeIssue: z.ZodObject<{
     objectId: z.ZodOptional<z.ZodString>;
     objectKind: z.ZodOptional<z.ZodEnum<{
+        accessRule: "accessRule";
+        schedule: "schedule";
         person: "person";
         zone: "zone";
-        schedule: "schedule";
         device: "device";
-        accessRule: "accessRule";
     }>>;
     code: z.ZodOptional<z.ZodEnum<{
         BAD_REFERENCE: "BAD_REFERENCE";
@@ -1513,11 +1513,11 @@ export declare const sValidateChangeRs: z.ZodObject<{
     issues: z.ZodArray<z.ZodObject<{
         objectId: z.ZodOptional<z.ZodString>;
         objectKind: z.ZodOptional<z.ZodEnum<{
+            accessRule: "accessRule";
+            schedule: "schedule";
             person: "person";
             zone: "zone";
-            schedule: "schedule";
             device: "device";
-            accessRule: "accessRule";
         }>>;
         code: z.ZodOptional<z.ZodEnum<{
             BAD_REFERENCE: "BAD_REFERENCE";
@@ -1779,11 +1779,11 @@ export declare const sDescribeObjectRq: z.ZodObject<{
     provider: z.ZodString;
     objectAssignedRef: z.ZodString;
     objectKind: z.ZodEnum<{
+        accessRule: "accessRule";
+        schedule: "schedule";
         person: "person";
         zone: "zone";
-        schedule: "schedule";
         device: "device";
-        accessRule: "accessRule";
     }>;
 }, z.core.$strip>;
 export declare const sDescribeObjectRs: z.ZodObject<{

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

@@ -43,18 +43,18 @@ export declare const sAddDeviceRequest: z.ZodObject<{
         "intercom-operator": "intercom-operator";
         "intercom-terminal": "intercom-terminal";
         pbx: "pbx";
-        alarm: "alarm";
-        display: "display";
-        "generic-sensor": "generic-sensor";
         server: "server";
+        alarm: "alarm";
+        "position-tracker": "position-tracker";
         "device-gateway": "device-gateway";
         "presence-tracker": "presence-tracker";
-        reader: "reader";
+        display: "display";
         "nvr-recorder": "nvr-recorder";
         "nvr-exporter": "nvr-exporter";
         "nvr-analytics-server": "nvr-analytics-server";
         system: "system";
-        "position-tracker": "position-tracker";
+        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>>;
@@ -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>;
@@ -168,3 +306,218 @@ export type DeviceSearchCriteria = {
 };
 export type EventVariantDescription = z.infer<typeof sEventVariantDescription>;
 export type GetEventCatalogResponse = z.infer<typeof sGetEventCatalogResponse>;
+/** The 202 body of a device write that is being applied. */
+export declare const sPendingDeviceWrite: z.ZodObject<{
+    device: z.ZodNullable<z.ZodIntersection<z.ZodIntersection<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"alarm">;
+    }, z.core.$strip>, z.ZodObject<{
+        ptzCapable: z.ZodBoolean;
+        ptzPanSpeed: z.ZodNumber;
+        ptzTiltSpeed: z.ZodNumber;
+        ptzZoomSpeed: z.ZodNumber;
+        panMin: z.ZodNumber;
+        panMax: z.ZodNumber;
+        tiltMin: z.ZodNumber;
+        tiltMax: z.ZodNumber;
+        zoomMin: z.ZodNumber;
+        zoomMax: z.ZodNumber;
+        streams: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            displayName: z.ZodString;
+            externalPlayerUrl: z.ZodNullable<z.ZodString>;
+            rtspUrl: z.ZodNullable<z.ZodString>;
+            width: z.ZodNullable<z.ZodNumber>;
+            height: z.ZodNullable<z.ZodNumber>;
+            lensType: z.ZodEnum<{
+                flat: "flat";
+                fisheye: "fisheye";
+            }>;
+            mountPoint: z.ZodEnum<{
+                wall: "wall";
+                ceiling: "ceiling";
+                floor: "floor";
+            }>;
+        }, z.core.$strip>>;
+        defaultStreamId: z.ZodString;
+        autoSwitchStreams: z.ZodBoolean;
+        streamNaming: z.ZodEnum<{
+            cameraStreamNo: "cameraStreamNo";
+            cameraStream: "cameraStream";
+            stream: "stream";
+        }>;
+        type: z.ZodLiteral<"camera">;
+    }, z.core.$strip>, z.ZodObject<{
+        canReportOpenState: z.ZodBoolean;
+        canReportLockState: z.ZodBoolean;
+        canControlLock: z.ZodBoolean;
+        canRelease: z.ZodBoolean;
+        type: z.ZodLiteral<"door">;
+    }, z.core.$strip>, z.ZodObject<{
+        inputs: z.ZodArray<z.ZodString>;
+        outputs: z.ZodArray<z.ZodString>;
+        type: z.ZodLiteral<"io-board">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"camera-lift">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"motion-sensor">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"generic-sensor">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"panic-button">;
+    }, z.core.$strip>, z.ZodObject<{
+        sipUri: z.ZodString;
+        sipUser: z.ZodString;
+        sipPassword: z.ZodString;
+        sipRealm: z.ZodString;
+        remoteExtension: z.ZodString;
+        type: z.ZodLiteral<"intercom-terminal">;
+    }, z.core.$strip>, z.ZodObject<{
+        sipWsUrl: z.ZodString;
+        type: z.ZodLiteral<"pbx">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"server">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"intercom-operator">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"device-gateway">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"presence-tracker">;
+    }, z.core.$strip>, z.ZodObject<{
+        credentialTypes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+            card: "card";
+            pin: "pin";
+            fingerprint: "fingerprint";
+            face: "face";
+            retina: "retina";
+        }>>>;
+        type: z.ZodLiteral<"reader">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"display">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"nvr-recorder">;
+    }, 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">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"position-tracker">;
+    }, z.core.$strip>], "type">, z.ZodObject<{
+        id: z.ZodString;
+        presets: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodString;
+            params: z.ZodUnknown;
+            isDefault: z.ZodBoolean;
+            assignedRef: z.ZodNullable<z.ZodString>;
+            createdOn: z.ZodString;
+            lastModifiedOn: z.ZodString;
+        }, z.core.$strip>>;
+        providerAssignedName: z.ZodString;
+        notes: z.ZodNullable<z.ZodString>;
+        tags: z.ZodArray<z.ZodString>;
+        displaySettings: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        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>>>;
+        groups: z.ZodArray<z.ZodString>;
+        enabled: z.ZodBoolean;
+        createdOn: z.ZodString;
+        lastModifiedOn: z.ZodString;
+    }, z.core.$strip>>, z.ZodObject<{
+        name: z.ZodString;
+        foreignRef: z.ZodString;
+        provider: z.ZodString;
+        providerMetadata: z.ZodObject<{}, z.core.$catchall<z.ZodUnknown>>;
+    }, z.core.$strip>>>;
+    changeset: z.ZodObject<{
+        id: z.ZodString;
+        phase: z.ZodEnum<{
+            failed: "failed";
+            pending: "pending";
+            committing: "committing";
+        }>;
+        label: z.ZodString;
+        originator: z.ZodString;
+        by: z.ZodNullable<z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodString;
+        }, z.core.$strip>>;
+        attempt: z.ZodNumber;
+        proposedAt: z.ZodNumber;
+        updatedAt: z.ZodNumber;
+        devices: z.ZodRecord<z.ZodString, z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodString;
+            type: z.ZodString;
+            change: z.ZodEnum<{
+                add: "add";
+                update: "update";
+                remove: "remove";
+                relation: "relation";
+                reconcile: "reconcile";
+            }>;
+        }, z.core.$strip>>;
+        steps: z.ZodArray<z.ZodObject<{
+            ref: z.ZodString;
+            deviceId: z.ZodString;
+            kind: z.ZodEnum<{
+                check: "check";
+                effect: "effect";
+            }>;
+            type: z.ZodString;
+            label: z.ZodString;
+            dependsOn: z.ZodArray<z.ZodString>;
+            status: z.ZodEnum<{
+                waiting: "waiting";
+                running: "running";
+                succeeded: "succeeded";
+                failed: "failed";
+                skipped: "skipped";
+            }>;
+            attempt: z.ZodNumber;
+            startedAt: z.ZodNullable<z.ZodNumber>;
+            finishedAt: z.ZodNullable<z.ZodNumber>;
+            error: z.ZodNullable<z.ZodObject<{
+                name: z.ZodString;
+                message: z.ZodString;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+        failure: z.ZodNullable<z.ZodObject<{
+            stepRef: z.ZodString;
+            message: z.ZodString;
+            at: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type PendingDeviceWrite = z.infer<typeof sPendingDeviceWrite>;

package/dist/api/rest/device.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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()),
@@ -53,3 +66,8 @@ exports.sRemoveDevicePresetRequest = zod_1.z.object({
 });
 exports.sGetEventCatalogResponse = zod_1.z.array(objects_1.sEventDescription);
 exports.sSetUnsetRelationRequest = objects_1.sDeviceRelationDto;
+/** The 202 body of a device write that is being applied. */
+exports.sPendingDeviceWrite = zod_1.z.object({
+    device: objects_1.sDeviceDto.nullable(), // import sDeviceDto from the device schemas
+    changeset: objects_1.sChangeset,
+});

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

@@ -1,9 +1,9 @@
 import { z } from 'zod';
 export declare const sAddMacroRequest: z.ZodObject<{
     displayName: z.ZodString;
+    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     code: z.ZodNullable<z.ZodString>;
     module: z.ZodNullable<z.ZodString>;
-    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     items: z.ZodArray<z.ZodObject<{
         id: z.ZodNullable<z.ZodString>;
         stepId: z.ZodString;
@@ -14,9 +14,9 @@ export declare const sAddMacroRequest: z.ZodObject<{
 }, z.core.$strip>;
 export declare const sUpdateMacroRequest: z.ZodObject<{
     displayName: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     code: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     module: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     items: z.ZodOptional<z.ZodArray<z.ZodObject<{
         id: z.ZodNullable<z.ZodString>;
         stepId: z.ZodString;

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

@@ -35,14 +35,14 @@ export declare const sMeResponse: z.ZodObject<{
 }, z.core.$strip>;
 export declare const sAddRoleRequest: z.ZodObject<{
     displayName: z.ZodString;
-    permissions: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"layout:read">, z.ZodLiteral<"layout:update">, z.ZodLiteral<"layout:delete">, z.ZodLiteral<"layout:create">, z.ZodLiteral<"camera:live">, z.ZodLiteral<"camera:playback">, z.ZodLiteral<"camera:playback-export">, z.ZodLiteral<"camera:ptz">, z.ZodLiteral<"camera:privacy-mode">, z.ZodLiteral<"camera:assign">, z.ZodLiteral<"camera:detection">, z.ZodLiteral<"camera:record">, z.ZodLiteral<"preset:read">, z.ZodLiteral<"preset:update">, z.ZodLiteral<"preset:delete">, z.ZodLiteral<"preset:create">, z.ZodLiteral<"door:release">, z.ZodLiteral<"door:lock">, z.ZodLiteral<"camera-lift:activate">, z.ZodLiteral<"io-board:activate">, z.ZodLiteral<"public-view:read">, z.ZodLiteral<"public-view:update">, z.ZodLiteral<"public-view:delete">, z.ZodLiteral<"public-view:create">, z.ZodLiteral<"private-view:read">, z.ZodLiteral<"person:read">, z.ZodLiteral<"person:update">, z.ZodLiteral<"person:delete">, z.ZodLiteral<"person:create">, z.ZodLiteral<"person:assign">, z.ZodLiteral<"person:print">, z.ZodLiteral<"person:face">, z.ZodLiteral<"zone:update">, z.ZodLiteral<"zone:delete">, z.ZodLiteral<"zone:create">, z.ZodLiteral<"access-rule:read">, z.ZodLiteral<"access-rule:update">, z.ZodLiteral<"access-rule:delete">, z.ZodLiteral<"access-rule:create">, z.ZodLiteral<"schedule:update">, z.ZodLiteral<"schedule:delete">, z.ZodLiteral<"schedule:create">, z.ZodLiteral<"presence:read">, z.ZodLiteral<"presence:update">, z.ZodLiteral<"presence:update-reader">, z.ZodLiteral<"factory:read">, z.ZodLiteral<"factory:update">, z.ZodLiteral<"factory:delete">, z.ZodLiteral<"factory:create">, z.ZodLiteral<"event:read">, z.ZodLiteral<"event:purge">, z.ZodLiteral<"alarm:read">, z.ZodLiteral<"alarm:acknowlede">, z.ZodLiteral<"alarm:arm">, z.ZodLiteral<"alarm:trigger">, z.ZodLiteral<"alarm:bypass">, z.ZodLiteral<"user:read">, z.ZodLiteral<"user:change-password">, z.ZodLiteral<"user:change-username">, z.ZodLiteral<"user:change-name">, z.ZodLiteral<"user:change-email">, z.ZodLiteral<"user:activate">, z.ZodLiteral<"user:delete">, z.ZodLiteral<"user:change-roles">, z.ZodLiteral<"user:create">, z.ZodLiteral<"role:create">, z.ZodLiteral<"role:delete">, z.ZodLiteral<"role:update">, z.ZodLiteral<"module:read">, z.ZodLiteral<"module:update">, z.ZodLiteral<"module:enable">, z.ZodLiteral<"device:discover">, z.ZodLiteral<"device:import">, z.ZodLiteral<"device:override-specs">, z.ZodLiteral<"device:notes">, z.ZodLiteral<"device:rename">, z.ZodLiteral<"device:alarms">, z.ZodLiteral<"automation:read">, z.ZodLiteral<"automation:update">, z.ZodLiteral<"automation:delete">, z.ZodLiteral<"automation:create">, z.ZodLiteral<"device-group:read">, z.ZodLiteral<"device-group:update">, z.ZodLiteral<"device-group:delete">, z.ZodLiteral<"device-group:create">, z.ZodLiteral<"macro:read">, z.ZodLiteral<"macro:update">, z.ZodLiteral<"macro:delete">, z.ZodLiteral<"macro:create">, z.ZodLiteral<"macro:run">, z.ZodLiteral<"notification:read">, z.ZodLiteral<"notification:create">, z.ZodLiteral<"notification:acknowledge">, z.ZodLiteral<"template:update">, z.ZodLiteral<"template:delete">, z.ZodLiteral<"template:create">, z.ZodLiteral<"custom-field:update">, z.ZodLiteral<"custom-field:delete">, z.ZodLiteral<"custom-field:create">, z.ZodLiteral<"display:read">, z.ZodLiteral<"security-level:update">, z.ZodLiteral<"security-level:delete">, z.ZodLiteral<"security-level:create">, z.ZodLiteral<"citadel-mode:toggle">, z.ZodLiteral<"token-conversion:update">, z.ZodLiteral<"token-conversion:delete">, z.ZodLiteral<"token-conversion:create">, z.ZodLiteral<"bookmark:read">, z.ZodLiteral<"bookmark:create">, z.ZodLiteral<"bookmark:update">, z.ZodLiteral<"bookmark:delete">, z.ZodLiteral<"access-path:read">, z.ZodLiteral<"access-path:create">, z.ZodLiteral<"access-path:update">, z.ZodLiteral<"access-path:delete">, z.ZodLiteral<"person-type:create">, z.ZodLiteral<"person-type:update">, z.ZodLiteral<"person-type:delete">, z.ZodLiteral<"agreement:create">, z.ZodLiteral<"agreement:update">, z.ZodLiteral<"agreement:delete">, z.ZodLiteral<"api-key:create">, z.ZodLiteral<"api-key:revoke">, z.ZodLiteral<"access-authority:read">, z.ZodLiteral<"access-authority:sync">, z.ZodLiteral<"access-authority:delete">, z.ZodLiteral<"trackable:read">, z.ZodLiteral<"trackable:image-upload">, z.ZodLiteral<"trackable:user-favorite">, z.ZodLiteral<"trackable:global-favorite">, z.ZodLiteral<"trackable:manage">, z.ZodLiteral<"trackable:image-manage">]>>;
     description: z.ZodString;
+    permissions: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"layout:read">, z.ZodLiteral<"layout:update">, z.ZodLiteral<"layout:delete">, z.ZodLiteral<"layout:create">, z.ZodLiteral<"camera:live">, z.ZodLiteral<"camera:playback">, z.ZodLiteral<"camera:playback-export">, z.ZodLiteral<"camera:ptz">, z.ZodLiteral<"camera:privacy-mode">, z.ZodLiteral<"camera:assign">, z.ZodLiteral<"camera:detection">, z.ZodLiteral<"camera:record">, z.ZodLiteral<"preset:read">, z.ZodLiteral<"preset:update">, z.ZodLiteral<"preset:delete">, z.ZodLiteral<"preset:create">, z.ZodLiteral<"door:release">, z.ZodLiteral<"door:lock">, z.ZodLiteral<"camera-lift:activate">, z.ZodLiteral<"io-board:activate">, z.ZodLiteral<"public-view:read">, z.ZodLiteral<"public-view:update">, z.ZodLiteral<"public-view:delete">, z.ZodLiteral<"public-view:create">, z.ZodLiteral<"private-view:read">, z.ZodLiteral<"person:read">, z.ZodLiteral<"person:update">, z.ZodLiteral<"person:delete">, z.ZodLiteral<"person:create">, z.ZodLiteral<"person:assign">, z.ZodLiteral<"person:print">, z.ZodLiteral<"person:face">, z.ZodLiteral<"zone:update">, z.ZodLiteral<"zone:delete">, z.ZodLiteral<"zone:create">, z.ZodLiteral<"access-rule:read">, z.ZodLiteral<"access-rule:update">, z.ZodLiteral<"access-rule:delete">, z.ZodLiteral<"access-rule:create">, z.ZodLiteral<"schedule:update">, z.ZodLiteral<"schedule:delete">, z.ZodLiteral<"schedule:create">, z.ZodLiteral<"presence:read">, z.ZodLiteral<"presence:update">, z.ZodLiteral<"presence:update-reader">, z.ZodLiteral<"factory:read">, z.ZodLiteral<"factory:update">, z.ZodLiteral<"factory:delete">, z.ZodLiteral<"factory:create">, z.ZodLiteral<"event:read">, z.ZodLiteral<"event:purge">, z.ZodLiteral<"alarm:read">, z.ZodLiteral<"alarm:acknowlede">, z.ZodLiteral<"alarm:arm">, z.ZodLiteral<"alarm:trigger">, z.ZodLiteral<"alarm:bypass">, z.ZodLiteral<"user:read">, z.ZodLiteral<"user:change-password">, z.ZodLiteral<"user:change-username">, z.ZodLiteral<"user:change-name">, z.ZodLiteral<"user:change-email">, z.ZodLiteral<"user:activate">, z.ZodLiteral<"user:delete">, z.ZodLiteral<"user:change-roles">, z.ZodLiteral<"user:create">, z.ZodLiteral<"role:create">, z.ZodLiteral<"role:delete">, z.ZodLiteral<"role:update">, z.ZodLiteral<"module:read">, z.ZodLiteral<"module:update">, z.ZodLiteral<"module:enable">, z.ZodLiteral<"device:discover">, z.ZodLiteral<"device:import">, z.ZodLiteral<"device:override-specs">, z.ZodLiteral<"device:notes">, z.ZodLiteral<"device:rename">, z.ZodLiteral<"device:alarms">, z.ZodLiteral<"automation:read">, z.ZodLiteral<"automation:update">, z.ZodLiteral<"automation:delete">, z.ZodLiteral<"automation:create">, z.ZodLiteral<"device-group:read">, z.ZodLiteral<"device-group:update">, z.ZodLiteral<"device-group:delete">, z.ZodLiteral<"device-group:create">, z.ZodLiteral<"macro:read">, z.ZodLiteral<"macro:update">, z.ZodLiteral<"macro:delete">, z.ZodLiteral<"macro:create">, z.ZodLiteral<"macro:run">, z.ZodLiteral<"notification:read">, z.ZodLiteral<"notification:create">, z.ZodLiteral<"notification:acknowledge">, z.ZodLiteral<"template:update">, z.ZodLiteral<"template:delete">, z.ZodLiteral<"template:create">, z.ZodLiteral<"custom-field:update">, z.ZodLiteral<"custom-field:delete">, z.ZodLiteral<"custom-field:create">, z.ZodLiteral<"display:read">, z.ZodLiteral<"security-level:update">, z.ZodLiteral<"security-level:delete">, z.ZodLiteral<"security-level:create">, z.ZodLiteral<"citadel-mode:toggle">, z.ZodLiteral<"token-conversion:update">, z.ZodLiteral<"token-conversion:delete">, z.ZodLiteral<"token-conversion:create">, z.ZodLiteral<"bookmark:read">, z.ZodLiteral<"bookmark:create">, z.ZodLiteral<"bookmark:update">, z.ZodLiteral<"bookmark:delete">, z.ZodLiteral<"access-path:read">, z.ZodLiteral<"access-path:create">, z.ZodLiteral<"access-path:update">, z.ZodLiteral<"access-path:delete">, z.ZodLiteral<"person-type:create">, z.ZodLiteral<"person-type:update">, z.ZodLiteral<"person-type:delete">, z.ZodLiteral<"agreement:create">, z.ZodLiteral<"agreement:update">, z.ZodLiteral<"agreement:delete">, z.ZodLiteral<"api-key:create">, z.ZodLiteral<"api-key:revoke">, z.ZodLiteral<"access-authority:read">, z.ZodLiteral<"access-authority:sync">, z.ZodLiteral<"access-authority:delete">, z.ZodLiteral<"trackable:read">, z.ZodLiteral<"trackable:image-upload">, z.ZodLiteral<"trackable:user-favorite">, z.ZodLiteral<"trackable:global-favorite">, z.ZodLiteral<"trackable:manage">, z.ZodLiteral<"trackable:image-manage">]>>;
     systemName: z.ZodString;
 }, z.core.$strip>;
 export declare const sUpdateRoleRequest: z.ZodObject<{
     displayName: z.ZodOptional<z.ZodString>;
-    permissions: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"layout:read">, z.ZodLiteral<"layout:update">, z.ZodLiteral<"layout:delete">, z.ZodLiteral<"layout:create">, z.ZodLiteral<"camera:live">, z.ZodLiteral<"camera:playback">, z.ZodLiteral<"camera:playback-export">, z.ZodLiteral<"camera:ptz">, z.ZodLiteral<"camera:privacy-mode">, z.ZodLiteral<"camera:assign">, z.ZodLiteral<"camera:detection">, z.ZodLiteral<"camera:record">, z.ZodLiteral<"preset:read">, z.ZodLiteral<"preset:update">, z.ZodLiteral<"preset:delete">, z.ZodLiteral<"preset:create">, z.ZodLiteral<"door:release">, z.ZodLiteral<"door:lock">, z.ZodLiteral<"camera-lift:activate">, z.ZodLiteral<"io-board:activate">, z.ZodLiteral<"public-view:read">, z.ZodLiteral<"public-view:update">, z.ZodLiteral<"public-view:delete">, z.ZodLiteral<"public-view:create">, z.ZodLiteral<"private-view:read">, z.ZodLiteral<"person:read">, z.ZodLiteral<"person:update">, z.ZodLiteral<"person:delete">, z.ZodLiteral<"person:create">, z.ZodLiteral<"person:assign">, z.ZodLiteral<"person:print">, z.ZodLiteral<"person:face">, z.ZodLiteral<"zone:update">, z.ZodLiteral<"zone:delete">, z.ZodLiteral<"zone:create">, z.ZodLiteral<"access-rule:read">, z.ZodLiteral<"access-rule:update">, z.ZodLiteral<"access-rule:delete">, z.ZodLiteral<"access-rule:create">, z.ZodLiteral<"schedule:update">, z.ZodLiteral<"schedule:delete">, z.ZodLiteral<"schedule:create">, z.ZodLiteral<"presence:read">, z.ZodLiteral<"presence:update">, z.ZodLiteral<"presence:update-reader">, z.ZodLiteral<"factory:read">, z.ZodLiteral<"factory:update">, z.ZodLiteral<"factory:delete">, z.ZodLiteral<"factory:create">, z.ZodLiteral<"event:read">, z.ZodLiteral<"event:purge">, z.ZodLiteral<"alarm:read">, z.ZodLiteral<"alarm:acknowlede">, z.ZodLiteral<"alarm:arm">, z.ZodLiteral<"alarm:trigger">, z.ZodLiteral<"alarm:bypass">, z.ZodLiteral<"user:read">, z.ZodLiteral<"user:change-password">, z.ZodLiteral<"user:change-username">, z.ZodLiteral<"user:change-name">, z.ZodLiteral<"user:change-email">, z.ZodLiteral<"user:activate">, z.ZodLiteral<"user:delete">, z.ZodLiteral<"user:change-roles">, z.ZodLiteral<"user:create">, z.ZodLiteral<"role:create">, z.ZodLiteral<"role:delete">, z.ZodLiteral<"role:update">, z.ZodLiteral<"module:read">, z.ZodLiteral<"module:update">, z.ZodLiteral<"module:enable">, z.ZodLiteral<"device:discover">, z.ZodLiteral<"device:import">, z.ZodLiteral<"device:override-specs">, z.ZodLiteral<"device:notes">, z.ZodLiteral<"device:rename">, z.ZodLiteral<"device:alarms">, z.ZodLiteral<"automation:read">, z.ZodLiteral<"automation:update">, z.ZodLiteral<"automation:delete">, z.ZodLiteral<"automation:create">, z.ZodLiteral<"device-group:read">, z.ZodLiteral<"device-group:update">, z.ZodLiteral<"device-group:delete">, z.ZodLiteral<"device-group:create">, z.ZodLiteral<"macro:read">, z.ZodLiteral<"macro:update">, z.ZodLiteral<"macro:delete">, z.ZodLiteral<"macro:create">, z.ZodLiteral<"macro:run">, z.ZodLiteral<"notification:read">, z.ZodLiteral<"notification:create">, z.ZodLiteral<"notification:acknowledge">, z.ZodLiteral<"template:update">, z.ZodLiteral<"template:delete">, z.ZodLiteral<"template:create">, z.ZodLiteral<"custom-field:update">, z.ZodLiteral<"custom-field:delete">, z.ZodLiteral<"custom-field:create">, z.ZodLiteral<"display:read">, z.ZodLiteral<"security-level:update">, z.ZodLiteral<"security-level:delete">, z.ZodLiteral<"security-level:create">, z.ZodLiteral<"citadel-mode:toggle">, z.ZodLiteral<"token-conversion:update">, z.ZodLiteral<"token-conversion:delete">, z.ZodLiteral<"token-conversion:create">, z.ZodLiteral<"bookmark:read">, z.ZodLiteral<"bookmark:create">, z.ZodLiteral<"bookmark:update">, z.ZodLiteral<"bookmark:delete">, z.ZodLiteral<"access-path:read">, z.ZodLiteral<"access-path:create">, z.ZodLiteral<"access-path:update">, z.ZodLiteral<"access-path:delete">, z.ZodLiteral<"person-type:create">, z.ZodLiteral<"person-type:update">, z.ZodLiteral<"person-type:delete">, z.ZodLiteral<"agreement:create">, z.ZodLiteral<"agreement:update">, z.ZodLiteral<"agreement:delete">, z.ZodLiteral<"api-key:create">, z.ZodLiteral<"api-key:revoke">, z.ZodLiteral<"access-authority:read">, z.ZodLiteral<"access-authority:sync">, z.ZodLiteral<"access-authority:delete">, z.ZodLiteral<"trackable:read">, z.ZodLiteral<"trackable:image-upload">, z.ZodLiteral<"trackable:user-favorite">, z.ZodLiteral<"trackable:global-favorite">, z.ZodLiteral<"trackable:manage">, z.ZodLiteral<"trackable:image-manage">]>>>;
     description: z.ZodOptional<z.ZodString>;
+    permissions: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"layout:read">, z.ZodLiteral<"layout:update">, z.ZodLiteral<"layout:delete">, z.ZodLiteral<"layout:create">, z.ZodLiteral<"camera:live">, z.ZodLiteral<"camera:playback">, z.ZodLiteral<"camera:playback-export">, z.ZodLiteral<"camera:ptz">, z.ZodLiteral<"camera:privacy-mode">, z.ZodLiteral<"camera:assign">, z.ZodLiteral<"camera:detection">, z.ZodLiteral<"camera:record">, z.ZodLiteral<"preset:read">, z.ZodLiteral<"preset:update">, z.ZodLiteral<"preset:delete">, z.ZodLiteral<"preset:create">, z.ZodLiteral<"door:release">, z.ZodLiteral<"door:lock">, z.ZodLiteral<"camera-lift:activate">, z.ZodLiteral<"io-board:activate">, z.ZodLiteral<"public-view:read">, z.ZodLiteral<"public-view:update">, z.ZodLiteral<"public-view:delete">, z.ZodLiteral<"public-view:create">, z.ZodLiteral<"private-view:read">, z.ZodLiteral<"person:read">, z.ZodLiteral<"person:update">, z.ZodLiteral<"person:delete">, z.ZodLiteral<"person:create">, z.ZodLiteral<"person:assign">, z.ZodLiteral<"person:print">, z.ZodLiteral<"person:face">, z.ZodLiteral<"zone:update">, z.ZodLiteral<"zone:delete">, z.ZodLiteral<"zone:create">, z.ZodLiteral<"access-rule:read">, z.ZodLiteral<"access-rule:update">, z.ZodLiteral<"access-rule:delete">, z.ZodLiteral<"access-rule:create">, z.ZodLiteral<"schedule:update">, z.ZodLiteral<"schedule:delete">, z.ZodLiteral<"schedule:create">, z.ZodLiteral<"presence:read">, z.ZodLiteral<"presence:update">, z.ZodLiteral<"presence:update-reader">, z.ZodLiteral<"factory:read">, z.ZodLiteral<"factory:update">, z.ZodLiteral<"factory:delete">, z.ZodLiteral<"factory:create">, z.ZodLiteral<"event:read">, z.ZodLiteral<"event:purge">, z.ZodLiteral<"alarm:read">, z.ZodLiteral<"alarm:acknowlede">, z.ZodLiteral<"alarm:arm">, z.ZodLiteral<"alarm:trigger">, z.ZodLiteral<"alarm:bypass">, z.ZodLiteral<"user:read">, z.ZodLiteral<"user:change-password">, z.ZodLiteral<"user:change-username">, z.ZodLiteral<"user:change-name">, z.ZodLiteral<"user:change-email">, z.ZodLiteral<"user:activate">, z.ZodLiteral<"user:delete">, z.ZodLiteral<"user:change-roles">, z.ZodLiteral<"user:create">, z.ZodLiteral<"role:create">, z.ZodLiteral<"role:delete">, z.ZodLiteral<"role:update">, z.ZodLiteral<"module:read">, z.ZodLiteral<"module:update">, z.ZodLiteral<"module:enable">, z.ZodLiteral<"device:discover">, z.ZodLiteral<"device:import">, z.ZodLiteral<"device:override-specs">, z.ZodLiteral<"device:notes">, z.ZodLiteral<"device:rename">, z.ZodLiteral<"device:alarms">, z.ZodLiteral<"automation:read">, z.ZodLiteral<"automation:update">, z.ZodLiteral<"automation:delete">, z.ZodLiteral<"automation:create">, z.ZodLiteral<"device-group:read">, z.ZodLiteral<"device-group:update">, z.ZodLiteral<"device-group:delete">, z.ZodLiteral<"device-group:create">, z.ZodLiteral<"macro:read">, z.ZodLiteral<"macro:update">, z.ZodLiteral<"macro:delete">, z.ZodLiteral<"macro:create">, z.ZodLiteral<"macro:run">, z.ZodLiteral<"notification:read">, z.ZodLiteral<"notification:create">, z.ZodLiteral<"notification:acknowledge">, z.ZodLiteral<"template:update">, z.ZodLiteral<"template:delete">, z.ZodLiteral<"template:create">, z.ZodLiteral<"custom-field:update">, z.ZodLiteral<"custom-field:delete">, z.ZodLiteral<"custom-field:create">, z.ZodLiteral<"display:read">, z.ZodLiteral<"security-level:update">, z.ZodLiteral<"security-level:delete">, z.ZodLiteral<"security-level:create">, z.ZodLiteral<"citadel-mode:toggle">, z.ZodLiteral<"token-conversion:update">, z.ZodLiteral<"token-conversion:delete">, z.ZodLiteral<"token-conversion:create">, z.ZodLiteral<"bookmark:read">, z.ZodLiteral<"bookmark:create">, z.ZodLiteral<"bookmark:update">, z.ZodLiteral<"bookmark:delete">, z.ZodLiteral<"access-path:read">, z.ZodLiteral<"access-path:create">, z.ZodLiteral<"access-path:update">, z.ZodLiteral<"access-path:delete">, z.ZodLiteral<"person-type:create">, z.ZodLiteral<"person-type:update">, z.ZodLiteral<"person-type:delete">, z.ZodLiteral<"agreement:create">, z.ZodLiteral<"agreement:update">, z.ZodLiteral<"agreement:delete">, z.ZodLiteral<"api-key:create">, z.ZodLiteral<"api-key:revoke">, z.ZodLiteral<"access-authority:read">, z.ZodLiteral<"access-authority:sync">, z.ZodLiteral<"access-authority:delete">, z.ZodLiteral<"trackable:read">, z.ZodLiteral<"trackable:image-upload">, z.ZodLiteral<"trackable:user-favorite">, z.ZodLiteral<"trackable:global-favorite">, z.ZodLiteral<"trackable:manage">, z.ZodLiteral<"trackable:image-manage">]>>>;
     systemName: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type NewUserRequest = z.infer<typeof sNewUserRequest>;

package/dist/objects/agent-metadata.d.ts

@@ -39,11 +39,11 @@ export declare const sProviderSpecs: z.ZodObject<{
     }, z.core.$strip>]>>>;
 }, z.core.$strip>;
 export declare const sAccessObjectKind: z.ZodEnum<{
+    accessRule: "accessRule";
+    schedule: "schedule";
     person: "person";
     zone: "zone";
-    schedule: "schedule";
     device: "device";
-    accessRule: "accessRule";
 }>;
 export declare const sTokenSpecs: z.ZodObject<{
     type: z.ZodEnum<{
@@ -71,11 +71,11 @@ export declare const sAccessControlCapabilityReport: z.ZodObject<{
         maxPerPerson: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>>;
     accessObjects: z.ZodArray<z.ZodEnum<{
+        accessRule: "accessRule";
+        schedule: "schedule";
         person: "person";
         zone: "zone";
-        schedule: "schedule";
         device: "device";
-        accessRule: "accessRule";
     }>>;
     oneSchedulePerDoor: z.ZodBoolean;
 }, z.core.$strip>;

package/dist/objects/all.d.ts

@@ -18,17 +18,17 @@ import { UserDto } from './user';
 import { ViewDto } from './view';
 import { ZoneDto, ZoneProps } from './zone';
 export declare const sObjectKind: z.ZodEnum<{
+    accessRule: "accessRule";
+    schedule: "schedule";
     person: "person";
     zone: "zone";
+    device: "device";
     layout: "layout";
-    schedule: "schedule";
     user: "user";
     role: "role";
-    device: "device";
     macro: "macro";
     bookmark: "bookmark";
     agreement: "agreement";
-    accessRule: "accessRule";
     personPresence: "personPresence";
     deviceGroup: "deviceGroup";
     view: "view";

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

@@ -30,18 +30,18 @@ export declare const sDeviceType: z.ZodEnum<{
     "intercom-operator": "intercom-operator";
     "intercom-terminal": "intercom-terminal";
     pbx: "pbx";
-    alarm: "alarm";
-    display: "display";
-    "generic-sensor": "generic-sensor";
     server: "server";
+    alarm: "alarm";
+    "position-tracker": "position-tracker";
     "device-gateway": "device-gateway";
     "presence-tracker": "presence-tracker";
-    reader: "reader";
+    display: "display";
     "nvr-recorder": "nvr-recorder";
     "nvr-exporter": "nvr-exporter";
     "nvr-analytics-server": "nvr-analytics-server";
     system: "system";
-    "position-tracker": "position-tracker";
+    reader: "reader";
+    "generic-sensor": "generic-sensor";
 }>;
 export declare const sDisplaySpecsWithType: z.ZodObject<{
     type: z.ZodLiteral<"display">;

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

@@ -0,0 +1,209 @@
+import { z } from 'zod';
+export declare const CONFIG_STATE_KEY = "deviceChanges";
+export declare const COMMIT_STEP_REF = "<commit>";
+export declare const MAX_STEP_ATTEMPTS = 3;
+export declare const sChangesetId: z.ZodString;
+/** `check` is reserved for verification steps; nothing emits it yet. */
+export declare const sStepKind: z.ZodEnum<{
+    check: "check";
+    effect: "effect";
+}>;
+/** `skipped`: a step this one depended on failed, so it never ran. */
+export declare const sStepStatus: z.ZodEnum<{
+    waiting: "waiting";
+    running: "running";
+    succeeded: "succeeded";
+    failed: "failed";
+    skipped: "skipped";
+}>;
+export declare const sStep: z.ZodObject<{
+    ref: z.ZodString;
+    deviceId: z.ZodString;
+    kind: z.ZodEnum<{
+        check: "check";
+        effect: "effect";
+    }>;
+    type: z.ZodString;
+    label: z.ZodString;
+    dependsOn: z.ZodArray<z.ZodString>;
+    status: z.ZodEnum<{
+        waiting: "waiting";
+        running: "running";
+        succeeded: "succeeded";
+        failed: "failed";
+        skipped: "skipped";
+    }>;
+    attempt: z.ZodNumber;
+    startedAt: z.ZodNullable<z.ZodNumber>;
+    finishedAt: z.ZodNullable<z.ZodNumber>;
+    error: z.ZodNullable<z.ZodObject<{
+        name: z.ZodString;
+        message: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const sDeviceChange: z.ZodEnum<{
+    add: "add";
+    update: "update";
+    remove: "remove";
+    relation: "relation";
+    reconcile: "reconcile";
+}>;
+export declare const sChangesetDevice: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    type: z.ZodString;
+    change: z.ZodEnum<{
+        add: "add";
+        update: "update";
+        remove: "remove";
+        relation: "relation";
+        reconcile: "reconcile";
+    }>;
+}, z.core.$strip>;
+export declare const sChangesetPhase: z.ZodEnum<{
+    failed: "failed";
+    pending: "pending";
+    committing: "committing";
+}>;
+export declare const sChangesetFailure: z.ZodObject<{
+    stepRef: z.ZodString;
+    message: z.ZodString;
+    at: z.ZodNumber;
+}, z.core.$strip>;
+export declare const sChangeset: z.ZodObject<{
+    id: z.ZodString;
+    phase: z.ZodEnum<{
+        failed: "failed";
+        pending: "pending";
+        committing: "committing";
+    }>;
+    label: z.ZodString;
+    originator: z.ZodString;
+    by: z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+    }, z.core.$strip>>;
+    attempt: z.ZodNumber;
+    proposedAt: z.ZodNumber;
+    updatedAt: z.ZodNumber;
+    devices: z.ZodRecord<z.ZodString, z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        type: z.ZodString;
+        change: z.ZodEnum<{
+            add: "add";
+            update: "update";
+            remove: "remove";
+            relation: "relation";
+            reconcile: "reconcile";
+        }>;
+    }, z.core.$strip>>;
+    steps: z.ZodArray<z.ZodObject<{
+        ref: z.ZodString;
+        deviceId: z.ZodString;
+        kind: z.ZodEnum<{
+            check: "check";
+            effect: "effect";
+        }>;
+        type: z.ZodString;
+        label: z.ZodString;
+        dependsOn: z.ZodArray<z.ZodString>;
+        status: z.ZodEnum<{
+            waiting: "waiting";
+            running: "running";
+            succeeded: "succeeded";
+            failed: "failed";
+            skipped: "skipped";
+        }>;
+        attempt: z.ZodNumber;
+        startedAt: z.ZodNullable<z.ZodNumber>;
+        finishedAt: z.ZodNullable<z.ZodNumber>;
+        error: z.ZodNullable<z.ZodObject<{
+            name: z.ZodString;
+            message: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    failure: z.ZodNullable<z.ZodObject<{
+        stepRef: z.ZodString;
+        message: z.ZodString;
+        at: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/** Server device state, key `configState`. Committed changesets are absent. */
+export declare const sConfigState: z.ZodObject<{
+    changesets: z.ZodRecord<z.ZodString, z.ZodObject<{
+        id: z.ZodString;
+        phase: z.ZodEnum<{
+            failed: "failed";
+            pending: "pending";
+            committing: "committing";
+        }>;
+        label: z.ZodString;
+        originator: z.ZodString;
+        by: z.ZodNullable<z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodString;
+        }, z.core.$strip>>;
+        attempt: z.ZodNumber;
+        proposedAt: z.ZodNumber;
+        updatedAt: z.ZodNumber;
+        devices: z.ZodRecord<z.ZodString, z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodString;
+            type: z.ZodString;
+            change: z.ZodEnum<{
+                add: "add";
+                update: "update";
+                remove: "remove";
+                relation: "relation";
+                reconcile: "reconcile";
+            }>;
+        }, z.core.$strip>>;
+        steps: z.ZodArray<z.ZodObject<{
+            ref: z.ZodString;
+            deviceId: z.ZodString;
+            kind: z.ZodEnum<{
+                check: "check";
+                effect: "effect";
+            }>;
+            type: z.ZodString;
+            label: z.ZodString;
+            dependsOn: z.ZodArray<z.ZodString>;
+            status: z.ZodEnum<{
+                waiting: "waiting";
+                running: "running";
+                succeeded: "succeeded";
+                failed: "failed";
+                skipped: "skipped";
+            }>;
+            attempt: z.ZodNumber;
+            startedAt: z.ZodNullable<z.ZodNumber>;
+            finishedAt: z.ZodNullable<z.ZodNumber>;
+            error: z.ZodNullable<z.ZodObject<{
+                name: z.ZodString;
+                message: z.ZodString;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+        failure: z.ZodNullable<z.ZodObject<{
+            stepRef: z.ZodString;
+            message: z.ZodString;
+            at: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/** Any existing touched device's state, key `configState`. Absent when untouched. */
+export declare const sDeviceConfigState: z.ZodObject<{
+    changesetId: z.ZodString;
+    phase: z.ZodEnum<{
+        failed: "failed";
+        pending: "pending";
+        committing: "committing";
+    }>;
+}, z.core.$strip>;
+export type Step = z.infer<typeof sStep>;
+export type StepStatus = z.infer<typeof sStepStatus>;
+export type ChangesetDevice = z.infer<typeof sChangesetDevice>;
+export type ChangesetPhase = z.infer<typeof sChangesetPhase>;
+export type Changeset = z.infer<typeof sChangeset>;
+export type ConfigState = z.infer<typeof sConfigState>;
+export type DeviceConfigState = z.infer<typeof sDeviceConfigState>;

package/dist/objects/device/changeset.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sDeviceConfigState = exports.sConfigState = exports.sChangeset = exports.sChangesetFailure = exports.sChangesetPhase = exports.sChangesetDevice = exports.sDeviceChange = exports.sStep = exports.sStepStatus = exports.sStepKind = exports.sChangesetId = exports.MAX_STEP_ATTEMPTS = exports.COMMIT_STEP_REF = exports.CONFIG_STATE_KEY = void 0;
+// api-types: objects/device/changeset.ts
+const zod_1 = require("zod");
+exports.CONFIG_STATE_KEY = 'deviceChanges';
+exports.COMMIT_STEP_REF = '<commit>';
+exports.MAX_STEP_ATTEMPTS = 3;
+exports.sChangesetId = zod_1.z.string();
+/** `check` is reserved for verification steps; nothing emits it yet. */
+exports.sStepKind = zod_1.z.enum(['effect', 'check']);
+/** `skipped`: a step this one depended on failed, so it never ran. */
+exports.sStepStatus = zod_1.z.enum([
+    'waiting',
+    'running',
+    'succeeded',
+    'failed',
+    'skipped',
+]);
+exports.sStep = zod_1.z.object({
+    /** `<planner>/<deviceId>/<ref>`, unique within the changeset. */
+    ref: zod_1.z.string().min(1),
+    deviceId: zod_1.z.string(),
+    kind: exports.sStepKind,
+    type: zod_1.z.string().min(1),
+    label: zod_1.z.string(),
+    dependsOn: zod_1.z.array(zod_1.z.string()),
+    status: exports.sStepStatus,
+    attempt: zod_1.z.number().int().min(0).max(exports.MAX_STEP_ATTEMPTS),
+    startedAt: zod_1.z.number().int().nullable(),
+    finishedAt: zod_1.z.number().int().nullable(),
+    error: zod_1.z.object({ name: zod_1.z.string(), message: zod_1.z.string() }).nullable(),
+});
+exports.sDeviceChange = zod_1.z.enum([
+    'add',
+    'update',
+    'remove',
+    'relation',
+    'reconcile',
+]);
+exports.sChangesetDevice = zod_1.z.object({
+    id: zod_1.z.string(),
+    name: zod_1.z.string(),
+    type: zod_1.z.string(),
+    change: exports.sDeviceChange,
+});
+exports.sChangesetPhase = zod_1.z.enum(['pending', 'committing', 'failed']);
+exports.sChangesetFailure = zod_1.z.object({
+    /** `COMMIT_STEP_REF` when the commit itself failed. */
+    stepRef: zod_1.z.string(),
+    message: zod_1.z.string(),
+    at: zod_1.z.number().int(),
+});
+exports.sChangeset = zod_1.z.object({
+    id: exports.sChangesetId,
+    phase: exports.sChangesetPhase,
+    label: zod_1.z.string(),
+    /** `http/<X-Request-Id>` or `system/boot`. How a client recognises its own. */
+    originator: zod_1.z.string(),
+    by: zod_1.z.object({ id: zod_1.z.string(), name: zod_1.z.string() }).nullable(),
+    /** 1 on proposal, +1 per retry. The id never changes. */
+    attempt: zod_1.z.number().int().min(1),
+    proposedAt: zod_1.z.number().int(),
+    updatedAt: zod_1.z.number().int(),
+    devices: zod_1.z.record(zod_1.z.string(), exports.sChangesetDevice),
+    steps: zod_1.z.array(exports.sStep),
+    failure: exports.sChangesetFailure.nullable(),
+});
+/** Server device state, key `configState`. Committed changesets are absent. */
+exports.sConfigState = zod_1.z.object({
+    changesets: zod_1.z.record(exports.sChangesetId, exports.sChangeset),
+});
+/** Any existing touched device's state, key `configState`. Absent when untouched. */
+exports.sDeviceConfigState = zod_1.z.object({
+    changesetId: exports.sChangesetId,
+    phase: exports.sChangesetPhase,
+});

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

@@ -21,3 +21,4 @@ export * from './nvr-recorder';
 export * from './nvr-exporter';
 export * from './nvr-analytics-server';
 export * from './system';
+export * from './changeset';

package/dist/objects/device/index.js

@@ -37,3 +37,4 @@ __exportStar(require("./nvr-recorder"), exports);
 __exportStar(require("./nvr-exporter"), exports);
 __exportStar(require("./nvr-analytics-server"), exports);
 __exportStar(require("./system"), exports);
+__exportStar(require("./changeset"), exports);

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

@@ -1,4 +1,5 @@
-import { AccessControlCapabilityReport } from '../../objects';
+import { ConfigState } from '../../objects/device/changeset';
+import { AccessControlCapabilityReport } from '../agent-metadata';
 import { ModuleConfig, ModuleConfigMetadata } from '../module-config';
 export declare const SERVER = "server";
 export type AccessControlProviderState = AccessControlCapabilityReport & {
@@ -15,4 +16,5 @@ export type ServerState = {
     runnableProviders: string[];
     accessControlProviders: Record<string, AccessControlProviderState>;
     citadelMode: boolean;
+    deviceChanges: ConfigState;
 };

package/dist/package.json

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