@pinelab/vendure-plugin-qls-fulfillment 2.0.2 → 2.1.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 2.1.0 (2026-07-08)
+
+- Added `addAdditionalEANSToQLS` admin mutation to manually add additional EANs/barcodes to existing QLS products.
+- Added admin UI action on the product variant detail page to prompt for and add a single additional EAN.
+- Removed automatic syncing of additional EANs during product sync; EANs must now be added manually via the mutation.
+- Removed obsolete `util.ts`, `util.spec.ts`, and `removeBarcode` QLS client method.
+
 # 2.0.2 (2026-07-01)
 
 - Verify barcode deletion in QLS by fetching remaining barcodes after removal attempt

package/README.md

@@ -15,6 +15,20 @@ This plugin contains:
 - Partial product sync: Creates/updates products in QLS when products change in Vendure
 - Partial stock sync: Updates Vendure stock based on incoming QLS webhooks
 
+## Additional EANs
+
+Additional EANs (or barcodes) are not automatically synced from Vendure to QLS. They can only be added manually via the `addAdditionalEANSToQLS` admin mutation. This mutation only adds EANs that do not already exist in QLS; existing EANs are skipped.
+
+Removal of additional EANs is not supported by this plugin and must be done inside the QLS platform itself. QLS may have assigned stock to those barcodes, so removing them should be handled in QLS directly.
+
+```graphql
+mutation AddAdditionalEANSToQLS($variantId: ID!, $additionalEANS: [String!]!) {
+  addAdditionalEANSToQLS(variantId: $variantId, additionalEANS: $additionalEANS)
+}
+```
+
+The mutation returns the list of all existing EANs for the product in QLS after the operation. The variant must already have a `qlsProductId` stored in its custom fields (i.e. it must have been synced to QLS first), otherwise an error is thrown. After adding EANs, the mutation also triggers a sync of the variant to QLS to ensure product fields are up to date.
+
 ## Order Sync
 
 - Pushes orders to QLS automatically on order placement
@@ -44,7 +58,6 @@ plugins: [
       getAdditionalVariantFields: (ctx, variant) => ({
         ean: variant.sku,
         image_url: `https://your-cdn.com/${variant.featuredAsset?.preview}`,
-        additionalEANs: ['1234567890'],
       }),
       // Optional: exclude certain variants from being synced to QLS
       excludeVariantFromSync: (ctx, injector, variant) => {

package/dist/api/api-extensions.js

@@ -19,6 +19,15 @@ exports.adminApiExtensions = (0, graphql_tag_1.default) `
     """
     triggerQlsProductSync: Boolean!
 
+    """
+    Add additional EANs/barcodes to an existing product in QLS.
+    Only EANs that do not already exist in QLS are added. Removal of EANs must be done in QLS itself.
+    """
+    addAdditionalEANSToQLS(
+      variantId: ID!
+      additionalEANS: [String!]!
+    ): [String!]!
+
     """
     Manually push an order to QLS (again)
     """

package/dist/api/generated/graphql.d.ts

@@ -21,11 +21,20 @@ export type Scalars = {
 };
 export type Mutation = {
     __typename?: 'Mutation';
+    /**
+     * Add additional EANs/barcodes to an existing product in QLS.
+     * Only EANs that do not already exist in QLS are added. Removal of EANs must be done in QLS itself.
+     */
+    addAdditionalEANSToQLS: Array<Scalars['String']>;
     /** Manually push an order to QLS (again) */
     pushOrderToQls: Scalars['String'];
     /** Trigger a sync to create or update all products in Vendure to QLS, and pull in stock levels from QLS. */
     triggerQlsProductSync: Scalars['Boolean'];
 };
+export type MutationAddAdditionalEansToQlsArgs = {
+    additionalEANS: Array<Scalars['String']>;
+    variantId: Scalars['ID'];
+};
 export type MutationPushOrderToQlsArgs = {
     orderId: Scalars['ID'];
 };

package/dist/api/qls-admin.resolver.d.ts

@@ -1,12 +1,13 @@
 import { Order, RequestContext } from '@vendure/core';
 import { QlsOrderService } from '../services/qls-order.service';
 import { QlsProductService } from '../services/qls-product.service';
-import { MutationPushOrderToQlsArgs } from './generated/graphql';
+import { MutationAddAdditionalEansToQlsArgs, MutationPushOrderToQlsArgs } from './generated/graphql';
 export declare class QlsAdminResolver {
     private qlsProductService;
     private qlsOrderService;
     constructor(qlsProductService: QlsProductService, qlsOrderService: QlsOrderService);
     qlsOrderIds(ctx: RequestContext, order: Order): Promise<string[]>;
     triggerQlsProductSync(ctx: RequestContext): Promise<boolean>;
+    addAdditionalEANSToQLS(ctx: RequestContext, input: MutationAddAdditionalEansToQlsArgs): Promise<string[]>;
     pushOrderToQls(ctx: RequestContext, input: MutationPushOrderToQlsArgs): Promise<string>;
 }

package/dist/api/qls-admin.resolver.js

@@ -30,6 +30,9 @@ let QlsAdminResolver = class QlsAdminResolver {
         await this.qlsProductService.triggerFullSync(ctx);
         return true;
     }
+    async addAdditionalEANSToQLS(ctx, input) {
+        return await this.qlsProductService.addAdditionalEANsToQls(ctx, input.variantId, input.additionalEANS);
+    }
     async pushOrderToQls(ctx, input) {
         return await this.qlsOrderService.pushOrderToQls(ctx, input.orderId, true);
     }
@@ -56,6 +59,16 @@ __decorate([
     __metadata("design:paramtypes", [core_1.RequestContext]),
     __metadata("design:returntype", Promise)
 ], QlsAdminResolver.prototype, "triggerQlsProductSync", null);
+__decorate([
+    (0, graphql_1.Mutation)(),
+    (0, core_1.Transaction)(),
+    (0, core_1.Allow)(permissions_1.qlsFullSyncPermission.Permission),
+    __param(0, (0, core_1.Ctx)()),
+    __param(1, (0, graphql_1.Args)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [core_1.RequestContext, Object]),
+    __metadata("design:returntype", Promise)
+], QlsAdminResolver.prototype, "addAdditionalEANSToQLS", null);
 __decorate([
     (0, graphql_1.Mutation)(),
     (0, core_1.Transaction)(),

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

@@ -33,10 +33,6 @@ export declare class QlsClient {
      * 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>;
     getServicePoints(countryCode: string, postalCode: string): Promise<QlsServicePoint[]>;
     rawRequest<T>(method: 'POST' | 'GET' | 'PUT' | 'DELETE', action: string, data?: unknown): Promise<QlsApiResponse<T | undefined>>;
 }

package/dist/lib/qls-client.js

@@ -100,12 +100,6 @@ class QlsClient {
             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 getServicePoints(countryCode, postalCode) {
         countryCode = countryCode.toUpperCase();
         const result = await this.rawRequest('GET', `service-points/${countryCode}/${postalCode}`);

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

@@ -55,6 +55,11 @@ export declare class QlsProductService implements OnModuleInit, OnApplicationBoo
      * Trigger a product sync job for particular product variants
      */
     triggerSyncVariants(ctx: RequestContext, productVariantIds: ID[]): Promise<import("@vendure/core/dist/job-queue/subscribable-job").SubscribableJob<QlsProductJobData> | undefined>;
+    /**
+     * Add additional EANs/barcodes to an existing QLS product.
+     * Removal of EANs must be done in QLS itself.
+     */
+    addAdditionalEANsToQls(ctx: RequestContext, variantId: ID, additionalEANs: string[]): Promise<string[]>;
     /**
      * Update the stock level for a variant based on the given available stock
      */
@@ -66,10 +71,6 @@ export declare class QlsProductService implements OnModuleInit, OnApplicationBoo
         status: 'created' | 'updated' | 'not-changed';
         qlsProductId?: string;
     }>;
-    /**
-     * 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,7 +23,6 @@ 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");
 const qls_variant_sync_failed_event_1 = require("./qls-variant-sync-failed-event");
 const core_2 = require("@nestjs/core");
 // Wait for 700ms to avoid rate limit of 500/5 minutes
@@ -270,6 +269,33 @@ let QlsProductService = class QlsProductService {
             productVariantIds,
         }, { retries: 1 });
     }
+    /**
+     * Add additional EANs/barcodes to an existing QLS product.
+     * Removal of EANs must be done in QLS itself.
+     */
+    async addAdditionalEANsToQls(ctx, variantId, additionalEANs) {
+        const client = await (0, qls_client_1.getQlsClient)(ctx, this.options);
+        if (!client) {
+            throw new Error(`QLS not enabled for channel ${ctx.channel.token}`);
+        }
+        const variant = await this.variantService.findOne(ctx, variantId, []);
+        if (!variant) {
+            throw new Error(`Variant with id ${variantId} not found`);
+        }
+        const qlsProductId = variant.customFields.qlsProductId;
+        if (!qlsProductId) {
+            throw new Error(`Variant '${variant.sku}' does not have a QLS product ID. Sync the variant to QLS first.`);
+        }
+        const eansToAdd = additionalEANs
+            .map((ean) => ean.trim())
+            .filter((ean) => ean.length > 0);
+        await Promise.all(eansToAdd.map((ean) => client.addBarcode(qlsProductId, ean)));
+        if (eansToAdd.length > 0) {
+            core_1.Logger.info(`Added additional EANs: ${eansToAdd.join(',')} to variant '${variant.sku}' in QLS`, constants_1.loggerCtx);
+        }
+        await this.triggerSyncVariants(ctx, [variantId]);
+        return eansToAdd;
+    }
     /**
      * Update the stock level for a variant based on the given available stock
      */
@@ -306,7 +332,7 @@ let QlsProductService = class QlsProductService {
         }
         let qlsProduct = existingProduct;
         let createdOrUpdated = 'not-changed';
-        const { additionalEANs, ...additionalVariantFields } = this.options.productSync.getAdditionalVariantFields(ctx, variant);
+        const additionalVariantFields = this.options.productSync.getAdditionalVariantFields(ctx, variant);
         if (!existingProduct) {
             const result = await client.createFulfillmentProduct({
                 name: variant.name,
@@ -334,59 +360,13 @@ let QlsProductService = class QlsProductService {
                 .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, variant);
-            if (createdOrUpdated === 'not-changed' && updatedEANs) {
-                // If nothing changed so far, but EANs changed, then we did update the product in QLS
-                createdOrUpdated = 'updated';
-            }
-        }
+        // Note: additional EANs are no longer synced automatically during product sync.
+        // Use the addAdditionalEANsToQls mutation to add EANs manually.
         if (createdOrUpdated === 'not-changed') {
             core_1.Logger.info(`Variant '${variant.sku}' not updated in QLS, because no changes were found.`, constants_1.loggerCtx);
         }
         return { status: createdOrUpdated, qlsProductId: qlsProduct?.id };
     }
-    /**
-     * Update the additional EANs/barcodes for a product in QLS if needed
-     */
-    async updateAdditionalEANs(ctx, client, qlsProduct, additionalEANs, variant) {
-        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 ||
-            (eansToUpdate.eansToAdd.length === 0 &&
-                eansToUpdate.eansToRemove.length === 0)) {
-            // No updates needed
-            return false;
-        }
-        // Add additional EANs
-        eansToUpdate.eansToAdd = (0, util_2.normalizeEans)(eansToUpdate.eansToAdd);
-        await Promise.all(eansToUpdate.eansToAdd.map((ean) => client.addBarcode(qlsProduct.id, ean)));
-        if (eansToUpdate.eansToAdd.length > 0) {
-            core_1.Logger.info(`Added additional EANs: ${eansToUpdate.eansToAdd.join(',')} to product '${qlsProduct.sku}' in QLS`, constants_1.loggerCtx);
-        }
-        // Remove EANs, normalize first
-        eansToUpdate.eansToRemove = (0, util_2.normalizeEans)(eansToUpdate.eansToRemove);
-        // 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)));
-        // Fetch remaining barcodes from QLS to verify deletion worked
-        const remainingBarcodes = await client.getBarcodes(qlsProduct.id);
-        const remainingEansToRemove = eansToUpdate.eansToRemove.filter((ean) => remainingBarcodes.some((barcode) => barcode.barcode === ean));
-        if (remainingEansToRemove.length > 0) {
-            const errorMessage = `Failed to remove EANs '${remainingEansToRemove.join(',')}' from product '${qlsProduct.sku}' in QLS. Barcodes still present after deletion attempt.`;
-            core_1.Logger.error(errorMessage, constants_1.loggerCtx);
-            await this.eventBus.publish(new qls_variant_sync_failed_event_1.QlsVariantSyncFailedEvent(ctx, variant, new Date(), errorMessage));
-        }
-        else if (eansToUpdate.eansToRemove.length > 0) {
-            core_1.Logger.info(`Removed EANs '${eansToUpdate.eansToRemove.join(',')}' from 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.
      */

package/dist/types.d.ts

@@ -87,7 +87,6 @@ export interface QlsPluginOptions {
  */
 export type AdditionalVariantFields = Partial<FulfillmentProductInput & {
     ean: string;
-    additionalEANs?: string[];
 }>;
 export interface AdditionalOrderFields {
     servicepoint_code?: string;

package/dist/ui/providers.ts

@@ -104,4 +104,47 @@ export default [
         });
     },
   }),
+  addActionBarDropdownMenuItem({
+    id: 'qls-fulfillment-add-ean',
+    label: 'Add additional EAN to QLS',
+    locationId: 'product-variant-detail',
+    icon: 'resistor',
+    requiresPermission: ['QLSFullSync'],
+    onClick: (_, { route, dataService, notificationService }) => {
+      const ean = window.prompt('Enter additional EAN to add to QLS:');
+      if (!ean) {
+        return;
+      }
+      const variantId = route.snapshot.params.id;
+      dataService
+        .mutate(
+          gql`
+            mutation AddAdditionalEANSToQLS(
+              $variantId: ID!
+              $additionalEANS: [String!]!
+            ) {
+              addAdditionalEANSToQLS(
+                variantId: $variantId
+                additionalEANS: $additionalEANS
+              )
+            }
+          `,
+          { variantId, additionalEANS: [ean] }
+        )
+        .subscribe({
+          next: () => {
+            notificationService.notify({
+              message: `Added EAN ${ean} to QLS`,
+              type: 'success',
+            });
+          },
+          error: (err) => {
+            notificationService.notify({
+              message: err.message,
+              type: 'error',
+            });
+          },
+        });
+    },
+  }),
 ];

package/package.json

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

package/dist/services/util.d.ts

@@ -1,15 +0,0 @@
-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

@@ -1,31 +0,0 @@
-"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

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

package/dist/services/util.spec.js

@@ -1,60 +0,0 @@
-"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, null/undefined and empty stringswhen 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']);
-    });
-});