@jerome-benoit/sap-ai-provider 3.0.0 → 4.0.0-rc.1

package/dist/index.js

@@ -24771,7 +24771,7 @@ var require_form_data = __commonJS({
     var parseUrl = __require("url").parse;
     var fs = __require("fs");
     var Stream = __require("stream").Stream;
-    var crypto = __require("crypto");
+    var crypto2 = __require("crypto");
     var mime = require_mime_types();
     var asynckit = require_asynckit();
     var setToStringTag = require_es_set_tostringtag();
@@ -24977,7 +24977,7 @@ var require_form_data = __commonJS({
       return Buffer.concat([dataBuffer, Buffer.from(this._lastBoundary())]);
     };
     FormData2.prototype._generateBoundary = function() {
-      this._boundary = "--------------------------" + crypto.randomBytes(12).toString("hex");
+      this._boundary = "--------------------------" + crypto2.randomBytes(12).toString("hex");
     };
     FormData2.prototype.getLengthSync = function() {
       var knownLength = this._overheadLength + this._valueLength;
@@ -26207,7 +26207,7 @@ var require_axios = __commonJS({
   "node_modules/axios/dist/node/axios.cjs"(exports, module) {
     "use strict";
     var FormData$1 = require_form_data();
-    var crypto = __require("crypto");
+    var crypto2 = __require("crypto");
     var url = __require("url");
     var proxyFromEnv = require_proxy_from_env();
     var http = __require("http");
@@ -26222,7 +26222,7 @@ var require_axios = __commonJS({
       return e && typeof e === "object" && "default" in e ? e : { "default": e };
     }
     var FormData__default = /* @__PURE__ */ _interopDefaultLegacy(FormData$1);
-    var crypto__default = /* @__PURE__ */ _interopDefaultLegacy(crypto);
+    var crypto__default = /* @__PURE__ */ _interopDefaultLegacy(crypto2);
     var url__default = /* @__PURE__ */ _interopDefaultLegacy(url);
     var proxyFromEnv__default = /* @__PURE__ */ _interopDefaultLegacy(proxyFromEnv);
     var http__default = /* @__PURE__ */ _interopDefaultLegacy(http);
@@ -29888,12 +29888,14 @@ function convertToSAPMessages(prompt, options = {}) {
       }
       case "tool": {
         for (const part of message.content) {
-          const toolMessage = {
-            role: "tool",
-            tool_call_id: part.toolCallId,
-            content: JSON.stringify(part.output)
-          };
-          messages.push(toolMessage);
+          if (part.type === "tool-result") {
+            const toolMessage = {
+              role: "tool",
+              tool_call_id: part.toolCallId,
+              content: JSON.stringify(part.output)
+            };
+            messages.push(toolMessage);
+          }
         }
         break;
       }
@@ -30062,6 +30064,16 @@ See: https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/create-serv
 }
 
 // src/sap-ai-chat-language-model.ts
+var StreamIdGenerator = class {
+  /**
+   * Generates a unique ID for a text block.
+   *
+   * @returns RFC 4122-compliant UUID string
+   */
+  generateTextBlockId() {
+    return crypto.randomUUID();
+  }
+};
 function validateModelParameters(params, warnings) {
   if (params.temperature !== void 0 && (params.temperature < 0 || params.temperature > 2)) {
     warnings.push({
@@ -30153,7 +30165,7 @@ function buildSAPToolParameters(schema) {
   };
 }
 var SAPAIChatLanguageModel = class {
-  specificationVersion = "v2";
+  specificationVersion = "v3";
   modelId;
   config;
   settings;
@@ -30176,10 +30188,14 @@ var SAPAIChatLanguageModel = class {
    * Checks if a URL is supported for file/image uploads.
    *
    * @param url - The URL to check
-   * @returns True if the URL protocol is HTTPS or data (content-type rules are enforced via supportedUrls)
+   * @returns True if the URL protocol is HTTPS or data with valid image format
    */
   supportsUrl(url) {
-    return url.protocol === "https:" || url.protocol === "data:";
+    if (url.protocol === "https:") return true;
+    if (url.protocol === "data:") {
+      return /^data:image\//i.test(url.href);
+    }
+    return false;
   }
   /**
    * Returns supported URL patterns for different content types.
@@ -30192,9 +30208,45 @@ var SAPAIChatLanguageModel = class {
     };
   }
   /**
-   * Gets the provider identifier.
+   * Generates text completion using SAP AI Core's Orchestration API.
+   *
+   * This method implements the `LanguageModelV3.doGenerate` interface,
+   * providing synchronous (non-streaming) text generation with support for:
+   * - Multi-turn conversations with system/user/assistant messages
+   * - Tool calling (function calling) with structured outputs
+   * - Multi-modal inputs (text + images)
+   * - Data masking via SAP DPI
+   * - Content filtering via Azure Content Safety or Llama Guard
+   *
+   * **Return Structure:**
+   * - Finish reason: `{ unified: string, raw?: string }`
+   * - Usage: Nested structure with token breakdown `{ inputTokens: { total, ... }, outputTokens: { total, ... } }`
+   * - Warnings: Array of warnings with `type` and optional `feature` field
+   *
+   * @param options - Generation options including prompt, tools, temperature, etc.
+   * @returns Promise resolving to generation result with content, usage, and metadata
+   *
+   * @throws {InvalidPromptError} If prompt format is invalid
+   * @throws {InvalidArgumentError} If arguments are malformed
+   * @throws {APICallError} If the SAP AI Core API call fails
+   *
+   * @example
+   * ```typescript
+   * const result = await model.doGenerate({
+   *   prompt: [
+   *     { role: 'user', content: [{ type: 'text', text: 'Hello!' }] }
+   *   ],
+   *   temperature: 0.7,
+   *   maxTokens: 100
+   * });
+   *
+   * console.log(result.content); // Array of V3 content parts
+   * console.log(result.finishReason.unified); // "stop", "length", "tool-calls", etc.
+   * console.log(result.usage.inputTokens.total); // Total input tokens
+   * ```
    *
-   * @returns The provider name ('sap-ai')
+   * @since 1.0.0
+   * @since 4.0.0 Updated to LanguageModelV3 interface
    */
   get provider() {
     return this.config.provider;
@@ -30261,11 +30313,11 @@ var SAPAIChatLanguageModel = class {
               const schemaRecord = jsonSchema;
               delete schemaRecord.$schema;
               parameters = buildSAPToolParameters(schemaRecord);
-            } catch {
+            } catch (error) {
               warnings.push({
-                type: "unsupported-tool",
-                tool,
-                details: "Failed to convert tool Zod schema to JSON Schema. Falling back to empty object schema."
+                type: "unsupported",
+                feature: `tool schema conversion for ${tool.name}`,
+                details: `Failed to convert tool Zod schema: ${error instanceof Error ? error.message : String(error)}. Falling back to empty object schema.`
               });
               parameters = buildSAPToolParameters({});
             }
@@ -30289,8 +30341,9 @@ var SAPAIChatLanguageModel = class {
           };
         } else {
           warnings.push({
-            type: "unsupported-tool",
-            tool
+            type: "unsupported",
+            feature: `tool type for ${tool.name}`,
+            details: "Only 'function' tool type is supported."
           });
           return null;
         }
@@ -30342,8 +30395,8 @@ var SAPAIChatLanguageModel = class {
     );
     if (options.toolChoice && options.toolChoice.type !== "auto") {
       warnings.push({
-        type: "unsupported-setting",
-        setting: "toolChoice",
+        type: "unsupported",
+        feature: "toolChoice",
         details: `SAP AI SDK does not support toolChoice '${options.toolChoice.type}'. Using default 'auto' behavior.`
       });
     }
@@ -30403,7 +30456,7 @@ var SAPAIChatLanguageModel = class {
   /**
    * Generates a single completion (non-streaming).
    *
-   * This method implements the `LanguageModelV2.doGenerate` interface,
+   * This method implements the `LanguageModelV3.doGenerate` interface,
    * sending a request to SAP AI Core and returning the complete response.
    *
    * **Features:**
@@ -30411,6 +30464,13 @@ var SAPAIChatLanguageModel = class {
    * - Multi-modal input (text + images)
    * - Data masking (if configured)
    * - Content filtering (if configured)
+   * - Abort signal support (via Promise.race)
+   *
+   * **Note on Abort Signal:**
+   * The abort signal implementation uses Promise.race to reject the promise when
+   * the signal is aborted. However, this does not cancel the underlying HTTP request
+   * to SAP AI Core - the request continues executing on the server. This is a
+   * limitation of the SAP AI SDK's chatCompletion API.
    *
    * @param options - Generation options including prompt, tools, and settings
    * @returns Promise resolving to the generation result with content, usage, and metadata
@@ -30483,7 +30543,7 @@ var SAPAIChatLanguageModel = class {
         Object.entries(responseHeadersRaw).flatMap(([key, value]) => {
           if (typeof value === "string") return [[key, value]];
           if (Array.isArray(value)) {
-            const strings = value.filter((item) => typeof item === "string").join(",");
+            const strings = value.filter((item) => typeof item === "string").join("; ");
             return strings.length > 0 ? [[key, strings]] : [];
           }
           if (typeof value === "number" || typeof value === "boolean") {
@@ -30524,9 +30584,17 @@ var SAPAIChatLanguageModel = class {
         content,
         finishReason,
         usage: {
-          inputTokens: tokenUsage.prompt_tokens,
-          outputTokens: tokenUsage.completion_tokens,
-          totalTokens: tokenUsage.total_tokens
+          inputTokens: {
+            total: tokenUsage.prompt_tokens,
+            noCache: tokenUsage.prompt_tokens,
+            cacheRead: void 0,
+            cacheWrite: void 0
+          },
+          outputTokens: {
+            total: tokenUsage.completion_tokens,
+            text: tokenUsage.completion_tokens,
+            reasoning: void 0
+          }
         },
         providerMetadata: {
           "sap-ai": {
@@ -30557,19 +30625,28 @@ var SAPAIChatLanguageModel = class {
   /**
    * Generates a streaming completion.
    *
-   * This method implements the `LanguageModelV2.doStream` interface,
+   * This method implements the `LanguageModelV3.doStream` interface,
    * sending a streaming request to SAP AI Core and returning a stream of response parts.
    *
    * **Stream Events:**
-   * - `stream-start` - Stream initialization
+   * - `stream-start` - Stream initialization with warnings
    * - `response-metadata` - Response metadata (model, timestamp)
-   * - `text-start` - Text generation starts
-   * - `text-delta` - Incremental text chunks
-   * - `text-end` - Text generation completes
-   * - `tool-call` - Tool call detected
+   * - `text-start` - Text block begins (with unique ID)
+   * - `text-delta` - Incremental text chunks (with block ID)
+   * - `text-end` - Text block completes (with accumulated text)
+   * - `tool-input-start` - Tool input begins
+   * - `tool-input-delta` - Tool input chunk
+   * - `tool-input-end` - Tool input completes
+   * - `tool-call` - Complete tool call
    * - `finish` - Stream completes with usage and finish reason
    * - `error` - Error occurred
    *
+   * **Stream Structure:**
+   * - Text blocks have explicit lifecycle with unique IDs
+   * - Finish reason format: `{ unified: string, raw?: string }`
+   * - Usage format: `{ inputTokens: { total, ... }, outputTokens: { total, ... } }`
+   * - Warnings only in `stream-start` event
+   *
    * @param options - Streaming options including prompt, tools, and settings
    * @returns Promise resolving to stream and request metadata
    *
@@ -30585,8 +30662,13 @@ var SAPAIChatLanguageModel = class {
    *   if (part.type === 'text-delta') {
    *     process.stdout.write(part.delta);
    *   }
+   *   if (part.type === 'text-end') {
+   *     console.log('Block complete:', part.id, part.text);
+   *   }
    * }
    * ```
+   *
+   * @since 4.0.0
    */
   async doStream(options) {
     try {
@@ -30614,12 +30696,25 @@ var SAPAIChatLanguageModel = class {
         options.abortSignal,
         { promptTemplating: { include_usage: true } }
       );
+      const idGenerator = new StreamIdGenerator();
+      let textBlockId = null;
       const streamState = {
-        finishReason: "unknown",
+        finishReason: {
+          unified: "other",
+          raw: void 0
+        },
         usage: {
-          inputTokens: void 0,
-          outputTokens: void 0,
-          totalTokens: void 0
+          inputTokens: {
+            total: void 0,
+            noCache: void 0,
+            cacheRead: void 0,
+            cacheWrite: void 0
+          },
+          outputTokens: {
+            total: void 0,
+            text: void 0,
+            reasoning: void 0
+          }
         },
         isFirstChunk: true,
         activeText: false
@@ -30647,19 +30742,25 @@ var SAPAIChatLanguageModel = class {
               }
               const deltaToolCalls = chunk.getDeltaToolCalls();
               if (Array.isArray(deltaToolCalls) && deltaToolCalls.length > 0) {
-                streamState.finishReason = "tool-calls";
+                streamState.finishReason = {
+                  unified: "tool-calls",
+                  raw: void 0
+                };
               }
               const deltaContent = chunk.getDeltaContent();
-              if (typeof deltaContent === "string" && deltaContent.length > 0 && streamState.finishReason !== "tool-calls") {
+              if (typeof deltaContent === "string" && deltaContent.length > 0 && streamState.finishReason.unified !== "tool-calls") {
                 if (!streamState.activeText) {
-                  controller.enqueue({ type: "text-start", id: "0" });
+                  textBlockId = idGenerator.generateTextBlockId();
+                  controller.enqueue({ type: "text-start", id: textBlockId });
                   streamState.activeText = true;
                 }
-                controller.enqueue({
-                  type: "text-delta",
-                  id: "0",
-                  delta: deltaContent
-                });
+                if (textBlockId) {
+                  controller.enqueue({
+                    type: "text-delta",
+                    id: textBlockId,
+                    delta: deltaContent
+                  });
+                }
               }
               if (Array.isArray(deltaToolCalls) && deltaToolCalls.length > 0) {
                 for (const toolCallChunk of deltaToolCalls) {
@@ -30709,7 +30810,7 @@ var SAPAIChatLanguageModel = class {
               const chunkFinishReason = chunk.getFinishReason();
               if (chunkFinishReason) {
                 streamState.finishReason = mapFinishReason(chunkFinishReason);
-                if (streamState.finishReason === "tool-calls") {
+                if (streamState.finishReason.unified === "tool-calls") {
                   const toolCalls2 = Array.from(toolCallsInProgress.values());
                   for (const tc of toolCalls2) {
                     if (tc.didEmitCall) {
@@ -30738,8 +30839,8 @@ var SAPAIChatLanguageModel = class {
                       input: tc.arguments
                     });
                   }
-                  if (streamState.activeText) {
-                    controller.enqueue({ type: "text-end", id: "0" });
+                  if (streamState.activeText && textBlockId) {
+                    controller.enqueue({ type: "text-end", id: textBlockId });
                     streamState.activeText = false;
                   }
                 }
@@ -30775,20 +30876,24 @@ var SAPAIChatLanguageModel = class {
                 input: tc.arguments
               });
             }
-            if (streamState.activeText) {
-              controller.enqueue({ type: "text-end", id: "0" });
+            if (streamState.activeText && textBlockId) {
+              controller.enqueue({ type: "text-end", id: textBlockId });
             }
             const finalFinishReason = streamResponse.getFinishReason();
             if (finalFinishReason) {
               streamState.finishReason = mapFinishReason(finalFinishReason);
             } else if (didEmitAnyToolCalls) {
-              streamState.finishReason = "tool-calls";
+              streamState.finishReason = {
+                unified: "tool-calls",
+                raw: void 0
+              };
             }
             const finalUsage = streamResponse.getTokenUsage();
             if (finalUsage) {
-              streamState.usage.inputTokens = finalUsage.prompt_tokens;
-              streamState.usage.outputTokens = finalUsage.completion_tokens;
-              streamState.usage.totalTokens = finalUsage.total_tokens;
+              streamState.usage.inputTokens.total = finalUsage.prompt_tokens;
+              streamState.usage.inputTokens.noCache = finalUsage.prompt_tokens;
+              streamState.usage.outputTokens.total = finalUsage.completion_tokens;
+              streamState.usage.outputTokens.text = finalUsage.completion_tokens;
             }
             controller.enqueue({
               type: "finish",
@@ -30819,8 +30924,7 @@ var SAPAIChatLanguageModel = class {
         stream: transformedStream,
         request: {
           body: requestBody
-        },
-        warnings: warningsOut
+        }
       };
     } catch (error) {
       throw convertToAISDKError(error, {
@@ -30832,27 +30936,28 @@ var SAPAIChatLanguageModel = class {
   }
 };
 function mapFinishReason(reason) {
-  if (!reason) return "unknown";
+  const raw = reason;
+  if (!reason) return { unified: "other", raw };
   switch (reason.toLowerCase()) {
     case "stop":
     case "end_turn":
     case "stop_sequence":
     case "eos":
-      return "stop";
+      return { unified: "stop", raw };
     case "length":
     case "max_tokens":
     case "max_tokens_reached":
-      return "length";
+      return { unified: "length", raw };
     case "tool_calls":
     case "tool_call":
     case "function_call":
-      return "tool-calls";
+      return { unified: "tool-calls", raw };
     case "content_filter":
-      return "content-filter";
+      return { unified: "content-filter", raw };
     case "error":
-      return "error";
+      return { unified: "error", raw };
     default:
-      return "other";
+      return { unified: "other", raw };
   }
 }