@awarevue/api-types 2.0.20 → 2.0.22

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

@@ -47,6 +47,8 @@ export declare const sResponsePayload: <TKind, T extends z.ZodRawShape>(kind: z.
     requestId: z.ZodString;
     kind: z.ZodLiteral<TKind>;
 }>[k_1]; } : never>, z.ZodObject<T, z.UnknownKeysParam, z.ZodTypeAny, z.objectUtil.addQuestionMarks<z.baseObjectOutputType<T>, any> extends infer T_3 ? { [k_2 in keyof T_3]: z.objectUtil.addQuestionMarks<z.baseObjectOutputType<T>, any>[k_2]; } : never, z.baseObjectInputType<T> extends infer T_4 ? { [k_3 in keyof T_4]: z.baseObjectInputType<T>[k_3]; } : never>>;
+export declare const sAgentErrorCode: z.ZodEnum<["NOT_SUPPORTED", "TIMEOUT"]>;
+export type AgentErrorCode = z.infer<typeof sAgentErrorCode>;
 export declare const sErrorPayload: z.ZodIntersection<z.ZodObject<{
     requestId: z.ZodString;
     kind: z.ZodLiteral<"error-rs">;
@@ -58,10 +60,13 @@ export declare const sErrorPayload: z.ZodIntersection<z.ZodObject<{
     requestId: string;
 }>, z.ZodObject<{
     error: z.ZodString;
+    code: z.ZodOptional<z.ZodEnum<["NOT_SUPPORTED", "TIMEOUT"]>>;
 }, z.UnknownKeysParam, z.ZodTypeAny, {
     error: string;
+    code?: "NOT_SUPPORTED" | "TIMEOUT" | undefined;
 }, {
     error: string;
+    code?: "NOT_SUPPORTED" | "TIMEOUT" | undefined;
 }>>;
 export declare const sUiOrderHint: z.ZodObject<{
     kind: z.ZodLiteral<"order">;
@@ -7919,14 +7924,14 @@ export declare const sChangeIssue: z.ZodObject<{
     message: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     index?: number | undefined;
-    code?: "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | "NOT_SUPPORTED" | undefined;
+    code?: "NOT_SUPPORTED" | "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | undefined;
     message?: string | undefined;
     path?: string | undefined;
     objectId?: string | undefined;
     objectKind?: "person" | "zone" | "accessRule" | "schedule" | "device" | undefined;
 }, {
     index?: number | undefined;
-    code?: "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | "NOT_SUPPORTED" | undefined;
+    code?: "NOT_SUPPORTED" | "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | undefined;
     message?: string | undefined;
     path?: string | undefined;
     objectId?: string | undefined;
@@ -7951,14 +7956,14 @@ export declare const sValidateChangeRs: z.ZodIntersection<z.ZodObject<{
         message: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         index?: number | undefined;
-        code?: "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | "NOT_SUPPORTED" | undefined;
+        code?: "NOT_SUPPORTED" | "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | undefined;
         message?: string | undefined;
         path?: string | undefined;
         objectId?: string | undefined;
         objectKind?: "person" | "zone" | "accessRule" | "schedule" | "device" | undefined;
     }, {
         index?: number | undefined;
-        code?: "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | "NOT_SUPPORTED" | undefined;
+        code?: "NOT_SUPPORTED" | "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | undefined;
         message?: string | undefined;
         path?: string | undefined;
         objectId?: string | undefined;
@@ -7967,7 +7972,7 @@ export declare const sValidateChangeRs: z.ZodIntersection<z.ZodObject<{
 }, z.UnknownKeysParam, z.ZodTypeAny, {
     issues: {
         index?: number | undefined;
-        code?: "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | "NOT_SUPPORTED" | undefined;
+        code?: "NOT_SUPPORTED" | "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | undefined;
         message?: string | undefined;
         path?: string | undefined;
         objectId?: string | undefined;
@@ -7976,7 +7981,7 @@ export declare const sValidateChangeRs: z.ZodIntersection<z.ZodObject<{
 }, {
     issues: {
         index?: number | undefined;
-        code?: "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | "NOT_SUPPORTED" | undefined;
+        code?: "NOT_SUPPORTED" | "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | undefined;
         message?: string | undefined;
         path?: string | 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.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.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;
+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.sPushFile = 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.sAgentErrorCode = exports.sResponsePayload = exports.sMessageWithPayload = exports.sMessageHeader = void 0;
 const device_import_1 = require("../device-import");
 const credential_1 = require("../access-control/credential");
 const zod_1 = require("zod");
@@ -22,8 +22,10 @@ const sResponsePayload = (kind, sPayload) =>
 // success branch
 zod_1.z.object({ requestId: zod_1.z.string().nonempty(), kind }).and(sPayload);
 exports.sResponsePayload = sResponsePayload;
+exports.sAgentErrorCode = zod_1.z.enum(['NOT_SUPPORTED', 'TIMEOUT']);
 exports.sErrorPayload = (0, exports.sResponsePayload)(zod_1.z.literal('error-rs'), zod_1.z.object({
     error: zod_1.z.string().nonempty().describe('Error message if request failed'),
+    code: exports.sAgentErrorCode.optional().describe('Optional error code'),
 }));
 // REGISTER
 exports.sUiOrderHint = zod_1.z.object({

package/dist/package.json

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

package/dist/queries/all.d.ts

@@ -3,13 +3,13 @@ import { CameraQueryRequestMap, CameraQueryResponseMap } from './camera';
 import { NvrAnalyticsQueryRequestMap, NvrAnalyticsQueryResponseMap } from './nvr-analytics-server';
 import { NvrExporterQueryRequestMap, NvrExporterQueryResponseMap } from './nvr-exporter';
 import { NvrRecorderQueryRequestMap, NvrRecorderQueryResponseMap } from './nvr-recorder';
-export declare const sEventCapsQueryArgs: {};
-export type EventCapsQueryArgs = typeof sEventCapsQueryArgs;
+export declare const sEventCapsQueryArgs: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+export type EventCapsQueryArgs = z.infer<typeof sEventCapsQueryArgs>;
 export declare const QUERY_EVENT_CAPS = "device:event-caps";
 export declare const sEventCapsQueryResponse: z.ZodArray<z.ZodString, "many">;
 export type EventCapsQueryResponse = z.infer<typeof sEventCapsQueryResponse>;
 export declare const requestSchemasByType: {
-    readonly "device:event-caps": {};
+    readonly "device:event-caps": z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
     readonly "cctv:rtsp-data": z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
     readonly "cctv:media-search": z.ZodObject<{
         devices: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodAny, "many">>>;

package/dist/queries/all.js

@@ -7,7 +7,7 @@ const nvr_analytics_server_1 = require("./nvr-analytics-server");
 const nvr_exporter_1 = require("./nvr-exporter");
 const nvr_recorder_1 = require("./nvr-recorder");
 // queries that apply to all devices
-exports.sEventCapsQueryArgs = {};
+exports.sEventCapsQueryArgs = zod_1.z.object({});
 exports.QUERY_EVENT_CAPS = 'device:event-caps';
 exports.sEventCapsQueryResponse = zod_1.z.array(zod_1.z.string());
 // Dictionary of request schemas by query type

package/dist/world-objects.js

@@ -31,4 +31,8 @@ exports.worldObjects = [
         id: 'bicycle',
         label: 'Bicycle',
     },
+    {
+        id: 'car',
+        label: 'Car',
+    },
 ];

package/package.json

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