@awarevue/api-types 1.0.1

package/dist/agent-communication/protocol.js

@@ -0,0 +1,341 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isMessageFromAgent = exports.getAgentMessageIssues = exports.abortChange = exports.sApplyChangeProgress = exports.sApplyChangeComplete = exports.sApplyChange = exports.sValidateChangeRs = exports.sChangeIssue = exports.sValidateChangeRq = exports.sDeviceMap = exports.sAccessMutation = exports.sRelationMerge = exports.sObjectDelete = exports.sObjectMerge = exports.sRegisterAccessControlAgentRs = exports.sRegisterAccessControlAgentRq = exports.sCapabilityReport = exports.sTokenSpecs = exports.sAccessObjectKind = exports.sGetAvailableDevicesRs = exports.sGetAvailableDevicesRq = exports.sPushEventRs = exports.sPushEventRq = exports.sPushStateUpdateRs = exports.sPushStateUpdateRq = exports.sRunCommandRs = exports.sRunCommandRq = exports.sStopServiceRs = exports.sStopServiceRq = exports.sStartServiceRs = exports.sStartServiceRq = exports.sValidateProviderConfigRs = exports.sConfigurationIssue = exports.sValidateProviderConfigRq = exports.sUnregister = exports.sRegisterRs = exports.sRegisterRq = exports.sProviderSpecs = exports.sUiHint = exports.sUiWidgetHint = exports.sUiOrderHint = exports.sErrorPayload = exports.sResponsePayload = exports.sMessageWithPayload = exports.sMessageHeader = void 0;
+const device_1 = require("../device");
+const device_import_1 = require("../device-import");
+const zod_1 = require("zod");
+// PROTOCOL ENVELOPE
+exports.sMessageHeader = zod_1.z.object({
+    version: zod_1.z.number().describe('Protocol version'),
+    id: zod_1.z.string().nonempty('ID is required').describe('Unique message ID'),
+    from: zod_1.z
+        .string()
+        .nonempty('Agent name required')
+        .describe("Sender ID (Agent ID or 'server')"),
+    on: zod_1.z.number().describe('Timestamp in milliseconds since epoch'),
+});
+const sMessageWithPayload = (sPayload) => exports.sMessageHeader.and(sPayload).describe('Message with payload');
+exports.sMessageWithPayload = sMessageWithPayload;
+const sResponsePayload = (kind, sPayload) => 
+// success branch
+zod_1.z.object({ requestId: zod_1.z.string().nonempty(), kind }).and(sPayload);
+exports.sResponsePayload = sResponsePayload;
+exports.sErrorPayload = (0, exports.sResponsePayload)(zod_1.z.literal('error-rs'), zod_1.z.object({
+    error: zod_1.z.string().nonempty().describe('Error message if request failed'),
+}));
+// REGISTER
+exports.sUiOrderHint = zod_1.z.object({
+    kind: zod_1.z.literal('order'),
+    path: zod_1.z.string(),
+    fields: zod_1.z.array(zod_1.z.string().nonempty()),
+});
+exports.sUiWidgetHint = zod_1.z.object({
+    kind: zod_1.z.literal('widget'),
+    path: zod_1.z.string(),
+    spanColumns: zod_1.z.number().optional(),
+    password: zod_1.z.boolean().optional(),
+    placeHolder: zod_1.z.string().optional(),
+});
+exports.sUiHint = zod_1.z.union([exports.sUiOrderHint, exports.sUiWidgetHint]);
+exports.sProviderSpecs = zod_1.z.object({
+    title: zod_1.z
+        .string()
+        .nonempty()
+        .describe('a human-readable name for the provider'),
+    configSchema: zod_1.z
+        .unknown()
+        .describe('a valid JSON schema that describes provider config data structure'), // We can use AJV to validate the definition of a JSON schema
+    configDefault: zod_1.z
+        .record(zod_1.z.unknown())
+        .describe('Default initialized values for configuration'),
+    configFormUiHints: zod_1.z
+        .array(exports.sUiHint)
+        .optional()
+        .describe('UI hints for configuration form visuals'),
+});
+exports.sRegisterRq = zod_1.z.object({
+    kind: zod_1.z.literal('register'),
+    providers: zod_1.z
+        .record(exports.sProviderSpecs)
+        .describe('Map of providers and their specs, ones that the agent can handle'),
+});
+exports.sRegisterRs = (0, exports.sResponsePayload)(zod_1.z.literal('register-rs'), zod_1.z.object({}));
+// UNREGISTER
+exports.sUnregister = zod_1.z
+    .object({
+    kind: zod_1.z.literal('unregister'),
+    provider: zod_1.z.string().nonempty(),
+})
+    .describe('Request to unregister a provider');
+// VALIDATE PROVIDER CONFIG
+exports.sValidateProviderConfigRq = zod_1.z.object({
+    kind: zod_1.z.literal('validate-config'),
+    provider: zod_1.z.string().nonempty(),
+    config: zod_1.z.record(zod_1.z.unknown()),
+});
+exports.sConfigurationIssue = zod_1.z
+    .object({
+    paths: zod_1.z.array(zod_1.z.string()),
+    message: zod_1.z.string(),
+})
+    .describe('A configuration issue that can be reported by agents');
+exports.sValidateProviderConfigRs = (0, exports.sResponsePayload)(zod_1.z.literal('validate-config-rs'), zod_1.z.object({
+    issues: zod_1.z.array(exports.sConfigurationIssue),
+})).describe('Validation result for provider configuration');
+// START SERVICE
+exports.sStartServiceRq = zod_1.z
+    .object({
+    kind: zod_1.z.literal('start'),
+    provider: zod_1.z.string().nonempty(),
+    config: zod_1.z.record(zod_1.z.unknown()),
+    lastEventForeignRef: zod_1.z
+        .string()
+        .nullable()
+        .describe('Last event foreign reference that the agent should start from'),
+    lastEventTimestamp: zod_1.z
+        .number()
+        .nullable()
+        .describe('Last event timestamp that the agent should start from'),
+})
+    .describe('Request to start a service for a provider');
+exports.sStartServiceRs = (0, exports.sResponsePayload)(zod_1.z.literal('start-rs'), zod_1.z.object({})).describe('Response for starting a service for a provider');
+// STOP SERVICE
+exports.sStopServiceRq = zod_1.z
+    .object({
+    kind: zod_1.z.literal('stop'),
+    provider: zod_1.z.string().nonempty(),
+})
+    .describe('Request to stop a service for a provider');
+exports.sStopServiceRs = (0, exports.sResponsePayload)(zod_1.z.literal('stop-rs'), zod_1.z.object({})).describe('Response for starting a service for a provider');
+// RUN COMMAND
+exports.sRunCommandRq = zod_1.z
+    .object({
+    kind: zod_1.z.literal('command'),
+    device: device_1.sForeignDeviceInfo,
+    command: zod_1.z.string().nonempty(),
+    batchId: zod_1.z
+        .string()
+        .optional()
+        .describe('Batch ID for the command of the command was part of a macro'),
+    params: zod_1.z.record(zod_1.z.unknown()).optional(),
+})
+    .describe('Request to run a device command');
+exports.sRunCommandRs = (0, exports.sResponsePayload)(zod_1.z.literal('command-rs'), zod_1.z.object({})).describe('Response for running a device command');
+// PUSH DEVICE STATE UPDATE
+exports.sPushStateUpdateRq = zod_1.z
+    .object({
+    kind: zod_1.z.literal('state'),
+    foreignRef: zod_1.z.string().nonempty(),
+    provider: zod_1.z.string().nonempty(),
+    mergeProps: zod_1.z.record(zod_1.z.unknown()),
+    removeProps: zod_1.z.array(zod_1.z.string().nonempty()),
+})
+    .describe('Request to push a device state update');
+exports.sPushStateUpdateRs = (0, exports.sResponsePayload)(zod_1.z.literal('state-rs'), zod_1.z.object({})).describe('Response for pushing a device state update');
+// PUSH DEVICE EVENT
+exports.sPushEventRq = zod_1.z
+    .object({
+    kind: zod_1.z.literal('event'),
+    foreignRef: zod_1.z.string().nonempty(),
+    provider: zod_1.z.string().nonempty(),
+    eventTimestamp: zod_1.z
+        .number()
+        .describe('Event timestamp in milliseconds since epoch, as reported by origin'),
+    eventForeignRef: zod_1.z.string().nonempty(),
+    event: zod_1.z.unknown().describe('Event data'),
+})
+    .describe('Request to push a device event');
+exports.sPushEventRs = (0, exports.sResponsePayload)(zod_1.z.literal('event-rs'), zod_1.z.object({})).describe('Response for pushing a device event');
+// REQUEST AVAILABLE DEVICES (DISCOVERY)
+exports.sGetAvailableDevicesRq = zod_1.z
+    .object({
+    kind: zod_1.z.literal('get-available-devices'),
+    provider: zod_1.z.string().nonempty(),
+})
+    .describe('Request to get available devices from a provider via an agent');
+exports.sGetAvailableDevicesRs = (0, exports.sResponsePayload)(zod_1.z.literal('get-available-devices-rs'), device_import_1.sDeviceDiscoveryDto).describe('Response for getting available devices from a provider via an agent');
+// REGISTER ACCESS CONTROL AGENT
+exports.sAccessObjectKind = zod_1.z.enum([
+    'access-rule',
+    'schedule',
+    'zone',
+    'person',
+    'reader',
+]);
+exports.sTokenSpecs = zod_1.z.object({
+    type: zod_1.z.enum(['card', 'pin', 'finger-print', 'face']), // etc, those map to a AWARE-standardized set of token types
+    regex: zod_1.z.string().optional(),
+    formatDescription: zod_1.z.string().optional(),
+    maxPerPerson: zod_1.z.number().optional(),
+});
+exports.sCapabilityReport = zod_1.z.object({
+    tokens: zod_1.z.array(exports.sTokenSpecs),
+    accessbjects: zod_1.z.array(exports.sAccessObjectKind),
+});
+exports.sRegisterAccessControlAgentRq = zod_1.z
+    .object({
+    kind: zod_1.z.literal('register-access-control-agent'),
+    provider: zod_1.z.string().nonempty(),
+})
+    .and(exports.sCapabilityReport);
+exports.sRegisterAccessControlAgentRs = (0, exports.sResponsePayload)(zod_1.z.literal('register-access-control-agent-rs'), zod_1.z.object({})).describe('Response for registering an access control agent');
+// ACCESS SYNC SECTION
+exports.sObjectMerge = zod_1.z
+    .object({
+    kind: zod_1.z.literal('merge'),
+    objectId: zod_1.z
+        .string()
+        .optional()
+        .describe('Object ID as in backend. Can be undefined if object is new to backend and agent is trying to create it'),
+    objectForeignRefs: zod_1.z
+        .array(zod_1.z.string())
+        .describe("Object foreign references as in target provider's repos. Can be undefined if object is new to agent and backend is trying to create it. It can be an array in case one access rule maps to many foreign refs"),
+    objectKind: exports.sAccessObjectKind,
+    props: zod_1.z.record(zod_1.z.unknown()),
+})
+    .describe('Object merge request');
+exports.sObjectDelete = zod_1.z
+    .object({
+    kind: zod_1.z.literal('delete'),
+    objectId: zod_1.z
+        .string()
+        .optional()
+        .describe('Object ID as in backend. Can be undefined if object is new to backend and agent is trying to create it'),
+    objectForeignRefs: zod_1.z
+        .array(zod_1.z.string())
+        .describe("Object foreign reference as in target provider's repos. Can be undefined if object is new to agent and backend is trying to create it"),
+    objectKind: exports.sAccessObjectKind,
+})
+    .describe('Object delete request');
+exports.sRelationMerge = zod_1.z.object({
+    kind: zod_1.z.literal('relation-merge'),
+    left: zod_1.z.object({
+        kind: exports.sAccessObjectKind,
+        objectId: zod_1.z
+            .string()
+            .optional()
+            .describe('Object ID as in backend. Can be undefined if object is new to backend and agent is trying to create it'),
+        objectForeignRefs: zod_1.z
+            .array(zod_1.z.string())
+            .describe("Object foreign reference as in target provider's repos. Can be undefined if object is new to agent and backend is trying to create it"),
+    }),
+    right: zod_1.z.object({
+        kind: exports.sAccessObjectKind,
+        objectId: zod_1.z
+            .string()
+            .optional()
+            .describe('Object ID as in backend. Can be undefined if object is new to backend and agent is trying to create it'),
+        objectForeignRefs: zod_1.z
+            .array(zod_1.z.string())
+            .describe("Object foreign reference as in target provider's repos. Can be undefined if object is new to agent and backend is trying to create it"),
+    }),
+    linkExists: zod_1.z.boolean(),
+});
+exports.sAccessMutation = zod_1.z
+    .union([exports.sObjectMerge, exports.sObjectDelete, exports.sRelationMerge])
+    .describe('Access object change description');
+exports.sDeviceMap = zod_1.z
+    .record(zod_1.z.record(zod_1.z.unknown()))
+    .describe('Map of devices (readers) and their stashed provider metadata');
+// A. VALIDATE ACCESS CHANGES
+exports.sValidateChangeRq = zod_1.z
+    .object({
+    kind: zod_1.z.literal('validate-change'),
+    provider: zod_1.z.string().nonempty(),
+    devices: exports.sDeviceMap,
+    mutations: zod_1.z.array(exports.sAccessMutation),
+})
+    .describe('Request to validate access changes');
+exports.sChangeIssue = zod_1.z
+    .object({
+    objectId: zod_1.z.string().optional(),
+    objectForeignRef: zod_1.z.string().optional(),
+    issue: zod_1.z.string().nonempty(),
+})
+    .describe('Access change issue description');
+exports.sValidateChangeRs = (0, exports.sResponsePayload)(zod_1.z.literal('validate-change-rs'), zod_1.z.object({
+    issues: zod_1.z.array(exports.sChangeIssue),
+})).describe('Response for validating access changes');
+// B. APPLY ACCESS CHANGES
+exports.sApplyChange = zod_1.z
+    .object({
+    kind: zod_1.z.literal('apply-change'),
+    provider: zod_1.z.string().nonempty(),
+    devices: exports.sDeviceMap,
+    mutations: zod_1.z.array(exports.sAccessMutation),
+    policyVersion: zod_1.z.number().describe('Version of the access changes'),
+})
+    .describe('Request to apply access changes');
+exports.sApplyChangeComplete = (0, exports.sResponsePayload)(zod_1.z.literal('apply-change-complete'), zod_1.z.object({
+    policyVersion: zod_1.z.number().describe('Version of the access changes'),
+    error: zod_1.z.string().optional().describe('Error message if request failed'),
+    refs: zod_1.z
+        .record(zod_1.z.record(zod_1.z.string().nonempty()))
+        .describe('Map of foreign references to object IDs'),
+})).describe('Response for applying access changes');
+exports.sApplyChangeProgress = zod_1.z
+    .object({
+    kind: zod_1.z.literal('apply-change-progress'),
+    policyVersion: zod_1.z.number().describe('Version of desired access snapshot'),
+    total: zod_1.z.number().describe('Progress of the access changes'),
+    completed: zod_1.z.number().describe('Progress of the access changes'),
+})
+    .describe('Progress of the access changes');
+// C. ABORT CHANGES
+exports.abortChange = zod_1.z
+    .object({
+    kind: zod_1.z.literal('abort-change'),
+    provider: zod_1.z.string().nonempty(),
+    policyVersion: zod_1.z.number().describe('Version of the access changes'),
+})
+    .describe('Request to abort access changes');
+const fromAgentSchemaByKind = {
+    register: exports.sRegisterRq,
+    unregister: exports.sUnregister,
+    'validate-config-rs': exports.sValidateProviderConfigRs,
+    'start-rs': exports.sStartServiceRs,
+    'stop-rs': exports.sStopServiceRs,
+    'command-rs': exports.sRunCommandRs,
+    state: exports.sPushStateUpdateRq,
+    event: exports.sPushEventRq,
+    'get-available-devices-rs': exports.sGetAvailableDevicesRs,
+    'register-access-control-agent': exports.sRegisterAccessControlAgentRq,
+    'validate-change-rs': exports.sValidateChangeRs,
+    'apply-change-complete': exports.sApplyChangeComplete,
+    'apply-change-progress': exports.sApplyChangeProgress,
+    'error-rs': exports.sErrorPayload,
+};
+const getAgentMessageIssues = (message) => {
+    const result = exports.sMessageHeader.safeParse(message);
+    if (!result.success) {
+        return result.error.errors.map((e) => `${e.path.map((p) => p.toString()).join('.')} - ${e.message}`);
+    }
+    const { kind } = message;
+    const schema = fromAgentSchemaByKind[kind];
+    if (!schema) {
+        return [`Unknown message kind: ${kind}`];
+    }
+    const result2 = schema.safeParse(message);
+    if (!result2.success) {
+        return result2.error.errors.map((e) => e.message);
+    }
+    return [];
+};
+exports.getAgentMessageIssues = getAgentMessageIssues;
+const isMessageFromAgent = (message) => {
+    if (typeof message !== 'object' || message === null) {
+        return false;
+    }
+    const headerResult = exports.sMessageHeader.safeParse(message);
+    if (!headerResult.success) {
+        return false;
+    }
+    const { kind } = message;
+    const schema = fromAgentSchemaByKind[kind];
+    if (!schema) {
+        return false;
+    }
+    const result = schema.safeParse(message);
+    return result.success;
+};
+exports.isMessageFromAgent = isMessageFromAgent;

package/dist/api/alarm.d.ts

@@ -0,0 +1,23 @@
+import { DeviceEvent } from '../device-event';
+export interface AlarmSearchQueryDto {
+    deviceId?: string[];
+    kind?: string[];
+    userId?: string[];
+    personId?: string[];
+    timeFrom?: number;
+    timeTo?: number;
+    offset?: number;
+    limit?: number;
+}
+export interface AlarmSearchItemDto {
+    id: string;
+    triggeredOn: number;
+    acknowledgedOn: number | null;
+    acknowledgedBy: string | null;
+    triggers: {
+        id: string;
+        timestamp: number;
+        deviceId: string;
+        kind: DeviceEvent['kind'];
+    }[];
+}

package/dist/api/alarm.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/auth.d.ts

@@ -0,0 +1,31 @@
+import { z } from 'zod';
+export declare const sLoginByCredentialsRequest: z.ZodObject<{
+    username: z.ZodString;
+    password: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    username: string;
+    password: string;
+}, {
+    username: string;
+    password: string;
+}>;
+export declare const sLoginByRefreshTokenRequest: z.ZodObject<{
+    refreshToken: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    refreshToken: string;
+}, {
+    refreshToken: string;
+}>;
+export declare const sLoginResponse: z.ZodObject<{
+    accessToken: z.ZodString;
+    refreshToken: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    refreshToken: string;
+    accessToken: string;
+}, {
+    refreshToken: string;
+    accessToken: string;
+}>;
+export type LoginByCredentialsRequest = z.infer<typeof sLoginByCredentialsRequest>;
+export type LoginByRefreshTokenRequest = z.infer<typeof sLoginByRefreshTokenRequest>;
+export type LoginResponse = z.infer<typeof sLoginResponse>;

package/dist/api/auth.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sLoginResponse = exports.sLoginByRefreshTokenRequest = exports.sLoginByCredentialsRequest = void 0;
+const zod_1 = require("zod");
+exports.sLoginByCredentialsRequest = zod_1.z.object({
+    username: zod_1.z.string().nonempty('Username must not be empty'),
+    password: zod_1.z.string().nonempty('Password must not be empty'),
+});
+exports.sLoginByRefreshTokenRequest = zod_1.z.object({
+    refreshToken: zod_1.z.string().nonempty('Refresh token must not be empty'),
+});
+exports.sLoginResponse = zod_1.z.object({
+    accessToken: zod_1.z
+        .string()
+        .describe('Access token to be used for authentication with short expiry time. Apply this token in the Authorization header as a Bearer token.'),
+    refreshToken: zod_1.z
+        .string()
+        .describe('Refresh token to be used to obtain a new access token when the current one expires.'),
+});

package/dist/api/index.d.ts

@@ -0,0 +1,4 @@
+export * from './alarm';
+export * from './auth';
+export * from './query';
+export * from './media';

package/dist/api/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./alarm"), exports);
+__exportStar(require("./auth"), exports);
+__exportStar(require("./query"), exports);
+__exportStar(require("./media"), exports);

package/dist/api/media.d.ts

@@ -0,0 +1,187 @@
+import { z } from 'zod';
+export declare const sRecordingSequence: z.ZodObject<{
+    start: z.ZodNumber;
+    end: z.ZodNumber;
+    motion: z.ZodOptional<z.ZodNumber>;
+    objects: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    end: number;
+    start: number;
+    motion?: number | undefined;
+    objects?: number | undefined;
+}, {
+    end: number;
+    start: number;
+    motion?: number | undefined;
+    objects?: number | undefined;
+}>;
+export declare const sGetRecordingsRequest: z.ZodObject<{
+    deviceId: z.ZodString;
+    timeFrom: z.ZodNumber;
+    timeTo: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    deviceId: string;
+    timeFrom: number;
+    timeTo: number;
+}, {
+    deviceId: string;
+    timeFrom: number;
+    timeTo: number;
+}>;
+export declare const sGetRecordingsResponse: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        start: z.ZodNumber;
+        end: z.ZodNumber;
+        motion: z.ZodOptional<z.ZodNumber>;
+        objects: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        end: number;
+        start: number;
+        motion?: number | undefined;
+        objects?: number | undefined;
+    }, {
+        end: number;
+        start: number;
+        motion?: number | undefined;
+        objects?: number | undefined;
+    }>, "many">;
+    total: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    total: number;
+    items: {
+        end: number;
+        start: number;
+        motion?: number | undefined;
+        objects?: number | undefined;
+    }[];
+}, {
+    total: number;
+    items: {
+        end: number;
+        start: number;
+        motion?: number | undefined;
+        objects?: number | undefined;
+    }[];
+}>;
+export declare const sGetPreviewImageRequest: z.ZodObject<{
+    deviceId: z.ZodString;
+    time: z.ZodNumber;
+    height: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    time: number;
+    height: number;
+    deviceId: string;
+}, {
+    time: number;
+    height: number;
+    deviceId: string;
+}>;
+export declare const sGetScenePreviewClipRequest: z.ZodObject<{
+    deviceId: z.ZodString;
+    providerAssignedRef: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    providerAssignedRef: string;
+    deviceId: string;
+}, {
+    providerAssignedRef: string;
+    deviceId: string;
+}>;
+export declare const sGetObjectSnapshotRequest: z.ZodObject<{
+    deviceId: z.ZodString;
+    providerAssignedRef: z.ZodString;
+    crop: z.ZodBoolean;
+    boxes: z.ZodBoolean;
+    height: z.ZodOptional<z.ZodNumber>;
+    quality: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    providerAssignedRef: string;
+    deviceId: string;
+    crop: boolean;
+    boxes: boolean;
+    height?: number | undefined;
+    quality?: number | undefined;
+}, {
+    providerAssignedRef: string;
+    deviceId: string;
+    crop: boolean;
+    boxes: boolean;
+    height?: number | undefined;
+    quality?: number | undefined;
+}>;
+export declare const sGetObjectThumbnailRequest: z.ZodObject<{
+    deviceId: z.ZodString;
+    providerAssignedRef: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    providerAssignedRef: string;
+    deviceId: string;
+}, {
+    providerAssignedRef: string;
+    deviceId: string;
+}>;
+export declare const sGetExportLinkResponse: z.ZodObject<{
+    relativeUrl: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    relativeUrl: string;
+}, {
+    relativeUrl: string;
+}>;
+export declare const sMediaSearchQueryDto: z.ZodObject<{
+    limit: z.ZodOptional<z.ZodNumber>;
+    q: z.ZodOptional<z.ZodString>;
+    deviceId: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    similarTo: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    label: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    timeFrom: z.ZodOptional<z.ZodNumber>;
+    timeTo: z.ZodOptional<z.ZodNumber>;
+    sortBy: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"time_asc">, z.ZodLiteral<"time_desc">]>>;
+}, "strip", z.ZodTypeAny, {
+    label?: string[] | undefined;
+    q?: string | undefined;
+    deviceId?: string[] | undefined;
+    limit?: number | undefined;
+    timeFrom?: number | undefined;
+    timeTo?: number | undefined;
+    similarTo?: string | undefined;
+    sortBy?: "time_asc" | "time_desc" | undefined;
+}, {
+    label?: string[] | undefined;
+    q?: string | undefined;
+    deviceId?: string[] | undefined;
+    limit?: number | undefined;
+    timeFrom?: number | undefined;
+    timeTo?: number | undefined;
+    similarTo?: string | undefined;
+    sortBy?: "time_asc" | "time_desc" | undefined;
+}>;
+export declare const sGetLatestFrameRequest: z.ZodObject<{
+    deviceId: z.ZodString;
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    height: number;
+    width: number;
+    deviceId: string;
+}, {
+    height: number;
+    width: number;
+    deviceId: string;
+}>;
+export type RecordingSequence = z.infer<typeof sRecordingSequence>;
+export type GetRecordingsRequest = z.infer<typeof sGetRecordingsRequest>;
+export type GetRecordingsResponse = z.infer<typeof sGetRecordingsResponse>;
+export type GetPreviewImageRequest = z.infer<typeof sGetPreviewImageRequest>;
+export type GetScenePreviewClipRequest = z.infer<typeof sGetScenePreviewClipRequest>;
+export type GetObjectSnapshotRequest = z.infer<typeof sGetObjectSnapshotRequest>;
+export type GetObjectThumbnailRequest = z.infer<typeof sGetObjectThumbnailRequest>;
+export type GetExportLinkResponse = z.infer<typeof sGetExportLinkResponse>;
+export type MediaSearchQueryDto = z.infer<typeof sMediaSearchQueryDto>;
+export type GetLatestFrameRequest = z.infer<typeof sGetLatestFrameRequest>;
+export type MediaSearchMatchDto = {
+    relevance: number;
+    providerAssignedRef: string;
+    deviceId: string;
+    probability: number;
+    objectKind: string;
+    startTime: number;
+    endTime: number | null;
+};