Merge pull request #68 from SmythOS/dev

alaa-eddine-k · web-flow · commit fafce473a6fd · 2025-07-30T18:36:52.000+02:00
Dev merge
diff --git a/examples/01-agent-code-skill/01-prompting.ts b/examples/01-agent-code-skill/01-prompting.ts
@@ -3,7 +3,7 @@ import { Agent, Scope } from '@smythos/sdk';
 async function main() {
     const agent = new Agent({
         id: 'crypto-market-assistant',
-        
+
         name: 'CryptoMarket Assistant',
         behavior: 'You are a crypto price tracker. You are given a coin id and you need to get the price of the coin in USD',
         model: 'gpt-4o',
@@ -19,28 +19,6 @@ async function main() {
             return data.market_data;
         },
     });
-    const imgSkill = agent.addSkill({
-        name: 'ImageAnalyser',
-        description: 'Any attachment should be processed by this function',
-        process: async ({ image_url }) => {
-            console.log(image_url);
-            return 'Image analysed';
-        },
-    });
-    // imgSkill.in({
-    //     image_url : {
-    //         type:'Binary',
-    //         description:'The image url that we will analyze'
-    //     }
-    // })
-
-
-
-    const prompt = await agent.prompt('Analyze this image please ', {
-        files: ['https://www.robuxio.com/wp-content/uploads/2023/05/Trend.png'],
-    });
-    console.log(prompt);
-
 
     //this will prompt the agent and use the agent's LLM to determine which skill to use
     const promptResult = await agent.prompt('What are the current prices of Bitcoin and Ethereum ?');
diff --git a/examples/01-agent-code-skill/01.1-prompting-with-attachment.ts b/examples/01-agent-code-skill/01.1-prompting-with-attachment.ts
@@ -0,0 +1,33 @@
+import { Agent, Scope } from '@smythos/sdk';
+
+async function main() {
+    const agent = new Agent({
+        id: 'image-analyser',
+
+        name: 'Image Analyser',
+        behavior: 'You are a image analyser. You are given a image url and you need to analyse the image',
+        model: 'gpt-4o',
+    });
+
+    const imgSkill = agent.addSkill({
+        name: 'ImageAnalyser',
+        description: 'Any attachment should be processed by this function',
+        process: async ({ image_url }) => {
+            console.log(image_url);
+            return 'Image analysed';
+        },
+    });
+    imgSkill.in({
+        image_url: {
+            type: 'Binary',
+            description: 'The image url that we will analyze',
+        },
+    });
+
+    const promptResult = await agent.prompt('Analyze this image please ', {
+        files: ['https://www.robuxio.com/wp-content/uploads/2023/05/Trend.png'],
+    });
+    console.log(promptResult);
+}
+
+main();
diff --git a/examples/package.json b/examples/package.json
@@ -19,6 +19,7 @@
         "@types/node": "^20.19.0",
         "ts-node": "^10.9.2",
         "tsx": "^4.7.0",
-        "typescript": "^5.3.0"
+        "typescript": "^5.3.0",
+        "why-is-node-running": "^3.2.2"
     }
 }
diff --git a/packages/core/src/subsystems/Security/Vault.service/connectors/JSONFileVault.class.ts b/packages/core/src/subsystems/Security/Vault.service/connectors/JSONFileVault.class.ts
@@ -13,6 +13,7 @@ import crypto from 'crypto';
 import fs from 'fs';
 import * as readlineSync from 'readline-sync';
 import path from 'path';
+import * as chokidar from 'chokidar';
 import { findSmythPath } from '../../../../helpers/Sysconfig.helper';
 
 const console = Logger('JSONFileVault');
@@ -28,55 +29,18 @@ export class JSONFileVault extends VaultConnector {
     private vaultData: any;
     private index: any;
     private shared: string;
+    private vaultFile: string;
+    private watcher: chokidar.FSWatcher | null = null;
 
     constructor(protected _settings: JSONFileVaultConfig) {
         super(_settings);
         //if (!SmythRuntime.Instance) throw new Error('SRE not initialized');
 
         this.shared = _settings.shared || ''; //if config.shared, all keys are accessible to all teams, and they are set under the 'shared' teamId
 
-        let vaultFile = this.findVaultFile(_settings.file);
-        this.vaultData = {};
-        if (fs.existsSync(vaultFile)) {
-            try {
-                if (_settings.fileKey && fs.existsSync(_settings.fileKey)) {
-                    try {
-                        const privateKey = fs.readFileSync(_settings.fileKey, 'utf8');
-                        const encryptedVault = fs.readFileSync(vaultFile, 'utf8').toString();
-                        const decryptedBuffer = crypto.privateDecrypt(
-                            {
-                                key: privateKey,
-                                padding: crypto.constants.RSA_PKCS1_OAEP_PADDING,
-                            },
-                            Buffer.from(encryptedVault, 'base64')
-                        );
-                        this.vaultData = JSON.parse(decryptedBuffer.toString('utf8'));
-                    } catch (error) {
-                        throw new Error('Failed to decrypt vault');
-                    }
-                } else {
-                    this.vaultData = JSON.parse(fs.readFileSync(vaultFile).toString());
-                }
-            } catch (e) {
-                console.error('Error parsing vault file:', e);
-                console.error('!!! Vault features might not work properly !!!');
-                this.vaultData = {};
-            }
-
-            if (this.vaultData?.encrypted && this.vaultData?.algorithm && this.vaultData?.data) {
-                //this is an encrypted vault we need to request the master key
-                this.setInteraction(this.getMasterKeyInteractive.bind(this));
-            }
-
-            for (let teamId in this.vaultData) {
-                for (let resourceId in this.vaultData[teamId]) {
-                    if (!this.index) this.index = {};
-                    if (!this.index[resourceId]) this.index[resourceId] = {};
-                    const value = this.vaultData[teamId][resourceId];
-                    this.index[resourceId][teamId] = value;
-                }
-            }
-        }
+        this.vaultFile = this.findVaultFile(_settings.file);
+        this.fetchVaultData(this.vaultFile, _settings);
+        this.initFileWatcher();
     }
 
     private findVaultFile(vaultFile) {
@@ -192,4 +156,66 @@ export class JSONFileVault extends VaultConnector {
 
         return acl;
     }
+
+    private fetchVaultData(vaultFile: string, _settings: JSONFileVaultConfig) {
+        if (fs.existsSync(vaultFile)) {
+            try {
+                if (_settings.fileKey && fs.existsSync(_settings.fileKey)) {
+                    try {
+                        const privateKey = fs.readFileSync(_settings.fileKey, 'utf8');
+                        const encryptedVault = fs.readFileSync(vaultFile, 'utf8').toString();
+                        const decryptedBuffer = crypto.privateDecrypt(
+                            {
+                                key: privateKey,
+                                padding: crypto.constants.RSA_PKCS1_OAEP_PADDING,
+                            },
+                            Buffer.from(encryptedVault, 'base64')
+                        );
+                        this.vaultData = JSON.parse(decryptedBuffer.toString('utf8'));
+                    } catch (error) {
+                        throw new Error('Failed to decrypt vault');
+                    }
+                } else {
+                    this.vaultData = JSON.parse(fs.readFileSync(vaultFile).toString());
+                }
+            } catch (e) {
+                console.error('Error parsing vault file:', e);
+                console.error('!!! Vault features might not work properly !!!');
+                this.vaultData = {};
+            }
+
+            if (this.vaultData?.encrypted && this.vaultData?.algorithm && this.vaultData?.data) {
+                //this is an encrypted vault we need to request the master key
+                this.setInteraction(this.getMasterKeyInteractive.bind(this));
+            }
+
+            for (let teamId in this.vaultData) {
+                for (let resourceId in this.vaultData[teamId]) {
+                    if (!this.index) this.index = {};
+                    if (!this.index[resourceId]) this.index[resourceId] = {};
+                    const value = this.vaultData[teamId][resourceId];
+                    this.index[resourceId][teamId] = value;
+                }
+            }
+        }
+    }
+
+    private initFileWatcher() {
+        this.watcher = chokidar.watch(this.vaultFile, {
+            persistent: false, // Don't keep the process running
+            ignoreInitial: true,
+        });
+
+        this.watcher.on('change', () => {
+            this.fetchVaultData(this.vaultFile, this._settings);
+        });
+    }
+
+    public async stop() {
+        super.stop();
+        if (this.watcher) {
+            this.watcher.close();
+            this.watcher = null;
+        }
+    }
 }
diff --git a/packages/core/tests/unit/core/JSONFileVaultConnector.test.ts b/packages/core/tests/unit/core/JSONFileVaultConnector.test.ts
@@ -0,0 +1,46 @@
+import { describe, expect, it } from 'vitest';
+import { setupSRE } from '../../utils/sre';
+import { ConnectorService } from '@sre/Core/ConnectorsService';
+import { IAccessCandidate, TAccessRole } from 'index';
+
+setupSRE({
+    Vault: {
+        Connector: 'JSONFileVault',
+        Settings: {
+            file: '/Users/zubair/Zubair/SmythOS/smyth-opensource/smythos-ui/vault.json',
+        },
+    },
+    Log: {
+        Connector: 'ConsoleLog',
+    },
+});
+
+describe('JSONFileVault Tests', () => {
+    it(
+        'List all keys in the vault',
+        async () => {
+            const mockCandidate: IAccessCandidate = {
+                id: 'default',
+                role: TAccessRole.Team,
+            };
+
+            const vaultConnector = ConnectorService.getVaultConnector('JSONFileVault');
+            const result = await vaultConnector.team(mockCandidate.id).listKeys();
+            expect(result).toBeDefined();
+        },
+    );
+
+    it(
+        'Get a key from the vault',
+        async () => {
+            const mockCandidate: IAccessCandidate = {
+                id: 'default',
+                role: TAccessRole.Team,
+            };
+
+            const vaultConnector = ConnectorService.getVaultConnector('JSONFileVault');
+            const result = await vaultConnector.team(mockCandidate.id).get('testKey');
+            expect(result).toBe('testValue');
+        },
+    );
+});
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@smythos/sdk",
-    "version": "1.0.33",
+    "version": "1.0.34",
     "description": "SRE SDK",
     "keywords": [
         "smythos",
diff --git a/packages/sdk/src/Agent/Agent.class.ts b/packages/sdk/src/Agent/Agent.class.ts
@@ -33,6 +33,7 @@ import { LLMInstance, TLLMInstanceParams } from '../LLM/LLMInstance.class';
 import { AgentData, ChatOptions, Scope } from '../types/SDKTypes';
 import { MCP, MCPSettings, MCPTransport } from '../MCP/MCP.class';
 import { findClosestModelInfo } from '../LLM/Model';
+import { VaultInstance } from '../Vault/VaultInstance.class';
 
 const console = SDKLog;
 
@@ -577,6 +578,27 @@ export class Agent extends SDKObject {
         return this._vectorDBProviders;
     }
 
+    private _vault: VaultInstance;
+
+    /**
+     * Access to the agent's team vault
+     *
+     * This will give you access to the current agent team vault, if no explicit team is set, the agent belongs to "default" team.
+     *
+     * @example
+     * ```typescript
+     * const value = await agent.vault.get('my-key');
+     * ```
+     *
+     * @returns The vault instance
+     */
+    public get vault() {
+        if (!this._vault) {
+            this._vault = new VaultInstance(AccessCandidate.agent(this._data.id));
+        }
+        return this._vault;
+    }
+
     /**
      * Add a skill to the agent, enabling it to perform specific tasks or operations.
      *
diff --git a/packages/sdk/src/Vault/Vault.ts b/packages/sdk/src/Vault/Vault.ts
@@ -0,0 +1,33 @@
+import { AccessCandidate, ConnectorService } from '@smythos/sre';
+
+export class Vault {
+    /**
+     * Get a value from the vault
+     * @param key - The key to get the value for
+     * @param candidate - The candidate to get the value for
+     * @returns The value of the key
+     */
+    static async get(key: string, candidate?: AccessCandidate) {
+        if (!candidate) candidate = AccessCandidate.team('default');
+        const vaultConnector = ConnectorService.getVaultConnector();
+        const vaultRequester = vaultConnector.requester(candidate);
+
+        const value = await vaultRequester.get(key);
+        return value;
+    }
+
+    /**
+     * List all keys in the vault
+     * @param candidate - The candidate to list the keys for
+     * @returns An array of keys
+     */
+    static async listKeys(candidate?: AccessCandidate) {
+        if (!candidate) candidate = AccessCandidate.team('default');
+
+        const vaultConnector = ConnectorService.getVaultConnector();
+        const vaultRequester = vaultConnector.requester(candidate);
+
+        const keys = await vaultRequester.listKeys();
+        return keys;
+    }
+}
diff --git a/packages/sdk/src/Vault/VaultInstance.class.ts b/packages/sdk/src/Vault/VaultInstance.class.ts
@@ -0,0 +1,41 @@
+import { AccessCandidate, ConnectorService, IAccessCandidate, IVaultRequest, VaultConnector } from '@smythos/sre';
+import { SRE } from '@smythos/sre';
+import { SDKObject } from '../Core/SDKObject.class';
+
+export class VaultInstance extends SDKObject {
+    #candidate: IAccessCandidate;
+    #vaultRequester: IVaultRequest;
+    constructor(candidate?: AccessCandidate) {
+        super();
+        this.#candidate = candidate || AccessCandidate.team('default');
+    }
+
+    protected async init() {
+        //if the SRE instance is not initializing, initialize it with default settings
+        if (!SRE.initializing) SRE.init({});
+        await SRE.ready();
+        const vaultConnector = ConnectorService.getVaultConnector();
+        this.#vaultRequester = vaultConnector.requester(this.#candidate);
+
+        this._readyPromise.resolve(true);
+    }
+
+    /**
+     * Get a value from the vault
+     * @param key - The key to get the value for
+     * @returns The value of the key
+     */
+    public async get(key: string) {
+        const value = await this.#vaultRequester.get(key);
+        return value;
+    }
+
+    /**
+     * List all keys in the vault
+     * @returns An array of keys
+     */
+    public async listKeys() {
+        const keys = await this.#vaultRequester.listKeys();
+        return keys;
+    }
+}
diff --git a/packages/sdk/src/index.ts b/packages/sdk/src/index.ts
@@ -29,6 +29,8 @@ export * from './types/ExportedSRETypes';
 export * from './types/SDKTypes';
 export * from './utils/help';
 export * from './utils/index';
+export * from './Vault/Vault';
+export * from './Vault/VaultInstance.class';
 export * from './VectorDB/VectorDB.class';
 export * from './VectorDB/VectorDBInstance.class';
 export * from './Components/generated/APICall';
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@`
`19`	`19`	`"@types/node": "^20.19.0",`
`20`	`20`	`"ts-node": "^10.9.2",`
`21`	`21`	`"tsx": "^4.7.0",`
`22`		`- "typescript": "^5.3.0"`
	`22`	`+ "typescript": "^5.3.0",`
	`23`	`+ "why-is-node-running": "^3.2.2"`
`23`	`24`	`}`
`24`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@smythos/sdk",`
`3`		`- "version": "1.0.33",`
	`3`	`+ "version": "1.0.34",`
`4`	`4`	`"description": "SRE SDK",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"smythos",`