@awarevue/api-types 1.0.1

package/dist/device/reader/index.js

@@ -0,0 +1,19 @@
+"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("./commands"), exports);
+__exportStar(require("./events"), exports);
+__exportStar(require("./specs"), exports);

package/dist/device/reader/specs.d.ts

@@ -0,0 +1,2 @@
+export declare const READER: "reader";
+export type ReaderSpecs = object;

package/dist/device/reader/specs.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.READER = void 0;
+exports.READER = 'reader';

package/dist/device/server.d.ts

@@ -0,0 +1,73 @@
+import { AccessRuleDto, PersonDto, PersonPresenceDto, ScheduleDto, ZoneDto } from '../access-control';
+import { DeviceDto } from './any-device';
+import { AutomationRuleDto } from '../automation';
+import { DeviceGroupDto } from '../device-group';
+import { MacroDto } from '../macros';
+import { LayoutDto } from '../layout';
+import { ViewDto } from '../view';
+import { RoleDto } from '../user';
+import { ModuleConfig, ModuleConfigMetadata } from '../module-config';
+export declare const SERVER = "server";
+export interface RunMacro {
+    command: 'server.run-macro';
+    params: {
+        macroId: string;
+    };
+}
+export type ServerCommand = RunMacro;
+export type ServerState = {
+    runningAgents: Record<string, string[]>;
+    configMetadata: ModuleConfigMetadata;
+    config: ModuleConfig;
+};
+export type ObjectKinds = {
+    layout: LayoutDto;
+    view: ViewDto;
+    accessRule: AccessRuleDto;
+    schedule: ScheduleDto;
+    person: PersonDto;
+    device: DeviceDto;
+    zone: ZoneDto;
+    personPresence: PersonPresenceDto;
+    automationRule: AutomationRuleDto;
+    deviceGroup: DeviceGroupDto;
+    macro: MacroDto;
+    role: RoleDto;
+};
+export declare const objectKinds: readonly (keyof ObjectKinds)[];
+export type ObjectCreated = {
+    [K in keyof ObjectKinds]: {
+        originator: string;
+        objectVersion: number;
+        objectKind: K;
+        data: ObjectKinds[K];
+        objectId: string;
+        kind: 'object-created';
+        userId?: string;
+    };
+}[keyof ObjectKinds];
+export type ObjectUpdated = {
+    [K in keyof ObjectKinds]: {
+        originator: string;
+        objectVersion: number;
+        objectKind: K;
+        original: ObjectKinds[K];
+        changes: Partial<ObjectKinds[K]>;
+        objectId: string;
+        kind: 'object-updated';
+        userId?: string;
+    };
+}[keyof ObjectKinds];
+export type ObjectDeleted = {
+    [K in keyof ObjectKinds]: {
+        originator: string;
+        objectVersion: number;
+        objectKind: K;
+        data: ObjectKinds[K];
+        objectId: string;
+        kind: 'object-deleted';
+        userId?: string;
+    };
+}[keyof ObjectKinds];
+export type ServerEvent = ObjectCreated | ObjectUpdated | ObjectDeleted;
+export declare const objectLabels: Record<string, string>;

package/dist/device/server.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.objectLabels = exports.objectKinds = exports.SERVER = void 0;
+exports.SERVER = 'server';
+exports.objectKinds = [
+    'accessRule',
+    'schedule',
+    'person',
+    'device',
+    'zone',
+    'personPresence',
+    'deviceGroup',
+    'view',
+    'layout',
+    'automationRule',
+    'macro',
+    'role',
+];
+exports.objectLabels = {
+    accessRule: 'Access Rule',
+    schedule: 'Schedule',
+    person: 'Person',
+    device: 'Device',
+    deviceGroup: 'Device Group',
+    zone: 'Zone',
+    layout: 'Layout',
+    view: 'View',
+    role: 'Role',
+    user: 'User',
+    personPresence: 'Person Presence',
+    automationRule: 'Automation Rule',
+    macro: 'Macro',
+};

package/dist/device-command.d.ts

@@ -0,0 +1,23 @@
+import { AlarmCommand } from './device/alarm';
+import { CameraCommand } from './device/camera';
+import { CameraLiftCommand } from './device/camera-lift';
+import { DeviceGatewayCommand } from './device/device-gateway';
+import { DoorCommand } from './device/door';
+import { IntercomTerminalCommand } from './device/intercom-terminal';
+import { IoBoardCommand } from './device/io-board';
+import { PbxCommand } from './device/pbx';
+import { PresenceTrackerCommand } from './device/presence-tracker';
+import { ReaderCommand } from './device/reader/index';
+import { ServerCommand } from './device/server';
+import { PermissionId } from './permissions';
+export type AnyDeviceCommand = ServerCommand | DeviceGatewayCommand | CameraCommand | DoorCommand | ReaderCommand | IoBoardCommand | CameraLiftCommand | AlarmCommand | IntercomTerminalCommand | PbxCommand | PresenceTrackerCommand;
+export type CommandRun<TCommand extends AnyDeviceCommand = AnyDeviceCommand> = {
+    timestamp: number;
+    requestId: string;
+    deviceId: string;
+    senderId?: number;
+} & TCommand;
+export declare const commandDescriptions: Record<AnyDeviceCommand['command'], {
+    description: string;
+    permission: PermissionId;
+}>;

package/dist/device-command.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.commandDescriptions = void 0;
+exports.commandDescriptions = {
+    'camera.ptz-set': { description: 'PTZ Set', permission: 'camera:ptz' },
+    'camera.ptz-move': { description: 'PTZ Move', permission: 'camera:ptz' },
+    'camera.ptz-begin-move': {
+        description: 'PTZ Begin Move',
+        permission: 'camera:ptz',
+    },
+    'camera.ptz-end-move': {
+        description: 'PTZ End Move',
+        permission: 'camera:ptz',
+    },
+    'camera.enable': {
+        description: 'Camera Enable',
+        permission: 'camera:privacy-mode',
+    },
+    'camera.disable': {
+        description: 'Camera Disable',
+        permission: 'camera:privacy-mode',
+    },
+    'door.unlock': { description: 'Door Unlock', permission: 'door:lock' },
+    'door.lock': { description: 'Door Lock', permission: 'door:lock' },
+    'door.release': { description: 'Door Release', permission: 'door:release' },
+    'door.alarm-ack': {
+        description: 'Door Alarm Acknowledge',
+        permission: 'alarm:acknowlede',
+    },
+    'io-board.set-output': {
+        description: 'IO board Set Output',
+        permission: 'io-board:activate',
+    },
+    'camera-lift.raise': {
+        description: 'Camera Lift Raise',
+        permission: 'camera-lift:activate',
+    },
+    'camera-lift.lower': {
+        description: 'Camera Lift Lower',
+        permission: 'camera-lift:activate',
+    },
+    'alarm.acknowledge': {
+        description: 'Alarm Acknowledge',
+        permission: 'alarm:acknowlede',
+    },
+    'alarm.arm': { description: 'Device Arm', permission: 'alarm:arm' },
+    'alarm.arm-all': { description: 'Device Arm All', permission: 'alarm:arm' },
+    'alarm.disarm': { description: 'Device Disarm', permission: 'alarm:arm' },
+    'alarm.disarm-all': {
+        description: 'Device Disarm All',
+        permission: 'alarm:arm',
+    },
+    'alarm.set-trigger': {
+        description: 'Alarm Trigger',
+        permission: 'alarm:trigger',
+    },
+    'intercom-terminal.dial': {
+        description: 'Intercom Call',
+        permission: 'intercom:read',
+    },
+    'intercom-terminal.cancel-call': {
+        description: 'Intercom Call Cancel',
+        permission: 'intercom:read',
+    },
+    'intercom-terminal.answer': {
+        description: 'Intercom Call Answer',
+        permission: 'intercom:read',
+    },
+    'intercom-terminal.hang-up': {
+        description: 'Intercom Call End',
+        permission: 'intercom:read',
+    },
+    'intercom-terminal.connect': {
+        description: 'Intercom Terminal Connect',
+        permission: 'intercom:read',
+    },
+    'intercom-terminal.disconnect': {
+        description: 'Intercom Terminal Disconnect',
+        permission: 'intercom:read',
+    },
+    'pbx.call': {
+        description: 'Automated Phone Call',
+        permission: 'intercom:read',
+    },
+    'camera.preset-activate': {
+        description: 'Camera Preset Activate',
+        permission: 'preset:read',
+    },
+    'camera.preset-delete': {
+        description: 'Camera Preset Delete',
+        permission: 'preset:delete',
+    },
+    'camera.preset-save': {
+        description: 'Camera Preset Save',
+        permission: 'preset:update',
+    },
+    'presence-tracker.check-in': {
+        description: 'Person Check In',
+        permission: 'presence:update',
+    },
+    'presence-tracker.check-out': {
+        description: 'Person Check Out',
+        permission: 'presence:update',
+    },
+    'presence-tracker.toggle-presence': {
+        description: 'Person Toggle Presence',
+        permission: 'presence:update',
+    },
+    'server.run-macro': { description: 'Run Macro', permission: 'macro:run' },
+};