@accounty/bloxs 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+ 
+# 0.1.0 (2025-03-21)
+
+
+### Features
+
+* Implemented Bloxs ([ce5a77c](https://github.com/PalmTreeCoding/Accounty/commit/ce5a77c2899e195101ef17f19f53bbcbaac1e5e8))

package/README.md

@@ -0,0 +1 @@
+# @accounty/bloxs

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@accounty/bloxs",
+  "version": "0.1.0",
+  "dependencies": {
+    "axios": "^1.6.5",
+    "bignumber.js": "^9.1.2",
+    "date-fns": "^3.6.0",
+    "debug": "^4.3.4",
+    "deepmerge": "^4.3.1",
+    "libphonenumber-js": "^1.10.53",
+    "validator": "^13.11.0",
+    "@accounty/core": "0.3.1",
+    "tslib": "2.6.2"
+  },
+  "main": "./src/index.js",
+  "type": "commonjs"
+}

package/src/bloxs.d.ts

@@ -0,0 +1,17 @@
+import AccountyProviderCore from '@accounty/core';
+import debug from 'debug';
+import type { Company, FetchCompaniesOptions, FetchInvoicesOptions, FetchResponse, SalesInvoice } from '@accounty/core';
+import { BloxsCompany, BloxsCredentials, BloxsInvoice } from './bloxs.interface';
+/**
+ * Used docs
+ *
+ * - PDF provided by provider
+ * - https://bloxs.bloxs.io/ODataFeed/$metadata
+ */
+export default class Bloxs extends AccountyProviderCore<BloxsCredentials> {
+    protected log: debug.Debugger;
+    testCredentials(): Promise<boolean>;
+    fetchCompanies(options?: FetchCompaniesOptions): Promise<FetchResponse<Array<Company<BloxsCompany>>>>;
+    fetchInvoices(options?: FetchInvoicesOptions): Promise<FetchResponse<Array<SalesInvoice<BloxsInvoice>>>>;
+    private get;
+}

package/src/bloxs.interface.d.ts

@@ -0,0 +1,60 @@
+import { RemoteDataJson } from '@accounty/core';
+export interface BloxsCredentials {
+    url: string;
+    username: string;
+    password: string;
+}
+export interface BloxsResponse<Result> {
+    value: Result;
+    '@odata.nextLink'?: string;
+}
+export interface BloxsInvoice extends RemoteDataJson {
+    SalesInvoiceId: 99;
+    Reference: '257.2017.00006';
+    WorkflowState: string;
+    WorkflowStateUpdatedTimeStamp: string;
+    InvoiceDate: '2017-04-01T00:00:00+02:00';
+    DueDate: '2017-04-01T00:00:00+02:00';
+    OwnerId: 832;
+    OwnerName: string;
+    RelationId: 645;
+    RelationName: string;
+    Subject: 'Factuur voor periode 1-4-2017 tot en met 30-4-2017';
+    TotalValueExcluding: 1400;
+    TotalValueIncluding: 1400;
+    JournalPostReference: '257.2017.300.00006';
+    TotalValueOutstanding: 0;
+    FinancialYear: 2017;
+    FinancialPeriod: 4;
+    SalesContractId: 121;
+    FinancingContractId: null;
+    PaymentMethod: 'BankTransfer';
+    PaymentTermId: 2;
+    PaymentTerm: string;
+    BankAccountId: number;
+}
+export interface BloxsCompany extends RemoteDataJson {
+    RelationId: 100;
+    Reference: 'R-00484';
+    Type: 'Person' | 'Organisation';
+    RelationType: 'Huurder';
+    State: 'Inactive';
+    ArchiveDate: '2019-10-01T00:00:00+02:00';
+    DisplayName: string;
+    AddressStreet: string;
+    AddressPostalCode: string;
+    AddressCity: string;
+    Email: string;
+    PhoneNumber: string;
+    MobileNumber: string;
+    AddressId: 98;
+    PostalAddressId: null;
+    InvoiceAddressId: null;
+    CoCNumber: null;
+    CoCDescription: null;
+    VATNumber: null;
+    BankAccountNumber: null;
+    BIC: null;
+    CommunicationFormId: 2;
+    DateOfBirth: '1998-05-12T00:00:00+02:00';
+}

package/src/bloxs.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=bloxs.interface.js.map

package/src/bloxs.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bloxs.interface.js","sourceRoot":"","sources":["../../../../packages/bloxs/src/bloxs.interface.ts"],"names":[],"mappings":""}

package/src/bloxs.js

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const core_1 = tslib_1.__importStar(require("@accounty/core"));
+const axios_1 = tslib_1.__importDefault(require("axios"));
+const format_1 = require("date-fns/format");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const deepmerge_1 = tslib_1.__importDefault(require("deepmerge"));
+/**
+ * Used docs
+ *
+ * - PDF provided by provider
+ * - https://bloxs.bloxs.io/ODataFeed/$metadata
+ */
+class Bloxs extends core_1.default {
+    constructor() {
+        super(...arguments);
+        this.log = (0, debug_1.default)('accounty:bloxs');
+    }
+    async testCredentials() {
+        return Boolean(await this.get('SalesInvoices', {}, false));
+    }
+    async fetchCompanies(options = {}) {
+        return {
+            version: new Date().getTime(),
+            data: (await this.get('/Relations', {
+                $filter: 'State eq 1'
+            })).map((company) => {
+                const emailAddresses = company.Email?.split(';') ?? [];
+                const mainEmailAddress = emailAddresses.shift();
+                const hasContactInfo = mainEmailAddress
+                    || company.PhoneNumber
+                    || company.MobileNumber;
+                // TODO:: Asked if we can get this field
+                const country = 'NL';
+                return {
+                    remoteId: `${company.RelationId}`,
+                    name: company.DisplayName,
+                    variant: company.Type === 'Person' ? 'PERSON' : 'COMPANY',
+                    language: null,
+                    country,
+                    currency: null,
+                    reference: `${company.Reference}`,
+                    registrationNr: company.CoCNumber,
+                    taxNr: company.VATNumber,
+                    address: company.AddressStreet
+                        ? {
+                            streetName: company.AddressStreet,
+                            city: company.AddressCity,
+                            zipcode: company.AddressPostalCode,
+                            country
+                        }
+                        : null,
+                    postalAddress: null,
+                    invoiceAddress: null,
+                    contacts: [
+                        hasContactInfo && {
+                            remoteId: `${company.RelationId}`,
+                            email: core_1.utils.toEmail(mainEmailAddress),
+                            firstName: null,
+                            lastName: null,
+                            phoneNr: core_1.utils.toPhoneNumber(country, company.PhoneNumber, false)
+                                || core_1.utils.toPhoneNumber(country, company.MobileNumber, false),
+                            mobileNr: core_1.utils.toPhoneNumber(country, company.MobileNumber, true)
+                                || core_1.utils.toPhoneNumber(country, company.PhoneNumber, true),
+                            language: null
+                        },
+                        ...emailAddresses
+                            .map(core_1.utils.toEmail)
+                            .filter(Boolean)
+                            .map((emailAddress) => ({
+                            remoteId: `${company.RelationId}-${emailAddress}`,
+                            email: emailAddress
+                        }))
+                    ].filter(Boolean),
+                    remoteData: company
+                };
+            })
+        };
+    }
+    async fetchInvoices(options = {}) {
+        return {
+            version: new Date().getTime(),
+            data: (await this.get('/SalesInvoices', {
+                $filter: [
+                    options.state === 'open' && 'TotalValueOutstanding gt 0',
+                    options.state === 'overdue' && `DueDate ge DateTime'${(0, format_1.format)(new Date(), 'yyyy-MM-dd')}'`
+                    // options.version && `LastModified+ge+DateTime'${format(options.version, 'yyyy-MM-dd')}'`
+                ].filter(Boolean).join(' and ')
+            })).map((invoice) => {
+                const centAmount = core_1.utils.toCentAmount(invoice.TotalValueIncluding);
+                const centAmountOpen = core_1.utils.toCentAmount(invoice.TotalValueOutstanding);
+                return {
+                    remoteId: `${invoice.SalesInvoiceId}`,
+                    reference: `${invoice.Reference || invoice.SalesInvoiceId}`,
+                    centAmount,
+                    centAmountPaid: centAmount - centAmountOpen,
+                    centAmountOpen,
+                    companyId: `${invoice.RelationId}`,
+                    // Set the invoice date info
+                    ...this.getInvoiceDateAndDueDate(invoice.InvoiceDate, invoice.DueDate),
+                    remoteData: invoice
+                };
+            })
+        };
+    }
+    async get(url, params = {}, enablePaging = true) {
+        if (!this.credentials ||
+            !this.credentials.url ||
+            !this.credentials.username ||
+            !this.credentials.password) {
+            throw new Error('Missing credentials!');
+        }
+        const baseURL = `${this.credentials.url}/odatafeed`;
+        this.log(`[GET] ${baseURL}${url}?${this.buildQueryParams(params)}`);
+        const response = await axios_1.default.request({
+            method: 'GET',
+            baseURL,
+            url,
+            headers: {
+                Authorization: `Basic ${Buffer.from(`${this.credentials.username}:${this.credentials.password}`).toString('base64')}`
+            },
+            params
+        });
+        if (response.data['@odata.nextLink'] && enablePaging) {
+            return (0, deepmerge_1.default)(response.data.value, await this.get(response.data['@odata.nextLink']));
+        }
+        return response.data.value;
+    }
+}
+exports.default = Bloxs;
+//# sourceMappingURL=bloxs.js.map

package/src/bloxs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bloxs.js","sourceRoot":"","sources":["../../../../packages/bloxs/src/bloxs.ts"],"names":[],"mappings":";;;AAAA,+DAAqG;AACrG,0DAAyB;AACzB,4CAAwC;AACxC,0DAAyB;AACzB,kEAAiC;AAMjC;;;;;GAKG;AACH,MAAqB,KAAM,SAAQ,cAAsC;IAAzE;;QAEY,QAAG,GAAG,IAAA,eAAK,EAAC,gBAAgB,CAAC,CAAA;IAyIzC,CAAC;IAvIQ,KAAK,CAAC,eAAe;QAC1B,OAAO,OAAO,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC,CAAA;IAC5D,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,UAAiC,EAAE;QAC7D,OAAO;YACL,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE;YAC7B,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,CAAsB,YAAY,EAAE;gBACvD,OAAO,EAAE,YAAY;aACtB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;gBAClB,MAAM,cAAc,GAAG,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAA;gBACtD,MAAM,gBAAgB,GAAG,cAAc,CAAC,KAAK,EAAE,CAAA;gBAE/C,MAAM,cAAc,GAAG,gBAAgB;uBAClC,OAAO,CAAC,WAAW;uBACnB,OAAO,CAAC,YAAY,CAAA;gBAEzB,wCAAwC;gBACxC,MAAM,OAAO,GAAG,IAAI,CAAA;gBAEpB,OAAO;oBACL,QAAQ,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE;oBACjC,IAAI,EAAE,OAAO,CAAC,WAAW;oBACzB,OAAO,EAAE,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;oBACzD,QAAQ,EAAE,IAAI;oBACd,OAAO;oBACP,QAAQ,EAAE,IAAI;oBACd,SAAS,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE;oBACjC,cAAc,EAAE,OAAO,CAAC,SAAS;oBACjC,KAAK,EAAE,OAAO,CAAC,SAAS;oBACxB,OAAO,EAAE,OAAO,CAAC,aAAa;wBAC5B,CAAC,CAAC;4BACA,UAAU,EAAE,OAAO,CAAC,aAAa;4BACjC,IAAI,EAAE,OAAO,CAAC,WAAW;4BACzB,OAAO,EAAE,OAAO,CAAC,iBAAiB;4BAClC,OAAO;yBACR;wBACD,CAAC,CAAC,IAAI;oBACR,aAAa,EAAE,IAAI;oBACnB,cAAc,EAAE,IAAI;oBAEpB,QAAQ,EAAE;wBACR,cAAc,IAAI;4BAChB,QAAQ,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE;4BACjC,KAAK,EAAE,YAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC;4BACtC,SAAS,EAAE,IAAI;4BACf,QAAQ,EAAE,IAAI;4BACd,OAAO,EAAE,YAAK,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,WAAW,EAAE,KAAK,CAAC;mCAC5D,YAAK,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC;4BAC9D,QAAQ,EAAE,YAAK,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC;mCAC7D,YAAK,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC;4BAC5D,QAAQ,EAAE,IAAI;yBACG;wBAEnB,GAAG,cAAc;6BACd,GAAG,CAAC,YAAK,CAAC,OAAO,CAAC;6BAClB,MAAM,CAAC,OAAO,CAAC;6BACf,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;4BACtB,QAAQ,EAAE,GAAG,OAAO,CAAC,UAAU,IAAI,YAAY,EAAE;4BACjD,KAAK,EAAE,YAAY;yBACpB,CAAmB,CAAC;qBACxB,CAAC,MAAM,CAAC,OAAO,CAAC;oBAEjB,UAAU,EAAE,OAAO;iBACpB,CAAA;YACH,CAAC,CAAC;SACH,CAAA;IACH,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,UAAgC,EAAE;QAC3D,OAAO;YACL,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE;YAC7B,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,CAAsB,gBAAgB,EAAE;gBAC3D,OAAO,EAAE;oBACP,OAAO,CAAC,KAAK,KAAK,MAAM,IAAI,4BAA4B;oBACxD,OAAO,CAAC,KAAK,KAAK,SAAS,IAAI,uBAAuB,IAAA,eAAM,EAAC,IAAI,IAAI,EAAE,EAAE,YAAY,CAAC,GAAG;oBAEzF,0FAA0F;iBAC3F,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;aAChC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;gBAClB,MAAM,UAAU,GAAG,YAAK,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAA;gBAClE,MAAM,cAAc,GAAG,YAAK,CAAC,YAAY,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAA;gBAExE,OAAO;oBACL,QAAQ,EAAE,GAAG,OAAO,CAAC,cAAc,EAAE;oBACrC,SAAS,EAAE,GAAG,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,cAAc,EAAE;oBAE3D,UAAU;oBACV,cAAc,EAAE,UAAU,GAAG,cAAc;oBAC3C,cAAc;oBAEd,SAAS,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE;oBAElC,4BAA4B;oBAC5B,GAAG,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC;oBAEtE,UAAU,EAAE,OAAO;iBACpB,CAAA;YACH,CAAC,CAAC;SACH,CAAA;IACH,CAAC;IAEO,KAAK,CAAC,GAAG,CAAW,GAAW,EAAE,SAAiB,EAAE,EAAE,YAAY,GAAG,IAAI;QAC/E,IACE,CAAC,IAAI,CAAC,WAAW;YACjB,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG;YACrB,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ;YAC1B,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAC1B,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;QACzC,CAAC;QAED,MAAM,OAAO,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,YAAY,CAAA;QACnD,IAAI,CAAC,GAAG,CAAC,SAAS,OAAO,GAAG,GAAG,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;QAEnE,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,OAAO,CAA0B;YAC5D,MAAM,EAAE,KAAK;YACb,OAAO;YACP,GAAG;YACH,OAAO,EAAE;gBACP,aAAa,EAAE,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,IAAI,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;aACtH;YACD,MAAM;SACP,CAAC,CAAA;QAEF,IAAI,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,YAAY,EAAE,CAAC;YACrD,OAAO,IAAA,mBAAS,EACd,QAAQ,CAAC,IAAI,CAAC,KAAK,EACnB,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CACjD,CAAA;QACH,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAiB,CAAA;IACxC,CAAC;CAEF;AA3ID,wBA2IC"}

package/src/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from './bloxs';
+export * from './bloxs.interface';

package/src/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = void 0;
+const tslib_1 = require("tslib");
+var bloxs_1 = require("./bloxs");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return tslib_1.__importDefault(bloxs_1).default; } });
+tslib_1.__exportStar(require("./bloxs.interface"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/bloxs/src/index.ts"],"names":[],"mappings":";;;;AAAA,iCAAiC;AAAxB,yHAAA,OAAO,OAAA;AAChB,4DAAiC"}