@tsed/formio 7.83.3 → 8.0.0-alpha.10

package/lib/types-esm/domain/FormioHooks.d.ts

@@ -1,194 +0,0 @@
-import { MongooseDocument } from "@tsed/mongoose";
-import { Request, Response } from "express";
-import { FilterQuery, Schema, SchemaDefinition } from "mongoose";
-import { Formio } from "./Formio.js";
-import { FormioActions } from "./FormioActionsIndex.js";
-import { FormioConfig } from "./FormioConfig.js";
-import { FormioDecodedToken } from "./FormioDecodedToken.js";
-import { FormioJs } from "./FormioJs.js";
-import { FormioActionItem, FormioForm, FormioModelsModels, FormioSubmission } from "./FormioModels.js";
-import { FormioSettings } from "./FormioSettings.js";
-import { ResourceRestOptions } from "./Resource.js";
-export type FormioInitEvent = "alias" | "params" | "token" | "getTempToken" | "logout" | "current" | "access" | "perms";
-export interface FormioHooks {
-    settings?: (settings: FormioSettings, req: Request, cb: Function) => FormioSettings;
-    alter?: {
-        alias?: (alias: string, req: Request, res: Response) => string;
-        /**
-         * Alter FormioJs configuration
-         * @param formIo
-         */
-        configFormio?: (formIo: {
-            Formio: FormioJs;
-        }) => void;
-        /**
-         * Alter formio server configuration.
-         * @param config
-         */
-        updateConfig?: (config: FormioConfig) => FormioConfig;
-        /**
-         * Alter audit log.
-         * @param info
-         * @param event
-         * @param req
-         */
-        audit?: (info: any[], event: string, req: Request) => void;
-        /**
-         * Alter log.
-         * @param info
-         * @param event
-         * @param req
-         */
-        log?: (event: string, req: Request, ...info: string[]) => void;
-        /**
-         * Alter available actions
-         * @param info
-         * @param event
-         * @param req
-         */
-        actions?: (actions: FormioActions) => FormioActions;
-        /**
-         * Skip auth for the current request.
-         * @param info
-         * @param event
-         * @param req
-         */
-        skip?: (value: boolean, req: Request) => boolean;
-        /**
-         * Resolve host.
-         * @param baseUrl
-         * @param req
-         */
-        host?: (baseUrl: string, req: Request) => string;
-        /**
-         * `/form/${req.params.formId}/action`
-         * @param action
-         * @param req
-         */
-        path?: (path: string, req: Request) => any;
-        /**
-         * Restrict request types
-         * @param methods
-         */
-        methods?: (methods: string[]) => string[];
-        /**
-         * Return the cors configuration.
-         */
-        cors?: () => Record<string, any>;
-        /**
-         * Return the current user submission.
-         */
-        currentUser?: (user: any) => any;
-        /**
-         * Alter current form.
-         * @param form
-         */
-        currentForm?: (form: FormioForm) => FormioForm;
-        /**
-         * Alter formio
-         * @param formio
-         */
-        formio?: (formio: Formio) => Formio;
-        /**
-         * Alter models
-         * @param models
-         */
-        models?: (models: FormioModelsModels) => FormioModelsModels;
-        /**
-         * Alter resources
-         * @param resources
-         */
-        resources?: (resources: {
-            form: any;
-            submission: any;
-            role: any;
-        }) => any;
-        resourceAccessFilter?: (search: any, req: Request, done: (err: unknown, newSearch: any) => void) => void;
-        actionMachineName?: (name: string, document: MongooseDocument<any>, done: Function) => void;
-        formMachineName?: (name: string, document: MongooseDocument<any>, done: Function) => void;
-        roleMachineName?: (name: string, document: MongooseDocument<any>, done: Function) => void;
-        actionSchema?: (schema: Schema) => Schema;
-        actionItemSchema?: (schema: Schema) => Schema;
-        formSchema?: (schema: Schema) => Schema;
-        roleSchema?: (schema: Schema) => Schema;
-        schemaSchema?: (schema: Schema) => Schema;
-        submissionSchema?: (schema: Schema | SchemaDefinition) => Schema;
-        tokenSchema?: (schema: Schema) => Schema;
-        permissionSchema?: (schema: SchemaDefinition) => SchemaDefinition;
-        fieldMatchAccessPermissionSchema?: (schemaOptions: SchemaDefinition) => SchemaDefinition;
-        actionsQuery?: <DocType = any>(query: FilterQuery<DocType>, req: Request) => FilterQuery<DocType>;
-        submissionQuery?: <DocType = any>(query: FilterQuery<DocType>, req: Request) => FilterQuery<DocType>;
-        roleQuery?: <DocType = any>(query: FilterQuery<DocType>, req: Request) => FilterQuery<DocType>;
-        formQuery?: <DocType = any>(query: FilterQuery<DocType>, req: Request) => FilterQuery<DocType>;
-        actionItem?: (actionItem: FormioActionItem, req: Request) => FormioActionItem;
-        actionContext?: (actionContext: any, req: Request) => any;
-        actionInfo?: (action: any, req: Request) => any;
-        submission?: (req: Request, res: Response, done: Function) => void;
-        submissionRequest?: (submission: FormioSubmission) => FormioSubmission;
-        validateSubmissionForm?: (form: FormioForm, submission: FormioSubmission, done: Function) => void;
-        postSubmissionUpdate?: (req: Request, res: Response, submissionUpdate: FormioSubmission) => void;
-        /**
-         * Allow modules to hook into the form loader middleware.
-         * @param item
-         * @param req
-         * @param done
-         */
-        formResponse?: (item: any, req: Request, done: Function) => void;
-        requestParams?: (req: Request & {
-            formId: string;
-            subId: string;
-            roleId: string;
-        }, params: Record<string, any>) => void;
-        /**
-         * Alter submitted params
-         * @param params
-         */
-        submissionParams?: (params: string[]) => string[];
-        /**
-         * Alter actions routes.
-         */
-        actionRoutes?: (options: ResourceRestOptions) => ResourceRestOptions;
-        /**
-         * Alter roles routes.
-         */
-        rolesRoutes?: (options: ResourceRestOptions) => ResourceRestOptions;
-        /**
-         * Alter forms routes.
-         */
-        formRoutes?: (options: ResourceRestOptions) => ResourceRestOptions;
-        /**
-         * Alter submission routes.
-         */
-        submissionRoutes?: (options: ResourceRestOptions) => ResourceRestOptions;
-        user?: (user: any, done: (err: any, user: any) => void) => void;
-        login?: (user: any, req: Request, done: (err: any) => void) => void;
-        token?: (token: FormioDecodedToken, form: FormioForm, req: Request) => FormioDecodedToken;
-        tokenDecode?: (token: FormioDecodedToken, req: Request, done: (err: any, decoded: FormioDecodedToken) => void) => void;
-        submissionRequestTokenQuery?: (query: {
-            formId: string;
-            submissionId: string;
-        }, token: string) => any;
-        [key: string]: any;
-    };
-    on?: {
-        init?: (type: FormioInitEvent) => boolean;
-        [key: string]: any;
-    };
-}
-export interface FormioHook {
-    /**
-     * Run settings function.
-     */
-    settings(req: Request, cb: Function): void;
-    /**
-     * Emit an event.
-     * @param args
-     */
-    invoke<T = any>(...args: any[]): T | boolean;
-    /**
-     * Alter the given value by calling all listener.
-     * @param event
-     * @param args
-     */
-    alter(event: string, ...args: any[]): any;
-}

package/lib/types-esm/domain/FormioJs.d.ts

@@ -1,17 +0,0 @@
-export interface FormioJs {
-    forms: Record<string, any>;
-    cache: Record<string, any>;
-    Components: {
-        components: {
-            component: {
-                Validator: {
-                    db: any | null;
-                    token: any | null;
-                    form: any | null;
-                    submission: any | null;
-                };
-            };
-        };
-    };
-    getToken(): string;
-}

package/lib/types-esm/domain/FormioModels.d.ts

@@ -1,42 +0,0 @@
-import { MongooseDocument } from "@tsed/mongoose";
-import { Schema } from "mongoose";
-import { FormioActionModelCtor, FormioActionMongooseSchema } from "./FormioAction.js";
-import { FormioBaseModel, FormioModel, FormioMongooseSchema } from "./FormioBaseModel.js";
-import { FormioActionItem, FormioForm, FormioRole, FormioSchema, FormioSubmission, FormioToken } from "@tsed/formio-types";
-export * from "@tsed/formio-types";
-export type WithID<T> = T & {
-    _id: string;
-};
-export interface FormioSchemas {
-    action: FormioActionMongooseSchema;
-    actionItem: Schema<MongooseDocument<FormioActionItem>>;
-    form: FormioMongooseSchema<FormioForm>;
-    role: FormioMongooseSchema<FormioRole>;
-    schema: Schema<MongooseDocument<FormioSchema>>;
-    submission: Schema<MongooseDocument<FormioSubmission>>;
-    token: Schema<MongooseDocument<FormioToken>>;
-    [key: string]: Schema<MongooseDocument<any>>;
-}
-export type FormioModelsModels = {
-    action: FormioActionModelCtor;
-    actionItem: FormioBaseModel<FormioActionItem>;
-    form: FormioModel<FormioForm>;
-    role: FormioModel<FormioRole>;
-    schema: FormioBaseModel<FormioSchema>;
-    submission: FormioBaseModel<FormioSubmission>;
-    token: FormioBaseModel<FormioToken>;
-} & Record<string, FormioBaseModel>;
-export interface FormioModels {
-    schemas: FormioSchemas;
-    models: FormioModelsModels;
-    specs: {
-        action: any;
-        actionItem: any;
-        form: any;
-        role: any;
-        schema: any;
-        submission: any;
-        token: any;
-        [key: string]: any;
-    };
-}

package/lib/types-esm/domain/FormioRouter.d.ts

@@ -1,7 +0,0 @@
-import { Router } from "express";
-import { Formio, FormioBase } from "./Formio.js";
-import { FormioHooks } from "./FormioHooks.js";
-export interface FormioRouter extends Router {
-    formio: FormioBase;
-    init(hooks: FormioHooks): Promise<Formio>;
-}

package/lib/types-esm/domain/FormioSettings.d.ts

@@ -1,53 +0,0 @@
-export interface FormioSettings extends Record<string, any> {
-    office365: {
-        tenant: string;
-        clientId: string;
-        email: string;
-        cert: string;
-        thumbprint: string;
-        [key: string]: any;
-    };
-    databases: {
-        mysql: {
-            host: string;
-            port: string;
-            database: string;
-            user: string;
-            password: string;
-            [key: string]: any;
-        };
-        mssql: {
-            host: string;
-            port: string;
-            database: string;
-            user: string;
-            password: string;
-            [key: string]: any;
-        };
-    };
-    email: {
-        gmail: {
-            auth: {
-                user: string;
-                pass: string;
-                [key: string]: any;
-            };
-            [key: string]: any;
-        };
-        sendgrid: {
-            auth: {
-                api_user: string;
-                api_key: string;
-                [key: string]: any;
-            };
-            [key: string]: any;
-        };
-        mandrill: {
-            auth: {
-                apiKey: string;
-                [key: string]: any;
-            };
-            [key: string]: any;
-        };
-    };
-}

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

@@ -1,8 +0,0 @@
-import { FormioActionItem, FormioForm, FormioRole, FormioSubmission } from "./FormioModels.js";
-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-esm/domain/FormioTemplateUtil.d.ts

@@ -1,13 +0,0 @@
-import { FormioTemplate } from "./FormioTemplate.js";
-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-esm/domain/FormioUpdate.d.ts

@@ -1,19 +0,0 @@
-import { NextFunction, Request, Response } from "express";
-import { Db } from "mongodb";
-import { Formio } from "./Formio.js";
-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-esm/domain/FormioUtils.d.ts

@@ -1,307 +0,0 @@
-import { Request, Response } from "express";
-import { FormioErrors } from "./FormioErrors.js";
-import { FormioJs } from "./FormioJs.js";
-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-esm/domain/OnHook.d.ts

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

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

@@ -1,18 +0,0 @@
-import { Request, Response, NextFunction } from "express";
-export type ResourceHttpHandler = (req: Request, res: Response, next: 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;
-}