@awarevue/api-types 2.0.22 → 2.0.24

package/dist/{layout.d.ts → api/rest/layout.d.ts}

@@ -1,30 +1,4 @@
 import z from 'zod';
-export declare const sLayoutDeviceDto: z.ZodObject<{
-    deviceId: z.ZodString;
-    x: z.ZodNumber;
-    y: z.ZodNumber;
-    scale: z.ZodNumber;
-    rotation: z.ZodNumber;
-    fov: z.ZodNumber;
-    far: z.ZodNumber;
-}, "strip", z.ZodTypeAny, {
-    scale: number;
-    x: number;
-    y: number;
-    deviceId: string;
-    rotation: number;
-    fov: number;
-    far: number;
-}, {
-    scale: number;
-    x: number;
-    y: number;
-    deviceId: string;
-    rotation: number;
-    fov: number;
-    far: number;
-}>;
-export type LayoutDeviceDto = z.infer<typeof sLayoutDeviceDto>;
 export declare const sAddLayoutRequest: z.ZodObject<{
     name: z.ZodString;
     thumbnailId: z.ZodString;
@@ -67,9 +41,9 @@ export declare const sAddLayoutRequest: z.ZodObject<{
         fov: number;
         far: number;
     }[];
+    colorize: boolean;
     thumbnailId: string;
     imageId: string;
-    colorize: boolean;
     order?: number | undefined;
 }, {
     name: string;
@@ -82,9 +56,9 @@ export declare const sAddLayoutRequest: z.ZodObject<{
         fov: number;
         far: number;
     }[];
+    colorize: boolean;
     thumbnailId: string;
     imageId: string;
-    colorize: boolean;
     order?: number | undefined;
 }>;
 export type AddLayoutRequest = z.infer<typeof sAddLayoutRequest>;
@@ -123,6 +97,7 @@ export declare const sUpdateLayoutRequest: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     name?: string | undefined;
     order?: number | undefined;
+    isDefault?: boolean | undefined;
     devices?: {
         scale: number;
         x: number;
@@ -132,13 +107,13 @@ export declare const sUpdateLayoutRequest: z.ZodObject<{
         fov: number;
         far: number;
     }[] | undefined;
-    isDefault?: boolean | undefined;
+    colorize?: 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;
@@ -148,86 +123,10 @@ export declare const sUpdateLayoutRequest: z.ZodObject<{
         fov: number;
         far: number;
     }[] | undefined;
-    isDefault?: boolean | undefined;
+    colorize?: boolean | undefined;
     thumbnailId?: string | undefined;
     imageId?: string | undefined;
-    colorize?: boolean | undefined;
 }>;
 export type UpdateLayoutRequest = {
     id: string;
 } & z.infer<typeof sUpdateLayoutRequest>;
-export declare const sLayoutDto: z.ZodObject<{
-    id: z.ZodString;
-    name: z.ZodString;
-    thumbnailUrl: z.ZodString;
-    imageUrl: z.ZodString;
-    order: z.ZodNumber;
-    isDefault: z.ZodBoolean;
-    devices: z.ZodArray<z.ZodObject<{
-        deviceId: z.ZodString;
-        x: z.ZodNumber;
-        y: z.ZodNumber;
-        scale: z.ZodNumber;
-        rotation: z.ZodNumber;
-        fov: z.ZodNumber;
-        far: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        scale: number;
-        x: number;
-        y: number;
-        deviceId: string;
-        rotation: number;
-        fov: number;
-        far: number;
-    }, {
-        scale: number;
-        x: number;
-        y: number;
-        deviceId: string;
-        rotation: number;
-        fov: number;
-        far: number;
-    }>, "many">;
-    colorize: z.ZodBoolean;
-    createdOn: z.ZodString;
-    lastModifiedOn: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    name: string;
-    id: string;
-    order: number;
-    devices: {
-        scale: number;
-        x: number;
-        y: number;
-        deviceId: string;
-        rotation: number;
-        fov: number;
-        far: number;
-    }[];
-    isDefault: boolean;
-    createdOn: string;
-    lastModifiedOn: string;
-    colorize: boolean;
-    thumbnailUrl: string;
-    imageUrl: string;
-}, {
-    name: string;
-    id: string;
-    order: number;
-    devices: {
-        scale: number;
-        x: number;
-        y: number;
-        deviceId: string;
-        rotation: number;
-        fov: number;
-        far: number;
-    }[];
-    isDefault: boolean;
-    createdOn: string;
-    lastModifiedOn: string;
-    colorize: boolean;
-    thumbnailUrl: string;
-    imageUrl: string;
-}>;
-export type LayoutDto = z.infer<typeof sLayoutDto>;

package/dist/api/rest/layout.js

@@ -0,0 +1,19 @@
+import { sLayoutDeviceDto } from '../../objects/layout';
+import z from 'zod';
+export const sAddLayoutRequest = z.object({
+    name: z.string().nonempty(),
+    thumbnailId: z.string().nonempty(),
+    imageId: z.string().nonempty(),
+    order: z.number().optional(),
+    devices: z.array(sLayoutDeviceDto),
+    colorize: z.boolean(),
+});
+export const sUpdateLayoutRequest = z.object({
+    name: z.string().optional(),
+    thumbnailId: z.string().optional(),
+    imageId: z.string().optional(),
+    order: z.number().optional(),
+    isDefault: z.boolean().optional(),
+    devices: z.array(sLayoutDeviceDto).optional(),
+    colorize: z.boolean().optional(),
+});

package/dist/{macros.d.ts → api/rest/macros.d.ts}

@@ -1,84 +1,4 @@
 import { z } from 'zod';
-export declare const sMacroItemDto: z.ZodObject<{
-    id: z.ZodNullable<z.ZodString>;
-    stepId: z.ZodString;
-    deviceId: z.ZodString;
-    command: z.ZodString;
-    params: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-}, "strip", z.ZodTypeAny, {
-    id: string | null;
-    params: Record<string, unknown>;
-    deviceId: string;
-    command: string;
-    stepId: string;
-}, {
-    id: string | null;
-    params: Record<string, unknown>;
-    deviceId: string;
-    command: string;
-    stepId: string;
-}>;
-export declare const sMacroDto: z.ZodObject<{
-    id: z.ZodString;
-    displayName: z.ZodString;
-    code: z.ZodNullable<z.ZodString>;
-    module: z.ZodNullable<z.ZodString>;
-    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-    createdOn: z.ZodString;
-    lastModifiedOn: z.ZodString;
-    createdBy: z.ZodNullable<z.ZodString>;
-    items: z.ZodArray<z.ZodObject<{
-        id: z.ZodNullable<z.ZodString>;
-        stepId: z.ZodString;
-        deviceId: z.ZodString;
-        command: z.ZodString;
-        params: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-    }, "strip", z.ZodTypeAny, {
-        id: string | null;
-        params: Record<string, unknown>;
-        deviceId: string;
-        command: string;
-        stepId: string;
-    }, {
-        id: string | null;
-        params: Record<string, unknown>;
-        deviceId: string;
-        command: string;
-        stepId: string;
-    }>, "many">;
-}, "strip", z.ZodTypeAny, {
-    code: string | null;
-    id: string;
-    module: string | null;
-    metadata: Record<string, unknown>;
-    items: {
-        id: string | null;
-        params: Record<string, unknown>;
-        deviceId: string;
-        command: string;
-        stepId: string;
-    }[];
-    displayName: string;
-    createdOn: string;
-    lastModifiedOn: string;
-    createdBy: string | null;
-}, {
-    code: string | null;
-    id: string;
-    module: string | null;
-    metadata: Record<string, unknown>;
-    items: {
-        id: string | null;
-        params: Record<string, unknown>;
-        deviceId: string;
-        command: string;
-        stepId: string;
-    }[];
-    displayName: string;
-    createdOn: string;
-    lastModifiedOn: string;
-    createdBy: string | null;
-}>;
 export declare const sAddMacroRequest: z.ZodObject<Omit<{
     id: z.ZodString;
     displayName: z.ZodString;
@@ -181,7 +101,5 @@ export declare const sUpdateMacroRequest: z.ZodObject<{
     }[] | undefined;
     displayName?: string | undefined;
 }>;
-export type MacroItemDto = z.infer<typeof sMacroItemDto>;
-export type MacroDto = z.infer<typeof sMacroDto>;
 export type AddMacroRequest = z.infer<typeof sAddMacroRequest>;
 export type UpdateMacroRequest = z.infer<typeof sUpdateMacroRequest>;

package/dist/api/rest/macros.js

@@ -0,0 +1,8 @@
+import { sMacroDto } from '../../objects/macro';
+export const sAddMacroRequest = sMacroDto.omit({
+    id: true,
+    createdOn: true,
+    lastModifiedOn: true,
+    createdBy: true,
+});
+export const sUpdateMacroRequest = sAddMacroRequest.partial();

package/dist/api/rest/media.js

@@ -0,0 +1,65 @@
+import { z } from 'zod';
+import { sPaginatedQueryResponseOf } from './query';
+export const sCreateExportRequest = z.object({
+    name: z.string().nonempty(),
+    deviceId: z.string().nonempty(),
+    timeFrom: z.number().nonnegative(),
+    timeTo: z.number().nonnegative(),
+});
+export const sCreateExportResponse = z.object({
+    exportId: z.string().nonempty(),
+});
+export const sRecordingSequence = z.object({
+    start: z.number().nonnegative(),
+    end: z.number().nonnegative(),
+    motion: z.number().optional(),
+    objects: z.number().optional(),
+});
+export const sGetRecordingsRequest = z.object({
+    deviceId: z.string().nonempty(),
+    timeFrom: z.number().nonnegative(),
+    timeTo: z.number().nonnegative(),
+});
+export const sGetRecordingsResponse = sPaginatedQueryResponseOf(sRecordingSequence);
+export const sGetPreviewImageRequest = z.object({
+    deviceId: z.string().nonempty(),
+    time: z.number().nonnegative(),
+    height: z.number().nonnegative(),
+});
+export const sGetScenePreviewClipRequest = z.object({
+    deviceId: z.string().nonempty(),
+    providerAssignedRef: z.string().nonempty(),
+});
+export const sGetObjectSnapshotRequest = z.object({
+    deviceId: z.string().nonempty(),
+    providerAssignedRef: z.string().nonempty(),
+    crop: z.boolean(),
+    boxes: z.boolean(),
+    height: z.number().nonnegative().optional(),
+    quality: z.number().nonnegative().optional(),
+});
+export const sGetObjectThumbnailRequest = z.object({
+    deviceId: z.string().nonempty(),
+    providerAssignedRef: z.string().nonempty(),
+});
+export const sSortOptions = z.union([
+    z.literal('time_asc'),
+    z.literal('time_desc'),
+]);
+export const sMediaSearchQueryDto = z
+    .object({
+    limit: z.number().nonnegative(),
+    q: z.string(),
+    deviceId: z.array(z.string().nonempty()),
+    similarTo: z.string().optional(),
+    label: z.array(z.string().nonempty()),
+    timeFrom: z.number().nonnegative(),
+    timeTo: z.number().nonnegative(),
+    sortBy: sSortOptions,
+})
+    .partial();
+export const sGetLatestFrameRequest = z.object({
+    deviceId: z.string().nonempty(),
+    width: z.number().nonnegative(),
+    height: z.number().nonnegative(),
+});

package/dist/api/rest/module-config.d.ts

@@ -0,0 +1,19 @@
+import { JSONSchema4 } from 'json-schema';
+import { UiHint } from '../../objects';
+export interface SaveProviderConfigRq {
+    provider: string;
+    enabled: boolean;
+    config: Record<string, unknown>;
+}
+export interface ConfigIssue {
+    paths: string[];
+    message: string;
+    provider: string;
+}
+export interface ModuleConfigSpecs {
+    provider: string;
+    title: string;
+    schema: JSONSchema4;
+    default: Record<string, unknown>;
+    uiHints?: UiHint[];
+}

package/dist/api/rest/module-config.js

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

package/dist/api/rest/notifications.d.ts

@@ -0,0 +1,21 @@
+import { z } from 'zod';
+export declare const sNotificationSearchParams: z.ZodObject<{
+    deviceId: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    severity: z.ZodOptional<z.ZodArray<z.ZodEnum<["info", "warning", "critical"]>, "many">>;
+    acknowledged: z.ZodOptional<z.ZodBoolean>;
+    timeFrom: z.ZodOptional<z.ZodNumber>;
+    timeTo: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    deviceId?: string[] | undefined;
+    severity?: ("info" | "warning" | "critical")[] | undefined;
+    timeFrom?: number | undefined;
+    timeTo?: number | undefined;
+    acknowledged?: boolean | undefined;
+}, {
+    deviceId?: string[] | undefined;
+    severity?: ("info" | "warning" | "critical")[] | undefined;
+    timeFrom?: number | undefined;
+    timeTo?: number | undefined;
+    acknowledged?: boolean | undefined;
+}>;
+export type NotificationSearchParams = z.infer<typeof sNotificationSearchParams>;

package/dist/api/rest/notifications.js

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+import { sDeviceId, sNotificationSeverity } from '../../primitives';
+export const sNotificationSearchParams = z.object({
+    deviceId: z.array(sDeviceId).optional(),
+    severity: z.array(sNotificationSeverity).optional(),
+    acknowledged: z.boolean().optional(),
+    timeFrom: z.number().int().nonnegative().optional(),
+    timeTo: z.number().int().nonnegative().optional(),
+});

package/dist/api/rest/person-agreement.d.ts

@@ -0,0 +1,15 @@
+import z from 'zod';
+export declare const sCreatePersonAgreementRequest: z.ZodObject<{
+    personId: z.ZodString;
+    agreementId: z.ZodString;
+    agreementImage: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    personId: string;
+    agreementId: string;
+    agreementImage: string;
+}, {
+    personId: string;
+    agreementId: string;
+    agreementImage: string;
+}>;
+export type CreatePersonAgreementRequest = z.infer<typeof sCreatePersonAgreementRequest>;

package/dist/api/rest/person-agreement.js

@@ -0,0 +1,6 @@
+import z from 'zod';
+export const sCreatePersonAgreementRequest = z.object({
+    personId: z.string(),
+    agreementId: z.string(),
+    agreementImage: z.string(),
+});

package/dist/api/rest/person-presence.d.ts

@@ -0,0 +1,72 @@
+import { z } from 'zod';
+export declare const sPersonPresenceQuery: z.ZodObject<{
+    persons: z.ZodArray<z.ZodString, "many">;
+    zones: z.ZodArray<z.ZodString, "many">;
+    online: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    online: boolean;
+    persons: string[];
+    zones: string[];
+}, {
+    online: boolean;
+    persons: string[];
+    zones: string[];
+}>;
+export type PersonPresenceQuery = z.infer<typeof sPersonPresenceQuery>;
+export declare const sPersonTogglePresence: z.ZodUnion<[z.ZodObject<{
+    personId: z.ZodString;
+    zoneId: z.ZodString;
+    credentialToken: z.ZodUndefined;
+}, "strip", z.ZodTypeAny, {
+    personId: string;
+    zoneId: string;
+    credentialToken?: undefined;
+}, {
+    personId: string;
+    zoneId: string;
+    credentialToken?: undefined;
+}>, z.ZodObject<{
+    credentialToken: z.ZodString;
+    zoneId: z.ZodString;
+    personId: z.ZodUndefined;
+}, "strip", z.ZodTypeAny, {
+    zoneId: string;
+    credentialToken: string;
+    personId?: undefined;
+}, {
+    zoneId: string;
+    credentialToken: string;
+    personId?: undefined;
+}>]>;
+export declare const sPersonCheckIn: z.ZodObject<{
+    personId: z.ZodString;
+    zoneId: z.ZodString;
+    checkCompleted: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    personId: string;
+    zoneId: string;
+    checkCompleted?: boolean | undefined;
+}, {
+    personId: string;
+    zoneId: string;
+    checkCompleted?: boolean | undefined;
+}>;
+export declare const sPersonCheckOut: z.ZodObject<{
+    personId: z.ZodString;
+    zoneId: z.ZodString;
+    leave: z.ZodNullable<z.ZodBoolean>;
+    checkCompleted: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    personId: string;
+    zoneId: string;
+    leave: boolean | null;
+    checkCompleted?: boolean | undefined;
+}, {
+    personId: string;
+    zoneId: string;
+    leave: boolean | null;
+    checkCompleted?: boolean | undefined;
+}>;
+export type PresenceToggleRequest = z.infer<typeof sPersonTogglePresence>;
+export type PresenceCheckInRequest = z.infer<typeof sPersonCheckIn>;
+export type PresenceCheckOutRequest = z.infer<typeof sPersonCheckOut>;

package/dist/api/rest/person-presence.js

@@ -0,0 +1,29 @@
+import { z } from 'zod';
+export const sPersonPresenceQuery = z.object({
+    persons: z.array(z.string().nonempty()),
+    zones: z.array(z.string().nonempty()),
+    online: z.boolean(),
+});
+export const sPersonTogglePresence = z.union([
+    z.object({
+        personId: z.string(),
+        zoneId: z.string(),
+        credentialToken: z.undefined(),
+    }),
+    z.object({
+        credentialToken: z.string(),
+        zoneId: z.string(),
+        personId: z.undefined(),
+    }),
+]);
+export const sPersonCheckIn = z.object({
+    personId: z.string(),
+    zoneId: z.string(),
+    checkCompleted: z.boolean().optional(),
+});
+export const sPersonCheckOut = z.object({
+    personId: z.string(),
+    zoneId: z.string(),
+    leave: z.boolean().nullable(),
+    checkCompleted: z.boolean().optional(),
+});

package/dist/{access-control → api/rest}/person-type.d.ts

@@ -1,35 +1,4 @@
-import z from 'zod';
-export declare const sPersonTypeDto: z.ZodObject<{
-    id: z.ZodString;
-    displayName: z.ZodString;
-    accessControlUser: z.ZodBoolean;
-    systemUser: z.ZodBoolean;
-    agreements: z.ZodArray<z.ZodString, "many">;
-    securityCheck: z.ZodBoolean;
-    inOnCreation: z.ZodBoolean;
-    createdOn: z.ZodString;
-    lastModifiedOn: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    id: string;
-    displayName: string;
-    createdOn: string;
-    lastModifiedOn: string;
-    agreements: string[];
-    accessControlUser: boolean;
-    systemUser: boolean;
-    securityCheck: boolean;
-    inOnCreation: boolean;
-}, {
-    id: string;
-    displayName: string;
-    createdOn: string;
-    lastModifiedOn: string;
-    agreements: string[];
-    accessControlUser: boolean;
-    systemUser: boolean;
-    securityCheck: boolean;
-    inOnCreation: boolean;
-}>;
+import { z } from 'zod';
 export declare const sCreatePersonTypeRequest: z.ZodObject<Omit<{
     id: z.ZodString;
     displayName: z.ZodString;
@@ -57,7 +26,6 @@ export declare const sCreatePersonTypeRequest: z.ZodObject<Omit<{
     securityCheck: boolean;
     inOnCreation: boolean;
 }>;
-export type PersonTypeDto = z.infer<typeof sPersonTypeDto>;
 export type CreatePersonTypeRequest = z.infer<typeof sCreatePersonTypeRequest>;
 export declare const sUpdatePersonTypeRequest: z.ZodObject<Omit<{
     id: z.ZodOptional<z.ZodString>;

package/dist/api/rest/person-type.js

@@ -0,0 +1,8 @@
+import { sPersonTypeDto } from '../../objects/person-type';
+export const sCreatePersonTypeRequest = sPersonTypeDto.omit({
+    createdOn: true,
+    lastModifiedOn: true,
+});
+export const sUpdatePersonTypeRequest = sCreatePersonTypeRequest
+    .partial()
+    .omit({ id: true });