@edirect/template 1.0.3 → 1.0.6

package/README.md

@@ -1,6 +1,6 @@
 # @edirect/template
 
-The EDirectInsure template mapper module.
+TemplateModule is a library that provides methods to transform a payload based on a given template. The transformation includes mapping fields, applying transformers, setting default values and so on.
 
 ### Installation
 
@@ -8,6 +8,57 @@ The EDirectInsure template mapper module.
 $ npm i --save @edirect/template
 ```
 
+### Import
+
+```javascript
+import { TemplateModule } from "./TemplateModule";
+```
+
+### Methods
+
+#### `Constructor`
+
+The TemplateModule class does not have a constructor.
+
+#### `setContext(context): void`
+
+Sets the context object to be used during the transformation.
+
+#### `setTemplate(template): void`
+
+Sets the template object that describes the transformation to be performed.
+
+#### `setTransformers(transformers: ITransformer): void`
+
+Sets the transformers to be used during the transformation.
+
+#### `verifyTransformer(transformer: ITransformer, methodName: string): boolean`
+
+Verifies if a given transformer method exists.
+
+#### `runTransformer(transformer: string, value?: unknown): unknown | null`
+
+Runs a transformer on a given value.
+
+- transformer - The name of the transformer to be used.
+- value - The value to be transformed.
+
+#### `checkValue(value: any): boolean`
+
+Checks if a given value is not null, undefined, or an empty string.
+
+#### `setValueByCondition(object, key: string, value: unknown)`
+
+Sets a value in an object after verify using the checkValue() method.
+
+- object - The object to be modified.
+- key - The key of the value to be set.
+- value - The value to be set.
+
+#### `transformPayload<T, U>(obj: T, template = this.template): U`
+
+Transforms a payload object on a given template.
+
 ### Simple example
 
 ```javascript
@@ -367,3 +418,49 @@ console.log(result);
 //   },
 // }
 ```
+
+### Example inferring types to transformPayload
+
+```typescript
+import { TemplateModule } from "@edirect/template";
+
+interface DataSource {
+  subscriber: {
+    firstName: string;
+    lastName: string;
+  };
+}
+
+interface TransformedData {
+  edirect_firstname: string;
+  edirect_lastname: string;
+}
+
+function transformData(dataSource: DataSource): TransformedData {
+  const template = {
+    edirect_firstname: "subscriber.firstName",
+    edirect_lastname: "subscriber.lastName",
+  };
+
+  const templateModule = new TemplateModule();
+  templateModule.setTemplate(template);
+
+  return templateModule.transformPayload<DataSource, TransformedData>(
+    dataSource
+  );
+}
+
+const dataSource = {
+  subscriber: {
+    firstName: "template",
+    lastName: "service",
+  },
+};
+
+console.log(transformData(dataSource));
+
+// {
+//   edirect_firstname: "template",
+//   edirect_lastname: "service",
+// }
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edirect/template",
-  "version": "1.0.3",
+  "version": "1.0.6",
   "description": "Template Module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",