@tasenor/common-node 1.9.16

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

@@ -0,0 +1,91 @@
+import { TasenorElement, BackendCatalog, Constructor, DirectoryPath, FilePath, Language, PluginCode, PluginType, PluginUse, Version, ID } from '@dataplug/tasenor-common';
+import { KnexDatabase } from '..';
+/**
+ * Baseclass for all plugins for back-end.
+ */
+export declare class BackendPlugin {
+    id: ID;
+    code: PluginCode;
+    title: string;
+    version: Version | null;
+    releaseDate: Date | string | null;
+    use: PluginUse | 'unknown';
+    type: PluginType | 'unknown';
+    icon: string;
+    description: string;
+    path: string;
+    languages: Record<string, Record<string, string>>;
+    private catalog?;
+    constructor();
+    /**
+     * Hook to be executed once during installing.
+     */
+    install(): Promise<void>;
+    /**
+     * Hook to be executed one during uninstalling.
+     */
+    uninstall(): Promise<void>;
+    /**
+     * Hook to register hooks when launching backend.
+     */
+    load(catalog: BackendCatalog): void;
+    /**
+     * Hook to be executed once for every database during installing.
+     * @param db Knex instance of the database.
+     */
+    installToDb(db: KnexDatabase): Promise<void>;
+    /**
+     * Hook to be executed once for every database during uninstalling.
+     * @param db Knex instance of the database.
+     */
+    uninstallFromDb(db: KnexDatabase): Promise<void>;
+    /**
+     * Get the full path to the directory of this plugin.
+     * @returns The path.
+     */
+    get fullPath(): DirectoryPath;
+    /**
+     * Construct the full path to the file of this module.
+     * @param name
+     * @returns The path.
+     */
+    filePath(name: string): FilePath;
+    /**
+     * Collect meta data as a JSON object.
+     * @returns Object
+     */
+    toJSON(): Record<string, unknown>;
+    /**
+     * Get the UI setting description or null if the plugin has no settings.
+     */
+    getSettings(): TasenorElement | null;
+    /**
+     * Do the translation for a string.
+     */
+    t(str: string, lang: Language): string;
+    /**
+     * Get the settings variable values for this plugin.
+     * @param db
+     * @param name
+     */
+    getSetting(db: KnexDatabase, name: string): Promise<any>;
+    /**
+     * A scheduled function that is ran once an hour. The hour number is in server time.
+     */
+    hourly(hour: number): Promise<void>;
+    /**
+     * A scheduled function that is ran once a day during night time on server time.
+     */
+    nightly(db: KnexDatabase): Promise<void>;
+    /**
+     * Ensure private working directory for this plugin and reserved for the given database.
+     */
+    getWorkSpace(db: KnexDatabase): DirectoryPath;
+    /**
+     * Create an instance of a plugin class and copy static fields into the instance.
+     * @param Class
+     * @param path
+     * @returns
+     */
+    static create(Class: Constructor<BackendPlugin>, id: ID, path: FilePath, catalog: BackendCatalog): BackendPlugin;
+}

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

@@ -0,0 +1,165 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { getServerRoot } from '@dataplug/tasenor-common';
+import * as path from 'path';
+import * as fs from 'fs';
+/**
+ * Baseclass for all plugins for back-end.
+ */
+export class BackendPlugin {
+    id;
+    code;
+    title;
+    version;
+    releaseDate;
+    use;
+    type;
+    icon;
+    description;
+    path;
+    languages;
+    catalog;
+    constructor() {
+        this.id = null;
+        this.code = '';
+        this.title = '';
+        this.version = null;
+        this.releaseDate = null;
+        this.use = 'unknown';
+        this.type = 'unknown';
+        this.icon = '';
+        this.description = '';
+        this.path = '';
+        // Plugin translations from language code to the translation dictionary.
+        this.languages = {};
+    }
+    /**
+     * Hook to be executed once during installing.
+     */
+    async install() {
+        // Do nothing by default.
+    }
+    /**
+     * Hook to be executed one during uninstalling.
+     */
+    async uninstall() {
+        // Do nothing by default.
+    }
+    /**
+     * Hook to register hooks when launching backend.
+     */
+    load(catalog) {
+        // Do nothing by default.
+    }
+    /**
+     * Hook to be executed once for every database during installing.
+     * @param db Knex instance of the database.
+     */
+    async installToDb(db) {
+        // Do nothing by default.
+    }
+    /**
+     * Hook to be executed once for every database during uninstalling.
+     * @param db Knex instance of the database.
+     */
+    async uninstallFromDb(db) {
+        // Do nothing by default.
+    }
+    /**
+     * Get the full path to the directory of this plugin.
+     * @returns The path.
+     */
+    get fullPath() {
+        return this.path;
+    }
+    /**
+     * Construct the full path to the file of this module.
+     * @param name
+     * @returns The path.
+     */
+    filePath(name) {
+        return `${this.fullPath}/backend/${name}`;
+    }
+    /**
+     * Collect meta data as a JSON object.
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            id: this.id,
+            code: this.code,
+            title: this.title,
+            description: this.description,
+            icon: this.icon,
+            version: this.version,
+            releaseDate: this.releaseDate,
+            use: this.use,
+            type: this.type,
+            path: this.path
+        };
+    }
+    /**
+     * Get the UI setting description or null if the plugin has no settings.
+     */
+    getSettings() {
+        return null;
+    }
+    /**
+     * Do the translation for a string.
+     */
+    t(str, lang) {
+        if (this.catalog) {
+            return this.catalog.t(str, lang);
+        }
+        // Mainly useful for plugin testing: translate using local plugin translations if no catalog available.
+        if ((lang in this.languages) && (str in this.languages[lang])) {
+            return this.languages[lang][str];
+        }
+        return str;
+    }
+    /**
+     * Get the settings variable values for this plugin.
+     * @param db
+     * @param name
+     */
+    async getSetting(db, name) {
+        const setting = await db('settings').select('value').where({ name: `${this.code}.${name}` }).first();
+        return setting ? setting.value : undefined;
+    }
+    /**
+     * A scheduled function that is ran once an hour. The hour number is in server time.
+     */
+    async hourly(hour) {
+        // Do nothing by default.
+    }
+    /**
+     * A scheduled function that is ran once a day during night time on server time.
+     */
+    async nightly(db) {
+        // Do nothing by default.
+    }
+    /**
+     * Ensure private working directory for this plugin and reserved for the given database.
+     */
+    getWorkSpace(db) {
+        const workdir = path.join(getServerRoot(), 'src', 'plugins', 'workspace', this.code, db.client.config.connection.database);
+        if (!fs.existsSync(workdir)) {
+            fs.mkdirSync(workdir, { recursive: true });
+        }
+        fs.chmodSync(workdir, 0o700);
+        return workdir;
+    }
+    /**
+     * Create an instance of a plugin class and copy static fields into the instance.
+     * @param Class
+     * @param path
+     * @returns
+     */
+    static create(Class, id, path, catalog) {
+        const instance = new Class();
+        instance.id = id;
+        instance.path = path;
+        instance.catalog = catalog;
+        return instance;
+    }
+}
+//# sourceMappingURL=BackendPlugin.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BackendPlugin.js","sourceRoot":"","sources":["../../../../src/plugins/BackendPlugin.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,OAAO,EAAkI,aAAa,EAAE,MAAM,0BAA0B,CAAA;AACxL,OAAO,KAAK,IAAI,MAAM,MAAM,CAAA;AAC5B,OAAO,KAAK,EAAE,MAAM,IAAI,CAAA;AAGxB;;GAEG;AACH,MAAM,OAAO,aAAa;IAEjB,EAAE,CAAI;IACN,IAAI,CAAY;IAChB,KAAK,CAAQ;IACb,OAAO,CAAgB;IACvB,WAAW,CAAsB;IACjC,GAAG,CAAuB;IAC1B,IAAI,CAAwB;IAC5B,IAAI,CAAQ;IACZ,WAAW,CAAQ;IACnB,IAAI,CAAQ;IACZ,SAAS,CAAwC;IAChD,OAAO,CAAiB;IAEhC;QACE,IAAI,CAAC,EAAE,GAAG,IAAI,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,EAAgB,CAAA;QAC5B,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;QACf,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACnB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAA;QACvB,IAAI,CAAC,GAAG,GAAG,SAAS,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAA;QACrB,IAAI,CAAC,IAAI,GAAG,EAAE,CAAA;QACd,IAAI,CAAC,WAAW,GAAG,EAAE,CAAA;QACrB,IAAI,CAAC,IAAI,GAAG,EAAE,CAAA;QAEd,wEAAwE;QACxE,IAAI,CAAC,SAAS,GAAG,EAChB,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO;QACX,yBAAyB;IAC3B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS;QACb,yBAAyB;IAC3B,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,OAAuB;QAC1B,yBAAyB;IAC3B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW,CAAC,EAAgB;QAChC,yBAAyB;IAC3B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe,CAAC,EAAgB;QACpC,yBAAyB;IAC3B,CAAC;IAED;;;OAGG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,IAAqB,CAAA;IACnC,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,IAAY;QACnB,OAAO,GAAG,IAAI,CAAC,QAAQ,YAAY,IAAI,EAAc,CAAA;IACvD,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAA;IACH,CAAC;IAED;;OAEG;IACH,WAAW;QACT,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACH,CAAC,CAAC,GAAW,EAAE,IAAc;QAC3B,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;SACjC;QACD,uGAAuG;QACvG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE;YAC7D,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAA;SACjC;QACD,OAAO,GAAG,CAAA;IACZ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,EAAgB,EAAE,IAAY;QAC7C,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAA;QACpG,OAAO,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;IAC5C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,IAAY;QACvB,yBAAyB;IAC3B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,EAAgB;QAC5B,yBAAyB;IAC3B,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,EAAgB;QAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;QAE1H,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;YAC3B,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;SAC3C;QAED,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAE5B,OAAO,OAAwB,CAAA;IACjC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,KAAiC,EAAE,EAAM,EAAE,IAAc,EAAE,OAAuB;QAC9F,MAAM,QAAQ,GAAG,IAAI,KAAK,EAAE,CAAA;QAC5B,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAA;QAChB,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAA;QACpB,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAA;QAC1B,OAAO,QAAQ,CAAA;IACjB,CAAC;CACF"}

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

@@ -0,0 +1,13 @@
+import { BackendPlugin } from './BackendPlugin';
+/**
+ * A plugin providing mainly some kind of possibly frequently updated data source services.
+ * Data will be publicly available from API.
+ */
+export declare class DataPlugin extends BackendPlugin {
+    protected sources: string[];
+    constructor(...sources: string[]);
+    /**
+     * Provide the public knowledge this plugin is providing.
+     */
+    getKnowledge(): Promise<Record<string, unknown>>;
+}

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

@@ -0,0 +1,26 @@
+import fs from 'fs';
+import { BackendPlugin } from './BackendPlugin';
+/**
+ * A plugin providing mainly some kind of possibly frequently updated data source services.
+ * Data will be publicly available from API.
+ */
+export class DataPlugin extends BackendPlugin {
+    sources;
+    constructor(...sources) {
+        super();
+        this.sources = sources;
+    }
+    /**
+     * Provide the public knowledge this plugin is providing.
+     */
+    async getKnowledge() {
+        const result = {};
+        for (const source of this.sources) {
+            const filePath = this.filePath(`${source}.json`);
+            const data = JSON.parse(fs.readFileSync(filePath).toString('utf-8'));
+            Object.assign(result, { [source]: data });
+        }
+        return result;
+    }
+}
+//# sourceMappingURL=DataPlugin.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DataPlugin.js","sourceRoot":"","sources":["../../../../src/plugins/DataPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAA;AACnB,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;;GAGG;AACH,MAAM,OAAO,UAAW,SAAQ,aAAa;IAEjC,OAAO,CAAU;IAE3B,YAAY,GAAG,OAAiB;QAC9B,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY;QAChB,MAAM,MAAM,GAAG,EAAE,CAAA;QACjB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE;YACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,MAAM,OAAO,CAAC,CAAA;YAChD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAA;YACpE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAA;SAC1C;QACD,OAAO,MAAM,CAAA;IACf,CAAC;CACF"}

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

@@ -0,0 +1,188 @@
+import { TransactionImportHandler } from '../import/TransactionImportHandler';
+import { BackendPlugin } from './BackendPlugin';
+/**
+ * A plugin providing import services for one or more file formats.
+ */
+export declare class ImportPlugin extends BackendPlugin {
+    private handler;
+    private UI;
+    constructor(handler: TransactionImportHandler);
+    /**
+     * Get common translations for all import plugins.
+     * @returns
+     */
+    getLanguages(): {
+        en: {
+            'account-debt-currency': string;
+            'account-deposit-currency': string;
+            'account-deposit-external': string;
+            'account-distribution-currency': string;
+            'account-distribution-statement': string;
+            'account-dividend-currency': string;
+            'account-expense-currency': string;
+            'account-expense-statement': string;
+            'account-fee-currency': string;
+            'account-fee-crypto': string;
+            'account-forex-currency': string;
+            'account-income-currency': string;
+            'account-income-statement': string;
+            'account-investment-currency': string;
+            'account-investment-statement': string;
+            'account-tax-currency': string;
+            'account-tax-statement': string;
+            'account-trade-crypto': string;
+            'account-trade-stock': string;
+            'account-trade-currency': string;
+            'account-transfer-currency': string;
+            'account-transfer-external': string;
+            'account-withdrawal-currency': string;
+            'account-withdrawal-external': string;
+            'asset-type-crypto': string;
+            'asset-type-currency': string;
+            'asset-type-external': string;
+            'asset-type-statement': string;
+            'asset-type-stock': string;
+            'asset-type-short': string;
+            'import-text-buy': string;
+            'import-text-correction': string;
+            'import-text-deposit': string;
+            'import-text-distribution': string;
+            'import-text-dividend': string;
+            'import-text-expense': string;
+            'import-text-forex': string;
+            'import-text-income': string;
+            'import-text-investment': string;
+            'import-text-sell': string;
+            'import-text-short-buy': string;
+            'import-text-short-sell': string;
+            'import-text-tax': string;
+            'import-text-trade': string;
+            'import-text-transfer': string;
+            'import-text-withdrawal': string;
+            'reason-deposit': string;
+            'reason-dividend': string;
+            'reason-expense': string;
+            'reason-fee': string;
+            'reason-forex': string;
+            'reason-income': string;
+            'reason-trade': string;
+            'reason-transfer': string;
+            'reason-withdrawal': string;
+            'note-split': string;
+            'note-converted': string;
+            'note-spinoff': string;
+            'note-renamed': string;
+            'note-old-name': string;
+            'note-new-name': string;
+            'note-renaming': string;
+        };
+        fi: {
+            'account-debt-currency': string;
+            'account-deposit-currency': string;
+            'account-deposit-external': string;
+            'account-distribution-currency': string;
+            'account-distribution-statement': string;
+            'account-dividend-currency': string;
+            'account-expense-currency': string;
+            'account-expense-statement': string;
+            'account-fee-currency': string;
+            'account-fee-crypto': string;
+            'account-forex-currency': string;
+            'account-income-currency': string;
+            'account-income-statement': string;
+            'account-investment-currency': string;
+            'account-investment-statement': string;
+            'account-tax-currency': string;
+            'account-tax-statement': string;
+            'account-trade-crypto': string;
+            'account-trade-stock': string;
+            'account-trade-currency': string;
+            'account-transfer-currency': string;
+            'account-transfer-external': string;
+            'account-withdrawal-currency': string;
+            'account-withdrawal-external': string;
+            'asset-type-crypto': string;
+            'asset-type-currency': string;
+            'asset-type-external': string;
+            'asset-type-statement': string;
+            'asset-type-stock': string;
+            'asset-type-short': string;
+            'Do you want to import also currency deposits here?': string;
+            'Do you want to import also currency withdrawals here?': string;
+            'import-text-buy': string;
+            'import-text-correction': string;
+            'import-text-deposit': string;
+            'import-text-distribution': string;
+            'import-text-dividend': string;
+            'import-text-expense': string;
+            'import-text-forex': string;
+            'import-text-income': string;
+            'import-text-investment': string;
+            'import-text-sell': string;
+            'import-text-short-buy': string;
+            'import-text-short-sell': string;
+            'import-text-tax': string;
+            'import-text-trade': string;
+            'import-text-transfer': string;
+            'import-text-withdrawal': string;
+            'Parsing error in expression `{expr}`: {message}': string;
+            'reason-deposit': string;
+            'reason-dividend': string;
+            'reason-expense': string;
+            'reason-fee': string;
+            'reason-forex': string;
+            'reason-income': string;
+            'reason-trade': string;
+            'reason-transfer': string;
+            'reason-withdrawal': string;
+            'Retried successfully': string;
+            'Retry failed': string;
+            'Select one of the following:': string;
+            'Additional information needed': string;
+            'Based on the following imported lines': string;
+            'Do you want to use the same account for all of them?': string;
+            Created: string;
+            Duplicates: string;
+            Ignored: string;
+            Skipped: string;
+            'Account Changes': string;
+            'Process Was Successfully Completed!': string;
+            'Do we allow short selling of assets?': string;
+            January: string;
+            February: string;
+            March: string;
+            April: string;
+            May: string;
+            June: string;
+            July: string;
+            August: string;
+            September: string;
+            October: string;
+            November: string;
+            December: string;
+            'note-split': string;
+            'note-converted': string;
+            'note-spinoff': string;
+            'note-renamed': string;
+            'note-old-name': string;
+            'note-new-name': string;
+            'The account below has negative balance. If you want to record it to the separate debt account, please select another account below:': string;
+            'The date {date} falls outside of the period {firstDate} to {lastDate}.': string;
+            'What do we do with that kind of transactions?': string;
+            'Ignore transaction': string;
+            'Halt with an error': string;
+            'Is transaction fee of type {type} already included in the {reason} total?': string;
+            'Select contra account for imported transactions, i.e. cash account.': string;
+        };
+    };
+    /**
+     * Get instance of internal handler class.
+     * @returns
+     */
+    getHandler(): TransactionImportHandler;
+    /**
+     * Load and return default rules from the JSON-rules file.
+     * @returns
+     */
+    getRules(): JSON;
+}