@awarevue/api-types 2.0.83 → 2.0.84

package/dist/api/agent-protocol/protocol.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isMessageFromAgent = exports.getAgentMessageIssues = exports.ReplyKindByRequestKind = exports.sAbortChange = exports.sApplyChangeProgress = exports.sApplyChangeRs = exports.sApplyChange = exports.sValidateChangeRs = exports.sChangeIssue = exports.sChangeIssueCode = exports.sValidateChangeRq = exports.sRefMap = exports.sDeviceMap = exports.sAccessMutation = exports.sObjectDelete = exports.sObjectMerge = exports.sGetAvailableDevicesRs = exports.sGetAvailableDevicesRq = exports.sPushEventRs = exports.sPushEventRq = exports.sPushStateUpdateRs = exports.sPushStateUpdateRq = exports.sPushFile = exports.sProgressUpdate = exports.sQueryRs = exports.sQueryRq = exports.sRunCommandRs = exports.sRunCommandRq = exports.sStopServiceRs = exports.sStopServiceRq = exports.sStartServiceRs = exports.sStartServiceRq = exports.sValidateProviderConfigRs = exports.sConfigurationIssue = exports.sValidateProviderConfigRq = exports.sUnregister = exports.sRegisterRs = exports.sRegisterRq = exports.sErrorPayload = exports.sAgentErrorCode = exports.sResponsePayload = exports.sMessageWithPayload = exports.sMessageHeader = void 0;
+exports.isMessageFromAgent = exports.getAgentMessageIssues = exports.ReplyKindByRequestKind = exports.sDescribeObjectRs = exports.sDescribeObjectRq = exports.sAbortChange = exports.sApplyChangeProgress = exports.sApplyChangeRs = exports.sApplyChange = exports.sValidateChangeRs = exports.sChangeIssue = exports.sChangeIssueCode = exports.sValidateChangeRq = exports.sRefMap = exports.sDeviceMap = exports.sAccessMutation = exports.sObjectDelete = exports.sObjectMerge = exports.sExternalObjectProps = exports.sExternalZoneProps = exports.sExternalAccessRuleProps = exports.sExternalScheduleProps = exports.sExternalPersonProps = exports.sGetAvailableDevicesRs = exports.sGetAvailableDevicesRq = exports.sPushEventRs = exports.sPushEventRq = exports.sPushStateUpdateRs = exports.sPushStateUpdateRq = exports.sPushFile = exports.sProgressUpdate = exports.sQueryRs = exports.sQueryRq = exports.sRunCommandRs = exports.sRunCommandRq = exports.sStopServiceRs = exports.sStopServiceRq = exports.sStartServiceRs = exports.sStartServiceRq = exports.sValidateProviderConfigRs = exports.sConfigurationIssue = exports.sValidateProviderConfigRq = exports.sUnregister = exports.sRegisterRs = exports.sRegisterRq = exports.sErrorPayload = exports.sAgentErrorCode = exports.sResponsePayload = exports.sMessageWithPayload = exports.sMessageHeader = void 0;
 const device_import_1 = require("../../objects/device/device-import");
 const zod_1 = require("zod");
 const rest_1 = require("../rest");
 const primitives_1 = require("../../primitives");
 const agent_metadata_1 = require("../../objects/agent-metadata");
+const objects_1 = require("../../objects");
 // PROTOCOL ENVELOPE
 exports.sMessageHeader = zod_1.z.object({
     version: zod_1.z.number().describe('Protocol version'),
@@ -36,6 +37,7 @@ exports.sRegisterRq = zod_1.z.object({
     accessControlProviders: zod_1.z
         .record(zod_1.z.string(), agent_metadata_1.sAccessControlCapabilityReport)
         .optional(),
+    testerCliTags: zod_1.z.array(zod_1.z.string().nonempty()).optional(),
 });
 exports.sRegisterRs = (0, exports.sResponsePayload)(zod_1.z.literal('register-rs'), zod_1.z.object({}));
 // UNREGISTER
@@ -165,74 +167,72 @@ exports.sGetAvailableDevicesRq = zod_1.z
     .describe('Request to get available devices from a provider via an agent');
 exports.sGetAvailableDevicesRs = (0, exports.sResponsePayload)(zod_1.z.literal('get-available-devices-rs'), device_import_1.sDeviceDiscoveryDto).describe('Response for getting available devices from a provider via an agent');
 // ACCESS SYNC SECTION
+exports.sExternalPersonProps = zod_1.z.object({
+    firstName: zod_1.z.string().nonempty(),
+    lastName: zod_1.z.string().nonempty(),
+    validFrom: zod_1.z.number().nullable(),
+    validTo: zod_1.z.number().nullable(),
+    accessSuspended: zod_1.z.boolean(),
+    credentials: zod_1.z
+        .array(rest_1.sAssignedCredential.omit({ note: true }))
+        .describe('IDs of credentials assigned to the person'),
+});
+exports.sExternalScheduleProps = zod_1.z.object({
+    displayName: zod_1.z.string().nonempty(),
+    include: objects_1.sScheduleDetailsRequest,
+});
+exports.sExternalAccessRuleProps = zod_1.z.object({
+    displayName: zod_1.z.string().nonempty(),
+    appliedTo: zod_1.z.array(zod_1.z.string().nonempty()),
+    permissions: zod_1.z.array(objects_1.sAccessRulePermissionDto),
+    groupPermissions: zod_1.z.array(objects_1.sAccessRuleGroupPermissionDto),
+});
+exports.sExternalZoneProps = zod_1.z.object({
+    displayName: zod_1.z.string().nonempty(),
+    devices: zod_1.z.array(zod_1.z.string().nonempty()),
+});
+exports.sExternalObjectProps = zod_1.z.object({
+    person: exports.sExternalPersonProps,
+    schedule: exports.sExternalScheduleProps,
+    accessRule: exports.sExternalAccessRuleProps,
+    zone: exports.sExternalZoneProps,
+});
 // ————————————————————————————————————————————————————
 // Merge (insert vs update) variants, all listed explicitly
 // ————————————————————————————————————————————————————
 exports.sObjectMerge = zod_1.z
     .union([
-    // accessRule insert
-    zod_1.z.object({
-        kind: zod_1.z.literal('merge'),
-        objectId: zod_1.z.string().nonempty().describe('Object ID as in backend'),
-        objectKind: zod_1.z.literal('accessRule'),
-        original: rest_1.sCreateAccessRuleRequest,
-        props: rest_1.sCreateAccessRuleRequest,
-    }),
     // accessRule update
     zod_1.z.object({
         kind: zod_1.z.literal('merge'),
         objectId: zod_1.z.string().nonempty().describe('Object ID as in backend'),
         objectKind: zod_1.z.literal('accessRule'),
-        original: rest_1.sCreateAccessRuleRequest,
-        props: rest_1.sCreateAccessRuleRequest.partial(),
-    }),
-    // schedule insert
-    zod_1.z.object({
-        kind: zod_1.z.literal('merge'),
-        objectId: zod_1.z.string().nonempty().describe('Object ID as in backend'),
-        objectKind: zod_1.z.literal('schedule'),
-        original: rest_1.sCreateScheduleRequest,
-        props: rest_1.sCreateScheduleRequest,
+        original: exports.sExternalAccessRuleProps,
+        props: exports.sExternalAccessRuleProps.partial(),
     }),
     // schedule update
     zod_1.z.object({
         kind: zod_1.z.literal('merge'),
         objectId: zod_1.z.string().nonempty().describe('Object ID as in backend'),
         objectKind: zod_1.z.literal('schedule'),
-        original: rest_1.sCreateScheduleRequest,
-        props: rest_1.sCreateScheduleRequest.partial(),
-    }),
-    // person insert
-    zod_1.z.object({
-        kind: zod_1.z.literal('merge'),
-        objectId: zod_1.z.string().nonempty().describe('Object ID as in backend'),
-        objectKind: zod_1.z.literal('person'),
-        original: rest_1.sCreatePersonRequest,
-        props: rest_1.sCreatePersonRequest,
+        original: exports.sExternalScheduleProps,
+        props: exports.sExternalScheduleProps.partial(),
     }),
     // person update
     zod_1.z.object({
         kind: zod_1.z.literal('merge'),
         objectId: zod_1.z.string().nonempty().describe('Object ID as in backend'),
         objectKind: zod_1.z.literal('person'),
-        original: rest_1.sCreatePersonRequest,
-        props: rest_1.sCreatePersonRequest.partial(),
-    }),
-    // zone insert
-    zod_1.z.object({
-        kind: zod_1.z.literal('merge'),
-        objectId: zod_1.z.string().nonempty().describe('Object ID as in backend'),
-        objectKind: zod_1.z.literal('zone'),
-        original: rest_1.sCreateZoneRequest,
-        props: rest_1.sCreateZoneRequest,
+        original: exports.sExternalPersonProps,
+        props: exports.sExternalPersonProps.partial(),
     }),
     // zone update
     zod_1.z.object({
         kind: zod_1.z.literal('merge'),
         objectId: zod_1.z.string().nonempty().describe('Object ID as in backend'),
         objectKind: zod_1.z.literal('zone'),
-        original: rest_1.sCreateZoneRequest,
-        props: rest_1.sCreateZoneRequest.partial(),
+        original: exports.sExternalZoneProps,
+        props: exports.sExternalZoneProps.partial(),
     }),
 ])
     .describe('Object merge request');
@@ -245,25 +245,25 @@ exports.sObjectDelete = zod_1.z
         kind: zod_1.z.literal('delete'),
         objectId: zod_1.z.string().nonempty().describe('Object ID as in backend'),
         objectKind: zod_1.z.literal('accessRule'),
-        original: rest_1.sCreateAccessRuleRequest,
+        original: exports.sExternalAccessRuleProps,
     }),
     zod_1.z.object({
         kind: zod_1.z.literal('delete'),
         objectId: zod_1.z.string().nonempty().describe('Object ID as in backend'),
         objectKind: zod_1.z.literal('schedule'),
-        original: rest_1.sCreateScheduleRequest,
+        original: exports.sExternalScheduleProps,
     }),
     zod_1.z.object({
         kind: zod_1.z.literal('delete'),
         objectId: zod_1.z.string().nonempty().describe('Object ID as in backend'),
         objectKind: zod_1.z.literal('person'),
-        original: rest_1.sCreatePersonRequest,
+        original: exports.sExternalPersonProps,
     }),
     zod_1.z.object({
         kind: zod_1.z.literal('delete'),
         objectId: zod_1.z.string().nonempty().describe('Object ID as in backend'),
         objectKind: zod_1.z.literal('zone'),
-        original: rest_1.sCreateZoneRequest,
+        original: exports.sExternalZoneProps,
     }),
 ])
     .describe('Object delete request');
@@ -351,6 +351,57 @@ exports.sAbortChange = zod_1.z
     policyVersion: zod_1.z.number().describe('Version of the access changes'),
 })
     .describe('Request to abort access changes');
+// DESCRIBE
+exports.sDescribeObjectRq = zod_1.z
+    .object({
+    kind: zod_1.z.literal('describe-object'),
+    provider: zod_1.z.string().nonempty(),
+    objectAssignedRef: zod_1.z
+        .string()
+        .nonempty()
+        .describe('Object ID as in 3rd party backend'),
+    objectKind: agent_metadata_1.sAccessObjectKind,
+})
+    .describe('Request to describe the capabilities of a provider via an agent');
+exports.sDescribeObjectRs = (0, exports.sResponsePayload)(zod_1.z.literal('describe-object-rs'), zod_1.z.object({
+    object: zod_1.z
+        .union([
+        zod_1.z.object({
+            objectKind: zod_1.z.literal('accessRule'),
+            objectAssignedRef: zod_1.z
+                .string()
+                .nonempty()
+                .describe('Object ID as in 3rd party backend'),
+            data: exports.sExternalAccessRuleProps,
+        }),
+        zod_1.z.object({
+            objectKind: zod_1.z.literal('schedule'),
+            objectAssignedRef: zod_1.z
+                .string()
+                .nonempty()
+                .describe('Object ID as in 3rd party backend'),
+            data: exports.sExternalScheduleProps,
+        }),
+        zod_1.z.object({
+            objectKind: zod_1.z.literal('person'),
+            data: exports.sExternalPersonProps,
+            objectAssignedRef: zod_1.z
+                .string()
+                .nonempty()
+                .describe('Object ID as in 3rd party backend'),
+        }),
+        zod_1.z.object({
+            objectKind: zod_1.z.literal('zone'),
+            data: exports.sExternalZoneProps,
+            objectAssignedRef: zod_1.z
+                .string()
+                .nonempty()
+                .describe('Object ID as in 3rd party backend'),
+        }),
+    ])
+        .nullable()
+        .describe('Object data or null if the object was not found'),
+}));
 const fromAgentSchemaByKind = {
     register: exports.sRegisterRq,
     unregister: exports.sUnregister,
@@ -366,6 +417,7 @@ const fromAgentSchemaByKind = {
     'validate-change-rs': exports.sValidateChangeRs,
     'apply-change-rs': exports.sApplyChangeRs,
     'apply-change-progress': exports.sApplyChangeProgress,
+    'describe-object-rs': exports.sDescribeObjectRs,
     'error-rs': exports.sErrorPayload,
 };
 exports.ReplyKindByRequestKind = {
@@ -380,6 +432,7 @@ exports.ReplyKindByRequestKind = {
     'get-available-devices': 'get-available-devices-rs',
     'validate-change': 'validate-change-rs',
     'apply-change': 'apply-change-rs',
+    'describe-object': 'describe-object-rs',
 };
 const getAgentMessageIssues = (message) => {
     const result = exports.sMessageHeader.safeParse(message);

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

@@ -42,7 +42,6 @@ export declare const sAccessObjectKind: z.ZodEnum<{
     person: "person";
     zone: "zone";
     schedule: "schedule";
-    device: "device";
     accessRule: "accessRule";
 }>;
 export declare const sTokenSpecs: z.ZodObject<{
@@ -70,7 +69,6 @@ export declare const sAccessControlCapabilityReport: z.ZodObject<{
         person: "person";
         zone: "zone";
         schedule: "schedule";
-        device: "device";
         accessRule: "accessRule";
     }>>;
     oneSchedulePerDoor: z.ZodBoolean;

package/dist/objects/agent-metadata.js

@@ -36,7 +36,6 @@ exports.sAccessObjectKind = zod_1.z.enum([
     'accessRule',
     'schedule',
     'person',
-    'device',
     'zone',
 ]);
 exports.sTokenSpecs = zod_1.z.object({

package/dist/package.json

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