@aphexcms/ai-openai 0.1.1 → 0.1.2
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.
- package/README.md +55 -0
- package/dist/index.d.ts +8 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +5 -6
package/README.md
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# @aphexcms/ai-openai
|
|
2
|
+
|
|
3
|
+
OpenAI-compatible model backend for the in-admin agent in [AphexCMS](https://github.com/IcelandicIcecream/aphex).
|
|
4
|
+
|
|
5
|
+
Implements the `AIProviderAdapter` port from `@aphexcms/cms-core`. Points at anything speaking the OpenAI chat-completions API — OpenAI itself, OpenRouter, or a local router like Ollama's compatibility endpoint.
|
|
6
|
+
|
|
7
|
+
The agent is **off unless a provider is configured**: with no `aiProvider`, the route 404s rather than existing unauthenticated.
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
pnpm add @aphexcms/ai-openai
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Quick start
|
|
16
|
+
|
|
17
|
+
```ts title="aphex.config.ts"
|
|
18
|
+
import { createOpenAIAdapter } from '@aphexcms/ai-openai';
|
|
19
|
+
|
|
20
|
+
export default createCMSConfig({
|
|
21
|
+
schemaTypes,
|
|
22
|
+
database: db,
|
|
23
|
+
aiProvider: createOpenAIAdapter({ apiKey: env.OPENAI_API_KEY }),
|
|
24
|
+
agentModel: 'gpt-5.4-mini'
|
|
25
|
+
});
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
`agentModel` is required whenever `aiProvider` is set — there is no default model, because the right one depends on which endpoint you pointed at.
|
|
29
|
+
|
|
30
|
+
### OpenRouter
|
|
31
|
+
|
|
32
|
+
```ts
|
|
33
|
+
import { createOpenRouterAdapter } from '@aphexcms/ai-openai';
|
|
34
|
+
|
|
35
|
+
aiProvider: createOpenRouterAdapter({ apiKey: env.OPENROUTER_API_KEY });
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### A local endpoint
|
|
39
|
+
|
|
40
|
+
Any OpenAI-compatible base URL works. `apiKey` can be a placeholder for a local router that doesn't check it:
|
|
41
|
+
|
|
42
|
+
```ts
|
|
43
|
+
createOpenAIAdapter({
|
|
44
|
+
baseURL: 'http://127.0.0.1:10531/v1',
|
|
45
|
+
apiKey: 'local'
|
|
46
|
+
});
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Customising the prompt
|
|
50
|
+
|
|
51
|
+
`agentSystemPrompt` in `createCMSConfig()` replaces the built-in system prompt outright. The default one already describes the schema system and the tools available, so replace it only when you want different behaviour, not to append to it.
|
|
52
|
+
|
|
53
|
+
## License
|
|
54
|
+
|
|
55
|
+
MIT
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,14 @@
|
|
|
1
1
|
import type { AIProviderAdapter, AIChatRequest, AIStreamEvent } from '@aphexcms/cms-core/server';
|
|
2
2
|
export interface OpenAIAdapterConfig {
|
|
3
3
|
apiKey: string;
|
|
4
|
-
/**
|
|
4
|
+
/**
|
|
5
|
+
* Override for OpenAI-compatible endpoints other than api.openai.com — a local
|
|
6
|
+
* router, Ollama's compat layer, etc. (see `createOpenRouterAdapter` below).
|
|
7
|
+
*
|
|
8
|
+
* Omit it and the OpenAI SDK applies its own default of `https://api.openai.com/v1`,
|
|
9
|
+
* which also leaves the standard `OPENAI_BASE_URL` env var working. Don't hardcode
|
|
10
|
+
* the default here — that would override it.
|
|
11
|
+
*/
|
|
5
12
|
baseURL?: string;
|
|
6
13
|
defaultHeaders?: Record<string, string>;
|
|
7
14
|
}
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACX,iBAAiB,EACjB,aAAa,EACb,aAAa,EAIb,MAAM,2BAA2B,CAAC;AAEnC,MAAM,WAAW,mBAAmB;IACnC,MAAM,EAAE,MAAM,CAAC;IACf
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACX,iBAAiB,EACjB,aAAa,EACb,aAAa,EAIb,MAAM,2BAA2B,CAAC;AAEnC,MAAM,WAAW,mBAAmB;IACnC,MAAM,EAAE,MAAM,CAAC;IACf;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACxC;AA2DD,qBAAa,qBAAsB,YAAW,iBAAiB;IAC9D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,MAAM,CAAS;gBAEX,MAAM,EAAE,mBAAmB,EAAE,IAAI,SAAW;IASjD,UAAU,CAAC,OAAO,EAAE,aAAa,GAAG,aAAa,CAAC,aAAa,CAAC;CAoEvE;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,mBAAmB,GAAG,iBAAiB,CAElF;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,yFAAyF;IACzF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sFAAsF;IACtF,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB,GAAG,iBAAiB,CAYpB;AAED,YAAY,EACX,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,SAAS,EACT,UAAU,EACV,UAAU,EACV,MAAM,2BAA2B,CAAC"}
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAwB5B,SAAS,gBAAgB,CAAC,QAAqB;IAC9C,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACzB,IAAI,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YACvB,OAAO;gBACN,IAAI,EAAE,MAAM;gBACZ,YAAY,EAAE,CAAC,CAAC,UAAU,IAAI,EAAE;gBAChC,OAAO,EAAE,CAAC,CAAC,OAAO;aAClB,CAAC;QACH,CAAC;QACD,IAAI,CAAC,CAAC,IAAI,KAAK,WAAW,IAAI,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC;YACnD,OAAO;gBACN,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,CAAC,CAAC,OAAO,IAAI,IAAI;gBAC1B,UAAU,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;oBACpC,EAAE,EAAE,EAAE,CAAC,EAAE;oBACT,IAAI,EAAE,UAAmB;oBACzB,QAAQ,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE;iBACpE,CAAC,CAAC;aACH,CAAC;QACH,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,IAAuC,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;IAChF,CAAC,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,IAAgB;IACrC,OAAO;QACN,IAAI,EAAE,UAAU;QAChB,QAAQ,EAAE;YACT,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,UAAU,EAAE,IAAI,CAAC,UAAU;SAC3B;KACD,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CACvB,MAAiC;IAEjC,QAAQ,MAAM,EAAE,CAAC;QAChB,KAAK,YAAY;YAChB,OAAO,YAAY,CAAC;QACrB,KAAK,QAAQ;YACZ,OAAO,QAAQ,CAAC;QACjB;YACC,OAAO,MAAM,CAAC;IAChB,CAAC;AACF,CAAC;AAWD,MAAM,OAAO,qBAAqB;IACxB,IAAI,CAAS;IACd,MAAM,CAAS;IAEvB,YAAY,MAA2B,EAAE,IAAI,GAAG,QAAQ;QACvD,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC;YACxB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,cAAc,EAAE,MAAM,CAAC,cAAc;SACrC,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,CAAC,UAAU,CAAC,OAAsB;QACvC,MAAM,OAAO,GAAG,IAAI,GAAG,EAA0B,CAAC;QAClD,IAAI,YAAY,GAA+C,MAAM,CAAC;QAEtE,IAAI,CAAC;YACJ,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CACvD;gBACC,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,QAAQ,EAAE,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC;gBAC5C,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5E,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC/D,MAAM,EAAE,IAAI;gBACZ,cAAc,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE;aACvC,EACD,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAC1B,CAAC;YAEF,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAClC,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;gBAClC,MAAM,KAAK,GAAG,MAAM,EAAE,KAAK,CAAC;gBAE5B,IAAI,KAAK,EAAE,OAAO,EAAE,CAAC;oBACpB,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;gBAC9C,CAAC;gBAED,IAAI,KAAK,EAAE,UAAU,EAAE,CAAC;oBACvB,KAAK,MAAM,EAAE,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;wBACnC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;wBACzE,IAAI,EAAE,CAAC,EAAE;4BAAE,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;wBAC/B,IAAI,EAAE,CAAC,QAAQ,EAAE,IAAI;4BAAE,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;wBACzD,IAAI,EAAE,CAAC,QAAQ,EAAE,SAAS;4BAAE,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC;wBACnE,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;oBACjC,CAAC;gBACF,CAAC;gBAED,IAAI,MAAM,EAAE,aAAa,EAAE,CAAC;oBAC3B,YAAY,GAAG,eAAe,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;gBACtD,CAAC;gBAED,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;oBACjB,MAAM;wBACL,IAAI,EAAE,OAAO;wBACb,YAAY,EAAE,KAAK,CAAC,KAAK,CAAC,aAAa;wBACvC,gBAAgB,EAAE,KAAK,CAAC,KAAK,CAAC,iBAAiB;qBAC/C,CAAC;gBACH,CAAC;YACF,CAAC;YAED,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;gBACpC,gFAAgF;gBAChF,0EAA0E;gBAC1E,wEAAwE;gBACxE,IAAI,IAAI,GAA4B,EAAE,CAAC;gBACvC,IAAI,CAAC;oBACJ,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7C,CAAC;gBAAC,MAAM,CAAC;oBACR,cAAc;gBACf,CAAC;gBACD,MAAM,QAAQ,GAAe,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;gBAC7E,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;YACtC,CAAC;YAED,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC;QACtC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACnF,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC;QAC/C,CAAC;IACF,CAAC;CACD;AAED,MAAM,UAAU,mBAAmB,CAAC,MAA2B;IAC9D,OAAO,IAAI,qBAAqB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACpD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,MAMvC;IACA,OAAO,IAAI,qBAAqB,CAC/B;QACC,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,OAAO,EAAE,8BAA8B;QACvC,cAAc,EAAE;YACf,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7D,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC1D;KACD,EACD,YAAY,CACZ,CAAC;AACH,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aphexcms/ai-openai",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public",
|
|
7
|
-
"provenance":
|
|
7
|
+
"provenance": true
|
|
8
8
|
},
|
|
9
9
|
"repository": {
|
|
10
10
|
"type": "git",
|
|
@@ -25,15 +25,14 @@
|
|
|
25
25
|
"dist"
|
|
26
26
|
],
|
|
27
27
|
"dependencies": {
|
|
28
|
-
"openai": "^6.48.0"
|
|
29
|
-
"@aphexcms/cms-core": "^9.7.0"
|
|
28
|
+
"openai": "^6.48.0"
|
|
30
29
|
},
|
|
31
30
|
"peerDependencies": {
|
|
32
|
-
"@aphexcms/cms-core": "
|
|
31
|
+
"@aphexcms/cms-core": ">=11.0.0"
|
|
33
32
|
},
|
|
34
33
|
"devDependencies": {
|
|
35
34
|
"typescript": "^5.9.3",
|
|
36
|
-
"@aphexcms/cms-core": "^
|
|
35
|
+
"@aphexcms/cms-core": "^11.0.0"
|
|
37
36
|
},
|
|
38
37
|
"scripts": {
|
|
39
38
|
"build": "tsc",
|