@awarevue/api-types 1.1.15 → 2.0.2

package/dist/primitives.d.ts

@@ -7,3 +7,599 @@ export declare const sZoneId: z.ZodString;
 export declare const sMacroId: z.ZodString;
 export declare const sDuration: z.ZodNumber;
 export declare const sUrl: z.ZodString;
+export declare const sFileResponse: z.ZodNullable<z.ZodObject<{
+    mimeType: z.ZodString;
+    data: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    data: string;
+    mimeType: string;
+}, {
+    data: string;
+    mimeType: string;
+}>>;
+export declare const sAgentDeviceInfo: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
+    name: z.ZodString;
+    foreignRef: z.ZodString;
+    provider: z.ZodString;
+    providerMetadata: z.ZodObject<{}, "strip", z.ZodUnknown, z.objectOutputType<{}, z.ZodUnknown, "strip">, z.objectInputType<{}, z.ZodUnknown, "strip">>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    foreignRef: string;
+    provider: string;
+    providerMetadata: {} & {
+        [k: string]: unknown;
+    };
+}, {
+    name: string;
+    foreignRef: string;
+    provider: string;
+    providerMetadata: {} & {
+        [k: string]: unknown;
+    };
+}>, z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"alarm">;
+}, "strip", z.ZodTypeAny, {
+    type: "alarm";
+}, {
+    type: "alarm";
+}>, z.ZodObject<{
+    lensType: z.ZodEnum<["flat", "fisheye"]>;
+    mountPoint: z.ZodEnum<["wall", "ceiling", "floor"]>;
+    ptzCapable: z.ZodBoolean;
+    ptzPanSpeed: z.ZodNumber;
+    ptzTiltSpeed: z.ZodNumber;
+    ptzZoomSpeed: z.ZodNumber;
+    panMin: z.ZodNumber;
+    panMax: z.ZodNumber;
+    tiltMin: z.ZodNumber;
+    tiltMax: z.ZodNumber;
+    zoomMin: z.ZodNumber;
+    zoomMax: z.ZodNumber;
+    recordingCapable: z.ZodBoolean;
+    webrtcPlaybackSource: z.ZodNullable<z.ZodIntersection<z.ZodObject<{
+        kind: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        kind: string;
+    }, {
+        kind: string;
+    }>, z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    streams: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        displayName: z.ZodString;
+        externalPlayerUrl: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        displayName: string;
+        externalPlayerUrl: string | null;
+    }, {
+        id: string;
+        displayName: string;
+        externalPlayerUrl: string | null;
+    }>, "many">;
+    defaultStreamId: z.ZodString;
+} & {
+    type: z.ZodLiteral<"camera">;
+}, "strip", z.ZodTypeAny, {
+    type: "camera";
+    streams: {
+        id: string;
+        displayName: string;
+        externalPlayerUrl: string | null;
+    }[];
+    lensType: "flat" | "fisheye";
+    mountPoint: "wall" | "ceiling" | "floor";
+    ptzCapable: boolean;
+    ptzPanSpeed: number;
+    ptzTiltSpeed: number;
+    ptzZoomSpeed: number;
+    panMin: number;
+    panMax: number;
+    tiltMin: number;
+    tiltMax: number;
+    zoomMin: number;
+    zoomMax: number;
+    recordingCapable: boolean;
+    webrtcPlaybackSource: ({
+        kind: string;
+    } & Record<string, unknown>) | null;
+    defaultStreamId: string;
+}, {
+    type: "camera";
+    streams: {
+        id: string;
+        displayName: string;
+        externalPlayerUrl: string | null;
+    }[];
+    lensType: "flat" | "fisheye";
+    mountPoint: "wall" | "ceiling" | "floor";
+    ptzCapable: boolean;
+    ptzPanSpeed: number;
+    ptzTiltSpeed: number;
+    ptzZoomSpeed: number;
+    panMin: number;
+    panMax: number;
+    tiltMin: number;
+    tiltMax: number;
+    zoomMin: number;
+    zoomMax: number;
+    recordingCapable: boolean;
+    webrtcPlaybackSource: ({
+        kind: string;
+    } & Record<string, unknown>) | null;
+    defaultStreamId: string;
+}>, z.ZodObject<{
+    canReportOpenState: z.ZodBoolean;
+    canReportLockState: z.ZodBoolean;
+    canControlLock: z.ZodBoolean;
+    canRelease: z.ZodBoolean;
+} & {
+    type: z.ZodLiteral<"door">;
+}, "strip", z.ZodTypeAny, {
+    type: "door";
+    canReportOpenState: boolean;
+    canReportLockState: boolean;
+    canControlLock: boolean;
+    canRelease: boolean;
+}, {
+    type: "door";
+    canReportOpenState: boolean;
+    canReportLockState: boolean;
+    canControlLock: boolean;
+    canRelease: boolean;
+}>, z.ZodObject<{
+    inputs: z.ZodArray<z.ZodString, "many">;
+    outputs: z.ZodArray<z.ZodString, "many">;
+} & {
+    type: z.ZodLiteral<"io-board">;
+}, "strip", z.ZodTypeAny, {
+    type: "io-board";
+    inputs: string[];
+    outputs: string[];
+}, {
+    type: "io-board";
+    inputs: string[];
+    outputs: string[];
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"camera-lift">;
+}, "strip", z.ZodTypeAny, {
+    type: "camera-lift";
+}, {
+    type: "camera-lift";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"motion-sensor">;
+}, "strip", z.ZodTypeAny, {
+    type: "motion-sensor";
+}, {
+    type: "motion-sensor";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"panic-button">;
+}, "strip", z.ZodTypeAny, {
+    type: "panic-button";
+}, {
+    type: "panic-button";
+}>, z.ZodObject<{
+    sipUri: z.ZodString;
+    sipUser: z.ZodString;
+    sipPassword: z.ZodString;
+    sipRealm: z.ZodString;
+    remoteExtension: z.ZodString;
+} & {
+    type: z.ZodLiteral<"intercom-terminal">;
+}, "strip", z.ZodTypeAny, {
+    type: "intercom-terminal";
+    sipUri: string;
+    sipUser: string;
+    sipPassword: string;
+    sipRealm: string;
+    remoteExtension: string;
+}, {
+    type: "intercom-terminal";
+    sipUri: string;
+    sipUser: string;
+    sipPassword: string;
+    sipRealm: string;
+    remoteExtension: string;
+}>, z.ZodObject<{
+    sipWsUrl: z.ZodString;
+} & {
+    type: z.ZodLiteral<"pbx">;
+}, "strip", z.ZodTypeAny, {
+    type: "pbx";
+    sipWsUrl: string;
+}, {
+    type: "pbx";
+    sipWsUrl: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"server">;
+}, "strip", z.ZodTypeAny, {
+    type: "server";
+}, {
+    type: "server";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"intercom-operator">;
+}, "strip", z.ZodTypeAny, {
+    type: "intercom-operator";
+}, {
+    type: "intercom-operator";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"device-gateway">;
+}, "strip", z.ZodTypeAny, {
+    type: "device-gateway";
+}, {
+    type: "device-gateway";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"presence-tracker">;
+}, "strip", z.ZodTypeAny, {
+    type: "presence-tracker";
+}, {
+    type: "presence-tracker";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"reader">;
+}, "strip", z.ZodTypeAny, {
+    type: "reader";
+}, {
+    type: "reader";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"display">;
+}, "strip", z.ZodTypeAny, {
+    type: "display";
+}, {
+    type: "display";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"nvr-recorder">;
+}, "strip", z.ZodTypeAny, {
+    type: "nvr-recorder";
+}, {
+    type: "nvr-recorder";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"nvr-exporter">;
+}, "strip", z.ZodTypeAny, {
+    type: "nvr-exporter";
+}, {
+    type: "nvr-exporter";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"nvr-analytics-server">;
+}, "strip", z.ZodTypeAny, {
+    type: "nvr-analytics-server";
+}, {
+    type: "nvr-analytics-server";
+}>]>>, z.ZodObject<{
+    presets: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        params: z.ZodUnknown;
+        isDefault: z.ZodBoolean;
+        assignedRef: z.ZodNullable<z.ZodString>;
+        createdOn: z.ZodString;
+        lastModifiedOn: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        id: string;
+        isDefault: boolean;
+        assignedRef: string | null;
+        createdOn: string;
+        lastModifiedOn: string;
+        params?: unknown;
+    }, {
+        name: string;
+        id: string;
+        isDefault: boolean;
+        assignedRef: string | null;
+        createdOn: string;
+        lastModifiedOn: string;
+        params?: unknown;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    presets: {
+        name: string;
+        id: string;
+        isDefault: boolean;
+        assignedRef: string | null;
+        createdOn: string;
+        lastModifiedOn: string;
+        params?: unknown;
+    }[];
+}, {
+    presets: {
+        name: string;
+        id: string;
+        isDefault: boolean;
+        assignedRef: string | null;
+        createdOn: string;
+        lastModifiedOn: string;
+        params?: unknown;
+    }[];
+}>>;
+export declare const sDeviceParam: z.ZodUnion<[z.ZodString, z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
+    name: z.ZodString;
+    foreignRef: z.ZodString;
+    provider: z.ZodString;
+    providerMetadata: z.ZodObject<{}, "strip", z.ZodUnknown, z.objectOutputType<{}, z.ZodUnknown, "strip">, z.objectInputType<{}, z.ZodUnknown, "strip">>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    foreignRef: string;
+    provider: string;
+    providerMetadata: {} & {
+        [k: string]: unknown;
+    };
+}, {
+    name: string;
+    foreignRef: string;
+    provider: string;
+    providerMetadata: {} & {
+        [k: string]: unknown;
+    };
+}>, z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"alarm">;
+}, "strip", z.ZodTypeAny, {
+    type: "alarm";
+}, {
+    type: "alarm";
+}>, z.ZodObject<{
+    lensType: z.ZodEnum<["flat", "fisheye"]>;
+    mountPoint: z.ZodEnum<["wall", "ceiling", "floor"]>;
+    ptzCapable: z.ZodBoolean;
+    ptzPanSpeed: z.ZodNumber;
+    ptzTiltSpeed: z.ZodNumber;
+    ptzZoomSpeed: z.ZodNumber;
+    panMin: z.ZodNumber;
+    panMax: z.ZodNumber;
+    tiltMin: z.ZodNumber;
+    tiltMax: z.ZodNumber;
+    zoomMin: z.ZodNumber;
+    zoomMax: z.ZodNumber;
+    recordingCapable: z.ZodBoolean;
+    webrtcPlaybackSource: z.ZodNullable<z.ZodIntersection<z.ZodObject<{
+        kind: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        kind: string;
+    }, {
+        kind: string;
+    }>, z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    streams: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        displayName: z.ZodString;
+        externalPlayerUrl: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        displayName: string;
+        externalPlayerUrl: string | null;
+    }, {
+        id: string;
+        displayName: string;
+        externalPlayerUrl: string | null;
+    }>, "many">;
+    defaultStreamId: z.ZodString;
+} & {
+    type: z.ZodLiteral<"camera">;
+}, "strip", z.ZodTypeAny, {
+    type: "camera";
+    streams: {
+        id: string;
+        displayName: string;
+        externalPlayerUrl: string | null;
+    }[];
+    lensType: "flat" | "fisheye";
+    mountPoint: "wall" | "ceiling" | "floor";
+    ptzCapable: boolean;
+    ptzPanSpeed: number;
+    ptzTiltSpeed: number;
+    ptzZoomSpeed: number;
+    panMin: number;
+    panMax: number;
+    tiltMin: number;
+    tiltMax: number;
+    zoomMin: number;
+    zoomMax: number;
+    recordingCapable: boolean;
+    webrtcPlaybackSource: ({
+        kind: string;
+    } & Record<string, unknown>) | null;
+    defaultStreamId: string;
+}, {
+    type: "camera";
+    streams: {
+        id: string;
+        displayName: string;
+        externalPlayerUrl: string | null;
+    }[];
+    lensType: "flat" | "fisheye";
+    mountPoint: "wall" | "ceiling" | "floor";
+    ptzCapable: boolean;
+    ptzPanSpeed: number;
+    ptzTiltSpeed: number;
+    ptzZoomSpeed: number;
+    panMin: number;
+    panMax: number;
+    tiltMin: number;
+    tiltMax: number;
+    zoomMin: number;
+    zoomMax: number;
+    recordingCapable: boolean;
+    webrtcPlaybackSource: ({
+        kind: string;
+    } & Record<string, unknown>) | null;
+    defaultStreamId: string;
+}>, z.ZodObject<{
+    canReportOpenState: z.ZodBoolean;
+    canReportLockState: z.ZodBoolean;
+    canControlLock: z.ZodBoolean;
+    canRelease: z.ZodBoolean;
+} & {
+    type: z.ZodLiteral<"door">;
+}, "strip", z.ZodTypeAny, {
+    type: "door";
+    canReportOpenState: boolean;
+    canReportLockState: boolean;
+    canControlLock: boolean;
+    canRelease: boolean;
+}, {
+    type: "door";
+    canReportOpenState: boolean;
+    canReportLockState: boolean;
+    canControlLock: boolean;
+    canRelease: boolean;
+}>, z.ZodObject<{
+    inputs: z.ZodArray<z.ZodString, "many">;
+    outputs: z.ZodArray<z.ZodString, "many">;
+} & {
+    type: z.ZodLiteral<"io-board">;
+}, "strip", z.ZodTypeAny, {
+    type: "io-board";
+    inputs: string[];
+    outputs: string[];
+}, {
+    type: "io-board";
+    inputs: string[];
+    outputs: string[];
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"camera-lift">;
+}, "strip", z.ZodTypeAny, {
+    type: "camera-lift";
+}, {
+    type: "camera-lift";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"motion-sensor">;
+}, "strip", z.ZodTypeAny, {
+    type: "motion-sensor";
+}, {
+    type: "motion-sensor";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"panic-button">;
+}, "strip", z.ZodTypeAny, {
+    type: "panic-button";
+}, {
+    type: "panic-button";
+}>, z.ZodObject<{
+    sipUri: z.ZodString;
+    sipUser: z.ZodString;
+    sipPassword: z.ZodString;
+    sipRealm: z.ZodString;
+    remoteExtension: z.ZodString;
+} & {
+    type: z.ZodLiteral<"intercom-terminal">;
+}, "strip", z.ZodTypeAny, {
+    type: "intercom-terminal";
+    sipUri: string;
+    sipUser: string;
+    sipPassword: string;
+    sipRealm: string;
+    remoteExtension: string;
+}, {
+    type: "intercom-terminal";
+    sipUri: string;
+    sipUser: string;
+    sipPassword: string;
+    sipRealm: string;
+    remoteExtension: string;
+}>, z.ZodObject<{
+    sipWsUrl: z.ZodString;
+} & {
+    type: z.ZodLiteral<"pbx">;
+}, "strip", z.ZodTypeAny, {
+    type: "pbx";
+    sipWsUrl: string;
+}, {
+    type: "pbx";
+    sipWsUrl: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"server">;
+}, "strip", z.ZodTypeAny, {
+    type: "server";
+}, {
+    type: "server";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"intercom-operator">;
+}, "strip", z.ZodTypeAny, {
+    type: "intercom-operator";
+}, {
+    type: "intercom-operator";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"device-gateway">;
+}, "strip", z.ZodTypeAny, {
+    type: "device-gateway";
+}, {
+    type: "device-gateway";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"presence-tracker">;
+}, "strip", z.ZodTypeAny, {
+    type: "presence-tracker";
+}, {
+    type: "presence-tracker";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"reader">;
+}, "strip", z.ZodTypeAny, {
+    type: "reader";
+}, {
+    type: "reader";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"display">;
+}, "strip", z.ZodTypeAny, {
+    type: "display";
+}, {
+    type: "display";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"nvr-recorder">;
+}, "strip", z.ZodTypeAny, {
+    type: "nvr-recorder";
+}, {
+    type: "nvr-recorder";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"nvr-exporter">;
+}, "strip", z.ZodTypeAny, {
+    type: "nvr-exporter";
+}, {
+    type: "nvr-exporter";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"nvr-analytics-server">;
+}, "strip", z.ZodTypeAny, {
+    type: "nvr-analytics-server";
+}, {
+    type: "nvr-analytics-server";
+}>]>>, z.ZodObject<{
+    presets: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        params: z.ZodUnknown;
+        isDefault: z.ZodBoolean;
+        assignedRef: z.ZodNullable<z.ZodString>;
+        createdOn: z.ZodString;
+        lastModifiedOn: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        id: string;
+        isDefault: boolean;
+        assignedRef: string | null;
+        createdOn: string;
+        lastModifiedOn: string;
+        params?: unknown;
+    }, {
+        name: string;
+        id: string;
+        isDefault: boolean;
+        assignedRef: string | null;
+        createdOn: string;
+        lastModifiedOn: string;
+        params?: unknown;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    presets: {
+        name: string;
+        id: string;
+        isDefault: boolean;
+        assignedRef: string | null;
+        createdOn: string;
+        lastModifiedOn: string;
+        params?: unknown;
+    }[];
+}, {
+    presets: {
+        name: string;
+        id: string;
+        isDefault: boolean;
+        assignedRef: string | null;
+        createdOn: string;
+        lastModifiedOn: string;
+        params?: unknown;
+    }[];
+}>>]>;

package/dist/primitives.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sUrl = exports.sDuration = exports.sMacroId = exports.sZoneId = exports.sPersonId = exports.sDeviceEvent = exports.sPresetId = exports.sDeviceId = void 0;
+exports.sDeviceParam = exports.sAgentDeviceInfo = exports.sFileResponse = exports.sUrl = exports.sDuration = exports.sMacroId = exports.sZoneId = exports.sPersonId = exports.sDeviceEvent = exports.sPresetId = exports.sDeviceId = void 0;
 const zod_1 = require("zod");
+const device_1 = require("./device");
 exports.sDeviceId = zod_1.z.string().uuid().nonempty();
 exports.sPresetId = zod_1.z.string().uuid().nonempty();
 exports.sDeviceEvent = zod_1.z.record(zod_1.z.unknown());
@@ -11,3 +12,14 @@ exports.sMacroId = zod_1.z.string().uuid().nonempty();
 // general
 exports.sDuration = zod_1.z.number().min(0).describe('Duration in milliseconds');
 exports.sUrl = zod_1.z.string().url().describe('A valid URL');
+exports.sFileResponse = zod_1.z
+    .object({
+    mimeType: zod_1.z.string().nonempty(),
+    data: zod_1.z.string().nonempty(),
+})
+    .nullable();
+exports.sAgentDeviceInfo = device_1.sForeignDeviceInfo.and(device_1.sAnyDeviceSpecs).and(zod_1.z.object({
+    presets: zod_1.z.array(device_1.sPresetDto),
+}));
+// reusable device argument. This schema can be checked at runtime to see if it's a device ID or full device info and substituted accordingly.
+exports.sDeviceParam = exports.sDeviceId.or(exports.sAgentDeviceInfo);