@backstage/repo-tools 0.11.0-next.0 → 0.11.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # @backstage/repo-tools
 
+## 0.11.0-next.2
+
+### Minor Changes
+
+- 1440232: `backstage-repo-tools package schema openapi generate --server` now generates complete TS interfaces for all request/response objects in your OpenAPI schema. This fixes an edge case around recursive schemas and standardizes both the generated client and server to have similar generated types.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.0.2-next.2
+  - @backstage/catalog-model@1.7.0
+  - @backstage/cli-common@0.1.15-next.0
+  - @backstage/cli-node@0.2.10-next.0
+  - @backstage/config-loader@1.9.2-next.0
+  - @backstage/errors@1.2.4
+
+## 0.11.0-next.1
+
+### Patch Changes
+
+- dde85ee: Added a new `generate-patch` command that can be used to generate patches for current changes in a source workspace to be installed it a target workspace.
+- 702f41d: Bumped dev dependencies `@types/node`
+- Updated dependencies
+  - @backstage/cli-common@0.1.15-next.0
+  - @backstage/backend-plugin-api@1.0.2-next.1
+  - @backstage/catalog-model@1.7.0
+  - @backstage/cli-node@0.2.10-next.0
+  - @backstage/config-loader@1.9.2-next.0
+  - @backstage/errors@1.2.4
+
 ## 0.11.0-next.0
 
 ### Minor Changes

package/dist/commands/generate-patch/generate-patch.cjs.js

@@ -0,0 +1,321 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var getPackages = require('@manypkg/get-packages');
+var os = require('os');
+var fs = require('fs-extra');
+var path = require('path');
+var exec = require('../../lib/exec.cjs.js');
+var errors = require('@backstage/errors');
+var stream = require('stream');
+var promises = require('stream/promises');
+var tar = require('tar');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var os__default = /*#__PURE__*/_interopDefaultCompat(os);
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+var tar__default = /*#__PURE__*/_interopDefaultCompat(tar);
+
+const DEFAULT_REGISTRY_URL = "https://registry.npmjs.org";
+const PATCH_GITIGNORE = [
+  // Avoid generating patches for source maps
+  "*.map",
+  // Patching package.json has no effect, so exclude
+  "package.json",
+  // No point patching docs
+  "/*.md",
+  "/docs"
+];
+const GIT_ENV = {
+  GIT_CONFIG_NOSYSTEM: "1",
+  HOME: "",
+  XDG_CONFIG_HOME: "",
+  USERPROFILE: ""
+};
+var generatePatch = async (packageArg, opts) => {
+  const sourceRepo = await getPackages.getPackages(process.cwd());
+  const targetRepo = await getPackages.getPackages(opts.target);
+  const registryUrl = opts.registryUrl || DEFAULT_REGISTRY_URL;
+  if (targetRepo.tool !== "yarn") {
+    throw new Error(
+      `Unable to generate patch for target repo, tool is not supported: ${targetRepo.tool}`
+    );
+  }
+  if (sourceRepo.root.dir === targetRepo.root.dir) {
+    throw new Error(
+      `Unexpected workspace roots, source and target repo are the same: ${sourceRepo.root.dir}`
+    );
+  }
+  await verifyYarnVersion(sourceRepo.root.dir);
+  await verifyYarnVersion(targetRepo.root.dir);
+  const sourcePkg = sourceRepo.packages.find(
+    (pkg) => pkg.packageJson.name === packageArg || path.relative(sourceRepo.root.dir, pkg.dir) === packageArg
+  );
+  if (!sourcePkg) {
+    throw new Error(`Could not find package ${packageArg} in source repo`);
+  }
+  const tmpDir = await fs__default.default.mkdtemp(os__default.default.tmpdir());
+  const ctx = {
+    sourceRepo,
+    targetRepo,
+    sourcePkg,
+    packageName: sourcePkg.packageJson.name,
+    targetRoot: targetRepo.root.dir,
+    registryUrl,
+    workDir: tmpDir
+  };
+  try {
+    const updateTargetRootPkg = await loadTrimmedRootPkg(ctx, opts.query);
+    console.log(
+      `Building and packaging target package ${sourcePkg.packageJson.name}`
+    );
+    const targetArchive = await buildTargetArchive(ctx);
+    console.log(`Generating patch from ${sourcePkg.packageJson.version}`);
+    const patchEntry = await generatePatch$1(
+      ctx,
+      targetArchive,
+      opts.baseVersion || sourcePkg.packageJson.version
+    );
+    await updateTargetRootPkg(patchEntry);
+    if (!opts.skipInstall) {
+      console.log("Running 'yarn install' in target workspace");
+      await exec.exec("yarn", ["install"], {
+        cwd: ctx.targetRoot
+      }).catch(() => {
+        throw new Error(
+          "Failed to run 'yarn install' in target workspace, please run it manually to troubleshoot"
+        );
+      });
+    } else {
+      console.log("Skipped running 'yarn install'");
+    }
+  } finally {
+    fs__default.default.rmSync(tmpDir, { force: true, recursive: true, maxRetries: 3 });
+  }
+};
+async function loadTrimmedRootPkg(ctx, query) {
+  const newPkgJson = JSON.parse(
+    JSON.stringify(ctx.targetRepo.root.packageJson)
+  );
+  const resolutionsObj = newPkgJson.resolutions || (newPkgJson.resolutions = {});
+  const searchEntry = query ? `${ctx.packageName}@${query}` : ctx.packageName;
+  if (query || resolutionsObj[searchEntry]) {
+    const existingPatchFile = tryParsePatchResolution(
+      resolutionsObj[searchEntry]
+    );
+    if (existingPatchFile) {
+      await fs__default.default.rm(path.resolve(ctx.targetRoot, existingPatchFile), {
+        force: true
+      });
+    }
+    return async (patchEntry) => {
+      resolutionsObj[searchEntry] = patchEntry;
+      await fs__default.default.writeJson(
+        path.resolve(ctx.targetRoot, "package.json"),
+        newPkgJson,
+        {
+          spaces: 2
+        }
+      );
+    };
+  }
+  const resolutionMap = await readResolutionMap(ctx);
+  const entriesToRemove = Object.entries(resolutionsObj).filter(
+    ([key]) => key.startsWith(`${ctx.packageName}@`)
+  );
+  for (const [key, value] of entriesToRemove) {
+    delete resolutionsObj[key];
+    const existingPatchFile = tryParsePatchResolution(value);
+    if (existingPatchFile) {
+      await fs__default.default.rm(path.resolve(ctx.targetRoot, existingPatchFile), {
+        force: true
+      });
+    }
+  }
+  const descriptors = new Array();
+  for (const [descriptor, locator] of resolutionMap) {
+    if (!locator.includes("@npm:")) {
+      if (!locator.includes("@virtual:")) {
+        console.warn(`Skipping resolution for ${descriptor}, no version found`);
+      }
+      continue;
+    }
+    descriptors.push(descriptor);
+  }
+  return async (patchEntry) => {
+    for (const descriptor of descriptors) {
+      resolutionsObj[descriptor] = patchEntry;
+    }
+    await fs__default.default.writeJson(
+      path.resolve(ctx.targetRoot, "package.json"),
+      newPkgJson,
+      {
+        spaces: 2
+      }
+    );
+  };
+}
+async function verifyYarnVersion(cwd) {
+  const exists = await fs__default.default.pathExists(path.join(cwd, ".yarnrc.yml"));
+  if (!exists) {
+    throw new Error(
+      `Missing .yarnrc.yml in ${cwd}, Yarn v1 (classic) is not support by this command`
+    );
+  }
+}
+async function generatePatch$1(ctx, targetArchive, version) {
+  const baseArchive = await downloadArchive(ctx, version);
+  const patch = await generatePatchForArchives(ctx, baseArchive, targetArchive);
+  if (!patch) {
+    console.warn(`Generated patch for ${ctx.packageName} is empty`);
+    return void 0;
+  }
+  const cleanPackageName = ctx.packageName.replace("/", "-");
+  const describeResult = await exec.exec(
+    "git",
+    ["describe", "--always", "--dirty", "--exclude='*'"],
+    {
+      cwd: ctx.sourceRepo.root.dir,
+      env: { ...process.env, ...GIT_ENV }
+    }
+  );
+  const describe = describeResult.stdout.toString("utf8").trim();
+  const name = `${cleanPackageName}-${version}-${describe}.patch`;
+  const patchDir = path.join(ctx.targetRepo.root.dir, ".yarn", "patches");
+  await fs__default.default.ensureDir(patchDir);
+  await fs__default.default.writeFile(path.join(patchDir, name), patch, "utf8");
+  const locator = `${ctx.sourcePkg.packageJson.name}@npm:${version}`;
+  return `patch:${encodeURIComponent(locator)}#${path.posix.join(
+    ".",
+    ".yarn",
+    "patches",
+    name
+  )}`;
+}
+function tryParsePatchResolution(value) {
+  if (!value) {
+    return void 0;
+  }
+  if (!value.startsWith("patch:")) {
+    return void 0;
+  }
+  const patchFilePath = value.split("#")[1];
+  return patchFilePath;
+}
+async function readResolutionMap(ctx) {
+  const { stdout: whyOutput } = await exec.exec(
+    "yarn",
+    ["why", "--json", ctx.packageName],
+    {
+      cwd: ctx.targetRoot,
+      maxBuffer: 64 * 1024 * 1024
+    }
+  );
+  const resolutionMap = /* @__PURE__ */ new Map();
+  for (const line of whyOutput.toString("utf8").trim().split(/\r?\n/)) {
+    for (const { locator, descriptor } of Object.values(
+      JSON.parse(line).children
+    )) {
+      const existing = resolutionMap.get(descriptor);
+      if (existing) {
+        if (existing !== locator) {
+          throw new Error(
+            `Conflicting resolutions in target package for ${descriptor}: ${existing} vs ${locator}`
+          );
+        }
+      } else {
+        resolutionMap.set(descriptor, locator);
+      }
+    }
+  }
+  return resolutionMap;
+}
+async function buildTargetArchive(ctx) {
+  await exec.exec("yarn", ["build"], {
+    cwd: ctx.sourcePkg.dir
+  });
+  const archiveName = "target.tgz";
+  await exec.exec("yarn", ["pack", "--out", path.join(ctx.workDir, archiveName)], {
+    cwd: ctx.sourcePkg.dir
+  });
+  return archiveName;
+}
+async function downloadArchive(ctx, version) {
+  const nameWithoutScope = ctx.packageName.replace(/^@.+\//, "");
+  const tarName = `${nameWithoutScope}-${version}.tgz`;
+  if (await fs__default.default.pathExists(path.join(ctx.workDir, tarName))) {
+    return tarName;
+  }
+  try {
+    const url = `${ctx.registryUrl}/${ctx.packageName}/-/${tarName}`;
+    const res = await fetch(url);
+    if (!res.ok) {
+      throw new Error(
+        `Request to ${url} failed with status ${res.status} ${res.statusText}`
+      );
+    }
+    if (!res.body) {
+      throw new Error("Missing response body");
+    }
+    const write = fs__default.default.createWriteStream(path.join(ctx.workDir, tarName));
+    await promises.finished(stream.Readable.fromWeb(res.body).pipe(write));
+    return tarName;
+  } catch (error) {
+    throw new errors.ForwardedError(
+      `Failed to fetch tarball for ${ctx.packageName}@${version}`,
+      error
+    );
+  }
+}
+async function generatePatchForArchives(ctx, baseArchive, headArchive) {
+  const basePath = path.join(ctx.workDir, baseArchive);
+  const headPath = path.join(ctx.workDir, headArchive);
+  const patchDir = await fs__default.default.mkdtemp(path.join(ctx.workDir, "patch-"));
+  await tar__default.default.extract({ file: basePath, cwd: patchDir, strip: 1 });
+  await fs__default.default.writeFile(
+    path.join(patchDir, ".gitignore"),
+    PATCH_GITIGNORE.join(os__default.default.EOL)
+  );
+  await exec.exec("git", ["init"], {
+    cwd: patchDir,
+    env: { ...process.env, ...GIT_ENV }
+  });
+  await exec.exec("git", ["add", "."], {
+    cwd: patchDir,
+    env: { ...process.env, ...GIT_ENV }
+  });
+  for (const path$1 of await fs__default.default.readdir(patchDir)) {
+    if (path$1 !== ".git" && path$1 !== ".gitignore") {
+      await fs__default.default.rm(path.join(patchDir, path$1), {
+        recursive: true,
+        maxRetries: 3,
+        force: true
+      });
+    }
+  }
+  await tar__default.default.extract({ file: headPath, cwd: patchDir, strip: 1 });
+  const { stdout: patch } = await exec.exec(
+    "git",
+    [
+      "-c",
+      "core.safecrlf=false",
+      "diff",
+      "--src-prefix=a/",
+      "--dst-prefix=b/",
+      "--ignore-cr-at-eol",
+      "--full-index",
+      "--no-renames",
+      "--text"
+    ],
+    {
+      cwd: patchDir,
+      env: { ...process.env, ...GIT_ENV }
+    }
+  );
+  return patch.toString("utf8");
+}
+
+exports.default = generatePatch;
+//# sourceMappingURL=generate-patch.cjs.js.map

package/dist/commands/index.cjs.js

@@ -133,6 +133,28 @@ function registerCommands(program) {
       )
     )
   );
+  program.command("generate-patch <package>").requiredOption(
+    "--target <target-repo>",
+    "The target repository to generate patches for"
+  ).option(
+    "--registry-url <registry-url>",
+    "The registry to use for downloading artifacts (default: https://registry.npmjs.org)"
+  ).option(
+    "--base-version <version>",
+    "Override the base version to generate the patch towards instead"
+  ).option(
+    "--query <query>",
+    "Only apply the patch for a specific version query in the target repository"
+  ).option(
+    "--skip-install",
+    "Skip dependency installation in the target repository after applying the patch"
+  ).description(
+    "Generate a patch for the selected package in the target repository"
+  ).action(
+    lazy(
+      () => Promise.resolve().then(function () { return require('./generate-patch/generate-patch.cjs.js'); }).then((m) => m.default)
+    )
+  );
   program.command("knip-reports [paths...]").option("--ci", "CI run checks that there is no changes on knip reports").description("Generate a knip report for selected packages").action(
     lazy(
       () => Promise.resolve().then(function () { return require('./knip-reports/knip-reports.cjs.js'); }).then((m) => m.buildKnipReports)

package/dist/commands/package/schema/openapi/generate/client.cjs.js

@@ -41,7 +41,7 @@ async function generate(outputDirectory, clientAdditionalProperties, abortSignal
       "-c",
       backendPluginApi.resolvePackagePath(
         "@backstage/repo-tools",
-        "templates/typescript-backstage.yaml"
+        "templates/typescript-backstage-client.yaml"
       ),
       "--generator-key",
       "v3.0",
@@ -56,14 +56,18 @@ async function generate(outputDirectory, clientAdditionalProperties, abortSignal
       }
     }
   );
-  await exec.exec(
-    `yarn backstage-cli package lint --fix ${resolvedOutputDirectory}`,
-    [],
-    { signal: abortSignal?.signal }
+  const parentDirectory = path.resolve(resolvedOutputDirectory, "..");
+  await fs__default.default.writeFile(
+    path.resolve(parentDirectory, "index.ts"),
+    `// 
+    export * from './generated';`
   );
+  await exec.exec(`yarn backstage-cli package lint --fix ${parentDirectory}`, [], {
+    signal: abortSignal?.signal
+  });
   const prettier = paths.paths.resolveTargetRoot("node_modules/.bin/prettier");
   if (prettier) {
-    await exec.exec(`${prettier} --write ${resolvedOutputDirectory}`, [], {
+    await exec.exec(`${prettier} --write ${parentDirectory}`, [], {
       signal: abortSignal?.signal
     });
   }

package/dist/commands/package/schema/openapi/generate/server.cjs.js

@@ -1,25 +1,32 @@
 'use strict';
 
-var fs = require('fs-extra');
-var YAML = require('js-yaml');
 var chalk = require('chalk');
-var paths = require('../../../../../lib/paths.cjs.js');
+var path = require('path');
+var YAML = require('js-yaml');
 var constants = require('../../../../../lib/openapi/constants.cjs.js');
-var util = require('util');
-var child_process = require('child_process');
+var paths = require('../../../../../lib/paths.cjs.js');
+var fs = require('fs-extra');
+var exec = require('../../../../../lib/exec.cjs.js');
+var backendPluginApi = require('@backstage/backend-plugin-api');
 var helpers = require('../../../../../lib/openapi/helpers.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-var YAML__default = /*#__PURE__*/_interopDefaultCompat(YAML);
 var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
+var YAML__default = /*#__PURE__*/_interopDefaultCompat(YAML);
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
 
-const exec = util.promisify(child_process.exec);
-async function generate(abortSignal) {
+async function generateSpecFile() {
   const openapiPath = await helpers.getPathToCurrentOpenApiSpec();
   const yaml = YAML__default.default.load(await fs__default.default.readFile(openapiPath, "utf8"));
   const tsPath = paths.paths.resolveTarget(constants.TS_SCHEMA_PATH);
+  const schemaDir = path.dirname(tsPath);
+  await fs__default.default.mkdirp(schemaDir);
+  const oldTsPath = paths.paths.resolveTarget(constants.OLD_SCHEMA_PATH);
+  if (fs__default.default.existsSync(oldTsPath)) {
+    console.warn(`Removing old schema file at ${oldTsPath}`);
+    fs__default.default.removeSync(oldTsPath);
+  }
   await fs__default.default.writeFile(
     tsPath,
     `//
@@ -27,22 +34,82 @@ async function generate(abortSignal) {
 // ******************************************************************
 // * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
 // ******************************************************************
-import {createValidatedOpenApiRouter} from '@backstage/backend-openapi-utils';
+import {createValidatedOpenApiRouterFromGeneratedEndpointMap} from '@backstage/backend-openapi-utils';
+import {EndpointMap} from './';
 export const spec = ${JSON.stringify(yaml, null, 2)} as const;
 export const createOpenApiRouter = async (
-  options?: Parameters<typeof createValidatedOpenApiRouter>['1'],
-) => createValidatedOpenApiRouter<typeof spec>(spec, options);
+  options?: Parameters<typeof createValidatedOpenApiRouterFromGeneratedEndpointMap>['1'],
+) => createValidatedOpenApiRouterFromGeneratedEndpointMap<EndpointMap>(spec, options);
 `
   );
-  await exec(`yarn backstage-cli package lint --fix ${tsPath}`, {
-    signal: abortSignal?.signal
-  });
+  const indexFile = path.join(schemaDir, "..", "index.ts");
+  await fs__default.default.writeFile(
+    indexFile,
+    `// 
+    export * from './generated';`
+  );
+  await exec.exec(`yarn backstage-cli package lint`, ["--fix", tsPath, indexFile]);
   if (await paths.paths.resolveTargetRoot("node_modules/.bin/prettier")) {
-    await exec(`yarn prettier --write ${tsPath}`, {
-      cwd: paths.paths.targetRoot,
+    await exec.exec(`yarn prettier`, ["--write", tsPath, indexFile], {
+      cwd: paths.paths.targetRoot
+    });
+  }
+}
+async function generate(abortSignal) {
+  const resolvedOpenapiPath = await helpers.getPathToCurrentOpenApiSpec();
+  const resolvedOutputDirectory = await helpers.getRelativePathToFile(constants.OUTPUT_PATH);
+  await fs__default.default.mkdirp(resolvedOutputDirectory);
+  await fs__default.default.writeFile(
+    path.resolve(resolvedOutputDirectory, ".openapi-generator-ignore"),
+    constants.OPENAPI_IGNORE_FILES.join("\n")
+  );
+  await exec.exec(
+    "node",
+    [
+      backendPluginApi.resolvePackagePath("@openapitools/openapi-generator-cli", "main.js"),
+      "generate",
+      "-i",
+      resolvedOpenapiPath,
+      "-o",
+      resolvedOutputDirectory,
+      "-g",
+      "typescript",
+      "-c",
+      backendPluginApi.resolvePackagePath(
+        "@backstage/repo-tools",
+        "templates/typescript-backstage-server.yaml"
+      ),
+      "--generator-key",
+      "v3.0"
+    ],
+    {
+      maxBuffer: Number.MAX_VALUE,
+      cwd: backendPluginApi.resolvePackagePath("@backstage/repo-tools"),
+      env: {
+        ...process.env
+      },
+      signal: abortSignal?.signal
+    }
+  );
+  await exec.exec(
+    `yarn backstage-cli package lint --fix ${resolvedOutputDirectory}`,
+    [],
+    {
+      signal: abortSignal?.signal
+    }
+  );
+  const prettier = paths.paths.resolveTargetRoot("node_modules/.bin/prettier");
+  if (prettier) {
+    await exec.exec(`${prettier} --write ${resolvedOutputDirectory}`, [], {
       signal: abortSignal?.signal
     });
   }
+  fs__default.default.removeSync(path.resolve(resolvedOutputDirectory, ".openapi-generator-ignore"));
+  fs__default.default.rmSync(path.resolve(resolvedOutputDirectory, ".openapi-generator"), {
+    recursive: true,
+    force: true
+  });
+  await generateSpecFile();
 }
 async function command({
   abortSignal,

package/dist/commands/repo/schema/openapi/verify.cjs.js

@@ -22,11 +22,16 @@ async function verify(directoryPath) {
     return;
   }
   const yaml = await helpers.loadAndValidateOpenApiYaml(openapiPath);
-  const schemaPath = path.join(directoryPath, constants.TS_SCHEMA_PATH);
-  if (!await fs__default.default.pathExists(schemaPath)) {
+  let schemaPath = path.join(directoryPath, constants.TS_SCHEMA_PATH);
+  if (!await fs__default.default.pathExists(schemaPath) && !await fs__default.default.pathExists(path.join(directoryPath, constants.OLD_SCHEMA_PATH))) {
     throw new Error(`No \`${constants.TS_SCHEMA_PATH}\` file found.`);
+  } else if (await fs__default.default.pathExists(path.join(directoryPath, constants.OLD_SCHEMA_PATH))) {
+    console.warn(
+      `\`${constants.OLD_SCHEMA_PATH}\` is deprecated. Please re-run \`yarn backstage-repo-tools package schema openapi generate\` to update it.`
+    );
+    schemaPath = path.join(directoryPath, constants.OLD_SCHEMA_PATH);
   }
-  const schema = await import(path.resolve(path.join(directoryPath, constants.TS_MODULE)));
+  const schema = await import(path.resolve(schemaPath));
   if (!schema.spec) {
     throw new Error(`\`${constants.TS_SCHEMA_PATH}\` needs to have a 'spec' export.`);
   }

package/dist/lib/openapi/constants.cjs.js

@@ -1,9 +1,10 @@
 'use strict';
 
 const YAML_SCHEMA_PATH = "src/schema/openapi.yaml";
-const TS_MODULE = "src/schema/openapi.generated";
+const OUTPUT_PATH = "src/schema/openapi/generated";
+const TS_MODULE = `${OUTPUT_PATH}/router`;
+const OLD_SCHEMA_PATH = `src/schema/openapi.generated.ts`;
 const TS_SCHEMA_PATH = `${TS_MODULE}.ts`;
-const OUTPUT_PATH = "src/generated";
 const OPENAPI_IGNORE_FILES = [
   // Get rid of the default files.
   "*.md",
@@ -22,6 +23,7 @@ const OPENAPI_IGNORE_FILES = [
   // Override the created version.
   "apis/*.ts",
   "!apis/*.client.ts",
+  "!apis/*.server.ts",
   "models/*.ts",
   "!models/*.model.ts",
   // Always include index.ts files.
@@ -36,6 +38,7 @@ const OPENAPI_IGNORE_FILES = [
   "tsconfig.json"
 ];
 
+exports.OLD_SCHEMA_PATH = OLD_SCHEMA_PATH;
 exports.OPENAPI_IGNORE_FILES = OPENAPI_IGNORE_FILES;
 exports.OUTPUT_PATH = OUTPUT_PATH;
 exports.TS_MODULE = TS_MODULE;

package/dist/package.json.cjs.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/repo-tools",
-  "version": "0.11.0-next.0",
+  "version": "0.11.0-next.2",
   "description": "CLI for Backstage repo tooling ",
   "backstage": {
     "role": "cli"
@@ -43,11 +43,11 @@
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@apisyouwonthate/style-guide": "^1.4.0",
-    "@backstage/backend-plugin-api": "1.0.2-next.0",
+    "@backstage/backend-plugin-api": "1.0.2-next.2",
     "@backstage/catalog-model": "1.7.0",
-    "@backstage/cli-common": "0.1.14",
-    "@backstage/cli-node": "0.2.9",
-    "@backstage/config-loader": "1.9.1",
+    "@backstage/cli-common": "0.1.15-next.0",
+    "@backstage/cli-node": "0.2.10-next.0",
+    "@backstage/config-loader": "1.9.2-next.0",
     "@backstage/errors": "1.2.4",
     "@manypkg/get-packages": "^1.1.3",
     "@microsoft/api-documenter": "^7.25.7",
@@ -74,15 +74,16 @@
     "minimatch": "^9.0.0",
     "p-limit": "^3.0.2",
     "portfinder": "^1.0.32",
+    "tar": "^6.1.12",
     "ts-morph": "^23.0.0",
     "yaml-diff-patch": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.0.3-next.0",
-    "@backstage/cli": "0.29.0-next.0",
+    "@backstage/backend-test-utils": "1.1.0-next.2",
+    "@backstage/cli": "0.29.0-next.2",
     "@backstage/types": "1.1.1",
     "@types/is-glob": "^4.0.2",
-    "@types/node": "^18.17.8",
+    "@types/node": "^20.16.0",
     "@types/prettier": "^2.0.0"
   },
   "peerDependencies": {

package/templates/{typescript-backstage → typescript-backstage-client}/api.mustache

@@ -29,8 +29,43 @@ export interface RequestOptions {
   token?: string;
 }
 
+{{#operation}}
+/**
+  * @public
+  */
+export type {{#lambda.pascalcase}}{{nickname}}{{/lambda.pascalcase}} = {
+    {{#hasPathParams}}
+    path: {
+        {{#pathParams}}
+            {{paramName}}{{^required}}?{{/required}}: {{{dataType}}},
+        {{/pathParams}}
+    },
+    {{/hasPathParams}}
+    {{#hasBodyParam}}
+        {{#bodyParam}}
+        body: {{{dataType}}},
+        {{/bodyParam}}
+    {{/hasBodyParam}}
+    {{#hasQueryParams}}
+    query: {
+        {{#queryParams}}
+        {{paramName}}{{^required}}?{{/required}}: {{{dataType}}},
+        {{/queryParams}}
+    },
+    {{/hasQueryParams}}
+    {{#hasHeaderParams}}
+    header: {
+        {{#headerParams}}
+        {{paramName}}{{^required}}?{{/required}}: {{{dataType}}},
+        {{/headerParams}}
+    },
+    {{/hasHeaderParams}}
+}
+{{/operation}}
+
 /**
  * {{{description}}}{{^description}}no description{{/description}}
+ * @public
  */
 export class {{classname}}Client {
     private readonly discoveryApi: DiscoveryApi;
@@ -53,39 +88,12 @@ export class {{classname}}Client {
      * {{&summary}}
      {{/summary}}
      {{#allParams}}
-     * @param {{paramName}} {{description}}
+     * @param {{paramName}} - {{description}}
      {{/allParams}}
      */
     public async {{nickname}}(
         // @ts-ignore
-        request: {
-            {{#hasPathParams}}
-            path: {
-                {{#pathParams}}
-                    {{paramName}}{{^required}}?{{/required}}: {{{dataType}}},
-                {{/pathParams}}
-            },
-            {{/hasPathParams}}
-            {{#hasBodyParam}}
-                {{#bodyParam}}
-                body: {{{dataType}}},
-                {{/bodyParam}}
-            {{/hasBodyParam}}
-            {{#hasQueryParams}}
-            query: {
-                {{#queryParams}}
-                {{paramName}}{{^required}}?{{/required}}: {{{dataType}}},
-                {{/queryParams}}
-            },
-            {{/hasQueryParams}}
-            {{#hasHeaderParams}}
-            header: {
-                {{#headerParams}}
-                {{paramName}}{{^required}}?{{/required}}: {{{dataType}}},
-                {{/headerParams}}
-            },
-            {{/hasHeaderParams}}
-        },
+        request: {{#lambda.pascalcase}}{{nickname}}{{/lambda.pascalcase}},
         options?: RequestOptions
     ): Promise<TypedResponse<{{{returnType}}} {{^returnType}}void{{/returnType}}>> {
         const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);

package/templates/{typescript-backstage → typescript-backstage-client}/modelAlias.mustache

@@ -1,3 +1,6 @@
 {{! Sourced from https://github.com/OpenAPITools/openapi-generator/blob/7347daec61b2cb8d3d28e1ed06fe8b5e682090f8/modules/openapi-generator/src/main/resources/typescript-angular/modelAlias.mustache }}
 
+/**
+  * @public
+  */
 export type {{classname}} = {{dataType}};

package/templates/{typescript-backstage → typescript-backstage-client}/modelEnum.mustache

@@ -1,6 +1,9 @@
 {{! Sourced from https://github.com/OpenAPITools/openapi-generator/blob/7347daec61b2cb8d3d28e1ed06fe8b5e682090f8/modules/openapi-generator/src/main/resources/typescript-angular/modelEnum.mustache }}
 
 {{#stringEnums}}
+/**
+  * @public
+  */
 export enum {{classname}} {
 {{#allowableValues}}
 {{#enumVars}}
@@ -10,8 +13,14 @@ export enum {{classname}} {
 }
 {{/stringEnums}}
 {{^stringEnums}}
+/**
+  * @public
+  */
 export type {{classname}} = {{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}} | {{/-last}}{{/enumVars}}{{/allowableValues}};
 
+/**
+  * @public
+  */
 export const {{classname}} = {
 {{#allowableValues}}
 {{#enumVars}}

package/templates/{typescript-backstage → typescript-backstage-client}/modelGeneric.mustache

@@ -3,13 +3,14 @@
 {{#models}}
 {{#model}}
 
-{{#description}}
 /**
+{{#description}}
 * {{{.}}}
-*/
 {{/description}}
+* @public
+*/
 {{^isEnum}}
-export interface {{classname}} {
+export {{#isNullable}}type{{/isNullable}}{{^isNullable}}interface{{/isNullable}} {{classname}} {{#isNullable}}={{/isNullable}} {
 {{>modelGenericAdditionalProperties}}
 {{#vars}}
 {{#description}}
@@ -19,12 +20,15 @@ export interface {{classname}} {
 {{/description}}
     '{{name}}'{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{#isNullable}} | null{{/isNullable}};
 {{/vars}}
-}
+}{{#isNullable}} | null{{/isNullable}}
 
 {{#hasEnums}}
 
 {{#vars}}
 {{#isEnum}}
+/**
+  * @public
+  */
 export type {{classname}}{{enumName}} ={{#allowableValues}}{{#values}} "{{.}}" {{^-last}}|{{/-last}}{{/values}}{{/allowableValues}};
 {{/isEnum}}
 {{/vars}}
@@ -32,6 +36,9 @@ export type {{classname}}{{enumName}} ={{#allowableValues}}{{#values}} "{{.}}" {
 {{/hasEnums}}
 {{/isEnum}}
 {{#isEnum}}
+/**
+  * @public
+  */
 export type {{classname}} ={{#allowableValues}}{{#values}} "{{.}}" {{^-last}}|{{/-last}}{{/values}}{{/allowableValues}};
 {{/isEnum}}
 {{/model}}

package/templates/{typescript-backstage → typescript-backstage-client}/modelGenericEnums.mustache

@@ -3,11 +3,17 @@
 {{#hasEnums}}
 
 {{^stringEnums}}
+/**
+  * @public
+  */
 export namespace {{classname}} {
 {{/stringEnums}}
 {{#vars}}
     {{#isEnum}}
 {{#stringEnums}}
+/**
+  * @public
+  */
 export enum {{classname}}{{enumName}} {
 {{#allowableValues}}
 {{#enumVars}}
@@ -17,7 +23,14 @@ export enum {{classname}}{{enumName}} {
 };
 {{/stringEnums}}
 {{^stringEnums}}
+    /**
+    * @public
+    */
     export type {{enumName}} = {{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}} | {{/-last}}{{/enumVars}}{{/allowableValues}};
+
+    /**
+    * @public
+    */
     export const {{enumName}} = {
     {{#allowableValues}}
     {{#enumVars}}

package/templates/{typescript-backstage → typescript-backstage-client}/modelOneOf.mustache

@@ -8,9 +8,10 @@ import {
 } from './';
 
 {{/hasImports}}
-{{#description}}
     /**
+{{#description}}
     * {{{.}}}
-    */
 {{/description}}
+    * @public
+    */
 export type {{classname}} = {{#oneOf}}{{{.}}}{{^-last}} | {{/-last}}{{/oneOf}};

package/templates/typescript-backstage-client.yaml

@@ -0,0 +1,40 @@
+templateDir: templates/typescript-backstage-client
+
+files:
+  api.mustache:
+    templateType: API
+    # For some reason, they check for destinationFilename differences. We have to change the ending to override the file.
+    destinationFilename: .client.ts
+  model.mustache:
+    templateType: Model
+    destinationFilename: .model.ts
+  modelGeneric.mustache:
+    templateType: SupportingFiles
+  modelOneOf.mustache:
+    templateType: SupportingFiles
+  modelGenericAdditionalProperties.mustache:
+    templateType: SupportingFiles
+  modelGenericEnums.mustache:
+    templateType: SupportingFiles
+  modelAlias.mustache:
+    templateType: SupportingFiles
+  modelEnum.mustache:
+    templateType: SupportingFiles
+  modelTaggedUnion.mustache:
+    templateType: SupportingFiles
+  models/models_all.mustache:
+    templateType: SupportingFiles
+    destinationFilename: models/index.ts
+  types/fetch.ts:
+    destinationFilename: types/fetch.ts
+  types/discovery.ts:
+    destinationFilename: types/discovery.ts
+  apis/index.mustache:
+    templateType: SupportingFiles
+    destinationFilename: apis/index.ts
+  pluginId.mustache:
+    templateType: SupportingFiles
+    destinationFilename: pluginId.ts
+  index.mustache:
+    templateType: SupportingFiles
+    destinationFilename: index.ts

package/templates/typescript-backstage-server/api.mustache

@@ -0,0 +1,54 @@
+{{>licenseInfo}}
+{{#imports}}
+import { {{classname}} } from '{{filename}}.model{{importFileExtension}}';
+{{/imports}}
+
+{{#operations}}
+
+{{#operation}}
+/**
+  * @public
+  */
+export type {{#lambda.pascalcase}}{{nickname}}{{/lambda.pascalcase}} = {
+    {{#hasPathParams}}
+    path: {
+        {{#pathParams}}
+            {{paramName}}{{^required}}?{{/required}}: {{{dataType}}},
+        {{/pathParams}}
+    },
+    {{/hasPathParams}}
+    {{#hasBodyParam}}
+        {{#bodyParam}}
+        body: {{{dataType}}},
+        {{/bodyParam}}
+    {{/hasBodyParam}}
+    {{#hasQueryParams}}
+    query: {
+        {{#queryParams}}
+        {{paramName}}{{^required}}?{{/required}}: {{{dataType}}},
+        {{/queryParams}}
+    },
+    {{/hasQueryParams}}
+    {{#hasHeaderParams}}
+    header: {
+        {{#headerParams}}
+        {{paramName}}{{^required}}?{{/required}}: {{{dataType}}},
+        {{/headerParams}}
+    },
+    {{/hasHeaderParams}}
+    response: {{#responses}} {{{dataType}}}{{^dataType}}void{{/dataType}} {{^-last}} | {{/-last}} {{/responses}}
+}
+{{/operation}}
+
+/**
+ * {{{description}}}{{^description}}no description{{/description}}
+ */
+
+export type EndpointMap = {
+    {{#operation}}
+    
+    '#{{#lambda.lowercase}}{{httpMethod}}{{/lambda.lowercase}}|{{path}}': {{#lambda.pascalcase}}{{nickname}}{{/lambda.pascalcase}},
+    
+    {{/operation}}
+}
+{{/operations}}

package/templates/typescript-backstage-server/apis/index.mustache

@@ -0,0 +1,3 @@
+//
+
+export * from './DefaultApi.server';

package/templates/typescript-backstage-server/index.mustache

@@ -0,0 +1,4 @@
+// 
+
+export * from './apis';
+export * from './router';

package/templates/typescript-backstage-server/licenseInfo.mustache

@@ -0,0 +1,5 @@
+//
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************

package/templates/typescript-backstage-server/model.mustache

@@ -0,0 +1,11 @@
+{{! Sourced from https://github.com/OpenAPITools/openapi-generator/blob/7347daec61b2cb8d3d28e1ed06fe8b5e682090f8/modules/openapi-generator/src/main/resources/typescript-angular/model.mustache#L17. }}
+{{>licenseInfo}}
+{{#models}}
+{{#model}}
+{{#tsImports}}
+import { {{classname}} } from '{{filename}}.model';
+{{/tsImports}}
+
+{{#isEnum}}{{>modelEnum}}{{/isEnum}}{{^isEnum}}{{#isAlias}}{{>modelAlias}}{{/isAlias}}{{^isAlias}}{{#taggedUnions}}{{>modelTaggedUnion}}{{/taggedUnions}}{{^taggedUnions}}{{#oneOf}}{{#-first}}{{>modelOneOf}}{{/-first}}{{/oneOf}}{{^oneOf}}{{>modelGeneric}}{{/oneOf}}{{/taggedUnions}}{{/isAlias}}{{/isEnum}}
+{{/model}}
+{{/models}}

package/templates/typescript-backstage-server/modelAlias.mustache

@@ -0,0 +1,6 @@
+{{! Sourced from https://github.com/OpenAPITools/openapi-generator/blob/7347daec61b2cb8d3d28e1ed06fe8b5e682090f8/modules/openapi-generator/src/main/resources/typescript-angular/modelAlias.mustache }}
+
+/**
+  * @public
+  */
+export type {{classname}} = {{dataType}};

package/templates/typescript-backstage-server/modelEnum.mustache

@@ -0,0 +1,31 @@
+{{! Sourced from https://github.com/OpenAPITools/openapi-generator/blob/7347daec61b2cb8d3d28e1ed06fe8b5e682090f8/modules/openapi-generator/src/main/resources/typescript-angular/modelEnum.mustache }}
+
+{{#stringEnums}}
+/**
+  * @public
+  */
+export enum {{classname}} {
+{{#allowableValues}}
+{{#enumVars}}
+    {{name}} = {{{value}}}{{^-last}},{{/-last}}
+{{/enumVars}}
+{{/allowableValues}}
+}
+{{/stringEnums}}
+{{^stringEnums}}
+/**
+  * @public
+  */
+export type {{classname}} = {{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}} | {{/-last}}{{/enumVars}}{{/allowableValues}};
+
+/**
+  * @public
+  */
+export const {{classname}} = {
+{{#allowableValues}}
+{{#enumVars}}
+    {{name}}: {{{value}}} as {{classname}}{{^-last}},{{/-last}}
+{{/enumVars}}
+{{/allowableValues}}
+};
+{{/stringEnums}}

package/templates/typescript-backstage-server/modelGeneric.mustache

@@ -0,0 +1,45 @@
+{{! Sourced from https://github.com/OpenAPITools/openapi-generator/blob/7347daec61b2cb8d3d28e1ed06fe8b5e682090f8/modules/openapi-generator/src/main/resources/typescript-angular/modelGeneric.mustache }}
+
+{{#models}}
+{{#model}}
+
+/**
+{{#description}}
+* {{{.}}}
+{{/description}}
+* @public
+*/
+{{^isEnum}}
+export {{#isNullable}}type{{/isNullable}}{{^isNullable}}interface{{/isNullable}} {{classname}} {{#isNullable}}={{/isNullable}} {
+{{>modelGenericAdditionalProperties}}
+{{#vars}}
+{{#description}}
+    /**
+    * {{{.}}}
+    */
+{{/description}}
+    '{{name}}'{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{#isNullable}} | null{{/isNullable}};
+{{/vars}}
+}{{#isNullable}} | null{{/isNullable}}
+
+{{#hasEnums}}
+
+{{#vars}}
+{{#isEnum}}
+/**
+  * @public
+  */
+export type {{classname}}{{enumName}} ={{#allowableValues}}{{#values}} "{{.}}" {{^-last}}|{{/-last}}{{/values}}{{/allowableValues}};
+{{/isEnum}}
+{{/vars}}
+
+{{/hasEnums}}
+{{/isEnum}}
+{{#isEnum}}
+/**
+  * @public
+  */
+export type {{classname}} ={{#allowableValues}}{{#values}} "{{.}}" {{^-last}}|{{/-last}}{{/values}}{{/allowableValues}};
+{{/isEnum}}
+{{/model}}
+{{/models}}

package/templates/typescript-backstage-server/modelGenericAdditionalProperties.mustache

@@ -0,0 +1,5 @@
+{{! Sourced from https://github.com/OpenAPITools/openapi-generator/blob/7347daec61b2cb8d3d28e1ed06fe8b5e682090f8/modules/openapi-generator/src/main/resources/typescript-angular/modelGenericAdditionalProperties.mustache }}
+
+{{#additionalPropertiesType}}
+  [key: string]: {{{additionalPropertiesType}}};
+{{/additionalPropertiesType}}

package/templates/typescript-backstage-server/modelGenericEnums.mustache

@@ -0,0 +1,45 @@
+{{! Sourced from https://github.com/OpenAPITools/openapi-generator/blob/7347daec61b2cb8d3d28e1ed06fe8b5e682090f8/modules/openapi-generator/src/main/resources/typescript-angular/modelGenericEnums.mustache }}
+
+{{#hasEnums}}
+
+{{^stringEnums}}
+/**
+  * @public
+  */
+export namespace {{classname}} {
+{{/stringEnums}}
+{{#vars}}
+    {{#isEnum}}
+{{#stringEnums}}
+/**
+  * @public
+  */
+export enum {{classname}}{{enumName}} {
+{{#allowableValues}}
+{{#enumVars}}
+    {{name}} = {{{value}}}{{^-last}},{{/-last}}
+{{/enumVars}}
+{{/allowableValues}}
+};
+{{/stringEnums}}
+{{^stringEnums}}
+    /**
+    * @public
+    */
+    export type {{enumName}} = {{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}} | {{/-last}}{{/enumVars}}{{/allowableValues}};
+
+    /**
+    * @public
+    */
+    export const {{enumName}} = {
+    {{#allowableValues}}
+    {{#enumVars}}
+        {{name}}: {{{value}}} as {{enumName}}{{^-last}},{{/-last}}
+    {{/enumVars}}
+    {{/allowableValues}}
+    };
+{{/stringEnums}}
+    {{/isEnum}}
+{{/vars}}
+{{^stringEnums}}}{{/stringEnums}}
+{{/hasEnums}}

package/templates/typescript-backstage-server/modelOneOf.mustache

@@ -0,0 +1,17 @@
+{{! Sourced from https://github.com/OpenAPITools/openapi-generator/blob/7347daec61b2cb8d3d28e1ed06fe8b5e682090f8/modules/openapi-generator/src/main/resources/typescript-angular/modelOneOf.mustache }}
+
+{{#hasImports}}
+import {
+    {{#imports}}
+    {{{.}}},
+    {{/imports}}
+} from './';
+
+{{/hasImports}}
+    /**
+{{#description}}
+    * {{{.}}}
+{{/description}}
+    * @public
+    */
+export type {{classname}} = {{#oneOf}}{{{.}}}{{^-last}} | {{/-last}}{{/oneOf}};

package/templates/typescript-backstage-server/modelTaggedUnion.mustache

@@ -0,0 +1,23 @@
+{{! Sourced from https://github.com/OpenAPITools/openapi-generator/blob/7347daec61b2cb8d3d28e1ed06fe8b5e682090f8/modules/openapi-generator/src/main/resources/typescript-angular/modelTaggedUnion.mustache }}
+
+{{#discriminator}}
+export type {{classname}} = {{#children}}{{^-first}} | {{/-first}}{{classname}}{{/children}};
+{{/discriminator}}
+{{^discriminator}}
+{{#parent}}
+export interface {{classname}} { {{>modelGenericAdditionalProperties}}
+{{#allVars}}
+    {{#description}}
+    /**
+    * {{{.}}}
+    */
+    {{/description}}
+    {{name}}{{^required}}?{{/required}}: {{#discriminatorValue}}'{{.}}'{{/discriminatorValue}}{{^discriminatorValue}}{{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{/discriminatorValue}}{{#isNullable}} | null{{/isNullable}};
+{{/allVars}}
+}
+{{>modelGenericEnums}}
+{{/parent}}
+{{^parent}}
+{{>modelGeneric}}
+{{/parent}}
+{{/discriminator}}

package/templates/typescript-backstage-server/models/models_all.mustache

@@ -0,0 +1,7 @@
+//
+
+{{#models}}
+{{#model}}
+export * from '{{{ importPath }}}.model{{importFileExtension}}'
+{{/model}}
+{{/models}}

package/templates/{typescript-backstage.yaml → typescript-backstage-server.yaml}

@@ -1,10 +1,16 @@
-templateDir: templates/typescript-backstage
+templateDir: templates/typescript-backstage-server
 
 files:
   api.mustache:
     templateType: API
     # For some reason, they check for destinationFilename differences. We have to change the ending to override the file.
-    destinationFilename: .client.ts
+    destinationFilename: .server.ts
+  apis/index.mustache:
+    templateType: SupportingFiles
+    destinationFilename: apis/index.ts
+  index.mustache:
+    templateType: SupportingFiles
+    destinationFilename: index.ts
   model.mustache:
     templateType: Model
     destinationFilename: .model.ts
@@ -24,12 +30,4 @@ files:
     templateType: SupportingFiles
   models/models_all.mustache:
     templateType: SupportingFiles
-    destinationFilename: models/index.ts
-  types/fetch.ts: {}
-  types/discovery.ts: {}
-  apis/index.mustache:
-    templateType: SupportingFiles
-    destinationFilename: apis/index.ts
-  pluginId.mustache:
-    templateType: SupportingFiles
-    destinationFilename: pluginId.ts
+    destinationFilename: models/index.ts