mapper-factory 2.0.3 → 3.0.1

package/dist/functions.js

@@ -10,85 +10,57 @@ const field_decorator_1 = require("./field.decorator");
 function toMap() {
     const metadataList = (0, field_decorator_1.getMapFieldMetadataList)(this);
     let obj = {};
+    const processProperty = (objCopy, propsStereoid, value, reverser) => {
+        let lastIndex;
+        for (let i = 0; i < propsStereoid.length; i++) {
+            const prop = propsStereoid[i];
+            if (prop.isArray) {
+                let arrIndex = prop.arrIndex.split(/\[(\w+)\]/g).filter(index => index !== '');
+                objCopy[prop.prop] = objCopy[prop.prop] || [];
+                objCopy = objCopy[prop.prop];
+                arrIndex.forEach((index, i) => {
+                    objCopy[index] = objCopy[index] || (i == arrIndex.length - 1 ? {} : []);
+                    if (i != arrIndex.length - 1)
+                        objCopy = objCopy[index];
+                    else
+                        lastIndex = index;
+                });
+            }
+            else {
+                objCopy[prop.prop] = objCopy[prop.prop] || {};
+                if (i != propsStereoid.length - 1)
+                    objCopy = objCopy[prop.prop];
+                else
+                    lastIndex = prop.prop;
+            }
+        }
+        objCopy[lastIndex] = reverser ? reverser(value, this) : value;
+    };
     this && Object.keys(this).forEach(propertyName => {
-        if (metadataList && Object.keys(metadataList).some(prop => prop == propertyName)) {
-            const src = metadataList[propertyName].src || propertyName;
+        const metadata = metadataList && metadataList[propertyName];
+        const src = metadata?.src || propertyName;
+        if (metadata) {
             if (src.includes('.')) {
                 let props = src.split('.');
-                let propsStereoid = props.map(prop => {
-                    let index = prop.indexOf('[');
-                    return {
-                        prop: index > 0 ? prop.substring(0, index) : prop,
-                        isArray: prop.includes('[') && prop.includes(']'),
-                        arrIndex: prop.substring(index),
-                    };
-                });
-                let i;
-                let objCopy = obj;
-                let lastIndex;
-                for (i = 0; i < propsStereoid?.length; i++) {
-                    if (propsStereoid[i].isArray) {
-                        let arrIndex = propsStereoid[i].arrIndex?.split(/\[(\w+)\]/g)?.filter(index => index !== '');
-                        objCopy[propsStereoid[i].prop] = objCopy[propsStereoid[i].prop] || [];
-                        objCopy = objCopy[propsStereoid[i].prop];
-                        arrIndex.forEach((index, i) => {
-                            objCopy[index] = objCopy[index] || (i == arrIndex.length - 1 ? {} : []);
-                            if (!(i == propsStereoid.length - 1))
-                                objCopy = objCopy[index];
-                            else
-                                lastIndex = index;
-                        });
-                    }
-                    else {
-                        objCopy[propsStereoid[i].prop] = objCopy[propsStereoid[i].prop] || {};
-                        if (!(i == propsStereoid?.length - 1))
-                            objCopy = objCopy[propsStereoid[i].prop];
-                        else
-                            lastIndex = propsStereoid[i].prop;
-                    }
-                }
-                if (Array.isArray(this[propertyName])) {
-                    objCopy[lastIndex] = metadataList[propertyName].reverser ?
-                        metadataList[propertyName].reverser(this[propertyName], this)
-                        : this[propertyName].map(item => {
-                            return item?.toMap ? item.toMap() : item;
-                        });
-                }
-                else if (metadataList[propertyName].toMap) {
-                    objCopy[lastIndex] = this[propertyName]?.toMap();
-                }
-                else {
-                    objCopy[lastIndex] = metadataList[propertyName].reverser ? metadataList[propertyName].reverser(this[propertyName], this) : this[propertyName];
-                }
+                let propsStereoid = props.map(prop => ({
+                    prop: prop.includes('[') ? prop.substring(0, prop.indexOf('[')) : prop,
+                    isArray: prop.includes('[') && prop.includes(']'),
+                    arrIndex: prop.substring(prop.indexOf('[')),
+                }));
+                processProperty(obj, propsStereoid, this[propertyName], metadata.reverser);
             }
             else {
-                /*if (metadataList[propertyName]?.initialize && metadataList[propertyName]?.reverser) {
-                    const revObj = metadataList[propertyName]?.reverser(this[propertyName]);
-                    revObj && Object.keys(revObj).forEach(key => {
-                        if (revObj[key])
-                            obj[key] = revObj[key];
-                    });
-                } else {*/
-                if (Array.isArray(this[propertyName]) && !metadataList[propertyName]?.reverser) {
-                    obj[src] = this[propertyName].map(item => {
-                        return item?.toMap ? item.toMap() : item;
-                    });
-                }
-                else if (metadataList[propertyName]?.reverser) {
-                    obj[src] = metadataList[propertyName].reverser(this[propertyName], this);
-                }
-                else if (this[propertyName]?.toMap) {
-                    obj[src] = this[propertyName]?.toMap();
-                }
-                else {
-                    obj[src] = this[propertyName];
-                }
-                /*}*/
+                obj[src] = Array.isArray(this[propertyName]) && !metadata.reverser
+                    ? this[propertyName].map(item => item?.toMap ? item.toMap() : item)
+                    : metadata.reverser
+                        ? metadata.reverser(this[propertyName], this)
+                        : this[propertyName]?.toMap
+                            ? this[propertyName].toMap()
+                            : this[propertyName];
             }
         }
         else {
-            if (!obj[propertyName])
-                obj[propertyName] = (metadataList && metadataList[propertyName]?.reverser) ? metadataList[propertyName].reverser(this[propertyName], this) : this[propertyName];
+            obj[propertyName] = this[propertyName];
         }
     });
     return obj;
@@ -101,26 +73,13 @@ exports.toMap = toMap;
  * @returns Instance of this class
  */
 function objToModel(obj) {
-    const metadataList = (0, field_decorator_1.getMapFieldMetadataList)(this);
-    obj && Object.keys(obj).forEach(propertyName => {
-        if (metadataList && Object.keys(metadataList).some(prop => prop == propertyName)) {
-            if (metadataList[propertyName].transformer) {
-                if (Array.isArray(obj[propertyName])) {
-                    this[propertyName] = obj[propertyName].map(item => {
-                        return item;
-                    });
-                }
-                else {
-                    this[propertyName] = obj[propertyName];
-                }
-            }
-            else {
-                this[propertyName] = obj[propertyName];
-            }
-        }
-        else {
-            this[propertyName] = obj[propertyName];
-        }
+    if (!obj)
+        return this;
+    Object.keys(obj).forEach(propertyName => {
+        const value = obj[propertyName];
+        this[propertyName] = Array.isArray(value)
+            ? value.map(item => item)
+            : value;
     });
     return this;
 }
@@ -131,14 +90,7 @@ exports.objToModel = objToModel;
  * @returns true or false
  */
 function empty() {
-    let check = true;
-    this && Object.keys(this).forEach(propertyName => {
-        if (this[propertyName] !== undefined && this[propertyName] !== null) {
-            check = false;
-            return;
-        }
-    });
-    return check;
+    return !Object.keys(this).some(propertyName => this[propertyName] !== undefined && this[propertyName] !== null);
 }
 exports.empty = empty;
 /**
@@ -147,16 +99,7 @@ exports.empty = empty;
  * @returns true or false
  */
 function filled() {
-    if (Object.keys(this)?.length == 0)
-        return false;
-    let check = true;
-    this && Object.keys(this).forEach(propertyName => {
-        if (this[propertyName] === undefined || this[propertyName] === null) {
-            check = false;
-            return;
-        }
-    });
-    return check;
+    return Object.keys(this).length > 0 && Object.keys(this).every(propertyName => this[propertyName] !== undefined && this[propertyName] !== null);
 }
 exports.filled = filled;
 /**
@@ -166,17 +109,8 @@ exports.filled = filled;
  * @returns Value of the property
  */
 function get(path) {
-    let pathReplaced = path.replace(/\[(\w+)\]/g, '.$1');
-    let props = pathReplaced.split('.');
-    let rtn;
-    if (props?.length) {
-        rtn = this[props[0]];
-        for (let index in props) {
-            if (+index > 0)
-                rtn = rtn && rtn[props[index]];
-        }
-    }
-    return rtn;
+    const props = path.replace(/\[(\w+)\]/g, '.$1').split('.');
+    return props.reduce((acc, prop) => acc && acc[prop], this);
 }
 exports.get = get;
 /**
@@ -186,14 +120,14 @@ exports.get = get;
  * @param value Value of the property
  */
 function set(path, value) {
-    path = path.replace(/\[(\w+)\]/g, '.$1');
-    let props = path.split('.');
+    const props = path.replace(/\[(\w+)\]/g, '.$1').split('.');
     let obj = this;
-    let i;
-    for (i = 0; i < props?.length - 1; i++) {
-        props?.[i] && (obj = obj?.[props?.[i]]);
-    }
-    props?.[i] && obj && (obj[props?.[i]] = value);
+    props.slice(0, -1).forEach(prop => {
+        if (!obj[prop])
+            obj[prop] = {};
+        obj = obj[prop];
+    });
+    obj[props[props.length - 1]] = value;
 }
 exports.set = set;
 /**
@@ -210,89 +144,63 @@ exports.copy = copy;
  */
 function from(object) {
     const metadataList = (0, field_decorator_1.getMapFieldMetadataList)(this);
+    const processProperty = (objCopy, propsStereoid) => {
+        for (let i = 0; i < propsStereoid.length; i++) {
+            const prop = propsStereoid[i];
+            if (prop.isArray) {
+                let arrIndex = prop.arrIndex.split(/\[(\w+)\]/g).filter(index => index !== '');
+                objCopy = objCopy[prop.prop];
+                arrIndex.forEach(index => {
+                    objCopy = objCopy[index];
+                });
+            }
+            else {
+                objCopy = objCopy[prop.prop];
+            }
+        }
+        return objCopy;
+    };
+    const setProperty = (metaKey, value, object) => {
+        const metaProp = metadataList?.[metaKey];
+        if (metaProp?.transformer) {
+            this[metaKey] = metaProp.transformer(value, object);
+        }
+        else {
+            this[metaKey] = value;
+        }
+    };
     object && Object.keys(object).forEach(propertyName => {
         let metaKeys = metadataList && Object.keys(metadataList).filter(metadata => metadataList[metadata]?.src?.split('.')?.includes(propertyName));
         if (metaKeys?.length) {
             metaKeys.forEach(metaKey => {
-                let metaProp = metadataList[metaKey];
+                const metaProp = metadataList?.[metaKey];
                 if (metaProp) {
-                    let props = metaProp.src?.split('.');
-                    let propsStereoid = props.map(prop => {
-                        let index = prop.indexOf('[');
-                        return {
-                            prop: index > 0 ? prop.substring(0, index) : prop,
-                            isArray: prop.includes('[') && prop.includes(']'),
-                            arrIndex: prop.substring(index),
-                        };
-                    });
-                    let i;
-                    let objCopy = { ...object };
-                    for (i = 0; i < propsStereoid.length; i++) {
-                        if (propsStereoid[i].isArray) {
-                            let arrIndex = propsStereoid[i].arrIndex?.split(/\[(\w+)\]/g)?.filter(index => index !== '');
-                            objCopy = objCopy[propsStereoid[i].prop];
-                            arrIndex.forEach((index, i) => {
-                                objCopy = objCopy[index];
-                            });
-                        }
-                        else {
-                            objCopy = objCopy[propsStereoid[i].prop];
-                        }
-                    }
-                    if (metaProp?.transformer) {
-                        this[metaKey] = metaProp.transformer(objCopy, object);
-                    }
-                    else {
-                        this[metaKey] = objCopy;
-                    }
-                }
-                else {
-                    let metaKey = metadataList && Object.keys(metadataList).find(metadata => metadataList[metadata]?.src == propertyName);
-                    if (metaKey) {
-                        const src = metadataList[metaKey].src || propertyName;
-                        if (metadataList[metaKey].transformer) {
-                            this[metaKey] = metadataList[metaKey].transformer(object[src], object);
-                        }
-                        else {
-                            this[metaKey] = object[src];
-                        }
-                    }
-                    else {
-                        if (metadataList[propertyName]?.transformer) {
-                            this[propertyName] = metadataList[propertyName].transformer(object[propertyName], object);
-                        }
-                        else {
-                            this[propertyName] = object[propertyName];
-                        }
-                    }
+                    const props = metaProp.src.split('.');
+                    const propsStereoid = props.map(prop => ({
+                        prop: prop.includes('[') ? prop.substring(0, prop.indexOf('[')) : prop,
+                        isArray: prop.includes('[') && prop.includes(']'),
+                        arrIndex: prop.substring(prop.indexOf('[')),
+                    }));
+                    const value = processProperty({ ...object }, propsStereoid);
+                    setProperty(metaKey, value, object);
                 }
             });
         }
         else {
             let metaKey = metadataList && Object.keys(metadataList).find(metadata => metadataList[metadata]?.src == propertyName);
             if (metaKey) {
-                const src = metadataList[metaKey].src || propertyName;
-                if (metadataList[metaKey].transformer) {
-                    this[metaKey] = metadataList[metaKey].transformer(object[src], object);
-                }
-                else {
-                    this[metaKey] = object[src];
-                }
+                const src = metadataList?.[metaKey].src || propertyName;
+                setProperty(metaKey, object[src], object);
             }
             else {
-                if (metadataList && metadataList[propertyName]?.transformer) {
-                    this[propertyName] = metadataList[propertyName].transformer(object[propertyName], object);
-                }
-                else {
-                    this[propertyName] = object[propertyName];
-                }
+                setProperty(propertyName, object[propertyName], object);
             }
         }
     });
-    //MAP CASE initialize = true
+    // Initialize properties with "initialize" metadata
     metadataList && Object.keys(metadataList).forEach(metaName => {
-        if (metadataList[metaName]?.initialize && metadataList[metaName]?.transformer && this[metaName] == undefined) {
-            this[metaName] = metadataList[metaName]?.transformer(null, object);
+        if (metadataList[metaName]?.initialize && metadataList[metaName]?.transformer && this[metaName] === undefined) {
+            this[metaName] = metadataList[metaName].transformer(null, object);
         }
     });
     return this;

package/dist/index.d.ts

@@ -1,12 +1,10 @@
 import { MapClass, MapInterface } from "./class.decorator";
 import { MapField } from "./field.decorator";
-import { MapperFactory } from "./mapper";
-import { objToModel, toMap, toModel } from "./mapper-functions";
 import { ClassType } from "./types";
-export { ClassType, MapClass, MapField, MapInterface, MapperFactory, objToModel, toMap, toModel };
+export { ClassType, MapClass, MapField, MapInterface };
 /**
  * npx tsc
  * npx ts-node src/example.ts
- * npm version patch
+ * npm version ( patch | minor | major )
  * npm publish
  */ 

package/dist/index.js

@@ -1,19 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toModel = exports.toMap = exports.objToModel = exports.MapperFactory = exports.MapField = exports.MapClass = void 0;
+exports.MapField = exports.MapClass = void 0;
 const class_decorator_1 = require("./class.decorator");
 Object.defineProperty(exports, "MapClass", { enumerable: true, get: function () { return class_decorator_1.MapClass; } });
 const field_decorator_1 = require("./field.decorator");
 Object.defineProperty(exports, "MapField", { enumerable: true, get: function () { return field_decorator_1.MapField; } });
-const mapper_1 = require("./mapper");
-Object.defineProperty(exports, "MapperFactory", { enumerable: true, get: function () { return mapper_1.MapperFactory; } });
-const mapper_functions_1 = require("./mapper-functions");
-Object.defineProperty(exports, "objToModel", { enumerable: true, get: function () { return mapper_functions_1.objToModel; } });
-Object.defineProperty(exports, "toMap", { enumerable: true, get: function () { return mapper_functions_1.toMap; } });
-Object.defineProperty(exports, "toModel", { enumerable: true, get: function () { return mapper_functions_1.toModel; } });
 /**
  * npx tsc
  * npx ts-node src/example.ts
- * npm version patch
+ * npm version ( patch | minor | major )
  * npm publish
  */ 

package/dist/mapper-functions.d.ts

@@ -1,4 +1,4 @@
-import { MapperFactory } from "./mapper";
+import { MapperFactory } from "./mapper.to-remove";
 export declare function toMap(model: MapperFactory): Object;
 export declare function toModel<T extends MapperFactory>(obj: Object): T;
 export declare function objToModel<T extends MapperFactory>(model: MapperFactory, obj: Object): T;

package/dist/mapper-functions.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.copy = exports.objToModel = exports.toModel = exports.toMap = void 0;
-const mapper_1 = require("./mapper");
+const mapper_to_remove_1 = require("./mapper.to-remove");
 function toMap(model) {
     return model.toMap();
 }
 exports.toMap = toMap;
 function toModel(obj) {
-    return new mapper_1.MapperFactory(obj);
+    return new mapper_to_remove_1.MapperFactory(obj);
 }
 exports.toModel = toModel;
 function objToModel(model, obj) {
@@ -15,6 +15,6 @@ function objToModel(model, obj) {
 }
 exports.objToModel = objToModel;
 function copy(model) {
-    return new mapper_1.MapperFactory(model.toMap());
+    return new mapper_to_remove_1.MapperFactory(model.toMap());
 }
 exports.copy = copy;

package/dist/mapper.d.ts

@@ -7,36 +7,180 @@ export declare class MapperFactory {
      */
     constructor(object?: any);
     /**
-     * Convert the instance of this class to JSON Object.
+     * Maps the properties of an object based on the provided metadata list.
      *
-     * @returns JSON object mapped considering metadata "src" and "reverser"
+     * @param object - The object whose properties need to be mapped.
+     * @param metadataList - The list of metadata used to map the object's properties.
+     *
+     * This method iterates over each property of the given object. For each property, it retrieves the corresponding metadata keys.
+     * If metadata keys are found, it maps the property using the `mapProperty` method for each metadata key.
+     * If no metadata keys are found, it maps the property directly using the `mapDirectProperty` method.
+     */
+    private mapObject;
+    /**
+     * Retrieves the metadata keys associated with a given property name.
+     *
+     * @param metadataList - The list of metadata objects to search through.
+     * @param propertyName - The name of the property to find metadata keys for.
+     * @returns An array of metadata keys that are associated with the specified property name.
+     */
+    private getMetaKeys;
+    /**
+     * Maps a property from the given object to the current instance based on the provided metadata.
+     *
+     * @param object - The source object containing the property to be mapped.
+     * @param metadataList - A list of metadata that provides mapping information.
+     * @param propertyName - The name of the property to be mapped.
+     * @param metaKey - The key used to retrieve the specific metadata for the property.
+     *
+     * This method performs the following steps:
+     * 1. Retrieves the metadata for the given metaKey.
+     * 2. If metadata exists, it gets the properties' stereoid and creates a copy of the object.
+     * 3. Iterates over the properties' stereoid and updates the object copy.
+     * 4. If a transformer function is defined in the metadata, it applies the transformer to the object copy and the original object.
+     * 5. If no metadata exists for the metaKey, it maps the property directly using the `mapDirectProperty` method.
+     */
+    private mapProperty;
+    /**
+     * Parses a dot-separated string and returns an array of PropStereoid objects.
+     * Each PropStereoid object contains information about the property name,
+     * whether it is an array, and the array index if applicable.
+     *
+     * @param src - The dot-separated string to parse.
+     * @returns An array of PropStereoid objects.
+     */
+    private getPropsStereoid;
+    /**
+     * Retrieves a copy of an object property based on the provided `PropStereoid`.
+     *
+     * @param objCopy - The object from which the property copy is to be retrieved.
+     * @param prop - The `PropStereoid` object containing property details.
+     * @returns A copy of the specified property from the object.
+     *
+     * @remarks
+     * If the property is an array, the method navigates through the array indices
+     * specified in `prop.arrIndex` to retrieve the nested property.
+     * Otherwise, it directly retrieves the property specified in `prop.prop`.
+     *
+     * @example
+     * ```typescript
+     * const obj = { a: { b: [ { c: 1 }, { c: 2 } ] } };
+     * const prop = { isArray: true, arrIndex: '[1]', prop: 'b' };
+     * const result = getObjectCopy(obj, prop);
+     * console.log(result); // Output: { c: 2 }
+     * ```
+     */
+    private getObjectCopy;
+    /**
+     * Maps a direct property from the given object to the current instance based on the provided metadata list.
+     *
+     * @param object - The source object containing the properties to be mapped.
+     * @param metadataList - An optional list of metadata that defines how properties should be mapped and transformed.
+     * @param propertyName - The name of the property to be mapped from the source object.
+     *
+     * The method performs the following steps:
+     * 1. Checks if the metadata list contains a key that matches the source property name.
+     * 2. If a matching metadata key is found, it uses the metadata to determine the source property name (`src`) and applies any defined transformer function.
+     * 3. If no matching metadata key is found, it directly maps the property from the source object, applying any transformer function if defined.
+     */
+    private mapDirectProperty;
+    /**
+     * Initializes properties of the current object based on the provided metadata list.
+     *
+     * @param metadataList - An object containing metadata information for properties.
+     * @param object - The object to be used for initializing properties.
+     *
+     * The method iterates over the keys of the metadataList. For each key, if the corresponding metadata
+     * has an `initialize` property set to true, a `transformer` function, and the current object does not
+     * already have a property with the same name, it initializes the property using the transformer function.
+     */
+    private initializeProperties;
+    /**
+     * Converts the current object instance to a mapped object.
+     *
+     * This method iterates over the properties of the current object and maps them
+     * according to the metadata provided by `getMapFieldMetadataList`. If a property
+     * has associated metadata, it uses the `mapToJson` method to map it. Otherwise,
+     * it directly assigns the property value to the resulting object, applying a
+     * reverser function if specified in the metadata.
+     *
+     * @returns {any} The mapped object.
      */
     toMap(): any;
     /**
-     * Convert a JSON Object to an instance of this class.
+     * Maps the provided object to a JSON structure based on the given metadata list.
+     *
+     * @param metadataList - An object containing metadata information for mapping.
+     * @param obj - The object to be mapped to JSON.
+     * @param propertyName - The name of the property to be mapped.
+     *
+     * The method supports nested properties and arrays. If the source property name
+     * (src) contains dots, it indicates nested properties. The method will traverse
+     * the object structure accordingly and create nested objects or arrays as needed.
+     *
+     * The `getPropsStereoid` method is used to parse the nested property names and
+     * determine if they are arrays. The `getReversedValue` method is used to get the
+     * value to be assigned to the final property.
+     *
+     * Example:
+     * ```
+     * const metadataList = {
+     *   'nested.property': { src: 'nested.property' },
+     *   'array[0].item': { src: 'array[0].item' }
+     * };
+     * const obj = {};
+     * mapToJson(metadataList, obj, 'nested.property');
+     * mapToJson(metadataList, obj, 'array[0].item');
+     * ```
+     * The resulting `obj` will have the structure:
+     * ```
+     * {
+     *   nested: {
+     *     property: <value>
+     *   },
+     *   array: [
+     *     { item: <value> }
+     *   ]
+     * }
+     * ```
+     */
+    private mapToJson;
+    /**
+     * Retrieves the reversed value of a property based on the provided metadata.
+     *
+     * @param metadataList - An object containing metadata for properties.
+     * @param propertyName - The name of the property to retrieve the reversed value for.
+     * @returns The reversed value of the property. If the property is an array, it applies the reverser function or maps each item to its mapped value. If the property has a `toMap` method, it calls that method. Otherwise, it applies the reverser function or returns the property value directly.
+     */
+    private getReversedValue;
+    /**
+     * Maps the properties of the given object to the current instance based on metadata.
      *
-     * @param obj JSON Object
-     * @returns Instance of this class
+     * @param obj - The source object whose properties are to be mapped.
+     * @returns The current instance with mapped properties.
      */
     objToModel(obj: Object): this;
     /**
-     * Check if this instance is empty.
+     * Checks if all properties of the current object are either `undefined` or `null`.
      *
-     * @returns true or false
+     * @returns {boolean} `true` if all properties are `undefined` or `null`, otherwise `false`.
      */
     empty(): boolean;
     /**
-     * GET property value from a string path.
+     * Retrieves a nested property value from the object based on the provided path.
+     * The path can include dot notation and array indices.
      *
-     * @param path String path
-     * @returns Value of the property
+     * @template T - The expected type of the property value.
+     * @param {string} path - The path to the property, using dot notation and array indices.
+     * @returns {T} - The value of the property at the specified path.
      */
     get<T>(path: string): T;
     /**
-     * SET property value from a string path.
+     * Sets the value at the specified path within the object.
+     * The path is a string that can include dot notation and array indices.
      *
-     * @param path String path
-     * @param value Value of the property
+     * @param path - The path to the property to set, using dot notation and array indices.
+     * @param value - The value to set at the specified path.
      */
     set(path: string, value: any): void;
 }