@awarevue/agent-sdk 1.0.30 → 1.0.31

package/dist/agent-app.d.ts

@@ -18,6 +18,7 @@ export declare class AgentApp {
     private sub;
     private getReply$;
     private addEnvelope;
+    private createAccessChangeContext;
     private runProvider$;
     private process$;
     constructor(agent: Agent, options: AgentOptions);

package/dist/agent-app.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AgentApp = void 0;
 const rxjs_1 = require("rxjs");
+const default_validator_1 = require("./default-validator");
 class AgentApp {
     constructor(agent, options) {
         this.agent = agent;
@@ -31,7 +32,32 @@ class AgentApp {
             version: this.options.version,
             on: Date.now(),
         });
+        this.createAccessChangeContext = (context, refMap, objectCache) => {
+            return {
+                ...context,
+                objectsById: (objectKind, objectId) => {
+                    const objectKindRefs = refMap[objectKind] || {};
+                    const refs = objectKindRefs[objectId] || [];
+                    return refs.flatMap((foreignRef) => {
+                        const value = objectCache[objectKind][foreignRef];
+                        return value ? [value] : [];
+                    });
+                },
+                objectByForeignRef: (objectKind, foreignRef) => {
+                    return objectCache[objectKind][foreignRef] || null;
+                },
+            };
+        };
         this.runProvider$ = (context) => {
+            const changeValidator$ = (0, default_validator_1.createValidator)(this.agent);
+            // we assume that there will be only one validate-apply cycle per agent at the same time
+            let objectCache = {
+                person: {},
+                accessRule: {},
+                schedule: {},
+                device: {},
+                zone: {},
+            };
             return (0, rxjs_1.merge)(
             // run the agent monitor
             this.agent
@@ -81,7 +107,14 @@ class AgentApp {
                         // validate access change
                         const validateOb$ = !this.agent.validateAccessChange$
                             ? (0, rxjs_1.throwError)(() => new Error(`Agent ${context.provider} does not support access change validation`))
-                            : this.agent.validateAccessChange$(context, message);
+                            : changeValidator$(context, message).pipe((0, rxjs_1.mergeMap)(([issues, cache]) => {
+                                objectCache = cache;
+                                const validationContext = this.createAccessChangeContext(context, message.refMap, objectCache);
+                                return issues.length > 0
+                                    ? (0, rxjs_1.of)(issues)
+                                    : this.agent.validateAccessChange$(validationContext, message);
+                                return (0, rxjs_1.of)(issues);
+                            }));
                         return validateOb$.pipe((0, rxjs_1.map)((issues) => ({
                             kind: 'validate-change-rs',
                             requestId: message.id,
@@ -96,9 +129,10 @@ class AgentApp {
                         }), (0, rxjs_1.tap)((rs) => this.options.transport.send(this.addEnvelope(rs))));
                     case 'apply-change':
                         // apply access change
+                        const applyContext = this.createAccessChangeContext(context, message.refMap, objectCache);
                         const applyOb$ = !this.agent.applyAccessChange$
                             ? (0, rxjs_1.throwError)(() => new Error(`Agent ${context.provider} does not support access change application`))
-                            : this.agent.applyAccessChange$(context, message);
+                            : this.agent.applyAccessChange$(applyContext, message);
                         return applyOb$.pipe((0, rxjs_1.map)((result) => ({
                             kind: 'apply-change-rs',
                             requestId: message.id,

package/dist/agent.d.ts

@@ -1,4 +1,4 @@
-import { ValidateProviderConfigRs, DeviceDiscoveryDto, RunCommandRq, AccessValidateChangeRq, AccessChangeIssue, AccessApplyChange, AccessRefMap } from '@awarevue/api-types';
+import { ValidateProviderConfigRs, DeviceDiscoveryDto, RunCommandRq, AccessValidateChangeRq, AccessChangeIssue, AccessApplyChange, AccessRefMap, AccessObjectKind } from '@awarevue/api-types';
 import { Observable } from 'rxjs';
 import { DeviceActivity } from './agent-app';
 export type Context = {
@@ -15,6 +15,8 @@ export type RunCommandContext = Context & {
 };
 export type AccessChangeContext = Context & {
     deviceCatalog: DeviceDiscoveryDto;
+    objectsById: <T extends Record<string, unknown>>(objectKind: AccessObjectKind, objectId: string) => T[];
+    objectByForeignRef: <T extends Record<string, unknown>>(objectKind: AccessObjectKind, foreignRef: string) => T | null;
 };
 export interface Agent {
     getConfigIssues$: (context: Context) => Observable<ValidateProviderConfigRs['issues']>;
@@ -23,4 +25,5 @@ export interface Agent {
     runCommand$: (context: RunCommandContext, command: RunCommandRq) => Observable<unknown>;
     validateAccessChange$?: (context: AccessChangeContext, change: AccessValidateChangeRq) => Observable<AccessChangeIssue[]>;
     applyAccessChange$?: (context: AccessChangeContext, change: AccessApplyChange) => Observable<AccessRefMap>;
+    find$?: (context: Context, objectKind: AccessObjectKind, objectIds: string[]) => Observable<Record<string, Record<string, unknown>[]>>;
 }

package/dist/default-validator.d.ts

@@ -0,0 +1,10 @@
+import { AccessValidateChangeRq } from '@awarevue/api-types';
+import { Agent, Context } from './agent';
+export declare const createValidator: <T extends Agent>(agent: T) => (context: Context, change: AccessValidateChangeRq) => import("rxjs").Observable<readonly [{
+    index?: number | undefined;
+    code?: "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | "NOT_SUPPORTED" | undefined;
+    message?: string | undefined;
+    path?: string | undefined;
+    objectKind?: "person" | "zone" | "device" | "schedule" | "accessRule" | undefined;
+    objectId?: string | undefined;
+}[], Record<"accessRule" | "schedule" | "person" | "device" | "zone", Record<string, Record<string, unknown>>>]>;

package/dist/default-validator.js

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createValidator = void 0;
+const rxjs_1 = require("rxjs");
+const emptyMap = {};
+const createValidator = (agent) => {
+    const getNotFoundIssues = (req) => {
+        // check object ref contains all related objects
+        const personIds = [
+            ...new Set(req.mutations.flatMap((m) => {
+                var _a;
+                return m.kind === 'merge' && m.objectKind === 'accessRule'
+                    ? ((_a = m.props.appliedTo) !== null && _a !== void 0 ? _a : [])
+                    : [];
+            })),
+        ];
+        const scheduleIds = [
+            ...new Set(req.mutations.flatMap((m) => m.kind === 'merge' && m.objectKind === 'accessRule'
+                ? [
+                    ...(m.props.permissions || []).map((p) => p.scheduleId),
+                    ...(m.props.groupPermissions || []).map((p) => p.scheduleId),
+                ]
+                : [])),
+        ];
+        const notFoundPersonIds = personIds.filter((p) => !req.refMap['person'][p]);
+        const notFoundScheduleIds = scheduleIds.filter((s) => !req.refMap['schedule'][s]);
+        return [
+            ...notFoundPersonIds.map((id) => ({
+                code: 'NOT_FOUND',
+                objectId: id,
+                objectKind: 'person',
+            })),
+            ...notFoundScheduleIds.map((id) => ({
+                code: 'NOT_FOUND',
+                objectId: id,
+                objectKind: 'schedule',
+            })),
+        ];
+    };
+    const getBadReferenceIssues$ = (context, req) => {
+        if (!agent.find$)
+            return [];
+        const personIds = Object.entries(req.refMap['person'] || {}).flatMap(([objectId, refs]) => refs.map((ref) => ({ objectId, ref })));
+        const scheduleIds = Object.entries(req.refMap['schedule'] || {}).flatMap(([objectId, refs]) => refs.map((ref) => ({ objectId, ref })));
+        const ruleIds = Object.entries(req.refMap['accessRule'] || {}).flatMap(([objectId, refs]) => refs.map((ref) => ({ objectId, ref })));
+        const zoneIds = Object.entries(req.refMap['zone'] || {}).flatMap(([objectId, refs]) => refs.map((ref) => ({ objectId, ref })));
+        return (0, rxjs_1.forkJoin)([
+            // load persons
+            personIds.length < 1
+                ? (0, rxjs_1.of)(emptyMap)
+                : agent.find$(context, 'person', personIds.map((p) => p.ref)),
+            // load schedules
+            scheduleIds.length < 1
+                ? (0, rxjs_1.of)(emptyMap)
+                : agent.find$(context, 'schedule', scheduleIds.map((p) => p.ref)),
+            // load rules
+            ruleIds.length < 1
+                ? (0, rxjs_1.of)(emptyMap)
+                : agent.find$(context, 'accessRule', ruleIds.map((p) => p.ref)),
+            // load zones
+            zoneIds.length < 1
+                ? (0, rxjs_1.of)(emptyMap)
+                : agent.find$(context, 'zone', zoneIds.map((p) => p.ref)),
+        ]).pipe((0, rxjs_1.mergeMap)(([persons, schedules, rules, zones]) => {
+            var _a, _b;
+            const issues = [];
+            // check persons
+            for (const personId of personIds) {
+                if (!persons[personId.ref]) {
+                    issues.push({
+                        code: 'BAD_REFERENCE',
+                        objectId: personId.objectId,
+                        objectKind: 'person',
+                    });
+                }
+            }
+            // check schedules
+            for (const scheduleId of scheduleIds) {
+                if (!schedules[scheduleId.ref]) {
+                    issues.push({
+                        code: 'BAD_REFERENCE',
+                        objectId: scheduleId.objectId,
+                        objectKind: 'schedule',
+                    });
+                }
+            }
+            // check rules
+            for (const ruleId of ruleIds) {
+                if (!((_a = rules['accessRule']) === null || _a === void 0 ? void 0 : _a[ruleId.ref])) {
+                    issues.push({
+                        code: 'BAD_REFERENCE',
+                        objectId: ruleId.ref,
+                        objectKind: 'accessRule',
+                    });
+                }
+            }
+            // check zones
+            for (const zoneId of zoneIds) {
+                if (!((_b = zones['zone']) === null || _b === void 0 ? void 0 : _b[zoneId.ref])) {
+                    issues.push({
+                        code: 'BAD_REFERENCE',
+                        objectId: zoneId.objectId,
+                        objectKind: 'zone',
+                    });
+                }
+            }
+            return (0, rxjs_1.of)([
+                issues,
+                {
+                    person: persons,
+                    schedule: schedules,
+                    accessRule: rules,
+                    zone: zones,
+                },
+            ]);
+        }));
+    };
+    return (context, change) => {
+        return (0, rxjs_1.forkJoin)([
+            (0, rxjs_1.of)(getNotFoundIssues(change)),
+            getBadReferenceIssues$(context, change),
+        ]).pipe((0, rxjs_1.mergeMap)(([notFoundIssues, [badReferenceIssues, cache]]) => (0, rxjs_1.of)([
+            [...notFoundIssues, ...badReferenceIssues],
+            cache,
+        ])));
+    };
+};
+exports.createValidator = createValidator;

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awarevue/agent-sdk",
-  "version": "1.0.30",
+  "version": "1.0.31",
   "description": "SDK for building Agent implementations that speak the Aware protocol.",
   "author": "Yaser Awajan",
   "license": "MIT",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awarevue/agent-sdk",
-  "version": "1.0.30",
+  "version": "1.0.31",
   "description": "SDK for building Agent implementations that speak the Aware protocol.",
   "author": "Yaser Awajan",
   "license": "MIT",