@pinelab/vendure-plugin-qls-fulfillment 1.0.0-beta.15 → 1.0.0-beta.16

package/dist/lib/qls-client.d.ts

@@ -22,6 +22,7 @@ export declare class QlsClient {
     getAllFulfillmentProducts(): Promise<FulfillmentProduct[]>;
     createFulfillmentProduct(data: FulfillmentProductInput): Promise<FulfillmentProduct>;
     updateFulfillmentProduct(fulfillmentProductId: string, data: FulfillmentProductInput): Promise<FulfillmentProduct>;
+    deleteFulfillmentProduct(fulfillmentProductId: string): Promise<void>;
     createFulfillmentOrder(data: Omit<FulfillmentOrderInput, 'brand_id'>): Promise<FulfillmentOrder>;
     /**
      * Add an extra barcode to a fulfillment product in QLS

package/dist/lib/qls-client.js

@@ -69,6 +69,9 @@ class QlsClient {
         }
         return response.data;
     }
+    async deleteFulfillmentProduct(fulfillmentProductId) {
+        await this.rawRequest('DELETE', `fulfillment/products/${fulfillmentProductId}`);
+    }
     async createFulfillmentOrder(data) {
         const response = await this.rawRequest('POST', 'fulfillment/orders', {
             ...data,

package/dist/services/qls-order.service.js

@@ -115,15 +115,16 @@ let QlsOrderService = class QlsOrderService {
                 !order.shippingAddress.countryCode) {
                 throw new Error(`Shipping address for order '${order.code}' is missing one of required fields: streetLine1, postalCode, city, streetLine2, countryCode. Can not push order to QLS.`);
             }
+            const receiverContact = this.options.getReceiverContact?.(ctx, order);
             const qlsOrder = {
                 customer_reference: order.code,
                 processable: new Date().toISOString(), // Processable starting now
                 servicepoint_code: order.customFields?.qlsServicePointId,
                 delivery_options: additionalOrderFields?.delivery_options ?? [],
                 total_price: order.totalWithTax,
-                receiver_contact: {
+                receiver_contact: receiverContact ?? {
                     name: order.shippingAddress.fullName || customerName,
-                    companyname: order.shippingAddress.company ?? customerName,
+                    companyname: order.shippingAddress.company ?? '',
                     street: order.shippingAddress.streetLine1,
                     housenumber: order.shippingAddress.streetLine2,
                     postalcode: order.shippingAddress.postalCode,

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

@@ -3,11 +3,11 @@ import { EventBus, ID, Job, JobQueueService, ListQueryBuilder, ProductPriceAppli
 import { FulfillmentProduct } from '../lib/client-types';
 import { QlsClient } from '../lib/qls-client';
 import { QlsPluginOptions, QlsProductJobData } from '../types';
-type SyncProductsJobResult = {
-    updatedInQls: number;
-    createdInQls: number;
-    updatedStock: number;
-    failed: number;
+type SyncProductsResult = {
+    updatedInQls: Partial<ProductVariant>[];
+    createdInQls: Partial<ProductVariant>[];
+    updatedStock: Partial<ProductVariant>[];
+    failed: Partial<ProductVariant>[];
 };
 export declare class QlsProductService implements OnModuleInit, OnApplicationBootstrap {
     private connection;
@@ -35,11 +35,15 @@ export declare class QlsProductService implements OnModuleInit, OnApplicationBoo
      * 3. Creates products in QLS if needed
      * 4. Updates products in QLS if needed
      */
-    runFullSync(ctx: RequestContext): Promise<SyncProductsJobResult>;
+    runFullSync(ctx: RequestContext): Promise<SyncProductsResult>;
+    /**
+     * Utility function to remove all products from QLS
+     */
+    removeAllProductsFromQls(ctx: RequestContext): Promise<void>;
     /**
      * Creates or updates the fulfillment products in QLS for the given product variants.
      */
-    syncVariants(ctx: RequestContext, productVariantIds: ID[]): Promise<SyncProductsJobResult>;
+    syncVariants(ctx: RequestContext, productVariantIds: ID[]): Promise<SyncProductsResult>;
     /**
      * Trigger a full product sync job
      */

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

@@ -24,6 +24,8 @@ const util_1 = __importDefault(require("util"));
 const constants_1 = require("../constants");
 const qls_client_1 = require("../lib/qls-client");
 const util_2 = require("./util");
+// Wait for 700ms to avoid rate limit of 500/5 minutes
+const waitToPreventRateLimit = () => new Promise((resolve) => setTimeout(resolve, 700));
 let QlsProductService = class QlsProductService {
     constructor(connection, options, jobQueueService, stockLevelService, variantService, stockLocationService, eventBus, listQueryBuilder, productPriceApplicator) {
         this.connection = connection;
@@ -64,7 +66,13 @@ let QlsProductService = class QlsProductService {
         try {
             const ctx = core_1.RequestContext.deserialize(job.data.ctx);
             if (job.data.action === 'full-sync-products') {
-                return await this.runFullSync(ctx);
+                const result = await this.runFullSync(ctx);
+                return {
+                    updatedInQls: result.updatedInQls.length,
+                    createdInQls: result.createdInQls.length,
+                    updatedStock: result.updatedStock.length,
+                    failed: result.failed.length,
+                };
             }
             else if (job.data.action === 'sync-products') {
                 return await this.syncVariants(ctx, job.data.productVariantIds);
@@ -89,8 +97,6 @@ let QlsProductService = class QlsProductService {
      * 4. Updates products in QLS if needed
      */
     async runFullSync(ctx) {
-        // Wait for 700ms to avoid rate limit of 500/5 minutes
-        const waitToPreventRateLimit = () => new Promise((resolve) => setTimeout(resolve, 700));
         try {
             const client = await (0, qls_client_1.getQlsClient)(ctx, this.options);
             if (!client) {
@@ -101,28 +107,28 @@ let QlsProductService = class QlsProductService {
             const allVariants = await this.getAllVariants(ctx);
             core_1.Logger.info(`Running full sync for ${allQlsProducts.length} QLS products and ${allVariants.length} Vendure variants`, constants_1.loggerCtx);
             // Update stock in Vendure based on QLS products
-            let updateStockCount = 0;
+            const updatedStock = [];
             for (const variant of allVariants) {
                 const qlsProduct = allQlsProducts.find((p) => p.sku == variant.sku);
                 if (qlsProduct) {
                     await this.updateStock(ctx, variant.id, qlsProduct.amount_available);
-                    updateStockCount += 1;
+                    updatedStock.push(variant);
                 }
             }
-            core_1.Logger.info(`Updated stock for ${updateStockCount} variants based on QLS stock levels`, constants_1.loggerCtx);
+            core_1.Logger.info(`Updated stock for ${updatedStock.length} variants based on QLS stock levels`, constants_1.loggerCtx);
             // Create or update products in QLS
-            let createdQlsProductsCount = 0;
-            let updatedQlsProductsCount = 0;
-            let failedCount = 0;
+            const createdQlsProducts = [];
+            const updatedQlsProducts = [];
+            const failed = [];
             for (const variant of allVariants) {
                 try {
                     const existingQlsProduct = allQlsProducts.find((p) => p.sku == variant.sku);
                     const result = await this.createOrUpdateProductInQls(ctx, client, variant, existingQlsProduct ?? null);
                     if (result === 'created') {
-                        createdQlsProductsCount += 1;
+                        createdQlsProducts.push(variant);
                     }
                     else if (result === 'updated') {
-                        updatedQlsProductsCount += 1;
+                        updatedQlsProducts.push(variant);
                     }
                     if (result === 'created' || result === 'updated') {
                         // Wait only if we created or updated a product, otherwise no calls have been made yet.
@@ -132,18 +138,18 @@ let QlsProductService = class QlsProductService {
                 catch (e) {
                     const error = (0, catch_unknown_1.asError)(e);
                     core_1.Logger.error(`Error creating or updating variant '${variant.sku}' in QLS: ${error.message}`, constants_1.loggerCtx, error.stack);
-                    failedCount += 1;
+                    failed.push(variant);
                     await waitToPreventRateLimit();
                 }
             }
-            core_1.Logger.info(`Created ${createdQlsProductsCount} products in QLS`, constants_1.loggerCtx);
-            core_1.Logger.info(`Updated ${updatedQlsProductsCount} products in QLS`, constants_1.loggerCtx);
-            core_1.Logger.info(`Finished full sync with ${failedCount} failures`, constants_1.loggerCtx);
+            core_1.Logger.info(`Created ${createdQlsProducts.length} products in QLS`, constants_1.loggerCtx);
+            core_1.Logger.info(`Updated ${updatedQlsProducts.length} products in QLS`, constants_1.loggerCtx);
+            core_1.Logger.info(`Finished full sync with ${failed.length} failures`, constants_1.loggerCtx);
             return {
-                updatedInQls: updatedQlsProductsCount,
-                createdInQls: createdQlsProductsCount,
-                updatedStock: updateStockCount,
-                failed: failedCount,
+                updatedInQls: updatedQlsProducts,
+                createdInQls: createdQlsProducts,
+                updatedStock,
+                failed,
             };
         }
         catch (e) {
@@ -152,6 +158,22 @@ let QlsProductService = class QlsProductService {
             throw error;
         }
     }
+    /**
+     * Utility function to remove all products from QLS
+     */
+    async removeAllProductsFromQls(ctx) {
+        const client = await (0, qls_client_1.getQlsClient)(ctx, this.options);
+        if (!client) {
+            throw new Error(`QLS not enabled for channel ${ctx.channel.token}`);
+        }
+        core_1.Logger.warn(`Removed all products from QLS for channel ${ctx.channel.token}`, constants_1.loggerCtx);
+        const allProducts = await client.getAllFulfillmentProducts();
+        for (const product of allProducts) {
+            await client.deleteFulfillmentProduct(product.id);
+            await waitToPreventRateLimit();
+        }
+        core_1.Logger.warn(`Removed ${allProducts.length} products from QLS for channel ${ctx.channel.token}`, constants_1.loggerCtx);
+    }
     /**
      * Creates or updates the fulfillment products in QLS for the given product variants.
      */
@@ -160,15 +182,15 @@ let QlsProductService = class QlsProductService {
         if (!client) {
             core_1.Logger.debug(`QLS not enabled for channel ${ctx.channel.token}. Not handling product update/create.`, constants_1.loggerCtx);
             return {
-                updatedInQls: 0,
-                createdInQls: 0,
-                updatedStock: 0,
-                failed: 0,
+                updatedInQls: [],
+                createdInQls: [],
+                updatedStock: [],
+                failed: [],
             };
         }
-        let updatedInQls = 0;
-        let createdInQls = 0;
-        let failedCount = 0;
+        const updatedInQls = [];
+        const createdInQls = [];
+        const failed = [];
         for (const variantId of productVariantIds) {
             try {
                 const variant = await this.variantService.findOne(ctx, variantId, [
@@ -184,23 +206,23 @@ let QlsProductService = class QlsProductService {
                 const existingQlsProduct = await client.getFulfillmentProductBySku(variant.sku);
                 const result = await this.createOrUpdateProductInQls(ctx, client, variant, existingQlsProduct ?? null);
                 if (result === 'created') {
-                    createdInQls += 1;
+                    createdInQls.push(variant);
                 }
                 else if (result === 'updated') {
-                    updatedInQls += 1;
+                    updatedInQls.push(variant);
                 }
             }
             catch (e) {
                 const error = (0, catch_unknown_1.asError)(e);
                 core_1.Logger.error(`Error syncing variant ${variantId} to QLS: ${error.message}`, constants_1.loggerCtx, error.stack);
-                failedCount += 1;
+                failed.push({ id: variantId });
             }
         }
         return {
             updatedInQls,
             createdInQls,
-            updatedStock: 0,
-            failed: failedCount,
+            updatedStock: [],
+            failed,
         };
     }
     /**
@@ -247,6 +269,10 @@ let QlsProductService = class QlsProductService {
      * Determines if a product needs to be created or updated in QLS based on the given variant and existing QLS product.
      */
     async createOrUpdateProductInQls(ctx, client, variant, existingProduct) {
+        if (this.options.excludeVariantFromSync?.(ctx, variant)) {
+            core_1.Logger.info(`Variant '${variant.sku}' excluded from sync to QLS.`, constants_1.loggerCtx);
+            return 'not-changed';
+        }
         let qlsProduct = existingProduct;
         let createdOrUpdated = 'not-changed';
         const { additionalEANs, ...additionalVariantFields } = this.options.getAdditionalVariantFields(ctx, variant);

package/dist/types.d.ts

@@ -1,5 +1,5 @@
 import { ID, Injector, Order, ProductVariant, RequestContext, SerializedRequestContext } from '@vendure/core';
-import { CustomValue, FulfillmentProductInput } from './lib/client-types';
+import { CustomValue, FulfillmentOrderReceiverContactInput, FulfillmentProductInput } from './lib/client-types';
 export interface QlsPluginOptions {
     /**
      * Get the QLS client config for the current channel based on given context
@@ -25,6 +25,17 @@ export interface QlsPluginOptions {
      * Useful for testing out order sync separately, or testing against a QLS test env that has no stock for example
      */
     disableStockSync?: boolean;
+    /**
+     * Optional function to determine if a product variant should be excluded from syncing to QLS.
+     * Return true to exclude the variant from sync, false or undefined to include it.
+     */
+    excludeVariantFromSync?: (ctx: RequestContext, variant: ProductVariant) => boolean | Promise<boolean>;
+    /**
+     * Optional function to customize the receiver contact details when creating a QLS order.
+     * Allows you to set different fields or override default mapping from the order's shipping address and customer.
+     * If not provided, default mapping will be used.
+     */
+    getReceiverContact?: (ctx: RequestContext, order: Order) => FulfillmentOrderReceiverContactInput | undefined;
 }
 /**
  * Additional fields for a product variant that are used to create or update a product in QLS

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pinelab/vendure-plugin-qls-fulfillment",
-  "version": "1.0.0-beta.15",
+  "version": "1.0.0-beta.16",
   "description": "Vendure plugin to fulfill orders via QLS.",
   "keywords": [
     "fulfillment",