@tasenor/common-node 1.9.16

package/dist/tasenor-common-node/src/plugins/ReportPlugin.js

@@ -0,0 +1,393 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import fs from 'fs';
+import { data2csv } from '..';
+import dayjs from 'dayjs';
+import quarterOfYear from 'dayjs/plugin/quarterOfYear';
+import { BackendPlugin } from './BackendPlugin';
+dayjs.extend(quarterOfYear);
+/**
+ * A plugin providing one or more reports.
+ */
+export class ReportPlugin extends BackendPlugin {
+    formats;
+    // Is set, allow this report only on DBs having those accounting schemes.
+    schemes;
+    constructor(...formats) {
+        super();
+        this.formats = formats;
+        this.schemes = undefined;
+    }
+    /**
+     * Read in report struture file.
+     */
+    getReportStructure(id, lang) {
+        const path = this.filePath(`${id}-${lang}.tsv`);
+        if (fs.existsSync(path)) {
+            return fs.readFileSync(path).toString('utf-8');
+        }
+    }
+    /**
+     * Get the list of supported languages.
+     */
+    getLanguages() {
+        return [];
+    }
+    /**
+     * Check if the given report is provided by this plugin.
+     * @param id
+     */
+    hasReport(id) {
+        return this.formats.includes(id);
+    }
+    /**
+     * Get the list of report IDs.
+     */
+    getFormats(scheme = undefined) {
+        if (this.schemes === undefined || scheme === undefined || this.schemes.has(scheme)) {
+            return this.formats;
+        }
+        return [];
+    }
+    /**
+     * Return UI option definitions for the given report.
+     * @param id
+     */
+    getReportOptions(id) {
+        return {};
+    }
+    /**
+     * Convert time stamp or Date to date string YYYY-MM-DD.
+     * @param {Number} timestamp
+     */
+    time2str(timestamp) {
+        if (timestamp === null) {
+            return null;
+        }
+        if (timestamp instanceof Date) {
+            timestamp = timestamp.toISOString();
+        }
+        return timestamp.substr(0, 10);
+    }
+    /**
+     * Construct rendering information from report flags
+     * @param flags
+     * @returns
+     */
+    flags2item(flags) {
+        const item = {};
+        flags.forEach(flag => {
+            if (flag) {
+                switch (flag) {
+                    case 'NEW_PAGE':
+                        break;
+                    case 'BREAK':
+                        item.break = true;
+                        break;
+                    case 'BOLD':
+                        item.bold = true;
+                        break;
+                    case 'ITALIC':
+                        item.italic = true;
+                        break;
+                    case 'DETAILS':
+                        item.accountDetails = true;
+                        break;
+                    case 'HIDE_TOTAL':
+                        item.hideTotal = true;
+                        break;
+                    case 'REQUIRED':
+                        item.required = true;
+                        break;
+                    default:
+                        throw new Error(`Cannot recognize report format flag '${flag}'.`);
+                }
+            }
+        });
+        return item;
+    }
+    /**
+     * Construct column definitions for the report.
+     * @param id
+     * @param entries
+     * @param options
+     */
+    async getColumns(id, entries, options, settings) {
+        if (!options.periods) {
+            throw new Error(`Need periods to define columns ${JSON.stringify(options)}`);
+        }
+        const columns = options.periods.map((period) => {
+            return {
+                type: 'numeric',
+                name: 'period' + period.id,
+                title: this.columnTitle(id, period, options)
+            };
+        });
+        columns.unshift({
+            name: 'title',
+            title: '',
+            type: 'name'
+        });
+        return columns;
+    }
+    /**
+     * Construct a title for a column.
+     * @param id
+     * @param period
+     * @param options
+     */
+    columnTitle(id, period, options) {
+        throw new Error(`Report plugin ${this.constructor.name} does not implement columnTitle().`);
+    }
+    /**
+     * Force some options, if needed.
+     * @returns
+     */
+    forceOptions(options) {
+        return {
+            negateAssetAndProfit: false,
+            addPreviousPeriod: false // A flag to define if the previous period should be displayed for comparison.
+        };
+    }
+    /**
+     * Construct a SQL for the report query.
+     * @param db
+     * @param options
+     * @returns A knex query prepared.
+     */
+    async constructSqlQuery(db, options, settings) {
+        // Construct value negator.
+        let negateSql = '(CASE debit WHEN true THEN 1 ELSE -1 END)';
+        if (options.negateAssetAndProfit) {
+            negateSql += " * (CASE WHEN account.type IN ('ASSET', 'PROFIT') THEN 1 ELSE -1 END)";
+        }
+        // Find periods.
+        const periodIds = [options.periodId];
+        if (options.addPreviousPeriod) {
+            const recentPeriods = await db.select('*').from('period').where('id', '<=', options.periodId).orderBy('end_date', 'desc').limit(2);
+            if (recentPeriods.length > 1) {
+                periodIds.push(recentPeriods[1].id);
+            }
+            options.periods = recentPeriods; // Save periods for further reference.
+        }
+        // Build a query basics.
+        let sqlQuery = db.select('document.period_id AS periodId', 'document.number AS documentId', 'document.date', 'account.name', 'account.type', 'account.number', db.raw(`CAST(ROUND(${negateSql} * entry.amount * 100) AS BIGINT) AS amount`), 'entry.description')
+            .from('entry')
+            .leftJoin('account', 'account.id', 'entry.account_id')
+            .leftJoin('document', 'document.id', 'entry.document_id')
+            .whereIn('document.period_id', periodIds);
+        // Limit by account, if given.
+        if (options.accountId) {
+            sqlQuery = sqlQuery.andWhere('account.id', '=', options.accountId);
+        }
+        // Tune ordering.
+        sqlQuery = (sqlQuery
+            .orderBy('document.date')
+            .orderBy('document.number')
+            .orderBy('document.id')
+            .orderBy('entry.row_number'));
+        return sqlQuery;
+    }
+    /**
+     * Construct a report data for the report.
+     * @param db
+     * @param id
+     * @param options
+     *
+     * Resulting entries on data is an array of objects containing:
+     * * `tab` Zero originating indentation number.
+     * * `error` If true, this row has an error.
+     * * `required` If true, this is always shown.
+     * * `hideTotal` if true, do not show total.
+     * * `bold` if true, show in bold.
+     * * `italic` if true, show in italic.
+     * * `bigger` if true, show in bigger font.
+     * * `fullWidth` if set, the content in column index defined here is expanded to cover all columns.
+     * * `useRemainingColumns` if set, extend this column index to use all the rest columns in the row.
+     * * `accountDetails` if true, after this are summarized accounts under this entry.
+     * * `isAccount` if true, this is an account entry.
+     * * `needLocalization` if set, value should be localized, i.e. translated via Localization component in ui.
+     * * `name` Title of the entry.
+     * * `number` Account number if the entry is an account.
+     * * `amounts` An object with entry for each column mapping name of the columnt to the value to display.
+     */
+    async renderReport(db, id, options = {}) {
+        // Add report forced options.
+        Object.assign(options, this.forceOptions(options));
+        // Collect settings.
+        const settings = (await db('settings').where('name', 'like', `${this.code}.%`).orWhere({ name: 'companyName' }).orWhere({ name: 'companyCode' })).reduce((prev, cur) => ({ ...prev, [cur.name]: cur.value }), {});
+        // Find tags.
+        const settingName = `${this.code}.tagTypes`;
+        if (options.byTags && settings[settingName]) {
+            const tags = await db('tags').select('id', 'tag', 'name', 'type', 'order').from('tags').whereIn('type', settings[settingName]).orderBy('order');
+            settings.tags = tags;
+        }
+        else {
+            settings.tags = [];
+        }
+        // Find the formatting text description, if it exist.
+        options.format = this.getReportStructure(id, options.lang || 'en');
+        // Prepare query.
+        const q = await this.constructSqlQuery(db, options, settings);
+        let entries = await q;
+        // Process big ints.
+        for (const entry of entries) {
+            entry.amount = parseInt(entry.amount);
+        }
+        // Apply query filtering.
+        entries = this.doFiltering(id, entries, options, settings);
+        // We have now relevant entries collected. Use plugin features next.
+        const columns = await this.getColumns(id, entries, options, settings);
+        let data = this.preProcess(id, entries, options, settings, columns);
+        data = this.postProcess(id, data, options, settings, columns);
+        const report = {
+            format: id,
+            columns,
+            meta: {
+                businessName: settings.companyName,
+                businessId: settings.companyCode
+            },
+            data
+        };
+        // Do the final conversion, if necessary.
+        if (options.csv) {
+            return data2csv(report, options);
+        }
+        return report;
+    }
+    /**
+     * Filter out entries not matching to the report selected parameters.
+     * @param id
+     * @param entries
+     * @param options
+     * @param settings
+     */
+    doFiltering(id, entries, options, settings) {
+        let filter = (entry) => true;
+        if (options.quarter1) {
+            filter = (entry) => dayjs(entry.date).quarter() <= 1;
+        }
+        if (options.quarter2) {
+            filter = (entry) => dayjs(entry.date).quarter() <= 2;
+        }
+        if (options.quarter3) {
+            filter = (entry) => dayjs(entry.date).quarter() <= 3;
+        }
+        return entries.filter(filter);
+    }
+    /**
+     * This function converts the list of relevant entries to the column report data.
+     * @param id
+     * @param entries
+     * @param options
+     * @param columns
+     */
+    preProcess(id, entries, options, settings, columns) {
+        throw new Error(`Report plugin ${this.constructor.name} does not implement preProcess().`);
+    }
+    /**
+     * Do post processing for report data before sending it.
+     * @param id Report type.
+     * @param data Calculated report data
+     * @param options Report options.
+     * @param settings System settings.
+     * @param columns Column definitions.
+     * @returns
+     */
+    postProcess(id, data, options, settings, columns) {
+        return data;
+    }
+    /**
+     * A helper to combine final report from pre-processed material for reports using text description.
+     * @param accountNumbers A set of all account numbers found.
+     * @param accountNames A mapping from account numbers to their names.
+     * @param columnNames A list of column names.
+     * @param format A text description of the report.
+     * @param totals A mapping from account numbers their total balance.
+     * @returns
+     */
+    parseAndCombineReport(accountNumbers, accountNames, columns, format, totals) {
+        const columnNames = columns.filter((col) => col.type === 'numeric').map((col) => col.name);
+        // Parse report and construct format.
+        const allAccounts = Array.from(accountNumbers).sort();
+        const ret = [];
+        format.split('\n').forEach((line) => {
+            if (/^#/.test(line)) {
+                return;
+            }
+            let [numbers, text, flags] = line.split('\t');
+            numbers = numbers.split(' ');
+            flags = flags ? new Set(flags.trim().split(/\s+/)) : new Set();
+            const tab = text ? text.replace(/^(_*).*/, '$1').length : 0;
+            text = text ? text.replace(/^_+/, '') : '';
+            if (flags.has('NEW_PAGE')) {
+                ret.push({ pageBreak: true });
+                return;
+            }
+            if (flags.has('BREAK')) {
+                ret.push({ paragraphBreak: true });
+                return;
+            }
+            // Split the line and reset variables.
+            const amounts = {};
+            columnNames.forEach((column) => (amounts[column] = null));
+            let unused = true;
+            const item = { tab, ...this.flags2item(flags) };
+            // Collect all totals inside any of the account number ranges.
+            for (let i = 0; i < numbers.length; i++) {
+                const parts = numbers[i].split('-');
+                const from = parts[0];
+                const to = parts[1];
+                columnNames.forEach((column) => {
+                    allAccounts.forEach((number) => {
+                        if (number >= from && number < to) {
+                            unused = false;
+                            if (totals[column][number] !== undefined) {
+                                amounts[column] += totals[column][number];
+                            }
+                        }
+                    });
+                });
+            }
+            // If we actually show details we can skip this entry and fill details below.
+            if (!item.accountDetails) {
+                if (item.required || !unused) {
+                    item.name = text;
+                    item.amounts = amounts;
+                    ret.push(item);
+                }
+            }
+            // Fill in account details for the entries wanting it.
+            if (item.accountDetails) {
+                for (let i = 0; i < numbers.length; i++) {
+                    const parts = numbers[i].split('-');
+                    const from = parts[0];
+                    const to = parts[1];
+                    allAccounts.forEach((number) => {
+                        if (number >= from && number < to) {
+                            const item = { tab, ...this.flags2item(flags) };
+                            item.isAccount = true;
+                            delete item.accountDetails;
+                            item.name = accountNames[number];
+                            item.number = number;
+                            item.amounts = {};
+                            columnNames.forEach((column) => {
+                                if (!item.amounts) {
+                                    item.amounts = {};
+                                }
+                                if (totals[column][number] === undefined) {
+                                    item.amounts[column] = null;
+                                }
+                                else {
+                                    item.amounts[column] = totals[column][number] + 0;
+                                }
+                            });
+                            ret.push(item);
+                        }
+                    });
+                }
+            }
+        });
+        return ret;
+    }
+}
+//# sourceMappingURL=ReportPlugin.js.map

package/dist/tasenor-common-node/src/plugins/ReportPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReportPlugin.js","sourceRoot":"","sources":["../../../../src/plugins/ReportPlugin.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,OAAO,EAAE,MAAM,IAAI,CAAA;AACnB,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAA;AAC7B,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,aAAa,MAAM,4BAA4B,CAAA;AAEtD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;AAE3B;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,aAAa;IAErC,OAAO,CAAY;IAC3B,yEAAyE;IAC/D,OAAO,CAAyB;IAE1C,YAAY,GAAG,OAAmB;QAChC,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,SAAS,CAAA;IAC1B,CAAC;IAED;;OAEG;IACH,kBAAkB,CAAC,EAAY,EAAE,IAAc;QAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,IAAI,MAAM,CAAC,CAAA;QAC/C,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YACvB,OAAO,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAiB,CAAA;SAC/D;IACH,CAAC;IAED;;OAEG;IACH,YAAY;QACV,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,EAAE;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;IAClC,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,SAA2B,SAAS;QAC7C,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAClF,OAAO,IAAI,CAAC,OAAO,CAAA;SACpB;QACD,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;;OAGG;IACH,gBAAgB,CAAC,EAAE;QACjB,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,SAAS;QAChB,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,OAAO,IAAI,CAAA;SACZ;QACD,IAAI,SAAS,YAAY,IAAI,EAAE;YAC7B,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAA;SACpC;QACD,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAChC,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,KAAuB;QAChC,MAAM,IAAI,GAAe,EAAE,CAAA;QAC3B,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACnB,IAAI,IAAI,EAAE;gBACR,QAAQ,IAAI,EAAE;oBACZ,KAAK,UAAU;wBACb,MAAK;oBACP,KAAK,OAAO;wBACV,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;wBACjB,MAAK;oBACP,KAAK,MAAM;wBACT,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;wBAChB,MAAK;oBACP,KAAK,QAAQ;wBACX,IAAI,CAAC,MAAM,GAAG,IAAI,CAAA;wBAClB,MAAK;oBACP,KAAK,SAAS;wBACZ,IAAI,CAAC,cAAc,GAAG,IAAI,CAAA;wBAC1B,MAAK;oBACP,KAAK,YAAY;wBACf,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;wBACrB,MAAK;oBACP,KAAK,UAAU;wBACb,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;wBACpB,MAAK;oBACP;wBACE,MAAM,IAAI,KAAK,CAAC,wCAAwC,IAAI,IAAI,CAAC,CAAA;iBACpE;aACF;QACH,CAAC,CAAC,CAAA;QACF,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAC,EAAE,EAAE,OAAO,EAAE,OAAsB,EAAE,QAAQ;QAC5D,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,kCAAkC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;SAC7E;QACD,MAAM,OAAO,GAA6B,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACvE,OAAO;gBACL,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,QAAQ,GAAG,MAAM,CAAC,EAAE;gBAC1B,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC;aAC7C,CAAA;QACH,CAAC,CAAC,CAAA;QACF,OAAO,CAAC,OAAO,CAAC;YACd,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE;YACT,IAAI,EAAE,MAAM;SACb,CAAC,CAAA;QACF,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,EAAY,EAAE,MAAmB,EAAE,OAAsB;QACnE,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,CAAC,WAAW,CAAC,IAAI,oCAAoC,CAAC,CAAA;IAC7F,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,OAAO;QAClB,OAAO;YACL,oBAAoB,EAAE,KAAK;YAC3B,iBAAiB,EAAE,KAAK,CAAC,8EAA8E;SACxG,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iBAAiB,CAAC,EAAE,EAAE,OAAO,EAAE,QAAQ;QAC3C,2BAA2B;QAC3B,IAAI,SAAS,GAAG,2CAA2C,CAAA;QAC3D,IAAI,OAAO,CAAC,oBAAoB,EAAE;YAChC,SAAS,IAAI,uEAAuE,CAAA;SACrF;QAED,gBAAgB;QAChB,MAAM,SAAS,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;QACpC,IAAI,OAAO,CAAC,iBAAiB,EAAE;YAC7B,MAAM,aAAa,GAAG,MAAM,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YAClI,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC5B,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;aACpC;YACD,OAAO,CAAC,OAAO,GAAG,aAAa,CAAA,CAAC,sCAAsC;SACvE;QAED,wBAAwB;QACxB,IAAI,QAAQ,GAAG,EAAE,CAAC,MAAM,CACtB,gCAAgC,EAChC,+BAA+B,EAC/B,eAAe,EACf,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,EAAE,CAAC,GAAG,CAAC,cAAc,SAAS,6CAA6C,CAAC,EAC5E,mBAAmB,CACpB;aACE,IAAI,CAAC,OAAO,CAAC;aACb,QAAQ,CAAC,SAAS,EAAE,YAAY,EAAE,kBAAkB,CAAC;aACrD,QAAQ,CAAC,UAAU,EAAE,aAAa,EAAE,mBAAmB,CAAC;aACxD,OAAO,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAA;QAE3C,8BAA8B;QAC9B,IAAI,OAAO,CAAC,SAAS,EAAE;YACrB,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;SACnE;QAED,iBAAiB;QACjB,QAAQ,GAAG,CAAC,QAAQ;aACjB,OAAO,CAAC,eAAe,CAAC;aACxB,OAAO,CAAC,iBAAiB,CAAC;aAC1B,OAAO,CAAC,aAAa,CAAC;aACtB,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAA;QAE/B,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,EAAE,UAA6B,EAAE;QAExD,6BAA6B;QAC7B,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;QAElD,oBAAoB;QACpB,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA;QAEjN,aAAa;QACb,MAAM,WAAW,GAAG,GAAG,IAAI,CAAC,IAAI,WAAW,CAAA;QAC3C,IAAI,OAAO,CAAC,MAAM,IAAI,QAAQ,CAAC,WAAW,CAAC,EAAE;YAC3C,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;YAC/I,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAA;SACrB;aAAM;YACL,QAAQ,CAAC,IAAI,GAAG,EAAE,CAAA;SACnB;QAED,qDAAqD;QACrD,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,CAAA;QAElE,iBAAiB;QACjB,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,EAAE,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;QAC7D,IAAI,OAAO,GAAG,MAAM,CAAC,CAAA;QAErB,oBAAoB;QACpB,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;YAC3B,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;SACtC;QAED,yBAAyB;QACzB,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;QAE1D,oEAAoE;QACpE,MAAM,OAAO,GAA6B,MAAM,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,OAAO,EAAE,OAAwB,EAAE,QAAQ,CAAC,CAAA;QAChH,IAAI,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;QACnE,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;QAC7D,MAAM,MAAM,GAAG;YACb,MAAM,EAAE,EAAE;YACV,OAAO;YACP,IAAI,EAAE;gBACJ,YAAY,EAAE,QAAQ,CAAC,WAAW;gBAClC,UAAU,EAAE,QAAQ,CAAC,WAAW;aACjC;YACD,IAAI;SACL,CAAA;QAED,yCAAyC;QACzC,IAAI,OAAO,CAAC,GAAG,EAAE;YACf,OAAO,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;SACjC;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ;QACxC,IAAI,MAAM,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAA;QAE5B,IAAI,OAAO,CAAC,QAAQ,EAAE;YACpB,MAAM,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;SACrD;QAAC,IAAI,OAAO,CAAC,QAAQ,EAAE;YACtB,MAAM,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;SACrD;QAAC,IAAI,OAAO,CAAC,QAAQ,EAAE;YACtB,MAAM,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;SACrD;QAED,OAAO,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAC/B,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO;QAChD,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,CAAC,WAAW,CAAC,IAAI,mCAAmC,CAAC,CAAA;IAC5F,CAAC;IAED;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO;QAC9C,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;OAQG;IACH,qBAAqB,CAAC,cAA+B,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM;QAC1F,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAE1F,qCAAqC;QACrC,MAAM,WAAW,GAAoB,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,EAAE,CAAA;QACtE,MAAM,GAAG,GAAiB,EAAE,CAAA;QAC5B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAClC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBACnB,OAAM;aACP;YACD,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YAC7C,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAC5B,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAA;YAC9D,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;YAC3D,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;YAE1C,IAAI,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;gBACzB,GAAG,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;gBAC7B,OAAM;aACP;YAED,IAAI,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;gBACtB,GAAG,CAAC,IAAI,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAA;gBAClC,OAAM;aACP;YAED,sCAAsC;YACtC,MAAM,OAAO,GAAkC,EAAE,CAAA;YACjD,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;YACzD,IAAI,MAAM,GAAG,IAAI,CAAA;YACjB,MAAM,IAAI,GAAe,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAA;YAE3D,8DAA8D;YAC9D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBACvC,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;gBACnC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;gBACrB,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;gBACnB,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;oBAC7B,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;wBAC7B,IAAI,MAAM,IAAI,IAAI,IAAI,MAAM,GAAG,EAAE,EAAE;4BACjC,MAAM,GAAG,KAAK,CAAA;4BACd,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE;gCACxC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAA;6BAC1C;yBACF;oBACH,CAAC,CAAC,CAAA;gBACJ,CAAC,CAAC,CAAA;aACH;YAED,6EAA6E;YAC7E,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;gBACxB,IAAI,IAAI,CAAC,QAAQ,IAAI,CAAC,MAAM,EAAE;oBAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;oBAChB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;oBACtB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;iBACf;aACF;YAED,sDAAsD;YACtD,IAAI,IAAI,CAAC,cAAc,EAAE;gBACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;oBACvC,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;oBACnC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;oBACrB,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;oBACnB,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;wBAC7B,IAAI,MAAM,IAAI,IAAI,IAAI,MAAM,GAAG,EAAE,EAAE;4BACjC,MAAM,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAA;4BAC/C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;4BACrB,OAAO,IAAI,CAAC,cAAc,CAAA;4BAC1B,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,CAAA;4BAChC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;4BACpB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;4BACjB,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;gCAC7B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;oCACjB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;iCAClB;gCACD,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE;oCACxC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAA;iCAC5B;qCAAM;oCACL,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;iCAClD;4BACH,CAAC,CAAC,CAAA;4BACF,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;yBACf;oBACH,CAAC,CAAC,CAAA;iBACH;aACF;QACH,CAAC,CAAC,CAAA;QAEF,OAAO,GAAG,CAAA;IACZ,CAAC;CACF"}

package/dist/tasenor-common-node/src/plugins/SchemePlugin.d.ts

@@ -0,0 +1,34 @@
+import { Currency, Language, SchemeName, TsvFilePath } from '@dataplug/tasenor-common';
+import { BackendPlugin } from './BackendPlugin';
+/**
+ * A plugin providing one or more accounting schemes.
+ */
+export declare class SchemePlugin extends BackendPlugin {
+    private schemes;
+    constructor(...schemes: SchemeName[]);
+    /**
+     * Check if this plugin has the given scheme.
+     * @param code
+     * @returns
+     */
+    hasScheme(code: any): boolean;
+    /**
+     * Get the paths to the accounting scheme .tsv files by its code name.
+     * @param code
+     */
+    getSchemePaths(code: any, languae: any): TsvFilePath[];
+    /**
+     * Get the default settings for the new database.
+     * @param  code
+     * @returns
+     */
+    getSchemeDefaults(code: any): Record<string, unknown>;
+    /**
+     * Supported currencies.
+     */
+    supportedCurrencies(): Currency[];
+    /**
+     * Supported languages.
+     */
+    supportedLanguages(): Language[];
+}

package/dist/tasenor-common-node/src/plugins/SchemePlugin.js

@@ -0,0 +1,47 @@
+import { BackendPlugin } from './BackendPlugin';
+/**
+ * A plugin providing one or more accounting schemes.
+ */
+export class SchemePlugin extends BackendPlugin {
+    schemes;
+    constructor(...schemes) {
+        super();
+        this.schemes = new Set(schemes);
+    }
+    /**
+     * Check if this plugin has the given scheme.
+     * @param code
+     * @returns
+     */
+    hasScheme(code) {
+        return this.schemes.has(code);
+    }
+    /**
+     * Get the paths to the accounting scheme .tsv files by its code name.
+     * @param code
+     */
+    getSchemePaths(code, languae) {
+        throw new Error(`A class ${this.constructor.name} does not implement getScheme().`);
+    }
+    /**
+     * Get the default settings for the new database.
+     * @param  code
+     * @returns
+     */
+    getSchemeDefaults(code) {
+        return {};
+    }
+    /**
+     * Supported currencies.
+     */
+    supportedCurrencies() {
+        return [];
+    }
+    /**
+     * Supported languages.
+     */
+    supportedLanguages() {
+        return [];
+    }
+}
+//# sourceMappingURL=SchemePlugin.js.map

package/dist/tasenor-common-node/src/plugins/SchemePlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemePlugin.js","sourceRoot":"","sources":["../../../../src/plugins/SchemePlugin.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,aAAa;IAErC,OAAO,CAAiB;IAEhC,YAAY,GAAG,OAAqB;QAClC,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAA;IACjC,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,IAAI;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAC/B,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,IAAI,EAAE,OAAO;QAC1B,MAAM,IAAI,KAAK,CAAC,WAAW,IAAI,CAAC,WAAW,CAAC,IAAI,kCAAkC,CAAC,CAAA;IACrF,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,IAAI;QACpB,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;OAEG;IACH,mBAAmB;QACjB,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,OAAO,EAAE,CAAA;IACX,CAAC;CACF"}

package/dist/tasenor-common-node/src/plugins/ServicePlugin.d.ts

@@ -0,0 +1,80 @@
+import { PluginService, PluginServiceResponse } from '@dataplug/tasenor-common';
+import { BackendPlugin } from './BackendPlugin';
+import { KnexDatabase } from '..';
+export type ServicePluginRequestOptions = {
+    rateLimitDelay?: number;
+};
+/**
+ * An API end point provider.
+ */
+export declare class ServicePlugin extends BackendPlugin {
+    private services;
+    constructor(...services: any[]);
+    getServices(): PluginService[];
+    /**
+     * A query executor called by the back end for API request.
+     * @param best The currently best solution found.
+     * @param db Knex database.
+     * @param service Name of the service to called.
+     * @param query Query parameters.
+     * This calls the actual query function, handles errors and finally modifies `best` if found a solution.
+     */
+    executeQuery(best: unknown, db: KnexDatabase, service: PluginService, query: Record<string, unknown>): Promise<void>;
+    /**
+     * Perform the actual query.
+     *
+     * @param db Knex database.
+     * @param service Name of the service to called.
+     * @param query Query parameters.
+     */
+    query(db: KnexDatabase, settings: Record<string, unknown>, service: PluginService, query: unknown): Promise<void>;
+    /**
+     * Combine result of the service query.
+     *
+     * @param old Currently found solution.
+     * @param latest The solution given by this plugin.
+     *
+     * By default, any 2xx status result will override the current result.
+     * Any error result will override initial 404 result.
+     * Otherwise the latest is ignored.
+     */
+    addResult(old: any, latest: any): void;
+    /**
+     * Check if the current solution is sufficient.
+     * By default, any status 2xx is sufficient.
+     */
+    isAdequate(solution: any): boolean;
+    /**
+     * Execute query to the third party service,
+     * @param service
+     * @param method
+     * @param url
+     * @param params
+     * @returns Result body.
+     */
+    request(service: any, method: any, url: any, params: any, headers?: {}): Promise<PluginServiceResponse>;
+    /**
+     * Pick meaningful keys unique from the headers for using as a key, whe storing result to teh cache.
+     * @param service
+     * @param header
+     * By default, no header is used as cache key.
+     */
+    cacheHeadersKey(service: any, header: any): {};
+    /**
+     * Pick meaningful keys unique from the query parameters for using as a key, whe storing result to teh cache.
+     * @param service
+     * @param params
+     * By default, all parameters are used as cache key.
+     */
+    cacheParamsKey(service: any, params: any): any;
+    /**
+     * Execute query to the third party service,
+     * @param db
+     * @param service
+     * @param method
+     * @param url
+     * @param params
+     * @returns Result body.
+     */
+    cachedRequest(db: KnexDatabase | null, service: any, method: any, url: any, params: any, headers?: {}, options?: ServicePluginRequestOptions): Promise<any>;
+}