@tasenor/common-node 1.9.16

package/dist/tasenor-common-node/src/process/ProcessFile.js

@@ -0,0 +1,145 @@
+import chardet from 'chardet';
+import clone from 'clone';
+import { DatabaseError, InvalidFile, NotImplemented } from '../error';
+/**
+ * An instance of input data for processing.
+ */
+export class ProcessFile {
+    id;
+    processId;
+    name;
+    type;
+    encoding;
+    data;
+    _decoded;
+    constructor(obj) {
+        this.id = null;
+        this.processId = obj.processId || null;
+        this.name = obj.name;
+        this.type = obj.type;
+        this.encoding = obj.encoding;
+        this.data = obj.data;
+        this._decoded = undefined;
+    }
+    toString() {
+        return `ProcessFile #${this.id} ${this.name}`;
+    }
+    /**
+     * Get the loaded process information as JSON object.
+     * @returns
+     */
+    toJSON() {
+        return {
+            processId: this.processId,
+            name: this.name,
+            type: this.type,
+            encoding: this.encoding,
+            data: this.data
+        };
+    }
+    /**
+     * Save the file to the database.
+     */
+    async save(db) {
+        const out = this.toJSON();
+        if (this.encoding === 'json') {
+            out.data = JSON.stringify(out.data);
+        }
+        if (this.id) {
+            await db('process_files').update(out).where({ id: this.id });
+            return this.id;
+        }
+        else {
+            this.id = (await db('process_files').insert(out).returning('id'))[0].id;
+            if (this.id)
+                return this.id;
+            throw new DatabaseError(`Saving process ${JSON.stringify(out)} failed.`);
+        }
+    }
+    /**
+     * Check if the first line of the text file matches to the regular expression.
+     * @param re
+     */
+    firstLineMatch(re) {
+        const str = this.decode();
+        const n = str.indexOf('\n');
+        const line1 = n < 0 ? str : str.substr(0, n).trim();
+        return re.test(line1);
+    }
+    /**
+     * Check if the second line of the text file matches to the regular expression.
+     * @param re
+     */
+    secondLineMatch(re) {
+        const lines = this.decode().split('\n');
+        return lines.length > 1 && re.test(lines[1].trim());
+    }
+    /**
+     * Check if the third line of the text file matches to the regular expression.
+     * @param re
+     */
+    thirdLineMatch(re) {
+        const lines = this.decode().split('\n');
+        return lines.length > 2 && re.test(lines[2].trim());
+    }
+    /**
+     * Check if the file begins with the given string.
+     */
+    startsWith(s) {
+        let buffer;
+        switch (this.encoding) {
+            case 'base64':
+                buffer = Buffer.from(this.data.substring(0, s.length * 2), 'base64');
+                return buffer.toString('ascii').substr(0, s.length) === s;
+            default:
+                throw new NotImplemented(`Cannot handle encoding ${this.encoding} in startWith().`);
+        }
+    }
+    /**
+     * Find out if the content is binary or text.
+     *
+     * The mime type has to start with `text/`.
+     */
+    isTextFile() {
+        return this.type?.startsWith('text/') || false;
+    }
+    /**
+     * Convert chardet encoding to the supported buffer encoding
+     * "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex"
+     */
+    parseEncoding(encoding) {
+        switch (encoding.toUpperCase()) {
+            case 'UTF-8':
+                return 'utf-8';
+            case 'ISO-8859-1':
+                return 'latin1';
+            case 'UTF-16LE':
+                return 'utf16le';
+            default:
+                throw new InvalidFile(`Not able to map text encoding ${encoding}.`);
+        }
+    }
+    /**
+     * Try to recognize the file content and decode if it is a recognizable text format.
+     */
+    decode() {
+        if (this._decoded) {
+            return this._decoded;
+        }
+        if (this.encoding === 'base64') {
+            const buffer = Buffer.from(this.data, 'base64');
+            const encoding = chardet.detect(buffer);
+            if (!encoding) {
+                throw new InvalidFile(`Cannot determine encoding for '${this}'.`);
+            }
+            this._decoded = buffer.toString(this.parseEncoding(encoding));
+            return this._decoded;
+        }
+        if (this.encoding === 'utf-8') {
+            this._decoded = clone(this.data);
+            return this._decoded || '';
+        }
+        throw new InvalidFile(`An encoding '${this.encoding}' is not yet supported.`);
+    }
+}
+//# sourceMappingURL=ProcessFile.js.map

package/dist/tasenor-common-node/src/process/ProcessFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProcessFile.js","sourceRoot":"","sources":["../../../../src/process/ProcessFile.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,SAAS,CAAA;AAC7B,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAarE;;GAEG;AACH,MAAM,OAAO,WAAW;IACtB,EAAE,CAAI;IACN,SAAS,CAAI;IACb,IAAI,CAAQ;IACZ,IAAI,CAAS;IACb,QAAQ,CAAc;IACtB,IAAI,CAAQ;IACZ,QAAQ,CAAS;IAEjB,YAAY,GAAoB;QAC9B,IAAI,CAAC,EAAE,GAAG,IAAI,CAAA;QACd,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,IAAI,IAAI,CAAA;QACtC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAA;QACpB,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAA;QAC5B,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAA;QACpB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAA;IAC3B,CAAC;IAED,QAAQ;QACN,OAAO,gBAAgB,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,EAAE,CAAA;IAC/C,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,EAAgB;QACzB,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAA;QACzB,IAAI,IAAI,CAAC,QAAQ,KAAK,MAAM,EAAE;YAC5B,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;SACpC;QACD,IAAI,IAAI,CAAC,EAAE,EAAE;YACX,MAAM,EAAE,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAA;YAC5D,OAAO,IAAI,CAAC,EAAE,CAAA;SACf;aAAM;YACL,IAAI,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;YACvE,IAAI,IAAI,CAAC,EAAE;gBAAE,OAAO,IAAI,CAAC,EAAE,CAAA;YAC3B,MAAM,IAAI,aAAa,CAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;SACzE;IACH,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,EAAU;QACvB,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAA;QACzB,MAAM,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QAC3B,MAAM,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;QACnD,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACvB,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,EAAU;QACxB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACvC,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;IACrD,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,EAAU;QACvB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACvC,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;IACrD,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,CAAS;QAClB,IAAI,MAAM,CAAA;QACV,QAAQ,IAAI,CAAC,QAAQ,EAAE;YACrB,KAAK,QAAQ;gBACX,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAA;gBACpE,OAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;YAC3D;gBACE,MAAM,IAAI,cAAc,CAAC,0BAA0B,IAAI,CAAC,QAAQ,kBAAkB,CAAC,CAAA;SACtF;IACH,CAAC;IAED;;;;OAIG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,IAAI,KAAK,CAAA;IAChD,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,QAAgB;QAC5B,QAAQ,QAAQ,CAAC,WAAW,EAAE,EAAE;YAC9B,KAAK,OAAO;gBACV,OAAO,OAAO,CAAA;YAChB,KAAK,YAAY;gBACf,OAAO,QAAQ,CAAA;YACjB,KAAK,UAAU;gBACb,OAAO,SAAS,CAAA;YAClB;gBACE,MAAM,IAAI,WAAW,CAAC,iCAAiC,QAAQ,GAAG,CAAC,CAAA;SACtE;IACH,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,OAAO,IAAI,CAAC,QAAQ,CAAA;SACrB;QACD,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ,EAAE;YAC9B,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;YAC/C,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;YACvC,IAAI,CAAC,QAAQ,EAAE;gBACb,MAAM,IAAI,WAAW,CAAC,kCAAkC,IAAI,IAAI,CAAC,CAAA;aAClE;YACD,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAA;YAC7D,OAAO,IAAI,CAAC,QAAQ,CAAA;SACrB;QAED,IAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,EAAE;YAC7B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YAChC,OAAO,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAA;SAC3B;QAED,MAAM,IAAI,WAAW,CAAC,gBAAgB,IAAI,CAAC,QAAQ,yBAAyB,CAAC,CAAA;IAC/E,CAAC;CACF"}

package/dist/tasenor-common-node/src/process/ProcessHandler.d.ts

@@ -0,0 +1,60 @@
+import { ProcessFile } from './ProcessFile';
+import { ProcessingSystem } from './ProcessingSystem';
+import { Process } from './Process';
+import { Directions, ImportAction, ImportState, ProcessConfig } from '@dataplug/tasenor-common';
+/**
+ * A handler taking care of moving between process states.
+ */
+export declare class ProcessHandler {
+    system: ProcessingSystem;
+    name: string;
+    constructor(name: string);
+    /**
+     * Attach this handler to the processing system during the registration.
+     * @param system
+     */
+    connect(system: ProcessingSystem): void;
+    /**
+     * Check if we are able to handle the given file.
+     * @param file
+     */
+    canHandle(file: ProcessFile): boolean;
+    /**
+     * Check if we are able to append the given file to the process.
+     * @param file
+     */
+    canAppend(file: ProcessFile): boolean;
+    /**
+     * Check if the state is either successful `true` or failed `false` or not yet complete `undefined`.
+     * @param state
+     */
+    checkCompletion(state: ImportState): boolean | undefined;
+    /**
+     * Execute an action to the state in order to produce new state. Note that state is cloned and can be modified to be new state.
+     * @param action
+     * @param state
+     * @param files
+     */
+    action(process: Process, action: ImportAction, state: ImportState, files: ProcessFile[]): Promise<ImportState>;
+    /**
+     * Construct intial state from the given data.
+     * @param file
+     */
+    startingState(files: ProcessFile[]): ImportState;
+    /**
+     * Figure out possible directions from the given state.
+     * @param state
+     */
+    getDirections(state: ImportState, config: ProcessConfig): Promise<Directions>;
+    /**
+     * See if it is possible rollback a process.
+     * @param step
+     */
+    rollback(process: Process, state: ImportState): Promise<ImportState>;
+}
+/**
+ * A collection of process handlers.
+ */
+export type ProcessHandlerMap = {
+    [key: string]: ProcessHandler;
+};

package/dist/tasenor-common-node/src/process/ProcessHandler.js

@@ -0,0 +1,73 @@
+import { NotImplemented } from '../error';
+/**
+ * A handler taking care of moving between process states.
+ */
+export class ProcessHandler {
+    system;
+    name;
+    constructor(name) {
+        this.name = name;
+    }
+    /**
+     * Attach this handler to the processing system during the registration.
+     * @param system
+     */
+    connect(system) {
+        this.system = system;
+    }
+    /**
+     * Check if we are able to handle the given file.
+     * @param file
+     */
+    canHandle(file) {
+        throw new NotImplemented(`A handler '${this.name}' cannot check file '${file.name}', since canHandle() is not implemented.`);
+    }
+    /**
+     * Check if we are able to append the given file to the process.
+     * @param file
+     */
+    canAppend(file) {
+        throw new NotImplemented(`A handler '${this.name}' cannot append file '${file.name}', since canAppend() is not implemented.`);
+    }
+    /**
+     * Check if the state is either successful `true` or failed `false` or not yet complete `undefined`.
+     * @param state
+     */
+    checkCompletion(state) {
+        throw new NotImplemented(`A handler '${this.name}' cannot check state '${JSON.stringify(state)}', since checkCompletion() is not implemented.`);
+    }
+    /**
+     * Execute an action to the state in order to produce new state. Note that state is cloned and can be modified to be new state.
+     * @param action
+     * @param state
+     * @param files
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async action(process, action, state, files) {
+        throw new NotImplemented(`A handler '${this.name}' for files ${files.map(f => `'${f}''`).join(', ')} does not implement action()`);
+    }
+    /**
+     * Construct intial state from the given data.
+     * @param file
+     */
+    startingState(files) {
+        throw new NotImplemented(`A handler '${this.name}' for file ${files.map(f => `'${f}''`).join(', ')} does not implement startingState()`);
+    }
+    /**
+     * Figure out possible directions from the given state.
+     * @param state
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async getDirections(state, config) {
+        throw new NotImplemented(`A handler '${this.name}' for state '${JSON.stringify(state)}' does not implement getDirections()`);
+    }
+    /**
+     * See if it is possible rollback a process.
+     * @param step
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async rollback(process, state) {
+        throw new NotImplemented(`A handler '${this.name}' does not implement rollback()`);
+    }
+}
+//# sourceMappingURL=ProcessHandler.js.map

package/dist/tasenor-common-node/src/process/ProcessHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProcessHandler.js","sourceRoot":"","sources":["../../../../src/process/ProcessHandler.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAGzC;;GAEG;AACH,MAAM,OAAO,cAAc;IAEzB,MAAM,CAAkB;IACxB,IAAI,CAAQ;IAEZ,YAAY,IAAY;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,MAAwB;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,IAAiB;QACzB,MAAM,IAAI,cAAc,CAAC,cAAc,IAAI,CAAC,IAAI,wBAAwB,IAAI,CAAC,IAAI,0CAA0C,CAAC,CAAA;IAC9H,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,IAAiB;QACzB,MAAM,IAAI,cAAc,CAAC,cAAc,IAAI,CAAC,IAAI,yBAAyB,IAAI,CAAC,IAAI,0CAA0C,CAAC,CAAA;IAC/H,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,KAAkB;QAChC,MAAM,IAAI,cAAc,CAAC,cAAc,IAAI,CAAC,IAAI,yBAAyB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,gDAAgD,CAAC,CAAA;IACjJ,CAAC;IAED;;;;;OAKG;IACH,6DAA6D;IAC7D,KAAK,CAAC,MAAM,CAAC,OAAgB,EAAE,MAAoB,EAAE,KAAkB,EAAE,KAAoB;QAC3F,MAAM,IAAI,cAAc,CAAC,cAAc,IAAI,CAAC,IAAI,eAAe,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAA;IACpI,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,KAAoB;QAChC,MAAM,IAAI,cAAc,CAAC,cAAc,IAAI,CAAC,IAAI,cAAc,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAA;IAC1I,CAAC;IAED;;;OAGG;IACH,6DAA6D;IAC7D,KAAK,CAAC,aAAa,CAAC,KAAkB,EAAE,MAAqB;QAC3D,MAAM,IAAI,cAAc,CAAC,cAAc,IAAI,CAAC,IAAI,gBAAgB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAA;IAC9H,CAAC;IAED;;;OAGG;IACH,6DAA6D;IAC7D,KAAK,CAAC,QAAQ,CAAC,OAAgB,EAAE,KAAkB;QACjD,MAAM,IAAI,cAAc,CAAC,cAAc,IAAI,CAAC,IAAI,iCAAiC,CAAC,CAAA;IACpF,CAAC;CACF"}

package/dist/tasenor-common-node/src/process/ProcessStep.d.ts

@@ -0,0 +1,52 @@
+import { Process } from './Process';
+import { KnexDatabase } from '../database';
+import { ID, Directions, ImportAction, ImportState } from '@dataplug/tasenor-common';
+/**
+ * A basic information of the processing step.
+ */
+export interface ProcessStepData {
+    processId?: ID;
+    number: number;
+    state: ImportState;
+    handler: string;
+    action?: ImportAction;
+    directions?: Directions;
+    started?: Date;
+    finished?: Date;
+}
+/**
+ * Data of the one step in the process including possible directions and action taken to the next step, if any.
+ */
+export declare class ProcessStep {
+    process: Process;
+    id: ID;
+    processId: ID;
+    number: number;
+    state: ImportState;
+    handler: string;
+    started: Date | undefined;
+    finished: Date | undefined;
+    directions?: Directions;
+    action?: ImportAction | undefined;
+    constructor(obj: ProcessStepData);
+    toString(): string;
+    /**
+     * Get a reference to the database.
+     */
+    get db(): KnexDatabase;
+    /**
+     * Save the process info to the database.
+     */
+    save(): Promise<ID>;
+    /**
+     * Get the loaded process information as JSON object.
+     * @returns
+     */
+    toJSON(): ProcessStepData;
+    /**
+     * Set directions and update database.
+     * @param db
+     * @param directions
+     */
+    setDirections(db: KnexDatabase, directions: Directions): Promise<void>;
+}

package/dist/tasenor-common-node/src/process/ProcessStep.js

@@ -0,0 +1,78 @@
+import { DatabaseError } from '../error';
+import { Directions } from '@dataplug/tasenor-common';
+/**
+ * Data of the one step in the process including possible directions and action taken to the next step, if any.
+ */
+export class ProcessStep {
+    process;
+    id;
+    processId;
+    number;
+    state;
+    handler;
+    started;
+    finished;
+    directions;
+    action;
+    constructor(obj) {
+        this.processId = obj.processId || null;
+        this.number = obj.number;
+        this.state = obj.state;
+        this.handler = obj.handler;
+        this.directions = obj.directions ? new Directions(obj.directions) : undefined;
+        this.action = obj.action;
+        this.started = obj.started;
+        this.finished = obj.finished;
+    }
+    toString() {
+        return `ProcessStep ${this.number} of Process #${this.processId}`;
+    }
+    /**
+     * Get a reference to the database.
+     */
+    get db() {
+        return this.process.db;
+    }
+    /**
+     * Save the process info to the database.
+     */
+    async save() {
+        if (this.id) {
+            await this.db('process_steps').update(this.toJSON()).where({ id: this.id });
+            return this.id;
+        }
+        else {
+            this.started = new Date();
+            this.id = (await this.db('process_steps').insert(this.toJSON()).returning('id'))[0].id;
+            if (this.id)
+                return this.id;
+            throw new DatabaseError(`Saving process ${JSON.stringify(this.toJSON)} failed.`);
+        }
+    }
+    /**
+     * Get the loaded process information as JSON object.
+     * @returns
+     */
+    toJSON() {
+        return {
+            processId: this.processId,
+            number: this.number,
+            state: this.state,
+            directions: this.directions,
+            handler: this.handler,
+            action: this.action,
+            started: this.started,
+            finished: this.finished
+        };
+    }
+    /**
+     * Set directions and update database.
+     * @param db
+     * @param directions
+     */
+    async setDirections(db, directions) {
+        this.directions = directions;
+        await db('process_steps').update({ directions: directions.toJSON() }).where({ id: this.id });
+    }
+}
+//# sourceMappingURL=ProcessStep.js.map

package/dist/tasenor-common-node/src/process/ProcessStep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProcessStep.js","sourceRoot":"","sources":["../../../../src/process/ProcessStep.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,OAAO,EAAM,UAAU,EAA6B,MAAM,0BAA0B,CAAA;AAgBpF;;GAEG;AACH,MAAM,OAAO,WAAW;IAEtB,OAAO,CAAS;IAEhB,EAAE,CAAI;IACN,SAAS,CAAI;IACb,MAAM,CAAQ;IACd,KAAK,CAAa;IAClB,OAAO,CAAQ;IACf,OAAO,CAAkB;IACzB,QAAQ,CAAkB;IAC1B,UAAU,CAAa;IACvB,MAAM,CAA2B;IAEjC,YAAY,GAAoB;QAC9B,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,IAAI,IAAI,CAAA;QACtC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAA;QACxB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAA;QAC1B,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QAC7E,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAA;QACxB,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAA;QAC1B,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAA;IAC9B,CAAC;IAED,QAAQ;QACN,OAAO,eAAe,IAAI,CAAC,MAAM,gBAAgB,IAAI,CAAC,SAAS,EAAE,CAAA;IACnE,CAAC;IAED;;OAEG;IACH,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAA;IACxB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,EAAE,EAAE;YACX,MAAM,IAAI,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAA;YAC3E,OAAO,IAAI,CAAC,EAAE,CAAA;SACf;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,IAAI,IAAI,EAAE,CAAA;YACzB,IAAI,CAAC,EAAE,GAAG,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;YACtF,IAAI,IAAI,CAAC,EAAE;gBAAE,OAAO,IAAI,CAAC,EAAE,CAAA;YAC3B,MAAM,IAAI,aAAa,CAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;SACjF;IACH,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAAC,EAAgB,EAAE,UAAsB;QAC1D,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,MAAM,EAAE,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAA;IAC9F,CAAC;CACF"}

package/dist/tasenor-common-node/src/process/ProcessingSystem.d.ts

@@ -0,0 +1,60 @@
+import { Process } from './Process';
+import { ProcessFileData } from './ProcessFile';
+import { ProcessStep } from './ProcessStep';
+import { ProcessHandler, ProcessHandlerMap } from './ProcessHandler';
+import { ProcessConnector } from './ProcessConnector';
+import { ProcessName, ProcessConfig, ID } from '@dataplug/tasenor-common';
+import { KnexDatabase } from '../database';
+/**
+ * An instance of the full processing system.
+ */
+export declare class ProcessingSystem {
+    db: KnexDatabase;
+    handlers: ProcessHandlerMap;
+    connector: ProcessConnector;
+    logger: {
+        info: (...msg: any[]) => void;
+        error: (...msg: any[]) => void;
+    };
+    /**
+     * Initialize the system and set the database instance for storing process data.
+     * @param db
+     */
+    constructor(db: KnexDatabase, connector: ProcessConnector);
+    /**
+     * Get the translation from the connector.
+     * @param language
+     * @param text
+     * @returns
+     */
+    getTranslation(text: string, language: string): Promise<string>;
+    /**
+     * Register new handler class for processing.
+     * @param handler
+     */
+    register(handler: ProcessHandler): void;
+    /**
+     * Initialize new process and save it to the database.
+     * @param type
+     * @param name
+     * @param file
+     * @returns New process that is already in crashed state, if no handler
+     */
+    createProcess(name: ProcessName, files: ProcessFileData[], config: ProcessConfig): Promise<Process>;
+    /**
+     * Check if we are in the finished state and if not, find the directions forward.
+     */
+    checkFinishAndFindDirections(handler: ProcessHandler, step: ProcessStep): Promise<void>;
+    /**
+     * Get the named handler or throw an error if not registered.
+     * @param name
+     * @returns
+     */
+    getHandler(name: string): ProcessHandler;
+    /**
+     * Load the process data from the disk.
+     * @param id
+     * @returns
+     */
+    loadProcess(id: ID): Promise<Process>;
+}

package/dist/tasenor-common-node/src/process/ProcessingSystem.js

@@ -0,0 +1,182 @@
+import { Process } from './Process';
+import { ProcessFile } from './ProcessFile';
+import { ProcessStep } from './ProcessStep';
+import { InvalidArgument } from '../error';
+/**
+ * An instance of the full processing system.
+ */
+export class ProcessingSystem {
+    db;
+    handlers = {};
+    connector;
+    logger;
+    /**
+     * Initialize the system and set the database instance for storing process data.
+     * @param db
+     */
+    constructor(db, connector) {
+        this.db = db;
+        this.logger = {
+            info: (...msg) => console.log(new Date(), ...msg),
+            error: (...msg) => console.error(new Date(), ...msg)
+        };
+        this.connector = connector;
+    }
+    /**
+     * Get the translation from the connector.
+     * @param language
+     * @param text
+     * @returns
+     */
+    async getTranslation(text, language) {
+        return this.connector.getTranslation(text, language);
+    }
+    /**
+     * Register new handler class for processing.
+     * @param handler
+     */
+    register(handler) {
+        if (!handler) {
+            throw new InvalidArgument('A handler was undefined.');
+        }
+        if (!handler.name) {
+            throw new InvalidArgument('A handler without name cannot be registered.');
+        }
+        if (handler.name in this.handlers) {
+            throw new InvalidArgument(`The handler '${handler.name}' is already defined.`);
+        }
+        if (handler.name.length > 32) {
+            throw new InvalidArgument(`The handler name '${handler.name}' is too long.`);
+        }
+        handler.system = this;
+        this.handlers[handler.name] = handler;
+    }
+    /**
+     * Initialize new process and save it to the database.
+     * @param type
+     * @param name
+     * @param file
+     * @returns New process that is already in crashed state, if no handler
+     */
+    async createProcess(name, files, config) {
+        // Set up the process.
+        const process = new Process(this, name, config);
+        await process.save();
+        // Check if we have files.
+        if (files.length < 1) {
+            await process.crashed(new InvalidArgument('No files given to create a process.'));
+            return process;
+        }
+        // Save the first file and attach it to the process.
+        const file = files[0];
+        const processFile = new ProcessFile(file);
+        process.addFile(processFile);
+        await processFile.save(this.db);
+        // Find the handler.
+        let selectedHandler = null;
+        for (const handler of Object.values(this.handlers)) {
+            try {
+                if (handler.canHandle(processFile)) {
+                    selectedHandler = handler;
+                    break;
+                }
+            }
+            catch (err) {
+                await process.crashed(err);
+                return process;
+            }
+        }
+        if (!selectedHandler) {
+            await process.crashed(new InvalidArgument(`No handler found for the file ${file.name} of type ${file.type}.`));
+            return process;
+        }
+        // Check if the handler accepts the rest of the files.
+        for (let i = 1; i < files.length; i++) {
+            const processFile = new ProcessFile(files[i]);
+            // await processFile.save(this.db)
+            if (!selectedHandler.canAppend(processFile)) {
+                await process.crashed(new InvalidArgument(`The file ${files[i].name} of type ${files[i].type} cannot be appended to handler.`));
+                return process;
+            }
+            process.addFile(processFile);
+            await processFile.save(this.db);
+        }
+        // Create initial step using the handler.
+        let state;
+        try {
+            state = selectedHandler.startingState(process.files);
+        }
+        catch (err) {
+            await process.crashed(err);
+            return process;
+        }
+        const step = new ProcessStep({
+            number: 0,
+            handler: selectedHandler.name,
+            state
+        });
+        process.addStep(step);
+        await step.save();
+        process.currentStep = 0;
+        await process.save();
+        this.logger.info(`Created process ${process}.`);
+        // Find directions forward from the initial state.
+        await this.checkFinishAndFindDirections(selectedHandler, step);
+        return process;
+    }
+    /**
+     * Check if we are in the finished state and if not, find the directions forward.
+     */
+    async checkFinishAndFindDirections(handler, step) {
+        let result;
+        try {
+            result = handler.checkCompletion(step.state);
+        }
+        catch (err) {
+            return step.process.crashed(err);
+        }
+        if (result === undefined) {
+            let directions;
+            try {
+                directions = await handler.getDirections(step.state, step.process.config);
+            }
+            catch (err) {
+                return step.process.crashed(err);
+            }
+            await step.setDirections(this.db, directions);
+        }
+        else {
+            // Process is finished.
+            step.directions = undefined;
+            step.action = undefined;
+            step.finished = new Date();
+            await step.save();
+            step.process.complete = true;
+            step.process.successful = result;
+            await step.process.save();
+        }
+        await step.process.updateStatus();
+    }
+    /**
+     * Get the named handler or throw an error if not registered.
+     * @param name
+     * @returns
+     */
+    getHandler(name) {
+        if (!(name in this.handlers)) {
+            throw new InvalidArgument(`There is no handler for '${name}'.`);
+        }
+        return this.handlers[name];
+    }
+    /**
+     * Load the process data from the disk.
+     * @param id
+     * @returns
+     */
+    async loadProcess(id) {
+        const process = new Process(this, null);
+        await process.load(id);
+        return process;
+    }
+}
+//# sourceMappingURL=ProcessingSystem.js.map

package/dist/tasenor-common-node/src/process/ProcessingSystem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProcessingSystem.js","sourceRoot":"","sources":["../../../../src/process/ProcessingSystem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,WAAW,EAAmB,MAAM,eAAe,CAAA;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAI3C,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAG1C;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAE3B,EAAE,CAAc;IAChB,QAAQ,GAAsB,EAAE,CAAA;IAChC,SAAS,CAAkB;IAC3B,MAAM,CAGL;IAED;;;OAGG;IACH,YAAY,EAAgB,EAAE,SAA2B;QACvD,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;QACZ,IAAI,CAAC,MAAM,GAAG;YACZ,IAAI,EAAE,CAAC,GAAG,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE,GAAG,GAAG,CAAC;YACjD,KAAK,EAAE,CAAC,GAAG,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,EAAE,GAAG,GAAG,CAAC;SACrD,CAAA;QACD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAAC,IAAY,EAAE,QAAgB;QACjD,OAAO,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;IACtD,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,OAAuB;QAC9B,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,eAAe,CAAC,0BAA0B,CAAC,CAAA;SACtD;QACD,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;YACjB,MAAM,IAAI,eAAe,CAAC,8CAA8C,CAAC,CAAA;SAC1E;QACD,IAAI,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjC,MAAM,IAAI,eAAe,CAAC,gBAAgB,OAAO,CAAC,IAAI,uBAAuB,CAAC,CAAA;SAC/E;QACD,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE;YAC5B,MAAM,IAAI,eAAe,CAAC,qBAAqB,OAAO,CAAC,IAAI,gBAAgB,CAAC,CAAA;SAC7E;QACD,OAAO,CAAC,MAAM,GAAG,IAAI,CAAA;QACrB,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAA;IACvC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,aAAa,CAAC,IAAiB,EAAE,KAAwB,EAAE,MAAqB;QACpF,sBAAsB;QACtB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;QAC/C,MAAM,OAAO,CAAC,IAAI,EAAE,CAAA;QAEpB,0BAA0B;QAC1B,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;YACpB,MAAM,OAAO,CAAC,OAAO,CAAC,IAAI,eAAe,CAAC,qCAAqC,CAAC,CAAC,CAAA;YACjF,OAAO,OAAO,CAAA;SACf;QAED,oDAAoD;QACpD,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;QACrB,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAA;QACzC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;QAC5B,MAAM,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAE/B,oBAAoB;QACpB,IAAI,eAAe,GAA0B,IAAI,CAAA;QACjD,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YAClD,IAAI;gBACF,IAAI,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE;oBAClC,eAAe,GAAG,OAAO,CAAA;oBACzB,MAAK;iBACN;aACF;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;gBAC1B,OAAO,OAAO,CAAA;aACf;SACF;QACD,IAAI,CAAC,eAAe,EAAE;YACpB,MAAM,OAAO,CAAC,OAAO,CAAC,IAAI,eAAe,CAAC,iCAAiC,IAAI,CAAC,IAAI,YAAY,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAA;YAC9G,OAAO,OAAO,CAAA;SACf;QAED,sDAAsD;QACtD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACrC,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;YAC7C,kCAAkC;YAClC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE;gBAC3C,MAAM,OAAO,CAAC,OAAO,CAAC,IAAI,eAAe,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,iCAAiC,CAAC,CAAC,CAAA;gBAC/H,OAAO,OAAO,CAAA;aACf;YACD,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;YAC5B,MAAM,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;SAChC;QAED,yCAAyC;QACzC,IAAI,KAAK,CAAA;QACT,IAAI;YACF,KAAK,GAAG,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;SACrD;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;YAC1B,OAAO,OAAO,CAAA;SACf;QACD,MAAM,IAAI,GAAG,IAAI,WAAW,CAAC;YAC3B,MAAM,EAAE,CAAC;YACT,OAAO,EAAE,eAAe,CAAC,IAAI;YAC7B,KAAK;SACN,CAAC,CAAA;QAEF,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACrB,MAAM,IAAI,CAAC,IAAI,EAAE,CAAA;QAEjB,OAAO,CAAC,WAAW,GAAG,CAAC,CAAA;QACvB,MAAM,OAAO,CAAC,IAAI,EAAE,CAAA;QACpB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,OAAO,GAAG,CAAC,CAAA;QAE/C,kDAAkD;QAClD,MAAM,IAAI,CAAC,4BAA4B,CAAC,eAAe,EAAE,IAAI,CAAC,CAAA;QAE9D,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,4BAA4B,CAAC,OAAuB,EAAE,IAAiB;QAC3E,IAAI,MAAM,CAAA;QACV,IAAI;YACF,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;SAC7C;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;SACjC;QAED,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,IAAI,UAAU,CAAA;YACd,IAAI;gBACF,UAAU,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;aAC1E;YAAC,OAAO,GAAG,EAAE;gBACZ,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;aACjC;YACD,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,CAAA;SAC9C;aAAM;YACL,uBAAuB;YACvB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAA;YAC3B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAA;YACvB,IAAI,CAAC,QAAQ,GAAG,IAAI,IAAI,EAAE,CAAA;YAC1B,MAAM,IAAI,CAAC,IAAI,EAAE,CAAA;YACjB,IAAI,CAAC,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAA;YAC5B,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,MAAM,CAAA;YAChC,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;SAC1B;QACD,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAA;IACnC,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,IAAY;QACrB,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE;YAC5B,MAAM,IAAI,eAAe,CAAC,4BAA4B,IAAI,IAAI,CAAC,CAAA;SAChE;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;IAC5B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW,CAAC,EAAM;QACtB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QACvC,MAAM,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACtB,OAAO,OAAO,CAAA;IAChB,CAAC;CACF"}