@awarevue/api-types 2.0.12 → 2.0.14

package/dist/events/presence-tracker.d.ts

@@ -0,0 +1,136 @@
+import { z } from 'zod';
+export declare const sPersonIn: z.ZodObject<{
+    kind: z.ZodLiteral<"person-in">;
+    personId: z.ZodString;
+    personFirstName: z.ZodString;
+    personLastName: z.ZodString;
+    personAvatarId: z.ZodNullable<z.ZodString>;
+    personType: z.ZodString;
+    personPosition: z.ZodNullable<z.ZodString>;
+    zoneId: z.ZodNullable<z.ZodString>;
+    securityChecked: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    kind: "person-in";
+    personId: string;
+    securityChecked: boolean;
+    zoneId: string | null;
+    personType: string;
+    personFirstName: string;
+    personLastName: string;
+    personAvatarId: string | null;
+    personPosition: string | null;
+}, {
+    kind: "person-in";
+    personId: string;
+    securityChecked: boolean;
+    zoneId: string | null;
+    personType: string;
+    personFirstName: string;
+    personLastName: string;
+    personAvatarId: string | null;
+    personPosition: string | null;
+}>;
+export declare const sPersonOut: z.ZodObject<{
+    kind: z.ZodLiteral<"person-out">;
+    personId: z.ZodString;
+    personFirstName: z.ZodString;
+    personLastName: z.ZodString;
+    personAvatarId: z.ZodNullable<z.ZodString>;
+    personType: z.ZodString;
+    personPosition: z.ZodNullable<z.ZodString>;
+    isLeave: z.ZodBoolean;
+    zoneId: z.ZodNullable<z.ZodString>;
+    securityChecked: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    kind: "person-out";
+    personId: string;
+    securityChecked: boolean;
+    isLeave: boolean;
+    zoneId: string | null;
+    personType: string;
+    personFirstName: string;
+    personLastName: string;
+    personAvatarId: string | null;
+    personPosition: string | null;
+}, {
+    kind: "person-out";
+    personId: string;
+    securityChecked: boolean;
+    isLeave: boolean;
+    zoneId: string | null;
+    personType: string;
+    personFirstName: string;
+    personLastName: string;
+    personAvatarId: string | null;
+    personPosition: string | null;
+}>;
+export declare const presenceTrackerEventSchemaByKind: {
+    readonly 'person-in': z.ZodObject<{
+        kind: z.ZodLiteral<"person-in">;
+        personId: z.ZodString;
+        personFirstName: z.ZodString;
+        personLastName: z.ZodString;
+        personAvatarId: z.ZodNullable<z.ZodString>;
+        personType: z.ZodString;
+        personPosition: z.ZodNullable<z.ZodString>;
+        zoneId: z.ZodNullable<z.ZodString>;
+        securityChecked: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        kind: "person-in";
+        personId: string;
+        securityChecked: boolean;
+        zoneId: string | null;
+        personType: string;
+        personFirstName: string;
+        personLastName: string;
+        personAvatarId: string | null;
+        personPosition: string | null;
+    }, {
+        kind: "person-in";
+        personId: string;
+        securityChecked: boolean;
+        zoneId: string | null;
+        personType: string;
+        personFirstName: string;
+        personLastName: string;
+        personAvatarId: string | null;
+        personPosition: string | null;
+    }>;
+    readonly 'person-out': z.ZodObject<{
+        kind: z.ZodLiteral<"person-out">;
+        personId: z.ZodString;
+        personFirstName: z.ZodString;
+        personLastName: z.ZodString;
+        personAvatarId: z.ZodNullable<z.ZodString>;
+        personType: z.ZodString;
+        personPosition: z.ZodNullable<z.ZodString>;
+        isLeave: z.ZodBoolean;
+        zoneId: z.ZodNullable<z.ZodString>;
+        securityChecked: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        kind: "person-out";
+        personId: string;
+        securityChecked: boolean;
+        isLeave: boolean;
+        zoneId: string | null;
+        personType: string;
+        personFirstName: string;
+        personLastName: string;
+        personAvatarId: string | null;
+        personPosition: string | null;
+    }, {
+        kind: "person-out";
+        personId: string;
+        securityChecked: boolean;
+        isLeave: boolean;
+        zoneId: string | null;
+        personType: string;
+        personFirstName: string;
+        personLastName: string;
+        personAvatarId: string | null;
+        personPosition: string | null;
+    }>;
+};
+export type PersonIn = z.infer<typeof sPersonIn>;
+export type PersonOut = z.infer<typeof sPersonOut>;
+export type PresenceTrackerEvent = PersonIn | PersonOut;

package/dist/events/presence-tracker.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.presenceTrackerEventSchemaByKind = exports.sPersonOut = exports.sPersonIn = void 0;
+const primitives_1 = require("../primitives");
+const zod_1 = require("zod");
+// EVENTS
+exports.sPersonIn = zod_1.z.object({
+    kind: zod_1.z.literal('person-in'),
+    personId: primitives_1.sPersonId,
+    personFirstName: zod_1.z.string().nonempty(),
+    personLastName: zod_1.z.string().nonempty(),
+    personAvatarId: zod_1.z.string().nullable(),
+    personType: zod_1.z.string().nonempty(),
+    personPosition: zod_1.z.string().nullable(),
+    zoneId: zod_1.z.string().nullable(),
+    securityChecked: zod_1.z.boolean(),
+});
+exports.sPersonOut = zod_1.z.object({
+    kind: zod_1.z.literal('person-out'),
+    personId: primitives_1.sPersonId,
+    personFirstName: zod_1.z.string().nonempty(),
+    personLastName: zod_1.z.string().nonempty(),
+    personAvatarId: zod_1.z.string().nullable(),
+    personType: zod_1.z.string().nonempty(),
+    personPosition: zod_1.z.string().max(128).nullable(),
+    isLeave: zod_1.z.boolean(),
+    zoneId: zod_1.z.string().nullable(),
+    securityChecked: zod_1.z.boolean(),
+});
+exports.presenceTrackerEventSchemaByKind = {
+    'person-in': exports.sPersonIn,
+    'person-out': exports.sPersonOut,
+};

package/dist/events/server.d.ts

@@ -0,0 +1,65 @@
+import { z } from 'zod';
+import { ObjectKinds } from '../objects';
+export declare const sAgentStarted: z.ZodObject<{
+    kind: z.ZodLiteral<"agent-started">;
+    agent: z.ZodString;
+    providers: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    kind: "agent-started";
+    providers: string[];
+    agent: string;
+}, {
+    kind: "agent-started";
+    providers: string[];
+    agent: string;
+}>;
+export declare const sAgentStopped: z.ZodObject<{
+    kind: z.ZodLiteral<"agent-stopped">;
+    agent: z.ZodString;
+    providers: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    kind: "agent-stopped";
+    providers: string[];
+    agent: string;
+}, {
+    kind: "agent-stopped";
+    providers: string[];
+    agent: string;
+}>;
+export type AgentStarted = z.infer<typeof sAgentStarted>;
+export type AgentStopped = z.infer<typeof sAgentStopped>;
+export type ObjectCreated = {
+    [K in keyof ObjectKinds]: {
+        originator: string;
+        objectVersion: number;
+        objectKind: K;
+        data: ObjectKinds[K];
+        objectId: string;
+        kind: 'object-created';
+        userId?: string;
+    };
+}[keyof ObjectKinds];
+export type ObjectUpdated = {
+    [K in keyof ObjectKinds]: {
+        originator: string;
+        objectVersion: number;
+        objectKind: K;
+        original: ObjectKinds[K];
+        changes: Partial<ObjectKinds[K]>;
+        objectId: string;
+        kind: 'object-updated';
+        userId?: string;
+    };
+}[keyof ObjectKinds];
+export type ObjectDeleted = {
+    [K in keyof ObjectKinds]: {
+        originator: string;
+        objectVersion: number;
+        objectKind: K;
+        data: ObjectKinds[K];
+        objectId: string;
+        kind: 'object-deleted';
+        userId?: string;
+    };
+}[keyof ObjectKinds];
+export type ServerEvent = ObjectCreated | ObjectUpdated | ObjectDeleted | AgentStarted | AgentStopped;

package/dist/events/server.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sAgentStopped = exports.sAgentStarted = void 0;
+const zod_1 = require("zod");
+// EVENTS
+exports.sAgentStarted = zod_1.z.object({
+    kind: zod_1.z.literal('agent-started'),
+    agent: zod_1.z.string(),
+    providers: zod_1.z.array(zod_1.z.string()),
+});
+exports.sAgentStopped = zod_1.z.object({
+    kind: zod_1.z.literal('agent-stopped'),
+    agent: zod_1.z.string(),
+    providers: zod_1.z.array(zod_1.z.string()),
+});

package/dist/index.d.ts

@@ -15,7 +15,7 @@ export * from './orchid';
 export * from './aware-config';
 export * from './access-control';
 export * from './device-event';
-export * from './device-command';
+export * from './commands/all';
 export * from './device-factory';
 export * from './module-config';
 export * from './device-group';
@@ -33,6 +33,9 @@ export * from './token-conversion';
 export * from './world-objects';
 export * from './bookmarks';
 export * from './objects';
+export * from './events';
+export * from './commands';
+export * from './queries';
 export * from './primitives';
 export * from './api-keys';
 export * from './notifications';

package/dist/index.js

@@ -31,7 +31,7 @@ __exportStar(require("./orchid"), exports);
 __exportStar(require("./aware-config"), exports);
 __exportStar(require("./access-control"), exports);
 __exportStar(require("./device-event"), exports);
-__exportStar(require("./device-command"), exports);
+__exportStar(require("./commands/all"), exports);
 __exportStar(require("./device-factory"), exports);
 __exportStar(require("./module-config"), exports);
 __exportStar(require("./device-group"), exports);
@@ -49,6 +49,9 @@ __exportStar(require("./token-conversion"), exports);
 __exportStar(require("./world-objects"), exports);
 __exportStar(require("./bookmarks"), exports);
 __exportStar(require("./objects"), exports);
+__exportStar(require("./events"), exports);
+__exportStar(require("./commands"), exports);
+__exportStar(require("./queries"), exports);
 __exportStar(require("./primitives"), exports);
 __exportStar(require("./api-keys"), exports);
 __exportStar(require("./notifications"), exports);

package/dist/layout.d.ts

@@ -123,7 +123,6 @@ export declare const sUpdateLayoutRequest: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     name?: string | undefined;
     order?: number | undefined;
-    isDefault?: boolean | undefined;
     devices?: {
         scale: number;
         x: number;
@@ -133,13 +132,13 @@ export declare const sUpdateLayoutRequest: z.ZodObject<{
         fov: number;
         far: number;
     }[] | undefined;
+    isDefault?: boolean | undefined;
     thumbnailId?: string | undefined;
     imageId?: string | undefined;
     colorize?: boolean | undefined;
 }, {
     name?: string | undefined;
     order?: number | undefined;
-    isDefault?: boolean | undefined;
     devices?: {
         scale: number;
         x: number;
@@ -149,6 +148,7 @@ export declare const sUpdateLayoutRequest: z.ZodObject<{
         fov: number;
         far: number;
     }[] | undefined;
+    isDefault?: boolean | undefined;
     thumbnailId?: string | undefined;
     imageId?: string | undefined;
     colorize?: boolean | undefined;
@@ -195,9 +195,6 @@ export declare const sLayoutDto: z.ZodObject<{
     name: string;
     id: string;
     order: number;
-    isDefault: boolean;
-    createdOn: string;
-    lastModifiedOn: string;
     devices: {
         scale: number;
         x: number;
@@ -207,6 +204,9 @@ export declare const sLayoutDto: z.ZodObject<{
         fov: number;
         far: number;
     }[];
+    isDefault: boolean;
+    createdOn: string;
+    lastModifiedOn: string;
     colorize: boolean;
     thumbnailUrl: string;
     imageUrl: string;
@@ -214,9 +214,6 @@ export declare const sLayoutDto: z.ZodObject<{
     name: string;
     id: string;
     order: number;
-    isDefault: boolean;
-    createdOn: string;
-    lastModifiedOn: string;
     devices: {
         scale: number;
         x: number;
@@ -226,6 +223,9 @@ export declare const sLayoutDto: z.ZodObject<{
         fov: number;
         far: number;
     }[];
+    isDefault: boolean;
+    createdOn: string;
+    lastModifiedOn: string;
     colorize: boolean;
     thumbnailUrl: string;
     imageUrl: string;

package/dist/macros.d.ts

@@ -8,14 +8,14 @@ export declare const sMacroItemDto: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     id: string | null;
     params: Record<string, unknown>;
-    command: string;
     deviceId: string;
+    command: string;
     stepId: string;
 }, {
     id: string | null;
     params: Record<string, unknown>;
-    command: string;
     deviceId: string;
+    command: string;
     stepId: string;
 }>;
 export declare const sMacroDto: z.ZodObject<{
@@ -36,14 +36,14 @@ export declare const sMacroDto: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         id: string | null;
         params: Record<string, unknown>;
-        command: string;
         deviceId: string;
+        command: string;
         stepId: string;
     }, {
         id: string | null;
         params: Record<string, unknown>;
-        command: string;
         deviceId: string;
+        command: string;
         stepId: string;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
@@ -54,8 +54,8 @@ export declare const sMacroDto: z.ZodObject<{
     items: {
         id: string | null;
         params: Record<string, unknown>;
-        command: string;
         deviceId: string;
+        command: string;
         stepId: string;
     }[];
     displayName: string;
@@ -70,8 +70,8 @@ export declare const sMacroDto: z.ZodObject<{
     items: {
         id: string | null;
         params: Record<string, unknown>;
-        command: string;
         deviceId: string;
+        command: string;
         stepId: string;
     }[];
     displayName: string;
@@ -97,14 +97,14 @@ export declare const sAddMacroRequest: z.ZodObject<Omit<{
     }, "strip", z.ZodTypeAny, {
         id: string | null;
         params: Record<string, unknown>;
-        command: string;
         deviceId: string;
+        command: string;
         stepId: string;
     }, {
         id: string | null;
         params: Record<string, unknown>;
-        command: string;
         deviceId: string;
+        command: string;
         stepId: string;
     }>, "many">;
 }, "id" | "createdOn" | "lastModifiedOn" | "createdBy">, "strip", z.ZodTypeAny, {
@@ -114,8 +114,8 @@ export declare const sAddMacroRequest: z.ZodObject<Omit<{
     items: {
         id: string | null;
         params: Record<string, unknown>;
-        command: string;
         deviceId: string;
+        command: string;
         stepId: string;
     }[];
     displayName: string;
@@ -126,8 +126,8 @@ export declare const sAddMacroRequest: z.ZodObject<Omit<{
     items: {
         id: string | null;
         params: Record<string, unknown>;
-        command: string;
         deviceId: string;
+        command: string;
         stepId: string;
     }[];
     displayName: string;
@@ -145,14 +145,14 @@ export declare const sUpdateMacroRequest: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         id: string | null;
         params: Record<string, unknown>;
-        command: string;
         deviceId: string;
+        command: string;
         stepId: string;
     }, {
         id: string | null;
         params: Record<string, unknown>;
-        command: string;
         deviceId: string;
+        command: string;
         stepId: string;
     }>, "many">>;
     displayName: z.ZodOptional<z.ZodString>;
@@ -163,8 +163,8 @@ export declare const sUpdateMacroRequest: z.ZodObject<{
     items?: {
         id: string | null;
         params: Record<string, unknown>;
-        command: string;
         deviceId: string;
+        command: string;
         stepId: string;
     }[] | undefined;
     displayName?: string | undefined;
@@ -175,8 +175,8 @@ export declare const sUpdateMacroRequest: z.ZodObject<{
     items?: {
         id: string | null;
         params: Record<string, unknown>;
-        command: string;
         deviceId: string;
+        command: string;
         stepId: string;
     }[] | undefined;
     displayName?: string | undefined;

package/dist/messages/device-communication.d.ts

@@ -1,6 +1,6 @@
 import z from 'zod';
-import { CommandRun } from '../device-command';
-import { DeviceEvent } from '../device-event';
+import { CommandRun } from '../commands/all';
+import { DeviceEvent } from '../events';
 import { WebSocketMessage } from './web-socket';
 export type CommandRunPayload = CommandRun;
 export declare const sCommandSuccess: z.ZodObject<{

package/dist/messages/notifications.d.ts

@@ -16,8 +16,8 @@ export declare const sNotificationCreatedPayload: z.ZodObject<{
     source: string;
     metadata: Record<string, unknown>;
     createdOn: number;
-    notificationRef: string | null;
     severity: "info" | "warning" | "critical";
+    notificationRef: string | null;
     acknowledgedBy: string | null;
     acknowledgedOn: number | null;
 }, {
@@ -26,8 +26,8 @@ export declare const sNotificationCreatedPayload: z.ZodObject<{
     source: string;
     metadata: Record<string, unknown>;
     createdOn: number;
-    notificationRef: string | null;
     severity: "info" | "warning" | "critical";
+    notificationRef: string | null;
     acknowledgedBy: string | null;
     acknowledgedOn: number | null;
 }>;

package/dist/messages/web-rtc-signaling.d.ts

@@ -17,11 +17,11 @@ export declare const sWebRtcLiveServiceParams: z.ZodObject<{
     deviceId: z.ZodString;
     streamId: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    streamId: string;
     deviceId: string;
-}, {
     streamId: string;
+}, {
     deviceId: string;
+    streamId: string;
 }>;
 export type WebRtcLiveServiceParams = z.infer<typeof sWebRtcLiveServiceParams>;
 export declare const sWebRtcPlaybackParams: z.ZodObject<{
@@ -57,23 +57,23 @@ export declare const sWebRtcServiceDescription: z.ZodUnion<[z.ZodObject<{
         deviceId: z.ZodString;
         streamId: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        streamId: string;
         deviceId: string;
-    }, {
         streamId: string;
+    }, {
         deviceId: string;
+        streamId: string;
     }>;
 }, "strip", z.ZodTypeAny, {
     service: "live";
     serviceParams: {
-        streamId: string;
         deviceId: string;
+        streamId: string;
     };
 }, {
     service: "live";
     serviceParams: {
-        streamId: string;
         deviceId: string;
+        streamId: string;
     };
 }>, z.ZodObject<{
     service: z.ZodLiteral<"playback">;
@@ -145,23 +145,23 @@ export declare const sWebRtcNewSessionPayload: z.ZodIntersection<z.ZodUnion<[z.Z
         deviceId: z.ZodString;
         streamId: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        streamId: string;
         deviceId: string;
-    }, {
         streamId: string;
+    }, {
         deviceId: string;
+        streamId: string;
     }>;
 }, "strip", z.ZodTypeAny, {
     service: "live";
     serviceParams: {
-        streamId: string;
         deviceId: string;
+        streamId: string;
     };
 }, {
     service: "live";
     serviceParams: {
-        streamId: string;
         deviceId: string;
+        streamId: string;
     };
 }>, z.ZodObject<{
     service: z.ZodLiteral<"playback">;

package/dist/notifications.d.ts

@@ -15,8 +15,8 @@ export declare const sNotificationDto: z.ZodObject<{
     source: string;
     metadata: Record<string, unknown>;
     createdOn: number;
-    notificationRef: string | null;
     severity: "info" | "warning" | "critical";
+    notificationRef: string | null;
     acknowledgedBy: string | null;
     acknowledgedOn: number | null;
 }, {
@@ -25,8 +25,8 @@ export declare const sNotificationDto: z.ZodObject<{
     source: string;
     metadata: Record<string, unknown>;
     createdOn: number;
-    notificationRef: string | null;
     severity: "info" | "warning" | "critical";
+    notificationRef: string | null;
     acknowledgedBy: string | null;
     acknowledgedOn: number | null;
 }>;
@@ -39,15 +39,15 @@ export declare const sNotificationSearchParams: z.ZodObject<{
     timeTo: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     deviceId?: string[] | undefined;
-    severity?: ("info" | "warning" | "critical")[] | undefined;
     timeFrom?: number | undefined;
     timeTo?: number | undefined;
+    severity?: ("info" | "warning" | "critical")[] | undefined;
     acknowledged?: boolean | undefined;
 }, {
     deviceId?: string[] | undefined;
-    severity?: ("info" | "warning" | "critical")[] | undefined;
     timeFrom?: number | undefined;
     timeTo?: number | undefined;
+    severity?: ("info" | "warning" | "critical")[] | undefined;
     acknowledged?: boolean | undefined;
 }>;
 export type NotificationSearchParams = z.infer<typeof sNotificationSearchParams>;

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awarevue/api-types",
-  "version": "2.0.12",
+  "version": "2.0.14",
   "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,23 @@ 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>;
+export declare const sCameraPresetInfo: z.ZodObject<{
+    name: z.ZodString;
+    isDefault: z.ZodBoolean;
+    values: z.ZodUnknown;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    isDefault: boolean;
+    values?: unknown;
+}, {
+    name: string;
+    isDefault: boolean;
+    values?: unknown;
+}>;
+export type CameraPresetInfo = z.infer<typeof sCameraPresetInfo>;
+export declare const sCallState: z.ZodEnum<["connecting", "connected", "ringing", "terminated"]>;
+export declare const sCallDirection: z.ZodEnum<["incoming", "outgoing"]>;