ag-grid/src/ts/components/framework/frameworkComponentWrapper.ts

Advanced Data Grid / Data Table supporting Javascript / React / AngularJS / Web Components

import {IComponent} from "../../interfaces/iComponent";
import {Promise} from "../../utils";

/**
 * B the business interface (ie IHeader)
 * A the agGridComponent interface (ie IHeaderComp). The final object acceptable by ag-grid
 */
export interface FrameworkComponentWrapper {
    wrap <A extends IComponent<any>> (frameworkComponent: { new(): any },
                                      methodList: string[],
                                      optionalMethodList?: string[],
                                      componentName?: string): A
}

export interface WrapableInterface {
    hasMethod(name: string): boolean

    callMethod(name: string, args: IArguments): void

    addMethod(name: string, callback: Function): void
}


export abstract class BaseComponentWrapper<F extends WrapableInterface> implements FrameworkComponentWrapper {
    wrap<A extends IComponent<any>>(OriginalConstructor: { new (): any },
                                    mandatoryMethodList: string[],
                                    optionalMethodList?: string[],
                                    componentName?: string): A {
        let wrapper: F = this.createWrapper(OriginalConstructor, componentName);

        mandatoryMethodList.forEach((methodName => {
            this.createMethod(wrapper, methodName, true);
        }));

        if (optionalMethodList) {
            optionalMethodList.forEach((methodName => {
                this.createMethod(wrapper, methodName, false);
            }));
        }


        return <A><any>wrapper;

    }

    abstract createWrapper(OriginalConstructor: { new (): any }, componentName?: string): F;


    private createMethod(wrapper: F, methodName: string, mandatory: boolean): void {
        wrapper.addMethod(methodName, this.createMethodProxy(wrapper, methodName, mandatory));
    }

    private createMethodProxy(wrapper: F, methodName: string, mandatory: boolean): Function {
        return function () {
            if (wrapper.hasMethod(methodName)) {
                return wrapper.callMethod(methodName, arguments)
            }

            if (mandatory) {
                console.warn('ag-Grid: Framework component is missing the method ' + methodName + '()');
            }
            return null;
        }
    }
}