@backstage/plugin-catalog-backend-module-backstage-openapi 0.1.6 → 0.1.7-next.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +28 -18
- package/dist/index.cjs.js +12 -16
- package/dist/index.cjs.js.map +1 -1
- package/package.json +25 -30
package/CHANGELOG.md
CHANGED
|
@@ -1,37 +1,47 @@
|
|
|
1
1
|
# @backstage/plugin-catalog-backend-module-backstage-openapi
|
|
2
2
|
|
|
3
|
-
## 0.1.
|
|
3
|
+
## 0.1.7-next.2
|
|
4
4
|
|
|
5
5
|
### Patch Changes
|
|
6
6
|
|
|
7
|
+
- 2bd1410: Removed unused dependencies
|
|
7
8
|
- Updated dependencies
|
|
8
|
-
- @backstage/
|
|
9
|
-
- @backstage/backend-
|
|
10
|
-
- @backstage/plugin-
|
|
11
|
-
- @backstage/backend-
|
|
12
|
-
- @backstage/
|
|
9
|
+
- @backstage/plugin-catalog-node@1.8.0-next.2
|
|
10
|
+
- @backstage/backend-openapi-utils@0.1.7-next.2
|
|
11
|
+
- @backstage/backend-plugin-api@0.6.14-next.2
|
|
12
|
+
- @backstage/backend-tasks@0.5.19-next.2
|
|
13
|
+
- @backstage/catalog-model@1.4.5-next.0
|
|
14
|
+
- @backstage/config@1.2.0-next.1
|
|
15
|
+
- @backstage/errors@1.2.4-next.0
|
|
13
16
|
|
|
14
|
-
## 0.1.
|
|
17
|
+
## 0.1.7-next.1
|
|
15
18
|
|
|
16
19
|
### Patch Changes
|
|
17
20
|
|
|
18
21
|
- Updated dependencies
|
|
19
|
-
- @backstage/
|
|
20
|
-
- @backstage/backend-
|
|
21
|
-
- @backstage/backend-plugin-api@0.6.
|
|
22
|
-
- @backstage/
|
|
23
|
-
- @backstage/backend-openapi-utils@0.1.
|
|
22
|
+
- @backstage/config@1.2.0-next.1
|
|
23
|
+
- @backstage/backend-common@0.21.4-next.1
|
|
24
|
+
- @backstage/backend-plugin-api@0.6.14-next.1
|
|
25
|
+
- @backstage/backend-tasks@0.5.19-next.1
|
|
26
|
+
- @backstage/backend-openapi-utils@0.1.7-next.1
|
|
27
|
+
- @backstage/catalog-model@1.4.5-next.0
|
|
28
|
+
- @backstage/errors@1.2.4-next.0
|
|
29
|
+
- @backstage/plugin-catalog-node@1.8.0-next.1
|
|
24
30
|
|
|
25
|
-
## 0.1.
|
|
31
|
+
## 0.1.6-next.0
|
|
26
32
|
|
|
27
33
|
### Patch Changes
|
|
28
34
|
|
|
35
|
+
- 43a9ae1: Migrated to use new auth service.
|
|
29
36
|
- Updated dependencies
|
|
30
|
-
- @backstage/backend-common@0.21.
|
|
31
|
-
- @backstage/
|
|
32
|
-
- @backstage/backend-plugin-api@0.6.
|
|
33
|
-
- @backstage/plugin-catalog-node@1.
|
|
34
|
-
- @backstage/backend-openapi-utils@0.1.
|
|
37
|
+
- @backstage/backend-common@0.21.3-next.0
|
|
38
|
+
- @backstage/errors@1.2.4-next.0
|
|
39
|
+
- @backstage/backend-plugin-api@0.6.13-next.0
|
|
40
|
+
- @backstage/plugin-catalog-node@1.8.0-next.0
|
|
41
|
+
- @backstage/backend-openapi-utils@0.1.6-next.0
|
|
42
|
+
- @backstage/backend-tasks@0.5.18-next.0
|
|
43
|
+
- @backstage/catalog-model@1.4.5-next.0
|
|
44
|
+
- @backstage/config@1.1.2-next.0
|
|
35
45
|
|
|
36
46
|
## 0.1.3
|
|
37
47
|
|
package/dist/index.cjs.js
CHANGED
|
@@ -104,13 +104,16 @@ const loadSpecs = async ({
|
|
|
104
104
|
discovery,
|
|
105
105
|
plugins,
|
|
106
106
|
logger,
|
|
107
|
-
|
|
107
|
+
auth
|
|
108
108
|
}) => {
|
|
109
109
|
const specs = [];
|
|
110
110
|
for (const pluginId of plugins) {
|
|
111
111
|
const url = await discovery.getExternalBaseUrl(pluginId);
|
|
112
112
|
const openApiUrl = backendOpenapiUtils.getOpenApiSpecRoute(url);
|
|
113
|
-
const { token } = await
|
|
113
|
+
const { token } = await auth.getPluginRequestToken({
|
|
114
|
+
onBehalfOf: await auth.getOwnServiceCredentials(),
|
|
115
|
+
targetPluginId: pluginId
|
|
116
|
+
});
|
|
114
117
|
const response = await fetch__default["default"](openApiUrl, {
|
|
115
118
|
method: "GET",
|
|
116
119
|
headers: {
|
|
@@ -134,11 +137,11 @@ const loadSpecs = async ({
|
|
|
134
137
|
return mergeSpecs({ baseUrl, specs });
|
|
135
138
|
};
|
|
136
139
|
class InternalOpenApiDocumentationProvider {
|
|
137
|
-
constructor(config, discovery, logger,
|
|
140
|
+
constructor(config, discovery, logger, auth, taskRunner) {
|
|
138
141
|
this.config = config;
|
|
139
142
|
this.discovery = discovery;
|
|
140
143
|
this.logger = logger;
|
|
141
|
-
this.
|
|
144
|
+
this.auth = auth;
|
|
142
145
|
__publicField(this, "connection");
|
|
143
146
|
__publicField(this, "scheduleFn");
|
|
144
147
|
this.scheduleFn = this.createScheduleFn(taskRunner);
|
|
@@ -156,7 +159,7 @@ class InternalOpenApiDocumentationProvider {
|
|
|
156
159
|
config,
|
|
157
160
|
options.discovery,
|
|
158
161
|
options.logger,
|
|
159
|
-
options.
|
|
162
|
+
options.auth,
|
|
160
163
|
taskRunner
|
|
161
164
|
);
|
|
162
165
|
}
|
|
@@ -214,7 +217,7 @@ class InternalOpenApiDocumentationProvider {
|
|
|
214
217
|
await loadSpecs({
|
|
215
218
|
baseUrl: this.config.getString("backend.baseUrl"),
|
|
216
219
|
discovery: this.discovery,
|
|
217
|
-
|
|
220
|
+
auth: this.auth,
|
|
218
221
|
plugins: pluginsToMerge,
|
|
219
222
|
logger
|
|
220
223
|
})
|
|
@@ -245,22 +248,15 @@ const catalogModuleInternalOpenApiSpec = backendPluginApi.createBackendModule({
|
|
|
245
248
|
discovery: backendPluginApi.coreServices.discovery,
|
|
246
249
|
scheduler: backendPluginApi.coreServices.scheduler,
|
|
247
250
|
logger: backendPluginApi.coreServices.logger,
|
|
248
|
-
|
|
251
|
+
auth: backendPluginApi.coreServices.auth
|
|
249
252
|
},
|
|
250
|
-
async init({
|
|
251
|
-
catalog,
|
|
252
|
-
config,
|
|
253
|
-
discovery,
|
|
254
|
-
scheduler,
|
|
255
|
-
logger,
|
|
256
|
-
tokenManager
|
|
257
|
-
}) {
|
|
253
|
+
async init({ catalog, config, discovery, scheduler, logger, auth }) {
|
|
258
254
|
catalog.addEntityProvider(
|
|
259
255
|
InternalOpenApiDocumentationProvider.fromConfig(config, {
|
|
260
256
|
discovery,
|
|
261
257
|
schedule: scheduler,
|
|
262
258
|
logger,
|
|
263
|
-
|
|
259
|
+
auth
|
|
264
260
|
})
|
|
265
261
|
);
|
|
266
262
|
}
|
package/dist/index.cjs.js.map
CHANGED
|
@@ -1 +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 */\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 { TokenManager } from '@backstage/backend-common';\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 { DiscoveryService, LoggerService } from '@backstage/backend-plugin-api';\nimport * as uuid from 'uuid';\nimport { PluginTaskScheduler, TaskRunner } from '@backstage/backend-tasks';\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 tokenManager,\n}: {\n baseUrl: string;\n plugins: string[];\n discovery: DiscoveryService;\n logger: LoggerService;\n tokenManager: TokenManager;\n}) => {\n const specs: OpenAPIObject[] = [];\n for (const pluginId of plugins) {\n const url = await discovery.getExternalBaseUrl(pluginId);\n const openApiUrl = getOpenApiSpecRoute(url);\n const { token } = await tokenManager.getToken();\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 constructor(\n public readonly config: Config,\n public readonly discovery: DiscoveryService,\n public readonly logger: LoggerService,\n public readonly tokenManager: TokenManager,\n taskRunner: TaskRunner,\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: PluginTaskScheduler;\n tokenManager: TokenManager;\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.tokenManager,\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(taskRunner: TaskRunner): () => 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 logger.info(`Loading specs from from ${pluginsToMerge}.`);\n const documentationEntity: ApiEntity = {\n apiVersion: 'backstage.io/v1beta1',\n kind: 'API',\n metadata: {\n name: 'INTERNAL_instance_openapi_doc',\n title: 'Your Backstage Instance documentation',\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 lifecycle: 'production',\n owner: 'backstage',\n definition: JSON.stringify(\n await loadSpecs({\n baseUrl: this.config.getString('backend.baseUrl'),\n discovery: this.discovery,\n tokenManager: this.tokenManager,\n plugins: pluginsToMerge,\n logger,\n }),\n ),\n },\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 */\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 tokenManager: coreServices.tokenManager,\n },\n async init({\n catalog,\n config,\n discovery,\n scheduler,\n logger,\n tokenManager,\n }) {\n catalog.addEntityProvider(\n InternalOpenApiDocumentationProvider.fromConfig(config, {\n discovery,\n schedule: scheduler,\n logger,\n tokenManager,\n }),\n );\n },\n });\n },\n});\n\nexport default catalogModuleInternalOpenApiSpec;\n"],"names":["merge","isErrorResult","ForwardedError","getOpenApiSpecRoute","fetch","uuid","ANNOTATION_LOCATION","ANNOTATION_ORIGIN_LOCATION","createBackendModule","catalogProcessingExtensionPoint","coreServices"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,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,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,IAAA,CAAA,KAAK,CAAE,CAAA,OAAA,CAAQ,CAAC,IAAyB,KAAA;AAC3D,IAAA,UAAA,CAAW,QAAQ,CAAQ,IAAA,KAAA;AApD/B,MAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAqDM,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,GAAE,EAAK,GAAA,IAAA,CAAA,IAAI,EAAsB,IAA/B,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAqC,SAAS,GAAM,CAAA,CAAA,EAAA;AACxD,UAAA,CAAC,EAAK,GAAA,IAAA,CAAA,IAAI,CAAsB,CAAA,IAAA,KAA/B,mBAAqC,IAAK,CAAA,GAAA,CAAA,CAAA;AAAA,SAC7C;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,YAAA;AACF,CAMM,KAAA;AACJ,EAAA,MAAM,QAAyB,EAAC,CAAA;AAChC,EAAA,KAAA,MAAW,YAAY,OAAS,EAAA;AAC9B,IAAA,MAAM,GAAM,GAAA,MAAM,SAAU,CAAA,kBAAA,CAAmB,QAAQ,CAAA,CAAA;AACvD,IAAM,MAAA,UAAA,GAAaC,wCAAoB,GAAG,CAAA,CAAA;AAC1C,IAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,aAAa,QAAS,EAAA,CAAA;AAC9C,IAAM,MAAA,QAAA,GAAW,MAAMC,yBAAA,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,EAG1E,WACkB,CAAA,MAAA,EACA,SACA,EAAA,MAAA,EACA,cAChB,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,YAAA,GAAA,YAAA,CAAA;AANlB,IAAQ,aAAA,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AACR,IAAiB,aAAA,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AAQf,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAAA,GACpD;AAAA,EAEA,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,YAAA;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,iBAAiB,UAA6C,EAAA;AACpE,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;AA3NvC,IAAA,IAAA,EAAA,CAAA;AA4NI,IAAM,MAAA,cAAA,GAAiB,KAAK,MAAO,CAAA,cAAA;AAAA,MACjC,4CAAA;AAAA,KACF,CAAA;AACA,IAAO,MAAA,CAAA,IAAA,CAAK,CAA2B,wBAAA,EAAA,cAAc,CAAG,CAAA,CAAA,CAAA,CAAA;AACxD,IAAA,MAAM,mBAAiC,GAAA;AAAA,MACrC,UAAY,EAAA,sBAAA;AAAA,MACZ,IAAM,EAAA,KAAA;AAAA,MACN,QAAU,EAAA;AAAA,QACR,IAAM,EAAA,+BAAA;AAAA,QACN,KAAO,EAAA,uCAAA;AAAA,QACP,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,SAAW,EAAA,YAAA;AAAA,QACX,KAAO,EAAA,WAAA;AAAA,QACP,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,cAAc,IAAK,CAAA,YAAA;AAAA,YACnB,OAAS,EAAA,cAAA;AAAA,YACT,MAAA;AAAA,WACD,CAAA;AAAA,SACH;AAAA,OACF;AAAA,KACF,CAAA;AACA,IAAM,OAAA,CAAA,EAAA,GAAA,IAAA,CAAK,UAAL,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAiB,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,KACF,CAAA,CAAA,CAAA;AAAA,GACF;AACF;;ACxOO,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,cAAcA,6BAAa,CAAA,YAAA;AAAA,OAC7B;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,OAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,MAAA;AAAA,QACA,YAAA;AAAA,OACC,EAAA;AACD,QAAQ,OAAA,CAAA,iBAAA;AAAA,UACN,oCAAA,CAAqC,WAAW,MAAQ,EAAA;AAAA,YACtD,SAAA;AAAA,YACA,QAAU,EAAA,SAAA;AAAA,YACV,MAAA;AAAA,YACA,YAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;;"}
|
|
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} from '@backstage/backend-plugin-api';\nimport * as uuid from 'uuid';\nimport { PluginTaskScheduler, TaskRunner } from '@backstage/backend-tasks';\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.getExternalBaseUrl(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: TaskRunner,\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: PluginTaskScheduler;\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(taskRunner: TaskRunner): () => 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 logger.info(`Loading specs from from ${pluginsToMerge}.`);\n const documentationEntity: ApiEntity = {\n apiVersion: 'backstage.io/v1beta1',\n kind: 'API',\n metadata: {\n name: 'INTERNAL_instance_openapi_doc',\n title: 'Your Backstage Instance documentation',\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 lifecycle: 'production',\n owner: 'backstage',\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 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","createBackendModule","catalogProcessingExtensionPoint","coreServices"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CA,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,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,IAAA,CAAA,KAAK,CAAE,CAAA,OAAA,CAAQ,CAAC,IAAyB,KAAA;AAC3D,IAAA,UAAA,CAAW,QAAQ,CAAQ,IAAA,KAAA;AAxD/B,MAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAyDM,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,GAAE,EAAK,GAAA,IAAA,CAAA,IAAI,EAAsB,IAA/B,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAqC,SAAS,GAAM,CAAA,CAAA,EAAA;AACxD,UAAA,CAAC,EAAK,GAAA,IAAA,CAAA,IAAI,CAAsB,CAAA,IAAA,KAA/B,mBAAqC,IAAK,CAAA,GAAA,CAAA,CAAA;AAAA,SAC7C;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,kBAAA,CAAmB,QAAQ,CAAA,CAAA;AACvD,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,yBAAA,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;AAPlB,IAAQ,aAAA,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AACR,IAAiB,aAAA,CAAA,IAAA,EAAA,YAAA,CAAA,CAAA;AASf,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAAA,GACpD;AAAA,EAEA,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,iBAAiB,UAA6C,EAAA;AACpE,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;AAnOvC,IAAA,IAAA,EAAA,CAAA;AAoOI,IAAM,MAAA,cAAA,GAAiB,KAAK,MAAO,CAAA,cAAA;AAAA,MACjC,4CAAA;AAAA,KACF,CAAA;AACA,IAAO,MAAA,CAAA,IAAA,CAAK,CAA2B,wBAAA,EAAA,cAAc,CAAG,CAAA,CAAA,CAAA,CAAA;AACxD,IAAA,MAAM,mBAAiC,GAAA;AAAA,MACrC,UAAY,EAAA,sBAAA;AAAA,MACZ,IAAM,EAAA,KAAA;AAAA,MACN,QAAU,EAAA;AAAA,QACR,IAAM,EAAA,+BAAA;AAAA,QACN,KAAO,EAAA,uCAAA;AAAA,QACP,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,SAAW,EAAA,YAAA;AAAA,QACX,KAAO,EAAA,WAAA;AAAA,QACP,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;AACA,IAAM,OAAA,CAAA,EAAA,GAAA,IAAA,CAAK,UAAL,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAiB,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,KACF,CAAA,CAAA,CAAA;AAAA,GACF;AACF;;AC/OO,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;;;;;;"}
|
package/package.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-catalog-backend-module-backstage-openapi",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"
|
|
5
|
-
|
|
6
|
-
|
|
3
|
+
"version": "0.1.7-next.2",
|
|
4
|
+
"backstage": {
|
|
5
|
+
"role": "backend-plugin-module"
|
|
6
|
+
},
|
|
7
7
|
"publishConfig": {
|
|
8
8
|
"access": "public",
|
|
9
9
|
"main": "dist/index.cjs.js",
|
|
@@ -14,42 +14,37 @@
|
|
|
14
14
|
"url": "https://github.com/backstage/backstage",
|
|
15
15
|
"directory": "plugins/catalog-backend-module-backstage-openapi"
|
|
16
16
|
},
|
|
17
|
-
"
|
|
18
|
-
|
|
19
|
-
|
|
17
|
+
"license": "Apache-2.0",
|
|
18
|
+
"main": "dist/index.cjs.js",
|
|
19
|
+
"types": "dist/index.d.ts",
|
|
20
|
+
"files": [
|
|
21
|
+
"dist",
|
|
22
|
+
"config.d.ts"
|
|
23
|
+
],
|
|
20
24
|
"scripts": {
|
|
21
|
-
"start": "backstage-cli package start",
|
|
22
25
|
"build": "backstage-cli package build",
|
|
23
|
-
"lint": "backstage-cli package lint",
|
|
24
|
-
"test": "backstage-cli package test",
|
|
25
26
|
"clean": "backstage-cli package clean",
|
|
27
|
+
"lint": "backstage-cli package lint",
|
|
26
28
|
"prepack": "backstage-cli package prepack",
|
|
27
|
-
"postpack": "backstage-cli package postpack"
|
|
29
|
+
"postpack": "backstage-cli package postpack",
|
|
30
|
+
"start": "backstage-cli package start",
|
|
31
|
+
"test": "backstage-cli package test"
|
|
28
32
|
},
|
|
29
33
|
"dependencies": {
|
|
30
|
-
"@backstage/backend-
|
|
31
|
-
"@backstage/backend-
|
|
32
|
-
"@backstage/backend-
|
|
33
|
-
"@backstage/
|
|
34
|
-
"@backstage/
|
|
35
|
-
"@backstage/
|
|
36
|
-
"@backstage/
|
|
37
|
-
"@backstage/plugin-catalog-node": "^1.7.3",
|
|
34
|
+
"@backstage/backend-openapi-utils": "^0.1.7-next.2",
|
|
35
|
+
"@backstage/backend-plugin-api": "^0.6.14-next.2",
|
|
36
|
+
"@backstage/backend-tasks": "^0.5.19-next.2",
|
|
37
|
+
"@backstage/catalog-model": "^1.4.5-next.0",
|
|
38
|
+
"@backstage/config": "^1.2.0-next.1",
|
|
39
|
+
"@backstage/errors": "^1.2.4-next.0",
|
|
40
|
+
"@backstage/plugin-catalog-node": "^1.8.0-next.2",
|
|
38
41
|
"cross-fetch": "^4.0.0",
|
|
39
|
-
"lodash": "^4.17.21",
|
|
40
42
|
"openapi-merge": "^1.3.2",
|
|
41
|
-
"uuid": "^9.0.0"
|
|
42
|
-
"yn": "^4.0.0"
|
|
43
|
+
"uuid": "^9.0.0"
|
|
43
44
|
},
|
|
44
45
|
"devDependencies": {
|
|
45
|
-
"@backstage/cli": "^0.25.2",
|
|
46
|
-
"@types/express": "*",
|
|
47
|
-
"@types/supertest": "^2.0.8",
|
|
46
|
+
"@backstage/cli": "^0.25.3-next.2",
|
|
48
47
|
"openapi3-ts": "^3.1.2"
|
|
49
48
|
},
|
|
50
|
-
"configSchema": "config.d.ts"
|
|
51
|
-
"files": [
|
|
52
|
-
"dist",
|
|
53
|
-
"config.d.ts"
|
|
54
|
-
]
|
|
49
|
+
"configSchema": "config.d.ts"
|
|
55
50
|
}
|