@backstage/plugin-search-backend-module-techdocs 0.1.4-next.0 → 0.1.4-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 +32 -0
- package/alpha/package.json +1 -1
- package/dist/alpha.cjs.js +8 -4
- package/dist/alpha.cjs.js.map +1 -1
- package/dist/alpha.d.ts +1 -1
- package/package.json +15 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,37 @@
|
|
|
1
1
|
# @backstage/plugin-search-backend-module-techdocs
|
|
2
2
|
|
|
3
|
+
## 0.1.4-next.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 29f77f923c71: Ensure that all services are dependency injected into the module instead of taken from options
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/backend-plugin-api@0.6.0-next.2
|
|
10
|
+
- @backstage/backend-tasks@0.5.5-next.2
|
|
11
|
+
- @backstage/backend-common@0.19.2-next.2
|
|
12
|
+
- @backstage/plugin-catalog-node@1.4.1-next.2
|
|
13
|
+
- @backstage/plugin-search-backend-node@1.2.4-next.2
|
|
14
|
+
- @backstage/plugin-techdocs-node@1.7.4-next.2
|
|
15
|
+
|
|
16
|
+
## 0.1.4-next.1
|
|
17
|
+
|
|
18
|
+
### Patch Changes
|
|
19
|
+
|
|
20
|
+
- 629cbd194a87: Use `coreServices.rootConfig` instead of `coreService.config`
|
|
21
|
+
- 12a8c94eda8d: Add package repository and homepage metadata
|
|
22
|
+
- Updated dependencies
|
|
23
|
+
- @backstage/backend-common@0.19.2-next.1
|
|
24
|
+
- @backstage/plugin-search-backend-node@1.2.4-next.1
|
|
25
|
+
- @backstage/backend-plugin-api@0.6.0-next.1
|
|
26
|
+
- @backstage/backend-tasks@0.5.5-next.1
|
|
27
|
+
- @backstage/plugin-techdocs-node@1.7.4-next.1
|
|
28
|
+
- @backstage/catalog-client@1.4.3
|
|
29
|
+
- @backstage/catalog-model@1.4.1
|
|
30
|
+
- @backstage/config@1.0.8
|
|
31
|
+
- @backstage/plugin-catalog-common@1.0.15
|
|
32
|
+
- @backstage/plugin-permission-common@0.7.7
|
|
33
|
+
- @backstage/plugin-search-common@1.2.5
|
|
34
|
+
|
|
3
35
|
## 0.1.4-next.0
|
|
4
36
|
|
|
5
37
|
### Patch Changes
|
package/alpha/package.json
CHANGED
package/dist/alpha.cjs.js
CHANGED
|
@@ -4,7 +4,8 @@ Object.defineProperty(exports, '__esModule', { value: true });
|
|
|
4
4
|
|
|
5
5
|
var backendPluginApi = require('@backstage/backend-plugin-api');
|
|
6
6
|
var backendCommon = require('@backstage/backend-common');
|
|
7
|
-
var alpha = require('@backstage/plugin-search-backend-node/alpha');
|
|
7
|
+
var alpha$1 = require('@backstage/plugin-search-backend-node/alpha');
|
|
8
|
+
var alpha = require('@backstage/plugin-catalog-node/alpha');
|
|
8
9
|
var pluginSearchBackendModuleTechdocs = require('@backstage/plugin-search-backend-module-techdocs');
|
|
9
10
|
|
|
10
11
|
const searchModuleTechDocsCollator = backendPluginApi.createBackendModule(
|
|
@@ -14,12 +15,13 @@ const searchModuleTechDocsCollator = backendPluginApi.createBackendModule(
|
|
|
14
15
|
register(env) {
|
|
15
16
|
env.registerInit({
|
|
16
17
|
deps: {
|
|
17
|
-
config: backendPluginApi.coreServices.
|
|
18
|
+
config: backendPluginApi.coreServices.rootConfig,
|
|
18
19
|
logger: backendPluginApi.coreServices.logger,
|
|
19
20
|
discovery: backendPluginApi.coreServices.discovery,
|
|
20
21
|
tokenManager: backendPluginApi.coreServices.tokenManager,
|
|
21
22
|
scheduler: backendPluginApi.coreServices.scheduler,
|
|
22
|
-
|
|
23
|
+
catalog: alpha.catalogServiceRef,
|
|
24
|
+
indexRegistry: alpha$1.searchIndexRegistryExtensionPoint
|
|
23
25
|
},
|
|
24
26
|
async init({
|
|
25
27
|
config,
|
|
@@ -27,6 +29,7 @@ const searchModuleTechDocsCollator = backendPluginApi.createBackendModule(
|
|
|
27
29
|
discovery,
|
|
28
30
|
tokenManager,
|
|
29
31
|
scheduler,
|
|
32
|
+
catalog,
|
|
30
33
|
indexRegistry
|
|
31
34
|
}) {
|
|
32
35
|
var _a;
|
|
@@ -43,7 +46,8 @@ const searchModuleTechDocsCollator = backendPluginApi.createBackendModule(
|
|
|
43
46
|
...options,
|
|
44
47
|
discovery,
|
|
45
48
|
tokenManager,
|
|
46
|
-
logger: backendCommon.loggerToWinstonLogger(logger)
|
|
49
|
+
logger: backendCommon.loggerToWinstonLogger(logger),
|
|
50
|
+
catalogClient: catalog
|
|
47
51
|
})
|
|
48
52
|
});
|
|
49
53
|
}
|
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} from '@backstage/backend-plugin-api';\nimport { TaskScheduleDefinition } from '@backstage/backend-tasks';\nimport { loggerToWinstonLogger } from '@backstage/backend-common';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\n\nimport {\n DefaultTechDocsCollatorFactory,\n TechDocsCollatorFactoryOptions,\n} from '@backstage/plugin-search-backend-module-techdocs';\n\n/**\n * @alpha\n * Options for {@link searchModuleTechDocsCollator}.\n */\nexport type SearchModuleTechDocsCollatorOptions = Omit<\n TechDocsCollatorFactoryOptions,\n 'logger' | 'discovery' | 'tokenManager'\n> & {\n schedule?: TaskScheduleDefinition;\n};\n\n/**\n * @alpha\n * Search backend module for the TechDocs index.\n */\nexport const searchModuleTechDocsCollator = createBackendModule(\n (options?: SearchModuleTechDocsCollatorOptions) => ({\n moduleId: 'techDocsCollator',\n pluginId: 'search',\n register(env) {\n env.registerInit({\n deps: {\n config: coreServices.
|
|
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} from '@backstage/backend-plugin-api';\nimport { TaskScheduleDefinition } from '@backstage/backend-tasks';\nimport { loggerToWinstonLogger } from '@backstage/backend-common';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\n\nimport {\n DefaultTechDocsCollatorFactory,\n TechDocsCollatorFactoryOptions,\n} from '@backstage/plugin-search-backend-module-techdocs';\n\n/**\n * @alpha\n * Options for {@link searchModuleTechDocsCollator}.\n */\nexport type SearchModuleTechDocsCollatorOptions = Omit<\n TechDocsCollatorFactoryOptions,\n 'logger' | 'discovery' | 'tokenManager' | 'catalogClient'\n> & {\n schedule?: TaskScheduleDefinition;\n};\n\n/**\n * @alpha\n * Search backend module for the TechDocs index.\n */\nexport const searchModuleTechDocsCollator = createBackendModule(\n (options?: SearchModuleTechDocsCollatorOptions) => ({\n moduleId: 'techDocsCollator',\n pluginId: 'search',\n register(env) {\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 indexRegistry.addCollator({\n schedule: scheduler.createScheduledTaskRunner(\n options?.schedule ?? defaultSchedule,\n ),\n factory: DefaultTechDocsCollatorFactory.fromConfig(config, {\n ...options,\n discovery,\n tokenManager,\n logger: loggerToWinstonLogger(logger),\n catalogClient: catalog,\n }),\n });\n },\n });\n },\n }),\n);\n"],"names":["createBackendModule","coreServices","catalogServiceRef","searchIndexRegistryExtensionPoint","DefaultTechDocsCollatorFactory","loggerToWinstonLogger"],"mappings":";;;;;;;;;;AAkDO,MAAM,4BAA+B,GAAAA,oCAAA;AAAA,EAC1C,CAAC,OAAmD,MAAA;AAAA,IAClD,QAAU,EAAA,kBAAA;AAAA,IACV,QAAU,EAAA,QAAA;AAAA,IACV,SAAS,GAAK,EAAA;AACZ,MAAA,GAAA,CAAI,YAAa,CAAA;AAAA,QACf,IAAM,EAAA;AAAA,UACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,UACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,UACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,UACxB,cAAcA,6BAAa,CAAA,YAAA;AAAA,UAC3B,WAAWA,6BAAa,CAAA,SAAA;AAAA,UACxB,OAAS,EAAAC,uBAAA;AAAA,UACT,aAAe,EAAAC,yCAAA;AAAA,SACjB;AAAA,QACA,MAAM,IAAK,CAAA;AAAA,UACT,MAAA;AAAA,UACA,MAAA;AAAA,UACA,SAAA;AAAA,UACA,YAAA;AAAA,UACA,SAAA;AAAA,UACA,OAAA;AAAA,UACA,aAAA;AAAA,SACC,EAAA;AAzEX,UAAA,IAAA,EAAA,CAAA;AA0EU,UAAA,MAAM,eAAkB,GAAA;AAAA,YACtB,SAAA,EAAW,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,YACzB,OAAA,EAAS,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,YACvB,YAAA,EAAc,EAAE,OAAA,EAAS,CAAE,EAAA;AAAA,WAC7B,CAAA;AAEA,UAAA,aAAA,CAAc,WAAY,CAAA;AAAA,YACxB,UAAU,SAAU,CAAA,yBAAA;AAAA,cAClB,CAAA,EAAA,GAAA,OAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,OAAA,CAAS,aAAT,IAAqB,GAAA,EAAA,GAAA,eAAA;AAAA,aACvB;AAAA,YACA,OAAA,EAASC,gEAA+B,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,cACzD,GAAG,OAAA;AAAA,cACH,SAAA;AAAA,cACA,YAAA;AAAA,cACA,MAAA,EAAQC,oCAAsB,MAAM,CAAA;AAAA,cACpC,aAAe,EAAA,OAAA;AAAA,aAChB,CAAA;AAAA,WACF,CAAA,CAAA;AAAA,SACH;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAAA,GACF,CAAA;AACF;;;;"}
|
package/dist/alpha.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ import { TechDocsCollatorFactoryOptions } from '@backstage/plugin-search-backend
|
|
|
6
6
|
* @alpha
|
|
7
7
|
* Options for {@link searchModuleTechDocsCollator}.
|
|
8
8
|
*/
|
|
9
|
-
type SearchModuleTechDocsCollatorOptions = Omit<TechDocsCollatorFactoryOptions, 'logger' | 'discovery' | 'tokenManager'> & {
|
|
9
|
+
type SearchModuleTechDocsCollatorOptions = Omit<TechDocsCollatorFactoryOptions, 'logger' | 'discovery' | 'tokenManager' | 'catalogClient'> & {
|
|
10
10
|
schedule?: TaskScheduleDefinition;
|
|
11
11
|
};
|
|
12
12
|
/**
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-search-backend-module-techdocs",
|
|
3
3
|
"description": "A module for the search backend that exports techdocs modules",
|
|
4
|
-
"version": "0.1.4-next.
|
|
4
|
+
"version": "0.1.4-next.2",
|
|
5
5
|
"main": "./dist/index.cjs.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -24,6 +24,12 @@
|
|
|
24
24
|
"backstage": {
|
|
25
25
|
"role": "backend-plugin-module"
|
|
26
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
|
+
},
|
|
27
33
|
"scripts": {
|
|
28
34
|
"start": "backstage-cli package start",
|
|
29
35
|
"build": "backstage-cli package build",
|
|
@@ -34,25 +40,26 @@
|
|
|
34
40
|
"clean": "backstage-cli package clean"
|
|
35
41
|
},
|
|
36
42
|
"dependencies": {
|
|
37
|
-
"@backstage/backend-common": "^0.19.2-next.
|
|
38
|
-
"@backstage/backend-plugin-api": "^0.
|
|
39
|
-
"@backstage/backend-tasks": "^0.5.5-next.
|
|
43
|
+
"@backstage/backend-common": "^0.19.2-next.2",
|
|
44
|
+
"@backstage/backend-plugin-api": "^0.6.0-next.2",
|
|
45
|
+
"@backstage/backend-tasks": "^0.5.5-next.2",
|
|
40
46
|
"@backstage/catalog-client": "^1.4.3",
|
|
41
47
|
"@backstage/catalog-model": "^1.4.1",
|
|
42
48
|
"@backstage/config": "^1.0.8",
|
|
43
49
|
"@backstage/plugin-catalog-common": "^1.0.15",
|
|
50
|
+
"@backstage/plugin-catalog-node": "^1.4.1-next.2",
|
|
44
51
|
"@backstage/plugin-permission-common": "^0.7.7",
|
|
45
|
-
"@backstage/plugin-search-backend-node": "^1.2.4-next.
|
|
52
|
+
"@backstage/plugin-search-backend-node": "^1.2.4-next.2",
|
|
46
53
|
"@backstage/plugin-search-common": "^1.2.5",
|
|
47
|
-
"@backstage/plugin-techdocs-node": "^1.7.4-next.
|
|
54
|
+
"@backstage/plugin-techdocs-node": "^1.7.4-next.2",
|
|
48
55
|
"lodash": "^4.17.21",
|
|
49
56
|
"node-fetch": "^2.6.7",
|
|
50
57
|
"p-limit": "^3.1.0",
|
|
51
58
|
"winston": "^3.2.1"
|
|
52
59
|
},
|
|
53
60
|
"devDependencies": {
|
|
54
|
-
"@backstage/backend-test-utils": "^0.
|
|
55
|
-
"@backstage/cli": "^0.22.10-next.
|
|
61
|
+
"@backstage/backend-test-utils": "^0.2.0-next.2",
|
|
62
|
+
"@backstage/cli": "^0.22.10-next.1",
|
|
56
63
|
"msw": "^1.0.0"
|
|
57
64
|
},
|
|
58
65
|
"files": [
|