David Snelling
755b1a6fc1
### Changes: - Created `examples/browser_compatible_exports.ts`: - Introduced browser-friendly exports with polyfill for `Buffer` in browser environments. - Implemented shims for Node.js modules (`fs`, `util`, and `path`) to avoid compatibility issues. - Exported browser-compatible types and utilities: `BrainyData`, `NounType`, `VerbType`, graph types, core types, distance functions, embedding utilities, and storage adapters. - Explicitly excluded Node.js/CLI-specific parts to focus on browser compatibility. - Added `src/types/brainyDataInterface.ts`: - Defined `BrainyDataInterface` to break the circular dependency between `brainyData.ts` and `serverSearchAugmentations.ts`. - Provided methods for managing nodes, relationships, initialization, search, and adding vector data with metadata. ### Purpose: - Enhanced the codebase to support browser environments by introducing browser-specific exports and avoiding Node.js dependencies. - Established clearer separation of concerns and modularity by introducing the `BrainyDataInterface` for dependency management, improving maintainability and flexibility.
47 lines
1.4 KiB
TypeScript
47 lines
1.4 KiB
TypeScript
/**
|
|
* BrainyDataInterface
|
|
*
|
|
* This interface defines the methods from BrainyData that are used by serverSearchAugmentations.ts.
|
|
* It's used to break the circular dependency between brainyData.ts and serverSearchAugmentations.ts.
|
|
*/
|
|
|
|
import { Vector } from '../coreTypes.js'
|
|
|
|
export interface BrainyDataInterface<T = unknown> {
|
|
/**
|
|
* Initialize the database
|
|
*/
|
|
init(): Promise<void>
|
|
|
|
/**
|
|
* Get a noun by ID
|
|
* @param id The ID of the noun to get
|
|
*/
|
|
get(id: string): Promise<unknown>
|
|
|
|
/**
|
|
* Add a vector or data to the database
|
|
* @param vectorOrData Vector or data to add
|
|
* @param metadata Optional metadata to associate with the vector
|
|
* @returns The ID of the added vector
|
|
*/
|
|
add(vectorOrData: Vector | unknown, metadata?: T): Promise<string>
|
|
|
|
/**
|
|
* Search for text in the database
|
|
* @param text The text to search for
|
|
* @param limit Maximum number of results to return
|
|
* @returns Search results
|
|
*/
|
|
searchText(text: string, limit?: number): Promise<unknown[]>
|
|
|
|
/**
|
|
* Create a relationship between two entities
|
|
* @param sourceId The ID of the source entity
|
|
* @param targetId The ID of the target entity
|
|
* @param relationType The type of relationship
|
|
* @param metadata Optional metadata about the relationship
|
|
* @returns The ID of the created relationship
|
|
*/
|
|
relate(sourceId: string, targetId: string, relationType: string, metadata?: unknown): Promise<string>
|
|
}
|