@nirmos/sdk 0.3.1 → 0.3.3

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 (91) hide show
  1. package/README.md +264 -16
  2. package/dist/cjs/client.js +1 -9
  3. package/dist/cjs/client.js.map +1 -1
  4. package/dist/cjs/core/transport.js +16 -3
  5. package/dist/cjs/core/transport.js.map +1 -1
  6. package/dist/cjs/core/version.js +6 -0
  7. package/dist/cjs/core/version.js.map +1 -0
  8. package/dist/cjs/gateway/chat-stream.js +10 -0
  9. package/dist/cjs/gateway/chat-stream.js.map +1 -1
  10. package/dist/cjs/gateway/chat.js +1 -0
  11. package/dist/cjs/gateway/chat.js.map +1 -1
  12. package/dist/cjs/gateway/embeddings.js +1 -0
  13. package/dist/cjs/gateway/embeddings.js.map +1 -1
  14. package/dist/cjs/gateway/mappers.js +39 -2
  15. package/dist/cjs/gateway/mappers.js.map +1 -1
  16. package/dist/cjs/index.js +8 -1
  17. package/dist/cjs/index.js.map +1 -1
  18. package/dist/cjs/management/manifest.js +16 -0
  19. package/dist/cjs/management/manifest.js.map +1 -1
  20. package/dist/cjs/management/resources.js +3 -1
  21. package/dist/cjs/management/resources.js.map +1 -1
  22. package/dist/cjs/prompts/render.js +12 -4
  23. package/dist/cjs/prompts/render.js.map +1 -1
  24. package/dist/cjs/prompts/variables.js +117 -0
  25. package/dist/cjs/prompts/variables.js.map +1 -0
  26. package/dist/esm/client.d.ts +6 -20
  27. package/dist/esm/client.d.ts.map +1 -1
  28. package/dist/esm/client.js +1 -9
  29. package/dist/esm/client.js.map +1 -1
  30. package/dist/esm/core/transport.js +15 -2
  31. package/dist/esm/core/transport.js.map +1 -1
  32. package/dist/esm/core/version.d.ts +2 -0
  33. package/dist/esm/core/version.d.ts.map +1 -0
  34. package/dist/esm/core/version.js +3 -0
  35. package/dist/esm/core/version.js.map +1 -0
  36. package/dist/esm/gateway/chat-stream.d.ts.map +1 -1
  37. package/dist/esm/gateway/chat-stream.js +11 -1
  38. package/dist/esm/gateway/chat-stream.js.map +1 -1
  39. package/dist/esm/gateway/chat.d.ts.map +1 -1
  40. package/dist/esm/gateway/chat.js +1 -0
  41. package/dist/esm/gateway/chat.js.map +1 -1
  42. package/dist/esm/gateway/embeddings.d.ts.map +1 -1
  43. package/dist/esm/gateway/embeddings.js +1 -0
  44. package/dist/esm/gateway/embeddings.js.map +1 -1
  45. package/dist/esm/gateway/mappers.d.ts +2 -0
  46. package/dist/esm/gateway/mappers.d.ts.map +1 -1
  47. package/dist/esm/gateway/mappers.js +38 -2
  48. package/dist/esm/gateway/mappers.js.map +1 -1
  49. package/dist/esm/gateway/types.d.ts +8 -0
  50. package/dist/esm/gateway/types.d.ts.map +1 -1
  51. package/dist/esm/index.d.ts +2 -1
  52. package/dist/esm/index.d.ts.map +1 -1
  53. package/dist/esm/index.js +1 -0
  54. package/dist/esm/index.js.map +1 -1
  55. package/dist/esm/management/contracts.d.ts +18194 -6741
  56. package/dist/esm/management/contracts.d.ts.map +1 -1
  57. package/dist/esm/management/manifest.d.ts +14 -0
  58. package/dist/esm/management/manifest.d.ts.map +1 -1
  59. package/dist/esm/management/manifest.js +16 -0
  60. package/dist/esm/management/manifest.js.map +1 -1
  61. package/dist/esm/management/resources.d.ts +2 -0
  62. package/dist/esm/management/resources.d.ts.map +1 -1
  63. package/dist/esm/management/resources.js +3 -1
  64. package/dist/esm/management/resources.js.map +1 -1
  65. package/dist/esm/memory/types.d.ts +14 -5
  66. package/dist/esm/memory/types.d.ts.map +1 -1
  67. package/dist/esm/prompts/render.js +11 -3
  68. package/dist/esm/prompts/render.js.map +1 -1
  69. package/dist/esm/prompts/variables.d.ts +29 -0
  70. package/dist/esm/prompts/variables.d.ts.map +1 -0
  71. package/dist/esm/prompts/variables.js +108 -0
  72. package/dist/esm/prompts/variables.js.map +1 -0
  73. package/examples/memory-quickstart.mjs +199 -0
  74. package/examples/memory-quickstart.ts +240 -0
  75. package/examples/tsconfig.json +5 -0
  76. package/package.json +5 -4
  77. package/src/client.ts +10 -30
  78. package/src/core/transport.ts +14 -2
  79. package/src/core/version.ts +2 -0
  80. package/src/gateway/chat-stream.ts +12 -1
  81. package/src/gateway/chat.ts +1 -0
  82. package/src/gateway/embeddings.ts +1 -0
  83. package/src/gateway/mappers.ts +55 -2
  84. package/src/gateway/types.ts +8 -0
  85. package/src/index.ts +13 -0
  86. package/src/management/contracts.ts +226 -131
  87. package/src/management/manifest.ts +16 -0
  88. package/src/management/resources.ts +3 -1
  89. package/src/memory/types.ts +15 -4
  90. package/src/prompts/render.ts +9 -4
  91. package/src/prompts/variables.ts +156 -0
@@ -47,7 +47,7 @@ export interface TransportResponse<T> {
47
47
  response: Response;
48
48
  }
49
49
 
50
- const SDK_VERSION = "0.3.0";
50
+ import { SDK_VERSION } from "./version.js";
51
51
 
52
52
  export class HttpTransport {
53
53
  readonly #config: TransportConfig;
@@ -95,7 +95,7 @@ export class HttpTransport {
95
95
  if (
96
96
  retryableMethod &&
97
97
  attempt < maxRetries &&
98
- isRetryableStatus(response.status)
98
+ (await mayRetryResponse(response))
99
99
  ) {
100
100
  await response.body?.cancel();
101
101
  await waitBeforeRetry(response, attempt, request.options?.signal);
@@ -319,6 +319,18 @@ function isRetryableStatus(status: number): boolean {
319
319
  return status === 408 || status === 429 || status >= 500;
320
320
  }
321
321
 
322
+ /** Server retryability overrides status defaults, including daily provider quota. */
323
+ async function mayRetryResponse(response: Response): Promise<boolean> {
324
+ if (!isRetryableStatus(response.status)) return false;
325
+ try {
326
+ const payload = asUnknownRecord(await response.clone().json());
327
+ return readBoolean(asUnknownRecord(payload.error), "retryable") !== false;
328
+ } catch {
329
+ // Non-JSON legacy responses retain bounded status-based retry behavior.
330
+ return true;
331
+ }
332
+ }
333
+
322
334
  function parseRetryAfter(value: string | null): number | undefined {
323
335
  if (!value) return undefined;
324
336
  const seconds = Number(value);
@@ -0,0 +1,2 @@
1
+ // Generated from package.json by scripts/generate-version.mjs.
2
+ export const SDK_VERSION = "0.3.3";
@@ -8,7 +8,7 @@ import {
8
8
  readString,
9
9
  } from "../core/metadata.js";
10
10
  import type { RequestMetadata, Usage } from "../core/types.js";
11
- import { normalizeToolCall, normalizeUsage } from "./mappers.js";
11
+ import { mergeReasoningDetails, normalizeToolCall, normalizeUsage } from "./mappers.js";
12
12
  import type {
13
13
  ChatChoice,
14
14
  ChatCompletion,
@@ -21,6 +21,8 @@ type MutableChoice = {
21
21
  index: number;
22
22
  role: ChatMessage["role"];
23
23
  content: string;
24
+ reasoning?: string;
25
+ reasoningDetails?: ChatMessage["reasoningDetails"];
24
26
  finishReason: ChatChoice["finishReason"];
25
27
  toolCalls: Map<number, FunctionToolCall>;
26
28
  };
@@ -140,6 +142,13 @@ export class ChatStream implements AsyncIterable<ChatStreamEvent> {
140
142
  : finishReason;
141
143
  }
142
144
 
145
+ const reasoning = readString(delta, "reasoning");
146
+ if (reasoning) {
147
+ mutable.reasoning = (mutable.reasoning ?? "") + reasoning;
148
+ yield { type: "reasoning.delta", id: this.#id, model: this.#model, choiceIndex: index, delta: reasoning, metadata: this.#metadata };
149
+ }
150
+ const details = readArray(delta, "reasoning_details", "reasoningDetails") as NonNullable<ChatMessage["reasoningDetails"]>;
151
+ if (details.length) mutable.reasoningDetails = mergeReasoningDetails(mutable.reasoningDetails ?? [], details);
143
152
  const content = readString(delta, "content");
144
153
  if (content) {
145
154
  mutable.content += content;
@@ -235,6 +244,8 @@ export class ChatStream implements AsyncIterable<ChatStreamEvent> {
235
244
  message: {
236
245
  role: choice.role,
237
246
  content: choice.content,
247
+ ...(choice.reasoning !== undefined ? { reasoning: choice.reasoning } : {}),
248
+ ...(choice.reasoningDetails ? { reasoningDetails: choice.reasoningDetails } : {}),
238
249
  ...(choice.toolCalls.size > 0
239
250
  ? { toolCalls: [...choice.toolCalls.values()] }
240
251
  : {}),
@@ -77,6 +77,7 @@ export class Chat {
77
77
  seed: params.seed,
78
78
  user: params.user,
79
79
  provider: params.provider,
80
+ provider_options: params.providerOptions,
80
81
  fallback_models: params.fallbackModels,
81
82
  routing_strategy: toWireRoutingStrategy(params.routingStrategy),
82
83
  metadata: params.metadata,
@@ -28,6 +28,7 @@ export class Embeddings {
28
28
  encoding_format: params.encoding,
29
29
  user: params.user,
30
30
  provider: params.provider,
31
+ provider_options: params.providerOptions,
31
32
  fallback_models: params.fallbackModels,
32
33
  routing_strategy: toWireRoutingStrategy(params.routingStrategy),
33
34
  },
@@ -36,6 +36,12 @@ export function toWireMessage(message: ChatMessage): Record<string, unknown> {
36
36
  audio: { data: part.data, format: part.format },
37
37
  };
38
38
  }),
39
+ ...(message.reasoning !== undefined
40
+ ? { reasoning: message.reasoning }
41
+ : {}),
42
+ ...(message.reasoningDetails?.length
43
+ ? { reasoning_details: message.reasoningDetails }
44
+ : {}),
39
45
  ...(message.name ? { name: message.name } : {}),
40
46
  ...(message.toolCallId ? { tool_call_id: message.toolCallId } : {}),
41
47
  ...(message.toolCalls && message.toolCalls.length > 0
@@ -68,8 +74,15 @@ export function normalizeUsage(value: unknown): Usage {
68
74
  totalTokens:
69
75
  readNumber(usage, "total_tokens", "totalTokens") ??
70
76
  inputTokens + outputTokens,
71
- cachedTokens: readNumber(usage, "cached_tokens", "cachedTokens"),
72
- reasoningTokens: readNumber(usage, "reasoning_tokens", "reasoningTokens"),
77
+ cachedTokens:
78
+ readNumber(usage, "cached_tokens", "cachedTokens") ??
79
+ readNumber(asUnknownRecord(usage.prompt_tokens_details), "cached_tokens"),
80
+ reasoningTokens:
81
+ readNumber(usage, "reasoning_tokens", "reasoningTokens") ??
82
+ readNumber(
83
+ asUnknownRecord(usage.completion_tokens_details),
84
+ "reasoning_tokens",
85
+ ),
73
86
  };
74
87
  }
75
88
 
@@ -183,6 +196,12 @@ export function normalizeMessage(value: unknown): ChatMessage {
183
196
  ? content
184
197
  : "",
185
198
  name: readString(message, "name"),
199
+ reasoning: readString(message, "reasoning"),
200
+ reasoningDetails: readArray(
201
+ message,
202
+ "reasoning_details",
203
+ "reasoningDetails",
204
+ ) as ChatMessage["reasoningDetails"],
186
205
  toolCallId: readString(message, "tool_call_id", "toolCallId"),
187
206
  toolCalls: toolCalls.length > 0 ? toolCalls : undefined,
188
207
  };
@@ -232,3 +251,37 @@ function normalizeFinishReason(
232
251
  if (value === "content_filter") return "contentFilter";
233
252
  return value;
234
253
  }
254
+
255
+ /** Assemble indexed reasoning blocks without losing encrypted continuation data. */
256
+ export function mergeReasoningDetails(
257
+ current: NonNullable<ChatMessage["reasoningDetails"]>,
258
+ incoming: NonNullable<ChatMessage["reasoningDetails"]>,
259
+ ): NonNullable<ChatMessage["reasoningDetails"]> {
260
+ const result = [...current];
261
+ for (const value of incoming) {
262
+ const detail = asUnknownRecord(value);
263
+ const position = result.findIndex((item) => {
264
+ const previous = asUnknownRecord(item);
265
+ return (
266
+ previous.type === detail.type &&
267
+ ((detail.index !== undefined && previous.index === detail.index) ||
268
+ (typeof detail.id === "string" && previous.id === detail.id))
269
+ );
270
+ });
271
+ if (position < 0) {
272
+ result.push(value);
273
+ continue;
274
+ }
275
+ const previous = asUnknownRecord(result[position]);
276
+ const merged = { ...previous, ...detail };
277
+ for (const field of ["text", "summary", "data", "signature"]) {
278
+ if (
279
+ typeof previous[field] === "string" &&
280
+ typeof detail[field] === "string"
281
+ )
282
+ merged[field] = previous[field] + detail[field];
283
+ }
284
+ result[position] = merged as (typeof result)[number];
285
+ }
286
+ return result;
287
+ }
@@ -45,6 +45,8 @@ export interface ChatMessage {
45
45
  role: ChatRole;
46
46
  content: string | readonly ChatContentPart[];
47
47
  name?: string;
48
+ reasoning?: string;
49
+ reasoningDetails?: readonly JsonValue[];
48
50
  toolCallId?: string;
49
51
  toolCalls?: readonly FunctionToolCall[];
50
52
  }
@@ -106,6 +108,8 @@ interface ChatCreateParamsBase {
106
108
  user?: string;
107
109
  /** Optional provider override. Omit to let the gateway select a provider. */
108
110
  provider?: string;
111
+ /** Options scoped to an upstream provider slug; other targets never receive them. */
112
+ providerOptions?: Readonly<Record<string, Readonly<Record<string, JsonValue>>>>;
109
113
  fallbackModels?: readonly string[];
110
114
  routingStrategy?: RoutingStrategy;
111
115
  metadata?: Readonly<Record<string, JsonValue>>;
@@ -167,6 +171,8 @@ export interface EmbeddingCreateParams {
167
171
  user?: string;
168
172
  /** Optional provider override. Omit to use the model's configured default provider. */
169
173
  provider?: string;
174
+ /** Options scoped to an upstream provider slug; other targets never receive them. */
175
+ providerOptions?: Readonly<Record<string, Readonly<Record<string, JsonValue>>>>;
170
176
  /** @deprecated Embeddings never fall back to another vector space. Requests with this option are rejected. */
171
177
  fallbackModels?: readonly string[];
172
178
  /** @deprecated Embeddings require direct model selection. */
@@ -204,6 +210,8 @@ export interface ImageGenerateParams {
204
210
  user?: string;
205
211
  /** Optional provider override. Omit to use the model's configured default provider. */
206
212
  provider?: string;
213
+ /** Options scoped to an upstream provider slug; other targets never receive them. */
214
+ providerOptions?: Readonly<Record<string, Readonly<Record<string, JsonValue>>>>;
207
215
  metadata?: Readonly<Record<string, JsonValue>>;
208
216
  }
209
217
 
package/src/index.ts CHANGED
@@ -4,6 +4,10 @@ export type {
4
4
  NirmosAuth,
5
5
  EndpointExecution,
6
6
  KnowledgeMatch,
7
+ KnowledgeSearchRequest,
8
+ KnowledgeSearchResponse,
9
+ KnowledgeSearchMode,
10
+ KnowledgeSearchStatus,
7
11
  PromptTestRequest,
8
12
  PromptTestResponse,
9
13
  } from "./client.js";
@@ -137,3 +141,12 @@ export type {
137
141
  } from "./memory/types.js";
138
142
 
139
143
  export { managementManifest } from "./management/manifest.js";
144
+
145
+ export {
146
+ extractPromptVariableNames,
147
+ interpolatePromptVariables,
148
+ promptVariableValue,
149
+ validatePromptTemplate,
150
+ validatePromptVariableValues,
151
+ validatePromptSettings,
152
+ } from "./prompts/variables.js";