feat(returner): add new type (#20)

https://make.atlassian.net/browse/CDM-13296

add new `returner` type to proto lib

this type will be used to return data from scenarios

Author: ivangelus

src/base.ts

@@ -30,6 +30,7 @@ export enum ModuleType {
   CONVERGER = 9,
   HITL = 10,
   PAUSER = 11,
+  RETURNER = 12,
 }
 
 /**
@@ -60,6 +61,7 @@ export class IMTBase extends EventEmitter {
   public static readonly MODULETYPE_CONVERGER = ModuleType.CONVERGER;
   public static readonly MODULETYPE_HITL = ModuleType.HITL;
   public static readonly MODULETYPE_PAUSER = ModuleType.PAUSER;
+  public static readonly MODULETYPE_RETURNER = ModuleType.RETURNER;
 
   public common: CommonData | null = null;
   public data: ModuleData | null = null;

src/global.ts

@@ -46,6 +46,7 @@ declare global {
   var IMTFeeder: typeof publicApi.IMTFeeder;
   var IMTTransformer: typeof publicApi.IMTTransformer;
   var IMTHITL: typeof publicApi.IMTHITL;
+  var IMTReturner: typeof publicApi.IMTReturner;
   /* eslint-enable no-var */
 }
 
@@ -98,4 +99,5 @@ if (!global.IMT_PROTO_LOADED) {
   global.IMTFeeder = publicApi.IMTFeeder;
   global.IMTTransformer = publicApi.IMTTransformer;
   global.IMTHITL = publicApi.IMTHITL;
+  global.IMTReturner = publicApi.IMTReturner;
 }

src/index.ts

@@ -15,3 +15,4 @@ export * from './listener';
 export * from './converger';
 export * from './aggregator';
 export * from './transformer';
+export * from './returner';

src/returner.ts

@@ -0,0 +1,22 @@
+import { IMTBase, ModuleType } from './base';
+import { Bundle, DoneWithResultCallback } from './types';
+
+export class IMTReturner extends IMTBase {
+  public readonly type = ModuleType.RETURNER;
+
+  /**
+   * Returns data.
+   *
+   * @param {Object} bundle Collection of data to process.
+   * @callback done Callback to call when operations are done.
+   *     @param {Error} err Error on error, otherwise null.
+   *     @param {Bundle} bundle Collection of returned data.
+   *
+   */
+
+  returnData(bundle: Bundle, done: DoneWithResultCallback): void {
+    void bundle;
+    void done;
+    throw new Error("Must override a superclass method 'returnData'.");
+  }
+}

test/legacy-compatibility.test.ts

@@ -20,6 +20,7 @@ describe('Legacy Compatibility', () => {
     IMTRPC,
     IMTFeeder,
     IMTTransformer,
+    IMTReturner,
   ];
 
   it('exports global variables', () => {
@@ -66,6 +67,7 @@ describe('Legacy Compatibility', () => {
     expect(global.IMTFeeder).toBeDefined();
     expect(global.IMTTransformer).toBeDefined();
     expect(global.IMTHITL).toBeDefined();
+    expect(global.IMTReturner).toBeDefined();
   });
 
   it('should have same values for globals and for public API', () => {
@@ -107,6 +109,7 @@ describe('Legacy Compatibility', () => {
     expect(global.IMTFeeder === publicApi.IMTFeeder).toBe(true);
     expect(global.IMTTransformer === publicApi.IMTTransformer).toBe(true);
     expect(global.IMTHITL === publicApi.IMTHITL).toBe(true);
+    expect(global.IMTReturner === publicApi.IMTReturner).toBe(true);
   });
 
   it('should be compatible with CoffeeScript classes', () => {

test/module-type.spec.ts

@@ -9,6 +9,7 @@ import {
   IMTRouter,
   IMTTransformer,
   IMTTrigger,
+  IMTReturner,
   ModuleType,
 } from '../src';
 
@@ -25,6 +26,7 @@ describe('ModuleType', () => {
       new IMTRouter(),
       new IMTTransformer(),
       new IMTTrigger(),
+      new IMTReturner(),
     ];
 
     for (const module of allModuleTypes) {
@@ -60,6 +62,9 @@ describe('ModuleType', () => {
         case ModuleType.PAUSER:
           expect(module).toBeInstanceOf(IMTPauser);
           break;
+        case ModuleType.RETURNER:
+          expect(module).toBeInstanceOf(IMTReturner);
+          break;
         default:
           throw new Error('Unexpected module type');
       }