@backstage/plugin-catalog-backend-module-backstage-openapi 0.4.1-next.0 → 0.4.1-next.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @backstage/plugin-catalog-backend-module-backstage-openapi
 
+## 0.4.1-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-node@1.13.1-next.1
+  - @backstage/backend-openapi-utils@0.2.0-next.1
+  - @backstage/backend-plugin-api@1.0.1-next.1
+  - @backstage/catalog-model@1.7.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+
 ## 0.4.1-next.0
 
 ### Patch Changes

package/dist/InternalOpenApiDocumentationProvider.cjs.js

@@ -0,0 +1,244 @@
+'use strict';
+
+var catalogModel = require('@backstage/catalog-model');
+var errors = require('@backstage/errors');
+var openapiMerge = require('openapi-merge');
+var backendOpenapiUtils = require('@backstage/backend-openapi-utils');
+var fetch = require('cross-fetch');
+var uuid = require('uuid');
+var lodash = require('lodash');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+function _interopNamespaceCompat(e) {
+  if (e && typeof e === 'object' && 'default' in e) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var fetch__default = /*#__PURE__*/_interopDefaultCompat(fetch);
+var uuid__namespace = /*#__PURE__*/_interopNamespaceCompat(uuid);
+var lodash__default = /*#__PURE__*/_interopDefaultCompat(lodash);
+
+const HTTP_VERBS = [
+  "get",
+  "post",
+  "put",
+  "delete",
+  "patch",
+  "trace",
+  "options",
+  "head"
+];
+const addTagsToSpec = (spec, tag) => {
+  Object.values(spec?.paths).forEach((path) => {
+    HTTP_VERBS.forEach((verb) => {
+      if (verb in path) {
+        if (!("tags" in path[verb])) {
+          path[verb].tags = [];
+        }
+        if (!path[verb].tags?.includes(tag)) {
+          path[verb].tags?.push(tag);
+        }
+      }
+    });
+  });
+};
+const mergeSpecs = async ({
+  baseUrl,
+  specs
+}) => {
+  const mergeResult = openapiMerge.merge([
+    // Add the full API information as the first item for other items to merge against it with.
+    {
+      oas: {
+        openapi: "3.0.3",
+        info: {
+          title: "Backstage API",
+          version: "1"
+        },
+        servers: [{ url: baseUrl }],
+        paths: {}
+      }
+    },
+    // For each plugin, load its spec and the known endpoint that it sits under.
+    ...specs.map(
+      (spec) => ({
+        oas: spec
+        // Weird typing differences between this package and the client package's openapi 3.
+      })
+    )
+  ]);
+  if (openapiMerge.isErrorResult(mergeResult)) {
+    throw new errors.ForwardedError(
+      `${mergeResult.message} (${mergeResult.type})`,
+      mergeResult
+    );
+  } else {
+    return mergeResult.output;
+  }
+};
+const loadSpecs = async ({
+  baseUrl,
+  discovery,
+  plugins,
+  logger,
+  auth
+}) => {
+  const specs = [];
+  for (const pluginId of plugins) {
+    const url = await discovery.getBaseUrl(pluginId);
+    const openApiUrl = backendOpenapiUtils.getOpenApiSpecRoute(url);
+    const { token } = await auth.getPluginRequestToken({
+      onBehalfOf: await auth.getOwnServiceCredentials(),
+      targetPluginId: pluginId
+    });
+    const response = await fetch__default.default(openApiUrl, {
+      method: "GET",
+      headers: {
+        Authorization: `Bearer ${token}`
+      }
+    });
+    if (response.ok) {
+      const spec = await response.json();
+      addTagsToSpec(spec, pluginId);
+      specs.push(spec);
+    } else if (response.status === 404) {
+      logger.error(
+        `Plugin=${pluginId} does not have an OpenAPI spec at '${openApiUrl}'.`
+      );
+    } else {
+      logger.error(
+        `Failed to load spec for plugin=${pluginId} at ${openApiUrl}. Error (${response.status}): ${response.body ? await response.text() : response.statusText}`
+      );
+    }
+  }
+  return mergeSpecs({ baseUrl, specs });
+};
+class InternalOpenApiDocumentationProvider {
+  constructor(config, discovery, logger, auth, taskRunner) {
+    this.config = config;
+    this.discovery = discovery;
+    this.logger = logger;
+    this.auth = auth;
+    this.scheduleFn = this.createScheduleFn(taskRunner);
+  }
+  connection;
+  scheduleFn;
+  static fromConfig(config, options) {
+    const taskRunner = options.schedule.createScheduledTaskRunner({
+      frequency: {
+        minutes: 1
+      },
+      timeout: {
+        minutes: 1
+      }
+    });
+    return new InternalOpenApiDocumentationProvider(
+      config,
+      options.discovery,
+      options.logger,
+      options.auth,
+      taskRunner
+    );
+  }
+  /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
+  getProviderName() {
+    return `InternalOpenApiDocumentationProvider`;
+  }
+  /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
+  async connect(connection) {
+    this.connection = connection;
+    return await this.scheduleFn();
+  }
+  createScheduleFn(taskRunner) {
+    return async () => {
+      const taskId = `${this.getProviderName()}:refresh`;
+      return taskRunner.run({
+        id: taskId,
+        fn: async () => {
+          const logger = this.logger.child({
+            class: InternalOpenApiDocumentationProvider.prototype.constructor.name,
+            taskId,
+            taskInstanceId: uuid__namespace.v4()
+          });
+          try {
+            await this.refresh(logger);
+          } catch (error) {
+            logger.error(`${this.getProviderName()} refresh failed`, error);
+          }
+        }
+      });
+    };
+  }
+  async refresh(logger) {
+    const pluginsToMerge = this.config.getStringArray(
+      "catalog.providers.backstageOpenapi.plugins"
+    );
+    const configToMerge = this.config.getOptional(
+      "catalog.providers.backstageOpenapi.entityOverrides"
+    );
+    const baseConfig = {
+      metadata: {
+        name: "internal_backstage_openapi_doc",
+        title: "Backstage API"
+      },
+      spec: {
+        lifecycle: "production",
+        owner: "backstage"
+      }
+    };
+    logger.info(`Loading specs from ${pluginsToMerge}.`);
+    const requiredConfig = {
+      apiVersion: "backstage.io/v1beta1",
+      kind: "API",
+      metadata: {
+        annotations: {
+          [catalogModel.ANNOTATION_LOCATION]: "internal-package:@backstage/plugin-catalog-backend-module-backstage-openapi",
+          [catalogModel.ANNOTATION_ORIGIN_LOCATION]: "internal-package:@backstage/plugin-catalog-backend-module-backstage-openapi"
+        }
+      },
+      spec: {
+        type: "openapi",
+        definition: JSON.stringify(
+          await loadSpecs({
+            baseUrl: this.config.getString("backend.baseUrl"),
+            discovery: this.discovery,
+            auth: this.auth,
+            plugins: pluginsToMerge,
+            logger
+          })
+        )
+      }
+    };
+    const mergedConfig = lodash__default.default.merge(baseConfig, configToMerge);
+    const documentationEntity = lodash__default.default.merge(
+      mergedConfig,
+      requiredConfig
+    );
+    await this.connection?.applyMutation({
+      type: "full",
+      entities: [
+        {
+          entity: documentationEntity,
+          locationKey: "internal-api-doc"
+        }
+      ]
+    });
+  }
+}
+
+exports.InternalOpenApiDocumentationProvider = InternalOpenApiDocumentationProvider;
+//# sourceMappingURL=InternalOpenApiDocumentationProvider.cjs.js.map

package/dist/InternalOpenApiDocumentationProvider.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InternalOpenApiDocumentationProvider.cjs.js","sources":["../src/InternalOpenApiDocumentationProvider.ts"],"sourcesContent":["/*\n * Copyright 2023 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 {\n  ANNOTATION_LOCATION,\n  ANNOTATION_ORIGIN_LOCATION,\n  type ApiEntity,\n} from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { ForwardedError } from '@backstage/errors';\nimport {\n  EntityProvider,\n  EntityProviderConnection,\n} from '@backstage/plugin-catalog-node';\nimport { merge, isErrorResult } from 'openapi-merge';\nimport { getOpenApiSpecRoute } from '@backstage/backend-openapi-utils';\nimport type {\n  OpenAPIObject,\n  OperationObject,\n  PathItemObject,\n} from 'openapi3-ts';\nimport fetch from 'cross-fetch';\nimport {\n  AuthService,\n  DiscoveryService,\n  LoggerService,\n  SchedulerService,\n  SchedulerServiceTaskRunner,\n} from '@backstage/backend-plugin-api';\nimport * as uuid from 'uuid';\nimport lodash from 'lodash';\n\nconst HTTP_VERBS: (keyof PathItemObject)[] = [\n  'get',\n  'post',\n  'put',\n  'delete',\n  'patch',\n  'trace',\n  'options',\n  'head',\n];\n\nconst addTagsToSpec = (spec: OpenAPIObject, tag: string) => {\n  Object.values(spec?.paths).forEach((path: PathItemObject) => {\n    HTTP_VERBS.forEach(verb => {\n      if (verb in path) {\n        if (!('tags' in path[verb])) {\n          (path[verb] as OperationObject).tags = [];\n        }\n        if (!(path[verb] as OperationObject).tags?.includes(tag)) {\n          (path[verb] as OperationObject).tags?.push(tag);\n        }\n      }\n    });\n  });\n};\n\nconst mergeSpecs = async ({\n  baseUrl,\n  specs,\n}: {\n  baseUrl: string;\n  specs: OpenAPIObject[];\n}) => {\n  const mergeResult = merge([\n    // Add the full API information as the first item for other items to merge against it with.\n    {\n      oas: {\n        openapi: '3.0.3',\n        info: {\n          title: 'Backstage API',\n          version: '1',\n        },\n        servers: [{ url: baseUrl }],\n        paths: {},\n      },\n    },\n    // For each plugin, load its spec and the known endpoint that it sits under.\n    ...specs.map(\n      spec =>\n        ({\n          oas: spec,\n          // Weird typing differences between this package and the client package's openapi 3.\n        } as any),\n    ),\n  ]);\n\n  if (isErrorResult(mergeResult)) {\n    throw new ForwardedError(\n      `${mergeResult.message} (${mergeResult.type})`,\n      mergeResult,\n    );\n  } else {\n    return mergeResult.output;\n  }\n};\n\nconst loadSpecs = async ({\n  baseUrl,\n  discovery,\n  plugins,\n  logger,\n  auth,\n}: {\n  baseUrl: string;\n  plugins: string[];\n  discovery: DiscoveryService;\n  logger: LoggerService;\n  auth: AuthService;\n}) => {\n  const specs: OpenAPIObject[] = [];\n  for (const pluginId of plugins) {\n    const url = await discovery.getBaseUrl(pluginId);\n    const openApiUrl = getOpenApiSpecRoute(url);\n    const { token } = await auth.getPluginRequestToken({\n      onBehalfOf: await auth.getOwnServiceCredentials(),\n      targetPluginId: pluginId,\n    });\n    const response = await fetch(openApiUrl, {\n      method: 'GET',\n      headers: {\n        Authorization: `Bearer ${token}`,\n      },\n    });\n    if (response.ok) {\n      const spec = await response.json();\n      addTagsToSpec(spec, pluginId);\n      specs.push(spec);\n    } else if (response.status === 404) {\n      logger.error(\n        `Plugin=${pluginId} does not have an OpenAPI spec at '${openApiUrl}'.`,\n      );\n    } else {\n      logger.error(\n        `Failed to load spec for plugin=${pluginId} at ${openApiUrl}. Error (${\n          response.status\n        }): ${response.body ? await response.text() : response.statusText}`,\n      );\n    }\n  }\n  return mergeSpecs({ baseUrl, specs });\n};\n\nexport class InternalOpenApiDocumentationProvider implements EntityProvider {\n  private connection?: EntityProviderConnection;\n  private readonly scheduleFn: () => Promise<void>;\n\n  constructor(\n    public readonly config: Config,\n    public readonly discovery: DiscoveryService,\n    public readonly logger: LoggerService,\n    public readonly auth: AuthService,\n    taskRunner: SchedulerServiceTaskRunner,\n  ) {\n    this.scheduleFn = this.createScheduleFn(taskRunner);\n  }\n\n  static fromConfig(\n    config: Config,\n    options: {\n      discovery: DiscoveryService;\n      logger: LoggerService;\n      schedule: SchedulerService;\n      auth: AuthService;\n    },\n  ) {\n    const taskRunner = options.schedule.createScheduledTaskRunner({\n      frequency: {\n        minutes: 1,\n      },\n      timeout: {\n        minutes: 1,\n      },\n    });\n    return new InternalOpenApiDocumentationProvider(\n      config,\n      options.discovery,\n      options.logger,\n      options.auth,\n      taskRunner,\n    );\n  }\n  /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */\n  getProviderName() {\n    return `InternalOpenApiDocumentationProvider`;\n  }\n\n  /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */\n  async connect(connection: EntityProviderConnection) {\n    this.connection = connection;\n    return await this.scheduleFn();\n  }\n\n  private createScheduleFn(\n    taskRunner: SchedulerServiceTaskRunner,\n  ): () => Promise<void> {\n    return async () => {\n      const taskId = `${this.getProviderName()}:refresh`;\n      return taskRunner.run({\n        id: taskId,\n        fn: async () => {\n          const logger = this.logger.child({\n            class:\n              InternalOpenApiDocumentationProvider.prototype.constructor.name,\n            taskId,\n            taskInstanceId: uuid.v4(),\n          });\n          try {\n            await this.refresh(logger);\n          } catch (error) {\n            logger.error(`${this.getProviderName()} refresh failed`, error);\n          }\n        },\n      });\n    };\n  }\n\n  async refresh(logger: LoggerService) {\n    const pluginsToMerge = this.config.getStringArray(\n      'catalog.providers.backstageOpenapi.plugins',\n    );\n    const configToMerge = this.config.getOptional(\n      'catalog.providers.backstageOpenapi.entityOverrides',\n    );\n\n    const baseConfig = {\n      metadata: {\n        name: 'internal_backstage_openapi_doc',\n        title: 'Backstage API',\n      },\n      spec: {\n        lifecycle: 'production',\n        owner: 'backstage',\n      },\n    };\n\n    logger.info(`Loading specs from ${pluginsToMerge}.`);\n    const requiredConfig = {\n      apiVersion: 'backstage.io/v1beta1',\n      kind: 'API',\n      metadata: {\n        annotations: {\n          [ANNOTATION_LOCATION]:\n            'internal-package:@backstage/plugin-catalog-backend-module-backstage-openapi',\n          [ANNOTATION_ORIGIN_LOCATION]:\n            'internal-package:@backstage/plugin-catalog-backend-module-backstage-openapi',\n        },\n      },\n      spec: {\n        type: 'openapi',\n        definition: JSON.stringify(\n          await loadSpecs({\n            baseUrl: this.config.getString('backend.baseUrl'),\n            discovery: this.discovery,\n            auth: this.auth,\n            plugins: pluginsToMerge,\n            logger,\n          }),\n        ),\n      },\n    };\n\n    // Overwrite baseConfig with options from config file.\n    const mergedConfig = lodash.merge(baseConfig, configToMerge);\n\n    // Overwite mergedConfig with requiredConfig (i.e., spec.type and spec.definition) to avoid bad configuration.\n    const documentationEntity = lodash.merge(\n      mergedConfig,\n      requiredConfig,\n    ) as ApiEntity;\n\n    await this.connection?.applyMutation({\n      type: 'full',\n      entities: [\n        {\n          entity: documentationEntity,\n          locationKey: 'internal-api-doc',\n        },\n      ],\n    });\n  }\n}\n"],"names":["merge","isErrorResult","ForwardedError","getOpenApiSpecRoute","fetch","uuid","ANNOTATION_LOCATION","ANNOTATION_ORIGIN_LOCATION","lodash"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6CA,MAAM,UAAuC,GAAA;AAAA,EAC3C,KAAA;AAAA,EACA,MAAA;AAAA,EACA,KAAA;AAAA,EACA,QAAA;AAAA,EACA,OAAA;AAAA,EACA,OAAA;AAAA,EACA,SAAA;AAAA,EACA,MAAA;AACF,CAAA,CAAA;AAEA,MAAM,aAAA,GAAgB,CAAC,IAAA,EAAqB,GAAgB,KAAA;AAC1D,EAAA,MAAA,CAAO,OAAO,IAAM,EAAA,KAAK,CAAE,CAAA,OAAA,CAAQ,CAAC,IAAyB,KAAA;AAC3D,IAAA,UAAA,CAAW,QAAQ,CAAQ,IAAA,KAAA;AACzB,MAAA,IAAI,QAAQ,IAAM,EAAA;AAChB,QAAA,IAAI,EAAE,MAAA,IAAU,IAAK,CAAA,IAAI,CAAI,CAAA,EAAA;AAC3B,UAAC,IAAK,CAAA,IAAI,CAAsB,CAAA,IAAA,GAAO,EAAC,CAAA;AAAA,SAC1C;AACA,QAAA,IAAI,CAAE,IAAK,CAAA,IAAI,EAAsB,IAAM,EAAA,QAAA,CAAS,GAAG,CAAG,EAAA;AACxD,UAAC,IAAK,CAAA,IAAI,CAAsB,CAAA,IAAA,EAAM,KAAK,GAAG,CAAA,CAAA;AAAA,SAChD;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACF,CAAA,CAAA;AACH,CAAA,CAAA;AAEA,MAAM,aAAa,OAAO;AAAA,EACxB,OAAA;AAAA,EACA,KAAA;AACF,CAGM,KAAA;AACJ,EAAA,MAAM,cAAcA,kBAAM,CAAA;AAAA;AAAA,IAExB;AAAA,MACE,GAAK,EAAA;AAAA,QACH,OAAS,EAAA,OAAA;AAAA,QACT,IAAM,EAAA;AAAA,UACJ,KAAO,EAAA,eAAA;AAAA,UACP,OAAS,EAAA,GAAA;AAAA,SACX;AAAA,QACA,OAAS,EAAA,CAAC,EAAE,GAAA,EAAK,SAAS,CAAA;AAAA,QAC1B,OAAO,EAAC;AAAA,OACV;AAAA,KACF;AAAA;AAAA,IAEA,GAAG,KAAM,CAAA,GAAA;AAAA,MACP,CACG,IAAA,MAAA;AAAA,QACC,GAAK,EAAA,IAAA;AAAA;AAAA,OAEP,CAAA;AAAA,KACJ;AAAA,GACD,CAAA,CAAA;AAED,EAAI,IAAAC,0BAAA,CAAc,WAAW,CAAG,EAAA;AAC9B,IAAA,MAAM,IAAIC,qBAAA;AAAA,MACR,CAAG,EAAA,WAAA,CAAY,OAAO,CAAA,EAAA,EAAK,YAAY,IAAI,CAAA,CAAA,CAAA;AAAA,MAC3C,WAAA;AAAA,KACF,CAAA;AAAA,GACK,MAAA;AACL,IAAA,OAAO,WAAY,CAAA,MAAA,CAAA;AAAA,GACrB;AACF,CAAA,CAAA;AAEA,MAAM,YAAY,OAAO;AAAA,EACvB,OAAA;AAAA,EACA,SAAA;AAAA,EACA,OAAA;AAAA,EACA,MAAA;AAAA,EACA,IAAA;AACF,CAMM,KAAA;AACJ,EAAA,MAAM,QAAyB,EAAC,CAAA;AAChC,EAAA,KAAA,MAAW,YAAY,OAAS,EAAA;AAC9B,IAAA,MAAM,GAAM,GAAA,MAAM,SAAU,CAAA,UAAA,CAAW,QAAQ,CAAA,CAAA;AAC/C,IAAM,MAAA,UAAA,GAAaC,wCAAoB,GAAG,CAAA,CAAA;AAC1C,IAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,KAAK,qBAAsB,CAAA;AAAA,MACjD,UAAA,EAAY,MAAM,IAAA,CAAK,wBAAyB,EAAA;AAAA,MAChD,cAAgB,EAAA,QAAA;AAAA,KACjB,CAAA,CAAA;AACD,IAAM,MAAA,QAAA,GAAW,MAAMC,sBAAA,CAAM,UAAY,EAAA;AAAA,MACvC,MAAQ,EAAA,KAAA;AAAA,MACR,OAAS,EAAA;AAAA,QACP,aAAA,EAAe,UAAU,KAAK,CAAA,CAAA;AAAA,OAChC;AAAA,KACD,CAAA,CAAA;AACD,IAAA,IAAI,SAAS,EAAI,EAAA;AACf,MAAM,MAAA,IAAA,GAAO,MAAM,QAAA,CAAS,IAAK,EAAA,CAAA;AACjC,MAAA,aAAA,CAAc,MAAM,QAAQ,CAAA,CAAA;AAC5B,MAAA,KAAA,CAAM,KAAK,IAAI,CAAA,CAAA;AAAA,KACjB,MAAA,IAAW,QAAS,CAAA,MAAA,KAAW,GAAK,EAAA;AAClC,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,CAAA,OAAA,EAAU,QAAQ,CAAA,mCAAA,EAAsC,UAAU,CAAA,EAAA,CAAA;AAAA,OACpE,CAAA;AAAA,KACK,MAAA;AACL,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,CAAkC,+BAAA,EAAA,QAAQ,CAAO,IAAA,EAAA,UAAU,YACzD,QAAS,CAAA,MACX,CAAM,GAAA,EAAA,QAAA,CAAS,OAAO,MAAM,QAAA,CAAS,IAAK,EAAA,GAAI,SAAS,UAAU,CAAA,CAAA;AAAA,OACnE,CAAA;AAAA,KACF;AAAA,GACF;AACA,EAAA,OAAO,UAAW,CAAA,EAAE,OAAS,EAAA,KAAA,EAAO,CAAA,CAAA;AACtC,CAAA,CAAA;AAEO,MAAM,oCAA+D,CAAA;AAAA,EAI1E,WACkB,CAAA,MAAA,EACA,SACA,EAAA,MAAA,EACA,MAChB,UACA,EAAA;AALgB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA,CAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA,CAAA;AAGhB,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAAA,GACpD;AAAA,EAXQ,UAAA,CAAA;AAAA,EACS,UAAA,CAAA;AAAA,EAYjB,OAAO,UACL,CAAA,MAAA,EACA,OAMA,EAAA;AACA,IAAM,MAAA,UAAA,GAAa,OAAQ,CAAA,QAAA,CAAS,yBAA0B,CAAA;AAAA,MAC5D,SAAW,EAAA;AAAA,QACT,OAAS,EAAA,CAAA;AAAA,OACX;AAAA,MACA,OAAS,EAAA;AAAA,QACP,OAAS,EAAA,CAAA;AAAA,OACX;AAAA,KACD,CAAA,CAAA;AACD,IAAA,OAAO,IAAI,oCAAA;AAAA,MACT,MAAA;AAAA,MACA,OAAQ,CAAA,SAAA;AAAA,MACR,OAAQ,CAAA,MAAA;AAAA,MACR,OAAQ,CAAA,IAAA;AAAA,MACR,UAAA;AAAA,KACF,CAAA;AAAA,GACF;AAAA;AAAA,EAEA,eAAkB,GAAA;AAChB,IAAO,OAAA,CAAA,oCAAA,CAAA,CAAA;AAAA,GACT;AAAA;AAAA,EAGA,MAAM,QAAQ,UAAsC,EAAA;AAClD,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAO,OAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GAC/B;AAAA,EAEQ,iBACN,UACqB,EAAA;AACrB,IAAA,OAAO,YAAY;AACjB,MAAA,MAAM,MAAS,GAAA,CAAA,EAAG,IAAK,CAAA,eAAA,EAAiB,CAAA,QAAA,CAAA,CAAA;AACxC,MAAA,OAAO,WAAW,GAAI,CAAA;AAAA,QACpB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAM,MAAA,MAAA,GAAS,IAAK,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,YAC/B,KAAA,EACE,oCAAqC,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YAC7D,MAAA;AAAA,YACA,cAAA,EAAgBC,gBAAK,EAAG,EAAA;AAAA,WACzB,CAAA,CAAA;AACD,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA,CAAA;AAAA,mBAClB,KAAO,EAAA;AACd,YAAA,MAAA,CAAO,MAAM,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAC,mBAAmB,KAAK,CAAA,CAAA;AAAA,WAChE;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,QAAQ,MAAuB,EAAA;AACnC,IAAM,MAAA,cAAA,GAAiB,KAAK,MAAO,CAAA,cAAA;AAAA,MACjC,4CAAA;AAAA,KACF,CAAA;AACA,IAAM,MAAA,aAAA,GAAgB,KAAK,MAAO,CAAA,WAAA;AAAA,MAChC,oDAAA;AAAA,KACF,CAAA;AAEA,IAAA,MAAM,UAAa,GAAA;AAAA,MACjB,QAAU,EAAA;AAAA,QACR,IAAM,EAAA,gCAAA;AAAA,QACN,KAAO,EAAA,eAAA;AAAA,OACT;AAAA,MACA,IAAM,EAAA;AAAA,QACJ,SAAW,EAAA,YAAA;AAAA,QACX,KAAO,EAAA,WAAA;AAAA,OACT;AAAA,KACF,CAAA;AAEA,IAAO,MAAA,CAAA,IAAA,CAAK,CAAsB,mBAAA,EAAA,cAAc,CAAG,CAAA,CAAA,CAAA,CAAA;AACnD,IAAA,MAAM,cAAiB,GAAA;AAAA,MACrB,UAAY,EAAA,sBAAA;AAAA,MACZ,IAAM,EAAA,KAAA;AAAA,MACN,QAAU,EAAA;AAAA,QACR,WAAa,EAAA;AAAA,UACX,CAACC,gCAAmB,GAClB,6EAAA;AAAA,UACF,CAACC,uCAA0B,GACzB,6EAAA;AAAA,SACJ;AAAA,OACF;AAAA,MACA,IAAM,EAAA;AAAA,QACJ,IAAM,EAAA,SAAA;AAAA,QACN,YAAY,IAAK,CAAA,SAAA;AAAA,UACf,MAAM,SAAU,CAAA;AAAA,YACd,OAAS,EAAA,IAAA,CAAK,MAAO,CAAA,SAAA,CAAU,iBAAiB,CAAA;AAAA,YAChD,WAAW,IAAK,CAAA,SAAA;AAAA,YAChB,MAAM,IAAK,CAAA,IAAA;AAAA,YACX,OAAS,EAAA,cAAA;AAAA,YACT,MAAA;AAAA,WACD,CAAA;AAAA,SACH;AAAA,OACF;AAAA,KACF,CAAA;AAGA,IAAA,MAAM,YAAe,GAAAC,uBAAA,CAAO,KAAM,CAAA,UAAA,EAAY,aAAa,CAAA,CAAA;AAG3D,IAAA,MAAM,sBAAsBA,uBAAO,CAAA,KAAA;AAAA,MACjC,YAAA;AAAA,MACA,cAAA;AAAA,KACF,CAAA;AAEA,IAAM,MAAA,IAAA,CAAK,YAAY,aAAc,CAAA;AAAA,MACnC,IAAM,EAAA,MAAA;AAAA,MACN,QAAU,EAAA;AAAA,QACR;AAAA,UACE,MAAQ,EAAA,mBAAA;AAAA,UACR,WAAa,EAAA,kBAAA;AAAA,SACf;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/index.cjs.js

@@ -4,245 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var alpha = require('@backstage/plugin-catalog-node/alpha');
-var catalogModel = require('@backstage/catalog-model');
-var errors = require('@backstage/errors');
-var openapiMerge = require('openapi-merge');
-var backendOpenapiUtils = require('@backstage/backend-openapi-utils');
-var fetch = require('cross-fetch');
-var uuid = require('uuid');
-var lodash = require('lodash');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
-
-function _interopNamespaceCompat(e) {
-  if (e && typeof e === 'object' && 'default' in e) return e;
-  var n = Object.create(null);
-  if (e) {
-    Object.keys(e).forEach(function (k) {
-      if (k !== 'default') {
-        var d = Object.getOwnPropertyDescriptor(e, k);
-        Object.defineProperty(n, k, d.get ? d : {
-          enumerable: true,
-          get: function () { return e[k]; }
-        });
-      }
-    });
-  }
-  n.default = e;
-  return Object.freeze(n);
-}
-
-var fetch__default = /*#__PURE__*/_interopDefaultCompat(fetch);
-var uuid__namespace = /*#__PURE__*/_interopNamespaceCompat(uuid);
-var lodash__default = /*#__PURE__*/_interopDefaultCompat(lodash);
-
-const HTTP_VERBS = [
-  "get",
-  "post",
-  "put",
-  "delete",
-  "patch",
-  "trace",
-  "options",
-  "head"
-];
-const addTagsToSpec = (spec, tag) => {
-  Object.values(spec?.paths).forEach((path) => {
-    HTTP_VERBS.forEach((verb) => {
-      if (verb in path) {
-        if (!("tags" in path[verb])) {
-          path[verb].tags = [];
-        }
-        if (!path[verb].tags?.includes(tag)) {
-          path[verb].tags?.push(tag);
-        }
-      }
-    });
-  });
-};
-const mergeSpecs = async ({
-  baseUrl,
-  specs
-}) => {
-  const mergeResult = openapiMerge.merge([
-    // Add the full API information as the first item for other items to merge against it with.
-    {
-      oas: {
-        openapi: "3.0.3",
-        info: {
-          title: "Backstage API",
-          version: "1"
-        },
-        servers: [{ url: baseUrl }],
-        paths: {}
-      }
-    },
-    // For each plugin, load its spec and the known endpoint that it sits under.
-    ...specs.map(
-      (spec) => ({
-        oas: spec
-        // Weird typing differences between this package and the client package's openapi 3.
-      })
-    )
-  ]);
-  if (openapiMerge.isErrorResult(mergeResult)) {
-    throw new errors.ForwardedError(
-      `${mergeResult.message} (${mergeResult.type})`,
-      mergeResult
-    );
-  } else {
-    return mergeResult.output;
-  }
-};
-const loadSpecs = async ({
-  baseUrl,
-  discovery,
-  plugins,
-  logger,
-  auth
-}) => {
-  const specs = [];
-  for (const pluginId of plugins) {
-    const url = await discovery.getBaseUrl(pluginId);
-    const openApiUrl = backendOpenapiUtils.getOpenApiSpecRoute(url);
-    const { token } = await auth.getPluginRequestToken({
-      onBehalfOf: await auth.getOwnServiceCredentials(),
-      targetPluginId: pluginId
-    });
-    const response = await fetch__default.default(openApiUrl, {
-      method: "GET",
-      headers: {
-        Authorization: `Bearer ${token}`
-      }
-    });
-    if (response.ok) {
-      const spec = await response.json();
-      addTagsToSpec(spec, pluginId);
-      specs.push(spec);
-    } else if (response.status === 404) {
-      logger.error(
-        `Plugin=${pluginId} does not have an OpenAPI spec at '${openApiUrl}'.`
-      );
-    } else {
-      logger.error(
-        `Failed to load spec for plugin=${pluginId} at ${openApiUrl}. Error (${response.status}): ${response.body ? await response.text() : response.statusText}`
-      );
-    }
-  }
-  return mergeSpecs({ baseUrl, specs });
-};
-class InternalOpenApiDocumentationProvider {
-  constructor(config, discovery, logger, auth, taskRunner) {
-    this.config = config;
-    this.discovery = discovery;
-    this.logger = logger;
-    this.auth = auth;
-    this.scheduleFn = this.createScheduleFn(taskRunner);
-  }
-  connection;
-  scheduleFn;
-  static fromConfig(config, options) {
-    const taskRunner = options.schedule.createScheduledTaskRunner({
-      frequency: {
-        minutes: 1
-      },
-      timeout: {
-        minutes: 1
-      }
-    });
-    return new InternalOpenApiDocumentationProvider(
-      config,
-      options.discovery,
-      options.logger,
-      options.auth,
-      taskRunner
-    );
-  }
-  /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
-  getProviderName() {
-    return `InternalOpenApiDocumentationProvider`;
-  }
-  /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
-  async connect(connection) {
-    this.connection = connection;
-    return await this.scheduleFn();
-  }
-  createScheduleFn(taskRunner) {
-    return async () => {
-      const taskId = `${this.getProviderName()}:refresh`;
-      return taskRunner.run({
-        id: taskId,
-        fn: async () => {
-          const logger = this.logger.child({
-            class: InternalOpenApiDocumentationProvider.prototype.constructor.name,
-            taskId,
-            taskInstanceId: uuid__namespace.v4()
-          });
-          try {
-            await this.refresh(logger);
-          } catch (error) {
-            logger.error(`${this.getProviderName()} refresh failed`, error);
-          }
-        }
-      });
-    };
-  }
-  async refresh(logger) {
-    const pluginsToMerge = this.config.getStringArray(
-      "catalog.providers.backstageOpenapi.plugins"
-    );
-    const configToMerge = this.config.getOptional(
-      "catalog.providers.backstageOpenapi.entityOverrides"
-    );
-    const baseConfig = {
-      metadata: {
-        name: "internal_backstage_openapi_doc",
-        title: "Backstage API"
-      },
-      spec: {
-        lifecycle: "production",
-        owner: "backstage"
-      }
-    };
-    logger.info(`Loading specs from ${pluginsToMerge}.`);
-    const requiredConfig = {
-      apiVersion: "backstage.io/v1beta1",
-      kind: "API",
-      metadata: {
-        annotations: {
-          [catalogModel.ANNOTATION_LOCATION]: "internal-package:@backstage/plugin-catalog-backend-module-backstage-openapi",
-          [catalogModel.ANNOTATION_ORIGIN_LOCATION]: "internal-package:@backstage/plugin-catalog-backend-module-backstage-openapi"
-        }
-      },
-      spec: {
-        type: "openapi",
-        definition: JSON.stringify(
-          await loadSpecs({
-            baseUrl: this.config.getString("backend.baseUrl"),
-            discovery: this.discovery,
-            auth: this.auth,
-            plugins: pluginsToMerge,
-            logger
-          })
-        )
-      }
-    };
-    const mergedConfig = lodash__default.default.merge(baseConfig, configToMerge);
-    const documentationEntity = lodash__default.default.merge(
-      mergedConfig,
-      requiredConfig
-    );
-    await this.connection?.applyMutation({
-      type: "full",
-      entities: [
-        {
-          entity: documentationEntity,
-          locationKey: "internal-api-doc"
-        }
-      ]
-    });
-  }
-}
+var InternalOpenApiDocumentationProvider = require('./InternalOpenApiDocumentationProvider.cjs.js');
 
 const metaOpenApiDocsPluginId = "meta-api-docs";
 const catalogModuleInternalOpenApiSpec = backendPluginApi.createBackendModule({
@@ -260,7 +22,7 @@ const catalogModuleInternalOpenApiSpec = backendPluginApi.createBackendModule({
       },
       async init({ catalog, config, discovery, scheduler, logger, auth }) {
         catalog.addEntityProvider(
-          InternalOpenApiDocumentationProvider.fromConfig(config, {
+          InternalOpenApiDocumentationProvider.InternalOpenApiDocumentationProvider.fromConfig(config, {
             discovery,
             schedule: scheduler,
             logger,

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/InternalOpenApiDocumentationProvider.ts","../src/index.ts"],"sourcesContent":["/*\n * Copyright 2023 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 {\n  ANNOTATION_LOCATION,\n  ANNOTATION_ORIGIN_LOCATION,\n  type ApiEntity,\n} from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { ForwardedError } from '@backstage/errors';\nimport {\n  EntityProvider,\n  EntityProviderConnection,\n} from '@backstage/plugin-catalog-node';\nimport { merge, isErrorResult } from 'openapi-merge';\nimport { getOpenApiSpecRoute } from '@backstage/backend-openapi-utils';\nimport type {\n  OpenAPIObject,\n  OperationObject,\n  PathItemObject,\n} from 'openapi3-ts';\nimport fetch from 'cross-fetch';\nimport {\n  AuthService,\n  DiscoveryService,\n  LoggerService,\n  SchedulerService,\n  SchedulerServiceTaskRunner,\n} from '@backstage/backend-plugin-api';\nimport * as uuid from 'uuid';\nimport lodash from 'lodash';\n\nconst HTTP_VERBS: (keyof PathItemObject)[] = [\n  'get',\n  'post',\n  'put',\n  'delete',\n  'patch',\n  'trace',\n  'options',\n  'head',\n];\n\nconst addTagsToSpec = (spec: OpenAPIObject, tag: string) => {\n  Object.values(spec?.paths).forEach((path: PathItemObject) => {\n    HTTP_VERBS.forEach(verb => {\n      if (verb in path) {\n        if (!('tags' in path[verb])) {\n          (path[verb] as OperationObject).tags = [];\n        }\n        if (!(path[verb] as OperationObject).tags?.includes(tag)) {\n          (path[verb] as OperationObject).tags?.push(tag);\n        }\n      }\n    });\n  });\n};\n\nconst mergeSpecs = async ({\n  baseUrl,\n  specs,\n}: {\n  baseUrl: string;\n  specs: OpenAPIObject[];\n}) => {\n  const mergeResult = merge([\n    // Add the full API information as the first item for other items to merge against it with.\n    {\n      oas: {\n        openapi: '3.0.3',\n        info: {\n          title: 'Backstage API',\n          version: '1',\n        },\n        servers: [{ url: baseUrl }],\n        paths: {},\n      },\n    },\n    // For each plugin, load its spec and the known endpoint that it sits under.\n    ...specs.map(\n      spec =>\n        ({\n          oas: spec,\n          // Weird typing differences between this package and the client package's openapi 3.\n        } as any),\n    ),\n  ]);\n\n  if (isErrorResult(mergeResult)) {\n    throw new ForwardedError(\n      `${mergeResult.message} (${mergeResult.type})`,\n      mergeResult,\n    );\n  } else {\n    return mergeResult.output;\n  }\n};\n\nconst loadSpecs = async ({\n  baseUrl,\n  discovery,\n  plugins,\n  logger,\n  auth,\n}: {\n  baseUrl: string;\n  plugins: string[];\n  discovery: DiscoveryService;\n  logger: LoggerService;\n  auth: AuthService;\n}) => {\n  const specs: OpenAPIObject[] = [];\n  for (const pluginId of plugins) {\n    const url = await discovery.getBaseUrl(pluginId);\n    const openApiUrl = getOpenApiSpecRoute(url);\n    const { token } = await auth.getPluginRequestToken({\n      onBehalfOf: await auth.getOwnServiceCredentials(),\n      targetPluginId: pluginId,\n    });\n    const response = await fetch(openApiUrl, {\n      method: 'GET',\n      headers: {\n        Authorization: `Bearer ${token}`,\n      },\n    });\n    if (response.ok) {\n      const spec = await response.json();\n      addTagsToSpec(spec, pluginId);\n      specs.push(spec);\n    } else if (response.status === 404) {\n      logger.error(\n        `Plugin=${pluginId} does not have an OpenAPI spec at '${openApiUrl}'.`,\n      );\n    } else {\n      logger.error(\n        `Failed to load spec for plugin=${pluginId} at ${openApiUrl}. Error (${\n          response.status\n        }): ${response.body ? await response.text() : response.statusText}`,\n      );\n    }\n  }\n  return mergeSpecs({ baseUrl, specs });\n};\n\nexport class InternalOpenApiDocumentationProvider implements EntityProvider {\n  private connection?: EntityProviderConnection;\n  private readonly scheduleFn: () => Promise<void>;\n\n  constructor(\n    public readonly config: Config,\n    public readonly discovery: DiscoveryService,\n    public readonly logger: LoggerService,\n    public readonly auth: AuthService,\n    taskRunner: SchedulerServiceTaskRunner,\n  ) {\n    this.scheduleFn = this.createScheduleFn(taskRunner);\n  }\n\n  static fromConfig(\n    config: Config,\n    options: {\n      discovery: DiscoveryService;\n      logger: LoggerService;\n      schedule: SchedulerService;\n      auth: AuthService;\n    },\n  ) {\n    const taskRunner = options.schedule.createScheduledTaskRunner({\n      frequency: {\n        minutes: 1,\n      },\n      timeout: {\n        minutes: 1,\n      },\n    });\n    return new InternalOpenApiDocumentationProvider(\n      config,\n      options.discovery,\n      options.logger,\n      options.auth,\n      taskRunner,\n    );\n  }\n  /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */\n  getProviderName() {\n    return `InternalOpenApiDocumentationProvider`;\n  }\n\n  /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */\n  async connect(connection: EntityProviderConnection) {\n    this.connection = connection;\n    return await this.scheduleFn();\n  }\n\n  private createScheduleFn(\n    taskRunner: SchedulerServiceTaskRunner,\n  ): () => Promise<void> {\n    return async () => {\n      const taskId = `${this.getProviderName()}:refresh`;\n      return taskRunner.run({\n        id: taskId,\n        fn: async () => {\n          const logger = this.logger.child({\n            class:\n              InternalOpenApiDocumentationProvider.prototype.constructor.name,\n            taskId,\n            taskInstanceId: uuid.v4(),\n          });\n          try {\n            await this.refresh(logger);\n          } catch (error) {\n            logger.error(`${this.getProviderName()} refresh failed`, error);\n          }\n        },\n      });\n    };\n  }\n\n  async refresh(logger: LoggerService) {\n    const pluginsToMerge = this.config.getStringArray(\n      'catalog.providers.backstageOpenapi.plugins',\n    );\n    const configToMerge = this.config.getOptional(\n      'catalog.providers.backstageOpenapi.entityOverrides',\n    );\n\n    const baseConfig = {\n      metadata: {\n        name: 'internal_backstage_openapi_doc',\n        title: 'Backstage API',\n      },\n      spec: {\n        lifecycle: 'production',\n        owner: 'backstage',\n      },\n    };\n\n    logger.info(`Loading specs from ${pluginsToMerge}.`);\n    const requiredConfig = {\n      apiVersion: 'backstage.io/v1beta1',\n      kind: 'API',\n      metadata: {\n        annotations: {\n          [ANNOTATION_LOCATION]:\n            'internal-package:@backstage/plugin-catalog-backend-module-backstage-openapi',\n          [ANNOTATION_ORIGIN_LOCATION]:\n            'internal-package:@backstage/plugin-catalog-backend-module-backstage-openapi',\n        },\n      },\n      spec: {\n        type: 'openapi',\n        definition: JSON.stringify(\n          await loadSpecs({\n            baseUrl: this.config.getString('backend.baseUrl'),\n            discovery: this.discovery,\n            auth: this.auth,\n            plugins: pluginsToMerge,\n            logger,\n          }),\n        ),\n      },\n    };\n\n    // Overwrite baseConfig with options from config file.\n    const mergedConfig = lodash.merge(baseConfig, configToMerge);\n\n    // Overwite mergedConfig with requiredConfig (i.e., spec.type and spec.definition) to avoid bad configuration.\n    const documentationEntity = lodash.merge(\n      mergedConfig,\n      requiredConfig,\n    ) as ApiEntity;\n\n    await this.connection?.applyMutation({\n      type: 'full',\n      entities: [\n        {\n          entity: documentationEntity,\n          locationKey: 'internal-api-doc',\n        },\n      ],\n    });\n  }\n}\n","/*\n * Copyright 2023 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 {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport { InternalOpenApiDocumentationProvider } from './InternalOpenApiDocumentationProvider';\n\n/**\n * @public\n */\nexport type MetaApiDocsPluginOptions = { exampleOption: boolean };\n\n/**\n * @public\n */\nexport const metaOpenApiDocsPluginId = 'meta-api-docs';\n\n/**\n * @public\n */\nexport const catalogModuleInternalOpenApiSpec = createBackendModule({\n  moduleId: metaOpenApiDocsPluginId,\n  pluginId: 'catalog',\n  register(env) {\n    env.registerInit({\n      deps: {\n        catalog: catalogProcessingExtensionPoint,\n        config: coreServices.rootConfig,\n        discovery: coreServices.discovery,\n        scheduler: coreServices.scheduler,\n        logger: coreServices.logger,\n        auth: coreServices.auth,\n      },\n      async init({ catalog, config, discovery, scheduler, logger, auth }) {\n        catalog.addEntityProvider(\n          InternalOpenApiDocumentationProvider.fromConfig(config, {\n            discovery,\n            schedule: scheduler,\n            logger,\n            auth,\n          }),\n        );\n      },\n    });\n  },\n});\n\nexport default catalogModuleInternalOpenApiSpec;\n"],"names":["merge","isErrorResult","ForwardedError","getOpenApiSpecRoute","fetch","uuid","ANNOTATION_LOCATION","ANNOTATION_ORIGIN_LOCATION","lodash","createBackendModule","catalogProcessingExtensionPoint","coreServices"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6CA,MAAM,UAAuC,GAAA;AAAA,EAC3C,KAAA;AAAA,EACA,MAAA;AAAA,EACA,KAAA;AAAA,EACA,QAAA;AAAA,EACA,OAAA;AAAA,EACA,OAAA;AAAA,EACA,SAAA;AAAA,EACA,MAAA;AACF,CAAA,CAAA;AAEA,MAAM,aAAA,GAAgB,CAAC,IAAA,EAAqB,GAAgB,KAAA;AAC1D,EAAA,MAAA,CAAO,OAAO,IAAM,EAAA,KAAK,CAAE,CAAA,OAAA,CAAQ,CAAC,IAAyB,KAAA;AAC3D,IAAA,UAAA,CAAW,QAAQ,CAAQ,IAAA,KAAA;AACzB,MAAA,IAAI,QAAQ,IAAM,EAAA;AAChB,QAAA,IAAI,EAAE,MAAA,IAAU,IAAK,CAAA,IAAI,CAAI,CAAA,EAAA;AAC3B,UAAC,IAAK,CAAA,IAAI,CAAsB,CAAA,IAAA,GAAO,EAAC,CAAA;AAAA,SAC1C;AACA,QAAA,IAAI,CAAE,IAAK,CAAA,IAAI,EAAsB,IAAM,EAAA,QAAA,CAAS,GAAG,CAAG,EAAA;AACxD,UAAC,IAAK,CAAA,IAAI,CAAsB,CAAA,IAAA,EAAM,KAAK,GAAG,CAAA,CAAA;AAAA,SAChD;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACF,CAAA,CAAA;AACH,CAAA,CAAA;AAEA,MAAM,aAAa,OAAO;AAAA,EACxB,OAAA;AAAA,EACA,KAAA;AACF,CAGM,KAAA;AACJ,EAAA,MAAM,cAAcA,kBAAM,CAAA;AAAA;AAAA,IAExB;AAAA,MACE,GAAK,EAAA;AAAA,QACH,OAAS,EAAA,OAAA;AAAA,QACT,IAAM,EAAA;AAAA,UACJ,KAAO,EAAA,eAAA;AAAA,UACP,OAAS,EAAA,GAAA;AAAA,SACX;AAAA,QACA,OAAS,EAAA,CAAC,EAAE,GAAA,EAAK,SAAS,CAAA;AAAA,QAC1B,OAAO,EAAC;AAAA,OACV;AAAA,KACF;AAAA;AAAA,IAEA,GAAG,KAAM,CAAA,GAAA;AAAA,MACP,CACG,IAAA,MAAA;AAAA,QACC,GAAK,EAAA,IAAA;AAAA;AAAA,OAEP,CAAA;AAAA,KACJ;AAAA,GACD,CAAA,CAAA;AAED,EAAI,IAAAC,0BAAA,CAAc,WAAW,CAAG,EAAA;AAC9B,IAAA,MAAM,IAAIC,qBAAA;AAAA,MACR,CAAG,EAAA,WAAA,CAAY,OAAO,CAAA,EAAA,EAAK,YAAY,IAAI,CAAA,CAAA,CAAA;AAAA,MAC3C,WAAA;AAAA,KACF,CAAA;AAAA,GACK,MAAA;AACL,IAAA,OAAO,WAAY,CAAA,MAAA,CAAA;AAAA,GACrB;AACF,CAAA,CAAA;AAEA,MAAM,YAAY,OAAO;AAAA,EACvB,OAAA;AAAA,EACA,SAAA;AAAA,EACA,OAAA;AAAA,EACA,MAAA;AAAA,EACA,IAAA;AACF,CAMM,KAAA;AACJ,EAAA,MAAM,QAAyB,EAAC,CAAA;AAChC,EAAA,KAAA,MAAW,YAAY,OAAS,EAAA;AAC9B,IAAA,MAAM,GAAM,GAAA,MAAM,SAAU,CAAA,UAAA,CAAW,QAAQ,CAAA,CAAA;AAC/C,IAAM,MAAA,UAAA,GAAaC,wCAAoB,GAAG,CAAA,CAAA;AAC1C,IAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,KAAK,qBAAsB,CAAA;AAAA,MACjD,UAAA,EAAY,MAAM,IAAA,CAAK,wBAAyB,EAAA;AAAA,MAChD,cAAgB,EAAA,QAAA;AAAA,KACjB,CAAA,CAAA;AACD,IAAM,MAAA,QAAA,GAAW,MAAMC,sBAAA,CAAM,UAAY,EAAA;AAAA,MACvC,MAAQ,EAAA,KAAA;AAAA,MACR,OAAS,EAAA;AAAA,QACP,aAAA,EAAe,UAAU,KAAK,CAAA,CAAA;AAAA,OAChC;AAAA,KACD,CAAA,CAAA;AACD,IAAA,IAAI,SAAS,EAAI,EAAA;AACf,MAAM,MAAA,IAAA,GAAO,MAAM,QAAA,CAAS,IAAK,EAAA,CAAA;AACjC,MAAA,aAAA,CAAc,MAAM,QAAQ,CAAA,CAAA;AAC5B,MAAA,KAAA,CAAM,KAAK,IAAI,CAAA,CAAA;AAAA,KACjB,MAAA,IAAW,QAAS,CAAA,MAAA,KAAW,GAAK,EAAA;AAClC,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,CAAA,OAAA,EAAU,QAAQ,CAAA,mCAAA,EAAsC,UAAU,CAAA,EAAA,CAAA;AAAA,OACpE,CAAA;AAAA,KACK,MAAA;AACL,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,CAAkC,+BAAA,EAAA,QAAQ,CAAO,IAAA,EAAA,UAAU,YACzD,QAAS,CAAA,MACX,CAAM,GAAA,EAAA,QAAA,CAAS,OAAO,MAAM,QAAA,CAAS,IAAK,EAAA,GAAI,SAAS,UAAU,CAAA,CAAA;AAAA,OACnE,CAAA;AAAA,KACF;AAAA,GACF;AACA,EAAA,OAAO,UAAW,CAAA,EAAE,OAAS,EAAA,KAAA,EAAO,CAAA,CAAA;AACtC,CAAA,CAAA;AAEO,MAAM,oCAA+D,CAAA;AAAA,EAI1E,WACkB,CAAA,MAAA,EACA,SACA,EAAA,MAAA,EACA,MAChB,UACA,EAAA;AALgB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA,CAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA,CAAA;AAGhB,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAAA,GACpD;AAAA,EAXQ,UAAA,CAAA;AAAA,EACS,UAAA,CAAA;AAAA,EAYjB,OAAO,UACL,CAAA,MAAA,EACA,OAMA,EAAA;AACA,IAAM,MAAA,UAAA,GAAa,OAAQ,CAAA,QAAA,CAAS,yBAA0B,CAAA;AAAA,MAC5D,SAAW,EAAA;AAAA,QACT,OAAS,EAAA,CAAA;AAAA,OACX;AAAA,MACA,OAAS,EAAA;AAAA,QACP,OAAS,EAAA,CAAA;AAAA,OACX;AAAA,KACD,CAAA,CAAA;AACD,IAAA,OAAO,IAAI,oCAAA;AAAA,MACT,MAAA;AAAA,MACA,OAAQ,CAAA,SAAA;AAAA,MACR,OAAQ,CAAA,MAAA;AAAA,MACR,OAAQ,CAAA,IAAA;AAAA,MACR,UAAA;AAAA,KACF,CAAA;AAAA,GACF;AAAA;AAAA,EAEA,eAAkB,GAAA;AAChB,IAAO,OAAA,CAAA,oCAAA,CAAA,CAAA;AAAA,GACT;AAAA;AAAA,EAGA,MAAM,QAAQ,UAAsC,EAAA;AAClD,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAO,OAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GAC/B;AAAA,EAEQ,iBACN,UACqB,EAAA;AACrB,IAAA,OAAO,YAAY;AACjB,MAAA,MAAM,MAAS,GAAA,CAAA,EAAG,IAAK,CAAA,eAAA,EAAiB,CAAA,QAAA,CAAA,CAAA;AACxC,MAAA,OAAO,WAAW,GAAI,CAAA;AAAA,QACpB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAM,MAAA,MAAA,GAAS,IAAK,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,YAC/B,KAAA,EACE,oCAAqC,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YAC7D,MAAA;AAAA,YACA,cAAA,EAAgBC,gBAAK,EAAG,EAAA;AAAA,WACzB,CAAA,CAAA;AACD,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA,CAAA;AAAA,mBAClB,KAAO,EAAA;AACd,YAAA,MAAA,CAAO,MAAM,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAC,mBAAmB,KAAK,CAAA,CAAA;AAAA,WAChE;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,QAAQ,MAAuB,EAAA;AACnC,IAAM,MAAA,cAAA,GAAiB,KAAK,MAAO,CAAA,cAAA;AAAA,MACjC,4CAAA;AAAA,KACF,CAAA;AACA,IAAM,MAAA,aAAA,GAAgB,KAAK,MAAO,CAAA,WAAA;AAAA,MAChC,oDAAA;AAAA,KACF,CAAA;AAEA,IAAA,MAAM,UAAa,GAAA;AAAA,MACjB,QAAU,EAAA;AAAA,QACR,IAAM,EAAA,gCAAA;AAAA,QACN,KAAO,EAAA,eAAA;AAAA,OACT;AAAA,MACA,IAAM,EAAA;AAAA,QACJ,SAAW,EAAA,YAAA;AAAA,QACX,KAAO,EAAA,WAAA;AAAA,OACT;AAAA,KACF,CAAA;AAEA,IAAO,MAAA,CAAA,IAAA,CAAK,CAAsB,mBAAA,EAAA,cAAc,CAAG,CAAA,CAAA,CAAA,CAAA;AACnD,IAAA,MAAM,cAAiB,GAAA;AAAA,MACrB,UAAY,EAAA,sBAAA;AAAA,MACZ,IAAM,EAAA,KAAA;AAAA,MACN,QAAU,EAAA;AAAA,QACR,WAAa,EAAA;AAAA,UACX,CAACC,gCAAmB,GAClB,6EAAA;AAAA,UACF,CAACC,uCAA0B,GACzB,6EAAA;AAAA,SACJ;AAAA,OACF;AAAA,MACA,IAAM,EAAA;AAAA,QACJ,IAAM,EAAA,SAAA;AAAA,QACN,YAAY,IAAK,CAAA,SAAA;AAAA,UACf,MAAM,SAAU,CAAA;AAAA,YACd,OAAS,EAAA,IAAA,CAAK,MAAO,CAAA,SAAA,CAAU,iBAAiB,CAAA;AAAA,YAChD,WAAW,IAAK,CAAA,SAAA;AAAA,YAChB,MAAM,IAAK,CAAA,IAAA;AAAA,YACX,OAAS,EAAA,cAAA;AAAA,YACT,MAAA;AAAA,WACD,CAAA;AAAA,SACH;AAAA,OACF;AAAA,KACF,CAAA;AAGA,IAAA,MAAM,YAAe,GAAAC,uBAAA,CAAO,KAAM,CAAA,UAAA,EAAY,aAAa,CAAA,CAAA;AAG3D,IAAA,MAAM,sBAAsBA,uBAAO,CAAA,KAAA;AAAA,MACjC,YAAA;AAAA,MACA,cAAA;AAAA,KACF,CAAA;AAEA,IAAM,MAAA,IAAA,CAAK,YAAY,aAAc,CAAA;AAAA,MACnC,IAAM,EAAA,MAAA;AAAA,MACN,QAAU,EAAA;AAAA,QACR;AAAA,UACE,MAAQ,EAAA,mBAAA;AAAA,UACR,WAAa,EAAA,kBAAA;AAAA,SACf;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF;;ACxQO,MAAM,uBAA0B,GAAA,gBAAA;AAKhC,MAAM,mCAAmCC,oCAAoB,CAAA;AAAA,EAClE,QAAU,EAAA,uBAAA;AAAA,EACV,QAAU,EAAA,SAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,OAAS,EAAAC,qCAAA;AAAA,QACT,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,MAAMA,6BAAa,CAAA,IAAA;AAAA,OACrB;AAAA,MACA,MAAM,KAAK,EAAE,OAAA,EAAS,QAAQ,SAAW,EAAA,SAAA,EAAW,MAAQ,EAAA,IAAA,EAAQ,EAAA;AAClE,QAAQ,OAAA,CAAA,iBAAA;AAAA,UACN,oCAAA,CAAqC,WAAW,MAAQ,EAAA;AAAA,YACtD,SAAA;AAAA,YACA,QAAU,EAAA,SAAA;AAAA,YACV,MAAA;AAAA,YACA,IAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/index.ts"],"sourcesContent":["/*\n * Copyright 2023 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 {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport { InternalOpenApiDocumentationProvider } from './InternalOpenApiDocumentationProvider';\n\n/**\n * @public\n */\nexport type MetaApiDocsPluginOptions = { exampleOption: boolean };\n\n/**\n * @public\n */\nexport const metaOpenApiDocsPluginId = 'meta-api-docs';\n\n/**\n * @public\n */\nexport const catalogModuleInternalOpenApiSpec = createBackendModule({\n  moduleId: metaOpenApiDocsPluginId,\n  pluginId: 'catalog',\n  register(env) {\n    env.registerInit({\n      deps: {\n        catalog: catalogProcessingExtensionPoint,\n        config: coreServices.rootConfig,\n        discovery: coreServices.discovery,\n        scheduler: coreServices.scheduler,\n        logger: coreServices.logger,\n        auth: coreServices.auth,\n      },\n      async init({ catalog, config, discovery, scheduler, logger, auth }) {\n        catalog.addEntityProvider(\n          InternalOpenApiDocumentationProvider.fromConfig(config, {\n            discovery,\n            schedule: scheduler,\n            logger,\n            auth,\n          }),\n        );\n      },\n    });\n  },\n});\n\nexport default catalogModuleInternalOpenApiSpec;\n"],"names":["createBackendModule","catalogProcessingExtensionPoint","coreServices","InternalOpenApiDocumentationProvider"],"mappings":";;;;;;;;AA+BO,MAAM,uBAA0B,GAAA,gBAAA;AAKhC,MAAM,mCAAmCA,oCAAoB,CAAA;AAAA,EAClE,QAAU,EAAA,uBAAA;AAAA,EACV,QAAU,EAAA,SAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,OAAS,EAAAC,qCAAA;AAAA,QACT,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,MAAMA,6BAAa,CAAA,IAAA;AAAA,OACrB;AAAA,MACA,MAAM,KAAK,EAAE,OAAA,EAAS,QAAQ,SAAW,EAAA,SAAA,EAAW,MAAQ,EAAA,IAAA,EAAQ,EAAA;AAClE,QAAQ,OAAA,CAAA,iBAAA;AAAA,UACNC,yEAAA,CAAqC,WAAW,MAAQ,EAAA;AAAA,YACtD,SAAA;AAAA,YACA,QAAU,EAAA,SAAA;AAAA,YACV,MAAA;AAAA,YACA,IAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-backstage-openapi",
-  "version": "0.4.1-next.0",
+  "version": "0.4.1-next.1",
   "backstage": {
     "role": "backend-plugin-module",
     "pluginId": "catalog",
@@ -33,19 +33,19 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-openapi-utils": "^0.1.19-next.0",
-    "@backstage/backend-plugin-api": "^1.0.1-next.0",
-    "@backstage/catalog-model": "^1.7.0",
-    "@backstage/config": "^1.2.0",
-    "@backstage/errors": "^1.2.4",
-    "@backstage/plugin-catalog-node": "^1.13.1-next.0",
+    "@backstage/backend-openapi-utils": "0.2.0-next.1",
+    "@backstage/backend-plugin-api": "1.0.1-next.1",
+    "@backstage/catalog-model": "1.7.0",
+    "@backstage/config": "1.2.0",
+    "@backstage/errors": "1.2.4",
+    "@backstage/plugin-catalog-node": "1.13.1-next.1",
     "cross-fetch": "^4.0.0",
     "lodash": "^4.17.21",
     "openapi-merge": "^1.3.2",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.28.0-next.0",
+    "@backstage/cli": "0.28.0-next.2",
     "openapi3-ts": "^3.1.2"
   },
   "configSchema": "config.d.ts"