@backstage/plugin-search-backend-module-techdocs 0.2.3-next.1 → 0.2.3-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 +16 -0
- package/alpha/package.json +1 -1
- package/dist/collators/DefaultTechDocsCollatorFactory.cjs.js +182 -0
- package/dist/collators/DefaultTechDocsCollatorFactory.cjs.js.map +1 -0
- package/dist/collators/defaultTechDocsCollatorEntityTransformer.cjs.js +37 -0
- package/dist/collators/defaultTechDocsCollatorEntityTransformer.cjs.js.map +1 -0
- package/dist/index.cjs.js +4 -207
- package/dist/index.cjs.js.map +1 -1
- package/package.json +8 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# @backstage/plugin-search-backend-module-techdocs
|
|
2
2
|
|
|
3
|
+
## 0.2.3-next.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
- @backstage/plugin-catalog-node@1.13.1-next.1
|
|
9
|
+
- @backstage/plugin-techdocs-node@1.12.12-next.2
|
|
10
|
+
- @backstage/catalog-client@1.7.1-next.0
|
|
11
|
+
- @backstage/backend-plugin-api@1.0.1-next.1
|
|
12
|
+
- @backstage/catalog-model@1.7.0
|
|
13
|
+
- @backstage/config@1.2.0
|
|
14
|
+
- @backstage/plugin-catalog-common@1.1.0
|
|
15
|
+
- @backstage/plugin-permission-common@0.8.1
|
|
16
|
+
- @backstage/plugin-search-backend-node@1.3.3-next.2
|
|
17
|
+
- @backstage/plugin-search-common@1.2.14
|
|
18
|
+
|
|
3
19
|
## 0.2.3-next.1
|
|
4
20
|
|
|
5
21
|
### Patch Changes
|
package/alpha/package.json
CHANGED
|
@@ -0,0 +1,182 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var backendCommon = require('@backstage/backend-common');
|
|
4
|
+
var catalogClient = require('@backstage/catalog-client');
|
|
5
|
+
var catalogModel = require('@backstage/catalog-model');
|
|
6
|
+
var alpha = require('@backstage/plugin-catalog-common/alpha');
|
|
7
|
+
var unescape = require('lodash/unescape');
|
|
8
|
+
var fetch = require('node-fetch');
|
|
9
|
+
var pLimit = require('p-limit');
|
|
10
|
+
var stream = require('stream');
|
|
11
|
+
var defaultTechDocsCollatorEntityTransformer = require('./defaultTechDocsCollatorEntityTransformer.cjs.js');
|
|
12
|
+
|
|
13
|
+
function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
|
|
14
|
+
|
|
15
|
+
var unescape__default = /*#__PURE__*/_interopDefaultCompat(unescape);
|
|
16
|
+
var fetch__default = /*#__PURE__*/_interopDefaultCompat(fetch);
|
|
17
|
+
var pLimit__default = /*#__PURE__*/_interopDefaultCompat(pLimit);
|
|
18
|
+
|
|
19
|
+
class DefaultTechDocsCollatorFactory {
|
|
20
|
+
type = "techdocs";
|
|
21
|
+
visibilityPermission = alpha.catalogEntityReadPermission;
|
|
22
|
+
discovery;
|
|
23
|
+
locationTemplate;
|
|
24
|
+
logger;
|
|
25
|
+
auth;
|
|
26
|
+
catalogClient;
|
|
27
|
+
parallelismLimit;
|
|
28
|
+
legacyPathCasing;
|
|
29
|
+
entityTransformer;
|
|
30
|
+
constructor(options) {
|
|
31
|
+
this.discovery = options.discovery;
|
|
32
|
+
this.locationTemplate = options.locationTemplate || "/docs/:namespace/:kind/:name/:path";
|
|
33
|
+
this.logger = options.logger.child({ documentType: this.type });
|
|
34
|
+
this.catalogClient = options.catalogClient || new catalogClient.CatalogClient({ discoveryApi: options.discovery });
|
|
35
|
+
this.parallelismLimit = options.parallelismLimit ?? 10;
|
|
36
|
+
this.legacyPathCasing = options.legacyPathCasing ?? false;
|
|
37
|
+
this.entityTransformer = options.entityTransformer ?? defaultTechDocsCollatorEntityTransformer.defaultTechDocsCollatorEntityTransformer;
|
|
38
|
+
this.auth = backendCommon.createLegacyAuthAdapters({
|
|
39
|
+
auth: options.auth,
|
|
40
|
+
discovery: options.discovery,
|
|
41
|
+
tokenManager: options.tokenManager
|
|
42
|
+
}).auth;
|
|
43
|
+
}
|
|
44
|
+
static fromConfig(config, options) {
|
|
45
|
+
const legacyPathCasing = config.getOptionalBoolean(
|
|
46
|
+
"techdocs.legacyUseCaseSensitiveTripletPaths"
|
|
47
|
+
) || false;
|
|
48
|
+
const locationTemplate = config.getOptionalString(
|
|
49
|
+
"search.collators.techdocs.locationTemplate"
|
|
50
|
+
);
|
|
51
|
+
const parallelismLimit = config.getOptionalNumber(
|
|
52
|
+
"search.collators.techdocs.parallelismLimit"
|
|
53
|
+
);
|
|
54
|
+
return new DefaultTechDocsCollatorFactory({
|
|
55
|
+
...options,
|
|
56
|
+
locationTemplate,
|
|
57
|
+
parallelismLimit,
|
|
58
|
+
legacyPathCasing
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
async getCollator() {
|
|
62
|
+
return stream.Readable.from(this.execute());
|
|
63
|
+
}
|
|
64
|
+
async *execute() {
|
|
65
|
+
const limit = pLimit__default.default(this.parallelismLimit);
|
|
66
|
+
const techDocsBaseUrl = await this.discovery.getBaseUrl("techdocs");
|
|
67
|
+
let entitiesRetrieved = 0;
|
|
68
|
+
let moreEntitiesToGet = true;
|
|
69
|
+
const batchSize = this.parallelismLimit * 50;
|
|
70
|
+
while (moreEntitiesToGet) {
|
|
71
|
+
const { token: catalogToken } = await this.auth.getPluginRequestToken({
|
|
72
|
+
onBehalfOf: await this.auth.getOwnServiceCredentials(),
|
|
73
|
+
targetPluginId: "catalog"
|
|
74
|
+
});
|
|
75
|
+
const entities = (await this.catalogClient.getEntities(
|
|
76
|
+
{
|
|
77
|
+
filter: {
|
|
78
|
+
"metadata.annotations.backstage.io/techdocs-ref": catalogClient.CATALOG_FILTER_EXISTS
|
|
79
|
+
},
|
|
80
|
+
limit: batchSize,
|
|
81
|
+
offset: entitiesRetrieved
|
|
82
|
+
},
|
|
83
|
+
{ token: catalogToken }
|
|
84
|
+
)).items;
|
|
85
|
+
moreEntitiesToGet = entities.length === batchSize;
|
|
86
|
+
entitiesRetrieved += entities.length;
|
|
87
|
+
const docPromises = entities.filter((it) => it.metadata?.annotations?.["backstage.io/techdocs-ref"]).map(
|
|
88
|
+
(entity) => limit(async () => {
|
|
89
|
+
const entityInfo = DefaultTechDocsCollatorFactory.handleEntityInfoCasing(
|
|
90
|
+
this.legacyPathCasing,
|
|
91
|
+
{
|
|
92
|
+
kind: entity.kind,
|
|
93
|
+
namespace: entity.metadata.namespace || "default",
|
|
94
|
+
name: entity.metadata.name
|
|
95
|
+
}
|
|
96
|
+
);
|
|
97
|
+
try {
|
|
98
|
+
const { token: techdocsToken } = await this.auth.getPluginRequestToken({
|
|
99
|
+
onBehalfOf: await this.auth.getOwnServiceCredentials(),
|
|
100
|
+
targetPluginId: "techdocs"
|
|
101
|
+
});
|
|
102
|
+
const searchIndexResponse = await fetch__default.default(
|
|
103
|
+
DefaultTechDocsCollatorFactory.constructDocsIndexUrl(
|
|
104
|
+
techDocsBaseUrl,
|
|
105
|
+
entityInfo
|
|
106
|
+
),
|
|
107
|
+
{
|
|
108
|
+
headers: {
|
|
109
|
+
Authorization: `Bearer ${techdocsToken}`
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
);
|
|
113
|
+
const searchIndex = await Promise.race([
|
|
114
|
+
searchIndexResponse.json(),
|
|
115
|
+
new Promise((_resolve, reject) => {
|
|
116
|
+
setTimeout(() => {
|
|
117
|
+
reject("Could not parse JSON in 5 seconds.");
|
|
118
|
+
}, 5e3);
|
|
119
|
+
})
|
|
120
|
+
]);
|
|
121
|
+
return searchIndex.docs.map((doc) => ({
|
|
122
|
+
...this.entityTransformer(entity),
|
|
123
|
+
title: unescape__default.default(doc.title),
|
|
124
|
+
text: unescape__default.default(doc.text || ""),
|
|
125
|
+
location: this.applyArgsToFormat(
|
|
126
|
+
this.locationTemplate || "/docs/:namespace/:kind/:name/:path",
|
|
127
|
+
{
|
|
128
|
+
...entityInfo,
|
|
129
|
+
path: doc.location
|
|
130
|
+
}
|
|
131
|
+
),
|
|
132
|
+
path: doc.location,
|
|
133
|
+
...entityInfo,
|
|
134
|
+
entityTitle: entity.metadata.title,
|
|
135
|
+
componentType: entity.spec?.type?.toString() || "other",
|
|
136
|
+
lifecycle: entity.spec?.lifecycle || "",
|
|
137
|
+
owner: getSimpleEntityOwnerString(entity),
|
|
138
|
+
authorization: {
|
|
139
|
+
resourceRef: catalogModel.stringifyEntityRef(entity)
|
|
140
|
+
}
|
|
141
|
+
}));
|
|
142
|
+
} catch (e) {
|
|
143
|
+
this.logger.debug(
|
|
144
|
+
`Failed to retrieve tech docs search index for entity ${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}`,
|
|
145
|
+
e
|
|
146
|
+
);
|
|
147
|
+
return [];
|
|
148
|
+
}
|
|
149
|
+
})
|
|
150
|
+
);
|
|
151
|
+
yield* (await Promise.all(docPromises)).flat();
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
applyArgsToFormat(format, args) {
|
|
155
|
+
let formatted = format;
|
|
156
|
+
for (const [key, value] of Object.entries(args)) {
|
|
157
|
+
formatted = formatted.replace(`:${key}`, value);
|
|
158
|
+
}
|
|
159
|
+
return formatted;
|
|
160
|
+
}
|
|
161
|
+
static constructDocsIndexUrl(techDocsBaseUrl, entityInfo) {
|
|
162
|
+
return `${techDocsBaseUrl}/static/docs/${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}/search/search_index.json`;
|
|
163
|
+
}
|
|
164
|
+
static handleEntityInfoCasing(legacyPaths, entityInfo) {
|
|
165
|
+
return legacyPaths ? entityInfo : Object.entries(entityInfo).reduce((acc, [key, value]) => {
|
|
166
|
+
return { ...acc, [key]: value.toLocaleLowerCase("en-US") };
|
|
167
|
+
}, {});
|
|
168
|
+
}
|
|
169
|
+
}
|
|
170
|
+
function getSimpleEntityOwnerString(entity) {
|
|
171
|
+
if (entity.relations) {
|
|
172
|
+
const owner = entity.relations.find((r) => r.type === catalogModel.RELATION_OWNED_BY);
|
|
173
|
+
if (owner) {
|
|
174
|
+
const { name } = catalogModel.parseEntityRef(owner.targetRef);
|
|
175
|
+
return name;
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
return "";
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
exports.DefaultTechDocsCollatorFactory = DefaultTechDocsCollatorFactory;
|
|
182
|
+
//# sourceMappingURL=DefaultTechDocsCollatorFactory.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"DefaultTechDocsCollatorFactory.cjs.js","sources":["../../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 {\n createLegacyAuthAdapters,\n TokenManager,\n} from '@backstage/backend-common';\nimport {\n CATALOG_FILTER_EXISTS,\n CatalogApi,\n CatalogClient,\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 { TechDocsCollatorEntityTransformer } from './TechDocsCollatorEntityTransformer';\nimport { defaultTechDocsCollatorEntityTransformer } from './defaultTechDocsCollatorEntityTransformer';\nimport {\n AuthService,\n DiscoveryService,\n HttpAuthService,\n LoggerService,\n} 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 * @deprecated This type is deprecated along with the {@link DefaultTechDocsCollatorFactory}.\n */\nexport type TechDocsCollatorFactoryOptions = {\n discovery: DiscoveryService;\n logger: LoggerService;\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 * @deprecated Migrate to the {@link https://backstage.io/docs/backend-system/building-backends/migrating | new backend system} and install this collator via module instead (see {@link https://github.com/backstage/backstage/blob/nbs10/search-deprecate-create-router/plugins/search-backend-module-techdocs/README.md#installation | here} for more installation details).\n */\nexport class DefaultTechDocsCollatorFactory implements DocumentCollatorFactory {\n public readonly type: string = 'techdocs';\n public readonly visibilityPermission: Permission =\n catalogEntityReadPermission;\n\n private discovery: DiscoveryService;\n private locationTemplate: string;\n private readonly logger: LoggerService;\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":["catalogEntityReadPermission","CatalogClient","defaultTechDocsCollatorEntityTransformer","createLegacyAuthAdapters","Readable","pLimit","CATALOG_FILTER_EXISTS","fetch","unescape","stringifyEntityRef","RELATION_OWNED_BY","parseEntityRef"],"mappings":";;;;;;;;;;;;;;;;;;AAuFO,MAAM,8BAAkE,CAAA;AAAA,EAC7D,IAAe,GAAA,UAAA,CAAA;AAAA,EACf,oBACd,GAAAA,iCAAA,CAAA;AAAA,EAEM,SAAA,CAAA;AAAA,EACA,gBAAA,CAAA;AAAA,EACS,MAAA,CAAA;AAAA,EACA,IAAA,CAAA;AAAA,EACA,aAAA,CAAA;AAAA,EACA,gBAAA,CAAA;AAAA,EACA,gBAAA,CAAA;AAAA,EACT,iBAAA,CAAA;AAAA,EAEA,YAAY,OAAyC,EAAA;AAC3D,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,GAAmB,QAAQ,gBAAoB,IAAA,EAAA,CAAA;AACpD,IAAK,IAAA,CAAA,gBAAA,GAAmB,QAAQ,gBAAoB,IAAA,KAAA,CAAA;AACpD,IAAK,IAAA,CAAA,iBAAA,GACH,QAAQ,iBAAqB,IAAAC,iFAAA,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,uBAAO,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,SACjB,MAAO,CAAA,CAAA,EAAA,KAAM,GAAG,QAAU,EAAA,WAAA,GAAc,2BAA2B,CAAC,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,sBAAA;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,GAA2B,MAAA;AAAA,cACtD,GAAG,IAAK,CAAA,iBAAA,CAAkB,MAAM,CAAA;AAAA,cAChC,KAAA,EAAOC,yBAAS,CAAA,GAAA,CAAI,KAAK,CAAA;AAAA,cACzB,IAAM,EAAAA,yBAAA,CAAS,GAAI,CAAA,IAAA,IAAQ,EAAE,CAAA;AAAA,cAC7B,UAAU,IAAK,CAAA,iBAAA;AAAA,gBACb,KAAK,gBAAoB,IAAA,oCAAA;AAAA,gBACzB;AAAA,kBACE,GAAG,UAAA;AAAA,kBACH,MAAM,GAAI,CAAA,QAAA;AAAA,iBACZ;AAAA,eACF;AAAA,cACA,MAAM,GAAI,CAAA,QAAA;AAAA,cACV,GAAG,UAAA;AAAA,cACH,WAAA,EAAa,OAAO,QAAS,CAAA,KAAA;AAAA,cAC7B,aAAe,EAAA,MAAA,CAAO,IAAM,EAAA,IAAA,EAAM,UAAc,IAAA,OAAA;AAAA,cAChD,SAAA,EAAY,MAAO,CAAA,IAAA,EAAM,SAAwB,IAAA,EAAA;AAAA,cACjD,KAAA,EAAO,2BAA2B,MAAM,CAAA;AAAA,cACxC,aAAe,EAAA;AAAA,gBACb,WAAA,EAAaC,gCAAmB,MAAM,CAAA;AAAA,eACxC;AAAA,aACA,CAAA,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;;;;"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var catalogModel = require('@backstage/catalog-model');
|
|
4
|
+
|
|
5
|
+
const getDocumentText = (entity) => {
|
|
6
|
+
const documentTexts = [];
|
|
7
|
+
documentTexts.push(entity.metadata.description || "");
|
|
8
|
+
if (catalogModel.isUserEntity(entity) || catalogModel.isGroupEntity(entity)) {
|
|
9
|
+
if (entity.spec?.profile?.displayName) {
|
|
10
|
+
documentTexts.push(entity.spec.profile.displayName);
|
|
11
|
+
}
|
|
12
|
+
}
|
|
13
|
+
if (catalogModel.isUserEntity(entity)) {
|
|
14
|
+
if (entity.spec?.profile?.email) {
|
|
15
|
+
documentTexts.push(entity.spec.profile.email);
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
return documentTexts.join(" : ");
|
|
19
|
+
};
|
|
20
|
+
const defaultTechDocsCollatorEntityTransformer = (entity) => {
|
|
21
|
+
return {
|
|
22
|
+
kind: entity.kind,
|
|
23
|
+
namespace: entity.metadata.namespace || "default",
|
|
24
|
+
annotations: entity.metadata.annotations || "",
|
|
25
|
+
name: entity.metadata.name || "",
|
|
26
|
+
title: entity.metadata.title || "",
|
|
27
|
+
text: getDocumentText(entity),
|
|
28
|
+
componentType: entity.spec?.type?.toString() || "other",
|
|
29
|
+
type: entity.spec?.type?.toString() || "other",
|
|
30
|
+
lifecycle: entity.spec?.lifecycle || "",
|
|
31
|
+
owner: entity.spec?.owner || "",
|
|
32
|
+
path: ""
|
|
33
|
+
};
|
|
34
|
+
};
|
|
35
|
+
|
|
36
|
+
exports.defaultTechDocsCollatorEntityTransformer = defaultTechDocsCollatorEntityTransformer;
|
|
37
|
+
//# sourceMappingURL=defaultTechDocsCollatorEntityTransformer.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"defaultTechDocsCollatorEntityTransformer.cjs.js","sources":["../../src/collators/defaultTechDocsCollatorEntityTransformer.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"],"names":["isUserEntity","isGroupEntity"],"mappings":";;;;AAmBA,MAAM,eAAA,GAAkB,CAAC,MAA2B,KAAA;AAClD,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,IAAI,IAAA,MAAA,CAAO,IAAM,EAAA,OAAA,EAAS,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,IAAI,IAAA,MAAA,CAAO,IAAM,EAAA,OAAA,EAAS,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;AAClB,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,aAAe,EAAA,MAAA,CAAO,IAAM,EAAA,IAAA,EAAM,UAAc,IAAA,OAAA;AAAA,IAChD,IAAM,EAAA,MAAA,CAAO,IAAM,EAAA,IAAA,EAAM,UAAc,IAAA,OAAA;AAAA,IACvC,SAAA,EAAY,MAAO,CAAA,IAAA,EAAM,SAAwB,IAAA,EAAA;AAAA,IACjD,KAAA,EAAQ,MAAO,CAAA,IAAA,EAAM,KAAoB,IAAA,EAAA;AAAA,IACzC,IAAM,EAAA,EAAA;AAAA,GACR,CAAA;AACF;;;;"}
|
package/dist/index.cjs.js
CHANGED
|
@@ -1,213 +1,10 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var
|
|
4
|
-
var
|
|
5
|
-
var catalogModel = require('@backstage/catalog-model');
|
|
6
|
-
var alpha = require('@backstage/plugin-catalog-common/alpha');
|
|
7
|
-
var unescape = require('lodash/unescape');
|
|
8
|
-
var fetch = require('node-fetch');
|
|
9
|
-
var pLimit = require('p-limit');
|
|
10
|
-
var stream = require('stream');
|
|
3
|
+
var DefaultTechDocsCollatorFactory = require('./collators/DefaultTechDocsCollatorFactory.cjs.js');
|
|
4
|
+
var defaultTechDocsCollatorEntityTransformer = require('./collators/defaultTechDocsCollatorEntityTransformer.cjs.js');
|
|
11
5
|
|
|
12
|
-
function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
|
|
13
6
|
|
|
14
|
-
var unescape__default = /*#__PURE__*/_interopDefaultCompat(unescape);
|
|
15
|
-
var fetch__default = /*#__PURE__*/_interopDefaultCompat(fetch);
|
|
16
|
-
var pLimit__default = /*#__PURE__*/_interopDefaultCompat(pLimit);
|
|
17
7
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
documentTexts.push(entity.metadata.description || "");
|
|
21
|
-
if (catalogModel.isUserEntity(entity) || catalogModel.isGroupEntity(entity)) {
|
|
22
|
-
if (entity.spec?.profile?.displayName) {
|
|
23
|
-
documentTexts.push(entity.spec.profile.displayName);
|
|
24
|
-
}
|
|
25
|
-
}
|
|
26
|
-
if (catalogModel.isUserEntity(entity)) {
|
|
27
|
-
if (entity.spec?.profile?.email) {
|
|
28
|
-
documentTexts.push(entity.spec.profile.email);
|
|
29
|
-
}
|
|
30
|
-
}
|
|
31
|
-
return documentTexts.join(" : ");
|
|
32
|
-
};
|
|
33
|
-
const defaultTechDocsCollatorEntityTransformer = (entity) => {
|
|
34
|
-
return {
|
|
35
|
-
kind: entity.kind,
|
|
36
|
-
namespace: entity.metadata.namespace || "default",
|
|
37
|
-
annotations: entity.metadata.annotations || "",
|
|
38
|
-
name: entity.metadata.name || "",
|
|
39
|
-
title: entity.metadata.title || "",
|
|
40
|
-
text: getDocumentText(entity),
|
|
41
|
-
componentType: entity.spec?.type?.toString() || "other",
|
|
42
|
-
type: entity.spec?.type?.toString() || "other",
|
|
43
|
-
lifecycle: entity.spec?.lifecycle || "",
|
|
44
|
-
owner: entity.spec?.owner || "",
|
|
45
|
-
path: ""
|
|
46
|
-
};
|
|
47
|
-
};
|
|
48
|
-
|
|
49
|
-
class DefaultTechDocsCollatorFactory {
|
|
50
|
-
type = "techdocs";
|
|
51
|
-
visibilityPermission = alpha.catalogEntityReadPermission;
|
|
52
|
-
discovery;
|
|
53
|
-
locationTemplate;
|
|
54
|
-
logger;
|
|
55
|
-
auth;
|
|
56
|
-
catalogClient;
|
|
57
|
-
parallelismLimit;
|
|
58
|
-
legacyPathCasing;
|
|
59
|
-
entityTransformer;
|
|
60
|
-
constructor(options) {
|
|
61
|
-
this.discovery = options.discovery;
|
|
62
|
-
this.locationTemplate = options.locationTemplate || "/docs/:namespace/:kind/:name/:path";
|
|
63
|
-
this.logger = options.logger.child({ documentType: this.type });
|
|
64
|
-
this.catalogClient = options.catalogClient || new catalogClient.CatalogClient({ discoveryApi: options.discovery });
|
|
65
|
-
this.parallelismLimit = options.parallelismLimit ?? 10;
|
|
66
|
-
this.legacyPathCasing = options.legacyPathCasing ?? false;
|
|
67
|
-
this.entityTransformer = options.entityTransformer ?? defaultTechDocsCollatorEntityTransformer;
|
|
68
|
-
this.auth = backendCommon.createLegacyAuthAdapters({
|
|
69
|
-
auth: options.auth,
|
|
70
|
-
discovery: options.discovery,
|
|
71
|
-
tokenManager: options.tokenManager
|
|
72
|
-
}).auth;
|
|
73
|
-
}
|
|
74
|
-
static fromConfig(config, options) {
|
|
75
|
-
const legacyPathCasing = config.getOptionalBoolean(
|
|
76
|
-
"techdocs.legacyUseCaseSensitiveTripletPaths"
|
|
77
|
-
) || false;
|
|
78
|
-
const locationTemplate = config.getOptionalString(
|
|
79
|
-
"search.collators.techdocs.locationTemplate"
|
|
80
|
-
);
|
|
81
|
-
const parallelismLimit = config.getOptionalNumber(
|
|
82
|
-
"search.collators.techdocs.parallelismLimit"
|
|
83
|
-
);
|
|
84
|
-
return new DefaultTechDocsCollatorFactory({
|
|
85
|
-
...options,
|
|
86
|
-
locationTemplate,
|
|
87
|
-
parallelismLimit,
|
|
88
|
-
legacyPathCasing
|
|
89
|
-
});
|
|
90
|
-
}
|
|
91
|
-
async getCollator() {
|
|
92
|
-
return stream.Readable.from(this.execute());
|
|
93
|
-
}
|
|
94
|
-
async *execute() {
|
|
95
|
-
const limit = pLimit__default.default(this.parallelismLimit);
|
|
96
|
-
const techDocsBaseUrl = await this.discovery.getBaseUrl("techdocs");
|
|
97
|
-
let entitiesRetrieved = 0;
|
|
98
|
-
let moreEntitiesToGet = true;
|
|
99
|
-
const batchSize = this.parallelismLimit * 50;
|
|
100
|
-
while (moreEntitiesToGet) {
|
|
101
|
-
const { token: catalogToken } = await this.auth.getPluginRequestToken({
|
|
102
|
-
onBehalfOf: await this.auth.getOwnServiceCredentials(),
|
|
103
|
-
targetPluginId: "catalog"
|
|
104
|
-
});
|
|
105
|
-
const entities = (await this.catalogClient.getEntities(
|
|
106
|
-
{
|
|
107
|
-
filter: {
|
|
108
|
-
"metadata.annotations.backstage.io/techdocs-ref": catalogClient.CATALOG_FILTER_EXISTS
|
|
109
|
-
},
|
|
110
|
-
limit: batchSize,
|
|
111
|
-
offset: entitiesRetrieved
|
|
112
|
-
},
|
|
113
|
-
{ token: catalogToken }
|
|
114
|
-
)).items;
|
|
115
|
-
moreEntitiesToGet = entities.length === batchSize;
|
|
116
|
-
entitiesRetrieved += entities.length;
|
|
117
|
-
const docPromises = entities.filter((it) => it.metadata?.annotations?.["backstage.io/techdocs-ref"]).map(
|
|
118
|
-
(entity) => limit(async () => {
|
|
119
|
-
const entityInfo = DefaultTechDocsCollatorFactory.handleEntityInfoCasing(
|
|
120
|
-
this.legacyPathCasing,
|
|
121
|
-
{
|
|
122
|
-
kind: entity.kind,
|
|
123
|
-
namespace: entity.metadata.namespace || "default",
|
|
124
|
-
name: entity.metadata.name
|
|
125
|
-
}
|
|
126
|
-
);
|
|
127
|
-
try {
|
|
128
|
-
const { token: techdocsToken } = await this.auth.getPluginRequestToken({
|
|
129
|
-
onBehalfOf: await this.auth.getOwnServiceCredentials(),
|
|
130
|
-
targetPluginId: "techdocs"
|
|
131
|
-
});
|
|
132
|
-
const searchIndexResponse = await fetch__default.default(
|
|
133
|
-
DefaultTechDocsCollatorFactory.constructDocsIndexUrl(
|
|
134
|
-
techDocsBaseUrl,
|
|
135
|
-
entityInfo
|
|
136
|
-
),
|
|
137
|
-
{
|
|
138
|
-
headers: {
|
|
139
|
-
Authorization: `Bearer ${techdocsToken}`
|
|
140
|
-
}
|
|
141
|
-
}
|
|
142
|
-
);
|
|
143
|
-
const searchIndex = await Promise.race([
|
|
144
|
-
searchIndexResponse.json(),
|
|
145
|
-
new Promise((_resolve, reject) => {
|
|
146
|
-
setTimeout(() => {
|
|
147
|
-
reject("Could not parse JSON in 5 seconds.");
|
|
148
|
-
}, 5e3);
|
|
149
|
-
})
|
|
150
|
-
]);
|
|
151
|
-
return searchIndex.docs.map((doc) => ({
|
|
152
|
-
...this.entityTransformer(entity),
|
|
153
|
-
title: unescape__default.default(doc.title),
|
|
154
|
-
text: unescape__default.default(doc.text || ""),
|
|
155
|
-
location: this.applyArgsToFormat(
|
|
156
|
-
this.locationTemplate || "/docs/:namespace/:kind/:name/:path",
|
|
157
|
-
{
|
|
158
|
-
...entityInfo,
|
|
159
|
-
path: doc.location
|
|
160
|
-
}
|
|
161
|
-
),
|
|
162
|
-
path: doc.location,
|
|
163
|
-
...entityInfo,
|
|
164
|
-
entityTitle: entity.metadata.title,
|
|
165
|
-
componentType: entity.spec?.type?.toString() || "other",
|
|
166
|
-
lifecycle: entity.spec?.lifecycle || "",
|
|
167
|
-
owner: getSimpleEntityOwnerString(entity),
|
|
168
|
-
authorization: {
|
|
169
|
-
resourceRef: catalogModel.stringifyEntityRef(entity)
|
|
170
|
-
}
|
|
171
|
-
}));
|
|
172
|
-
} catch (e) {
|
|
173
|
-
this.logger.debug(
|
|
174
|
-
`Failed to retrieve tech docs search index for entity ${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}`,
|
|
175
|
-
e
|
|
176
|
-
);
|
|
177
|
-
return [];
|
|
178
|
-
}
|
|
179
|
-
})
|
|
180
|
-
);
|
|
181
|
-
yield* (await Promise.all(docPromises)).flat();
|
|
182
|
-
}
|
|
183
|
-
}
|
|
184
|
-
applyArgsToFormat(format, args) {
|
|
185
|
-
let formatted = format;
|
|
186
|
-
for (const [key, value] of Object.entries(args)) {
|
|
187
|
-
formatted = formatted.replace(`:${key}`, value);
|
|
188
|
-
}
|
|
189
|
-
return formatted;
|
|
190
|
-
}
|
|
191
|
-
static constructDocsIndexUrl(techDocsBaseUrl, entityInfo) {
|
|
192
|
-
return `${techDocsBaseUrl}/static/docs/${entityInfo.namespace}/${entityInfo.kind}/${entityInfo.name}/search/search_index.json`;
|
|
193
|
-
}
|
|
194
|
-
static handleEntityInfoCasing(legacyPaths, entityInfo) {
|
|
195
|
-
return legacyPaths ? entityInfo : Object.entries(entityInfo).reduce((acc, [key, value]) => {
|
|
196
|
-
return { ...acc, [key]: value.toLocaleLowerCase("en-US") };
|
|
197
|
-
}, {});
|
|
198
|
-
}
|
|
199
|
-
}
|
|
200
|
-
function getSimpleEntityOwnerString(entity) {
|
|
201
|
-
if (entity.relations) {
|
|
202
|
-
const owner = entity.relations.find((r) => r.type === catalogModel.RELATION_OWNED_BY);
|
|
203
|
-
if (owner) {
|
|
204
|
-
const { name } = catalogModel.parseEntityRef(owner.targetRef);
|
|
205
|
-
return name;
|
|
206
|
-
}
|
|
207
|
-
}
|
|
208
|
-
return "";
|
|
209
|
-
}
|
|
210
|
-
|
|
211
|
-
exports.DefaultTechDocsCollatorFactory = DefaultTechDocsCollatorFactory;
|
|
212
|
-
exports.defaultTechDocsCollatorEntityTransformer = defaultTechDocsCollatorEntityTransformer;
|
|
8
|
+
exports.DefaultTechDocsCollatorFactory = DefaultTechDocsCollatorFactory.DefaultTechDocsCollatorFactory;
|
|
9
|
+
exports.defaultTechDocsCollatorEntityTransformer = defaultTechDocsCollatorEntityTransformer.defaultTechDocsCollatorEntityTransformer;
|
|
213
10
|
//# sourceMappingURL=index.cjs.js.map
|
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 createLegacyAuthAdapters,\n TokenManager,\n} from '@backstage/backend-common';\nimport {\n CATALOG_FILTER_EXISTS,\n CatalogApi,\n CatalogClient,\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 { TechDocsCollatorEntityTransformer } from './TechDocsCollatorEntityTransformer';\nimport { defaultTechDocsCollatorEntityTransformer } from './defaultTechDocsCollatorEntityTransformer';\nimport {\n AuthService,\n DiscoveryService,\n HttpAuthService,\n LoggerService,\n} 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 * @deprecated This type is deprecated along with the {@link DefaultTechDocsCollatorFactory}.\n */\nexport type TechDocsCollatorFactoryOptions = {\n discovery: DiscoveryService;\n logger: LoggerService;\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 * @deprecated Migrate to the {@link https://backstage.io/docs/backend-system/building-backends/migrating | new backend system} and install this collator via module instead (see {@link https://github.com/backstage/backstage/blob/nbs10/search-deprecate-create-router/plugins/search-backend-module-techdocs/README.md#installation | here} for more installation details).\n */\nexport class DefaultTechDocsCollatorFactory implements DocumentCollatorFactory {\n public readonly type: string = 'techdocs';\n public readonly visibilityPermission: Permission =\n catalogEntityReadPermission;\n\n private discovery: DiscoveryService;\n private locationTemplate: string;\n private readonly logger: LoggerService;\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;AAClD,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,IAAI,IAAA,MAAA,CAAO,IAAM,EAAA,OAAA,EAAS,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,IAAI,IAAA,MAAA,CAAO,IAAM,EAAA,OAAA,EAAS,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;AAClB,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,aAAe,EAAA,MAAA,CAAO,IAAM,EAAA,IAAA,EAAM,UAAc,IAAA,OAAA;AAAA,IAChD,IAAM,EAAA,MAAA,CAAO,IAAM,EAAA,IAAA,EAAM,UAAc,IAAA,OAAA;AAAA,IACvC,SAAA,EAAY,MAAO,CAAA,IAAA,EAAM,SAAwB,IAAA,EAAA;AAAA,IACjD,KAAA,EAAQ,MAAO,CAAA,IAAA,EAAM,KAAoB,IAAA,EAAA;AAAA,IACzC,IAAM,EAAA,EAAA;AAAA,GACR,CAAA;AACF;;ACiCK,MAAM,8BAAkE,CAAA;AAAA,EAC7D,IAAe,GAAA,UAAA,CAAA;AAAA,EACf,oBACd,GAAAE,iCAAA,CAAA;AAAA,EAEM,SAAA,CAAA;AAAA,EACA,gBAAA,CAAA;AAAA,EACS,MAAA,CAAA;AAAA,EACA,IAAA,CAAA;AAAA,EACA,aAAA,CAAA;AAAA,EACA,gBAAA,CAAA;AAAA,EACA,gBAAA,CAAA;AAAA,EACT,iBAAA,CAAA;AAAA,EAEA,YAAY,OAAyC,EAAA;AAC3D,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,GAAmB,QAAQ,gBAAoB,IAAA,EAAA,CAAA;AACpD,IAAK,IAAA,CAAA,gBAAA,GAAmB,QAAQ,gBAAoB,IAAA,KAAA,CAAA;AACpD,IAAK,IAAA,CAAA,iBAAA,GACH,QAAQ,iBAAqB,IAAA,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,uBAAO,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,SACjB,MAAO,CAAA,CAAA,EAAA,KAAM,GAAG,QAAU,EAAA,WAAA,GAAc,2BAA2B,CAAC,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,sBAAA;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,GAA2B,MAAA;AAAA,cACtD,GAAG,IAAK,CAAA,iBAAA,CAAkB,MAAM,CAAA;AAAA,cAChC,KAAA,EAAOC,yBAAS,CAAA,GAAA,CAAI,KAAK,CAAA;AAAA,cACzB,IAAM,EAAAA,yBAAA,CAAS,GAAI,CAAA,IAAA,IAAQ,EAAE,CAAA;AAAA,cAC7B,UAAU,IAAK,CAAA,iBAAA;AAAA,gBACb,KAAK,gBAAoB,IAAA,oCAAA;AAAA,gBACzB;AAAA,kBACE,GAAG,UAAA;AAAA,kBACH,MAAM,GAAI,CAAA,QAAA;AAAA,iBACZ;AAAA,eACF;AAAA,cACA,MAAM,GAAI,CAAA,QAAA;AAAA,cACV,GAAG,UAAA;AAAA,cACH,WAAA,EAAa,OAAO,QAAS,CAAA,KAAA;AAAA,cAC7B,aAAe,EAAA,MAAA,CAAO,IAAM,EAAA,IAAA,EAAM,UAAc,IAAA,OAAA;AAAA,cAChD,SAAA,EAAY,MAAO,CAAA,IAAA,EAAM,SAAwB,IAAA,EAAA;AAAA,cACjD,KAAA,EAAO,2BAA2B,MAAM,CAAA;AAAA,cACxC,aAAe,EAAA;AAAA,gBACb,WAAA,EAAaC,gCAAmB,MAAM,CAAA;AAAA,eACxC;AAAA,aACA,CAAA,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":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-search-backend-module-techdocs",
|
|
3
|
-
"version": "0.2.3-next.
|
|
3
|
+
"version": "0.2.3-next.2",
|
|
4
4
|
"description": "A module for the search backend that exports techdocs modules",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "backend-plugin-module",
|
|
@@ -49,23 +49,23 @@
|
|
|
49
49
|
},
|
|
50
50
|
"dependencies": {
|
|
51
51
|
"@backstage/backend-common": "^0.25.0",
|
|
52
|
-
"@backstage/backend-plugin-api": "1.0.1-next.
|
|
53
|
-
"@backstage/catalog-client": "1.7.0",
|
|
52
|
+
"@backstage/backend-plugin-api": "1.0.1-next.1",
|
|
53
|
+
"@backstage/catalog-client": "1.7.1-next.0",
|
|
54
54
|
"@backstage/catalog-model": "1.7.0",
|
|
55
55
|
"@backstage/config": "1.2.0",
|
|
56
56
|
"@backstage/plugin-catalog-common": "1.1.0",
|
|
57
|
-
"@backstage/plugin-catalog-node": "1.13.1-next.
|
|
57
|
+
"@backstage/plugin-catalog-node": "1.13.1-next.1",
|
|
58
58
|
"@backstage/plugin-permission-common": "0.8.1",
|
|
59
|
-
"@backstage/plugin-search-backend-node": "1.3.3-next.
|
|
59
|
+
"@backstage/plugin-search-backend-node": "1.3.3-next.2",
|
|
60
60
|
"@backstage/plugin-search-common": "1.2.14",
|
|
61
|
-
"@backstage/plugin-techdocs-node": "1.12.12-next.
|
|
61
|
+
"@backstage/plugin-techdocs-node": "1.12.12-next.2",
|
|
62
62
|
"lodash": "^4.17.21",
|
|
63
63
|
"node-fetch": "^2.7.0",
|
|
64
64
|
"p-limit": "^3.1.0"
|
|
65
65
|
},
|
|
66
66
|
"devDependencies": {
|
|
67
|
-
"@backstage/backend-test-utils": "1.0.1-next.
|
|
68
|
-
"@backstage/cli": "0.28.0-next.
|
|
67
|
+
"@backstage/backend-test-utils": "1.0.1-next.2",
|
|
68
|
+
"@backstage/cli": "0.28.0-next.2",
|
|
69
69
|
"msw": "^1.0.0"
|
|
70
70
|
},
|
|
71
71
|
"configSchema": "config.d.ts"
|