@formio/appserver 2.0.0-rc.8 → 2.0.0

package/lib/actions/role/RoleAction.d.ts

@@ -1,61 +1,2 @@
-import { SubmissionRequest, SubmissionResponse, ActionScope } from "@formio/appserver-types";
-import { NextFunction } from "express";
-export declare const RoleAction: {
-    readonly info: {
-        name: string;
-        title: string;
-        description: string;
-        priority: number;
-        defaults: {
-            handler: string[];
-            method: string[];
-        };
-        access: {
-            handler: boolean;
-            method: boolean;
-        };
-    };
-    /**
-     * The settings form for this action.
-     * @param {*} scope
-     */
-    settingsForm(scope: 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;
-        };
-    })[]>;
-    /**
-     * Returns the action middleware.
-     *
-     * @param {*} scope
-     */
-    executor(scope: ActionScope): Promise<(req: SubmissionRequest, res: SubmissionResponse, next: NextFunction) => Promise<void | SubmissionResponse>>;
-};
+import { Action } from "@formio/appserver-core";
+export declare const RoleAction: Action;

package/lib/actions/role/RoleAction.js

@@ -30,12 +30,9 @@ exports.RoleAction = {
             }
         };
     },
-    /**
-     * The settings form for this action.
-     * @param {*} scope
-     */
-    settingsForm(scope) {
+    settingsForm(form) {
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             return [
                 {
                     type: 'select',
@@ -97,7 +94,7 @@ exports.RoleAction = {
                     placeholder: 'Select the Role that this action will Add or Remove.',
                     template: '<span>{{ item.title }}</span>',
                     dataSrc: 'json',
-                    data: { json: Object.values(scope.template.roles) },
+                    data: { json: Object.values(((_a = form.project.template) === null || _a === void 0 ? void 0 : _a.roles) || {}) },
                     valueProperty: '_id',
                     multiple: false,
                     validate: {
@@ -107,47 +104,43 @@ exports.RoleAction = {
             ];
         });
     },
-    /**
-     * Returns the action middleware.
-     *
-     * @param {*} scope
-     */
-    executor(scope) {
+    executor(form, action, handler, method) {
         return __awaiter(this, void 0, void 0, function* () {
             return (req, res, next) => __awaiter(this, void 0, void 0, function* () {
+                var _a, _b;
                 debug('Role Action');
                 // Check the submission for the submissionId.
-                if (scope.action.settings.association !== 'existing' && scope.action.settings.association !== 'new') {
+                if (action.settings.association !== 'existing' && action.settings.association !== 'new') {
                     error('Invalid setting `association` for the RoleAction; expecting `new` or `existing`.');
                     return res.status(400).send('Invalid setting `association` for the RoleAction; expecting `new` or `existing`.');
                 }
                 // Error if operation type is not valid.
-                if (!scope.action.settings.type || (scope.action.settings.type !== 'add' && scope.action.settings.type !== 'remove')) {
+                if (!action.settings.type || (action.settings.type !== 'add' && action.settings.type !== 'remove')) {
                     error('Invalid setting `type` for the RoleAction; expecting `add` or `remove`.');
                     return res.status(400).send('Invalid setting `type` for the RoleAction; expecting `add` or `remove`.');
                 }
                 // Error if no resource is being returned.
-                if (scope.action.settings.association === 'new' && res.hasOwnProperty('resource') && !res.resource.item && scope.action.settings.role) {
+                if (action.settings.association === 'new' && res.hasOwnProperty('resource') && !((_a = res.resource) === null || _a === void 0 ? void 0 : _a.item) && action.settings.role) {
                     error('Invalid resource was provided for RoleAction association of `new`.');
                     return res.status(400).send('Invalid resource was provided for RoleAction association of `new`.');
                 }
                 // Error if association is existing and valid data was not provided.
-                if (scope.action.settings.association === 'existing' && !scope.action.settings.role) {
+                if (action.settings.association === 'existing' && !action.settings.role) {
                     error('Missing role for RoleAction association of "existing". Must specify role to assign in action settings or a form component named "role"');
                     return res.status(400).send('Missing role for RoleAction association of "existing". Must specify role to assign in action settings or a form component named "role"');
                 }
-                if (scope.action.settings.association === 'existing' && !res.resource.item) {
+                if (action.settings.association === 'existing' && !((_b = res.resource) === null || _b === void 0 ? void 0 : _b.item)) {
                     error('Missing submission for RoleAction association of "existing:. Form must have a resource field named "submission".');
                     return res.status(400).send('Missing submission for RoleAction association of "existing:. Form must have a resource field named "submission".');
                 }
                 // Determine the resources based on the current request.
                 let resource = res.resource ? (res.resource.item || req.body) : req.body;
-                let role = scope.utils.roleId(scope, scope.action.settings.role);
+                let role = form.project.roleId(action.settings.role);
                 if (!resource.roles) {
                     resource.roles = [];
                 }
                 const roleIndex = resource.roles.indexOf(role);
-                switch (scope.action.settings.type) {
+                switch (action.settings.type) {
                     case 'add':
                         if (roleIndex !== -1) {
                             return next();
@@ -163,7 +156,7 @@ exports.RoleAction = {
                 }
                 debug('Updating user with roles', resource.roles);
                 // Update the user.
-                yield scope.db.update(scope, resource._id, resource, ['roles']);
+                yield form.saveSubmission(resource, ['roles']);
                 next();
             });
         });

package/lib/actions/save/SaveAction.d.ts

@@ -1,28 +1,2 @@
-import { ActionScope, SubmissionRequest, SubmissionResponse } from '@formio/appserver-types';
-import { NextFunction } from 'express';
-export declare const SaveAction: {
-    readonly info: {
-        name: string;
-        title: string;
-        description: string;
-        priority: number;
-        defaults: {
-            handler: string[];
-            method: string[];
-        };
-        access: {
-            handler: boolean;
-            method: boolean;
-        };
-    };
-    mappingComponents(scope: ActionScope): Promise<any>;
-    /**
-     * The settings form for this action.
-     * @param {*} scope
-     */
-    settingsForm(scope: ActionScope): Promise<any>;
-    saveToForm(scope: ActionScope, resource: string): undefined;
-    childSubmission(scope: ActionScope, req: SubmissionRequest, res: SubmissionResponse, submission: any): any;
-    childResponse(scope: ActionScope, req: SubmissionRequest, res: SubmissionResponse): void;
-    executor(scope: ActionScope): Promise<(req: SubmissionRequest, res: SubmissionResponse, next: NextFunction) => Promise<void>>;
-};
+import { Action } from '@formio/appserver-core';
+export declare const SaveAction: Action;

package/lib/actions/save/SaveAction.js

@@ -18,6 +18,7 @@ const set_1 = __importDefault(require("lodash/set"));
 const has_1 = __importDefault(require("lodash/has"));
 const get_1 = __importDefault(require("lodash/get"));
 const async_1 = __importDefault(require("async"));
+const appserver_core_1 = require("@formio/appserver-core");
 const debug = require('debug')('formio:actions:save');
 const error = require('debug')('formio:error');
 exports.SaveAction = {
@@ -38,8 +39,9 @@ exports.SaveAction = {
             }
         };
     },
-    mappingComponents(scope) {
+    mappingComponents(form) {
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             const components = [
                 {
                     type: 'select',
@@ -76,8 +78,8 @@ exports.SaveAction = {
                     ]
                 }
             ];
-            for (let key in scope.template.resources) {
-                const form = scope.template.resources[key];
+            for (let key in (_a = form.project.template) === null || _a === void 0 ? void 0 : _a.resources) {
+                const resource = form.project.template.resources[key];
                 const mappings = {
                     title: 'Simple Mappings',
                     label: 'Simple Mappings',
@@ -88,13 +90,13 @@ exports.SaveAction = {
                     components: []
                 };
                 const toFields = [];
-                yield scope.utils.eachComponentAsync(form.components, (component) => {
+                appserver_core_1.Utils.eachComponent(resource.components, (component) => {
                     if (['button'].indexOf(component.type) !== -1) {
                         return;
                     }
                     toFields.push({ label: component.label || component.key, value: component.key });
                 });
-                yield scope.utils.eachComponentAsync(scope.form.components, (component) => {
+                appserver_core_1.Utils.eachComponent(resource.components, (component) => {
                     if (['button'].indexOf(component.type) !== -1) {
                         return;
                     }
@@ -112,16 +114,13 @@ exports.SaveAction = {
             return components;
         });
     },
-    /**
-     * The settings form for this action.
-     * @param {*} scope
-     */
-    settingsForm(scope) {
+    settingsForm(form) {
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
             const resources = [];
-            for (let name in scope.template.resources) {
+            for (let name in (_a = form.project.template) === null || _a === void 0 ? void 0 : _a.resources) {
                 resources.push({
-                    label: scope.template.resources[name].title,
+                    label: (_b = form.project.template) === null || _b === void 0 ? void 0 : _b.resources[name].title,
                     value: name
                 });
             }
@@ -168,7 +167,7 @@ exports.SaveAction = {
                                 }
                             ]
                         }
-                    ].concat(yield exports.SaveAction.mappingComponents(scope))
+                    ].concat(yield exports.SaveAction.mappingComponents(form))
                 },
                 {
                     type: 'panel',
@@ -211,31 +210,12 @@ exports.SaveAction = {
             ];
         });
     },
-    saveToForm(scope, resource) {
-        let saveTo;
-        (0, each_1.default)(scope.template.resources, (form) => {
-            if (form.key === resource) {
-                saveTo = form;
-                return false;
-            }
-        });
-        if (!saveTo) {
-            (0, each_1.default)(scope.template.forms, (form) => {
-                if (form.key === resource) {
-                    saveTo = form;
-                    return false;
-                }
-            });
-        }
-        return saveTo;
-    },
     // Create a child submission.
-    childSubmission(scope, req, res, submission) {
-        const { action } = scope;
+    childSubmission(action, req, res, form, submission) {
         let childSub = { data: {} };
         if (action.settings.mapping) {
             try {
-                childSub = scope.utils.evaluate(action.settings.mapping, scope.utils.evalContext(Object.assign(Object.assign({}, scope), { body: req.body }), req, res), 'body');
+                childSub = appserver_core_1.Utils.evaluate(action.settings.mapping, appserver_core_1.Utils.evalContext(form, req.body, req.auth, req.headers, req.findQuery), 'body');
             }
             catch (err) {
                 console.log(`Error in mapping transform: ${err.message}`);
@@ -254,7 +234,7 @@ exports.SaveAction = {
         childSub.metadata = submission.metadata;
         if (action.settings.transform) {
             try {
-                childSub.data = scope.utils.evaluate(action.settings.transform, scope.utils.evalContext(scope, req, res), 'data');
+                childSub.data = appserver_core_1.Utils.evaluate(action.settings.transform, appserver_core_1.Utils.evalContext(form, req.body, req.auth, req.headers, req.findQuery), 'data');
             }
             catch (err) {
                 console.log(`Error in submission transform: ${err.message}`);
@@ -263,9 +243,8 @@ exports.SaveAction = {
         return childSub;
     },
     // Set the child response
-    childResponse(scope, req, res) {
+    childResponse(action, req, res, form, submission) {
         var _a, _b;
-        const { action } = scope;
         if ((_a = res.resource) === null || _a === void 0 ? void 0 : _a.item) {
             // Set the action in the property.
             if ((_b = action.settings) === null || _b === void 0 ? void 0 : _b.property) {
@@ -284,7 +263,7 @@ exports.SaveAction = {
             // Allow for a response mapping.
             if (action.settings.response) {
                 try {
-                    res.resource.item = scope.utils.evaluate(action.settings.response, scope.utils.evalContext(Object.assign(Object.assign({}, scope), { response: res.resource.item }), req, res), 'response');
+                    res.resource.item = appserver_core_1.Utils.evaluate(action.settings.response, Object.assign(Object.assign({}, appserver_core_1.Utils.evalContext(form, req.body, req.auth, req.headers, req.findQuery)), { response: res.resource.item }), 'response');
                 }
                 catch (err) {
                     console.log(`Error in mapping transform: ${err.message}`);
@@ -292,9 +271,8 @@ exports.SaveAction = {
             }
         }
     },
-    executor(scope) {
+    executor(form, action, handler, method) {
         return __awaiter(this, void 0, void 0, function* () {
-            const action = scope.action;
             return (req, res, next) => __awaiter(this, void 0, void 0, function* () {
                 var _a;
                 debug('Save Action');
@@ -305,28 +283,32 @@ exports.SaveAction = {
                 // If this is saving to another resource, then we need to use those handlers instead.
                 if ((_a = action.settings) === null || _a === void 0 ? void 0 : _a.resource) {
                     debug('Saving to resource: ' + action.settings.resource);
-                    const saveTo = exports.SaveAction.saveToForm(scope, action.settings.resource);
+                    const saveTo = yield form.project.getForm(action.settings.resource);
                     if (saveTo) {
                         if (!saveTo.handlers) {
                             error('Cannot find resource handlers.');
                             return next('Cannot find resource handlers.');
                         }
                         const handlers = req.method === 'PUT' ? saveTo.handlers.update : saveTo.handlers.create;
-                        const childReq = scope.utils.childRequest(req);
-                        childReq.body = exports.SaveAction.childSubmission(scope, req, res, childReq.body);
+                        const childReq = appserver_core_1.Utils.childRequest(req);
+                        if (!childReq) {
+                            error('Failed to create child request');
+                            return next('Failed to create child request');
+                        }
+                        childReq.body = exports.SaveAction.childSubmission(action, req, res, saveTo, childReq.body);
                         return async_1.default.series(handlers.map((handler) => async_1.default.apply(handler, childReq, res)), (err) => {
                             if (err) {
                                 error(err);
                                 return next(err);
                             }
                             // Set the child response based on the response of the subform.
-                            exports.SaveAction.childResponse(scope, req, res);
+                            exports.SaveAction.childResponse(action, req, res, saveTo, childReq.body);
                             next();
                         });
                     }
                 }
                 // Save the submission.
-                req.scope.saveSubmission = true;
+                req.saveSubmission = true;
                 debug('Saving submission');
                 return next();
             });

package/lib/modules/index.d.ts

@@ -1,3 +1 @@
-import { Database } from './mongodb/db';
-import { Auth } from '@formio/appserver-auth-jwt';
-export { Database, Auth };
+export { Database } from './mongodb/db';

package/lib/modules/index.js

@@ -1,7 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Auth = exports.Database = void 0;
-const db_1 = require("./mongodb/db");
+exports.Database = void 0;
+var db_1 = require("./mongodb/db");
 Object.defineProperty(exports, "Database", { enumerable: true, get: function () { return db_1.Database; } });
-const appserver_auth_jwt_1 = require("@formio/appserver-auth-jwt");
-Object.defineProperty(exports, "Auth", { enumerable: true, get: function () { return appserver_auth_jwt_1.Auth; } });

package/lib/modules/mongodb/db.d.ts

@@ -1,12 +1,6 @@
 import { Collection, Document, Db, FindOptions, MongoClient } from 'mongodb';
-import { DBConfig, ServerDB, FormScope } from '@formio/appserver-types';
-import { ValidationContext } from '@formio/core/types';
-export type DatabaseIndexResponse = {
-    items: Document[];
-    count: number;
-    skip: number;
-    limit: number;
-};
+import { Component, Submission } from '@formio/core';
+import { ServerDB, DBConfig, AppServerForm, DatabaseIndexResponse } from '@formio/appserver-core';
 export declare class Database implements ServerDB {
     config: DBConfig;
     db: Db | null;
@@ -15,103 +9,108 @@ export declare class Database implements ServerDB {
     currentCollection: Collection<Document> | null;
     defaultCollection: Collection<Document> | null;
     prefix: string;
+    authQuery: any;
     constructor(config: DBConfig);
     ObjectId(id: any): any;
     collectionName(name: string): string;
     /**
      * Connect to the database.
-     * @param {*} scope
      * @returns
      */
     connect(prefix?: string): Promise<void>;
     close(): Promise<void>;
     collection(name: string): Collection<Document> | null;
-    save(collectionName: string, item: any): Promise<import("mongodb").WithId<Document> | null>;
-    saveOne(collectionName: string, item: any): Promise<import("mongodb").WithId<Document> | null>;
-    load(collectionName: string, query?: {}): Promise<import("mongodb").WithId<Document> | null | undefined>;
-    remove(collectionName: string, query?: {}): Promise<number | null>;
+    save(collectionName: string, item: any): Promise<any | null>;
+    saveOne(collectionName: string, item: any): Promise<any>;
+    load(collectionName: string, dbQuery?: {}): Promise<any | null>;
+    indexAuth(query: any): void;
+    getQueryValue(name: string, value: string, selector: string): string | boolean | Date | null;
+    /**
+     * Converts the url query to query parameters.
+     * @param query
+     * @returns
+     */
+    dbQuery(query?: Record<string, string>): any;
+    remove(collectionName: string, dbQuery?: {}): Promise<number | null>;
     /**
      * Ensures the form collection is created an returns it.
-     * @param scope
      * @returns
      */
-    formCollection(scope: FormScope): Promise<Collection<Document> | null>;
+    formCollection(form: AppServerForm): Promise<Collection<Document> | null>;
     /**
      * Setup indexes.
      */
-    setupIndexes(collection: Collection<Document> | null, scope?: FormScope): Promise<void>;
+    setupIndexes(collection: Collection<Document> | null, form?: AppServerForm): Promise<void>;
     /**
      * Add a field index
      */
     addIndex(collection: Collection<Document> | null, path: string): Promise<void>;
     /**
      * Adds new indexes to the forms submission collection.
-     * @param scope
      * @param indexes
      * @returns
      */
-    addIndexes(scope: FormScope, indexes: string[]): Promise<void>;
+    addIndexes(form: AppServerForm, indexes: string[]): Promise<void>;
     /**
      * Remove a field index.
      */
     removeIndex(collection: Collection<Document>, path: string): Promise<void>;
     /**
      * Removes indexes to the forms submission collection.
-     * @param scope
      * @param indexes
      * @returns
      */
-    removeIndexes(scope: FormScope, indexes: string[]): Promise<void>;
+    removeIndexes(form: AppServerForm, indexes: string[]): Promise<void>;
     /**
      * Fetch a list of submissions from a table/collection.
      * @param {*} table
      * @param {*} query
      */
-    index(scope: FormScope, query?: any, collection?: Collection<Document> | null): Promise<DatabaseIndexResponse>;
+    index(form: AppServerForm, urlQuery?: any, collection?: Collection<Document> | null): Promise<DatabaseIndexResponse<Submission>>;
     /**
      * Perform a count of the amount of documents within a collection.
-     * @param scope
+     * @param form
      * @param query
      * @returns
      */
-    count(scope: FormScope, query?: any, inCollection?: Collection<Document> | null, includeDeleted?: boolean): Promise<number>;
+    count(form: AppServerForm, dbQuery?: any, inCollection?: Collection<Document> | null, includeDeleted?: boolean): Promise<number>;
     /**
      * Create a new record.
      */
-    create(scope: FormScope, record: any, allowFields?: string[]): Promise<import("mongodb").WithId<Document> | null | undefined>;
+    create(form: AppServerForm, record: any, allowFields?: string[]): Promise<Submission | null>;
     /**
      * Return a query for a single mongo record.
      * @param {*} form
      * @param {*} id
      * @returns
      */
-    query(scope: FormScope, query?: any, includeAll?: boolean): any;
+    query(form: AppServerForm, query?: any, includeAll?: boolean): any;
     /**
      * Find many records that match a query.
      */
-    find(scope: FormScope, query?: any, limit?: number, skip?: number, sort?: any, select?: any, inCollection?: Collection<Document> | null, includeDeleted?: boolean): Promise<Document[]>;
+    find(form: AppServerForm, dbQuery?: any, limit?: number, skip?: number, sort?: any, select?: any, inCollection?: Collection<Document> | null, includeDeleted?: boolean): Promise<any | null>;
     /**
      * Find a record for a provided query.
      */
-    findOne(scope: FormScope, query?: any, options?: FindOptions<Document>): Promise<import("mongodb").WithId<Document> | null>;
+    findOne(form: AppServerForm, dbQuery?: any, options?: FindOptions<Document>): Promise<Submission | null>;
     /**
      * Read a single submission from a form
      *
      * @param {*} table
      * @param {*} query
      */
-    read(scope: FormScope, id: string | undefined): Promise<import("mongodb").WithId<Document> | null>;
+    read(form: AppServerForm, id: string | undefined): Promise<Submission | null>;
     /**
      * Update a single submission of a form.
      *
      * @param {*} table
      * @param {*} query
      */
-    update(scope: FormScope, id: string | undefined, update: any, allowFields?: string[]): Promise<import("mongodb").WithId<Document> | null>;
+    update(form: AppServerForm, id: string | undefined, update: any, allowFields?: string[]): Promise<Submission | null>;
     /**
      * Delete a record from the database.
      */
-    delete(scope: FormScope, id: string | undefined, hard?: boolean): Promise<boolean>;
+    delete(form: AppServerForm, id: string | undefined, hard?: boolean): Promise<boolean>;
     addPathQueryParams(pathQueryParams: any, query: any, path: string): void;
     /**
      * Performs a unique query on the database to see if a value is unique.
@@ -119,10 +118,10 @@ export declare class Database implements ServerDB {
      *  - 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: FormScope, context: ValidationContext, value: any): Promise<boolean | string>;
+    isUnique(form: AppServerForm, component: Component, submission: Submission, componentPath: string, value: any): Promise<boolean | string>;
 }