@tanstack/ai 0.42.0 → 0.43.0

package/dist/esm/activities/stream-generation-result.js

@@ -1,49 +1,84 @@
-import { EventType } from "@ag-ui/core";
 import { toRunErrorPayload } from "./error-payload.js";
+import { EventType } from "@ag-ui/core";
+//#region src/activities/stream-generation-result.ts
+/**
+* Internal helper for wrapping one-shot generation results as StreamChunk
+* async iterables. NOT exported from the package — used only by activity
+* implementations to support `stream: true`.
+*/
 function createId(prefix) {
-  return `${prefix}-${Date.now()}-${Math.random().toString(36).slice(2, 9)}`;
+	return `${prefix}-${Date.now()}-${Math.random().toString(36).slice(2, 9)}`;
+}
+/**
+* Persisted artifact refs a middleware may have attached to the result. Read
+* defensively: the result shape is activity-specific and `artifacts` is only
+* present when generation persistence is wired with an artifact + blob store.
+*/
+function artifactsFromResult(result) {
+	if (typeof result !== "object" || result === null) return void 0;
+	const artifacts = result.artifacts;
+	return Array.isArray(artifacts) && artifacts.length > 0 ? artifacts : void 0;
 }
+/**
+* Wrap a one-shot generation result as a StreamChunk async iterable.
+*
+* This allows non-streaming activities (image, speech, transcription, summarize)
+* to be sent over the same streaming transport as chat.
+*
+* @param generator - An async function that performs the generation and returns the result
+* @param options - Optional configuration (runId, threadId)
+* @returns An AsyncIterable of StreamChunks with RUN_STARTED, CUSTOM(generation:result), and RUN_FINISHED events on success, or RUN_STARTED and RUN_ERROR on failure
+*/
 async function* streamGenerationResult(generator, options) {
-  const runId = createId("run");
-  const threadId = createId("thread");
-  yield {
-    type: EventType.RUN_STARTED,
-    runId,
-    threadId,
-    timestamp: Date.now()
-  };
-  try {
-    const result = await generator();
-    yield {
-      type: EventType.CUSTOM,
-      name: "generation:result",
-      value: result,
-      timestamp: Date.now()
-    };
-    yield {
-      type: EventType.RUN_FINISHED,
-      runId,
-      threadId,
-      finishReason: "stop",
-      timestamp: Date.now()
-    };
-  } catch (error) {
-    const payload = toRunErrorPayload(error, "Generation failed");
-    const codeFields = payload.code !== void 0 ? { code: payload.code } : void 0;
-    yield {
-      type: EventType.RUN_ERROR,
-      message: payload.message,
-      ...codeFields,
-      // Deprecated nested form for backward compatibility
-      error: {
-        message: payload.message,
-        ...codeFields
-      },
-      timestamp: Date.now()
-    };
-  }
+	const runId = options?.runId ?? createId("run");
+	const threadId = options?.threadId ?? createId("thread");
+	yield {
+		type: EventType.RUN_STARTED,
+		runId,
+		threadId,
+		timestamp: Date.now()
+	};
+	try {
+		const result = await generator({
+			runId,
+			threadId
+		});
+		const artifacts = artifactsFromResult(result);
+		if (artifacts) yield {
+			type: EventType.CUSTOM,
+			name: "generation:artifacts",
+			value: artifacts,
+			timestamp: Date.now()
+		};
+		yield {
+			type: EventType.CUSTOM,
+			name: "generation:result",
+			value: result,
+			timestamp: Date.now()
+		};
+		yield {
+			type: EventType.RUN_FINISHED,
+			runId,
+			threadId,
+			finishReason: "stop",
+			timestamp: Date.now()
+		};
+	} catch (error) {
+		const payload = toRunErrorPayload(error, "Generation failed");
+		const codeFields = payload.code !== void 0 ? { code: payload.code } : void 0;
+		yield {
+			type: EventType.RUN_ERROR,
+			message: payload.message,
+			...codeFields,
+			error: {
+				message: payload.message,
+				...codeFields
+			},
+			timestamp: Date.now()
+		};
+	}
 }
-export {
-  streamGenerationResult
-};
-//# sourceMappingURL=stream-generation-result.js.map
+//#endregion
+export { streamGenerationResult };
+
+//# sourceMappingURL=stream-generation-result.js.map

package/dist/esm/activities/stream-generation-result.js.map

@@ -1 +1 @@
-{"version":3,"file":"stream-generation-result.js","sources":["../../../src/activities/stream-generation-result.ts"],"sourcesContent":["/**\n * Internal helper for wrapping one-shot generation results as StreamChunk\n * async iterables. NOT exported from the package — used only by activity\n * implementations to support `stream: true`.\n */\n\nimport { EventType } from '@ag-ui/core'\nimport { toRunErrorPayload } from './error-payload'\nimport type { StreamChunk } from '../types'\n\nfunction createId(prefix: string): string {\n  return `${prefix}-${Date.now()}-${Math.random().toString(36).slice(2, 9)}`\n}\n\n/**\n * Wrap a one-shot generation result as a StreamChunk async iterable.\n *\n * This allows non-streaming activities (image, speech, transcription, summarize)\n * to be sent over the same streaming transport as chat.\n *\n * @param generator - An async function that performs the generation and returns the result\n * @param options - Optional configuration (runId, threadId)\n * @returns An AsyncIterable of StreamChunks with RUN_STARTED, CUSTOM(generation:result), and RUN_FINISHED events on success, or RUN_STARTED and RUN_ERROR on failure\n */\nexport async function* streamGenerationResult<TResult>(\n  generator: () => Promise<TResult>,\n  options?: { runId?: string; threadId?: string },\n): AsyncIterable<StreamChunk> {\n  const runId = options?.runId ?? createId('run')\n  const threadId = options?.threadId ?? createId('thread')\n\n  yield {\n    type: EventType.RUN_STARTED,\n    runId,\n    threadId,\n    timestamp: Date.now(),\n  }\n\n  try {\n    const result = await generator()\n\n    yield {\n      type: EventType.CUSTOM,\n      name: 'generation:result',\n      value: result as unknown,\n      timestamp: Date.now(),\n    }\n\n    yield {\n      type: EventType.RUN_FINISHED,\n      runId,\n      threadId,\n      finishReason: 'stop',\n      timestamp: Date.now(),\n    }\n  } catch (error: unknown) {\n    const payload = toRunErrorPayload(error, 'Generation failed')\n    // `code` is omitted entirely when undefined so the event matches the\n    // AG-UI `code?: string` shape under `exactOptionalPropertyTypes`. The\n    // deprecated nested `error` form preserves the same conditional\n    // structure for backward compatibility.\n    const codeFields =\n      payload.code !== undefined ? { code: payload.code } : undefined\n    yield {\n      type: EventType.RUN_ERROR,\n      message: payload.message,\n      ...codeFields,\n      // Deprecated nested form for backward compatibility\n      error: {\n        message: payload.message,\n        ...codeFields,\n      },\n      timestamp: Date.now(),\n    }\n  }\n}\n"],"names":[],"mappings":";;AAUA,SAAS,SAAS,QAAwB;AACxC,SAAO,GAAG,MAAM,IAAI,KAAK,IAAA,CAAK,IAAI,KAAK,OAAA,EAAS,SAAS,EAAE,EAAE,MAAM,GAAG,CAAC,CAAC;AAC1E;AAYA,gBAAuB,uBACrB,WACA,SAC4B;AAC5B,QAAM,QAA0B,SAAS,KAAK;AAC9C,QAAM,WAAgC,SAAS,QAAQ;AAEvD,QAAM;AAAA,IACJ,MAAM,UAAU;AAAA,IAChB;AAAA,IACA;AAAA,IACA,WAAW,KAAK,IAAA;AAAA,EAAI;AAGtB,MAAI;AACF,UAAM,SAAS,MAAM,UAAA;AAErB,UAAM;AAAA,MACJ,MAAM,UAAU;AAAA,MAChB,MAAM;AAAA,MACN,OAAO;AAAA,MACP,WAAW,KAAK,IAAA;AAAA,IAAI;AAGtB,UAAM;AAAA,MACJ,MAAM,UAAU;AAAA,MAChB;AAAA,MACA;AAAA,MACA,cAAc;AAAA,MACd,WAAW,KAAK,IAAA;AAAA,IAAI;AAAA,EAExB,SAAS,OAAgB;AACvB,UAAM,UAAU,kBAAkB,OAAO,mBAAmB;AAK5D,UAAM,aACJ,QAAQ,SAAS,SAAY,EAAE,MAAM,QAAQ,SAAS;AACxD,UAAM;AAAA,MACJ,MAAM,UAAU;AAAA,MAChB,SAAS,QAAQ;AAAA,MACjB,GAAG;AAAA;AAAA,MAEH,OAAO;AAAA,QACL,SAAS,QAAQ;AAAA,QACjB,GAAG;AAAA,MAAA;AAAA,MAEL,WAAW,KAAK,IAAA;AAAA,IAAI;AAAA,EAExB;AACF;"}
+{"version":3,"file":"stream-generation-result.js","names":[],"sources":["../../../src/activities/stream-generation-result.ts"],"sourcesContent":["/**\n * Internal helper for wrapping one-shot generation results as StreamChunk\n * async iterables. NOT exported from the package — used only by activity\n * implementations to support `stream: true`.\n */\n\nimport { EventType } from '@ag-ui/core'\nimport { toRunErrorPayload } from './error-payload'\nimport type { StreamChunk } from '../types'\n\nfunction createId(prefix: string): string {\n  return `${prefix}-${Date.now()}-${Math.random().toString(36).slice(2, 9)}`\n}\n\n/**\n * Persisted artifact refs a middleware may have attached to the result. Read\n * defensively: the result shape is activity-specific and `artifacts` is only\n * present when generation persistence is wired with an artifact + blob store.\n */\nfunction artifactsFromResult(result: unknown): Array<unknown> | undefined {\n  if (typeof result !== 'object' || result === null) return undefined\n  const artifacts = (result as { artifacts?: unknown }).artifacts\n  return Array.isArray(artifacts) && artifacts.length > 0\n    ? artifacts\n    : undefined\n}\n\n/**\n * Wrap a one-shot generation result as a StreamChunk async iterable.\n *\n * This allows non-streaming activities (image, speech, transcription, summarize)\n * to be sent over the same streaming transport as chat.\n *\n * @param generator - An async function that performs the generation and returns the result\n * @param options - Optional configuration (runId, threadId)\n * @returns An AsyncIterable of StreamChunks with RUN_STARTED, CUSTOM(generation:result), and RUN_FINISHED events on success, or RUN_STARTED and RUN_ERROR on failure\n */\nexport async function* streamGenerationResult<TResult>(\n  generator: (resolved: {\n    runId: string\n    threadId: string\n  }) => Promise<TResult>,\n  options?: { runId?: string; threadId?: string },\n): AsyncIterable<StreamChunk> {\n  const runId = options?.runId ?? createId('run')\n  const threadId = options?.threadId ?? createId('thread')\n\n  yield {\n    type: EventType.RUN_STARTED,\n    runId,\n    threadId,\n    timestamp: Date.now(),\n  }\n\n  try {\n    const result = await generator({ runId, threadId })\n\n    // Emit persisted artifact refs (if a middleware attached any) before the\n    // result, so the client records them as the run streams.\n    const artifacts = artifactsFromResult(result)\n    if (artifacts) {\n      yield {\n        type: EventType.CUSTOM,\n        name: 'generation:artifacts',\n        value: artifacts,\n        timestamp: Date.now(),\n      }\n    }\n\n    yield {\n      type: EventType.CUSTOM,\n      name: 'generation:result',\n      value: result as unknown,\n      timestamp: Date.now(),\n    }\n\n    yield {\n      type: EventType.RUN_FINISHED,\n      runId,\n      threadId,\n      finishReason: 'stop',\n      timestamp: Date.now(),\n    }\n  } catch (error: unknown) {\n    const payload = toRunErrorPayload(error, 'Generation failed')\n    // `code` is omitted entirely when undefined so the event matches the\n    // AG-UI `code?: string` shape under `exactOptionalPropertyTypes`. The\n    // deprecated nested `error` form preserves the same conditional\n    // structure for backward compatibility.\n    const codeFields =\n      payload.code !== undefined ? { code: payload.code } : undefined\n    yield {\n      type: EventType.RUN_ERROR,\n      message: payload.message,\n      ...codeFields,\n      // Deprecated nested form for backward compatibility\n      error: {\n        message: payload.message,\n        ...codeFields,\n      },\n      timestamp: Date.now(),\n    }\n  }\n}\n"],"mappings":";;;;;;;;AAUA,SAAS,SAAS,QAAwB;CACxC,OAAO,GAAG,OAAO,GAAG,KAAK,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC;AACzE;;;;;;AAOA,SAAS,oBAAoB,QAA6C;CACxE,IAAI,OAAO,WAAW,YAAY,WAAW,MAAM,OAAO,KAAA;CAC1D,MAAM,YAAa,OAAmC;CACtD,OAAO,MAAM,QAAQ,SAAS,KAAK,UAAU,SAAS,IAClD,YACA,KAAA;AACN;;;;;;;;;;;AAYA,gBAAuB,uBACrB,WAIA,SAC4B;CAC5B,MAAM,QAAQ,SAAS,SAAS,SAAS,KAAK;CAC9C,MAAM,WAAW,SAAS,YAAY,SAAS,QAAQ;CAEvD,MAAM;EACJ,MAAM,UAAU;EAChB;EACA;EACA,WAAW,KAAK,IAAI;CACtB;CAEA,IAAI;EACF,MAAM,SAAS,MAAM,UAAU;GAAE;GAAO;EAAS,CAAC;EAIlD,MAAM,YAAY,oBAAoB,MAAM;EAC5C,IAAI,WACF,MAAM;GACJ,MAAM,UAAU;GAChB,MAAM;GACN,OAAO;GACP,WAAW,KAAK,IAAI;EACtB;EAGF,MAAM;GACJ,MAAM,UAAU;GAChB,MAAM;GACN,OAAO;GACP,WAAW,KAAK,IAAI;EACtB;EAEA,MAAM;GACJ,MAAM,UAAU;GAChB;GACA;GACA,cAAc;GACd,WAAW,KAAK,IAAI;EACtB;CACF,SAAS,OAAgB;EACvB,MAAM,UAAU,kBAAkB,OAAO,mBAAmB;EAK5D,MAAM,aACJ,QAAQ,SAAS,KAAA,IAAY,EAAE,MAAM,QAAQ,KAAK,IAAI,KAAA;EACxD,MAAM;GACJ,MAAM,UAAU;GAChB,SAAS,QAAQ;GACjB,GAAG;GAEH,OAAO;IACL,SAAS,QAAQ;IACjB,GAAG;GACL;GACA,WAAW,KAAK,IAAI;EACtB;CACF;AACF"}

package/dist/esm/activities/summarize/adapter.js

@@ -1,16 +1,23 @@
-class BaseSummarizeAdapter {
-  kind = "summarize";
-  model;
-  config;
-  constructor(config = {}, model) {
-    this.config = config;
-    this.model = model;
-  }
-  generateId() {
-    return `${this.name}-${Date.now()}-${Math.random().toString(36).substring(7)}`;
-  }
-}
-export {
-  BaseSummarizeAdapter
+//#region src/activities/summarize/adapter.ts
+/**
+* Abstract base class for summarize adapters.
+* Extend this class to implement a summarize adapter for a specific provider.
+*
+* Generic parameters match SummarizeAdapter - all pre-resolved by the provider function.
+*/
+var BaseSummarizeAdapter = class {
+	kind = "summarize";
+	model;
+	config;
+	constructor(config = {}, model) {
+		this.config = config;
+		this.model = model;
+	}
+	generateId() {
+		return `${this.name}-${Date.now()}-${Math.random().toString(36).substring(7)}`;
+	}
 };
-//# sourceMappingURL=adapter.js.map
+//#endregion
+export { BaseSummarizeAdapter };
+
+//# sourceMappingURL=adapter.js.map

package/dist/esm/activities/summarize/adapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"adapter.js","sources":["../../../../src/activities/summarize/adapter.ts"],"sourcesContent":["import type {\n  StreamChunk,\n  SummarizationOptions,\n  SummarizationResult,\n} from '../../types'\n\n/**\n * Configuration for summarize adapter instances\n */\nexport interface SummarizeAdapterConfig {\n  apiKey?: string\n  baseUrl?: string\n  timeout?: number\n  maxRetries?: number\n  headers?: Record<string, string>\n}\n\n/**\n * Summarize adapter interface with pre-resolved generics.\n *\n * An adapter is created by a provider function: `provider('model')` → `adapter`\n * All type resolution happens at the provider call site, not in this interface.\n *\n * Generic parameters:\n * - TModel: The specific model name (e.g., 'gpt-4o')\n * - TProviderOptions: Provider-specific options (already resolved)\n */\nexport interface SummarizeAdapter<\n  TModel extends string = string,\n  TProviderOptions extends object = Record<string, unknown>,\n> {\n  /** Discriminator for adapter kind - used by generate() to determine API shape */\n  readonly kind: 'summarize'\n  /** Adapter name identifier */\n  readonly name: string\n  /** The model this adapter is configured for */\n  readonly model: TModel\n\n  /**\n   * @internal Type-only properties for inference. Not assigned at runtime.\n   */\n  '~types': {\n    providerOptions: TProviderOptions\n  }\n\n  /**\n   * Summarize the given text\n   */\n  summarize: (\n    options: SummarizationOptions<TProviderOptions>,\n  ) => Promise<SummarizationResult>\n\n  /**\n   * Stream summarization of the given text.\n   * Optional - if not implemented, the activity layer will fall back to\n   * non-streaming summarize and yield the result as a single chunk.\n   */\n  summarizeStream?: (\n    options: SummarizationOptions<TProviderOptions>,\n  ) => AsyncIterable<StreamChunk>\n}\n\n/**\n * A SummarizeAdapter with any/unknown type parameters.\n * Useful as a constraint in generic functions and interfaces.\n */\nexport type AnySummarizeAdapter = SummarizeAdapter<any, any>\n\n/**\n * Abstract base class for summarize adapters.\n * Extend this class to implement a summarize adapter for a specific provider.\n *\n * Generic parameters match SummarizeAdapter - all pre-resolved by the provider function.\n */\nexport abstract class BaseSummarizeAdapter<\n  TModel extends string = string,\n  TProviderOptions extends object = Record<string, unknown>,\n> implements SummarizeAdapter<TModel, TProviderOptions> {\n  readonly kind = 'summarize' as const\n  abstract readonly name: string\n  readonly model: TModel\n\n  // Type-only property - never assigned at runtime\n  declare '~types': {\n    providerOptions: TProviderOptions\n  }\n\n  protected config: SummarizeAdapterConfig\n\n  constructor(config: SummarizeAdapterConfig = {}, model: TModel) {\n    this.config = config\n    this.model = model\n  }\n\n  abstract summarize(\n    options: SummarizationOptions<TProviderOptions>,\n  ): Promise<SummarizationResult>\n\n  /**\n   * Stream summarization of the given text.\n   * Override this method in concrete implementations to enable streaming.\n   * If not overridden, the activity layer will fall back to non-streaming.\n   */\n  summarizeStream?(\n    options: SummarizationOptions<TProviderOptions>,\n  ): AsyncIterable<StreamChunk>\n\n  protected generateId(): string {\n    return `${this.name}-${Date.now()}-${Math.random().toString(36).substring(7)}`\n  }\n}\n"],"names":[],"mappings":"AA0EO,MAAe,qBAGkC;AAAA,EAC7C,OAAO;AAAA,EAEP;AAAA,EAOC;AAAA,EAEV,YAAY,SAAiC,CAAA,GAAI,OAAe;AAC9D,SAAK,SAAS;AACd,SAAK,QAAQ;AAAA,EACf;AAAA,EAeU,aAAqB;AAC7B,WAAO,GAAG,KAAK,IAAI,IAAI,KAAK,KAAK,IAAI,KAAK,OAAA,EAAS,SAAS,EAAE,EAAE,UAAU,CAAC,CAAC;AAAA,EAC9E;AACF;"}
+{"version":3,"file":"adapter.js","names":[],"sources":["../../../../src/activities/summarize/adapter.ts"],"sourcesContent":["import type {\n  StreamChunk,\n  SummarizationOptions,\n  SummarizationResult,\n} from '../../types'\n\n/**\n * Configuration for summarize adapter instances\n */\nexport interface SummarizeAdapterConfig {\n  apiKey?: string\n  baseUrl?: string\n  timeout?: number\n  maxRetries?: number\n  headers?: Record<string, string>\n}\n\n/**\n * Summarize adapter interface with pre-resolved generics.\n *\n * An adapter is created by a provider function: `provider('model')` → `adapter`\n * All type resolution happens at the provider call site, not in this interface.\n *\n * Generic parameters:\n * - TModel: The specific model name (e.g., 'gpt-4o')\n * - TProviderOptions: Provider-specific options (already resolved)\n */\nexport interface SummarizeAdapter<\n  TModel extends string = string,\n  TProviderOptions extends object = Record<string, unknown>,\n> {\n  /** Discriminator for adapter kind - used by generate() to determine API shape */\n  readonly kind: 'summarize'\n  /** Adapter name identifier */\n  readonly name: string\n  /** The model this adapter is configured for */\n  readonly model: TModel\n\n  /**\n   * @internal Type-only properties for inference. Not assigned at runtime.\n   */\n  '~types': {\n    providerOptions: TProviderOptions\n  }\n\n  /**\n   * Summarize the given text\n   */\n  summarize: (\n    options: SummarizationOptions<TProviderOptions>,\n  ) => Promise<SummarizationResult>\n\n  /**\n   * Stream summarization of the given text.\n   * Optional - if not implemented, the activity layer will fall back to\n   * non-streaming summarize and yield the result as a single chunk.\n   */\n  summarizeStream?: (\n    options: SummarizationOptions<TProviderOptions>,\n  ) => AsyncIterable<StreamChunk>\n}\n\n/**\n * A SummarizeAdapter with any/unknown type parameters.\n * Useful as a constraint in generic functions and interfaces.\n */\nexport type AnySummarizeAdapter = SummarizeAdapter<any, any>\n\n/**\n * Abstract base class for summarize adapters.\n * Extend this class to implement a summarize adapter for a specific provider.\n *\n * Generic parameters match SummarizeAdapter - all pre-resolved by the provider function.\n */\nexport abstract class BaseSummarizeAdapter<\n  TModel extends string = string,\n  TProviderOptions extends object = Record<string, unknown>,\n> implements SummarizeAdapter<TModel, TProviderOptions> {\n  readonly kind = 'summarize' as const\n  abstract readonly name: string\n  readonly model: TModel\n\n  // Type-only property - never assigned at runtime\n  declare '~types': {\n    providerOptions: TProviderOptions\n  }\n\n  protected config: SummarizeAdapterConfig\n\n  constructor(config: SummarizeAdapterConfig = {}, model: TModel) {\n    this.config = config\n    this.model = model\n  }\n\n  abstract summarize(\n    options: SummarizationOptions<TProviderOptions>,\n  ): Promise<SummarizationResult>\n\n  /**\n   * Stream summarization of the given text.\n   * Override this method in concrete implementations to enable streaming.\n   * If not overridden, the activity layer will fall back to non-streaming.\n   */\n  summarizeStream?(\n    options: SummarizationOptions<TProviderOptions>,\n  ): AsyncIterable<StreamChunk>\n\n  protected generateId(): string {\n    return `${this.name}-${Date.now()}-${Math.random().toString(36).substring(7)}`\n  }\n}\n"],"mappings":";;;;;;;AA0EA,IAAsB,uBAAtB,MAGwD;CACtD,OAAgB;CAEhB;CAOA;CAEA,YAAY,SAAiC,CAAC,GAAG,OAAe;EAC9D,KAAK,SAAS;EACd,KAAK,QAAQ;CACf;CAeA,aAA+B;EAC7B,OAAO,GAAG,KAAK,KAAK,GAAG,KAAK,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,UAAU,CAAC;CAC7E;AACF"}