@edirect/template 1.5.1 → 11.0.17

package/README.md

@@ -11,7 +11,7 @@ $ npm i --save @edirect/template
 ### Import
 
 ```javascript
-import { TemplateModule } from "./TemplateModule";
+import { TemplateModule } from './TemplateModule';
 ```
 
 ### Methods
@@ -66,17 +66,17 @@ Transforms a payload object on a given template.
 ### Simple example
 
 ```javascript
-import { TemplateModule } from "@edirect/template";
+import { TemplateModule } from '@edirect/template';
 
 const template = {
-  edirect_firstname: "subscriber.firstName",
-  edirect_lastname: "subscriber.lastName",
+  edirect_firstname: 'subscriber.firstName',
+  edirect_lastname: 'subscriber.lastName',
 };
 
 const dataSource = {
   subscriber: {
-    firstName: "template",
-    lastName: "service",
+    firstName: 'template',
+    lastName: 'service',
   },
 };
 
@@ -147,34 +147,34 @@ export default transformers;
 ##### File name: index.ts
 
 ```javascript
-import { TemplateModule } from "@edirect/template";
-import baseTransformers from "./baseTransformers";
+import { TemplateModule } from '@edirect/template';
+import baseTransformers from './baseTransformers';
 
 const template = {
   edirect_firstname: {
-    fields: ["firstName", "subscriber.firstName"],
-    transformer: "upperCase",
-    defaultValue: "First Name - Default",
+    fields: ['firstName', 'subscriber.firstName'],
+    transformer: 'upperCase',
+    defaultValue: 'First Name - Default',
   },
   edirect_lastname: {
-    fields: ["lastName", "subscriber.lastName"],
+    fields: ['lastName', 'subscriber.lastName'],
   },
   edirect_fullname: {
-    transformer: "fullName",
+    transformer: 'fullName',
   },
   edirect_phone: {
-    fields: ["phoneNumber", "subscriber.phoneNumber"],
-    defaultValue: "999999999",
+    fields: ['phoneNumber', 'subscriber.phoneNumber'],
+    defaultValue: '999999999',
   },
   timeZone: {
-    defaultValue: "Time zone in Porto (GMT+1)",
+    defaultValue: 'Time zone in Porto (GMT+1)',
   },
 };
 
 const dataSource = {
   subscriber: {
-    firstName: "template",
-    lastName: "service",
+    firstName: 'template',
+    lastName: 'service',
   },
 };
 
@@ -219,33 +219,33 @@ export default transformers;
 ##### File name: index.ts
 
 ```javascript
-import { TemplateModule } from "@edirect/template";
-import baseTransformers from "./baseTransformers";
+import { TemplateModule } from '@edirect/template';
+import baseTransformers from './baseTransformers';
 
 const template = {
   order: {
-    date: "order.date",
-    value: "order.value",
+    date: 'order.date',
+    value: 'order.value',
     subscriber: {
-      name: "sub.name",
-      phone: "sub.phone",
+      name: 'sub.name',
+      phone: 'sub.phone',
       email: {
-        fields: ["email", "sub.email"],
+        fields: ['email', 'sub.email'],
       },
       address: {
-        street: "sub.add.stt",
-        number: "sub.add.num",
+        street: 'sub.add.stt',
+        number: 'sub.add.num',
         city: {
-          fields: ["sub.add.city"],
-          transformer: "upperCase",
+          fields: ['sub.add.city'],
+          transformer: 'upperCase',
         },
         state: {
-          fields: ["sub.add.stt"],
-          transformer: "upperCase",
+          fields: ['sub.add.stt'],
+          transformer: 'upperCase',
         },
         zip: {
-          fields: ["sub.add.zip"],
-          defaultValue: "0000-000",
+          fields: ['sub.add.zip'],
+          defaultValue: '0000-000',
         },
       },
     },
@@ -255,18 +255,18 @@ const template = {
 const dataSource = {
   order: {
     value: 1000.0,
-    date: "2000-01-01",
+    date: '2000-01-01',
   },
   sub: {
-    name: "name-test",
-    phone: "999999999",
-    email: "template.service@bolltech.io",
+    name: 'name-test',
+    phone: '999999999',
+    email: 'template.service@bolltech.io',
     add: {
-      st: "st-test",
+      st: 'st-test',
       num: 100,
-      city: "city-test",
-      stt: "state-test",
-      zip: "zip-test",
+      city: 'city-test',
+      stt: 'state-test',
+      zip: 'zip-test',
     },
   },
 };
@@ -326,27 +326,27 @@ export default transformers;
 ##### File name: index.ts
 
 ```javascript
-import { TemplateModule } from "@edirect/template";
-import baseTransformers from "./baseTransformers";
+import { TemplateModule } from '@edirect/template';
+import baseTransformers from './baseTransformers';
 
 const template = {
   quote: {
     orders: {
-      arraySource: "order",
+      arraySource: 'order',
       arrayTemplate: {
-        value: "value",
-        date: "date",
+        value: 'value',
+        date: 'date',
         products: {
-          arraySource: "products",
+          arraySource: 'products',
           arrayTemplate: {
-            id: "id",
-            value: "value",
+            id: 'id',
+            value: 'value',
             description: {
-              fields: ["description"],
-              transformer: "upperCase",
-              defaultValue: "Default description",
+              fields: ['description'],
+              transformer: 'upperCase',
+              defaultValue: 'Default description',
             },
-            categories: "categories",
+            categories: 'categories',
           },
         },
       },
@@ -358,24 +358,24 @@ const dataSource = {
   order: [
     {
       value: 1000.0,
-      date: "2000-01-01",
+      date: '2000-01-01',
       products: [
         {
-          id: "id-test-1",
+          id: 'id-test-1',
           value: 1000,
-          description: "description-test 1",
-          categories: ["category-1"],
+          description: 'description-test 1',
+          categories: ['category-1'],
         },
         {
-          id: "id-test-2",
+          id: 'id-test-2',
           value: 2000,
-          description: "description-test 2",
-          categories: ["category-1", "category-2"],
+          description: 'description-test 2',
+          categories: ['category-1', 'category-2'],
         },
         {
-          id: "id-test-3",
+          id: 'id-test-3',
           value: 3000,
-          categories: ["category-1", "category-2", "category-3"],
+          categories: ['category-1', 'category-2', 'category-3'],
         },
       ],
     },
@@ -429,7 +429,7 @@ console.log(result);
 
 - `arraySource`: source path where the engine will seek the information to mapper
 - `arrayTemplate`: template that will be used for each object within the array
-- `ignoreIndexs`: array with the index position that must be ignore 
+- `ignoreIndexs`: array with the index position that must be ignore
 
 ##### File name: baseTransformers.ts
 
@@ -450,29 +450,29 @@ export default transformers;
 ##### File name: index.ts
 
 ```javascript
-import { TemplateModule } from "@edirect/template";
-import baseTransformers from "./baseTransformers";
+import { TemplateModule } from '@edirect/template';
+import baseTransformers from './baseTransformers';
 
 const template = {
   quote: {
     orders: {
-      arraySource: "order",
+      arraySource: 'order',
       arrayTemplate: {
-        value: "value",
-        date: "date",
+        value: 'value',
+        date: 'date',
         products: {
-          arraySource: "products",
+          arraySource: 'products',
           arrayTemplate: {
-            id: "id",
-            value: "value",
+            id: 'id',
+            value: 'value',
             description: {
-              fields: ["description"],
-              transformer: "upperCase",
-              defaultValue: "Default description",
+              fields: ['description'],
+              transformer: 'upperCase',
+              defaultValue: 'Default description',
             },
-            categories: "categories",
+            categories: 'categories',
           },
-          ignoreIndexs: [0]
+          ignoreIndexs: [0],
         },
       },
     },
@@ -483,24 +483,24 @@ const dataSource = {
   order: [
     {
       value: 1000.0,
-      date: "2000-01-01",
+      date: '2000-01-01',
       products: [
         {
-          id: "id-test-1",
+          id: 'id-test-1',
           value: 1000,
-          description: "description-test 1",
-          categories: ["category-1"],
+          description: 'description-test 1',
+          categories: ['category-1'],
         },
         {
-          id: "id-test-2",
+          id: 'id-test-2',
           value: 2000,
-          description: "description-test 2",
-          categories: ["category-1", "category-2"],
+          description: 'description-test 2',
+          categories: ['category-1', 'category-2'],
         },
         {
-          id: "id-test-3",
+          id: 'id-test-3',
           value: 3000,
-          categories: ["category-1", "category-2", "category-3"],
+          categories: ['category-1', 'category-2', 'category-3'],
         },
       ],
     },
@@ -577,38 +577,38 @@ export default transformers;
 ##### File name: index.ts
 
 ```javascript
-import { TemplateModule } from "@edirect/template";
-import baseTransformers from "./baseTransformers";
+import { TemplateModule } from '@edirect/template';
+import baseTransformers from './baseTransformers';
 
 const template = {
-  status: "status",
+  status: 'status',
   concatenated_result: {
-    fields: ["lead_id"],
-    transformer: "concat",
+    fields: ['lead_id'],
+    transformer: 'concat',
     transformerParams: [
-      "-",
-      "${person_number}",
-      "/",
-      "${person_number2}",
-      "_",
-      "${person_number3}",
+      '-',
+      '${person_number}',
+      '/',
+      '${person_number2}',
+      '_',
+      '${person_number3}',
     ],
   },
   concatenated_result2: {
-    fields: ["lead_id"],
-    transformer: "concatWithSeparator",
+    fields: ['lead_id'],
+    transformer: 'concatWithSeparator',
     transformerParams: [
-      "-",
-      "${person_number}",
-      "${person_number2}",
-      "${person_number3}",
+      '-',
+      '${person_number}',
+      '${person_number2}',
+      '${person_number3}',
     ],
   },
 };
 
 const dataSource = {
   status: true,
-  lead_id: "FR-14af3f",
+  lead_id: 'FR-14af3f',
   person_number: 123,
   person_number2: 456,
   person_number3: 789,
@@ -653,24 +653,24 @@ export default transformers;
 ##### File name: index.ts
 
 ```javascript
-import { TemplateModule } from "@edirect/template";
-import baseTransformers from "./baseTransformers";
+import { TemplateModule } from '@edirect/template';
+import baseTransformers from './baseTransformers';
 
 const template = {
   status: {
-    fields: ["status"],
-    transformer: "translator",
+    fields: ['status'],
+    transformer: 'translator',
     transformerParams: [
       {
-        ERROR: "ERROR",
-        RECHAZADA: "REJECTED",
+        ERROR: 'ERROR',
+        RECHAZADA: 'REJECTED',
       },
     ],
   },
 };
 
 const dataSource = {
-  status: "RECHAZADA",
+  status: 'RECHAZADA',
 };
 
 const templateModule = new TemplateModule();
@@ -752,46 +752,38 @@ export default transformers;
 ##### File name: index.ts
 
 ```javascript
-import { TemplateModule } from "@edirect/template";
-import baseTransformers from "./baseTransformers";
+import { TemplateModule } from '@edirect/template';
+import baseTransformers from './baseTransformers';
 
 const template = {
   age: {
     transformers: [
       {
-        fields: [
-          "data.externalReferences"
-        ],
-        transformer: "findKeyInArrayGetField",
-        transformerParams: [
-          "type",
-          "birthDate",
-          "value"
-        ]
+        fields: ['data.externalReferences'],
+        transformer: 'findKeyInArrayGetField',
+        transformerParams: ['type', 'birthDate', 'value'],
       },
       {
-        transformer: "calculateAgeByBirthdate",
-        transformerParams: [
-          "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
-        ]
-      }
-    ]
-  }
+        transformer: 'calculateAgeByBirthdate',
+        transformerParams: ["yyyy-MM-dd'T'HH:mm:ss.SSSXXX"],
+      },
+    ],
+  },
 };
 
 const dataSource = {
   data: {
     externalReferences: [
       {
-        type: "randomKey",
-        value: "randomValue"
+        type: 'randomKey',
+        value: 'randomValue',
       },
       {
-        type: "birthDate",
-        value: "1995-12-27T15:22:32.511+00:00"
-      }
-    ]
-  }
+        type: 'birthDate',
+        value: '1995-12-27T15:22:32.511+00:00',
+      },
+    ],
+  },
 };
 
 const templateModule = new TemplateModule();
@@ -809,10 +801,12 @@ console.log(result);
 ```
 
 In this example:
+
 1. The first transformer (`findKeyInArrayGetField`) extracts the birthdate value from the array of external references
 2. The second transformer (`calculateAgeByBirthdate`) calculates the age from the birthdate
 
 The transformers are applied sequentially, with each one receiving the result of the previous transformation as its input value.
+
 ### Example with DynamicArrayMapper in transformers array
 
 The library now supports using DynamicArrayMapper as an element in the transformers array. This allows you to dynamically process arrays within a transformation sequence.
@@ -924,6 +918,7 @@ Expected output:
 ```
 
 In this example:
+
 1. We have a regular transformer that capitalizes the user's name
 2. The second transformer in the sequence is a DynamicArrayMapper that processes the contacts array
 3. The result is a transformed array of contact information
@@ -939,17 +934,17 @@ const templateWithMultipleTransformers = {
         arraySource: 'contacts',
         arrayTemplate: {
           type: 'type',
-          value: 'value'
-        }
+          value: 'value',
+        },
       },
       // Format phone numbers in the array
       {
         fields: ['1.value'], // Access the phone number (index 1 in the array)
         transformer: 'formatPhone',
-        allowNull: false
-      }
-    ]
-  }
+        allowNull: false,
+      },
+    ],
+  },
 };
 ```
 
@@ -958,7 +953,7 @@ This combination allows for powerful and flexible data transformations.
 ### Example inferring types to transformPayload
 
 ```typescript
-import { TemplateModule } from "@edirect/template";
+import { TemplateModule } from '@edirect/template';
 
 interface DataSource {
   subscriber: {
@@ -974,8 +969,8 @@ interface TransformedData {
 
 function transformData(dataSource: DataSource): TransformedData {
   const template = {
-    edirect_firstname: "subscriber.firstName",
-    edirect_lastname: "subscriber.lastName",
+    edirect_firstname: 'subscriber.firstName',
+    edirect_lastname: 'subscriber.lastName',
   };
 
   const templateModule = new TemplateModule();
@@ -986,8 +981,8 @@ function transformData(dataSource: DataSource): TransformedData {
 
 const dataSource = {
   subscriber: {
-    firstName: "template",
-    lastName: "service",
+    firstName: 'template',
+    lastName: 'service',
   },
 };
 
@@ -1006,19 +1001,19 @@ Options:
 - omitEmptyFields?: boolean;
 
 ```js
-import { TemplateModule } from "@edirect/template";
+import { TemplateModule } from '@edirect/template';
 
 const template = {
-  edirect_firstname: "subscriber.firstName",
-  edirect_lastname: "subscriber.lastName",
-  edirect_age: "subscriber.age",
+  edirect_firstname: 'subscriber.firstName',
+  edirect_lastname: 'subscriber.lastName',
+  edirect_age: 'subscriber.age',
 };
 
 const dataSource = {
   subscriber: {
-    firstName: "template",
-    lastName: "service",
-    age: "",
+    firstName: 'template',
+    lastName: 'service',
+    age: '',
   },
 };
 
@@ -1041,24 +1036,24 @@ console.log(result);
 ### Example using simple arrays
 
 ```js
-import { TemplateModule } from "@edirect/template";
+import { TemplateModule } from '@edirect/template';
 
 const template = {
   emails: {
-    arraySource: "subscriber.emails",
+    arraySource: 'subscriber.emails',
     simpleArray: true,
     arrayTemplate: {
       type: {
-        defaultValue: "personal",
+        defaultValue: 'personal',
       },
-      value: "value",
+      value: 'value',
     },
   },
 };
 
 const dataSource = {
   subscriber: {
-    emails: ["johndoe@example.com", "janedoe@example.com"],
+    emails: ['johndoe@example.com', 'janedoe@example.com'],
   },
 };
 
@@ -1083,4 +1078,4 @@ console.log(result);
     ]
   }
 */
-```
+```