@backstage/cli 0.36.0-next.2 → 0.36.0

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

@@ -1,63 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var cleye = require('cleye');
-var configLoader = require('@backstage/config-loader');
-var openBrowser = require('react-dev-utils/openBrowser');
-var chalk = require('chalk');
-var config = require('../lib/config.cjs.js');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var openBrowser__default = /*#__PURE__*/_interopDefaultCompat(openBrowser);
-var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-
-const DOCS_URL = "https://config.backstage.io";
-var docs = async ({ args, info }) => {
-  const {
-    flags: { package: pkg }
-  } = cleye.cli(
-    {
-      help: info,
-      booleanFlagNegation: true,
-      flags: {
-        package: {
-          type: String,
-          description: "Only include the schema that applies to the given package"
-        }
-      }
-    },
-    void 0,
-    args
-  );
-  const { schema: appSchemas } = await config.loadCliConfig({
-    args: [],
-    fromPackage: pkg,
-    mockEnv: true
-  });
-  const schema = configLoader.mergeConfigSchemas(
-    appSchemas.serialize().schemas.map(
-      (_) => _.value
-    )
-  );
-  const url = `${DOCS_URL}#schema=${JSON.stringify(schema)}`;
-  console.log();
-  console.log(
-    chalk__default.default.cyan(
-      "Opening configuration reference documentation in your browser..."
-    )
-  );
-  console.log(`  ${chalk__default.default.cyan(url)}`);
-  console.log();
-  const opened = openBrowser__default.default(url);
-  if (!opened) {
-    console.log(
-      chalk__default.default.yellow("\u26A0\uFE0F  WARNING: Unable to open browser automatically.")
-    );
-    console.log(chalk__default.default.yellow("Please open the URL manually in your browser."));
-  }
-};
-
-exports.default = docs;
-//# sourceMappingURL=docs.cjs.js.map

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

@@ -1,81 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var cleye = require('cleye');
-var YAML = require('yaml');
-var config$1 = require('@backstage/config');
-var config = require('../lib/config.cjs.js');
-
-var print = async ({ args, info }) => {
-  const {
-    flags: { config: config$1, lax, frontend, withSecrets, format, package: pkg }
-  } = cleye.cli(
-    {
-      help: info,
-      booleanFlagNegation: true,
-      flags: {
-        package: { type: String, description: "Package to print config for" },
-        lax: {
-          type: Boolean,
-          description: "Do not require environment variables to be set"
-        },
-        frontend: { type: Boolean, description: "Only print frontend config" },
-        withSecrets: {
-          type: Boolean,
-          description: "Include secrets in the output"
-        },
-        format: { type: String, description: "Output format (yaml or json)" },
-        config: {
-          type: [String],
-          description: "Config files to load instead of app-config.yaml"
-        }
-      }
-    },
-    void 0,
-    args
-  );
-  const { schema, appConfigs } = await config.loadCliConfig({
-    args: config$1,
-    fromPackage: pkg,
-    mockEnv: lax,
-    fullVisibility: !frontend
-  });
-  const visibility = getVisibilityOption(frontend, withSecrets);
-  const data = serializeConfigData(appConfigs, schema, visibility);
-  if (format === "json") {
-    process.stdout.write(`${JSON.stringify(data, null, 2)}
-`);
-  } else {
-    process.stdout.write(`${YAML.stringify(data)}
-`);
-  }
-};
-function getVisibilityOption(frontend, withSecrets) {
-  if (frontend && withSecrets) {
-    throw new Error("Not allowed to combine frontend and secret config");
-  }
-  if (frontend) {
-    return "frontend";
-  } else if (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/schema.cjs.js

@@ -1,56 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var cleye = require('cleye');
-var YAML = require('yaml');
-var config = require('../lib/config.cjs.js');
-var configLoader = require('@backstage/config-loader');
-
-var schema = async ({ args, info }) => {
-  const {
-    flags: { merge, format, package: pkg }
-  } = cleye.cli(
-    {
-      help: info,
-      booleanFlagNegation: true,
-      flags: {
-        package: { type: String, description: "Package to print schema for" },
-        format: { type: String, description: "Output format (yaml or json)" },
-        merge: {
-          type: Boolean,
-          description: "Merge all schemas into a single schema"
-        }
-      }
-    },
-    void 0,
-    args
-  );
-  const { schema } = await config.loadCliConfig({
-    args: [],
-    fromPackage: pkg,
-    mockEnv: true
-  });
-  let configSchema;
-  if (merge) {
-    configSchema = configLoader.mergeConfigSchemas(
-      schema.serialize().schemas.map(
-        (_) => _.value
-      )
-    );
-    configSchema.title = "Application Configuration Schema";
-    configSchema.description = "This is the schema describing the structure of the app-config.yaml configuration file.";
-  } else {
-    configSchema = schema.serialize();
-  }
-  if (format === "json") {
-    process.stdout.write(`${JSON.stringify(configSchema, null, 2)}
-`);
-  } else {
-    process.stdout.write(`${YAML.stringify(configSchema)}
-`);
-  }
-};
-
-exports.default = schema;
-//# sourceMappingURL=schema.cjs.js.map

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

@@ -1,50 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var cleye = require('cleye');
-var config = require('../lib/config.cjs.js');
-
-var validate = async ({ args, info }) => {
-  const {
-    flags: { config: config$1, lax, frontend, deprecated, strict, package: pkg }
-  } = cleye.cli(
-    {
-      help: info,
-      booleanFlagNegation: true,
-      flags: {
-        package: {
-          type: String,
-          description: "Package to validate config for"
-        },
-        lax: {
-          type: Boolean,
-          description: "Do not require environment variables to be set"
-        },
-        frontend: {
-          type: Boolean,
-          description: "Only validate frontend config"
-        },
-        deprecated: { type: Boolean, description: "Output deprecated keys" },
-        strict: { type: Boolean, description: "Enable strict validation" },
-        config: {
-          type: [String],
-          description: "Config files to load instead of app-config.yaml"
-        }
-      }
-    },
-    void 0,
-    args
-  );
-  await config.loadCliConfig({
-    args: config$1,
-    fromPackage: pkg,
-    mockEnv: lax,
-    fullVisibility: !frontend,
-    withDeprecatedKeys: deprecated,
-    strict
-  });
-};
-
-exports.default = validate;
-//# sourceMappingURL=validate.cjs.js.map

package/dist/modules/config/index.cjs.js

@@ -1,51 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var factory = require('../../wiring/factory.cjs.js');
-
-const configOption = [
-  "--config <path>",
-  "Config files to load instead of app-config.yaml",
-  (opt, opts) => opts ? [...opts, opt] : [opt],
-  Array()
-];
-var index = factory.createCliPlugin({
-  pluginId: "config",
-  init: async (reg) => {
-    reg.addCommand({
-      path: ["config:docs"],
-      description: "Browse the configuration reference documentation",
-      execute: { loader: () => import('./commands/docs.cjs.js') }
-    });
-    reg.addCommand({
-      path: ["config", "docs"],
-      description: "Browse the configuration reference documentation",
-      execute: { loader: () => import('./commands/docs.cjs.js') }
-    });
-    reg.addCommand({
-      path: ["config:print"],
-      description: "Print the app configuration for the current package",
-      execute: { loader: () => import('./commands/print.cjs.js') }
-    });
-    reg.addCommand({
-      path: ["config:check"],
-      description: "Validate that the given configuration loads and matches schema",
-      execute: { loader: () => import('./commands/validate.cjs.js') }
-    });
-    reg.addCommand({
-      path: ["config:schema"],
-      description: "Print the JSON schema for the given configuration",
-      execute: { loader: () => import('./commands/schema.cjs.js') }
-    });
-    reg.addCommand({
-      path: ["config", "schema"],
-      description: "Print the JSON schema for the given configuration",
-      execute: { loader: () => import('./commands/schema.cjs.js') }
-    });
-  }
-});
-
-exports.configOption = configOption;
-exports.default = index;
-//# sourceMappingURL=index.cjs.js.map

package/dist/modules/config/lib/config.cjs.js

@@ -1,94 +0,0 @@
-'use strict';
-
-var configLoader = require('@backstage/config-loader');
-var config = require('@backstage/config');
-var cliCommon = require('@backstage/cli-common');
-var getPackages = require('@manypkg/get-packages');
-var cliNode = require('@backstage/cli-node');
-var path = require('node:path');
-
-async function loadCliConfig(options) {
-  const targetDir = options.targetDir ?? cliCommon.targetPaths.dir;
-  const { packages } = await getPackages.getPackages(targetDir);
-  let localPackageNames;
-  if (options.fromPackage) {
-    if (packages.length) {
-      const graph = cliNode.PackageGraph.fromPackages(packages);
-      localPackageNames = Array.from(
-        graph.collectPackageNames([options.fromPackage], (node) => {
-          if (node.name === "@backstage/cli") {
-            return void 0;
-          }
-          return node.localDependencies.keys();
-        })
-      );
-    } else {
-      localPackageNames = [options.fromPackage];
-    }
-  } else {
-    localPackageNames = packages.map((p) => p.packageJson.name);
-  }
-  const schema = await configLoader.loadConfigSchema({
-    dependencies: localPackageNames,
-    // Include the package.json in the project root if it exists
-    packagePaths: [cliCommon.targetPaths.resolveRoot("package.json")],
-    noUndeclaredProperties: options.strict
-  });
-  const source = configLoader.ConfigSources.default({
-    allowMissingDefaultConfig: true,
-    substitutionFunc: options.mockEnv ? async (name) => process.env[name] || "x" : void 0,
-    rootDir: cliCommon.targetPaths.rootDir,
-    argv: options.args.flatMap((t) => ["--config", path.resolve(targetDir, t)])
-  });
-  const appConfigs = await new Promise((resolve, reject) => {
-    async function readConfig() {
-      let loaded = false;
-      try {
-        const abortController = new AbortController();
-        for await (const { configs } of source.readConfigData({
-          signal: abortController.signal
-        })) {
-          resolve(configs);
-          loaded = true;
-          abortController.abort();
-        }
-      } catch (error) {
-        if (!loaded) {
-          reject(error);
-        }
-      }
-    }
-    readConfig();
-  });
-  const configurationLoadedMessage = appConfigs.length ? `Loaded config from ${appConfigs.map((c) => c.context).join(", ")}` : `No configuration files found, running without config`;
-  process.stderr.write(`${configurationLoadedMessage}
-`);
-  try {
-    const frontendAppConfigs = schema.process(appConfigs, {
-      visibility: options.fullVisibility ? ["frontend", "backend", "secret"] : ["frontend"],
-      withDeprecatedKeys: options.withDeprecatedKeys,
-      ignoreSchemaErrors: !options.strict
-    });
-    const frontendConfig = config.ConfigReader.fromConfigs(frontendAppConfigs);
-    const fullConfig = config.ConfigReader.fromConfigs(appConfigs);
-    return {
-      schema,
-      appConfigs,
-      frontendConfig,
-      frontendAppConfigs,
-      fullConfig
-    };
-  } catch (error) {
-    const maybeSchemaError = error;
-    if (maybeSchemaError.messages) {
-      const messages = maybeSchemaError.messages.join("\n  ");
-      throw new Error(`Configuration does not match schema
-
-  ${messages}`);
-    }
-    throw error;
-  }
-}
-
-exports.loadCliConfig = loadCliConfig;
-//# sourceMappingURL=config.cjs.js.map

package/dist/modules/create-github-app/commands/create-github-app/GithubCreateAppServer.cjs.js

@@ -1,127 +0,0 @@
-'use strict';
-
-var crypto = require('node:crypto');
-var openBrowser = require('react-dev-utils/openBrowser');
-var request = require('@octokit/request');
-var express = require('express');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var crypto__default = /*#__PURE__*/_interopDefaultCompat(crypto);
-var openBrowser__default = /*#__PURE__*/_interopDefaultCompat(openBrowser);
-var express__default = /*#__PURE__*/_interopDefaultCompat(express);
-
-const FORM_PAGE = `
-<html>
-  <body>
-    <form id="form" action="ACTION_URL" method="post">
-      <input type="hidden" name="manifest" value="MANIFEST_JSON">
-      <input type="submit" value="Continue">
-    </form>
-    <script>
-      document.getElementById("form").submit()
-    <\/script>
-  </body>
-</html>
-`;
-class GithubCreateAppServer {
-  baseUrl;
-  webhookUrl;
-  static async run(options) {
-    const encodedOrg = encodeURIComponent(options.org);
-    const actionUrl = `https://github.com/organizations/${encodedOrg}/settings/apps/new`;
-    const server = new GithubCreateAppServer(actionUrl, options.permissions);
-    return server.start();
-  }
-  actionUrl;
-  permissions;
-  constructor(actionUrl, permissions) {
-    this.actionUrl = actionUrl;
-    this.permissions = permissions;
-    const webhookId = crypto__default.default.randomBytes(15).toString("base64").replace(/[\+\/]/g, "");
-    this.webhookUrl = `https://smee.io/${webhookId}`;
-  }
-  async start() {
-    const app = express__default.default();
-    app.get("/", this.formHandler);
-    const callPromise = new Promise((resolve, reject) => {
-      app.get("/callback", (req, res) => {
-        request.request(
-          `POST /app-manifests/${encodeURIComponent(
-            req.query.code
-          )}/conversions`
-        ).then(({ data }) => {
-          resolve({
-            name: data.name,
-            slug: data.slug,
-            appId: data.id,
-            webhookUrl: this.webhookUrl,
-            clientId: data.client_id,
-            clientSecret: data.client_secret,
-            webhookSecret: data.webhook_secret,
-            privateKey: data.pem
-          });
-          res.redirect(302, `${data.html_url}/installations/new`);
-        }, reject);
-      });
-    });
-    this.baseUrl = await this.listen(app);
-    openBrowser__default.default(this.baseUrl);
-    return callPromise;
-  }
-  formHandler = (_req, res) => {
-    const baseUrl = this.baseUrl;
-    if (!baseUrl) {
-      throw new Error("baseUrl is not set");
-    }
-    const manifest = {
-      default_events: ["create", "delete", "push", "repository"],
-      default_permissions: {
-        metadata: "read",
-        ...this.permissions.includes("members") && {
-          members: "read"
-        },
-        ...this.permissions.includes("read") && {
-          contents: "read",
-          checks: "read"
-        },
-        ...this.permissions.includes("write") && {
-          contents: "write",
-          checks: "read",
-          actions: "write"
-        }
-      },
-      name: "Backstage-<changeme>",
-      url: "https://backstage.io",
-      description: "GitHub App for Backstage",
-      public: false,
-      redirect_url: `${baseUrl}/callback`,
-      hook_attributes: {
-        url: this.webhookUrl,
-        active: false
-      }
-    };
-    const manifestJson = JSON.stringify(manifest).replace(/\"/g, "&quot;");
-    let body = FORM_PAGE;
-    body = body.replace("MANIFEST_JSON", manifestJson);
-    body = body.replace("ACTION_URL", this.actionUrl);
-    res.setHeader("content-type", "text/html");
-    res.send(body);
-  };
-  async listen(app) {
-    return new Promise((resolve, reject) => {
-      const listener = app.listen(0, () => {
-        const info = listener.address();
-        if (typeof info !== "object" || info === null) {
-          reject(new Error(`Unexpected listener info '${info}'`));
-          return;
-        }
-        const { port } = info;
-        resolve(`http://localhost:${port}`);
-      });
-    });
-  }
-}
-
-exports.GithubCreateAppServer = GithubCreateAppServer;
-//# sourceMappingURL=GithubCreateAppServer.cjs.js.map

package/dist/modules/create-github-app/commands/create-github-app/index.cjs.js

@@ -1,126 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var fs = require('fs-extra');
-var chalk = require('chalk');
-var YAML = require('yaml');
-var inquirer = require('inquirer');
-var cliCommon = require('@backstage/cli-common');
-var cleye = require('cleye');
-var GithubCreateAppServer = require('./GithubCreateAppServer.cjs.js');
-var openBrowser = require('react-dev-utils/openBrowser');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-var inquirer__default = /*#__PURE__*/_interopDefaultCompat(inquirer);
-var openBrowser__default = /*#__PURE__*/_interopDefaultCompat(openBrowser);
-
-var index = async ({ args, info }) => {
-  const { _: positionals } = cleye.cli(
-    {
-      help: { ...info, usage: `${info.usage} <github-org>` },
-      booleanFlagNegation: true,
-      parameters: ["<github-org>"]
-    },
-    void 0,
-    args
-  );
-  const org = positionals[0];
-  const answers = await inquirer__default.default.prompt({
-    name: "appType",
-    type: "checkbox",
-    message: "Select permissions [required] (these can be changed later but then require approvals in all installations)",
-    choices: [
-      {
-        name: "Read access to content (required by Software Catalog to ingest data from repositories)",
-        value: "read",
-        checked: true
-      },
-      {
-        name: "Read access to members (required by Software Catalog to ingest GitHub teams)",
-        value: "members",
-        checked: true
-      },
-      {
-        name: "Read and Write to content and actions (required by Software Templates to create new repositories)",
-        value: "write"
-      }
-    ]
-  });
-  if (answers.appType.length === 0) {
-    console.log(chalk__default.default.red("You must select at least one permission"));
-    process.exit(1);
-  }
-  await verifyGithubOrg(org);
-  const { slug, name, ...config } = await GithubCreateAppServer.GithubCreateAppServer.run({
-    org,
-    permissions: answers.appType
-  });
-  const fileName = `github-app-${slug}-credentials.yaml`;
-  const content = `# Name: ${name}
-${YAML.stringify(config)}`;
-  await fs__default.default.writeFile(cliCommon.targetPaths.resolveRoot(fileName), content);
-  console.log(`GitHub App configuration written to ${chalk__default.default.cyan(fileName)}`);
-  console.log(
-    chalk__default.default.yellow(
-      "This file contains sensitive credentials, it should not be committed to version control and handled with care!"
-    )
-  );
-  console.log(
-    "Here's an example on how to update the integrations section in app-config.yaml"
-  );
-  console.log(
-    chalk__default.default.green(`
-integrations:
-  github:
-    - host: github.com
-      apps:
-        - $include: ${fileName}`)
-  );
-};
-async function verifyGithubOrg(org) {
-  let response;
-  try {
-    response = await fetch(
-      `https://api.github.com/orgs/${encodeURIComponent(org)}`
-    );
-  } catch (e) {
-    console.log(
-      chalk__default.default.yellow(
-        "Warning: Unable to verify existence of GitHub organization. ",
-        e
-      )
-    );
-  }
-  if (response?.status === 404) {
-    const questions = [
-      {
-        type: "confirm",
-        name: "shouldCreateOrg",
-        message: `GitHub organization ${chalk__default.default.cyan(
-          org
-        )} does not exist. Would you like to create a new Organization instead?`
-      }
-    ];
-    const answers = await inquirer__default.default.prompt(questions);
-    if (!answers.shouldCreateOrg) {
-      console.log(
-        chalk__default.default.yellow("GitHub organization must exist to create GitHub app")
-      );
-      process.exit(1);
-    }
-    openBrowser__default.default("https://github.com/account/organizations/new");
-    console.log(
-      chalk__default.default.yellow(
-        "Please re-run this command when you have created your new organization"
-      )
-    );
-    process.exit(0);
-  }
-}
-
-exports.default = index;
-//# sourceMappingURL=index.cjs.js.map

package/dist/modules/create-github-app/index.cjs.js

@@ -1,19 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var factory = require('../../wiring/factory.cjs.js');
-
-var index = factory.createCliPlugin({
-  pluginId: "new",
-  init: async (reg) => {
-    reg.addCommand({
-      path: ["create-github-app"],
-      description: "Create new GitHub App in your organization.",
-      execute: { loader: () => import('./commands/create-github-app/index.cjs.js') }
-    });
-  }
-});
-
-exports.default = index;
-//# sourceMappingURL=index.cjs.js.map