@formio/appserver 2.0.0-dev.3 → 2.0.0-dev.30

package/lib/db.js

@@ -1,445 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Database = void 0;
-const mongodb_1 = require("mongodb");
-const pick_1 = __importDefault(require("lodash/pick"));
-const omit_1 = __importDefault(require("lodash/omit"));
-const debug = require('debug')('formio:db');
-const error = require('debug')('formio:error');
-class Database {
-    constructor(config) {
-        this.config = config;
-        this.prefix = '';
-        this.db = null;
-        this.currentCollectionName = 'submissions';
-        this.currentCollection = null;
-        this.defaultCollection = null;
-    }
-    ObjectId(id) {
-        if (id === null || id === void 0 ? void 0 : id.hasOwnProperty('$in')) {
-            return { $in: id['$in'].map((_id) => this.ObjectId(_id)) };
-        }
-        try {
-            return id ? (new mongodb_1.ObjectId(id)) : null;
-        }
-        catch (e) {
-            return id;
-        }
-    }
-    collectionName(name) {
-        return `${this.prefix}${name}`;
-    }
-    /**
-     * Connect to the database.
-     * @param {*} scope
-     * @returns
-     */
-    connect(prefix = '') {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.prefix = prefix ? `${prefix}.` : '';
-            try {
-                debug('db.connect()');
-                const config = this.config.config ? JSON.parse(this.config.config) : {};
-                const client = new mongodb_1.MongoClient(this.config.url, config);
-                yield client.connect();
-                this.db = yield client.db();
-                this.addIndex(this.db.collection(this.collectionName('project')), 'name');
-                this.defaultCollection = this.db.collection(this.collectionName('submissions'));
-                yield this.setupIndexes(this.defaultCollection);
-                debug('Connected to database');
-            }
-            catch (err) {
-                error(err.message);
-                process.exit();
-            }
-        });
-    }
-    // Generic save record method.
-    save(collectionName, item) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this.db) {
-                return null;
-            }
-            const collection = this.db.collection(`${this.prefix}${collectionName}`);
-            let result;
-            try {
-                debug('db.save()', collectionName);
-                result = yield collection.findOneAndUpdate({ _id: this.ObjectId(item._id) }, { $set: (0, omit_1.default)(item, '_id') }, { upsert: true, returnOriginal: false });
-            }
-            catch (err) {
-                error(err.message);
-            }
-            return result ? result.value : null;
-        });
-    }
-    // Generic load record method.
-    load(collectionName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this.db) {
-                return null;
-            }
-            debug('db.load()', collectionName);
-            const collection = this.db.collection(this.collectionName(collectionName));
-            let item;
-            try {
-                item = yield collection.findOne({});
-            }
-            catch (err) {
-                error(err.message);
-            }
-            return item;
-        });
-    }
-    // Generic delete record method.
-    remove(collectionName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this.db) {
-                return null;
-            }
-            debug('db.remove()', collectionName);
-            const collection = this.db.collection(this.collectionName(collectionName));
-            let result;
-            try {
-                result = yield collection.deleteOne({});
-            }
-            catch (err) {
-                error(err.message);
-            }
-            return result ? result.deletedCount : null;
-        });
-    }
-    /**
-     * Ensures the form collection is created an returns it.
-     * @param scope
-     * @returns
-     */
-    formCollection(scope) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.db && scope && scope.form && scope.form.settings && scope.form.settings.collection) {
-                if (this.currentCollection && this.currentCollectionName === scope.form.settings.collection) {
-                    return this.currentCollection;
-                }
-                let collection = null;
-                try {
-                    debug('db.createCollection()', scope.form.settings.collection);
-                    yield this.db.createCollection(this.collectionName(scope.form.settings.collection));
-                    collection = this.db.collection(this.collectionName(scope.form.settings.collection));
-                    this.setupIndexes(collection, scope);
-                }
-                catch (err) {
-                    error(err.message);
-                }
-                this.currentCollection = collection || this.db.collection(this.collectionName(scope.form.settings.collection));
-                this.currentCollectionName = scope.form.settings.collection;
-                return this.currentCollection;
-            }
-            return this.defaultCollection;
-        });
-    }
-    /**
-     * Setup indexes.
-     */
-    setupIndexes(collection, scope) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!collection) {
-                return;
-            }
-            this.addIndex(collection, 'project');
-            this.addIndex(collection, 'form');
-            this.addIndex(collection, 'deleted');
-            this.addIndex(collection, 'modified');
-            this.addIndex(collection, 'created');
-            if (scope && scope.form && scope.form.components) {
-                scope.utils.eachComponent(scope.form.components, (component, components, path) => {
-                    if (component.dbIndex) {
-                        this.addIndex(collection, `data.${path}`);
-                    }
-                });
-            }
-        });
-    }
-    /**
-     * Add a field index
-     */
-    addIndex(collection, path) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const index = {};
-            index[path] = 1;
-            try {
-                debug('db.addIndex()', path);
-                collection.createIndex(index, { background: true });
-            }
-            catch (err) {
-                error(`Cannot add index ${path}`, err.message);
-            }
-        });
-    }
-    /**
-     * Adds new indexes to the forms submission collection.
-     * @param scope
-     * @param indexes
-     * @returns
-     */
-    addIndexes(scope, indexes) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const collection = yield this.formCollection(scope);
-            if (!collection) {
-                return;
-            }
-            for (const path of indexes) {
-                yield this.addIndex(collection, `data.${path}`);
-            }
-        });
-    }
-    /**
-     * Remove a field index.
-     */
-    removeIndex(collection, path) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const index = {};
-            index[path] = 1;
-            try {
-                debug('db.removeIndex()', path);
-                collection.dropIndex(index);
-            }
-            catch (err) {
-                error(`Cannot remove index ${path}`, err.message);
-            }
-        });
-    }
-    /**
-     * Removes indexes to the forms submission collection.
-     * @param scope
-     * @param indexes
-     * @returns
-     */
-    removeIndexes(scope, indexes) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const collection = yield this.formCollection(scope);
-            if (!collection) {
-                return;
-            }
-            for (const path of indexes) {
-                yield this.removeIndex(collection, `data.${path}`);
-            }
-        });
-    }
-    /**
-     * Fetch a list of submissions from a table/collection.
-     * @param {*} table
-     * @param {*} query
-     */
-    index(scope, query = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let items;
-            try {
-                debug('db.index()', query);
-                items = yield this.find(scope, query);
-            }
-            catch (err) {
-                error(err.message);
-            }
-            return items;
-        });
-    }
-    /**
-     * Create a new record.
-     */
-    create(scope, record, allowFields = []) {
-        return __awaiter(this, void 0, void 0, function* () {
-            record.deleted = null;
-            record.created = new Date();
-            record.modified = new Date();
-            if (scope.form && scope.form._id) {
-                record.form = this.ObjectId(scope.form._id);
-            }
-            if (scope.project && scope.project._id) {
-                record.project = this.ObjectId(scope.project._id);
-            }
-            if (record.owner) {
-                record.owner = this.ObjectId(record.owner);
-            }
-            const collection = yield this.formCollection(scope);
-            try {
-                debug('db.create()', record);
-                const result = yield collection.insertOne((0, pick_1.default)(record, [
-                    'data',
-                    'metadata',
-                    'modified',
-                    'created',
-                    'deleted',
-                    'form',
-                    'project',
-                    'owner',
-                    'access'
-                ].concat(allowFields)));
-                if (!result.insertedId) {
-                    return null;
-                }
-                return yield this.read(scope, result.insertedId);
-            }
-            catch (err) {
-                error(err.message);
-            }
-        });
-    }
-    /**
-     * Return a query for a single mongo record.
-     * @param {*} form
-     * @param {*} id
-     * @returns
-     */
-    query(scope, query = {}) {
-        if (query._id) {
-            query._id = this.ObjectId(query._id);
-        }
-        if (query.owner) {
-            query.owner = this.ObjectId(query.owner);
-        }
-        if (query.form) {
-            query.form = this.ObjectId(query.form);
-        }
-        else if (scope.form && scope.form._id) {
-            query.form = this.ObjectId(scope.form._id);
-        }
-        if (scope.project && scope.project._id) {
-            query.project = this.ObjectId(scope.project._id);
-        }
-        query.deleted = { $eq: null };
-        // Handle nested queries.
-        ['$or', '$and'].forEach((key) => {
-            if (query[key]) {
-                query[key].forEach((subQuery) => this.query(scope, subQuery));
-            }
-        });
-        return query;
-    }
-    /**
-     * Find many records that match a query.
-     */
-    find(scope, query = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                debug('db.find()', query);
-                const collection = yield this.formCollection(scope);
-                if (!collection) {
-                    return [];
-                }
-                return yield collection.find(this.query(scope, query)).toArray();
-            }
-            catch (err) {
-                error(err.message);
-            }
-            return [];
-        });
-    }
-    /**
-     * Find a record for a provided query.
-     */
-    findOne(scope, query = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                debug('db.findOne()', query);
-                const collection = yield this.formCollection(scope);
-                if (!collection) {
-                    return null;
-                }
-                return yield collection.findOne(this.query(scope, query));
-            }
-            catch (err) {
-                error(err.message);
-            }
-            return null;
-        });
-    }
-    /**
-     * Read a single submission from a form
-     *
-     * @param {*} table
-     * @param {*} query
-     */
-    read(scope, id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                debug('db.read()', id);
-                const collection = yield this.formCollection(scope);
-                if (!collection) {
-                    return null;
-                }
-                return yield collection.findOne(this.query(scope, { _id: id }));
-            }
-            catch (err) {
-                error(err.message);
-            }
-            return null;
-        });
-    }
-    /**
-     * Update a single submission of a form.
-     *
-     * @param {*} table
-     * @param {*} query
-     */
-    update(scope, id, update, allowFields = []) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!id || !update) {
-                return null;
-            }
-            update.modified = new Date();
-            try {
-                debug('db.update()', id, update);
-                const collection = yield this.formCollection(scope);
-                if (!collection) {
-                    return null;
-                }
-                const result = yield collection.updateOne(this.query(scope, { _id: id }), {
-                    $set: (0, pick_1.default)(update, ['data', 'metadata', 'modified'].concat(allowFields))
-                });
-                if (result.modifiedCount === 0) {
-                    return null;
-                }
-                return yield this.read(scope, id);
-            }
-            catch (err) {
-                error(err.message);
-            }
-            return null;
-        });
-    }
-    /**
-     * Delete a record from the database.
-     */
-    delete(scope, id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!id) {
-                return false;
-            }
-            try {
-                debug('db.delete()', id);
-                const collection = yield this.formCollection(scope);
-                if (!collection) {
-                    return false;
-                }
-                const result = yield collection.updateOne(this.query(scope, { _id: id }), { $set: { deleted: Date.now() } });
-                return result.modifiedCount > 0;
-            }
-            catch (err) {
-                error(err.message);
-            }
-            return false;
-        });
-    }
-}
-exports.Database = Database;

package/lib/index.d.ts

@@ -1,180 +0,0 @@
-/// <reference types="express" />
-import { Server as CoreServer } from '@formio/appserver-core';
-import { Auth } from "./auth";
-import { Database } from "./db";
-import Actions from "./actions";
-import { Processor } from "./process";
-import { Prepper } from './prepare';
-import { AppServerScope, Processor as ProcessorType, Prepper as PrepperType } from '@formio/appserver-types';
-export declare const Modules: {
-    db: typeof Database;
-    auth: typeof Auth;
-    processor: ProcessorType;
-    prepper: PrepperType;
-    actions: {
-        save: {
-            readonly info: {
-                name: string;
-                title: string;
-                description: string;
-                priority: number;
-                defaults: {
-                    handler: string[];
-                    method: string[];
-                };
-                access: {
-                    handler: boolean;
-                    method: boolean;
-                };
-            };
-            mappingComponents(scope: import("@formio/appserver-types").ActionScope): Promise<any>;
-            settingsForm(scope: import("@formio/appserver-types").ActionScope): Promise<any>;
-            saveToForm(scope: import("@formio/appserver-types").ActionScope, resource: string): undefined;
-            childSubmission(scope: import("@formio/appserver-types").ActionScope, req: import("@formio/appserver-types").SubmissionRequest, res: import("@formio/appserver-types").SubmissionResponse, submission: any): any;
-            childResponse(scope: import("@formio/appserver-types").ActionScope, req: import("@formio/appserver-types").SubmissionRequest, res: import("@formio/appserver-types").SubmissionResponse): void;
-            executor(scope: import("@formio/appserver-types").ActionScope): Promise<(req: import("@formio/appserver-types").SubmissionRequest, res: import("@formio/appserver-types").SubmissionResponse, next: import("express").NextFunction) => Promise<void>>;
-        };
-        login: {
-            readonly info: {
-                name: string;
-                title: string;
-                description: string;
-                priority: number;
-                defaults: {
-                    handler: string[];
-                    method: string[];
-                };
-                access: {
-                    handler: boolean;
-                    method: boolean;
-                };
-            };
-            settingsForm(scope: import("@formio/appserver-types").ActionScope): Promise<({
-                type: string;
-                label: string;
-                key: string;
-                placeholder: string;
-                dataSrc: string;
-                valueProperty: string;
-                data: {
-                    json: any;
-                };
-                multiple: boolean;
-                validate: {
-                    required: boolean;
-                };
-                input?: undefined;
-                description?: undefined;
-                defaultValue?: undefined;
-                suffix?: undefined;
-            } | {
-                type: string;
-                input: boolean;
-                label: string;
-                key: string;
-                placeholder: string;
-                dataSrc: string;
-                valueProperty: string;
-                data: {
-                    json: any;
-                };
-                multiple: boolean;
-                validate: {
-                    required: boolean;
-                };
-                description?: undefined;
-                defaultValue?: undefined;
-                suffix?: undefined;
-            } | {
-                type: string;
-                key: string;
-                input: boolean;
-                label: string;
-                description: string;
-                defaultValue: string;
-                placeholder?: undefined;
-                dataSrc?: undefined;
-                valueProperty?: undefined;
-                data?: undefined;
-                multiple?: undefined;
-                validate?: undefined;
-                suffix?: undefined;
-            } | {
-                type: string;
-                key: string;
-                input: boolean;
-                label: string;
-                description: string;
-                defaultValue: string;
-                suffix: string;
-                placeholder?: undefined;
-                dataSrc?: undefined;
-                valueProperty?: undefined;
-                data?: undefined;
-                multiple?: undefined;
-                validate?: undefined;
-            })[]>;
-            waitText(time: number): string;
-            checkAttempts(scope: import("@formio/appserver-types").ActionScope, error: any, user: import("@formio/appserver-types").User): Promise<any>;
-            executor(scope: import("@formio/appserver-types").ActionScope): Promise<(req: import("@formio/appserver-types").SubmissionRequest, res: import("@formio/appserver-types").SubmissionResponse, next: import("express").NextFunction) => Promise<void>>;
-        };
-        role: {
-            readonly info: {
-                name: string;
-                title: string;
-                description: string;
-                priority: number;
-                defaults: {
-                    handler: string[];
-                    method: string[];
-                };
-                access: {
-                    handler: boolean;
-                    method: boolean;
-                };
-            };
-            settingsForm(scope: import("@formio/appserver-types").ActionScope): Promise<({
-                type: string;
-                input: boolean;
-                label: string;
-                key: string;
-                placeholder: string;
-                template: string;
-                dataSrc: string;
-                data: {
-                    json: string;
-                };
-                valueProperty: string;
-                multiple: boolean;
-                validate: {
-                    required: boolean;
-                };
-            } | {
-                type: string;
-                input: boolean;
-                label: string;
-                key: string;
-                placeholder: string;
-                template: string;
-                dataSrc: string;
-                data: {
-                    json: unknown[];
-                };
-                valueProperty: string;
-                multiple: boolean;
-                validate: {
-                    required: boolean;
-                };
-            })[]>;
-            executor(scope: import("@formio/appserver-types").ActionScope): Promise<(req: import("@formio/appserver-types").SubmissionRequest, res: import("@formio/appserver-types").SubmissionResponse, next: import("express").NextFunction) => Promise<void | import("@formio/appserver-types").SubmissionResponse>>;
-        };
-    };
-};
-export declare class Server extends CoreServer {
-    constructor(config?: AppServerScope);
-}
-export { Prepper };
-export { Processor };
-export { Database };
-export { Auth };
-export { Actions };