@prompty/openai 2.0.0-alpha.1 → 2.0.0-alpha.4

package/README.md

@@ -1,87 +1,87 @@
-# @prompty/openai
-
-OpenAI provider for Prompty — executor and processor for the OpenAI API.
-
-## Installation
-
-```bash
-npm install @prompty/core @prompty/openai openai
-```
-
-## Usage
-
-Import `@prompty/openai` to auto-register the `openai` provider, then use `@prompty/core` as normal:
-
-```typescript
-import "@prompty/openai";
-import { run } from "@prompty/core";
-
-const result = await run("./chat.prompty", {
-  question: "What is quantum computing?",
-});
-```
-
-## `.prompty` Configuration
-
-Set `provider: openai` in your `.prompty` file:
-
-```prompty
----
-name: my-prompt
-model:
-  id: gpt-4o-mini
-  provider: openai
-  apiType: chat
-  connection:
-    kind: key
-    endpoint: ${env:OPENAI_BASE_URL}
-    apiKey: ${env:OPENAI_API_KEY}
-  options:
-    temperature: 0.7
-    maxOutputTokens: 1000
----
-system:
-You are a helpful assistant.
-
-user:
-{{question}}
-```
-
-## Supported API Types
-
-| `apiType` | Description |
-|-----------|-------------|
-| `chat` (default) | Chat completions via `client.chat.completions.create()` |
-| `embedding` | Embeddings via `client.embeddings.create()` |
-| `image` | Image generation via `client.images.generate()` |
-| `responses` | Responses API via `client.responses.create()` |
-
-## Streaming
-
-Enable streaming via `additionalProperties`:
-
-```prompty
-model:
-  options:
-    additionalProperties:
-      stream: true
-```
-
-Returns a `PromptyStream` that can be iterated asynchronously.
-
-## Exports
-
-| Export | Description |
-|--------|-------------|
-| `OpenAIExecutor` | Executor implementation for OpenAI |
-| `OpenAIProcessor` | Processor for OpenAI responses |
-| `processResponse` | Shared response processing helper |
-| `messageToWire` | Convert `Message` → OpenAI wire format |
-| `buildChatArgs` | Build chat completion arguments |
-| `buildEmbeddingArgs` | Build embedding arguments |
-| `buildImageArgs` | Build image generation arguments |
-| `buildResponsesArgs` | Build Responses API arguments |
-
-## License
-
-MIT
+# @prompty/openai
+
+OpenAI provider for Prompty — executor and processor for the OpenAI API.
+
+## Installation
+
+```bash
+npm install @prompty/core @prompty/openai openai
+```
+
+## Usage
+
+Import `@prompty/openai` to auto-register the `openai` provider, then use `@prompty/core` as normal:
+
+```typescript
+import "@prompty/openai";
+import { run } from "@prompty/core";
+
+const result = await run("./chat.prompty", {
+  question: "What is quantum computing?",
+});
+```
+
+## `.prompty` Configuration
+
+Set `provider: openai` in your `.prompty` file:
+
+```prompty
+---
+name: my-prompt
+model:
+  id: gpt-4o-mini
+  provider: openai
+  apiType: chat
+  connection:
+    kind: key
+    endpoint: ${env:OPENAI_BASE_URL}
+    apiKey: ${env:OPENAI_API_KEY}
+  options:
+    temperature: 0.7
+    maxOutputTokens: 1000
+---
+system:
+You are a helpful assistant.
+
+user:
+{{question}}
+```
+
+## Supported API Types
+
+| `apiType` | Description |
+|-----------|-------------|
+| `chat` (default) | Chat completions via `client.chat.completions.create()` |
+| `embedding` | Embeddings via `client.embeddings.create()` |
+| `image` | Image generation via `client.images.generate()` |
+| `responses` | Responses API via `client.responses.create()` |
+
+## Streaming
+
+Enable streaming via `additionalProperties`:
+
+```prompty
+model:
+  options:
+    additionalProperties:
+      stream: true
+```
+
+Returns a `PromptyStream` that can be iterated asynchronously.
+
+## Exports
+
+| Export | Description |
+|--------|-------------|
+| `OpenAIExecutor` | Executor implementation for OpenAI |
+| `OpenAIProcessor` | Processor for OpenAI responses |
+| `processResponse` | Shared response processing helper |
+| `messageToWire` | Convert `Message` → OpenAI wire format |
+| `buildChatArgs` | Build chat completion arguments |
+| `buildEmbeddingArgs` | Build embedding arguments |
+| `buildImageArgs` | Build image generation arguments |
+| `buildResponsesArgs` | Build Responses API arguments |
+
+## License
+
+MIT

package/dist/index.cjs

@@ -43,11 +43,13 @@ module.exports = __toCommonJS(index_exports);
 
 // src/executor.ts
 var import_openai = __toESM(require("openai"), 1);
-var import_core = require("@prompty/core");
 var import_core2 = require("@prompty/core");
 var import_core3 = require("@prompty/core");
+var import_core4 = require("@prompty/core");
 
 // src/wire.ts
+var import_core = require("@prompty/core");
+var import_node_path = require("path");
 function messageToWire(msg) {
   const wire = { role: msg.role };
   for (const [k, v] of Object.entries(msg.metadata)) {
@@ -77,13 +79,26 @@ function partToWire(part) {
         type: "input_audio",
         input_audio: {
           data: part.source,
-          ...part.mediaType && { format: part.mediaType }
+          ...part.mediaType && { format: mimeToAudioFormat(part.mediaType) }
         }
       };
     case "file":
       return { type: "file", file: { url: part.source } };
   }
 }
+var AUDIO_MIME_MAP = {
+  "audio/wav": "wav",
+  "audio/mpeg": "mp3",
+  "audio/mp3": "mp3",
+  "audio/mp4": "mp4",
+  "audio/ogg": "ogg",
+  "audio/flac": "flac",
+  "audio/webm": "webm",
+  "audio/pcm": "pcm"
+};
+function mimeToAudioFormat(mediaType) {
+  return AUDIO_MIME_MAP[mediaType.toLowerCase()] ?? mediaType;
+}
 function buildChatArgs(agent, messages) {
   const model = agent.model?.id || "gpt-4";
   const wireMessages = messages.map(messageToWire);
@@ -104,10 +119,24 @@ function buildChatArgs(agent, messages) {
 }
 function buildEmbeddingArgs(agent, data) {
   const model = agent.model?.id || "text-embedding-ada-002";
-  const args = {
-    input: Array.isArray(data) ? data : [data],
-    model
-  };
+  let input;
+  if (Array.isArray(data)) {
+    const texts = data.map((item) => {
+      if (typeof item === "string") return item;
+      if (item && typeof item === "object" && "text" in item) return item.text;
+      if (item && typeof item === "object" && "toTextContent" in item) {
+        const content = item.toTextContent();
+        return typeof content === "string" ? content : String(content);
+      }
+      return String(item);
+    });
+    input = texts.length === 1 ? texts[0] : texts;
+  } else if (typeof data === "string") {
+    input = data;
+  } else {
+    input = String(data);
+  }
+  const args = { input, model };
   const extra = agent.model?.options?.additionalProperties;
   if (extra) {
     for (const [k, v] of Object.entries(extra)) {
@@ -159,7 +188,7 @@ function buildOptions(agent) {
   if (opts.topP !== void 0) result.top_p = opts.topP;
   if (opts.frequencyPenalty !== void 0) result.frequency_penalty = opts.frequencyPenalty;
   if (opts.presencePenalty !== void 0) result.presence_penalty = opts.presencePenalty;
-  if (opts.stopSequences !== void 0) result.stop = opts.stopSequences;
+  if (opts.stopSequences !== void 0 && opts.stopSequences.length > 0) result.stop = opts.stopSequences;
   if (opts.seed !== void 0) result.seed = opts.seed;
   if (opts.additionalProperties) {
     for (const [k, v] of Object.entries(opts.additionalProperties)) {
@@ -220,24 +249,64 @@ function toolsToWire(agent) {
   if (!tools || tools.length === 0) return [];
   const result = [];
   for (const t of tools) {
-    if (t.kind !== "function") continue;
-    const funcDef = { name: t.name };
-    if (t.description) funcDef.description = t.description;
-    const params = t.parameters;
-    if (params && Array.isArray(params)) {
-      funcDef.parameters = schemaToWire(params);
-    }
-    const strict = t.strict;
-    if (strict) {
-      funcDef.strict = true;
-      if (funcDef.parameters) {
-        funcDef.parameters.additionalProperties = false;
+    if (t.kind === "function") {
+      const funcDef = { name: t.name };
+      if (t.description) funcDef.description = t.description;
+      const boundNames = new Set((t.bindings ?? []).map((b) => b.name));
+      let params = t.parameters;
+      if (params && Array.isArray(params)) {
+        if (boundNames.size > 0) {
+          params = params.filter((p) => !boundNames.has(p.name));
+        }
+        funcDef.parameters = schemaToWire(params);
+      }
+      const strict = t.strict;
+      if (strict) {
+        funcDef.strict = true;
+        if (funcDef.parameters) {
+          funcDef.parameters.additionalProperties = false;
+        }
       }
+      result.push({ type: "function", function: funcDef });
+    } else if (t.kind === "prompty") {
+      const funcDef = projectPromptyTool(t, agent);
+      result.push({ type: "function", function: funcDef });
     }
-    result.push({ type: "function", function: funcDef });
   }
   return result;
 }
+function projectPromptyTool(tool, parent) {
+  const toolPath = tool.path;
+  if (!toolPath) {
+    throw new Error(`PromptyTool '${tool.name}' has no path`);
+  }
+  const parentPath = (parent.metadata ?? {}).__source_path;
+  if (!parentPath) {
+    throw new Error(
+      `Cannot resolve PromptyTool '${tool.name}': parent agent has no __source_path in metadata`
+    );
+  }
+  const childPath = (0, import_node_path.resolve)((0, import_node_path.dirname)(parentPath), toolPath);
+  const child = (0, import_core.load)(childPath);
+  const funcDef = { name: tool.name };
+  funcDef.description = tool.description || child.description || "";
+  const bindings = tool.bindings;
+  const boundNames = new Set((bindings ?? []).map((b) => b.name));
+  const childInputs = child.inputs ?? [];
+  let params = childInputs;
+  if (boundNames.size > 0) {
+    params = params.filter((p) => !boundNames.has(p.name));
+  }
+  funcDef.parameters = schemaToWire(params);
+  const strict = tool.strict;
+  if (strict) {
+    funcDef.strict = true;
+    if (funcDef.parameters) {
+      funcDef.parameters.additionalProperties = false;
+    }
+  }
+  return funcDef;
+}
 function outputSchemaToWire(agent) {
   const outputs = agent.outputs;
   if (!outputs || outputs.length === 0) return null;
@@ -248,7 +317,7 @@ function outputSchemaToWire(agent) {
     properties[prop.name] = propertyToJsonSchema(prop);
     required.push(prop.name);
   }
-  const name = (agent.name || "response").toLowerCase().replace(/[\s-]/g, "_");
+  const name = "structured_output";
   return {
     type: "json_schema",
     json_schema: {
@@ -295,6 +364,9 @@ function buildResponsesArgs(agent, messages) {
 }
 function messageToResponsesInput(msg) {
   const content = msg.toTextContent();
+  if (msg.metadata.responses_function_call) {
+    return msg.metadata.responses_function_call;
+  }
   if (msg.metadata.tool_call_id) {
     return {
       type: "function_call_output",
@@ -326,24 +398,41 @@ function responsesToolsToWire(agent) {
   if (!tools || tools.length === 0) return [];
   const result = [];
   for (const t of tools) {
-    if (t.kind !== "function") continue;
-    const tool = {
-      type: "function",
-      name: t.name
-    };
-    if (t.description) tool.description = t.description;
-    const params = t.parameters;
-    if (params && Array.isArray(params)) {
-      tool.parameters = schemaToWire(params);
-    }
-    const strict = t.strict;
-    if (strict) {
-      tool.strict = true;
-      if (tool.parameters) {
-        tool.parameters.additionalProperties = false;
+    if (t.kind === "function") {
+      const tool = {
+        type: "function",
+        name: t.name
+      };
+      if (t.description) tool.description = t.description;
+      const params = t.parameters;
+      if (params && Array.isArray(params)) {
+        tool.parameters = schemaToWire(params);
+      }
+      const strict = t.strict;
+      if (strict) {
+        tool.strict = true;
+        if (tool.parameters) {
+          tool.parameters.additionalProperties = false;
+        }
       }
+      result.push(tool);
+    } else if (t.kind === "prompty") {
+      const projected = projectPromptyTool(t, agent);
+      const tool = {
+        type: "function",
+        name: projected.name
+      };
+      if (projected.description) tool.description = projected.description;
+      if (projected.parameters) tool.parameters = projected.parameters;
+      const strict = projected.strict;
+      if (strict) {
+        tool.strict = true;
+        if (tool.parameters) {
+          tool.parameters.additionalProperties = false;
+        }
+      }
+      result.push(tool);
     }
-    result.push(tool);
   }
   return result;
 }
@@ -357,7 +446,7 @@ function outputSchemaToResponsesWire(agent) {
     properties[prop.name] = propertyToJsonSchema(prop);
     required.push(prop.name);
   }
-  const name = (agent.name || "response").toLowerCase().replace(/[\s-]/g, "_");
+  const name = "structured_output";
   return {
     format: {
       type: "json_schema",
@@ -376,18 +465,18 @@ function outputSchemaToResponsesWire(agent) {
 // src/executor.ts
 var OpenAIExecutor = class {
   async execute(agent, messages) {
-    return (0, import_core3.traceSpan)("OpenAIExecutor", async (emit) => {
+    return (0, import_core4.traceSpan)("OpenAIExecutor", async (emit) => {
       emit("signature", "prompty.openai.executor.OpenAIExecutor.invoke");
       emit("inputs", { data: messages });
       const client = this.resolveClient(agent);
       const clientName = client.constructor?.name ?? "OpenAI";
-      await (0, import_core3.traceSpan)(clientName, async (ctorEmit) => {
+      await (0, import_core4.traceSpan)(clientName, async (ctorEmit) => {
         ctorEmit("signature", `${clientName}.ctor`);
         const conn = agent.model?.connection;
-        if (conn instanceof import_core.ReferenceConnection) {
+        if (conn instanceof import_core2.ReferenceConnection) {
           ctorEmit("inputs", { source: "reference", name: conn.name });
         } else {
-          ctorEmit("inputs", (0, import_core3.sanitizeValue)("ctor", this.clientKwargs(agent)));
+          ctorEmit("inputs", (0, import_core4.sanitizeValue)("ctor", this.clientKwargs(agent)));
         }
         ctorEmit("result", clientName);
       });
@@ -400,18 +489,17 @@ var OpenAIExecutor = class {
   /** Dispatch to the appropriate API and trace the call. */
   async executeApiCall(client, clientName, agent, messages, apiType) {
     switch (apiType) {
-      case "chat":
-      case "agent": {
+      case "chat": {
         const args = buildChatArgs(agent, messages);
         const isStreaming = !!args.stream;
-        return (0, import_core3.traceSpan)("create", async (callEmit) => {
+        return (0, import_core4.traceSpan)("create", async (callEmit) => {
           callEmit("signature", `${clientName}.chat.completions.create`);
-          callEmit("inputs", (0, import_core3.sanitizeValue)("create", args));
+          callEmit("inputs", (0, import_core4.sanitizeValue)("create", args));
           const result = await client.chat.completions.create(
             args
           );
           if (isStreaming) {
-            return new import_core.PromptyStream(`${clientName}Executor`, result);
+            return new import_core2.PromptyStream(`${clientName}Executor`, result);
           }
           callEmit("result", result);
           return result;
@@ -419,9 +507,9 @@ var OpenAIExecutor = class {
       }
       case "embedding": {
         const args = buildEmbeddingArgs(agent, messages);
-        return (0, import_core3.traceSpan)("create", async (callEmit) => {
+        return (0, import_core4.traceSpan)("create", async (callEmit) => {
           callEmit("signature", `${clientName}.embeddings.create`);
-          callEmit("inputs", (0, import_core3.sanitizeValue)("create", args));
+          callEmit("inputs", (0, import_core4.sanitizeValue)("create", args));
           const result = await client.embeddings.create(
             args
           );
@@ -431,9 +519,9 @@ var OpenAIExecutor = class {
       }
       case "image": {
         const args = buildImageArgs(agent, messages);
-        return (0, import_core3.traceSpan)("generate", async (callEmit) => {
+        return (0, import_core4.traceSpan)("generate", async (callEmit) => {
           callEmit("signature", `${clientName}.images.generate`);
-          callEmit("inputs", (0, import_core3.sanitizeValue)("generate", args));
+          callEmit("inputs", (0, import_core4.sanitizeValue)("generate", args));
           const result = await client.images.generate(
             args
           );
@@ -444,14 +532,14 @@ var OpenAIExecutor = class {
       case "responses": {
         const args = buildResponsesArgs(agent, messages);
         const isStreaming = !!args.stream;
-        return (0, import_core3.traceSpan)("create", async (callEmit) => {
+        return (0, import_core4.traceSpan)("create", async (callEmit) => {
           callEmit("signature", `${clientName}.responses.create`);
-          callEmit("inputs", (0, import_core3.sanitizeValue)("create", args));
+          callEmit("inputs", (0, import_core4.sanitizeValue)("create", args));
           const result = await client.responses.create(
             args
           );
           if (isStreaming) {
-            return new import_core.PromptyStream(`${clientName}Executor`, result);
+            return new import_core2.PromptyStream(`${clientName}Executor`, result);
           }
           callEmit("result", result);
           return result;
@@ -463,8 +551,8 @@ var OpenAIExecutor = class {
   }
   resolveClient(agent) {
     const conn = agent.model?.connection;
-    if (conn instanceof import_core.ReferenceConnection) {
-      return (0, import_core2.getConnection)(conn.name);
+    if (conn instanceof import_core2.ReferenceConnection) {
+      return (0, import_core3.getConnection)(conn.name);
     }
     const kwargs = this.clientKwargs(agent);
     return new import_openai.default(kwargs);
@@ -472,19 +560,23 @@ var OpenAIExecutor = class {
   clientKwargs(agent) {
     const kwargs = {};
     const conn = agent.model?.connection;
-    if (conn instanceof import_core.ApiKeyConnection) {
+    if (conn instanceof import_core2.ApiKeyConnection) {
       if (conn.apiKey) kwargs.apiKey = conn.apiKey;
       if (conn.endpoint) kwargs.baseURL = conn.endpoint;
+    } else if (conn) {
+      throw new Error(
+        `Connection kind '${conn.kind}' is not supported by the OpenAI executor. Use 'key' for API key auth or 'reference' with registerConnection() for pre-configured clients.`
+      );
     }
     return kwargs;
   }
 };
 
 // src/processor.ts
-var import_core4 = require("@prompty/core");
+var import_core5 = require("@prompty/core");
 var OpenAIProcessor = class {
   async process(agent, response) {
-    return (0, import_core4.traceSpan)("OpenAIProcessor", async (emit) => {
+    return (0, import_core5.traceSpan)("OpenAIProcessor", async (emit) => {
       emit("signature", "prompty.openai.processor.OpenAIProcessor.invoke");
       emit("inputs", { data: response });
       const result = processResponse(agent, response);
@@ -628,7 +720,11 @@ function processChatCompletion(agent, response) {
     });
   }
   const content = message.content;
-  if (content === null) return null;
+  if (content === null) {
+    const refusal = message.refusal;
+    if (typeof refusal === "string") return refusal;
+    return null;
+  }
   if (agent.outputs && agent.outputs.length > 0) {
     try {
       return JSON.parse(content);
@@ -654,9 +750,9 @@ function processImage(response) {
 }
 
 // src/index.ts
-var import_core5 = require("@prompty/core");
-(0, import_core5.registerExecutor)("openai", new OpenAIExecutor());
-(0, import_core5.registerProcessor)("openai", new OpenAIProcessor());
+var import_core6 = require("@prompty/core");
+(0, import_core6.registerExecutor)("openai", new OpenAIExecutor());
+(0, import_core6.registerProcessor)("openai", new OpenAIProcessor());
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   OpenAIExecutor,