@tsed/formio 7.83.3 → 8.0.0-alpha.10

package/lib/types-esm/FormioModule.d.ts

@@ -1,24 +0,0 @@
-import { InjectorService, OnReady, OnRoutesInit, PlatformApplication, PlatformRouteDetails } from "@tsed/common";
-import { FormioConfig } from "./domain/FormioConfig.js";
-import { FormioTemplate } from "./domain/FormioTemplate.js";
-import { FormioHooksService } from "./services/FormioHooksService.js";
-import { FormioInstaller } from "./services/FormioInstaller.js";
-import { FormioService } from "./services/FormioService.js";
-export declare class FormioModule implements OnRoutesInit, OnReady {
-    protected formio: FormioService;
-    protected hooks: FormioHooksService;
-    protected installer: FormioInstaller;
-    protected app: PlatformApplication;
-    protected injector: InjectorService;
-    protected settings: FormioConfig;
-    protected baseUrl: string;
-    protected skipInstall: boolean;
-    protected template?: FormioTemplate;
-    protected root?: any;
-    $onInit(): Promise<import("./index.js").Formio> | undefined;
-    init(options: FormioConfig): Promise<import("./index.js").Formio> | undefined;
-    $onRoutesInit(): Promise<void>;
-    $logRoutes(routes: PlatformRouteDetails[]): Promise<PlatformRouteDetails[]>;
-    $onReady(): void;
-    protected shouldInstall(): Promise<boolean | undefined>;
-}

package/lib/types-esm/builder/FormioMapper.d.ts

@@ -1,11 +0,0 @@
-import { FormioCtxMapper } from "../domain/FormioCtxMapper.js";
-export declare class FormioMapper {
-    readonly ctxData: FormioCtxMapper;
-    constructor(ctxData: FormioCtxMapper);
-    find(key: string): any;
-    findId(data: string): any;
-    findMachineName(data: any): string | undefined;
-    mapToExport(data: any): any;
-    mapToImport(data: any): any;
-    mapData(data: any, resolver: any): any;
-}

package/lib/types-esm/components/AlterActions.d.ts

@@ -1,18 +0,0 @@
-import { InjectorService, Provider } from "@tsed/di";
-import { PlatformParams } from "@tsed/platform-params";
-import { PlatformResponseFilter } from "@tsed/platform-response-filter";
-import { AlterHook } from "../domain/AlterHook.js";
-import { SetActionItemMessage } from "../domain/FormioAction.js";
-import { FormioActions } from "../domain/FormioActionsIndex.js";
-import { FormioService } from "../services/FormioService.js";
-export declare class AlterActions implements AlterHook {
-    protected injector: InjectorService;
-    protected formio: FormioService;
-    protected params: PlatformParams;
-    protected responseFilter: PlatformResponseFilter;
-    transform(actions: FormioActions): FormioActions;
-    protected getActions(): Provider<any>[];
-    protected createHandler(provider: Provider, propertyKey: string | symbol): (action: any, handler: string, method: string, req: any, res: any, next: any, setActionItemMessage: SetActionItemMessage) => Promise<void>;
-    private onRequest;
-    private flush;
-}

package/lib/types-esm/components/AlterAudit.d.ts

@@ -1,5 +0,0 @@
-import { DIContext } from "@tsed/di";
-import { AlterHook } from "../domain/AlterHook.js";
-export declare class AlterAudit implements AlterHook {
-    transform(info: any[], event: string, ctx: DIContext): boolean;
-}

package/lib/types-esm/components/AlterHost.d.ts

@@ -1,5 +0,0 @@
-import { PlatformContext } from "@tsed/common";
-import { AlterHook } from "../domain/AlterHook.js";
-export declare class AlterHost implements AlterHook<string> {
-    transform(baseUrl: string, ctx: PlatformContext): string;
-}

package/lib/types-esm/components/AlterLog.d.ts

@@ -1,5 +0,0 @@
-import { PlatformContext } from "@tsed/common";
-import { AlterHook } from "../domain/AlterHook.js";
-export declare class AlterLog implements AlterHook {
-    transform(event: string, ctx: PlatformContext, ...info: any[]): boolean;
-}

package/lib/types-esm/components/AlterSkip.d.ts

@@ -1,7 +0,0 @@
-import { PlatformContext } from "@tsed/common";
-import { AlterHook } from "../domain/AlterHook.js";
-export declare class AlterSkip implements AlterHook {
-    baseUrl: string;
-    whiteList: string[];
-    transform(value: any, ctx: PlatformContext): any;
-}

package/lib/types-esm/components/AlterTemplateExportSteps.d.ts

@@ -1,12 +0,0 @@
-import { MongooseDocument } from "@tsed/mongoose";
-import { FormioMapper } from "../builder/FormioMapper.js";
-import { AlterHook } from "../domain/AlterHook.js";
-import { FormioSubmission } from "../domain/FormioModels.js";
-import { FormioTemplate } from "../domain/FormioTemplate.js";
-import { FormioDatabase } from "../services/FormioDatabase.js";
-export declare class AlterTemplateExportSteps implements AlterHook {
-    protected database: FormioDatabase;
-    transform(queue: any[], template: FormioTemplate, map: any, options: any): any;
-    protected exportSubmissions(template: FormioTemplate, map: any, options: any, next: any): Promise<void>;
-    protected mapSubmissions(submissions: MongooseDocument<FormioSubmission>[], mapper: FormioMapper): any;
-}

package/lib/types-esm/components/AlterTemplateImportSteps.d.ts

@@ -1,11 +0,0 @@
-import { FormioMapper } from "../builder/FormioMapper.js";
-import { AlterHook } from "../domain/AlterHook.js";
-import { FormioSubmission } from "../domain/FormioModels.js";
-import { FormioTemplate } from "../domain/FormioTemplate.js";
-import { FormioDatabase } from "../services/FormioDatabase.js";
-export declare class AlterTemplateImportSteps implements AlterHook {
-    protected database: FormioDatabase;
-    transform(queue: any[], install: Function, template: Partial<FormioTemplate>): any;
-    protected importSubmissions(template: Partial<FormioTemplate>, done: any): Promise<void>;
-    protected importSubmission(submission: Partial<FormioSubmission>, mapper: FormioMapper): Promise<any>;
-}

package/lib/types-esm/decorators/action.d.ts

@@ -1,7 +0,0 @@
-import { FormioActionInfo } from "@tsed/formio-types";
-/**
- * Create a new FormIO Action.
- * @param options
- * @decorator
- */
-export declare function Action(options: FormioActionInfo): ClassDecorator;

package/lib/types-esm/decorators/actionCtx.d.ts

@@ -1,23 +0,0 @@
-import { SetActionItemMessage } from "../domain/FormioAction.js";
-import { FormioAction } from "@tsed/formio-types";
-/**
- * Return the current action context with the following data:
- *
- * ```typescript
- * export type ActionCtx = {
- *  handler: string;
- *  method: string;
- *  setActionItemMessage: SetActionItemMessage;
- *  action: FormioAction;
- * };
- * ```
- * @param expression
- * @constructor
- */
-export declare function ActionCtx(expression?: string): ParameterDecorator;
-export type ActionCtx = {
-    handler: string;
-    method: string;
-    setActionItemMessage: SetActionItemMessage;
-    action: FormioAction;
-};

package/lib/types-esm/decorators/alter.d.ts

@@ -1,6 +0,0 @@
-/**
- *
- * @param name
- * @constructor
- */
-export declare function Alter(name: string): ClassDecorator;

package/lib/types-esm/decorators/on.d.ts

@@ -1,6 +0,0 @@
-/**
- * Create a Form io hook event listener
- * @param name
- * @constructor
- */
-export declare function On(name: string): ClassDecorator;

package/lib/types-esm/decorators/useFormioAuth.d.ts

@@ -1,6 +0,0 @@
-/**
- * Check if a user is connected by using the Formio Auth middleware
- * @decorator
- * @formio
- */
-export declare function UseFormioAuth(): Function;

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

@@ -1,3 +0,0 @@
-export interface AlterHook<T = any> {
-    transform(...args: any[]): T;
-}

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

@@ -1,112 +0,0 @@
-/// <reference types="node" />
-import { EventEmitter } from "events";
-import { NextFunction, Request, Response } from "express";
-import { Db } from "mongodb";
-import { Mongoose, Schema } from "mongoose";
-import { FormioActionModelCtor } from "./FormioAction.js";
-import { FormioActionsIndex } from "./FormioActionsIndex.js";
-import { FormioAuth } from "./FormioAuth.js";
-import { FormioBaseModel } from "./FormioBaseModel.js";
-import { FormioConfig } from "./FormioConfig.js";
-import { FormioHook, FormioHooks } from "./FormioHooks.js";
-import { FormioModels, FormioSchemas } from "./FormioModels.js";
-import { FormioTemplateUtil } from "./FormioTemplateUtil.js";
-import { FormioUpdate } from "./FormioUpdate.js";
-import { FormioUtil } from "./FormioUtils.js";
-export interface FormioBase {
-    /**
-     * Auth
-     */
-    auth: FormioAuth;
-    /**
-     * Event emitter
-     */
-    events: EventEmitter;
-    /**
-     * Formio configuration
-     */
-    config: FormioConfig & {
-        schema: string;
-    };
-    /**
-     * Emit alter `log` event. Return false to disable event logging.
-     * @param event
-     * @param req
-     * @param info
-     */
-    log(event: string, req: Request, ...info: any[]): void;
-    /**
-     * Emit alter `audit` event if `config.audit` is enabled. Return false to disable event logging.
-     * Use `console.log`.
-     * @param event
-     * @param req
-     * @param info
-     */
-    audit(event: string, req: Request, ...info: any[]): void;
-}
-export interface FormioMiddlewares {
-    alias(req: Request, res: Response, next: NextFunction): void;
-    params(req: Request, res: Response, next: NextFunction): void;
-    accessHandler(req: Request, res: Response, next: NextFunction): void;
-    /**
-     * Authorize all urls based on roles and permissions.
-     * @param req
-     * @param res
-     * @param next
-     */
-    permissionHandler(req: Request, res: Response, next: NextFunction): void;
-    restrictRequestTypes(req: Request, res: Response, next: NextFunction): void;
-    tokenHandler(req: Request, res: Response, next: NextFunction): void;
-}
-export interface Formio extends FormioBase {
-    Action: FormioActionModelCtor;
-    BaseModel: FormioBaseModel;
-    actions: FormioActionsIndex;
-    resources: any;
-    /**
-     * Database connection
-     */
-    db: Db;
-    schemas: FormioSchemas & {
-        AccessSchema: Schema;
-        PermissionSchema: Schema;
-        FieldMatchAccessPermissionSchema: Schema;
-    };
-    models: FormioModels;
-    /**
-     * Mongoose lib.
-     */
-    mongoose: Mongoose;
-    /**
-     * Exported formio middlewares
-     */
-    readonly middleware: FormioMiddlewares;
-    /**
-     * Hooks.
-     */
-    hooks: FormioHooks;
-    /**
-     * Plugins.
-     */
-    plugins: any;
-    /**
-     * Formio hook util.
-     */
-    readonly hook: FormioHook;
-    /**
-     * The formio utils.
-     */
-    readonly util: FormioUtil;
-    /**
-     * Update system.
-     */
-    readonly update: FormioUpdate;
-    /**
-     * Template export/import
-     */
-    readonly template: FormioTemplateUtil;
-    /**
-     * Encryption system.
-     */
-    encrypt(text: string, next: (err: null | Error, hash: string) => void): void;
-}

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

@@ -1,20 +0,0 @@
-import { Request, Response } from "express";
-import { FormioMongooseSchema } from "./FormioBaseModel.js";
-import { FormioComponent } from "./FormioModels.js";
-import { FormioAction, FormioActionInfo } from "@tsed/formio-types";
-export interface FormioActionModel extends FormioAction {
-    resolve(handler: string, method: string, req: Request, res: Response, next: Function, setActionItemMessage: SetActionItemMessage): void;
-}
-export type FormioActionMongooseSchema = FormioMongooseSchema<FormioAction>;
-export type SetActionItemMessage = (message: string, data?: any, state?: any) => void;
-export interface FormioActionModelCtor {
-    schema?: FormioActionMongooseSchema;
-    info(req: Request, response: Response, next: (err: any, info: FormioActionInfo) => void): void;
-    settingsForm(req: Request, response: Response, next: (err: any, info: FormioComponent[]) => void): void;
-    new (data: FormioAction, req: Request, res: Response): FormioActionModel;
-}
-export interface ActionMethods {
-    info?(req: Request, response: Response): Promise<FormioAction>;
-    settingsForm(req: Request, response: Response): Promise<FormioComponent[]>;
-    resolve(...args: any[]): Promise<any>;
-}

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

@@ -1,15 +0,0 @@
-import { Type } from "@tsed/core";
-import { FormioActionModelCtor } from "./FormioAction.js";
-export interface FormioActions {
-    email: FormioActionModelCtor;
-    login: FormioActionModelCtor;
-    resetpass: FormioActionModelCtor;
-    role: FormioActionModelCtor;
-    save: FormioActionModelCtor;
-    sql: FormioActionModelCtor;
-    webhook: FormioActionModelCtor;
-    [key: string]: FormioActionModelCtor;
-}
-export interface FormioActionsIndex {
-    actions: FormioActions & Record<string, Type<FormioActionModelCtor>>;
-}

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

@@ -1,67 +0,0 @@
-import { Next, Req, Res } from "@tsed/common";
-import { FormioDecodedToken, FormioPayloadToken } from "./FormioDecodedToken.js";
-import { FormioForm } from "./FormioModels.js";
-export interface FormioAuth {
-    /**
-     * Send the current user.
-     *
-     * @param req
-     * @param res
-     * @param next
-     */
-    currentUser(req: Req, res: Res, next: Function): void;
-    /**
-     * Checks to see if a decoded token is allowed to access this path.
-     * @param req
-     * @param decoded
-     * @return {boolean}
-     */
-    isTokenAllowed(req: Req, decoded: FormioDecodedToken): boolean;
-    /**
-     * Generate our JWT with the given payload, and pass it to the given callback function.
-     *
-     * @param payload {Object}
-     *   The decoded JWT.
-     *
-     * @return {String|Boolean}
-     *   The JWT from the given payload, or false if the jwt payload is still valid.
-     */
-    getToken(payload: FormioPayloadToken): string | boolean;
-    /**
-     * Generate a temporary token for a specific path and expiration.
-     *
-     * @param req
-     * @param res
-     * @param allow
-     * @param expire
-     * @param admin
-     * @param cb
-     */
-    getTempToken(req: Req, res: Res, allow: boolean, expire: number, admin: boolean, cb: Function): void;
-    tempToken(req: Req, res: Res): void;
-    /**
-     * Authenticate a user.
-     *
-     * @param req
-     * @param forms {Mixed}
-     *   A single form or an array of forms to authenticate against.
-     * @param userField {String}
-     *   The user submission field that contains the username.
-     * @param passField {String}
-     *   The user submission field that contains the password.
-     * @param username {String}
-     *   The user submission username to login with.
-     * @param password {String}
-     *   The user submission password to login with.
-     * @param next {Function}
-     *   The callback function to call after authentication.
-     */
-    authenticate(req: Req, forms: FormioForm | FormioForm[], userField: string, passField: string, username: string, password: string, next: Function): void;
-    /**
-     * Interception logout request.
-     * @param req
-     * @param res
-     * @param next
-     */
-    logout(req: Req, res: Res, next: Next): void;
-}

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

@@ -1,11 +0,0 @@
-import { MongooseDocument } from "@tsed/mongoose";
-import { Schema, Document } from "mongoose";
-export type FormioMongooseSchema<T> = Schema<Document<T>> & {
-    machineName(document: MongooseDocument<T>, done: Function): void;
-};
-export interface FormioBaseModel<T = any> {
-    schema: Schema<Document<T>>;
-}
-export interface FormioModel<T = any> extends FormioBaseModel<T> {
-    schema: FormioMongooseSchema<T>;
-}

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

@@ -1,59 +0,0 @@
-import { FormioSettings } from "./FormioSettings.js";
-import { FormioTemplate } from "./FormioTemplate.js";
-export interface FormioJwtConfig {
-    secret: string;
-    expireTime?: number;
-}
-export interface FormioEmailConfig {
-    type: string;
-    username: string;
-    password: string;
-}
-export interface FormioConfig {
-    /**
-     * Base url to mount the formio endpoints with Ts.ED server. Default: '/'
-     */
-    baseUrl: string;
-    /**
-     * Skip installation process
-     */
-    skipInstall?: boolean;
-    template?: FormioTemplate;
-    /**
-     * Cors allowed origin configuration. Default: `["*"]`.
-     */
-    allowedOrigins?: string[];
-    /**
-     *
-     */
-    mongoCA?: any;
-    mongo?: string;
-    mongoConfig?: string;
-    /**
-     * Reserved keywords form name list
-     */
-    reservedForms?: string[];
-    /**
-     * Jwt configuration
-     */
-    jwt: FormioJwtConfig;
-    /**
-     * Email sendgrid settings
-     */
-    email?: FormioEmailConfig;
-    /**
-     * Settings of external formio services
-     */
-    settings?: FormioSettings;
-    /**
-     * Enable audit log. Default: false
-     */
-    audit?: boolean;
-    /**
-     * User root credentials
-     */
-    root: {
-        email: string;
-        password: string;
-    };
-}

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

@@ -1,7 +0,0 @@
-import { MongooseDocument } from "@tsed/mongoose";
-import { FormioAction, FormioForm, FormioRole } from "@tsed/formio-types";
-export interface FormioCtxMapper {
-    forms: Map<string, MongooseDocument<FormioForm>>;
-    actions: Map<string, MongooseDocument<FormioAction>>;
-    roles: Map<string, MongooseDocument<FormioRole>>;
-}

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

@@ -1,12 +0,0 @@
-export interface FormioDecodedToken extends Record<string, unknown> {
-    user: {
-        _id: string;
-    };
-    form: {
-        _id: string;
-    };
-}
-export interface FormioPayloadToken {
-    token: string;
-    decoded: FormioDecodedToken;
-}

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

@@ -1,53 +0,0 @@
-export interface FormioErrors {
-    app: {
-        ESETTINGSLOAD: "Cannot load app settings.";
-        EDBCONFIG: "Database settings is missing.";
-        EDBHOST: "Invalid SQL Host.";
-    };
-    db: {
-        EINVQUERY: "Invalid query.";
-        EDBCONN: "Connection error.";
-        EQUERY: "Query request error.";
-    };
-    emailer: {
-        ENOTRANSP: "Cannot get emailer transports.";
-        ESENDMAIL: "Email sending failed.";
-        ESUBPARAMS: "Failed to get substitution parameters.";
-    };
-    cache: {
-        EFORMLOAD: "Cannot load form.";
-    };
-    form: {
-        ENOFORM: "Form not found.";
-    };
-    auth: {
-        EAUTH: "Authentication failed.";
-        EPASSFIELD: "Invalid password field.";
-        EPASSRESET: "Unable to change password.";
-        ERESETTOKEN: "Invalid reset password token.";
-        ENOPASSP: "No password provided.";
-        ELOGINCOUNT: "Unable to update login count.";
-    };
-    submission: {
-        ENOSUB: "Submission not found.";
-        ESUBLOAD: "Cannot load submission.";
-        ESUBSAVE: "Cannot save submission.";
-    };
-    user: {
-        ENOUSER: "User not found.";
-        ENONAMEP: "No user name provided.";
-    };
-    role: {
-        EROLESLOAD: "Cannot load the Roles.";
-        ENOROLE: "Role not found.";
-        EROLELOAD: "Cannot load role.";
-        EROLEEXIST: "Provided role already exists.";
-    };
-    request: {
-        EREQRECUR: "Too many recursive requests.";
-    };
-    resource: {
-        ENOIDP: "Resource id is missing.";
-        ENOHANDLER: "Resource handler not found.";
-    };
-}