@commercetools-frontend-extensions/operations 3.5.0 → 3.6.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @commercetools-frontend-extensions/operations
 
+## 3.6.0
+
+### Minor Changes
+
+- [#1734](https://github.com/commercetools/merchant-center-operations/pull/1734) [`59d43ea`](https://github.com/commercetools/merchant-center-operations/commit/59d43ea4a4ffb929a970e3094881777639d6631f) Thanks [@yassinejebli](https://github.com/yassinejebli)! - feat: add optional `fileType` override to `useFileUpload` hook
+
 ## 3.5.0
 
 ### Minor Changes

package/README.md

@@ -40,6 +40,7 @@ const { upload, isUploading, progress, validationProgress } = useFileUpload({
 **Upload config options:**
 - `file` (required): The file to upload
 - `resourceType` (required): The resource type
+- `fileType` (optional): File type (`'csv'` or `'json'`) sent to the API.
 - `settings` (optional): Import settings (format, decimal separator...)
 - `autoProcess` (optional): When `true`, the backend automatically starts processing after validation completes (job-based flow only). Default: `false`
 - `skipValidationPolling` (optional): When `true`, skips full validation polling and returns once the job reaches `processing` state. Useful for fire-and-forget uploads with `autoProcess: true` (job-based flow only). Default: `false`
@@ -63,6 +64,7 @@ const abortController = new AbortController()
 await upload({
   file: File,
   resourceType: 'product' | 'category' | ...,
+  fileType?: 'csv' | 'json', // override derived file type (job-based flow only)
   settings?: {
     format?: 'CSV' | 'JSON',
     decimalSeparator?: '.' | ',',

package/dist/commercetools-frontend-extensions-operations.cjs.dev.js

@@ -2989,12 +2989,13 @@ const useFileImportJobUpload = _ref => {
         } : {}),
         projectKey
       });
+      const fileType = config.fileType ?? getFileImportJobFileType(config.resourceType);
       const jobResponse = await createFileImportJob({
         projectKey,
         resourceType: config.resourceType,
         importContainerKey,
         payload: {
-          fileType: getFileImportJobFileType(config.resourceType),
+          fileType,
           fileName: config.file.name,
           file: config.file
         },
@@ -3187,6 +3188,7 @@ const useFileUpload = _ref2 => {
         await jobUpload.upload({
           file: config.file,
           resourceType: config.resourceType,
+          fileType: config.fileType,
           settings: config.settings,
           autoProcess: config.autoProcess,
           operationType: config.operationType,

package/dist/commercetools-frontend-extensions-operations.cjs.prod.js

@@ -2981,12 +2981,13 @@ const useFileImportJobUpload = _ref => {
         } : {}),
         projectKey
       });
+      const fileType = config.fileType ?? getFileImportJobFileType(config.resourceType);
       const jobResponse = await createFileImportJob({
         projectKey,
         resourceType: config.resourceType,
         importContainerKey,
         payload: {
-          fileType: getFileImportJobFileType(config.resourceType),
+          fileType,
           fileName: config.file.name,
           file: config.file
         },
@@ -3179,6 +3180,7 @@ const useFileUpload = _ref2 => {
         await jobUpload.upload({
           file: config.file,
           resourceType: config.resourceType,
+          fileType: config.fileType,
           settings: config.settings,
           autoProcess: config.autoProcess,
           operationType: config.operationType,

package/dist/commercetools-frontend-extensions-operations.esm.js

@@ -2951,12 +2951,13 @@ const useFileImportJobUpload = _ref => {
         } : {}),
         projectKey
       });
+      const fileType = config.fileType ?? getFileImportJobFileType(config.resourceType);
       const jobResponse = await createFileImportJob({
         projectKey,
         resourceType: config.resourceType,
         importContainerKey,
         payload: {
-          fileType: getFileImportJobFileType(config.resourceType),
+          fileType,
           fileName: config.file.name,
           file: config.file
         },
@@ -3149,6 +3150,7 @@ const useFileUpload = _ref2 => {
         await jobUpload.upload({
           file: config.file,
           resourceType: config.resourceType,
+          fileType: config.fileType,
           settings: config.settings,
           autoProcess: config.autoProcess,
           operationType: config.operationType,

package/dist/declarations/src/@hooks/use-file-import-job-upload.d.ts

@@ -3,6 +3,7 @@ import type { ExtendedImportContainerDraft } from "../@types/index.js";
 export type UseFileImportJobUploadConfig = {
     file: File;
     resourceType: ResourceTypeId;
+    fileType?: 'csv' | 'json';
     settings?: ExtendedImportContainerDraft['settings'];
     autoProcess?: boolean;
     operationType?: 'delete';

package/dist/declarations/src/@hooks/use-file-upload.d.ts

@@ -7,6 +7,7 @@ export type ValidationProgress = {
 export type FileUploadConfig = {
     file: File;
     resourceType: ResourceTypeId;
+    fileType?: 'csv' | 'json';
     settings?: ExtendedImportContainerDraft['settings'];
     autoProcess?: boolean;
     skipValidationPolling?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools-frontend-extensions/operations",
-  "version": "3.5.0",
+  "version": "3.6.0",
   "license": "Proprietary",
   "publishConfig": {
     "access": "public"

package/src/@hooks/use-file-import-job-upload.spec.ts

@@ -262,6 +262,55 @@ describe('useFileImportJobUpload', () => {
     expect(result.current.progress).toBe(100)
   })
 
+  it('should use explicit fileType override instead of deriving from resourceType', async () => {
+    const onSuccess = jest.fn()
+
+    const { result } = renderHook(() => useFileImportJobUpload({ projectKey }))
+
+    await act(async () => {
+      await result.current.upload({
+        file: mockFile,
+        resourceType: 'product',
+        fileType: 'json',
+        onSuccess,
+      })
+    })
+
+    expect(mockCreateFileImportJob).toHaveBeenCalledWith(
+      expect.objectContaining({
+        payload: expect.objectContaining({
+          fileType: 'json',
+        }),
+      })
+    )
+
+    expect(mockGetFileImportJobFileType).not.toHaveBeenCalled()
+    expect(onSuccess).toHaveBeenCalledWith('job-123', importContainerKey)
+  })
+
+  it('should fall back to derived fileType when fileType override is not provided', async () => {
+    const onSuccess = jest.fn()
+
+    const { result } = renderHook(() => useFileImportJobUpload({ projectKey }))
+
+    await act(async () => {
+      await result.current.upload({
+        file: mockFile,
+        resourceType: 'product',
+        onSuccess,
+      })
+    })
+
+    expect(mockGetFileImportJobFileType).toHaveBeenCalledWith('product')
+    expect(mockCreateFileImportJob).toHaveBeenCalledWith(
+      expect.objectContaining({
+        payload: expect.objectContaining({
+          fileType: 'csv',
+        }),
+      })
+    )
+  })
+
   it('should work without optional settings', async () => {
     const onSuccess = jest.fn()
 

package/src/@hooks/use-file-import-job-upload.ts

@@ -16,6 +16,7 @@ import type { ExtendedImportContainerDraft } from '../@types'
 export type UseFileImportJobUploadConfig = {
   file: File
   resourceType: ResourceTypeId
+  fileType?: 'csv' | 'json'
   settings?: ExtendedImportContainerDraft['settings']
   autoProcess?: boolean
   operationType?: 'delete'
@@ -57,12 +58,15 @@ export const useFileImportJobUpload = ({
           projectKey,
         })
 
+        const fileType =
+          config.fileType ?? getFileImportJobFileType(config.resourceType)
+
         const jobResponse = await createFileImportJob({
           projectKey,
           resourceType: config.resourceType,
           importContainerKey,
           payload: {
-            fileType: getFileImportJobFileType(config.resourceType),
+            fileType,
             fileName: config.file.name,
             file: config.file,
           },

package/src/@hooks/use-file-upload.ts

@@ -19,6 +19,7 @@ export type ValidationProgress = {
 export type FileUploadConfig = {
   file: File
   resourceType: ResourceTypeId
+  fileType?: 'csv' | 'json'
   settings?: ExtendedImportContainerDraft['settings']
   autoProcess?: boolean
   skipValidationPolling?: boolean
@@ -85,6 +86,7 @@ export const useFileUpload = ({
           await jobUpload.upload({
             file: config.file,
             resourceType: config.resourceType,
+            fileType: config.fileType,
             settings: config.settings,
             autoProcess: config.autoProcess,
             operationType: config.operationType,