@awarevue/api-types 1.0.10 → 1.0.12

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

@@ -1319,14 +1319,27 @@ export declare const sValidateChangeRq: z.ZodObject<{
         linkExists: boolean;
     })[];
 }>;
+export declare const sChangeIssueCode: z.ZodEnum<["BAD_REFERENCE", "NOT_FOUND", "NOT_UNIQUE", "INVALID", "NOT_SUPPORTED"]>;
 export declare const sChangeIssue: z.ZodObject<{
     objectId: z.ZodOptional<z.ZodString>;
-    issue: z.ZodString;
+    objectKind: z.ZodOptional<z.ZodEnum<["access-rule", "schedule", "zone", "person", "reader"]>>;
+    code: z.ZodOptional<z.ZodEnum<["BAD_REFERENCE", "NOT_FOUND", "NOT_UNIQUE", "INVALID", "NOT_SUPPORTED"]>>;
+    path: z.ZodOptional<z.ZodString>;
+    index: z.ZodOptional<z.ZodNumber>;
+    message: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    issue: string;
+    index?: number | undefined;
+    code?: "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | "NOT_SUPPORTED" | undefined;
+    message?: string | undefined;
+    path?: string | undefined;
+    objectKind?: "person" | "zone" | "reader" | "access-rule" | "schedule" | undefined;
     objectId?: string | undefined;
 }, {
-    issue: string;
+    index?: number | undefined;
+    code?: "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | "NOT_SUPPORTED" | undefined;
+    message?: string | undefined;
+    path?: string | undefined;
+    objectKind?: "person" | "zone" | "reader" | "access-rule" | "schedule" | undefined;
     objectId?: string | undefined;
 }>;
 export declare const sValidateChangeRs: z.ZodIntersection<z.ZodObject<{
@@ -1341,22 +1354,42 @@ export declare const sValidateChangeRs: z.ZodIntersection<z.ZodObject<{
 }>, z.ZodObject<{
     issues: z.ZodArray<z.ZodObject<{
         objectId: z.ZodOptional<z.ZodString>;
-        issue: z.ZodString;
+        objectKind: z.ZodOptional<z.ZodEnum<["access-rule", "schedule", "zone", "person", "reader"]>>;
+        code: z.ZodOptional<z.ZodEnum<["BAD_REFERENCE", "NOT_FOUND", "NOT_UNIQUE", "INVALID", "NOT_SUPPORTED"]>>;
+        path: z.ZodOptional<z.ZodString>;
+        index: z.ZodOptional<z.ZodNumber>;
+        message: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        issue: string;
+        index?: number | undefined;
+        code?: "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | "NOT_SUPPORTED" | undefined;
+        message?: string | undefined;
+        path?: string | undefined;
+        objectKind?: "person" | "zone" | "reader" | "access-rule" | "schedule" | undefined;
         objectId?: string | undefined;
     }, {
-        issue: string;
+        index?: number | undefined;
+        code?: "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | "NOT_SUPPORTED" | undefined;
+        message?: string | undefined;
+        path?: string | undefined;
+        objectKind?: "person" | "zone" | "reader" | "access-rule" | "schedule" | undefined;
         objectId?: string | undefined;
     }>, "many">;
 }, z.UnknownKeysParam, z.ZodTypeAny, {
     issues: {
-        issue: string;
+        index?: number | undefined;
+        code?: "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | "NOT_SUPPORTED" | undefined;
+        message?: string | undefined;
+        path?: string | undefined;
+        objectKind?: "person" | "zone" | "reader" | "access-rule" | "schedule" | undefined;
         objectId?: string | undefined;
     }[];
 }, {
     issues: {
-        issue: string;
+        index?: number | undefined;
+        code?: "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | "NOT_SUPPORTED" | undefined;
+        message?: string | undefined;
+        path?: string | undefined;
+        objectKind?: "person" | "zone" | "reader" | "access-rule" | "schedule" | undefined;
         objectId?: string | undefined;
     }[];
 }>>;

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.sValidateChangeRq = exports.sRefMap = exports.sDeviceMap = exports.sAccessMutation = exports.sRelationMerge = 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.sRelationMerge = 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;
 const device_1 = require("../device");
 const device_import_1 = require("../device-import");
 const credential_1 = require("../access-control/credential");
@@ -227,10 +227,32 @@ exports.sValidateChangeRq = zod_1.z
     mutations: zod_1.z.array(exports.sAccessMutation),
 })
     .describe('Request to validate access changes');
+exports.sChangeIssueCode = zod_1.z.enum([
+    'BAD_REFERENCE',
+    'NOT_FOUND',
+    'NOT_UNIQUE',
+    'INVALID',
+    'NOT_SUPPORTED',
+]);
 exports.sChangeIssue = zod_1.z
     .object({
-    objectId: zod_1.z.string().optional(),
-    issue: zod_1.z.string().nonempty(),
+    objectId: zod_1.z.string().optional().describe('Object ID as in backend'),
+    objectKind: exports.sAccessObjectKind.optional(),
+    code: exports.sChangeIssueCode
+        .optional()
+        .describe('Issue code that describes the issue to UI agent(s) or bots'),
+    path: zod_1.z
+        .string()
+        .optional()
+        .describe('Path - inside object referenced by ObjectID, points to a field or a related object'),
+    index: zod_1.z
+        .number()
+        .optional()
+        .describe('Index ofa value in field pointed at by path'),
+    message: zod_1.z
+        .string()
+        .optional()
+        .describe('Message that describes the issue to user or the details of what went wrong'),
 })
     .describe('Access change issue description');
 exports.sValidateChangeRs = (0, exports.sResponsePayload)(zod_1.z.literal('validate-change-rs'), zod_1.z.object({

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awarevue/api-types",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "description": "Common types between backend, agent(s) and frontend(s)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awarevue/api-types",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "description": "Common types between backend, agent(s) and frontend(s)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",