@backstage/plugin-catalog-backend-module-openapi 0.1.26-next.2 → 0.1.27-next.0

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # @backstage/plugin-catalog-backend-module-openapi
 
+## 0.1.27-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.21.0-next.0
+  - @backstage/plugin-catalog-backend@1.17.0-next.0
+  - @backstage/plugin-catalog-node@1.6.2-next.0
+  - @backstage/backend-plugin-api@0.6.10-next.0
+  - @backstage/catalog-model@1.4.3
+  - @backstage/config@1.1.1
+  - @backstage/integration@1.8.0
+  - @backstage/types@1.1.1
+  - @backstage/plugin-catalog-common@1.0.20
+
+## 0.1.26
+
+### Patch Changes
+
+- 4ebf99b: Add support for the new backend system.
+
+  A new backend module for the catalog backend
+  was added and exported as `default`.
+
+  You can use it with the new backend system like
+
+  ```ts title="packages/backend/src/index.ts"
+  backend.add(import('@backstage/plugin-catalog-backend-module-openapi'));
+  ```
+
+- Updated dependencies
+  - @backstage/backend-common@0.20.1
+  - @backstage/backend-plugin-api@0.6.9
+  - @backstage/plugin-catalog-node@1.6.1
+  - @backstage/plugin-catalog-backend@1.16.1
+  - @backstage/catalog-model@1.4.3
+  - @backstage/config@1.1.1
+  - @backstage/integration@1.8.0
+  - @backstage/types@1.1.1
+  - @backstage/plugin-catalog-common@1.0.20
+
 ## 0.1.26-next.2
 
 ### Patch Changes

package/README.md

@@ -17,6 +17,33 @@ yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-openapi
 
 ### Adding the plugin to your `packages/backend`
 
+```ts title="packages/backend/src/index.ts"
+backend.add(import('@backstage/plugin-catalog-backend-module-openapi'));
+```
+
+This will add the `jsonSchemaRefPlaceholderResolver` for
+the placeholder resolver keys `asyncapi` and `openapi`.
+
+This allows you to use the `$openapi` placeholder when referencing your OpenAPI specification and `$asyncapi` when referencing your AsyncAPI specifications. This will then resolve all `$ref` instances in your specification.
+
+You can also use this resolver for other kind of yaml files to resolve $ref pointer.
+
+```yaml
+apiVersion: backstage.io/v1alpha1
+kind: API
+metadata:
+  name: example
+  description: Example API
+spec:
+  type: openapi
+  lifecycle: production
+  owner: team
+  definition:
+    $openapi: ./spec/openapi.yaml # by using $openapi Backstage will now resolve all $ref instances
+```
+
+### Adding the plugin to your `packages/backend` (old backend system)
+
 #### **jsonSchemaRefPlaceholderResolver**
 
 The placeholder resolver can be added by importing `jsonSchemaRefPlaceholderResolver` in `src/plugins/catalog.ts` in your `backend` package and adding the following.

package/dist/index.cjs.js

@@ -7,6 +7,8 @@ var $RefParser = require('@apidevtools/json-schema-ref-parser');
 var yaml = require('yaml');
 var path = require('path');
 var integration = require('@backstage/integration');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha = require('@backstage/plugin-catalog-node/alpha');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -179,9 +181,32 @@ class OpenApiRefProcessor {
   }
 }
 
+const catalogModuleJsonSchemaRefPlaceholderResolver = backendPluginApi.createBackendModule({
+  pluginId: "catalog",
+  moduleId: "json-schema-ref-placeholder-resolver",
+  register(env) {
+    env.registerInit({
+      deps: {
+        catalog: alpha.catalogProcessingExtensionPoint
+      },
+      async init({ catalog }) {
+        catalog.addPlaceholderResolver(
+          "asyncapi",
+          jsonSchemaRefPlaceholderResolver
+        );
+        catalog.addPlaceholderResolver(
+          "openapi",
+          jsonSchemaRefPlaceholderResolver
+        );
+      }
+    });
+  }
+});
+
 const openApiPlaceholderResolver = jsonSchemaRefPlaceholderResolver;
 
 exports.OpenApiRefProcessor = OpenApiRefProcessor;
+exports["default"] = catalogModuleJsonSchemaRefPlaceholderResolver;
 exports.jsonSchemaRefPlaceholderResolver = jsonSchemaRefPlaceholderResolver;
 exports.openApiPlaceholderResolver = openApiPlaceholderResolver;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/lib/bundle.ts","../src/jsonSchemaRefPlaceholderResolver.ts","../src/OpenApiRefProcessor.ts","../src/index.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport $RefParser from '@apidevtools/json-schema-ref-parser';\nimport { parse, stringify } from 'yaml';\nimport * as path from 'path';\n\nconst protocolPattern = /^(\\w{2,}):\\/\\//i;\nconst getProtocol = (refPath: string) => {\n  const match = protocolPattern.exec(refPath);\n  if (match) {\n    return match[1].toLowerCase();\n  }\n  return undefined;\n};\n\nexport type BundlerRead = (url: string) => Promise<Buffer>;\n\nexport type BundlerResolveUrl = (url: string, base: string) => string;\n\nexport async function bundleFileWithRefs(\n  fileWithRefs: string,\n  baseUrl: string,\n  read: BundlerRead,\n  resolveUrl: BundlerResolveUrl,\n): Promise<string> {\n  const fileUrlReaderResolver: $RefParser.ResolverOptions = {\n    canRead: file => {\n      const protocol = getProtocol(file.url);\n      return protocol === undefined || protocol === 'file';\n    },\n    read: async file => {\n      const relativePath = path.relative('.', file.url);\n      const url = resolveUrl(relativePath, baseUrl);\n      return await read(url);\n    },\n  };\n  const httpUrlReaderResolver: $RefParser.ResolverOptions = {\n    canRead: ref => {\n      const protocol = getProtocol(ref.url);\n      return protocol === 'http' || protocol === 'https';\n    },\n    read: async ref => {\n      const url = resolveUrl(ref.url, baseUrl);\n      return await read(url);\n    },\n  };\n\n  const options: $RefParser.Options = {\n    resolve: {\n      file: fileUrlReaderResolver,\n      http: httpUrlReaderResolver,\n    },\n  };\n  const fileObject = parse(fileWithRefs);\n  const bundledObject = await $RefParser.bundle(baseUrl, fileObject, options);\n  return stringify(bundledObject);\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { PlaceholderResolverParams } from '@backstage/plugin-catalog-backend';\nimport { JsonValue } from '@backstage/types';\nimport { processingResult } from '@backstage/plugin-catalog-node';\nimport { bundleFileWithRefs } from './lib';\n\n/** @public */\nexport async function jsonSchemaRefPlaceholderResolver(\n  params: PlaceholderResolverParams,\n): Promise<JsonValue> {\n  const { content, url } = await readTextLocation(params);\n\n  params.emit(processingResult.refresh(`url:${url}`));\n\n  try {\n    return await bundleFileWithRefs(\n      content,\n      url,\n      params.read,\n      params.resolveUrl,\n    );\n  } catch (error) {\n    throw new Error(\n      `Placeholder \\$${params.key} unable to bundle the file at ${params.value}, ${error}`,\n    );\n  }\n}\n\n/*\n * Helpers, copied from PlaceholderProcessor\n */\n\nasync function readTextLocation(\n  params: PlaceholderResolverParams,\n): Promise<{ content: string; url: string }> {\n  const newUrl = relativeUrl(params);\n\n  try {\n    const data = await params.read(newUrl);\n    return { content: data.toString('utf-8'), url: newUrl };\n  } catch (e) {\n    throw new Error(\n      `Placeholder \\$${params.key} could not read location ${params.value}, ${e}`,\n    );\n  }\n}\n\nfunction relativeUrl({\n  key,\n  value,\n  baseUrl,\n  resolveUrl,\n}: PlaceholderResolverParams): string {\n  if (typeof value !== 'string') {\n    throw new Error(\n      `Placeholder \\$${key} expected a string value parameter, in the form of an absolute URL or a relative path`,\n    );\n  }\n\n  try {\n    return resolveUrl(value, baseUrl);\n  } catch (e) {\n    // The only remaining case that isn't support is a relative file path that should be\n    // resolved using a relative file location. Accessing local file paths can lead to\n    // path traversal attacks and access to any file on the host system. Implementing this\n    // would require additional security measures.\n    throw new Error(\n      `Placeholder \\$${key} could not form a URL out of ${baseUrl} and ${value}, ${e}`,\n    );\n  }\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { UrlReader } from '@backstage/backend-common';\nimport { Entity } from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { ScmIntegrations } from '@backstage/integration';\nimport { CatalogProcessor } from '@backstage/plugin-catalog-node';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport { bundleFileWithRefs } from './lib';\nimport { Logger } from 'winston';\n\n/**\n * @public\n * @deprecated replaced by the openApiPlaceholderResolver\n */\nexport class OpenApiRefProcessor implements CatalogProcessor {\n  private readonly integrations: ScmIntegrations;\n  private readonly logger: Logger;\n  private readonly reader: UrlReader;\n\n  static fromConfig(\n    config: Config,\n    options: { logger: Logger; reader: UrlReader },\n  ) {\n    const integrations = ScmIntegrations.fromConfig(config);\n\n    return new OpenApiRefProcessor({\n      ...options,\n      integrations,\n    });\n  }\n\n  constructor(options: {\n    integrations: ScmIntegrations;\n    logger: Logger;\n    reader: UrlReader;\n  }) {\n    this.integrations = options.integrations;\n    this.logger = options.logger;\n    this.reader = options.reader;\n  }\n\n  getProcessorName(): string {\n    return 'OpenApiRefProcessor';\n  }\n\n  async preProcessEntity(\n    entity: Entity,\n    location: LocationSpec,\n  ): Promise<Entity> {\n    if (\n      !entity ||\n      entity.kind !== 'API' ||\n      (entity.spec && entity.spec.type !== 'openapi')\n    ) {\n      return entity;\n    }\n\n    const scmIntegration = this.integrations.byUrl(location.target);\n    const definition = entity.spec!.definition;\n\n    if (!scmIntegration || !definition) {\n      return entity;\n    }\n\n    const resolveUrl = (url: string, base: string): string => {\n      return scmIntegration.resolveUrl({ url, base });\n    };\n\n    this.logger.debug(`Bundling OpenAPI specification from ${location.target}`);\n    try {\n      const read = async (url: string) => {\n        const { buffer } = await this.reader.readUrl(url);\n        return await buffer();\n      };\n      const bundledSpec = await bundleFileWithRefs(\n        definition.toString(),\n        location.target,\n        read,\n        resolveUrl,\n      );\n\n      return {\n        ...entity,\n        spec: { ...entity.spec, definition: bundledSpec },\n      };\n    } catch (error) {\n      this.logger.error(`Unable to bundle OpenAPI specification`, error);\n      return entity;\n    }\n  }\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { jsonSchemaRefPlaceholderResolver } from './jsonSchemaRefPlaceholderResolver';\n\nexport { OpenApiRefProcessor } from './OpenApiRefProcessor';\nexport { jsonSchemaRefPlaceholderResolver } from './jsonSchemaRefPlaceholderResolver';\n/**\n * @public\n * @deprecated replaced by jsonSchemaRefPlaceholderResolver\n */\nexport const openApiPlaceholderResolver = jsonSchemaRefPlaceholderResolver;\n"],"names":["path","parse","$RefParser","stringify","processingResult","ScmIntegrations"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmBA,MAAM,eAAkB,GAAA,iBAAA,CAAA;AACxB,MAAM,WAAA,GAAc,CAAC,OAAoB,KAAA;AACvC,EAAM,MAAA,KAAA,GAAQ,eAAgB,CAAA,IAAA,CAAK,OAAO,CAAA,CAAA;AAC1C,EAAA,IAAI,KAAO,EAAA;AACT,IAAO,OAAA,KAAA,CAAM,CAAC,CAAA,CAAE,WAAY,EAAA,CAAA;AAAA,GAC9B;AACA,EAAO,OAAA,KAAA,CAAA,CAAA;AACT,CAAA,CAAA;AAMA,eAAsB,kBACpB,CAAA,YAAA,EACA,OACA,EAAA,IAAA,EACA,UACiB,EAAA;AACjB,EAAA,MAAM,qBAAoD,GAAA;AAAA,IACxD,SAAS,CAAQ,IAAA,KAAA;AACf,MAAM,MAAA,QAAA,GAAW,WAAY,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AACrC,MAAO,OAAA,QAAA,KAAa,UAAa,QAAa,KAAA,MAAA,CAAA;AAAA,KAChD;AAAA,IACA,IAAA,EAAM,OAAM,IAAQ,KAAA;AAClB,MAAA,MAAM,YAAe,GAAAA,eAAA,CAAK,QAAS,CAAA,GAAA,EAAK,KAAK,GAAG,CAAA,CAAA;AAChD,MAAM,MAAA,GAAA,GAAM,UAAW,CAAA,YAAA,EAAc,OAAO,CAAA,CAAA;AAC5C,MAAO,OAAA,MAAM,KAAK,GAAG,CAAA,CAAA;AAAA,KACvB;AAAA,GACF,CAAA;AACA,EAAA,MAAM,qBAAoD,GAAA;AAAA,IACxD,SAAS,CAAO,GAAA,KAAA;AACd,MAAM,MAAA,QAAA,GAAW,WAAY,CAAA,GAAA,CAAI,GAAG,CAAA,CAAA;AACpC,MAAO,OAAA,QAAA,KAAa,UAAU,QAAa,KAAA,OAAA,CAAA;AAAA,KAC7C;AAAA,IACA,IAAA,EAAM,OAAM,GAAO,KAAA;AACjB,MAAA,MAAM,GAAM,GAAA,UAAA,CAAW,GAAI,CAAA,GAAA,EAAK,OAAO,CAAA,CAAA;AACvC,MAAO,OAAA,MAAM,KAAK,GAAG,CAAA,CAAA;AAAA,KACvB;AAAA,GACF,CAAA;AAEA,EAAA,MAAM,OAA8B,GAAA;AAAA,IAClC,OAAS,EAAA;AAAA,MACP,IAAM,EAAA,qBAAA;AAAA,MACN,IAAM,EAAA,qBAAA;AAAA,KACR;AAAA,GACF,CAAA;AACA,EAAM,MAAA,UAAA,GAAaC,WAAM,YAAY,CAAA,CAAA;AACrC,EAAA,MAAM,gBAAgB,MAAMC,8BAAA,CAAW,MAAO,CAAA,OAAA,EAAS,YAAY,OAAO,CAAA,CAAA;AAC1E,EAAA,OAAOC,eAAU,aAAa,CAAA,CAAA;AAChC;;AChDA,eAAsB,iCACpB,MACoB,EAAA;AACpB,EAAA,MAAM,EAAE,OAAS,EAAA,GAAA,EAAQ,GAAA,MAAM,iBAAiB,MAAM,CAAA,CAAA;AAEtD,EAAA,MAAA,CAAO,KAAKC,kCAAiB,CAAA,OAAA,CAAQ,CAAO,IAAA,EAAA,GAAG,EAAE,CAAC,CAAA,CAAA;AAElD,EAAI,IAAA;AACF,IAAA,OAAO,MAAM,kBAAA;AAAA,MACX,OAAA;AAAA,MACA,GAAA;AAAA,MACA,MAAO,CAAA,IAAA;AAAA,MACP,MAAO,CAAA,UAAA;AAAA,KACT,CAAA;AAAA,WACO,KAAO,EAAA;AACd,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,gBAAiB,MAAO,CAAA,GAAG,iCAAiC,MAAO,CAAA,KAAK,KAAK,KAAK,CAAA,CAAA;AAAA,KACpF,CAAA;AAAA,GACF;AACF,CAAA;AAMA,eAAe,iBACb,MAC2C,EAAA;AAC3C,EAAM,MAAA,MAAA,GAAS,YAAY,MAAM,CAAA,CAAA;AAEjC,EAAI,IAAA;AACF,IAAA,MAAM,IAAO,GAAA,MAAM,MAAO,CAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AACrC,IAAA,OAAO,EAAE,OAAS,EAAA,IAAA,CAAK,SAAS,OAAO,CAAA,EAAG,KAAK,MAAO,EAAA,CAAA;AAAA,WAC/C,CAAG,EAAA;AACV,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,gBAAiB,MAAO,CAAA,GAAG,4BAA4B,MAAO,CAAA,KAAK,KAAK,CAAC,CAAA,CAAA;AAAA,KAC3E,CAAA;AAAA,GACF;AACF,CAAA;AAEA,SAAS,WAAY,CAAA;AAAA,EACnB,GAAA;AAAA,EACA,KAAA;AAAA,EACA,OAAA;AAAA,EACA,UAAA;AACF,CAAsC,EAAA;AACpC,EAAI,IAAA,OAAO,UAAU,QAAU,EAAA;AAC7B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,gBAAiB,GAAG,CAAA,qFAAA,CAAA;AAAA,KACtB,CAAA;AAAA,GACF;AAEA,EAAI,IAAA;AACF,IAAO,OAAA,UAAA,CAAW,OAAO,OAAO,CAAA,CAAA;AAAA,WACzB,CAAG,EAAA;AAKV,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,gBAAiB,GAAG,CAAA,6BAAA,EAAgC,OAAO,CAAQ,KAAA,EAAA,KAAK,KAAK,CAAC,CAAA,CAAA;AAAA,KAChF,CAAA;AAAA,GACF;AACF;;;;;;;;ACxDO,MAAM,mBAAgD,CAAA;AAAA,EAiB3D,YAAY,OAIT,EAAA;AApBH,IAAiB,aAAA,CAAA,IAAA,EAAA,cAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AAmBf,IAAA,IAAA,CAAK,eAAe,OAAQ,CAAA,YAAA,CAAA;AAC5B,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AACtB,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AAAA,GACxB;AAAA,EApBA,OAAO,UACL,CAAA,MAAA,EACA,OACA,EAAA;AACA,IAAM,MAAA,YAAA,GAAeC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AAEtD,IAAA,OAAO,IAAI,mBAAoB,CAAA;AAAA,MAC7B,GAAG,OAAA;AAAA,MACH,YAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAYA,gBAA2B,GAAA;AACzB,IAAO,OAAA,qBAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAM,gBACJ,CAAA,MAAA,EACA,QACiB,EAAA;AACjB,IACE,IAAA,CAAC,MACD,IAAA,MAAA,CAAO,IAAS,KAAA,KAAA,IACf,OAAO,IAAQ,IAAA,MAAA,CAAO,IAAK,CAAA,IAAA,KAAS,SACrC,EAAA;AACA,MAAO,OAAA,MAAA,CAAA;AAAA,KACT;AAEA,IAAA,MAAM,cAAiB,GAAA,IAAA,CAAK,YAAa,CAAA,KAAA,CAAM,SAAS,MAAM,CAAA,CAAA;AAC9D,IAAM,MAAA,UAAA,GAAa,OAAO,IAAM,CAAA,UAAA,CAAA;AAEhC,IAAI,IAAA,CAAC,cAAkB,IAAA,CAAC,UAAY,EAAA;AAClC,MAAO,OAAA,MAAA,CAAA;AAAA,KACT;AAEA,IAAM,MAAA,UAAA,GAAa,CAAC,GAAA,EAAa,IAAyB,KAAA;AACxD,MAAA,OAAO,cAAe,CAAA,UAAA,CAAW,EAAE,GAAA,EAAK,MAAM,CAAA,CAAA;AAAA,KAChD,CAAA;AAEA,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAuC,oCAAA,EAAA,QAAA,CAAS,MAAM,CAAE,CAAA,CAAA,CAAA;AAC1E,IAAI,IAAA;AACF,MAAM,MAAA,IAAA,GAAO,OAAO,GAAgB,KAAA;AAClC,QAAA,MAAM,EAAE,MAAO,EAAA,GAAI,MAAM,IAAK,CAAA,MAAA,CAAO,QAAQ,GAAG,CAAA,CAAA;AAChD,QAAA,OAAO,MAAM,MAAO,EAAA,CAAA;AAAA,OACtB,CAAA;AACA,MAAA,MAAM,cAAc,MAAM,kBAAA;AAAA,QACxB,WAAW,QAAS,EAAA;AAAA,QACpB,QAAS,CAAA,MAAA;AAAA,QACT,IAAA;AAAA,QACA,UAAA;AAAA,OACF,CAAA;AAEA,MAAO,OAAA;AAAA,QACL,GAAG,MAAA;AAAA,QACH,MAAM,EAAE,GAAG,MAAO,CAAA,IAAA,EAAM,YAAY,WAAY,EAAA;AAAA,OAClD,CAAA;AAAA,aACO,KAAO,EAAA;AACd,MAAK,IAAA,CAAA,MAAA,CAAO,KAAM,CAAA,CAAA,sCAAA,CAAA,EAA0C,KAAK,CAAA,CAAA;AACjE,MAAO,OAAA,MAAA,CAAA;AAAA,KACT;AAAA,GACF;AACF;;ACjFO,MAAM,0BAA6B,GAAA;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/lib/bundle.ts","../src/jsonSchemaRefPlaceholderResolver.ts","../src/OpenApiRefProcessor.ts","../src/module/catalogModuleJsonSchemaRefPlaceholderResolver.ts","../src/index.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport $RefParser from '@apidevtools/json-schema-ref-parser';\nimport { parse, stringify } from 'yaml';\nimport * as path from 'path';\n\nconst protocolPattern = /^(\\w{2,}):\\/\\//i;\nconst getProtocol = (refPath: string) => {\n  const match = protocolPattern.exec(refPath);\n  if (match) {\n    return match[1].toLowerCase();\n  }\n  return undefined;\n};\n\nexport type BundlerRead = (url: string) => Promise<Buffer>;\n\nexport type BundlerResolveUrl = (url: string, base: string) => string;\n\nexport async function bundleFileWithRefs(\n  fileWithRefs: string,\n  baseUrl: string,\n  read: BundlerRead,\n  resolveUrl: BundlerResolveUrl,\n): Promise<string> {\n  const fileUrlReaderResolver: $RefParser.ResolverOptions = {\n    canRead: file => {\n      const protocol = getProtocol(file.url);\n      return protocol === undefined || protocol === 'file';\n    },\n    read: async file => {\n      const relativePath = path.relative('.', file.url);\n      const url = resolveUrl(relativePath, baseUrl);\n      return await read(url);\n    },\n  };\n  const httpUrlReaderResolver: $RefParser.ResolverOptions = {\n    canRead: ref => {\n      const protocol = getProtocol(ref.url);\n      return protocol === 'http' || protocol === 'https';\n    },\n    read: async ref => {\n      const url = resolveUrl(ref.url, baseUrl);\n      return await read(url);\n    },\n  };\n\n  const options: $RefParser.Options = {\n    resolve: {\n      file: fileUrlReaderResolver,\n      http: httpUrlReaderResolver,\n    },\n  };\n  const fileObject = parse(fileWithRefs);\n  const bundledObject = await $RefParser.bundle(baseUrl, fileObject, options);\n  return stringify(bundledObject);\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { PlaceholderResolverParams } from '@backstage/plugin-catalog-backend';\nimport { JsonValue } from '@backstage/types';\nimport { processingResult } from '@backstage/plugin-catalog-node';\nimport { bundleFileWithRefs } from './lib';\n\n/** @public */\nexport async function jsonSchemaRefPlaceholderResolver(\n  params: PlaceholderResolverParams,\n): Promise<JsonValue> {\n  const { content, url } = await readTextLocation(params);\n\n  params.emit(processingResult.refresh(`url:${url}`));\n\n  try {\n    return await bundleFileWithRefs(\n      content,\n      url,\n      params.read,\n      params.resolveUrl,\n    );\n  } catch (error) {\n    throw new Error(\n      `Placeholder \\$${params.key} unable to bundle the file at ${params.value}, ${error}`,\n    );\n  }\n}\n\n/*\n * Helpers, copied from PlaceholderProcessor\n */\n\nasync function readTextLocation(\n  params: PlaceholderResolverParams,\n): Promise<{ content: string; url: string }> {\n  const newUrl = relativeUrl(params);\n\n  try {\n    const data = await params.read(newUrl);\n    return { content: data.toString('utf-8'), url: newUrl };\n  } catch (e) {\n    throw new Error(\n      `Placeholder \\$${params.key} could not read location ${params.value}, ${e}`,\n    );\n  }\n}\n\nfunction relativeUrl({\n  key,\n  value,\n  baseUrl,\n  resolveUrl,\n}: PlaceholderResolverParams): string {\n  if (typeof value !== 'string') {\n    throw new Error(\n      `Placeholder \\$${key} expected a string value parameter, in the form of an absolute URL or a relative path`,\n    );\n  }\n\n  try {\n    return resolveUrl(value, baseUrl);\n  } catch (e) {\n    // The only remaining case that isn't support is a relative file path that should be\n    // resolved using a relative file location. Accessing local file paths can lead to\n    // path traversal attacks and access to any file on the host system. Implementing this\n    // would require additional security measures.\n    throw new Error(\n      `Placeholder \\$${key} could not form a URL out of ${baseUrl} and ${value}, ${e}`,\n    );\n  }\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { UrlReader } from '@backstage/backend-common';\nimport { Entity } from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { ScmIntegrations } from '@backstage/integration';\nimport { CatalogProcessor } from '@backstage/plugin-catalog-node';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport { bundleFileWithRefs } from './lib';\nimport { Logger } from 'winston';\n\n/**\n * @public\n * @deprecated replaced by the openApiPlaceholderResolver\n */\nexport class OpenApiRefProcessor implements CatalogProcessor {\n  private readonly integrations: ScmIntegrations;\n  private readonly logger: Logger;\n  private readonly reader: UrlReader;\n\n  static fromConfig(\n    config: Config,\n    options: { logger: Logger; reader: UrlReader },\n  ) {\n    const integrations = ScmIntegrations.fromConfig(config);\n\n    return new OpenApiRefProcessor({\n      ...options,\n      integrations,\n    });\n  }\n\n  constructor(options: {\n    integrations: ScmIntegrations;\n    logger: Logger;\n    reader: UrlReader;\n  }) {\n    this.integrations = options.integrations;\n    this.logger = options.logger;\n    this.reader = options.reader;\n  }\n\n  getProcessorName(): string {\n    return 'OpenApiRefProcessor';\n  }\n\n  async preProcessEntity(\n    entity: Entity,\n    location: LocationSpec,\n  ): Promise<Entity> {\n    if (\n      !entity ||\n      entity.kind !== 'API' ||\n      (entity.spec && entity.spec.type !== 'openapi')\n    ) {\n      return entity;\n    }\n\n    const scmIntegration = this.integrations.byUrl(location.target);\n    const definition = entity.spec!.definition;\n\n    if (!scmIntegration || !definition) {\n      return entity;\n    }\n\n    const resolveUrl = (url: string, base: string): string => {\n      return scmIntegration.resolveUrl({ url, base });\n    };\n\n    this.logger.debug(`Bundling OpenAPI specification from ${location.target}`);\n    try {\n      const read = async (url: string) => {\n        const { buffer } = await this.reader.readUrl(url);\n        return await buffer();\n      };\n      const bundledSpec = await bundleFileWithRefs(\n        definition.toString(),\n        location.target,\n        read,\n        resolveUrl,\n      );\n\n      return {\n        ...entity,\n        spec: { ...entity.spec, definition: bundledSpec },\n      };\n    } catch (error) {\n      this.logger.error(`Unable to bundle OpenAPI specification`, error);\n      return entity;\n    }\n  }\n}\n","/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createBackendModule } from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport { jsonSchemaRefPlaceholderResolver } from '../jsonSchemaRefPlaceholderResolver';\n\n/**\n * Registers the jsonSchemaRefPlaceholderResolver\n * as placeholder resolver for `$asyncapi` and `$openapi`.\n *\n * @public\n */\nexport const catalogModuleJsonSchemaRefPlaceholderResolver =\n  createBackendModule({\n    pluginId: 'catalog',\n    moduleId: 'json-schema-ref-placeholder-resolver',\n    register(env) {\n      env.registerInit({\n        deps: {\n          catalog: catalogProcessingExtensionPoint,\n        },\n        async init({ catalog }) {\n          catalog.addPlaceholderResolver(\n            'asyncapi',\n            jsonSchemaRefPlaceholderResolver,\n          );\n          catalog.addPlaceholderResolver(\n            'openapi',\n            jsonSchemaRefPlaceholderResolver,\n          );\n        },\n      });\n    },\n  });\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { jsonSchemaRefPlaceholderResolver } from './jsonSchemaRefPlaceholderResolver';\n\nexport { OpenApiRefProcessor } from './OpenApiRefProcessor';\nexport { jsonSchemaRefPlaceholderResolver } from './jsonSchemaRefPlaceholderResolver';\n/**\n * @public\n * @deprecated replaced by jsonSchemaRefPlaceholderResolver\n */\nexport const openApiPlaceholderResolver = jsonSchemaRefPlaceholderResolver;\n\nexport * from './module';\nexport { default } from './module';\n"],"names":["path","parse","$RefParser","stringify","processingResult","ScmIntegrations","createBackendModule","catalogProcessingExtensionPoint"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmBA,MAAM,eAAkB,GAAA,iBAAA,CAAA;AACxB,MAAM,WAAA,GAAc,CAAC,OAAoB,KAAA;AACvC,EAAM,MAAA,KAAA,GAAQ,eAAgB,CAAA,IAAA,CAAK,OAAO,CAAA,CAAA;AAC1C,EAAA,IAAI,KAAO,EAAA;AACT,IAAO,OAAA,KAAA,CAAM,CAAC,CAAA,CAAE,WAAY,EAAA,CAAA;AAAA,GAC9B;AACA,EAAO,OAAA,KAAA,CAAA,CAAA;AACT,CAAA,CAAA;AAMA,eAAsB,kBACpB,CAAA,YAAA,EACA,OACA,EAAA,IAAA,EACA,UACiB,EAAA;AACjB,EAAA,MAAM,qBAAoD,GAAA;AAAA,IACxD,SAAS,CAAQ,IAAA,KAAA;AACf,MAAM,MAAA,QAAA,GAAW,WAAY,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AACrC,MAAO,OAAA,QAAA,KAAa,UAAa,QAAa,KAAA,MAAA,CAAA;AAAA,KAChD;AAAA,IACA,IAAA,EAAM,OAAM,IAAQ,KAAA;AAClB,MAAA,MAAM,YAAe,GAAAA,eAAA,CAAK,QAAS,CAAA,GAAA,EAAK,KAAK,GAAG,CAAA,CAAA;AAChD,MAAM,MAAA,GAAA,GAAM,UAAW,CAAA,YAAA,EAAc,OAAO,CAAA,CAAA;AAC5C,MAAO,OAAA,MAAM,KAAK,GAAG,CAAA,CAAA;AAAA,KACvB;AAAA,GACF,CAAA;AACA,EAAA,MAAM,qBAAoD,GAAA;AAAA,IACxD,SAAS,CAAO,GAAA,KAAA;AACd,MAAM,MAAA,QAAA,GAAW,WAAY,CAAA,GAAA,CAAI,GAAG,CAAA,CAAA;AACpC,MAAO,OAAA,QAAA,KAAa,UAAU,QAAa,KAAA,OAAA,CAAA;AAAA,KAC7C;AAAA,IACA,IAAA,EAAM,OAAM,GAAO,KAAA;AACjB,MAAA,MAAM,GAAM,GAAA,UAAA,CAAW,GAAI,CAAA,GAAA,EAAK,OAAO,CAAA,CAAA;AACvC,MAAO,OAAA,MAAM,KAAK,GAAG,CAAA,CAAA;AAAA,KACvB;AAAA,GACF,CAAA;AAEA,EAAA,MAAM,OAA8B,GAAA;AAAA,IAClC,OAAS,EAAA;AAAA,MACP,IAAM,EAAA,qBAAA;AAAA,MACN,IAAM,EAAA,qBAAA;AAAA,KACR;AAAA,GACF,CAAA;AACA,EAAM,MAAA,UAAA,GAAaC,WAAM,YAAY,CAAA,CAAA;AACrC,EAAA,MAAM,gBAAgB,MAAMC,8BAAA,CAAW,MAAO,CAAA,OAAA,EAAS,YAAY,OAAO,CAAA,CAAA;AAC1E,EAAA,OAAOC,eAAU,aAAa,CAAA,CAAA;AAChC;;AChDA,eAAsB,iCACpB,MACoB,EAAA;AACpB,EAAA,MAAM,EAAE,OAAS,EAAA,GAAA,EAAQ,GAAA,MAAM,iBAAiB,MAAM,CAAA,CAAA;AAEtD,EAAA,MAAA,CAAO,KAAKC,kCAAiB,CAAA,OAAA,CAAQ,CAAO,IAAA,EAAA,GAAG,EAAE,CAAC,CAAA,CAAA;AAElD,EAAI,IAAA;AACF,IAAA,OAAO,MAAM,kBAAA;AAAA,MACX,OAAA;AAAA,MACA,GAAA;AAAA,MACA,MAAO,CAAA,IAAA;AAAA,MACP,MAAO,CAAA,UAAA;AAAA,KACT,CAAA;AAAA,WACO,KAAO,EAAA;AACd,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,gBAAiB,MAAO,CAAA,GAAG,iCAAiC,MAAO,CAAA,KAAK,KAAK,KAAK,CAAA,CAAA;AAAA,KACpF,CAAA;AAAA,GACF;AACF,CAAA;AAMA,eAAe,iBACb,MAC2C,EAAA;AAC3C,EAAM,MAAA,MAAA,GAAS,YAAY,MAAM,CAAA,CAAA;AAEjC,EAAI,IAAA;AACF,IAAA,MAAM,IAAO,GAAA,MAAM,MAAO,CAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AACrC,IAAA,OAAO,EAAE,OAAS,EAAA,IAAA,CAAK,SAAS,OAAO,CAAA,EAAG,KAAK,MAAO,EAAA,CAAA;AAAA,WAC/C,CAAG,EAAA;AACV,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,gBAAiB,MAAO,CAAA,GAAG,4BAA4B,MAAO,CAAA,KAAK,KAAK,CAAC,CAAA,CAAA;AAAA,KAC3E,CAAA;AAAA,GACF;AACF,CAAA;AAEA,SAAS,WAAY,CAAA;AAAA,EACnB,GAAA;AAAA,EACA,KAAA;AAAA,EACA,OAAA;AAAA,EACA,UAAA;AACF,CAAsC,EAAA;AACpC,EAAI,IAAA,OAAO,UAAU,QAAU,EAAA;AAC7B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,gBAAiB,GAAG,CAAA,qFAAA,CAAA;AAAA,KACtB,CAAA;AAAA,GACF;AAEA,EAAI,IAAA;AACF,IAAO,OAAA,UAAA,CAAW,OAAO,OAAO,CAAA,CAAA;AAAA,WACzB,CAAG,EAAA;AAKV,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,gBAAiB,GAAG,CAAA,6BAAA,EAAgC,OAAO,CAAQ,KAAA,EAAA,KAAK,KAAK,CAAC,CAAA,CAAA;AAAA,KAChF,CAAA;AAAA,GACF;AACF;;;;;;;;ACxDO,MAAM,mBAAgD,CAAA;AAAA,EAiB3D,YAAY,OAIT,EAAA;AApBH,IAAiB,aAAA,CAAA,IAAA,EAAA,cAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AAmBf,IAAA,IAAA,CAAK,eAAe,OAAQ,CAAA,YAAA,CAAA;AAC5B,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AACtB,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AAAA,GACxB;AAAA,EApBA,OAAO,UACL,CAAA,MAAA,EACA,OACA,EAAA;AACA,IAAM,MAAA,YAAA,GAAeC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AAEtD,IAAA,OAAO,IAAI,mBAAoB,CAAA;AAAA,MAC7B,GAAG,OAAA;AAAA,MACH,YAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAYA,gBAA2B,GAAA;AACzB,IAAO,OAAA,qBAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAM,gBACJ,CAAA,MAAA,EACA,QACiB,EAAA;AACjB,IACE,IAAA,CAAC,MACD,IAAA,MAAA,CAAO,IAAS,KAAA,KAAA,IACf,OAAO,IAAQ,IAAA,MAAA,CAAO,IAAK,CAAA,IAAA,KAAS,SACrC,EAAA;AACA,MAAO,OAAA,MAAA,CAAA;AAAA,KACT;AAEA,IAAA,MAAM,cAAiB,GAAA,IAAA,CAAK,YAAa,CAAA,KAAA,CAAM,SAAS,MAAM,CAAA,CAAA;AAC9D,IAAM,MAAA,UAAA,GAAa,OAAO,IAAM,CAAA,UAAA,CAAA;AAEhC,IAAI,IAAA,CAAC,cAAkB,IAAA,CAAC,UAAY,EAAA;AAClC,MAAO,OAAA,MAAA,CAAA;AAAA,KACT;AAEA,IAAM,MAAA,UAAA,GAAa,CAAC,GAAA,EAAa,IAAyB,KAAA;AACxD,MAAA,OAAO,cAAe,CAAA,UAAA,CAAW,EAAE,GAAA,EAAK,MAAM,CAAA,CAAA;AAAA,KAChD,CAAA;AAEA,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAuC,oCAAA,EAAA,QAAA,CAAS,MAAM,CAAE,CAAA,CAAA,CAAA;AAC1E,IAAI,IAAA;AACF,MAAM,MAAA,IAAA,GAAO,OAAO,GAAgB,KAAA;AAClC,QAAA,MAAM,EAAE,MAAO,EAAA,GAAI,MAAM,IAAK,CAAA,MAAA,CAAO,QAAQ,GAAG,CAAA,CAAA;AAChD,QAAA,OAAO,MAAM,MAAO,EAAA,CAAA;AAAA,OACtB,CAAA;AACA,MAAA,MAAM,cAAc,MAAM,kBAAA;AAAA,QACxB,WAAW,QAAS,EAAA;AAAA,QACpB,QAAS,CAAA,MAAA;AAAA,QACT,IAAA;AAAA,QACA,UAAA;AAAA,OACF,CAAA;AAEA,MAAO,OAAA;AAAA,QACL,GAAG,MAAA;AAAA,QACH,MAAM,EAAE,GAAG,MAAO,CAAA,IAAA,EAAM,YAAY,WAAY,EAAA;AAAA,OAClD,CAAA;AAAA,aACO,KAAO,EAAA;AACd,MAAK,IAAA,CAAA,MAAA,CAAO,KAAM,CAAA,CAAA,sCAAA,CAAA,EAA0C,KAAK,CAAA,CAAA;AACjE,MAAO,OAAA,MAAA,CAAA;AAAA,KACT;AAAA,GACF;AACF;;AC9EO,MAAM,gDACXC,oCAAoB,CAAA;AAAA,EAClB,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,sCAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,OAAS,EAAAC,qCAAA;AAAA,OACX;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,OAAA,EAAW,EAAA;AACtB,QAAQ,OAAA,CAAA,sBAAA;AAAA,UACN,UAAA;AAAA,UACA,gCAAA;AAAA,SACF,CAAA;AACA,QAAQ,OAAA,CAAA,sBAAA;AAAA,UACN,SAAA;AAAA,UACA,gCAAA;AAAA,SACF,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;ACxBI,MAAM,0BAA6B,GAAA;;;;;;;"}

package/dist/index.d.ts

@@ -7,6 +7,7 @@ import { ScmIntegrations } from '@backstage/integration';
 import { CatalogProcessor } from '@backstage/plugin-catalog-node';
 import { LocationSpec } from '@backstage/plugin-catalog-common';
 import { Logger } from 'winston';
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
 
 /** @public */
 declare function jsonSchemaRefPlaceholderResolver(params: PlaceholderResolverParams): Promise<JsonValue>;
@@ -32,10 +33,18 @@ declare class OpenApiRefProcessor implements CatalogProcessor {
     preProcessEntity(entity: Entity, location: LocationSpec): Promise<Entity>;
 }
 
+/**
+ * Registers the jsonSchemaRefPlaceholderResolver
+ * as placeholder resolver for `$asyncapi` and `$openapi`.
+ *
+ * @public
+ */
+declare const catalogModuleJsonSchemaRefPlaceholderResolver: () => _backstage_backend_plugin_api.BackendFeature;
+
 /**
  * @public
  * @deprecated replaced by jsonSchemaRefPlaceholderResolver
  */
 declare const openApiPlaceholderResolver: typeof jsonSchemaRefPlaceholderResolver;
 
-export { OpenApiRefProcessor, jsonSchemaRefPlaceholderResolver, openApiPlaceholderResolver };
+export { OpenApiRefProcessor, catalogModuleJsonSchemaRefPlaceholderResolver as default, jsonSchemaRefPlaceholderResolver, openApiPlaceholderResolver };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-openapi",
   "description": "A Backstage catalog backend module that helps with OpenAPI specifications",
-  "version": "0.1.26-next.2",
+  "version": "0.1.27-next.0",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -33,20 +33,21 @@
   },
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^9.0.6",
-    "@backstage/backend-common": "^0.20.1-next.2",
+    "@backstage/backend-common": "^0.21.0-next.0",
+    "@backstage/backend-plugin-api": "^0.6.10-next.0",
     "@backstage/catalog-model": "^1.4.3",
     "@backstage/config": "^1.1.1",
     "@backstage/integration": "^1.8.0",
-    "@backstage/plugin-catalog-backend": "^1.16.1-next.2",
-    "@backstage/plugin-catalog-common": "^1.0.19",
-    "@backstage/plugin-catalog-node": "^1.6.1-next.2",
+    "@backstage/plugin-catalog-backend": "^1.17.0-next.0",
+    "@backstage/plugin-catalog-common": "^1.0.20",
+    "@backstage/plugin-catalog-node": "^1.6.2-next.0",
     "@backstage/types": "^1.1.1",
     "winston": "^3.2.1",
     "yaml": "^2.1.1"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.2.10-next.2",
-    "@backstage/cli": "^0.25.1-next.1",
+    "@backstage/backend-test-utils": "^0.3.0-next.0",
+    "@backstage/cli": "^0.25.2-next.0",
     "openapi-types": "^12.0.0"
   },
   "files": [