@flusys/nestjs-form-builder 6.4.1 → 7.0.0-beta.1

package/cjs/config/event-actions.js

@@ -0,0 +1,29 @@
+/**
+ * Domain event actions published by the form builder module, alongside the
+ * CRUD lifecycle actions every ApiService emits.
+ */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get FORM_BUILDER_EVENT_ACTIONS () {
+        return FORM_BUILDER_EVENT_ACTIONS;
+    },
+    get FORM_BUILDER_EVENT_ENTITIES () {
+        return FORM_BUILDER_EVENT_ENTITIES;
+    }
+});
+const FORM_BUILDER_EVENT_ACTIONS = {
+    SUBMITTED: 'submitted',
+    DRAFT_SAVED: 'draft-saved'
+};
+const FORM_BUILDER_EVENT_ENTITIES = {
+    FORM: 'form',
+    FORM_RESULT: 'form_result'
+};

package/cjs/config/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
+_export_star(require("./event-actions"), exports);
 _export_star(require("./form-builder.constants"), exports);
 _export_star(require("./message-keys"), exports);
 function _export_star(from, to) {

package/cjs/modules/form-builder.module.js

@@ -80,6 +80,7 @@ let FormBuilderModule = class FormBuilderModule {
                 useValue: options
             });
         }
+        providers.push((0, _modules.createModuleEventsProvider)('form-builder', _formbuilderconstants.FORM_BUILDER_MODULE_OPTIONS));
         return providers;
     }
     static buildAsyncProviders(options) {

package/cjs/services/form-result.service.js

@@ -207,6 +207,7 @@ let FormResultService = class FormResultService extends _classes.ApiService {
                     await this.invalidateResultCache([
                         saved
                     ]);
+                    await this.publishSubmissionEvent(saved, dto.formId, true, user);
                     return this.convertEntityToResponseDto(saved, false);
                 }
                 await this.repository.softRemove(existingDraft);
@@ -226,6 +227,7 @@ let FormResultService = class FormResultService extends _classes.ApiService {
             ...staleResults,
             saved
         ]);
+        await this.publishSubmissionEvent(saved, dto.formId, isDraft, user);
         return this.convertEntityToResponseDto(saved, false);
     }
     async getMyDraft(formId, user) {
@@ -266,8 +268,23 @@ let FormResultService = class FormResultService extends _classes.ApiService {
         await this.invalidateResultCache([
             saved
         ]);
+        await this.publishSubmissionEvent(saved, dto.formId, isDraft, user);
         return this.convertEntityToResponseDto(saved, false);
     }
+    async publishSubmissionEvent(result, formId, isDraft, user) {
+        await this.publishDomainAction(isDraft ? _config.FORM_BUILDER_EVENT_ACTIONS.DRAFT_SAVED : _config.FORM_BUILDER_EVENT_ACTIONS.SUBMITTED, {
+            ids: [
+                result.id
+            ],
+            data: result,
+            metadata: {
+                formId,
+                isDraft,
+                schemaVersion: result.schemaVersion
+            },
+            user
+        });
+    }
     async invalidateResultCache(results) {
         await Promise.all([
             this.clearCacheForAll(),

package/cjs/services/form-result.service.spec.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", {
     value: true
 });
 const _testing = require("@nestjs/testing");
+const _classes = require("@flusys/nestjs-shared/classes");
 const _modules = require("@flusys/nestjs-shared/modules");
 const _repositorymock = require("@test-utils/mocks/repository.mock");
 const _loggedusermock = require("@test-utils/mocks/logged-user.mock");
@@ -745,4 +746,78 @@ describe('FormResultService', ()=>{
             expect(result).toBe(false);
         });
     });
+    describe('domain events', ()=>{
+        let publish;
+        beforeEach(()=>{
+            publish = jest.fn().mockResolvedValue(undefined);
+            _classes.EventBusRegistry.reset();
+            _classes.EventBusRegistry.setBus({
+                publish,
+                subscribe: jest.fn(),
+                close: jest.fn()
+            });
+            _classes.EventBusRegistry.configureModule('form-builder', {
+                enabled: true
+            });
+        });
+        afterEach(()=>{
+            _classes.EventBusRegistry.reset();
+        });
+        it('publishes form-builder.form_result.submitted for a final submission', async ()=>{
+            await buildService(false);
+            mockFormRepo.findOne.mockResolvedValue(buildForm({
+                accessType: _formaccesstypeenum.FormAccessType.PUBLIC
+            }));
+            mockResultRepo.save.mockResolvedValue(buildFormResult({
+                isDraft: false
+            }));
+            await service.submitForm({
+                formId: 'form-uuid-1',
+                data: {}
+            }, null, true);
+            expect(publish).toHaveBeenCalledWith(expect.objectContaining({
+                name: 'form-builder.form_result.submitted',
+                action: 'submitted',
+                payload: expect.objectContaining({
+                    ids: [
+                        'result-uuid-1'
+                    ],
+                    metadata: expect.objectContaining({
+                        formId: 'form-uuid-1',
+                        isDraft: false
+                    })
+                })
+            }));
+        });
+        it('publishes form-builder.form_result.draft-saved when the submission is a draft', async ()=>{
+            await buildService(false);
+            mockFormRepo.findOne.mockResolvedValue(buildForm({
+                accessType: _formaccesstypeenum.FormAccessType.PUBLIC
+            }));
+            mockResultRepo.save.mockResolvedValue(buildFormResult({
+                isDraft: true
+            }));
+            await service.submitForm({
+                formId: 'form-uuid-1',
+                data: {},
+                isDraft: true
+            }, null, true);
+            expect(publish.mock.calls[0][0].name).toBe('form-builder.form_result.draft-saved');
+        });
+        it('does not publish when the module has events disabled', async ()=>{
+            _classes.EventBusRegistry.configureModule('form-builder', {
+                enabled: false
+            });
+            await buildService(false);
+            mockFormRepo.findOne.mockResolvedValue(buildForm({
+                accessType: _formaccesstypeenum.FormAccessType.PUBLIC
+            }));
+            mockResultRepo.save.mockResolvedValue(buildFormResult());
+            await service.submitForm({
+                formId: 'form-uuid-1',
+                data: {}
+            }, null, true);
+            expect(publish).not.toHaveBeenCalled();
+        });
+    });
 });

package/config/event-actions.d.ts

@@ -0,0 +1,8 @@
+export declare const FORM_BUILDER_EVENT_ACTIONS: {
+    readonly SUBMITTED: "submitted";
+    readonly DRAFT_SAVED: "draft-saved";
+};
+export declare const FORM_BUILDER_EVENT_ENTITIES: {
+    readonly FORM: "form";
+    readonly FORM_RESULT: "form_result";
+};

package/config/index.d.ts

@@ -1,2 +1,3 @@
+export * from './event-actions';
 export * from './form-builder.constants';
 export * from './message-keys';

package/fesm/config/event-actions.js

@@ -0,0 +1,11 @@
+/**
+ * Domain event actions published by the form builder module, alongside the
+ * CRUD lifecycle actions every ApiService emits.
+ */ export const FORM_BUILDER_EVENT_ACTIONS = {
+    SUBMITTED: 'submitted',
+    DRAFT_SAVED: 'draft-saved'
+};
+/** Every entity the form builder module publishes under */ export const FORM_BUILDER_EVENT_ENTITIES = {
+    FORM: 'form',
+    FORM_RESULT: 'form_result'
+};

package/fesm/config/index.js

@@ -1,2 +1,3 @@
+export * from './event-actions';
 export * from './form-builder.constants';
 export * from './message-keys';

package/fesm/modules/form-builder.module.js

@@ -17,7 +17,7 @@ function _ts_decorate(decorators, target, key, desc) {
     else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
-import { CacheModule, UtilsModule } from '@flusys/nestjs-shared/modules';
+import { CacheModule, UtilsModule, createModuleEventsProvider } from '@flusys/nestjs-shared/modules';
 import { Module } from '@nestjs/common';
 import { FORM_BUILDER_MODULE_OPTIONS } from '../config/form-builder.constants';
 import { FormController, FormResultController } from '../controllers';
@@ -70,6 +70,7 @@ export class FormBuilderModule {
                 useValue: options
             });
         }
+        providers.push(createModuleEventsProvider('form-builder', FORM_BUILDER_MODULE_OPTIONS));
         return providers;
     }
     static buildAsyncProviders(options) {

package/fesm/services/form-result.service.js

@@ -31,7 +31,7 @@ import { ILoggedUserInfo } from '@flusys/nestjs-shared/interfaces';
 import { UtilsService } from '@flusys/nestjs-shared/modules';
 import { BadRequestException, ForbiddenException, Inject, Injectable, NotFoundException, Scope, UnauthorizedException } from '@nestjs/common';
 import { IsNull } from 'typeorm';
-import { FORM_MESSAGES, FORM_RESULT_MESSAGES } from '../config';
+import { FORM_BUILDER_EVENT_ACTIONS, FORM_MESSAGES, FORM_RESULT_MESSAGES } from '../config';
 import { SubmitFormDto } from '../dtos/form-result.dto';
 import { Form, FormResult, FormWithCompany } from '../entities';
 import { FormAccessType } from '../enums/form-access-type.enum';
@@ -197,6 +197,7 @@ export class FormResultService extends ApiService {
                     await this.invalidateResultCache([
                         saved
                     ]);
+                    await this.publishSubmissionEvent(saved, dto.formId, true, user);
                     return this.convertEntityToResponseDto(saved, false);
                 }
                 await this.repository.softRemove(existingDraft);
@@ -216,6 +217,7 @@ export class FormResultService extends ApiService {
             ...staleResults,
             saved
         ]);
+        await this.publishSubmissionEvent(saved, dto.formId, isDraft, user);
         return this.convertEntityToResponseDto(saved, false);
     }
     async getMyDraft(formId, user) {
@@ -256,8 +258,23 @@ export class FormResultService extends ApiService {
         await this.invalidateResultCache([
             saved
         ]);
+        await this.publishSubmissionEvent(saved, dto.formId, isDraft, user);
         return this.convertEntityToResponseDto(saved, false);
     }
+    async publishSubmissionEvent(result, formId, isDraft, user) {
+        await this.publishDomainAction(isDraft ? FORM_BUILDER_EVENT_ACTIONS.DRAFT_SAVED : FORM_BUILDER_EVENT_ACTIONS.SUBMITTED, {
+            ids: [
+                result.id
+            ],
+            data: result,
+            metadata: {
+                formId,
+                isDraft,
+                schemaVersion: result.schemaVersion
+            },
+            user
+        });
+    }
     async invalidateResultCache(results) {
         await Promise.all([
             this.clearCacheForAll(),

package/fesm/services/form-result.service.spec.js

@@ -1,4 +1,5 @@
 import { Test } from '@nestjs/testing';
+import { EventBusRegistry } from '@flusys/nestjs-shared/classes';
 import { UtilsService } from '@flusys/nestjs-shared/modules';
 import { createMockQueryBuilder, createMockRepository } from '@test-utils/mocks/repository.mock';
 import { buildMockUser } from '@test-utils/mocks/logged-user.mock';
@@ -700,4 +701,78 @@ describe('FormResultService', ()=>{
             expect(result).toBe(false);
         });
     });
+    describe('domain events', ()=>{
+        let publish;
+        beforeEach(()=>{
+            publish = jest.fn().mockResolvedValue(undefined);
+            EventBusRegistry.reset();
+            EventBusRegistry.setBus({
+                publish,
+                subscribe: jest.fn(),
+                close: jest.fn()
+            });
+            EventBusRegistry.configureModule('form-builder', {
+                enabled: true
+            });
+        });
+        afterEach(()=>{
+            EventBusRegistry.reset();
+        });
+        it('publishes form-builder.form_result.submitted for a final submission', async ()=>{
+            await buildService(false);
+            mockFormRepo.findOne.mockResolvedValue(buildForm({
+                accessType: FormAccessType.PUBLIC
+            }));
+            mockResultRepo.save.mockResolvedValue(buildFormResult({
+                isDraft: false
+            }));
+            await service.submitForm({
+                formId: 'form-uuid-1',
+                data: {}
+            }, null, true);
+            expect(publish).toHaveBeenCalledWith(expect.objectContaining({
+                name: 'form-builder.form_result.submitted',
+                action: 'submitted',
+                payload: expect.objectContaining({
+                    ids: [
+                        'result-uuid-1'
+                    ],
+                    metadata: expect.objectContaining({
+                        formId: 'form-uuid-1',
+                        isDraft: false
+                    })
+                })
+            }));
+        });
+        it('publishes form-builder.form_result.draft-saved when the submission is a draft', async ()=>{
+            await buildService(false);
+            mockFormRepo.findOne.mockResolvedValue(buildForm({
+                accessType: FormAccessType.PUBLIC
+            }));
+            mockResultRepo.save.mockResolvedValue(buildFormResult({
+                isDraft: true
+            }));
+            await service.submitForm({
+                formId: 'form-uuid-1',
+                data: {},
+                isDraft: true
+            }, null, true);
+            expect(publish.mock.calls[0][0].name).toBe('form-builder.form_result.draft-saved');
+        });
+        it('does not publish when the module has events disabled', async ()=>{
+            EventBusRegistry.configureModule('form-builder', {
+                enabled: false
+            });
+            await buildService(false);
+            mockFormRepo.findOne.mockResolvedValue(buildForm({
+                accessType: FormAccessType.PUBLIC
+            }));
+            mockResultRepo.save.mockResolvedValue(buildFormResult());
+            await service.submitForm({
+                formId: 'form-uuid-1',
+                data: {}
+            }, null, true);
+            expect(publish).not.toHaveBeenCalled();
+        });
+    });
 });

package/interfaces/form-builder-module.interface.d.ts

@@ -1,6 +1,8 @@
 import { ModuleMetadata, Type } from '@nestjs/common';
 import { IBootstrapAppConfig, IDataSourceServiceOptions, IDynamicModuleConfig, IModuleOptionsFactory } from '@flusys/nestjs-core';
+import { IModuleEventsConfig } from '@flusys/nestjs-shared/interfaces';
 export interface IFormBuilderConfig extends IDataSourceServiceOptions {
+    events?: IModuleEventsConfig;
 }
 export interface FormBuilderModuleOptions extends IDynamicModuleConfig {
     bootstrapAppConfig?: IBootstrapAppConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flusys/nestjs-form-builder",
-  "version": "6.4.1",
+  "version": "7.0.0-beta.1",
   "description": "Dynamic form builder module with schema versioning and access control",
   "main": "cjs/index.js",
   "module": "fesm/index.js",
@@ -84,7 +84,7 @@
     "express": "^5.0.0"
   },
   "dependencies": {
-    "@flusys/nestjs-core": "6.4.1",
-    "@flusys/nestjs-shared": "6.4.1"
+    "@flusys/nestjs-core": "7.0.0-beta.1",
+    "@flusys/nestjs-shared": "7.0.0-beta.1"
   }
 }

package/services/form-result.service.d.ts

@@ -33,6 +33,7 @@ export declare class FormResultService extends ApiService<CreateFormResultDto, U
     submitForm(dto: SubmitFormDto, user: ILoggedUserInfo | null, isPublic?: boolean): Promise<IFormResult>;
     getMyDraft(formId: string, user: ILoggedUserInfo): Promise<IFormResult | null>;
     updateDraft(draftId: string, dto: SubmitFormDto, user: ILoggedUserInfo): Promise<IFormResult>;
+    private publishSubmissionEvent;
     private invalidateResultCache;
     getByFormId(formId: string, user: ILoggedUserInfo | null, pagination?: {
         page?: number;