@awarevue/api-types 1.0.113 → 1.1.0

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

@@ -595,6 +595,74 @@ export declare const sRunCommandRs: z.ZodIntersection<z.ZodObject<{
     kind: "command-rs";
     requestId: string;
 }>, z.ZodObject<{}, z.UnknownKeysParam, z.ZodTypeAny, {}, {}>>;
+export declare const sQueryRq: z.ZodObject<{
+    kind: z.ZodLiteral<"query">;
+    query: z.ZodString;
+    device: z.ZodObject<{
+        name: z.ZodString;
+        foreignRef: z.ZodString;
+        provider: z.ZodString;
+        providerMetadata: z.ZodObject<{}, "strip", z.ZodUnknown, z.objectOutputType<{}, z.ZodUnknown, "strip">, z.objectInputType<{}, z.ZodUnknown, "strip">>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        foreignRef: string;
+        provider: string;
+        providerMetadata: {} & {
+            [k: string]: unknown;
+        };
+    }, {
+        name: string;
+        foreignRef: string;
+        provider: string;
+        providerMetadata: {} & {
+            [k: string]: unknown;
+        };
+    }>;
+    args: z.ZodUnknown;
+    replyUrl: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    kind: "query";
+    device: {
+        name: string;
+        foreignRef: string;
+        provider: string;
+        providerMetadata: {} & {
+            [k: string]: unknown;
+        };
+    };
+    query: string;
+    args?: unknown;
+    replyUrl?: string | undefined;
+}, {
+    kind: "query";
+    device: {
+        name: string;
+        foreignRef: string;
+        provider: string;
+        providerMetadata: {} & {
+            [k: string]: unknown;
+        };
+    };
+    query: string;
+    args?: unknown;
+    replyUrl?: string | undefined;
+}>;
+export declare const sQueryRs: z.ZodIntersection<z.ZodObject<{
+    requestId: z.ZodString;
+    kind: z.ZodLiteral<"query-rs">;
+}, "strip", z.ZodTypeAny, {
+    kind: "query-rs";
+    requestId: string;
+}, {
+    kind: "query-rs";
+    requestId: string;
+}>, z.ZodObject<{
+    result: z.ZodUnknown;
+}, z.UnknownKeysParam, z.ZodTypeAny, {
+    result?: unknown;
+}, {
+    result?: unknown;
+}>>;
 export declare const sPushStateUpdateRq: z.ZodObject<{
     kind: z.ZodLiteral<"state">;
     foreignRef: z.ZodString;
@@ -8573,6 +8641,8 @@ export type StopServiceRq = z.infer<typeof sStopServiceRq>;
 export type StopServiceRs = z.infer<typeof sStopServiceRs>;
 export type RunCommandRq = z.infer<typeof sRunCommandRq>;
 export type RunCommandRs = z.infer<typeof sRunCommandRs>;
+export type QueryRq = z.infer<typeof sQueryRq>;
+export type QueryRs = z.infer<typeof sQueryRs>;
 export type PushStateUpdateRq = z.infer<typeof sPushStateUpdateRq>;
 export type PushStateUpdateRs = z.infer<typeof sPushStateUpdateRs>;
 export type PushEventRq = z.infer<typeof sPushEventRq>;
@@ -8608,6 +8678,8 @@ export type PayloadByKind = {
     'stop-rs': StopServiceRs;
     command: RunCommandRq;
     'command-rs': RunCommandRs;
+    query: QueryRq;
+    'query-rs': QueryRs;
     state: PushStateUpdateRq;
     'state-rs': PushStateUpdateRs;
     event: PushEventRq;
@@ -8622,8 +8694,8 @@ export type PayloadByKind = {
     'abort-change': AccessAbortChange;
     'error-rs': ErrorPayload;
 };
-export type FromAgent = ErrorPayload | RegisterRq | Unregister | ValidateProviderConfigRs | StartServiceRs | StopServiceRs | RunCommandRs | PushStateUpdateRq | PushEventRq | GetAvailableDevicesRs | AccessValidateChangeRs | AccessApplyChangeRs | AccessApplyChangeProgress;
-export type FromServer = ErrorPayload | RegisterRs | ValidateProviderConfigRq | StartServiceRq | StopServiceRq | RunCommandRq | PushStateUpdateRs | PushEventRs | GetAvailableDevicesRq | AccessValidateChangeRq | AccessApplyChange | AccessAbortChange;
+export type FromAgent = ErrorPayload | RegisterRq | Unregister | ValidateProviderConfigRs | StartServiceRs | StopServiceRs | RunCommandRs | QueryRs | PushStateUpdateRq | PushEventRq | GetAvailableDevicesRs | AccessValidateChangeRs | AccessApplyChangeRs | AccessApplyChangeProgress;
+export type FromServer = ErrorPayload | RegisterRs | ValidateProviderConfigRq | StartServiceRq | StopServiceRq | RunCommandRq | QueryRq | PushStateUpdateRs | PushEventRs | GetAvailableDevicesRq | AccessValidateChangeRq | AccessApplyChange | AccessAbortChange;
 export type AnyPayload = FromAgent | FromServer;
 export declare const getAgentMessageIssues: (message: unknown) => string[];
 export declare const isMessageFromAgent: (message: unknown) => message is Message<FromAgent>;

package/dist/agent-communication/protocol.js

@@ -1,6 +1,6 @@
 "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 = void 0;
 const device_1 = require("../device");
 const device_import_1 = require("../device-import");
 const credential_1 = require("../access-control/credential");
@@ -142,6 +142,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: device_1.sForeignDeviceInfo,
+    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 +293,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 +384,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,