@backstage/plugin-search-backend-module-techdocs 0.1.28-next.2 → 0.2.0
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 +40 -0
- package/alpha/package.json +1 -1
- package/config.d.ts +2 -2
- package/dist/alpha.cjs.js +1 -2
- package/dist/alpha.cjs.js.map +1 -1
- package/package.json +13 -14
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,45 @@
|
|
|
1
1
|
# @backstage/plugin-search-backend-module-techdocs
|
|
2
2
|
|
|
3
|
+
## 0.2.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- fc24d9e: Stop using `@backstage/backend-tasks` as it will be deleted in near future.
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- 93095ee: Make sure node-fetch is version 2.7.0 or greater
|
|
12
|
+
- Updated dependencies
|
|
13
|
+
- @backstage/backend-plugin-api@0.8.0
|
|
14
|
+
- @backstage/backend-common@0.24.0
|
|
15
|
+
- @backstage/plugin-search-backend-node@1.3.0
|
|
16
|
+
- @backstage/plugin-techdocs-node@1.12.9
|
|
17
|
+
- @backstage/plugin-permission-common@0.8.1
|
|
18
|
+
- @backstage/plugin-search-common@1.2.14
|
|
19
|
+
- @backstage/plugin-catalog-node@1.12.5
|
|
20
|
+
- @backstage/catalog-model@1.6.0
|
|
21
|
+
- @backstage/catalog-client@1.6.6
|
|
22
|
+
- @backstage/config@1.2.0
|
|
23
|
+
- @backstage/plugin-catalog-common@1.0.26
|
|
24
|
+
|
|
25
|
+
## 0.1.28-next.3
|
|
26
|
+
|
|
27
|
+
### Patch Changes
|
|
28
|
+
|
|
29
|
+
- Updated dependencies
|
|
30
|
+
- @backstage/backend-plugin-api@0.8.0-next.3
|
|
31
|
+
- @backstage/backend-common@0.23.4-next.3
|
|
32
|
+
- @backstage/plugin-techdocs-node@1.12.9-next.3
|
|
33
|
+
- @backstage/catalog-model@1.6.0-next.0
|
|
34
|
+
- @backstage/backend-tasks@0.5.28-next.3
|
|
35
|
+
- @backstage/catalog-client@1.6.6-next.0
|
|
36
|
+
- @backstage/config@1.2.0
|
|
37
|
+
- @backstage/plugin-catalog-common@1.0.26-next.2
|
|
38
|
+
- @backstage/plugin-catalog-node@1.12.5-next.3
|
|
39
|
+
- @backstage/plugin-permission-common@0.8.1-next.1
|
|
40
|
+
- @backstage/plugin-search-backend-node@1.2.28-next.3
|
|
41
|
+
- @backstage/plugin-search-common@1.2.14-next.1
|
|
42
|
+
|
|
3
43
|
## 0.1.28-next.2
|
|
4
44
|
|
|
5
45
|
### Patch Changes
|
package/alpha/package.json
CHANGED
package/config.d.ts
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
16
|
|
|
17
|
-
import {
|
|
17
|
+
import { SchedulerServiceTaskScheduleDefinitionConfig } from '@backstage/backend-plugin-api';
|
|
18
18
|
|
|
19
19
|
export interface Config {
|
|
20
20
|
search?: {
|
|
@@ -26,7 +26,7 @@ export interface Config {
|
|
|
26
26
|
/**
|
|
27
27
|
* The schedule for how often to run the collation job.
|
|
28
28
|
*/
|
|
29
|
-
schedule?:
|
|
29
|
+
schedule?: SchedulerServiceTaskScheduleDefinitionConfig;
|
|
30
30
|
/**
|
|
31
31
|
* A templating string with placeholders, to form the final location of
|
|
32
32
|
* the entity.
|
package/dist/alpha.cjs.js
CHANGED
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
4
|
|
|
5
5
|
var backendPluginApi = require('@backstage/backend-plugin-api');
|
|
6
|
-
var backendTasks = require('@backstage/backend-tasks');
|
|
7
6
|
var alpha$1 = require('@backstage/plugin-catalog-node/alpha');
|
|
8
7
|
var pluginSearchBackendModuleTechdocs = require('@backstage/plugin-search-backend-module-techdocs');
|
|
9
8
|
var alpha$2 = require('@backstage/plugin-search-backend-node/alpha');
|
|
@@ -57,7 +56,7 @@ var alpha = backendPluginApi.createBackendModule({
|
|
|
57
56
|
timeout: { minutes: 15 },
|
|
58
57
|
initialDelay: { seconds: 3 }
|
|
59
58
|
};
|
|
60
|
-
const schedule = config.has("search.collators.techdocs.schedule") ?
|
|
59
|
+
const schedule = config.has("search.collators.techdocs.schedule") ? backendPluginApi.readSchedulerServiceTaskScheduleDefinitionFromConfig(
|
|
61
60
|
config.getConfig("search.collators.techdocs.schedule")
|
|
62
61
|
) : defaultSchedule;
|
|
63
62
|
indexRegistry.addCollator({
|
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 {\n coreServices,\n createBackendModule,\n createExtensionPoint,\n} from '@backstage/backend-plugin-api';\nimport {
|
|
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 {\n coreServices,\n createBackendModule,\n createExtensionPoint,\n readSchedulerServiceTaskScheduleDefinitionFromConfig,\n} from '@backstage/backend-plugin-api';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\nimport {\n DefaultTechDocsCollatorFactory,\n TechDocsCollatorEntityTransformer,\n} from '@backstage/plugin-search-backend-module-techdocs';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\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 ? readSchedulerServiceTaskScheduleDefinitionFromConfig(\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,\n catalogClient: catalog,\n entityTransformer: transformer,\n }),\n });\n },\n });\n },\n});\n"],"names":["createExtensionPoint","createBackendModule","coreServices","catalogServiceRef","searchIndexRegistryExtensionPoint","readSchedulerServiceTaskScheduleDefinitionFromConfig","DefaultTechDocsCollatorFactory"],"mappings":";;;;;;;;;AA4CO,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,qEAAA;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;AAAA,YACA,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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-search-backend-module-techdocs",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "A module for the search backend that exports techdocs modules",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "backend-plugin-module",
|
|
@@ -47,25 +47,24 @@
|
|
|
47
47
|
"test": "backstage-cli package test"
|
|
48
48
|
},
|
|
49
49
|
"dependencies": {
|
|
50
|
-
"@backstage/backend-common": "^0.
|
|
51
|
-
"@backstage/backend-plugin-api": "^0.8.0
|
|
52
|
-
"@backstage/
|
|
53
|
-
"@backstage/catalog-
|
|
54
|
-
"@backstage/catalog-model": "^1.5.0",
|
|
50
|
+
"@backstage/backend-common": "^0.24.0",
|
|
51
|
+
"@backstage/backend-plugin-api": "^0.8.0",
|
|
52
|
+
"@backstage/catalog-client": "^1.6.6",
|
|
53
|
+
"@backstage/catalog-model": "^1.6.0",
|
|
55
54
|
"@backstage/config": "^1.2.0",
|
|
56
|
-
"@backstage/plugin-catalog-common": "^1.0.26
|
|
57
|
-
"@backstage/plugin-catalog-node": "^1.12.5
|
|
58
|
-
"@backstage/plugin-permission-common": "^0.8.1
|
|
59
|
-
"@backstage/plugin-search-backend-node": "^1.
|
|
60
|
-
"@backstage/plugin-search-common": "^1.2.14
|
|
61
|
-
"@backstage/plugin-techdocs-node": "^1.12.9
|
|
55
|
+
"@backstage/plugin-catalog-common": "^1.0.26",
|
|
56
|
+
"@backstage/plugin-catalog-node": "^1.12.5",
|
|
57
|
+
"@backstage/plugin-permission-common": "^0.8.1",
|
|
58
|
+
"@backstage/plugin-search-backend-node": "^1.3.0",
|
|
59
|
+
"@backstage/plugin-search-common": "^1.2.14",
|
|
60
|
+
"@backstage/plugin-techdocs-node": "^1.12.9",
|
|
62
61
|
"lodash": "^4.17.21",
|
|
63
62
|
"node-fetch": "^2.7.0",
|
|
64
63
|
"p-limit": "^3.1.0"
|
|
65
64
|
},
|
|
66
65
|
"devDependencies": {
|
|
67
|
-
"@backstage/backend-test-utils": "^0.
|
|
68
|
-
"@backstage/cli": "^0.27.0
|
|
66
|
+
"@backstage/backend-test-utils": "^0.5.0",
|
|
67
|
+
"@backstage/cli": "^0.27.0",
|
|
69
68
|
"msw": "^1.0.0"
|
|
70
69
|
},
|
|
71
70
|
"configSchema": "config.d.ts"
|