@formio/appserver 2.0.0-rc.1 → 2.0.0-rc.3

package/README.md

@@ -170,12 +170,18 @@ const { CustomAction } = require('./actions/custom');
          * 
          * The "scope" argument is a ProcessScope type. See https://github.com/formio/appserver/blob/main/src/types/submission.ts
          */
-        processors: Processor.processors.concat([
-            async (scope) => {
-                console.log('Custom Processor');
-                return [];
-            },
-        ])
+        processors: {
+            submission: [
+                (scope) => {},
+                (scope) => {}
+            ],
+            evaluator: [
+                (scope) => {}
+            ],
+            prepare: [
+                (scope) => {}
+            ]
+        }
     });
 
     // Initialize the server.

package/lib/actions/index.d.ts

@@ -14,12 +14,12 @@ declare const _default: {
                 method: boolean;
             };
         };
-        mappingComponents(scope: import("src/types/lib").ActionScope): Promise<any>;
-        settingsForm(scope: import("src/types/lib").ActionScope): Promise<any>;
-        saveToForm(scope: import("src/types/lib").ActionScope, resource: string): undefined;
-        childSubmission(scope: import("src/types/lib").ActionScope, req: import("src/types/lib").SubmissionRequest, res: import("src/types/lib").SubmissionResponse, submission: any): any;
-        childResponse(scope: import("src/types/lib").ActionScope, req: import("src/types/lib").SubmissionRequest, res: import("src/types/lib").SubmissionResponse): void;
-        executor(scope: import("src/types/lib").ActionScope): Promise<(req: import("src/types/lib").SubmissionRequest, res: import("src/types/lib").SubmissionResponse, next: import("express").NextFunction) => Promise<void>>;
+        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: {
@@ -36,7 +36,7 @@ declare const _default: {
                 method: boolean;
             };
         };
-        settingsForm(scope: import("src/types/lib").ActionScope): Promise<({
+        settingsForm(scope: import("@formio/appserver-types").ActionScope): Promise<({
             type: string;
             label: string;
             key: string;
@@ -102,8 +102,8 @@ declare const _default: {
             validate?: undefined;
         })[]>;
         waitText(time: number): string;
-        checkAttempts(scope: import("src/types/lib").ActionScope, error: any, user: import("src/types/lib").User): Promise<any>;
-        executor(scope: import("src/types/lib").ActionScope): Promise<(req: import("src/types/lib").SubmissionRequest, res: import("src/types/lib").SubmissionResponse, next: import("express").NextFunction) => Promise<void>>;
+        checkAttempts(scope: import("@formio/appserver-types").ActionScope, error: any, user: import("@formio/core").Submission): 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: {
@@ -120,7 +120,7 @@ declare const _default: {
                 method: boolean;
             };
         };
-        settingsForm(scope: import("src/types/lib").ActionScope): Promise<({
+        settingsForm(scope: import("@formio/appserver-types").ActionScope): Promise<({
             type: string;
             input: boolean;
             label: string;
@@ -153,7 +153,7 @@ declare const _default: {
                 required: boolean;
             };
         })[]>;
-        executor(scope: import("src/types/lib").ActionScope): Promise<(req: import("src/types/lib").SubmissionRequest, res: import("src/types/lib").SubmissionResponse, next: import("express").NextFunction) => Promise<void | import("src/types/lib").SubmissionResponse>>;
+        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 default _default;

package/lib/actions/login/LoginAction.d.ts

@@ -1,5 +1,6 @@
 import { NextFunction } from 'express';
-import { ActionScope, User, SubmissionRequest, SubmissionResponse } from '@formio/appserver-types';
+import { ActionScope, SubmissionRequest, SubmissionResponse } from '@formio/appserver-types';
+import { Submission } from '@formio/core/types';
 export declare const LoginAction: {
     readonly info: {
         name: string;
@@ -98,7 +99,7 @@ export declare const LoginAction: {
      * @param next
      * @returns {*}
      */
-    checkAttempts(scope: ActionScope, error: any, user: User): Promise<any>;
+    checkAttempts(scope: ActionScope, error: any, user: Submission): Promise<any>;
     /**
      * Returns the action middleware.
      *

package/lib/actions/login/LoginAction.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/actions/login/LoginAction.spec.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const LoginAction_1 = require("./LoginAction");
+const assert_1 = __importDefault(require("assert"));
+describe('LoginAction', () => {
+    it('Validate the LoginAction information', () => {
+        const info = LoginAction_1.LoginAction.info;
+        assert_1.default.equal(info.name, 'login');
+        assert_1.default.equal(info.title, 'Login');
+    });
+    it('TO-DO: Write tests for LoginAction');
+});

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

@@ -0,0 +1 @@
+export {};

package/lib/actions/role/RoleAction.spec.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const RoleAction_1 = require("./RoleAction");
+const assert_1 = __importDefault(require("assert"));
+describe('RoleAction', () => {
+    it('Validate the RoleAction information', () => {
+        const info = RoleAction_1.RoleAction.info;
+        assert_1.default.equal(info.name, 'role');
+        assert_1.default.equal(info.title, 'Role Assignment');
+    });
+    it('TO-DO: Write tests for RoleAction');
+});

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

@@ -0,0 +1 @@
+export {};

package/lib/actions/save/SaveAction.spec.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const SaveAction_1 = require("./SaveAction");
+const assert_1 = __importDefault(require("assert"));
+describe('SaveAction', () => {
+    it('Validate the SaveAction information', () => {
+        const info = SaveAction_1.SaveAction.info;
+        assert_1.default.equal(info.name, 'save');
+        assert_1.default.equal(info.title, 'Save Submission');
+    });
+    it('TO-DO: Write tests for SaveAction');
+});

package/lib/modules/auth/auth.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/modules/auth/auth.spec.js

@@ -0,0 +1,93 @@
+"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 });
+const auth_1 = require("./auth");
+const assert_1 = __importDefault(require("assert"));
+describe('Auth', () => {
+    const user = {
+        user: {
+            _id: 'test',
+            data: {
+                firstName: 'Joe',
+                lastName: 'Smith',
+                email: 'joe@example.com'
+            },
+            roles: [
+                '1234',
+                '2468'
+            ],
+            form: '234234243234234234',
+            project: '213312131213212334'
+        },
+        form: {
+            _id: '234234243234234234'
+        },
+        project: {
+            _id: '213312131213212334'
+        }
+    };
+    let token = '';
+    it('Should return a valid auth token for a valid user', () => __awaiter(void 0, void 0, void 0, function* () {
+        const auth = new auth_1.Auth();
+        token = yield auth.token(user, 'test', 240);
+        (0, assert_1.default)(token, 'It must generate a valid token');
+    }));
+    it('Should validate that the token is valid', () => __awaiter(void 0, void 0, void 0, function* () {
+        const auth = new auth_1.Auth();
+        const tokenUser = yield auth.user(token, 'test');
+        (0, assert_1.default)(tokenUser === null || tokenUser === void 0 ? void 0 : tokenUser.iat, 'It must have an iat');
+        (0, assert_1.default)(tokenUser === null || tokenUser === void 0 ? void 0 : tokenUser.exp, 'It must have an exp');
+        tokenUser === null || tokenUser === void 0 ? true : delete tokenUser.iat;
+        tokenUser === null || tokenUser === void 0 ? true : delete tokenUser.exp;
+        assert_1.default.deepEqual(tokenUser, user);
+    }));
+    it('Should throw an error with "Bad Token" for an invalid token', () => __awaiter(void 0, void 0, void 0, function* () {
+        const auth = new auth_1.Auth();
+        try {
+            yield auth.user('invalid', 'test');
+        }
+        catch (err) {
+            assert_1.default.equal(err.message, 'Bad Token');
+        }
+    }));
+    it('Should throw an error with "Token Expired" for an expired token', () => __awaiter(void 0, void 0, void 0, function* () {
+        const auth = new auth_1.Auth();
+        token = yield auth.token(user, 'test', 0);
+        try {
+            yield auth.user(token, 'test');
+        }
+        catch (err) {
+            assert_1.default.equal(err.message, 'Token Expired');
+        }
+    }));
+    it('Should throw an error for a token without a secret', () => __awaiter(void 0, void 0, void 0, function* () {
+        const auth = new auth_1.Auth();
+        try {
+            yield auth.token(user, '');
+        }
+        catch (err) {
+            assert_1.default.equal(err.message, 'You cannot generate a token without a secret!');
+        }
+    }));
+    it('Should throw an error for a token with the wrong secret', () => __awaiter(void 0, void 0, void 0, function* () {
+        const auth = new auth_1.Auth();
+        token = yield auth.token(user, 'test', 0);
+        try {
+            yield auth.user(token, '1234');
+        }
+        catch (err) {
+            assert_1.default.equal(err.message, 'Bad Token');
+        }
+    }));
+});

package/lib/modules/index.d.ts

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

package/lib/modules/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Auth = exports.Database = void 0;
-const appserver_db_mongodb_1 = require("@formio/appserver-db-mongodb");
-Object.defineProperty(exports, "Database", { enumerable: true, get: function () { return appserver_db_mongodb_1.Database; } });
+const 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

@@ -0,0 +1,128 @@
+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;
+};
+export declare class Database implements ServerDB {
+    config: DBConfig;
+    db: Db | null;
+    client: MongoClient | null;
+    currentCollectionName: string;
+    currentCollection: Collection<Document> | null;
+    defaultCollection: Collection<Document> | null;
+    prefix: string;
+    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>;
+    /**
+     * Ensures the form collection is created an returns it.
+     * @param scope
+     * @returns
+     */
+    formCollection(scope: FormScope): Promise<Collection<Document> | null>;
+    /**
+     * Setup indexes.
+     */
+    setupIndexes(collection: Collection<Document> | null, scope?: FormScope): 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>;
+    /**
+     * 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>;
+    /**
+     * Fetch a list of submissions from a table/collection.
+     * @param {*} table
+     * @param {*} query
+     */
+    index(scope: FormScope, query?: any, collection?: Collection<Document> | null): Promise<DatabaseIndexResponse>;
+    /**
+     * Perform a count of the amount of documents within a collection.
+     * @param scope
+     * @param query
+     * @returns
+     */
+    count(scope: FormScope, query?: 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>;
+    /**
+     * Return a query for a single mongo record.
+     * @param {*} form
+     * @param {*} id
+     * @returns
+     */
+    query(scope: FormScope, 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 a record for a provided query.
+     */
+    findOne(scope: FormScope, query?: any, options?: FindOptions<Document>): Promise<import("mongodb").WithId<Document> | null>;
+    /**
+     * Read a single submission from a form
+     *
+     * @param {*} table
+     * @param {*} query
+     */
+    read(scope: FormScope, id: string | undefined): Promise<import("mongodb").WithId<Document> | 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>;
+    /**
+     * Delete a record from the database.
+     */
+    delete(scope: FormScope, 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.
+     *  - If the value is unique, it returns true.
+     *  - 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 context
+     * @param value
+     * @returns
+     */
+    isUnique(scope: FormScope, context: ValidationContext, value: any): Promise<boolean | string>;
+}