@ysk-kit/llm 1.0.0

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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 YSK Limited
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,39 @@
1
+ import type { LlmMessage, LlmUsage } from '@ysk-kit/contracts';
2
+ export type LlmInput = {
3
+ messages: LlmMessage[];
4
+ temperature?: number | undefined;
5
+ model?: string | undefined;
6
+ };
7
+ export type LlmResult = {
8
+ text: string;
9
+ model: string;
10
+ usage: LlmUsage;
11
+ };
12
+ export type LlmStreamChunk = {
13
+ delta: string;
14
+ done: boolean;
15
+ usage?: LlmUsage;
16
+ };
17
+ export interface ILlmPort {
18
+ model: string;
19
+ complete(input: LlmInput): Promise<LlmResult>;
20
+ stream(input: LlmInput): AsyncIterable<LlmStreamChunk>;
21
+ }
22
+ export declare const createFakeLlm: (opts?: {
23
+ text?: string;
24
+ model?: string;
25
+ }) => ILlmPort;
26
+ export declare const createOpenAiCompatibleLlm: (opts: {
27
+ baseUrl: string;
28
+ apiKey: string;
29
+ model: string;
30
+ fetchImpl?: typeof fetch;
31
+ }) => ILlmPort;
32
+ export declare const createLlmFromEnv: (env: {
33
+ NODE_ENV: string;
34
+ LLM_BASE_URL?: string | undefined;
35
+ LLM_API_KEY?: string | undefined;
36
+ XAI_API_KEY?: string | undefined;
37
+ LLM_MODEL?: string | undefined;
38
+ }) => ILlmPort;
39
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE/D,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,QAAQ,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB,CAAC;AAEF,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAC9C,MAAM,CAAC,KAAK,EAAE,QAAQ,GAAG,aAAa,CAAC,cAAc,CAAC,CAAC;CACxD;AAED,eAAO,MAAM,aAAa,GAAI,OAAO;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,KAAG,QAoBxE,CAAC;AAaF,eAAO,MAAM,yBAAyB,GAAI,MAAM;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,OAAO,KAAK,CAAC;CAC1B,KAAG,QAqFH,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAAI,KAAK;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC,KAAG,QAYH,CAAC"}
package/dist/index.js ADDED
@@ -0,0 +1,128 @@
1
+ export const createFakeLlm = (opts) => {
2
+ const text = opts?.text ?? 'pong';
3
+ const model = opts?.model ?? 'fake';
4
+ const usage = {
5
+ promptTokens: 1,
6
+ completionTokens: text.length,
7
+ totalTokens: 1 + text.length,
8
+ };
9
+ return {
10
+ model,
11
+ async complete() {
12
+ return { text, model, usage };
13
+ },
14
+ async *stream() {
15
+ const mid = Math.max(1, Math.floor(text.length / 2));
16
+ yield { delta: text.slice(0, mid), done: false };
17
+ yield { delta: text.slice(mid), done: false };
18
+ yield { delta: '', done: true, usage };
19
+ },
20
+ };
21
+ };
22
+ const toUsage = (raw) => {
23
+ const u = raw;
24
+ const promptTokens = u?.prompt_tokens ?? 0;
25
+ const completionTokens = u?.completion_tokens ?? 0;
26
+ return {
27
+ promptTokens,
28
+ completionTokens,
29
+ totalTokens: u?.total_tokens ?? promptTokens + completionTokens,
30
+ };
31
+ };
32
+ export const createOpenAiCompatibleLlm = (opts) => {
33
+ const fetchImpl = opts.fetchImpl ?? fetch;
34
+ const root = opts.baseUrl.replace(/\/$/, '');
35
+ return {
36
+ model: opts.model,
37
+ async complete(input) {
38
+ const res = await fetchImpl(`${root}/chat/completions`, {
39
+ method: 'POST',
40
+ headers: {
41
+ 'content-type': 'application/json',
42
+ authorization: `Bearer ${opts.apiKey}`,
43
+ },
44
+ body: JSON.stringify({
45
+ model: input.model ?? opts.model,
46
+ messages: input.messages,
47
+ temperature: input.temperature,
48
+ }),
49
+ signal: AbortSignal.timeout(60_000),
50
+ });
51
+ if (!res.ok) {
52
+ throw new Error(`LLM HTTP ${res.status}`);
53
+ }
54
+ const json = (await res.json());
55
+ return {
56
+ text: json.choices?.[0]?.message?.content ?? '',
57
+ model: json.model ?? opts.model,
58
+ usage: toUsage(json.usage),
59
+ };
60
+ },
61
+ async *stream(input) {
62
+ const res = await fetchImpl(`${root}/chat/completions`, {
63
+ method: 'POST',
64
+ headers: {
65
+ 'content-type': 'application/json',
66
+ authorization: `Bearer ${opts.apiKey}`,
67
+ },
68
+ body: JSON.stringify({
69
+ model: input.model ?? opts.model,
70
+ messages: input.messages,
71
+ temperature: input.temperature,
72
+ stream: true,
73
+ stream_options: { include_usage: true },
74
+ }),
75
+ });
76
+ if (!res.ok || !res.body) {
77
+ throw new Error(`LLM HTTP ${res.status}`);
78
+ }
79
+ const reader = res.body.getReader();
80
+ const decoder = new TextDecoder();
81
+ let buffer = '';
82
+ let usage;
83
+ while (true) {
84
+ const { value, done } = await reader.read();
85
+ if (done)
86
+ break;
87
+ buffer += decoder.decode(value, { stream: true });
88
+ const lines = buffer.split('\n');
89
+ buffer = lines.pop() ?? '';
90
+ for (const line of lines) {
91
+ const trimmed = line.trim();
92
+ if (!trimmed.startsWith('data:'))
93
+ continue;
94
+ const data = trimmed.slice(5).trim();
95
+ if (data === '[DONE]') {
96
+ yield { delta: '', done: true, ...(usage ? { usage } : {}) };
97
+ return;
98
+ }
99
+ try {
100
+ const json = JSON.parse(data);
101
+ if (json.usage)
102
+ usage = toUsage(json.usage);
103
+ const delta = json.choices?.[0]?.delta?.content ?? '';
104
+ if (delta)
105
+ yield { delta, done: false };
106
+ }
107
+ catch {
108
+ /* ignore partial JSON */
109
+ }
110
+ }
111
+ }
112
+ yield { delta: '', done: true, ...(usage ? { usage } : {}) };
113
+ },
114
+ };
115
+ };
116
+ export const createLlmFromEnv = (env) => {
117
+ const apiKey = env.LLM_API_KEY || env.XAI_API_KEY;
118
+ const model = env.LLM_MODEL && env.LLM_MODEL.length > 0 ? env.LLM_MODEL : 'grok-4.7';
119
+ if (apiKey) {
120
+ return createOpenAiCompatibleLlm({
121
+ baseUrl: env.LLM_BASE_URL && env.LLM_BASE_URL.length > 0 ? env.LLM_BASE_URL : 'https://api.x.ai/v1',
122
+ apiKey,
123
+ model,
124
+ });
125
+ }
126
+ return createFakeLlm({ model });
127
+ };
128
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AA0BA,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAwC,EAAY,EAAE;IAClF,MAAM,IAAI,GAAG,IAAI,EAAE,IAAI,IAAI,MAAM,CAAC;IAClC,MAAM,KAAK,GAAG,IAAI,EAAE,KAAK,IAAI,MAAM,CAAC;IACpC,MAAM,KAAK,GAAa;QACtB,YAAY,EAAE,CAAC;QACf,gBAAgB,EAAE,IAAI,CAAC,MAAM;QAC7B,WAAW,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM;KAC7B,CAAC;IACF,OAAO;QACL,KAAK;QACL,KAAK,CAAC,QAAQ;YACZ,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;QAChC,CAAC;QACD,KAAK,CAAC,CAAC,MAAM;YACX,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;YACrD,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YACjD,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YAC9C,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QACzC,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,GAAY,EAAY,EAAE;IACzC,MAAM,CAAC,GAAG,GAAoF,CAAC;IAC/F,MAAM,YAAY,GAAG,CAAC,EAAE,aAAa,IAAI,CAAC,CAAC;IAC3C,MAAM,gBAAgB,GAAG,CAAC,EAAE,iBAAiB,IAAI,CAAC,CAAC;IACnD,OAAO;QACL,YAAY;QACZ,gBAAgB;QAChB,WAAW,EAAE,CAAC,EAAE,YAAY,IAAI,YAAY,GAAG,gBAAgB;KAChE,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,IAKzC,EAAY,EAAE;IACb,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;IAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC7C,OAAO;QACL,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,KAAK,CAAC,QAAQ,CAAC,KAAK;YAClB,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,GAAG,IAAI,mBAAmB,EAAE;gBACtD,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;oBAClC,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE;iBACvC;gBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK;oBAChC,QAAQ,EAAE,KAAK,CAAC,QAAQ;oBACxB,WAAW,EAAE,KAAK,CAAC,WAAW;iBAC/B,CAAC;gBACF,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;aACpC,CAAC,CAAC;YACH,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,YAAY,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YAC5C,CAAC;YACD,MAAM,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAI7B,CAAC;YACF,OAAO;gBACL,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,IAAI,EAAE;gBAC/C,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK;gBAC/B,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;aAC3B,CAAC;QACJ,CAAC;QACD,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK;YACjB,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,GAAG,IAAI,mBAAmB,EAAE;gBACtD,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;oBAClC,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE;iBACvC;gBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK;oBAChC,QAAQ,EAAE,KAAK,CAAC,QAAQ;oBACxB,WAAW,EAAE,KAAK,CAAC,WAAW;oBAC9B,MAAM,EAAE,IAAI;oBACZ,cAAc,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE;iBACxC,CAAC;aACH,CAAC,CAAC;YACH,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CAAC,YAAY,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YAC5C,CAAC;YACD,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpC,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;YAClC,IAAI,MAAM,GAAG,EAAE,CAAC;YAChB,IAAI,KAA2B,CAAC;YAChC,OAAO,IAAI,EAAE,CAAC;gBACZ,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC5C,IAAI,IAAI;oBAAE,MAAM;gBAChB,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;gBAClD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACjC,MAAM,GAAG,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;gBAC3B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACzB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;oBAC5B,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC;wBAAE,SAAS;oBAC3C,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;oBACrC,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;wBACtB,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;wBAC7D,OAAO;oBACT,CAAC;oBACD,IAAI,CAAC;wBACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAG3B,CAAC;wBACF,IAAI,IAAI,CAAC,KAAK;4BAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;wBAC5C,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,IAAI,EAAE,CAAC;wBACtD,IAAI,KAAK;4BAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;oBAC1C,CAAC;oBAAC,MAAM,CAAC;wBACP,yBAAyB;oBAC3B,CAAC;gBACH,CAAC;YACH,CAAC;YACD,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;QAC/D,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,GAMhC,EAAY,EAAE;IACb,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,WAAW,CAAC;IAClD,MAAM,KAAK,GAAG,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC;IACrF,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,yBAAyB,CAAC;YAC/B,OAAO,EACL,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,qBAAqB;YAC5F,MAAM;YACN,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IACD,OAAO,aAAa,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;AAClC,CAAC,CAAC"}
package/package.json ADDED
@@ -0,0 +1,33 @@
1
+ {
2
+ "name": "@ysk-kit/llm",
3
+ "version": "1.0.0",
4
+ "type": "module",
5
+ "main": "./dist/index.js",
6
+ "types": "./dist/index.d.ts",
7
+ "exports": {
8
+ ".": {
9
+ "types": "./dist/index.d.ts",
10
+ "import": "./dist/index.js"
11
+ }
12
+ },
13
+ "dependencies": {
14
+ "@ysk-kit/contracts": "1.0.0"
15
+ },
16
+ "devDependencies": {
17
+ "@types/node": "^24.5.2",
18
+ "typescript": "^6.0.3",
19
+ "vitest": "^5.0.2"
20
+ },
21
+ "files": [
22
+ "dist"
23
+ ],
24
+ "publishConfig": {
25
+ "registry": "https://registry.npmjs.org",
26
+ "access": "public"
27
+ },
28
+ "scripts": {
29
+ "typecheck": "tsc --noEmit -p tsconfig.json",
30
+ "test": "vitest run --passWithNoTests",
31
+ "build": "tsc -p tsconfig.build.json"
32
+ }
33
+ }