@pinelab/vendure-plugin-e-boekhouden 0.0.3

package/README.md

@@ -0,0 +1,50 @@
+# Vendure E-boekhouden plugin
+
+![Vendure version](https://img.shields.io/npm/dependency-version/vendure-plugin-e-boekhouden/dev/@vendure/core)
+
+### [Official documentation here](https://pinelab-plugins.com/plugin/vendure-plugin-e-boekhouden)
+
+Plugin for syncing orders to the Dutch accounting platform E-boekhouden.nl.
+
+## Getting started
+
+Send orders to e-Boekhouden as `GeldOntvangen` mutation and configured `account` and `contraAccount` numbers. Creates a
+mutation line for each taxrate of the order's tax summary.
+
+1. Add this to your plugin in `vendure-config.ts`:
+
+```ts
+import { EboekhoudenPlugin } from 'vendure-plugin-e-boekhouden'
+
+plugins: [
+  EboekhoudenPlugin,
+  ...
+]
+```
+
+2. Run a database migration to add the config entity to your database.
+3. Add this plugin to the Vendure admin ui plugin to add the configuration screen to Vendure.
+
+```ts
+plugins: [
+  AdminUiPlugin.init({
+    port: 3002,
+    route: 'admin',
+    app: compileUiExtensions({
+      outputPath: path.join(__dirname, '__admin-ui'),
+      extensions: [EboekhoudenPlugin.ui],
+    }),
+  }),
+];
+```
+
+You can read more about Admin UI compilation in the Vendure
+[docs](https://www.vendure.io/docs/plugins/extending-the-admin-ui/#compiling-as-a-deployment-step)
+
+4. Start the server and set your credentials via `Settings > E-boekhouden`
+
+### Development - generate new client
+
+1. Go to https://soap.e-boekhouden.nl/soap.asmx?wsdl and save the wsdl file in `src/client/e-boekhouden-wsdl.xml`.
+2. Run `yarn generate-soap-client`.
+3. `src/client` will now have an updated and typed soap client for e-Boekhouden.

package/dist/api/e-boekhouden-config.entity.d.ts

@@ -0,0 +1,11 @@
+import { DeepPartial, VendureEntity } from '@vendure/core';
+export declare class EBoekhoudenConfigEntity extends VendureEntity {
+    constructor(input?: DeepPartial<EBoekhoudenConfigEntity>);
+    channelToken: string;
+    enabled: boolean;
+    username: string;
+    secret1: string;
+    secret2: string;
+    account: string;
+    contraAccount: string;
+}

package/dist/api/e-boekhouden-config.entity.js

@@ -0,0 +1,52 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EBoekhoudenConfigEntity = void 0;
+const typeorm_1 = require("typeorm");
+const core_1 = require("@vendure/core");
+let EBoekhoudenConfigEntity = class EBoekhoudenConfigEntity extends core_1.VendureEntity {
+    constructor(input) {
+        super(input);
+    }
+};
+__decorate([
+    (0, typeorm_1.Column)({ unique: true }),
+    __metadata("design:type", String)
+], EBoekhoudenConfigEntity.prototype, "channelToken", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: false }),
+    __metadata("design:type", Boolean)
+], EBoekhoudenConfigEntity.prototype, "enabled", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: false }),
+    __metadata("design:type", String)
+], EBoekhoudenConfigEntity.prototype, "username", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: false }),
+    __metadata("design:type", String)
+], EBoekhoudenConfigEntity.prototype, "secret1", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: false }),
+    __metadata("design:type", String)
+], EBoekhoudenConfigEntity.prototype, "secret2", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: false }),
+    __metadata("design:type", String)
+], EBoekhoudenConfigEntity.prototype, "account", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: false }),
+    __metadata("design:type", String)
+], EBoekhoudenConfigEntity.prototype, "contraAccount", void 0);
+EBoekhoudenConfigEntity = __decorate([
+    (0, typeorm_1.Entity)('e_boekhouden_config'),
+    __metadata("design:paramtypes", [Object])
+], EBoekhoudenConfigEntity);
+exports.EBoekhoudenConfigEntity = EBoekhoudenConfigEntity;

package/dist/api/e-boekhouden.adapter.d.ts

@@ -0,0 +1,25 @@
+import { CMutatieRegel, OMut } from '../client';
+import { Order } from '@vendure/core';
+import { EBoekhoudenConfigEntity } from './e-boekhouden-config.entity';
+import { OrderTaxSummary } from '@vendure/common/lib/generated-types';
+/**
+ * Recalculate taxes based on the taxBase+taxTotal (the totalIncVAT), because Vendure calculates taxes per orderline and
+ * EBoekhouden calculates taxes based on the total per taxRate.
+ * This can result in small rounding differences
+ * @param summary
+ */
+export declare const recalculateTaxFromTotalIncVAT: (summary: OrderTaxSummary) => {
+    totalIncVAT: number;
+    totalExVAT: number;
+    totalTax: number;
+};
+export declare class EBoekhoudenAdapter {
+    /**
+     * Transforms an order, together with config, to a e-Boekhouden mutation format
+     * using the order.taxSummary
+     */
+    static toMutation(order: Order, config: EBoekhoudenConfigEntity): OMut;
+    static toMutationLine(tax: OrderTaxSummary, config: EBoekhoudenConfigEntity): CMutatieRegel;
+    static getTax(value: number, reference: string): 'LAAG_VERK_9' | 'HOOG_VERK_21' | 'AFW' | 'GEEN';
+    static toDateString(date: Date): string;
+}

package/dist/api/e-boekhouden.adapter.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EBoekhoudenAdapter = exports.recalculateTaxFromTotalIncVAT = void 0;
+const core_1 = require("@vendure/core");
+const constants_1 = require("../constants");
+const toPrice = (price) => (Math.round(price) / 100).toFixed(2);
+/**
+ * Recalculate taxes based on the taxBase+taxTotal (the totalIncVAT), because Vendure calculates taxes per orderline and
+ * EBoekhouden calculates taxes based on the total per taxRate.
+ * This can result in small rounding differences
+ * @param summary
+ */
+const recalculateTaxFromTotalIncVAT = (summary) => {
+    const taxMultiplier = summary.taxRate / 100 + 1;
+    const totalIncVAT = summary.taxBase + summary.taxTotal;
+    const totalExVAT = totalIncVAT / taxMultiplier;
+    const totalTax = totalIncVAT - totalExVAT;
+    return {
+        totalIncVAT,
+        totalExVAT,
+        totalTax,
+    };
+};
+exports.recalculateTaxFromTotalIncVAT = recalculateTaxFromTotalIncVAT;
+class EBoekhoudenAdapter {
+    /**
+     * Transforms an order, together with config, to a e-Boekhouden mutation format
+     * using the order.taxSummary
+     */
+    static toMutation(order, config) {
+        const description = `Order ${order.code} - ${order.customer?.firstName} ${order.customer?.lastName} (${order.customer?.emailAddress})`;
+        const cMutatieRegel = order.taxSummary.map((summary) => this.toMutationLine(summary, config));
+        return {
+            Soort: 'GeldOntvangen',
+            Datum: this.toDateString(order.orderPlacedAt || order.updatedAt),
+            Rekening: config.account,
+            Omschrijving: description,
+            InExBTW: 'IN',
+            MutatieRegels: {
+                cMutatieRegel,
+            },
+        };
+    }
+    static toMutationLine(tax, config) {
+        const recalculatedTax = (0, exports.recalculateTaxFromTotalIncVAT)(tax);
+        return {
+            BedragExclBTW: toPrice(recalculatedTax.totalExVAT),
+            BedragInclBTW: toPrice(recalculatedTax.totalIncVAT),
+            BedragBTW: toPrice(recalculatedTax.totalTax),
+            BTWPercentage: String(tax.taxRate),
+            TegenrekeningCode: config.contraAccount,
+            BTWCode: this.getTax(tax.taxRate, tax.description),
+            BedragInvoer: toPrice(recalculatedTax.totalIncVAT),
+        };
+    }
+    static getTax(value, reference) {
+        if (value === 9) {
+            return 'LAAG_VERK_9';
+        }
+        else if (value === 21) {
+            return 'HOOG_VERK_21';
+        }
+        else if (value === 0) {
+            return 'GEEN';
+        }
+        else {
+            core_1.Logger.error(`Unknown taxValue ${value} for ${reference}. Used 21 as default`, constants_1.loggerCtx);
+            return 'HOOG_VERK_21';
+        }
+    }
+    static toDateString(date) {
+        const dateString = date.toISOString();
+        return dateString.substr(0, 10);
+    }
+}
+exports.EBoekhoudenAdapter = EBoekhoudenAdapter;

package/dist/api/e-boekhouden.resolver.d.ts

@@ -0,0 +1,11 @@
+import { RequestContext } from '@vendure/core';
+import { EBoekhoudenService } from './e-boekhouden.service';
+import { PermissionDefinition } from '@vendure/core';
+import { EBoekhoudenConfig, EBoekhoudenConfigInput } from '../ui/generated/graphql';
+export declare const eBoekhoudenPermission: PermissionDefinition;
+export declare class EBoekhoudenResolver {
+    private service;
+    constructor(service: EBoekhoudenService);
+    eBoekhoudenConfig(ctx: RequestContext): Promise<EBoekhoudenConfig | null>;
+    updateEBoekhoudenConfig(ctx: RequestContext, input: EBoekhoudenConfigInput): Promise<EBoekhoudenConfig | null>;
+}

package/dist/api/e-boekhouden.resolver.js

@@ -0,0 +1,56 @@
+"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.EBoekhoudenResolver = exports.eBoekhoudenPermission = void 0;
+const graphql_1 = require("@nestjs/graphql");
+const core_1 = require("@vendure/core");
+const e_boekhouden_service_1 = require("./e-boekhouden.service");
+const core_2 = require("@vendure/core");
+exports.eBoekhoudenPermission = new core_2.PermissionDefinition({
+    name: 'eBoekhouden',
+    description: 'Allows enabling e-Boekhouden plugin',
+});
+let EBoekhoudenResolver = class EBoekhoudenResolver {
+    constructor(service) {
+        this.service = service;
+    }
+    async eBoekhoudenConfig(ctx) {
+        return this.service.getConfig(ctx.channel.token);
+    }
+    async updateEBoekhoudenConfig(ctx, input) {
+        return this.service.upsertConfig(ctx.channel.token, input);
+    }
+};
+__decorate([
+    (0, graphql_1.Query)(),
+    (0, core_1.Allow)(exports.eBoekhoudenPermission.Permission),
+    __param(0, (0, core_1.Ctx)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [core_1.RequestContext]),
+    __metadata("design:returntype", Promise)
+], EBoekhoudenResolver.prototype, "eBoekhoudenConfig", null);
+__decorate([
+    (0, graphql_1.Mutation)(),
+    (0, core_1.Allow)(exports.eBoekhoudenPermission.Permission),
+    __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)
+], EBoekhoudenResolver.prototype, "updateEBoekhoudenConfig", null);
+EBoekhoudenResolver = __decorate([
+    (0, graphql_1.Resolver)(),
+    __metadata("design:paramtypes", [e_boekhouden_service_1.EBoekhoudenService])
+], EBoekhoudenResolver);
+exports.EBoekhoudenResolver = EBoekhoudenResolver;

package/dist/api/e-boekhouden.service.d.ts

@@ -0,0 +1,29 @@
+import { ChannelService, EventBus, JobQueue, JobQueueService, OrderService, TransactionalConnection } from '@vendure/core';
+import { OnApplicationBootstrap, OnModuleInit } from '@nestjs/common';
+import { EBoekhoudenConfigEntity } from './e-boekhouden-config.entity';
+import { EBoekhoudenConfigInput } from '../ui/generated/graphql';
+import { EBoekhoudenWsdlClient } from '../client';
+interface JobData {
+    channelToken: string;
+    orderCode: string;
+}
+export declare class EBoekhoudenService implements OnApplicationBootstrap, OnModuleInit {
+    private connection;
+    private orderService;
+    private channelService;
+    private eventBus;
+    private jobQueueService;
+    client: EBoekhoudenWsdlClient;
+    jobQueue: JobQueue<JobData>;
+    constructor(connection: TransactionalConnection, orderService: OrderService, channelService: ChannelService, eventBus: EventBus, jobQueueService: JobQueueService);
+    onModuleInit(): Promise<void>;
+    onApplicationBootstrap(): Promise<void>;
+    upsertConfig(channelToken: string, input: EBoekhoudenConfigInput): Promise<EBoekhoudenConfigEntity>;
+    getConfig(channelToken: string): Promise<EBoekhoudenConfigEntity | null>;
+    getConfigs(): Promise<EBoekhoudenConfigEntity[]>;
+    pushOrder({ orderCode, channelToken }: JobData): Promise<void>;
+    private openSession;
+    closeSession(sessionId: string): Promise<void>;
+    private validate;
+}
+export {};

package/dist/api/e-boekhouden.service.js

@@ -0,0 +1,147 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EBoekhoudenService = void 0;
+const core_1 = require("@vendure/core");
+const common_1 = require("@nestjs/common");
+const e_boekhouden_config_entity_1 = require("./e-boekhouden-config.entity");
+const client_1 = require("../client");
+const constants_1 = require("../constants");
+const e_boekhouden_adapter_1 = require("./e-boekhouden.adapter");
+let EBoekhoudenService = class EBoekhoudenService {
+    constructor(connection, orderService, channelService, eventBus, jobQueueService) {
+        this.connection = connection;
+        this.orderService = orderService;
+        this.channelService = channelService;
+        this.eventBus = eventBus;
+        this.jobQueueService = jobQueueService;
+    }
+    async onModuleInit() {
+        const url = 'https://soap.e-boekhouden.nl/soap.asmx?wsdl';
+        const options = {
+            envelopeKey: 'soap',
+            wsdl_options: {
+                xmlKey: '$xml',
+                overrideRootElement: {
+                    namespace: 'xmlns:soap',
+                },
+            },
+        };
+        this.client = await (0, client_1.createClientAsync)(url, options);
+        this.jobQueue = await this.jobQueueService.createQueue({
+            name: 'push-orders-to-e-boekhouden',
+            process: async (job) => await this.pushOrder(job.data),
+        });
+    }
+    async onApplicationBootstrap() {
+        this.eventBus.ofType(core_1.OrderPlacedEvent).subscribe(async (event) => await this.jobQueue.add({
+            channelToken: event.ctx.channel.token,
+            orderCode: event.order.code,
+        }));
+    }
+    async upsertConfig(channelToken, input) {
+        const existing = await this.connection
+            .getRepository(e_boekhouden_config_entity_1.EBoekhoudenConfigEntity)
+            .findOne({ where: { channelToken } });
+        if (existing) {
+            await this.connection
+                .getRepository(e_boekhouden_config_entity_1.EBoekhoudenConfigEntity)
+                .update(existing.id, input);
+        }
+        else {
+            await this.connection
+                .getRepository(e_boekhouden_config_entity_1.EBoekhoudenConfigEntity)
+                .insert({ ...input, channelToken });
+        }
+        return this.connection
+            .getRepository(e_boekhouden_config_entity_1.EBoekhoudenConfigEntity)
+            .findOneOrFail({ where: { channelToken } });
+    }
+    async getConfig(channelToken) {
+        return this.connection
+            .getRepository(e_boekhouden_config_entity_1.EBoekhoudenConfigEntity)
+            .findOne({ where: { channelToken }, cache: 60000 });
+    }
+    async getConfigs() {
+        return this.connection
+            .getRepository(e_boekhouden_config_entity_1.EBoekhoudenConfigEntity)
+            .find({ cache: 60000 });
+    }
+    async pushOrder({ orderCode, channelToken }) {
+        const config = await this.getConfig(channelToken);
+        if (!config?.enabled) {
+            return;
+        }
+        const channel = await this.channelService.getChannelFromToken(channelToken);
+        const ctx = new core_1.RequestContext({
+            apiType: 'admin',
+            isAuthorized: true,
+            channel,
+            authorizedAsOwnerOnly: false,
+        });
+        const order = await this.orderService.findOneByCode(ctx, orderCode);
+        if (!order) {
+            core_1.Logger.error(`No order with code ${orderCode} found. Not retrying this job`, constants_1.loggerCtx);
+            return;
+        }
+        let sessionId;
+        try {
+            sessionId = await this.openSession(config);
+            const mutation = e_boekhouden_adapter_1.EBoekhoudenAdapter.toMutation(order, config);
+            const result = await this.client.AddMutatieAsync({
+                SessionID: sessionId,
+                SecurityCode2: config.secret2,
+                oMut: mutation,
+            });
+            this.validate(result[0].AddMutatieResult);
+            core_1.Logger.info(`Successfully send order ${orderCode} to e-boekhouden with mutationNr ${result?.[0]?.AddMutatieResult?.Mutatienummer}`, constants_1.loggerCtx);
+        }
+        catch (e) {
+            core_1.Logger.error(`Failed to push order ${order.code} for channel ${config.channelToken} to account ${config.username}: ${e?.message}`, constants_1.loggerCtx, e);
+            throw e;
+        }
+        finally {
+            if (sessionId) {
+                await this.closeSession(sessionId);
+            }
+        }
+    }
+    async openSession(config) {
+        const openSession = await this.client.OpenSessionAsync({
+            SecurityCode1: config.secret1,
+            SecurityCode2: config.secret2,
+            Username: config.username,
+        });
+        this.validate(openSession[0].OpenSessionResult);
+        const sessionId = openSession[0].OpenSessionResult?.SessionID;
+        if (!sessionId) {
+            throw Error(`No SessionID from OpenSession for account ${config.username}`);
+        }
+        return sessionId;
+    }
+    async closeSession(sessionId) {
+        await this.client.CloseSessionAsync({ SessionID: sessionId });
+    }
+    validate(res) {
+        if (res?.ErrorMsg?.LastErrorDescription || res?.ErrorMsg?.LastErrorCode) {
+            throw Error(`${res.ErrorMsg?.LastErrorCode} - ${res.ErrorMsg?.LastErrorDescription}`);
+        }
+    }
+};
+EBoekhoudenService = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [core_1.TransactionalConnection,
+        core_1.OrderService,
+        core_1.ChannelService,
+        core_1.EventBus,
+        core_1.JobQueueService])
+], EBoekhoudenService);
+exports.EBoekhoudenService = EBoekhoudenService;

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

@@ -0,0 +1 @@
+export declare const schema: import("graphql").DocumentNode;

package/dist/api/schema.graphql.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.schema = void 0;
+const graphql_tag_1 = __importDefault(require("graphql-tag"));
+exports.schema = (0, graphql_tag_1.default) `
+  input EBoekhoudenConfigInput {
+    enabled: Boolean!
+    username: String!
+    secret1: String!
+    secret2: String!
+    account: String!
+    contraAccount: String!
+  }
+
+  type EBoekhoudenConfig {
+    enabled: Boolean!
+    username: String!
+    secret1: String!
+    secret2: String!
+    account: String!
+    contraAccount: String!
+  }
+
+  extend type Mutation {
+    updateEBoekhoudenConfig(input: EBoekhoudenConfigInput!): EBoekhoudenConfig
+  }
+
+  extend type Query {
+    eBoekhoudenConfig: EBoekhoudenConfig
+  }
+`;