@awarevue/api-types 1.0.1

package/dist/view.d.ts

@@ -0,0 +1,775 @@
+import z from 'zod';
+export declare const sLayoutArea: 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;
+}>;
+export type LayoutArea = z.infer<typeof sLayoutArea>;
+export declare const sLayoutSelectorArea: z.ZodObject<{
+    area: z.ZodString;
+    type: z.ZodLiteral<"layoutSelector">;
+}, "strip", z.ZodTypeAny, {
+    type: "layoutSelector";
+    area: string;
+}, {
+    type: "layoutSelector";
+    area: string;
+}>;
+export type LayoutSelectorArea = z.infer<typeof sLayoutSelectorArea>;
+export declare const sDeviceArea: 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;
+}>;
+export type DeviceArea = z.infer<typeof sDeviceArea>;
+export declare const sDeviceCarouselArea: 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;
+}>;
+export type DeviceCarouselArea = z.infer<typeof sDeviceCarouselArea>;
+export type ViewAreaContents = LayoutArea | LayoutSelectorArea | DeviceArea | DeviceCarouselArea;
+export declare const sViewAreaContents: 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;
+}>]>;
+export declare const sViewConfig: 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;
+    }>]>, "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;
+    })[];
+    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;
+    })[];
+    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;
+        }>]>, "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;
+        })[];
+        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;
+        })[];
+        hotspotArea?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    isPublic: boolean;
+    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;
+        })[];
+        hotspotArea?: string | undefined;
+    };
+    order?: number | undefined;
+    isDefault?: boolean | undefined;
+}, {
+    name: string;
+    isPublic: boolean;
+    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;
+        })[];
+        hotspotArea?: string | undefined;
+    };
+    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;
+        }>]>, "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;
+        })[];
+        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;
+        })[];
+        hotspotArea?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    name?: string | undefined;
+    order?: number | undefined;
+    isDefault?: boolean | undefined;
+    isPublic?: 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;
+        })[];
+        hotspotArea?: string | undefined;
+    } | undefined;
+}, {
+    name?: string | undefined;
+    order?: number | undefined;
+    isDefault?: boolean | undefined;
+    isPublic?: 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;
+        })[];
+        hotspotArea?: string | undefined;
+    } | undefined;
+}>;
+export type ViewConfig = z.infer<typeof sViewConfig>;
+export declare const sViewInfo: z.ZodIntersection<z.ZodObject<{
+    name: z.ZodString;
+    order: z.ZodNumber;
+    isPublic: z.ZodBoolean;
+    isDefault: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    order: number;
+    isDefault: boolean;
+    isPublic: boolean;
+}, {
+    name: string;
+    order: number;
+    isDefault: boolean;
+    isPublic: boolean;
+}>, 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;
+    }>]>, "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;
+    })[];
+    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;
+    })[];
+    hotspotArea?: string | undefined;
+}>>;
+export type ViewInfo = z.infer<typeof sViewInfo>;
+export declare const sViewDto: z.ZodIntersection<z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    order: z.ZodNumber;
+    isPublic: z.ZodBoolean;
+    isDefault: z.ZodBoolean;
+    createdBy: z.ZodString;
+    createdOn: z.ZodString;
+    lastModifiedOn: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    id: string;
+    order: number;
+    createdOn: string;
+    lastModifiedOn: string;
+    isDefault: boolean;
+    createdBy: string;
+    isPublic: boolean;
+}, {
+    name: string;
+    id: string;
+    order: number;
+    createdOn: string;
+    lastModifiedOn: string;
+    isDefault: boolean;
+    createdBy: string;
+    isPublic: boolean;
+}>, 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;
+    }>]>, "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;
+    })[];
+    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;
+    })[];
+    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>;