@output.ai/llm 0.2.7 → 0.2.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@output.ai/llm",
-  "version": "0.2.7",
+  "version": "0.2.8",
   "description": "Framework abstraction to interact with LLM models",
   "type": "module",
   "main": "src/index.js",

package/src/ai_sdk.js

@@ -5,24 +5,25 @@ import * as AI from 'ai';
 import { validateGenerateTextArgs, validateGenerateObjectArgs, validateGenerateArrayArgs, validateGenerateEnumArgs } from './validations.js';
 import { loadPrompt } from './prompt_loader.js';
 
-/*
-  Word of wisdom:
-  We could retrieve the result object using the rest operator:
-  ```js
-  const { usage, providerMetadata, ...rest } = response;
-  const result = rest[resultProperty];
-  ```
-  But we CAN'T because the response of the generateText is an instance of `DefaultGenerateTextResult`
-  and 'text' is a getter (`get text()`).
-  Be aware of this when refactoring.
-*/
 const traceWrapper = async ( { traceId, resultProperty, fn } ) => {
   try {
     const response = await fn();
     const { usage, providerMetadata } = response;
     const result = response[resultProperty];
     Tracing.addEventEnd( { id: traceId, details: { result, usage, providerMetadata } } );
-    return result;
+
+    // Use a Proxy to add 'result' as a unified field name without mutating the AI SDK response.
+    // This preserves the original response object (with its getters/prototype) while allowing
+    // developers to use 'result' consistently across all generate* functions.
+    // Note: Don't use spread/rest on response - AI SDK uses getters that won't copy correctly.
+    return new Proxy( response, {
+      get( target, prop, receiver ) {
+        if ( prop === 'result' ) {
+          return target[resultProperty];
+        }
+        return Reflect.get( target, prop, receiver );
+      }
+    } );
   } catch ( error ) {
     Tracing.addEventError( { id: traceId, details: error } );
     throw error;
@@ -63,7 +64,7 @@ const extraAiSdkOptionsFromPrompt = prompt => {
  * @param {Record<string, string | number>} [args.variables] - Variables to interpolate
  * @throws {ValidationError} If the prompt config is invalid (e.g., snake_case fields)
  * @throws {FatalError} If the prompt file is not found or template rendering fails
- * @returns {Promise<string>} Generated text
+ * @returns {Promise<GenerateTextResult>} AI SDK response with text and metadata
  */
 export async function generateText( { prompt, variables } ) {
   validateGenerateTextArgs( { prompt, variables } );
@@ -87,7 +88,7 @@ export async function generateText( { prompt, variables } ) {
  * @param {string} [args.schemaDescription] - Output schema description
  * @throws {ValidationError} If the prompt config is invalid (e.g., snake_case fields)
  * @throws {FatalError} If the prompt file is not found or template rendering fails
- * @returns {Promise<object>} Object matching the provided schema
+ * @returns {Promise<GenerateObjectResult>} AI SDK response with object and metadata
  */
 export async function generateObject( args ) {
   validateGenerateObjectArgs( args );
@@ -118,7 +119,7 @@ export async function generateObject( args ) {
  * @param {string} [args.schemaDescription] - Output schema description
  * @throws {ValidationError} If the prompt config is invalid (e.g., snake_case fields)
  * @throws {FatalError} If the prompt file is not found or template rendering fails
- * @returns {Promise<object>} Array where each element matches the schema
+ * @returns {Promise<GenerateObjectResult>} AI SDK response with array and metadata
  */
 export async function generateArray( args ) {
   validateGenerateArrayArgs( args );
@@ -147,7 +148,7 @@ export async function generateArray( args ) {
  * @param {string[]} args.enum - Allowed values for the generation
  * @throws {ValidationError} If the prompt config is invalid (e.g., snake_case fields)
  * @throws {FatalError} If the prompt file is not found or template rendering fails
- * @returns {Promise<string>} One of the provided enum values
+ * @returns {Promise<GenerateObjectResult>} AI SDK response with enum value and metadata
  */
 export async function generateEnum( args ) {
   validateGenerateEnumArgs( args );

package/src/ai_sdk.spec.js

@@ -52,8 +52,17 @@ beforeEach( () => {
   loadModelImpl.mockReset().mockReturnValue( 'MODEL' );
   loadPromptImpl.mockReset().mockReturnValue( basePrompt );
 
-  aiFns.generateText.mockReset().mockResolvedValue( { text: 'TEXT' } );
-  aiFns.generateObject.mockReset().mockResolvedValue( { object: 'OBJECT' } );
+  aiFns.generateText.mockReset().mockResolvedValue( {
+    text: 'TEXT',
+    sources: [],
+    usage: { inputTokens: 10, outputTokens: 5, totalTokens: 15 },
+    finishReason: 'stop'
+  } );
+  aiFns.generateObject.mockReset().mockResolvedValue( {
+    object: 'OBJECT',
+    usage: { inputTokens: 10, outputTokens: 5, totalTokens: 15 },
+    finishReason: 'stop'
+  } );
 
   validators.validateGenerateTextArgs.mockClear();
   validators.validateGenerateObjectArgs.mockClear();
@@ -83,12 +92,19 @@ describe( 'ai_sdk', () => {
       temperature: 0.3,
       providerOptions: basePrompt.config.providerOptions
     } );
-    expect( result ).toBe( 'TEXT' );
+    expect( result.text ).toBe( 'TEXT' );
+    expect( result.sources ).toEqual( [] );
+    expect( result.usage ).toEqual( { inputTokens: 10, outputTokens: 5, totalTokens: 15 } );
+    expect( result.finishReason ).toBe( 'stop' );
   } );
 
   it( 'generateObject: validates, traces, calls AI with output object and returns object', async () => {
     const { generateObject } = await importSut();
-    aiFns.generateObject.mockResolvedValueOnce( { object: { a: 1 } } );
+    aiFns.generateObject.mockResolvedValueOnce( {
+      object: { a: 1 },
+      usage: { inputTokens: 10, outputTokens: 5, totalTokens: 15 },
+      finishReason: 'stop'
+    } );
 
     const schema = z.object( { a: z.number() } );
     const result = await generateObject( {
@@ -113,12 +129,16 @@ describe( 'ai_sdk', () => {
       temperature: 0.3,
       providerOptions: basePrompt.config.providerOptions
     } );
-    expect( result ).toEqual( { a: 1 } );
+    expect( result.object ).toEqual( { a: 1 } );
   } );
 
   it( 'generateArray: validates, traces, calls AI (item schema) and returns array', async () => {
     const { generateArray } = await importSut();
-    aiFns.generateObject.mockResolvedValueOnce( { object: [ 1, 2 ] } );
+    aiFns.generateObject.mockResolvedValueOnce( {
+      object: [ 1, 2 ],
+      usage: { inputTokens: 10, outputTokens: 5, totalTokens: 15 },
+      finishReason: 'stop'
+    } );
 
     const schema = z.number();
     const result = await generateArray( {
@@ -143,12 +163,16 @@ describe( 'ai_sdk', () => {
       temperature: 0.3,
       providerOptions: basePrompt.config.providerOptions
     } );
-    expect( result ).toEqual( [ 1, 2 ] );
+    expect( result.object ).toEqual( [ 1, 2 ] );
   } );
 
   it( 'generateEnum: validates, traces, calls AI with output enum and returns value', async () => {
     const { generateEnum } = await importSut();
-    aiFns.generateObject.mockResolvedValueOnce( { object: 'B' } );
+    aiFns.generateObject.mockResolvedValueOnce( {
+      object: 'B',
+      usage: { inputTokens: 10, outputTokens: 5, totalTokens: 15 },
+      finishReason: 'stop'
+    } );
 
     const result = await generateEnum( { prompt: 'test_prompt@v1', enum: [ 'A', 'B', 'C' ] } );
 
@@ -165,7 +189,7 @@ describe( 'ai_sdk', () => {
       temperature: 0.3,
       providerOptions: basePrompt.config.providerOptions
     } );
-    expect( result ).toBe( 'B' );
+    expect( result.object ).toBe( 'B' );
   } );
 
   it( 'generateText: passes provider-specific options to AI SDK', async () => {
@@ -325,4 +349,149 @@ describe( 'ai_sdk', () => {
       }
     } );
   } );
+
+  it( 'generateText: passes through providerMetadata', async () => {
+    aiFns.generateText.mockResolvedValueOnce( {
+      text: 'TEXT',
+      sources: [],
+      usage: { inputTokens: 10, outputTokens: 5, totalTokens: 15 },
+      finishReason: 'stop',
+      providerMetadata: { anthropic: { cacheReadInputTokens: 50 } }
+    } );
+
+    const { generateText } = await importSut();
+    const result = await generateText( { prompt: 'test_prompt@v1' } );
+
+    expect( result.providerMetadata ).toEqual( { anthropic: { cacheReadInputTokens: 50 } } );
+  } );
+
+  it( 'generateText: passes through warnings and response metadata', async () => {
+    aiFns.generateText.mockResolvedValueOnce( {
+      text: 'TEXT',
+      sources: [],
+      usage: { inputTokens: 10, outputTokens: 5, totalTokens: 15 },
+      finishReason: 'stop',
+      warnings: [ { type: 'other', message: 'Test warning' } ],
+      response: { id: 'req_123', modelId: 'gpt-4o-2024-05-13' }
+    } );
+
+    const { generateText } = await importSut();
+    const result = await generateText( { prompt: 'test_prompt@v1' } );
+
+    expect( result.warnings ).toEqual( [ { type: 'other', message: 'Test warning' } ] );
+    expect( result.response ).toEqual( { id: 'req_123', modelId: 'gpt-4o-2024-05-13' } );
+  } );
+
+  it( 'generateText: includes unified result field that matches text', async () => {
+    const { generateText } = await importSut();
+    const response = await generateText( { prompt: 'test_prompt@v1' } );
+
+    expect( response.result ).toBe( 'TEXT' );
+    expect( response.result ).toBe( response.text );
+  } );
+
+  it( 'generateObject: includes unified result field that matches object', async () => {
+    const { generateObject } = await importSut();
+    aiFns.generateObject.mockResolvedValueOnce( {
+      object: { a: 1, b: 'test' },
+      usage: { inputTokens: 10, outputTokens: 5, totalTokens: 15 },
+      finishReason: 'stop'
+    } );
+
+    const schema = z.object( { a: z.number(), b: z.string() } );
+    const response = await generateObject( { prompt: 'test_prompt@v1', schema } );
+
+    expect( response.result ).toEqual( { a: 1, b: 'test' } );
+    expect( response.result ).toEqual( response.object );
+  } );
+
+  it( 'generateArray: includes unified result field that matches object', async () => {
+    const { generateArray } = await importSut();
+    aiFns.generateObject.mockResolvedValueOnce( {
+      object: [ 'item1', 'item2', 'item3' ],
+      usage: { inputTokens: 10, outputTokens: 5, totalTokens: 15 },
+      finishReason: 'stop'
+    } );
+
+    const schema = z.string();
+    const response = await generateArray( { prompt: 'test_prompt@v1', schema } );
+
+    expect( response.result ).toEqual( [ 'item1', 'item2', 'item3' ] );
+    expect( response.result ).toEqual( response.object );
+  } );
+
+  it( 'generateEnum: includes unified result field that matches object', async () => {
+    const { generateEnum } = await importSut();
+    aiFns.generateObject.mockResolvedValueOnce( {
+      object: 'yes',
+      usage: { inputTokens: 10, outputTokens: 5, totalTokens: 15 },
+      finishReason: 'stop'
+    } );
+
+    const response = await generateEnum( { prompt: 'test_prompt@v1', enum: [ 'yes', 'no' ] } );
+
+    expect( response.result ).toBe( 'yes' );
+    expect( response.result ).toBe( response.object );
+  } );
+
+  it( 'generateText: traces error and rethrows when AI SDK fails', async () => {
+    const error = new Error( 'API rate limit exceeded' );
+    aiFns.generateText.mockRejectedValueOnce( error );
+    const { generateText } = await importSut();
+
+    await expect( generateText( { prompt: 'test_prompt@v1' } ) ).rejects.toThrow( 'API rate limit exceeded' );
+    expect( tracingSpies.addEventError ).toHaveBeenCalledWith(
+      expect.objectContaining( { details: error } )
+    );
+  } );
+
+  it( 'generateObject: traces error and rethrows when AI SDK fails', async () => {
+    const error = new Error( 'Invalid schema' );
+    aiFns.generateObject.mockRejectedValueOnce( error );
+    const { generateObject } = await importSut();
+
+    const schema = z.object( { a: z.number() } );
+    await expect( generateObject( { prompt: 'test_prompt@v1', schema } ) ).rejects.toThrow( 'Invalid schema' );
+    expect( tracingSpies.addEventError ).toHaveBeenCalledWith(
+      expect.objectContaining( { details: error } )
+    );
+  } );
+
+  it( 'generateText: Proxy correctly handles AI SDK response with getter', async () => {
+    const responseWithGetter = {
+      _internalText: 'TEXT_FROM_GETTER',
+      get text() {
+        return this._internalText;
+      },
+      sources: [],
+      usage: { inputTokens: 10, outputTokens: 5, totalTokens: 15 },
+      finishReason: 'stop'
+    };
+    aiFns.generateText.mockResolvedValueOnce( responseWithGetter );
+
+    const { generateText } = await importSut();
+    const response = await generateText( { prompt: 'test_prompt@v1' } );
+
+    expect( response.text ).toBe( 'TEXT_FROM_GETTER' );
+    expect( response.result ).toBe( 'TEXT_FROM_GETTER' );
+  } );
+
+  it( 'generateObject: Proxy correctly handles AI SDK response with getter', async () => {
+    const responseWithGetter = {
+      _internalObject: { value: 42 },
+      get object() {
+        return this._internalObject;
+      },
+      usage: { inputTokens: 10, outputTokens: 5, totalTokens: 15 },
+      finishReason: 'stop'
+    };
+    aiFns.generateObject.mockResolvedValueOnce( responseWithGetter );
+
+    const { generateObject } = await importSut();
+    const schema = z.object( { value: z.number() } );
+    const response = await generateObject( { prompt: 'test_prompt@v1', schema } );
+
+    expect( response.object ).toEqual( { value: 42 } );
+    expect( response.result ).toEqual( { value: 42 } );
+  } );
 } );

package/src/index.d.ts

@@ -1,4 +1,8 @@
 import type { z } from '@output.ai/core';
+import type {
+  GenerateTextResult as AIGenerateTextResult,
+  GenerateObjectResult as AIGenerateObjectResult
+} from 'ai';
 
 /**
  * Represents a single message in a prompt conversation.
@@ -61,6 +65,36 @@ export type Prompt = {
   messages: PromptMessage[];
 };
 
+// Re-export AI SDK types directly (auto-synced with AI SDK updates)
+export type {
+  LanguageModelUsage,
+  FinishReason,
+  LanguageModelResponseMetadata,
+  ProviderMetadata,
+  CallWarning
+} from 'ai';
+
+/**
+ * Result from generateText including full AI SDK response metadata.
+ * Extends AI SDK's GenerateTextResult with a unified `result` field.
+ */
+export type GenerateTextResult =
+  AIGenerateTextResult<Record<string, never>, unknown> & {
+    /** Unified field name alias for 'text' - provides consistency across all generate* functions */
+    result: string;
+  };
+
+/**
+ * Result from generateObject/generateArray/generateEnum including full AI SDK response metadata.
+ * Extends AI SDK's GenerateObjectResult with a unified `result` field.
+ * @typeParam T - The type of the generated object, inferred from the schema parameter
+ */
+export type GenerateObjectResult<T> =
+  AIGenerateObjectResult<T> & {
+    /** Unified field name alias for 'object' - provides consistency across all generate* functions */
+    result: T;
+  };
+
 /**
  * Loads a prompt file and interpolates variables into its content.
  *
@@ -82,14 +116,14 @@ export function loadPrompt(
  * @param args - Generation arguments.
  * @param args.prompt - Prompt file name.
  * @param args.variables - Variables to interpolate.
- * @returns Generated text.
+ * @returns AI SDK response with text and metadata.
  */
 export function generateText(
   args: {
     prompt: string,
     variables?: Record<string, string | number | boolean>
   }
-): Promise<string>;
+): Promise<GenerateTextResult>;
 
 /**
  * Use an LLM model to generate an object with a fixed schema.
@@ -103,7 +137,7 @@ export function generateText(
  * @param args.schema - Output schema.
  * @param args.schemaName - Output schema name.
  * @param args.schemaDescription - Output schema description.
- * @returns Resolves to an object matching the provided schema.
+ * @returns AI SDK response with object and metadata.
  */
 export function generateObject<TSchema extends z.ZodObject>(
   args: {
@@ -113,7 +147,7 @@ export function generateObject<TSchema extends z.ZodObject>(
     schemaName?: string,
     schemaDescription?: string
   }
-): Promise<z.infer<TSchema>>;
+): Promise<GenerateObjectResult<z.infer<TSchema>>>;
 
 /**
  * Use an LLM model to generate an array of values with a fixed schema.
@@ -127,7 +161,7 @@ export function generateObject<TSchema extends z.ZodObject>(
  * @param args.schema - Output schema (array item).
  * @param args.schemaName - Output schema name.
  * @param args.schemaDescription - Output schema description.
- * @returns Resolves to an array where each element matches the schema.
+ * @returns AI SDK response with array and metadata.
  */
 export function generateArray<TSchema extends z.ZodType>(
   args: {
@@ -137,7 +171,7 @@ export function generateArray<TSchema extends z.ZodType>(
     schemaName?: string,
     schemaDescription?: string
   }
-): Promise<Array<z.infer<TSchema>>>;
+): Promise<GenerateObjectResult<Array<z.infer<TSchema>>>>;
 
 /**
  * Use an LLM model to generate a result from an enum (array of string values).
@@ -149,7 +183,7 @@ export function generateArray<TSchema extends z.ZodType>(
  * @param args.prompt - Prompt file name.
  * @param args.variables - Variables to interpolate.
  * @param args.enum - Allowed values for the generation.
- * @returns Resolves to one of the provided enum values.
+ * @returns AI SDK response with enum value and metadata.
  */
 export function generateEnum<const TEnum extends readonly [string, ...string[]]>(
   args: {
@@ -157,4 +191,4 @@ export function generateEnum<const TEnum extends readonly [string, ...string[]]>
     variables?: Record<string, string | number | boolean>,
     enum: TEnum
   }
-): Promise<TEnum[number]>;
+): Promise<GenerateObjectResult<TEnum[number]>>;