@ai-sdk/openai 4.0.54 → 4.0.55

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @ai-sdk/openai
 
+## 4.0.55
+
+### Patch Changes
+
+- 3fc40db: feat(openai): implement `getFileMetadata`, `downloadFile` (streaming), and `deleteFile` on the OpenAI files interface, support streaming uploads via `{ type: 'stream' }` data, expose `byteSize`/`createdAt`/`expiresAt` on upload results, and thread `abortSignal`/`headers` through all file operations; blank and dot-segment file ids are rejected/encoded so they cannot retarget request paths
+- Updated dependencies [5190b67]
+  - @ai-sdk/provider@4.0.10
+  - @ai-sdk/provider-utils@5.0.35
+
 ## 4.0.54
 
 ### Patch Changes

package/dist/index.js

@@ -2043,12 +2043,19 @@ var OpenAIEmbeddingModel = class _OpenAIEmbeddingModel {
 };
 
 // src/files/openai-files.ts
+import {
+  InvalidArgumentError
+} from "@ai-sdk/provider";
 import {
   combineHeaders as combineHeaders4,
   convertInlineFileDataToUint8Array,
+  createBinaryStreamResponseHandler,
   createJsonResponseHandler as createJsonResponseHandler4,
+  deleteFromApi,
+  getFromApi,
   parseProviderOptions as parseProviderOptions4,
-  postFormDataToApi
+  postFormDataToApi,
+  postMultipartStreamToApi
 } from "@ai-sdk/provider-utils";
 
 // src/files/openai-files-api.ts
@@ -2068,6 +2075,15 @@ var openaiFilesResponseSchema = lazySchema7(
     })
   )
 );
+var openaiFileDeleteResponseSchema = lazySchema7(
+  () => zodSchema7(
+    z8.object({
+      id: z8.string(),
+      object: z8.string().nullish(),
+      deleted: z8.boolean()
+    })
+  )
+);
 
 // src/files/openai-files-options.ts
 import {
@@ -2090,6 +2106,10 @@ var openaiFilesOptionsSchema = lazySchema8(
 );
 
 // src/files/openai-files.ts
+function encodePathSegment(value) {
+  const encodedValue = encodeURIComponent(value);
+  return encodedValue === "." ? "%252E" : encodedValue === ".." ? "%252E%252E" : encodedValue;
+}
 var OpenAIFiles = class {
   constructor(config) {
     this.config = config;
@@ -2098,63 +2118,206 @@ var OpenAIFiles = class {
   get provider() {
     return this.config.provider;
   }
+  getFileId(file) {
+    const fileId = file.openai;
+    if (fileId == null || fileId.trim() === "") {
+      throw new InvalidArgumentError({
+        argument: "file",
+        message: "file reference is missing an 'openai' file id."
+      });
+    }
+    return fileId;
+  }
+  getHeaders(headers) {
+    return combineHeaders4(this.config.headers(), headers);
+  }
   async uploadFile({
     data,
     mediaType,
     filename,
+    abortSignal,
+    headers,
     providerOptions
   }) {
     var _a2, _b, _c;
-    const openaiOptions = await parseProviderOptions4({
-      provider: "openai",
-      providerOptions,
-      schema: openaiFilesOptionsSchema
-    });
-    const fileBytes = convertInlineFileDataToUint8Array(data);
-    const blob = new Blob([fileBytes], {
-      type: mediaType
-    });
-    const formData = new FormData();
-    if (filename != null) {
-      formData.append("file", blob, filename);
-    } else {
-      formData.append("file", blob);
+    let openaiOptions;
+    try {
+      openaiOptions = await parseProviderOptions4({
+        provider: "openai",
+        providerOptions,
+        schema: openaiFilesOptionsSchema
+      });
+    } catch (error) {
+      if (data.type === "stream") {
+        await data.stream.cancel(error).catch(() => {
+        });
+      }
+      throw error;
     }
-    formData.append("purpose", (_a2 = openaiOptions == null ? void 0 : openaiOptions.purpose) != null ? _a2 : "assistants");
-    if ((openaiOptions == null ? void 0 : openaiOptions.expiresAfter) != null) {
-      formData.append("expires_after[anchor]", "created_at");
-      formData.append(
-        "expires_after[seconds]",
-        String(openaiOptions.expiresAfter)
-      );
+    const purpose = (_a2 = openaiOptions == null ? void 0 : openaiOptions.purpose) != null ? _a2 : "assistants";
+    const requestHeaders = this.getHeaders(headers);
+    const url = `${this.config.baseURL}/files`;
+    let response;
+    if (data.type === "stream") {
+      const parts = [
+        { type: "field", name: "purpose", value: purpose }
+      ];
+      if ((openaiOptions == null ? void 0 : openaiOptions.expiresAfter) != null) {
+        parts.push(
+          { type: "field", name: "expires_after[anchor]", value: "created_at" },
+          {
+            type: "field",
+            name: "expires_after[seconds]",
+            value: String(openaiOptions.expiresAfter)
+          }
+        );
+      }
+      parts.push({
+        type: "file",
+        name: "file",
+        filename,
+        mediaType,
+        content: data.stream
+      });
+      ({ value: response } = await postMultipartStreamToApi({
+        url,
+        headers: requestHeaders,
+        parts,
+        failedResponseHandler: openaiFailedResponseHandler,
+        successfulResponseHandler: createJsonResponseHandler4(
+          openaiFilesResponseSchema
+        ),
+        abortSignal,
+        fetch: this.config.fetch
+      }));
+    } else {
+      const fileBytes = convertInlineFileDataToUint8Array(data);
+      const blob = new Blob([fileBytes], {
+        type: mediaType
+      });
+      const formData = new FormData();
+      if (filename != null) {
+        formData.append("file", blob, filename);
+      } else {
+        formData.append("file", blob);
+      }
+      formData.append("purpose", purpose);
+      if ((openaiOptions == null ? void 0 : openaiOptions.expiresAfter) != null) {
+        formData.append("expires_after[anchor]", "created_at");
+        formData.append(
+          "expires_after[seconds]",
+          String(openaiOptions.expiresAfter)
+        );
+      }
+      ({ value: response } = await postFormDataToApi({
+        url,
+        headers: requestHeaders,
+        formData,
+        failedResponseHandler: openaiFailedResponseHandler,
+        successfulResponseHandler: createJsonResponseHandler4(
+          openaiFilesResponseSchema
+        ),
+        abortSignal,
+        fetch: this.config.fetch
+      }));
     }
-    const { value: response } = await postFormDataToApi({
-      url: `${this.config.baseURL}/files`,
-      headers: combineHeaders4(this.config.headers()),
-      formData,
+    return {
+      warnings: [],
+      providerReference: { openai: response.id },
+      ...((_b = response.filename) != null ? _b : filename) ? { filename: (_c = response.filename) != null ? _c : filename } : {},
+      ...mediaType != null ? { mediaType } : {},
+      ...response.bytes != null ? { byteSize: response.bytes } : {},
+      ...response.created_at != null ? { createdAt: new Date(response.created_at * 1e3) } : {},
+      ...response.expires_at != null ? { expiresAt: new Date(response.expires_at * 1e3) } : {},
+      providerMetadata: {
+        openai: this.toFileMetadata(response)
+      }
+    };
+  }
+  async getFileMetadata({
+    file,
+    abortSignal,
+    headers
+  }) {
+    const fileId = this.getFileId(file);
+    const { value: response } = await getFromApi({
+      url: `${this.config.baseURL}/files/${encodePathSegment(fileId)}`,
+      headers: this.getHeaders(headers),
       failedResponseHandler: openaiFailedResponseHandler,
       successfulResponseHandler: createJsonResponseHandler4(
         openaiFilesResponseSchema
       ),
-      fetch: this.config.fetch
+      abortSignal,
+      fetch: this.config.fetch,
+      validateUrl: false
     });
     return {
       warnings: [],
       providerReference: { openai: response.id },
-      ...((_b = response.filename) != null ? _b : filename) ? { filename: (_c = response.filename) != null ? _c : filename } : {},
-      ...mediaType != null ? { mediaType } : {},
+      ...response.filename != null ? { filename: response.filename } : {},
+      ...response.bytes != null ? { byteSize: response.bytes } : {},
+      ...response.created_at != null ? { createdAt: new Date(response.created_at * 1e3) } : {},
+      ...response.expires_at != null ? { expiresAt: new Date(response.expires_at * 1e3) } : {},
       providerMetadata: {
-        openai: {
-          ...response.filename != null ? { filename: response.filename } : {},
-          ...response.purpose != null ? { purpose: response.purpose } : {},
-          ...response.bytes != null ? { bytes: response.bytes } : {},
-          ...response.created_at != null ? { createdAt: response.created_at } : {},
-          ...response.status != null ? { status: response.status } : {},
-          ...response.expires_at != null ? { expiresAt: response.expires_at } : {}
-        }
+        openai: this.toFileMetadata(response)
       }
     };
   }
+  async downloadFile({
+    file,
+    abortSignal,
+    headers
+  }) {
+    var _a2;
+    const fileId = this.getFileId(file);
+    const { value: content, responseHeaders } = await getFromApi({
+      url: `${this.config.baseURL}/files/${encodePathSegment(fileId)}/content`,
+      headers: this.getHeaders(headers),
+      failedResponseHandler: openaiFailedResponseHandler,
+      successfulResponseHandler: createBinaryStreamResponseHandler(),
+      abortSignal,
+      fetch: this.config.fetch,
+      validateUrl: false
+    });
+    const mediaType = (_a2 = responseHeaders == null ? void 0 : responseHeaders["content-type"]) == null ? void 0 : _a2.split(";")[0].trim();
+    return {
+      warnings: [],
+      content,
+      ...mediaType ? { mediaType } : {}
+    };
+  }
+  async deleteFile({
+    file,
+    abortSignal,
+    headers
+  }) {
+    const fileId = this.getFileId(file);
+    const { value: response } = await deleteFromApi({
+      url: `${this.config.baseURL}/files/${encodePathSegment(fileId)}`,
+      headers: this.getHeaders(headers),
+      failedResponseHandler: openaiFailedResponseHandler,
+      successfulResponseHandler: createJsonResponseHandler4(
+        openaiFileDeleteResponseSchema
+      ),
+      abortSignal,
+      fetch: this.config.fetch
+    });
+    return {
+      warnings: [],
+      providerReference: { openai: response.id },
+      deleted: response.deleted
+    };
+  }
+  toFileMetadata(response) {
+    return {
+      ...response.filename != null ? { filename: response.filename } : {},
+      ...response.purpose != null ? { purpose: response.purpose } : {},
+      ...response.bytes != null ? { bytes: response.bytes } : {},
+      ...response.created_at != null ? { createdAt: response.created_at } : {},
+      ...response.status != null ? { status: response.status } : {},
+      ...response.expires_at != null ? { expiresAt: response.expires_at } : {}
+    };
+  }
 };
 
 // src/image/openai-image-model.ts
@@ -3355,7 +3518,7 @@ var openaiTools = {
 
 // src/openai-responses-batch.ts
 import {
-  InvalidArgumentError,
+  InvalidArgumentError as InvalidArgumentError2,
   InvalidResponseDataError
 } from "@ai-sdk/provider";
 import {
@@ -3363,7 +3526,7 @@ import {
   convertAsyncIteratorToReadableStream,
   createJsonLinesResponseHandler,
   createJsonResponseHandler as createJsonResponseHandler7,
-  getFromApi,
+  getFromApi as getFromApi2,
   lazySchema as lazySchema26,
   normalizeBatchRequestCounts,
   postJsonToApi as postJsonToApi6,
@@ -8913,7 +9076,7 @@ var OpenAIResponsesBatch = class {
     const batch = await this.retrieveBatch(options);
     const batchStatus = convertOpenAIBatchStatus(batch);
     if (batchStatus.status === "pending") {
-      throw new InvalidArgumentError({
+      throw new InvalidArgumentError2({
         argument: "batchId",
         message: `OpenAI batch "${options.batchId}" is not complete.`
       });
@@ -8932,7 +9095,7 @@ var OpenAIResponsesBatch = class {
   }
   async retrieveBatch(options) {
     var _a2, _b;
-    const { value: batch } = await getFromApi({
+    const { value: batch } = await getFromApi2({
       url: this.getUrl(`/batches/${encodeURIComponent(options.batchId)}`),
       headers: combineHeaders7((_b = (_a2 = this.options.config).headers) == null ? void 0 : _b.call(_a2), options.headers),
       failedResponseHandler: openaiFailedResponseHandler,
@@ -8951,7 +9114,7 @@ var OpenAIResponsesBatch = class {
   }) {
     var _a2, _b;
     for (const fileId of fileIds) {
-      const { value: lines } = await getFromApi({
+      const { value: lines } = await getFromApi2({
         url: this.getUrl(`/files/${encodeURIComponent(fileId)}/content`),
         headers: combineHeaders7(
           (_b = (_a2 = this.options.config).headers) == null ? void 0 : _b.call(_a2),
@@ -10400,7 +10563,7 @@ function getOpenAIRealtimeConnection(headers) {
 
 // src/speech-translation/openai-speech-translation-model.ts
 import {
-  InvalidArgumentError as InvalidArgumentError2
+  InvalidArgumentError as InvalidArgumentError3
 } from "@ai-sdk/provider";
 import {
   combineHeaders as combineHeaders10,
@@ -10447,7 +10610,7 @@ var OpenAISpeechTranslationModel = class _OpenAISpeechTranslationModel {
   async doStream(options) {
     var _a2, _b, _c, _d, _e;
     if (options.targetLanguage == null) {
-      throw new InvalidArgumentError2({
+      throw new InvalidArgumentError3({
         argument: "targetLanguage",
         message: `targetLanguage is required for translation model '${this.modelId}'.`
       });
@@ -10687,7 +10850,7 @@ function buildOpenAIRealtimeSpeechTranslationSession({
 }
 function validateOpenAISpeechTranslationInputAudioFormat(inputAudioFormat) {
   if (inputAudioFormat.type !== "audio/pcm" || inputAudioFormat.rate != null && inputAudioFormat.rate !== 24e3) {
-    throw new InvalidArgumentError2({
+    throw new InvalidArgumentError3({
       argument: "inputAudioFormat",
       message: "The OpenAI Realtime translation API only supports 24kHz 16-bit PCM input audio."
     });
@@ -10800,7 +10963,7 @@ var OpenAISkills = class {
 };
 
 // src/version.ts
-var VERSION = true ? "4.0.54" : "0.0.0-test";
+var VERSION = true ? "4.0.55" : "0.0.0-test";
 
 // src/openai-provider.ts
 function createOpenAI(options = {}) {