@awarevue/api-types 2.0.22 → 2.0.24

package/dist/api/state/index.d.ts

@@ -0,0 +1,10 @@
+import { AlarmStateDto } from '../../objects/device/alarm';
+import { CameraStateDto } from '../../objects/device/camera';
+import { CameraLiftStateDto } from '../../objects/device/camera-lift';
+import { DoorStateDto } from '../../objects/device/door';
+import { IntercomOperatorStateDto } from '../../objects/device/intercom-operator';
+import { IntercomTerminalStateDto } from '../../objects/device/intercom-terminal';
+import { IoBoardStateDto } from '../../objects/device/io-board';
+import { MotionSensorStateDto } from '../../objects/device/motion-sensor';
+import { PanicButtonStateDto } from '../../objects/device/panic-button';
+export type DeviceStateDto = CameraStateDto | DoorStateDto | AlarmStateDto | IoBoardStateDto | CameraLiftStateDto | MotionSensorStateDto | PanicButtonStateDto | IntercomTerminalStateDto | IntercomOperatorStateDto;

package/dist/api/state/index.js

@@ -0,0 +1 @@
+export {};

package/dist/api/ws/device-communication.js

@@ -0,0 +1,55 @@
+import z from 'zod';
+export const sCommandSuccess = z.object({
+    timestamp: z.number(),
+    requestId: z.string(),
+});
+export const sCommandError = z.object({
+    timestamp: z.number(),
+    requestId: z.string(),
+    error: z.object({}),
+});
+export const sStateUpdate = z.object({
+    timestamp: z.number(),
+    deviceId: z.string(),
+    state: z.object({}),
+});
+export const sStateUnavailable = z.object({
+    timestamp: z.number(),
+    deviceId: z.string(),
+});
+export const sStateUpdateError = z.object({
+    timestamp: z.number(),
+    deviceId: z.string(),
+    error: z.object({}),
+});
+export const sStateSubscribe = z.object({
+    timestamp: z.number(),
+    requestId: z.string(),
+    deviceId: z.string(),
+});
+export const sStateUnsubscribe = z.object({
+    timestamp: z.number(),
+    requestId: z.string(),
+    deviceId: z.string(),
+});
+const validators = {
+    'command-run': z.object({}),
+    'command-success': sCommandSuccess,
+    'command-error': sCommandError,
+    'state-update': sStateUpdate,
+    'state-unavailable': sStateUnavailable,
+    'state-update-error': sStateUpdateError,
+    'state-subscribe': sStateSubscribe,
+    'state-unsubscribe': sStateUnsubscribe,
+    'device-event': z.object({}),
+};
+export const isDeviceMessage = (message) => {
+    const validator = validators[message.event];
+    if (!validator) {
+        return false;
+    }
+    return validator.safeParse(message.data).success;
+};
+export const isDeviceEventMessage = (message) => {
+    return message.event === 'device-event';
+};

package/dist/api/ws/index.js

@@ -0,0 +1,5 @@
+export * from './device-communication';
+export * from './web-socket';
+export * from './progress';
+export * from './web-rtc-signaling';
+export * from './notifications';

package/dist/api/ws/notifications.js

@@ -0,0 +1,20 @@
+import z from 'zod';
+import { sNotificationDto } from '../../objects';
+export const sNotificationCreatedPayload = sNotificationDto;
+export const sNotificationAcknowledgedPayload = z.object({
+    id: z.string().nonempty(),
+    acknowledgedBy: z.string().nonempty(),
+    acknowledgedOn: z.number().int().nonnegative(),
+});
+const validators = {
+    new: sNotificationCreatedPayload,
+    ack: sNotificationAcknowledgedPayload,
+};
+// validate a web socket message as a Notification message (use validators according to event)
+export const isNotificationWebSocketMessage = (message) => {
+    const validator = validators[message.event];
+    if (!validator) {
+        return false;
+    }
+    return validator.safeParse(message.data).success;
+};

package/dist/api/ws/progress.js

@@ -0,0 +1,44 @@
+import z from 'zod';
+export const sProgress = z.object({
+    total: z.number().optional(),
+    complete: z.number().optional(),
+    failed: z.object({}).default({}),
+});
+export const sProgressUpdate = z.object({
+    timestamp: z.number(),
+    item: z.string(),
+    progress: sProgress,
+});
+export const sProgressUnavailable = z.object({
+    timestamp: z.number(),
+    item: z.string(),
+});
+export const sProgressUpdateError = z.object({
+    timestamp: z.number(),
+    item: z.string(),
+    error: z.object({}),
+});
+export const sProgressSubscribe = z.object({
+    timestamp: z.number(),
+    requestId: z.string(),
+    item: z.string(),
+});
+export const sProgressUnsubscribe = z.object({
+    timestamp: z.number(),
+    requestId: z.string(),
+    item: z.string(),
+});
+const validators = {
+    'progress-update': sProgressUpdate,
+    'progress-unavailable': sProgressUnavailable,
+    'progress-update-error': sProgressUpdateError,
+    'progress-subscribe': sProgressSubscribe,
+    'progress-unsubscribe': sProgressUnsubscribe,
+};
+export const isProgressMessage = (message) => {
+    const validator = validators[message.event];
+    if (!validator) {
+        return false;
+    }
+    return validator.safeParse(message.data).success;
+};

package/dist/api/ws/web-rtc-signaling.js

@@ -0,0 +1,92 @@
+import z from 'zod';
+export const sSessionDescription = z.object({
+    type: z.string().nonempty(),
+    sdp: z.string().nonempty(),
+});
+export const sIceCandidate = z.string().nonempty();
+export const sWebRtcLiveServiceParams = z.object({
+    deviceId: z.string().nonempty(),
+    streamId: z.string().nonempty(),
+});
+export const sWebRtcPlaybackParams = z.object({
+    controllerId: z.string().nonempty(),
+});
+export const sWebRtcPlaybackTrackParams = z.object({
+    controllerId: z.string().nonempty(),
+    trackId: z.string().nonempty(),
+});
+export const sWebRtcPlaybackControllerParams = z.object({
+    controllerId: z.string().nonempty(),
+});
+export const sWebRtcServiceDescription = z.union([
+    z.object({
+        service: z.literal('live'),
+        serviceParams: sWebRtcLiveServiceParams,
+    }),
+    z.object({
+        service: z.literal('playback'),
+        serviceParams: sWebRtcPlaybackParams,
+    }),
+    z.object({
+        service: z.literal('playback-track'),
+        serviceParams: sWebRtcPlaybackTrackParams,
+    }),
+    z.object({
+        service: z.literal('playback-controller'),
+        serviceParams: sWebRtcPlaybackControllerParams,
+    }),
+]);
+export const sWebRtcNewSessionPayload = sWebRtcServiceDescription.and(z.object({
+    from: z.string().optional(),
+    requestId: z.string().nonempty(),
+}));
+export const sWebRtcSessionCreatedPayload = z.object({
+    requestId: z.string().nonempty(),
+    sessionId: z.string().nonempty(),
+    stunServer: z.string().nullable(),
+    frozenStreamTimeout: z.number().nullable(),
+    trickleIce: z.boolean(),
+});
+export const sWebRtcOfferPayload = z.object({
+    sessionId: z.string().nonempty(),
+    description: sSessionDescription,
+    from: z.string().optional(),
+});
+export const sWebRtcAnswerPayload = z.object({
+    sessionId: z.string().nonempty(),
+    description: sSessionDescription,
+    from: z.string().optional(),
+});
+export const sWebRtcIceCandidatePayload = z.object({
+    sessionId: z.string().nonempty(),
+    candidate: sIceCandidate,
+    from: z.string().optional(),
+});
+export const sWebRtcReleaseSessionPayload = z.object({
+    sessionId: z.string().nonempty(),
+    from: z.string().optional(),
+});
+export const sWebRtcErrorPayload = z.object({
+    sessionId: z.string().nonempty(),
+    error: z.object({
+        code: z.string().nonempty(),
+        message: z.string().nonempty(),
+    }),
+});
+const validators = {
+    'new-session': sWebRtcNewSessionPayload,
+    'session-created': sWebRtcSessionCreatedPayload,
+    offer: sWebRtcOfferPayload,
+    answer: sWebRtcAnswerPayload,
+    'ice-candidate': sWebRtcIceCandidatePayload,
+    'release-session': sWebRtcReleaseSessionPayload,
+    error: sWebRtcErrorPayload,
+};
+// validate a web socket message as a WebRTC signaling message (use validators according to event)
+export const isWebRtcWebSocketMessage = (message) => {
+    const validator = validators[message.event];
+    if (!validator) {
+        return false;
+    }
+    return validator.safeParse(message.data).success;
+};

package/dist/api/ws/web-socket.js

@@ -0,0 +1,2 @@
+export const WS_SERVER_READY = 'server-ready';
+export const WS_KEEP_ALIVE = 'keep-alive';

package/dist/index.d.ts

@@ -1,41 +1,6 @@
 export * from './api';
-export * from './messages';
-export * from './error';
-export * from './user';
 export * from './permissions';
-export * from './view';
-export * from './layout';
-export * from './device';
-export * from './device-relation';
-export * from './file';
-export * from './device-state';
-export * from './device-import';
-export * from './milestone';
-export * from './orchid';
-export * from './aware-config';
-export * from './access-control';
-export * from './device-event';
-export * from './commands/all';
-export * from './device-factory';
-export * from './module-config';
-export * from './device-group';
-export * from './app';
-export * from './automation';
 export * from './alarm-automation';
-export * from './macros';
-export * from './template';
-export * from './webrtc-playback';
-export * from './custom-field';
-export * from './agent-communication';
-export * from './cast';
-export * from './security-level';
-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';
+export * from './_legacy';

package/dist/index.js

@@ -1,57 +1,6 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./api"), exports);
-__exportStar(require("./messages"), exports);
-__exportStar(require("./error"), exports);
-__exportStar(require("./user"), exports);
-__exportStar(require("./permissions"), exports);
-__exportStar(require("./view"), exports);
-__exportStar(require("./layout"), exports);
-__exportStar(require("./device"), exports);
-__exportStar(require("./device-relation"), exports);
-__exportStar(require("./file"), exports);
-__exportStar(require("./device-state"), exports);
-__exportStar(require("./device-import"), exports);
-__exportStar(require("./milestone"), exports);
-__exportStar(require("./orchid"), exports);
-__exportStar(require("./aware-config"), exports);
-__exportStar(require("./access-control"), exports);
-__exportStar(require("./device-event"), exports);
-__exportStar(require("./commands/all"), exports);
-__exportStar(require("./device-factory"), exports);
-__exportStar(require("./module-config"), exports);
-__exportStar(require("./device-group"), exports);
-__exportStar(require("./app"), exports);
-__exportStar(require("./automation"), exports);
-__exportStar(require("./alarm-automation"), exports);
-__exportStar(require("./macros"), exports);
-__exportStar(require("./template"), exports);
-__exportStar(require("./webrtc-playback"), exports);
-__exportStar(require("./custom-field"), exports);
-__exportStar(require("./agent-communication"), exports);
-__exportStar(require("./cast"), exports);
-__exportStar(require("./security-level"), exports);
-__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);
+export * from './api';
+export * from './permissions';
+export * from './alarm-automation';
+export * from './objects';
+export * from './primitives';
+export * from './_legacy';

package/dist/{access-control → objects}/access-rule.d.ts

@@ -1,4 +1,4 @@
-import z from 'zod';
+import { z } from 'zod';
 export declare const sAccessRulePersonDto: z.ZodObject<{
     id: z.ZodString;
     firstName: z.ZodString;
@@ -85,9 +85,6 @@ export declare const sAccessRuleDto: z.ZodObject<{
     id: string;
     version: number;
     displayName: string;
-    refs: Record<string, string | string[]>;
-    createdOn: string;
-    lastModifiedOn: string;
     appliedTo: {
         id: string;
         firstName: string;
@@ -102,13 +99,13 @@ export declare const sAccessRuleDto: z.ZodObject<{
         scheduleId: string;
         groupId: string;
     }[];
+    createdOn: string;
+    lastModifiedOn: string;
+    refs: Record<string, string | string[]>;
 }, {
     id: string;
     version: number;
     displayName: string;
-    refs: Record<string, string | string[]>;
-    createdOn: string;
-    lastModifiedOn: string;
     appliedTo: {
         id: string;
         firstName: string;
@@ -123,9 +120,12 @@ export declare const sAccessRuleDto: z.ZodObject<{
         scheduleId: string;
         groupId: string;
     }[];
+    createdOn: string;
+    lastModifiedOn: string;
+    refs: Record<string, string | string[]>;
 }>;
 export type AccessRuleDto = z.infer<typeof sAccessRuleDto>;
-export declare const sCreateAccessRuleRequest: z.ZodObject<{
+export declare const sAccessRuleProps: z.ZodObject<{
     displayName: z.ZodString;
     appliedTo: z.ZodArray<z.ZodString, "many">;
     permissions: z.ZodArray<z.ZodObject<{
@@ -171,73 +171,4 @@ export declare const sCreateAccessRuleRequest: z.ZodObject<{
         groupId: string;
     }[];
 }>;
-export declare const sUpdateAccessRuleRequest: z.ZodObject<{
-    displayName: z.ZodOptional<z.ZodString>;
-    appliedTo: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    permissions: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        deviceId: z.ZodString;
-        scheduleId: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        deviceId: string;
-        scheduleId: string;
-    }, {
-        deviceId: string;
-        scheduleId: string;
-    }>, "many">>;
-    groupPermissions: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        groupId: z.ZodString;
-        scheduleId: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        scheduleId: string;
-        groupId: string;
-    }, {
-        scheduleId: string;
-        groupId: string;
-    }>, "many">>;
-}, "strip", z.ZodTypeAny, {
-    displayName?: string | undefined;
-    appliedTo?: string[] | undefined;
-    permissions?: {
-        deviceId: string;
-        scheduleId: string;
-    }[] | undefined;
-    groupPermissions?: {
-        scheduleId: string;
-        groupId: string;
-    }[] | undefined;
-}, {
-    displayName?: string | undefined;
-    appliedTo?: string[] | undefined;
-    permissions?: {
-        deviceId: string;
-        scheduleId: string;
-    }[] | undefined;
-    groupPermissions?: {
-        scheduleId: string;
-        groupId: string;
-    }[] | undefined;
-}>;
-export declare const sAddMemberToAccessRuleRequest: z.ZodObject<{
-    personId: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    personId: string;
-}, {
-    personId: string;
-}>;
-export declare const sRemoveMemberFromAccessRuleRequest: z.ZodObject<{
-    personId: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    personId: string;
-}, {
-    personId: string;
-}>;
-export type CreateAccessRuleRequest = z.infer<typeof sCreateAccessRuleRequest>;
-export type UpdateAccessRuleRequest = {
-    id: string;
-} & z.infer<typeof sUpdateAccessRuleRequest>;
-export type AddMemberToAccessRuleRequest = {
-    id: string;
-} & z.infer<typeof sAddMemberToAccessRuleRequest>;
-export type RemoveMemberFromAccessRuleRequest = {
-    id: string;
-} & z.infer<typeof sRemoveMemberFromAccessRuleRequest>;
+export type AccessRuleProps = z.infer<typeof sAccessRuleProps>;

package/dist/objects/access-rule.js

@@ -0,0 +1,36 @@
+import { z } from 'zod';
+export const sAccessRulePersonDto = z.object({
+    id: z.string().describe('Person ID'),
+    firstName: z.string().describe('First name'),
+    lastName: z.string().describe('Last name'),
+    avatarId: z.string().nullable().describe('Avatar ID'),
+});
+export const sAccessRulePermissionDto = z.object({
+    deviceId: z.string().describe('Device ID').nonempty(),
+    scheduleId: z.string().describe('Schedule ID').nonempty(),
+});
+export const sAccessRuleGroupPermissionDto = z.object({
+    groupId: z.string().describe('Group ID').nonempty(),
+    scheduleId: z.string().describe('Schedule ID').nonempty(),
+});
+export const sAccessRuleDto = z.object({
+    id: z.string().describe('Access rule ID'),
+    displayName: z.string().describe('Display name'),
+    appliedTo: z.array(sAccessRulePersonDto).describe('Applied to'),
+    permissions: z.array(sAccessRulePermissionDto).describe('Permissions'),
+    groupPermissions: z
+        .array(sAccessRuleGroupPermissionDto)
+        .describe('Group permissions'),
+    createdOn: z.string().describe('Created on'),
+    lastModifiedOn: z.string().describe('Last modified on'),
+    refs: z.record(z.union([z.string(), z.array(z.string())])),
+    version: z.number().describe('Version'),
+});
+export const sAccessRuleProps = z.object({
+    displayName: z.string().nonempty().describe('Display name'),
+    appliedTo: z.array(z.string().nonempty()).describe('Applied to'),
+    permissions: z.array(sAccessRulePermissionDto).describe('Permissions'),
+    groupPermissions: z
+        .array(sAccessRuleGroupPermissionDto)
+        .describe('Group permissions'),
+});