aws-cdk/lib/api/plugin/plugin.js

CDK Toolkit, the command line tool for CDK apps

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.PluginHost = void 0;
const util_1 = require("util");
const chalk = require("chalk");
const _env_1 = require("./_env");
const context_provider_plugin_1 = require("./context-provider-plugin");
/**
 * A utility to manage plug-ins.
 *
 */
class PluginHost {
    constructor() {
        /**
         * Access the currently registered CredentialProviderSources. New sources can
         * be registered using the +registerCredentialProviderSource+ method.
         */
        this.credentialProviderSources = new Array();
        this.contextProviderPlugins = {};
        if (PluginHost.instance && PluginHost.instance !== this) {
            throw new Error('New instances of PluginHost must not be built. Use PluginHost.instance instead!');
        }
    }
    /**
     * Loads a plug-in into this PluginHost.
     *
     * @param moduleSpec the specification (path or name) of the plug-in module to be loaded.
     */
    load(moduleSpec) {
        try {
            /* eslint-disable @typescript-eslint/no-require-imports */
            const plugin = require(moduleSpec);
            /* eslint-enable */
            if (!isPlugin(plugin)) {
                (0, _env_1.error)(`Module ${chalk.green(moduleSpec)} is not a valid plug-in, or has an unsupported version.`);
                throw new Error(`Module ${moduleSpec} does not define a valid plug-in.`);
            }
            if (plugin.init) {
                plugin.init(PluginHost.instance);
            }
        }
        catch (e) {
            (0, _env_1.error)(`Unable to load ${chalk.green(moduleSpec)}: ${e.stack}`);
            throw new Error(`Unable to load plug-in: ${moduleSpec}`);
        }
        function isPlugin(x) {
            return x != null && x.version === '1';
        }
    }
    /**
     * Allows plug-ins to register new CredentialProviderSources.
     *
     * @param source a new CredentialProviderSource to register.
     */
    registerCredentialProviderSource(source) {
        // Forward to the right credentials-related plugin host
        this.credentialProviderSources.push(source);
    }
    /**
     * (EXPERIMENTAL) Allow plugins to register context providers
     *
     * Context providers are objects with the following method:
     *
     * ```ts
     *   getValue(args: {[key: string]: any}): Promise<any>;
     * ```
     *
     * Currently, they cannot reuse the CDK's authentication mechanisms, so they
     * must be prepared to either not make AWS calls or use their own source of
     * AWS credentials.
     *
     * This feature is experimental, and only intended to be used internally at Amazon
     * as a trial.
     *
     * After registering with 'my-plugin-name', the provider must be addressed as follows:
     *
     * ```ts
     * const value = ContextProvider.getValue(this, {
     *   providerName: 'plugin',
     *   props: {
     *     pluginName: 'my-plugin-name',
     *     myParameter1: 'xyz',
     *   },
     *   includeEnvironment: true | false,
     *   dummyValue: 'what-to-return-on-the-first-pass',
     * })
     * ```
     *
     * @experimental
     */
    registerContextProviderAlpha(pluginProviderName, provider) {
        if (!(0, context_provider_plugin_1.isContextProviderPlugin)(provider)) {
            throw new Error(`Object you gave me does not look like a ContextProviderPlugin: ${(0, util_1.inspect)(provider)}`);
        }
        this.contextProviderPlugins[pluginProviderName] = provider;
    }
}
exports.PluginHost = PluginHost;
PluginHost.instance = new PluginHost();
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"plugin.js","sourceRoot":"","sources":["plugin.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAC/B,+BAA+B;AAE/B,iCAA+B;AAC/B,uEAA2F;AAkC3F;;;GAGG;AACH,MAAa,UAAU;IAWrB;QARA;;;WAGG;QACa,8BAAyB,GAAG,IAAI,KAAK,EAA4B,CAAC;QAElE,2BAAsB,GAA0C,EAAE,CAAC;QAGjF,IAAI,UAAU,CAAC,QAAQ,IAAI,UAAU,CAAC,QAAQ,KAAK,IAAI,EAAE;YACvD,MAAM,IAAI,KAAK,CAAC,iFAAiF,CAAC,CAAC;SACpG;IACH,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,UAAkB;QAC5B,IAAI;YACF,0DAA0D;YAC1D,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;YACnC,mBAAmB;YACnB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBACrB,IAAA,YAAK,EAAC,UAAU,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,yDAAyD,CAAC,CAAC;gBAClG,MAAM,IAAI,KAAK,CAAC,UAAU,UAAU,mCAAmC,CAAC,CAAC;aAC1E;YACD,IAAI,MAAM,CAAC,IAAI,EAAE;gBAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;aAAE;SACvD;QAAC,OAAO,CAAM,EAAE;YACf,IAAA,YAAK,EAAC,kBAAkB,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;YAC/D,MAAM,IAAI,KAAK,CAAC,2BAA2B,UAAU,EAAE,CAAC,CAAC;SAC1D;QAED,SAAS,QAAQ,CAAC,CAAM;YACtB,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,OAAO,KAAK,GAAG,CAAC;QACxC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,gCAAgC,CAAC,MAAgC;QACtE,uDAAuD;QACvD,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACI,4BAA4B,CAAC,kBAA0B,EAAE,QAA+B;QAC7F,IAAI,CAAC,IAAA,iDAAuB,EAAC,QAAQ,CAAC,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,kEAAkE,IAAA,cAAO,EAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;SACxG;QACD,IAAI,CAAC,sBAAsB,CAAC,kBAAkB,CAAC,GAAG,QAAQ,CAAC;IAC7D,CAAC;;AAzFH,gCA0FC;AAzFe,mBAAQ,GAAG,IAAI,UAAU,EAAE,AAAnB,CAAoB","sourcesContent":["import { inspect } from 'util';\nimport * as chalk from 'chalk';\n\nimport { error } from './_env';\nimport { ContextProviderPlugin, isContextProviderPlugin } from './context-provider-plugin';\nimport { CredentialProviderSource } from './credential-provider-source';\n\n/**\n * The basic contract for plug-ins to adhere to::\n *\n *   import { Plugin, PluginHost } from 'aws-cdk';\n *   import { CustomCredentialProviderSource } from './custom-credential-provider-source';\n *\n *   export default class FooCDKPlugIn implements PluginHost {\n *     public readonly version = '1';\n *\n *     public init(host: PluginHost) {\n *     host.registerCredentialProviderSource(new CustomCredentialProviderSource());\n *     }\n *   }\n *\n */\nexport interface Plugin {\n  /**\n   * The version of the plug-in interface used by the plug-in. This will be used by\n   * the plug-in host to handle version changes.\n   */\n  version: '1';\n\n  /**\n   * When defined, this function is invoked right after the plug-in has been loaded,\n   * so that the plug-in is able to initialize itself. It may call methods of the\n   * ``PluginHost`` instance it receives to register new ``CredentialProviderSource``\n   * instances.\n   */\n  init?: (host: PluginHost) => void;\n}\n\n/**\n * A utility to manage plug-ins.\n *\n */\nexport class PluginHost {\n  public static instance = new PluginHost();\n\n  /**\n   * Access the currently registered CredentialProviderSources. New sources can\n   * be registered using the +registerCredentialProviderSource+ method.\n   */\n  public readonly credentialProviderSources = new Array<CredentialProviderSource>();\n\n  public readonly contextProviderPlugins: Record<string, ContextProviderPlugin> = {};\n\n  constructor() {\n    if (PluginHost.instance && PluginHost.instance !== this) {\n      throw new Error('New instances of PluginHost must not be built. Use PluginHost.instance instead!');\n    }\n  }\n\n  /**\n   * Loads a plug-in into this PluginHost.\n   *\n   * @param moduleSpec the specification (path or name) of the plug-in module to be loaded.\n   */\n  public load(moduleSpec: string) {\n    try {\n      /* eslint-disable @typescript-eslint/no-require-imports */\n      const plugin = require(moduleSpec);\n      /* eslint-enable */\n      if (!isPlugin(plugin)) {\n        error(`Module ${chalk.green(moduleSpec)} is not a valid plug-in, or has an unsupported version.`);\n        throw new Error(`Module ${moduleSpec} does not define a valid plug-in.`);\n      }\n      if (plugin.init) { plugin.init(PluginHost.instance); }\n    } catch (e: any) {\n      error(`Unable to load ${chalk.green(moduleSpec)}: ${e.stack}`);\n      throw new Error(`Unable to load plug-in: ${moduleSpec}`);\n    }\n\n    function isPlugin(x: any): x is Plugin {\n      return x != null && x.version === '1';\n    }\n  }\n\n  /**\n   * Allows plug-ins to register new CredentialProviderSources.\n   *\n   * @param source a new CredentialProviderSource to register.\n   */\n  public registerCredentialProviderSource(source: CredentialProviderSource) {\n    // Forward to the right credentials-related plugin host\n    this.credentialProviderSources.push(source);\n  }\n\n  /**\n   * (EXPERIMENTAL) Allow plugins to register context providers\n   *\n   * Context providers are objects with the following method:\n   *\n   * ```ts\n   *   getValue(args: {[key: string]: any}): Promise<any>;\n   * ```\n   *\n   * Currently, they cannot reuse the CDK's authentication mechanisms, so they\n   * must be prepared to either not make AWS calls or use their own source of\n   * AWS credentials.\n   *\n   * This feature is experimental, and only intended to be used internally at Amazon\n   * as a trial.\n   *\n   * After registering with 'my-plugin-name', the provider must be addressed as follows:\n   *\n   * ```ts\n   * const value = ContextProvider.getValue(this, {\n   *   providerName: 'plugin',\n   *   props: {\n   *     pluginName: 'my-plugin-name',\n   *     myParameter1: 'xyz',\n   *   },\n   *   includeEnvironment: true | false,\n   *   dummyValue: 'what-to-return-on-the-first-pass',\n   * })\n   * ```\n   *\n   * @experimental\n   */\n  public registerContextProviderAlpha(pluginProviderName: string, provider: ContextProviderPlugin) {\n    if (!isContextProviderPlugin(provider)) {\n      throw new Error(`Object you gave me does not look like a ContextProviderPlugin: ${inspect(provider)}`);\n    }\n    this.contextProviderPlugins[pluginProviderName] = provider;\n  }\n}\n"]}