@commercetools-frontend-extensions/operations 0.0.0

package/CHANGELOG.md

@@ -0,0 +1,55 @@
+# @commercetools-frontend-extensions/operations
+
+## 2.0.1
+
+### Patch Changes
+
+- [#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
+
+## 2.0.0
+
+### Major Changes
+
+- [#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
+
+## 1.1.3
+
+### Patch Changes
+
+- [#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
+
+## 1.1.2
+
+### Patch Changes
+
+- [#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
+
+## 1.1.1
+
+### Patch Changes
+
+- [#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
+
+## 1.1.0
+
+### Minor Changes
+
+- [#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`
+
+## 1.0.3
+
+### Patch Changes
+
+- [#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
+
+## 1.0.2
+
+### Patch Changes
+
+- [#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
+
+## 1.0.1
+
+### Patch Changes
+
+- [#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

@@ -0,0 +1,169 @@
+# Shared operations package
+
+Shared functionality for import/export operations across multiple frontend applications and extensions.
+
+## Hooks
+
+### `useImportContainerUpload`
+
+Handles file upload to import containers with automatic cleanup on errors.
+
+```typescript
+const { upload, abort, isUploading, progress } = useImportContainerUpload({
+  projectKey: string
+})
+```
+
+**Parameters:**
+- `projectKey` (required): The commercetools project key
+
+**Returns:**
+- `upload`: Function to start file upload
+- `abort`: Function to cancel ongoing upload
+- `isUploading`: Boolean indicating upload state
+- `progress`: Upload progress (0-100)
+
+**Usage:**
+```typescript
+const projectKey = useApplicationContext((context) => context.project?.key)
+const { upload, isUploading, progress } = useImportContainerUpload({ 
+  projectKey: projectKey! 
+})
+
+await upload({
+  file: File,
+  resourceType: 'product' | 'category' | ...,
+  settings?: {
+    format?: 'CSV' | 'JSON',
+    decimalSeparator?: '.' | ',',
+    resourceType?: string,  // example: 'product-draft' for products
+    options?: {
+      publishAllChanges?: boolean,      // product-specific
+      unpublishAllChanges?: boolean     // product-specific
+    }
+  },
+  onSuccess: (response, containerKey) => { /* ... */ },
+  onError: (error) => { /* ... */ },
+  onProgress: (progress) => { /* ... */ }
+})
+```
+
+---
+
+### `useFetchImportOperations`
+
+Fetches import operations for a specific container with optional polling.
+
+```typescript
+const { data, error, isLoading, refetch, lastFetchTime } = useFetchImportOperations({
+  projectKey: string,
+  importContainerKey: string,
+  queryParams?: ImportOperationQueryParams,
+  pollingInterval?: number,
+  shouldContinuePolling?: (data) => boolean
+})
+```
+
+**Parameters:**
+- `projectKey` (required): The commercetools project key
+- `importContainerKey` (required): The import container key
+- `queryParams`: Optional query parameters (limit, offset, etc.)
+- `pollingInterval`: Polling interval in milliseconds
+- `shouldContinuePolling`: Function to determine if polling should continue
+
+---
+
+### `useFetchImportSummaries`
+
+Fetches import summaries (containers) with optional polling.
+
+```typescript
+const { data, error, isLoading, refetch, lastFetchTime } = useFetchImportSummaries({
+  projectKey: string,
+  queryParams?: ImportContainerQueryParams,
+  pollingInterval?: number,
+  shouldContinuePolling?: (data) => boolean
+})
+```
+
+**Parameters:**
+- `projectKey` (required): The commercetools project key
+- `queryParams`: Optional query parameters (limit, offset, states, etc.)
+- `pollingInterval`: Polling interval in milliseconds
+- `shouldContinuePolling`: Function to determine if polling should continue
+
+---
+
+### `useFetchImportContainerDetails`
+
+Fetches details for a specific import container with optional polling.
+
+```typescript
+const { data, error, isLoading, refetch, lastFetchTime } = useFetchImportContainerDetails({
+  projectKey: string,
+  importContainerKey: string,
+  pollingInterval?: number,
+  shouldContinuePolling?: (data) => boolean
+})
+```
+
+**Parameters:**
+- `projectKey` (required): The commercetools project key
+- `importContainerKey` (required): The import container key
+- `pollingInterval`: Polling interval in milliseconds
+- `shouldContinuePolling`: Function to determine if polling should continue
+
+---
+
+### `useFetchExportOperations`
+
+Fetches export operations with optional polling.
+
+```typescript
+const { data, error, isLoading, refetch, lastFetchTime } = useFetchExportOperations({
+  projectKey: string,
+  queryParams?: ExportOperationQueryParams,
+  pollingInterval?: number,
+  shouldContinuePolling?: (data) => boolean
+})
+```
+
+**Parameters:**
+- `projectKey` (required): The commercetools project key
+- `queryParams`: Optional query parameters (limit, offset, resourceTypes, etc.)
+- `pollingInterval`: Polling interval in milliseconds
+- `shouldContinuePolling`: Function to determine if polling should continue
+
+---
+
+## Notes
+
+- **All hooks require `projectKey`** to be passed explicitly (retrieved from `useApplicationContext`)
+- **Polling is opt-in** via `pollingInterval` parameter
+- **Standard return structure**: All fetch hooks return `{ data, error, isLoading, refetch, lastFetchTime }`
+- **Automatic cleanup**: `useImportContainerUpload` automatically cleans up containers on upload errors
+- **File upload limits**: The package exports backend-recommended limits enforced in frontend validation:
+  - `MAX_FILE_SIZE_MB` (35 MB)
+  - `MAX_ROW_COUNT` (80,000)
+- **Internal use only**: This package also exports additional components, utilities, types, and API functions that are intended for internal use within the operations repository (operations app and frontend extensions). Only the hooks documented above are considered stable public API for external consumption.
+
+---
+
+## Common patterns
+
+### Polling example
+
+```typescript
+const POLL_INTERVAL = 5000 // 5 seconds
+
+const { data, isLoading } = useFetchImportOperations({
+  projectKey,
+  importContainerKey,
+  pollingInterval: POLL_INTERVAL,
+  shouldContinuePolling: (data) => {
+    // Stop polling when all operations are completed
+    return data?.results?.some(op => op.state === 'processing') ?? false
+  }
+})
+```
+

package/babel.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  presets: [
+    '@commercetools-frontend/babel-preset-mc-app',
+    ['@babel/preset-react', { runtime: 'automatic' }],
+  ],
+}

package/dist/commercetools-frontend-extensions-operations.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "./declarations/src/index.js";
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbWVyY2V0b29scy1mcm9udGVuZC1leHRlbnNpb25zLW9wZXJhdGlvbnMuY2pzLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuL2RlY2xhcmF0aW9ucy9zcmMvaW5kZXguZC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSJ9