@tasenor/common-node 1.9.16

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

@@ -0,0 +1,168 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import axios from 'axios';
+import { log, note, error, waitPromise } from '@dataplug/tasenor-common';
+import { BackendPlugin } from './BackendPlugin';
+/**
+ * An API end point provider.
+ */
+export class ServicePlugin extends BackendPlugin {
+    services;
+    constructor(...services) {
+        super();
+        this.services = services;
+    }
+    getServices() {
+        return this.services;
+    }
+    /**
+     * 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.
+     */
+    async executeQuery(best, db, service, query) {
+        const settings = {};
+        for (const setting of await db('settings').select('*').where('name', 'like', `${this.code}.%`)) {
+            const [, name] = setting.name.split('.');
+            settings[name] = setting.value;
+        }
+        // First check if the current answer is adequate.
+        if (this.isAdequate(best)) {
+            return;
+        }
+        // Then run the query and catch errors.
+        let result;
+        try {
+            result = await this.query(db, settings, service, query);
+        }
+        catch (err) {
+            error(`Exception when handling service ${service} query ${JSON.stringify(query)}: ${err}`);
+            result = {
+                status: 500,
+                message: `Execution of service ${service} query failed on plugin ${this.constructor.name}.`
+            };
+        }
+        // Combine result.
+        this.addResult(best, result);
+    }
+    /**
+     * Perform the actual query.
+     *
+     * @param db Knex database.
+     * @param service Name of the service to called.
+     * @param query Query parameters.
+     */
+    async query(db, settings, service, query) {
+        throw new Error(`A service plugin ${this.constructor.name} does not implement query().`);
+    }
+    /**
+     * 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, latest) {
+        if ((latest.status >= 200 && latest.status < 300) ||
+            (old.status === 404 && old.message === 'No handlers found.')) {
+            delete old.message;
+            Object.assign(old, latest);
+        }
+    }
+    /**
+     * Check if the current solution is sufficient.
+     * By default, any status 2xx is sufficient.
+     */
+    isAdequate(solution) {
+        return solution.status >= 200 && solution.status < 300;
+    }
+    /**
+     * Execute query to the third party service,
+     * @param service
+     * @param method
+     * @param url
+     * @param params
+     * @returns Result body.
+     */
+    async request(service, method, url, params, headers = {}) {
+        if (method !== 'GET') {
+            throw new Error('Only GET method currently supported in plugin requests.');
+        }
+        note(`Service ${service} request ${method} ${url}`);
+        return new Promise((resolve, reject) => {
+            axios.request({ method, url, params, headers })
+                .then(response => {
+                log(`Request ${method} ${url}: HTTP ${response.status}`);
+                resolve({
+                    status: response.status,
+                    data: response.data
+                });
+            })
+                .catch(err => {
+                const status = err.response ? err.response.status : 500;
+                const message = err.response && err.response.data && err.response.data.message ? err.response.data.message : `${err}`;
+                error(`Request ${method} ${url} failed: HTTP ${status} ${message}`);
+                resolve({
+                    status,
+                    message
+                });
+            });
+        });
+    }
+    /**
+     * 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, header) {
+        return {};
+    }
+    /**
+     * 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, params) {
+        return params;
+    }
+    /**
+     * Execute query to the third party service,
+     * @param db
+     * @param service
+     * @param method
+     * @param url
+     * @param params
+     * @returns Result body.
+     */
+    async cachedRequest(db, service, method, url, params, headers = {}, options = {}) {
+        // Get cache keys.
+        const keyParams = this.cacheParamsKey(service, params);
+        const keyHeaders = this.cacheHeadersKey(service, headers);
+        // Check if cached.
+        const cached = db ? await db('cached_requests').select('status', 'result').where({ method, url, query: keyParams, headers: keyHeaders }).first() : null;
+        if (cached) {
+            if (cached.status >= 200 && cached.status < 300) {
+                log(`Using cached service ${service} result for ${method} ${url}`);
+                return cached.result;
+            }
+        }
+        // Add delay if needed.
+        if (options.rateLimitDelay) {
+            await waitPromise(options.rateLimitDelay);
+        }
+        // Do the request and cache the result.
+        const result = await this.request(service, method, url, params, headers);
+        if (db) {
+            await db('cached_requests').insert({ method, url, query: keyParams, headers: keyHeaders, status: result.status || null, result });
+        }
+        return result;
+    }
+}
+//# sourceMappingURL=ServicePlugin.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ServicePlugin.js","sourceRoot":"","sources":["../../../../src/plugins/ServicePlugin.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAwC,WAAW,EAAE,MAAM,0BAA0B,CAAA;AAC9G,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAO/C;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,aAAa;IAEtC,QAAQ,CAAiB;IAEjC,YAAY,GAAG,QAAQ;QACrB,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC1B,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,YAAY,CAAC,IAAa,EAAE,EAAgB,EAAE,OAAsB,EAAE,KAA8B;QACxG,MAAM,QAAQ,GAA4B,EAAE,CAAA;QAC5C,KAAK,MAAM,OAAO,IAAI,MAAM,EAAE,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,IAAI,CAAC,EAAE;YAC9F,MAAM,CAAC,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACxC,QAAQ,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,KAAK,CAAA;SAC/B;QAED,iDAAiD;QACjD,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YACzB,OAAM;SACP;QACD,uCAAuC;QACvC,IAAI,MAAM,CAAA;QACV,IAAI;YACF,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;SACxD;QAAC,OAAO,GAAG,EAAE;YACZ,KAAK,CAAC,mCAAmC,OAAO,UAAU,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,GAAG,EAAE,CAAC,CAAA;YAC1F,MAAM,GAAG;gBACP,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,wBAAwB,OAAO,2BAA2B,IAAI,CAAC,WAAW,CAAC,IAAI,GAAG;aAC5F,CAAA;SACF;QACD,kBAAkB;QAClB,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CAAC,EAAgB,EAAE,QAAiC,EAAE,OAAsB,EAAE,KAAc;QACrG,MAAM,IAAI,KAAK,CAAC,oBAAoB,IAAI,CAAC,WAAW,CAAC,IAAI,8BAA8B,CAAC,CAAA;IAC1F,CAAC;IAED;;;;;;;;;OASG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM;QACnB,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,GAAG,IAAI,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC;YAC/C,CAAC,GAAG,CAAC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,OAAO,KAAK,oBAAoB,CAAC,EAAE;YAC9D,OAAO,GAAG,CAAC,OAAO,CAAA;YAClB,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;SAC3B;IACH,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,QAAQ;QACjB,OAAO,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAA;IACxD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,GAAG,EAAE;QACtD,IAAI,MAAM,KAAK,KAAK,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAA;SAC3E;QACD,IAAI,CAAC,WAAW,OAAO,YAAY,MAAM,IAAI,GAAG,EAAE,CAAC,CAAA;QACnD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;iBAC5C,IAAI,CAAC,QAAQ,CAAC,EAAE;gBACf,GAAG,CAAC,WAAW,MAAM,IAAI,GAAG,UAAU,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;gBACxD,OAAO,CAAC;oBACN,MAAM,EAAE,QAAQ,CAAC,MAAM;oBACvB,IAAI,EAAE,QAAQ,CAAC,IAAI;iBACpB,CAAC,CAAA;YACJ,CAAC,CAAC;iBACD,KAAK,CAAC,GAAG,CAAC,EAAE;gBACX,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAA;gBACvD,MAAM,OAAO,GAAG,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE,CAAA;gBACrH,KAAK,CAAC,WAAW,MAAM,IAAI,GAAG,iBAAiB,MAAM,IAAI,OAAO,EAAE,CAAC,CAAA;gBACnE,OAAO,CAAC;oBACN,MAAM;oBACN,OAAO;iBACR,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM;QAC7B,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM;QAC5B,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,aAAa,CAAC,EAAuB,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,GAAG,EAAE,EAAE,UAAuC,EAAE;QAEhI,kBAAkB;QAClB,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QACtD,MAAM,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAEzD,mBAAmB;QACnB,MAAM,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,iBAAiB,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;QACvJ,IAAI,MAAM,EAAE;YACV,IAAI,MAAM,CAAC,MAAM,IAAI,GAAG,IAAI,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE;gBAC/C,GAAG,CAAC,wBAAwB,OAAO,eAAe,MAAM,IAAI,GAAG,EAAE,CAAC,CAAA;gBAClE,OAAO,MAAM,CAAC,MAAM,CAAA;aACrB;SACF;QAED,uBAAuB;QACvB,IAAI,OAAO,CAAC,cAAc,EAAE;YAC1B,MAAM,WAAW,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;SAC1C;QAED,uCAAuC;QACvC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QACxE,IAAI,EAAE,EAAE;YACN,MAAM,EAAE,CAAC,iBAAiB,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,IAAI,EAAE,MAAM,EAAE,CAAC,CAAA;SAClI;QACD,OAAO,MAAM,CAAA;IACf,CAAC;CACF"}

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

@@ -0,0 +1,27 @@
+import { KnexDatabase } from '../database';
+import { BackendPlugin } from './BackendPlugin';
+/**
+ * A generic tool.
+ */
+export declare class ToolPlugin extends BackendPlugin {
+    /**
+     * Handler for GET request.
+     */
+    GET(db: KnexDatabase, query: any): Promise<unknown>;
+    /**
+     * Handler for DELETE request.
+     */
+    DELETE(db: KnexDatabase, query: any): Promise<unknown>;
+    /**
+     * Handler for POST request.
+     */
+    POST(db: KnexDatabase, data: any): Promise<unknown>;
+    /**
+     * Handler for PUT request.
+     */
+    PUT(db: KnexDatabase, data: any): Promise<unknown>;
+    /**
+     * Handler for PATCH request.
+     */
+    PATCH(db: KnexDatabase, data: any): Promise<unknown>;
+}

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

@@ -0,0 +1,37 @@
+import { BackendPlugin } from './BackendPlugin';
+/**
+ * A generic tool.
+ */
+export class ToolPlugin extends BackendPlugin {
+    /**
+     * Handler for GET request.
+     */
+    async GET(db, query) {
+        return undefined;
+    }
+    /**
+     * Handler for DELETE request.
+     */
+    async DELETE(db, query) {
+        return undefined;
+    }
+    /**
+     * Handler for POST request.
+     */
+    async POST(db, data) {
+        return undefined;
+    }
+    /**
+     * Handler for PUT request.
+     */
+    async PUT(db, data) {
+        return undefined;
+    }
+    /**
+     * Handler for PATCH request.
+     */
+    async PATCH(db, data) {
+        return undefined;
+    }
+}
+//# sourceMappingURL=ToolPlugin.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ToolPlugin.js","sourceRoot":"","sources":["../../../../src/plugins/ToolPlugin.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,aAAa;IAE3C;;OAEG;IACH,KAAK,CAAC,GAAG,CAAC,EAAgB,EAAE,KAAK;QAC/B,OAAO,SAAS,CAAA;IAClB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,EAAgB,EAAE,KAAK;QAClC,OAAO,SAAS,CAAA;IAClB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,EAAgB,EAAE,IAAI;QAC/B,OAAO,SAAS,CAAA;IAClB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAC,EAAgB,EAAE,IAAI;QAC9B,OAAO,SAAS,CAAA;IAClB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,EAAgB,EAAE,IAAI;QAChC,OAAO,SAAS,CAAA;IAClB,CAAC;CACF"}

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

@@ -0,0 +1,13 @@
+/**
+ * Plugin base classes for backend and utility functions.
+ *
+ * @module tasenor-common-node/src/plugins
+ */
+export * from './BackendPlugin';
+export * from './DataPlugin';
+export * from './ImportPlugin';
+export * from './ReportPlugin';
+export * from './SchemePlugin';
+export * from './ServicePlugin';
+export * from './ToolPlugin';
+export * from './plugins';

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

@@ -0,0 +1,14 @@
+/**
+ * Plugin base classes for backend and utility functions.
+ *
+ * @module tasenor-common-node/src/plugins
+ */
+export * from './BackendPlugin';
+export * from './DataPlugin';
+export * from './ImportPlugin';
+export * from './ReportPlugin';
+export * from './SchemePlugin';
+export * from './ServicePlugin';
+export * from './ToolPlugin';
+export * from './plugins';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/plugins/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,cAAc,iBAAiB,CAAA;AAC/B,cAAc,cAAc,CAAA;AAC5B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,cAAc,CAAA;AAC5B,cAAc,WAAW,CAAA"}

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

@@ -0,0 +1,101 @@
+import { TasenorPlugin, PluginCatalog, FilePath } from '@dataplug/tasenor-common';
+interface PluginConfig {
+    PLUGIN_PATH?: string;
+}
+type ConfigVariable = keyof PluginConfig;
+interface PluginState {
+    installed: boolean;
+}
+/**
+ * Get the configuration variable or throw an error.
+ * @param variable Name of the variable.
+ */
+declare function getConfig(variable: ConfigVariable): string;
+/**
+ * Set the configuration variable. When setting the root for plugins other directories are set automatically.
+ * @param variable Name of the variable.
+ * @param value Value of the variable.
+ */
+declare function setConfig(variable: ConfigVariable, value: string): void;
+/**
+ * Sort list of plugins according to the code.
+ * @param plugins A list of plugins.
+ * @returns New sorted list.
+ */
+declare function sortPlugins(plugins: TasenorPlugin[]): TasenorPlugin[];
+/**
+ * Compare two plugin lists if they are essentially the same.
+ * @param listA
+ * @param listB
+ * @returns True if code, versions and path match.
+ */
+declare function samePlugins(listA: TasenorPlugin[], listB: TasenorPlugin[]): boolean;
+/**
+ * Read in the current `index.json` file.
+ */
+declare function loadPluginIndex(): PluginCatalog;
+/**
+ * Store plugin index.
+ * @param plugins
+ */
+declare function savePluginIndex(plugins: any): void;
+/**
+ * Update one plugin in the index.
+ */
+declare function updatePluginIndex(plugin: TasenorPlugin, plugins?: TasenorPlugin[] | undefined): TasenorPlugin[] | undefined;
+/**
+ * Find the named plugin from the current `index.json` file or from the list if given..
+ * @param {String} code
+ * @returns Data or null if not found.
+ */
+declare function findPluginFromIndex(code: string, plugins?: TasenorPlugin[] | undefined): TasenorPlugin | null;
+/**
+ * Get the current plugin list maintained by some master API.
+ * @returns The latest list.
+ */
+declare function fetchOfficialPluginList(): Promise<TasenorPlugin[]>;
+/**
+ * Scan all plugins from the plugin directory based on index files found.
+ */
+declare function scanPlugins(): TasenorPlugin[];
+/**
+ * Read the local plugin state.
+ */
+declare function loadPluginState(plugin: TasenorPlugin): PluginState;
+/**
+ * Save local plugin state.
+ */
+declare function savePluginState(plugin: TasenorPlugin, state: PluginState): void;
+/**
+ * Check if plugin is marked as installed.
+ */
+declare function isInstalled(plugin: TasenorPlugin): boolean;
+/**
+ * Combine official and installed plugins to the same list and save if changed.
+ */
+declare function updatePluginList(): Promise<TasenorPlugin[]>;
+/**
+ * Convert full path from UI or backend index file to relative path inside the plugin.
+ */
+declare function pluginLocalPath(indexFilePath: FilePath): string | undefined;
+/**
+ * Collection of file system and API related plugin handling functions for fetching, building and scanning.
+ */
+export declare const plugins: {
+    findPluginFromIndex: typeof findPluginFromIndex;
+    fetchOfficialPluginList: typeof fetchOfficialPluginList;
+    getConfig: typeof getConfig;
+    isInstalled: typeof isInstalled;
+    loadPluginIndex: typeof loadPluginIndex;
+    loadPluginState: typeof loadPluginState;
+    pluginLocalPath: typeof pluginLocalPath;
+    samePlugins: typeof samePlugins;
+    savePluginIndex: typeof savePluginIndex;
+    savePluginState: typeof savePluginState;
+    scanPlugins: typeof scanPlugins;
+    setConfig: typeof setConfig;
+    sortPlugins: typeof sortPlugins;
+    updatePluginIndex: typeof updatePluginIndex;
+    updatePluginList: typeof updatePluginList;
+};
+export {};

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

@@ -0,0 +1,292 @@
+import fs from 'fs';
+import glob from 'fast-glob';
+import path from 'path';
+import { net, note, log } from '@dataplug/tasenor-common';
+import { create } from 'ts-opaque';
+import { vault } from '../net';
+const PLUGIN_FIELDS = ['code', 'title', 'version', 'icon', 'releaseDate', 'use', 'type', 'description'];
+// Internal configuration for the module.
+const config = {
+    PLUGIN_PATH: undefined
+};
+/**
+ * Get the configuration variable or throw an error.
+ * @param variable Name of the variable.
+ */
+function getConfig(variable) {
+    const value = config[variable];
+    if (value === undefined) {
+        throw new Error(`Configuration variable ${variable} is required but it is not set.`);
+    }
+    return value;
+}
+/**
+ * Set the configuration variable. When setting the root for plugins other directories are set automatically.
+ * @param variable Name of the variable.
+ * @param value Value of the variable.
+ */
+function setConfig(variable, value) {
+    if (variable in config) {
+        config[variable] = value;
+    }
+    else {
+        throw new Error(`No such configuration variable as ${variable}.`);
+    }
+}
+/**
+ * Sort list of plugins according to the code.
+ * @param plugins A list of plugins.
+ * @returns New sorted list.
+ */
+function sortPlugins(plugins) {
+    return plugins.sort((a, b) => a.code < b.code ? -1 : (a.code > b.code ? 1 : 0));
+}
+/**
+ * Compare two plugin lists if they are essentially the same.
+ * @param listA
+ * @param listB
+ * @returns True if code, versions and path match.
+ */
+function samePlugins(listA, listB) {
+    if (listA.length !== listB.length) {
+        return false;
+    }
+    listA = sortPlugins(listA);
+    listB = sortPlugins(listB);
+    for (let i = 0; i < listA.length; i++) {
+        if (listA[i].id !== listB[i].id ||
+            listA[i].code !== listB[i].code ||
+            listA[i].installedVersion !== listB[i].installedVersion ||
+            listA[i].path !== listB[i].path) {
+            return false;
+        }
+    }
+    return true;
+}
+/**
+ * Read in the current `index.json` file.
+ */
+function loadPluginIndex() {
+    const indexPath = path.join(getConfig('PLUGIN_PATH'), 'index.json');
+    note(`Loading plugin index from '${indexPath}'.`);
+    if (fs.existsSync(indexPath)) {
+        return JSON.parse(fs.readFileSync(indexPath).toString('utf-8'));
+    }
+    return [];
+}
+/**
+ * Store plugin index.
+ * @param plugins
+ */
+function savePluginIndex(plugins) {
+    plugins = sortPlugins(plugins);
+    const indexPath = path.join(getConfig('PLUGIN_PATH'), 'index.json');
+    note(`Saving plugin index to '${indexPath}'.`);
+    fs.writeFileSync(indexPath, JSON.stringify(plugins, null, 2) + '\n');
+}
+/**
+ * Update one plugin in the index.
+ */
+function updatePluginIndex(plugin, plugins = undefined) {
+    const old = findPluginFromIndex(plugin.code, plugins);
+    if (!old) {
+        throw new Error(`Cannot update non-existing plugin ${plugin.code}.`);
+    }
+    Object.assign(old, plugin);
+    savePluginIndex(plugins);
+    return plugins;
+}
+/**
+ * Find the named plugin from the current `index.json` file or from the list if given..
+ * @param {String} code
+ * @returns Data or null if not found.
+ */
+function findPluginFromIndex(code, plugins = undefined) {
+    const index = plugins || loadPluginIndex();
+    const plugin = index.find(plugin => plugin.code === code);
+    return plugin || null;
+}
+/**
+ * Get the current plugin list maintained by some master API.
+ * @returns The latest list.
+ */
+async function fetchOfficialPluginList() {
+    const url = vault.get('TASENOR_API_URL', '');
+    if (url) {
+        const plugins = await net.GET(`${url}/plugins`);
+        if (plugins.success) {
+            return plugins.data;
+        }
+    }
+    return [];
+}
+/**
+ * Scan all plugins from the plugin directory based on index files found.
+ */
+function scanPlugins() {
+    const rootPath = path.resolve(getConfig('PLUGIN_PATH'));
+    log(`Scanning plugins from ${rootPath}.`);
+    let uiFiles = [];
+    let backendFiles = [];
+    // Scan each dir resolving symlinks first.
+    const dirs = glob.sync(path.join(rootPath, '**', 'package.json'));
+    dirs.map(dir => path.dirname(fs.realpathSync(dir))).forEach(dir => {
+        uiFiles = uiFiles.concat(glob.sync(path.join(dir, '**', 'ui', 'index.tsx')).map(p => p.substring(0, p.length - 'ui/index.tsx'.length)));
+        backendFiles = backendFiles.concat(glob.sync(path.join(dir, '**', 'backend', 'index.ts')).map(p => p.substring(0, p.length - 'backend/index.ts'.length)));
+    });
+    const pluginSet = new Set(uiFiles.concat(backendFiles));
+    return [...pluginSet].map(scanPlugin);
+}
+/**
+ * Read data from the plugin's index file(s) found from the given path.
+ */
+function scanPlugin(pluginPath) {
+    const uiPath = path.join(pluginPath, 'ui', 'index.tsx');
+    const ui = fs.existsSync(uiPath) ? readUIPlugin(uiPath) : null;
+    const backendPath = path.join(pluginPath, 'backend', 'index.ts');
+    const backend = fs.existsSync(backendPath) ? readBackendPlugin(backendPath) : null;
+    if (ui && backend) {
+        for (const field of PLUGIN_FIELDS) {
+            if (ui[field] !== backend[field]) {
+                throw new Error(`A field '${field}' have contradicting values ${JSON.stringify(ui[field])} and ${JSON.stringify(backend[field])} for index files '${uiPath}' and '${backendPath}'.`);
+            }
+        }
+    }
+    if (ui === null && backend === null) {
+        throw new Error(`Cannot find any plugins in '${pluginPath}'.`);
+    }
+    return ui || backend;
+}
+/**
+ * Read UI plugin data from the given index file.
+ */
+function readUIPlugin(indexPath) {
+    const regex = new RegExp(`^\\s*static\\s+(${PLUGIN_FIELDS.join('|')})\\s*=\\s*(?:'([^']*)'|"([^"]*)")`);
+    const data = {
+        code: create('Unknown'),
+        title: 'Unknown Development Plugin',
+        icon: 'HelpOutline',
+        path: path.dirname(path.dirname(indexPath)),
+        version: create('0'),
+        releaseDate: null,
+        use: 'unknown',
+        type: 'unknown',
+        description: 'No description'
+    };
+    const code = fs.readFileSync(indexPath).toString('utf-8').split('\n');
+    for (const line of code) {
+        const match = regex.exec(line);
+        if (match) {
+            data[match[1]] = match[2];
+        }
+    }
+    return data;
+}
+function readBackendPlugin(indexPath) {
+    const regex = new RegExp(`^\\s*this\\.(${PLUGIN_FIELDS.join('|')})\\s*=\\s*(?:'([^']*)'|"([^"]*)")`);
+    const data = {
+        code: create('Unknown'),
+        title: 'Unknown Development Plugin',
+        icon: 'HelpOutline',
+        path: path.dirname(path.dirname(indexPath)),
+        version: create('0'),
+        releaseDate: null,
+        use: 'unknown',
+        type: 'unknown',
+        description: 'No description'
+    };
+    const code = fs.readFileSync(indexPath).toString('utf-8').split('\n');
+    for (const line of code) {
+        const match = regex.exec(line);
+        if (match) {
+            data[match[1]] = match[2];
+        }
+    }
+    return data;
+}
+/**
+ * Read the local plugin state.
+ */
+function loadPluginState(plugin) {
+    const stateFile = plugin.path && path.join(plugin.path, '.state');
+    if (stateFile && fs.existsSync(stateFile)) {
+        return JSON.parse(fs.readFileSync(stateFile).toString('utf-8'));
+    }
+    return {
+        installed: false
+    };
+}
+/**
+ * Save local plugin state.
+ */
+function savePluginState(plugin, state) {
+    const stateFile = path.join(plugin.path, '.state');
+    fs.writeFileSync(stateFile, JSON.stringify(state, null, 2) + '\n');
+}
+/**
+ * Check if plugin is marked as installed.
+ */
+function isInstalled(plugin) {
+    return loadPluginState(plugin).installed;
+}
+/**
+ * Combine official and installed plugins to the same list and save if changed.
+ */
+async function updatePluginList() {
+    let current = [];
+    // Get the official list if any.
+    for (const plugin of await fetchOfficialPluginList()) {
+        current[plugin.code] = plugin;
+    }
+    // Collect and add local plugins.
+    let localId = -1;
+    for (const plugin of await scanPlugins()) {
+        if (!current[plugin.code]) {
+            current[plugin.code] = plugin;
+            current[plugin.code].id = localId--;
+        }
+        current[plugin.code].path = plugin.path;
+        current[plugin.code].version = plugin.version;
+        current[plugin.code].availableVersion = plugin.version;
+        if (isInstalled(plugin)) {
+            current[plugin.code].installedVersion = plugin.version;
+        }
+    }
+    // Avoid dev server unnecessary restart.
+    const old = loadPluginIndex();
+    current = Object.values(current);
+    if (!samePlugins(old, current)) {
+        savePluginIndex(current);
+    }
+    return current;
+}
+/**
+ * Convert full path from UI or backend index file to relative path inside the plugin.
+ */
+function pluginLocalPath(indexFilePath) {
+    const match = /\/[^/]+\/(ui|backend)\/index.tsx?$/.exec(indexFilePath);
+    if (match) {
+        return match[0].substring(1);
+    }
+}
+/**
+ * Collection of file system and API related plugin handling functions for fetching, building and scanning.
+ */
+export const plugins = {
+    findPluginFromIndex,
+    fetchOfficialPluginList,
+    getConfig,
+    isInstalled,
+    loadPluginIndex,
+    loadPluginState,
+    pluginLocalPath,
+    samePlugins,
+    savePluginIndex,
+    savePluginState,
+    scanPlugins,
+    setConfig,
+    sortPlugins,
+    updatePluginIndex,
+    updatePluginList
+};
+//# sourceMappingURL=plugins.js.map