@openai/agents-core 0.0.16 → 0.1.0

package/dist/types/protocol.js

@@ -1,4 +1,7 @@
-import { z } from '@openai/zod/v3';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamEvent = exports.StreamEventGenericItem = exports.StreamEventResponseCompleted = exports.StreamEventResponseStarted = exports.StreamEventTextStream = exports.UsageData = exports.ModelItem = exports.OutputModelItem = exports.UnknownItem = exports.ReasoningItem = exports.ToolCallItem = exports.ComputerCallResultItem = exports.ComputerUseCallItem = exports.FunctionCallResultItem = exports.FunctionCallItem = exports.HostedToolCallItem = exports.MessageItem = exports.UserMessageItem = exports.UserContent = exports.AssistantMessageItem = exports.AssistantContent = exports.computerActions = exports.ComputerToolOutput = exports.ToolOutputImage = exports.ToolOutputText = exports.ImageContent = exports.AudioContent = exports.InputFile = exports.InputImage = exports.ReasoningText = exports.InputText = exports.OutputText = exports.Refusal = exports.ItemBase = exports.SharedBase = void 0;
+const zod_1 = require("zod");
 // ----------------------------
 // Shared base types
 // ----------------------------
@@ -6,343 +9,343 @@ import { z } from '@openai/zod/v3';
  * Every item in the protocol provides a `providerData` field to accommodate custom functionality
  * or new fields
  */
-export const SharedBase = z.object({
+exports.SharedBase = zod_1.z.object({
     /**
      * Additional optional provider specific data. Used for custom functionality or model provider
      * specific fields.
      */
-    providerData: z.record(z.string(), z.any()).optional(),
+    providerData: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
 });
 /**
  * Every item has a shared of shared item data including an optional ID.
  */
-export const ItemBase = SharedBase.extend({
+exports.ItemBase = exports.SharedBase.extend({
     /**
      * An ID to identify the item. This is optional by default. If a model provider absolutely
      * requires this field, it will be validated on the model level.
      */
-    id: z.string().optional(),
+    id: zod_1.z.string().optional(),
 });
 // ----------------------------
 // Content types
 // ----------------------------
-export const Refusal = SharedBase.extend({
-    type: z.literal('refusal'),
+exports.Refusal = exports.SharedBase.extend({
+    type: zod_1.z.literal('refusal'),
     /**
      * The refusal explanation from the model.
      */
-    refusal: z.string(),
+    refusal: zod_1.z.string(),
 });
-export const OutputText = SharedBase.extend({
-    type: z.literal('output_text'),
+exports.OutputText = exports.SharedBase.extend({
+    type: zod_1.z.literal('output_text'),
     /**
      * The text output from the model.
      */
-    text: z.string(),
+    text: zod_1.z.string(),
 });
-export const InputText = SharedBase.extend({
-    type: z.literal('input_text'),
+exports.InputText = exports.SharedBase.extend({
+    type: zod_1.z.literal('input_text'),
     /**
      * A text input for example a message from a user
      */
-    text: z.string(),
+    text: zod_1.z.string(),
 });
-export const ReasoningText = SharedBase.extend({
-    type: z.literal('reasoning_text'),
+exports.ReasoningText = exports.SharedBase.extend({
+    type: zod_1.z.literal('reasoning_text'),
     /**
      * A text input for example a message from a user
      */
-    text: z.string(),
+    text: zod_1.z.string(),
 });
-export const InputImage = SharedBase.extend({
-    type: z.literal('input_image'),
+exports.InputImage = exports.SharedBase.extend({
+    type: zod_1.z.literal('input_image'),
     /**
      * The image input to the model. Could be a URL, base64 or an object with a file ID.
      */
-    image: z
+    image: zod_1.z
         .string()
-        .or(z.object({
-        id: z.string(),
+        .or(zod_1.z.object({
+        id: zod_1.z.string(),
     }))
         .describe('Could be a URL, base64 or an object with a file ID.'),
 });
-export const InputFile = SharedBase.extend({
-    type: z.literal('input_file'),
+exports.InputFile = exports.SharedBase.extend({
+    type: zod_1.z.literal('input_file'),
     /**
      * The file input to the model. Could be a URL, base64 or an object with a file ID.
      */
-    file: z
+    file: zod_1.z
         .string()
         .describe('Either base64 encoded file data or a publicly accessible file URL')
-        .or(z.object({
-        id: z.string().describe('OpenAI file ID'),
+        .or(zod_1.z.object({
+        id: zod_1.z.string().describe('OpenAI file ID'),
     }))
-        .or(z.object({
-        url: z.string().describe('Publicly accessible PDF file URL'),
+        .or(zod_1.z.object({
+        url: zod_1.z.string().describe('Publicly accessible PDF file URL'),
     }))
         .describe('Contents of the file or an object with a file ID.'),
 });
-export const AudioContent = SharedBase.extend({
-    type: z.literal('audio'),
+exports.AudioContent = exports.SharedBase.extend({
+    type: zod_1.z.literal('audio'),
     /**
      * The audio input to the model. Could be base64 encoded audio data or an object with a file ID.
      */
-    audio: z
+    audio: zod_1.z
         .string()
-        .or(z.object({
-        id: z.string(),
+        .or(zod_1.z.object({
+        id: zod_1.z.string(),
     }))
         .describe('Base64 encoded audio data or file id'),
     /**
      * The format of the audio.
      */
-    format: z.string().nullable().optional(),
+    format: zod_1.z.string().nullable().optional(),
     /**
      * The transcript of the audio.
      */
-    transcript: z.string().nullable().optional(),
+    transcript: zod_1.z.string().nullable().optional(),
 });
-export const ImageContent = SharedBase.extend({
-    type: z.literal('image'),
+exports.ImageContent = exports.SharedBase.extend({
+    type: zod_1.z.literal('image'),
     /**
      * The image input to the model. Could be base64 encoded image data or an object with a file ID.
      */
-    image: z.string().describe('Base64 encoded image data'),
+    image: zod_1.z.string().describe('Base64 encoded image data'),
 });
-export const ToolOutputText = SharedBase.extend({
-    type: z.literal('text'),
+exports.ToolOutputText = exports.SharedBase.extend({
+    type: zod_1.z.literal('text'),
     /**
      * The text output from the model.
      */
-    text: z.string(),
+    text: zod_1.z.string(),
 });
-export const ToolOutputImage = SharedBase.extend({
-    type: z.literal('image'),
+exports.ToolOutputImage = exports.SharedBase.extend({
+    type: zod_1.z.literal('image'),
     /**
      * The image data. Could be base64 encoded image data or an object with a file ID.
      */
-    data: z.string().describe('Base64 encoded image data'),
+    data: zod_1.z.string().describe('Base64 encoded image data'),
     /**
      * The media type of the image.
      */
-    mediaType: z.string().describe('IANA media type of the image'),
+    mediaType: zod_1.z.string().describe('IANA media type of the image'),
 });
-export const ComputerToolOutput = SharedBase.extend({
-    type: z.literal('computer_screenshot'),
+exports.ComputerToolOutput = exports.SharedBase.extend({
+    type: zod_1.z.literal('computer_screenshot'),
     /**
      * A base64 encoded image data or a URL representing the screenshot.
      */
-    data: z.string().describe('Base64 encoded image data or URL'),
+    data: zod_1.z.string().describe('Base64 encoded image data or URL'),
 });
-export const computerActions = z.discriminatedUnion('type', [
-    z.object({ type: z.literal('screenshot') }),
-    z.object({
-        type: z.literal('click'),
-        x: z.number(),
-        y: z.number(),
-        button: z.enum(['left', 'right', 'wheel', 'back', 'forward']),
+exports.computerActions = zod_1.z.discriminatedUnion('type', [
+    zod_1.z.object({ type: zod_1.z.literal('screenshot') }),
+    zod_1.z.object({
+        type: zod_1.z.literal('click'),
+        x: zod_1.z.number(),
+        y: zod_1.z.number(),
+        button: zod_1.z.enum(['left', 'right', 'wheel', 'back', 'forward']),
     }),
-    z.object({
-        type: z.literal('double_click'),
-        x: z.number(),
-        y: z.number(),
+    zod_1.z.object({
+        type: zod_1.z.literal('double_click'),
+        x: zod_1.z.number(),
+        y: zod_1.z.number(),
     }),
-    z.object({
-        type: z.literal('scroll'),
-        x: z.number(),
-        y: z.number(),
-        scroll_x: z.number(),
-        scroll_y: z.number(),
+    zod_1.z.object({
+        type: zod_1.z.literal('scroll'),
+        x: zod_1.z.number(),
+        y: zod_1.z.number(),
+        scroll_x: zod_1.z.number(),
+        scroll_y: zod_1.z.number(),
     }),
-    z.object({
-        type: z.literal('type'),
-        text: z.string(),
+    zod_1.z.object({
+        type: zod_1.z.literal('type'),
+        text: zod_1.z.string(),
     }),
-    z.object({ type: z.literal('wait') }),
-    z.object({
-        type: z.literal('move'),
-        x: z.number(),
-        y: z.number(),
+    zod_1.z.object({ type: zod_1.z.literal('wait') }),
+    zod_1.z.object({
+        type: zod_1.z.literal('move'),
+        x: zod_1.z.number(),
+        y: zod_1.z.number(),
     }),
-    z.object({
-        type: z.literal('keypress'),
-        keys: z.array(z.string()),
+    zod_1.z.object({
+        type: zod_1.z.literal('keypress'),
+        keys: zod_1.z.array(zod_1.z.string()),
     }),
-    z.object({
-        type: z.literal('drag'),
-        path: z.array(z.object({ x: z.number(), y: z.number() })),
+    zod_1.z.object({
+        type: zod_1.z.literal('drag'),
+        path: zod_1.z.array(zod_1.z.object({ x: zod_1.z.number(), y: zod_1.z.number() })),
     }),
 ]);
 // ----------------------------
 // Message types
 // ----------------------------
-export const AssistantContent = z.discriminatedUnion('type', [
-    OutputText,
-    Refusal,
-    AudioContent,
-    ImageContent,
+exports.AssistantContent = zod_1.z.discriminatedUnion('type', [
+    exports.OutputText,
+    exports.Refusal,
+    exports.AudioContent,
+    exports.ImageContent,
 ]);
-const MessageBase = ItemBase.extend({
+const MessageBase = exports.ItemBase.extend({
     /**
      * Any item without a type is treated as a message
      */
-    type: z.literal('message').optional(),
+    type: zod_1.z.literal('message').optional(),
 });
-export const AssistantMessageItem = MessageBase.extend({
+exports.AssistantMessageItem = MessageBase.extend({
     /**
      * Representing a message from the assistant (i.e. the model)
      */
-    role: z.literal('assistant'),
+    role: zod_1.z.literal('assistant'),
     /**
      * The status of the message.
      */
-    status: z.enum(['in_progress', 'completed', 'incomplete']),
+    status: zod_1.z.enum(['in_progress', 'completed', 'incomplete']),
     /**
      * The content of the message.
      */
-    content: z.array(AssistantContent),
+    content: zod_1.z.array(exports.AssistantContent),
 });
-export const UserContent = z.discriminatedUnion('type', [
-    InputText,
-    InputImage,
-    InputFile,
-    AudioContent,
+exports.UserContent = zod_1.z.discriminatedUnion('type', [
+    exports.InputText,
+    exports.InputImage,
+    exports.InputFile,
+    exports.AudioContent,
 ]);
-export const UserMessageItem = MessageBase.extend({
+exports.UserMessageItem = MessageBase.extend({
     // type: z.literal('message'),
     /**
      * Representing a message from the user
      */
-    role: z.literal('user'),
+    role: zod_1.z.literal('user'),
     /**
      * The content of the message.
      */
-    content: z.array(UserContent).or(z.string()),
+    content: zod_1.z.array(exports.UserContent).or(zod_1.z.string()),
 });
 const SystemMessageItem = MessageBase.extend({
     // type: z.literal('message'),
     /**
      * Representing a system message to the user
      */
-    role: z.literal('system'),
+    role: zod_1.z.literal('system'),
     /**
      * The content of the message.
      */
-    content: z.string(),
+    content: zod_1.z.string(),
 });
-export const MessageItem = z.discriminatedUnion('role', [
+exports.MessageItem = zod_1.z.discriminatedUnion('role', [
     SystemMessageItem,
-    AssistantMessageItem,
-    UserMessageItem,
+    exports.AssistantMessageItem,
+    exports.UserMessageItem,
 ]);
 // ----------------------------
 // Tool call types
 // ----------------------------
-export const HostedToolCallItem = ItemBase.extend({
-    type: z.literal('hosted_tool_call'),
+exports.HostedToolCallItem = exports.ItemBase.extend({
+    type: zod_1.z.literal('hosted_tool_call'),
     /**
      * The name of the hosted tool. For example `web_search_call` or `file_search_call`
      */
-    name: z.string().describe('The name of the hosted tool'),
+    name: zod_1.z.string().describe('The name of the hosted tool'),
     /**
      * The arguments of the hosted tool call.
      */
-    arguments: z
+    arguments: zod_1.z
         .string()
         .describe('The arguments of the hosted tool call')
         .optional(),
     /**
      * The status of the tool call.
      */
-    status: z.string().optional(),
+    status: zod_1.z.string().optional(),
     /**
      * The primary output of the tool call. Additional output might be in the `providerData` field.
      */
-    output: z.string().optional(),
+    output: zod_1.z.string().optional(),
 });
-export const FunctionCallItem = ItemBase.extend({
-    type: z.literal('function_call'),
+exports.FunctionCallItem = exports.ItemBase.extend({
+    type: zod_1.z.literal('function_call'),
     /**
      * The ID of the tool call. Required to match up the respective tool call result.
      */
-    callId: z.string().describe('The ID of the tool call'),
+    callId: zod_1.z.string().describe('The ID of the tool call'),
     /**
      * The name of the function.
      */
-    name: z.string().describe('The name of the function'),
+    name: zod_1.z.string().describe('The name of the function'),
     /**
      * The status of the function call.
      */
-    status: z.enum(['in_progress', 'completed', 'incomplete']).optional(),
+    status: zod_1.z.enum(['in_progress', 'completed', 'incomplete']).optional(),
     /**
      * The arguments of the function call.
      */
-    arguments: z.string(),
+    arguments: zod_1.z.string(),
 });
-export const FunctionCallResultItem = ItemBase.extend({
-    type: z.literal('function_call_result'),
+exports.FunctionCallResultItem = exports.ItemBase.extend({
+    type: zod_1.z.literal('function_call_result'),
     /**
      * The name of the tool that was called
      */
-    name: z.string().describe('The name of the tool'),
+    name: zod_1.z.string().describe('The name of the tool'),
     /**
      * The ID of the tool call. Required to match up the respective tool call result.
      */
-    callId: z.string().describe('The ID of the tool call'),
+    callId: zod_1.z.string().describe('The ID of the tool call'),
     /**
      * The status of the tool call.
      */
-    status: z.enum(['in_progress', 'completed', 'incomplete']),
+    status: zod_1.z.enum(['in_progress', 'completed', 'incomplete']),
     /**
      * The output of the tool call.
      */
-    output: z.discriminatedUnion('type', [ToolOutputText, ToolOutputImage]),
+    output: zod_1.z.discriminatedUnion('type', [exports.ToolOutputText, exports.ToolOutputImage]),
 });
-export const ComputerUseCallItem = ItemBase.extend({
-    type: z.literal('computer_call'),
+exports.ComputerUseCallItem = exports.ItemBase.extend({
+    type: zod_1.z.literal('computer_call'),
     /**
      * The ID of the computer call. Required to match up the respective computer call result.
      */
-    callId: z.string().describe('The ID of the computer call'),
+    callId: zod_1.z.string().describe('The ID of the computer call'),
     /**
      * The status of the computer call.
      */
-    status: z.enum(['in_progress', 'completed', 'incomplete']),
+    status: zod_1.z.enum(['in_progress', 'completed', 'incomplete']),
     /**
      * The action to be performed by the computer.
      */
-    action: computerActions,
+    action: exports.computerActions,
 });
-export const ComputerCallResultItem = ItemBase.extend({
-    type: z.literal('computer_call_result'),
+exports.ComputerCallResultItem = exports.ItemBase.extend({
+    type: zod_1.z.literal('computer_call_result'),
     /**
      * The ID of the computer call. Required to match up the respective computer call result.
      */
-    callId: z.string().describe('The ID of the computer call'),
+    callId: zod_1.z.string().describe('The ID of the computer call'),
     /**
      * The output of the computer call.
      */
-    output: ComputerToolOutput,
+    output: exports.ComputerToolOutput,
 });
-export const ToolCallItem = z.discriminatedUnion('type', [
-    ComputerUseCallItem,
-    FunctionCallItem,
-    HostedToolCallItem,
+exports.ToolCallItem = zod_1.z.discriminatedUnion('type', [
+    exports.ComputerUseCallItem,
+    exports.FunctionCallItem,
+    exports.HostedToolCallItem,
 ]);
 // ----------------------------
 // Special item types
 // ----------------------------
-export const ReasoningItem = SharedBase.extend({
-    id: z.string().optional(),
-    type: z.literal('reasoning'),
+exports.ReasoningItem = exports.SharedBase.extend({
+    id: zod_1.z.string().optional(),
+    type: zod_1.z.literal('reasoning'),
     /**
      * The user facing representation of the reasoning. Additional information might be in the `providerData` field.
      */
-    content: z.array(InputText),
+    content: zod_1.z.array(exports.InputText),
     /**
      * The raw reasoning text from the model.
      */
-    rawContent: z.array(ReasoningText).optional(),
+    rawContent: zod_1.z.array(exports.ReasoningText).optional(),
 });
 /**
  * This is a catch all for items that are not part of the protocol.
@@ -353,42 +356,42 @@ export const ReasoningItem = SharedBase.extend({
  *
  * This enables new features to be added to be added by a model provider without breaking the protocol.
  */
-export const UnknownItem = ItemBase.extend({
-    type: z.literal('unknown'),
+exports.UnknownItem = exports.ItemBase.extend({
+    type: zod_1.z.literal('unknown'),
 });
 // ----------------------------
 // Joined item types
 // ----------------------------
-export const OutputModelItem = z.discriminatedUnion('type', [
-    AssistantMessageItem,
-    HostedToolCallItem,
-    FunctionCallItem,
-    ComputerUseCallItem,
-    ReasoningItem,
-    UnknownItem,
+exports.OutputModelItem = zod_1.z.discriminatedUnion('type', [
+    exports.AssistantMessageItem,
+    exports.HostedToolCallItem,
+    exports.FunctionCallItem,
+    exports.ComputerUseCallItem,
+    exports.ReasoningItem,
+    exports.UnknownItem,
 ]);
-export const ModelItem = z.union([
-    UserMessageItem,
-    AssistantMessageItem,
+exports.ModelItem = zod_1.z.union([
+    exports.UserMessageItem,
+    exports.AssistantMessageItem,
     SystemMessageItem,
-    HostedToolCallItem,
-    FunctionCallItem,
-    ComputerUseCallItem,
-    FunctionCallResultItem,
-    ComputerCallResultItem,
-    ReasoningItem,
-    UnknownItem,
+    exports.HostedToolCallItem,
+    exports.FunctionCallItem,
+    exports.ComputerUseCallItem,
+    exports.FunctionCallResultItem,
+    exports.ComputerCallResultItem,
+    exports.ReasoningItem,
+    exports.UnknownItem,
 ]);
 // ----------------------------
 // Meta data types
 // ----------------------------
-export const UsageData = z.object({
-    requests: z.number().optional(),
-    inputTokens: z.number(),
-    outputTokens: z.number(),
-    totalTokens: z.number(),
-    inputTokensDetails: z.record(z.string(), z.number()).optional(),
-    outputTokensDetails: z.record(z.string(), z.number()).optional(),
+exports.UsageData = zod_1.z.object({
+    requests: zod_1.z.number().optional(),
+    inputTokens: zod_1.z.number(),
+    outputTokens: zod_1.z.number(),
+    totalTokens: zod_1.z.number(),
+    inputTokensDetails: zod_1.z.record(zod_1.z.string(), zod_1.z.number()).optional(),
+    outputTokensDetails: zod_1.z.record(zod_1.z.string(), zod_1.z.number()).optional(),
 });
 // ----------------------------
 // Stream event types
@@ -396,54 +399,54 @@ export const UsageData = z.object({
 /**
  * Event returned by the model when new output text is available to stream to the user.
  */
-export const StreamEventTextStream = SharedBase.extend({
-    type: z.literal('output_text_delta'),
+exports.StreamEventTextStream = exports.SharedBase.extend({
+    type: zod_1.z.literal('output_text_delta'),
     /**
      * The delta text that was streamed by the modelto the user.
      */
-    delta: z.string(),
+    delta: zod_1.z.string(),
 });
 /**
  * Event returned by the model when a new response is started.
  */
-export const StreamEventResponseStarted = SharedBase.extend({
-    type: z.literal('response_started'),
+exports.StreamEventResponseStarted = exports.SharedBase.extend({
+    type: zod_1.z.literal('response_started'),
 });
 /**
  * Event returned by the model when a response is completed.
  */
-export const StreamEventResponseCompleted = SharedBase.extend({
-    type: z.literal('response_done'),
+exports.StreamEventResponseCompleted = exports.SharedBase.extend({
+    type: zod_1.z.literal('response_done'),
     /**
      * The response from the model.
      */
-    response: SharedBase.extend({
+    response: exports.SharedBase.extend({
         /**
          * The ID of the response.
          */
-        id: z.string(),
+        id: zod_1.z.string(),
         /**
          * The usage data for the response.
          */
-        usage: UsageData,
+        usage: exports.UsageData,
         /**
          * The output from the model.
          */
-        output: z.array(OutputModelItem),
+        output: zod_1.z.array(exports.OutputModelItem),
     }),
 });
 /**
  * Event returned for every item that gets streamed to the model. Used to expose the raw events
  * from the model.
  */
-export const StreamEventGenericItem = SharedBase.extend({
-    type: z.literal('model'),
-    event: z.any().describe('The event from the model'),
+exports.StreamEventGenericItem = exports.SharedBase.extend({
+    type: zod_1.z.literal('model'),
+    event: zod_1.z.any().describe('The event from the model'),
 });
-export const StreamEvent = z.discriminatedUnion('type', [
-    StreamEventTextStream,
-    StreamEventResponseCompleted,
-    StreamEventResponseStarted,
-    StreamEventGenericItem,
+exports.StreamEvent = zod_1.z.discriminatedUnion('type', [
+    exports.StreamEventTextStream,
+    exports.StreamEventResponseCompleted,
+    exports.StreamEventResponseStarted,
+    exports.StreamEventGenericItem,
 ]);
 //# sourceMappingURL=protocol.js.map