@awarevue/api-types 1.0.1

package/dist/access-control/access-rule.d.ts

@@ -0,0 +1,243 @@
+import z from 'zod';
+export declare const sAccessRulePersonDto: z.ZodObject<{
+    id: z.ZodString;
+    firstName: z.ZodString;
+    lastName: z.ZodString;
+    avatarId: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    firstName: string;
+    lastName: string;
+    avatarId: string | null;
+}, {
+    id: string;
+    firstName: string;
+    lastName: string;
+    avatarId: string | null;
+}>;
+export type AccessRulePersonDto = z.infer<typeof sAccessRulePersonDto>;
+export declare const sAccessRulePermissionDto: z.ZodObject<{
+    deviceId: z.ZodString;
+    scheduleId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    deviceId: string;
+    scheduleId: string;
+}, {
+    deviceId: string;
+    scheduleId: string;
+}>;
+export type AccessRulePermissionDto = z.infer<typeof sAccessRulePermissionDto>;
+export declare const sAccessRuleGroupPermissionDto: z.ZodObject<{
+    groupId: z.ZodString;
+    scheduleId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    scheduleId: string;
+    groupId: string;
+}, {
+    scheduleId: string;
+    groupId: string;
+}>;
+export type AccessRuleGroupPermissionDto = z.infer<typeof sAccessRuleGroupPermissionDto>;
+export declare const sAccessRuleDto: z.ZodObject<{
+    id: z.ZodString;
+    displayName: z.ZodString;
+    appliedTo: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        firstName: z.ZodString;
+        lastName: z.ZodString;
+        avatarId: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        firstName: string;
+        lastName: string;
+        avatarId: string | null;
+    }, {
+        id: string;
+        firstName: string;
+        lastName: string;
+        avatarId: string | null;
+    }>, "many">;
+    permissions: z.ZodArray<z.ZodObject<{
+        deviceId: z.ZodString;
+        scheduleId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        deviceId: string;
+        scheduleId: string;
+    }, {
+        deviceId: string;
+        scheduleId: string;
+    }>, "many">;
+    groupPermissions: z.ZodArray<z.ZodObject<{
+        groupId: z.ZodString;
+        scheduleId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        scheduleId: string;
+        groupId: string;
+    }, {
+        scheduleId: string;
+        groupId: string;
+    }>, "many">;
+    createdOn: z.ZodString;
+    lastModifiedOn: z.ZodString;
+    refs: z.ZodRecord<z.ZodString, z.ZodString>;
+    version: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    version: number;
+    displayName: string;
+    createdOn: string;
+    lastModifiedOn: string;
+    appliedTo: {
+        id: string;
+        firstName: string;
+        lastName: string;
+        avatarId: string | null;
+    }[];
+    permissions: {
+        deviceId: string;
+        scheduleId: string;
+    }[];
+    groupPermissions: {
+        scheduleId: string;
+        groupId: string;
+    }[];
+    refs: Record<string, string>;
+}, {
+    id: string;
+    version: number;
+    displayName: string;
+    createdOn: string;
+    lastModifiedOn: string;
+    appliedTo: {
+        id: string;
+        firstName: string;
+        lastName: string;
+        avatarId: string | null;
+    }[];
+    permissions: {
+        deviceId: string;
+        scheduleId: string;
+    }[];
+    groupPermissions: {
+        scheduleId: string;
+        groupId: string;
+    }[];
+    refs: Record<string, string>;
+}>;
+export type AccessRuleDto = z.infer<typeof sAccessRuleDto>;
+export declare const sCreateAccessRuleRequest: z.ZodObject<{
+    displayName: z.ZodString;
+    appliedTo: z.ZodArray<z.ZodString, "many">;
+    permissions: z.ZodArray<z.ZodObject<{
+        deviceId: z.ZodString;
+        scheduleId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        deviceId: string;
+        scheduleId: string;
+    }, {
+        deviceId: string;
+        scheduleId: string;
+    }>, "many">;
+    groupPermissions: z.ZodArray<z.ZodObject<{
+        groupId: z.ZodString;
+        scheduleId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        scheduleId: string;
+        groupId: string;
+    }, {
+        scheduleId: string;
+        groupId: string;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    displayName: string;
+    appliedTo: string[];
+    permissions: {
+        deviceId: string;
+        scheduleId: string;
+    }[];
+    groupPermissions: {
+        scheduleId: string;
+        groupId: string;
+    }[];
+}, {
+    displayName: string;
+    appliedTo: string[];
+    permissions: {
+        deviceId: string;
+        scheduleId: string;
+    }[];
+    groupPermissions: {
+        scheduleId: string;
+        groupId: string;
+    }[];
+}>;
+export declare const sUpdateAccessRuleRequest: z.ZodObject<{
+    displayName: z.ZodOptional<z.ZodString>;
+    appliedTo: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    permissions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        deviceId: z.ZodString;
+        scheduleId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        deviceId: string;
+        scheduleId: string;
+    }, {
+        deviceId: string;
+        scheduleId: string;
+    }>, "many">>;
+    groupPermissions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        groupId: z.ZodString;
+        scheduleId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        scheduleId: string;
+        groupId: string;
+    }, {
+        scheduleId: string;
+        groupId: string;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    displayName?: string | undefined;
+    appliedTo?: string[] | undefined;
+    permissions?: {
+        deviceId: string;
+        scheduleId: string;
+    }[] | undefined;
+    groupPermissions?: {
+        scheduleId: string;
+        groupId: string;
+    }[] | undefined;
+}, {
+    displayName?: string | undefined;
+    appliedTo?: string[] | undefined;
+    permissions?: {
+        deviceId: string;
+        scheduleId: string;
+    }[] | undefined;
+    groupPermissions?: {
+        scheduleId: string;
+        groupId: string;
+    }[] | undefined;
+}>;
+export declare const sAddMemberToAccessRuleRequest: z.ZodObject<{
+    personId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    personId: string;
+}, {
+    personId: string;
+}>;
+export declare const sRemoveMemberFromAccessRuleRequest: z.ZodObject<{
+    personId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    personId: string;
+}, {
+    personId: string;
+}>;
+export type CreateAccessRuleRequest = z.infer<typeof sCreateAccessRuleRequest>;
+export type UpdateAccessRuleRequest = {
+    id: string;
+} & z.infer<typeof sUpdateAccessRuleRequest>;
+export type AddMemberToAccessRuleRequest = {
+    id: string;
+} & z.infer<typeof sAddMemberToAccessRuleRequest>;
+export type RemoveMemberFromAccessRuleRequest = {
+    id: string;
+} & z.infer<typeof sRemoveMemberFromAccessRuleRequest>;

package/dist/access-control/access-rule.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sRemoveMemberFromAccessRuleRequest = exports.sAddMemberToAccessRuleRequest = exports.sUpdateAccessRuleRequest = exports.sCreateAccessRuleRequest = exports.sAccessRuleDto = exports.sAccessRuleGroupPermissionDto = exports.sAccessRulePermissionDto = exports.sAccessRulePersonDto = void 0;
+const zod_1 = __importDefault(require("zod"));
+exports.sAccessRulePersonDto = zod_1.default.object({
+    id: zod_1.default.string().describe('Person ID'),
+    firstName: zod_1.default.string().describe('First name'),
+    lastName: zod_1.default.string().describe('Last name'),
+    avatarId: zod_1.default.string().nullable().describe('Avatar ID'),
+});
+exports.sAccessRulePermissionDto = zod_1.default.object({
+    deviceId: zod_1.default.string().describe('Device ID').nonempty(),
+    scheduleId: zod_1.default.string().describe('Schedule ID').nonempty(),
+});
+exports.sAccessRuleGroupPermissionDto = zod_1.default.object({
+    groupId: zod_1.default.string().describe('Group ID').nonempty(),
+    scheduleId: zod_1.default.string().describe('Schedule ID').nonempty(),
+});
+exports.sAccessRuleDto = zod_1.default.object({
+    id: zod_1.default.string().describe('Access rule ID'),
+    displayName: zod_1.default.string().describe('Display name'),
+    appliedTo: zod_1.default.array(exports.sAccessRulePersonDto).describe('Applied to'),
+    permissions: zod_1.default.array(exports.sAccessRulePermissionDto).describe('Permissions'),
+    groupPermissions: zod_1.default
+        .array(exports.sAccessRuleGroupPermissionDto)
+        .describe('Group permissions'),
+    createdOn: zod_1.default.string().describe('Created on'),
+    lastModifiedOn: zod_1.default.string().describe('Last modified on'),
+    refs: zod_1.default.record(zod_1.default.string()).describe('References'),
+    version: zod_1.default.number().describe('Version'),
+});
+exports.sCreateAccessRuleRequest = zod_1.default.object({
+    displayName: zod_1.default.string().nonempty().describe('Display name'),
+    appliedTo: zod_1.default.array(zod_1.default.string().nonempty()).describe('Applied to'),
+    permissions: zod_1.default.array(exports.sAccessRulePermissionDto).describe('Permissions'),
+    groupPermissions: zod_1.default
+        .array(exports.sAccessRuleGroupPermissionDto)
+        .describe('Group permissions'),
+});
+exports.sUpdateAccessRuleRequest = exports.sCreateAccessRuleRequest.partial();
+exports.sAddMemberToAccessRuleRequest = zod_1.default.object({
+    personId: zod_1.default.string().nonempty().describe('Person ID'),
+});
+exports.sRemoveMemberFromAccessRuleRequest = zod_1.default.object({
+    personId: zod_1.default.string().nonempty().describe('Person ID'),
+});

package/dist/access-control/credential.d.ts

@@ -0,0 +1,14 @@
+import z from 'zod';
+export declare const sCredentialType: z.ZodEnum<["card", "pin", "login-password"]>;
+export declare const sAssignedCredential: z.ZodObject<{
+    type: z.ZodEnum<["card", "pin", "login-password"]>;
+    value: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "card" | "pin" | "login-password";
+    value: string;
+}, {
+    type: "card" | "pin" | "login-password";
+    value: string;
+}>;
+export type CredentialType = z.infer<typeof sCredentialType>;
+export type AssignedCredential = z.infer<typeof sAssignedCredential>;

package/dist/access-control/credential.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sAssignedCredential = exports.sCredentialType = void 0;
+const zod_1 = __importDefault(require("zod"));
+exports.sCredentialType = zod_1.default.enum(['card', 'pin', 'login-password']);
+exports.sAssignedCredential = zod_1.default.object({
+    type: exports.sCredentialType,
+    value: zod_1.default.string().nonempty(),
+});

package/dist/access-control/index.d.ts

@@ -0,0 +1,7 @@
+export * from './access-rule';
+export * from './credential';
+export * from './schedule';
+export * from './person';
+export * from './zone';
+export * from './sync';
+export * from './person-presence';

package/dist/access-control/index.js

@@ -0,0 +1,23 @@
+"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("./access-rule"), exports);
+__exportStar(require("./credential"), exports);
+__exportStar(require("./schedule"), exports);
+__exportStar(require("./person"), exports);
+__exportStar(require("./zone"), exports);
+__exportStar(require("./sync"), exports);
+__exportStar(require("./person-presence"), exports);

package/dist/access-control/person-presence.d.ts

@@ -0,0 +1,249 @@
+import { z } from 'zod';
+export declare const sPresencePersonDto: z.ZodObject<{
+    id: z.ZodString;
+    firstName: z.ZodString;
+    lastName: z.ZodString;
+    avatarId: z.ZodNullable<z.ZodString>;
+    staffMember: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    firstName: string;
+    lastName: string;
+    avatarId: string | null;
+    staffMember: boolean;
+}, {
+    id: string;
+    firstName: string;
+    lastName: string;
+    avatarId: string | null;
+    staffMember: boolean;
+}>;
+export type PresencePersonDto = z.infer<typeof sPresencePersonDto>;
+export declare const sPresenceZoneDto: z.ZodObject<{
+    id: z.ZodString;
+    displayName: z.ZodString;
+    isGlobal: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    displayName: string;
+    isGlobal: boolean;
+}, {
+    id: string;
+    displayName: string;
+    isGlobal: boolean;
+}>;
+export type PresenceZoneDto = z.infer<typeof sPresenceZoneDto>;
+export declare const sPersonPresenceDto: z.ZodObject<{
+    id: z.ZodString;
+    person: z.ZodObject<{
+        id: z.ZodString;
+        firstName: z.ZodString;
+        lastName: z.ZodString;
+        avatarId: z.ZodNullable<z.ZodString>;
+        staffMember: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        firstName: string;
+        lastName: string;
+        avatarId: string | null;
+        staffMember: boolean;
+    }, {
+        id: string;
+        firstName: string;
+        lastName: string;
+        avatarId: string | null;
+        staffMember: boolean;
+    }>;
+    zone: z.ZodUnion<[z.ZodObject<{
+        id: z.ZodString;
+        displayName: z.ZodString;
+        isGlobal: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        displayName: string;
+        isGlobal: boolean;
+    }, {
+        id: string;
+        displayName: string;
+        isGlobal: boolean;
+    }>, z.ZodString]>;
+    online: z.ZodNullable<z.ZodBoolean>;
+    onLeave: z.ZodBoolean;
+    lastCheckInOn: z.ZodNullable<z.ZodNumber>;
+    lastCheckOutOn: z.ZodNullable<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    online: boolean | null;
+    person: {
+        id: string;
+        firstName: string;
+        lastName: string;
+        avatarId: string | null;
+        staffMember: boolean;
+    };
+    zone: string | {
+        id: string;
+        displayName: string;
+        isGlobal: boolean;
+    };
+    onLeave: boolean;
+    lastCheckInOn: number | null;
+    lastCheckOutOn: number | null;
+}, {
+    id: string;
+    online: boolean | null;
+    person: {
+        id: string;
+        firstName: string;
+        lastName: string;
+        avatarId: string | null;
+        staffMember: boolean;
+    };
+    zone: string | {
+        id: string;
+        displayName: string;
+        isGlobal: boolean;
+    };
+    onLeave: boolean;
+    lastCheckInOn: number | null;
+    lastCheckOutOn: number | null;
+}>;
+export type PersonPresenceDto = z.infer<typeof sPersonPresenceDto>;
+export declare const sPersonPresenceActionDto: z.ZodObject<{
+    id: z.ZodString;
+    person: z.ZodUnion<[z.ZodObject<{
+        id: z.ZodString;
+        firstName: z.ZodString;
+        lastName: z.ZodString;
+        avatarId: z.ZodNullable<z.ZodString>;
+        staffMember: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        firstName: string;
+        lastName: string;
+        avatarId: string | null;
+        staffMember: boolean;
+    }, {
+        id: string;
+        firstName: string;
+        lastName: string;
+        avatarId: string | null;
+        staffMember: boolean;
+    }>, z.ZodString]>;
+    zone: z.ZodUnion<[z.ZodObject<{
+        id: z.ZodString;
+        displayName: z.ZodString;
+        isGlobal: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        displayName: string;
+        isGlobal: boolean;
+    }, {
+        id: string;
+        displayName: string;
+        isGlobal: boolean;
+    }>, z.ZodString]>;
+    timestamp: z.ZodNumber;
+    checkInOrOut: z.ZodBoolean;
+    isLeave: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    person: string | {
+        id: string;
+        firstName: string;
+        lastName: string;
+        avatarId: string | null;
+        staffMember: boolean;
+    };
+    zone: string | {
+        id: string;
+        displayName: string;
+        isGlobal: boolean;
+    };
+    timestamp: number;
+    checkInOrOut: boolean;
+    isLeave: boolean;
+}, {
+    id: string;
+    person: string | {
+        id: string;
+        firstName: string;
+        lastName: string;
+        avatarId: string | null;
+        staffMember: boolean;
+    };
+    zone: string | {
+        id: string;
+        displayName: string;
+        isGlobal: boolean;
+    };
+    timestamp: number;
+    checkInOrOut: boolean;
+    isLeave: boolean;
+}>;
+export type PersonPresenceActionDto = z.infer<typeof sPersonPresenceActionDto>;
+export declare const sPersonPresenceQuery: z.ZodObject<{
+    persons: z.ZodArray<z.ZodString, "many">;
+    zones: z.ZodArray<z.ZodString, "many">;
+    online: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    online: boolean;
+    persons: string[];
+    zones: string[];
+}, {
+    online: boolean;
+    persons: string[];
+    zones: string[];
+}>;
+export type PersonPresenceQuery = z.infer<typeof sPersonPresenceQuery>;
+export declare const sPersonTogglePresence: z.ZodUnion<[z.ZodObject<{
+    personId: z.ZodString;
+    zoneId: z.ZodString;
+    credentialToken: z.ZodUndefined;
+}, "strip", z.ZodTypeAny, {
+    personId: string;
+    zoneId: string;
+    credentialToken?: undefined;
+}, {
+    personId: string;
+    zoneId: string;
+    credentialToken?: undefined;
+}>, z.ZodObject<{
+    credentialToken: z.ZodString;
+    zoneId: z.ZodString;
+    personId: z.ZodUndefined;
+}, "strip", z.ZodTypeAny, {
+    zoneId: string;
+    credentialToken: string;
+    personId?: undefined;
+}, {
+    zoneId: string;
+    credentialToken: string;
+    personId?: undefined;
+}>]>;
+export declare const sPersonCheckIn: z.ZodObject<{
+    personId: z.ZodString;
+    zoneId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    personId: string;
+    zoneId: string;
+}, {
+    personId: string;
+    zoneId: string;
+}>;
+export declare const sPersonCheckOut: z.ZodObject<{
+    personId: z.ZodString;
+    zoneId: z.ZodString;
+    leave: z.ZodNullable<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    personId: string;
+    zoneId: string;
+    leave: boolean | null;
+}, {
+    personId: string;
+    zoneId: string;
+    leave: boolean | null;
+}>;
+export type PresenceToggleRequest = z.infer<typeof sPersonTogglePresence>;
+export type PresenceCheckInRequest = z.infer<typeof sPersonCheckIn>;
+export type PresenceCheckOutRequest = z.infer<typeof sPersonCheckOut>;

package/dist/access-control/person-presence.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sPersonCheckOut = exports.sPersonCheckIn = exports.sPersonTogglePresence = exports.sPersonPresenceQuery = exports.sPersonPresenceActionDto = exports.sPersonPresenceDto = exports.sPresenceZoneDto = exports.sPresencePersonDto = void 0;
+const zod_1 = require("zod");
+exports.sPresencePersonDto = zod_1.z.object({
+    id: zod_1.z.string(),
+    firstName: zod_1.z.string(),
+    lastName: zod_1.z.string(),
+    avatarId: zod_1.z.string().nullable(),
+    staffMember: zod_1.z.boolean(),
+});
+exports.sPresenceZoneDto = zod_1.z.object({
+    id: zod_1.z.string(),
+    displayName: zod_1.z.string(),
+    isGlobal: zod_1.z
+        .boolean()
+        .describe('Whether the zone is the designated global zone'),
+});
+exports.sPersonPresenceDto = zod_1.z.object({
+    id: zod_1.z.string(),
+    person: exports.sPresencePersonDto,
+    zone: zod_1.z.union([exports.sPresenceZoneDto, zod_1.z.string()]),
+    online: zod_1.z.boolean().nullable(),
+    onLeave: zod_1.z.boolean(),
+    lastCheckInOn: zod_1.z.number().nullable(),
+    lastCheckOutOn: zod_1.z.number().nullable(),
+});
+exports.sPersonPresenceActionDto = zod_1.z.object({
+    id: zod_1.z.string(),
+    person: zod_1.z.union([exports.sPresencePersonDto, zod_1.z.string()]),
+    zone: zod_1.z.union([exports.sPresenceZoneDto, zod_1.z.string()]),
+    timestamp: zod_1.z.number(),
+    checkInOrOut: zod_1.z.boolean(),
+    isLeave: zod_1.z.boolean(),
+});
+exports.sPersonPresenceQuery = zod_1.z.object({
+    persons: zod_1.z.array(zod_1.z.string().nonempty()),
+    zones: zod_1.z.array(zod_1.z.string().nonempty()),
+    online: zod_1.z.boolean(),
+});
+exports.sPersonTogglePresence = zod_1.z.union([
+    zod_1.z.object({
+        personId: zod_1.z.string(),
+        zoneId: zod_1.z.string(),
+        credentialToken: zod_1.z.undefined(),
+    }),
+    zod_1.z.object({
+        credentialToken: zod_1.z.string(),
+        zoneId: zod_1.z.string(),
+        personId: zod_1.z.undefined(),
+    }),
+]);
+exports.sPersonCheckIn = zod_1.z.object({
+    personId: zod_1.z.string(),
+    zoneId: zod_1.z.string(),
+});
+exports.sPersonCheckOut = zod_1.z.object({
+    personId: zod_1.z.string(),
+    zoneId: zod_1.z.string(),
+    leave: zod_1.z.boolean().nullable(),
+});