@commercetools-frontend-extensions/operations 0.0.0-canary-20251209161906

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (180) hide show
  1. package/CHANGELOG.md +61 -0
  2. package/README.md +178 -0
  3. package/babel.config.js +6 -0
  4. package/dist/commercetools-frontend-extensions-operations.cjs.d.ts +2 -0
  5. package/dist/commercetools-frontend-extensions-operations.cjs.dev.js +3273 -0
  6. package/dist/commercetools-frontend-extensions-operations.cjs.js +7 -0
  7. package/dist/commercetools-frontend-extensions-operations.cjs.prod.js +3265 -0
  8. package/dist/commercetools-frontend-extensions-operations.esm.js +3074 -0
  9. package/dist/declarations/src/@api/export-operations.d.ts +5 -0
  10. package/dist/declarations/src/@api/fetcher.d.ts +17 -0
  11. package/dist/declarations/src/@api/file-import-jobs.d.ts +7 -0
  12. package/dist/declarations/src/@api/file-upload.d.ts +3 -0
  13. package/dist/declarations/src/@api/import-containers.d.ts +35 -0
  14. package/dist/declarations/src/@api/import-operations.d.ts +6 -0
  15. package/dist/declarations/src/@api/index.d.ts +9 -0
  16. package/dist/declarations/src/@api/process-file.d.ts +3 -0
  17. package/dist/declarations/src/@api/test-fixtures.d.ts +279 -0
  18. package/dist/declarations/src/@api/urls.d.ts +74 -0
  19. package/dist/declarations/src/@components/file-drop-area/active-drag-drop-area.d.ts +10 -0
  20. package/dist/declarations/src/@components/file-drop-area/disabled-drop-area.d.ts +5 -0
  21. package/dist/declarations/src/@components/file-drop-area/drop-area-wrapper.d.ts +11 -0
  22. package/dist/declarations/src/@components/file-drop-area/enabled-drop-area.d.ts +7 -0
  23. package/dist/declarations/src/@components/file-drop-area/file-drop-area.d.ts +14 -0
  24. package/dist/declarations/src/@components/file-drop-area/file-dropped-area.d.ts +6 -0
  25. package/dist/declarations/src/@components/file-drop-area/index.d.ts +7 -0
  26. package/dist/declarations/src/@components/file-drop-area/styles.d.ts +9 -0
  27. package/dist/declarations/src/@components/icons/file-icon.d.ts +2 -0
  28. package/dist/declarations/src/@components/icons/index.d.ts +2 -0
  29. package/dist/declarations/src/@components/icons/lock-icon.d.ts +2 -0
  30. package/dist/declarations/src/@components/index.d.ts +6 -0
  31. package/dist/declarations/src/@components/info-box/index.d.ts +1 -0
  32. package/dist/declarations/src/@components/info-box/info-box.d.ts +7 -0
  33. package/dist/declarations/src/@components/upload-separator/index.d.ts +1 -0
  34. package/dist/declarations/src/@components/upload-separator/upload-separator.d.ts +12 -0
  35. package/dist/declarations/src/@components/upload-settings/index.d.ts +1 -0
  36. package/dist/declarations/src/@components/upload-settings/upload-settings.d.ts +11 -0
  37. package/dist/declarations/src/@components/uploading-modal/index.d.ts +1 -0
  38. package/dist/declarations/src/@components/uploading-modal/uploading-modal.d.ts +13 -0
  39. package/dist/declarations/src/@constants/delimiters.d.ts +8 -0
  40. package/dist/declarations/src/@constants/file-import-job.d.ts +1 -0
  41. package/dist/declarations/src/@constants/import-limits.d.ts +6 -0
  42. package/dist/declarations/src/@constants/import-tags.d.ts +7 -0
  43. package/dist/declarations/src/@constants/index.d.ts +5 -0
  44. package/dist/declarations/src/@constants/resource-links.d.ts +10 -0
  45. package/dist/declarations/src/@errors/http-error.d.ts +6 -0
  46. package/dist/declarations/src/@errors/index.d.ts +9 -0
  47. package/dist/declarations/src/@errors/invalid-response-error.d.ts +3 -0
  48. package/dist/declarations/src/@errors/no-resources-to-export-error.d.ts +3 -0
  49. package/dist/declarations/src/@errors/polling-aborted-error.d.ts +3 -0
  50. package/dist/declarations/src/@errors/project-key-not-available-error.d.ts +3 -0
  51. package/dist/declarations/src/@errors/query-predicate-error.d.ts +4 -0
  52. package/dist/declarations/src/@errors/unexpected-column-error.d.ts +3 -0
  53. package/dist/declarations/src/@errors/unexpected-operation-state-error.d.ts +4 -0
  54. package/dist/declarations/src/@errors/unexpected-resource-type-error.d.ts +3 -0
  55. package/dist/declarations/src/@hooks/index.d.ts +8 -0
  56. package/dist/declarations/src/@hooks/use-fetch-export-operations.d.ts +15 -0
  57. package/dist/declarations/src/@hooks/use-fetch-file-import-job.d.ts +17 -0
  58. package/dist/declarations/src/@hooks/use-fetch-import-container-details.d.ts +15 -0
  59. package/dist/declarations/src/@hooks/use-fetch-import-operations.d.ts +16 -0
  60. package/dist/declarations/src/@hooks/use-fetch-import-summaries.d.ts +20 -0
  61. package/dist/declarations/src/@hooks/use-file-import-job-upload.d.ts +18 -0
  62. package/dist/declarations/src/@hooks/use-file-upload.d.ts +28 -0
  63. package/dist/declarations/src/@hooks/use-import-container-upload.d.ts +19 -0
  64. package/dist/declarations/src/@types/api.d.ts +13 -0
  65. package/dist/declarations/src/@types/basic-error-data-type.d.ts +5 -0
  66. package/dist/declarations/src/@types/export-operation.d.ts +97 -0
  67. package/dist/declarations/src/@types/file-import-job.d.ts +99 -0
  68. package/dist/declarations/src/@types/file-upload-result.d.ts +21 -0
  69. package/dist/declarations/src/@types/file-upload.d.ts +63 -0
  70. package/dist/declarations/src/@types/import-container.d.ts +53 -0
  71. package/dist/declarations/src/@types/import-operation.d.ts +13 -0
  72. package/dist/declarations/src/@types/import-states.d.ts +9 -0
  73. package/dist/declarations/src/@types/import-summary.d.ts +15 -0
  74. package/dist/declarations/src/@types/index.d.ts +11 -0
  75. package/dist/declarations/src/@types/shared.d.ts +7 -0
  76. package/dist/declarations/src/@utils/error-mapping.d.ts +19 -0
  77. package/dist/declarations/src/@utils/file-import-job-helpers.d.ts +12 -0
  78. package/dist/declarations/src/@utils/file-upload.d.ts +54 -0
  79. package/dist/declarations/src/@utils/form.d.ts +1 -0
  80. package/dist/declarations/src/@utils/format.d.ts +5 -0
  81. package/dist/declarations/src/@utils/import-container.d.ts +8 -0
  82. package/dist/declarations/src/@utils/index.d.ts +8 -0
  83. package/dist/declarations/src/@utils/poll-job-until-validated.d.ts +11 -0
  84. package/dist/declarations/src/@utils/url.d.ts +6 -0
  85. package/dist/declarations/src/index.d.ts +26 -0
  86. package/index.js +1 -0
  87. package/jest.test.config.js +11 -0
  88. package/package.json +62 -0
  89. package/src/@api/export-operations.ts +26 -0
  90. package/src/@api/fetcher.spec.ts +51 -0
  91. package/src/@api/fetcher.ts +137 -0
  92. package/src/@api/file-import-jobs.ts +217 -0
  93. package/src/@api/file-upload.spec.ts +85 -0
  94. package/src/@api/file-upload.ts +46 -0
  95. package/src/@api/import-containers.ts +256 -0
  96. package/src/@api/import-operations.ts +33 -0
  97. package/src/@api/index.ts +9 -0
  98. package/src/@api/process-file.spec.ts +74 -0
  99. package/src/@api/process-file.ts +53 -0
  100. package/src/@api/test-fixtures.ts +894 -0
  101. package/src/@api/urls.ts +194 -0
  102. package/src/@components/file-drop-area/active-drag-drop-area.tsx +33 -0
  103. package/src/@components/file-drop-area/disabled-drop-area.tsx +17 -0
  104. package/src/@components/file-drop-area/drop-area-wrapper.tsx +38 -0
  105. package/src/@components/file-drop-area/enabled-drop-area.tsx +27 -0
  106. package/src/@components/file-drop-area/file-drop-area.tsx +74 -0
  107. package/src/@components/file-drop-area/file-dropped-area.tsx +29 -0
  108. package/src/@components/file-drop-area/index.ts +7 -0
  109. package/src/@components/file-drop-area/styles.ts +67 -0
  110. package/src/@components/icons/file-icon.tsx +30 -0
  111. package/src/@components/icons/index.ts +2 -0
  112. package/src/@components/icons/lock-icon.tsx +34 -0
  113. package/src/@components/index.ts +6 -0
  114. package/src/@components/info-box/index.ts +1 -0
  115. package/src/@components/info-box/info-box.tsx +23 -0
  116. package/src/@components/upload-separator/index.ts +1 -0
  117. package/src/@components/upload-separator/upload-separator.tsx +61 -0
  118. package/src/@components/upload-settings/index.ts +1 -0
  119. package/src/@components/upload-settings/upload-settings.tsx +36 -0
  120. package/src/@components/uploading-modal/index.ts +1 -0
  121. package/src/@components/uploading-modal/uploading-modal.tsx +66 -0
  122. package/src/@constants/delimiters.ts +14 -0
  123. package/src/@constants/file-import-job.ts +1 -0
  124. package/src/@constants/import-limits.ts +13 -0
  125. package/src/@constants/import-tags.ts +9 -0
  126. package/src/@constants/index.ts +5 -0
  127. package/src/@constants/resource-links.ts +61 -0
  128. package/src/@errors/http-error.ts +17 -0
  129. package/src/@errors/index.ts +9 -0
  130. package/src/@errors/invalid-response-error.ts +6 -0
  131. package/src/@errors/no-resources-to-export-error.ts +6 -0
  132. package/src/@errors/polling-aborted-error.ts +6 -0
  133. package/src/@errors/project-key-not-available-error.ts +6 -0
  134. package/src/@errors/query-predicate-error.ts +10 -0
  135. package/src/@errors/unexpected-column-error.ts +6 -0
  136. package/src/@errors/unexpected-operation-state-error.ts +8 -0
  137. package/src/@errors/unexpected-resource-type-error.ts +6 -0
  138. package/src/@hooks/index.ts +8 -0
  139. package/src/@hooks/use-fetch-export-operations.ts +34 -0
  140. package/src/@hooks/use-fetch-file-import-job.spec.ts +131 -0
  141. package/src/@hooks/use-fetch-file-import-job.ts +38 -0
  142. package/src/@hooks/use-fetch-import-container-details.ts +31 -0
  143. package/src/@hooks/use-fetch-import-operations.ts +42 -0
  144. package/src/@hooks/use-fetch-import-summaries.ts +47 -0
  145. package/src/@hooks/use-fetch.spec.ts +68 -0
  146. package/src/@hooks/use-fetch.ts +76 -0
  147. package/src/@hooks/use-file-import-job-upload.spec.ts +273 -0
  148. package/src/@hooks/use-file-import-job-upload.ts +101 -0
  149. package/src/@hooks/use-file-upload.ts +223 -0
  150. package/src/@hooks/use-import-container-upload.spec.ts +297 -0
  151. package/src/@hooks/use-import-container-upload.ts +130 -0
  152. package/src/@types/api.ts +14 -0
  153. package/src/@types/basic-error-data-type.ts +5 -0
  154. package/src/@types/export-operation.ts +147 -0
  155. package/src/@types/file-import-job.ts +165 -0
  156. package/src/@types/file-upload-result.ts +23 -0
  157. package/src/@types/file-upload.ts +81 -0
  158. package/src/@types/import-container.ts +104 -0
  159. package/src/@types/import-operation.ts +31 -0
  160. package/src/@types/import-states.ts +9 -0
  161. package/src/@types/import-summary.ts +22 -0
  162. package/src/@types/index.ts +11 -0
  163. package/src/@types/shared.ts +52 -0
  164. package/src/@utils/error-mapping.spec.ts +126 -0
  165. package/src/@utils/error-mapping.ts +40 -0
  166. package/src/@utils/file-import-job-helpers.spec.ts +147 -0
  167. package/src/@utils/file-import-job-helpers.ts +47 -0
  168. package/src/@utils/file-upload.spec.ts +151 -0
  169. package/src/@utils/file-upload.ts +189 -0
  170. package/src/@utils/form.ts +20 -0
  171. package/src/@utils/format.spec.ts +62 -0
  172. package/src/@utils/format.ts +53 -0
  173. package/src/@utils/import-container.spec.ts +26 -0
  174. package/src/@utils/import-container.ts +34 -0
  175. package/src/@utils/index.ts +8 -0
  176. package/src/@utils/poll-job-until-validated.ts +76 -0
  177. package/src/@utils/url.spec.ts +75 -0
  178. package/src/@utils/url.ts +18 -0
  179. package/src/index.ts +27 -0
  180. package/tsconfig.json +9 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,61 @@
1
+ # @commercetools-frontend-extensions/operations
2
+
3
+ ## 0.0.0-canary-20251209161906
4
+
5
+ ### Major Changes
6
+
7
+ - [#1646](https://github.com/commercetools/merchant-center-operations/pull/1646) [`c1c381d`](https://github.com/commercetools/merchant-center-operations/commit/c1c381da4aa5c47c6fcc63940f164defe08170bd) Thanks [@yassinejebli](https://github.com/yassinejebli)! - feat: introduce the new Import job flow
8
+
9
+ ## 2.0.1
10
+
11
+ ### Patch Changes
12
+
13
+ - [#1640](https://github.com/commercetools/merchant-center-operations/pull/1640) [`f857821`](https://github.com/commercetools/merchant-center-operations/commit/f857821ffebd12a90b02ab5b6f77cf4cb08a495c) Thanks [@yassinejebli](https://github.com/yassinejebli)! - chore: enable npm publication for operations shared package
14
+
15
+ ## 2.0.0
16
+
17
+ ### Major Changes
18
+
19
+ - [#1638](https://github.com/commercetools/merchant-center-operations/pull/1638) [`516f918`](https://github.com/commercetools/merchant-center-operations/commit/516f9189854c90c9d30242d2b724f0882ebbebee) Thanks [@yassinejebli](https://github.com/yassinejebli)! - Publish shared operations package and update modals
20
+
21
+ ## 1.1.3
22
+
23
+ ### Patch Changes
24
+
25
+ - [#1423](https://github.com/commercetools/merchant-center-operations/pull/1423) [`d3da143`](https://github.com/commercetools/merchant-center-operations/commit/d3da1439618f27b4804b7293b0d8419508c6639a) Thanks [@renovate](https://github.com/apps/renovate)! - update all dependencies
26
+
27
+ ## 1.1.2
28
+
29
+ ### Patch Changes
30
+
31
+ - [#1382](https://github.com/commercetools/merchant-center-operations/pull/1382) [`67fde7a`](https://github.com/commercetools/merchant-center-operations/commit/67fde7aee9c41631d2e703f009fdfb3bbb091868) Thanks [@renovate](https://github.com/apps/renovate)! - update all dependencies
32
+
33
+ ## 1.1.1
34
+
35
+ ### Patch Changes
36
+
37
+ - [#1344](https://github.com/commercetools/merchant-center-operations/pull/1344) [`0ee84d2`](https://github.com/commercetools/merchant-center-operations/commit/0ee84d2d6a8c3f34f53ac750890c9f7ab68cfedf) Thanks [@renovate](https://github.com/apps/renovate)! - chore: update deps
38
+
39
+ ## 1.1.0
40
+
41
+ ### Minor Changes
42
+
43
+ - [#1282](https://github.com/commercetools/merchant-center-operations/pull/1282) [`1a8828c`](https://github.com/commercetools/merchant-center-operations/commit/1a8828c14baff2512819872a5dd895a70861185f) Thanks [@mustafaasif2](https://github.com/mustafaasif2)! - remove support for locale `zh-CN`
44
+
45
+ ## 1.0.3
46
+
47
+ ### Patch Changes
48
+
49
+ - [#1243](https://github.com/commercetools/merchant-center-operations/pull/1243) [`da123a8`](https://github.com/commercetools/merchant-center-operations/commit/da123a824ce028794562865c4d047478fcdf0812) Thanks [@renovate](https://github.com/apps/renovate)! - chore: update all dependencies
50
+
51
+ ## 1.0.2
52
+
53
+ ### Patch Changes
54
+
55
+ - [#1243](https://github.com/commercetools/merchant-center-operations/pull/1243) [`da123a8`](https://github.com/commercetools/merchant-center-operations/commit/da123a824ce028794562865c4d047478fcdf0812) Thanks [@renovate](https://github.com/apps/renovate)! - chore: update all dependencies
56
+
57
+ ## 1.0.1
58
+
59
+ ### Patch Changes
60
+
61
+ - [#1189](https://github.com/commercetools/merchant-center-operations/pull/1189) [`7e1b60f`](https://github.com/commercetools/merchant-center-operations/commit/7e1b60f9b220dc7b79d5e21f9d1ec8880b7caeac) Thanks [@renovate](https://github.com/apps/renovate)! - update all dependencies
package/README.md ADDED
@@ -0,0 +1,178 @@
1
+ # Shared operations package
2
+
3
+ Shared functionality for import/export operations across multiple frontend applications and extensions.
4
+
5
+ ## Hooks
6
+
7
+ ### `useFileUpload`
8
+
9
+ A unified hook for file uploads that handles both the old flow (import container) and new flow (file import job).
10
+
11
+ ```typescript
12
+ const { upload, isUploading, progress, validationProgress } = useFileUpload({
13
+ projectKey: string,
14
+ useJobBasedFlow?: boolean,
15
+ pollingInterval?: number,
16
+ maxPollingAttempts?: number
17
+ })
18
+ ```
19
+
20
+ **Parameters:**
21
+ - `projectKey` (required): The commercetools project key
22
+ - `useJobBasedFlow` (optional): Whether to use the job-based flow. Default: `false`
23
+ - `pollingInterval` (optional): Polling interval in ms for job-based flow. Default: `5000`
24
+ - `maxPollingAttempts` (optional): Maximum polling attempts. Default: `120`
25
+
26
+ **Returns:**
27
+ - `upload` - Function to start the upload
28
+ - `isUploading` - Whether upload is in progress
29
+ - `progress` - Upload progress (0-100)
30
+ - `validationProgress` - `{ processed: number, isValidating: boolean }` (job-based flow only)
31
+
32
+ **Usage:**
33
+ ```typescript
34
+ import { useFileUpload } from '@commercetools-frontend-extensions/operations'
35
+
36
+ const { upload, isUploading, progress, validationProgress } = useFileUpload({
37
+ projectKey,
38
+ useJobBasedFlow: isFeatureFlagEnabled
39
+ })
40
+
41
+ const abortController = new AbortController()
42
+
43
+ await upload({
44
+ file: File,
45
+ resourceType: 'product' | 'category' | ...,
46
+ settings?: {
47
+ format?: 'CSV' | 'JSON',
48
+ decimalSeparator?: '.' | ',',
49
+ resourceType?: 'product-draft' | 'category' | ...,
50
+ options?: {
51
+ publishAllChanges?: boolean,
52
+ unpublishAllChanges?: boolean
53
+ }
54
+ },
55
+ abortSignal: abortController.signal,
56
+ onSuccess: (result) => {
57
+ // result.containerKey - Import container key
58
+ // result.summary - { total, valid, invalid, fields, ignoredFields, results }
59
+ // result.jobId - Job ID (job-based flow only)
60
+ // result.job - Full job object (job-based flow only)
61
+ },
62
+ onError: (error) => { /* ... */ },
63
+ onProgress: (progress) => { /* 0-100 */ },
64
+ onValidationProgress: (job) => { /* job-based flow only */ }
65
+ })
66
+
67
+ // To cancel:
68
+ abortController.abort()
69
+ ```
70
+
71
+ ---
72
+
73
+ ### `useFetchImportOperations`
74
+
75
+ Fetches import operations for a container with optional polling.
76
+
77
+ ```typescript
78
+ const { data, error, isLoading, refetch } = useFetchImportOperations({
79
+ projectKey,
80
+ importContainerKey,
81
+ queryParams?: { limit, offset, ... },
82
+ pollingInterval?: number,
83
+ shouldContinuePolling?: (data) => boolean
84
+ })
85
+ ```
86
+
87
+ ---
88
+
89
+ ### `useFetchImportSummaries`
90
+
91
+ Fetches import summaries (containers) with optional polling.
92
+
93
+ ```typescript
94
+ const { data, error, isLoading, refetch } = useFetchImportSummaries({
95
+ projectKey,
96
+ queryParams?: { limit, offset, states, ... },
97
+ pollingInterval?: number,
98
+ shouldContinuePolling?: (data) => boolean
99
+ })
100
+ ```
101
+
102
+ ---
103
+
104
+ ### `useFetchImportContainerDetails`
105
+
106
+ Fetches details for a specific import container.
107
+
108
+ ```typescript
109
+ const { data, error, isLoading, refetch } = useFetchImportContainerDetails({
110
+ projectKey,
111
+ importContainerKey,
112
+ pollingInterval?: number,
113
+ shouldContinuePolling?: (data) => boolean
114
+ })
115
+ ```
116
+
117
+ ---
118
+
119
+ ### `useFetchExportOperations`
120
+
121
+ Fetches export operations with optional polling.
122
+
123
+ ```typescript
124
+ const { data, error, isLoading, refetch } = useFetchExportOperations({
125
+ projectKey,
126
+ queryParams?: { limit, offset, resourceTypes, ... },
127
+ pollingInterval?: number,
128
+ shouldContinuePolling?: (data) => boolean
129
+ })
130
+ ```
131
+
132
+ ---
133
+
134
+ ### `useFetchFileImportJob`
135
+
136
+ Polls a File Import Job for status updates.
137
+
138
+ ```typescript
139
+ const { data, error, isLoading, refetch } = useFetchFileImportJob({
140
+ projectKey,
141
+ importContainerKey,
142
+ jobId,
143
+ pollingInterval?: number,
144
+ shouldContinuePolling?: (job) => boolean
145
+ })
146
+ ```
147
+
148
+ **Job states:** `queued` → `processing` → `validated` → `initialising` → `ready`
149
+
150
+ ---
151
+
152
+ ## Helper Functions
153
+
154
+ ```typescript
155
+ import {
156
+ isImportJobQueued,
157
+ isImportJobProcessing,
158
+ isImportJobValidated,
159
+ isImportJobInitializing,
160
+ isImportJobReady,
161
+ shouldContinuePollingForImportValidation
162
+ } from '@commercetools-frontend-extensions/operations'
163
+ ```
164
+
165
+ ---
166
+
167
+ ## Polling Example
168
+
169
+ ```typescript
170
+ const { data, isLoading } = useFetchImportOperations({
171
+ projectKey,
172
+ importContainerKey,
173
+ pollingInterval: 5000,
174
+ shouldContinuePolling: (data) => {
175
+ return data?.results?.some(op => op.state === 'processing') ?? false
176
+ }
177
+ })
178
+ ```
@@ -0,0 +1,6 @@
1
+ module.exports = {
2
+ presets: [
3
+ '@commercetools-frontend/babel-preset-mc-app',
4
+ ['@babel/preset-react', { runtime: 'automatic' }],
5
+ ],
6
+ }
@@ -0,0 +1,2 @@
1
+ export * from "./declarations/src/index.js";
2
+ //# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbWVyY2V0b29scy1mcm9udGVuZC1leHRlbnNpb25zLW9wZXJhdGlvbnMuY2pzLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuL2RlY2xhcmF0aW9ucy9zcmMvaW5kZXguZC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSJ9