@awarevue/api-types 1.0.114 → 1.1.1

package/dist/agent-communication/protocol.js

@@ -1,11 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isMessageFromAgent = exports.getAgentMessageIssues = 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.sRunCommandRs = exports.sRunCommandRq = exports.sStopServiceRs = exports.sStopServiceRq = exports.sStartServiceRs = exports.sStartServiceRq = exports.sValidateProviderConfigRs = exports.sConfigurationIssue = exports.sValidateProviderConfigRq = exports.sUnregister = exports.sRegisterRs = exports.sRegisterRq = exports.sAccessControlCapabilityReport = exports.sTokenSpecs = exports.sAccessObjectKind = exports.sProviderSpecs = exports.sUiHint = exports.sUiWidgetHint = exports.sUiOrderHint = exports.sErrorPayload = exports.sResponsePayload = exports.sMessageWithPayload = exports.sMessageHeader = void 0;
+exports.isMessageFromAgent = exports.getAgentMessageIssues = 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.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.sAccessControlCapabilityReport = exports.sTokenSpecs = exports.sAccessObjectKind = exports.sProviderSpecs = exports.sUiHint = exports.sUiWidgetHint = exports.sUiOrderHint = exports.sErrorPayload = exports.sResponsePayload = exports.sMessageWithPayload = exports.sMessageHeader = exports.sAgentDeviceInfo = void 0;
 const device_1 = require("../device");
 const device_import_1 = require("../device-import");
 const credential_1 = require("../access-control/credential");
 const zod_1 = require("zod");
 const access_control_1 = require("../access-control");
+exports.sAgentDeviceInfo = device_1.sForeignDeviceInfo.and(device_1.sAnyDeviceSpecs).and(zod_1.z.object({
+    presets: zod_1.z.array(device_1.sPresetDto),
+}));
 // PROTOCOL ENVELOPE
 exports.sMessageHeader = zod_1.z.object({
     version: zod_1.z.number().describe('Protocol version'),
@@ -132,7 +135,7 @@ exports.sStopServiceRs = (0, exports.sResponsePayload)(zod_1.z.literal('stop-rs'
 exports.sRunCommandRq = zod_1.z
     .object({
     kind: zod_1.z.literal('command'),
-    device: device_1.sForeignDeviceInfo,
+    device: exports.sAgentDeviceInfo,
     command: zod_1.z.string().nonempty(),
     batchId: zod_1.z
         .string()
@@ -142,6 +145,21 @@ exports.sRunCommandRq = zod_1.z
 })
     .describe('Request to run a device command');
 exports.sRunCommandRs = (0, exports.sResponsePayload)(zod_1.z.literal('command-rs'), zod_1.z.object({})).describe('Response for running a device command');
+// QUERIES
+exports.sQueryRq = zod_1.z.object({
+    kind: zod_1.z.literal('query'),
+    query: zod_1.z.string().nonempty(),
+    device: exports.sAgentDeviceInfo,
+    args: zod_1.z.unknown().describe('Query arguments, depends on the query type'),
+    replyUrl: zod_1.z
+        .string()
+        .nonempty()
+        .optional()
+        .describe('URL to optionally POST the query response to. The default is to reply via query-rs'),
+});
+exports.sQueryRs = (0, exports.sResponsePayload)(zod_1.z.literal('query-rs'), zod_1.z.object({
+    result: zod_1.z.unknown().describe('Query result, depends on the query type'),
+})).describe('Response for a query');
 // PUSH DEVICE STATE UPDATE
 exports.sPushStateUpdateRq = zod_1.z
     .object({
@@ -278,28 +296,6 @@ exports.sObjectDelete = zod_1.z
     }),
 ])
     .describe('Object delete request');
-// export const sRelationMerge = z.object({
-//   kind: z.literal('relation-merge'),
-//   left: z.object({
-//     kind: sAccessObjectKind,
-//     objectId: z
-//       .string()
-//       .optional()
-//       .describe(
-//         'Object ID as in backend. Can be undefined if object is new to backend and agent is trying to create it',
-//       ),
-//   }),
-//   right: z.object({
-//     kind: sAccessObjectKind,
-//     objectId: z
-//       .string()
-//       .optional()
-//       .describe(
-//         'Object ID as in backend. Can be undefined if object is new to backend and agent is trying to create it',
-//       ),
-//   }),
-//   linkExists: z.boolean(),
-// });
 exports.sAccessMutation = zod_1.z
     .union([exports.sObjectMerge, exports.sObjectDelete])
     .describe('Access object change description');
@@ -391,6 +387,7 @@ const fromAgentSchemaByKind = {
     'start-rs': exports.sStartServiceRs,
     'stop-rs': exports.sStopServiceRs,
     'command-rs': exports.sRunCommandRs,
+    'query-rs': exports.sQueryRs,
     state: exports.sPushStateUpdateRq,
     event: exports.sPushEventRq,
     'get-available-devices-rs': exports.sGetAvailableDevicesRs,