@awarevue/api-types 2.0.30 → 2.0.31

package/dist/api/commands/io-board.js

@@ -2,11 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ioBoardCommands = exports.sIoBoardSetOutputCommand = void 0;
 const zod_1 = require("zod");
+const primitives_1 = require("../../primitives");
 // COMMANDS
 exports.sIoBoardSetOutputCommand = zod_1.z.object({
     command: zod_1.z.literal('io-board.set-output'),
     params: zod_1.z.object({
-        output: zod_1.z.string().nonempty(),
+        output: primitives_1.sIoOutputSlotId,
         value: zod_1.z.boolean(),
     }),
 });

package/dist/api/events/io-board.js

@@ -2,10 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ioBoardEventSchemaByKind = exports.sIoBoardInputChangedEvent = void 0;
 const zod_1 = require("zod");
+const primitives_1 = require("../../primitives");
 // EVENTS
 exports.sIoBoardInputChangedEvent = zod_1.z.object({
     kind: zod_1.z.literal('io-board-input-changed'),
-    inputName: zod_1.z.string().nonempty(),
+    inputName: primitives_1.sIoInputSlotId,
     value: zod_1.z.boolean(),
 });
 exports.ioBoardEventSchemaByKind = {

package/dist/package.json

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

package/dist/primitives.d.ts

@@ -1,3 +1,10 @@
+/**
+ * P R I M I T I V E S
+ * These are the basic building blocks used throughout the API type definitions.
+ * Funactionally, product components compare schema attribute types to these primitives - by reference equality - to provide custom handling
+ * for common data types. We're not talking about int, string and that, we're talking about
+ * domain-specific types like DeviceId, PresetId, Duration, URL, etc.
+ */
 import { z } from 'zod';
 export declare const sDeviceId: z.ZodString;
 export declare const sPresetId: z.ZodString;
@@ -6,6 +13,10 @@ export declare const sPersonId: z.ZodString;
 export declare const sZoneId: z.ZodString;
 export declare const sMacroId: z.ZodString;
 export declare const sWorldObjectId: z.ZodString;
+export declare const sIoInputSlotId: z.ZodString;
+export type IoInputSlotId = z.infer<typeof sIoInputSlotId>;
+export declare const sIoOutputSlotId: z.ZodString;
+export type IoOutputSlotId = z.infer<typeof sIoOutputSlotId>;
 export declare const sDuration: z.ZodNumber;
 export declare const sUrl: z.ZodString;
 export declare const sFileResponse: z.ZodNullable<z.ZodObject<{

package/dist/primitives.js

@@ -1,6 +1,13 @@
 "use strict";
+/**
+ * P R I M I T I V E S
+ * These are the basic building blocks used throughout the API type definitions.
+ * Funactionally, product components compare schema attribute types to these primitives - by reference equality - to provide custom handling
+ * for common data types. We're not talking about int, string and that, we're talking about
+ * domain-specific types like DeviceId, PresetId, Duration, URL, etc.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sCallDirection = exports.sCallState = exports.sCameraPresetInfo = exports.sNotificationSeverity = exports.sDeviceParam = exports.sForeignDeviceId = exports.sAgentDeviceInfo = exports.sFileResponse = exports.sUrl = exports.sDuration = exports.sWorldObjectId = exports.sMacroId = exports.sZoneId = exports.sPersonId = exports.sDeviceEvent = exports.sPresetId = exports.sDeviceId = void 0;
+exports.sCallDirection = exports.sCallState = exports.sCameraPresetInfo = exports.sNotificationSeverity = exports.sDeviceParam = exports.sForeignDeviceId = exports.sAgentDeviceInfo = exports.sFileResponse = exports.sUrl = exports.sDuration = exports.sIoOutputSlotId = exports.sIoInputSlotId = exports.sWorldObjectId = exports.sMacroId = exports.sZoneId = exports.sPersonId = exports.sDeviceEvent = exports.sPresetId = exports.sDeviceId = void 0;
 const zod_1 = require("zod");
 const device_1 = require("./objects/device");
 exports.sDeviceId = zod_1.z.string().uuid().nonempty();
@@ -10,6 +17,8 @@ exports.sPersonId = zod_1.z.string().uuid().nonempty();
 exports.sZoneId = zod_1.z.string().uuid().nonempty();
 exports.sMacroId = zod_1.z.string().uuid().nonempty();
 exports.sWorldObjectId = zod_1.z.string().nonempty();
+exports.sIoInputSlotId = zod_1.z.string().nonempty();
+exports.sIoOutputSlotId = zod_1.z.string().nonempty();
 // general
 exports.sDuration = zod_1.z.number().min(0).describe('Duration in milliseconds');
 exports.sUrl = zod_1.z.string().url().describe('A valid URL');

package/package.json

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