@mikesaintsg/core 0.0.3 → 0.0.5

package/README.md

@@ -12,7 +12,8 @@
 
 - ✅ **Shared Types** — Contracts used across multiple packages
 - ✅ **Result Pattern** — Functional error handling (`ok`, `err`, `map`, `chain`)
-- ✅ **Bridge Functions** — Connect packages without circular dependencies
+- ✅ **Bridge Classes** — Ready-to-use implementations for cross-package communication
+- ✅ **Factory Functions** — Simple API for creating bridge instances
 - ✅ **Adapter Interfaces** — Embedding, tool format, persistence, and policy adapters
 - ✅ **Base Error Class** — `EcosystemError` for all package-specific errors
 - ✅ **Content Hashing** — SHA-256 based deduplication support
@@ -141,6 +142,17 @@ const results = await bridge.execute([call1, call2, call3])
 | `createFormDirtyGuard(options)`     | Navigation guard for dirty forms |
 | `createSessionPersistence(options)` | Session storage adapter          |
 
+### Bridge Classes
+
+Implementation classes for cross-package bridges (also available via factory functions):
+
+| Class                | Factory                      | Description                      |
+|----------------------|------------------------------|----------------------------------|
+| `ToolCallBridge`     | `createToolCallBridge()`     | Executes tool calls via registry |
+| `RetrievalTool`      | `createRetrievalTool()`      | Vectorstore search tool          |
+| `FormDirtyGuard`     | `createFormDirtyGuard()`     | Navigation guard for dirty forms |
+| `SessionPersistence` | `createSessionPersistence()` | Session storage adapter          |
+
 ### Error Handling
 
 | Export                 | Description                        |
@@ -155,7 +167,7 @@ const results = await bridge.execute([call1, call2, call3])
 | `Result<T, E>`                            | Success or failure union              |
 | `Ok<T>`, `Err<E>`                         | Result discriminants                  |
 | `Unsubscribe`                             | Cleanup function type                 |
-| `DestroyFn`                               | Resource cleanup function             |
+| `Destroyable`                             | Interface for resources with cleanup  |
 | `SubscriptionToHook<T>`                   | Convert subscriptions to hooks        |
 | `Embedding`                               | Float32Array embedding vector         |
 | `ToolCall`, `ToolResult`, `ToolSchema`    | Tool-related types                    |
@@ -286,6 +298,29 @@ const guard = createFormDirtyGuard({
 router.beforeNavigate(guard)
 ```
 
+### Using Bridge Classes Directly
+
+```ts
+import { ToolCallBridge, RetrievalTool, SessionPersistence } from '@mikesaintsg/core'
+
+// Direct class instantiation (alternative to factory functions)
+const bridge = new ToolCallBridge({
+  registry,
+  timeout: 30000,
+})
+
+const tool = new RetrievalTool({
+  vectorStore,
+  name: 'search',
+  description: 'Search documents',
+})
+
+const persistence = new SessionPersistence({
+  database,
+  storeName: 'sessions',
+})
+```
+
 ---
 
 ## Constants