@awarevue/api-types 2.0.22 → 2.0.23

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

@@ -1,129 +1,4 @@
 import { z } from 'zod';
-export declare const sAutomationRuleCommand: z.ZodObject<{
-    command: z.ZodString;
-    target: z.ZodString;
-    params: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-}, "strip", z.ZodTypeAny, {
-    target: string;
-    params: Record<string, unknown>;
-    command: string;
-}, {
-    target: string;
-    params: Record<string, unknown>;
-    command: string;
-}>;
-export declare const sAutomationRuleBody: z.ZodObject<{
-    onEvent: z.ZodString;
-    runIf: z.ZodOptional<z.ZodString>;
-    commands: z.ZodArray<z.ZodObject<{
-        command: z.ZodString;
-        target: z.ZodString;
-        params: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-    }, "strip", z.ZodTypeAny, {
-        target: string;
-        params: Record<string, unknown>;
-        command: string;
-    }, {
-        target: string;
-        params: Record<string, unknown>;
-        command: string;
-    }>, "many">;
-}, "strip", z.ZodTypeAny, {
-    onEvent: string;
-    commands: {
-        target: string;
-        params: Record<string, unknown>;
-        command: string;
-    }[];
-    runIf?: string | undefined;
-}, {
-    onEvent: string;
-    commands: {
-        target: string;
-        params: Record<string, unknown>;
-        command: string;
-    }[];
-    runIf?: string | undefined;
-}>;
-export declare const sAutomationRuleProps: z.ZodObject<{
-    displayName: z.ZodString;
-    description: z.ZodOptional<z.ZodString>;
-    code: z.ZodNullable<z.ZodString>;
-    body: z.ZodObject<{
-        onEvent: z.ZodString;
-        runIf: z.ZodOptional<z.ZodString>;
-        commands: z.ZodArray<z.ZodObject<{
-            command: z.ZodString;
-            target: z.ZodString;
-            params: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-        }, "strip", z.ZodTypeAny, {
-            target: string;
-            params: Record<string, unknown>;
-            command: string;
-        }, {
-            target: string;
-            params: Record<string, unknown>;
-            command: string;
-        }>, "many">;
-    }, "strip", z.ZodTypeAny, {
-        onEvent: string;
-        commands: {
-            target: string;
-            params: Record<string, unknown>;
-            command: string;
-        }[];
-        runIf?: string | undefined;
-    }, {
-        onEvent: string;
-        commands: {
-            target: string;
-            params: Record<string, unknown>;
-            command: string;
-        }[];
-        runIf?: string | undefined;
-    }>;
-    enabled: z.ZodBoolean;
-    exclusivityGroup: z.ZodNullable<z.ZodString>;
-    score: z.ZodNullable<z.ZodNumber>;
-    module: z.ZodNullable<z.ZodString>;
-    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-}, "strip", z.ZodTypeAny, {
-    code: string | null;
-    module: string | null;
-    body: {
-        onEvent: string;
-        commands: {
-            target: string;
-            params: Record<string, unknown>;
-            command: string;
-        }[];
-        runIf?: string | undefined;
-    };
-    metadata: Record<string, unknown>;
-    displayName: string;
-    enabled: boolean;
-    exclusivityGroup: string | null;
-    score: number | null;
-    description?: string | undefined;
-}, {
-    code: string | null;
-    module: string | null;
-    body: {
-        onEvent: string;
-        commands: {
-            target: string;
-            params: Record<string, unknown>;
-            command: string;
-        }[];
-        runIf?: string | undefined;
-    };
-    metadata: Record<string, unknown>;
-    displayName: string;
-    enabled: boolean;
-    exclusivityGroup: string | null;
-    score: number | null;
-    description?: string | undefined;
-}>;
 export declare const sAddAutomationRuleRequest: z.ZodObject<{
     displayName: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
@@ -286,95 +161,6 @@ export declare const sUpdateAutomationRule: z.ZodObject<{
     exclusivityGroup?: string | null | undefined;
     score?: number | null | undefined;
 }>;
-export declare const sAutomationRuleDto: z.ZodObject<{
-    displayName: z.ZodString;
-    description: z.ZodOptional<z.ZodString>;
-    code: z.ZodNullable<z.ZodString>;
-    body: z.ZodObject<{
-        onEvent: z.ZodString;
-        runIf: z.ZodOptional<z.ZodString>;
-        commands: z.ZodArray<z.ZodObject<{
-            command: z.ZodString;
-            target: z.ZodString;
-            params: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-        }, "strip", z.ZodTypeAny, {
-            target: string;
-            params: Record<string, unknown>;
-            command: string;
-        }, {
-            target: string;
-            params: Record<string, unknown>;
-            command: string;
-        }>, "many">;
-    }, "strip", z.ZodTypeAny, {
-        onEvent: string;
-        commands: {
-            target: string;
-            params: Record<string, unknown>;
-            command: string;
-        }[];
-        runIf?: string | undefined;
-    }, {
-        onEvent: string;
-        commands: {
-            target: string;
-            params: Record<string, unknown>;
-            command: string;
-        }[];
-        runIf?: string | undefined;
-    }>;
-    enabled: z.ZodBoolean;
-    exclusivityGroup: z.ZodNullable<z.ZodString>;
-    score: z.ZodNullable<z.ZodNumber>;
-    module: z.ZodNullable<z.ZodString>;
-    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-} & {
-    id: z.ZodString;
-    createdOn: z.ZodString;
-    lastModifiedOn: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    code: string | null;
-    id: string;
-    module: string | null;
-    body: {
-        onEvent: string;
-        commands: {
-            target: string;
-            params: Record<string, unknown>;
-            command: string;
-        }[];
-        runIf?: string | undefined;
-    };
-    metadata: Record<string, unknown>;
-    displayName: string;
-    createdOn: string;
-    lastModifiedOn: string;
-    enabled: boolean;
-    exclusivityGroup: string | null;
-    score: number | null;
-    description?: string | undefined;
-}, {
-    code: string | null;
-    id: string;
-    module: string | null;
-    body: {
-        onEvent: string;
-        commands: {
-            target: string;
-            params: Record<string, unknown>;
-            command: string;
-        }[];
-        runIf?: string | undefined;
-    };
-    metadata: Record<string, unknown>;
-    displayName: string;
-    createdOn: string;
-    lastModifiedOn: string;
-    enabled: boolean;
-    exclusivityGroup: string | null;
-    score: number | null;
-    description?: string | undefined;
-}>;
 export declare const sAutomationBulkMergeRequest: z.ZodObject<{
     merge: z.ZodArray<z.ZodObject<{
         displayName: z.ZodString;
@@ -499,9 +285,6 @@ export declare const sAutomationBulkMergeRequest: z.ZodObject<{
     }[];
     removeCodes: string[];
 }>;
-export type AutomationRuleBody = z.infer<typeof sAutomationRuleBody>;
-export type AutomationRuleProps = z.infer<typeof sAutomationRuleProps>;
-export type AutomationRuleDto = z.infer<typeof sAutomationRuleDto>;
 export type AddAutomationRuleRequest = z.infer<typeof sAddAutomationRuleRequest>;
 export type UpdateAutomationRuleRequest = z.infer<typeof sUpdateAutomationRule>;
 export type AutomationBulkMergeRequest = z.infer<typeof sAutomationBulkMergeRequest>;

package/dist/api/rest/automation.js

@@ -0,0 +1,14 @@
+import { sAutomationRuleProps } from '../../objects/automation-rule';
+import { z } from 'zod';
+export const sAddAutomationRuleRequest = sAutomationRuleProps;
+export const sUpdateAutomationRule = sAutomationRuleProps.partial().merge(z.object({
+    id: z.string().describe('The ID of the automation rule'),
+}));
+export const sAutomationBulkMergeRequest = z.object({
+    merge: z
+        .array(sAutomationRuleProps)
+        .describe('The automation rules to merge by code'),
+    removeCodes: z
+        .array(z.string())
+        .describe('The IDs of the automation rules to delete by code'),
+});

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

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

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

@@ -1,20 +1,4 @@
 import { z } from 'zod';
-export declare const sBookmarkProps: z.ZodObject<{
-    timestamp: z.ZodNumber;
-    label: z.ZodString;
-    deviceId: z.ZodString;
-    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-}, "strip", z.ZodTypeAny, {
-    label: string;
-    metadata: Record<string, unknown>;
-    deviceId: string;
-    timestamp: number;
-}, {
-    label: string;
-    metadata: Record<string, unknown>;
-    deviceId: string;
-    timestamp: number;
-}>;
 export declare const sCreateBookmarkRq: z.ZodObject<{
     timestamp: z.ZodNumber;
     label: z.ZodString;
@@ -76,37 +60,6 @@ export declare const sDeleteBookmarkRq: z.ZodObject<{
 }, {
     id: string;
 }>;
-export declare const sBookmarkDto: z.ZodIntersection<z.ZodObject<{
-    timestamp: z.ZodNumber;
-    label: z.ZodString;
-    deviceId: z.ZodString;
-    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-}, "strip", z.ZodTypeAny, {
-    label: string;
-    metadata: Record<string, unknown>;
-    deviceId: string;
-    timestamp: number;
-}, {
-    label: string;
-    metadata: Record<string, unknown>;
-    deviceId: string;
-    timestamp: number;
-}>, z.ZodObject<{
-    id: z.ZodString;
-    createdBy: z.ZodString;
-    createdOn: z.ZodString;
-    lastModifiedOn: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    id: string;
-    createdOn: string;
-    lastModifiedOn: string;
-    createdBy: string;
-}, {
-    id: string;
-    createdOn: string;
-    lastModifiedOn: string;
-    createdBy: string;
-}>>;
 export declare const sBookmarkSearchCriteria: z.ZodObject<{
     deviceId: z.ZodArray<z.ZodString, "many">;
     createdBy: z.ZodArray<z.ZodString, "many">;
@@ -123,10 +76,8 @@ export declare const sBookmarkSearchCriteria: z.ZodObject<{
     timeFrom: number;
     timeTo: number;
 }>;
-export type BookmarkProps = z.infer<typeof sBookmarkProps>;
 export type CreateBookmarkRq = z.infer<typeof sCreateBookmarkRq>;
 export type UpdateBookmarkRq = z.infer<typeof sUpdateBookmarkRq>;
 export type UpdateBookmarkBody = z.infer<typeof sUpdateBookmarkBody>;
 export type DeleteBookmarkRq = z.infer<typeof sDeleteBookmarkRq>;
-export type BookmarkDto = z.infer<typeof sBookmarkDto>;
 export type BookmarkSearchCriteria = z.infer<typeof sBookmarkSearchCriteria>;

package/dist/api/rest/bookmarks.js

@@ -0,0 +1,18 @@
+import { sBookmarkProps } from '../../objects/bookmark';
+import { z } from 'zod';
+export const sCreateBookmarkRq = sBookmarkProps;
+export const sUpdateBookmarkBody = sBookmarkProps.partial();
+export const sUpdateBookmarkRq = z
+    .object({
+    id: z.string().nonempty(),
+})
+    .and(sUpdateBookmarkBody);
+export const sDeleteBookmarkRq = z.object({
+    id: z.string().nonempty(),
+});
+export const sBookmarkSearchCriteria = z.object({
+    deviceId: z.array(z.string()),
+    createdBy: z.array(z.string()),
+    timeFrom: z.number().min(0),
+    timeTo: z.number().min(0),
+});

package/dist/api/rest/cast.js

@@ -0,0 +1,7 @@
+import z from 'zod';
+export const sCastCamerasRequest = z
+    .array(z.object({
+    cameraId: z.string().nonempty(),
+    streamId: z.string().nonempty(),
+}))
+    .min(1);

package/dist/{custom-field.d.ts → api/rest/custom-field.d.ts}

@@ -1,22 +1,5 @@
+import { CustomFieldDto } from '../../objects/custom-field';
 import { z } from 'zod';
-export declare const CustomFieldTypeEnum: z.ZodEnum<["string", "number", "boolean", "date"]>;
-export declare const CustomFieldExtendsTypeEnum: z.ZodEnum<["person"]>;
-export declare const sCustomFieldDto: z.ZodObject<{
-    id: z.ZodString;
-    name: z.ZodString;
-    type: z.ZodEnum<["string", "number", "boolean", "date"]>;
-    extendsType: z.ZodEnum<["person"]>;
-}, "strip", z.ZodTypeAny, {
-    name: string;
-    type: "string" | "number" | "boolean" | "date";
-    id: string;
-    extendsType: "person";
-}, {
-    name: string;
-    type: "string" | "number" | "boolean" | "date";
-    id: string;
-    extendsType: "person";
-}>;
 export declare const sAddCustomFieldRequest: z.ZodObject<Omit<{
     id: z.ZodString;
     name: z.ZodString;
@@ -44,7 +27,6 @@ export declare const sUpdateCustomFieldRequest: z.ZodObject<{
     type?: "string" | "number" | "boolean" | "date" | undefined;
     extendsType?: "person" | undefined;
 }>;
-export type CustomFieldDto = z.infer<typeof sCustomFieldDto>;
 export type AddCustomFieldRequest = z.infer<typeof sAddCustomFieldRequest>;
 export type UpdateCustomFieldRequest = z.infer<typeof sUpdateCustomFieldRequest>;
 export type CustomFieldRequestQueryParams = {

package/dist/api/rest/custom-field.js

@@ -0,0 +1,3 @@
+import { sCustomFieldDto } from '../../objects/custom-field';
+export const sAddCustomFieldRequest = sCustomFieldDto.omit({ id: true });
+export const sUpdateCustomFieldRequest = sAddCustomFieldRequest.partial();

package/dist/{device-event.d.ts → api/rest/device-event.d.ts}

@@ -1,4 +1,4 @@
-import { AnyDeviceEvent } from './events';
+import { AnyDeviceEvent } from '../events';
 export interface EventSearchQueryDto {
     deviceId?: string[];
     kind?: string[];

package/dist/api/rest/device-event.js

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

package/dist/{device-group.d.ts → api/rest/device-group.d.ts}

@@ -1,27 +1,4 @@
 import z from 'zod';
-export declare const sDeviceGroup: z.ZodObject<{
-    id: z.ZodString;
-    code: z.ZodNullable<z.ZodString>;
-    displayName: z.ZodString;
-    createdOn: z.ZodString;
-    lastModifiedOn: z.ZodString;
-    devices: z.ZodArray<z.ZodString, "many">;
-}, "strip", z.ZodTypeAny, {
-    code: string | null;
-    id: string;
-    displayName: string;
-    devices: string[];
-    createdOn: string;
-    lastModifiedOn: string;
-}, {
-    code: string | null;
-    id: string;
-    displayName: string;
-    devices: string[];
-    createdOn: string;
-    lastModifiedOn: string;
-}>;
-export type DeviceGroupDto = z.infer<typeof sDeviceGroup>;
 export declare const sAddGroupRequest: z.ZodObject<{
     code: z.ZodNullable<z.ZodString>;
     displayName: z.ZodString;

package/dist/api/rest/device-group.js

@@ -0,0 +1,17 @@
+import z from 'zod';
+export const sAddGroupRequest = z.object({
+    code: z.string().nullable(),
+    displayName: z.string().nonempty(),
+    devices: z.array(z.string().nonempty()),
+});
+export const sUpdateGroupRequest = z.object({
+    code: z.string().nullable().optional(),
+    displayName: z.string().optional(),
+    devices: z.array(z.string().nonempty()).optional(),
+});
+export const sAddDevicesToGroupRequest = z.object({
+    devices: z.array(z.string().nonempty()),
+});
+export const sRemoveDevicesFromGroupRequest = z.object({
+    devices: z.array(z.string().nonempty()),
+});

package/dist/api/rest/file.js

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

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

@@ -0,0 +1,34 @@
+export * from './access-rule';
+export * from '../../objects/credential';
+export * from './schedule';
+export * from './person';
+export * from './zone';
+export * from './person-presence';
+export * from './person-type';
+export * from './agreement';
+export * from './person-agreement';
+export * from './alarm';
+export * from './auth';
+export * from './media';
+export * from './query';
+export * from './api-keys';
+export * from './app';
+export * from './automation';
+export * from './aware-config';
+export * from './bookmarks';
+export * from './cast';
+export * from './custom-field';
+export * from './device-event';
+export * from './device-group';
+export * from './file';
+export * from './layout';
+export * from './macros';
+export * from './module-config';
+export * from './notifications';
+export * from './security-level';
+export * from './template';
+export * from './token-conversion';
+export * from './user';
+export * from './view';
+export * from './webrtc-playback';
+export * from './io-device';

package/dist/api/rest/index.js

@@ -0,0 +1,34 @@
+export * from './access-rule';
+export * from '../../objects/credential';
+export * from './schedule';
+export * from './person';
+export * from './zone';
+export * from './person-presence';
+export * from './person-type';
+export * from './agreement';
+export * from './person-agreement';
+export * from './alarm';
+export * from './auth';
+export * from './media';
+export * from './query';
+export * from './api-keys';
+export * from './app';
+export * from './automation';
+export * from './aware-config';
+export * from './bookmarks';
+export * from './cast';
+export * from './custom-field';
+export * from './device-event';
+export * from './device-group';
+export * from './file';
+export * from './layout';
+export * from './macros';
+export * from './module-config';
+export * from './notifications';
+export * from './security-level';
+export * from './template';
+export * from './token-conversion';
+export * from './user';
+export * from './view';
+export * from './webrtc-playback';
+export * from './io-device';

package/dist/{device-factory.d.ts → api/rest/io-device.d.ts}

@@ -1,5 +1,5 @@
 import z from 'zod';
-import { DeviceType } from './device/any-device';
+import { DeviceType } from '../../objects/device/any-device';
 export declare const sIoSlot: z.ZodObject<{
     deviceId: z.ZodString;
     slot: z.ZodString;

package/dist/api/rest/io-device.js

@@ -0,0 +1,19 @@
+import z from 'zod';
+export const sIoSlot = z.object({
+    deviceId: z.string().nonempty(),
+    slot: z.string().nonempty(),
+    inverted: z.boolean().optional(),
+});
+export const sInputBindings = z.record(sIoSlot);
+export const sOutputBindings = z.record(sIoSlot);
+export const isDeviceFactoryProviderMetadata = (obj) => {
+    return obj && obj.templateName && typeof obj.templateName === 'string';
+};
+export const sAddCustomDeviceRequest = z.object({
+    name: z.string().nonempty(),
+    templateName: z.string().nonempty(),
+});
+export const sUpdateCustomDeviceRequest = z.object({
+    inputBindings: sInputBindings,
+    outputBindings: sOutputBindings,
+});