@pinelab/vendure-plugin-qls-fulfillment 1.0.0-beta.6 → 1.0.0-beta.7

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

@@ -30,6 +30,9 @@ export type FulfillmentProduct = {
     collection_id: string | null;
     dimensions: unknown;
     article_number: string | null;
+    /**
+     * Main EAN of the product
+     */
     ean: string;
     name: string;
     sku: string;
@@ -53,8 +56,18 @@ export type FulfillmentProduct = {
     amount_blocked: number;
     status: string | null;
     suppliers: unknown[];
-    barcodes: string[];
+    barcodes: Array<{
+        id: number;
+        fulfillment_product_id: string;
+        company_id: string;
+        barcode: string;
+        created: string;
+        modified: string;
+    }>;
     image_url_handheld: string | null;
+    /**
+     * All EANs of the product, including the main EAN
+     */
     barcodes_and_ean: string[];
 };
 export interface FulfillmentOrderInput {

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

@@ -22,5 +22,13 @@ export declare class QlsClient {
     createFulfillmentProduct(data: FulfillmentProductInput): Promise<FulfillmentProduct>;
     updateFulfillmentProduct(fulfillmentProductId: string, data: FulfillmentProductInput): Promise<FulfillmentProduct>;
     createFulfillmentOrder(data: Omit<FulfillmentOrderInput, 'brand_id'>): Promise<FulfillmentOrder>;
+    /**
+     * Add an extra barcode to a fulfillment product in QLS
+     */
+    addBarcode(productId: string, barcode: string): Promise<void>;
+    /**
+     * Add an extra barcode to a fulfillment product in QLS
+     */
+    removeBarcode(productId: string, barcodeId: number): Promise<void>;
     rawRequest<T>(method: 'POST' | 'GET' | 'PUT' | 'DELETE', action: string, data?: unknown): Promise<QlsApiResponse<T>>;
 }

package/dist/lib/qls-client.js

@@ -50,7 +50,8 @@ class QlsClient {
             allProducts.push(...result.data);
             hasNextPage = result.pagination?.nextPage ?? false;
             page++;
-            await new Promise((resolve) => setTimeout(resolve, 1100)); // Limit to 55/minute, because the rate limit is 60/minute
+            core_1.Logger.info(`Fetched products ${allProducts.length}/${result.pagination?.count}`, constants_1.loggerCtx);
+            await new Promise((resolve) => setTimeout(resolve, 700)); // Limit to ~86/minute, because the rate limit is 500/5 minutes
         }
         return allProducts;
     }
@@ -69,6 +70,20 @@ class QlsClient {
         });
         return response.data;
     }
+    /**
+     * Add an extra barcode to a fulfillment product in QLS
+     */
+    async addBarcode(productId, barcode) {
+        await this.rawRequest('POST', `fulfillment/products/${productId}/barcodes`, {
+            barcode,
+        });
+    }
+    /**
+     * Add an extra barcode to a fulfillment product in QLS
+     */
+    async removeBarcode(productId, barcodeId) {
+        await this.rawRequest('DELETE', `fulfillment/products/${productId}/barcodes/${barcodeId}`);
+    }
     async rawRequest(method, action, data) {
         // Set headers
         const headers = {

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

@@ -56,6 +56,10 @@ export declare class QlsProductService implements OnModuleInit, OnApplicationBoo
      * Determines if a product needs to be created or updated in QLS based on the given variant and existing QLS product.
      */
     createOrUpdateProductInQls(ctx: RequestContext, client: QlsClient, variant: ProductVariant, existingProduct: FulfillmentProduct | null): Promise<'created' | 'updated' | 'not-changed'>;
+    /**
+     * Update the additional EANs/barcodes for a product in QLS if needed
+     */
+    private updateAdditionalEANs;
     /**
      * Determine if a product needs to be updated in QLS based on the given variant and QLS product.
      */

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

@@ -23,6 +23,7 @@ const typeorm_1 = require("typeorm");
 const util_1 = __importDefault(require("util"));
 const constants_1 = require("../constants");
 const qls_client_1 = require("../lib/qls-client");
+const util_2 = require("./util");
 let QlsProductService = class QlsProductService {
     constructor(connection, options, jobQueueService, stockLevelService, variantService, stockLocationService, eventBus, listQueryBuilder, productPriceApplicator) {
         this.connection = connection;
@@ -239,45 +240,74 @@ 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) {
-        let qlsProductId = existingProduct?.id;
+        let qlsProduct = existingProduct;
         let createdOrUpdated = 'not-changed';
+        const { additionalEANs, ...additionalVariantFields } = this.options.getAdditionalVariantFields(ctx, variant);
         if (!existingProduct) {
             const result = await client.createFulfillmentProduct({
                 name: variant.name,
                 sku: variant.sku,
-                ...this.options.getAdditionalVariantFields?.(ctx, variant),
+                ...additionalVariantFields,
             });
-            qlsProductId = result.id;
+            qlsProduct = result;
             core_1.Logger.info(`Created product '${variant.sku}' in QLS`, constants_1.loggerCtx);
             createdOrUpdated = 'created';
         }
-        else if (this.shouldUpdateProductInQls(ctx, variant, existingProduct)) {
+        else if (this.shouldUpdateProductInQls(variant, existingProduct, additionalVariantFields)) {
             await client.updateFulfillmentProduct(existingProduct.id, {
                 sku: variant.sku,
                 name: variant.name,
-                ...this.options.getAdditionalVariantFields?.(ctx, variant),
+                ...additionalVariantFields,
             });
             core_1.Logger.info(`Updated product '${variant.sku}' in QLS`, constants_1.loggerCtx);
             createdOrUpdated = 'updated';
         }
-        if (qlsProductId !== variant.customFields.qlsProductId) {
+        if (qlsProduct && qlsProduct?.id !== variant.customFields.qlsProductId) {
             // Update variant with QLS product ID if it changed
             // Do not use variantService.update because it will trigger a change event and cause an infinite loop
             await this.connection
                 .getRepository(ctx, core_1.ProductVariant)
-                .update({ id: variant.id }, { customFields: { qlsProductId } });
-            core_1.Logger.info(`Set QLS product ID for variant '${variant.sku}' to ${qlsProductId}`, constants_1.loggerCtx);
+                .update({ id: variant.id }, { customFields: { qlsProductId: qlsProduct.id } });
+            core_1.Logger.info(`Set QLS product ID for variant '${variant.sku}' to ${qlsProduct.id}`, constants_1.loggerCtx);
+        }
+        if (qlsProduct) {
+            const updatedEANs = await this.updateAdditionalEANs(ctx, client, qlsProduct, additionalEANs);
+            if (createdOrUpdated === 'not-changed' && updatedEANs) {
+                // If nothing changed so far, but EANs changed, then we did update the product in QLS
+                createdOrUpdated = 'updated';
+            }
         }
         return createdOrUpdated;
     }
+    /**
+     * Update the additional EANs/barcodes for a product in QLS if needed
+     */
+    async updateAdditionalEANs(ctx, client, qlsProduct, additionalEANs) {
+        const existingAdditionalEANs = qlsProduct?.barcodes_and_ean.filter((ean) => ean !== qlsProduct.ean); // Remove the main EAN
+        const eansToUpdate = (0, util_2.getEansToUpdate)({
+            existingEans: existingAdditionalEANs,
+            desiredEans: additionalEANs,
+        });
+        if (!eansToUpdate) {
+            // No updates needed
+            return false;
+        }
+        await Promise.all(eansToUpdate.eansToAdd.map((ean) => client.addBarcode(qlsProduct.id, ean)));
+        // get barcode ID's to remove, because deletion goes via barcode ID, not barcode value
+        const barcodeIdsToRemove = qlsProduct.barcodes
+            .filter((barcode) => eansToUpdate.eansToRemove.includes(barcode.barcode))
+            .map((barcode) => barcode.id);
+        await Promise.all(barcodeIdsToRemove.map((barcodeId) => client.removeBarcode(qlsProduct.id, barcodeId)));
+        core_1.Logger.info(`Added additional EANs '${eansToUpdate.eansToAdd.join(',')}', and removed EANs '${eansToUpdate.eansToRemove.join(',')}' for product '${qlsProduct.sku}' in QLS`, constants_1.loggerCtx);
+        return true;
+    }
     /**
      * Determine if a product needs to be updated in QLS based on the given variant and QLS product.
      */
-    shouldUpdateProductInQls(ctx, variant, qlsProduct) {
-        const additionalFields = this.options.getAdditionalVariantFields?.(ctx, variant);
+    shouldUpdateProductInQls(variant, qlsProduct, additionalVariantFields) {
         if (qlsProduct.name !== variant.name ||
-            qlsProduct.ean !== additionalFields?.ean ||
-            qlsProduct.image_url !== additionalFields?.image_url) {
+            qlsProduct.ean !== additionalVariantFields?.ean ||
+            qlsProduct.image_url !== additionalVariantFields?.image_url) {
             // If name or ean has changed, product should be updated in QLS
             return true;
         }
@@ -323,6 +353,10 @@ let QlsProductService = class QlsProductService {
      * Update stock level for a variant based on the given available stock
      */
     async updateStock(ctx, variantId, availableStock) {
+        if (this.options.disableStockSync) {
+            core_1.Logger.warn(`Stock sync disabled. Not updating stock for variant '${variantId}'`, constants_1.loggerCtx);
+            return;
+        }
         // Find default Stock Location
         const defaultStockLocation = await this.stockLocationService.defaultStockLocation(ctx);
         // Get current stock level id

package/dist/services/util.d.ts

@@ -0,0 +1,15 @@
+export interface EanUpdate {
+    eansToAdd: string[];
+    eansToRemove: string[];
+}
+/**
+ * Get the EANs to add or remove
+ */
+export declare function getEansToUpdate({ existingEans, desiredEans, }: {
+    existingEans?: (string | undefined | null)[];
+    desiredEans?: (string | undefined | null)[];
+}): EanUpdate | false;
+/**
+ * Normalize the EANs by filtering out null, undefined and empty strings and sorting them
+ */
+export declare function normalizeEans(eans?: (string | undefined | null)[]): string[];

package/dist/services/util.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEansToUpdate = getEansToUpdate;
+exports.normalizeEans = normalizeEans;
+/**
+ * Get the EANs to add or remove
+ */
+function getEansToUpdate({ existingEans, desiredEans, }) {
+    const normalizedExisting = normalizeEans(existingEans);
+    const normalizedDesired = normalizeEans(desiredEans);
+    // Find out what EANs to add
+    const eansToAdd = normalizedDesired.filter((ean) => !normalizedExisting.includes(ean));
+    // Find out what EANs to remove
+    const eansToRemove = normalizedExisting.filter((ean) => !normalizedDesired.includes(ean));
+    if (eansToAdd.length === 0 && eansToRemove.length === 0) {
+        return false;
+    }
+    return {
+        eansToAdd,
+        eansToRemove,
+    };
+}
+/**
+ * Normalize the EANs by filtering out null, undefined and empty strings and sorting them
+ */
+function normalizeEans(eans) {
+    return (eans ?? [])
+        .filter((ean) => !!ean && ean.trim().length > 0)
+        .map((ean) => ean.trim())
+        .sort();
+}

package/dist/services/util.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/services/util.spec.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const util_1 = require("./util");
+(0, vitest_1.describe)('getEansToUpdate', () => {
+    (0, vitest_1.it)('returns false for identical EAN arrays', () => {
+        (0, vitest_1.expect)((0, util_1.getEansToUpdate)({
+            existingEans: ['123', '456'],
+            desiredEans: ['456', '123'],
+        })).toBe(false);
+    });
+    (0, vitest_1.it)('ignores ordering, whitespace and null/undefined when determining additions', () => {
+        (0, vitest_1.expect)((0, util_1.getEansToUpdate)({
+            existingEans: [null, '123'],
+            desiredEans: [' 123', '456 ', undefined, null],
+        })).toEqual({
+            eansToAdd: ['456'],
+            eansToRemove: [],
+        });
+    });
+    (0, vitest_1.it)('returns removals when desired array is missing values', () => {
+        (0, vitest_1.expect)((0, util_1.getEansToUpdate)({
+            existingEans: ['123', '456', null],
+            desiredEans: ['123'],
+        })).toEqual({
+            eansToAdd: [],
+            eansToRemove: ['456'],
+        });
+    });
+    (0, vitest_1.it)('returns both additions and removals when values differ', () => {
+        (0, vitest_1.expect)((0, util_1.getEansToUpdate)({
+            existingEans: ['123', '456'],
+            desiredEans: ['123', '789'],
+        })).toEqual({
+            eansToAdd: ['789'],
+            eansToRemove: ['456'],
+        });
+    });
+    (0, vitest_1.it)('treats undefined arrays as equal', () => {
+        (0, vitest_1.expect)((0, util_1.getEansToUpdate)({ existingEans: undefined, desiredEans: undefined })).toBe(false);
+    });
+    (0, vitest_1.it)('treats undefined and empty array as equal', () => {
+        // This is the case when creating a new product in QLS
+        (0, vitest_1.expect)((0, util_1.getEansToUpdate)({ existingEans: undefined, desiredEans: [] })).toBe(false);
+    });
+});
+(0, vitest_1.describe)('normalizeEans', () => {
+    (0, vitest_1.it)('filters and trims invalid values', () => {
+        (0, vitest_1.expect)((0, util_1.normalizeEans)([' 123', '', undefined, null, '456 '])).toEqual([
+            '123',
+            '456',
+        ]);
+    });
+    (0, vitest_1.it)('returns empty array for undefined input', () => {
+        (0, vitest_1.expect)((0, util_1.normalizeEans)(undefined)).toEqual([]);
+    });
+    (0, vitest_1.it)('sorts resulting values alphabetically', () => {
+        (0, vitest_1.expect)((0, util_1.normalizeEans)(['789', '123'])).toEqual(['123', '789']);
+    });
+});

package/dist/types.d.ts

@@ -9,7 +9,7 @@ export interface QlsPluginOptions {
      * Required to get the EAN and image URL for a product variant.
      * Also allows you to override other product attributes like name, price, etc.
      */
-    getAdditionalVariantFields?: (ctx: RequestContext, variant: ProductVariant) => Partial<FulfillmentProductInput>;
+    getAdditionalVariantFields: (ctx: RequestContext, variant: ProductVariant) => AdditionalVariantFields;
     /**
      * Function to get the set service point code for an order.
      * Return undefined to not use a service point at all.
@@ -20,7 +20,19 @@ export interface QlsPluginOptions {
      * Set this to a random string
      */
     webhookSecret: string;
+    /**
+     * Disable the pulling in of stock levels from QLS. When disabled, stock in Vendure will not be modified based on QLS stock levels.
+     * Useful for testing out order sync separately, or testing against a QLS test env that has no stock for example
+     */
+    disableStockSync?: boolean;
 }
+/**
+ * Additional fields for a product variant that are used to create or update a product in QLS
+ */
+export type AdditionalVariantFields = Partial<FulfillmentProductInput & {
+    ean: string;
+    additionalEANs?: string[];
+}>;
 export interface AdditionalOrderFields {
     servicepoint_code?: string;
     delivery_options?: string[];

package/package.json

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