infrastructure-components/src/types/configuration.ts

Infrastructure-Components configure the infrastructure of your React-App as part of your React-Components.

import {IPlugin} from "../libs/plugin";
import Types from './index'

/**
 * A configuration is the top-level node of an infrastructure-components project
 */
export interface IConfiguration {


    /**
     * An Infrastructure may provide plugins, the Plugins may need some data that we provide here!
     */
    createPlugins: (configPath: string, stage: string | undefined, parserMode: string) => Array<IPlugin>

}

/**
 * A function to check whether a component serves as an Infrastructure
 *
 * used in the parser during compilation, we get a real object here!
 *
 * @param parsedComponent is the real object to be tested!
 */
export const isConfiguration = (parsedComponent): boolean => {

    //console.log("check if Configuration: " , parsedComponent)

    if (parsedComponent !== undefined) {
        return parsedComponent.createPlugins !== undefined &&
            parsedComponent.infrastructureType === Types.INFRASTRUCTURE_TYPE_CONFIGURATION
    }

    //console.log("NOPE!");

    return false;
};


/**
 * Extracts the plugins from an infrastructure
 *
 * @param infrastructure is the infrastructure-object
 * @param configPath specifies the path to the original configuration of the project, as passes as argument in the command
 *
 */
export function extractPlugins(infrastructure: IConfiguration, configPath: string, stage: string | undefined, parserMode: string) {
    
    return infrastructure.createPlugins(configPath, stage, parserMode);
}