@awarevue/api-types 1.0.1

package/dist/messages/web-rtc-signaling.d.ts

@@ -0,0 +1,265 @@
+import z from 'zod';
+import { WebSocketMessage } from './web-socket';
+export declare const sSessionDescription: z.ZodObject<{
+    type: z.ZodString;
+    sdp: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    sdp: string;
+}, {
+    type: string;
+    sdp: string;
+}>;
+export type SessionDescription = z.infer<typeof sSessionDescription>;
+export declare const sIceCandidate: z.ZodString;
+export type IceCandidate = z.infer<typeof sIceCandidate>;
+export declare const sWebRtcServiceDescription: z.ZodUnion<[z.ZodObject<{
+    service: z.ZodLiteral<"live">;
+    serviceParams: z.ZodObject<{
+        deviceId: z.ZodString;
+        streamId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        deviceId: string;
+        streamId: string;
+    }, {
+        deviceId: string;
+        streamId: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    service: "live";
+    serviceParams: {
+        deviceId: string;
+        streamId: string;
+    };
+}, {
+    service: "live";
+    serviceParams: {
+        deviceId: string;
+        streamId: string;
+    };
+}>, z.ZodObject<{
+    service: z.ZodLiteral<"playback">;
+    serviceParams: z.ZodObject<{
+        controllerId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        controllerId: string;
+    }, {
+        controllerId: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    service: "playback";
+    serviceParams: {
+        controllerId: string;
+    };
+}, {
+    service: "playback";
+    serviceParams: {
+        controllerId: string;
+    };
+}>]>;
+export type WebRtcServiceDescription = z.infer<typeof sWebRtcServiceDescription>;
+export declare const sWebRtcNewSessionPayload: z.ZodIntersection<z.ZodUnion<[z.ZodObject<{
+    service: z.ZodLiteral<"live">;
+    serviceParams: z.ZodObject<{
+        deviceId: z.ZodString;
+        streamId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        deviceId: string;
+        streamId: string;
+    }, {
+        deviceId: string;
+        streamId: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    service: "live";
+    serviceParams: {
+        deviceId: string;
+        streamId: string;
+    };
+}, {
+    service: "live";
+    serviceParams: {
+        deviceId: string;
+        streamId: string;
+    };
+}>, z.ZodObject<{
+    service: z.ZodLiteral<"playback">;
+    serviceParams: z.ZodObject<{
+        controllerId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        controllerId: string;
+    }, {
+        controllerId: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    service: "playback";
+    serviceParams: {
+        controllerId: string;
+    };
+}, {
+    service: "playback";
+    serviceParams: {
+        controllerId: string;
+    };
+}>]>, z.ZodObject<{
+    from: z.ZodOptional<z.ZodString>;
+    requestId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    requestId: string;
+    from?: string | undefined;
+}, {
+    requestId: string;
+    from?: string | undefined;
+}>>;
+export type WebRtcNewSessionPayload = z.infer<typeof sWebRtcNewSessionPayload>;
+export declare const sWebRtcSessionCreatedPayload: z.ZodObject<{
+    requestId: z.ZodString;
+    sessionId: z.ZodString;
+    stunServer: z.ZodNullable<z.ZodString>;
+    frozenStreamTimeout: z.ZodNullable<z.ZodNumber>;
+    trickleIce: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    requestId: string;
+    sessionId: string;
+    stunServer: string | null;
+    frozenStreamTimeout: number | null;
+    trickleIce: boolean;
+}, {
+    requestId: string;
+    sessionId: string;
+    stunServer: string | null;
+    frozenStreamTimeout: number | null;
+    trickleIce: boolean;
+}>;
+export type WebRtcSessionCreatedPayload = z.infer<typeof sWebRtcSessionCreatedPayload>;
+export declare const sWebRtcOfferPayload: z.ZodObject<{
+    sessionId: z.ZodString;
+    description: z.ZodObject<{
+        type: z.ZodString;
+        sdp: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        sdp: string;
+    }, {
+        type: string;
+        sdp: string;
+    }>;
+    from: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    description: {
+        type: string;
+        sdp: string;
+    };
+    sessionId: string;
+    from?: string | undefined;
+}, {
+    description: {
+        type: string;
+        sdp: string;
+    };
+    sessionId: string;
+    from?: string | undefined;
+}>;
+export type WebRtcOfferPayload = z.infer<typeof sWebRtcOfferPayload>;
+export declare const sWebRtcAnswerPayload: z.ZodObject<{
+    sessionId: z.ZodString;
+    description: z.ZodObject<{
+        type: z.ZodString;
+        sdp: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        sdp: string;
+    }, {
+        type: string;
+        sdp: string;
+    }>;
+    from: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    description: {
+        type: string;
+        sdp: string;
+    };
+    sessionId: string;
+    from?: string | undefined;
+}, {
+    description: {
+        type: string;
+        sdp: string;
+    };
+    sessionId: string;
+    from?: string | undefined;
+}>;
+export type WebRtcAnswerPayload = z.infer<typeof sWebRtcAnswerPayload>;
+export declare const sWebRtcIceCandidatePayload: z.ZodObject<{
+    sessionId: z.ZodString;
+    candidate: z.ZodString;
+    from: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    candidate: string;
+    sessionId: string;
+    from?: string | undefined;
+}, {
+    candidate: string;
+    sessionId: string;
+    from?: string | undefined;
+}>;
+export type WebRtcIceCandidatePayload = z.infer<typeof sWebRtcIceCandidatePayload>;
+export declare const sWebRtcReleaseSessionPayload: z.ZodObject<{
+    sessionId: z.ZodString;
+    from: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    sessionId: string;
+    from?: string | undefined;
+}, {
+    sessionId: string;
+    from?: string | undefined;
+}>;
+export type WebRtcReleaseSessionPayload = z.infer<typeof sWebRtcReleaseSessionPayload>;
+export declare const sWebRtcErrorPayload: z.ZodObject<{
+    sessionId: z.ZodString;
+    error: z.ZodObject<{
+        code: z.ZodString;
+        message: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        message: string;
+    }, {
+        code: string;
+        message: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    error: {
+        code: string;
+        message: string;
+    };
+    sessionId: string;
+}, {
+    error: {
+        code: string;
+        message: string;
+    };
+    sessionId: string;
+}>;
+export type WebRtcErrorPayload = z.infer<typeof sWebRtcErrorPayload>;
+interface WebRtcEventMap {
+    'new-session': WebRtcNewSessionPayload;
+    'session-created': WebRtcSessionCreatedPayload;
+    offer: WebRtcOfferPayload;
+    answer: WebRtcAnswerPayload;
+    'ice-candidate': WebRtcIceCandidatePayload;
+    'release-session': WebRtcReleaseSessionPayload;
+    error: WebRtcErrorPayload;
+}
+export type WebRtcWsMessage = {
+    [K in keyof WebRtcEventMap]: {
+        event: K;
+        data: WebRtcEventMap[K];
+    };
+}[keyof WebRtcEventMap];
+export declare const isWebRtcWebSocketMessage: (message: WebSocketMessage) => message is WebRtcWsMessage;
+export type WebRtcMessage = {
+    [K in keyof WebRtcEventMap]: {
+        type: K;
+    } & WebRtcEventMap[K];
+}[keyof WebRtcEventMap];
+export {};

package/dist/messages/web-rtc-signaling.js

@@ -0,0 +1,82 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWebRtcWebSocketMessage = exports.sWebRtcErrorPayload = exports.sWebRtcReleaseSessionPayload = exports.sWebRtcIceCandidatePayload = exports.sWebRtcAnswerPayload = exports.sWebRtcOfferPayload = exports.sWebRtcSessionCreatedPayload = exports.sWebRtcNewSessionPayload = exports.sWebRtcServiceDescription = exports.sIceCandidate = exports.sSessionDescription = void 0;
+const zod_1 = __importDefault(require("zod"));
+exports.sSessionDescription = zod_1.default.object({
+    type: zod_1.default.string().nonempty(),
+    sdp: zod_1.default.string().nonempty(),
+});
+exports.sIceCandidate = zod_1.default.string().nonempty();
+exports.sWebRtcServiceDescription = zod_1.default.union([
+    zod_1.default.object({
+        service: zod_1.default.literal('live'),
+        serviceParams: zod_1.default.object({
+            deviceId: zod_1.default.string().nonempty(),
+            streamId: zod_1.default.string().nonempty(),
+        }),
+    }),
+    zod_1.default.object({
+        service: zod_1.default.literal('playback'),
+        serviceParams: zod_1.default.object({
+            controllerId: zod_1.default.string().nonempty(),
+        }),
+    }),
+]);
+exports.sWebRtcNewSessionPayload = exports.sWebRtcServiceDescription.and(zod_1.default.object({
+    from: zod_1.default.string().optional(),
+    requestId: zod_1.default.string().nonempty(),
+}));
+exports.sWebRtcSessionCreatedPayload = zod_1.default.object({
+    requestId: zod_1.default.string().nonempty(),
+    sessionId: zod_1.default.string().nonempty(),
+    stunServer: zod_1.default.string().nullable(),
+    frozenStreamTimeout: zod_1.default.number().nullable(),
+    trickleIce: zod_1.default.boolean(),
+});
+exports.sWebRtcOfferPayload = zod_1.default.object({
+    sessionId: zod_1.default.string().nonempty(),
+    description: exports.sSessionDescription,
+    from: zod_1.default.string().optional(),
+});
+exports.sWebRtcAnswerPayload = zod_1.default.object({
+    sessionId: zod_1.default.string().nonempty(),
+    description: exports.sSessionDescription,
+    from: zod_1.default.string().optional(),
+});
+exports.sWebRtcIceCandidatePayload = zod_1.default.object({
+    sessionId: zod_1.default.string().nonempty(),
+    candidate: exports.sIceCandidate,
+    from: zod_1.default.string().optional(),
+});
+exports.sWebRtcReleaseSessionPayload = zod_1.default.object({
+    sessionId: zod_1.default.string().nonempty(),
+    from: zod_1.default.string().optional(),
+});
+exports.sWebRtcErrorPayload = zod_1.default.object({
+    sessionId: zod_1.default.string().nonempty(),
+    error: zod_1.default.object({
+        code: zod_1.default.string().nonempty(),
+        message: zod_1.default.string().nonempty(),
+    }),
+});
+const validators = {
+    'new-session': exports.sWebRtcNewSessionPayload,
+    'session-created': exports.sWebRtcSessionCreatedPayload,
+    offer: exports.sWebRtcOfferPayload,
+    answer: exports.sWebRtcAnswerPayload,
+    'ice-candidate': exports.sWebRtcIceCandidatePayload,
+    'release-session': exports.sWebRtcReleaseSessionPayload,
+    error: exports.sWebRtcErrorPayload,
+};
+// validate a web socket message as a WebRTC signaling message (use validators according to event)
+const isWebRtcWebSocketMessage = (message) => {
+    const validator = validators[message.event];
+    if (!validator) {
+        return false;
+    }
+    return validator.safeParse(message.data).success;
+};
+exports.isWebRtcWebSocketMessage = isWebRtcWebSocketMessage;

package/dist/messages/web-socket.d.ts

@@ -0,0 +1,7 @@
+export declare const WS_SERVER_READY = "server-ready";
+export declare const WS_KEEP_ALIVE = "keep-alive";
+export type WebSocketClientId = number;
+export interface WebSocketMessage {
+    readonly event: string;
+    readonly data: unknown;
+}

package/dist/messages/web-socket.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WS_KEEP_ALIVE = exports.WS_SERVER_READY = void 0;
+exports.WS_SERVER_READY = 'server-ready';
+exports.WS_KEEP_ALIVE = 'keep-alive';

package/dist/milestone.d.ts

@@ -0,0 +1,5 @@
+export interface MilestoneAuthorizeResponse {
+    connectionId: string;
+    configurationId: string;
+    serverUrl: string;
+}

package/dist/milestone.js

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

package/dist/module-config.d.ts

@@ -0,0 +1,27 @@
+import { JSONSchema4 } from 'json-schema';
+import { UiHint } from './agent-communication';
+export interface ModuleConfig {
+    app: {
+        modules: string[];
+    };
+    [moduleName: string]: Record<string, unknown>;
+}
+export interface ModuleConfigMetadata {
+    allModules: string[];
+    moduleTitles: Record<string, string>;
+    moduleDefaults: Record<string, Record<string, unknown>>;
+    moduleSchemas: Record<string, JSONSchema4>;
+    moduleUiHints: Record<string, UiHint[]>;
+}
+export interface ConfigIssue {
+    paths: string[];
+    message: string;
+    provider: string;
+}
+export interface ModuleConfigSpecs {
+    provider: string;
+    title: string;
+    schema: JSONSchema4;
+    default: Record<string, unknown>;
+    uiHints?: UiHint[];
+}

package/dist/module-config.js

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

package/dist/orchid.d.ts

@@ -0,0 +1,19 @@
+export type OrchidLoginResponse = {
+    token: string;
+    sessionId: string;
+    id: string;
+    username: string;
+    emailAddress: string | null;
+    admin: boolean;
+    libraryAccess: boolean;
+    groups: {
+        id: string;
+        name: string;
+        description: string;
+    }[];
+    identity: {
+        authProvider: string;
+        id: string;
+        name: string;
+    };
+};

package/dist/orchid.js

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

package/dist/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@awarevue/api-types",
+  "version": "1.0.1",
+  "description": "Common types between backend, agent(s) and frontend(s)",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "license": "MIT",
+  "peerDependencies": {
+    "zod": "^3.24.2"
+  },
+  "devDependencies": {
+    "@types/json-schema": "^7.0.15",
+    "@typescript-eslint/eslint-plugin": "^8.31.1",
+    "@typescript-eslint/parser": "^8.31.1",
+    "eslint": "^9.26.0",
+    "eslint-config-prettier": "^10.1.2",
+    "eslint-plugin-import": "^2.31.0",
+    "typescript": "~5.8.3",
+    "zod": "^3.24.2"
+  },
+  "scripts": {
+    "build": "tsc && cp package.json dist/",
+    "prepare": "yarn run build",
+    "lint": "eslint packages --ext .ts,.tsx"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}

package/dist/permissions.d.ts

@@ -0,0 +1,6 @@
+import { z } from 'zod';
+export declare const sPermissionId: z.ZodUnion<[z.ZodLiteral<"layout:read">, z.ZodLiteral<"layout:update">, z.ZodLiteral<"layout:delete">, z.ZodLiteral<"layout:create">, z.ZodLiteral<"camera:live">, z.ZodLiteral<"camera:playback">, z.ZodLiteral<"camera:playback-export">, z.ZodLiteral<"camera:ptz">, z.ZodLiteral<"camera:privacy-mode">, z.ZodLiteral<"camera:assign">, z.ZodLiteral<"preset:read">, z.ZodLiteral<"preset:update">, z.ZodLiteral<"preset:delete">, z.ZodLiteral<"preset:create">, z.ZodLiteral<"door:release">, z.ZodLiteral<"door:lock">, z.ZodLiteral<"camera-lift:activate">, z.ZodLiteral<"io-board:activate">, z.ZodLiteral<"public-view:read">, z.ZodLiteral<"public-view:update">, z.ZodLiteral<"public-view:delete">, z.ZodLiteral<"public-view:create">, z.ZodLiteral<"private-view:read">, z.ZodLiteral<"private-view:update">, z.ZodLiteral<"private-view:delete">, z.ZodLiteral<"private-view:create">, z.ZodLiteral<"person:read">, z.ZodLiteral<"person:update">, z.ZodLiteral<"person:delete">, z.ZodLiteral<"person:create">, z.ZodLiteral<"person:assign">, z.ZodLiteral<"person:print">, z.ZodLiteral<"door-group:read">, z.ZodLiteral<"door-group:update">, z.ZodLiteral<"door-group:delete">, z.ZodLiteral<"door-group:create">, z.ZodLiteral<"access-rule:read">, z.ZodLiteral<"access-rule:update">, z.ZodLiteral<"access-rule:delete">, z.ZodLiteral<"access-rule:create">, z.ZodLiteral<"schedule:read">, z.ZodLiteral<"schedule:update">, z.ZodLiteral<"schedule:delete">, z.ZodLiteral<"schedule:create">, z.ZodLiteral<"presence:read">, z.ZodLiteral<"presence:update">, z.ZodLiteral<"presence:update-reader">, z.ZodLiteral<"factory:read">, z.ZodLiteral<"factory:update">, z.ZodLiteral<"factory:delete">, z.ZodLiteral<"factory:create">, z.ZodLiteral<"event:read">, z.ZodLiteral<"event:purge">, z.ZodLiteral<"alarm:read">, z.ZodLiteral<"alarm:acknowlede">, z.ZodLiteral<"alarm:arm">, z.ZodLiteral<"alarm:trigger">, z.ZodLiteral<"user:read">, z.ZodLiteral<"user:change-password">, z.ZodLiteral<"user:change-username">, z.ZodLiteral<"user:change-name">, z.ZodLiteral<"user:change-email">, z.ZodLiteral<"user:activate">, z.ZodLiteral<"user:delete">, z.ZodLiteral<"user:change-roles">, z.ZodLiteral<"user:create">, z.ZodLiteral<"role:read">, z.ZodLiteral<"role:create">, z.ZodLiteral<"role:delete">, z.ZodLiteral<"role:update">, z.ZodLiteral<"module:read">, z.ZodLiteral<"module:update">, z.ZodLiteral<"module:enable">, z.ZodLiteral<"device:discover">, z.ZodLiteral<"device:import">, z.ZodLiteral<"device:override-specs">, z.ZodLiteral<"automation:read">, z.ZodLiteral<"automation:update">, z.ZodLiteral<"automation:delete">, z.ZodLiteral<"automation:create">, z.ZodLiteral<"device-group:read">, z.ZodLiteral<"device-group:update">, z.ZodLiteral<"device-group:delete">, z.ZodLiteral<"device-group:create">, z.ZodLiteral<"macro:read">, z.ZodLiteral<"macro:update">, z.ZodLiteral<"macro:delete">, z.ZodLiteral<"macro:create">, z.ZodLiteral<"macro:run">, z.ZodLiteral<"template:read">, z.ZodLiteral<"template:update">, z.ZodLiteral<"template:delete">, z.ZodLiteral<"template:create">, z.ZodLiteral<"custom-field:read">, z.ZodLiteral<"custom-field:update">, z.ZodLiteral<"custom-field:delete">, z.ZodLiteral<"custom-field:create">, z.ZodLiteral<"media:read">, z.ZodLiteral<"about:read">, z.ZodLiteral<"intercom:read">, ...(z.ZodLiteral<"device:camera"> | z.ZodLiteral<"device:door"> | z.ZodLiteral<"device:motion-sensor"> | z.ZodLiteral<"device:panic-button"> | z.ZodLiteral<"device:intercom-terminal">)[]]>;
+export type PermissionArea = 'layout' | 'camera' | 'preset' | 'door' | 'public-view' | 'private-view' | 'person' | 'door-group' | 'access-rule' | 'schedule' | 'presence' | 'factory' | 'event' | 'alarm' | 'user' | 'role' | 'device' | 'module' | 'automation' | 'device-group' | 'macro' | 'template' | 'custom-field' | 'media' | 'about' | 'intercom' | 'device';
+export declare const permissions: Record<"device:camera" | "device:door" | "device:motion-sensor" | "device:panic-button" | "device:intercom-terminal" | "layout:read" | "layout:update" | "layout:delete" | "layout:create" | "camera:live" | "camera:playback" | "camera:playback-export" | "camera:ptz" | "camera:privacy-mode" | "camera:assign" | "preset:read" | "preset:update" | "preset:delete" | "preset:create" | "door:release" | "door:lock" | "camera-lift:activate" | "io-board:activate" | "public-view:read" | "public-view:update" | "public-view:delete" | "public-view:create" | "private-view:read" | "private-view:update" | "private-view:delete" | "private-view:create" | "person:read" | "person:update" | "person:delete" | "person:create" | "person:assign" | "person:print" | "door-group:read" | "door-group:update" | "door-group:delete" | "door-group:create" | "access-rule:read" | "access-rule:update" | "access-rule:delete" | "access-rule:create" | "schedule:read" | "schedule:update" | "schedule:delete" | "schedule:create" | "presence:read" | "presence:update" | "presence:update-reader" | "factory:read" | "factory:update" | "factory:delete" | "factory:create" | "event:read" | "event:purge" | "alarm:read" | "alarm:acknowlede" | "alarm:arm" | "alarm:trigger" | "user:read" | "user:change-password" | "user:change-username" | "user:change-name" | "user:change-email" | "user:activate" | "user:delete" | "user:change-roles" | "user:create" | "role:read" | "role:create" | "role:delete" | "role:update" | "module:read" | "module:update" | "module:enable" | "device:discover" | "device:import" | "device:override-specs" | "automation:read" | "automation:update" | "automation:delete" | "automation:create" | "device-group:read" | "device-group:update" | "device-group:delete" | "device-group:create" | "macro:read" | "macro:update" | "macro:delete" | "macro:create" | "macro:run" | "template:read" | "template:update" | "template:delete" | "template:create" | "custom-field:read" | "custom-field:update" | "custom-field:delete" | "custom-field:create" | "media:read" | "about:read" | "intercom:read", string>;
+export declare const permissionsArray: ("device:camera" | "device:door" | "device:motion-sensor" | "device:panic-button" | "device:intercom-terminal" | "layout:read" | "layout:update" | "layout:delete" | "layout:create" | "camera:live" | "camera:playback" | "camera:playback-export" | "camera:ptz" | "camera:privacy-mode" | "camera:assign" | "preset:read" | "preset:update" | "preset:delete" | "preset:create" | "door:release" | "door:lock" | "camera-lift:activate" | "io-board:activate" | "public-view:read" | "public-view:update" | "public-view:delete" | "public-view:create" | "private-view:read" | "private-view:update" | "private-view:delete" | "private-view:create" | "person:read" | "person:update" | "person:delete" | "person:create" | "person:assign" | "person:print" | "door-group:read" | "door-group:update" | "door-group:delete" | "door-group:create" | "access-rule:read" | "access-rule:update" | "access-rule:delete" | "access-rule:create" | "schedule:read" | "schedule:update" | "schedule:delete" | "schedule:create" | "presence:read" | "presence:update" | "presence:update-reader" | "factory:read" | "factory:update" | "factory:delete" | "factory:create" | "event:read" | "event:purge" | "alarm:read" | "alarm:acknowlede" | "alarm:arm" | "alarm:trigger" | "user:read" | "user:change-password" | "user:change-username" | "user:change-name" | "user:change-email" | "user:activate" | "user:delete" | "user:change-roles" | "user:create" | "role:read" | "role:create" | "role:delete" | "role:update" | "module:read" | "module:update" | "module:enable" | "device:discover" | "device:import" | "device:override-specs" | "automation:read" | "automation:update" | "automation:delete" | "automation:create" | "device-group:read" | "device-group:update" | "device-group:delete" | "device-group:create" | "macro:read" | "macro:update" | "macro:delete" | "macro:create" | "macro:run" | "template:read" | "template:update" | "template:delete" | "template:create" | "custom-field:read" | "custom-field:update" | "custom-field:delete" | "custom-field:create" | "media:read" | "about:read" | "intercom:read")[];
+export type PermissionId = z.infer<typeof sPermissionId>;

package/dist/permissions.js

@@ -0,0 +1,168 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.permissionsArray = exports.permissions = exports.sPermissionId = void 0;
+const zod_1 = require("zod");
+// Some Device Types omitted for now until we work out if they are needed
+const deviceTypePermissions = {
+    camera: zod_1.z.literal('device:camera').describe('View cameras'),
+    door: zod_1.z.literal('device:door').describe('View doors'),
+    'motion-sensor': zod_1.z
+        .literal('device:motion-sensor')
+        .describe('View motion sensors'),
+    'panic-button': zod_1.z
+        .literal('device:panic-button')
+        .describe('View panic buttons'),
+    'intercom-terminal': zod_1.z
+        .literal('device:intercom-terminal')
+        .describe('View intercom terminals'),
+};
+const sDeviceTypePermissions = Object.values(deviceTypePermissions);
+exports.sPermissionId = zod_1.z.union([
+    //Layout
+    zod_1.z.literal('layout:read').describe('Read layout data'),
+    zod_1.z.literal('layout:update').describe('Update layouts'),
+    zod_1.z.literal('layout:delete').describe('Delete layout'),
+    zod_1.z.literal('layout:create').describe('Create layout'),
+    //Camera
+    zod_1.z.literal('camera:live').describe('View live camera feed'),
+    zod_1.z.literal('camera:playback').describe('View camera playback'),
+    zod_1.z.literal('camera:playback-export').describe('Export camera playback'),
+    zod_1.z.literal('camera:ptz').describe('Control camera PTZ'),
+    zod_1.z.literal('camera:privacy-mode').describe('Control camera privacy mode'),
+    zod_1.z.literal('camera:assign').describe('Assign adjacent cameras to devices'),
+    //Preset
+    zod_1.z.literal('preset:read').describe('Use camera presets'),
+    zod_1.z.literal('preset:update').describe('Update presets'),
+    zod_1.z.literal('preset:delete').describe('Delete preset'),
+    zod_1.z.literal('preset:create').describe('Create preset'),
+    //Door
+    zod_1.z.literal('door:release').describe('Release door'),
+    zod_1.z.literal('door:lock').describe('Lock or unlock door'),
+    //Camera Lift
+    zod_1.z.literal('camera-lift:activate').describe('Activate camera lifts'),
+    //IO Board
+    zod_1.z.literal('io-board:activate').describe('Activate IO board outputs'),
+    //Public View
+    zod_1.z.literal('public-view:read').describe('Read public view data'),
+    zod_1.z.literal('public-view:update').describe('Update public views'),
+    zod_1.z.literal('public-view:delete').describe('Delete public view'),
+    zod_1.z.literal('public-view:create').describe('Create public view'),
+    //Private View
+    zod_1.z.literal('private-view:read').describe('Read private view data'),
+    zod_1.z.literal('private-view:update').describe('Update private views'),
+    zod_1.z.literal('private-view:delete').describe('Delete private view'),
+    zod_1.z.literal('private-view:create').describe('Create private view'),
+    //Person
+    zod_1.z.literal('person:read').describe('Read person data'),
+    zod_1.z.literal('person:update').describe('Update person data'),
+    zod_1.z.literal('person:delete').describe('Delete person'),
+    zod_1.z.literal('person:create').describe('Create person'),
+    zod_1.z.literal('person:assign').describe('Assign credentials and access rules'),
+    zod_1.z.literal('person:print').describe('Print person details'),
+    //Doors and Groups (needs access to doors to be useful)
+    zod_1.z.literal('door-group:read').describe('Read door group data'),
+    zod_1.z.literal('door-group:update').describe('Update door group'),
+    zod_1.z.literal('door-group:delete').describe('Delete door group'),
+    zod_1.z.literal('door-group:create').describe('Create door group'),
+    //Access Rule
+    zod_1.z.literal('access-rule:read').describe('Read access rule data'),
+    zod_1.z.literal('access-rule:update').describe('Update access rules'),
+    zod_1.z.literal('access-rule:delete').describe('Delete access rule'),
+    zod_1.z.literal('access-rule:create').describe('Create access rule'),
+    //Schedule
+    zod_1.z.literal('schedule:read').describe('Read schedule data'),
+    zod_1.z.literal('schedule:update').describe('Update schedule data'),
+    zod_1.z.literal('schedule:delete').describe('Delete schedule'),
+    zod_1.z.literal('schedule:create').describe('Create schedule'),
+    //Presence
+    zod_1.z.literal('presence:read').describe('Read presence data'),
+    zod_1.z.literal('presence:update').describe('Update presence data'),
+    zod_1.z
+        .literal('presence:update-reader')
+        .describe('Update presence via USB reader'),
+    //Factory
+    zod_1.z.literal('factory:read').describe('Read custom devices'),
+    zod_1.z.literal('factory:update').describe('Update custom devices'),
+    zod_1.z.literal('factory:delete').describe('Delete custom device'),
+    zod_1.z.literal('factory:create').describe('Create custom device'),
+    //Event
+    zod_1.z.literal('event:read').describe('View events'),
+    zod_1.z.literal('event:purge').describe('Clear events'), //No UI effect yet
+    //Alarm
+    zod_1.z.literal('alarm:read').describe('View alarms'),
+    zod_1.z.literal('alarm:acknowlede').describe('Acknowledge alarms'),
+    zod_1.z.literal('alarm:arm').describe('Can arm or disarm'),
+    zod_1.z.literal('alarm:trigger').describe('Can trigger alarms'),
+    //User
+    zod_1.z.literal('user:read').describe('View user data'),
+    zod_1.z.literal('user:change-password').describe('Change user password'),
+    zod_1.z.literal('user:change-username').describe('Change user login id'),
+    zod_1.z.literal('user:change-name').describe('Change user name'),
+    zod_1.z.literal('user:change-email').describe('Change user email'),
+    zod_1.z.literal('user:activate').describe('Activate or Deactivate user'),
+    zod_1.z.literal('user:delete').describe('Delete user'),
+    zod_1.z.literal('user:change-roles').describe('Change user roles'),
+    zod_1.z.literal('user:create').describe('Create user'),
+    //Role
+    zod_1.z.literal('role:read').describe('View role data'),
+    zod_1.z.literal('role:create').describe('Create role'),
+    zod_1.z.literal('role:delete').describe('Delete role'),
+    zod_1.z.literal('role:update').describe('Update role data'),
+    //Module
+    zod_1.z.literal('module:read').describe('View module settings'),
+    zod_1.z.literal('module:update').describe('Update module settings'),
+    zod_1.z.literal('module:enable').describe('Enable and disable modules'),
+    //Device
+    zod_1.z.literal('device:discover').describe('Discover devices'), //No UI effect yet
+    zod_1.z.literal('device:import').describe('Import discovered devices'), //No UI effect yet
+    zod_1.z.literal('device:override-specs').describe('Override device specs'),
+    //Automation
+    zod_1.z.literal('automation:read').describe('View automation data'),
+    zod_1.z.literal('automation:update').describe('Update automation data'), //No UI effect yet
+    zod_1.z.literal('automation:delete').describe('Delete automation'), //No UI effect yet
+    zod_1.z.literal('automation:create').describe('Create automation'), //No UI effect yet
+    //Device Groups
+    zod_1.z.literal('device-group:read').describe('View device groups'),
+    zod_1.z.literal('device-group:update').describe('Update device groups'),
+    zod_1.z.literal('device-group:delete').describe('Delete device group'),
+    zod_1.z.literal('device-group:create').describe('Create device group'),
+    //Macros
+    zod_1.z.literal('macro:read').describe('View macros'),
+    zod_1.z.literal('macro:update').describe('Update macros'),
+    zod_1.z.literal('macro:delete').describe('Delete macro'),
+    zod_1.z.literal('macro:create').describe('Create macro'),
+    zod_1.z.literal('macro:run').describe('Run macro'),
+    //Templates
+    zod_1.z.literal('template:read').describe('View templates'),
+    zod_1.z.literal('template:update').describe('Update templates'),
+    zod_1.z.literal('template:delete').describe('Delete template'),
+    zod_1.z.literal('template:create').describe('Create template'),
+    //Custom Fields
+    zod_1.z.literal('custom-field:read').describe('View custom fields'),
+    zod_1.z.literal('custom-field:update').describe('Update custom fields'),
+    zod_1.z.literal('custom-field:delete').describe('Delete custom field'),
+    zod_1.z.literal('custom-field:create').describe('Create custom field'),
+    //Media
+    zod_1.z.literal('media:read').describe('View media page'),
+    //About
+    zod_1.z.literal('about:read').describe('View about data'),
+    //Intercom
+    zod_1.z.literal('intercom:read').describe('View intercom data'), //No UI effect yet
+    //Devices
+    ...sDeviceTypePermissions, //No UI effects yet
+]);
+const permissionsToRecord = (permissions) => {
+    const options = permissions.options;
+    return options.reduce((acc, option) => {
+        const key = option.value;
+        const description = option.description;
+        acc[key] = description || '';
+        return acc;
+    }, {});
+};
+const permissionsToArray = (permissions) => {
+    const options = permissions.options;
+    return options.map((option) => option.value);
+};
+exports.permissions = permissionsToRecord(exports.sPermissionId);
+exports.permissionsArray = permissionsToArray(exports.sPermissionId);