@backstage/plugin-search-backend-module-techdocs 0.1.17-next.0 → 0.1.17

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.
Files changed (8) hide show
  1. package/CHANGELOG.md +31 -14
  2. package/alpha/package.json +1 -1
  3. package/dist/alpha.cjs.js +0 -6
  4. package/dist/alpha.cjs.js.map +1 -1
  5. package/dist/index.cjs.js +5 -17
  6. package/dist/index.cjs.js.map +1 -1
  7. package/dist/index.d.ts +1 -4
  8. package/package.json +35 -35
package/CHANGELOG.md CHANGED
@@ -1,23 +1,40 @@
1
1
  # @backstage/plugin-search-backend-module-techdocs
2
2
 
3
- ## 0.1.17-next.0
3
+ ## 0.1.17
4
4
 
5
5
  ### Patch Changes
6
6
 
7
- - bb368a5: Migrated to support new auth services.
8
7
  - Updated dependencies
9
- - @backstage/backend-common@0.21.3-next.0
10
- - @backstage/backend-plugin-api@0.6.13-next.0
11
- - @backstage/plugin-techdocs-node@1.11.5-next.0
12
- - @backstage/plugin-permission-common@0.7.13-next.0
13
- - @backstage/plugin-search-common@1.2.11-next.0
14
- - @backstage/plugin-catalog-node@1.8.0-next.0
15
- - @backstage/backend-tasks@0.5.18-next.0
16
- - @backstage/plugin-search-backend-node@1.2.17-next.0
17
- - @backstage/catalog-client@1.6.1-next.0
18
- - @backstage/catalog-model@1.4.5-next.0
19
- - @backstage/config@1.1.2-next.0
20
- - @backstage/plugin-catalog-common@1.0.22-next.0
8
+ - @backstage/backend-common@0.21.3
9
+ - @backstage/backend-tasks@0.5.18
10
+ - @backstage/plugin-search-backend-node@1.2.17
11
+ - @backstage/plugin-techdocs-node@1.11.5
12
+ - @backstage/plugin-catalog-node@1.7.3
13
+ - @backstage/backend-plugin-api@0.6.13
14
+
15
+ ## 0.1.16
16
+
17
+ ### Patch Changes
18
+
19
+ - Updated dependencies
20
+ - @backstage/backend-common@0.21.2
21
+ - @backstage/backend-tasks@0.5.17
22
+ - @backstage/plugin-search-backend-node@1.2.16
23
+ - @backstage/plugin-techdocs-node@1.11.4
24
+ - @backstage/backend-plugin-api@0.6.12
25
+ - @backstage/plugin-catalog-node@1.7.2
26
+
27
+ ## 0.1.15
28
+
29
+ ### Patch Changes
30
+
31
+ - Updated dependencies
32
+ - @backstage/backend-common@0.21.1
33
+ - @backstage/backend-tasks@0.5.16
34
+ - @backstage/plugin-search-backend-node@1.2.15
35
+ - @backstage/plugin-techdocs-node@1.11.3
36
+ - @backstage/backend-plugin-api@0.6.11
37
+ - @backstage/plugin-catalog-node@1.7.1
21
38
 
22
39
  ## 0.1.14
23
40
 
package/alpha/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-search-backend-module-techdocs",
3
- "version": "0.1.17-next.0",
3
+ "version": "0.1.17",
4
4
  "main": "../dist/alpha.cjs.js",
5
5
  "types": "../dist/alpha.d.ts"
6
6
  }
package/dist/alpha.cjs.js CHANGED
@@ -34,8 +34,6 @@ var alpha = backendPluginApi.createBackendModule({
34
34
  deps: {
35
35
  config: backendPluginApi.coreServices.rootConfig,
36
36
  logger: backendPluginApi.coreServices.logger,
37
- auth: backendPluginApi.coreServices.auth,
38
- httpAuth: backendPluginApi.coreServices.httpAuth,
39
37
  discovery: backendPluginApi.coreServices.discovery,
40
38
  tokenManager: backendPluginApi.coreServices.tokenManager,
41
39
  scheduler: backendPluginApi.coreServices.scheduler,
@@ -45,8 +43,6 @@ var alpha = backendPluginApi.createBackendModule({
45
43
  async init({
46
44
  config,
47
45
  logger,
48
- auth,
49
- httpAuth,
50
46
  discovery,
51
47
  tokenManager,
52
48
  scheduler,
@@ -66,8 +62,6 @@ var alpha = backendPluginApi.createBackendModule({
66
62
  factory: pluginSearchBackendModuleTechdocs.DefaultTechDocsCollatorFactory.fromConfig(config, {
67
63
  discovery,
68
64
  tokenManager,
69
- auth,
70
- httpAuth,
71
65
  logger: backendCommon.loggerToWinstonLogger(logger),
72
66
  catalogClient: catalog,
73
67
  entityTransformer: transformer
package/dist/alpha.cjs.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.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\n/**\n * @packageDocumentation\n * A module for the search backend that exports TechDocs modules.\n */\n\nimport { loggerToWinstonLogger } from '@backstage/backend-common';\nimport {\n coreServices,\n createBackendModule,\n createExtensionPoint,\n} from '@backstage/backend-plugin-api';\nimport { readTaskScheduleDefinitionFromConfig } from '@backstage/backend-tasks';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\nimport { DefaultTechDocsCollatorFactory } from '@backstage/plugin-search-backend-module-techdocs';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\nimport { TechDocsCollatorEntityTransformer } from '@backstage/plugin-search-backend-module-techdocs';\n\n/** @alpha */\nexport interface TechDocsCollatorEntityTransformerExtensionPoint {\n setTransformer(transformer: TechDocsCollatorEntityTransformer): void;\n}\n\n/**\n * Extension point used to customize the TechDocs collator entity transformer.\n *\n * @alpha\n */\nexport const techdocsCollatorEntityTransformerExtensionPoint =\n createExtensionPoint<TechDocsCollatorEntityTransformerExtensionPoint>({\n id: 'search.techdocsCollator.transformer',\n });\n\n/**\n * @alpha\n * Search backend module for the TechDocs index.\n */\nexport default createBackendModule({\n pluginId: 'search',\n moduleId: 'techdocs-collator',\n register(env) {\n let transformer: TechDocsCollatorEntityTransformer | undefined;\n\n env.registerExtensionPoint(\n techdocsCollatorEntityTransformerExtensionPoint,\n {\n setTransformer(newTransformer) {\n if (transformer) {\n throw new Error(\n 'TechDocs collator entity transformer may only be set once',\n );\n }\n transformer = newTransformer;\n },\n },\n );\n\n env.registerInit({\n deps: {\n config: coreServices.rootConfig,\n logger: coreServices.logger,\n auth: coreServices.auth,\n httpAuth: coreServices.httpAuth,\n discovery: coreServices.discovery,\n tokenManager: coreServices.tokenManager,\n scheduler: coreServices.scheduler,\n catalog: catalogServiceRef,\n indexRegistry: searchIndexRegistryExtensionPoint,\n },\n async init({\n config,\n logger,\n auth,\n httpAuth,\n discovery,\n tokenManager,\n scheduler,\n catalog,\n indexRegistry,\n }) {\n const defaultSchedule = {\n frequency: { minutes: 10 },\n timeout: { minutes: 15 },\n initialDelay: { seconds: 3 },\n };\n\n const schedule = config.has('search.collators.techdocs.schedule')\n ? readTaskScheduleDefinitionFromConfig(\n config.getConfig('search.collators.techdocs.schedule'),\n )\n : defaultSchedule;\n\n indexRegistry.addCollator({\n schedule: scheduler.createScheduledTaskRunner(schedule),\n factory: DefaultTechDocsCollatorFactory.fromConfig(config, {\n discovery,\n tokenManager,\n auth,\n httpAuth,\n logger: loggerToWinstonLogger(logger),\n catalogClient: catalog,\n entityTransformer: transformer,\n }),\n });\n },\n });\n },\n});\n"],"names":["createExtensionPoint","createBackendModule","coreServices","catalogServiceRef","searchIndexRegistryExtensionPoint","readTaskScheduleDefinitionFromConfig","DefaultTechDocsCollatorFactory","loggerToWinstonLogger"],"mappings":";;;;;;;;;;;AA2CO,MAAM,kDACXA,qCAAsE,CAAA;AAAA,EACpE,EAAI,EAAA,qCAAA;AACN,CAAC,EAAA;AAMH,YAAeC,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,mBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,WAAA,CAAA;AAEJ,IAAI,GAAA,CAAA,sBAAA;AAAA,MACF,+CAAA;AAAA,MACA;AAAA,QACE,eAAe,cAAgB,EAAA;AAC7B,UAAA,IAAI,WAAa,EAAA;AACf,YAAA,MAAM,IAAI,KAAA;AAAA,cACR,2DAAA;AAAA,aACF,CAAA;AAAA,WACF;AACA,UAAc,WAAA,GAAA,cAAA,CAAA;AAAA,SAChB;AAAA,OACF;AAAA,KACF,CAAA;AAEA,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,MAAMA,6BAAa,CAAA,IAAA;AAAA,QACnB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,cAAcA,6BAAa,CAAA,YAAA;AAAA,QAC3B,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,OAAS,EAAAC,yBAAA;AAAA,QACT,aAAe,EAAAC,yCAAA;AAAA,OACjB;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,MAAA;AAAA,QACA,MAAA;AAAA,QACA,IAAA;AAAA,QACA,QAAA;AAAA,QACA,SAAA;AAAA,QACA,YAAA;AAAA,QACA,SAAA;AAAA,QACA,OAAA;AAAA,QACA,aAAA;AAAA,OACC,EAAA;AACD,QAAA,MAAM,eAAkB,GAAA;AAAA,UACtB,SAAA,EAAW,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,UACzB,OAAA,EAAS,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,UACvB,YAAA,EAAc,EAAE,OAAA,EAAS,CAAE,EAAA;AAAA,SAC7B,CAAA;AAEA,QAAA,MAAM,QAAW,GAAA,MAAA,CAAO,GAAI,CAAA,oCAAoC,CAC5D,GAAAC,iDAAA;AAAA,UACE,MAAA,CAAO,UAAU,oCAAoC,CAAA;AAAA,SAEvD,GAAA,eAAA,CAAA;AAEJ,QAAA,aAAA,CAAc,WAAY,CAAA;AAAA,UACxB,QAAA,EAAU,SAAU,CAAA,yBAAA,CAA0B,QAAQ,CAAA;AAAA,UACtD,OAAA,EAASC,gEAA+B,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,YACzD,SAAA;AAAA,YACA,YAAA;AAAA,YACA,IAAA;AAAA,YACA,QAAA;AAAA,YACA,MAAA,EAAQC,oCAAsB,MAAM,CAAA;AAAA,YACpC,aAAe,EAAA,OAAA;AAAA,YACf,iBAAmB,EAAA,WAAA;AAAA,WACpB,CAAA;AAAA,SACF,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC,CAAA;;;;;"}
1
+ {"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.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\n/**\n * @packageDocumentation\n * A module for the search backend that exports TechDocs modules.\n */\n\nimport { loggerToWinstonLogger } from '@backstage/backend-common';\nimport {\n coreServices,\n createBackendModule,\n createExtensionPoint,\n} from '@backstage/backend-plugin-api';\nimport { readTaskScheduleDefinitionFromConfig } from '@backstage/backend-tasks';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\nimport { DefaultTechDocsCollatorFactory } from '@backstage/plugin-search-backend-module-techdocs';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\nimport { TechDocsCollatorEntityTransformer } from '@backstage/plugin-search-backend-module-techdocs';\n\n/** @alpha */\nexport interface TechDocsCollatorEntityTransformerExtensionPoint {\n setTransformer(transformer: TechDocsCollatorEntityTransformer): void;\n}\n\n/**\n * Extension point used to customize the TechDocs collator entity transformer.\n *\n * @alpha\n */\nexport const techdocsCollatorEntityTransformerExtensionPoint =\n createExtensionPoint<TechDocsCollatorEntityTransformerExtensionPoint>({\n id: 'search.techdocsCollator.transformer',\n });\n\n/**\n * @alpha\n * Search backend module for the TechDocs index.\n */\nexport default createBackendModule({\n pluginId: 'search',\n moduleId: 'techdocs-collator',\n register(env) {\n let transformer: TechDocsCollatorEntityTransformer | undefined;\n\n env.registerExtensionPoint(\n techdocsCollatorEntityTransformerExtensionPoint,\n {\n setTransformer(newTransformer) {\n if (transformer) {\n throw new Error(\n 'TechDocs collator entity transformer may only be set once',\n );\n }\n transformer = newTransformer;\n },\n },\n );\n\n env.registerInit({\n deps: {\n config: coreServices.rootConfig,\n logger: coreServices.logger,\n discovery: coreServices.discovery,\n tokenManager: coreServices.tokenManager,\n scheduler: coreServices.scheduler,\n catalog: catalogServiceRef,\n indexRegistry: searchIndexRegistryExtensionPoint,\n },\n async init({\n config,\n logger,\n discovery,\n tokenManager,\n scheduler,\n catalog,\n indexRegistry,\n }) {\n const defaultSchedule = {\n frequency: { minutes: 10 },\n timeout: { minutes: 15 },\n initialDelay: { seconds: 3 },\n };\n\n const schedule = config.has('search.collators.techdocs.schedule')\n ? readTaskScheduleDefinitionFromConfig(\n config.getConfig('search.collators.techdocs.schedule'),\n )\n : defaultSchedule;\n\n indexRegistry.addCollator({\n schedule: scheduler.createScheduledTaskRunner(schedule),\n factory: DefaultTechDocsCollatorFactory.fromConfig(config, {\n discovery,\n tokenManager,\n logger: loggerToWinstonLogger(logger),\n catalogClient: catalog,\n entityTransformer: transformer,\n }),\n });\n },\n });\n },\n});\n"],"names":["createExtensionPoint","createBackendModule","coreServices","catalogServiceRef","searchIndexRegistryExtensionPoint","readTaskScheduleDefinitionFromConfig","DefaultTechDocsCollatorFactory","loggerToWinstonLogger"],"mappings":";;;;;;;;;;;AA2CO,MAAM,kDACXA,qCAAsE,CAAA;AAAA,EACpE,EAAI,EAAA,qCAAA;AACN,CAAC,EAAA;AAMH,YAAeC,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,mBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,WAAA,CAAA;AAEJ,IAAI,GAAA,CAAA,sBAAA;AAAA,MACF,+CAAA;AAAA,MACA;AAAA,QACE,eAAe,cAAgB,EAAA;AAC7B,UAAA,IAAI,WAAa,EAAA;AACf,YAAA,MAAM,IAAI,KAAA;AAAA,cACR,2DAAA;AAAA,aACF,CAAA;AAAA,WACF;AACA,UAAc,WAAA,GAAA,cAAA,CAAA;AAAA,SAChB;AAAA,OACF;AAAA,KACF,CAAA;AAEA,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,cAAcA,6BAAa,CAAA,YAAA;AAAA,QAC3B,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,OAAS,EAAAC,yBAAA;AAAA,QACT,aAAe,EAAAC,yCAAA;AAAA,OACjB;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,MAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,YAAA;AAAA,QACA,SAAA;AAAA,QACA,OAAA;AAAA,QACA,aAAA;AAAA,OACC,EAAA;AACD,QAAA,MAAM,eAAkB,GAAA;AAAA,UACtB,SAAA,EAAW,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,UACzB,OAAA,EAAS,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,UACvB,YAAA,EAAc,EAAE,OAAA,EAAS,CAAE,EAAA;AAAA,SAC7B,CAAA;AAEA,QAAA,MAAM,QAAW,GAAA,MAAA,CAAO,GAAI,CAAA,oCAAoC,CAC5D,GAAAC,iDAAA;AAAA,UACE,MAAA,CAAO,UAAU,oCAAoC,CAAA;AAAA,SAEvD,GAAA,eAAA,CAAA;AAEJ,QAAA,aAAA,CAAc,WAAY,CAAA;AAAA,UACxB,QAAA,EAAU,SAAU,CAAA,yBAAA,CAA0B,QAAQ,CAAA;AAAA,UACtD,OAAA,EAASC,gEAA+B,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,YACzD,SAAA;AAAA,YACA,YAAA;AAAA,YACA,MAAA,EAAQC,oCAAsB,MAAM,CAAA;AAAA,YACpC,aAAe,EAAA,OAAA;AAAA,YACf,iBAAmB,EAAA,WAAA;AAAA,WACpB,CAAA;AAAA,SACF,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC,CAAA;;;;;"}
package/dist/index.cjs.js CHANGED
@@ -2,7 +2,6 @@
2
2
 
3
3
  Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
- var backendCommon = require('@backstage/backend-common');
6
5
  var catalogClient = require('@backstage/catalog-client');
7
6
  var catalogModel = require('@backstage/catalog-model');
8
7
  var alpha = require('@backstage/plugin-catalog-common/alpha');
@@ -63,8 +62,8 @@ class DefaultTechDocsCollatorFactory {
63
62
  __publicField(this, "discovery");
64
63
  __publicField(this, "locationTemplate");
65
64
  __publicField(this, "logger");
66
- __publicField(this, "auth");
67
65
  __publicField(this, "catalogClient");
66
+ __publicField(this, "tokenManager");
68
67
  __publicField(this, "parallelismLimit");
69
68
  __publicField(this, "legacyPathCasing");
70
69
  __publicField(this, "entityTransformer");
@@ -75,12 +74,8 @@ class DefaultTechDocsCollatorFactory {
75
74
  this.catalogClient = options.catalogClient || new catalogClient.CatalogClient({ discoveryApi: options.discovery });
76
75
  this.parallelismLimit = (_a = options.parallelismLimit) != null ? _a : 10;
77
76
  this.legacyPathCasing = (_b = options.legacyPathCasing) != null ? _b : false;
77
+ this.tokenManager = options.tokenManager;
78
78
  this.entityTransformer = (_c = options.entityTransformer) != null ? _c : defaultTechDocsCollatorEntityTransformer;
79
- this.auth = backendCommon.createLegacyAuthAdapters({
80
- auth: options.auth,
81
- discovery: options.discovery,
82
- tokenManager: options.tokenManager
83
- }).auth;
84
79
  }
85
80
  static fromConfig(config, options) {
86
81
  const legacyPathCasing = config.getOptionalBoolean(
@@ -105,14 +100,11 @@ class DefaultTechDocsCollatorFactory {
105
100
  async *execute() {
106
101
  const limit = pLimit__default["default"](this.parallelismLimit);
107
102
  const techDocsBaseUrl = await this.discovery.getBaseUrl("techdocs");
103
+ const { token } = await this.tokenManager.getToken();
108
104
  let entitiesRetrieved = 0;
109
105
  let moreEntitiesToGet = true;
110
106
  const batchSize = this.parallelismLimit * 50;
111
107
  while (moreEntitiesToGet) {
112
- const { token: catalogToken } = await this.auth.getPluginRequestToken({
113
- onBehalfOf: await this.auth.getOwnServiceCredentials(),
114
- targetPluginId: "catalog"
115
- });
116
108
  const entities = (await this.catalogClient.getEntities(
117
109
  {
118
110
  filter: {
@@ -121,7 +113,7 @@ class DefaultTechDocsCollatorFactory {
121
113
  limit: batchSize,
122
114
  offset: entitiesRetrieved
123
115
  },
124
- { token: catalogToken }
116
+ { token }
125
117
  )).items;
126
118
  moreEntitiesToGet = entities.length === batchSize;
127
119
  entitiesRetrieved += entities.length;
@@ -139,10 +131,6 @@ class DefaultTechDocsCollatorFactory {
139
131
  }
140
132
  );
141
133
  try {
142
- const { token: techdocsToken } = await this.auth.getPluginRequestToken({
143
- onBehalfOf: await this.auth.getOwnServiceCredentials(),
144
- targetPluginId: "techdocs"
145
- });
146
134
  const searchIndexResponse = await fetch__default["default"](
147
135
  DefaultTechDocsCollatorFactory.constructDocsIndexUrl(
148
136
  techDocsBaseUrl,
@@ -150,7 +138,7 @@ class DefaultTechDocsCollatorFactory {
150
138
  ),
151
139
  {
152
140
  headers: {
153
- Authorization: `Bearer ${techdocsToken}`
141
+ Authorization: `Bearer ${token}`
154
142
  }
155
143
  }
156
144
  );
package/dist/index.cjs.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs.js","sources":["../src/collators/defaultTechDocsCollatorEntityTransformer.ts","../src/collators/DefaultTechDocsCollatorFactory.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 { Entity, isGroupEntity, isUserEntity } from '@backstage/catalog-model';\nimport { TechDocsCollatorEntityTransformer } from './TechDocsCollatorEntityTransformer';\n\nconst getDocumentText = (entity: Entity): string => {\n const documentTexts: string[] = [];\n documentTexts.push(entity.metadata.description || '');\n\n if (isUserEntity(entity) || isGroupEntity(entity)) {\n if (entity.spec?.profile?.displayName) {\n documentTexts.push(entity.spec.profile.displayName);\n }\n }\n\n if (isUserEntity(entity)) {\n if (entity.spec?.profile?.email) {\n documentTexts.push(entity.spec.profile.email);\n }\n }\n\n return documentTexts.join(' : ');\n};\n\n/** @public */\nexport const defaultTechDocsCollatorEntityTransformer: TechDocsCollatorEntityTransformer =\n (entity: Entity) => {\n return {\n kind: entity.kind,\n namespace: entity.metadata.namespace || 'default',\n annotations: entity.metadata.annotations || '',\n name: entity.metadata.name || '',\n title: entity.metadata.title || '',\n text: getDocumentText(entity),\n componentType: entity.spec?.type?.toString() || 'other',\n type: entity.spec?.type?.toString() || 'other',\n lifecycle: (entity.spec?.lifecycle as string) || '',\n owner: (entity.spec?.owner as string) || '',\n path: '',\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 PluginEndpointDiscovery,\n TokenManager,\n createLegacyAuthAdapters,\n} from '@backstage/backend-common';\nimport {\n CatalogApi,\n CatalogClient,\n CATALOG_FILTER_EXISTS,\n} from '@backstage/catalog-client';\nimport {\n Entity,\n parseEntityRef,\n RELATION_OWNED_BY,\n stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { catalogEntityReadPermission } from '@backstage/plugin-catalog-common/alpha';\nimport { Permission } from '@backstage/plugin-permission-common';\nimport { DocumentCollatorFactory } from '@backstage/plugin-search-common';\nimport { TechDocsDocument } from '@backstage/plugin-techdocs-node';\nimport unescape from 'lodash/unescape';\nimport fetch from 'node-fetch';\nimport pLimit from 'p-limit';\nimport { Readable } from 'stream';\nimport { Logger } from 'winston';\nimport { TechDocsCollatorEntityTransformer } from './TechDocsCollatorEntityTransformer';\nimport { defaultTechDocsCollatorEntityTransformer } from './defaultTechDocsCollatorEntityTransformer';\nimport { AuthService, HttpAuthService } from '@backstage/backend-plugin-api';\n\ninterface MkSearchIndexDoc {\n title: string;\n text: string;\n location: string;\n}\n\n/**\n * Options to configure the TechDocs collator factory\n *\n * @public\n */\nexport type TechDocsCollatorFactoryOptions = {\n discovery: PluginEndpointDiscovery;\n logger: Logger;\n tokenManager: TokenManager;\n auth?: AuthService;\n httpAuth?: HttpAuthService;\n locationTemplate?: string;\n catalogClient?: CatalogApi;\n parallelismLimit?: number;\n legacyPathCasing?: boolean;\n entityTransformer?: TechDocsCollatorEntityTransformer;\n};\n\ntype EntityInfo = {\n name: string;\n namespace: string;\n kind: string;\n};\n\n/**\n * A search collator factory responsible for gathering and transforming\n * TechDocs documents.\n *\n * @public\n */\nexport class DefaultTechDocsCollatorFactory implements DocumentCollatorFactory {\n public readonly type: string = 'techdocs';\n public readonly visibilityPermission: Permission =\n catalogEntityReadPermission;\n\n private discovery: PluginEndpointDiscovery;\n private locationTemplate: string;\n private readonly logger: Logger;\n private readonly auth: AuthService;\n private readonly catalogClient: CatalogApi;\n private readonly parallelismLimit: number;\n private readonly legacyPathCasing: boolean;\n private entityTransformer: TechDocsCollatorEntityTransformer;\n\n private constructor(options: TechDocsCollatorFactoryOptions) {\n this.discovery = options.discovery;\n this.locationTemplate =\n options.locationTemplate || '/docs/:namespace/:kind/:name/:path';\n this.logger = options.logger.child({ documentType: this.type });\n this.catalogClient =\n options.catalogClient ||\n new CatalogClient({ discoveryApi: options.discovery });\n this.parallelismLimit = options.parallelismLimit ?? 10;\n this.legacyPathCasing = options.legacyPathCasing ?? false;\n this.entityTransformer =\n options.entityTransformer ?? defaultTechDocsCollatorEntityTransformer;\n\n this.auth = createLegacyAuthAdapters({\n auth: options.auth,\n discovery: options.discovery,\n tokenManager: options.tokenManager,\n }).auth;\n }\n\n static fromConfig(config: Config, options: TechDocsCollatorFactoryOptions) {\n const legacyPathCasing =\n config.getOptionalBoolean(\n 'techdocs.legacyUseCaseSensitiveTripletPaths',\n ) || false;\n const locationTemplate = config.getOptionalString(\n 'search.collators.techdocs.locationTemplate',\n );\n const parallelismLimit = config.getOptionalNumber(\n 'search.collators.techdocs.parallelismLimit',\n );\n return new DefaultTechDocsCollatorFactory({\n ...options,\n locationTemplate,\n parallelismLimit,\n legacyPathCasing,\n });\n }\n\n async getCollator(): Promise<Readable> {\n return Readable.from(this.execute());\n }\n\n private async *execute(): AsyncGenerator<TechDocsDocument, void, undefined> {\n const limit = pLimit(this.parallelismLimit);\n const techDocsBaseUrl = await this.discovery.getBaseUrl('techdocs');\n\n let entitiesRetrieved = 0;\n let moreEntitiesToGet = true;\n\n // Offset/limit pagination is used on the Catalog Client in order to\n // limit (and allow some control over) memory used by the search backend\n // at index-time. The batchSize is calculated as a factor of the given\n // parallelism limit to simplify configuration.\n const batchSize = this.parallelismLimit * 50;\n while (moreEntitiesToGet) {\n const { token: catalogToken } = await this.auth.getPluginRequestToken({\n onBehalfOf: await this.auth.getOwnServiceCredentials(),\n targetPluginId: 'catalog',\n });\n\n const entities = (\n await this.catalogClient.getEntities(\n {\n filter: {\n 'metadata.annotations.backstage.io/techdocs-ref':\n CATALOG_FILTER_EXISTS,\n },\n limit: batchSize,\n offset: entitiesRetrieved,\n },\n { token: catalogToken },\n )\n ).items;\n\n // Control looping through entity batches.\n moreEntitiesToGet = entities.length === batchSize;\n entitiesRetrieved += entities.length;\n\n const docPromises = entities\n .filter(it => it.metadata?.annotations?.['backstage.io/techdocs-ref'])\n .map((entity: Entity) =>\n limit(async (): Promise<TechDocsDocument[]> => {\n const entityInfo =\n DefaultTechDocsCollatorFactory.handleEntityInfoCasing(\n this.legacyPathCasing,\n {\n kind: entity.kind,\n namespace: entity.metadata.namespace || 'default',\n name: entity.metadata.name,\n },\n );\n\n try {\n const { token: techdocsToken } =\n await this.auth.getPluginRequestToken({\n onBehalfOf: await this.auth.getOwnServiceCredentials(),\n targetPluginId: 'techdocs',\n });\n\n const searchIndexResponse = await fetch(\n DefaultTechDocsCollatorFactory.constructDocsIndexUrl(\n techDocsBaseUrl,\n entityInfo,\n ),\n {\n headers: {\n Authorization: `Bearer ${techdocsToken}`,\n },\n },\n );\n\n // todo(@backstage/techdocs-core): remove Promise.race() when node-fetch is 3.x+\n // workaround for fetch().json() hanging in node-fetch@2.x.x, fixed in 3.x.x\n // https://github.com/node-fetch/node-fetch/issues/665\n const searchIndex = await Promise.race([\n searchIndexResponse.json(),\n new Promise((_resolve, reject) => {\n setTimeout(() => {\n reject('Could not parse JSON in 5 seconds.');\n }, 5000);\n }),\n ]);\n\n return searchIndex.docs.map((doc: MkSearchIndexDoc) => ({\n ...this.entityTransformer(entity),\n title: unescape(doc.title),\n text: unescape(doc.text || ''),\n location: this.applyArgsToFormat(\n this.locationTemplate || '/docs/:namespace/:kind/:name/:path',\n {\n ...entityInfo,\n path: doc.location,\n },\n ),\n path: doc.location,\n ...entityInfo,\n entityTitle: entity.metadata.title,\n componentType: entity.spec?.type?.toString() || 'other',\n lifecycle: (entity.spec?.lifecycle as string) || '',\n owner: getSimpleEntityOwnerString(entity),\n authorization: {\n resourceRef: stringifyEntityRef(entity),\n },\n }));\n } catch (e) {\n this.logger.debug(\n `Failed to retrieve tech docs search index for entity ${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}`,\n e,\n );\n return [];\n }\n }),\n );\n yield* (await Promise.all(docPromises)).flat();\n }\n }\n\n private applyArgsToFormat(\n format: string,\n args: Record<string, string>,\n ): string {\n let formatted = format;\n for (const [key, value] of Object.entries(args)) {\n formatted = formatted.replace(`:${key}`, value);\n }\n return formatted;\n }\n\n private static constructDocsIndexUrl(\n techDocsBaseUrl: string,\n entityInfo: { kind: string; namespace: string; name: string },\n ) {\n return `${techDocsBaseUrl}/static/docs/${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}/search/search_index.json`;\n }\n\n private static handleEntityInfoCasing(\n legacyPaths: boolean,\n entityInfo: EntityInfo,\n ): EntityInfo {\n return legacyPaths\n ? entityInfo\n : Object.entries(entityInfo).reduce((acc, [key, value]) => {\n return { ...acc, [key]: value.toLocaleLowerCase('en-US') };\n }, {} as EntityInfo);\n }\n}\n\nfunction getSimpleEntityOwnerString(entity: Entity): string {\n if (entity.relations) {\n const owner = entity.relations.find(r => r.type === RELATION_OWNED_BY);\n if (owner) {\n const { name } = parseEntityRef(owner.targetRef);\n return name;\n }\n }\n return '';\n}\n"],"names":["isUserEntity","isGroupEntity","catalogEntityReadPermission","CatalogClient","createLegacyAuthAdapters","Readable","pLimit","CATALOG_FILTER_EXISTS","fetch","unescape","stringifyEntityRef","RELATION_OWNED_BY","parseEntityRef"],"mappings":";;;;;;;;;;;;;;;;;;;AAmBA,MAAM,eAAA,GAAkB,CAAC,MAA2B,KAAA;AAnBpD,EAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AAoBE,EAAA,MAAM,gBAA0B,EAAC,CAAA;AACjC,EAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,QAAS,CAAA,WAAA,IAAe,EAAE,CAAA,CAAA;AAEpD,EAAA,IAAIA,yBAAa,CAAA,MAAM,CAAK,IAAAC,0BAAA,CAAc,MAAM,CAAG,EAAA;AACjD,IAAA,IAAA,CAAI,EAAO,GAAA,CAAA,EAAA,GAAA,MAAA,CAAA,IAAA,KAAP,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,OAAA,KAAb,mBAAsB,WAAa,EAAA;AACrC,MAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,WAAW,CAAA,CAAA;AAAA,KACpD;AAAA,GACF;AAEA,EAAI,IAAAD,yBAAA,CAAa,MAAM,CAAG,EAAA;AACxB,IAAA,IAAA,CAAI,EAAO,GAAA,CAAA,EAAA,GAAA,MAAA,CAAA,IAAA,KAAP,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,OAAA,KAAb,mBAAsB,KAAO,EAAA;AAC/B,MAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,KAAK,CAAA,CAAA;AAAA,KAC9C;AAAA,GACF;AAEA,EAAO,OAAA,aAAA,CAAc,KAAK,KAAK,CAAA,CAAA;AACjC,CAAA,CAAA;AAGa,MAAA,wCAAA,GACX,CAAC,MAAmB,KAAA;AAxCtB,EAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AAyCI,EAAO,OAAA;AAAA,IACL,MAAM,MAAO,CAAA,IAAA;AAAA,IACb,SAAA,EAAW,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA;AAAA,IACxC,WAAA,EAAa,MAAO,CAAA,QAAA,CAAS,WAAe,IAAA,EAAA;AAAA,IAC5C,IAAA,EAAM,MAAO,CAAA,QAAA,CAAS,IAAQ,IAAA,EAAA;AAAA,IAC9B,KAAA,EAAO,MAAO,CAAA,QAAA,CAAS,KAAS,IAAA,EAAA;AAAA,IAChC,IAAA,EAAM,gBAAgB,MAAM,CAAA;AAAA,IAC5B,iBAAe,EAAO,GAAA,CAAA,EAAA,GAAA,MAAA,CAAA,IAAA,KAAP,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,IAAA,KAAb,mBAAmB,QAAc,EAAA,KAAA,OAAA;AAAA,IAChD,QAAM,EAAO,GAAA,CAAA,EAAA,GAAA,MAAA,CAAA,IAAA,KAAP,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,IAAA,KAAb,mBAAmB,QAAc,EAAA,KAAA,OAAA;AAAA,IACvC,SAAY,EAAA,CAAA,CAAA,EAAA,GAAA,MAAA,CAAO,IAAP,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAa,SAAwB,KAAA,EAAA;AAAA,IACjD,KAAQ,EAAA,CAAA,CAAA,EAAA,GAAA,MAAA,CAAO,IAAP,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAa,KAAoB,KAAA,EAAA;AAAA,IACzC,IAAM,EAAA,EAAA;AAAA,GACR,CAAA;AACF;;;;;;;;AC4BK,MAAM,8BAAkE,CAAA;AAAA,EAcrE,YAAY,OAAyC,EAAA;AAb7D,IAAA,aAAA,CAAA,IAAA,EAAgB,MAAe,EAAA,UAAA,CAAA,CAAA;AAC/B,IAAA,aAAA,CAAA,IAAA,EAAgB,sBACd,EAAAE,iCAAA,CAAA,CAAA;AAEF,IAAQ,aAAA,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,kBAAA,CAAA,CAAA;AACR,IAAiB,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,MAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,eAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,kBAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,kBAAA,CAAA,CAAA;AACjB,IAAQ,aAAA,CAAA,IAAA,EAAA,mBAAA,CAAA,CAAA;AA9FV,IAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AAiGI,IAAA,IAAA,CAAK,YAAY,OAAQ,CAAA,SAAA,CAAA;AACzB,IAAK,IAAA,CAAA,gBAAA,GACH,QAAQ,gBAAoB,IAAA,oCAAA,CAAA;AAC9B,IAAK,IAAA,CAAA,MAAA,GAAS,QAAQ,MAAO,CAAA,KAAA,CAAM,EAAE,YAAc,EAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AAC9D,IAAK,IAAA,CAAA,aAAA,GACH,QAAQ,aACR,IAAA,IAAIC,4BAAc,EAAE,YAAA,EAAc,OAAQ,CAAA,SAAA,EAAW,CAAA,CAAA;AACvD,IAAK,IAAA,CAAA,gBAAA,GAAA,CAAmB,EAAQ,GAAA,OAAA,CAAA,gBAAA,KAAR,IAA4B,GAAA,EAAA,GAAA,EAAA,CAAA;AACpD,IAAK,IAAA,CAAA,gBAAA,GAAA,CAAmB,EAAQ,GAAA,OAAA,CAAA,gBAAA,KAAR,IAA4B,GAAA,EAAA,GAAA,KAAA,CAAA;AACpD,IAAK,IAAA,CAAA,iBAAA,GAAA,CACH,EAAQ,GAAA,OAAA,CAAA,iBAAA,KAAR,IAA6B,GAAA,EAAA,GAAA,wCAAA,CAAA;AAE/B,IAAA,IAAA,CAAK,OAAOC,sCAAyB,CAAA;AAAA,MACnC,MAAM,OAAQ,CAAA,IAAA;AAAA,MACd,WAAW,OAAQ,CAAA,SAAA;AAAA,MACnB,cAAc,OAAQ,CAAA,YAAA;AAAA,KACvB,CAAE,CAAA,IAAA,CAAA;AAAA,GACL;AAAA,EAEA,OAAO,UAAW,CAAA,MAAA,EAAgB,OAAyC,EAAA;AACzE,IAAA,MAAM,mBACJ,MAAO,CAAA,kBAAA;AAAA,MACL,6CAAA;AAAA,KACG,IAAA,KAAA,CAAA;AACP,IAAA,MAAM,mBAAmB,MAAO,CAAA,iBAAA;AAAA,MAC9B,4CAAA;AAAA,KACF,CAAA;AACA,IAAA,MAAM,mBAAmB,MAAO,CAAA,iBAAA;AAAA,MAC9B,4CAAA;AAAA,KACF,CAAA;AACA,IAAA,OAAO,IAAI,8BAA+B,CAAA;AAAA,MACxC,GAAG,OAAA;AAAA,MACH,gBAAA;AAAA,MACA,gBAAA;AAAA,MACA,gBAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,MAAM,WAAiC,GAAA;AACrC,IAAA,OAAOC,eAAS,CAAA,IAAA,CAAK,IAAK,CAAA,OAAA,EAAS,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,OAAe,OAA6D,GAAA;AAC1E,IAAM,MAAA,KAAA,GAAQC,0BAAO,CAAA,IAAA,CAAK,gBAAgB,CAAA,CAAA;AAC1C,IAAA,MAAM,eAAkB,GAAA,MAAM,IAAK,CAAA,SAAA,CAAU,WAAW,UAAU,CAAA,CAAA;AAElE,IAAA,IAAI,iBAAoB,GAAA,CAAA,CAAA;AACxB,IAAA,IAAI,iBAAoB,GAAA,IAAA,CAAA;AAMxB,IAAM,MAAA,SAAA,GAAY,KAAK,gBAAmB,GAAA,EAAA,CAAA;AAC1C,IAAA,OAAO,iBAAmB,EAAA;AACxB,MAAA,MAAM,EAAE,KAAO,EAAA,YAAA,KAAiB,MAAM,IAAA,CAAK,KAAK,qBAAsB,CAAA;AAAA,QACpE,UAAY,EAAA,MAAM,IAAK,CAAA,IAAA,CAAK,wBAAyB,EAAA;AAAA,QACrD,cAAgB,EAAA,SAAA;AAAA,OACjB,CAAA,CAAA;AAED,MAAM,MAAA,QAAA,GAAA,CACJ,MAAM,IAAA,CAAK,aAAc,CAAA,WAAA;AAAA,QACvB;AAAA,UACE,MAAQ,EAAA;AAAA,YACN,gDACE,EAAAC,mCAAA;AAAA,WACJ;AAAA,UACA,KAAO,EAAA,SAAA;AAAA,UACP,MAAQ,EAAA,iBAAA;AAAA,SACV;AAAA,QACA,EAAE,OAAO,YAAa,EAAA;AAAA,OAExB,EAAA,KAAA,CAAA;AAGF,MAAA,iBAAA,GAAoB,SAAS,MAAW,KAAA,SAAA,CAAA;AACxC,MAAA,iBAAA,IAAqB,QAAS,CAAA,MAAA,CAAA;AAE9B,MAAM,MAAA,WAAA,GAAc,QACjB,CAAA,MAAA,CAAO,CAAG,EAAA,KAAA;AAhLnB,QAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAgLsB,QAAG,OAAA,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,EAAA,CAAA,QAAA,KAAH,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,WAAA,KAAb,IAA2B,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,2BAAA,CAAA,CAAA;AAAA,OAA4B,CACpE,CAAA,GAAA;AAAA,QAAI,CAAC,MACJ,KAAA,KAAA,CAAM,YAAyC;AAC7C,UAAA,MAAM,aACJ,8BAA+B,CAAA,sBAAA;AAAA,YAC7B,IAAK,CAAA,gBAAA;AAAA,YACL;AAAA,cACE,MAAM,MAAO,CAAA,IAAA;AAAA,cACb,SAAA,EAAW,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA;AAAA,cACxC,IAAA,EAAM,OAAO,QAAS,CAAA,IAAA;AAAA,aACxB;AAAA,WACF,CAAA;AAEF,UAAI,IAAA;AACF,YAAA,MAAM,EAAE,KAAO,EAAA,aAAA,KACb,MAAM,IAAA,CAAK,KAAK,qBAAsB,CAAA;AAAA,cACpC,UAAY,EAAA,MAAM,IAAK,CAAA,IAAA,CAAK,wBAAyB,EAAA;AAAA,cACrD,cAAgB,EAAA,UAAA;AAAA,aACjB,CAAA,CAAA;AAEH,YAAA,MAAM,sBAAsB,MAAMC,yBAAA;AAAA,cAChC,8BAA+B,CAAA,qBAAA;AAAA,gBAC7B,eAAA;AAAA,gBACA,UAAA;AAAA,eACF;AAAA,cACA;AAAA,gBACE,OAAS,EAAA;AAAA,kBACP,aAAA,EAAe,UAAU,aAAa,CAAA,CAAA;AAAA,iBACxC;AAAA,eACF;AAAA,aACF,CAAA;AAKA,YAAM,MAAA,WAAA,GAAc,MAAM,OAAA,CAAQ,IAAK,CAAA;AAAA,cACrC,oBAAoB,IAAK,EAAA;AAAA,cACzB,IAAI,OAAA,CAAQ,CAAC,QAAA,EAAU,MAAW,KAAA;AAChC,gBAAA,UAAA,CAAW,MAAM;AACf,kBAAA,MAAA,CAAO,oCAAoC,CAAA,CAAA;AAAA,mBAC1C,GAAI,CAAA,CAAA;AAAA,eACR,CAAA;AAAA,aACF,CAAA,CAAA;AAED,YAAA,OAAO,WAAY,CAAA,IAAA,CAAK,GAAI,CAAA,CAAC,GAAuB,KAAA;AA5NlE,cAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AA4NsE,cAAA,OAAA;AAAA,gBACtD,GAAG,IAAK,CAAA,iBAAA,CAAkB,MAAM,CAAA;AAAA,gBAChC,KAAA,EAAOC,4BAAS,CAAA,GAAA,CAAI,KAAK,CAAA;AAAA,gBACzB,IAAM,EAAAA,4BAAA,CAAS,GAAI,CAAA,IAAA,IAAQ,EAAE,CAAA;AAAA,gBAC7B,UAAU,IAAK,CAAA,iBAAA;AAAA,kBACb,KAAK,gBAAoB,IAAA,oCAAA;AAAA,kBACzB;AAAA,oBACE,GAAG,UAAA;AAAA,oBACH,MAAM,GAAI,CAAA,QAAA;AAAA,mBACZ;AAAA,iBACF;AAAA,gBACA,MAAM,GAAI,CAAA,QAAA;AAAA,gBACV,GAAG,UAAA;AAAA,gBACH,WAAA,EAAa,OAAO,QAAS,CAAA,KAAA;AAAA,gBAC7B,iBAAe,EAAO,GAAA,CAAA,EAAA,GAAA,MAAA,CAAA,IAAA,KAAP,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,IAAA,KAAb,mBAAmB,QAAc,EAAA,KAAA,OAAA;AAAA,gBAChD,SAAY,EAAA,CAAA,CAAA,EAAA,GAAA,MAAA,CAAO,IAAP,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAa,SAAwB,KAAA,EAAA;AAAA,gBACjD,KAAA,EAAO,2BAA2B,MAAM,CAAA;AAAA,gBACxC,aAAe,EAAA;AAAA,kBACb,WAAA,EAAaC,gCAAmB,MAAM,CAAA;AAAA,iBACxC;AAAA,eACF,CAAA;AAAA,aAAE,CAAA,CAAA;AAAA,mBACK,CAAG,EAAA;AACV,YAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,cACV,CAAA,qDAAA,EAAwD,WAAW,SAAS,CAAA,CAAA,EAAI,WAAW,IAAI,CAAA,CAAA,EAAI,WAAW,IAAI,CAAA,CAAA;AAAA,cAClH,CAAA;AAAA,aACF,CAAA;AACA,YAAA,OAAO,EAAC,CAAA;AAAA,WACV;AAAA,SACD,CAAA;AAAA,OACH,CAAA;AACF,MAAA,OAAA,CAAQ,MAAM,OAAA,CAAQ,GAAI,CAAA,WAAW,GAAG,IAAK,EAAA,CAAA;AAAA,KAC/C;AAAA,GACF;AAAA,EAEQ,iBAAA,CACN,QACA,IACQ,EAAA;AACR,IAAA,IAAI,SAAY,GAAA,MAAA,CAAA;AAChB,IAAA,KAAA,MAAW,CAAC,GAAK,EAAA,KAAK,KAAK,MAAO,CAAA,OAAA,CAAQ,IAAI,CAAG,EAAA;AAC/C,MAAA,SAAA,GAAY,SAAU,CAAA,OAAA,CAAQ,CAAI,CAAA,EAAA,GAAG,IAAI,KAAK,CAAA,CAAA;AAAA,KAChD;AACA,IAAO,OAAA,SAAA,CAAA;AAAA,GACT;AAAA,EAEA,OAAe,qBACb,CAAA,eAAA,EACA,UACA,EAAA;AACA,IAAO,OAAA,CAAA,EAAG,eAAe,CAAA,aAAA,EAAgB,UAAW,CAAA,SAAS,IAAI,UAAW,CAAA,IAAI,CAAI,CAAA,EAAA,UAAA,CAAW,IAAI,CAAA,yBAAA,CAAA,CAAA;AAAA,GACrG;AAAA,EAEA,OAAe,sBACb,CAAA,WAAA,EACA,UACY,EAAA;AACZ,IAAA,OAAO,WACH,GAAA,UAAA,GACA,MAAO,CAAA,OAAA,CAAQ,UAAU,CAAA,CAAE,MAAO,CAAA,CAAC,GAAK,EAAA,CAAC,GAAK,EAAA,KAAK,CAAM,KAAA;AACvD,MAAO,OAAA,EAAE,GAAG,GAAK,EAAA,CAAC,GAAG,GAAG,KAAA,CAAM,iBAAkB,CAAA,OAAO,CAAE,EAAA,CAAA;AAAA,KAC3D,EAAG,EAAgB,CAAA,CAAA;AAAA,GACzB;AACF,CAAA;AAEA,SAAS,2BAA2B,MAAwB,EAAA;AAC1D,EAAA,IAAI,OAAO,SAAW,EAAA;AACpB,IAAA,MAAM,QAAQ,MAAO,CAAA,SAAA,CAAU,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,SAASC,8BAAiB,CAAA,CAAA;AACrE,IAAA,IAAI,KAAO,EAAA;AACT,MAAA,MAAM,EAAE,IAAA,EAAS,GAAAC,2BAAA,CAAe,MAAM,SAAS,CAAA,CAAA;AAC/C,MAAO,OAAA,IAAA,CAAA;AAAA,KACT;AAAA,GACF;AACA,EAAO,OAAA,EAAA,CAAA;AACT;;;;;"}
1
+ {"version":3,"file":"index.cjs.js","sources":["../src/collators/defaultTechDocsCollatorEntityTransformer.ts","../src/collators/DefaultTechDocsCollatorFactory.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 { Entity, isGroupEntity, isUserEntity } from '@backstage/catalog-model';\nimport { TechDocsCollatorEntityTransformer } from './TechDocsCollatorEntityTransformer';\n\nconst getDocumentText = (entity: Entity): string => {\n const documentTexts: string[] = [];\n documentTexts.push(entity.metadata.description || '');\n\n if (isUserEntity(entity) || isGroupEntity(entity)) {\n if (entity.spec?.profile?.displayName) {\n documentTexts.push(entity.spec.profile.displayName);\n }\n }\n\n if (isUserEntity(entity)) {\n if (entity.spec?.profile?.email) {\n documentTexts.push(entity.spec.profile.email);\n }\n }\n\n return documentTexts.join(' : ');\n};\n\n/** @public */\nexport const defaultTechDocsCollatorEntityTransformer: TechDocsCollatorEntityTransformer =\n (entity: Entity) => {\n return {\n kind: entity.kind,\n namespace: entity.metadata.namespace || 'default',\n annotations: entity.metadata.annotations || '',\n name: entity.metadata.name || '',\n title: entity.metadata.title || '',\n text: getDocumentText(entity),\n componentType: entity.spec?.type?.toString() || 'other',\n type: entity.spec?.type?.toString() || 'other',\n lifecycle: (entity.spec?.lifecycle as string) || '',\n owner: (entity.spec?.owner as string) || '',\n path: '',\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 PluginEndpointDiscovery,\n TokenManager,\n} from '@backstage/backend-common';\nimport {\n CatalogApi,\n CatalogClient,\n CATALOG_FILTER_EXISTS,\n} from '@backstage/catalog-client';\nimport {\n Entity,\n parseEntityRef,\n RELATION_OWNED_BY,\n stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { catalogEntityReadPermission } from '@backstage/plugin-catalog-common/alpha';\nimport { Permission } from '@backstage/plugin-permission-common';\nimport { DocumentCollatorFactory } from '@backstage/plugin-search-common';\nimport { TechDocsDocument } from '@backstage/plugin-techdocs-node';\nimport unescape from 'lodash/unescape';\nimport fetch from 'node-fetch';\nimport pLimit from 'p-limit';\nimport { Readable } from 'stream';\nimport { Logger } from 'winston';\nimport { TechDocsCollatorEntityTransformer } from './TechDocsCollatorEntityTransformer';\nimport { defaultTechDocsCollatorEntityTransformer } from './defaultTechDocsCollatorEntityTransformer';\n\ninterface MkSearchIndexDoc {\n title: string;\n text: string;\n location: string;\n}\n\n/**\n * Options to configure the TechDocs collator factory\n *\n * @public\n */\nexport type TechDocsCollatorFactoryOptions = {\n discovery: PluginEndpointDiscovery;\n logger: Logger;\n tokenManager: TokenManager;\n locationTemplate?: string;\n catalogClient?: CatalogApi;\n parallelismLimit?: number;\n legacyPathCasing?: boolean;\n entityTransformer?: TechDocsCollatorEntityTransformer;\n};\n\ntype EntityInfo = {\n name: string;\n namespace: string;\n kind: string;\n};\n\n/**\n * A search collator factory responsible for gathering and transforming\n * TechDocs documents.\n *\n * @public\n */\nexport class DefaultTechDocsCollatorFactory implements DocumentCollatorFactory {\n public readonly type: string = 'techdocs';\n public readonly visibilityPermission: Permission =\n catalogEntityReadPermission;\n\n private discovery: PluginEndpointDiscovery;\n private locationTemplate: string;\n private readonly logger: Logger;\n private readonly catalogClient: CatalogApi;\n private readonly tokenManager: TokenManager;\n private readonly parallelismLimit: number;\n private readonly legacyPathCasing: boolean;\n private entityTransformer: TechDocsCollatorEntityTransformer;\n\n private constructor(options: TechDocsCollatorFactoryOptions) {\n this.discovery = options.discovery;\n this.locationTemplate =\n options.locationTemplate || '/docs/:namespace/:kind/:name/:path';\n this.logger = options.logger.child({ documentType: this.type });\n this.catalogClient =\n options.catalogClient ||\n new CatalogClient({ discoveryApi: options.discovery });\n this.parallelismLimit = options.parallelismLimit ?? 10;\n this.legacyPathCasing = options.legacyPathCasing ?? false;\n this.tokenManager = options.tokenManager;\n this.entityTransformer =\n options.entityTransformer ?? defaultTechDocsCollatorEntityTransformer;\n }\n\n static fromConfig(config: Config, options: TechDocsCollatorFactoryOptions) {\n const legacyPathCasing =\n config.getOptionalBoolean(\n 'techdocs.legacyUseCaseSensitiveTripletPaths',\n ) || false;\n const locationTemplate = config.getOptionalString(\n 'search.collators.techdocs.locationTemplate',\n );\n const parallelismLimit = config.getOptionalNumber(\n 'search.collators.techdocs.parallelismLimit',\n );\n return new DefaultTechDocsCollatorFactory({\n ...options,\n locationTemplate,\n parallelismLimit,\n legacyPathCasing,\n });\n }\n\n async getCollator(): Promise<Readable> {\n return Readable.from(this.execute());\n }\n\n private async *execute(): AsyncGenerator<TechDocsDocument, void, undefined> {\n const limit = pLimit(this.parallelismLimit);\n const techDocsBaseUrl = await this.discovery.getBaseUrl('techdocs');\n const { token } = await this.tokenManager.getToken();\n let entitiesRetrieved = 0;\n let moreEntitiesToGet = true;\n\n // Offset/limit pagination is used on the Catalog Client in order to\n // limit (and allow some control over) memory used by the search backend\n // at index-time. The batchSize is calculated as a factor of the given\n // parallelism limit to simplify configuration.\n const batchSize = this.parallelismLimit * 50;\n while (moreEntitiesToGet) {\n const entities = (\n await this.catalogClient.getEntities(\n {\n filter: {\n 'metadata.annotations.backstage.io/techdocs-ref':\n CATALOG_FILTER_EXISTS,\n },\n limit: batchSize,\n offset: entitiesRetrieved,\n },\n { token },\n )\n ).items;\n\n // Control looping through entity batches.\n moreEntitiesToGet = entities.length === batchSize;\n entitiesRetrieved += entities.length;\n\n const docPromises = entities\n .filter(it => it.metadata?.annotations?.['backstage.io/techdocs-ref'])\n .map((entity: Entity) =>\n limit(async (): Promise<TechDocsDocument[]> => {\n const entityInfo =\n DefaultTechDocsCollatorFactory.handleEntityInfoCasing(\n this.legacyPathCasing,\n {\n kind: entity.kind,\n namespace: entity.metadata.namespace || 'default',\n name: entity.metadata.name,\n },\n );\n\n try {\n const searchIndexResponse = await fetch(\n DefaultTechDocsCollatorFactory.constructDocsIndexUrl(\n techDocsBaseUrl,\n entityInfo,\n ),\n {\n headers: {\n Authorization: `Bearer ${token}`,\n },\n },\n );\n\n // todo(@backstage/techdocs-core): remove Promise.race() when node-fetch is 3.x+\n // workaround for fetch().json() hanging in node-fetch@2.x.x, fixed in 3.x.x\n // https://github.com/node-fetch/node-fetch/issues/665\n const searchIndex = await Promise.race([\n searchIndexResponse.json(),\n new Promise((_resolve, reject) => {\n setTimeout(() => {\n reject('Could not parse JSON in 5 seconds.');\n }, 5000);\n }),\n ]);\n\n return searchIndex.docs.map((doc: MkSearchIndexDoc) => ({\n ...this.entityTransformer(entity),\n title: unescape(doc.title),\n text: unescape(doc.text || ''),\n location: this.applyArgsToFormat(\n this.locationTemplate || '/docs/:namespace/:kind/:name/:path',\n {\n ...entityInfo,\n path: doc.location,\n },\n ),\n path: doc.location,\n ...entityInfo,\n entityTitle: entity.metadata.title,\n componentType: entity.spec?.type?.toString() || 'other',\n lifecycle: (entity.spec?.lifecycle as string) || '',\n owner: getSimpleEntityOwnerString(entity),\n authorization: {\n resourceRef: stringifyEntityRef(entity),\n },\n }));\n } catch (e) {\n this.logger.debug(\n `Failed to retrieve tech docs search index for entity ${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}`,\n e,\n );\n return [];\n }\n }),\n );\n yield* (await Promise.all(docPromises)).flat();\n }\n }\n\n private applyArgsToFormat(\n format: string,\n args: Record<string, string>,\n ): string {\n let formatted = format;\n for (const [key, value] of Object.entries(args)) {\n formatted = formatted.replace(`:${key}`, value);\n }\n return formatted;\n }\n\n private static constructDocsIndexUrl(\n techDocsBaseUrl: string,\n entityInfo: { kind: string; namespace: string; name: string },\n ) {\n return `${techDocsBaseUrl}/static/docs/${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}/search/search_index.json`;\n }\n\n private static handleEntityInfoCasing(\n legacyPaths: boolean,\n entityInfo: EntityInfo,\n ): EntityInfo {\n return legacyPaths\n ? entityInfo\n : Object.entries(entityInfo).reduce((acc, [key, value]) => {\n return { ...acc, [key]: value.toLocaleLowerCase('en-US') };\n }, {} as EntityInfo);\n }\n}\n\nfunction getSimpleEntityOwnerString(entity: Entity): string {\n if (entity.relations) {\n const owner = entity.relations.find(r => r.type === RELATION_OWNED_BY);\n if (owner) {\n const { name } = parseEntityRef(owner.targetRef);\n return name;\n }\n }\n return '';\n}\n"],"names":["isUserEntity","isGroupEntity","catalogEntityReadPermission","CatalogClient","Readable","pLimit","CATALOG_FILTER_EXISTS","fetch","unescape","stringifyEntityRef","RELATION_OWNED_BY","parseEntityRef"],"mappings":";;;;;;;;;;;;;;;;;;AAmBA,MAAM,eAAA,GAAkB,CAAC,MAA2B,KAAA;AAnBpD,EAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AAoBE,EAAA,MAAM,gBAA0B,EAAC,CAAA;AACjC,EAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,QAAS,CAAA,WAAA,IAAe,EAAE,CAAA,CAAA;AAEpD,EAAA,IAAIA,yBAAa,CAAA,MAAM,CAAK,IAAAC,0BAAA,CAAc,MAAM,CAAG,EAAA;AACjD,IAAA,IAAA,CAAI,EAAO,GAAA,CAAA,EAAA,GAAA,MAAA,CAAA,IAAA,KAAP,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,OAAA,KAAb,mBAAsB,WAAa,EAAA;AACrC,MAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,WAAW,CAAA,CAAA;AAAA,KACpD;AAAA,GACF;AAEA,EAAI,IAAAD,yBAAA,CAAa,MAAM,CAAG,EAAA;AACxB,IAAA,IAAA,CAAI,EAAO,GAAA,CAAA,EAAA,GAAA,MAAA,CAAA,IAAA,KAAP,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,OAAA,KAAb,mBAAsB,KAAO,EAAA;AAC/B,MAAA,aAAA,CAAc,IAAK,CAAA,MAAA,CAAO,IAAK,CAAA,OAAA,CAAQ,KAAK,CAAA,CAAA;AAAA,KAC9C;AAAA,GACF;AAEA,EAAO,OAAA,aAAA,CAAc,KAAK,KAAK,CAAA,CAAA;AACjC,CAAA,CAAA;AAGa,MAAA,wCAAA,GACX,CAAC,MAAmB,KAAA;AAxCtB,EAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AAyCI,EAAO,OAAA;AAAA,IACL,MAAM,MAAO,CAAA,IAAA;AAAA,IACb,SAAA,EAAW,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA;AAAA,IACxC,WAAA,EAAa,MAAO,CAAA,QAAA,CAAS,WAAe,IAAA,EAAA;AAAA,IAC5C,IAAA,EAAM,MAAO,CAAA,QAAA,CAAS,IAAQ,IAAA,EAAA;AAAA,IAC9B,KAAA,EAAO,MAAO,CAAA,QAAA,CAAS,KAAS,IAAA,EAAA;AAAA,IAChC,IAAA,EAAM,gBAAgB,MAAM,CAAA;AAAA,IAC5B,iBAAe,EAAO,GAAA,CAAA,EAAA,GAAA,MAAA,CAAA,IAAA,KAAP,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,IAAA,KAAb,mBAAmB,QAAc,EAAA,KAAA,OAAA;AAAA,IAChD,QAAM,EAAO,GAAA,CAAA,EAAA,GAAA,MAAA,CAAA,IAAA,KAAP,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,IAAA,KAAb,mBAAmB,QAAc,EAAA,KAAA,OAAA;AAAA,IACvC,SAAY,EAAA,CAAA,CAAA,EAAA,GAAA,MAAA,CAAO,IAAP,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAa,SAAwB,KAAA,EAAA;AAAA,IACjD,KAAQ,EAAA,CAAA,CAAA,EAAA,GAAA,MAAA,CAAO,IAAP,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAa,KAAoB,KAAA,EAAA;AAAA,IACzC,IAAM,EAAA,EAAA;AAAA,GACR,CAAA;AACF;;;;;;;;ACwBK,MAAM,8BAAkE,CAAA;AAAA,EAcrE,YAAY,OAAyC,EAAA;AAb7D,IAAA,aAAA,CAAA,IAAA,EAAgB,MAAe,EAAA,UAAA,CAAA,CAAA;AAC/B,IAAA,aAAA,CAAA,IAAA,EAAgB,sBACd,EAAAE,iCAAA,CAAA,CAAA;AAEF,IAAQ,aAAA,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,kBAAA,CAAA,CAAA;AACR,IAAiB,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,eAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,cAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,kBAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,kBAAA,CAAA,CAAA;AACjB,IAAQ,aAAA,CAAA,IAAA,EAAA,mBAAA,CAAA,CAAA;AA1FV,IAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AA6FI,IAAA,IAAA,CAAK,YAAY,OAAQ,CAAA,SAAA,CAAA;AACzB,IAAK,IAAA,CAAA,gBAAA,GACH,QAAQ,gBAAoB,IAAA,oCAAA,CAAA;AAC9B,IAAK,IAAA,CAAA,MAAA,GAAS,QAAQ,MAAO,CAAA,KAAA,CAAM,EAAE,YAAc,EAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AAC9D,IAAK,IAAA,CAAA,aAAA,GACH,QAAQ,aACR,IAAA,IAAIC,4BAAc,EAAE,YAAA,EAAc,OAAQ,CAAA,SAAA,EAAW,CAAA,CAAA;AACvD,IAAK,IAAA,CAAA,gBAAA,GAAA,CAAmB,EAAQ,GAAA,OAAA,CAAA,gBAAA,KAAR,IAA4B,GAAA,EAAA,GAAA,EAAA,CAAA;AACpD,IAAK,IAAA,CAAA,gBAAA,GAAA,CAAmB,EAAQ,GAAA,OAAA,CAAA,gBAAA,KAAR,IAA4B,GAAA,EAAA,GAAA,KAAA,CAAA;AACpD,IAAA,IAAA,CAAK,eAAe,OAAQ,CAAA,YAAA,CAAA;AAC5B,IAAK,IAAA,CAAA,iBAAA,GAAA,CACH,EAAQ,GAAA,OAAA,CAAA,iBAAA,KAAR,IAA6B,GAAA,EAAA,GAAA,wCAAA,CAAA;AAAA,GACjC;AAAA,EAEA,OAAO,UAAW,CAAA,MAAA,EAAgB,OAAyC,EAAA;AACzE,IAAA,MAAM,mBACJ,MAAO,CAAA,kBAAA;AAAA,MACL,6CAAA;AAAA,KACG,IAAA,KAAA,CAAA;AACP,IAAA,MAAM,mBAAmB,MAAO,CAAA,iBAAA;AAAA,MAC9B,4CAAA;AAAA,KACF,CAAA;AACA,IAAA,MAAM,mBAAmB,MAAO,CAAA,iBAAA;AAAA,MAC9B,4CAAA;AAAA,KACF,CAAA;AACA,IAAA,OAAO,IAAI,8BAA+B,CAAA;AAAA,MACxC,GAAG,OAAA;AAAA,MACH,gBAAA;AAAA,MACA,gBAAA;AAAA,MACA,gBAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,MAAM,WAAiC,GAAA;AACrC,IAAA,OAAOC,eAAS,CAAA,IAAA,CAAK,IAAK,CAAA,OAAA,EAAS,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,OAAe,OAA6D,GAAA;AAC1E,IAAM,MAAA,KAAA,GAAQC,0BAAO,CAAA,IAAA,CAAK,gBAAgB,CAAA,CAAA;AAC1C,IAAA,MAAM,eAAkB,GAAA,MAAM,IAAK,CAAA,SAAA,CAAU,WAAW,UAAU,CAAA,CAAA;AAClE,IAAA,MAAM,EAAE,KAAM,EAAA,GAAI,MAAM,IAAA,CAAK,aAAa,QAAS,EAAA,CAAA;AACnD,IAAA,IAAI,iBAAoB,GAAA,CAAA,CAAA;AACxB,IAAA,IAAI,iBAAoB,GAAA,IAAA,CAAA;AAMxB,IAAM,MAAA,SAAA,GAAY,KAAK,gBAAmB,GAAA,EAAA,CAAA;AAC1C,IAAA,OAAO,iBAAmB,EAAA;AACxB,MAAM,MAAA,QAAA,GAAA,CACJ,MAAM,IAAA,CAAK,aAAc,CAAA,WAAA;AAAA,QACvB;AAAA,UACE,MAAQ,EAAA;AAAA,YACN,gDACE,EAAAC,mCAAA;AAAA,WACJ;AAAA,UACA,KAAO,EAAA,SAAA;AAAA,UACP,MAAQ,EAAA,iBAAA;AAAA,SACV;AAAA,QACA,EAAE,KAAM,EAAA;AAAA,OAEV,EAAA,KAAA,CAAA;AAGF,MAAA,iBAAA,GAAoB,SAAS,MAAW,KAAA,SAAA,CAAA;AACxC,MAAA,iBAAA,IAAqB,QAAS,CAAA,MAAA,CAAA;AAE9B,MAAM,MAAA,WAAA,GAAc,QACjB,CAAA,MAAA,CAAO,CAAG,EAAA,KAAA;AAlKnB,QAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAkKsB,QAAG,OAAA,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,EAAA,CAAA,QAAA,KAAH,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,WAAA,KAAb,IAA2B,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,2BAAA,CAAA,CAAA;AAAA,OAA4B,CACpE,CAAA,GAAA;AAAA,QAAI,CAAC,MACJ,KAAA,KAAA,CAAM,YAAyC;AAC7C,UAAA,MAAM,aACJ,8BAA+B,CAAA,sBAAA;AAAA,YAC7B,IAAK,CAAA,gBAAA;AAAA,YACL;AAAA,cACE,MAAM,MAAO,CAAA,IAAA;AAAA,cACb,SAAA,EAAW,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA;AAAA,cACxC,IAAA,EAAM,OAAO,QAAS,CAAA,IAAA;AAAA,aACxB;AAAA,WACF,CAAA;AAEF,UAAI,IAAA;AACF,YAAA,MAAM,sBAAsB,MAAMC,yBAAA;AAAA,cAChC,8BAA+B,CAAA,qBAAA;AAAA,gBAC7B,eAAA;AAAA,gBACA,UAAA;AAAA,eACF;AAAA,cACA;AAAA,gBACE,OAAS,EAAA;AAAA,kBACP,aAAA,EAAe,UAAU,KAAK,CAAA,CAAA;AAAA,iBAChC;AAAA,eACF;AAAA,aACF,CAAA;AAKA,YAAM,MAAA,WAAA,GAAc,MAAM,OAAA,CAAQ,IAAK,CAAA;AAAA,cACrC,oBAAoB,IAAK,EAAA;AAAA,cACzB,IAAI,OAAA,CAAQ,CAAC,QAAA,EAAU,MAAW,KAAA;AAChC,gBAAA,UAAA,CAAW,MAAM;AACf,kBAAA,MAAA,CAAO,oCAAoC,CAAA,CAAA;AAAA,mBAC1C,GAAI,CAAA,CAAA;AAAA,eACR,CAAA;AAAA,aACF,CAAA,CAAA;AAED,YAAA,OAAO,WAAY,CAAA,IAAA,CAAK,GAAI,CAAA,CAAC,GAAuB,KAAA;AAxMlE,cAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AAwMsE,cAAA,OAAA;AAAA,gBACtD,GAAG,IAAK,CAAA,iBAAA,CAAkB,MAAM,CAAA;AAAA,gBAChC,KAAA,EAAOC,4BAAS,CAAA,GAAA,CAAI,KAAK,CAAA;AAAA,gBACzB,IAAM,EAAAA,4BAAA,CAAS,GAAI,CAAA,IAAA,IAAQ,EAAE,CAAA;AAAA,gBAC7B,UAAU,IAAK,CAAA,iBAAA;AAAA,kBACb,KAAK,gBAAoB,IAAA,oCAAA;AAAA,kBACzB;AAAA,oBACE,GAAG,UAAA;AAAA,oBACH,MAAM,GAAI,CAAA,QAAA;AAAA,mBACZ;AAAA,iBACF;AAAA,gBACA,MAAM,GAAI,CAAA,QAAA;AAAA,gBACV,GAAG,UAAA;AAAA,gBACH,WAAA,EAAa,OAAO,QAAS,CAAA,KAAA;AAAA,gBAC7B,iBAAe,EAAO,GAAA,CAAA,EAAA,GAAA,MAAA,CAAA,IAAA,KAAP,IAAa,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,IAAA,KAAb,mBAAmB,QAAc,EAAA,KAAA,OAAA;AAAA,gBAChD,SAAY,EAAA,CAAA,CAAA,EAAA,GAAA,MAAA,CAAO,IAAP,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAa,SAAwB,KAAA,EAAA;AAAA,gBACjD,KAAA,EAAO,2BAA2B,MAAM,CAAA;AAAA,gBACxC,aAAe,EAAA;AAAA,kBACb,WAAA,EAAaC,gCAAmB,MAAM,CAAA;AAAA,iBACxC;AAAA,eACF,CAAA;AAAA,aAAE,CAAA,CAAA;AAAA,mBACK,CAAG,EAAA;AACV,YAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,cACV,CAAA,qDAAA,EAAwD,WAAW,SAAS,CAAA,CAAA,EAAI,WAAW,IAAI,CAAA,CAAA,EAAI,WAAW,IAAI,CAAA,CAAA;AAAA,cAClH,CAAA;AAAA,aACF,CAAA;AACA,YAAA,OAAO,EAAC,CAAA;AAAA,WACV;AAAA,SACD,CAAA;AAAA,OACH,CAAA;AACF,MAAA,OAAA,CAAQ,MAAM,OAAA,CAAQ,GAAI,CAAA,WAAW,GAAG,IAAK,EAAA,CAAA;AAAA,KAC/C;AAAA,GACF;AAAA,EAEQ,iBAAA,CACN,QACA,IACQ,EAAA;AACR,IAAA,IAAI,SAAY,GAAA,MAAA,CAAA;AAChB,IAAA,KAAA,MAAW,CAAC,GAAK,EAAA,KAAK,KAAK,MAAO,CAAA,OAAA,CAAQ,IAAI,CAAG,EAAA;AAC/C,MAAA,SAAA,GAAY,SAAU,CAAA,OAAA,CAAQ,CAAI,CAAA,EAAA,GAAG,IAAI,KAAK,CAAA,CAAA;AAAA,KAChD;AACA,IAAO,OAAA,SAAA,CAAA;AAAA,GACT;AAAA,EAEA,OAAe,qBACb,CAAA,eAAA,EACA,UACA,EAAA;AACA,IAAO,OAAA,CAAA,EAAG,eAAe,CAAA,aAAA,EAAgB,UAAW,CAAA,SAAS,IAAI,UAAW,CAAA,IAAI,CAAI,CAAA,EAAA,UAAA,CAAW,IAAI,CAAA,yBAAA,CAAA,CAAA;AAAA,GACrG;AAAA,EAEA,OAAe,sBACb,CAAA,WAAA,EACA,UACY,EAAA;AACZ,IAAA,OAAO,WACH,GAAA,UAAA,GACA,MAAO,CAAA,OAAA,CAAQ,UAAU,CAAA,CAAE,MAAO,CAAA,CAAC,GAAK,EAAA,CAAC,GAAK,EAAA,KAAK,CAAM,KAAA;AACvD,MAAO,OAAA,EAAE,GAAG,GAAK,EAAA,CAAC,GAAG,GAAG,KAAA,CAAM,iBAAkB,CAAA,OAAO,CAAE,EAAA,CAAA;AAAA,KAC3D,EAAG,EAAgB,CAAA,CAAA;AAAA,GACzB;AACF,CAAA;AAEA,SAAS,2BAA2B,MAAwB,EAAA;AAC1D,EAAA,IAAI,OAAO,SAAW,EAAA;AACpB,IAAA,MAAM,QAAQ,MAAO,CAAA,SAAA,CAAU,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,SAASC,8BAAiB,CAAA,CAAA;AACrE,IAAA,IAAI,KAAO,EAAA;AACT,MAAA,MAAM,EAAE,IAAA,EAAS,GAAAC,2BAAA,CAAe,MAAM,SAAS,CAAA,CAAA;AAC/C,MAAO,OAAA,IAAA,CAAA;AAAA,KACT;AAAA,GACF;AACA,EAAO,OAAA,EAAA,CAAA;AACT;;;;;"}
package/dist/index.d.ts CHANGED
@@ -8,7 +8,6 @@ import { Readable } from 'stream';
8
8
  import { Logger } from 'winston';
9
9
  import { Entity } from '@backstage/catalog-model';
10
10
  import { TechDocsDocument } from '@backstage/plugin-techdocs-node';
11
- import { AuthService, HttpAuthService } from '@backstage/backend-plugin-api';
12
11
 
13
12
  /** @public */
14
13
  type TechDocsCollatorEntityTransformer = (entity: Entity) => Omit<TechDocsDocument, 'location' | 'authorization'>;
@@ -22,8 +21,6 @@ type TechDocsCollatorFactoryOptions = {
22
21
  discovery: PluginEndpointDiscovery;
23
22
  logger: Logger;
24
23
  tokenManager: TokenManager;
25
- auth?: AuthService;
26
- httpAuth?: HttpAuthService;
27
24
  locationTemplate?: string;
28
25
  catalogClient?: CatalogApi;
29
26
  parallelismLimit?: number;
@@ -42,8 +39,8 @@ declare class DefaultTechDocsCollatorFactory implements DocumentCollatorFactory
42
39
  private discovery;
43
40
  private locationTemplate;
44
41
  private readonly logger;
45
- private readonly auth;
46
42
  private readonly catalogClient;
43
+ private readonly tokenManager;
47
44
  private readonly parallelismLimit;
48
45
  private readonly legacyPathCasing;
49
46
  private entityTransformer;
package/package.json CHANGED
@@ -1,20 +1,13 @@
1
1
  {
2
2
  "name": "@backstage/plugin-search-backend-module-techdocs",
3
- "version": "0.1.17-next.0",
4
3
  "description": "A module for the search backend that exports techdocs modules",
5
- "backstage": {
6
- "role": "backend-plugin-module"
7
- },
4
+ "version": "0.1.17",
5
+ "main": "./dist/index.cjs.js",
6
+ "types": "./dist/index.d.ts",
7
+ "license": "Apache-2.0",
8
8
  "publishConfig": {
9
9
  "access": "public"
10
10
  },
11
- "homepage": "https://backstage.io",
12
- "repository": {
13
- "type": "git",
14
- "url": "https://github.com/backstage/backstage",
15
- "directory": "plugins/search-backend-module-techdocs"
16
- },
17
- "license": "Apache-2.0",
18
11
  "exports": {
19
12
  ".": {
20
13
  "require": "./dist/index.cjs.js",
@@ -28,44 +21,51 @@
28
21
  },
29
22
  "./package.json": "./package.json"
30
23
  },
31
- "main": "./dist/index.cjs.js",
32
- "types": "./dist/index.d.ts",
33
- "files": [
34
- "dist",
35
- "config.d.ts",
36
- "alpha"
37
- ],
24
+ "backstage": {
25
+ "role": "backend-plugin-module"
26
+ },
27
+ "homepage": "https://backstage.io",
28
+ "repository": {
29
+ "type": "git",
30
+ "url": "https://github.com/backstage/backstage",
31
+ "directory": "plugins/search-backend-module-techdocs"
32
+ },
38
33
  "scripts": {
34
+ "start": "backstage-cli package start",
39
35
  "build": "backstage-cli package build",
40
- "clean": "backstage-cli package clean",
41
36
  "lint": "backstage-cli package lint",
37
+ "test": "backstage-cli package test",
42
38
  "prepack": "backstage-cli package prepack",
43
39
  "postpack": "backstage-cli package postpack",
44
- "start": "backstage-cli package start",
45
- "test": "backstage-cli package test"
40
+ "clean": "backstage-cli package clean"
46
41
  },
47
42
  "dependencies": {
48
- "@backstage/backend-common": "^0.21.3-next.0",
49
- "@backstage/backend-plugin-api": "^0.6.13-next.0",
50
- "@backstage/backend-tasks": "^0.5.18-next.0",
51
- "@backstage/catalog-client": "^1.6.1-next.0",
52
- "@backstage/catalog-model": "^1.4.5-next.0",
53
- "@backstage/config": "^1.1.2-next.0",
54
- "@backstage/plugin-catalog-common": "^1.0.22-next.0",
55
- "@backstage/plugin-catalog-node": "^1.8.0-next.0",
56
- "@backstage/plugin-permission-common": "^0.7.13-next.0",
57
- "@backstage/plugin-search-backend-node": "^1.2.17-next.0",
58
- "@backstage/plugin-search-common": "^1.2.11-next.0",
59
- "@backstage/plugin-techdocs-node": "^1.11.5-next.0",
43
+ "@backstage/backend-common": "^0.21.3",
44
+ "@backstage/backend-plugin-api": "^0.6.13",
45
+ "@backstage/backend-tasks": "^0.5.18",
46
+ "@backstage/catalog-client": "^1.6.0",
47
+ "@backstage/catalog-model": "^1.4.4",
48
+ "@backstage/config": "^1.1.1",
49
+ "@backstage/plugin-catalog-common": "^1.0.21",
50
+ "@backstage/plugin-catalog-node": "^1.7.3",
51
+ "@backstage/plugin-permission-common": "^0.7.12",
52
+ "@backstage/plugin-search-backend-node": "^1.2.17",
53
+ "@backstage/plugin-search-common": "^1.2.10",
54
+ "@backstage/plugin-techdocs-node": "^1.11.5",
60
55
  "lodash": "^4.17.21",
61
56
  "node-fetch": "^2.6.7",
62
57
  "p-limit": "^3.1.0",
63
58
  "winston": "^3.2.1"
64
59
  },
65
60
  "devDependencies": {
66
- "@backstage/backend-test-utils": "^0.3.3-next.0",
67
- "@backstage/cli": "^0.25.3-next.0",
61
+ "@backstage/backend-test-utils": "^0.3.3",
62
+ "@backstage/cli": "^0.25.2",
68
63
  "msw": "^1.0.0"
69
64
  },
65
+ "files": [
66
+ "dist",
67
+ "config.d.ts",
68
+ "alpha"
69
+ ],
70
70
  "configSchema": "config.d.ts"
71
71
  }