@commercetools-frontend-extensions/operations 3.3.0 → 3.5.0

package/package.json

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

package/src/@api/file-import-jobs.ts

@@ -34,12 +34,17 @@ export function createFileImportJob({
   importContainerKey,
   payload,
   autoProcess = false,
+  operationType,
   onProgress,
   abortSignal,
 }: CreateFileImportJobParameters): Promise<FileImportJob> {
+  const urlResourceType = operationType
+    ? `${resourceType}-${operationType}`
+    : resourceType
+
   const url = getFileImportJobsURL({
     projectKey,
-    resourceType,
+    resourceType: urlResourceType,
     importContainerKey,
   })
 
@@ -145,16 +150,20 @@ export async function processFileImportJob({
   resourceType,
   importContainerKey,
   jobId,
-  action,
+  operationType,
 }: ProcessFileImportJobParameters): Promise<ProcessFileImportJobResponse> {
+  const urlResourceType = operationType
+    ? `${resourceType}-${operationType}`
+    : resourceType
+
   const url = getFileImportJobProcessURL({
     projectKey,
-    resourceType,
+    resourceType: urlResourceType,
     importContainerKey,
     jobId,
   })
 
-  const payload = action ? { action } : {}
+  const payload = operationType ? { action: operationType } : {}
 
   const response = await fetcher<ProcessFileImportJobResponse>({
     url,

package/src/@api/process-file.ts

@@ -13,7 +13,6 @@ export async function processUploadedFile({
   resourceType,
   action,
 }: ProcessUploadedFileRequestParameters): Promise<ProcessFileResponse> {
-  // For delete operations with action (like 'delete') -> use different URL and payload structure
   const uri = action
     ? getImportContainerTasksURL({ projectKey, importContainerKey })
     : getProccessFileURL({ projectKey, resourceType, importContainerKey })

package/src/@api/urls.ts

@@ -6,6 +6,15 @@ import type {
   ExportOperationQueryParams,
 } from '../@types'
 
+const OPERATION_RESOURCE_TYPES = ['product-delete', 'product-unpublish']
+
+function pluralizeResourceType(resourceType: string): string {
+  if (OPERATION_RESOURCE_TYPES.includes(resourceType)) {
+    return resourceType
+  }
+  return plural(resourceType)
+}
+
 export function getImportContainersURL({
   projectKey,
   queryParams,
@@ -126,7 +135,7 @@ export function getFileImportJobsURL({
   resourceType: string
   importContainerKey: string
 }): string {
-  return `/${projectKey}/${plural(
+  return `/${projectKey}/${pluralizeResourceType(
     toImportApiResourceType(resourceType)
   )}/import-containers/${importContainerKey}/file-import-jobs`
 }
@@ -166,7 +175,7 @@ export function getFileImportJobProcessURL({
   importContainerKey: string
   jobId: string
 }): string {
-  return `/${projectKey}/${plural(
+  return `/${projectKey}/${pluralizeResourceType(
     toImportApiResourceType(resourceType)
   )}/import-containers/${importContainerKey}/file-import-jobs/${jobId}/process`
 }

package/src/@errors/base.ts

@@ -0,0 +1,30 @@
+export const ErrorCode = {
+  HTTP_ERROR: 'HTTP_ERROR',
+  POLLING_TIMEOUT: 'POLLING_TIMEOUT',
+  POLLING_ABORTED: 'POLLING_ABORTED',
+
+  INVALID_RESPONSE: 'INVALID_RESPONSE',
+  UNEXPECTED_COLUMN: 'UNEXPECTED_COLUMN',
+  QUERY_PREDICATE_ERROR: 'QUERY_PREDICATE_ERROR',
+
+  UNEXPECTED_OPERATION_STATE: 'UNEXPECTED_OPERATION_STATE',
+  UNEXPECTED_RESOURCE_TYPE: 'UNEXPECTED_RESOURCE_TYPE',
+
+  PROJECT_KEY_NOT_AVAILABLE: 'PROJECT_KEY_NOT_AVAILABLE',
+
+  NO_RESOURCES_TO_EXPORT: 'NO_RESOURCES_TO_EXPORT',
+} as const
+
+export type ErrorCodeType = (typeof ErrorCode)[keyof typeof ErrorCode]
+
+export abstract class OperationsError extends Error {
+  abstract readonly code: ErrorCodeType
+  abstract readonly isRetryable: boolean
+
+  readonly timestamp: number
+
+  constructor(message: string) {
+    super(message)
+    this.timestamp = Date.now()
+  }
+}

package/src/@errors/guards.ts

@@ -0,0 +1,43 @@
+import { ErrorCode, type ErrorCodeType } from './base'
+
+type ErrorWithCode = {
+  code: ErrorCodeType
+  isRetryable: boolean
+}
+
+function hasErrorCode(error: unknown): error is ErrorWithCode {
+  return (
+    typeof error === 'object' &&
+    error !== null &&
+    'code' in error &&
+    typeof (error as ErrorWithCode).code === 'string'
+  )
+}
+
+export function isOperationsError(error: unknown): error is ErrorWithCode {
+  return hasErrorCode(error)
+}
+
+export function isRetryableError(error: unknown): boolean {
+  return hasErrorCode(error) && error.isRetryable === true
+}
+
+export function isNetworkError(error: unknown): boolean {
+  return (
+    hasErrorCode(error) &&
+    (error.code === ErrorCode.HTTP_ERROR ||
+      error.code === ErrorCode.POLLING_TIMEOUT)
+  )
+}
+
+export function isPollingAbortedError(error: unknown): boolean {
+  return hasErrorCode(error) && error.code === ErrorCode.POLLING_ABORTED
+}
+
+export function isPollingTimeoutError(error: unknown): boolean {
+  return hasErrorCode(error) && error.code === ErrorCode.POLLING_TIMEOUT
+}
+
+export function isHttpError(error: unknown): boolean {
+  return hasErrorCode(error) && error.code === ErrorCode.HTTP_ERROR
+}

package/src/@errors/http-error.ts

@@ -1,8 +1,11 @@
 import type { BasicErrorDataType } from '../@types'
+import { ErrorCode, OperationsError } from './base'
 
-export class HttpError<T = BasicErrorDataType> extends Error {
+export class HttpError<T = BasicErrorDataType> extends OperationsError {
+  readonly code = ErrorCode.HTTP_ERROR
   readonly statusCode: number
   readonly errorData?: T
+  readonly isRetryable: boolean
 
   constructor(statusCode: number, statusText?: string, errorData?: T) {
     super(
@@ -13,5 +16,6 @@ export class HttpError<T = BasicErrorDataType> extends Error {
     this.name = 'HttpError'
     this.statusCode = statusCode
     this.errorData = errorData
+    this.isRetryable = statusCode >= 500 || statusCode === 408
   }
 }

package/src/@errors/index.ts

@@ -1,7 +1,10 @@
+export * from './base'
+export * from './guards'
 export * from './http-error'
 export * from './invalid-response-error'
 export * from './no-resources-to-export-error'
 export * from './polling-aborted-error'
+export * from './polling-timeout-error'
 export * from './project-key-not-available-error'
 export * from './query-predicate-error'
 export * from './unexpected-column-error'

package/src/@errors/invalid-response-error.ts

@@ -1,4 +1,9 @@
-export class InvalidResponseError extends Error {
+import { ErrorCode, OperationsError } from './base'
+
+export class InvalidResponseError extends OperationsError {
+  readonly code = ErrorCode.INVALID_RESPONSE
+  readonly isRetryable = false
+
   constructor(message: string) {
     super(message)
     this.name = 'InvalidResponseError'

package/src/@errors/no-resources-to-export-error.ts

@@ -1,4 +1,9 @@
-export class NoResourcesToExportError extends Error {
+import { ErrorCode, OperationsError } from './base'
+
+export class NoResourcesToExportError extends OperationsError {
+  readonly code = ErrorCode.NO_RESOURCES_TO_EXPORT
+  readonly isRetryable = false
+
   constructor(message: string = 'There are no resources to export.') {
     super(message)
     this.name = 'NoResourcesToExportError'

package/src/@errors/polling-aborted-error.ts

@@ -1,4 +1,9 @@
-export class PollingAbortedError extends Error {
+import { ErrorCode, OperationsError } from './base'
+
+export class PollingAbortedError extends OperationsError {
+  readonly code = ErrorCode.POLLING_ABORTED
+  readonly isRetryable = false
+
   constructor() {
     super('Polling was aborted')
     this.name = 'PollingAbortedError'

package/src/@errors/polling-timeout-error.ts

@@ -0,0 +1,17 @@
+import { ErrorCode, OperationsError } from './base'
+
+export class PollingTimeoutError extends OperationsError {
+  readonly code = ErrorCode.POLLING_TIMEOUT
+  readonly isRetryable = true
+  readonly maxAttempts: number
+  readonly totalTimeSeconds: number
+
+  constructor(maxAttempts: number, totalTimeSeconds: number) {
+    super(
+      `Polling timeout after ${maxAttempts} attempts (${totalTimeSeconds}s)`
+    )
+    this.name = 'PollingTimeoutError'
+    this.maxAttempts = maxAttempts
+    this.totalTimeSeconds = totalTimeSeconds
+  }
+}

package/src/@errors/project-key-not-available-error.ts

@@ -1,4 +1,9 @@
-export class ProjectKeyNotAvailableError extends Error {
+import { ErrorCode, OperationsError } from './base'
+
+export class ProjectKeyNotAvailableError extends OperationsError {
+  readonly code = ErrorCode.PROJECT_KEY_NOT_AVAILABLE
+  readonly isRetryable = false
+
   constructor(message: string = 'Project key is not available') {
     super(message)
     this.name = 'ProjectKeyNotAvailableError'

package/src/@errors/query-predicate-error.ts

@@ -1,5 +1,9 @@
-export class QueryPredicateError extends Error {
-  field = 'queryPredicate'
+import { ErrorCode, OperationsError } from './base'
+
+export class QueryPredicateError extends OperationsError {
+  readonly code = ErrorCode.QUERY_PREDICATE_ERROR
+  readonly isRetryable = false
+  readonly field = 'queryPredicate'
 
   constructor(
     message: string = 'There is an error with the query predicate. Make sure the syntax is correct.'

package/src/@errors/unexpected-column-error.ts

@@ -1,6 +1,13 @@
-export class UnexpectedColumnError extends Error {
+import { ErrorCode, OperationsError } from './base'
+
+export class UnexpectedColumnError extends OperationsError {
+  readonly code = ErrorCode.UNEXPECTED_COLUMN
+  readonly isRetryable = false
+  readonly columnName: string
+
   constructor(columnName: string) {
     super(`Unexpected column "${columnName}"`)
     this.name = 'UnexpectedColumnError'
+    this.columnName = columnName
   }
 }

package/src/@errors/unexpected-operation-state-error.ts

@@ -1,8 +1,14 @@
 import { ProcessingState } from '@commercetools/importapi-sdk'
+import { ErrorCode, OperationsError } from './base'
+
+export class UnexpectedOperationStateError extends OperationsError {
+  readonly code = ErrorCode.UNEXPECTED_OPERATION_STATE
+  readonly isRetryable = false
+  readonly state: ProcessingState
 
-export class UnexpectedOperationStateError extends Error {
   constructor(state: ProcessingState) {
     super(`Unexpected operation state "${state}"`)
     this.name = 'UnexpectedOperationStateError'
+    this.state = state
   }
 }

package/src/@errors/unexpected-resource-type-error.ts

@@ -1,6 +1,13 @@
-export class UnexpectedResourceTypeError extends Error {
+import { ErrorCode, OperationsError } from './base'
+
+export class UnexpectedResourceTypeError extends OperationsError {
+  readonly code = ErrorCode.UNEXPECTED_RESOURCE_TYPE
+  readonly isRetryable = false
+  readonly resourceType: string
+
   constructor(resourceType: string) {
     super(`Unexpected resource type "${resourceType}"`)
     this.name = 'UnexpectedResourceTypeError'
+    this.resourceType = resourceType
   }
 }

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

@@ -16,7 +16,6 @@ const mockGetFileImportJob = getFileImportJob as jest.MockedFunction<
 
 describe('useFetchFileImportJob', () => {
   const projectKey = 'test-with-big-data'
-  const resourceType = 'product'
   const importContainerKey = 'test-container'
   const jobId = 'test-job-id'
 
@@ -45,7 +44,6 @@ describe('useFetchFileImportJob', () => {
     const { result } = renderHook(() =>
       useFetchFileImportJob({
         projectKey,
-        resourceType,
         importContainerKey,
         jobId,
       })
@@ -57,7 +55,6 @@ describe('useFetchFileImportJob', () => {
 
     expect(mockGetFileImportJob).toHaveBeenCalledWith({
       projectKey,
-      resourceType,
       importContainerKey,
       jobId,
     })
@@ -70,7 +67,6 @@ describe('useFetchFileImportJob', () => {
     const { result } = renderHook(() =>
       useFetchFileImportJob({
         projectKey,
-        resourceType,
         importContainerKey,
         jobId,
       })
@@ -92,7 +88,6 @@ describe('useFetchFileImportJob', () => {
     const { result } = renderHook(() =>
       useFetchFileImportJob({
         projectKey,
-        resourceType,
         importContainerKey,
         jobId,
         pollingInterval,
@@ -106,7 +101,6 @@ describe('useFetchFileImportJob', () => {
 
     expect(mockGetFileImportJob).toHaveBeenCalledWith({
       projectKey,
-      resourceType,
       importContainerKey,
       jobId,
     })
@@ -116,7 +110,6 @@ describe('useFetchFileImportJob', () => {
     const { result } = renderHook(() =>
       useFetchFileImportJob({
         projectKey: '',
-        resourceType,
         importContainerKey,
         jobId,
       })

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

@@ -6,7 +6,6 @@ import { useFetch } from './use-fetch'
 
 type UseFetchFileImportJobConfig = {
   projectKey: string
-  resourceType: string
   importContainerKey: string
   jobId: string
   pollingInterval?: number

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

@@ -5,7 +5,10 @@ import {
   createFileImportJob,
 } from '../@api'
 import { ProjectKeyNotAvailableError } from '../@errors'
-import { encodeFileNameWithTimestampToContainerKey } from '../@utils'
+import {
+  encodeFileNameWithTimestampToContainerKey,
+  getFileImportJobFileType,
+} from '../@utils'
 import {
   useFileImportJobUpload,
   UseFileImportJobUploadConfig,
@@ -28,6 +31,10 @@ const mockEncodeFileNameWithTimestampToContainerKey =
   encodeFileNameWithTimestampToContainerKey as jest.MockedFunction<
     typeof encodeFileNameWithTimestampToContainerKey
   >
+const mockGetFileImportJobFileType =
+  getFileImportJobFileType as jest.MockedFunction<
+    typeof getFileImportJobFileType
+  >
 
 describe('useFileImportJobUpload', () => {
   const projectKey = 'test-with-big-data'
@@ -53,6 +60,9 @@ describe('useFileImportJobUpload', () => {
     mockEncodeFileNameWithTimestampToContainerKey.mockReturnValue(
       importContainerKey
     )
+    mockGetFileImportJobFileType.mockImplementation((resourceType) =>
+      resourceType === 'custom-object' ? 'json' : 'csv'
+    )
     mockCreateImportContainerForFileUpload.mockResolvedValue({
       key: importContainerKey,
     })
@@ -112,7 +122,10 @@ describe('useFileImportJobUpload', () => {
         fileName: 'test.csv',
         file: mockFile,
       },
+      autoProcess: undefined,
+      operationType: undefined,
       onProgress: expect.any(Function),
+      abortSignal: undefined,
     })
 
     expect(onSuccess).toHaveBeenCalledWith('job-123', importContainerKey)
@@ -147,7 +160,10 @@ describe('useFileImportJobUpload', () => {
         fileName: 'test.json',
         file: mockJsonFile,
       },
+      autoProcess: undefined,
+      operationType: undefined,
       onProgress: expect.any(Function),
+      abortSignal: undefined,
     })
 
     expect(onSuccess).toHaveBeenCalledWith('job-123', importContainerKey)

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

@@ -18,6 +18,7 @@ export type UseFileImportJobUploadConfig = {
   resourceType: ResourceTypeId
   settings?: ExtendedImportContainerDraft['settings']
   autoProcess?: boolean
+  operationType?: 'delete'
   onSuccess: (jobId: string, importContainerKey: string) => void
   onError?: (error: unknown) => void
   onProgress?: (progress: number) => void
@@ -66,6 +67,7 @@ export const useFileImportJobUpload = ({
             file: config.file,
           },
           autoProcess: config.autoProcess,
+          operationType: config.operationType,
           onProgress: (uploadProgress) => {
             setProgress(uploadProgress)
             config.onProgress?.(uploadProgress)

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

@@ -22,6 +22,7 @@ export type FileUploadConfig = {
   settings?: ExtendedImportContainerDraft['settings']
   autoProcess?: boolean
   skipValidationPolling?: boolean
+  operationType?: 'delete'
   onSuccess: (result: FileUploadResult) => void
   onError?: (error: unknown) => void
   onProgress?: (progress: number) => void
@@ -86,6 +87,7 @@ export const useFileUpload = ({
             resourceType: config.resourceType,
             settings: config.settings,
             autoProcess: config.autoProcess,
+            operationType: config.operationType,
             abortSignal: config.abortSignal,
             onSuccess: async (jobId, containerKey) => {
               if (config.skipValidationPolling) {

package/src/@types/file-import-job.ts

@@ -57,6 +57,7 @@ export interface CreateFileImportJobParameters {
   importContainerKey: string
   payload: CreateFileImportJobPayload
   autoProcess?: boolean
+  operationType?: 'delete'
   onProgress?: (progress: number) => void
   abortSignal?: AbortSignal
 }
@@ -100,7 +101,7 @@ export interface ProcessFileImportJobParameters {
   resourceType: string
   importContainerKey: string
   jobId: string
-  action?: 'delete'
+  operationType?: 'delete'
 }
 
 export interface ProcessFileImportJobResponse {

package/src/@types/file-upload.ts

@@ -53,7 +53,7 @@ export interface ProcessUploadedFileRequestParameters {
   projectKey: string
   importContainerKey: string
   resourceType: ResourceTypeId
-  action?: 'delete' // Currently only 'delete' action is supported
+  action?: 'delete'
 }
 
 export type ProcessFileResponse = {

package/src/@utils/error-mapping.spec.ts

@@ -6,6 +6,8 @@ type RowErrorsResponse = {
   errors: Array<{ field: string; code: string; message: string }>
 }
 
+// Note: Both `row` and `index` are included in the output for backwards compatibility
+// Old flow uses `row`, new flow uses `index`. After migration, `row` will be removed
 describe('mapUploadFileErrorsResponseToUploadFileErrorRows', () => {
   it('should return an empty array if uploadFileErrorsResponse is undefined', () => {
     const result = mapUploadFileErrorsResponseToUploadFileErrorRows(undefined)
@@ -47,6 +49,7 @@ describe('mapUploadFileErrorsResponseToUploadFileErrorRows', () => {
           "code": "InvalidField",
           "field": "name.de2",
           "id": "1",
+          "index": 1,
           "row": 1,
           "validationMessage": ""name.de2" is not allowed",
         },
@@ -54,6 +57,7 @@ describe('mapUploadFileErrorsResponseToUploadFileErrorRows', () => {
           "code": "InvalidField",
           "field": "name.enn",
           "id": "2",
+          "index": 1,
           "row": 1,
           "validationMessage": ""name.enn" is not allowed",
         },
@@ -61,6 +65,7 @@ describe('mapUploadFileErrorsResponseToUploadFileErrorRows', () => {
           "code": "InvalidField",
           "field": "slug.RU",
           "id": "3",
+          "index": 2,
           "row": 2,
           "validationMessage": ""slug.RU" is not allowed",
         },
@@ -104,6 +109,7 @@ describe('mapUploadFileErrorsResponseToUploadFileErrorRows', () => {
           "field": "name.de2",
           "id": "1",
           "index": 0,
+          "row": 0,
           "validationMessage": ""name.de2" is not allowed",
         },
         {
@@ -111,6 +117,7 @@ describe('mapUploadFileErrorsResponseToUploadFileErrorRows', () => {
           "field": "name.enn",
           "id": "2",
           "index": 0,
+          "row": 0,
           "validationMessage": ""name.enn" is not allowed",
         },
         {
@@ -118,6 +125,7 @@ describe('mapUploadFileErrorsResponseToUploadFileErrorRows', () => {
           "field": "slug.RU",
           "id": "3",
           "index": 1,
+          "row": 1,
           "validationMessage": ""slug.RU" is not allowed",
         },
       ]

package/src/@utils/poll-job-until-processing.ts

@@ -1,5 +1,5 @@
 import { getFileImportJob } from '../@api'
-import { PollingAbortedError } from '../@errors'
+import { PollingAbortedError, PollingTimeoutError } from '../@errors'
 import type { FileImportJob } from '../@types'
 import { hasImportJobStartedProcessing } from './file-import-job-helpers'
 
@@ -64,9 +64,6 @@ export const pollJobUntilProcessing = async ({
     attempts++
   }
 
-  throw new Error(
-    `Job did not start processing after ${maxAttempts} attempts (${
-      (maxAttempts * pollingInterval) / 1000
-    }s)`
-  )
+  const totalTimeSeconds = (maxAttempts * pollingInterval) / 1000
+  throw new PollingTimeoutError(maxAttempts, totalTimeSeconds)
 }

package/src/@utils/poll-job-until-validated.ts

@@ -1,5 +1,5 @@
 import { getFileImportJob } from '../@api'
-import { PollingAbortedError } from '../@errors'
+import { PollingAbortedError, PollingTimeoutError } from '../@errors'
 import type { FileImportJob } from '../@types'
 import { isImportJobTerminal } from './file-import-job-helpers'
 
@@ -68,9 +68,6 @@ export const pollJobUntilValidated = async ({
     attempts++
   }
 
-  throw new Error(
-    `Job validation timeout after ${maxAttempts} attempts (${
-      (maxAttempts * pollingInterval) / 1000
-    }s)`
-  )
+  const totalTimeSeconds = (maxAttempts * pollingInterval) / 1000
+  throw new PollingTimeoutError(maxAttempts, totalTimeSeconds)
 }