@flutchai/flutch-sdk 0.1.0 → 0.1.1

package/README.md

@@ -1,10 +1,10 @@
 # @flutchai/flutch-sdk
 
-Base infrastructure package for building graph microservices in the Amelie AI platform.
+Base infrastructure package for building graph microservices with LangGraph and NestJS.
 
 ## Overview
 
-`sdk` is the foundation package that provides all the essential components needed to build, run, and manage graph-based microservices. It's designed to be self-contained with minimal external dependencies.
+`@flutchai/flutch-sdk` is a self-contained foundation package that provides all the essential components needed to build, run, and manage LangGraph-based microservices using NestJS framework.
 
 ## What's Included
 
@@ -53,10 +53,14 @@ Complete callback infrastructure for interactive user flows:
 
 ## Installation
 
-This is a workspace package - install via workspace root:
+```bash
+npm install @flutchai/flutch-sdk
+```
+
+or
 
 ```bash
-yarn install
+yarn add @flutchai/flutch-sdk
 ```
 
 ## Usage
@@ -181,40 +185,49 @@ src/
 
 ### Dependencies
 
-**Internal:**
+The package has no internal dependencies and relies only on well-established external libraries:
 
-- `@amelie/shared-types` - Base type definitions
-- `@amelie/graph-service-registry` - Service discovery (runtime only)
-
-**External:**
-
-- `@nestjs/*` - NestJS framework
-- `@langchain/langgraph` - Graph orchestration
-- `ioredis` - Redis client for callbacks
-- `helmet`, `compression` - HTTP middleware
+- `@nestjs/*` - NestJS framework for building scalable server-side applications
+- `@langchain/*` - LangChain ecosystem for LLM integrations and graph orchestration
+- `ioredis` - Redis client for callback system and caching
+- `axios` - HTTP client for external API calls
+- `zod` - TypeScript-first schema validation
+- `helmet`, `compression` - HTTP security and performance middleware
 
 ### Design Principles
 
-1. **Self-contained** - Minimal internal dependencies
-2. **Type-safe** - Comprehensive TypeScript definitions
-3. **Modular** - Use only what you need
-4. **Backward compatible** - Graceful migration paths
-5. **Framework agnostic** - Core types work anywhere
-
-## Migration Guide
+1. **Self-contained** - No internal dependencies, everything you need in one package
+2. **Type-safe** - Comprehensive TypeScript definitions for all components
+3. **Modular** - Use only what you need, import specific modules
+4. **Production-ready** - Built-in monitoring, health checks, and error handling
+5. **Framework integration** - Seamless NestJS integration with LangGraph
 
-If you were using types from `@amelie/graph-service-core` or `@amelie/graph-utils`:
+## Quick Start
 
 ```typescript
-// ❌ Old imports
-import { IGraphService } from "@amelie/graph-service-core";
-import { EventProcessor } from "@amelie/graph-utils";
+import { UniversalGraphModule, AbstractGraphBuilder } from "@flutchai/flutch-sdk";
+import { Module } from "@nestjs/common";
+
+@Injectable()
+export class MyGraphBuilder extends AbstractGraphBuilder<"myGraph"> {
+  async buildGraph(config?: any) {
+    // Your LangGraph implementation
+    return compiledGraph;
+  }
+}
 
-// ✅ New imports
-import { IGraphService, EventProcessor } from "@flutchai/flutch-sdk";
+@Module({
+  imports: [
+    UniversalGraphModule.register({
+      graphType: "myGraph",
+      builder: MyGraphBuilder,
+    }),
+  ],
+})
+export class MyGraphModule {}
 ```
 
-All old imports are marked `@deprecated` but still work for backward compatibility.
+Your graph service is now ready with built-in REST API, health checks, and monitoring!
 
 ## API
 
@@ -250,38 +263,48 @@ See `src/index.ts` for complete export list.
 ### Building
 
 ```bash
-yarn workspace @flutchai/flutch-sdk build
+npm run build
 ```
 
 ### Testing
 
 ```bash
-yarn workspace @flutchai/flutch-sdk test
+npm test
 ```
 
 ### Linting
 
 ```bash
-yarn workspace @flutchai/flutch-sdk lint
+npm run lint
 ```
 
-## Contributing
+## Features
+
+- **Ready-to-use NestJS module** for graph services
+- **Type-safe graph definitions** with TypeScript
+- **Built-in REST API** with OpenAPI documentation
+- **Callback system** for interactive user flows
+- **Stream processing** with real-time events
+- **Health checks** and Prometheus metrics
+- **Redis integration** for callbacks and caching
+- **Multi-LLM support** (OpenAI, Anthropic, Azure, Google, Mistral, Cohere)
+- **Graph versioning** utilities
+- **Manifest validation** for graph configurations
 
-When adding new features to sdk:
+## Use Cases
 
-1. **Keep it generic** - This is base infrastructure
-2. **Type everything** - Export proper TypeScript interfaces
-3. **Document well** - Add JSDoc comments
-4. **Test thoroughly** - Add unit tests for new utilities
-5. **Export properly** - Add to appropriate section in `index.ts`
+- Building AI agent microservices with LangGraph
+- Creating conversational AI applications
+- Implementing RAG (Retrieval-Augmented Generation) systems
+- Developing multi-step AI workflows
+- Building interactive AI assistants with callbacks
 
-## Version History
+## Links
 
-- **0.1.0** - Initial self-contained release
-  - Migrated core interfaces from graph-service-core
-  - Migrated utilities from graph-utils
-  - Removed external graph-services dependencies
+- [GitHub Repository](https://github.com/flutchai/flutch3)
+- [NPM Package](https://www.npmjs.com/package/@flutchai/flutch-sdk)
+- [Issues](https://github.com/flutchai/flutch3/issues)
 
 ## License
 
-Proprietary - Amelie AI Platform
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flutchai/flutch-sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Base infrastructure package for building graph microservices - core interfaces, types, utilities, and execution engine",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",