@stratix/ai-openai 0.8.0 → 0.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +15 -37
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -3,18 +3,25 @@
3
3
 
4
4
  # @stratix/ai-openai
5
5
 
6
- **🔧 Provider** | OpenAI LLM provider for Stratix AI agents
6
+ **OpenAI LLM provider for Stratix AI agents**
7
7
 
8
- [![npm version](https://img.shields.io/npm/v/@stratix/ai-openai.svg)](https://www.npmjs.com/package/@stratix/ai-openai)
8
+ [![npm version](https://img.shields.io/npm/v/@stratix/cli.svg)](https://www.npmjs.com/package/@stratix/cli)
9
9
  [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
10
10
 
11
- [Documentation](https://stratix-dev.github.io/stratix/) | [Getting Started](https://stratix-dev.github.io/stratix/docs/getting-started/quick-start)
11
+ [Documentation](https://stratix-dev.github.io/docs/)
12
12
 
13
13
  </div>
14
14
 
15
- > Part of **[Stratix Framework](https://stratix-dev.github.io/stratix/)** - A TypeScript framework for building scalable applications with Domain-Driven Design, Hexagonal Architecture, and CQRS patterns.
15
+ > Part of **[Stratix Framework](https://stratix-dev.github.io/docs/)** - A TypeScript framework for building scalable applications with Domain-Driven Design, Hexagonal Architecture, and CQRS patterns.
16
16
  >
17
- > **New to Stratix?** Start with the [Getting Started Guide](https://stratix-dev.github.io/stratix/docs/getting-started/quick-start)
17
+
18
+ ## ⚠️ Pre-Release Warning
19
+
20
+ **This is a pre-release version of @stratix/ai-openai.**
21
+
22
+ This package is under active development and should be considered unstable. The API may change significantly between versions without prior notice. Features may be added, modified, or removed entirely. This package may also be deprecated or discontinued in future releases.
23
+
24
+ **Stable versions will be available starting from version 1.0.0.** Not recommended for production use. Use at your own risk.
18
25
 
19
26
  ## About This Package
20
27
 
@@ -27,48 +34,19 @@ OpenAI LLM provider for Stratix AI agents
27
34
  Stratix is an AI-first TypeScript framework combining Domain-Driven Design, Hexagonal Architecture, and CQRS. It provides production-ready patterns for building scalable, maintainable applications with AI agents as first-class citizens.
28
35
 
29
36
  **Key Resources:**
30
- - [Documentation](https://stratix-dev.github.io/stratix/)
31
- - [Quick Start](https://stratix-dev.github.io/stratix/docs/getting-started/quick-start)
37
+ - [Documentation](https://stratix-dev.github.io/docs/)
32
38
  - [Report Issues](https://github.com/stratix-dev/stratix/issues)
33
39
 
34
40
  ## Installation
35
41
 
36
42
  **Prerequisites:**
37
43
  - Node.js 18.0.0 or higher
38
- - `@stratix/core` and `@stratix/runtime` installed
39
- - Basic understanding of [Stratix architecture](https://stratix-dev.github.io/stratix/docs/core-concepts/architecture-overview)
40
44
 
41
- **Recommended:** Use the Stratix CLI
42
- ```bash
43
- stratix add openai
44
- ```
45
-
46
- **Manual installation:**
45
+ **Installation:**
47
46
  ```bash
48
47
  npm install @stratix/ai-openai
49
48
  ```
50
49
 
51
- ## Related Packages
52
-
53
- **Essential:**
54
- - [`@stratix/core`](https://www.npmjs.com/package/@stratix/core) - Core primitives and abstractions
55
- - [`@stratix/runtime`](https://www.npmjs.com/package/@stratix/runtime) - Application runtime and plugin system
56
- - [`@stratix/cli`](https://www.npmjs.com/package/@stratix/cli) - Code generation and scaffolding
57
-
58
- [View all plugins](https://stratix-dev.github.io/stratix/docs/plugins/official-plugins)
59
-
60
- ## Documentation
61
-
62
- - [Getting Started](https://stratix-dev.github.io/stratix/docs/getting-started/quick-start)
63
- - [Core Concepts](https://stratix-dev.github.io/stratix/docs/core-concepts/architecture-overview)
64
- - [Plugin Architecture](https://stratix-dev.github.io/stratix/docs/plugins/plugin-architecture)
65
- - [Complete Documentation](https://stratix-dev.github.io/stratix/)
66
-
67
- ## Support
68
-
69
- - [GitHub Issues](https://github.com/stratix-dev/stratix/issues) - Report bugs and request features
70
- - [Documentation](https://stratix-dev.github.io/stratix/) - Comprehensive guides and tutorials
71
-
72
50
  ## License
73
51
 
74
52
  MIT - See [LICENSE](https://github.com/stratix-dev/stratix/blob/main/LICENSE) for details.
@@ -77,4 +55,4 @@ MIT - See [LICENSE](https://github.com/stratix-dev/stratix/blob/main/LICENSE) fo
77
55
 
78
56
  **[Stratix Framework](https://stratix-dev.github.io/stratix/)** - Build better software with proven patterns
79
57
 
80
- </div>
58
+ </div>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stratix/ai-openai",
3
- "version": "0.8.0",
3
+ "version": "0.8.1",
4
4
  "description": "Stratix AI Agents - OpenAI Provider",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -40,7 +40,7 @@
40
40
  },
41
41
  "dependencies": {
42
42
  "openai": "^4.75.0",
43
- "@stratix/core": "^0.8.0"
43
+ "@stratix/core": "^0.8.1"
44
44
  },
45
45
  "devDependencies": {
46
46
  "@types/node": "^20.0.0",