/** @module run */
import { AnyValueMap } from 'pip-services4-commons-node';
import { JsonConverter } from 'pip-services4-commons-node';
import { RecursiveObjectReader } from 'pip-services4-commons-node';
import { RecursiveObjectWriter } from 'pip-services4-commons-node';
import { ObjectWriter } from 'pip-services4-commons-node';
import { ConfigParams } from '../config/ConfigParams';

/**
 * Contains map with execution parameters.
 * 
 * In general, this map may contain non-serializable values.
 * And in contrast with other maps, its getters and setters
 * support dot notation and able to access properties
 * in the entire object graph.
 * 
 * This class is often use to pass execution and notification
 * arguments, and parameterize classes before execution.
 * 
 * @see [[IParameterized]]
 * @see [[AnyValueMap]]
 */
export class Parameters extends AnyValueMap {

    /**
     * Creates a new instance of the map and assigns its value.
     * 
     * @param value     (optional) values to initialize this map.
     */
    public constructor(map: any = null) {
        super(map);
    }

    /**
     * Gets a map element specified by its key.
     * 
     * The key can be defined using dot notation
     * and allows to recursively access elements of elements.
     * 
     * @param key     a key of the element to get.
     * @returns       the value of the map element.
     */
    public get(key: string): any {
        if (key == null) {
            return null;
        } else if (key.indexOf('.') > 0) {
            return RecursiveObjectReader.getProperty(this, key);
        } else {
            return super.get(key);
        }
    }

    /**
     * Puts a new value into map element specified by its key.
     * 
     * The key can be defined using dot notation
     * and allows to recursively access elements of elements.
     * 
     * @param key       a key of the element to put.
     * @param value     a new value for map element.
     */
    public put(key: string, value: any): any {
        if (key == null) {
            return null;
        } else if (key.indexOf('.') > 0) {
            RecursiveObjectWriter.setProperty(this, key, value);
        } else {
            super.put(key, value);
        }
        return value;
    }

    /** 
     * Converts map element into an Parameters or returns null if conversion is not possible.
     * 
     * @param key       a key of element to get.
     * @returns Parameters value of the element or null if conversion is not supported. 
     */
    public getAsNullableParameters(key: string): Parameters {
        const value = this.getAsNullableMap(key);
        return value != null ? new Parameters(value) : null;
    }

    /** 
     * Converts map element into an Parameters or returns empty Parameters if conversion is not possible.
     * 
     * @param key       a key of element to get.
     * @returns Parameters value of the element or empty Parameters if conversion is not supported. 
     */
    public getAsParameters(key: string): Parameters {
        const value = this.getAsMap(key);
        return new Parameters(value);
    }

    /**
     * Converts map element into an Parameters or returns default value if conversion is not possible.
     * 
     * @param key       a key of element to get.
     * @param defaultValue  the default value
     * @returns Parameters value of the element or default value if conversion is not supported. 
     */
    public getAsParametersWithDefault(key: string, defaultValue: Parameters): Parameters {
        const result = this.getAsNullableParameters(key);
        return result != null ? result: defaultValue;
    }

    /**
     * Checks if this map contains an element with specified key.
     * 
     * The key can be defined using dot notation
     * and allows to recursively access elements of elements.
     * 
     * @param key     a key to be checked
     * @returns       true if this map contains the key or false otherwise.
     */
    public containsKey(key: string): boolean {
        return RecursiveObjectReader.hasProperty(this, key.toString());
    }
    
    /**
     * Overrides parameters with new values from specified Parameters
     * and returns a new Parameters object.
     * 
     * @param parameters        Parameters with parameters to override the current values.
     * @param recursive            (optional) true to perform deep copy, and false for shallow copy. Default: false
     * @returns                    a new Parameters object.
     * 
     * @see [[setDefaults]]
     */
     public override(parameters: Parameters, recursive = false): Parameters {
         const result = new Parameters();
         if (recursive) {
             RecursiveObjectWriter.copyProperties(result, this);
             RecursiveObjectWriter.copyProperties(result, parameters);
         } else {
             ObjectWriter.setProperties(result, this);
             ObjectWriter.setProperties(result, parameters);
         }
        return result;
    }

    /**
     * Set default values from specified Parameters and returns a new Parameters object.
     * 
     * @param defaultParameters    Parameters with default parameter values.
     * @param recursive            (optional) true to perform deep copy, and false for shallow copy. Default: false
     * @returns                        a new Parameters object.
     * 
     * @see [[override]]
     */
    public setDefaults(defaultParameters: Parameters, recursive = false): Parameters {
         const result = new Parameters();
         if (recursive) {
             RecursiveObjectWriter.copyProperties(result, defaultParameters);
             RecursiveObjectWriter.copyProperties(result, this);
         } else {
             ObjectWriter.setProperties(result, defaultParameters);
             ObjectWriter.setProperties(result, this);
         }
        return result;
    }

    /**
     * Assigns (copies over) properties from the specified value to this map.
     * 
     * @param value     value whose properties shall be copied over.
     */
    public assignTo(value: any): void {
        if (value == null) return;        
        RecursiveObjectWriter.copyProperties(value, this);
    }
    
    /**
     * Picks select parameters from this Parameters and returns them as a new Parameters object.
     * 
     * @param paths     keys to be picked and copied over to new Parameters.
     * @returns a new Parameters object.
     */
    public pick(...paths: string[]): Parameters {
        const result = new Parameters();
        for (const path of paths) {
            if (this.containsKey(path)) {
                result.put(path, this.get(path));
            }
        }
        return result;
    }

    /**
     * Omits selected parameters from this Parameters and returns the rest as a new Parameters object.
     * 
     * @param paths     keys to be omitted from copying over to new Parameters.
     * @returns a new Parameters object.
     */
    public omit(...paths: string[]): Parameters {
        const result = new Parameters(this);        
        for (const path of paths) {
            result.remove(path);
        }
        return result;
    }
    
    /**
     * Converts this map to JSON object.
     * 
     * @returns    a JSON representation of this map.
     */
    public toJson(): string {
        return JsonConverter.toJson(this);
    }
    
    /**
     * Creates a new Parameters object filled with key-value pairs from specified object.
     * 
     * @param value        an object with key-value pairs used to initialize a new Parameters.
     * @returns            a new Parameters object.
     */
    public static fromValue(value: any): Parameters {
        return new Parameters(value);
    }
    
    /**
     * Creates a new Parameters object filled with provided key-value pairs called tuples.
     * Tuples parameters contain a sequence of key1, value1, key2, value2, ... pairs.
     * 
     * @param tuples    the tuples to fill a new Parameters object.
     * @returns            a new Parameters object.
     * 
     * @see [[AnyValueMap.fromTuplesArray]]
     */
    public static fromTuples(...tuples: any[]): Parameters {
        const map = AnyValueMap.fromTuples(...tuples);
        return new Parameters(map);
    }
        
    /**
     * Merges two or more Parameters into one. The following Parameters override
     * previously defined parameters.
     * 
     * @param configs     a list of Parameters objects to be merged.
     * @returns            a new Parameters object.
     * 
     * @see [[AnyValueMap.fromMaps]]
     */
    public static mergeParams(...parameters: Parameters[]): Parameters {
        const map = AnyValueMap.fromMaps(...parameters);
        return new Parameters(map);
    }
    
    /**
     * Creates new Parameters from JSON object.
     * 
     * @param json     a JSON string containing parameters.
     * @returns a new Parameters object.
     * 
     * @see [[JsonConverter.toNullableMap]]
     */
    public static fromJson(json: string): Parameters {
        const map = JsonConverter.toNullableMap(json);
        return new Parameters(map);
    }
    
    /**
     * Creates new Parameters from ConfigMap object.
     * 
     * @param config     a ConfigParams that contain parameters.
     * @returns            a new Parameters object.
     * 
     * @see [[ConfigParams]]
     */
    public static fromConfig(config: ConfigParams): Parameters {
        const result = new Parameters();
        
        if (config == null) {
            return result;
        }
        
        for (const key in config) {
            if (Object.prototype.hasOwnProperty.call(config, key)) {
                result.put(key, config[key]);
            }
        }
        
        return result;
    }
}