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

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @backstage/repo-tools
 
+## 0.12.0-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.1.0-next.2
+  - @backstage/errors@1.2.6-next.0
+  - @backstage/cli-node@0.2.11-next.1
+  - @backstage/config-loader@1.9.3-next.1
+  - @backstage/catalog-model@1.7.2-next.0
+  - @backstage/cli-common@0.1.15
+
+## 0.12.0-next.1
+
+### Patch Changes
+
+- 860e3b5: Generated OpenAPI clients now support paths with tags.
+- 00058d0: The `generate-patch` command will now add a single resolution entry for all versions of the patched package, rather than separate entries for each version query.
+- Updated dependencies
+  - @backstage/config-loader@1.9.3-next.0
+  - @backstage/backend-plugin-api@1.1.0-next.1
+  - @backstage/catalog-model@1.7.1
+  - @backstage/cli-common@0.1.15
+  - @backstage/cli-node@0.2.11-next.0
+  - @backstage/errors@1.2.5
+
 ## 0.12.0-next.0
 
 ### Minor Changes

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

@@ -121,7 +121,6 @@ async function loadTrimmedRootPkg(ctx, query) {
       );
     };
   }
-  const resolutionMap = await readResolutionMap(ctx);
   const entriesToRemove = Object.entries(resolutionsObj).filter(
     ([key]) => key.startsWith(`${ctx.packageName}@`)
   );
@@ -134,24 +133,8 @@ async function loadTrimmedRootPkg(ctx, query) {
       });
     }
   }
-  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) => {
-    if (descriptors.length > 0) {
-      for (const descriptor of descriptors) {
-        resolutionsObj[descriptor] = patchEntry;
-      }
-    } else {
-      resolutionsObj[ctx.packageName] = patchEntry;
-    }
+    resolutionsObj[ctx.packageName] = patchEntry;
     await fs__default.default.writeJson(
       path.resolve(ctx.targetRoot, "package.json"),
       newPkgJson,
@@ -208,34 +191,6 @@ function tryParsePatchResolution(value) {
   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

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

@@ -20,9 +20,10 @@ async function generate(outputDirectory, clientAdditionalProperties, abortSignal
     outputDirectory,
     constants.OUTPUT_PATH
   );
-  const additionalProperties = clientAdditionalProperties ? `--additional-properties=${clientAdditionalProperties}` : "";
-  fs.mkdirpSync(resolvedOutputDirectory);
-  await fs__default.default.mkdirp(resolvedOutputDirectory);
+  const additionalProperties = helpers.toGeneratorAdditionalProperties({
+    initialValue: clientAdditionalProperties
+  });
+  await fs__default.default.emptyDir(resolvedOutputDirectory);
   await fs__default.default.writeFile(
     path.resolve(resolvedOutputDirectory, ".openapi-generator-ignore"),
     constants.OPENAPI_IGNORE_FILES.join("\n")
@@ -45,7 +46,7 @@ async function generate(outputDirectory, clientAdditionalProperties, abortSignal
       ),
       "--generator-key",
       "v3.0",
-      additionalProperties
+      additionalProperties ? `--additional-properties=${additionalProperties}` : ""
     ],
     {
       signal: abortSignal?.signal,

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

@@ -58,7 +58,7 @@ export const createOpenApiRouter = async (
 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.emptyDir(resolvedOutputDirectory);
   await fs__default.default.writeFile(
     path.resolve(resolvedOutputDirectory, ".openapi-generator-ignore"),
     constants.OPENAPI_IGNORE_FILES.join("\n")

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

@@ -37,6 +37,20 @@ async function loadAndValidateOpenApiYaml(path) {
   await Parser__default.default.validate(lodash.cloneDeep(yaml));
   return yaml;
 }
+function toGeneratorAdditionalProperties({
+  initialValue,
+  defaultValue
+}) {
+  const items = initialValue?.split(",") ?? [];
+  const parsed = items.reduce(
+    (acc, item) => {
+      const [key, value] = item.split("=");
+      return { ...acc, [key]: value };
+    },
+    { ...defaultValue }
+  );
+  return Object.entries(parsed).map(([key, value]) => `${key}=${value}`).join(",");
+}
 
 exports.assertExists = assertExists;
 exports.getPathToCurrentOpenApiSpec = getPathToCurrentOpenApiSpec;
@@ -44,4 +58,5 @@ exports.getPathToFile = getPathToFile;
 exports.getPathToOpenApiSpec = getPathToOpenApiSpec;
 exports.getRelativePathToFile = getRelativePathToFile;
 exports.loadAndValidateOpenApiYaml = loadAndValidateOpenApiYaml;
+exports.toGeneratorAdditionalProperties = toGeneratorAdditionalProperties;
 //# sourceMappingURL=helpers.cjs.js.map

package/dist/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.12.0-next.0";
+var version = "0.12.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.12.0-next.0",
+  "version": "0.12.0-next.2",
   "description": "CLI for Backstage repo tooling ",
   "backstage": {
     "role": "cli"
@@ -43,12 +43,12 @@
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@apisyouwonthate/style-guide": "^1.4.0",
-    "@backstage/backend-plugin-api": "1.0.3-next.0",
-    "@backstage/catalog-model": "1.7.1",
+    "@backstage/backend-plugin-api": "1.1.0-next.2",
+    "@backstage/catalog-model": "1.7.2-next.0",
     "@backstage/cli-common": "0.1.15",
-    "@backstage/cli-node": "0.2.11-next.0",
-    "@backstage/config-loader": "1.9.2",
-    "@backstage/errors": "1.2.5",
+    "@backstage/cli-node": "0.2.11-next.1",
+    "@backstage/config-loader": "1.9.3-next.1",
+    "@backstage/errors": "1.2.6-next.0",
     "@manypkg/get-packages": "^1.1.3",
     "@microsoft/api-documenter": "^7.25.7",
     "@microsoft/api-extractor": "^7.47.2",
@@ -79,8 +79,8 @@
     "yaml-diff-patch": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.2.0-next.0",
-    "@backstage/cli": "0.29.3-next.0",
+    "@backstage/backend-test-utils": "1.2.0-next.2",
+    "@backstage/cli": "0.29.3-next.2",
     "@backstage/types": "1.2.0",
     "@types/is-glob": "^4.0.2",
     "@types/node": "^20.16.0",

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

@@ -4,10 +4,12 @@ import { FetchApi } from '../types/fetch';
 import crossFetch from 'cross-fetch';
 import {pluginId} from '../pluginId';
 import * as parser from 'uri-template';
-
+{{#apiInfo}}
+{{#apis}}
 {{#imports}}
 import { {{classname}} } from '{{filename}}.model{{importFileExtension}}';
 {{/imports}}
+{{/apis}}
 
 /**
  * Wraps the Response type to convey a type on the json call.
@@ -18,8 +20,6 @@ export type TypedResponse<T> = Omit<Response, 'json'> & {
   json: () => Promise<T>;
 };
 
-{{#operations}}
-
 /**
  * Options you can pass into a request for additional information.
  *
@@ -28,7 +28,8 @@ export type TypedResponse<T> = Omit<Response, 'json'> & {
 export interface RequestOptions {
   token?: string;
 }
-
+{{#apis}}
+{{#operations}}
 {{#operation}}
 /**
   * @public
@@ -62,12 +63,13 @@ export type {{#lambda.pascalcase}}{{nickname}}{{/lambda.pascalcase}} = {
     {{/hasHeaderParams}}
 }
 {{/operation}}
+{{/operations}}
+{{/apis}}
 
 /**
- * {{{description}}}{{^description}}no description{{/description}}
  * @public
  */
-export class {{classname}}Client {
+export class DefaultApiClient {
     private readonly discoveryApi: DiscoveryApi;
     private readonly fetchApi: FetchApi;
 
@@ -79,6 +81,9 @@ export class {{classname}}Client {
         this.fetchApi = options.fetchApi || { fetch: crossFetch };
     }
 
+    {{#apis}}
+    {{#operations}}
+
     {{#operation}}
     /**
      {{#notes}}
@@ -123,5 +128,7 @@ export class {{classname}}Client {
     }
 
     {{/operation}}
+    {{/operations}}
+    {{/apis}}
 }
-{{/operations}}
+{{/apiInfo}}

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

@@ -1,3 +1,3 @@
 //
 
-export * from './DefaultApi.client';
+export * from './Api.client';

package/templates/typescript-backstage-client.yaml

@@ -1,10 +1,6 @@
 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
@@ -32,6 +28,9 @@ files:
   apis/index.mustache:
     templateType: SupportingFiles
     destinationFilename: apis/index.ts
+  apis/api-all.mustache:
+    templateType: SupportingFiles
+    destinationFilename: apis/Api.client.ts
   pluginId.mustache:
     templateType: SupportingFiles
     destinationFilename: pluginId.ts

package/templates/typescript-backstage-server/{api.mustache → apis/api-all.mustache}

@@ -1,4 +1,7 @@
+//
 {{>licenseInfo}}
+{{#apiInfo}}
+{{#apis}}
 {{#imports}}
 import { {{classname}} } from '{{filename}}.model{{importFileExtension}}';
 {{/imports}}
@@ -39,16 +42,19 @@ export type {{#lambda.pascalcase}}{{nickname}}{{/lambda.pascalcase}} = {
     response: {{#responses}} {{{dataType}}}{{^dataType}}void{{/dataType}} {{^-last}} | {{/-last}} {{/responses}}
 }
 {{/operation}}
-
-/**
- * {{{description}}}{{^description}}no description{{/description}}
- */
+{{/operations}}
+{{/apis}}
 
 export type EndpointMap = {
+    {{#apis}}
+    {{#operations}}
     {{#operation}}
     
     '#{{#lambda.lowercase}}{{httpMethod}}{{/lambda.lowercase}}|{{path}}': {{#lambda.pascalcase}}{{nickname}}{{/lambda.pascalcase}},
     
     {{/operation}}
+    {{/operations}}
+    {{/apis}}
 }
-{{/operations}}
+
+{{/apiInfo}}

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

@@ -1,3 +1,4 @@
 //
+{{>licenseInfo}}
 
-export * from './DefaultApi.server';
+export * from './Api.server'

package/templates/typescript-backstage-server.yaml

@@ -1,13 +1,12 @@
 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: .server.ts
   apis/index.mustache:
     templateType: SupportingFiles
     destinationFilename: apis/index.ts
+  apis/api-all.mustache:
+    templateType: SupportingFiles
+    destinationFilename: apis/Api.server.ts
   index.mustache:
     templateType: SupportingFiles
     destinationFilename: index.ts