@backstage/cli 0.32.2-next.0 → 0.33.0-next.1

package/dist/packages/opaque-internal/src/OpaqueType.cjs.js

@@ -0,0 +1,105 @@
+'use strict';
+
+class OpaqueType {
+  /**
+   * Creates a new opaque type.
+   *
+   * @param options.type The type identifier of the opaque type
+   * @param options.versions The available versions of the opaque type
+   * @returns A new opaque type helper
+   */
+  static create(options) {
+    return new OpaqueType(options.type, new Set(options.versions));
+  }
+  #type;
+  #versions;
+  constructor(type, versions) {
+    this.#type = type;
+    this.#versions = versions;
+  }
+  /**
+   * The internal version of the opaque type, used like this: `typeof MyOpaqueType.TPublic`
+   *
+   * @remarks
+   *
+   * This property is only useful for type checking, its runtime value is `undefined`.
+   */
+  TPublic = void 0;
+  /**
+   * The internal version of the opaque type, used like this: `typeof MyOpaqueType.TInternal`
+   *
+   * @remarks
+   *
+   * This property is only useful for type checking, its runtime value is `undefined`.
+   */
+  TInternal = void 0;
+  /**
+   * @param value Input value expected to be an instance of this opaque type
+   * @returns True if the value matches this opaque type
+   */
+  isType = (value) => {
+    return this.#isThisInternalType(value);
+  };
+  /**
+   * @param value Input value expected to be an instance of this opaque type
+   * @throws If the value is not an instance of this opaque type or is of an unsupported version
+   * @returns The internal version of the opaque type
+   */
+  toInternal = (value) => {
+    if (!this.#isThisInternalType(value)) {
+      throw new TypeError(
+        `Invalid opaque type, expected '${this.#type}', but got '${this.#stringifyUnknown(value)}'`
+      );
+    }
+    if (!this.#versions.has(value.version)) {
+      const versions = Array.from(this.#versions).map(this.#stringifyVersion);
+      if (versions.length > 1) {
+        versions[versions.length - 1] = `or ${versions[versions.length - 1]}`;
+      }
+      const expected = versions.length > 2 ? versions.join(", ") : versions.join(" ");
+      throw new TypeError(
+        `Invalid opaque type instance, got version ${this.#stringifyVersion(
+          value.version
+        )}, expected ${expected}`
+      );
+    }
+    return value;
+  };
+  /**
+   * Creates an instance of the opaque type, returning the public type.
+   *
+   * @param version The version of the instance to create
+   * @param value The remaining public and internal properties of the instance
+   * @returns An instance of the opaque type
+   */
+  createInstance(version, props) {
+    return Object.assign(props, {
+      $$type: this.#type,
+      ...version && { version }
+    });
+  }
+  #isThisInternalType(value) {
+    if (value === null || typeof value !== "object") {
+      return false;
+    }
+    return value.$$type === this.#type;
+  }
+  #stringifyUnknown(value) {
+    if (typeof value !== "object") {
+      return `<${typeof value}>`;
+    }
+    if (value === null) {
+      return "<null>";
+    }
+    if ("$$type" in value) {
+      return String(value.$$type);
+    }
+    return String(value);
+  }
+  #stringifyVersion = (version) => {
+    return version ? `'${version}'` : "undefined";
+  };
+}
+
+exports.OpaqueType = OpaqueType;
+//# sourceMappingURL=OpaqueType.cjs.js.map

package/dist/plugins/scaffolder-node/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.8.3-next.1";
+var version = "0.9.0-next.2";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/scaffolder-node-test-utils/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.2.3-next.1";
+var version = "0.3.0-next.2";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/wiring/CliInitializer.cjs.js

@@ -0,0 +1,124 @@
+'use strict';
+
+var CommandGraph = require('./CommandGraph.cjs.js');
+var types$1 = require('./types.cjs.js');
+var CommandRegistry = require('./CommandRegistry.cjs.js');
+var commander = require('commander');
+var version = require('../lib/version.cjs.js');
+var chalk = require('chalk');
+var errors$1 = require('../lib/errors.cjs.js');
+var errors = require('@backstage/errors');
+var types = require('util/types');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
+
+class CliInitializer {
+  graph = new CommandGraph.CommandGraph();
+  commandRegistry = new CommandRegistry.CommandRegistry(this.graph);
+  #uninitiazedFeatures = [];
+  add(feature) {
+    if (types.isPromise(feature)) {
+      this.#uninitiazedFeatures.push(
+        feature.then((f) => unwrapFeature(f.default))
+      );
+    } else {
+      this.#uninitiazedFeatures.push(Promise.resolve(feature));
+    }
+  }
+  async #register(feature) {
+    if (types$1.OpaqueCliPlugin.isType(feature)) {
+      const internal = types$1.OpaqueCliPlugin.toInternal(feature);
+      await internal.init(this.commandRegistry);
+    } else {
+      throw new Error(`Unsupported feature type: ${feature.$$type}`);
+    }
+  }
+  async #doInit() {
+    const features = await Promise.all(this.#uninitiazedFeatures);
+    for (const feature of features) {
+      await this.#register(feature);
+    }
+  }
+  /**
+   * Actually parse argv and pass it to the command.
+   */
+  async run() {
+    await this.#doInit();
+    const programName = "backstage-cli";
+    const program = new commander.Command();
+    program.name(programName).version(version.version).allowUnknownOption(true).allowExcessArguments(true);
+    const queue = this.graph.atDepth(0).map((node) => ({
+      node,
+      argParser: program
+    }));
+    while (queue.length) {
+      const { node, argParser } = queue.shift();
+      if (node.$$type === "@tree/root") {
+        const treeParser = argParser.command(`${node.name} [command]`).description(node.name);
+        queue.push(
+          ...node.children.map((child) => ({
+            node: child,
+            argParser: treeParser
+          }))
+        );
+      } else {
+        argParser.command(node.name, { hidden: !!node.command.deprecated }).description(node.command.description).helpOption(false).allowUnknownOption(true).allowExcessArguments(true).action(async () => {
+          try {
+            const args = program.parseOptions(process.argv);
+            const nonProcessArgs = args.operands.slice(2);
+            const positionalArgs = [];
+            let index = 0;
+            for (let argIndex = 0; argIndex < nonProcessArgs.length; argIndex++) {
+              if (argIndex === index && node.command.path[argIndex] === nonProcessArgs[argIndex]) {
+                index += 1;
+                continue;
+              }
+              positionalArgs.push(nonProcessArgs[argIndex]);
+            }
+            await node.command.execute({
+              args: [...positionalArgs, ...args.unknown],
+              info: {
+                usage: [programName, ...node.command.path].join(" "),
+                description: node.command.description
+              }
+            });
+            process.exit(0);
+          } catch (error) {
+            errors.assertError(error);
+            errors$1.exitWithError(error);
+          }
+        });
+      }
+    }
+    program.on("command:*", () => {
+      console.log();
+      console.log(chalk__default.default.red(`Invalid command: ${program.args.join(" ")}`));
+      console.log();
+      program.outputHelp();
+      process.exit(1);
+    });
+    process.on("unhandledRejection", (rejection) => {
+      if (rejection instanceof Error) {
+        errors$1.exitWithError(rejection);
+      } else {
+        errors$1.exitWithError(new Error(`Unknown rejection: '${rejection}'`));
+      }
+    });
+    program.parse(process.argv);
+  }
+}
+function unwrapFeature(feature) {
+  if ("$$type" in feature) {
+    return feature;
+  }
+  if ("default" in feature) {
+    return feature.default;
+  }
+  return feature;
+}
+
+exports.CliInitializer = CliInitializer;
+exports.unwrapFeature = unwrapFeature;
+//# sourceMappingURL=CliInitializer.cjs.js.map

package/dist/wiring/CommandGraph.cjs.js

@@ -0,0 +1,71 @@
+'use strict';
+
+class CommandGraph {
+  graph = [];
+  /**
+   * Adds a command to the graph. The graph is sparse, so we use the path to determine the nodes
+   *    to traverse. Only leaf nodes should have a command/action.
+   */
+  add(command) {
+    const path = command.path;
+    let current = this.graph;
+    for (let i = 0; i < path.length - 1; i++) {
+      const name = path[i];
+      let next = current.find((n) => n.name === name);
+      if (!next) {
+        next = { $$type: "@tree/root", name, children: [] };
+        current.push(next);
+      } else if (next.$$type === "@tree/leaf") {
+        throw new Error(
+          `Command already exists at path: "${path.slice(0, i).join(" ")}"`
+        );
+      }
+      current = next.children;
+    }
+    const last = current.find((n) => n.name === path[path.length - 1]);
+    if (last && last.$$type === "@tree/leaf") {
+      throw new Error(
+        `Command already exists at path: "${path.slice(0, -1).join(" ")}"`
+      );
+    } else {
+      current.push({
+        $$type: "@tree/leaf",
+        name: path[path.length - 1],
+        command
+      });
+    }
+  }
+  /**
+   * Given a path, try to find a command that matches it.
+   */
+  find(path) {
+    let current = this.graph;
+    for (let i = 0; i < path.length - 1; i++) {
+      const name = path[i];
+      const next = current.find((n) => n.name === name);
+      if (!next) {
+        return void 0;
+      } else if (next.$$type === "@tree/leaf") {
+        return void 0;
+      }
+      current = next.children;
+    }
+    const last = current.find((n) => n.name === path[path.length - 1]);
+    if (!last || last.$$type === "@tree/root") {
+      return void 0;
+    }
+    return last?.command;
+  }
+  atDepth(depth) {
+    let current = this.graph;
+    for (let i = 0; i < depth; i++) {
+      current = current.flatMap(
+        (n) => n.$$type === "@tree/root" ? n.children : []
+      );
+    }
+    return current;
+  }
+}
+
+exports.CommandGraph = CommandGraph;
+//# sourceMappingURL=CommandGraph.cjs.js.map

package/dist/wiring/CommandRegistry.cjs.js

@@ -0,0 +1,14 @@
+'use strict';
+
+class CommandRegistry {
+  graph;
+  constructor(graph) {
+    this.graph = graph;
+  }
+  addCommand(command) {
+    this.graph.add(command);
+  }
+}
+
+exports.CommandRegistry = CommandRegistry;
+//# sourceMappingURL=CommandRegistry.cjs.js.map

package/dist/wiring/factory.cjs.js

@@ -0,0 +1,15 @@
+'use strict';
+
+var describeParentCallSite = require('../packages/frontend-plugin-api/src/routing/describeParentCallSite.cjs.js');
+var types = require('./types.cjs.js');
+
+function createCliPlugin(options) {
+  return types.OpaqueCliPlugin.createInstance("v1", {
+    pluginId: options.pluginId,
+    init: options.init,
+    description: `created at '${describeParentCallSite.describeParentCallSite()}'`
+  });
+}
+
+exports.createCliPlugin = createCliPlugin;
+//# sourceMappingURL=factory.cjs.js.map

package/dist/wiring/types.cjs.js

@@ -0,0 +1,11 @@
+'use strict';
+
+var OpaqueType = require('../packages/opaque-internal/src/OpaqueType.cjs.js');
+
+const OpaqueCliPlugin = OpaqueType.OpaqueType.create({
+  type: "@backstage/CliPlugin",
+  versions: ["v1"]
+});
+
+exports.OpaqueCliPlugin = OpaqueCliPlugin;
+//# sourceMappingURL=types.cjs.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/cli",
-  "version": "0.32.2-next.0",
+  "version": "0.33.0-next.1",
   "description": "CLI for developing Backstage plugins and apps",
   "backstage": {
     "role": "cli"
@@ -20,8 +20,7 @@
   "license": "Apache-2.0",
   "main": "dist/index.cjs.js",
   "bin": {
-    "backstage-cli": "bin/backstage-cli",
-    "backstage-cli-alpha": "bin/backstage-cli-alpha"
+    "backstage-cli": "bin/backstage-cli"
   },
   "files": [
     "asset-types",
@@ -165,19 +164,19 @@
   },
   "devDependencies": {
     "@backstage/backend-plugin-api": "1.4.0-next.1",
-    "@backstage/backend-test-utils": "1.6.0-next.1",
+    "@backstage/backend-test-utils": "1.6.0-next.2",
     "@backstage/catalog-client": "1.10.1-next.0",
     "@backstage/config": "1.3.2",
     "@backstage/core-app-api": "1.17.0",
-    "@backstage/core-components": "0.17.2",
+    "@backstage/core-components": "0.17.3-next.0",
     "@backstage/core-plugin-api": "1.10.7",
-    "@backstage/dev-utils": "1.1.11-next.1",
+    "@backstage/dev-utils": "1.1.11-next.2",
     "@backstage/errors": "1.2.7",
     "@backstage/plugin-auth-backend": "0.25.1-next.1",
     "@backstage/plugin-auth-backend-module-guest-provider": "0.2.9-next.1",
     "@backstage/plugin-catalog-node": "1.17.1-next.1",
-    "@backstage/plugin-scaffolder-node": "0.8.3-next.1",
-    "@backstage/plugin-scaffolder-node-test-utils": "0.2.3-next.1",
+    "@backstage/plugin-scaffolder-node": "0.9.0-next.2",
+    "@backstage/plugin-scaffolder-node-test-utils": "0.3.0-next.2",
     "@backstage/test-utils": "1.7.8",
     "@backstage/theme": "0.6.6",
     "@rspack/core": "^1.3.9",

package/templates/backend-plugin/package.json.hbs

@@ -8,7 +8,8 @@
     "types": "dist/index.d.ts"
   },
   "backstage": {
-    "role": "backend-plugin"
+    "role": "backend-plugin",
+    "pluginId": "{{pluginId}}"
   },
   "scripts": {
     "start": "backstage-cli package start",

package/templates/backend-plugin-module/package.json.hbs

@@ -9,7 +9,8 @@
     "types": "dist/index.d.ts"
   },
   "backstage": {
-    "role": "backend-plugin-module"
+    "role": "backend-plugin-module",
+    "pluginId": "{{pluginId}}"
   },
   "scripts": {
     "start": "backstage-cli package start",

package/templates/frontend-plugin/package.json.hbs

@@ -8,7 +8,8 @@
     "types": "dist/index.d.ts"
   },
   "backstage": {
-    "role": "frontend-plugin"
+    "role": "frontend-plugin",
+    "pluginId": "{{pluginId}}"
   },
   "sideEffects": false,
   "scripts": {

package/templates/plugin-common-library/package.json.hbs

@@ -10,7 +10,8 @@
     "types": "dist/index.d.ts"
   },
   "backstage": {
-    "role": "common-library"
+    "role": "common-library",
+    "pluginId": "{{pluginId}}"
   },
   "sideEffects": false,
   "scripts": {

package/templates/plugin-node-library/package.json.hbs

@@ -9,7 +9,8 @@
     "types": "dist/index.d.ts"
   },
   "backstage": {
-    "role": "node-library"
+    "role": "node-library",
+    "pluginId": "{{pluginId}}"
   },
   "scripts": {
     "build": "backstage-cli package build",

package/templates/plugin-web-library/package.json.hbs

@@ -9,7 +9,8 @@
     "types": "dist/index.d.ts"
   },
   "backstage": {
-    "role": "web-library"
+    "role": "web-library",
+    "pluginId": "{{pluginId}}"
   },
   "sideEffects": false,
   "scripts": {

package/templates/scaffolder-backend-module/package.json.hbs

@@ -9,7 +9,8 @@
     "types": "dist/index.d.ts"
   },
   "backstage": {
-    "role": "backend-plugin-module"
+    "role": "backend-plugin-module",
+    "pluginId": "scaffolder"
   },
   "scripts": {
     "start": "backstage-cli package start",

package/templates/scaffolder-backend-module/src/actions/example.ts

@@ -12,22 +12,16 @@ import { createTemplateAction } from '@backstage/plugin-scaffolder-node';
 export function createExampleAction() {
   // For more information on how to define custom actions, see
   //   https://backstage.io/docs/features/software-templates/writing-custom-actions
-  return createTemplateAction<{
-    myParameter: string;
-  }>({
+  return createTemplateAction({
     id: 'acme:example',
     description: 'Runs an example action',
     schema: {
       input: {
-        type: 'object',
-        required: ['myParameter'],
-        properties: {
-          myParameter: {
-            title: 'An example parameter',
-            description: "This is an example parameter, don't set it to foo",
-            type: 'string',
-          },
-        },
+        myParameter: z =>
+          z.string({
+            description:
+              "This is an example parameter, don't set it to foo",
+          }),
       },
     },
     async handler(ctx) {

package/dist/commands/index.cjs.js

@@ -1,52 +0,0 @@
-'use strict';
-
-var index = require('../modules/config/index.cjs.js');
-var index$2 = require('../modules/build/index.cjs.js');
-var index$3 = require('../modules/info/index.cjs.js');
-var index$1 = require('../modules/migrate/index.cjs.js');
-var index$6 = require('../modules/test/index.cjs.js');
-var index$7 = require('../modules/lint/index.cjs.js');
-var index$8 = require('../modules/maintenance/index.cjs.js');
-var removed = require('../lib/removed.cjs.js');
-var index$4 = require('../modules/new/index.cjs.js');
-var index$5 = require('../modules/create-github-app/index.cjs.js');
-
-function registerRepoCommand(program) {
-  const command = program.command("repo [command]").description("Command that run across an entire Backstage project");
-  index$2.registerRepoCommands(command);
-  index$6.registerRepoCommands(command);
-  index$7.registerRepoCommands(command);
-  index$8.registerRepoCommands(command);
-}
-function registerScriptCommand(program) {
-  const command = program.command("package [command]").description("Lifecycle scripts for individual packages");
-  index$2.registerPackageCommands(command);
-  index$6.registerPackageCommands(command);
-  index$8.registerPackageCommands(command);
-  index$7.registerPackageCommands(command);
-}
-function registerCommands(program) {
-  index.registerCommands(program);
-  registerRepoCommand(program);
-  registerScriptCommand(program);
-  index$1.registerCommands(program);
-  index$2.registerCommands(program);
-  index$3.registerCommands(program);
-  index$4.registerCommands(program);
-  index$5.registerCommands(program);
-  program.command("plugin:diff").allowUnknownOption(true).action(removed.removed("use 'backstage-cli fix' instead"));
-  program.command("test").allowUnknownOption(true).action(
-    removed.removed(
-      "use 'backstage-cli repo test' or 'backstage-cli package test' instead"
-    )
-  );
-  program.command("clean").allowUnknownOption(true).action(removed.removed("use 'backstage-cli package clean' instead"));
-  program.command("versions:check").allowUnknownOption(true).action(removed.removed("use 'yarn dedupe' or 'yarn-deduplicate' instead"));
-  program.command("install").allowUnknownOption(true).action(removed.removed());
-  program.command("onboard").allowUnknownOption(true).action(removed.removed());
-}
-
-exports.registerCommands = registerCommands;
-exports.registerRepoCommand = registerRepoCommand;
-exports.registerScriptCommand = registerScriptCommand;
-//# sourceMappingURL=index.cjs.js.map

package/dist/modules/config/commands/print.cjs.js

@@ -1,53 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var yaml = require('yaml');
-var config$1 = require('@backstage/config');
-var config = require('../lib/config.cjs.js');
-
-var print = async (opts) => {
-  const { schema, appConfigs } = await config.loadCliConfig({
-    args: opts.config,
-    fromPackage: opts.package,
-    mockEnv: opts.lax,
-    fullVisibility: !opts.frontend
-  });
-  const visibility = getVisibilityOption(opts);
-  const data = serializeConfigData(appConfigs, schema, visibility);
-  if (opts.format === "json") {
-    process.stdout.write(`${JSON.stringify(data, null, 2)}
-`);
-  } else {
-    process.stdout.write(`${yaml.stringify(data)}
-`);
-  }
-};
-function getVisibilityOption(opts) {
-  if (opts.frontend && opts.withSecrets) {
-    throw new Error("Not allowed to combine frontend and secret config");
-  }
-  if (opts.frontend) {
-    return "frontend";
-  } else if (opts.withSecrets) {
-    return "secret";
-  }
-  return "backend";
-}
-function serializeConfigData(appConfigs, schema, visibility) {
-  if (visibility === "frontend") {
-    const frontendConfigs = schema.process(appConfigs, {
-      visibility: ["frontend"]
-    });
-    return config$1.ConfigReader.fromConfigs(frontendConfigs).get();
-  } else if (visibility === "secret") {
-    return config$1.ConfigReader.fromConfigs(appConfigs).get();
-  }
-  const sanitizedConfigs = schema.process(appConfigs, {
-    valueTransform: (value, context) => context.visibility === "secret" ? "<secret>" : value
-  });
-  return config$1.ConfigReader.fromConfigs(sanitizedConfigs).get();
-}
-
-exports.default = print;
-//# sourceMappingURL=print.cjs.js.map

package/dist/modules/config/commands/validate.cjs.js

@@ -1,19 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var config = require('../lib/config.cjs.js');
-
-var validate = async (opts) => {
-  await config.loadCliConfig({
-    args: opts.config,
-    fromPackage: opts.package,
-    mockEnv: opts.lax,
-    fullVisibility: !opts.frontend,
-    withDeprecatedKeys: opts.deprecated,
-    strict: opts.strict
-  });
-};
-
-exports.default = validate;
-//# sourceMappingURL=validate.cjs.js.map