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

package/src/services/self-relation-custom-fields.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.splitSelfRelationCustomFields = splitSelfRelationCustomFields;
+exports.loadSelfRelationCustomFieldIds = loadSelfRelationCustomFieldIds;
+const lodash_1 = require("lodash");
+/** Owner ids per query, far below Postgres' 65 535 bind parameter limit. */
+const ID_CHUNK_SIZE = 1000;
+/**
+ * Splits an entity's relation custom fields into paths that can be loaded through
+ * `ProductService.findAll` / repository `relations`, and self-referencing fields (a Product field
+ * relating to Product, a ProductVariant field relating to ProductVariant). TypeORM joins a
+ * self-referencing relation under the owner table's own alias a second time, which Postgres rejects
+ * ("table name specified more than once"), so those must be loaded with
+ * {@link loadSelfRelationCustomFieldIds} instead.
+ */
+function splitSelfRelationCustomFields(fields, owner, prefix) {
+    const relationFields = fields.filter((field) => field.type === 'relation');
+    return {
+        relations: relationFields
+            .filter((field) => field.entity !== owner)
+            .map((field) => `${prefix}${field.name}`),
+        selfRelationNames: relationFields
+            .filter((field) => field.entity === owner)
+            .map((field) => field.name),
+    };
+}
+/**
+ * Loads the related ids of self-referencing relation custom fields with an explicit join alias,
+ * one query per field. Returns a map keyed by the stringified owner id; each entry holds every
+ * requested field: `ID | null` for a single relation, `ID[]` (possibly empty) for a list.
+ */
+async function loadSelfRelationCustomFieldIds(repository, alias, ids, fields) {
+    const byOwnerId = new Map();
+    if (ids.length === 0 || fields.length === 0) {
+        return byOwnerId;
+    }
+    for (const id of ids) {
+        byOwnerId.set(String(id), Object.fromEntries(fields.map((field) => [field.name, field.list ? [] : null])));
+    }
+    for (const [field, idChunk] of fields.flatMap((field) => (0, lodash_1.chunk)(ids, ID_CHUNK_SIZE).map((idChunk) => [field, idChunk]))) {
+        const rows = await repository
+            .createQueryBuilder(alias)
+            .select(`${alias}.id`, 'ownerId')
+            .addSelect('related.id', 'relatedId')
+            .innerJoin(`${alias}.customFields.${field.name}`, 'related')
+            .where(`${alias}.id IN (:...ids)`, { ids: idChunk })
+            // A stable order for list fields; the join table stores no position.
+            .orderBy('related.id', 'ASC')
+            .getRawMany();
+        for (const row of rows) {
+            const entry = byOwnerId.get(String(row.ownerId));
+            if (!entry) {
+                continue;
+            }
+            const current = entry[field.name];
+            if (Array.isArray(current)) {
+                // The array was created above for this call only, so appending in place is safe.
+                current.push(row.relatedId);
+            }
+            else {
+                entry[field.name] = row.relatedId;
+            }
+        }
+    }
+    return byOwnerId;
+}
+//# sourceMappingURL=self-relation-custom-fields.js.map

package/src/services/self-relation-custom-fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"self-relation-custom-fields.js","sourceRoot":"","sources":["../../../../../packages/product-import-export-plugin/src/services/self-relation-custom-fields.ts"],"names":[],"mappings":";;AAsBA,sEAcC;AAOD,wEA2CC;AArFD,mCAA8B;AAG9B,4EAA4E;AAC5E,MAAM,aAAa,GAAG,IAAI,CAAA;AAS1B;;;;;;;GAOG;AACH,SAAgB,6BAA6B,CAC3C,MAA2B,EAC3B,KAA6C,EAC7C,MAAc;IAEd,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,UAAU,CAAC,CAAA;IAC1E,OAAO;QACL,SAAS,EAAE,cAAc;aACtB,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC;aACzC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAC3C,iBAAiB,EAAE,cAAc;aAC9B,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC;aACzC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;KAC9B,CAAA;AACH,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,8BAA8B,CAClD,UAA4D,EAC5D,KAAa,EACb,GAAS,EACT,MAA8C;IAE9C,MAAM,SAAS,GAAG,IAAI,GAAG,EAA4C,CAAA;IACrE,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5C,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;QACrB,SAAS,CAAC,GAAG,CACX,MAAM,CAAC,EAAE,CAAC,EACV,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAChF,CAAA;IACH,CAAC;IACD,KAAK,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CACtD,IAAA,cAAK,EAAC,GAAG,EAAE,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,OAAO,CAAU,CAAC,CACtE,EAAE,CAAC;QACF,MAAM,IAAI,GAAG,MAAO,UAAmD;aACpE,kBAAkB,CAAC,KAAK,CAAC;aACzB,MAAM,CAAC,GAAG,KAAK,KAAK,EAAE,SAAS,CAAC;aAChC,SAAS,CAAC,YAAY,EAAE,WAAW,CAAC;aACpC,SAAS,CAAC,GAAG,KAAK,iBAAiB,KAAK,CAAC,IAAI,EAAE,EAAE,SAAS,CAAC;aAC3D,KAAK,CAAC,GAAG,KAAK,kBAAkB,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC;YACpD,qEAAqE;aACpE,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC;aAC5B,UAAU,EAAkC,CAAA;QAC/C,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAA;YAChD,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,SAAQ;YACV,CAAC;YACD,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YACjC,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC3B,iFAAiF;gBACjF,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;YAC7B,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,SAAS,CAAA;YACnC,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC"}

package/src/types.d.ts

@@ -1,6 +1,6 @@
 import { ID } from '@vendure/core';
 import { ParsedProduct, ParsedProductWithVariants } from './providers/import-providers/import-parser';
-import type { Injector } from '@vendure/core';
+import type { Injector, Product, ProductVariant, RequestContext } from '@vendure/core';
 import { ExportStorageStrategy } from './services/export-storage/export-storage-strategy';
 import { ImportJobStorageStrategy } from './services/import-storage/import-job-storage-strategy';
 /**
@@ -68,8 +68,35 @@ export interface PluginInitOptions {
          * Preferred configuration: provide a factory which can use Vendure's DI via the Injector.
          */
         storageStrategyFactory?: (injector: Injector) => ExportStorageStrategy | Promise<ExportStorageStrategy>;
+        /**
+         * @description
+         * Optional. If omitted, the default local-disk strategy is used.
+         */
+        /**
+         * @description
+         * Optional. Additional CSV columns appended after the built-in export fields.
+         * Each column's `name` must not contain `:` and must not collide with a
+         * built-in export field name; names must also be unique. Validated at
+         * plugin init time.
+         */
+        customExportColumns?: CustomExportColumn[];
     };
 }
+/**
+ * @description
+ * A custom column added to the product export CSV. Only included in the output
+ * when its `name` is present in the caller-selected export fields.
+ *
+ * @category Options
+ */
+export interface CustomExportColumn {
+    /** CSV column name. No ':' and no collision with built-in export fields. */
+    name: string;
+    /** Awaited once per export job before the first resolve. Use to reset caches. */
+    onExportStart?: () => void | Promise<void>;
+    /** Called per variant row; return value is written to the cell ('' for null/undefined). */
+    resolve: (ctx: RequestContext, injector: Injector, product: Product, variant: ProductVariant) => Promise<unknown> | unknown;
+}
 export type ParsedProductWithId = ParsedProductWithVariants & {
     product: ParsedProduct & {
         productId: number | null;
@@ -81,7 +108,7 @@ export type JsonAsset = {
     name?: string;
 };
 type ExportFields = Array<ProductFields | VariantFields>;
-type ProductFields = 'name' | 'slug' | 'description' | 'assets' | 'facets' | 'optionGroups';
+type ProductFields = 'id' | 'name' | 'slug' | 'description' | 'assets' | 'facets' | 'optionGroups';
 type VariantFields = 'sku' | 'optionValues' | 'price' | 'taxCategory' | 'stockOnHand' | 'trackInventory' | 'variantAssets' | 'variantFacets' | 'enabled';
 export type UpdatingStrategy = 'replace' | 'merge';
 export {};

package/src/ui/components/product-import.component.ts

@@ -60,6 +60,7 @@ export class ProductImportComponent implements OnInit {
       method: 'GET',
       headers: {
         'Content-Type': 'application/json',
+        ...this.getRequestHeaders(),
       },
     })
       .then((res) => res.json())

package/README.mdx

@@ -1,244 +0,0 @@
----
-name: product-import-export-plugin
-title: Product Import & Export
-description: Vendure plugin for importing and exporting product data via CSV.
-version: 3.6.0-next.2
-tags:
-  - vendure
-  - plugin
-  - import
-  - export
-  - products
-  - csv
-  - bulk
----
-
-# Product Import Export Plugin
-
-A Vendure plugin for importing and exporting product data via CSV. Supports bulk product management and data migration between environments.
-
-## 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
-
-![Dashboard UI](assets/Screenshot-dashboard-ui.png)
-
-## Compatibility
-
-Vendure **^3.6.0**
-
-## Getting started
-
-```bash npm2yarn
-npm install @haus-tech/product-import-export-plugin
-```
-
-## Configuration
-
-Add the plugin to your Vendure configuration.
-
-```typescript
-export const config = {
-  plugins: [
-    ProductImportExportPlugin.init({
-      importOptions: {}, // Configure import options
-      exportOptions: {
-        storageStrategy: 's3', // 's3' | 'disk'
-        s3Options: {
-          bucket: 'your-bucket',
-          region: 'your-region',
-          credentials: {
-            accessKeyId: '...',
-            secretAccessKey: '...',
-          },
-        },
-      },
-    }),
-  ],
-}
-```
-
-## Configuration Options
-
-### 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`.                                        |
-
-Available import storage strategies:
-
-- `LocalImportJobStorageStrategy` (default)
-- `S3ImportJobStorageStrategy`
-
-### Export options
-
-| Option                  | Type                  | Default                 | Description                                                  |
-| ----------------------- | --------------------- | ----------------------- | ------------------------------------------------------------ |
-| `defaultFileName`       | `string`              | `'products_export.csv'` | Default filename for exports                                 |
-| `exportAssetsAsOptions` | `('url' \| 'json')[]` | `['url', 'json']`       | Available formats for asset export                           |
-| `defaultExportAssetsAs` | `'url' \| 'json'`     | `'url'`                 | Default asset export format                                  |
-| `defaultExportFields`   | `string[]`            | See above               | Fields that will be pre-selected in the export UI            |
-| `requiredExportFields`  | `string[]`            | `['name', 'sku']`       | Fields that must always be included                          |
-| `storageStrategy`       | `'s3' \| 'disk'`      | `'disk'`                | Where exported files are stored                              |
-| `s3Options`             | `object`              | `undefined`             | S3 configuration (required when `storageStrategy` is `'s3'`) |
-
-### Storage strategy
-
-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
-
-## CSV Format for Import
-
-### Required columns
-
-- `name` – Product name (use `name:en`, `name:sv` etc. for multiple languages)
-- `sku` – Variant SKU (unique per variant)
-
-### Optional columns
-
-| 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 |
-
-#### Import behavior rules
-
-- If a column is omitted from the CSV header, that field is left unchanged on existing products/variants.
-- 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`).
-
-| Column pattern           | Example columns        | Use case                                         |
-| ------------------------ | ---------------------- | ------------------------------------------------ |
-| `name:en`, `name:sv`     | Product name per lang  | Translated product names                         |
-| `slug:en`, `slug:sv`     | Slug per lang          | Translated URLs                                  |
-| `description:en`         | Description per lang   | Translated descriptions                          |
-| `facets:en`, `facets:sv` | Facets per lang        | Translated facet names and values                |
-| `optionGroups:en`        | Option groups per lang | Translated option group names (e.g. Size, Color) |
-| `optionValues:en`        | Option values per lang | Translated option values (e.g. Large, Blue)      |
-
-Example CSV with English and Swedish:
-
-```csv
-name:en,name:sv,sku,facets:en,facets:sv
-"Red Shirt","Röd tröja",SHIRT-001,"Color:Red|Size:Large","Färg:Röd|Storlek:Stor"
-```
-
-#### Multiple values (pipe separator)
-
-Fields that can have multiple values use the pipe character `|` as a separator:
-
-- **Facets**: `Brand:Acme|Category:Electronics`
-- **Option groups**: `Size|Color`
-- **Option values**: `Large|Blue` (order matches option groups)
-- **Assets**: `https://example.com/1.jpg|https://example.com/2.jpg`
-
-## Usage
-
-:::note
-The Admin UI offers basic import and export. Some features such as the export-all option and the list of exported files are only available in the Dashboard. New features will be added to the Dashboard only.
-:::
-
-### Importing products
-
-1. Create a CSV with the columns above.
-2. Go to the Admin UI or Dashboard and open the Product Import section.
-3. Upload the CSV and choose options (update slugs, restore soft-deleted, main language).
-4. Select the update strategy: **merge** (keep existing facets/assets) or **replace** (overwrite).
-5. Start the import.
-
-### Exporting products
-
-1. In the Admin UI or Dashboard, select products to export (or use bulk export).
-2. Configure export fields (assets, facets, custom fields, etc.).
-   - For products with more than one variant, `optionGroups` and `optionValues` must be included.
-   - `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.
-
-![Export settings](assets/Screenshot-export-settings.png)
-
-## Optional: Email notification on export complete
-
-If you use `@vendure/email-plugin`, you can add an email notification when an export finishes from the `/email` subpath.
-
-The plugin now provides a default fallback template for `product-export-complete/body.hbs`.  
-If you define your own template in your app's template directory, your template takes precedence.
-Note: templates for `@vendure/email-plugin` should be valid MJML.
-
-```typescript
-import path from 'path'
-import {
-  DefaultEmailPlugin,
-  FileBasedTemplateLoader,
-  defaultEmailHandlers,
-} from '@vendure/email-plugin'
-import {
-  withProductExportedHandler,
-  withProductExportedTemplateFallback,
-} from '@haus-tech/product-import-export-plugin/email'
-
-export const config = {
-  plugins: [
-    DefaultEmailPlugin.init({
-      handlers: withProductExportedHandler(defaultEmailHandlers),
-      templateLoader: withProductExportedTemplateFallback(
-        new FileBasedTemplateLoader(path.join(__dirname, '../static/email/templates')),
-      ),
-    }),
-  ],
-}
-```
-
-## Resources
-
-- [Vendure Plugin Documentation](https://docs.vendure.io/guides/developer-guide/plugins/)
-- [Vendure Import/Export Guide](https://docs.vendure.io/guides/developer-guide/importing-data/)