@tsed/formio 8.11.0 → 8.11.2-rc.1

package/src/components/AlterTemplateExportSteps.spec.ts

@@ -1,99 +0,0 @@
-import {PlatformTest} from "@tsed/platform-http/testing";
-
-import {FormioDatabase} from "../services/FormioDatabase.js";
-import {AlterTemplateExportSteps} from "./AlterTemplateExportSteps.js";
-
-async function createServiceFixture() {
-  const mapper = {
-    mapToExport: vi.fn().mockImplementation((data) => {
-      if (data === "form_id") {
-        return "machineName";
-      }
-      return data;
-    })
-  };
-
-  const database = {
-    submissionModel: {
-      deleteMany: vi.fn(),
-      create: vi.fn(),
-      find: vi.fn()
-    },
-    getFormioMapper: vi.fn().mockResolvedValue(mapper)
-  };
-
-  const service = await PlatformTest.invoke<AlterTemplateExportSteps>(AlterTemplateExportSteps, [
-    {
-      token: FormioDatabase,
-      use: database
-    }
-  ]);
-
-  return {service, mapper, database};
-}
-
-describe("AlterTemplateExportSteps", () => {
-  beforeEach(() => PlatformTest.create());
-  afterEach(PlatformTest.reset);
-
-  it("should export submission", async () => {
-    const {service, database} = await createServiceFixture();
-    let queue: any[] = [];
-    const map = {};
-    const options = {};
-    const template: any = {
-      submissions: {
-        admin: [
-          {
-            form: "$machineName:admin",
-            data: {},
-            roles: ["admin", "admin"]
-          }
-        ]
-      }
-    };
-
-    database.submissionModel.find.mockResolvedValue([
-      {
-        toObject() {
-          return {
-            _id: "_id",
-            created: "created",
-            updated: "updated",
-            deleted: "deleted",
-            modified: "modified",
-            __v: "__v",
-            owner: "owner",
-            roles: ["roles"],
-            form: "form_id",
-            metadata: "metadata",
-            data: {}
-          };
-        }
-      }
-    ]);
-
-    queue = service.transform(queue, template, map, options);
-
-    expect(queue.length).toEqual(1);
-
-    const result = await new Promise((resolve) => queue[0]((err: any, template: any) => resolve(template)));
-
-    expect(result).toEqual({
-      submissions: {
-        machineName: [
-          {
-            created: "created",
-            data: {},
-            deleted: "deleted",
-            form: "machineName",
-            modified: "modified",
-            roles: ["roles"]
-          }
-        ]
-      }
-    });
-    expect(database.getFormioMapper).toHaveBeenCalledWith();
-    expect(database.submissionModel.find).toHaveBeenCalledWith({deleted: {$eq: null}});
-  });
-});

package/src/components/AlterTemplateExportSteps.ts

@@ -1,58 +0,0 @@
-import {getValue} from "@tsed/core";
-import {Inject} from "@tsed/di";
-import {MongooseDocument} from "@tsed/mongoose";
-import async from "async";
-
-import {FormioMapper} from "../builder/FormioMapper.js";
-import {Alter} from "../decorators/alter.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";
-
-@Alter("templateExportSteps")
-export class AlterTemplateExportSteps implements AlterHook {
-  @Inject()
-  protected database: FormioDatabase;
-
-  transform(queue: any[], template: FormioTemplate, map: any, options: any): any {
-    queue.push(async.apply(this.exportSubmissions.bind(this), template, map, options));
-
-    return queue;
-  }
-
-  protected async exportSubmissions(template: FormioTemplate, map: any, options: any, next: any) {
-    const [mapper, submissions] = await Promise.all([
-      this.database.getFormioMapper(),
-      this.database.submissionModel.find({
-        deleted: {$eq: null}
-      })
-    ]);
-
-    template.submissions = await this.mapSubmissions(submissions, mapper);
-
-    next(null, template);
-  }
-
-  protected mapSubmissions(submissions: MongooseDocument<FormioSubmission>[], mapper: FormioMapper) {
-    return submissions
-      .map((submission) => submission.toObject())
-      .reduce((acc: any, {_id, created, updated, modified, __v, owner, roles, form, metadata, ...submission}) => {
-        const machineName = mapper.mapToExport(form.toString());
-        const key = machineName.replace("$machineName:", "");
-
-        acc[key] = getValue(acc, key, []);
-
-        acc[key].push({
-          ...submission,
-          created: created && created.toString(),
-          modified: modified && modified.toString(),
-          data: mapper.mapToExport(submission.data),
-          roles: mapper.mapToExport(roles).filter(Boolean),
-          form: mapper.mapToExport(form)
-        });
-
-        return acc;
-      }, {});
-  }
-}

package/src/components/AlterTemplateImportSteps.spec.ts

@@ -1,70 +0,0 @@
-import {PlatformTest} from "@tsed/platform-http/testing";
-
-import {FormioDatabase} from "../services/FormioDatabase.js";
-import {AlterTemplateImportSteps} from "./AlterTemplateImportSteps.js";
-
-async function createServiceFixture() {
-  const mapper = {
-    mapToImport: vi.fn().mockImplementation((data) => {
-      if (data && data.data) {
-        return {
-          form: "form_id",
-          data: {},
-          roles: []
-        };
-      }
-      return data;
-    })
-  };
-
-  const database = {
-    submissionModel: {
-      deleteMany: vi.fn(),
-      create: vi.fn()
-    },
-    getFormioMapper: vi.fn().mockResolvedValue(mapper)
-  };
-
-  const service = await PlatformTest.invoke<AlterTemplateImportSteps>(AlterTemplateImportSteps, [
-    {
-      token: FormioDatabase,
-      use: database
-    }
-  ]);
-
-  return {service, mapper, database};
-}
-
-describe("AlterTemplateImportSteps", () => {
-  beforeEach(() => PlatformTest.create());
-  afterEach(PlatformTest.reset);
-
-  it("should import submission", async () => {
-    const {service, database} = await createServiceFixture();
-    let queue: any[] = [];
-    const template: any = {
-      submissions: {
-        admin: [
-          {
-            form: "$machineName:admin",
-            data: {},
-            roles: ["admin", "admin"]
-          }
-        ]
-      }
-    };
-
-    queue = service.transform(queue, vi.fn(), template);
-
-    expect(queue.length).toEqual(1);
-
-    await new Promise((resolve) => queue[0](resolve));
-
-    expect(database.submissionModel.deleteMany).toHaveBeenCalledWith({});
-    expect(database.submissionModel.create).toHaveBeenCalledWith({
-      form: "form_id",
-      data: {},
-      roles: ["admin"]
-    });
-  });
-});

package/src/components/AlterTemplateImportSteps.ts

@@ -1,50 +0,0 @@
-import {Inject} from "@tsed/di";
-import async from "async";
-
-import {FormioMapper} from "../builder/FormioMapper.js";
-import {Alter} from "../decorators/alter.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";
-
-@Alter("templateImportSteps")
-export class AlterTemplateImportSteps implements AlterHook {
-  @Inject()
-  protected database: FormioDatabase;
-
-  transform(queue: any[], install: Function, template: Partial<FormioTemplate>): any {
-    queue.push(async.apply(this.importSubmissions.bind(this), template));
-
-    return queue;
-  }
-
-  protected async importSubmissions(template: Partial<FormioTemplate>, done: any) {
-    if (template && template.submissions) {
-      // clean all submissions
-      await this.database.submissionModel.deleteMany({});
-
-      const ctxData = await this.database.getFormioMapper();
-      const entries = Object.entries(template.submissions);
-
-      for (const entry of entries) {
-        for (const submission of entry[1]) {
-          await this.importSubmission({...submission, form: submission.form || entry[0]}, ctxData);
-        }
-      }
-    }
-
-    done();
-  }
-
-  protected async importSubmission(submission: Partial<FormioSubmission>, mapper: FormioMapper) {
-    const value = {
-      ...mapper.mapToImport(submission),
-      roles: [...new Set(mapper.mapToImport(submission.roles || []))].filter(Boolean)
-    };
-
-    await this.database.submissionModel.create(value);
-
-    return value;
-  }
-}

package/src/decorators/action.ts

@@ -1,20 +0,0 @@
-import {StoreSet, useDecorators} from "@tsed/core";
-import {registerProvider} from "@tsed/di";
-import {FormioActionInfo} from "@tsed/formio-types";
-
-/**
- * Create a new FormIO Action.
- * @param options
- * @decorator
- */
-export function Action(options: FormioActionInfo): ClassDecorator {
-  return useDecorators(
-    (target: any) => {
-      registerProvider({
-        token: target,
-        type: "formio:action"
-      });
-    },
-    StoreSet("formio:action", options)
-  );
-}

package/src/decorators/actionCtx.spec.ts

@@ -1,25 +0,0 @@
-import {JsonParameterStore} from "@tsed/schema";
-
-import {ActionCtx} from "./actionCtx.js";
-
-describe("@ActionCtx", () => {
-  it("should inject ActionCtx", () => {
-    class CustomAction {
-      resolve(@ActionCtx() actionCtx: ActionCtx) {}
-    }
-
-    const param = JsonParameterStore.get(CustomAction, "resolve", 0);
-
-    expect(param.expression).toEqual("ACTION_CTX");
-  });
-
-  it("should inject ActionCtx (with expression)", () => {
-    class CustomAction {
-      resolve(@ActionCtx("handler") actionCtx: ActionCtx) {}
-    }
-
-    const param = JsonParameterStore.get(CustomAction, "resolve", 0);
-
-    expect(param.expression).toEqual("ACTION_CTX.handler");
-  });
-});

package/src/decorators/actionCtx.ts

@@ -1,29 +0,0 @@
-import {FormioAction} from "@tsed/formio-types";
-import {Context} from "@tsed/platform-params";
-
-import {SetActionItemMessage} from "../domain/FormioAction.js";
-
-/**
- * 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 function ActionCtx(expression?: string): ParameterDecorator {
-  return Context(["ACTION_CTX", expression].filter(Boolean).join("."));
-}
-
-export type ActionCtx = {
-  handler: string;
-  method: string;
-  setActionItemMessage: SetActionItemMessage;
-  action: FormioAction;
-};

package/src/decorators/alter.spec.ts

@@ -1,16 +0,0 @@
-import {Store} from "@tsed/core";
-
-import {AlterHook} from "../domain/AlterHook.js";
-import {Alter} from "./alter.js";
-
-describe("@Alter", () => {
-  it("should register a hook listener", () => {
-    @Alter("custom")
-    class AlterCustom implements AlterHook {
-      transform() {}
-    }
-
-    const store = Store.from(AlterCustom);
-    expect(store.get("formio:alter:name")).toEqual("custom");
-  });
-});

package/src/decorators/alter.ts

@@ -1,19 +0,0 @@
-import {StoreSet, useDecorators} from "@tsed/core";
-import {registerProvider} from "@tsed/di";
-
-/**
- *
- * @param name
- * @constructor
- */
-export function Alter(name: string): ClassDecorator {
-  return useDecorators(
-    (target: any) => {
-      registerProvider({
-        token: target,
-        type: "formio:alter"
-      });
-    },
-    StoreSet("formio:alter:name", name)
-  );
-}

package/src/decorators/on.spec.ts

@@ -1,16 +0,0 @@
-import {Store} from "@tsed/core";
-
-import {OnHook} from "../domain/OnHook.js";
-import {On} from "./on.js";
-
-describe("@On", () => {
-  it("should register a hook listener", () => {
-    @On("custom")
-    class CustomEvent implements OnHook {
-      on() {}
-    }
-
-    const store = Store.from(CustomEvent);
-    expect(store.get("formio:on:name")).toEqual("custom");
-  });
-});

package/src/decorators/on.ts

@@ -1,19 +0,0 @@
-import {StoreSet, useDecorators} from "@tsed/core";
-import {registerProvider} from "@tsed/di";
-
-/**
- * Create a Form io hook event listener
- * @param name
- * @constructor
- */
-export function On(name: string): ClassDecorator {
-  return useDecorators(
-    (target: any) => {
-      registerProvider({
-        token: target,
-        type: "formio:on"
-      });
-    },
-    StoreSet("formio:on:name", name)
-  );
-}

package/src/decorators/useFormioAuth.spec.ts

@@ -1,15 +0,0 @@
-import {EndpointMetadata} from "@tsed/schema";
-
-import {FormioAuthMiddleware} from "../middlewares/FormioAuthMiddleware.js";
-import {UseFormioAuth} from "./useFormioAuth.js";
-
-describe("UseFormioAuth", () => {
-  it("should add auth on method", () => {
-    class MyClass {
-      @UseFormioAuth()
-      get() {}
-    }
-
-    expect(EndpointMetadata.get(MyClass, "get").beforeMiddlewares[0]).toEqual(FormioAuthMiddleware);
-  });
-});

package/src/decorators/useFormioAuth.ts

@@ -1,12 +0,0 @@
-import {UseAuth} from "@tsed/platform-middlewares";
-
-import {FormioAuthMiddleware} from "../middlewares/FormioAuthMiddleware.js";
-
-/**
- * Check if a user is connected by using the Formio Auth middleware
- * @decorator
- * @formio
- */
-export function UseFormioAuth(): Function {
-  return UseAuth(FormioAuthMiddleware);
-}

package/src/domain/AlterHook.ts

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

package/src/domain/Formio.ts

@@ -1,122 +0,0 @@
-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/src/domain/FormioAction.ts

@@ -1,30 +0,0 @@
-import {FormioAction, FormioActionInfo} from "@tsed/formio-types";
-import {Request, Response} from "express";
-
-import {FormioMongooseSchema} from "./FormioBaseModel.js";
-import {FormioComponent} from "./FormioModels.js";
-
-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/src/domain/FormioActionsIndex.ts

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