botbuilder-dialogs/src/configurable.ts

A dialog stack based conversation manager for Microsoft BotBuilder.

/**
 * @module botbuilder-dialogs
 */
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License.
 */

import { Converter, ConverterFactory } from './converter';

/**
 * Base class for all configurable classes.
 */
export abstract class Configurable {
    /**
     * Fluent method for configuring the object.
     *
     * @param config Configuration settings to apply.
     * @returns The [Configurable](xref:botbuilder-dialogs.Configurable) after the operation is complete.
     */
    configure(config: Record<string, unknown>): this {
        for (const key in config) {
            if (Object.prototype.hasOwnProperty.call(config, key)) {
                const setting = config[`${key}`];
                const converter = this.getConverter(key);
                if (converter && typeof converter === 'object') {
                    this[`${key}`] = converter.convert(setting);
                } else {
                    if (Array.isArray(setting)) {
                        this[`${key}`] = setting;
                    } else if (typeof setting == 'object') {
                        if (typeof this[`${key}`] == 'object') {
                            // Apply as a map update
                            for (const child in setting) {
                                if (Object.prototype.hasOwnProperty.call(setting, child)) {
                                    this[`${key}`][`${child}`] = setting[`${child}`];
                                }
                            }
                        } else {
                            this[`${key}`] = setting;
                        }
                    } else if (setting !== undefined) {
                        this[`${key}`] = setting;
                    }
                }
            }
        }
        return this;
    }

    /**
     * @param _property The key of the conditional selector configuration.
     * @returns The converter for the selector configuration.
     */
    getConverter(_property: string): Converter | ConverterFactory {
        return undefined;
    }
}