@awarevue/api-types 2.0.22 → 2.0.24

package/dist/objects/token-conversion.d.ts

@@ -0,0 +1,23 @@
+import { z } from 'zod';
+export declare const sConversionTypeEnum: z.ZodEnum<["hex-to-decimal"]>;
+export declare const sTokenConversionDto: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    type: z.ZodEnum<["hex-to-decimal"]>;
+    jsonData: z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    type: "hex-to-decimal";
+    id: string;
+    jsonData: {} & {
+        [k: string]: unknown;
+    };
+}, {
+    name: string;
+    type: "hex-to-decimal";
+    id: string;
+    jsonData: {} & {
+        [k: string]: unknown;
+    };
+}>;
+export type TokenConversionDto = z.infer<typeof sTokenConversionDto>;

package/dist/objects/token-conversion.js

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+export const sConversionTypeEnum = z.enum(['hex-to-decimal']);
+export const sTokenConversionDto = z.object({
+    id: z.string().uuid(),
+    name: z.string().min(1).max(64),
+    type: sConversionTypeEnum,
+    jsonData: z.object({}).passthrough(), // Allows any JSON object structure
+});

package/dist/objects/user.d.ts

@@ -0,0 +1,31 @@
+import { z } from 'zod';
+export declare const sUserPassword: z.ZodString;
+export declare const sUserDto: z.ZodObject<{
+    id: z.ZodString;
+    firstName: z.ZodString;
+    lastName: z.ZodString;
+    email: z.ZodNullable<z.ZodString>;
+    username: z.ZodString;
+    isActive: z.ZodBoolean;
+    isRoot: z.ZodBoolean;
+    roles: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    username: string;
+    email: string | null;
+    firstName: string;
+    lastName: string;
+    isActive: boolean;
+    isRoot: boolean;
+    roles: string[];
+}, {
+    id: string;
+    username: string;
+    email: string | null;
+    firstName: string;
+    lastName: string;
+    isActive: boolean;
+    isRoot: boolean;
+    roles: string[];
+}>;
+export type UserDto = z.infer<typeof sUserDto>;

package/dist/objects/user.js

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+export const sUserPassword = z.string().min(4).max(64);
+export const sUserDto = z.object({
+    id: z.string(),
+    firstName: z.string(),
+    lastName: z.string(),
+    email: z.string().nullable(),
+    username: z.string(),
+    isActive: z.boolean(),
+    isRoot: z.boolean(),
+    roles: z.array(z.string()),
+});

package/dist/{view.d.ts → objects/view.d.ts}

@@ -1,4 +1,4 @@
-import z from 'zod';
+import { z } from 'zod';
 export declare const sLayoutArea: z.ZodObject<{
     area: z.ZodString;
     type: z.ZodLiteral<"layout">;
@@ -261,398 +261,6 @@ export declare const sViewConfig: z.ZodObject<{
     })[];
     hotspotArea?: string | undefined;
 }>;
-export declare const sAddViewRequest: z.ZodObject<{
-    name: z.ZodString;
-    order: z.ZodOptional<z.ZodNumber>;
-    isPublic: z.ZodBoolean;
-    isDefault: z.ZodOptional<z.ZodBoolean>;
-    config: z.ZodObject<{
-        rows: z.ZodNumber;
-        columns: z.ZodNumber;
-        areas: z.ZodArray<z.ZodArray<z.ZodString, "many">, "many">;
-        hotspotArea: z.ZodOptional<z.ZodString>;
-        contents: z.ZodArray<z.ZodUnion<[z.ZodObject<{
-            area: z.ZodString;
-            type: z.ZodLiteral<"layout">;
-            layoutId: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            type: "layout";
-            area: string;
-            layoutId: string;
-        }, {
-            type: "layout";
-            area: string;
-            layoutId: string;
-        }>, z.ZodObject<{
-            area: z.ZodString;
-            type: z.ZodLiteral<"layoutSelector">;
-        }, "strip", z.ZodTypeAny, {
-            type: "layoutSelector";
-            area: string;
-        }, {
-            type: "layoutSelector";
-            area: string;
-        }>, z.ZodObject<{
-            area: z.ZodString;
-            type: z.ZodLiteral<"device">;
-            deviceId: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            type: "device";
-            area: string;
-            deviceId: string;
-        }, {
-            type: "device";
-            area: string;
-            deviceId: string;
-        }>, z.ZodObject<{
-            area: z.ZodString;
-            type: z.ZodLiteral<"deviceCarousel">;
-            deviceIds: z.ZodArray<z.ZodString, "many">;
-            timeIntervalMs: z.ZodNumber;
-        }, "strip", z.ZodTypeAny, {
-            type: "deviceCarousel";
-            area: string;
-            deviceIds: string[];
-            timeIntervalMs: number;
-        }, {
-            type: "deviceCarousel";
-            area: string;
-            deviceIds: string[];
-            timeIntervalMs: number;
-        }>, z.ZodObject<{
-            area: z.ZodString;
-            type: z.ZodLiteral<"playbackTrack">;
-            controllerId: z.ZodString;
-            source: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            type: "playbackTrack";
-            source: string;
-            area: string;
-            controllerId: string;
-        }, {
-            type: "playbackTrack";
-            source: string;
-            area: string;
-            controllerId: string;
-        }>]>, "many">;
-    }, "strip", z.ZodTypeAny, {
-        columns: number;
-        rows: number;
-        areas: string[][];
-        contents: ({
-            type: "layout";
-            area: string;
-            layoutId: string;
-        } | {
-            type: "layoutSelector";
-            area: string;
-        } | {
-            type: "device";
-            area: string;
-            deviceId: string;
-        } | {
-            type: "deviceCarousel";
-            area: string;
-            deviceIds: string[];
-            timeIntervalMs: number;
-        } | {
-            type: "playbackTrack";
-            source: string;
-            area: string;
-            controllerId: string;
-        })[];
-        hotspotArea?: string | undefined;
-    }, {
-        columns: number;
-        rows: number;
-        areas: string[][];
-        contents: ({
-            type: "layout";
-            area: string;
-            layoutId: string;
-        } | {
-            type: "layoutSelector";
-            area: string;
-        } | {
-            type: "device";
-            area: string;
-            deviceId: string;
-        } | {
-            type: "deviceCarousel";
-            area: string;
-            deviceIds: string[];
-            timeIntervalMs: number;
-        } | {
-            type: "playbackTrack";
-            source: string;
-            area: string;
-            controllerId: string;
-        })[];
-        hotspotArea?: string | undefined;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    name: string;
-    config: {
-        columns: number;
-        rows: number;
-        areas: string[][];
-        contents: ({
-            type: "layout";
-            area: string;
-            layoutId: string;
-        } | {
-            type: "layoutSelector";
-            area: string;
-        } | {
-            type: "device";
-            area: string;
-            deviceId: string;
-        } | {
-            type: "deviceCarousel";
-            area: string;
-            deviceIds: string[];
-            timeIntervalMs: number;
-        } | {
-            type: "playbackTrack";
-            source: string;
-            area: string;
-            controllerId: string;
-        })[];
-        hotspotArea?: string | undefined;
-    };
-    isPublic: boolean;
-    order?: number | undefined;
-    isDefault?: boolean | undefined;
-}, {
-    name: string;
-    config: {
-        columns: number;
-        rows: number;
-        areas: string[][];
-        contents: ({
-            type: "layout";
-            area: string;
-            layoutId: string;
-        } | {
-            type: "layoutSelector";
-            area: string;
-        } | {
-            type: "device";
-            area: string;
-            deviceId: string;
-        } | {
-            type: "deviceCarousel";
-            area: string;
-            deviceIds: string[];
-            timeIntervalMs: number;
-        } | {
-            type: "playbackTrack";
-            source: string;
-            area: string;
-            controllerId: string;
-        })[];
-        hotspotArea?: string | undefined;
-    };
-    isPublic: boolean;
-    order?: number | undefined;
-    isDefault?: boolean | undefined;
-}>;
-export declare const sUpdateViewRequest: z.ZodObject<{
-    name: z.ZodOptional<z.ZodString>;
-    order: z.ZodOptional<z.ZodNumber>;
-    isPublic: z.ZodOptional<z.ZodBoolean>;
-    isDefault: z.ZodOptional<z.ZodBoolean>;
-    config: z.ZodOptional<z.ZodObject<{
-        rows: z.ZodNumber;
-        columns: z.ZodNumber;
-        areas: z.ZodArray<z.ZodArray<z.ZodString, "many">, "many">;
-        hotspotArea: z.ZodOptional<z.ZodString>;
-        contents: z.ZodArray<z.ZodUnion<[z.ZodObject<{
-            area: z.ZodString;
-            type: z.ZodLiteral<"layout">;
-            layoutId: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            type: "layout";
-            area: string;
-            layoutId: string;
-        }, {
-            type: "layout";
-            area: string;
-            layoutId: string;
-        }>, z.ZodObject<{
-            area: z.ZodString;
-            type: z.ZodLiteral<"layoutSelector">;
-        }, "strip", z.ZodTypeAny, {
-            type: "layoutSelector";
-            area: string;
-        }, {
-            type: "layoutSelector";
-            area: string;
-        }>, z.ZodObject<{
-            area: z.ZodString;
-            type: z.ZodLiteral<"device">;
-            deviceId: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            type: "device";
-            area: string;
-            deviceId: string;
-        }, {
-            type: "device";
-            area: string;
-            deviceId: string;
-        }>, z.ZodObject<{
-            area: z.ZodString;
-            type: z.ZodLiteral<"deviceCarousel">;
-            deviceIds: z.ZodArray<z.ZodString, "many">;
-            timeIntervalMs: z.ZodNumber;
-        }, "strip", z.ZodTypeAny, {
-            type: "deviceCarousel";
-            area: string;
-            deviceIds: string[];
-            timeIntervalMs: number;
-        }, {
-            type: "deviceCarousel";
-            area: string;
-            deviceIds: string[];
-            timeIntervalMs: number;
-        }>, z.ZodObject<{
-            area: z.ZodString;
-            type: z.ZodLiteral<"playbackTrack">;
-            controllerId: z.ZodString;
-            source: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            type: "playbackTrack";
-            source: string;
-            area: string;
-            controllerId: string;
-        }, {
-            type: "playbackTrack";
-            source: string;
-            area: string;
-            controllerId: string;
-        }>]>, "many">;
-    }, "strip", z.ZodTypeAny, {
-        columns: number;
-        rows: number;
-        areas: string[][];
-        contents: ({
-            type: "layout";
-            area: string;
-            layoutId: string;
-        } | {
-            type: "layoutSelector";
-            area: string;
-        } | {
-            type: "device";
-            area: string;
-            deviceId: string;
-        } | {
-            type: "deviceCarousel";
-            area: string;
-            deviceIds: string[];
-            timeIntervalMs: number;
-        } | {
-            type: "playbackTrack";
-            source: string;
-            area: string;
-            controllerId: string;
-        })[];
-        hotspotArea?: string | undefined;
-    }, {
-        columns: number;
-        rows: number;
-        areas: string[][];
-        contents: ({
-            type: "layout";
-            area: string;
-            layoutId: string;
-        } | {
-            type: "layoutSelector";
-            area: string;
-        } | {
-            type: "device";
-            area: string;
-            deviceId: string;
-        } | {
-            type: "deviceCarousel";
-            area: string;
-            deviceIds: string[];
-            timeIntervalMs: number;
-        } | {
-            type: "playbackTrack";
-            source: string;
-            area: string;
-            controllerId: string;
-        })[];
-        hotspotArea?: string | undefined;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    name?: string | undefined;
-    order?: number | undefined;
-    isDefault?: boolean | undefined;
-    config?: {
-        columns: number;
-        rows: number;
-        areas: string[][];
-        contents: ({
-            type: "layout";
-            area: string;
-            layoutId: string;
-        } | {
-            type: "layoutSelector";
-            area: string;
-        } | {
-            type: "device";
-            area: string;
-            deviceId: string;
-        } | {
-            type: "deviceCarousel";
-            area: string;
-            deviceIds: string[];
-            timeIntervalMs: number;
-        } | {
-            type: "playbackTrack";
-            source: string;
-            area: string;
-            controllerId: string;
-        })[];
-        hotspotArea?: string | undefined;
-    } | undefined;
-    isPublic?: boolean | undefined;
-}, {
-    name?: string | undefined;
-    order?: number | undefined;
-    isDefault?: boolean | undefined;
-    config?: {
-        columns: number;
-        rows: number;
-        areas: string[][];
-        contents: ({
-            type: "layout";
-            area: string;
-            layoutId: string;
-        } | {
-            type: "layoutSelector";
-            area: string;
-        } | {
-            type: "device";
-            area: string;
-            deviceId: string;
-        } | {
-            type: "deviceCarousel";
-            area: string;
-            deviceIds: string[];
-            timeIntervalMs: number;
-        } | {
-            type: "playbackTrack";
-            source: string;
-            area: string;
-            controllerId: string;
-        })[];
-        hotspotArea?: string | undefined;
-    } | undefined;
-    isPublic?: boolean | undefined;
-}>;
 export type ViewConfig = z.infer<typeof sViewConfig>;
 export declare const sViewInfo: z.ZodIntersection<z.ZodObject<{
     name: z.ZodString;
@@ -807,18 +415,18 @@ export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
     name: string;
     id: string;
     order: number;
-    isDefault: boolean;
     createdOn: string;
     lastModifiedOn: string;
+    isDefault: boolean;
     createdBy: string;
     isPublic: boolean;
 }, {
     name: string;
     id: string;
     order: number;
-    isDefault: boolean;
     createdOn: string;
     lastModifiedOn: string;
+    isDefault: boolean;
     createdBy: string;
     isPublic: boolean;
 }>, z.ZodObject<{
@@ -946,7 +554,3 @@ export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
     hotspotArea?: string | undefined;
 }>>;
 export type ViewDto = z.infer<typeof sViewDto>;
-export type AddViewRequest = z.infer<typeof sAddViewRequest>;
-export type UpdateViewRequest = {
-    id: string;
-} & z.infer<typeof sUpdateViewRequest>;

package/dist/objects/view.js

@@ -0,0 +1,64 @@
+import { z } from 'zod';
+export const sLayoutArea = z.object({
+    area: z.string().nonempty(),
+    type: z.literal('layout'),
+    layoutId: z.string().nonempty(),
+});
+export const sLayoutSelectorArea = z.object({
+    area: z.string().nonempty(),
+    type: z.literal('layoutSelector'),
+});
+export const sDeviceArea = z.object({
+    area: z.string().nonempty(),
+    type: z.literal('device'),
+    deviceId: z.string().nonempty(),
+});
+export const sDeviceCarouselArea = z.object({
+    area: z.string().nonempty(),
+    type: z.literal('deviceCarousel'),
+    deviceIds: z.array(z.string().nonempty()),
+    timeIntervalMs: z.number().nonnegative(),
+});
+export const sPlaybackTrackArea = z.object({
+    area: z.string().nonempty(),
+    type: z.literal('playbackTrack'),
+    controllerId: z.string().nonempty(),
+    source: z
+        .string()
+        .nonempty()
+        .describe('The track within the controller. It is the device ID for the camera in the track.'),
+});
+export const sViewAreaContents = z.union([
+    sLayoutArea,
+    sLayoutSelectorArea,
+    sDeviceArea,
+    sDeviceCarouselArea,
+    sPlaybackTrackArea,
+]);
+export const sViewConfig = z.object({
+    rows: z.number(),
+    columns: z.number(),
+    areas: z.array(z.array(z.string().nonempty())),
+    hotspotArea: z.string().optional(),
+    contents: z.array(sViewAreaContents),
+});
+export const sViewInfo = z
+    .object({
+    name: z.string(),
+    order: z.number(),
+    isPublic: z.boolean(),
+    isDefault: z.boolean(),
+})
+    .and(sViewConfig);
+export const sViewDto = z
+    .object({
+    id: z.string(),
+    name: z.string(),
+    order: z.number(),
+    isPublic: z.boolean(),
+    isDefault: z.boolean(),
+    createdBy: z.string(),
+    createdOn: z.string(),
+    lastModifiedOn: z.string(),
+})
+    .and(sViewConfig);

package/dist/{world-objects.js → objects/world-object.js}

@@ -1,12 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.worldObjects = exports.sWorldObject = void 0;
-const zod_1 = require("zod");
-exports.sWorldObject = zod_1.z.object({
-    id: zod_1.z.string().describe('The unique identifier of the world object'),
-    label: zod_1.z.string().describe('The label of the world object'),
+import { z } from 'zod';
+export const sWorldObject = z.object({
+    id: z.string().describe('The unique identifier of the world object'),
+    label: z.string().describe('The label of the world object'),
 });
-exports.worldObjects = [
+export const worldObjects = [
     {
         id: 'person',
         label: 'Person',

package/dist/objects/zone.d.ts

@@ -0,0 +1,41 @@
+import { z } from 'zod';
+export declare const sZoneProps: z.ZodObject<{
+    displayName: z.ZodString;
+    devices: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    displayName: string;
+    devices: string[];
+}, {
+    displayName: string;
+    devices: string[];
+}>;
+export declare const sZoneDto: z.ZodObject<{
+    id: z.ZodString;
+    displayName: z.ZodString;
+    createdOn: z.ZodString;
+    lastModifiedOn: z.ZodString;
+    devices: z.ZodArray<z.ZodString, "many">;
+    isGlobal: z.ZodBoolean;
+    refs: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
+    version: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    version: number;
+    displayName: string;
+    createdOn: string;
+    lastModifiedOn: string;
+    refs: Record<string, string | string[]>;
+    devices: string[];
+    isGlobal: boolean;
+}, {
+    id: string;
+    version: number;
+    displayName: string;
+    createdOn: string;
+    lastModifiedOn: string;
+    refs: Record<string, string | string[]>;
+    devices: string[];
+    isGlobal: boolean;
+}>;
+export type ZoneDto = z.infer<typeof sZoneDto>;
+export type ZoneProps = z.infer<typeof sZoneProps>;

package/dist/objects/zone.js

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+export const sZoneProps = z.object({
+    displayName: z.string().nonempty(),
+    devices: z.array(z.string().nonempty()),
+});
+export const sZoneDto = z.object({
+    id: z.string(),
+    displayName: z.string(),
+    createdOn: z.string(),
+    lastModifiedOn: z.string(),
+    devices: z.array(z.string()),
+    isGlobal: z.boolean(),
+    refs: z.record(z.union([z.string(), z.array(z.string())])),
+    version: z.number(),
+});

package/dist/package.json

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