@edirect/template 11.0.40 → 11.0.41

package/README.md

@@ -1,69 +1,87 @@
 # @edirect/template
 
-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.
+`@edirect/template` is a flexible library for transforming payloads based on declarative templates. It supports mapping fields, applying custom transformers, setting default values, handling nested objects, and working with arrays.
 
-### Installation
+## Features
 
-```shell
-$ npm i --save @edirect/template
+- Declarative template-based payload transformation
+- Custom transformer functions for mapping, validation, formatting, and business rules
+- Support for nested objects and arrays
+- Default values and context-aware mapping
+- Sequential transformers and transformer parameters
+
+---
+
+## Installation
+
+```sh
+pnpm add @edirect/template
+# or
+npm install @edirect/template
 ```
 
-### Import
+## Usage
 
-```javascript
-import { TemplateModule } from './TemplateModule';
+Import the module:
+
+```js
+import { TemplateModule } from '@edirect/template';
 ```
 
-### Methods
+## API
 
-#### `Constructor`
+### Constructor
 
-The TemplateModule class does not have a constructor.
+The `TemplateModule` class can be instantiated directly:
 
-#### `setContext(context): void`
+```js
+const templateModule = new TemplateModule();
+```
 
-Sets the context object to be used during the transformation.
+### setContext(context: object): void
 
-#### `setTemplate(template): void`
+Sets the context object to be used during transformation.
+
+### setTemplate(template: object): void
 
 Sets the template object that describes the transformation to be performed.
 
-#### `setTransformers(transformers: ITransformer): void`
+### setTransformers(transformers: ITransformer): void
 
 Sets the transformers to be used during the transformation.
 
-#### `setOptions(transformers: ITemplateOptions): void`
+### setOptions(options: ITemplateOptions): void
 
-Sets the options to be used during and after the transformation.
+Sets options to be used during and after the transformation.
 
-#### `verifyTransformer(transformer: ITransformer, methodName: string): boolean`
+### verifyTransformer(transformer: ITransformer, methodName: string): boolean
 
 Verifies if a given transformer method exists.
 
-#### `runTransformer(transformer: string, value?: unknown): unknown | null`
+### 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.
+- `transformer`: The name of the transformer to use
+- `value`: The value to be transformed
 
-#### `checkValue(value: any): boolean`
+### checkValue(value: any): boolean
 
 Checks if a given value is not null, undefined, or an empty string.
 
-#### `setValueByCondition(object, key: string, value: unknown)`
+### setValueByCondition(object, key: string, value: unknown)
 
-Sets a value in an object after verify using the checkValue() method.
+Sets a value in an object after verifying with `checkValue()`.
 
-- object - The object to be modified.
-- key - The key of the value to be set.
-- value - The value to be set.
+- `object`: The object to modify
+- `key`: The key to set
+- `value`: The value to set
 
-#### `transformPayload<T, U>(obj: T, template = this.template): U`
+### transformPayload<T, U>(obj: T, template = this.template): U
 
-Transforms a payload object on a given template.
+Transforms a payload object using the provided template.
 
-### Simple example
+## Simple Example
 
 ```javascript
 import { TemplateModule } from '@edirect/template';
@@ -93,7 +111,7 @@ console.log(result);
 // }
 ```
 
-### Example with transformers
+## Example with Transformers
 
 #### First of all, what's a transformer?
 
@@ -196,7 +214,7 @@ console.log(result);
 // }
 ```
 
-### Example with nested object + transformers
+## Example with Nested Object + Transformers
 
 `Note`: the transformer notation uses three keys to identify an object as being a transformer: fields, transformer, and defaultValue, if there are at least 1 of these keys, the engine will consider the object as being a transformer, on the other hand, if there isn't, the engine will consider as a nested object to mapper all information.
 
@@ -300,7 +318,7 @@ console.log(result);
 // }
 ```
 
-### Example with arrays + transformers
+## Example with Arrays + Transformers
 
 `Note`: When it comes to arrays mapper, we need to have in mind that is required use this two keys: arraySource and arrayTemplate.
 
@@ -423,7 +441,7 @@ console.log(result);
 // }
 ```
 
-### Example with arrays + ignoreIndexs
+## Example with Arrays + ignoreIndexs
 
 `Note`: When it comes to arrays mapper, we need to have in mind that is required use this two keys: arraySource and arrayTemplate.
 
@@ -542,7 +560,7 @@ console.log(result);
 // }
 ```
 
-### Template example with transformer + transformerParams
+## Example: Transformer + transformerParams
 
 ##### File name: baseTransformers.ts
 
@@ -630,7 +648,7 @@ console.log(result);
 // }
 ```
 
-### Template example with transformer + transformerParams + complexParams
+## Example: Transformer + transformerParams + complexParams
 
 ##### File name: baseTransformers.ts
 
@@ -687,7 +705,7 @@ console.log(result);
 // }
 ```
 
-### Example with Sequential Transformers
+## Example: Sequential Transformers
 
 The library now supports applying multiple transformers sequentially to a single field. This is particularly useful for more complex transformations that require multiple steps.
 
@@ -1033,7 +1051,23 @@ console.log(result);
 // }
 ```
 
-### Example using simple arrays
+## Example: Simple Arrays
+
+## Configuration & Environment Variables
+
+`@edirect/template` is a pure JavaScript/TypeScript library and does not require any environment variables by default. However, if your custom transformers or templates depend on environment-specific values, you can inject them via your application context or configuration system.
+
+For example, you can pass environment variables into the context:
+
+```js
+const context = {
+  ...process.env,
+  // other context values
+};
+templateModule.setContext(context);
+```
+
+**Note:** Never commit sensitive credentials to version control. Use environment variables or secure secrets management as appropriate for your application.
 
 ```js
 import { TemplateModule } from '@edirect/template';

package/dist/README.md

@@ -1,69 +1,87 @@
 # @edirect/template
 
-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.
+`@edirect/template` is a flexible library for transforming payloads based on declarative templates. It supports mapping fields, applying custom transformers, setting default values, handling nested objects, and working with arrays.
 
-### Installation
+## Features
 
-```shell
-$ npm i --save @edirect/template
+- Declarative template-based payload transformation
+- Custom transformer functions for mapping, validation, formatting, and business rules
+- Support for nested objects and arrays
+- Default values and context-aware mapping
+- Sequential transformers and transformer parameters
+
+---
+
+## Installation
+
+```sh
+pnpm add @edirect/template
+# or
+npm install @edirect/template
 ```
 
-### Import
+## Usage
 
-```javascript
-import { TemplateModule } from './TemplateModule';
+Import the module:
+
+```js
+import { TemplateModule } from '@edirect/template';
 ```
 
-### Methods
+## API
 
-#### `Constructor`
+### Constructor
 
-The TemplateModule class does not have a constructor.
+The `TemplateModule` class can be instantiated directly:
 
-#### `setContext(context): void`
+```js
+const templateModule = new TemplateModule();
+```
 
-Sets the context object to be used during the transformation.
+### setContext(context: object): void
 
-#### `setTemplate(template): void`
+Sets the context object to be used during transformation.
+
+### setTemplate(template: object): void
 
 Sets the template object that describes the transformation to be performed.
 
-#### `setTransformers(transformers: ITransformer): void`
+### setTransformers(transformers: ITransformer): void
 
 Sets the transformers to be used during the transformation.
 
-#### `setOptions(transformers: ITemplateOptions): void`
+### setOptions(options: ITemplateOptions): void
 
-Sets the options to be used during and after the transformation.
+Sets options to be used during and after the transformation.
 
-#### `verifyTransformer(transformer: ITransformer, methodName: string): boolean`
+### verifyTransformer(transformer: ITransformer, methodName: string): boolean
 
 Verifies if a given transformer method exists.
 
-#### `runTransformer(transformer: string, value?: unknown): unknown | null`
+### 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.
+- `transformer`: The name of the transformer to use
+- `value`: The value to be transformed
 
-#### `checkValue(value: any): boolean`
+### checkValue(value: any): boolean
 
 Checks if a given value is not null, undefined, or an empty string.
 
-#### `setValueByCondition(object, key: string, value: unknown)`
+### setValueByCondition(object, key: string, value: unknown)
 
-Sets a value in an object after verify using the checkValue() method.
+Sets a value in an object after verifying with `checkValue()`.
 
-- object - The object to be modified.
-- key - The key of the value to be set.
-- value - The value to be set.
+- `object`: The object to modify
+- `key`: The key to set
+- `value`: The value to set
 
-#### `transformPayload<T, U>(obj: T, template = this.template): U`
+### transformPayload<T, U>(obj: T, template = this.template): U
 
-Transforms a payload object on a given template.
+Transforms a payload object using the provided template.
 
-### Simple example
+## Simple Example
 
 ```javascript
 import { TemplateModule } from '@edirect/template';
@@ -93,7 +111,7 @@ console.log(result);
 // }
 ```
 
-### Example with transformers
+## Example with Transformers
 
 #### First of all, what's a transformer?
 
@@ -196,7 +214,7 @@ console.log(result);
 // }
 ```
 
-### Example with nested object + transformers
+## Example with Nested Object + Transformers
 
 `Note`: the transformer notation uses three keys to identify an object as being a transformer: fields, transformer, and defaultValue, if there are at least 1 of these keys, the engine will consider the object as being a transformer, on the other hand, if there isn't, the engine will consider as a nested object to mapper all information.
 
@@ -300,7 +318,7 @@ console.log(result);
 // }
 ```
 
-### Example with arrays + transformers
+## Example with Arrays + Transformers
 
 `Note`: When it comes to arrays mapper, we need to have in mind that is required use this two keys: arraySource and arrayTemplate.
 
@@ -423,7 +441,7 @@ console.log(result);
 // }
 ```
 
-### Example with arrays + ignoreIndexs
+## Example with Arrays + ignoreIndexs
 
 `Note`: When it comes to arrays mapper, we need to have in mind that is required use this two keys: arraySource and arrayTemplate.
 
@@ -542,7 +560,7 @@ console.log(result);
 // }
 ```
 
-### Template example with transformer + transformerParams
+## Example: Transformer + transformerParams
 
 ##### File name: baseTransformers.ts
 
@@ -630,7 +648,7 @@ console.log(result);
 // }
 ```
 
-### Template example with transformer + transformerParams + complexParams
+## Example: Transformer + transformerParams + complexParams
 
 ##### File name: baseTransformers.ts
 
@@ -687,7 +705,7 @@ console.log(result);
 // }
 ```
 
-### Example with Sequential Transformers
+## Example: Sequential Transformers
 
 The library now supports applying multiple transformers sequentially to a single field. This is particularly useful for more complex transformations that require multiple steps.
 
@@ -1033,7 +1051,23 @@ console.log(result);
 // }
 ```
 
-### Example using simple arrays
+## Example: Simple Arrays
+
+## Configuration & Environment Variables
+
+`@edirect/template` is a pure JavaScript/TypeScript library and does not require any environment variables by default. However, if your custom transformers or templates depend on environment-specific values, you can inject them via your application context or configuration system.
+
+For example, you can pass environment variables into the context:
+
+```js
+const context = {
+  ...process.env,
+  // other context values
+};
+templateModule.setContext(context);
+```
+
+**Note:** Never commit sensitive credentials to version control. Use environment variables or secure secrets management as appropriate for your application.
 
 ```js
 import { TemplateModule } from '@edirect/template';

package/dist/package.json

@@ -16,12 +16,12 @@
     "dist"
   ],
   "dependencies": {
-    "lodash": "^4.17.21",
+    "lodash": "^4.17.23",
     "tslib": "^2.8.1"
   },
   "devDependencies": {
     "@types/lodash": "^4.17.23",
-    "@types/node": "^25.0.9"
+    "@types/node": "^25.0.10"
   },
   "type": "commonjs"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edirect/template",
-  "version": "11.0.40",
+  "version": "11.0.41",
   "packageScope": "@edirect",
   "main": "./dist/src/index.js",
   "types": "./dist/src/index.d.ts",
@@ -17,12 +17,12 @@
     "dist"
   ],
   "dependencies": {
-    "lodash": "^4.17.21",
+    "lodash": "^4.17.23",
     "tslib": "^2.8.1"
   },
   "devDependencies": {
     "@types/lodash": "^4.17.23",
-    "@types/node": "^25.0.9"
+    "@types/node": "^25.0.10"
   },
   "nx": {
     "name": "@edirect/template",