@backstage/plugin-search-backend-module-techdocs 0.0.0-nightly-20240818022051 → 0.0.0-nightly-20240820021901

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,23 +1,26 @@
1
1
  # @backstage/plugin-search-backend-module-techdocs
2
2
 
3
- ## 0.0.0-nightly-20240818022051
3
+ ## 0.0.0-nightly-20240820021901
4
+
5
+ ### Minor Changes
6
+
7
+ - fc24d9e: Stop using `@backstage/backend-tasks` as it will be deleted in near future.
4
8
 
5
9
  ### Patch Changes
6
10
 
7
11
  - 93095ee: Make sure node-fetch is version 2.7.0 or greater
8
12
  - Updated dependencies
9
- - @backstage/backend-plugin-api@0.0.0-nightly-20240818022051
10
- - @backstage/backend-common@0.0.0-nightly-20240818022051
11
- - @backstage/plugin-search-backend-node@0.0.0-nightly-20240818022051
12
- - @backstage/plugin-techdocs-node@0.0.0-nightly-20240818022051
13
- - @backstage/plugin-permission-common@0.0.0-nightly-20240818022051
14
- - @backstage/plugin-search-common@0.0.0-nightly-20240818022051
15
- - @backstage/plugin-catalog-node@0.0.0-nightly-20240818022051
16
- - @backstage/backend-tasks@0.0.0-nightly-20240818022051
17
- - @backstage/catalog-model@0.0.0-nightly-20240818022051
18
- - @backstage/catalog-client@0.0.0-nightly-20240818022051
13
+ - @backstage/backend-plugin-api@0.0.0-nightly-20240820021901
14
+ - @backstage/backend-common@0.0.0-nightly-20240820021901
15
+ - @backstage/plugin-search-backend-node@0.0.0-nightly-20240820021901
16
+ - @backstage/plugin-techdocs-node@0.0.0-nightly-20240820021901
17
+ - @backstage/plugin-permission-common@0.0.0-nightly-20240820021901
18
+ - @backstage/plugin-search-common@0.0.0-nightly-20240820021901
19
+ - @backstage/plugin-catalog-node@0.0.0-nightly-20240820021901
20
+ - @backstage/catalog-model@0.0.0-nightly-20240820021901
21
+ - @backstage/catalog-client@0.0.0-nightly-20240820021901
19
22
  - @backstage/config@1.2.0
20
- - @backstage/plugin-catalog-common@0.0.0-nightly-20240818022051
23
+ - @backstage/plugin-catalog-common@0.0.0-nightly-20240820021901
21
24
 
22
25
  ## 0.1.28-next.3
23
26
 
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-search-backend-module-techdocs__alpha",
3
- "version": "0.0.0-nightly-20240818022051",
3
+ "version": "0.0.0-nightly-20240820021901",
4
4
  "main": "../dist/alpha.cjs.js",
5
5
  "types": "../dist/alpha.d.ts"
6
6
  }
package/config.d.ts CHANGED
@@ -14,7 +14,7 @@
14
14
  * limitations under the License.
15
15
  */
16
16
 
17
- import { TaskScheduleDefinitionConfig } from '@backstage/backend-tasks';
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?: TaskScheduleDefinitionConfig;
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") ? backendTasks.readTaskScheduleDefinitionFromConfig(
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({
@@ -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 { readTaskScheduleDefinitionFromConfig } from '@backstage/backend-tasks';\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 ? readTaskScheduleDefinitionFromConfig(\n config.getConfig('search.collators.techdocs.schedule'),\n )\n : defaultSchedule;\n\n indexRegistry.addCollator({\n schedule: scheduler.createScheduledTaskRunner(schedule),\n factory: DefaultTechDocsCollatorFactory.fromConfig(config, {\n discovery,\n tokenManager,\n auth,\n httpAuth,\n logger,\n catalogClient: catalog,\n entityTransformer: transformer,\n }),\n });\n },\n });\n },\n});\n"],"names":["createExtensionPoint","createBackendModule","coreServices","catalogServiceRef","searchIndexRegistryExtensionPoint","readTaskScheduleDefinitionFromConfig","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,iDAAA;AAAA,UACE,MAAA,CAAO,UAAU,oCAAoC,CAAA;AAAA,SAEvD,GAAA,eAAA,CAAA;AAEJ,QAAA,aAAA,CAAc,WAAY,CAAA;AAAA,UACxB,QAAA,EAAU,SAAU,CAAA,yBAAA,CAA0B,QAAQ,CAAA;AAAA,UACtD,OAAA,EAASC,gEAA+B,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,YACzD,SAAA;AAAA,YACA,YAAA;AAAA,YACA,IAAA;AAAA,YACA,QAAA;AAAA,YACA,MAAA;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;;;;;"}
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.0.0-nightly-20240818022051",
3
+ "version": "0.0.0-nightly-20240820021901",
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.0.0-nightly-20240818022051",
51
- "@backstage/backend-plugin-api": "^0.0.0-nightly-20240818022051",
52
- "@backstage/backend-tasks": "^0.0.0-nightly-20240818022051",
53
- "@backstage/catalog-client": "^0.0.0-nightly-20240818022051",
54
- "@backstage/catalog-model": "^0.0.0-nightly-20240818022051",
50
+ "@backstage/backend-common": "^0.0.0-nightly-20240820021901",
51
+ "@backstage/backend-plugin-api": "^0.0.0-nightly-20240820021901",
52
+ "@backstage/catalog-client": "^0.0.0-nightly-20240820021901",
53
+ "@backstage/catalog-model": "^0.0.0-nightly-20240820021901",
55
54
  "@backstage/config": "^1.2.0",
56
- "@backstage/plugin-catalog-common": "^0.0.0-nightly-20240818022051",
57
- "@backstage/plugin-catalog-node": "^0.0.0-nightly-20240818022051",
58
- "@backstage/plugin-permission-common": "^0.0.0-nightly-20240818022051",
59
- "@backstage/plugin-search-backend-node": "^0.0.0-nightly-20240818022051",
60
- "@backstage/plugin-search-common": "^0.0.0-nightly-20240818022051",
61
- "@backstage/plugin-techdocs-node": "^0.0.0-nightly-20240818022051",
55
+ "@backstage/plugin-catalog-common": "^0.0.0-nightly-20240820021901",
56
+ "@backstage/plugin-catalog-node": "^0.0.0-nightly-20240820021901",
57
+ "@backstage/plugin-permission-common": "^0.0.0-nightly-20240820021901",
58
+ "@backstage/plugin-search-backend-node": "^0.0.0-nightly-20240820021901",
59
+ "@backstage/plugin-search-common": "^0.0.0-nightly-20240820021901",
60
+ "@backstage/plugin-techdocs-node": "^0.0.0-nightly-20240820021901",
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.0.0-nightly-20240818022051",
68
- "@backstage/cli": "^0.0.0-nightly-20240818022051",
66
+ "@backstage/backend-test-utils": "^0.0.0-nightly-20240820021901",
67
+ "@backstage/cli": "^0.0.0-nightly-20240820021901",
69
68
  "msw": "^1.0.0"
70
69
  },
71
70
  "configSchema": "config.d.ts"