@formio/appserver 2.0.0-rc.8 → 2.0.0

package/lib/modules/mongodb/db.js

@@ -8,6 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Database = void 0;
 const mongodb_1 = require("mongodb");
@@ -19,6 +30,7 @@ class Database {
     constructor(config) {
         this.config = config;
         this.prefix = '';
+        this.authQuery = null;
         this.db = null;
         this.client = null; // Add this line
         this.currentCollectionName = 'submissions';
@@ -41,7 +53,6 @@ class Database {
     }
     /**
      * Connect to the database.
-     * @param {*} scope
      * @returns
      */
     connect() {
@@ -135,7 +146,7 @@ class Database {
     }
     // Generic load record method.
     load(collectionName_1) {
-        return __awaiter(this, arguments, void 0, function* (collectionName, query = {}) {
+        return __awaiter(this, arguments, void 0, function* (collectionName, dbQuery = {}) {
             if (!this.db) {
                 return null;
             }
@@ -146,7 +157,7 @@ class Database {
             }
             let item;
             try {
-                item = yield collection.findOne(query);
+                item = yield collection.findOne(dbQuery);
             }
             catch (err) {
                 error(err.message);
@@ -154,9 +165,118 @@ class Database {
             return item;
         });
     }
+    // Provides a suplemental query for authentication purposes.
+    indexAuth(query) {
+        this.authQuery = query || null;
+    }
+    getQueryValue(name, value, selector) {
+        if (name === 'created' || name === 'modified') {
+            return new Date(value);
+        }
+        if ((typeof value === 'string') && (!selector || (selector === 'eq' || selector === 'ne'))) {
+            const lcValue = value.toLowerCase();
+            if (lcValue === 'null') {
+                return null;
+            }
+            if (lcValue === '"null"') {
+                return 'null';
+            }
+            if (lcValue === 'true') {
+                return true;
+            }
+            if (lcValue === '"true"') {
+                return 'true';
+            }
+            if (lcValue === 'false') {
+                return false;
+            }
+            if (lcValue === '"false"') {
+                return 'false';
+            }
+        }
+        return value;
+    }
+    /**
+     * Converts the url query to query parameters.
+     * @param query
+     * @returns
+     */
+    dbQuery(query = {}) {
+        const dbQuery = {};
+        const { limit, skip, sort } = query, filters = __rest(query, ["limit", "skip", "sort"]);
+        if (limit !== undefined) {
+            dbQuery.limit = limit ? Number(limit) : 10;
+        }
+        if (skip !== undefined) {
+            dbQuery.skip = skip ? Number(skip) : 0;
+        }
+        if (sort) {
+            dbQuery.sort = {};
+            const sortParts = sort.split(',');
+            sortParts.forEach((part) => {
+                const desc = part.charAt(0) === '-';
+                const field = desc ? part.substring(1) : part;
+                dbQuery.sort[field] = desc ? -1 : 1;
+            });
+        }
+        // Iterate through each filter.
+        Object.entries(filters).forEach(([name, value]) => {
+            // Get the filter object.
+            const filter = (0, lodash_1.zipObject)(['name', 'selector'], name.split('__'));
+            if (filter.selector) {
+                var filterQuery = dbQuery[filter.name];
+                // Init the filter.
+                if (!filterQuery) {
+                    filterQuery = {};
+                }
+                if (filter.selector === 'exists') {
+                    value = ((value === 'true') || (value === '1')) ? true : value;
+                    value = ((value === 'false') || (value === '0')) ? false : value;
+                    value = !!value;
+                }
+                else if (filter.selector === 'regex') {
+                    const parts = value.match(/\/?([^/]+)\/?([^/]+)?/);
+                    if (!parts) {
+                        return;
+                    }
+                    try {
+                        value = new RegExp((0, lodash_1.escapeRegExp)(parts[1]), (parts[2] || 'i'));
+                    }
+                    catch (err) {
+                        error(err);
+                        value = null;
+                    }
+                }
+                // Special case for in filter with multiple values.
+                else if (['in', 'nin'].includes(filter.selector)) {
+                    value = Array.isArray(value) ? value : value.split(',');
+                    value = value.map((item) => this.getQueryValue(filter.name, item, filter.selector));
+                }
+                else {
+                    // Set the selector for this filter name.
+                    value = this.getQueryValue(filter.name, value, filter.selector);
+                }
+                filterQuery[`$${filter.selector}`] = value;
+                dbQuery[filter.name] = filterQuery;
+                return;
+            }
+            else {
+                // Set the find query to this value.
+                value = this.getQueryValue(filter.name, value, filter.selector);
+                dbQuery[filter.name] = value;
+                return;
+            }
+        });
+        // If an authQuery is provided, merge it in.
+        if (this.authQuery && (0, lodash_1.isPlainObject)(this.authQuery)) {
+            return (0, lodash_1.merge)(dbQuery, this.authQuery);
+        }
+        // Return the dbQuery.
+        return dbQuery;
+    }
     // Generic delete record method.
     remove(collectionName_1) {
-        return __awaiter(this, arguments, void 0, function* (collectionName, query = {}) {
+        return __awaiter(this, arguments, void 0, function* (collectionName, dbQuery = {}) {
             if (!this.db) {
                 return null;
             }
@@ -167,7 +287,7 @@ class Database {
             }
             let result;
             try {
-                result = yield collection.deleteOne(query);
+                result = yield collection.deleteOne(dbQuery);
             }
             catch (err) {
                 error(err.message);
@@ -177,27 +297,26 @@ class Database {
     }
     /**
      * Ensures the form collection is created an returns it.
-     * @param scope
      * @returns
      */
-    formCollection(scope) {
+    formCollection(form) {
         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) {
+            if (this.db && form && form.settings && form.settings.collection) {
+                if (this.currentCollection && this.currentCollectionName === 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.collection(scope.form.settings.collection);
-                    this.setupIndexes(collection, scope);
+                    debug('db.createCollection()', form.settings.collection);
+                    yield this.db.createCollection(this.collectionName(form.settings.collection));
+                    collection = this.collection(form.settings.collection);
+                    this.setupIndexes(collection, form);
                 }
                 catch (err) {
                     error(err.message);
                 }
-                this.currentCollection = collection || this.collection(scope.form.settings.collection);
-                this.currentCollectionName = scope.form.settings.collection;
+                this.currentCollection = collection || this.collection(form.settings.collection);
+                this.currentCollectionName = form.settings.collection;
                 return this.currentCollection;
             }
             return this.defaultCollection;
@@ -206,7 +325,7 @@ class Database {
     /**
      * Setup indexes.
      */
-    setupIndexes(collection, scope) {
+    setupIndexes(collection, form) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!collection) {
                 return;
@@ -232,8 +351,8 @@ class Database {
             else {
                 this.addIndex(collection, 'created');
             }
-            if (scope && scope.form && scope.form.components) {
-                scope.utils.eachComponent(scope.form.components, (component, path) => {
+            if (form && form.components) {
+                core_1.Utils.eachComponent(form.components, (component, path) => {
                     if (component.dbIndex) {
                         this.addIndex(collection, `data.${path}`);
                     }
@@ -262,13 +381,12 @@ class Database {
     }
     /**
      * Adds new indexes to the forms submission collection.
-     * @param scope
      * @param indexes
      * @returns
      */
-    addIndexes(scope, indexes) {
+    addIndexes(form, indexes) {
         return __awaiter(this, void 0, void 0, function* () {
-            const collection = yield this.formCollection(scope);
+            const collection = yield this.formCollection(form);
             if (!collection) {
                 return;
             }
@@ -295,13 +413,12 @@ class Database {
     }
     /**
      * Removes indexes to the forms submission collection.
-     * @param scope
      * @param indexes
      * @returns
      */
-    removeIndexes(scope, indexes) {
+    removeIndexes(form, indexes) {
         return __awaiter(this, void 0, void 0, function* () {
-            const collection = yield this.formCollection(scope);
+            const collection = yield this.formCollection(form);
             if (!collection) {
                 return;
             }
@@ -315,59 +432,60 @@ class Database {
      * @param {*} table
      * @param {*} query
      */
-    index(scope_1) {
-        return __awaiter(this, arguments, void 0, function* (scope, query = {}, collection = null) {
+    index(form_1) {
+        return __awaiter(this, arguments, void 0, function* (form, urlQuery = {}, collection = null) {
             let items = [], skip = 0, limit = 10, count = 0;
             try {
-                limit = query.limit || 10;
-                skip = query.skip || 0;
-                const sort = query.sort || { created: -1 };
-                const includeDeleted = query.includeDeleted || false;
+                limit = urlQuery.limit || 10;
+                skip = urlQuery.skip || 0;
+                const sort = urlQuery.sort || { created: -1 };
+                const includeDeleted = urlQuery.includeDeleted || false;
                 let project = {};
-                if (query.select) {
-                    if (typeof query.select === 'string') {
-                        const fields = query.select.split(',');
+                if (urlQuery.select) {
+                    if (typeof urlQuery.select === 'string') {
+                        const fields = urlQuery.select.split(',');
                         fields.forEach((field) => {
                             project[field] = true;
                         });
                     }
                     else {
-                        Object.keys(query.select).forEach((field) => {
+                        Object.keys(urlQuery.select).forEach((field) => {
                             project[field] = true;
                         });
                     }
                 }
-                delete query.limit;
-                delete query.skip;
-                delete query.sort;
-                delete query.select;
-                delete query.includeDeleted;
-                debug('db.index()', query);
-                items = (yield this.find(scope, query, limit, skip, sort, project, collection, includeDeleted)) || [];
-                count = yield this.count(scope, query, collection, includeDeleted);
+                delete urlQuery.limit;
+                delete urlQuery.skip;
+                delete urlQuery.sort;
+                delete urlQuery.select;
+                delete urlQuery.includeDeleted;
+                debug('db.index()', urlQuery);
+                const dbQuery = this.dbQuery(urlQuery);
+                items = (yield this.find(form, dbQuery, limit, skip, sort, project, collection, includeDeleted)) || [];
+                count = yield this.count(form, dbQuery, collection, includeDeleted);
             }
             catch (err) {
                 error(err.message);
             }
-            return { items, limit, skip, count };
+            return { items: items, limit, skip, count };
         });
     }
     /**
      * Perform a count of the amount of documents within a collection.
-     * @param scope
+     * @param form
      * @param query
      * @returns
      */
-    count(scope_1) {
-        return __awaiter(this, arguments, void 0, function* (scope, query = {}, inCollection = null, includeDeleted = false) {
+    count(form_1) {
+        return __awaiter(this, arguments, void 0, function* (form, dbQuery = {}, inCollection = null, includeDeleted = false) {
             let count = 0;
             try {
-                debug('db.count()', query);
-                const collection = inCollection || (yield this.formCollection(scope));
+                debug('db.count()', dbQuery);
+                const collection = inCollection || (yield this.formCollection(form));
                 if (!collection) {
                     return 0;
                 }
-                count = yield collection.countDocuments(this.query(scope, query, includeDeleted));
+                count = yield collection.countDocuments(this.query(form, dbQuery, includeDeleted));
             }
             catch (err) {
                 error(err.message);
@@ -378,21 +496,21 @@ class Database {
     /**
      * Create a new record.
      */
-    create(scope_1, record_1) {
-        return __awaiter(this, arguments, void 0, function* (scope, record, allowFields = []) {
+    create(form_1, record_1) {
+        return __awaiter(this, arguments, void 0, function* (form, record, allowFields = []) {
             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 (form && form._id) {
+                record.form = this.ObjectId(form._id);
             }
-            if (scope.project && scope.project._id) {
-                record.project = this.ObjectId(scope.project._id);
+            if (form.project && form.project) {
+                record.project = this.ObjectId(form.project);
             }
             if (record.owner) {
                 record.owner = this.ObjectId(record.owner);
             }
-            const collection = yield this.formCollection(scope);
+            const collection = yield this.formCollection(form);
             try {
                 debug('db.create()', record);
                 const result = yield collection.insertOne((0, lodash_1.pick)(record, [
@@ -410,10 +528,11 @@ class Database {
                 if (!result.insertedId) {
                     return null;
                 }
-                return yield this.read(scope, result.insertedId);
+                return yield this.read(form, result.insertedId);
             }
             catch (err) {
                 error(err.message);
+                return null;
             }
         });
     }
@@ -423,7 +542,7 @@ class Database {
      * @param {*} id
      * @returns
      */
-    query(scope, query = {}, includeAll = false) {
+    query(form, query = {}, includeAll = false) {
         if (query._id) {
             query._id = this.ObjectId(query._id);
         }
@@ -433,11 +552,11 @@ class Database {
         if (query.form) {
             query.form = this.ObjectId(query.form);
         }
-        else if (!includeAll && scope.form && scope.form._id) {
-            query.form = this.ObjectId(scope.form._id);
+        else if (!includeAll && form && form._id) {
+            query.form = this.ObjectId(form._id);
         }
-        if (!includeAll && scope.project && scope.project._id) {
-            query.project = this.ObjectId(scope.project._id);
+        if (!includeAll && form.project) {
+            query.project = this.ObjectId(form.project);
         }
         if (!includeAll) {
             query.deleted = { $eq: null };
@@ -445,7 +564,7 @@ class Database {
         // Handle nested queries.
         ['$or', '$and'].forEach((key) => {
             if (query[key]) {
-                query[key].forEach((subQuery) => this.query(scope, subQuery, true));
+                query[key].forEach((subQuery) => this.query(form, subQuery, true));
             }
         });
         return query;
@@ -453,15 +572,15 @@ class Database {
     /**
      * Find many records that match a query.
      */
-    find(scope_1) {
-        return __awaiter(this, arguments, void 0, function* (scope, query = {}, limit = 10, skip = 0, sort = { created: -1 }, select = {}, inCollection = null, includeDeleted = false) {
+    find(form_1) {
+        return __awaiter(this, arguments, void 0, function* (form, dbQuery = {}, limit = 10, skip = 0, sort = { created: -1 }, select = {}, inCollection = null, includeDeleted = false) {
             try {
-                debug('db.find()', query);
-                const collection = inCollection || (yield this.formCollection(scope));
+                debug('db.find()', dbQuery);
+                const collection = inCollection || (yield this.formCollection(form));
                 if (!collection) {
                     return [];
                 }
-                return yield collection.find(this.query(scope, query, includeDeleted)).limit(limit).skip(skip).sort(sort).project(select).toArray();
+                return yield collection.find(this.query(form, dbQuery, includeDeleted)).limit(limit).skip(skip).sort(sort).project(select).toArray();
             }
             catch (err) {
                 error(err.message);
@@ -472,15 +591,19 @@ class Database {
     /**
      * Find a record for a provided query.
      */
-    findOne(scope_1) {
-        return __awaiter(this, arguments, void 0, function* (scope, query = {}, options = {}) {
+    findOne(form_1) {
+        return __awaiter(this, arguments, void 0, function* (form, dbQuery = {}, options = {}) {
             try {
-                debug('db.findOne()', query);
-                const collection = yield this.formCollection(scope);
+                debug('db.findOne()', dbQuery);
+                const collection = yield this.formCollection(form);
                 if (!collection) {
                     return null;
                 }
-                return yield collection.findOne(this.query(scope, query));
+                const doc = yield collection.findOne(this.query(form, dbQuery));
+                if (!doc) {
+                    return null;
+                }
+                return doc;
             }
             catch (err) {
                 error(err.message);
@@ -494,18 +617,22 @@ class Database {
      * @param {*} table
      * @param {*} query
      */
-    read(scope, id) {
+    read(form, id) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 debug('db.read()', id);
                 if (!id) {
                     return null;
                 }
-                const collection = yield this.formCollection(scope);
+                const collection = yield this.formCollection(form);
                 if (!collection) {
                     return null;
                 }
-                return yield collection.findOne(this.query(scope, { _id: this.ObjectId(id) }));
+                const doc = yield collection.findOne(this.query(form, { _id: this.ObjectId(id) }));
+                if (!doc) {
+                    return null;
+                }
+                return doc;
             }
             catch (err) {
                 error(err.message);
@@ -519,25 +646,25 @@ class Database {
      * @param {*} table
      * @param {*} query
      */
-    update(scope_1, id_1, update_1) {
-        return __awaiter(this, arguments, void 0, function* (scope, id, update, allowFields = []) {
+    update(form_1, id_1, update_1) {
+        return __awaiter(this, arguments, void 0, function* (form, id, update, allowFields = []) {
             if (!id || !update) {
                 return null;
             }
             update.modified = new Date();
             try {
                 debug('db.update()', id, update);
-                const collection = yield this.formCollection(scope);
+                const collection = yield this.formCollection(form);
                 if (!collection) {
                     return null;
                 }
-                const result = yield collection.updateOne(this.query(scope, { _id: this.ObjectId(id) }), {
+                const result = yield collection.updateOne(this.query(form, { _id: this.ObjectId(id) }), {
                     $set: (0, lodash_1.pick)(update, ['data', 'metadata', 'modified', 'state'].concat(allowFields))
                 });
                 if (result.modifiedCount === 0) {
                     return null;
                 }
-                return yield this.read(scope, id);
+                return yield this.read(form, id);
             }
             catch (err) {
                 error(err.message);
@@ -548,25 +675,25 @@ class Database {
     /**
      * Delete a record from the database.
      */
-    delete(scope_1, id_1) {
-        return __awaiter(this, arguments, void 0, function* (scope, id, hard = false) {
+    delete(form_1, id_1) {
+        return __awaiter(this, arguments, void 0, function* (form, id, hard = false) {
             if (!id) {
                 return false;
             }
             try {
                 debug('db.delete()', id, hard ? '(hard)' : '(soft)');
-                const collection = yield this.formCollection(scope);
+                const collection = yield this.formCollection(form);
                 if (!collection) {
                     return false;
                 }
                 if (hard) {
                     // Hard delete - completely remove the record from the database
-                    const result = yield collection.deleteOne(this.query(scope, { _id: this.ObjectId(id) }, true));
+                    const result = yield collection.deleteOne(this.query(form, { _id: this.ObjectId(id) }, true));
                     return result.deletedCount > 0;
                 }
                 else {
                     // Soft delete - set deleted timestamp
-                    const result = yield collection.updateOne(this.query(scope, { _id: this.ObjectId(id) }), {
+                    const result = yield collection.updateOne(this.query(form, { _id: this.ObjectId(id) }), {
                         $set: {
                             deleted: new Date(),
                             modified: new Date()
@@ -610,15 +737,14 @@ class Database {
      *  - If the value is not unique, it returns the id of the non-unique submission.
      *  - If an error occurs, or uniqueness cannot be determined, it will throw an error.
      *
-     * @param scope
+     * @param form
      * @param context
      * @param value
      * @returns
      */
-    isUnique(scope, context, value) {
+    isUnique(form, component, submission, componentPath, value) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { component, submission, form } = context;
-            const path = `data.${context.path}`;
+            const path = `data.${componentPath}`;
             if (!form) {
                 return false;
             }
@@ -666,8 +792,8 @@ class Database {
             // Perform the query.
             let result = null;
             try {
-                result = yield this.findOne(scope, query, options);
-                if (!result || ((result === null || result === void 0 ? void 0 : result._id.toString()) === (submission === null || submission === void 0 ? void 0 : submission._id))) {
+                result = yield this.findOne(form, query, options);
+                if (!(result === null || result === void 0 ? void 0 : result._id) || ((result === null || result === void 0 ? void 0 : result._id.toString()) === (submission === null || submission === void 0 ? void 0 : submission._id))) {
                     return true;
                 }
                 else {
@@ -683,8 +809,8 @@ class Database {
                         $options: 'i'
                     }, query, path);
                     try {
-                        result = yield this.findOne(scope, query);
-                        if (!result || ((result === null || result === void 0 ? void 0 : result._id.toString()) === (submission === null || submission === void 0 ? void 0 : submission._id))) {
+                        result = yield this.findOne(form, query);
+                        if (!(result === null || result === void 0 ? void 0 : result._id) || ((result === null || result === void 0 ? void 0 : result._id.toString()) === (submission === null || submission === void 0 ? void 0 : submission._id))) {
                             return true;
                         }
                         else {