zeppelin/backend/src/plugins/ZeppelinPluginBlueprint.ts

import { BasePluginType, plugin, PluginBlueprint } from "knub";
import * as t from "io-ts";
import { pluginConfigPreprocessor } from "../pluginUtils";

export interface ZeppelinPluginBlueprint<TPluginType extends BasePluginType = BasePluginType>
  extends PluginBlueprint<TPluginType> {
  configSchema?: t.TypeC<any>;
  showInDocs?: boolean;
}

export function zeppelinPlugin(name: string, blueprint: Omit<ZeppelinPluginBlueprint, "name">): ZeppelinPluginBlueprint;
export function zeppelinPlugin<TPluginType extends BasePluginType>(): (
  name: string,
  blueprint: Omit<ZeppelinPluginBlueprint<TPluginType>, "name">,
) => ZeppelinPluginBlueprint<TPluginType>;
export function zeppelinPlugin(...args) {
  if (args.length) {
    const blueprint: ZeppelinPluginBlueprint = plugin(...(args as Parameters<typeof plugin>));
    blueprint.configPreprocessor = pluginConfigPreprocessor.bind(blueprint);
    return blueprint;
  } else {
    return zeppelinPlugin;
  }
}