@pinelab/vendure-plugin-qls-fulfillment 1.0.0-beta.10 → 1.0.0-beta.12

package/README.md

@@ -51,6 +51,33 @@ This plugin only uses Vendure's default stock location, that means you should ei
 
 Vendure assumes the first created stock location is the default stock location.
 
+## Service Points
+
+You can use the query `qlsServicePoints(postalCode: String!): [QlsServicePoint!]!` to get the service points for a given postal code. You can use the `setOrderCustomFields` mutation to set the service point on an order.
+
+```graphql
+mutation {
+  setOrderCustomFields(
+    input: {
+      customFields: {
+        qlsServicePointId: "12232" # This is the ID of one of the points returned by the query above
+        qlsServicePointDetails: "Some details about the service point for admin users" # This is just for admin users in Vendure
+      }
+    }
+  ) {
+    __typename
+    ... on Order {
+      id
+      code
+      customFields {
+        qlsServicePointId
+        qlsServicePointDetails
+      }
+    }
+  }
+}
+```
+
 ## Monitoring
 
 Make sure to monitor failed jobs: A job that failed after its retries were exhausted, means:

package/dist/api/api-extensions.d.ts

@@ -1 +1,2 @@
 export declare const adminApiExtensions: import("graphql").DocumentNode;
+export declare const shopApiExtensions: import("graphql").DocumentNode;

package/dist/api/api-extensions.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.adminApiExtensions = void 0;
+exports.shopApiExtensions = exports.adminApiExtensions = void 0;
 const graphql_tag_1 = __importDefault(require("graphql-tag"));
 exports.adminApiExtensions = (0, graphql_tag_1.default) `
   extend type Mutation {
@@ -18,3 +18,47 @@ exports.adminApiExtensions = (0, graphql_tag_1.default) `
     pushOrderToQls(orderId: ID!): String!
   }
 `;
+exports.shopApiExtensions = (0, graphql_tag_1.default) `
+  type QlsServicePoint {
+    servicepoint_code: String!
+    name: String!
+    address: QlsServicePointAddress!
+    geo: QlsServicePointGeo!
+    times: [QlsServicePointTime!]!
+    needsPostNumber: Boolean!
+    productId: Int!
+    productName: String!
+  }
+
+  type QlsServicePointAddress {
+    country: String!
+    postalcode: String!
+    locality: String!
+    street: String!
+    housenumber: String!
+  }
+
+  type QlsServicePointGeo {
+    lat: Float!
+    long: Float!
+  }
+
+  type QlsServicePointTime {
+    weekday: Int!
+    formatted: String!
+    from: String!
+    to: String!
+  }
+
+  input QlsServicePointSearchInput {
+    countryCode: String!
+    postalCode: String!
+  }
+
+  extend type Query {
+    """
+    Get the service points for a given postal code
+    """
+    qlsServicePoints(input: QlsServicePointSearchInput!): [QlsServicePoint!]!
+  }
+`;

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

@@ -29,3 +29,46 @@ export type Mutation = {
 export type MutationPushOrderToQlsArgs = {
     orderId: Scalars['ID'];
 };
+export type QlsServicePoint = {
+    __typename?: 'QlsServicePoint';
+    address: QlsServicePointAddress;
+    geo: QlsServicePointGeo;
+    name: Scalars['String'];
+    needsPostNumber: Scalars['Boolean'];
+    productId: Scalars['Int'];
+    productName: Scalars['String'];
+    servicepoint_code: Scalars['String'];
+    times: Array<QlsServicePointTime>;
+};
+export type QlsServicePointAddress = {
+    __typename?: 'QlsServicePointAddress';
+    country: Scalars['String'];
+    housenumber: Scalars['String'];
+    locality: Scalars['String'];
+    postalcode: Scalars['String'];
+    street: Scalars['String'];
+};
+export type QlsServicePointGeo = {
+    __typename?: 'QlsServicePointGeo';
+    lat: Scalars['Float'];
+    long: Scalars['Float'];
+};
+export type QlsServicePointSearchInput = {
+    countryCode: Scalars['String'];
+    postalCode: Scalars['String'];
+};
+export type QlsServicePointTime = {
+    __typename?: 'QlsServicePointTime';
+    formatted: Scalars['String'];
+    from: Scalars['String'];
+    to: Scalars['String'];
+    weekday: Scalars['Int'];
+};
+export type Query = {
+    __typename?: 'Query';
+    /** Get the service points for a given postal code */
+    qlsServicePoints: Array<QlsServicePoint>;
+};
+export type QueryQlsServicePointsArgs = {
+    input: QlsServicePointSearchInput;
+};

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

@@ -3,9 +3,9 @@ import { QlsProductService } from '../services/qls-product.service';
 import { MutationPushOrderToQlsArgs } from './generated/graphql';
 import { QlsOrderService } from '../services/qls-order.service';
 export declare class QlsAdminResolver {
-    private qlsService;
+    private qlsProductService;
     private qlsOrderService;
-    constructor(qlsService: QlsProductService, qlsOrderService: QlsOrderService);
+    constructor(qlsProductService: QlsProductService, qlsOrderService: QlsOrderService);
     triggerQlsProductSync(ctx: RequestContext): Promise<boolean>;
     pushOrderToQls(ctx: RequestContext, input: MutationPushOrderToQlsArgs): Promise<string>;
 }

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

@@ -19,12 +19,12 @@ const qls_product_service_1 = require("../services/qls-product.service");
 const qls_order_service_1 = require("../services/qls-order.service");
 const permissions_1 = require("../config/permissions");
 let QlsAdminResolver = class QlsAdminResolver {
-    constructor(qlsService, qlsOrderService) {
-        this.qlsService = qlsService;
+    constructor(qlsProductService, qlsOrderService) {
+        this.qlsProductService = qlsProductService;
         this.qlsOrderService = qlsOrderService;
     }
     async triggerQlsProductSync(ctx) {
-        await this.qlsService.triggerFullSync(ctx);
+        await this.qlsProductService.triggerFullSync(ctx);
         return true;
     }
     async pushOrderToQls(ctx, input) {

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

@@ -0,0 +1,8 @@
+import { RequestContext } from '@vendure/core';
+import { QlsOrderService } from '../services/qls-order.service';
+import { QlsServicePoint, QlsServicePointSearchInput } from './generated/graphql';
+export declare class QlsShopResolver {
+    private qlsOrderService;
+    constructor(qlsOrderService: QlsOrderService);
+    qlsServicePoints(ctx: RequestContext, input: QlsServicePointSearchInput): Promise<QlsServicePoint[]>;
+}

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

@@ -0,0 +1,39 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QlsShopResolver = void 0;
+const graphql_1 = require("@nestjs/graphql");
+const core_1 = require("@vendure/core");
+const qls_order_service_1 = require("../services/qls-order.service");
+let QlsShopResolver = class QlsShopResolver {
+    constructor(qlsOrderService) {
+        this.qlsOrderService = qlsOrderService;
+    }
+    async qlsServicePoints(ctx, input) {
+        return await this.qlsOrderService.getServicePoints(ctx, input);
+    }
+};
+exports.QlsShopResolver = QlsShopResolver;
+__decorate([
+    (0, graphql_1.Query)(),
+    __param(0, (0, core_1.Ctx)()),
+    __param(1, (0, graphql_1.Args)('input')),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [core_1.RequestContext, Object]),
+    __metadata("design:returntype", Promise)
+], QlsShopResolver.prototype, "qlsServicePoints", null);
+exports.QlsShopResolver = QlsShopResolver = __decorate([
+    (0, graphql_1.Resolver)(),
+    __metadata("design:paramtypes", [qls_order_service_1.QlsOrderService])
+], QlsShopResolver);

package/dist/custom-fields.d.ts

@@ -5,3 +5,4 @@ declare module '@vendure/core' {
     }
 }
 export declare const variantCustomFields: CustomFieldConfig[];
+export declare const orderCustomFields: CustomFieldConfig[];

package/dist/custom-fields.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.variantCustomFields = void 0;
+exports.orderCustomFields = exports.variantCustomFields = void 0;
 const core_1 = require("@vendure/core");
 exports.variantCustomFields = [
     {
@@ -13,3 +13,31 @@ exports.variantCustomFields = [
         ui: { tab: 'QLS' },
     },
 ];
+exports.orderCustomFields = [
+    {
+        name: 'qlsServicePointId',
+        type: 'string',
+        label: [{ value: 'QLS Service Point ID', languageCode: core_1.LanguageCode.en }],
+        nullable: true,
+        public: true,
+        readonly: false,
+        ui: { tab: 'QLS' },
+    },
+    {
+        name: 'qlsServicePointDetails',
+        type: 'string',
+        label: [
+            { value: 'QLS Service Point Details', languageCode: core_1.LanguageCode.en },
+        ],
+        description: [
+            {
+                value: 'Only used for display purposes.',
+                languageCode: core_1.LanguageCode.en,
+            },
+        ],
+        nullable: true,
+        public: true,
+        readonly: false,
+        ui: { tab: 'QLS' },
+    },
+];

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

@@ -1,6 +1,7 @@
 import { RequestContext } from '@vendure/core';
 import { QlsClientConfig, QlsPluginOptions } from '../types';
 import type { FulfillmentOrder, FulfillmentOrderInput, FulfillmentProduct, FulfillmentProductInput, QlsApiResponse } from './client-types';
+import { QlsServicePoint } from '../api/generated/graphql';
 export declare function getQlsClient(ctx: RequestContext, pluginOptions: QlsPluginOptions): Promise<QlsClient | undefined>;
 /**
  * Wrapper around the QLS Rest API.
@@ -30,5 +31,6 @@ export declare class QlsClient {
      * 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>>;
+    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

@@ -26,7 +26,7 @@ class QlsClient {
      */
     async getFulfillmentProductBySku(sku) {
         const result = await this.rawRequest('GET', `fulfillment/products?filter%5Bsku%5D=${encodeURIComponent(sku)}`);
-        if (result.data.length === 0) {
+        if (!result.data || result.data.length === 0) {
             return undefined;
         }
         if (result.data.length > 1) {
@@ -57,10 +57,16 @@ class QlsClient {
     }
     async createFulfillmentProduct(data) {
         const response = await this.rawRequest('POST', 'fulfillment/products', data);
+        if (!response.data) {
+            throw new Error('Failed to create fulfillment product. Got empty response.');
+        }
         return response.data;
     }
     async updateFulfillmentProduct(fulfillmentProductId, data) {
         const response = await this.rawRequest('PUT', `fulfillment/products/${fulfillmentProductId}`, data);
+        if (!response.data) {
+            throw new Error('Failed to update fulfillment product. Got empty response.');
+        }
         return response.data;
     }
     async createFulfillmentOrder(data) {
@@ -68,6 +74,9 @@ class QlsClient {
             ...data,
             brand_id: this.config.brandId,
         });
+        if (!response.data) {
+            throw new Error('Failed to create fulfillment order. Got empty response.');
+        }
         return response.data;
     }
     /**
@@ -84,6 +93,11 @@ class QlsClient {
     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}`);
+        return result.data ?? [];
+    }
     async rawRequest(method, action, data) {
         // Set headers
         const headers = {
@@ -98,6 +112,15 @@ class QlsClient {
             headers,
             body,
         });
+        if (response.status === 204) {
+            // 204 No Content
+            return {
+                data: undefined,
+                meta: {
+                    code: response.status,
+                },
+            };
+        }
         if (!response.ok) {
             const errorText = await response.text();
             // Log error including the request body

package/dist/qls-plugin.js

@@ -15,6 +15,7 @@ const core_1 = require("@vendure/core");
 const path_1 = __importDefault(require("path"));
 const api_extensions_1 = require("./api/api-extensions");
 const qls_admin_resolver_1 = require("./api/qls-admin.resolver");
+const qls_shop_resolver_1 = require("./api/qls-shop.resolver");
 const qls_webhooks_controller_1 = require("./api/qls-webhooks-controller");
 const permissions_1 = require("./config/permissions");
 const constants_1 = require("./constants");
@@ -49,6 +50,7 @@ exports.QlsPlugin = QlsPlugin = QlsPlugin_1 = __decorate([
             config.authOptions.customPermissions.push(permissions_1.qlsFullSyncPermission);
             config.authOptions.customPermissions.push(permissions_1.qlsPushOrderPermission);
             config.customFields.ProductVariant.push(...custom_fields_1.variantCustomFields);
+            config.customFields.Order.push(...custom_fields_1.orderCustomFields);
             return config;
         },
         compatibility: '>=3.2.0',
@@ -56,5 +58,9 @@ exports.QlsPlugin = QlsPlugin = QlsPlugin_1 = __decorate([
             schema: api_extensions_1.adminApiExtensions,
             resolvers: [qls_admin_resolver_1.QlsAdminResolver],
         },
+        shopApiExtensions: {
+            schema: api_extensions_1.shopApiExtensions,
+            resolvers: [qls_shop_resolver_1.QlsShopResolver],
+        },
     })
 ], QlsPlugin);

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

@@ -3,6 +3,7 @@ import { ModuleRef } from '@nestjs/core';
 import { EventBus, ID, Job, JobQueueService, OrderService, RequestContext, TransactionalConnection } from '@vendure/core';
 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;
@@ -25,5 +26,6 @@ export declare class QlsOrderService implements OnModuleInit, OnApplicationBoots
      */
     handleOrderStatusUpdate(ctx: RequestContext, body: IncomingOrderWebhook): Promise<void>;
     triggerPushOrder(ctx: RequestContext, orderId: ID, orderCode?: string): Promise<Job<QlsOrderJobData> | undefined>;
+    getServicePoints(ctx: RequestContext, input: QlsServicePointSearchInput): Promise<QlsServicePoint[]>;
     private getVendureOrderState;
 }

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

@@ -133,6 +133,7 @@ let QlsOrderService = class QlsOrderService {
                 ...(additionalOrderFields ?? {}),
             };
             const result = await client.createFulfillmentOrder(qlsOrder);
+            core_2.Logger.info(`Successfully created order '${order.code}' in QLS with id '${result.id}'`, constants_1.loggerCtx);
             await this.orderService.addNoteToOrder(ctx, {
                 id: orderId,
                 isPublic: false,
@@ -184,6 +185,13 @@ let QlsOrderService = class QlsOrderService {
             orderId,
         }, { retries: 5 });
     }
+    async getServicePoints(ctx, input) {
+        const client = await (0, qls_client_1.getQlsClient)(ctx, this.options);
+        if (!client) {
+            throw new core_2.UserInputError(`QLS not enabled for channel ${ctx.channel.token}`);
+        }
+        return await client.getServicePoints(input.countryCode, input.postalCode);
+    }
     getVendureOrderState(body) {
         if (body.cancelled) {
             return 'Cancelled';

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

@@ -89,6 +89,8 @@ 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) {
@@ -123,14 +125,15 @@ let QlsProductService = class QlsProductService {
                         updatedQlsProductsCount += 1;
                     }
                     if (result === 'created' || result === 'updated') {
-                        // Wait for 700ms to avoid rate limit of 500/5 minutes, but only if we created or updated a product, otherwise no calls have been made yet.
-                        await new Promise((resolve) => setTimeout(resolve, 700));
+                        // Wait only if we created or updated a product, otherwise no calls have been made yet.
+                        await waitToPreventRateLimit();
                     }
                 }
                 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;
+                    await waitToPreventRateLimit();
                 }
             }
             core_1.Logger.info(`Created ${createdQlsProductsCount} products in QLS`, constants_1.loggerCtx);
@@ -295,7 +298,9 @@ let QlsProductService = class QlsProductService {
             existingEans: existingAdditionalEANs,
             desiredEans: additionalEANs,
         });
-        if (!eansToUpdate || eansToUpdate.eansToAdd.length === 0 && eansToUpdate.eansToRemove.length === 0) {
+        if (!eansToUpdate ||
+            (eansToUpdate.eansToAdd.length === 0 &&
+                eansToUpdate.eansToRemove.length === 0)) {
             // No updates needed
             return false;
         }

package/package.json

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