@awarevue/agent-sdk 2.0.73 → 2.0.75

package/dist/agent-app-with-defaults.d.ts

@@ -0,0 +1,16 @@
+import { FromAgent, FromServer, Message } from '@awarevue/api-types';
+import { Agent } from './agent';
+import { AgentApp, AgentOptions } from './agent-app';
+import { DuplexTransport } from './transport_types';
+export type AgentAppWithDefaultsOptions = Omit<AgentOptions, 'transport'> & {
+    url: string;
+    apiKey: string;
+    transport?: DuplexTransport<Message<FromServer>, Message<FromAgent>>;
+};
+/**
+ * Creates an AgentApp instance with default transport settings (WS transport wrapped in a logging decorator) if no custom transport is provided.
+ * @param agent The agent instance to use.
+ * @param options Configuration options for the AgentApp.
+ * @returns A configured AgentApp instance.
+ */
+export declare function createAgentApp(agent: Agent, options: AgentAppWithDefaultsOptions): AgentApp;

package/dist/agent-app-with-defaults.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAgentApp = createAgentApp;
+const agent_app_1 = require("./agent-app");
+const logging_1 = require("./transports/logging");
+const ws_1 = require("./transports/ws");
+/**
+ * Creates an AgentApp instance with default transport settings (WS transport wrapped in a logging decorator) if no custom transport is provided.
+ * @param agent The agent instance to use.
+ * @param options Configuration options for the AgentApp.
+ * @returns A configured AgentApp instance.
+ */
+function createAgentApp(agent, options) {
+    const { url, apiKey, transport, ...rest } = options;
+    const finalTransport = transport !== null && transport !== void 0 ? transport : new logging_1.LoggingDuplexTransport(new ws_1.WsDuplexTransport({
+        url,
+        headers: {
+            Authorization: `APIKey ${apiKey}`,
+        },
+    }));
+    return new agent_app_1.AgentApp(agent, { ...rest, transport: finalTransport });
+}

package/dist/agent-app.js

@@ -11,7 +11,15 @@ class AgentApp {
         this.agent = agent;
         this.options = options;
         this.sub = null;
-        this.handleResponse$ = (requestId) => (obs) => obs.pipe((0, rxjs_1.tap)({
+        this.handleResponse$ = (requestId, responseBuilder) => (obs) => obs.pipe((0, rxjs_1.mergeMap)((result) => result instanceof agent_error_1.AgentProgressMessage
+            ? (0, rxjs_1.of)({
+                kind: 'progress',
+                requestId,
+                message: result.message,
+            })
+            : responseBuilder
+                ? (0, rxjs_1.of)(responseBuilder(result))
+                : rxjs_1.EMPTY), (0, rxjs_1.tap)({
             error: (error) => console.error('Error processing request', requestId, (0, utils_1.stringifyError)(error)),
         }), (0, rxjs_1.catchError)((error) => (0, rxjs_1.of)({
             kind: 'error-rs',
@@ -63,25 +71,28 @@ class AgentApp {
                     case 'command':
                         return this.agent.runCommand$(context, message).pipe(
                         // if command observable completes without emitting, throw not supported error
-                        (0, rxjs_1.throwIfEmpty)(() => new agent_error_1.AgentError(`Agent ${context.provider} does not support command ${message.command}`, 'NOT_SUPPORTED')), 
-                        // success
-                        (0, rxjs_1.map)(() => ({
+                        (0, rxjs_1.throwIfEmpty)(() => new agent_error_1.AgentError(`Agent ${context.provider} does not support command ${message.command}`, 'NOT_SUPPORTED')), this.handleResponse$(message.id, (result) => ({
                             kind: 'command-rs',
                             requestId: message.id,
-                        })), this.handleResponse$(message.id));
+                            result,
+                        })));
                     case 'query':
                         if (!this.agent.getResult$) {
-                            return (0, rxjs_1.throwError)(() => new agent_error_1.AgentError(`Agent ${context.provider} does not support queries`, 'NOT_SUPPORTED')).pipe(this.handleResponse$(message.id));
+                            return (0, rxjs_1.throwError)(() => new agent_error_1.AgentError(`Agent ${context.provider} does not support queries`, 'NOT_SUPPORTED')).pipe(this.handleResponse$(message.id, (result) => ({
+                                kind: 'query-rs',
+                                requestId: message.id,
+                                result,
+                            })));
                         }
                         return this.agent.getResult$(context, message).pipe(
                         // if query observable completes without emitting, throw not supported error
                         (0, rxjs_1.throwIfEmpty)(() => new agent_error_1.AgentError(`Agent ${context.provider} does not support query ${message.query}`, 'NOT_SUPPORTED')), 
                         // success
-                        (0, rxjs_1.map)((result) => ({
+                        this.handleResponse$(message.id, (result) => ({
                             kind: 'query-rs',
                             requestId: message.id,
                             result,
-                        })), this.handleResponse$(message.id));
+                        })));
                     case 'push-file':
                         if (!this.agent.pushFile) {
                             return (0, rxjs_1.throwError)(() => new agent_error_1.AgentError(`Agent ${context.provider} does not support file pushing`, 'NOT_SUPPORTED'));
@@ -91,13 +102,11 @@ class AgentApp {
                         (0, rxjs_1.mergeMap)(() => rxjs_1.EMPTY), this.handleResponse$(message.id));
                     case 'get-available-devices':
                         // get available devices
-                        return this.agent.getDevicesAndRelations$(context).pipe(
-                        // success
-                        (0, rxjs_1.map)((rs) => ({
+                        return this.agent.getDevicesAndRelations$(context).pipe(this.handleResponse$(message.id, (result) => ({
+                            ...result,
                             kind: 'get-available-devices-rs',
-                            ...rs,
                             requestId: message.id,
-                        })), this.handleResponse$(message.id));
+                        })));
                     case 'validate-change':
                         let validateOb$ = (0, rxjs_1.throwError)(() => new agent_error_1.AgentError(`Agent ${context.provider} does not support access change validation`, 'NOT_SUPPORTED'));
                         if (this.agent.validateAccessChange$) {
@@ -111,22 +120,22 @@ class AgentApp {
                                     : v$(validationContext, message);
                             }));
                         }
-                        return validateOb$.pipe((0, rxjs_1.map)((issues) => ({
+                        return validateOb$.pipe(this.handleResponse$(message.id, (result) => ({
                             kind: 'validate-change-rs',
                             requestId: message.id,
-                            issues,
-                        })), this.handleResponse$(message.id));
+                            issues: result,
+                        })));
                     case 'apply-change':
                         // apply access change
                         const applyContext = this.createAccessChangeContext(context, message.refMap, objectCache);
                         const applyOb$ = !this.agent.applyAccessChange$
                             ? (0, rxjs_1.throwError)(() => new agent_error_1.AgentError(`Agent ${context.provider} does not support access change apply`, 'NOT_SUPPORTED'))
                             : this.agent.applyAccessChange$(applyContext, message);
-                        return applyOb$.pipe((0, rxjs_1.map)((result) => ({
+                        return applyOb$.pipe(this.handleResponse$(message.id, (result) => ({
                             kind: 'apply-change-rs',
                             requestId: message.id,
                             refs: result,
-                        })), this.handleResponse$(message.id));
+                        })));
                     default:
                         return rxjs_1.EMPTY;
                 }
@@ -170,13 +179,11 @@ class AgentApp {
                     provider,
                     config,
                 })
-                    .pipe(
-                // success
-                (0, rxjs_1.map)((issues) => ({
+                    .pipe(this.handleResponse$(message.id, (result) => ({
                     kind: 'validate-config-rs',
                     requestId: message.id,
-                    issues,
-                })), this.handleResponse$(message.id));
+                    issues: result,
+                })));
             }));
             return (0, rxjs_1.merge)(registration$, startStop$, validateConfig$);
         };

package/dist/agent-error.d.ts

@@ -3,3 +3,7 @@ export declare class AgentError extends Error {
     readonly code: AgentErrorCode;
     constructor(message: string, code: AgentErrorCode);
 }
+export declare class AgentProgressMessage {
+    readonly message: string;
+    constructor(message: string);
+}

package/dist/agent-error.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AgentError = void 0;
+exports.AgentProgressMessage = exports.AgentError = void 0;
 class AgentError extends Error {
     constructor(message, code) {
         super(message);
@@ -9,3 +9,9 @@ class AgentError extends Error {
     }
 }
 exports.AgentError = AgentError;
+class AgentProgressMessage {
+    constructor(message) {
+        this.message = message;
+    }
+}
+exports.AgentProgressMessage = AgentProgressMessage;

package/dist/agent-protocol.d.ts

@@ -27,6 +27,6 @@ export declare class AgentProtocol<D extends Direction> {
     constructor(transport: DuplexTransport<Message<Inbound<D>>, Message<Outbound<D>>>, options: AgentProtocolOptions);
     getReply$: <K extends RequestKind>(payload: Extract<Outbound<D>, {
         kind: K;
-    }>) => Observable<Message<PayloadByKind[ResponseKind<K>]>>;
+    }>, timeoutMs?: number) => Observable<Message<PayloadByKind[ResponseKind<K>]>>;
     send: (payload: Outbound<D>) => void;
 }

package/dist/agent-protocol.js

@@ -15,17 +15,24 @@ class AgentProtocol {
             version: constants_1.AGENT_PROTOCOL_VERSION,
             on: Date.now(),
         });
-        this.getReply$ = (payload) => {
+        this.getReply$ = (payload, timeoutMs) => {
             const responseKind = api_types_1.ReplyKindByRequestKind[payload.kind];
-            const reply$ = (id) => this.transport.messages$.pipe((0, rxjs_1.mergeMap)((message) => {
-                if (message.kind === 'error-rs' && message.requestId === id) {
+            const reply$ = (id) => this.transport.messages$.pipe(
+            // pass through only messages with matching requestId (it could be response, error or progress update)
+            (0, rxjs_1.filter)((message) => 'requestId' in message && message.requestId === id), (0, rxjs_1.mergeMap)((message) => {
+                // if the agent responded with an error message related to our request, throw an error to fail the stream
+                if (message.kind === 'error-rs') {
                     const error = message.error;
                     return (0, rxjs_1.throwError)(() => new Error(`Server failed to process message ${payload.kind}: ${error}`));
                 }
                 return (0, rxjs_1.of)(message);
-            }), (0, rxjs_1.filter)((message) => message.kind === responseKind &&
-                'requestId' in message &&
-                message.requestId === id), (0, rxjs_1.take)(1), (0, rxjs_1.timeout)(this.options.replyTimeout || 10000));
+            }), 
+            // enforce timeout (progress updates will reset the timer, but if no messages arrive for `timeoutMs` duration, the request is considered failed)
+            (0, rxjs_1.timeout)(timeoutMs || this.options.replyTimeout || 10000), 
+            // pass through only the final response message (filter out progress updates)
+            (0, rxjs_1.filter)((message) => message.kind === responseKind), 
+            // we only expect one response message, so complete the stream after the response arrives
+            (0, rxjs_1.take)(1));
             return (0, rxjs_1.of)(this.addEnvelope({ ...payload, id: AgentProtocol.nextId() })).pipe(
             // send the message to the agent
             (0, rxjs_1.tap)((p) => this.transport.send(p)), 

package/dist/default-validator.d.ts

@@ -7,4 +7,4 @@ export declare const createValidator: <T extends Agent>(agent: T) => (context: C
     objectKind?: "person" | "zone" | "schedule" | "device" | "accessRule" | undefined;
     objectId?: string | undefined;
     index?: number | undefined;
-}[], Record<"accessRule" | "schedule" | "person" | "device" | "zone", Record<string, Record<string, unknown>>>]>;
+}[], Record<"accessRule" | "schedule" | "person" | "zone" | "device", Record<string, Record<string, unknown>>>]>;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './agent-app';
+export * from './agent-app-with-defaults';
 export * from './agent';
 export * from './constants';
 export * from './agent-protocol';

package/dist/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./agent-app"), exports);
+__exportStar(require("./agent-app-with-defaults"), exports);
 __exportStar(require("./agent"), exports);
 __exportStar(require("./constants"), exports);
 __exportStar(require("./agent-protocol"), exports);

package/dist/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "git+https://github.com/Linc-Security-Systems/aware-essentials.git"
   },
-  "version": "2.0.73",
+  "version": "2.0.75",
   "description": "SDK for building Agent implementations that speak the agent protocol.",
   "author": "Yaser Awajan",
   "license": "MIT",
@@ -31,12 +31,12 @@
     "lint:fix": "yarn lint --fix"
   },
   "peerDependencies": {
-    "@awarevue/api-types": "2.0.73",
+    "@awarevue/api-types": "2.0.75",
     "rxjs": "^7.8.2",
     "ws": "^8"
   },
   "devDependencies": {
-    "@awarevue/api-types": "2.0.73",
+    "@awarevue/api-types": "2.0.75",
     "@types/node": "^20.12.7",
     "@types/ws": "^8.18.1",
     "@typescript-eslint/eslint-plugin": "^8.31.1",

package/dist/transports/logging.js

@@ -16,7 +16,7 @@ class LoggingDuplexTransport {
         this.inner = inner;
         this.label = (_a = opts.label) !== null && _a !== void 0 ? _a : 'transport';
         this.sink =
-            (_b = opts.logger) !== null && _b !== void 0 ? _b : ((direction, label, msg) => console.log(`[${label}] ${direction}`, JSON.stringify(msg, null, 2)));
+            (_b = opts.logger) !== null && _b !== void 0 ? _b : ((direction, label, msg) => console.log(`[${label}] ${direction}`, JSON.stringify(msg)));
         this.connected$ = inner.connected$;
         // Tap into the incoming stream before exposing it to consumers.
         this.messages$ = inner.messages$.pipe((0, operators_1.tap)((msg) => this.sink('IN', this.label, msg)));

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "git+https://github.com/Linc-Security-Systems/aware-essentials.git"
   },
-  "version": "2.0.73",
+  "version": "2.0.75",
   "description": "SDK for building Agent implementations that speak the agent protocol.",
   "author": "Yaser Awajan",
   "license": "MIT",
@@ -31,12 +31,12 @@
     "lint:fix": "yarn lint --fix"
   },
   "peerDependencies": {
-    "@awarevue/api-types": "2.0.73",
+    "@awarevue/api-types": "2.0.75",
     "rxjs": "^7.8.2",
     "ws": "^8"
   },
   "devDependencies": {
-    "@awarevue/api-types": "2.0.73",
+    "@awarevue/api-types": "2.0.75",
     "@types/node": "^20.12.7",
     "@types/ws": "^8.18.1",
     "@typescript-eslint/eslint-plugin": "^8.31.1",