@awarevue/api-types 1.0.1

package/dist/device/alarm.d.ts

@@ -0,0 +1,265 @@
+import { DeviceEvent } from '../device-event';
+import { z } from 'zod';
+export declare const ALARM: "alarm";
+export declare const sAlarmSpecs: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+export type AlarmSpecs = z.infer<typeof sAlarmSpecs>;
+export interface ArmCommand {
+    command: 'alarm.arm';
+    params: {
+        deviceId: string;
+    };
+}
+export interface DisarmCommand {
+    command: 'alarm.disarm';
+    params: {
+        deviceId: string;
+        duration?: number;
+    };
+}
+export interface ArmAllCommand {
+    command: 'alarm.arm-all';
+    params: object;
+}
+export interface DisarmAllCommand {
+    command: 'alarm.disarm-all';
+    params: {
+        duration?: number;
+    };
+}
+export interface AcknowledgeCommand {
+    command: 'alarm.acknowledge';
+    params: object;
+}
+export interface SetTriggerCommand {
+    command: 'alarm.set-trigger';
+    params: {
+        event: DeviceEvent;
+        onlyIfArmed: boolean;
+    };
+}
+export type AlarmCommand = ArmCommand | DisarmCommand | ArmAllCommand | DisarmAllCommand | AcknowledgeCommand | SetTriggerCommand;
+export type AlarmStateDto = {
+    activeAlarmId: string | null;
+    triggeredOn: number | null;
+    triggeredBy: string[];
+    armed: Record<string, boolean>;
+};
+export declare const sAlarmTriggeredEvent: z.ZodObject<{
+    kind: z.ZodLiteral<"alarm-triggered">;
+    alarmId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    kind: "alarm-triggered";
+    alarmId: string;
+}, {
+    kind: "alarm-triggered";
+    alarmId: string;
+}>;
+export declare const sAlarmAcknowledgedEvent: z.ZodObject<{
+    kind: z.ZodLiteral<"alarm-acknowledged">;
+    alarmId: z.ZodString;
+    userId: z.ZodOptional<z.ZodString>;
+    personId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    kind: "alarm-acknowledged";
+    alarmId: string;
+    personId?: string | undefined;
+    userId?: string | undefined;
+}, {
+    kind: "alarm-acknowledged";
+    alarmId: string;
+    personId?: string | undefined;
+    userId?: string | undefined;
+}>;
+export declare const sAlarmArmedAllEvent: z.ZodObject<{
+    kind: z.ZodLiteral<"alarm-armed-all">;
+    userId: z.ZodOptional<z.ZodString>;
+    personId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    kind: "alarm-armed-all";
+    personId?: string | undefined;
+    userId?: string | undefined;
+}, {
+    kind: "alarm-armed-all";
+    personId?: string | undefined;
+    userId?: string | undefined;
+}>;
+export declare const sAlarmDisarmedAllEvent: z.ZodObject<{
+    kind: z.ZodLiteral<"alarm-disarmed-all">;
+    userId: z.ZodOptional<z.ZodString>;
+    personId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    kind: "alarm-disarmed-all";
+    personId?: string | undefined;
+    userId?: string | undefined;
+}, {
+    kind: "alarm-disarmed-all";
+    personId?: string | undefined;
+    userId?: string | undefined;
+}>;
+export declare const sAlarmArmedEvent: z.ZodObject<{
+    kind: z.ZodLiteral<"alarm-armed">;
+    subjects: z.ZodArray<z.ZodString, "many">;
+    userId: z.ZodOptional<z.ZodString>;
+    personId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    kind: "alarm-armed";
+    subjects: string[];
+    personId?: string | undefined;
+    userId?: string | undefined;
+}, {
+    kind: "alarm-armed";
+    subjects: string[];
+    personId?: string | undefined;
+    userId?: string | undefined;
+}>;
+export declare const sAlarmDisarmedEvent: z.ZodObject<{
+    kind: z.ZodLiteral<"alarm-disarmed">;
+    subjects: z.ZodArray<z.ZodString, "many">;
+    userId: z.ZodOptional<z.ZodString>;
+    personId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    kind: "alarm-disarmed";
+    subjects: string[];
+    personId?: string | undefined;
+    userId?: string | undefined;
+}, {
+    kind: "alarm-disarmed";
+    subjects: string[];
+    personId?: string | undefined;
+    userId?: string | undefined;
+}>;
+export declare const sAlarmArmReleasedEvent: z.ZodObject<{
+    kind: z.ZodLiteral<"alarm-arm-released">;
+    userId: z.ZodOptional<z.ZodString>;
+    personId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    kind: "alarm-arm-released";
+    personId?: string | undefined;
+    userId?: string | undefined;
+}, {
+    kind: "alarm-arm-released";
+    personId?: string | undefined;
+    userId?: string | undefined;
+}>;
+export declare const sAlarmRearmedEvent: z.ZodObject<{
+    kind: z.ZodLiteral<"alarm-rearmed">;
+}, "strip", z.ZodTypeAny, {
+    kind: "alarm-rearmed";
+}, {
+    kind: "alarm-rearmed";
+}>;
+export declare const alarmEventSchemasByKind: {
+    readonly 'alarm-triggered': z.ZodObject<{
+        kind: z.ZodLiteral<"alarm-triggered">;
+        alarmId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        kind: "alarm-triggered";
+        alarmId: string;
+    }, {
+        kind: "alarm-triggered";
+        alarmId: string;
+    }>;
+    readonly 'alarm-acknowledged': z.ZodObject<{
+        kind: z.ZodLiteral<"alarm-acknowledged">;
+        alarmId: z.ZodString;
+        userId: z.ZodOptional<z.ZodString>;
+        personId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        kind: "alarm-acknowledged";
+        alarmId: string;
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }, {
+        kind: "alarm-acknowledged";
+        alarmId: string;
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }>;
+    readonly 'alarm-armed-all': z.ZodObject<{
+        kind: z.ZodLiteral<"alarm-armed-all">;
+        userId: z.ZodOptional<z.ZodString>;
+        personId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        kind: "alarm-armed-all";
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }, {
+        kind: "alarm-armed-all";
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }>;
+    readonly 'alarm-disarmed-all': z.ZodObject<{
+        kind: z.ZodLiteral<"alarm-disarmed-all">;
+        userId: z.ZodOptional<z.ZodString>;
+        personId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        kind: "alarm-disarmed-all";
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }, {
+        kind: "alarm-disarmed-all";
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }>;
+    readonly 'alarm-armed': z.ZodObject<{
+        kind: z.ZodLiteral<"alarm-armed">;
+        subjects: z.ZodArray<z.ZodString, "many">;
+        userId: z.ZodOptional<z.ZodString>;
+        personId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        kind: "alarm-armed";
+        subjects: string[];
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }, {
+        kind: "alarm-armed";
+        subjects: string[];
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }>;
+    readonly 'alarm-disarmed': z.ZodObject<{
+        kind: z.ZodLiteral<"alarm-disarmed">;
+        subjects: z.ZodArray<z.ZodString, "many">;
+        userId: z.ZodOptional<z.ZodString>;
+        personId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        kind: "alarm-disarmed";
+        subjects: string[];
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }, {
+        kind: "alarm-disarmed";
+        subjects: string[];
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }>;
+    readonly 'alarm-arm-released': z.ZodObject<{
+        kind: z.ZodLiteral<"alarm-arm-released">;
+        userId: z.ZodOptional<z.ZodString>;
+        personId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        kind: "alarm-arm-released";
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }, {
+        kind: "alarm-arm-released";
+        personId?: string | undefined;
+        userId?: string | undefined;
+    }>;
+    readonly 'alarm-rearmed': z.ZodObject<{
+        kind: z.ZodLiteral<"alarm-rearmed">;
+    }, "strip", z.ZodTypeAny, {
+        kind: "alarm-rearmed";
+    }, {
+        kind: "alarm-rearmed";
+    }>;
+};
+export type AlarmTriggeredEvent = z.infer<typeof sAlarmTriggeredEvent>;
+export type AlarmAcknowledgedEvent = z.infer<typeof sAlarmAcknowledgedEvent>;
+export type AlarmArmedAllEvent = z.infer<typeof sAlarmArmedAllEvent>;
+export type AlarmDisarmedAllEvent = z.infer<typeof sAlarmDisarmedAllEvent>;
+export type AlarmArmedEvent = z.infer<typeof sAlarmArmedEvent>;
+export type AlarmDisarmedEvent = z.infer<typeof sAlarmDisarmedEvent>;
+export type AlarmArmReleasedEvent = z.infer<typeof sAlarmArmReleasedEvent>;
+export type AlarmRearmedEvent = z.infer<typeof sAlarmRearmedEvent>;
+export type AlarmEvent = AlarmTriggeredEvent | AlarmAcknowledgedEvent | AlarmArmedAllEvent | AlarmDisarmedAllEvent | AlarmArmedEvent | AlarmDisarmedEvent | AlarmArmReleasedEvent | AlarmRearmedEvent;

package/dist/device/alarm.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.alarmEventSchemasByKind = exports.sAlarmRearmedEvent = exports.sAlarmArmReleasedEvent = exports.sAlarmDisarmedEvent = exports.sAlarmArmedEvent = exports.sAlarmDisarmedAllEvent = exports.sAlarmArmedAllEvent = exports.sAlarmAcknowledgedEvent = exports.sAlarmTriggeredEvent = exports.sAlarmSpecs = exports.ALARM = void 0;
+const zod_1 = require("zod");
+/*
+- only one alarm is active at the same time. If a new alarm-causing event takes place, the already existing alarm will be amended with the new event rather than creating a new alarm
+  (Imagine the case of pirates boarding a ship: the alarm will not be triggered for each pirate, but only once for the whole group of pirates so the UI will show one alarm window and all devices that triggered that alarm listed as they come in, each with its adjacent camera footage if applicable)
+- alarms are triggered by events only, so each alarm MUST correspond to one or more events (we shall call those 'alarm triggers')
+- upon arming the system, events like 'door-access', 'motion-detected' etc. would trigger an alarm
+- in all situations, 'door-force', 'tamper' and other unusual events will trigger alarms regardless of their arm / disarm states
+- arming / disarming more than one device will be achieved by an action against a device group (e.g. 'All Devices', 'Top Deck Doors', 'All Doors', 'All Motion Detectors' etc.)
+*/
+exports.ALARM = 'alarm';
+// SPECS
+exports.sAlarmSpecs = zod_1.z.object({});
+// EVENTS
+exports.sAlarmTriggeredEvent = zod_1.z.object({
+    kind: zod_1.z.literal('alarm-triggered'),
+    alarmId: zod_1.z.string().nonempty(),
+});
+exports.sAlarmAcknowledgedEvent = zod_1.z.object({
+    kind: zod_1.z.literal('alarm-acknowledged'),
+    alarmId: zod_1.z.string().nonempty(),
+    userId: zod_1.z.string().optional(),
+    personId: zod_1.z.string().optional(),
+});
+exports.sAlarmArmedAllEvent = zod_1.z.object({
+    kind: zod_1.z.literal('alarm-armed-all'),
+    userId: zod_1.z.string().optional(),
+    personId: zod_1.z.string().optional(),
+});
+exports.sAlarmDisarmedAllEvent = zod_1.z.object({
+    kind: zod_1.z.literal('alarm-disarmed-all'),
+    userId: zod_1.z.string().optional(),
+    personId: zod_1.z.string().optional(),
+});
+exports.sAlarmArmedEvent = zod_1.z.object({
+    kind: zod_1.z.literal('alarm-armed'),
+    subjects: zod_1.z.array(zod_1.z.string().nonempty()),
+    userId: zod_1.z.string().optional(),
+    personId: zod_1.z.string().optional(),
+});
+exports.sAlarmDisarmedEvent = zod_1.z.object({
+    kind: zod_1.z.literal('alarm-disarmed'),
+    subjects: zod_1.z.array(zod_1.z.string().nonempty()),
+    userId: zod_1.z.string().optional(),
+    personId: zod_1.z.string().optional(),
+});
+exports.sAlarmArmReleasedEvent = zod_1.z.object({
+    kind: zod_1.z.literal('alarm-arm-released'),
+    userId: zod_1.z.string().optional(),
+    personId: zod_1.z.string().optional(),
+});
+exports.sAlarmRearmedEvent = zod_1.z.object({
+    kind: zod_1.z.literal('alarm-rearmed'),
+});
+exports.alarmEventSchemasByKind = {
+    'alarm-triggered': exports.sAlarmTriggeredEvent,
+    'alarm-acknowledged': exports.sAlarmAcknowledgedEvent,
+    'alarm-armed-all': exports.sAlarmArmedAllEvent,
+    'alarm-disarmed-all': exports.sAlarmDisarmedAllEvent,
+    'alarm-armed': exports.sAlarmArmedEvent,
+    'alarm-disarmed': exports.sAlarmDisarmedEvent,
+    'alarm-arm-released': exports.sAlarmArmReleasedEvent,
+    'alarm-rearmed': exports.sAlarmRearmedEvent,
+};