@smythos/sre 1.5.4 → 1.5.6

package/dist/types/helpers/Sysconfig.helper.d.ts

@@ -0,0 +1 @@
+export declare function findSmythPath(_path?: string, callback?: (smythDir: string, success?: boolean, nextDir?: string) => void): any;

package/dist/types/index.d.ts

@@ -51,6 +51,7 @@ export * from './helpers/Log.helper';
 export * from './helpers/OpenApiParser.helper';
 export * from './helpers/S3Cache.helper';
 export * from './helpers/SmythURI.helper';
+export * from './helpers/Sysconfig.helper';
 export * from './helpers/TemplateString.helper';
 export * from './helpers/TypeChecker.helper';
 export * from './types/ACL.types';
@@ -137,6 +138,7 @@ export * from './subsystems/AgentManager/AgentData.service/connectors/NullAgentD
 export * from './subsystems/AgentManager/Component.service/connectors/LocalComponentConnector.class';
 export * from './subsystems/ComputeManager/Code.service/connectors/AWSLambdaCode.class';
 export * from './subsystems/IO/Log.service/connectors/ConsoleLog.class';
+export * from './subsystems/IO/NKV.service/connectors/NKVLocalStorage.class';
 export * from './subsystems/IO/NKV.service/connectors/NKVRAM.class';
 export * from './subsystems/IO/NKV.service/connectors/NKVRedis.class';
 export * from './subsystems/IO/Router.service/connectors/ExpressRouter.class';

package/dist/types/subsystems/IO/Log.service/connectors/ConsoleLog.class.d.ts

@@ -4,9 +4,9 @@ import { IAccessCandidate } from '@sre/types/ACL.types';
 import { LogConnector } from '../LogConnector';
 import { AgentCallLog } from '@sre/types/AgentLogger.types';
 export declare class ConsoleLog extends LogConnector {
+    name: string;
     id: string;
     getResourceACL(resourceId: string, candidate: IAccessCandidate): Promise<ACL>;
     protected log(acRequest: AccessRequest, logData: AgentCallLog, callId?: string): Promise<any>;
     protected logTask(acRequest: AccessRequest, tasks: number, isUsingTestDomain: boolean): Promise<void>;
-    name: string;
 }

package/dist/types/subsystems/IO/NKV.service/NKVConnector.d.ts

@@ -17,6 +17,8 @@ export interface INKVRequest {
 }
 /**
  * NKV = Namespace-Key-Value Connector
+ * The NKV Connectors are used to store and retrieve data in a namespace-key-value format.
+ * It is generally used by internal connectors to index data : for example, some vectorDB providers may use it to keep track of inserted vectors.
  */
 export declare abstract class NKVConnector extends SecureConnector {
     requester(candidate: AccessCandidate): INKVRequest;

package/dist/types/subsystems/IO/NKV.service/connectors/NKVLocalStorage.class.d.ts

@@ -0,0 +1,34 @@
+import { AccessRequest } from '@sre/Security/AccessControl/AccessRequest.class';
+import { NKVConnector } from '../NKVConnector';
+import { IAccessCandidate } from '@sre/types/ACL.types';
+import { ACL } from '@sre/Security/AccessControl/ACL.class';
+import { StorageData } from '@sre/types/Storage.types';
+export type NKVLocalStorageConfig = {
+    folder?: string;
+};
+export declare class NKVLocalStorage extends NKVConnector {
+    protected _settings?: NKVLocalStorageConfig;
+    name: string;
+    private folder;
+    private accountConnector;
+    private cacheConnector;
+    private isInitialized;
+    constructor(_settings?: NKVLocalStorageConfig);
+    private findStorageFolder;
+    private initialize;
+    private getStoragePath;
+    key(...parts: string[]): string;
+    protected get(acRequest: AccessRequest, namespace: string, key: string): Promise<StorageData>;
+    protected set(acRequest: AccessRequest, namespace: string, key: string, value: any): Promise<void>;
+    protected delete(acRequest: AccessRequest, namespace: string, key: string): Promise<void>;
+    protected exists(acRequest: AccessRequest, namespace: string, key: string): Promise<boolean>;
+    list(acRequest: AccessRequest, namespace: string): Promise<{
+        key: string;
+        data: StorageData;
+    }[]>;
+    deleteAll(acRequest: AccessRequest, namespace: string): Promise<void>;
+    getResourceACL(resourceId: string, candidate: IAccessCandidate): Promise<ACL>;
+    clearAll(): void;
+    static NamespaceAccessControl(target: any, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;
+    static Validate(target: any, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;
+}

package/dist/types/subsystems/IO/Storage.service/connectors/LocalStorage.class.d.ts

@@ -20,6 +20,7 @@ export declare class LocalStorage extends StorageConnector {
     private metadataPrefix;
     private isInitialized;
     constructor(_settings?: LocalStorageConfig);
+    private findStorageFolder;
     /**
      * Reads an object from the local storage.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smythos/sre",
-  "version": "1.5.4",
+  "version": "1.5.6",
   "description": "Smyth Runtime Environment",
   "author": "Alaa-eddine KADDOURI",
   "license": "MIT",

package/src/Components/DataSourceLookup.class.ts

@@ -70,7 +70,7 @@ export class DataSourceLookup extends Component {
                 .requester(AccessCandidate.team(teamId))
                 .search(namespace, _input, { topK, includeMetadata: true });
             results = response.slice(0, config.data.topK).map((result) => ({
-                content: result.metadata?.text,
+                content: result.text,
                 metadata: result.metadata,
             }));
 

package/src/Core/SmythRuntime.class.ts

@@ -1,14 +1,10 @@
 import { boot } from './boot';
 
 import { SREConfig, TConnectorService } from '@sre/types/SRE.types';
+import { Logger } from '../helpers/Log.helper';
 import { ConnectorService } from './ConnectorsService';
 import { SystemEvents } from './SystemEvents';
-import { Logger } from '../helpers/Log.helper';
-import path from 'path';
-import fs from 'fs';
-import os from 'os';
-import { fileURLToPath } from 'url';
-import { dirname } from 'path';
+import { findSmythPath } from '../helpers/Sysconfig.helper';
 
 const logger = Logger('SRE');
 
@@ -90,7 +86,7 @@ export class SmythRuntime {
 
     public init(_config?: SREConfig): SmythRuntime {
         if (!_config || JSON.stringify(_config) === '{}') {
-            this._smythDir = findSmythDir();
+            this._smythDir = findSmythPath();
             logger.info('.smyth directory found in:', this._smythDir);
         }
 
@@ -198,65 +194,6 @@ export class SmythRuntime {
 export const SRE = SmythRuntime.Instance;
 let shuttingDown = false;
 
-function findSmythDir() {
-    // 1. Try to find in local directory (the directory from which the program was run)
-    const localDir = path.resolve(process.cwd(), '.smyth');
-    if (fs.existsSync(localDir)) {
-        return localDir;
-    }
-
-    // 2. Try to find from main script's directory (entry point)
-    const mainScriptPath = process.argv[1];
-    const mainScriptDir = path.dirname(path.resolve(mainScriptPath));
-    if (mainScriptPath) {
-        const mainScriptSmythDir = path.resolve(mainScriptDir, '.smyth');
-        if (fs.existsSync(mainScriptSmythDir)) {
-            return mainScriptSmythDir;
-        }
-    }
-
-    // 3. Try to find it in current package root directory (where package.json is)
-    let packageRootDir = findPackageRoot();
-    if (packageRootDir) {
-        const packageSmythDir = path.resolve(packageRootDir, '.smyth');
-        if (fs.existsSync(packageSmythDir)) {
-            return packageSmythDir;
-        }
-    }
-
-    // 4. Try to find it in current package root directory from main script's directory
-    packageRootDir = findPackageRoot(mainScriptDir);
-    if (packageRootDir) {
-        const packageSmythDir = path.resolve(packageRootDir, '.smyth');
-        if (fs.existsSync(packageSmythDir)) {
-            return packageSmythDir;
-        }
-    }
-
-    // 5. Try to find it in user home directory
-    const homeDir = path.resolve(os.homedir(), '.smyth');
-    if (fs.existsSync(homeDir)) {
-        return homeDir;
-    }
-
-    // Default: return path in current working directory (will be created if needed)
-    return localDir;
-}
-
-function findPackageRoot(startDir = process.cwd()) {
-    let currentDir = startDir;
-
-    while (currentDir !== path.dirname(currentDir)) {
-        const packageJsonPath = path.resolve(currentDir, 'package.json');
-        if (fs.existsSync(packageJsonPath)) {
-            return currentDir;
-        }
-        currentDir = path.dirname(currentDir);
-    }
-
-    return null;
-}
-
 async function shutdown(reason) {
     if (!SmythRuntime.Instance.started) return;
     if (shuttingDown) return;

package/src/helpers/Sysconfig.helper.ts

@@ -0,0 +1,67 @@
+import path from 'path';
+import fs from 'fs';
+import os from 'os';
+
+export function findSmythPath(_path: string = '', callback?: (smythDir: string, success?: boolean, nextDir?: string) => void) {
+    //TODO : also search for a local sre configuration file indicating .smyth folder explicitly
+
+    const searchDirectories = [];
+
+    // 1. Try to find in local directory (the directory from which the program was run)
+    const localDir = path.resolve(process.cwd(), '.smyth', _path);
+    searchDirectories.push(localDir);
+
+    // 2. Try to find from main script's directory (entry point)
+    const mainScriptPath = process.argv[1];
+    const mainScriptDir = mainScriptPath ? path.dirname(path.resolve(mainScriptPath)) : null;
+    if (mainScriptDir) {
+        const mainScriptSmythDir = path.resolve(mainScriptDir, '.smyth', _path);
+        searchDirectories.push(mainScriptSmythDir);
+    }
+
+    // 3. Try to find it in current package root directory (where package.json is)
+    const packageRootDir = findPackageRoot();
+    if (packageRootDir) {
+        const packageSmythDir = path.resolve(packageRootDir, '.smyth', _path);
+        searchDirectories.push(packageSmythDir);
+    }
+
+    // 4. Try to find it in current package root directory from main script's directory
+    const packageMainRootDir = findPackageRoot(mainScriptDir);
+    if (packageMainRootDir) {
+        const packageSmythDir = path.resolve(packageMainRootDir, '.smyth', _path);
+        searchDirectories.push(packageSmythDir);
+    }
+
+    // 5. Try to find it in user home directory
+    const homeDir = path.resolve(os.homedir(), '.smyth', _path);
+    searchDirectories.push(homeDir);
+
+    //check if any of the directories exist
+    for (let i = 0; i < searchDirectories.length; i++) {
+        const dir = searchDirectories[i];
+        const nextDir = searchDirectories[i + 1];
+        if (!fs.existsSync(dir)) {
+            callback?.(dir, false, nextDir);
+            continue;
+        }
+        callback?.(dir, true, null);
+        return dir;
+    }
+
+    return localDir;
+}
+
+function findPackageRoot(startDir = process.cwd()) {
+    let currentDir = startDir;
+
+    while (currentDir !== path.dirname(currentDir)) {
+        const packageJsonPath = path.resolve(currentDir, 'package.json');
+        if (fs.existsSync(packageJsonPath)) {
+            return currentDir;
+        }
+        currentDir = path.dirname(currentDir);
+    }
+
+    return null;
+}

package/src/index.ts

@@ -57,6 +57,7 @@ export * from './helpers/Log.helper';
 export * from './helpers/OpenApiParser.helper';
 export * from './helpers/S3Cache.helper';
 export * from './helpers/SmythURI.helper';
+export * from './helpers/Sysconfig.helper';
 export * from './helpers/TemplateString.helper';
 export * from './helpers/TypeChecker.helper';
 export * from './types/ACL.types';
@@ -143,6 +144,7 @@ export * from './subsystems/AgentManager/AgentData.service/connectors/NullAgentD
 export * from './subsystems/AgentManager/Component.service/connectors/LocalComponentConnector.class';
 export * from './subsystems/ComputeManager/Code.service/connectors/AWSLambdaCode.class';
 export * from './subsystems/IO/Log.service/connectors/ConsoleLog.class';
+export * from './subsystems/IO/NKV.service/connectors/NKVLocalStorage.class';
 export * from './subsystems/IO/NKV.service/connectors/NKVRAM.class';
 export * from './subsystems/IO/NKV.service/connectors/NKVRedis.class';
 export * from './subsystems/IO/Router.service/connectors/ExpressRouter.class';