@awarevue/api-types 2.0.150 → 2.0.152

package/dist/api/error.d.ts

@@ -42,6 +42,20 @@ export declare const sTokenLimitExceededMeta: z.ZodObject<{
         retina: "retina";
     }>;
 }, z.core.$strip>;
+export declare const sPersonTypeNotAccessControlUserMeta: z.ZodObject<{
+    personTypeId: z.ZodString;
+    field: z.ZodEnum<{
+        type: "type";
+        credentials: "credentials";
+        accessRules: "accessRules";
+    }>;
+    personIds: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export declare const sPersonTypeSyncPermissionRequiredMeta: z.ZodObject<{
+    personTypeId: z.ZodString;
+    affectedPeople: z.ZodNumber;
+    permission: z.ZodString;
+}, z.core.$strip>;
 export type VoidMeta = z.infer<typeof sVoidMeta>;
 export type DuplicateMeta = z.infer<typeof sDuplicateMeta>;
 export type NotFoundMeta = z.infer<typeof sNotFoundMeta>;
@@ -75,6 +89,8 @@ export declare enum AppErrorCode {
     TOKEN_INVALID_FORMAT = "TOKEN_INVALID_FORMAT",
     TOKEN_LIMIT_EXCEEDED = "TOKEN_LIMIT_EXCEEDED",
     TOKEN_IN_USE = "TOKEN_IN_USE",
+    PERSON_TYPE_NOT_ACCESS_CONTROL_USER = "PERSON_TYPE_NOT_ACCESS_CONTROL_USER",
+    PERSON_TYPE_SYNC_PERMISSION_REQUIRED = "PERSON_TYPE_SYNC_PERMISSION_REQUIRED",
     DEVICE_NOT_FOUND = "DEVICE_NOT_FOUND",
     DEVICE_ALREADY_EXISTS = "DEVICE_ALREADY_EXISTS",
     DEVICE_INVALID_ID = "DEVICE_INVALID_ID",
@@ -192,6 +208,20 @@ export declare const errorMetadataSchemas: {
         blockingId: z.ZodOptional<z.ZodString>;
         value: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>;
+    readonly PERSON_TYPE_NOT_ACCESS_CONTROL_USER: z.ZodObject<{
+        personTypeId: z.ZodString;
+        field: z.ZodEnum<{
+            type: "type";
+            credentials: "credentials";
+            accessRules: "accessRules";
+        }>;
+        personIds: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>;
+    readonly PERSON_TYPE_SYNC_PERMISSION_REQUIRED: z.ZodObject<{
+        personTypeId: z.ZodString;
+        affectedPeople: z.ZodNumber;
+        permission: z.ZodString;
+    }, z.core.$strip>;
     readonly DEVICE_NOT_FOUND: z.ZodObject<{
         subject: z.ZodString;
         field: z.ZodString;

package/dist/api/error.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.errorMetadataSchemas = exports.AppErrorCode = exports.sTokenLimitExceededMeta = exports.sTokenInvalidFormatMeta = exports.sZoneAccessRuleConflictMeta = exports.sAccessRuleConflictMeta = exports.sVoidMeta = exports.sConflictMeta = exports.sInvalidMeta = exports.sNotFoundMeta = exports.sDuplicateMeta = void 0;
+exports.errorMetadataSchemas = exports.AppErrorCode = exports.sPersonTypeSyncPermissionRequiredMeta = exports.sPersonTypeNotAccessControlUserMeta = exports.sTokenLimitExceededMeta = exports.sTokenInvalidFormatMeta = exports.sZoneAccessRuleConflictMeta = exports.sAccessRuleConflictMeta = exports.sVoidMeta = exports.sConflictMeta = exports.sInvalidMeta = exports.sNotFoundMeta = exports.sDuplicateMeta = void 0;
 exports.isErrorResponse = isErrorResponse;
 const zod_1 = require("zod");
 const credential_type_1 = require("../primitives/credential-type");
@@ -42,6 +42,16 @@ exports.sTokenLimitExceededMeta = zod_1.z.object({
     limit: zod_1.z.number(),
     type: credential_type_1.sCredentialType,
 });
+exports.sPersonTypeNotAccessControlUserMeta = zod_1.z.object({
+    personTypeId: zod_1.z.string(),
+    field: zod_1.z.enum(['credentials', 'accessRules', 'type']),
+    personIds: zod_1.z.array(zod_1.z.string()),
+});
+exports.sPersonTypeSyncPermissionRequiredMeta = zod_1.z.object({
+    personTypeId: zod_1.z.string(),
+    affectedPeople: zod_1.z.number(),
+    permission: zod_1.z.string(),
+});
 // ERROR CODES
 var AppErrorCode;
 (function (AppErrorCode) {
@@ -76,6 +86,8 @@ var AppErrorCode;
     AppErrorCode["TOKEN_INVALID_FORMAT"] = "TOKEN_INVALID_FORMAT";
     AppErrorCode["TOKEN_LIMIT_EXCEEDED"] = "TOKEN_LIMIT_EXCEEDED";
     AppErrorCode["TOKEN_IN_USE"] = "TOKEN_IN_USE";
+    AppErrorCode["PERSON_TYPE_NOT_ACCESS_CONTROL_USER"] = "PERSON_TYPE_NOT_ACCESS_CONTROL_USER";
+    AppErrorCode["PERSON_TYPE_SYNC_PERMISSION_REQUIRED"] = "PERSON_TYPE_SYNC_PERMISSION_REQUIRED";
     // device
     AppErrorCode["DEVICE_NOT_FOUND"] = "DEVICE_NOT_FOUND";
     AppErrorCode["DEVICE_ALREADY_EXISTS"] = "DEVICE_ALREADY_EXISTS";
@@ -138,6 +150,8 @@ exports.errorMetadataSchemas = {
     [AppErrorCode.TOKEN_INVALID_FORMAT]: exports.sTokenInvalidFormatMeta,
     [AppErrorCode.TOKEN_LIMIT_EXCEEDED]: exports.sTokenLimitExceededMeta,
     [AppErrorCode.TOKEN_IN_USE]: exports.sConflictMeta,
+    [AppErrorCode.PERSON_TYPE_NOT_ACCESS_CONTROL_USER]: exports.sPersonTypeNotAccessControlUserMeta,
+    [AppErrorCode.PERSON_TYPE_SYNC_PERMISSION_REQUIRED]: exports.sPersonTypeSyncPermissionRequiredMeta,
     // device
     [AppErrorCode.DEVICE_NOT_FOUND]: exports.sNotFoundMeta,
     [AppErrorCode.DEVICE_ALREADY_EXISTS]: exports.sDuplicateMeta,

package/dist/api/rest/access-control-authority.d.ts

@@ -0,0 +1,48 @@
+import { z } from 'zod';
+export declare const sAccessProviderObjectCounts: z.ZodObject<{
+    person: z.ZodNumber;
+    accessRule: z.ZodNumber;
+    schedule: z.ZodNumber;
+    zone: z.ZodNumber;
+}, z.core.$strip>;
+export type AccessProviderObjectCounts = z.infer<typeof sAccessProviderObjectCounts>;
+export declare const sAccessProviderAuditConflict: z.ZodObject<{
+    personId: z.ZodUUID;
+    firstName: z.ZodString;
+    lastName: z.ZodString;
+    personTypeId: z.ZodString;
+    credentialCount: z.ZodNumber;
+    accessRuleCount: z.ZodNumber;
+}, z.core.$strip>;
+export type AccessProviderAuditConflict = z.infer<typeof sAccessProviderAuditConflict>;
+export declare const sAccessProviderAuditDto: z.ZodObject<{
+    provider: z.ZodString;
+    held: z.ZodObject<{
+        person: z.ZodNumber;
+        accessRule: z.ZodNumber;
+        schedule: z.ZodNumber;
+        zone: z.ZodNumber;
+    }, z.core.$strip>;
+    people: z.ZodObject<{
+        eligible: z.ZodNumber;
+        toAdd: z.ZodNumber;
+        toRemove: z.ZodNumber;
+    }, z.core.$strip>;
+    conflicts: z.ZodArray<z.ZodObject<{
+        personId: z.ZodUUID;
+        firstName: z.ZodString;
+        lastName: z.ZodString;
+        personTypeId: z.ZodString;
+        credentialCount: z.ZodNumber;
+        accessRuleCount: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type AccessProviderAuditDto = z.infer<typeof sAccessProviderAuditDto>;
+export declare const sPersonTypeSyncImpactDto: z.ZodObject<{
+    personTypeId: z.ZodString;
+    accessControlUser: z.ZodBoolean;
+    affectedPeople: z.ZodNumber;
+    peopleWithAccess: z.ZodNumber;
+    syncRequired: z.ZodBoolean;
+}, z.core.$strip>;
+export type PersonTypeSyncImpactDto = z.infer<typeof sPersonTypeSyncImpactDto>;

package/dist/api/rest/access-control-authority.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sPersonTypeSyncImpactDto = exports.sAccessProviderAuditDto = exports.sAccessProviderAuditConflict = exports.sAccessProviderObjectCounts = void 0;
+const zod_1 = require("zod");
+// Number of local objects that currently have a reference in the provider
+exports.sAccessProviderObjectCounts = zod_1.z.object({
+    person: zod_1.z.number().int(),
+    accessRule: zod_1.z.number().int(),
+    schedule: zod_1.z.number().int(),
+    zone: zod_1.z.number().int(),
+});
+// LEGACY(access-control-user-sync): remove once no site has conflicts
+// A person whose type is not an access control user, but who still holds
+// credentials or access rules. A resync removes them from the provider.
+exports.sAccessProviderAuditConflict = zod_1.z.object({
+    personId: zod_1.z.uuid(),
+    firstName: zod_1.z.string(),
+    lastName: zod_1.z.string(),
+    personTypeId: zod_1.z.string(),
+    credentialCount: zod_1.z.number().int(),
+    accessRuleCount: zod_1.z.number().int(),
+});
+exports.sAccessProviderAuditDto = zod_1.z.object({
+    provider: zod_1.z.string(),
+    // objects held in the provider, according to the reference table
+    held: exports.sAccessProviderObjectCounts,
+    people: zod_1.z.object({
+        // people whose type is an access control user
+        eligible: zod_1.z.number().int(),
+        // eligible people not yet in the provider; a resync adds them
+        toAdd: zod_1.z.number().int(),
+        // people in the provider whose type is not an access control user;
+        // a resync removes them
+        toRemove: zod_1.z.number().int(),
+    }),
+    // LEGACY(access-control-user-sync): remove once no site has conflicts
+    conflicts: zod_1.z.array(exports.sAccessProviderAuditConflict),
+});
+// Effect of toggling accessControlUser on a person type
+exports.sPersonTypeSyncImpactDto = zod_1.z.object({
+    personTypeId: zod_1.z.string(),
+    // the value the flag would change to
+    accessControlUser: zod_1.z.boolean(),
+    // people that would be added to (enabling) or removed from (disabling)
+    // the access control providers; 0 when no provider is connected
+    affectedPeople: zod_1.z.number().int(),
+    // people whose credentials and access rules would be removed (disabling only)
+    peopleWithAccess: zod_1.z.number().int(),
+    // true when affectedPeople or peopleWithAccess is non-zero; the change then
+    // needs the access-authority:sync permission, and a Sync All afterwards
+    syncRequired: zod_1.z.boolean(),
+});

package/dist/api/rest/index.d.ts

@@ -37,3 +37,4 @@ export * from './camera';
 export * from './trackables';
 export * from './time-zone';
 export * from './filter-preset';
+export * from './access-control-authority';

package/dist/api/rest/index.js

@@ -53,3 +53,4 @@ __exportStar(require("./camera"), exports);
 __exportStar(require("./trackables"), exports);
 __exportStar(require("./time-zone"), exports);
 __exportStar(require("./filter-preset"), exports);
+__exportStar(require("./access-control-authority"), exports);

package/dist/api/rest/module-config.d.ts

@@ -1,4 +1,5 @@
 import { JSONSchema4 } from 'json-schema';
+import z from 'zod';
 import { UiHint } from '../../objects';
 export interface SaveProviderConfigRq {
     provider: string;
@@ -17,3 +18,8 @@ export interface ModuleConfigSpecs {
     default: Record<string, unknown>;
     uiHints?: UiHint[];
 }
+export declare const sModuleConfig: z.ZodObject<{
+    app: z.ZodObject<{
+        modules: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$catchall<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;

package/dist/api/rest/module-config.js

@@ -1,2 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.sModuleConfig = void 0;
+const zod_1 = __importDefault(require("zod"));
+exports.sModuleConfig = zod_1.default
+    .object({ app: zod_1.default.object({ modules: zod_1.default.array(zod_1.default.string()) }) })
+    .catchall(zod_1.default.record(zod_1.default.string(), zod_1.default.unknown()));

package/dist/objects/device/server.d.ts

@@ -1,6 +1,6 @@
 import { ConfigState } from '../../objects/device/changeset';
 import { AccessControlCapabilityReport } from '../agent-metadata';
-import { ModuleConfig, ModuleConfigMetadata } from '../module-config';
+import { ModuleConfigMetadata } from '../module-config';
 export declare const SERVER = "server";
 export type AccessControlProviderState = AccessControlCapabilityReport & {
     syncInProgress: boolean;
@@ -12,7 +12,6 @@ export type AccessControlProviderState = AccessControlCapabilityReport & {
 export type ServerState = {
     activeProviders: string[];
     configMetadata: ModuleConfigMetadata;
-    config: ModuleConfig;
     runnableProviders: string[];
     accessControlProviders: Record<string, AccessControlProviderState>;
     citadelMode: boolean;

package/dist/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "git+https://github.com/Linc-Security-Systems/aware-essentials.git"
   },
-  "version": "2.0.150",
+  "version": "2.0.152",
   "description": "Common types between backend, agent(s) and frontend(s)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "git+https://github.com/Linc-Security-Systems/aware-essentials.git"
   },
-  "version": "2.0.150",
+  "version": "2.0.152",
   "description": "Common types between backend, agent(s) and frontend(s)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",