0.2.0

- Supported chat with image
- Added bun script

Author: 0x5123

CHANGELOG.md

@@ -5,10 +5,35 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.0] - 2025-12-XX
+
+### Added
+- 🖼️ **Image Generation Support** - Added `image_config` option for models that support image generation
+  - `image_config.aspect_ratio` - Configure aspect ratio for generated images (e.g., "16:9", "1:1", "9:16")
+  - Works with both streaming and non-streaming requests
+  - Full TypeScript type safety with `ImageConfigOptions` interface
+- Comprehensive test coverage for image config functionality
+
+### Changed
+- `ChatCompletionStreamingRequest` and `ChatCompletionNonStreamingRequest` now support `image_config` option
+- Updated API documentation with image generation examples
+
+## [0.1.1] - 2025-12-XX
+
+### Added
+- 🚀 **Bun Support** - Full support for Bun runtime (v1.0.0+)
+- Updated examples to use Bun instead of tsx
+- Updated build scripts to use Bun commands
+
+### Changed
+- Development scripts now use Bun by default (npm still supported)
+- Examples updated to work with Bun's native TypeScript support
+- Documentation updated to mention Bun as recommended runtime
+
 ## [0.1.0] - 2025-12-02
 
 ### Added
-- 🎉 Initial release of @eternalai-org/typescript-sdk
+- 🎉 Initial release of @eternalai-org/sdk
 - `EternalAPI` client class for chat completions
 - `chat.send()` method with streaming and non-streaming support
 - OpenAI-compatible API interface
@@ -22,7 +47,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - **Streaming Support** - Real-time streaming responses using async iterators
 - **OpenAI Compatible** - Drop-in replacement for OpenAI API
 - **TypeScript First** - Strict typing with full IntelliSense support
-- **Multi-Environment** - Works in Node.js (v18+) and browser
+- **Multi-Environment** - Works in Bun (v1.0.0+), Node.js (v18+), and browser
 - **Error Handling** - Descriptive error messages for debugging
 - **Server-Sent Events** - Efficient SSE streaming parser
 - **Configurable Timeout** - AbortController support for request timeouts
@@ -35,4 +60,6 @@ Access multiple AI providers through EternalAI's unified API:
 - Google Gemini
 - And more via [eternalai.org](https://eternalai.org/api/build)
 
+[0.2.0]: https://github.com/eternalai-org/sdk/releases/tag/v0.2.0
+[0.1.1]: https://github.com/eternalai-org/sdk/releases/tag/v0.1.1
 [0.1.0]: https://github.com/eternalai-org/sdk/releases/tag/v0.1.0

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to @eternalai-org/typescript-sdk
+# Contributing to @eternalai-org/sdk
 
 Thank you for your interest in contributing! This document provides guidelines for development.
 
@@ -12,7 +12,10 @@ Thank you for your interest in contributing! This document provides guidelines f
 
 2. **Install dependencies**
    ```bash
-   # Using yarn (recommended - project uses yarn.lock)
+   # Using Bun (recommended - fastest)
+   bun install
+   
+   # Using yarn
    yarn install
 
    # Or using npm
@@ -21,16 +24,37 @@ Thank you for your interest in contributing! This document provides guidelines f
 
 3. **Run tests**
    ```bash
+   # Using Bun (recommended)
+   bun test
+   
+   # Using npm
    npm test
    ```
 
 4. **Build the SDK**
    ```bash
+   # Using Bun (recommended)
+   bun run build
+   
+   # Using npm
    npm run build
    ```
 
 ## Development Commands
 
+Using Bun (recommended):
+- `bun run dev` - Build in watch mode
+- `bun test` - Run tests
+- `bun run test:watch` - Run tests in watch mode
+- `bun run test:coverage` - Generate test coverage report
+- `bun run type-check` - Run TypeScript type checking
+- `bun run lint` - Lint code with ESLint
+- `bun run lint:fix` - Auto-fix linting issues
+- `bun run format` - Format code with Prettier
+- `bun run format:check` - Check code formatting
+- `bun run build` - Build production bundle
+
+Using npm (alternative):
 - `npm run dev` - Build in watch mode
 - `npm test` - Run tests
 - `npm run test:watch` - Run tests in watch mode
@@ -71,6 +95,11 @@ tests/                 # Test files
 Run linting and formatting before committing:
 
 ```bash
+# Using Bun (recommended)
+bun run lint:fix
+bun run format
+
+# Using npm
 npm run lint:fix
 npm run format
 ```
@@ -123,7 +152,14 @@ Please maintain 100% coverage for all new code. View the test suite documentatio
 1. Fork the repository
 2. Create a feature branch (`git checkout -b feature/amazing-feature`)
 3. Make your changes
-4. Run tests and linting (`npm test && npm run lint`)
+4. Run tests and linting:
+   ```bash
+   # Using Bun (recommended)
+   bun test && bun run lint
+   
+   # Using npm
+   npm test && npm run lint
+   ```
 5. Commit your changes with a descriptive message
 6. Push to your fork (`git push origin feature/amazing-feature`)
 7. Open a Pull Request

README.md

@@ -1,15 +1,17 @@
-# @eternalai-org/typescript-sdk
+# @eternalai-org/sdk
 
 Official TypeScript SDK for **EternalAI** - The next-generation API platform for AI applications. Access hundreds of AI models through one unified interface with cashback rewards on every API call.
 
-[![npm version](https://img.shields.io/npm/v/@eternalai-org/typescript-sdk.svg)](https://www.npmjs.com/package/@eternalai-org/typescript-sdk)
+[![npm version](https://img.shields.io/npm/v/@eternalai-org/sdk.svg)](https://www.npmjs.com/package/@eternalai-org/sdk)
+[![Bun](https://img.shields.io/badge/Bun-1.0+-black?logo=bun)](https://bun.sh)
+[![Yarn](https://img.shields.io/badge/Yarn-1.22+-2C8EBB?logo=yarn&logoColor=white)](https://yarnpkg.com)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.3-blue.svg)](https://www.typescriptlang.org/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
 
 ## Quick Start
 
 ```typescript
-import { EternalAPI } from '@eternalai-org/typescript-sdk';
+import { EternalAPI } from '@eternalai-org/sdk';
 
 const eternalApi = new EternalAPI({ apiKey: 'your-api-key' });
 
@@ -29,24 +31,53 @@ for await (const chunk of result) {
 }
 ```
 
+### Image Generation Example
+
+For models that support image generation, you can configure image options:
+
+```typescript
+const result = await eternalApi.chat.send({
+  messages: [
+    {
+      role: 'user',
+      content: 'Generate a beautiful landscape',
+    },
+  ],
+  model: 'image-generation-model',
+  image_config: {
+    aspect_ratio: '16:9', // Optional: '16:9', '1:1', '9:16', etc.
+  },
+  stream: false,
+});
+
+console.log(result.choices[0].message.content);
+```
+
 ## Installation
 
 Install from npm:
 
 ```bash
+# Using Bun (recommended)
+bun add @eternalai-org/sdk
+
 # Using npm
-npm install @eternalai-org/typescript-sdk
+npm install @eternalai-org/sdk
 
 # Using yarn
-yarn add @eternalai-org/typescript-sdk
+yarn add @eternalai-org/sdk
 
 # Using pnpm
-pnpm add @eternalai-org/typescript-sdk
+pnpm add @eternalai-org/sdk
 ```
 
 Or install directly from GitHub:
 
 ```bash
+# Using Bun
+bun add git+https://github.com/eternalai-org/sdk.git
+
+# Using npm
 npm install git+https://github.com/eternalai-org/sdk.git
 ```
 
@@ -123,6 +154,8 @@ Send a chat completion request.
 - `request.messages` (ChatMessage[], required) - Array of chat messages
 - `request.model` (string, required) - Model name (e.g., `"openai/gpt-5.1"`)
 - `request.stream` (boolean, optional) - Enable streaming responses (default: `false`)
+- `request.image_config` (ImageConfigOptions, optional) - Image generation configuration for models that support image generation
+  - `image_config.aspect_ratio` (string, optional) - Aspect ratio for generated images (e.g., `"16:9"`, `"1:1"`, `"9:16"`)
 
 **Returns:**
 
@@ -148,7 +181,7 @@ import type {
   ChatCompletionMessage,
   ChatCompletionNonStreamingChoice,
   ChatCompletionResponse,
-} from '@eternalai-org/typescript-sdk';
+} from '@eternalai-org/sdk';
 ```
 
 ## Error Handling
@@ -166,10 +199,11 @@ try {
 }
 ```
 
-## Browser vs Node.js
+## Browser vs Node.js vs Bun
 
-This SDK works in both Node.js and browser environments:
+This SDK works in multiple environments:
 
+- **Bun** - Full support (v1.0.0+) - Recommended for best performance
 - **Node.js** - Full support (v18+)
 - **Browser** - Requires a bundler (Webpack, Vite, etc.) that supports ESM
 
@@ -178,13 +212,14 @@ This SDK works in both Node.js and browser environments:
 This SDK includes a comprehensive test suite. To run the tests:
 
 ```bash
-# Run all tests
-npm test
+# Using Bun (recommended)
+bun test
+bun run test:watch
+bun run test:coverage
 
-# Run tests in watch mode
+# Using npm
+npm test
 npm run test:watch
-
-# Generate coverage report
 npm run test:coverage
 ```
 
@@ -208,7 +243,7 @@ MIT - see [LICENSE](./LICENSE) file for details.
 ## Support
 
 For issues and questions:
-- 📦 **npm Package**: [npmjs.com/package/@eternalai-org/typescript-sdk](https://www.npmjs.com/package/@eternalai-org/typescript-sdk)
+- 📦 **npm Package**: [npmjs.com/package/@eternalai-org/sdk](https://www.npmjs.com/package/@eternalai-org/sdk)
 - 🌐 **Website**: [eternalai.org](https://eternalai.org)
 - 📖 **API Platform**: [eternalai.org/api/build](https://eternalai.org/api/build)
 - 🐛 **GitHub Issues**: [github.com/eternalai-org/sdk/issues](https://github.com/eternalai-org/sdk/issues)