@pinelab/vendure-plugin-qls-fulfillment 1.0.0-beta.17 → 1.0.0-beta.19

package/dist/qls-plugin.js

@@ -24,7 +24,11 @@ const qls_order_service_1 = require("./services/qls-order.service");
 const qls_product_service_1 = require("./services/qls-product.service");
 let QlsPlugin = QlsPlugin_1 = class QlsPlugin {
     static init(options) {
-        this.options = options;
+        this.options = {
+            synchronizeStockLevels: true,
+            autoPushOrders: true,
+            ...options,
+        };
         return QlsPlugin_1;
     }
 };

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

@@ -1,18 +1,17 @@
 import { OnApplicationBootstrap, OnModuleInit } from '@nestjs/common';
 import { ModuleRef } from '@nestjs/core';
-import { EventBus, ID, Job, JobQueueService, OrderService, RequestContext, TransactionalConnection } from '@vendure/core';
+import { EventBus, ID, Job, JobQueueService, OrderService, RequestContext } from '@vendure/core';
+import { QlsServicePoint, QlsServicePointSearchInput } from '../api/generated/graphql';
 import { IncomingOrderWebhook } from '../lib/client-types';
 import { QlsOrderJobData, QlsPluginOptions } from '../types';
-import { QlsServicePoint, QlsServicePointSearchInput } from '../api/generated/graphql';
 export declare class QlsOrderService implements OnModuleInit, OnApplicationBootstrap {
-    private connection;
     private options;
     private jobQueueService;
     private eventBus;
     private orderService;
     private moduleRef;
     private orderJobQueue;
-    constructor(connection: TransactionalConnection, options: QlsPluginOptions, jobQueueService: JobQueueService, eventBus: EventBus, orderService: OrderService, moduleRef: ModuleRef);
+    constructor(options: QlsPluginOptions, jobQueueService: JobQueueService, eventBus: EventBus, orderService: OrderService, moduleRef: ModuleRef);
     onApplicationBootstrap(): void;
     onModuleInit(): Promise<void>;
     /**

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

@@ -24,8 +24,7 @@ const util_1 = __importDefault(require("util"));
 const constants_1 = require("../constants");
 const qls_client_1 = require("../lib/qls-client");
 let QlsOrderService = class QlsOrderService {
-    constructor(connection, options, jobQueueService, eventBus, orderService, moduleRef) {
-        this.connection = connection;
+    constructor(options, jobQueueService, eventBus, orderService, moduleRef) {
         this.options = options;
         this.jobQueueService = jobQueueService;
         this.eventBus = eventBus;
@@ -35,6 +34,10 @@ let QlsOrderService = class QlsOrderService {
     onApplicationBootstrap() {
         // Listen for OrderPlacedEvent and add a job to the queue
         this.eventBus.ofType(core_2.OrderPlacedEvent).subscribe((event) => {
+            if (!this.options.autoPushOrders) {
+                core_2.Logger.info(`Auto push orders disabled, not triggering push order job for order ${event.order.code}`, constants_1.loggerCtx);
+                return;
+            }
             this.triggerPushOrder(event.ctx, event.order.id, event.order.code).catch((e) => {
                 const error = (0, catch_unknown_1.asError)(e);
                 core_2.Logger.error(`Failed to trigger push order job for order ${event.order.code}: ${error.message}`, constants_1.loggerCtx, error.stack);
@@ -87,7 +90,15 @@ let QlsOrderService = class QlsOrderService {
         }
         try {
             // Check if all products are available in QLS
-            const qlsProducts = order.lines.map((line) => {
+            const qlsProducts = order.lines
+                .filter((line) => {
+                if (this.options.excludeVariantFromSync?.(ctx, line.productVariant)) {
+                    core_2.Logger.info(`Product variant '${line.productVariant.sku}' not sent to QLS in order '${order.code}' because it is excluded from sync.`, constants_1.loggerCtx);
+                    return false;
+                }
+                return true;
+            })
+                .map((line) => {
                 if (!line.productVariant.customFields.qlsProductId) {
                     throw new Error(`Product variant '${line.productVariant.sku}' does not have a QLS product ID set. Unable to push order '${order.code}' to QLS.`);
                 }
@@ -115,10 +126,11 @@ 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 processable = (await this.options.processOrderFrom?.(ctx, order)) ?? new Date();
             const receiverContact = this.options.getReceiverContact?.(ctx, order);
             const qlsOrder = {
                 customer_reference: order.code,
-                processable: new Date().toISOString(), // Processable starting now
+                processable: processable.toISOString(),
                 servicepoint_code: order.customFields?.qlsServicePointId,
                 delivery_options: additionalOrderFields?.delivery_options ?? [],
                 total_price: order.totalWithTax,
@@ -217,8 +229,8 @@ let QlsOrderService = class QlsOrderService {
 exports.QlsOrderService = QlsOrderService;
 exports.QlsOrderService = QlsOrderService = __decorate([
     (0, common_1.Injectable)(),
-    __param(1, (0, common_1.Inject)(constants_1.PLUGIN_INIT_OPTIONS)),
-    __metadata("design:paramtypes", [core_2.TransactionalConnection, Object, core_2.JobQueueService,
+    __param(0, (0, common_1.Inject)(constants_1.PLUGIN_INIT_OPTIONS)),
+    __metadata("design:paramtypes", [Object, core_2.JobQueueService,
         core_2.EventBus,
         core_2.OrderService,
         core_1.ModuleRef])

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

@@ -37,7 +37,8 @@ export declare class QlsProductService implements OnModuleInit, OnApplicationBoo
      */
     runFullSync(ctx: RequestContext): Promise<SyncProductsResult>;
     /**
-     * Utility function to remove all products from QLS
+     * Utility function to remove all products from QLS.
+     * You might need to cancel active orders in QLS first, because products cannot be deleted if they are in an active order.
      */
     removeAllProductsFromQls(ctx: RequestContext): Promise<void>;
     /**

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

@@ -159,17 +159,19 @@ let QlsProductService = class QlsProductService {
         }
     }
     /**
-     * Utility function to remove all products from QLS
+     * Utility function to remove all products from QLS.
+     * You might need to cancel active orders in QLS first, because products cannot be deleted if they are in an active order.
      */
     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);
+        core_1.Logger.warn(`Removing 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);
+            core_1.Logger.info(`Removed product '${product.sku}' (${product.id}) from QLS`, constants_1.loggerCtx);
             await waitToPreventRateLimit();
         }
         core_1.Logger.warn(`Removed ${allProducts.length} products from QLS for channel ${ctx.channel.token}`, constants_1.loggerCtx);
@@ -400,7 +402,7 @@ 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) {
+        if (!this.options.synchronizeStockLevels) {
             core_1.Logger.warn(`Stock sync disabled. Not updating stock for variant '${variantId}'`, constants_1.loggerCtx);
             return;
         }

package/dist/types.d.ts

@@ -21,10 +21,21 @@ export interface QlsPluginOptions {
      */
     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
+     * Allows you to disable the pulling in of stock levels from QLS. When disabled, stock in Vendure will not be modified based on QLS stock levels.
+     * Defaults to true.
      */
-    disableStockSync?: boolean;
+    synchronizeStockLevels?: boolean;
+    /**
+     * Allows you to disable the automatic pushing of orders to QLS. You can still push orders manually via the Admin UI.
+     * Defaults to true.
+     */
+    autoPushOrders?: boolean;
+    /**
+     * Allows you to define a date from when the order should be processed by QLS.
+     * You can for example make orders processable 2 hours from now, so that you can still edit the order in QLS
+     * Defaults to now.
+     */
+    processOrderFrom?: (ctx: RequestContext, order: Order) => Date | Promise<Date>;
     /**
      * 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.

package/package.json

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