@haus-tech/product-import-export-plugin 3.0.9 → 3.0.11-rc.0

package/dist/providers/import-providers/product-importer.js

@@ -13,6 +13,7 @@ exports.ProductImporter = void 0;
 const common_1 = require("@nestjs/common");
 const core_1 = require("@vendure/core");
 const rxjs_1 = require("rxjs");
+const generated_types_1 = require("@vendure/common/lib/generated-types");
 const extended_fast_importer_service_1 = require("../../services/extended-fast-importer.service");
 const lodash_1 = require("lodash");
 const normalize_string_1 = require("../../helpers/normalize-string");
@@ -312,12 +313,16 @@ let ProductImporter = class ProductImporter {
             if (existingProduct && updatingStrategy === 'replace') {
                 await this.fastImporter.removeAllAssetsFromProduct(existingProduct);
             }
+            const getFeaturedAssetId = (product) => {
+                if (product?.featuredAsset) {
+                    const assetIsImage = product.featuredAsset.type === generated_types_1.AssetType.IMAGE;
+                    return assetIsImage ? product.featuredAsset.id : undefined;
+                }
+                const firstAsset = productAssets.find((a) => a.type === generated_types_1.AssetType.IMAGE);
+                return firstAsset ? firstAsset.id : undefined;
+            };
             const productData = {
-                featuredAssetId: existingProduct?.featuredAsset
-                    ? undefined
-                    : productAssets.length
-                        ? productAssets[0].id
-                        : undefined,
+                featuredAssetId: getFeaturedAssetId(existingProduct),
                 assetIds: productAssets.map((a) => a.id),
                 facetValueIds: updatingStrategy === 'replace' ? [] : undefined,
                 translations: await Promise.all(product.translations.map(async (translation) => {
@@ -440,14 +445,18 @@ let ProductImporter = class ProductImporter {
                     // Remove all assets from the product
                     await this.fastImporter.removeAllAssetsFromVariant(existingVariant);
                 }
+                const getFeaturedAssetId = (variant) => {
+                    if (variant?.featuredAsset) {
+                        const assetIsImage = variant.featuredAsset.type === generated_types_1.AssetType.IMAGE;
+                        return assetIsImage ? variant.featuredAsset.id : undefined;
+                    }
+                    const firstAsset = variantAssets.find((a) => a.type === generated_types_1.AssetType.IMAGE);
+                    return firstAsset ? firstAsset.id : undefined;
+                };
                 const variantData = {
                     productId: createdProductId,
                     facetValueIds: updatingStrategy === 'replace' ? [] : undefined,
-                    featuredAssetId: existingVariant?.featuredAsset
-                        ? undefined
-                        : variantAssets.length
-                            ? variantAssets[0].id
-                            : undefined,
+                    featuredAssetId: getFeaturedAssetId(existingVariant),
                     assetIds: variantAssets.map((a) => a.id),
                     sku: variant.sku,
                     taxCategoryId: this.getMatchingTaxCategoryId(variant.taxCategory, taxCategories.items),

package/dist/services/extended-fast-importer.service.js

@@ -69,6 +69,9 @@ let ExtendedFastImporterService = class ExtendedFastImporterService {
                 if (input.featuredAssetId) {
                     p.featuredAsset = { id: input.featuredAssetId };
                 }
+                else {
+                    (0, lodash_1.set)(p, 'featuredAssetId', null);
+                }
             },
         });
         if (input.assetIds) {

package/dist/services/product-export.service.d.ts

@@ -1,15 +1,16 @@
-import { EntityHydrator, ID, ProductService, RequestContext, StockLevelService, ChannelService, ConfigService } from '@vendure/core';
+import { ID, ProductService, RequestContext, StockLevelService, ChannelService, ConfigService, Product, LanguageCode } from '@vendure/core';
 import { PluginInitOptions } from '../types';
+import { CsvWriter } from 'csv-writer/src/lib/csv-writer';
 export type RelationType = 'string' | 'boolean' | 'localeString' | 'text' | 'localeText' | 'int' | 'float' | 'datetime' | 'relation';
 export declare class ProductExportService {
     private options;
     private productService;
     private stockLevelService;
-    private entityHydratorService;
     private channelService;
     private configService;
-    constructor(options: PluginInitOptions, productService: ProductService, stockLevelService: StockLevelService, entityHydratorService: EntityHydrator, channelService: ChannelService, configService: ConfigService);
-    createExportFile(ctx: RequestContext, selectionIds: ID[], fileName: string, selectedCustomFields: string, exportAssetsAs: 'url' | 'json', selectedExportFields: string): Promise<string>;
+    constructor(options: PluginInitOptions, productService: ProductService, stockLevelService: StockLevelService, channelService: ChannelService, configService: ConfigService);
+    createExportFile(ctx: RequestContext, selectionIds: ID[], fileName: string, selectedCustomFields: string, exportAssetsAs: 'url' | 'json', selectedExportFields: string, pageSize?: number, concurrency?: number): Promise<string>;
+    exportProduct(ctx: RequestContext, product: Product, languages: LanguageCode[], filteredCustomFieldNames: string[], exportAssetsAs: 'url' | 'json', csvWriter: CsvWriter<any>, records?: any[]): Promise<void>;
     private handleAssets;
     private handleCustomFields;
     private getStockOnHand;

package/dist/services/product-export.service.js

@@ -46,23 +46,21 @@ const csv_writer_1 = require("csv-writer");
 const path = __importStar(require("path"));
 const os_1 = __importDefault(require("os"));
 const lodash_1 = require("lodash");
+const bottleneck_1 = __importDefault(require("bottleneck"));
 let ProductExportService = class ProductExportService {
     options;
     productService;
     stockLevelService;
-    entityHydratorService;
     channelService;
     configService;
-    constructor(options, productService, stockLevelService, entityHydratorService, channelService, configService) {
+    constructor(options, productService, stockLevelService, channelService, configService) {
         this.options = options;
         this.productService = productService;
         this.stockLevelService = stockLevelService;
-        this.entityHydratorService = entityHydratorService;
         this.channelService = channelService;
         this.configService = configService;
     }
-    async createExportFile(ctx, selectionIds, fileName, selectedCustomFields, exportAssetsAs, selectedExportFields) {
-        const products = await this.productService.findByIds(ctx, selectionIds);
+    async createExportFile(ctx, selectionIds, fileName, selectedCustomFields, exportAssetsAs, selectedExportFields, pageSize = 50, concurrency = 5) {
         const channel = await this.channelService.findOne(ctx, ctx.channelId);
         if (!channel) {
             throw new Error('Channel not found');
@@ -105,113 +103,129 @@ let ProductExportService = class ProductExportService {
         const csvWriter = (0, csv_writer_1.createObjectCsvWriter)({
             path: exportFile,
             header: filteredHeaders,
+            append: false,
         });
-        for (const product of products) {
-            const records = [];
-            const hydratedProduct = await this.entityHydratorService.hydrate(ctx, product, {
-                relations: [
-                    'variants',
-                    'facetValues',
-                    'facetValues.facet',
-                    'optionGroups',
-                    'assets',
-                    'variants.assets',
-                    'variants.facetValues',
-                    'variants.facetValues.facet',
-                    'variants.options',
-                ],
-            });
-            const { assets = [], facetValues = [], optionGroups = [], variants = [], translations = [], customFields = {}, } = hydratedProduct;
-            const nameTranslations = this.mapTranslations(translations, 'name', languages);
-            const slugTranslations = this.mapTranslations(translations, 'slug', languages);
-            const descriptionTranslations = this.mapTranslations(translations, 'description', languages);
-            // Filter out all variants that are soft deleted
-            const activeVariants = variants.filter((v) => !v.deletedAt);
-            const productAssets = assets.length === 0
-                ? ''
-                : assets.length > 0
-                    ? this.handleAssets(assets.map(({ asset }) => asset), exportAssetsAs)
-                    : this.handleAssets([hydratedProduct.featuredAsset], exportAssetsAs);
-            const productFacets = languages.reduce((acc, lang) => {
-                acc[lang] = facetValues
-                    .map((facetValue) => this.mapFacetTranslations(facetValue, lang))
-                    .filter((facet) => facet)
+        const limiter = new bottleneck_1.default({
+            maxConcurrent: concurrency,
+        });
+        let currentPage = 1;
+        let hasMore = true;
+        const records = [];
+        while (hasMore) {
+            const { items, totalItems } = await this.productService.findAll(ctx, {
+                filter: {
+                    id: { in: selectionIds },
+                },
+                skip: (currentPage - 1) * pageSize,
+                take: pageSize,
+            }, [
+                'variants',
+                'facetValues',
+                'facetValues.facet',
+                'optionGroups',
+                'assets',
+                'variants.assets',
+                'variants.facetValues',
+                'variants.facetValues.facet',
+                'variants.options',
+            ]);
+            hasMore = currentPage * pageSize < totalItems;
+            const exportPromises = items.map((product) => limiter.schedule(async () => this.exportProduct(ctx, product, languages, filteredCustomFieldNames, exportAssetsAs, csvWriter, records)));
+            await Promise.all(exportPromises);
+            currentPage++;
+        }
+        return exportFile;
+    }
+    async exportProduct(ctx, product, languages, filteredCustomFieldNames, exportAssetsAs, csvWriter, records = []) {
+        const { assets = [], facetValues = [], optionGroups = [], variants = [], translations = [], customFields = {}, } = product;
+        const nameTranslations = this.mapTranslations(translations, 'name', languages);
+        const slugTranslations = this.mapTranslations(translations, 'slug', languages);
+        const descriptionTranslations = this.mapTranslations(translations, 'description', languages);
+        // Filter out all variants that are soft deleted
+        const activeVariants = variants.filter((v) => !v.deletedAt);
+        const productAssets = assets.length === 0
+            ? ''
+            : assets.length > 0
+                ? this.handleAssets(assets.map(({ asset }) => asset), exportAssetsAs)
+                : this.handleAssets([product.featuredAsset], exportAssetsAs);
+        const productFacets = languages.reduce((acc, lang) => {
+            acc[lang] = facetValues
+                .map((facetValue) => this.mapFacetTranslations(facetValue, lang))
+                .filter((facet) => facet)
+                .join('|');
+            return acc;
+        }, {});
+        const optionGroupNames = languages.reduce((acc, lang) => {
+            acc[lang] = (0, lodash_1.sortBy)(optionGroups, (g) => g.id)
+                .map((group) => this.mapTranslations(group.translations, 'name', [lang])[lang])
+                .filter((name) => name)
+                .join('|');
+            return acc;
+        }, {});
+        for (const variant of activeVariants) {
+            const variantValues = languages.reduce((acc, lang) => {
+                acc[lang] = ((0, lodash_1.sortBy)(variant.options, (o) => o.groupId) || [])
+                    .map((option) => this.mapTranslations(option.translations, 'name', [lang])[lang])
+                    .filter((name) => name)
                     .join('|');
                 return acc;
             }, {});
-            const optionGroupNames = languages.reduce((acc, lang) => {
-                acc[lang] = (0, lodash_1.sortBy)(optionGroups, (g) => g.id)
-                    .map((group) => this.mapTranslations(group.translations, 'name', [lang])[lang])
-                    .filter((name) => name)
+            const variantAssets = this.handleAssets(variant.assets.map(({ asset }) => asset), exportAssetsAs);
+            const variantFacets = languages.reduce((acc, lang) => {
+                acc[lang] = (variant.facetValues || [])
+                    .map((facet) => this.mapFacetTranslations(facet, lang))
+                    .filter((facet) => facet)
                     .join('|');
                 return acc;
             }, {});
-            for (const variant of activeVariants) {
-                const variantValues = languages.reduce((acc, lang) => {
-                    acc[lang] = ((0, lodash_1.sortBy)(variant.options, (o) => o.groupId) || [])
-                        .map((option) => this.mapTranslations(option.translations, 'name', [lang])[lang])
-                        .filter((name) => name)
-                        .join('|');
-                    return acc;
-                }, {});
-                const variantAssets = this.handleAssets(variant.assets.map(({ asset }) => asset), exportAssetsAs);
-                const variantFacets = languages.reduce((acc, lang) => {
-                    acc[lang] = (variant.facetValues || [])
-                        .map((facet) => this.mapFacetTranslations(facet, lang))
-                        .filter((facet) => facet)
-                        .join('|');
-                    return acc;
-                }, {});
-                const stockOnHand = await this.getStockOnHand(ctx, variant.id); // Adjusted to fetch stock details
-                const variantTranslations = variant.translations;
-                const variantNameTranslations = this.mapTranslations(variantTranslations, 'name', languages);
-                const record = {};
-                const convertToHTML = (text) => {
-                    return text
-                        .replace(/\n/g, '<br>')
-                        .replace(/\t/g, '&nbsp;&nbsp;&nbsp;&nbsp;')
-                        .replace(/,\s*'/g, ", '");
-                };
-                for (const lang of languages) {
-                    const escapedDescription = convertToHTML(descriptionTranslations[lang]);
-                    const escapedName = nameTranslations[lang]
-                        .replace(/"/g, "'")
-                        .replace(/\s+/g, ' ')
-                        .replace(/,\s*'/g, ", '")
-                        .replace(/'/g, "''");
-                    record.productId = records.length === 0 ? product.id : '';
-                    record[`name:${lang}`] = records.length === 0 ? escapedName || '' : '';
-                    record[`slug:${lang}`] = records.length === 0 ? slugTranslations[lang] || '' : '';
-                    record[`description:${lang}`] = records.length === 0 ? escapedDescription || '' : '';
-                    record[`facets:${lang}`] = records.length === 0 ? productFacets[lang] : '';
-                    record[`optionGroups:${lang}`] = records.length === 0 ? optionGroupNames[lang] : '';
-                    record[`optionValues:${lang}`] = variantValues[lang];
-                    record[`variantFacets:${lang}`] = variantFacets[lang];
+            const stockOnHand = await this.getStockOnHand(ctx, variant.id); // Adjusted to fetch stock details
+            const variantTranslations = variant.translations;
+            const variantNameTranslations = this.mapTranslations(variantTranslations, 'name', languages);
+            const record = {};
+            const convertToHTML = (text) => {
+                return text
+                    .replace(/\n/g, '<br>')
+                    .replace(/\t/g, '&nbsp;&nbsp;&nbsp;&nbsp;')
+                    .replace(/,\s*'/g, ", '");
+            };
+            for (const lang of languages) {
+                const escapedDescription = convertToHTML(descriptionTranslations[lang]);
+                const escapedName = nameTranslations[lang]
+                    .replace(/"/g, "'")
+                    .replace(/\s+/g, ' ')
+                    .replace(/,\s*'/g, ", '")
+                    .replace(/'/g, "''");
+                record.productId = records.length === 0 ? product.id : '';
+                record[`name:${lang}`] = records.length === 0 ? escapedName || '' : '';
+                record[`slug:${lang}`] = records.length === 0 ? slugTranslations[lang] || '' : '';
+                record[`description:${lang}`] = records.length === 0 ? escapedDescription || '' : '';
+                record[`facets:${lang}`] = records.length === 0 ? productFacets[lang] : '';
+                record[`optionGroups:${lang}`] = records.length === 0 ? optionGroupNames[lang] : '';
+                record[`optionValues:${lang}`] = variantValues[lang];
+                record[`variantFacets:${lang}`] = variantFacets[lang];
+            }
+            const productVariantPrices = variant.productVariantPrices.filter((price) => price.channelId === ctx.channelId);
+            record.assets = records.length === 0 ? productAssets : '';
+            record.sku = variant.sku;
+            record.price = productVariantPrices[0]?.price / 100; // Assuming the price is stored in cents
+            record.taxCategory = 'standard'; // Replace with actual tax category if available
+            record.stockOnHand = stockOnHand;
+            record.trackInventory = variant.trackInventory.toLowerCase();
+            record.variantAssets = variantAssets;
+            for (const field of filteredCustomFieldNames) {
+                const [entity, fieldName, type] = field.split(':');
+                if (entity === 'product') {
+                    record[field] =
+                        this.handleCustomFields(customFields, fieldName, type, exportAssetsAs) || '';
                 }
-                const productVariantPrices = variant.productVariantPrices.filter((price) => price.channelId === ctx.channelId);
-                record.assets = records.length === 0 ? productAssets : '';
-                record.sku = variant.sku;
-                record.price = productVariantPrices[0]?.price / 100; // Assuming the price is stored in cents
-                record.taxCategory = 'standard'; // Replace with actual tax category if available
-                record.stockOnHand = stockOnHand;
-                record.trackInventory = variant.trackInventory.toLowerCase();
-                record.variantAssets = variantAssets;
-                for (const field of filteredCustomFieldNames) {
-                    const [entity, fieldName, type] = field.split(':');
-                    if (entity === 'product') {
-                        record[field] =
-                            this.handleCustomFields(customFields, fieldName, type, exportAssetsAs) || '';
-                    }
-                    else if (entity === 'variant') {
-                        record[field] =
-                            this.handleCustomFields(variant.customFields, fieldName, type, exportAssetsAs) || '';
-                    }
+                else if (entity === 'variant') {
+                    record[field] =
+                        this.handleCustomFields(variant.customFields, fieldName, type, exportAssetsAs) || '';
                 }
-                records.push(record);
             }
-            await csvWriter.writeRecords(records);
+            records.push(record);
         }
-        return exportFile;
+        await csvWriter.writeRecords(records);
     }
     handleAssets(assets, exportAssetsAs) {
         if (!assets.length) {
@@ -337,7 +351,6 @@ ProductExportService = __decorate([
     __param(0, (0, common_1.Inject)(constants_1.PRODUCT_IMPORT_EXPORT_PLUGIN_OPTIONS)),
     __metadata("design:paramtypes", [Object, core_1.ProductService,
         core_1.StockLevelService,
-        core_1.EntityHydrator,
         core_1.ChannelService,
         core_1.ConfigService])
 ], ProductExportService);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@haus-tech/product-import-export-plugin",
-  "version": "3.0.9",
+  "version": "3.0.11-rc.0",
   "description": "A Vendure plugin for importing and exporting products using a CSV file",
   "author": "Haus Tech",
   "repository": {
@@ -24,8 +24,9 @@
     "prepublishOnly": "yarn && yarn build"
   },
   "devDependencies": {
-    "csv-parse": "^5.5.6",
-    "csv-stringify": "^6.5.1"
+    "@types/fs-extra": "^11.0.4",
+    "csv-parse": "^5.6.0",
+    "csv-stringify": "^6.5.2"
   },
   "peerDependencies": {
     "csv-parse": "^5.5.6",