@olane/o-approval 0.8.3 → 0.8.4

package/README.md

@@ -20,7 +20,36 @@ The `o-approval` package provides a configurable approval system that allows hum
 This package is typically included as part of the Olane OS common tools and is automatically registered on all nodes.
 
 ```bash
-npm install @olane/o-approval
+pnpm install @olane/o-approval
+```
+
+## Dependencies
+
+This tool requires the following nodes to be running on the network:
+
+- **`o://leader`** - Used for persistent storage of approval preferences (whitelist/blacklist). Preferences are saved so that "always allow" and "never allow" choices survive restarts.
+- **`o://human`** - Used to prompt a human agent for approval decisions. When an action requires review, the approval tool sends a question to the human node and waits for a response.
+
+## Response Structure
+
+When calling the approval tool via `node.use()`, responses follow the standard Olane response structure:
+
+```typescript
+const response = await node.use(new oNodeAddress('o://approval'), {
+  method: 'request_approval',
+  params: { ... }
+});
+
+// response.result.success - boolean indicating success or failure
+// response.result.data    - the return value on success
+// response.result.error   - error message on failure
+
+if (response.result.success) {
+  const data = response.result.data;
+  console.log('Approved:', data.approved);
+} else {
+  console.error('Error:', response.result.error);
+}
 ```
 
 ## Usage
@@ -79,9 +108,9 @@ await approvalTool.start();
 #### Request Approval
 
 ```typescript
-import { oAddress } from '@olane/o-core';
+import { oNodeAddress } from '@olane/o-node';
 
-const response = await node.use(new oAddress('o://approval'), {
+const response = await node.use(new oNodeAddress('o://approval'), {
   method: 'request_approval',
   params: {
     toolAddress: 'o://storage',

package/dist/src/o-approval.tool.d.ts

@@ -1,4 +1,3 @@
-import { ToolResult } from '@olane/o-tool';
 import { oRequest } from '@olane/o-core';
 import { oApprovalConfig } from './interfaces/approval-config.js';
 import { oLaneTool } from '@olane/o-lane';
@@ -13,7 +12,7 @@ export declare class oApprovalTool extends oLaneTool {
     /**
      * Request human approval for an action
      */
-    _tool_request_approval(request: oRequest): Promise<ToolResult>;
+    _tool_request_approval(request: oRequest): Promise<any>;
     /**
      * Format the approval prompt for the human
      */
@@ -37,14 +36,14 @@ export declare class oApprovalTool extends oLaneTool {
     /**
      * Set an approval preference manually
      */
-    _tool_set_preference(request: oRequest): Promise<ToolResult>;
+    _tool_set_preference(request: oRequest): Promise<any>;
     /**
      * Get the current approval mode
      */
-    _tool_get_mode(request: oRequest): Promise<ToolResult>;
+    _tool_get_mode(request: oRequest): Promise<any>;
     /**
      * Set the approval mode
      */
-    _tool_set_mode(request: oRequest): Promise<ToolResult>;
+    _tool_set_mode(request: oRequest): Promise<any>;
 }
 //# sourceMappingURL=o-approval.tool.d.ts.map

package/dist/src/o-approval.tool.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"o-approval.tool.d.ts","sourceRoot":"","sources":["../../src/o-approval.tool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAY,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEnD,OAAO,EACL,eAAe,EAGhB,MAAM,iCAAiC,CAAC;AAMzC,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAK1C,qBAAa,aAAc,SAAQ,SAAS;IAC1C,OAAO,CAAC,IAAI,CAAe;IAC3B,OAAO,CAAC,WAAW,CAAsB;gBAE7B,MAAM,EAAE,eAAe;IAenC;;OAEG;IACH,OAAO,CAAC,aAAa;IA4BrB;;OAEG;IACG,sBAAsB,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC;IAuHpE;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAmB5B;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAkB7B;;OAEG;YACW,cAAc;IAU5B;;OAEG;YACW,cAAc;IAU5B;;OAEG;YACW,eAAe;IAY7B;;OAEG;IACG,oBAAoB,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC;IA+BlE;;OAEG;IACG,cAAc,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC;IAQ5D;;OAEG;IACG,cAAc,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC;CA+B7D"}
+{"version":3,"file":"o-approval.tool.d.ts","sourceRoot":"","sources":["../../src/o-approval.tool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEnD,OAAO,EACL,eAAe,EAGhB,MAAM,iCAAiC,CAAC;AAMzC,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAK1C,qBAAa,aAAc,SAAQ,SAAS;IAC1C,OAAO,CAAC,IAAI,CAAe;IAC3B,OAAO,CAAC,WAAW,CAAsB;gBAE7B,MAAM,EAAE,eAAe;IAenC;;OAEG;IACH,OAAO,CAAC,aAAa;IA4BrB;;OAEG;IACG,sBAAsB,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAyF7D;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAmB5B;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAkB7B;;OAEG;YACW,cAAc;IAU5B;;OAEG;YACW,cAAc;IAU5B;;OAEG;YACW,eAAe;IAY7B;;OAEG;IACG,oBAAoB,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAmB3D;;OAEG;IACG,cAAc,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAOrD;;OAEG;IACG,cAAc,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;CAoBtD"}

package/dist/src/o-approval.tool.js

@@ -49,101 +49,72 @@ export class oApprovalTool extends oLaneTool {
      * Request human approval for an action
      */
     async _tool_request_approval(request) {
-        try {
-            const toolAddress = request.params.toolAddress;
-            const method = request.params.method;
-            const params = request.params.params;
-            const intent = request.params.intent;
-            const approvalRequest = {
-                toolAddress,
-                method,
-                params,
-                intent,
-                timestamp: Date.now(),
+        const toolAddress = request.params.toolAddress;
+        const method = request.params.method;
+        const params = request.params.params;
+        const intent = request.params.intent;
+        const approvalRequest = {
+            toolAddress,
+            method,
+            params,
+            intent,
+            timestamp: Date.now(),
+        };
+        const toolMethod = `${toolAddress}/${method}`;
+        // Check if this action is blacklisted
+        if (this.preferences.blacklist?.includes(toolMethod)) {
+            this.logger.warn(`Action denied by blacklist: ${toolMethod}`);
+            throw new Error('Action denied by approval blacklist');
+        }
+        // Check if this action is whitelisted
+        if (this.preferences.whitelist?.includes(toolMethod)) {
+            this.logger.info(`Action pre-approved by whitelist: ${toolMethod}`);
+            return {
+                approved: true,
+                decision: 'approve',
             };
-            const toolMethod = `${toolAddress}/${method}`;
-            // Check if this action is blacklisted
-            if (this.preferences.blacklist?.includes(toolMethod)) {
-                this.logger.warn(`Action denied by blacklist: ${toolMethod}`);
-                return {
-                    success: false,
-                    error: 'Action denied by approval blacklist',
-                    approved: false,
-                };
-            }
-            // Check if this action is whitelisted
-            if (this.preferences.whitelist?.includes(toolMethod)) {
-                this.logger.info(`Action pre-approved by whitelist: ${toolMethod}`);
-                return {
-                    success: true,
-                    approved: true,
-                    decision: 'approve',
-                };
-            }
-            // Check if approval is needed based on mode
-            if (!this.needsApproval(toolAddress, method)) {
-                this.logger.debug(`Approval not required for ${toolMethod} (mode: ${this.mode})`);
-                return {
-                    success: true,
-                    approved: true,
-                    decision: 'approve',
-                };
-            }
-            // Format the approval prompt
-            const question = this.formatApprovalPrompt(approvalRequest);
-            // Request approval from human
-            this.logger.info(`Requesting approval for: ${toolMethod}`);
-            const timeout = this.preferences.timeout || DEFAULT_TIMEOUT;
-            const approvalPromise = this.use(new oAddress('o://human'), {
-                method: 'question',
-                params: { question },
-            });
-            // Implement timeout
-            const timeoutPromise = new Promise((_, reject) => setTimeout(() => reject(new Error('Approval timeout')), timeout));
-            try {
-                const response = await Promise.race([approvalPromise, timeoutPromise]);
-                const answer = response.result.data?.answer
-                    ?.trim()
-                    .toLowerCase();
-                // Parse the response
-                const decision = this.parseApprovalResponse(answer);
-                // Handle preference storage
-                if (decision === 'always') {
-                    await this.addToWhitelist(toolMethod);
-                    this.logger.info(`Added to whitelist: ${toolMethod}`);
-                }
-                else if (decision === 'never') {
-                    await this.addToBlacklist(toolMethod);
-                    this.logger.info(`Added to blacklist: ${toolMethod}`);
-                }
-                const approved = decision === 'approve' || decision === 'always';
-                this.logger.info(`Approval decision for ${toolMethod}: ${decision} (approved: ${approved})`);
-                return {
-                    success: true,
-                    approved,
-                    decision,
-                    timestamp: Date.now(),
-                };
-            }
-            catch (error) {
-                // Timeout or error - default to deny
-                this.logger.error(`Approval timeout or error for ${toolMethod}:`, error.message);
-                return {
-                    success: false,
-                    error: error.message || 'Approval timeout',
-                    approved: false,
-                    decision: 'deny',
-                };
-            }
         }
-        catch (error) {
-            this.logger.error('Error in approval request:', error);
+        // Check if approval is needed based on mode
+        if (!this.needsApproval(toolAddress, method)) {
+            this.logger.debug(`Approval not required for ${toolMethod} (mode: ${this.mode})`);
             return {
-                success: false,
-                error: error.message || 'Unknown error',
-                approved: false,
+                approved: true,
+                decision: 'approve',
             };
         }
+        // Format the approval prompt
+        const question = this.formatApprovalPrompt(approvalRequest);
+        // Request approval from human
+        this.logger.info(`Requesting approval for: ${toolMethod}`);
+        const timeout = this.preferences.timeout || DEFAULT_TIMEOUT;
+        const approvalPromise = this.use(new oAddress('o://human'), {
+            method: 'question',
+            params: { question },
+        });
+        // Implement timeout
+        const timeoutPromise = new Promise((_, reject) => setTimeout(() => reject(new Error('Approval timeout')), timeout));
+        const response = await Promise.race([approvalPromise, timeoutPromise]);
+        const answer = response.result.data?.answer
+            ?.trim()
+            .toLowerCase();
+        // Parse the response
+        const decision = this.parseApprovalResponse(answer);
+        // Handle preference storage
+        if (decision === 'always') {
+            await this.addToWhitelist(toolMethod);
+            this.logger.info(`Added to whitelist: ${toolMethod}`);
+        }
+        else if (decision === 'never') {
+            await this.addToBlacklist(toolMethod);
+            this.logger.info(`Added to blacklist: ${toolMethod}`);
+        }
+        const approved = decision === 'approve' || decision === 'always';
+        this.logger.info(`Approval decision for ${toolMethod}: ${decision} (approved: ${approved})`);
+        return {
+            approved,
+            decision,
+            timestamp: Date.now(),
+        };
     }
     /**
      * Format the approval prompt for the human
@@ -229,43 +200,29 @@ Your response:`.trim();
      * Set an approval preference manually
      */
     async _tool_set_preference(request) {
-        try {
-            const toolMethod = request.params.toolMethod;
-            const preference = request.params.preference;
-            if (preference === 'allow') {
-                await this.addToWhitelist(toolMethod);
-                return {
-                    success: true,
-                    message: `Added ${toolMethod} to whitelist`,
-                };
-            }
-            else if (preference === 'deny') {
-                await this.addToBlacklist(toolMethod);
-                return {
-                    success: true,
-                    message: `Added ${toolMethod} to blacklist`,
-                };
-            }
-            else {
-                return {
-                    success: false,
-                    error: 'Invalid preference. Use "allow" or "deny"',
-                };
-            }
+        const toolMethod = request.params.toolMethod;
+        const preference = request.params.preference;
+        if (preference === 'allow') {
+            await this.addToWhitelist(toolMethod);
+            return {
+                message: `Added ${toolMethod} to whitelist`,
+            };
         }
-        catch (error) {
+        else if (preference === 'deny') {
+            await this.addToBlacklist(toolMethod);
             return {
-                success: false,
-                error: error.message || 'Unknown error',
+                message: `Added ${toolMethod} to blacklist`,
             };
         }
+        else {
+            throw new Error('Invalid preference. Use "allow" or "deny"');
+        }
     }
     /**
      * Get the current approval mode
      */
     async _tool_get_mode(request) {
         return {
-            success: true,
             mode: this.mode,
             preferences: this.preferences,
         };
@@ -274,31 +231,19 @@ Your response:`.trim();
      * Set the approval mode
      */
     async _tool_set_mode(request) {
-        try {
-            const mode = request.params.mode;
-            if (!['allow', 'review', 'auto'].includes(mode)) {
-                return {
-                    success: false,
-                    error: 'Invalid mode. Use "allow", "review", or "auto"',
-                };
-            }
-            this.mode = mode;
-            this.logger.info(`Approval mode set to: ${this.mode}`);
-            // Save mode to OS config
-            await this.use(new oAddress('o://leader'), {
-                method: 'update_approval_mode',
-                params: { mode: this.mode },
-            });
-            return {
-                success: true,
-                mode: this.mode,
-            };
-        }
-        catch (error) {
-            return {
-                success: false,
-                error: error.message || 'Unknown error',
-            };
-        }
+        const mode = request.params.mode;
+        if (!['allow', 'review', 'auto'].includes(mode)) {
+            throw new Error('Invalid mode. Use "allow", "review", or "auto"');
+        }
+        this.mode = mode;
+        this.logger.info(`Approval mode set to: ${this.mode}`);
+        // Save mode to OS config
+        await this.use(new oAddress('o://leader'), {
+            method: 'update_approval_mode',
+            params: { mode: this.mode },
+        });
+        return {
+            mode: this.mode,
+        };
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@olane/o-approval",
-  "version": "0.8.3",
+  "version": "0.8.4",
   "type": "module",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -53,13 +53,13 @@
     "typescript": "5.4.5"
   },
   "dependencies": {
-    "@olane/o-config": "0.8.3",
-    "@olane/o-core": "0.8.3",
-    "@olane/o-lane": "0.8.3",
-    "@olane/o-protocol": "0.8.3",
-    "@olane/o-tool": "0.8.3",
+    "@olane/o-config": "0.8.4",
+    "@olane/o-core": "0.8.4",
+    "@olane/o-lane": "0.8.4",
+    "@olane/o-protocol": "0.8.4",
+    "@olane/o-tool": "0.8.4",
     "debug": "^4.4.1",
     "dotenv": "^16.5.0"
   },
-  "gitHead": "189c0cf7b6dd9d5d961f5424af21d37978092d9e"
+  "gitHead": "b53623b1ad4365133911722f80d5597a72b65bf2"
 }