Initial commit

src/index.ts

@@ -0,0 +1,351 @@
+/**
+ * OPFS BrainyData
+ * A vector database using HNSW indexing with Origin Private File System storage
+ */
+
+// Export main BrainyData class and related types
+import { BrainyData, BrainyDataConfig } from './brainyData.js'
+
+export { BrainyData }
+export type { BrainyDataConfig }
+
+// Export distance functions for convenience
+import {
+  euclideanDistance,
+  cosineDistance,
+  manhattanDistance,
+  dotProductDistance
+} from './utils/index.js'
+
+export {
+  euclideanDistance,
+  cosineDistance,
+  manhattanDistance,
+  dotProductDistance
+}
+
+// Export embedding functionality
+import {
+  UniversalSentenceEncoder,
+  createEmbeddingFunction,
+  createTensorFlowEmbeddingFunction,
+  createThreadedEmbeddingFunction,
+  defaultEmbeddingFunction
+} from './utils/embedding.js'
+
+export {
+  UniversalSentenceEncoder,
+  createEmbeddingFunction,
+  createTensorFlowEmbeddingFunction,
+  createThreadedEmbeddingFunction,
+  defaultEmbeddingFunction
+}
+
+// Export storage adapters
+import {
+  OPFSStorage,
+  MemoryStorage,
+  createStorage
+} from './storage/opfsStorage.js'
+import { FileSystemStorage } from './storage/fileSystemStorage.js'
+import { R2Storage, S3CompatibleStorage } from './storage/s3CompatibleStorage.js'
+
+export {
+  OPFSStorage,
+  MemoryStorage,
+  FileSystemStorage,
+  R2Storage,
+  S3CompatibleStorage,
+  createStorage
+}
+
+// Export unified pipeline
+import {
+  Pipeline,
+  pipeline,
+  augmentationPipeline,
+  ExecutionMode,
+  PipelineOptions,
+  PipelineResult,
+  executeStreamlined,
+  executeByType,
+  executeSingle,
+  processStaticData,
+  processStreamingData,
+  createPipeline,
+  createStreamingPipeline,
+  StreamlinedExecutionMode,
+  StreamlinedPipelineOptions,
+  StreamlinedPipelineResult
+} from './pipeline.js'
+
+// Export sequential pipeline (for backward compatibility)
+import {
+  SequentialPipeline,
+  sequentialPipeline,
+  SequentialPipelineOptions
+} from './sequentialPipeline.js'
+
+// Export augmentation factory
+import {
+  createSenseAugmentation,
+  addWebSocketSupport,
+  executeAugmentation,
+  loadAugmentationModule,
+  AugmentationOptions
+} from './augmentationFactory.js'
+
+export {
+  // Unified pipeline exports
+  Pipeline,
+  pipeline,
+  augmentationPipeline,
+  ExecutionMode,
+  SequentialPipeline,
+  sequentialPipeline,
+
+  // Streamlined pipeline exports (now part of unified pipeline)
+  executeStreamlined,
+  executeByType,
+  executeSingle,
+  processStaticData,
+  processStreamingData,
+  createPipeline,
+  createStreamingPipeline,
+  StreamlinedExecutionMode,
+
+  // Augmentation factory exports
+  createSenseAugmentation,
+  addWebSocketSupport,
+  executeAugmentation,
+  loadAugmentationModule
+}
+export type { 
+  PipelineOptions, 
+  PipelineResult, 
+  SequentialPipelineOptions,
+  StreamlinedPipelineOptions,
+  StreamlinedPipelineResult,
+  AugmentationOptions
+}
+
+// Export augmentation registry for build-time loading
+import {
+  availableAugmentations,
+  registerAugmentation,
+  initializeAugmentationPipeline,
+  setAugmentationEnabled,
+  getAugmentationsByType
+} from './augmentationRegistry.js'
+
+export {
+  availableAugmentations,
+  registerAugmentation,
+  initializeAugmentationPipeline,
+  setAugmentationEnabled,
+  getAugmentationsByType
+}
+
+// Export augmentation registry loader for build tools
+import {
+  loadAugmentationsFromModules,
+  createAugmentationRegistryPlugin,
+  createAugmentationRegistryRollupPlugin
+} from './augmentationRegistryLoader.js'
+import type {
+  AugmentationRegistryLoaderOptions,
+  AugmentationLoadResult
+} from './augmentationRegistryLoader.js'
+
+export {
+  loadAugmentationsFromModules,
+  createAugmentationRegistryPlugin,
+  createAugmentationRegistryRollupPlugin
+}
+export type {
+  AugmentationRegistryLoaderOptions,
+  AugmentationLoadResult
+}
+
+// Export augmentation implementations
+import {
+  MemoryStorageAugmentation,
+  FileSystemStorageAugmentation,
+  OPFSStorageAugmentation,
+  createMemoryAugmentation
+} from './augmentations/memoryAugmentations.js'
+import {
+  WebSocketConduitAugmentation,
+  WebRTCConduitAugmentation,
+  createConduitAugmentation
+} from './augmentations/conduitAugmentations.js'
+import {
+  ServerSearchConduitAugmentation,
+  ServerSearchActivationAugmentation,
+  createServerSearchAugmentations
+} from './augmentations/serverSearchAugmentations.js'
+
+// Non-LLM exports
+export {
+  MemoryStorageAugmentation,
+  FileSystemStorageAugmentation,
+  OPFSStorageAugmentation,
+  createMemoryAugmentation,
+  WebSocketConduitAugmentation,
+  WebRTCConduitAugmentation,
+  createConduitAugmentation,
+  ServerSearchConduitAugmentation,
+  ServerSearchActivationAugmentation,
+  createServerSearchAugmentations
+}
+
+// LLM augmentations are optional and not imported by default
+// They can be imported directly from their module if needed:
+// import { LLMCognitionAugmentation, LLMActivationAugmentation, createLLMAugmentations } from './augmentations/llmAugmentations.js'
+
+
+// Export types
+import type {
+  Vector,
+  VectorDocument,
+  SearchResult,
+  DistanceFunction,
+  EmbeddingFunction,
+  EmbeddingModel,
+  HNSWNoun,
+  GraphVerb,
+  HNSWConfig,
+  StorageAdapter
+} from './coreTypes.js'
+
+// Export HNSW index and optimized version
+import { HNSWIndex } from './hnsw/hnswIndex.js'
+import { HNSWIndexOptimized, HNSWOptimizedConfig } from './hnsw/hnswIndexOptimized.js'
+
+export {
+  HNSWIndex,
+  HNSWIndexOptimized
+}
+
+export type {
+  Vector,
+  VectorDocument,
+  SearchResult,
+  DistanceFunction,
+  EmbeddingFunction,
+  EmbeddingModel,
+  HNSWNoun,
+  GraphVerb,
+  HNSWConfig,
+  HNSWOptimizedConfig,
+  StorageAdapter
+}
+
+// Export augmentation types
+import type {
+  IAugmentation,
+  AugmentationResponse,
+  IWebSocketSupport,
+  ISenseAugmentation,
+  IConduitAugmentation,
+  ICognitionAugmentation,
+  IMemoryAugmentation,
+  IPerceptionAugmentation,
+  IDialogAugmentation,
+  IActivationAugmentation
+} from './types/augmentations.js'
+import { AugmentationType, BrainyAugmentations } from './types/augmentations.js'
+
+export type {
+  IAugmentation,
+  AugmentationResponse,
+  IWebSocketSupport
+}
+export {
+  AugmentationType,
+  BrainyAugmentations,
+  ISenseAugmentation,
+  IConduitAugmentation,
+  ICognitionAugmentation,
+  IMemoryAugmentation,
+  IPerceptionAugmentation,
+  IDialogAugmentation,
+  IActivationAugmentation
+}
+
+// Export combined WebSocket augmentation interfaces
+export type {
+  IWebSocketCognitionAugmentation,
+  IWebSocketSenseAugmentation,
+  IWebSocketPerceptionAugmentation,
+  IWebSocketActivationAugmentation,
+  IWebSocketDialogAugmentation,
+  IWebSocketConduitAugmentation,
+  IWebSocketMemoryAugmentation
+} from './types/augmentations.js'
+
+// Export graph types
+import type {
+  GraphNoun,
+  EmbeddedGraphVerb,
+  Person,
+  Place,
+  Thing,
+  Event,
+  Concept,
+  Content
+} from './types/graphTypes.js'
+import { NounType, VerbType } from './types/graphTypes.js'
+
+export type {
+  GraphNoun,
+  EmbeddedGraphVerb,
+  Person,
+  Place,
+  Thing,
+  Event,
+  Concept,
+  Content
+}
+export { NounType, VerbType }
+
+// Export MCP (Model Control Protocol) components
+import {
+  BrainyMCPAdapter,
+  MCPAugmentationToolset,
+  BrainyMCPService
+} from './mcp/index.js' // Import from mcp/index.js
+import {
+  MCPRequest,
+  MCPResponse,
+  MCPDataAccessRequest,
+  MCPToolExecutionRequest,
+  MCPSystemInfoRequest,
+  MCPAuthenticationRequest,
+  MCPRequestType,
+  MCPServiceOptions,
+  MCPTool,
+  MCP_VERSION
+} from './types/mcpTypes.js'
+
+export {
+  // MCP classes
+  BrainyMCPAdapter,
+  MCPAugmentationToolset,
+  BrainyMCPService,
+
+  // MCP types
+  MCPRequestType,
+  MCP_VERSION
+}
+
+export type {
+  MCPRequest,
+  MCPResponse,
+  MCPDataAccessRequest,
+  MCPToolExecutionRequest,
+  MCPSystemInfoRequest,
+  MCPAuthenticationRequest,
+  MCPServiceOptions,
+  MCPTool
+}