@haus-tech/product-import-export-plugin 3.6.3 → 3.6.4

package/CHANGELOG.md

@@ -1,85 +1,34 @@
-## 3.3.11-next.1
-
-### 🚀 Features
-
-- **product-import-export-plugin:** backport id export field + customExportColumns to 3.5 line (3.3.11-next.0) ([#22](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/pull/22))
-
-## 3.3.11-next.0
-
-### 🚀 Features
-
-- **product-import-export-plugin:** add progress reporting to product export process ([ed6220e](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/ed6220e))
-- **product-import-export-plugin:** optimize product export process and stock level retrieval ([d281929](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/d281929))
-- **product-import-export-plugin:** enhance email notification and import/export functionality ([c133dc5](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/c133dc5))
-- **product-import-export-plugin:** enforce import/export acceptance criteria and enhance documentation ([b1a93b6](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/b1a93b6))
-- **product-import-export-plugin:** update pre-version command and clean up export artifacts ([1cde024](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/1cde024))
-- **product-import-export-plugin:** optimize asset handling and caching in product importer ([9d2888e](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/9d2888e))
-- **product-import-export-plugin:** enhance testing and export functionality ([1764eb2](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/1764eb2))
+## 3.6.3
 
 ### 🩹 Fixes
 
-- **product-import-export-plugin:** ensure tax category is always assigned to product variants ([276bed5](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/276bed5))
-- **product-import-export-plugin:** poll exports list and restore featured asset on import ([2c61b48](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/2c61b48))
+- **product-import-export-plugin:** secure REST API, stop leaking storage credentials ([#24](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/pull/24))
 
-## 3.3.10-next.6
+## 3.6.2
 
-### 🩹 Fixes
-
-- **product-import-export-plugin:** ensure tax category is always assigned to product variants ([276bed5](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/276bed5))
-
-## 3.3.10-next.5
-
-### 🚀 Features
-
-- **product-import-export-plugin:** add progress reporting to product export process ([ed6220e](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/ed6220e))
+This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes.
 
-## 3.3.10-next.4
+## 3.6.1
 
 ### 🚀 Features
 
-- **product-import-export-plugin:** optimize product export process and stock level retrieval ([d281929](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/d281929))
+- add custom changelog renderer to filter out prerelease versions ([4412746](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/4412746))
 
-## 3.3.10-next.3
-
-### 🚀 Features
-
-- **product-import-export-plugin:** optimize product export process and stock level retrieval ([d281929](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/d281929))
-
-## 3.3.10-next.2
-
-### 🩹 Fixes
-
-- **product-import-export-plugin:** poll exports list and restore featured asset on import ([2c61b48](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/2c61b48))
-
-## 3.3.2-next.2
+## 3.6.0
 
 ### 🚀 Features
 
+- **product-import-export-plugin:** integrate active channel management into export and import components ([1d3eef1](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/1d3eef1))
+- **product-import-export-plugin:** add installation ID and enhance e2e database management ([78eeffb](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/78eeffb))
+- **product-import-export-plugin:** add popover help for export asset options ([7aa8373](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/7aa8373))
+- **product-import-export-plugin:** implement export configuration panel and enhance export dialog ([d2e1f34](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/d2e1f34))
+- **product-import-export-plugin:** enhance product export functionality and update tests ([de56d44](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/de56d44))
+- **product-import-export-plugin:** update dependencies and enhance import/export functionality ([9c78665](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/9c78665))
 - **product-import-export-plugin:** enhance email notification and import/export functionality ([c133dc5](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/c133dc5))
-
-## 3.3.2-next.1
-
-### 🚀 Features
-
 - **product-import-export-plugin:** enforce import/export acceptance criteria and enhance documentation ([b1a93b6](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/b1a93b6))
 - **product-import-export-plugin:** update pre-version command and clean up export artifacts ([1cde024](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/1cde024))
-
-## 3.3.2-next.0
-
-### 🚀 Features
-
 - **product-import-export-plugin:** optimize asset handling and caching in product importer ([9d2888e](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/9d2888e))
 - **product-import-export-plugin:** enhance testing and export functionality ([1764eb2](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/1764eb2))
-- **product-import-export-plugin:** enforce import/export acceptance criteria (column-presence updates, multi-variant option requirements, no ProductID export option, clearer import CTA, and strict required relation custom-field validation)
-
-## 3.3.1
-
-This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes.
-
-## 3.3.1-next.0
-
-### 🚀 Features
-
 - enhance file name validation for product export functionality ([f9d5a45](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/f9d5a45))
 - enhance export storage strategy configuration ([d589906](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/d589906))
 - abstract logic into separate strategies ([1c7d0c7](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/1c7d0c7))
@@ -88,8 +37,15 @@ This was a version bump only for product-import-export-plugin to align it with o
 
 ### 🩹 Fixes
 
+- **plugins:** correct Vendure compatibility and add hub-required JSDoc ([ae089bd](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/ae089bd))
+- **product-import-export-plugin:** poll exports list and restore featured asset on import ([644099a](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/644099a))
+- **product-import-export-plugin:** update dashboard and export settings screenshots ([2129b39](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/2129b39))
 - correct file path handling and ensure consistent file name sanitization in product export ([03a5bb5](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/03a5bb5))
 
+## 3.3.1
+
+This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes.
+
 ## 3.2.1
 
 This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes.

package/{README.mdx → README.md}

@@ -1,8 +1,8 @@
 ---
 name: product-import-export-plugin
-title: Product Import & Export Plugin
+title: Product Import & Export
 description: Vendure plugin for importing and exporting product data via CSV.
-version: 3.3.1
+version: 3.6.3
 tags:
   - vendure
   - plugin
@@ -19,20 +19,20 @@ A Vendure plugin for importing and exporting product data via CSV. Supports bulk
 
 ## Features
 
-* **Import** – Bulk upload products from CSV with validation, custom fields, assets, facets, and variants
-* **Export** – Export products to CSV with selected fields; export all products or a selection
-* **Storage strategies** – Store exported files in S3 or locally on disk (with automatic fallback)
-* **UI** – Admin UI and Dashboard integration for import and export
+- **Import** – Bulk upload products from CSV with validation, custom fields, assets, facets, and variants
+- **Export** – Export products to CSV with selected fields; export all products or a selection
+- **Storage strategies** – Store exported files in S3 or locally on disk (with automatic fallback)
+- **UI** – Admin UI and Dashboard integration for import and export
 
 ![Dashboard UI](assets/Screenshot-dashboard-ui.png)
 
 ## Compatibility
 
-Vendure **^2.0.0** or **^3.0.0**
+Vendure **^3.6.0**
 
 ## Getting started
 
-```bash npm2yarn
+```bash
 npm install @haus-tech/product-import-export-plugin
 ```
 
@@ -65,13 +65,13 @@ export const config = {
 
 ### Import options
 
-| Option                   | Type                                            | Default    | Description                                                                                                                  |
-| ------------------------ | ----------------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------- |
-| `updateProductSlug`      | `boolean`                                       | `true`     | Update product slug from the `name` field in the CSV                                                                         |
-| `restoreSoftDeleted`     | `boolean`                                       | `true`     | Restore soft-deleted products/variants found by id or SKU during import. If `false`, new products will be created instead. |
-| `storageStrategy`        | `ImportJobStorageStrategy`                      | local disk | Strategy instance for queued import file storage and retrieval.                                                              |
-| `storageStrategyFactory` | `(injector: Injector) => ImportJobStorageStrategy` | `undefined` | Factory for DI-aware strategy creation (recommended for S3/remote storage).                                                  |
-| `importJobStorage`       | `'local' \| 's3'`                              | `'local'`  | Deprecated compatibility flag. Prefer `storageStrategy` / `storageStrategyFactory`.                                          |
+| Option                   | Type                                               | Default     | Description                                                                                                                |
+| ------------------------ | -------------------------------------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------- |
+| `updateProductSlug`      | `boolean`                                          | `true`      | Update product slug from the `name` field in the CSV                                                                       |
+| `restoreSoftDeleted`     | `boolean`                                          | `true`      | Restore soft-deleted products/variants found by id or SKU during import. If `false`, new products will be created instead. |
+| `storageStrategy`        | `ImportJobStorageStrategy`                         | local disk  | Strategy instance for queued import file storage and retrieval.                                                            |
+| `storageStrategyFactory` | `(injector: Injector) => ImportJobStorageStrategy` | `undefined` | Factory for DI-aware strategy creation (recommended for S3/remote storage).                                                |
+| `importJobStorage`       | `'local' \| 's3'`                                  | `'local'`   | Deprecated compatibility flag. Prefer `storageStrategy` / `storageStrategyFactory`.                                        |
 
 Available import storage strategies:
 
@@ -95,8 +95,8 @@ Available import storage strategies:
 
 The plugin supports configurable storage for exported files:
 
-* **S3** – Stores export files in an S3-compatible bucket
-* **Disk (default)** – Saves files locally on the server
+- **S3** – Stores export files in an S3-compatible bucket
+- **Disk (default)** – Saves files locally on the server
 
 ### Custom export columns
 
@@ -140,22 +140,21 @@ export const config = {
 
 ### Optional columns
 
-| Column                        | Format                                                       | Example                                                                                    |
-| ----------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
-| `id`                          | Vendure product id                                            | `42`                                                                                        |
-| `name`, `slug`, `description` | Text, or `name:en`, `name:sv` for translations               | `My Product`                                                                               |
-| `assets`                      | Pipe-separated URLs, or JSON `[{"url":"...","name":"..."}]`  | `https://example.com/1.jpg\|https://example.com/2.jpg`                                     |
-| `facets`                      | `facet:value` pairs, pipe-separated                          | `Brand:Acme\|Category:Electronics`                                                         |
-| `optionGroups`                | Pipe-separated group names                                   | `Size\|Color`                                                                              |
-| `optionValues`                | Pipe-separated values (order matches option groups)          | `Large\|Blue`                                                                              |
-| `price`                       | Number (in smallest currency unit)                           | `9999`                                                                                     |
-| `taxCategory`                 | Tax category name                                            | `standard`                                                                                 |
-| `stockOnHand`                 | Number                                                       | `100`                                                                                      |
-| `trackInventory`              | `true` or `false`                                            | `true`                                                                                     |
-| `variantAssets`               | Same format as `assets`                                      | `https://example.com/variant.jpg`                                                          |
-| `variantFacets`               | Same format as `facets`                                      | `Material:Cotton`                                                                          |
-| `enabled`                     | `true` or `false`                                            | `true`                                                                                     |
-| Custom fields                 | Column name = custom field name; value depends on field type | Add columns for any Product or ProductVariant custom fields defined in your Vendure config |
+| Column                        | Format                                                                                                                             | Example                                                                                    |
+| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
+| `name`, `slug`, `description` | Text, or `name:en`, `name:sv` for translations                                                                                     | `My Product`                                                                               |
+| `assets`                      | Pipe-separated URLs, or JSON `[{"url":"...","name":"..."}]`                                                                        | `https://example.com/1.jpg\|https://example.com/2.jpg`                                     |
+| `facets`                      | `facet:value` pairs, pipe-separated                                                                                                | `Brand:Acme\|Category:Electronics`                                                         |
+| `optionGroups`                | Pipe-separated group names. Use `name:code` to share a group across products (see [Sharing option groups](#sharing-option-groups)) | `Size\|Color` or `size:shoe-size`                                                          |
+| `optionValues`                | Pipe-separated values (order matches option groups)                                                                                | `Large\|Blue`                                                                              |
+| `price`                       | Number (in smallest currency unit)                                                                                                 | `9999`                                                                                     |
+| `taxCategory`                 | Tax category name                                                                                                                  | `standard`                                                                                 |
+| `stockOnHand`                 | Number                                                                                                                             | `100`                                                                                      |
+| `trackInventory`              | `true` or `false`                                                                                                                  | `true`                                                                                     |
+| `variantAssets`               | Same format as `assets`                                                                                                            | `https://example.com/variant.jpg`                                                          |
+| `variantFacets`               | Same format as `facets`                                                                                                            | `Material:Cotton`                                                                          |
+| `enabled`                     | `true` or `false`                                                                                                                  | `true`                                                                                     |
+| Custom fields                 | Column name = custom field name; value depends on field type                                                                       | Add columns for any Product or ProductVariant custom fields defined in your Vendure config. Relation custom fields export the related entity's id (`id\|id` for list fields), including fields that relate a product or variant to its own entity type. |
 
 #### Import behavior rules
 
@@ -163,6 +162,28 @@ export const config = {
 - If a column exists in the header but the cell is empty, that field is explicitly cleared.
 - For products with more than one variant, `optionGroups` and `optionValues` are required.
 
+#### Sharing option groups
+
+By default, each product gets its own option groups. To **share an option group** across
+multiple products (e.g. a common "Size" group for all shoes), use the `name:code` syntax in the
+`optionGroups` column: `size:shoe-size`. All products that reference the same code will share
+a single option group. Products using a plain name (e.g. just `size`) will each get their own
+independent option group.
+
+```csv
+...optionGroups     , optionValues , ...
+# Each shoe product shares a single "shoe-size" option group:
+"size:shoe-size"    , Small        , ...
+"size:shoe-size"    , Medium       , ...
+# This product gets its own independent "size" group:
+"size"              , 4GB          , ...
+```
+
+The first product to reference a given code defines the full set of option values for that
+shared group; subsequent products may use any subset of those values. Codes are language-
+agnostic — only the `name` portion before the colon is translated per language column
+(`optionGroups:en`, `optionGroups:sv`, etc.).
+
 #### Multi-language support
 
 Use language-specific columns by suffixing the field name with the language code. The language codes must match those configured in your Vendure instance (e.g. `en`, `sv`).
@@ -212,8 +233,10 @@ The Admin UI offers basic import and export. Some features such as the export-al
 2. Configure export fields (assets, facets, custom fields, etc.).
    - For products with more than one variant, `optionGroups` and `optionValues` must be included.
    - `id` (the Vendure product id) is available as a selectable export field. It is written after the translated `name`/`slug`/`description` columns, so it is never CSV column 0, since import treats column 0 positionally as a product id for by-id matching.
-   - If `customFields` are not selected, no custom-field columns are written to the CSV.
    - If `customExportColumns` is configured, only the columns whose `name` is selected are written to the CSV.
+   - The job reports progress per page; the Dashboard job queue shows it.
+   - `productId` is not available as a selectable export field.
+   - If `customFields` are not selected, no custom-field columns are written to the CSV.
 3. Choose asset format: URL or JSON.
 4. Start the export (it is added to a job queue and runs in the background).
 5. Download the CSV when the export is complete. Your downloaded files will be listed in the export view.
@@ -230,7 +253,11 @@ Note: templates for `@vendure/email-plugin` should be valid MJML.
 
 ```typescript
 import path from 'path'
-import { DefaultEmailPlugin, FileBasedTemplateLoader, defaultEmailHandlers } from '@vendure/email-plugin'
+import {
+  DefaultEmailPlugin,
+  FileBasedTemplateLoader,
+  defaultEmailHandlers,
+} from '@vendure/email-plugin'
 import {
   withProductExportedHandler,
   withProductExportedTemplateFallback,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@haus-tech/product-import-export-plugin",
-  "version": "3.6.3",
+  "version": "3.6.4",
   "description": "A Vendure plugin for importing and exporting products using a CSV file",
   "author": "Haus Tech",
   "repository": {
@@ -35,7 +35,7 @@
   "files": [
     "src",
     "assets",
-    "README.mdx",
+    "README.md",
     "CHANGELOG.md"
   ],
   "scripts": {
@@ -46,20 +46,20 @@
   },
   "dependencies": {
     "@aws-sdk/client-s3": "^3.744.0",
-    "axios": "^1.7.0",
-    "bottleneck": "^2.19.5",
+    "axios": "^1.16.1",
     "fs-extra": "^11.2.0",
-    "lodash": "^4.17.21"
+    "lodash": "^4.18.1"
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.4",
-    "csv-parse": "^5.6.0",
+    "@vendure/email-plugin": "3.6.3",
+    "csv-parse": "^6.0.0",
     "csv-stringify": "^6.6.0"
   },
   "peerDependencies": {
-    "@vendure/core": "^2.0.0 || ^3.0.0",
-    "@vendure/email-plugin": "^2.0.0 || ^3.0.0",
-    "csv-parse": "^5.5.6",
+    "@vendure/core": "^3.6.0",
+    "@vendure/email-plugin": "^3.6.0",
+    "csv-parse": "^6.0.0",
     "csv-stringify": "^6.5.1",
     "slug": "^9.1.0"
   },

package/src/dashboard/bulk-export.tsx

@@ -22,6 +22,7 @@ export function ExportProductsBulkAction({
   return (
     <>
       <DataTableBulkActionItem
+        closeOnClick={false}
         onClick={() => setDialogOpen(true)}
         label="Export products to CSV"
         icon={DownloadIcon}