From a9d33bc8d11637230052f1729e85af5e174b2423 Mon Sep 17 00:00:00 2001
From: William Bouchard <46496014+willbouch@users.noreply.github.com>
Date: Fri, 7 Nov 2025 04:12:57 -0500
Subject: [PATCH] fix(core-flows,types): change doc for upload file functions
 (#13809)

* fix(core-flows,types): change doc for upload file functions

* Create silent-seas-hammer.md

* comment

* comment
---
 .changeset/silent-seas-hammer.md                            | 6 ++++++
 packages/core/core-flows/src/file/steps/upload-files.ts     | 6 +++---
 packages/core/core-flows/src/file/workflows/upload-files.ts | 6 +++---
 packages/core/types/src/file/mutations.ts                   | 2 +-
 packages/core/types/src/file/provider.ts                    | 2 +-
 packages/core/types/src/file/service.ts                     | 4 ++--
 6 files changed, 16 insertions(+), 10 deletions(-)
 create mode 100644 .changeset/silent-seas-hammer.md

diff --git a/.changeset/silent-seas-hammer.md b/.changeset/silent-seas-hammer.md
new file mode 100644
index 0000000000..3f746f9a67
--- /dev/null
+++ b/.changeset/silent-seas-hammer.md
@@ -0,0 +1,6 @@
+---
+"@medusajs/core-flows": patch
+"@medusajs/types": patch
+---
+
+fix(core-flows,types): change doc for upload file functions
diff --git a/packages/core/core-flows/src/file/steps/upload-files.ts b/packages/core/core-flows/src/file/steps/upload-files.ts
index 65490420e5..299338aff4 100644
--- a/packages/core/core-flows/src/file/steps/upload-files.ts
+++ b/packages/core/core-flows/src/file/steps/upload-files.ts
@@ -1,6 +1,6 @@
 import type { IFileModuleService } from "@medusajs/framework/types"
 import { Modules } from "@medusajs/framework/utils"
-import { StepResponse, createStep } from "@medusajs/framework/workflows-sdk"
+import { createStep, StepResponse } from "@medusajs/framework/workflows-sdk"
 
 /**
  * The data to upload files.
@@ -23,7 +23,7 @@ export type UploadFilesStepInput = {
     mimeType: string
     /**
      * The content of the file. For images, for example,
-     * use binary string. For CSV files, use the CSV content.
+     * use base64 string. For CSV files, use the CSV content.
      */
     content: string
     /**
@@ -48,7 +48,7 @@ export const uploadFilesStepId = "upload-files"
  *     {
  *       filename: "test.jpg",
  *       mimeType: "img/jpg",
- *       content: "binary-string",
+ *       content: "base64-string",
  *       access: "public"
  *     }
  *   ]
diff --git a/packages/core/core-flows/src/file/workflows/upload-files.ts b/packages/core/core-flows/src/file/workflows/upload-files.ts
index 4c63fa27a7..f3049f0cd4 100644
--- a/packages/core/core-flows/src/file/workflows/upload-files.ts
+++ b/packages/core/core-flows/src/file/workflows/upload-files.ts
@@ -1,8 +1,8 @@
 import type { FileDTO } from "@medusajs/framework/types"
 import {
+  createWorkflow,
   WorkflowData,
   WorkflowResponse,
-  createWorkflow,
 } from "@medusajs/framework/workflows-sdk"
 import { uploadFilesStep } from "../steps"
 
@@ -27,7 +27,7 @@ export type UploadFilesWorkflowInput = {
     mimeType: string
     /**
      * The content of the file. For images, for example,
-     * use binary string. For CSV files, use the CSV content.
+     * use base64 string. For CSV files, use the CSV content.
      */
     content: string
     /**
@@ -58,7 +58,7 @@ export const uploadFilesWorkflowId = "upload-files"
  *       {
  *         filename: "test.jpg",
  *         mimeType: "img/jpg",
- *         content: "binary-string",
+ *         content: "base64-string",
  *         access: "public"
  *       }
  *     ]
diff --git a/packages/core/types/src/file/mutations.ts b/packages/core/types/src/file/mutations.ts
index 545eed48bc..17582da995 100644
--- a/packages/core/types/src/file/mutations.ts
+++ b/packages/core/types/src/file/mutations.ts
@@ -18,7 +18,7 @@ export interface CreateFileDTO {
   mimeType: string
 
   /**
-   * The file content as a binary-encoded string.
+   * The file content as a base64-encoded string.
    */
   content: string
 
diff --git a/packages/core/types/src/file/provider.ts b/packages/core/types/src/file/provider.ts
index ca13315b09..66b263149e 100644
--- a/packages/core/types/src/file/provider.ts
+++ b/packages/core/types/src/file/provider.ts
@@ -72,7 +72,7 @@ export type ProviderUploadFileDTO = {
   mimeType: string
 
   /**
-   * The file content as a binary-encoded string
+   * The file content as a base64-encoded string
    */
   content: string
 
diff --git a/packages/core/types/src/file/service.ts b/packages/core/types/src/file/service.ts
index 3b8416b44f..a3affff543 100644
--- a/packages/core/types/src/file/service.ts
+++ b/packages/core/types/src/file/service.ts
@@ -30,7 +30,7 @@ export interface IFileModuleService extends IModuleService {
    * const [file] = await fileModuleService.createFiles([{
    *   filename: "product.png",
    *   mimeType: "image/png",
-   *   content: "somecontent" // binary string
+   *   content: "somecontent" // base64 string
    * }])
    */
   createFiles(
@@ -49,7 +49,7 @@ export interface IFileModuleService extends IModuleService {
    * const file = await fileModuleService.createFiles({
    *   filename: "product.png",
    *   mimeType: "image/png",
-   *   content: "somecontent" // binary string
+   *   content: "somecontent" // base64 string
    * })
    */