@tsed/formio 6.87.1 → 6.89.0

package/lib/types/domain/FormioTemplate.d.ts

@@ -0,0 +1,8 @@
+import { FormioActionItem, FormioForm, FormioRole, FormioSubmission } from "./FormioModels";
+export interface FormioTemplate {
+    roles?: Record<string, FormioRole>;
+    forms: Record<string, FormioForm>;
+    resources: Record<string, FormioForm>;
+    actions: Record<string, FormioActionItem>;
+    submissions?: Record<string, FormioSubmission[]>;
+}

package/lib/types/domain/FormioTemplateUtil.d.ts

@@ -0,0 +1,13 @@
+import { FormioTemplate } from "./FormioTemplate";
+export interface FormioExportOptions {
+    title: string;
+    version: string;
+    description: string;
+    name: string;
+}
+export interface FormioTemplateUtil {
+    import: {
+        template(template: FormioTemplate, cb: (er: unknown, data: FormioTemplate) => void): void;
+    };
+    export(options: Partial<FormioExportOptions>, cb: (er: unknown, data: FormioTemplate) => void): void;
+}

package/lib/types/domain/FormioUpdate.d.ts

@@ -0,0 +1,19 @@
+import { NextFunction, Request, Response } from "express";
+import { Db } from "mongodb";
+import { Formio } from "./Formio";
+export interface FormioUpdate {
+    db: Db;
+    version: string;
+    /**
+     *
+     * @param cb
+     */
+    initialize(cb: (err: unknown, db: any) => void): Promise<Formio>;
+    /**
+     *
+     * @param req
+     * @param res
+     * @param next
+     */
+    sanityCheck(req: Request, res: Response, next: NextFunction): void;
+}

package/lib/types/domain/FormioUtils.d.ts

@@ -0,0 +1,307 @@
+import { Request, Response } from "express";
+import { FormioErrors } from "./FormioErrors";
+import { FormioJs } from "./FormioJs";
+export interface FormioUtil {
+    Formio: FormioJs;
+    /**
+     * Iterate through each component within a form.
+     *
+     * @param {Object} components
+     *   The components to iterate.
+     * @param {Function} fn
+     *   The iteration function to invoke for each component.
+     * @param {Boolean} includeAll
+     *   Whether or not to include layout components.
+     * @param {String} path
+     */
+    eachComponent: Function;
+    /**
+     * Get a component by its key
+     *
+     * @param {Object} components
+     *   The components to iterate.
+     * @param {String} key
+     *   The key of the component to get.
+     *
+     * @returns {Object}
+     *   The component that matches the given key, or undefined if not found.
+     */
+    getComponent: Function;
+    /**
+     * Define if component should be considered input component
+     *
+     * @param {Object} componentJson
+     *   JSON of component to check
+     *
+     * @returns {Boolean}
+     *   If component is input or not
+     */
+    isInputComponent: Function;
+    /**
+     * Flatten the form components for data manipulation.
+     *
+     * @param {Object} components
+     *   The components to iterate.
+     * @param {Boolean} includeAll
+     *   Whether or not to include layout components.
+     *
+     * @returns {Object}
+     *   The flattened components map.
+     */
+    flattenComponents: Function;
+    /**
+     * Get the value for a component key, in the given submission.
+     *
+     * @param {Object} submission
+     *   A submission object to search.
+     * @param {String} key
+     *   A for components API key to search for.
+     */
+    getValue: Function;
+    /**
+     * Determine if a component is a layout component or not.
+     *
+     * @param {Object} component
+     *   The component to check.
+     *
+     * @returns {Boolean}
+     *   Whether or not the component is a layout component.
+     */
+    isLayoutComponent: Function;
+    /**
+     * Apply JSON logic functionality.
+     *
+     * @param component
+     * @param row
+     * @param data
+     */
+    jsonLogic: Function;
+    /**
+     * Check if the condition for a component is true or not.
+     *
+     * @param component
+     * @param row
+     * @param data
+     */
+    checkCondition: Function;
+    flattenComponentsForRender: Function;
+    renderFormSubmission: Function;
+    renderComponentValue: Function;
+    /**
+     * A node-fetch shim adding support for http(s) proxy and allowing
+     * invalid tls certificates (to be used with self signed certificates).
+     *
+     * @param {any} url The request url string or url like object.
+     * @param {any} options The request options object.
+     * @returns {Promise<Response>} The promise with the node-fetch response object.
+     */
+    fetch: any;
+    base64: {
+        /**
+         * Base64 encode the given data.
+         *
+         * @param {String} decoded
+         *   The decoded data to encode.
+         *
+         * @return {String}
+         *   The base64 representation of the given data.
+         */
+        encode(decoded: string): string;
+        /**
+         * Base64 decode the given data.
+         *
+         * @param {String} encoded
+         *   The encoded data to decode.
+         *
+         * @return {String}
+         *   The ascii representation of the given encoded data.
+         */
+        decode(encoded: string): string;
+    };
+    /**
+     * Application error codes.
+     */
+    errorCodes: FormioErrors;
+    layoutComponents: ("panel" | "table" | "well" | "columns" | "fieldset" | "tabs" | string)[];
+    deleteProp(target: any, propertyKey: any): any;
+    /**
+     * A wrapper around console.log that gets ignored by eslint.
+     *
+     * @param {*} content
+     *   The content to pass to console.log.
+     */
+    log(content: string): void;
+    /**
+     * Determine if a value is a boolean representation.
+     * @param value
+     * @return {boolean}
+     */
+    isBoolean(value: any): boolean;
+    /**
+     * Quick boolean coercer.
+     * @param value
+     * @return {boolean}
+     */
+    boolean(value: any): boolean;
+    /**
+     * A wrapper around console.error that gets ignored by eslint.
+     *
+     * @param {*} content
+     *   The content to pass to console.error.
+     */
+    error(content: any): void;
+    /**
+     * Returns the URL alias for a form provided the url.
+     */
+    getAlias(req: Request, reservedForms: string[]): {
+        alias: string;
+        additional: string;
+    };
+    /**
+     * Escape a string for use in regex.
+     *
+     * @param str
+     * @returns {*}
+     */
+    escapeRegExp(str: string): string;
+    /**
+     * Create a sub response object that only handles errors.
+     *
+     * @param res
+     * @return {{send: function(), sendStatus: function(*=), status: function(*=)}}
+     */
+    createSubResponse(res: Response): Response;
+    /**
+     * Create a sub-request object from the original request.
+     *
+     * @param req
+     */
+    createSubRequest(req: Request): Request;
+    /**
+     * Return the objectId.
+     *
+     * @param id
+     * @returns {*}
+     * @constructor
+     */
+    ObjectId(id: string): any;
+    /**
+     * Search the request headers for the given key.
+     *
+     * @param req
+     *   The Express request object.
+     * @param key
+     *   The key to search for in the headers.
+     *
+     * @return
+     *   The header value if found or false.
+     */
+    getHeader(req: Request, key: string): string | false;
+    /**
+     * Search the request query for the given key.
+     *
+     * @param req
+     *   The Express request object.
+     * @param key
+     *   The key to search for in the query.
+     *
+     * @return
+     *   The query value if found or false.
+     */
+    getQuery(req: Request, key: string): any | false;
+    /**
+     * Search the request parameters for the given key.
+     *
+     * @param req
+     *   The Express request object.
+     * @param key
+     *   The key to search for in the parameters.
+     *
+     * @return
+     *   The parameter value if found or false.
+     */
+    getParameter(req: Request, key: string): any | false;
+    /**
+     * Determine if the request has the given key set as a header or url parameter.
+     *
+     * @param req
+     *   The Express request object.
+     * @param key
+     *   The key to search for.
+     *
+     * @return
+     *   Return the value of the key or false if not found.
+     */
+    getRequestValue(req: Request, key: string): any | false;
+    /**
+     * Split the given URL into its key/value pairs.
+     *
+     * @param url
+     *   The request url to split, typically req.url.
+     *
+     * @returns {{}}
+     *   The key/value pairs of the request url.
+     */
+    getUrlParams(url: string): Record<string, any>;
+    /**
+     * Converts a form component key into a submission key
+     * by putting .data. between each nested component
+     * (ex: `user.name` becomes `user.data.name` in a submission)
+     * @param key
+     *   The key to convert
+     * @return
+     *   The submission key
+     */
+    getSubmissionKey(key: string): string;
+    /**
+     * Converts a submission key into a form component key
+     * by replacing .data. with .
+     * (ex: `user.data.name` becomes `user.name` in a submission)
+     * @param key
+     *   The key to convert
+     * @return
+     *   The form component key
+     */
+    getFormComponentKey(key: string): string;
+    /**
+     * Utility function to ensure the given id is always a BSON object.
+     *
+     * @param _id {String|Object}
+     *   A mongo id as a string or object.
+     *
+     * @returns {Object}
+     *   The mongo BSON id.
+     */
+    idToBson(_id: string | any): any;
+    /**
+     * Utility function to ensure the given id is always a string object.
+     *
+     * @param _id {String|Object}
+     *   A mongo id as a string or object.
+     *
+     * @returns {String}
+     *   The mongo string id.
+     */
+    idToString(_id: string | any): string;
+    /**
+     * Ensures that a submission data has MongoDB ObjectID's for all "id" fields.
+     * @param data
+     * @return {boolean}
+     */
+    ensureIds(data: any[]): any;
+    removeProtectedFields(form: string, action: string, submissions: any): void;
+    /**
+     * Retrieve a unique machine name
+     *
+     * @param document
+     * @param model
+     * @param next
+     * @return {*}
+     */
+    uniqueMachineName(document: {
+        machineName: string;
+    }, model: any, next: (err?: Error) => void): void;
+    castValue<T = any>(valueType: "string" | "number" | "boolean" | "[number]" | "[string]", value: any): T;
+    valuePath(prefix: string, key: string): string;
+    eachValue(components: any, data: any, fn: Function, context: any, path?: string): void;
+}

package/lib/types/domain/OnHook.d.ts

@@ -0,0 +1,3 @@
+export interface OnHook<T = any> {
+    on(...args: any[]): boolean | void;
+}

package/lib/types/domain/Resource.d.ts

@@ -0,0 +1,18 @@
+import Express from "express";
+export declare type ResourceHttpHandler = (req: Request, res: Response, next: Express.NextFunction) => void;
+export interface ResourceHttpMethodOptions {
+    before?: ResourceHttpHandler;
+    after?: ResourceHttpHandler;
+}
+export interface ResourceRestOptions extends ResourceHttpMethodOptions {
+    beforePut?: ResourceHttpHandler;
+    beforePatch?: ResourceHttpHandler;
+    beforePost?: ResourceHttpHandler;
+    beforeIndex?: ResourceHttpHandler;
+    beforeGet?: ResourceHttpHandler;
+    afterPut?: ResourceHttpHandler;
+    afterPatch?: ResourceHttpHandler;
+    afterPost?: ResourceHttpHandler;
+    afterIndex?: ResourceHttpHandler;
+    afterGet?: ResourceHttpHandler;
+}

package/lib/types/index.d.ts

@@ -0,0 +1,38 @@
+export * from "./decorators/action";
+export * from "./decorators/actionCtx";
+export * from "./decorators/alter";
+export * from "./decorators/on";
+export * from "./decorators/useFormioAuth";
+export * from "./middlewares/FormioAuthMiddleware";
+export * from "./domain/AlterHook";
+export * from "./domain/Formio";
+export * from "./domain/FormioDecodedToken";
+export * from "./domain/FormioAction";
+export * from "./domain/FormioActionsIndex";
+export * from "./domain/FormioAuth";
+export * from "./domain/FormioBaseModel";
+export * from "./domain/FormioConfig";
+export * from "./domain/FormioCtxMapper";
+export * from "./domain/FormioErrors";
+export * from "./domain/FormioHooks";
+export * from "./domain/FormioJs";
+export * from "./domain/FormioModels";
+export * from "./domain/FormioRouter";
+export * from "./domain/FormioSettings";
+export * from "./domain/FormioUpdate";
+export * from "./domain/FormioUtils";
+export * from "./domain/FormioTemplate";
+export * from "./domain/FormioTemplateUtil";
+export * from "./domain/OnHook";
+export * from "./FormioModule";
+export * from "./builder/FormioMapper";
+export * from "./services/FormioService";
+export * from "./services/FormioDatabase";
+export * from "./services/FormioDatabase";
+export * from "./services/FormioAuthService";
+export * from "./services/FormioHooksService";
+export * from "./components/AlterActions";
+export * from "./components/AlterAudit";
+export * from "./components/AlterLog";
+export * from "./components/AlterHost";
+export * from "./components/AlterSkip";

package/lib/types/middlewares/FormioAuthMiddleware.d.ts

@@ -0,0 +1,11 @@
+import { Context } from "@tsed/common";
+import { FormioService } from "../services/FormioService";
+/**
+ * @middleware
+ * @formio
+ */
+export declare class FormioAuthMiddleware {
+    protected formio: FormioService;
+    get tokenHandler(): any;
+    use(ctx: Context): Promise<void>;
+}

package/lib/types/services/FormioAuthService.d.ts

@@ -0,0 +1,54 @@
+/// <reference types="mongoose" />
+import { PlatformContext, Req } from "@tsed/common";
+import { FormioPayloadToken } from "../domain/FormioDecodedToken";
+import { FormioSubmission, WithID } from "../domain/FormioModels";
+import { FormioDatabase } from "./FormioDatabase";
+import { FormioHooksService } from "./FormioHooksService";
+import { FormioService } from "./FormioService";
+export declare class FormioAuthService {
+    formio: FormioService;
+    hooks: FormioHooksService;
+    db: FormioDatabase;
+    get currentUser(): (arg1: Req, arg2: import("@tsed/common").Res) => Promise<unknown>;
+    get getToken(): (payload: FormioPayloadToken) => string | boolean;
+    get tempToken(): (req: Req, res: import("@tsed/common").Res) => void;
+    get logout(): (req: Req, res: import("@tsed/common").Res, next: TsED.NextFunction) => void;
+    setCurrentUser<User = any>(user: WithID<FormioSubmission<User>>, token: FormioPayloadToken, ctx: PlatformContext): this;
+    /**
+     * Generate the payload token for the session
+     * @param user
+     * @param ctx
+     */
+    generatePayloadToken<User = any>(user: WithID<FormioSubmission<User>>, ctx: PlatformContext): Promise<{
+        user: WithID<FormioSubmission<User>>;
+        token: FormioPayloadToken;
+    }>;
+    /**
+     * Generate session from the given authenticated user.
+     * @param user
+     * @param ctx
+     */
+    generateSession<User = any>(user: WithID<FormioSubmission<User>>, ctx: PlatformContext): Promise<void>;
+    /**
+     * Retrieve roles
+     * @param req
+     */
+    getRoles(req?: Req): Promise<import("mongoose").LeanDocument<import("@tsed/mongoose").MongooseMergedDocument<import("mongoose").Document<any, {}> & import("@tsed/formio-types/lib/types/domain/FormioRole").FormioRole & import("@tsed/mongoose").MongooseDocumentMethods<import("@tsed/formio-types/lib/types/domain/FormioRole").FormioRole>>>[]>;
+    /**
+     * Update the role of the current user submission
+     * @param _id
+     * @param role
+     * @param req
+     */
+    updateUserRole(_id: string | any, role: string, req?: Req): Promise<import("@tsed/mongoose").MongooseMergedDocument<import("mongoose").Document<any, {}> & FormioSubmission<any> & import("@tsed/mongoose").MongooseDocumentMethods<FormioSubmission<any>>>>;
+    /**
+     * Create a user submission in formio
+     * @param user
+     */
+    createUser<User = any>(user: Partial<FormioSubmission<User>>): Promise<import("mongoose").LeanDocument<import("mongoose").Document<any, {}> & FormioSubmission<any> & import("@tsed/mongoose").MongooseDocumentMethods<FormioSubmission<any>>>>;
+    /**
+     * Update user submission in formio
+     * @param user
+     */
+    updateUser<User = any>(user: WithID<FormioSubmission<User>>): Promise<WithID<FormioSubmission<User>>>;
+}

package/lib/types/services/FormioDatabase.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="mongoose" />
+import { MongooseModel } from "@tsed/mongoose";
+import { FormioAction, FormioActionItem, FormioForm, FormioRole, FormioSubmission, FormioToken } from "@tsed/formio-types";
+import { FormioMapper } from "../builder/FormioMapper";
+import { FormioService } from "./FormioService";
+export declare class FormioDatabase {
+    protected formio: FormioService;
+    get models(): {
+        [index: string]: import("mongoose").Model<any, {}>;
+    };
+    get roleModel(): MongooseModel<FormioRole>;
+    get formModel(): MongooseModel<FormioForm>;
+    get actionModel(): MongooseModel<FormioAction>;
+    get submissionModel(): MongooseModel<FormioSubmission>;
+    get tokenModel(): MongooseModel<FormioToken>;
+    get actionItemModel(): MongooseModel<FormioActionItem>;
+    getFormioMapper(): Promise<FormioMapper>;
+    hasForms(): Promise<boolean>;
+    hasForm(name: string): Promise<boolean>;
+    getForm(nameOrId: string): Promise<import("mongoose").LeanDocument<import("@tsed/mongoose").MongooseMergedDocument<import("mongoose").Document<any, {}> & FormioForm & import("@tsed/mongoose").MongooseDocumentMethods<FormioForm>>> | null>;
+    createFormIfNotExists(form: FormioForm, onCreate?: (form: FormioForm) => any): Promise<import("mongoose").LeanDocument<import("@tsed/mongoose").MongooseMergedDocument<import("mongoose").Document<any, {}> & FormioForm & import("@tsed/mongoose").MongooseDocumentMethods<FormioForm>>> | null>;
+    saveFormDefinition(form: FormioForm): Promise<import("mongoose").Document<any, {}> & FormioForm & import("@tsed/mongoose").MongooseDocumentMethods<FormioForm>>;
+    idToBson(form?: any): any;
+}

package/lib/types/services/FormioHooksService.d.ts

@@ -0,0 +1,17 @@
+import { InjectorService } from "@tsed/common";
+import { FormioHooks } from "../domain/FormioHooks";
+import { FormioService } from "./FormioService";
+import { Request } from "express";
+export declare class FormioHooksService {
+    protected injector: InjectorService;
+    protected formio: FormioService;
+    get settings(): (req: Request, cb: Function) => void;
+    get invoke(): <T = any>(...args: any[]) => boolean | T;
+    get alter(): (event: string, ...args: any[]) => any;
+    get alterAsync(): (event: string, ...args: any[]) => Promise<any>;
+    getHooks(): FormioHooks;
+    protected getProviders(type: "alter" | "on"): import("@tsed/common").Provider<any>[];
+    protected getHooksProvider(type: "alter" | "on"): {};
+    protected bindHooks(type: "alter" | "on", hooks: Record<string, Function[]>): {};
+    private createHooks;
+}

package/lib/types/services/FormioInstaller.d.ts

@@ -0,0 +1,14 @@
+import { Logger } from "@tsed/logger";
+import { FormioSubmission } from "../domain/FormioModels";
+import { FormioTemplate } from "../domain/FormioTemplate";
+import { FormioDatabase } from "./FormioDatabase";
+import { FormioService } from "./FormioService";
+export declare class FormioInstaller extends FormioDatabase {
+    protected formio: FormioService;
+    protected logger: Logger;
+    install(template: FormioTemplate, root: any): Promise<void>;
+    createRootUser<User = unknown>(user: {
+        email: string;
+        password: string;
+    }, template: FormioTemplate): Promise<FormioSubmission<User>>;
+}

package/lib/types/services/FormioService.d.ts

@@ -0,0 +1,36 @@
+import { InjectorService } from "@tsed/common";
+import { Db } from "mongodb";
+import { Mongoose } from "mongoose";
+import { Formio } from "../domain/Formio";
+import { FormioConfig } from "../domain/FormioConfig";
+import { FormioHook, FormioHooks } from "../domain/FormioHooks";
+import { FormioSchemas } from "../domain/FormioModels";
+import { FormioRouter } from "../domain/FormioRouter";
+import { FormioTemplate } from "../domain/FormioTemplate";
+import { FormioExportOptions } from "../domain/FormioTemplateUtil";
+export declare class FormioService {
+    router: FormioRouter;
+    protected injector: InjectorService;
+    get audit(): Function;
+    get auth(): import("..").FormioAuth;
+    get swagger(): (...args: any[]) => Promise<unknown>;
+    get config(): FormioConfig;
+    get db(): Db;
+    get resources(): any;
+    get mongoose(): Mongoose;
+    get middleware(): import("../domain/Formio").FormioMiddlewares;
+    get schemas(): FormioSchemas;
+    get formio(): Formio;
+    get hook(): FormioHook;
+    get util(): import("..").FormioUtil;
+    get template(): import("../domain/FormioTemplateUtil").FormioTemplateUtil;
+    get Action(): import("..").FormioActionModelCtor;
+    exportTemplate(options?: Partial<FormioExportOptions>): Promise<FormioTemplate>;
+    importTemplate(template: FormioTemplate): Promise<FormioTemplate>;
+    encrypt(text: string): Promise<string>;
+    isInit(): boolean;
+    createRouter(options: FormioConfig): any;
+    init(options: FormioConfig, hooks?: FormioHooks): Promise<Formio> | undefined;
+    protected mapConfiguration(options: FormioConfig): FormioConfig;
+    protected bindLogger(): void;
+}

package/lib/types/utils/isMongoId.d.ts

@@ -0,0 +1 @@
+export declare function isMongoId(text: string): RegExpMatchArray | null;

package/package.json

@@ -1,10 +1,7 @@
 {
   "name": "@tsed/formio",
-  "version": "6.87.1",
+  "version": "6.89.0",
   "description": "Formio package for Ts.ED framework",
-  "source": "./src/index.ts",
-  "main": "./lib/index.js",
-  "typings": "./lib/index.d.ts",
   "private": false,
   "keywords": [
     "Formio",
@@ -14,30 +11,41 @@
     "decorators",
     "express"
   ],
+  "source": "./src/index.ts",
+  "main": "./lib/cjs/index.js",
+  "typings": "./lib/types/index.d.ts",
+  "exports": {
+    "types": "./lib/types/index.d.ts",
+    "import": "./lib/esm/index.js",
+    "require": "./lib/cjs/index.js",
+    "default": "./lib/esm/index.js"
+  },
   "scripts": {
-    "build": "tsc --build tsconfig.compile.json",
+    "build": "yarn run build:esm && yarn run build:cjs",
+    "build:cjs": "tsc --build tsconfig.compile.json",
+    "build:esm": "tsc --build tsconfig.compile.esm.json",
     "start": "ts-node -r tsconfig-paths/register test/app/index.ts",
     "test": "cross-env NODE_ENV=test nyc mocha"
   },
   "dependencies": {
-    "@tsed/formio-types": "6.87.1",
+    "@tsed/formio-types": "6.89.0",
     "tslib": "2.2.0"
   },
   "devDependencies": {
-    "@tsed/common": "6.87.1",
-    "@tsed/core": "6.87.1",
-    "@tsed/di": "6.87.1",
-    "@tsed/mongoose": "6.87.1",
+    "@tsed/common": "6.89.0",
+    "@tsed/core": "6.89.0",
+    "@tsed/di": "6.89.0",
+    "@tsed/mongoose": "6.89.0",
     "express": "^4.17.1",
     "formio": "^2.0.0",
     "mongodb": "*",
     "mongoose": "^5.12.2"
   },
   "peerDependencies": {
-    "@tsed/common": "^6.87.1",
-    "@tsed/core": "^6.87.1",
-    "@tsed/di": "^6.87.1",
-    "@tsed/mongoose": "^6.87.1",
+    "@tsed/common": "^6.89.0",
+    "@tsed/core": "^6.89.0",
+    "@tsed/di": "^6.89.0",
+    "@tsed/mongoose": "^6.89.0",
     "express": "^4.17.1",
     "formio": "^2.0.0",
     "mongodb": "*",

package/tsconfig.compile.esm.json

@@ -0,0 +1,23 @@
+{
+  "extends": "./tsconfig.compile.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "module": "ES2020",
+    "rootDir": "src",
+    "outDir": "./lib/esm",
+    "declaration": true,
+    "declarationDir": "./lib/types"
+  },
+  "exclude": [
+    "node_modules",
+    "test",
+    "lib",
+    "benchmark",
+    "coverage",
+    "spec",
+    "**/*.benchmark.ts",
+    "**/*.spec.ts",
+    "keys",
+    "jest.config.js"
+  ]
+}