@tsed/formio 8.11.0 → 8.11.2-rc.1

package/src/domain/FormioAuth.ts

@@ -1,83 +0,0 @@
-import {Next, Req, Res} from "@tsed/platform-http";
-
-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/src/domain/FormioBaseModel.ts

@@ -1,14 +0,0 @@
-import {MongooseDocument} from "@tsed/mongoose";
-import {Document, Schema} 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/src/domain/FormioConfig.ts

@@ -1,63 +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/src/domain/FormioCtxMapper.ts

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

package/src/domain/FormioDecodedToken.ts

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

package/src/domain/FormioErrors.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.";
-  };
-}

package/src/domain/FormioHooks.ts

@@ -1,207 +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;
-
-    // machineName
-    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;
-
-    // schemas
-    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;
-
-    // query
-    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>;
-
-    // Data
-    actionItem?: (actionItem: FormioActionItem, req: Request) => FormioActionItem;
-    actionContext?: (actionContext: any, req: Request) => any;
-    actionInfo?: (action: any, req: Request) => any;
-
-    // submission
-    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;
-
-    // response
-    /**
-     * Allow modules to hook into the form loader middleware.
-     * @param item
-     * @param req
-     * @param done
-     */
-    formResponse?: (item: any, req: Request, done: Function) => void;
-
-    // params
-    requestParams?: (req: Request & {formId: string; subId: string; roleId: string}, params: Record<string, any>) => void;
-    /**
-     * Alter submitted params
-     * @param params
-     */
-    submissionParams?: (params: string[]) => string[];
-
-    // Routes
-    /**
-     * 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;
-
-    // Auth
-    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/src/domain/FormioJs.ts

@@ -1,18 +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/src/domain/FormioModels.ts

@@ -1,48 +0,0 @@
-import {FormioActionItem, FormioForm, FormioRole, FormioSchema, FormioSubmission, FormioToken} from "@tsed/formio-types";
-import {MongooseDocument} from "@tsed/mongoose";
-import {Schema} from "mongoose";
-
-import {FormioActionModelCtor, FormioActionMongooseSchema} from "./FormioAction.js";
-import {FormioBaseModel, FormioModel, FormioMongooseSchema} from "./FormioBaseModel.js";
-
-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/src/domain/FormioRouter.ts

@@ -1,10 +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/src/domain/FormioSettings.ts

@@ -1,61 +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/src/domain/FormioTemplate.ts

@@ -1,9 +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/src/domain/FormioTemplateUtil.ts

@@ -1,15 +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/src/domain/FormioUpdate.ts

@@ -1,23 +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;
-}