@backstage/plugin-search-backend-module-techdocs 0.1.3 → 0.1.4-next.1

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 CHANGED
@@ -1,5 +1,41 @@
1
1
  # @backstage/plugin-search-backend-module-techdocs
2
2
 
3
+ ## 0.1.4-next.1
4
+
5
+ ### Patch Changes
6
+
7
+ - 629cbd194a87: Use `coreServices.rootConfig` instead of `coreService.config`
8
+ - 12a8c94eda8d: Add package repository and homepage metadata
9
+ - Updated dependencies
10
+ - @backstage/backend-common@0.19.2-next.1
11
+ - @backstage/plugin-search-backend-node@1.2.4-next.1
12
+ - @backstage/backend-plugin-api@0.6.0-next.1
13
+ - @backstage/backend-tasks@0.5.5-next.1
14
+ - @backstage/plugin-techdocs-node@1.7.4-next.1
15
+ - @backstage/catalog-client@1.4.3
16
+ - @backstage/catalog-model@1.4.1
17
+ - @backstage/config@1.0.8
18
+ - @backstage/plugin-catalog-common@1.0.15
19
+ - @backstage/plugin-permission-common@0.7.7
20
+ - @backstage/plugin-search-common@1.2.5
21
+
22
+ ## 0.1.4-next.0
23
+
24
+ ### Patch Changes
25
+
26
+ - Updated dependencies
27
+ - @backstage/plugin-search-backend-node@1.2.4-next.0
28
+ - @backstage/backend-common@0.19.2-next.0
29
+ - @backstage/backend-plugin-api@0.5.5-next.0
30
+ - @backstage/backend-tasks@0.5.5-next.0
31
+ - @backstage/catalog-client@1.4.3
32
+ - @backstage/catalog-model@1.4.1
33
+ - @backstage/config@1.0.8
34
+ - @backstage/plugin-catalog-common@1.0.15
35
+ - @backstage/plugin-permission-common@0.7.7
36
+ - @backstage/plugin-search-common@1.2.5
37
+ - @backstage/plugin-techdocs-node@1.7.4-next.0
38
+
3
39
  ## 0.1.3
4
40
 
5
41
  ### Patch Changes
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-search-backend-module-techdocs",
3
- "version": "0.1.3",
3
+ "version": "0.1.4-next.1",
4
4
  "main": "../dist/alpha.cjs.js",
5
5
  "types": "../dist/alpha.d.ts"
6
6
  }
package/dist/alpha.cjs.js CHANGED
@@ -14,7 +14,7 @@ const searchModuleTechDocsCollator = backendPluginApi.createBackendModule(
14
14
  register(env) {
15
15
  env.registerInit({
16
16
  deps: {
17
- config: backendPluginApi.coreServices.config,
17
+ config: backendPluginApi.coreServices.rootConfig,
18
18
  logger: backendPluginApi.coreServices.logger,
19
19
  discovery: backendPluginApi.coreServices.discovery,
20
20
  tokenManager: backendPluginApi.coreServices.tokenManager,
@@ -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.config,\n logger: coreServices.logger,\n discovery: coreServices.discovery,\n tokenManager: coreServices.tokenManager,\n scheduler: coreServices.scheduler,\n indexRegistry: searchIndexRegistryExtensionPoint,\n },\n async init({\n config,\n logger,\n discovery,\n tokenManager,\n scheduler,\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 }),\n });\n },\n });\n },\n }),\n);\n"],"names":["createBackendModule","coreServices","searchIndexRegistryExtensionPoint","DefaultTechDocsCollatorFactory","loggerToWinstonLogger"],"mappings":";;;;;;;;;AAiDO,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,MAAA;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,aAAe,EAAAC,uCAAA;AAAA,SACjB;AAAA,QACA,MAAM,IAAK,CAAA;AAAA,UACT,MAAA;AAAA,UACA,MAAA;AAAA,UACA,SAAA;AAAA,UACA,YAAA;AAAA,UACA,SAAA;AAAA,UACA,aAAA;AAAA,SACC,EAAA;AAtEX,UAAA,IAAA,EAAA,CAAA;AAuEU,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,aACrC,CAAA;AAAA,WACF,CAAA,CAAA;AAAA,SACH;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAAA,GACF,CAAA;AACF;;;;"}
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.rootConfig,\n logger: coreServices.logger,\n discovery: coreServices.discovery,\n tokenManager: coreServices.tokenManager,\n scheduler: coreServices.scheduler,\n indexRegistry: searchIndexRegistryExtensionPoint,\n },\n async init({\n config,\n logger,\n discovery,\n tokenManager,\n scheduler,\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 }),\n });\n },\n });\n },\n }),\n);\n"],"names":["createBackendModule","coreServices","searchIndexRegistryExtensionPoint","DefaultTechDocsCollatorFactory","loggerToWinstonLogger"],"mappings":";;;;;;;;;AAiDO,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,aAAe,EAAAC,uCAAA;AAAA,SACjB;AAAA,QACA,MAAM,IAAK,CAAA;AAAA,UACT,MAAA;AAAA,UACA,MAAA;AAAA,UACA,SAAA;AAAA,UACA,YAAA;AAAA,UACA,SAAA;AAAA,UACA,aAAA;AAAA,SACC,EAAA;AAtEX,UAAA,IAAA,EAAA,CAAA;AAuEU,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,aACrC,CAAA;AAAA,WACF,CAAA,CAAA;AAAA,SACH;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAAA,GACF,CAAA;AACF;;;;"}
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.3",
4
+ "version": "0.1.4-next.1",
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,25 @@
34
40
  "clean": "backstage-cli package clean"
35
41
  },
36
42
  "dependencies": {
37
- "@backstage/backend-common": "^0.19.1",
38
- "@backstage/backend-plugin-api": "^0.5.4",
39
- "@backstage/backend-tasks": "^0.5.4",
43
+ "@backstage/backend-common": "^0.19.2-next.1",
44
+ "@backstage/backend-plugin-api": "^0.6.0-next.1",
45
+ "@backstage/backend-tasks": "^0.5.5-next.1",
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",
44
50
  "@backstage/plugin-permission-common": "^0.7.7",
45
- "@backstage/plugin-search-backend-node": "^1.2.3",
51
+ "@backstage/plugin-search-backend-node": "^1.2.4-next.1",
46
52
  "@backstage/plugin-search-common": "^1.2.5",
47
- "@backstage/plugin-techdocs-node": "^1.7.3",
53
+ "@backstage/plugin-techdocs-node": "^1.7.4-next.1",
48
54
  "lodash": "^4.17.21",
49
55
  "node-fetch": "^2.6.7",
50
56
  "p-limit": "^3.1.0",
51
57
  "winston": "^3.2.1"
52
58
  },
53
59
  "devDependencies": {
54
- "@backstage/backend-test-utils": "^0.1.39",
55
- "@backstage/cli": "^0.22.9",
60
+ "@backstage/backend-test-utils": "^0.2.0-next.1",
61
+ "@backstage/cli": "^0.22.10-next.1",
56
62
  "msw": "^1.0.0"
57
63
  },
58
64
  "files": [