@awarevue/api-types 1.0.1

package/dist/device-event.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDeviceEvent = exports.eventSchemaByKind = exports.eventKindLabels = exports.sEventHeader = void 0;
+const zod_1 = require("zod");
+const alarm_1 = require("./device/alarm");
+const camera_1 = require("./device/camera");
+const door_1 = require("./device/door");
+const intercom_terminal_1 = require("./device/intercom-terminal");
+const io_board_1 = require("./device/io-board");
+const panic_button_1 = require("./device/panic-button");
+const presence_tracker_1 = require("./device/presence-tracker");
+const index_1 = require("./device/reader/index");
+exports.sEventHeader = zod_1.z.object({
+    id: zod_1.z.string().nonempty(),
+    timestamp: zod_1.z.number().int().positive(),
+    deviceId: zod_1.z.string().nonempty(),
+    observedBy: zod_1.z.string().optional(),
+});
+exports.eventKindLabels = {
+    'door-access': 'Door Access',
+    'door-force': 'Force-Opened',
+    'door-tamper': 'Tampered',
+    'door-left-open': 'Left Open',
+    'alarm-triggered': 'Alarm Triggered',
+    'alarm-acknowledged': 'Alarm Acknowledged',
+    'door-relock': 'Relocked',
+    'door-mains-failed': 'Mains Failed',
+    'door-acu-not-responding': 'ACU Not Responding',
+    'door-acu-online': 'ACU Online',
+    'door-mains-restored': 'Mains Restored',
+    'door-tamper-restored': 'Tamper Restored',
+    'motion-detected': 'Motion Detected',
+    'device-command': 'Device Command',
+    'reader-auth': 'Reader Authorized',
+    'alarm-arm-released': 'Alarm Arm Released',
+    'alarm-rearmed': 'Alarm Rearmed',
+    'alarm-armed': 'Alarm Armed',
+    'alarm-disarmed': 'Alarm Disarmed',
+    'alarm-armed-all': 'Alarm Armed All',
+    'alarm-disarmed-all': 'Alarm Disarmed All',
+    'panic-button-pressed': 'Panic Button Pressed',
+    'device-connected': 'Device Connected',
+    'device-disconnected': 'Device Disconnected',
+    'intercom-call': 'Intercom Call',
+    'intercom-call-answered': 'Intercom Call Answered',
+    'intercom-call-ended': 'Intercom Call Ended',
+    'intercom-call-cancelled': 'Intercom Call Cancelled',
+    'object-created': 'Object Created',
+    'object-updated': 'Object Updated',
+    'object-deleted': 'Object Deleted',
+    'ptz-preset-saved': 'PTZ Preset Saved on Device',
+    'person-in': 'Person Checked In',
+    'person-out': 'Person Checked Out',
+    'object-detection-started': 'Object Detection Started',
+    'object-detection-updated': 'Object Detection Updated',
+    'object-detection-ended': 'Object Detection Ended',
+    'scene-created': 'Scene Created',
+    'scene-updated': 'Scene Updated',
+    'scene-ended': 'Scene Ended',
+    'io-board-input-changed': 'IO Board Input Changed',
+};
+exports.eventSchemaByKind = {
+    ...alarm_1.alarmEventSchemasByKind,
+    ...camera_1.cameraEventSchemasByKind,
+    ...door_1.doorEventSchemaByKind,
+    ...intercom_terminal_1.intercomTerminalEventSchemaByKind,
+    ...io_board_1.ioBoardEventSchemaByKind,
+    ...panic_button_1.panicButtonEventSchemaByKind,
+    ...presence_tracker_1.presenceTrackerEventSchemaByKind,
+    ...index_1.readerEventSchemaByKind,
+};
+const isDeviceEvent = (event) => {
+    if (typeof event !== 'object' || event === null)
+        return false;
+    if (!('kind' in event))
+        return false;
+    if (typeof event.kind !== 'string')
+        return false;
+    const schema = exports.eventSchemaByKind[event.kind];
+    if (!schema)
+        return false;
+    const result = schema.safeParse(event);
+    if (!result.success)
+        return false;
+    return true;
+};
+exports.isDeviceEvent = isDeviceEvent;

package/dist/device-factory.d.ts

@@ -0,0 +1,112 @@
+import z from 'zod';
+import { DeviceType } from './device/any-device';
+export declare const sIoSlot: z.ZodObject<{
+    deviceId: z.ZodString;
+    slot: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    slot: string;
+    deviceId: string;
+}, {
+    slot: string;
+    deviceId: string;
+}>;
+export type IoSlot = z.infer<typeof sIoSlot>;
+export declare const sInputBindings: z.ZodRecord<z.ZodString, z.ZodObject<{
+    deviceId: z.ZodString;
+    slot: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    slot: string;
+    deviceId: string;
+}, {
+    slot: string;
+    deviceId: string;
+}>>;
+export type InputBindings = z.infer<typeof sInputBindings>;
+export declare const sOutputBindings: z.ZodRecord<z.ZodString, z.ZodObject<{
+    deviceId: z.ZodString;
+    slot: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    slot: string;
+    deviceId: string;
+}, {
+    slot: string;
+    deviceId: string;
+}>>;
+export type OutputBindings = z.infer<typeof sOutputBindings>;
+export interface DeviceFactoryProviderMetadata {
+    templateName: string;
+}
+export declare const isDeviceFactoryProviderMetadata: (obj: any) => obj is DeviceFactoryProviderMetadata;
+export interface DeviceIo {
+    name: string;
+    displayName: string;
+    dataType: 'boolean';
+}
+export interface DeviceTemplate {
+    deviceType: DeviceType;
+    displayName: string;
+    description: string;
+    inputs: DeviceIo[];
+    outputs: DeviceIo[];
+}
+export declare const sAddCustomDeviceRequest: z.ZodObject<{
+    name: z.ZodString;
+    templateName: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    templateName: string;
+}, {
+    name: string;
+    templateName: string;
+}>;
+export type AddCustomDeviceRequest = z.infer<typeof sAddCustomDeviceRequest>;
+export declare const sUpdateCustomDeviceRequest: z.ZodObject<{
+    inputBindings: z.ZodRecord<z.ZodString, z.ZodObject<{
+        deviceId: z.ZodString;
+        slot: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        slot: string;
+        deviceId: string;
+    }, {
+        slot: string;
+        deviceId: string;
+    }>>;
+    outputBindings: z.ZodRecord<z.ZodString, z.ZodObject<{
+        deviceId: z.ZodString;
+        slot: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        slot: string;
+        deviceId: string;
+    }, {
+        slot: string;
+        deviceId: string;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    inputBindings: Record<string, {
+        slot: string;
+        deviceId: string;
+    }>;
+    outputBindings: Record<string, {
+        slot: string;
+        deviceId: string;
+    }>;
+}, {
+    inputBindings: Record<string, {
+        slot: string;
+        deviceId: string;
+    }>;
+    outputBindings: Record<string, {
+        slot: string;
+        deviceId: string;
+    }>;
+}>;
+export type UpdateCustomDeviceRequest = {
+    id: string;
+} & z.infer<typeof sUpdateCustomDeviceRequest>;
+export type CustomDeviceInfo = {
+    id: string;
+    name: string;
+    templateName: string;
+    inputBindings: Record<string, IoSlot>;
+    outputBindings: Record<string, IoSlot>;
+};

package/dist/device-factory.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sUpdateCustomDeviceRequest = exports.sAddCustomDeviceRequest = exports.isDeviceFactoryProviderMetadata = exports.sOutputBindings = exports.sInputBindings = exports.sIoSlot = void 0;
+const zod_1 = __importDefault(require("zod"));
+exports.sIoSlot = zod_1.default.object({
+    deviceId: zod_1.default.string().nonempty(),
+    slot: zod_1.default.string().nonempty(),
+});
+exports.sInputBindings = zod_1.default.record(exports.sIoSlot);
+exports.sOutputBindings = zod_1.default.record(exports.sIoSlot);
+const isDeviceFactoryProviderMetadata = (obj) => {
+    return obj && obj.templateName && typeof obj.templateName === 'string';
+};
+exports.isDeviceFactoryProviderMetadata = isDeviceFactoryProviderMetadata;
+exports.sAddCustomDeviceRequest = zod_1.default.object({
+    name: zod_1.default.string().nonempty(),
+    templateName: zod_1.default.string().nonempty(),
+});
+exports.sUpdateCustomDeviceRequest = zod_1.default.object({
+    inputBindings: exports.sInputBindings,
+    outputBindings: exports.sOutputBindings,
+});

package/dist/device-group.d.ts

@@ -0,0 +1,74 @@
+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;
+    createdOn: string;
+    lastModifiedOn: string;
+    devices: string[];
+}, {
+    code: string | null;
+    id: string;
+    displayName: string;
+    createdOn: string;
+    lastModifiedOn: string;
+    devices: string[];
+}>;
+export type DeviceGroupDto = z.infer<typeof sDeviceGroup>;
+export declare const sAddGroupRequest: z.ZodObject<{
+    code: z.ZodNullable<z.ZodString>;
+    displayName: z.ZodString;
+    devices: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    code: string | null;
+    displayName: string;
+    devices: string[];
+}, {
+    code: string | null;
+    displayName: string;
+    devices: string[];
+}>;
+export declare const sUpdateGroupRequest: z.ZodObject<{
+    code: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    displayName: z.ZodOptional<z.ZodString>;
+    devices: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    code?: string | null | undefined;
+    displayName?: string | undefined;
+    devices?: string[] | undefined;
+}, {
+    code?: string | null | undefined;
+    displayName?: string | undefined;
+    devices?: string[] | undefined;
+}>;
+export declare const sAddDevicesToGroupRequest: z.ZodObject<{
+    devices: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    devices: string[];
+}, {
+    devices: string[];
+}>;
+export declare const sRemoveDevicesFromGroupRequest: z.ZodObject<{
+    devices: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    devices: string[];
+}, {
+    devices: string[];
+}>;
+export type AddGroupRequest = z.infer<typeof sAddGroupRequest>;
+export type UpdateGroupRequest = {
+    id: string;
+} & z.infer<typeof sUpdateGroupRequest>;
+export type AddDevicesToGroupRequest = {
+    id: string;
+} & z.infer<typeof sAddDevicesToGroupRequest>;
+export type RemoveDevicesFromGroupRequest = {
+    id: string;
+} & z.infer<typeof sRemoveDevicesFromGroupRequest>;

package/dist/device-group.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sRemoveDevicesFromGroupRequest = exports.sAddDevicesToGroupRequest = exports.sUpdateGroupRequest = exports.sAddGroupRequest = exports.sDeviceGroup = void 0;
+const zod_1 = __importDefault(require("zod"));
+exports.sDeviceGroup = zod_1.default.object({
+    id: zod_1.default.string(),
+    code: zod_1.default.string().nullable(),
+    displayName: zod_1.default.string(),
+    createdOn: zod_1.default.string(),
+    lastModifiedOn: zod_1.default.string(),
+    devices: zod_1.default.array(zod_1.default.string().nonempty()),
+});
+exports.sAddGroupRequest = zod_1.default.object({
+    code: zod_1.default.string().nullable(),
+    displayName: zod_1.default.string().nonempty(),
+    devices: zod_1.default.array(zod_1.default.string().nonempty()),
+});
+exports.sUpdateGroupRequest = zod_1.default.object({
+    code: zod_1.default.string().nullable().optional(),
+    displayName: zod_1.default.string().optional(),
+    devices: zod_1.default.array(zod_1.default.string().nonempty()).optional(),
+});
+exports.sAddDevicesToGroupRequest = zod_1.default.object({
+    devices: zod_1.default.array(zod_1.default.string().nonempty()),
+});
+exports.sRemoveDevicesFromGroupRequest = zod_1.default.object({
+    devices: zod_1.default.array(zod_1.default.string().nonempty()),
+});