@awarevue/api-types 2.0.11 → 2.0.13

package/dist/device/server.js

@@ -15,7 +15,7 @@ exports.sRunMacroCommand = zod_1.z.object({
 exports.sNotify = zod_1.z.object({
     command: zod_1.z.literal('server.notify'),
     params: zod_1.z.object({
-        source: primitives_1.sDeviceId,
+        source: primitives_1.sDeviceParam,
         message: zod_1.z.string().nonempty(),
         severity: primitives_1.sNotificationSeverity,
         metadata: zod_1.z.record(zod_1.z.unknown()),

package/dist/device-command.d.ts

@@ -24,7 +24,7 @@ export declare const commandSchemas: {
         command: import("zod").ZodLiteral<"nvr-exporter.start-export">;
         params: import("zod").ZodObject<{
             requestId: import("zod").ZodString;
-            device: import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodIntersection<import("zod").ZodObject<{
+            device: import("zod").ZodUnion<[import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodIntersection<import("zod").ZodObject<{
                 name: import("zod").ZodString;
                 foreignRef: import("zod").ZodString;
                 provider: import("zod").ZodString;
@@ -276,14 +276,14 @@ export declare const commandSchemas: {
                 type: "system";
             }, {
                 type: "system";
-            }>]>>]>;
+            }>]>>]>, import("zod").ZodTuple<[import("zod").ZodString, import("zod").ZodString], null>]>;
             timeFrom: import("zod").ZodNumber;
             timeTo: import("zod").ZodNumber;
             name: import("zod").ZodString;
         }, "strip", import("zod").ZodTypeAny, {
             name: string;
             requestId: string;
-            device: string | ({
+            device: string | [string, string] | ({
                 name: string;
                 foreignRef: string;
                 provider: string;
@@ -368,7 +368,7 @@ export declare const commandSchemas: {
         }, {
             name: string;
             requestId: string;
-            device: string | ({
+            device: string | [string, string] | ({
                 name: string;
                 foreignRef: string;
                 provider: string;
@@ -455,7 +455,7 @@ export declare const commandSchemas: {
         params: {
             name: string;
             requestId: string;
-            device: string | ({
+            device: string | [string, string] | ({
                 name: string;
                 foreignRef: string;
                 provider: string;
@@ -543,7 +543,7 @@ export declare const commandSchemas: {
         params: {
             name: string;
             requestId: string;
-            device: string | ({
+            device: string | [string, string] | ({
                 name: string;
                 foreignRef: string;
                 provider: string;

package/dist/package.json

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

package/dist/primitives.d.ts

@@ -270,7 +270,8 @@ export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodObject<{
 }, {
     type: "system";
 }>]>>;
-export declare const sDeviceParam: z.ZodUnion<[z.ZodString, z.ZodIntersection<z.ZodObject<{
+export declare const sForeignDeviceId: z.ZodTuple<[z.ZodString, z.ZodString], null>;
+export declare const sDeviceParam: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodIntersection<z.ZodObject<{
     name: z.ZodString;
     foreignRef: z.ZodString;
     provider: z.ZodString;
@@ -522,6 +523,7 @@ export declare const sDeviceParam: z.ZodUnion<[z.ZodString, z.ZodIntersection<z.
     type: "system";
 }, {
     type: "system";
-}>]>>]>;
+}>]>>]>, z.ZodTuple<[z.ZodString, z.ZodString], null>]>;
+export type DeviceParam = z.infer<typeof sDeviceParam>;
 export declare const sNotificationSeverity: z.ZodEnum<["info", "warning", "critical"]>;
 export type NotificationSeverity = z.infer<typeof sNotificationSeverity>;

package/dist/primitives.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sNotificationSeverity = exports.sDeviceParam = exports.sAgentDeviceInfo = exports.sFileResponse = exports.sUrl = exports.sDuration = exports.sMacroId = exports.sZoneId = exports.sPersonId = exports.sDeviceEvent = exports.sPresetId = exports.sDeviceId = void 0;
+exports.sNotificationSeverity = exports.sDeviceParam = exports.sForeignDeviceId = exports.sAgentDeviceInfo = exports.sFileResponse = exports.sUrl = exports.sDuration = exports.sMacroId = exports.sZoneId = exports.sPersonId = exports.sDeviceEvent = exports.sPresetId = exports.sDeviceId = void 0;
 const zod_1 = require("zod");
 const device_1 = require("./device");
 exports.sDeviceId = zod_1.z.string().uuid().nonempty();
@@ -21,6 +21,10 @@ exports.sFileResponse = zod_1.z
 exports.sAgentDeviceInfo = zod_1.z.intersection(device_1.sForeignDeviceInfo, device_1.sAnyDeviceSpecs, zod_1.z.object({
     presets: zod_1.z.array(device_1.sPresetDto),
 }));
-// reusable device argument. This schema can be checked at runtime to see if it's a device ID or full device info and substituted accordingly.
-exports.sDeviceParam = exports.sDeviceId.or(exports.sAgentDeviceInfo);
+exports.sForeignDeviceId = zod_1.z.tuple([
+    zod_1.z.string().nonempty().describe('Foreign system identifier'),
+    zod_1.z.string().nonempty().describe('Device identifier in foreign system'),
+]);
+// a pointer to a device, can be local device id, foreign device info, or full device info for agents
+exports.sDeviceParam = exports.sDeviceId.or(exports.sAgentDeviceInfo).or(exports.sForeignDeviceId);
 exports.sNotificationSeverity = zod_1.z.enum(['info', 'warning', 'critical']);

package/package.json

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