@hazeljs/ai 0.2.0-alpha.1

package/LICENSE

@@ -0,0 +1,192 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   Copyright 2024 HazelJS Team
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+---
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+   Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+   stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+   that You distribute, all copyright, patent, trademark, and
+   attribution notices from the Source form of the Work,
+   excluding those notices that do not pertain to any part of
+   the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+   distribution, then any Derivative Works that You distribute must
+   include a readable copy of the attribution notices contained
+   within such NOTICE file, excluding those notices that do not
+   pertain to any part of the Derivative Works, in at least one
+   of the following places: within a NOTICE text file distributed
+   as part of the Derivative Works; within the Source form or
+   documentation, if provided along with the Derivative Works; or,
+   within a display generated by the Derivative Works, if and
+   wherever such third-party notices normally appear. The contents
+   of the NOTICE file are for informational purposes only and
+   do not modify the License. You may add Your own attribution
+   notices within Derivative Works that You distribute, alongside
+   or as an addendum to the NOTICE text from the Work, provided
+   that such additional attribution notices cannot be construed
+   as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,497 @@
+# @hazeljs/ai
+
+**Add AI to your API in minutes — not days.**
+
+OpenAI, Anthropic, Gemini, Cohere, Ollama. One decorator, one config. Streaming, caching, retries, and type-safe outputs. Ship AI features without the glue code.
+
+[![npm version](https://img.shields.io/npm/v/@hazeljs/ai.svg)](https://www.npmjs.com/package/@hazeljs/ai)
+[![npm downloads](https://img.shields.io/npm/dm/@hazeljs/ai)](https://www.npmjs.com/package/@hazeljs/ai)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+## Features
+
+- 🤖 **Multiple Providers** - OpenAI, Anthropic, Gemini, Cohere, Ollama
+- 🎨 **Decorator-Based API** - `@AITask` decorator for clean integration
+- 📡 **Streaming Support** - Real-time response streaming
+- 🔄 **Retry Logic** - Automatic retries with exponential backoff
+- 💾 **Response Caching** - Built-in caching with @hazeljs/cache
+- 🎯 **Type Safety** - Full TypeScript support with output types
+- 🔧 **Flexible Configuration** - Per-task or global configuration
+- 📊 **Token Tracking** - Monitor usage and costs
+
+## Installation
+
+```bash
+npm install @hazeljs/ai
+```
+
+### Peer Dependencies
+
+Install the provider(s) you want to use:
+
+```bash
+# OpenAI
+npm install openai
+
+# Anthropic
+npm install @anthropic-ai/sdk
+
+# Google Gemini
+npm install @google/generative-ai
+
+# Cohere
+npm install cohere-ai
+
+# Ollama (local LLMs)
+npm install ollama
+```
+
+## Quick Start
+
+### Basic Usage with Decorator
+
+```typescript
+import { Injectable } from '@hazeljs/core';
+import { AIService, AITask } from '@hazeljs/ai';
+
+@Injectable()
+export class ChatService {
+  constructor(private aiService: AIService) {}
+
+  @AITask({
+    name: 'chat',
+    prompt: 'You are a helpful assistant. Respond to: {{input}}',
+    provider: 'openai',
+    model: 'gpt-4',
+    outputType: 'string',
+  })
+  async chat(message: string): Promise<string> {
+    return message; // Decorator handles AI execution
+  }
+}
+
+// Usage
+const response = await chatService.chat('Hello, how are you?');
+console.log(response);
+```
+
+### Direct AI Service Usage
+
+```typescript
+import { AIEnhancedService } from '@hazeljs/ai';
+
+const aiService = new AIEnhancedService();
+
+const response = await aiService.complete({
+  messages: [
+    { role: 'system', content: 'You are a helpful assistant' },
+    { role: 'user', content: 'What is TypeScript?' }
+  ],
+  model: 'gpt-4',
+  provider: 'openai',
+  temperature: 0.7,
+  maxTokens: 500,
+});
+
+console.log(response.content);
+console.log('Tokens used:', response.usage);
+```
+
+## Providers
+
+### OpenAI
+
+```typescript
+import { AIEnhancedService } from '@hazeljs/ai';
+
+const aiService = new AIEnhancedService();
+
+// GPT-4
+const response = await aiService.complete({
+  messages: [{ role: 'user', content: 'Hello!' }],
+  model: 'gpt-4',
+  provider: 'openai',
+});
+
+// GPT-3.5 Turbo
+const response2 = await aiService.complete({
+  messages: [{ role: 'user', content: 'Hello!' }],
+  model: 'gpt-3.5-turbo',
+  provider: 'openai',
+});
+```
+
+### Anthropic Claude
+
+```typescript
+const response = await aiService.complete({
+  messages: [{ role: 'user', content: 'Explain quantum computing' }],
+  model: 'claude-3-opus-20240229',
+  provider: 'anthropic',
+  maxTokens: 1000,
+});
+```
+
+### Google Gemini
+
+```typescript
+const response = await aiService.complete({
+  messages: [{ role: 'user', content: 'Write a poem' }],
+  model: 'gemini-pro',
+  provider: 'gemini',
+});
+```
+
+### Cohere
+
+```typescript
+const response = await aiService.complete({
+  messages: [{ role: 'user', content: 'Summarize this text' }],
+  model: 'command',
+  provider: 'cohere',
+});
+```
+
+### Ollama (Local LLMs)
+
+```typescript
+const response = await aiService.complete({
+  messages: [{ role: 'user', content: 'Hello!' }],
+  model: 'llama2',
+  provider: 'ollama',
+  baseURL: 'http://localhost:11434',
+});
+```
+
+## Streaming
+
+```typescript
+import { AIEnhancedService } from '@hazeljs/ai';
+
+const aiService = new AIEnhancedService();
+
+// Stream responses in real-time
+for await (const chunk of aiService.streamComplete({
+  messages: [{ role: 'user', content: 'Tell me a long story' }],
+  provider: 'openai',
+  model: 'gpt-4',
+})) {
+  process.stdout.write(chunk.delta);
+}
+```
+
+### Streaming with Decorator
+
+```typescript
+@AITask({
+  name: 'stream-chat',
+  prompt: 'You are a storyteller. Tell a story about: {{topic}}',
+  provider: 'openai',
+  model: 'gpt-4',
+  stream: true,
+})
+async streamStory(topic: string): AsyncGenerator<string> {
+  return topic; // Returns async generator
+}
+
+// Usage
+for await (const chunk of chatService.streamStory('dragons')) {
+  console.log(chunk);
+}
+```
+
+## Advanced Features
+
+### Response Caching
+
+```typescript
+import { AITask } from '@hazeljs/ai';
+
+@AITask({
+  name: 'cached-completion',
+  prompt: 'Explain {{concept}}',
+  provider: 'openai',
+  model: 'gpt-4',
+  cache: {
+    enabled: true,
+    ttl: 3600, // 1 hour
+    key: 'explain-{{concept}}',
+  },
+})
+async explainConcept(concept: string): Promise<string> {
+  return concept;
+}
+```
+
+### Retry Logic
+
+```typescript
+const response = await aiService.complete({
+  messages: [{ role: 'user', content: 'Hello' }],
+  provider: 'openai',
+  model: 'gpt-4',
+  retry: {
+    maxRetries: 3,
+    initialDelay: 1000,
+    maxDelay: 10000,
+    backoffMultiplier: 2,
+  },
+});
+```
+
+### Output Type Validation
+
+```typescript
+interface UserProfile {
+  name: string;
+  age: number;
+  interests: string[];
+}
+
+@AITask({
+  name: 'extract-profile',
+  prompt: 'Extract user profile from: {{text}}',
+  provider: 'openai',
+  model: 'gpt-4',
+  outputType: 'json',
+})
+async extractProfile(text: string): Promise<UserProfile> {
+  return text;
+}
+
+const profile = await service.extractProfile('John is 25 and loves coding');
+console.log(profile.name); // Type-safe!
+```
+
+### Function Calling
+
+```typescript
+const response = await aiService.complete({
+  messages: [{ role: 'user', content: 'What is the weather in NYC?' }],
+  provider: 'openai',
+  model: 'gpt-4',
+  functions: [
+    {
+      name: 'get_weather',
+      description: 'Get the current weather in a location',
+      parameters: {
+        type: 'object',
+        properties: {
+          location: {
+            type: 'string',
+            description: 'The city and state, e.g. San Francisco, CA',
+          },
+          unit: { type: 'string', enum: ['celsius', 'fahrenheit'] },
+        },
+        required: ['location'],
+      },
+    },
+  ],
+  functionCall: 'auto',
+});
+
+if (response.functionCall) {
+  console.log('Function:', response.functionCall.name);
+  console.log('Arguments:', response.functionCall.arguments);
+}
+```
+
+## Configuration
+
+### Global Configuration
+
+```typescript
+import { AIModule } from '@hazeljs/ai';
+
+@HazelModule({
+  imports: [
+    AIModule.forRoot({
+      providers: {
+        openai: {
+          apiKey: process.env.OPENAI_API_KEY,
+          organization: process.env.OPENAI_ORG,
+        },
+        anthropic: {
+          apiKey: process.env.ANTHROPIC_API_KEY,
+        },
+        gemini: {
+          apiKey: process.env.GEMINI_API_KEY,
+        },
+      },
+      defaultProvider: 'openai',
+      defaultModel: 'gpt-4',
+      cache: {
+        enabled: true,
+        ttl: 3600,
+      },
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+### Per-Task Configuration
+
+```typescript
+@AITask({
+  name: 'custom-task',
+  prompt: 'Process: {{input}}',
+  provider: 'openai',
+  model: 'gpt-4',
+  temperature: 0.7,
+  maxTokens: 1000,
+  topP: 0.9,
+  frequencyPenalty: 0.5,
+  presencePenalty: 0.5,
+  stop: ['\n\n'],
+})
+async processInput(input: string): Promise<string> {
+  return input;
+}
+```
+
+## Use Cases
+
+### Chatbot
+
+```typescript
+@Injectable()
+export class ChatbotService {
+  private conversationHistory: Array<{ role: string; content: string }> = [];
+
+  @AITask({
+    name: 'chat',
+    provider: 'openai',
+    model: 'gpt-4',
+  })
+  async chat(message: string): Promise<string> {
+    this.conversationHistory.push({ role: 'user', content: message });
+    
+    const response = await this.aiService.complete({
+      messages: this.conversationHistory,
+      provider: 'openai',
+      model: 'gpt-4',
+    });
+
+    this.conversationHistory.push({ 
+      role: 'assistant', 
+      content: response.content 
+    });
+
+    return response.content;
+  }
+}
+```
+
+### Content Generation
+
+```typescript
+@Injectable()
+export class ContentService {
+  @AITask({
+    name: 'generate-blog',
+    prompt: `Write a blog post about {{topic}}.
+    
+    Requirements:
+    - Length: {{length}} words
+    - Tone: {{tone}}
+    - Include SEO keywords: {{keywords}}`,
+    provider: 'openai',
+    model: 'gpt-4',
+    outputType: 'string',
+  })
+  async generateBlogPost(
+    topic: string,
+    length: number,
+    tone: string,
+    keywords: string[]
+  ): Promise<string> {
+    return topic;
+  }
+}
+```
+
+### Data Extraction
+
+```typescript
+interface ExtractedData {
+  entities: string[];
+  sentiment: 'positive' | 'negative' | 'neutral';
+  summary: string;
+}
+
+@Injectable()
+export class AnalysisService {
+  @AITask({
+    name: 'analyze-text',
+    prompt: `Analyze the following text and extract:
+    1. Named entities (people, places, organizations)
+    2. Overall sentiment
+    3. Brief summary
+    
+    Text: {{text}}
+    
+    Return as JSON.`,
+    provider: 'openai',
+    model: 'gpt-4',
+    outputType: 'json',
+  })
+  async analyzeText(text: string): Promise<ExtractedData> {
+    return text;
+  }
+}
+```
+
+## API Reference
+
+### AIEnhancedService
+
+```typescript
+class AIEnhancedService {
+  complete(options: AICompletionOptions): Promise<AIResponse>;
+  streamComplete(options: AICompletionOptions): AsyncGenerator<AIStreamChunk>;
+  embed(text: string, options?: EmbedOptions): Promise<number[]>;
+}
+```
+
+### @AITask Decorator
+
+```typescript
+@AITask({
+  name: string;
+  prompt?: string;
+  provider: 'openai' | 'anthropic' | 'gemini' | 'cohere' | 'ollama';
+  model: string;
+  outputType?: 'string' | 'json' | 'number' | 'boolean';
+  stream?: boolean;
+  temperature?: number;
+  maxTokens?: number;
+  cache?: CacheOptions;
+  retry?: RetryOptions;
+})
+```
+
+## Examples
+
+See the [examples](../../example/src/ai) directory for complete working examples.
+
+## Testing
+
+```bash
+npm test
+```
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](../../CONTRIBUTING.md) for details.
+
+## License
+
+Apache 2.0 © [HazelJS](https://hazeljs.com)
+
+## Links
+
+- [Documentation](https://hazeljs.com/docs/packages/ai)
+- [GitHub](https://github.com/hazel-js/hazeljs)
+- [Issues](https://github.com/hazel-js/hazeljs/issues)
+- [Discord](https://discord.com/channels/1448263814238965833/1448263814859456575)