@backstage/plugin-search-backend-module-techdocs 0.3.2-next.3 → 0.3.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.
Files changed (4) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/dist/module.cjs.js +4 -4
  3. package/dist/module.cjs.js.map +1 -1
  4. package/package.json +13 -13
package/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # @backstage/plugin-search-backend-module-techdocs
2
2
 
3
+ ## 0.3.2
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+ - @backstage/catalog-client@1.8.0
9
+ - @backstage/config@1.3.0
10
+ - @backstage/plugin-catalog-node@1.14.0
11
+ - @backstage/backend-plugin-api@1.0.2
12
+ - @backstage/plugin-search-backend-node@1.3.5
13
+ - @backstage/plugin-permission-common@0.8.2
14
+ - @backstage/catalog-model@1.7.1
15
+ - @backstage/plugin-catalog-common@1.1.1
16
+ - @backstage/plugin-search-common@1.2.15
17
+ - @backstage/plugin-techdocs-node@1.12.13
18
+
3
19
  ## 0.3.2-next.3
4
20
 
5
21
  ### Patch Changes
package/dist/module.cjs.js CHANGED
@@ -3,9 +3,9 @@
3
3
  Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var backendPluginApi = require('@backstage/backend-plugin-api');
6
- var alpha = require('@backstage/plugin-catalog-node/alpha');
6
+ var alpha$1 = require('@backstage/plugin-catalog-node/alpha');
7
7
  var pluginSearchBackendModuleTechdocs = require('@backstage/plugin-search-backend-module-techdocs');
8
- var alpha$1 = require('@backstage/plugin-search-backend-node/alpha');
8
+ var alpha = require('@backstage/plugin-search-backend-node/alpha');
9
9
 
10
10
  const techdocsCollatorEntityTransformerExtensionPoint = backendPluginApi.createExtensionPoint({
11
11
  id: "search.techdocsCollator.transformer"
@@ -45,8 +45,8 @@ var feature = backendPluginApi.createBackendModule({
45
45
  httpAuth: backendPluginApi.coreServices.httpAuth,
46
46
  discovery: backendPluginApi.coreServices.discovery,
47
47
  scheduler: backendPluginApi.coreServices.scheduler,
48
- catalog: alpha.catalogServiceRef,
49
- indexRegistry: alpha$1.searchIndexRegistryExtensionPoint
48
+ catalog: alpha$1.catalogServiceRef,
49
+ indexRegistry: alpha.searchIndexRegistryExtensionPoint
50
50
  },
51
51
  async init({
52
52
  config,
package/dist/module.cjs.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"module.cjs.js","sources":["../src/module.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 TechDocsCollatorDocumentTransformer,\n TechDocsCollatorEntityTransformer,\n} from '@backstage/plugin-search-backend-module-techdocs';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\n\n/** @public */\nexport interface TechDocsCollatorEntityTransformerExtensionPoint {\n setTransformer(transformer: TechDocsCollatorEntityTransformer): void;\n setDocumentTransformer(\n transformer: TechDocsCollatorDocumentTransformer,\n ): void;\n}\n\n/**\n * Extension point used to customize the TechDocs collator entity transformer.\n *\n * @public\n */\nexport const techdocsCollatorEntityTransformerExtensionPoint =\n createExtensionPoint<TechDocsCollatorEntityTransformerExtensionPoint>({\n id: 'search.techdocsCollator.transformer',\n });\n\n/**\n * @public\n * Search backend module for the TechDocs index.\n */\nexport default createBackendModule({\n pluginId: 'search',\n moduleId: 'techdocs-collator',\n register(env) {\n let entityTransformer: TechDocsCollatorEntityTransformer | undefined;\n let documentTransformer: TechDocsCollatorDocumentTransformer | undefined;\n\n env.registerExtensionPoint(\n techdocsCollatorEntityTransformerExtensionPoint,\n {\n setTransformer(newTransformer) {\n if (entityTransformer) {\n throw new Error(\n 'TechDocs collator entity transformer may only be set once',\n );\n }\n entityTransformer = newTransformer;\n },\n setDocumentTransformer(newTransformer) {\n if (documentTransformer) {\n throw new Error(\n 'TechDocs collator document transformer may only be set once',\n );\n }\n documentTransformer = 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 scheduler: coreServices.scheduler,\n catalog: catalogServiceRef,\n indexRegistry: searchIndexRegistryExtensionPoint,\n },\n async init({\n config,\n logger,\n auth,\n httpAuth,\n discovery,\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 auth,\n httpAuth,\n logger,\n catalogClient: catalog,\n entityTransformer,\n documentTransformer,\n }),\n });\n },\n });\n },\n});\n"],"names":["createExtensionPoint","createBackendModule","coreServices","catalogServiceRef","searchIndexRegistryExtensionPoint","readSchedulerServiceTaskScheduleDefinitionFromConfig","DefaultTechDocsCollatorFactory"],"mappings":";;;;;;;;;AAgDO,MAAM,kDACXA,qCAAsE,CAAA;AAAA,EACpE,EAAI,EAAA;AACN,CAAC;AAMH,cAAeC,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,mBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,iBAAA;AACJ,IAAI,IAAA,mBAAA;AAEJ,IAAI,GAAA,CAAA,sBAAA;AAAA,MACF,+CAAA;AAAA,MACA;AAAA,QACE,eAAe,cAAgB,EAAA;AAC7B,UAAA,IAAI,iBAAmB,EAAA;AACrB,YAAA,MAAM,IAAI,KAAA;AAAA,cACR;AAAA,aACF;AAAA;AAEF,UAAoB,iBAAA,GAAA,cAAA;AAAA,SACtB;AAAA,QACA,uBAAuB,cAAgB,EAAA;AACrC,UAAA,IAAI,mBAAqB,EAAA;AACvB,YAAA,MAAM,IAAI,KAAA;AAAA,cACR;AAAA,aACF;AAAA;AAEF,UAAsB,mBAAA,GAAA,cAAA;AAAA;AACxB;AACF,KACF;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,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,OAAS,EAAAC,uBAAA;AAAA,QACT,aAAe,EAAAC;AAAA,OACjB;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,MAAA;AAAA,QACA,MAAA;AAAA,QACA,IAAA;AAAA,QACA,QAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,OAAA;AAAA,QACA;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;AAAA,SAC7B;AAEA,QAAA,MAAM,QAAW,GAAA,MAAA,CAAO,GAAI,CAAA,oCAAoC,CAC5D,GAAAC,qEAAA;AAAA,UACE,MAAA,CAAO,UAAU,oCAAoC;AAAA,SAEvD,GAAA,eAAA;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,IAAA;AAAA,YACA,QAAA;AAAA,YACA,MAAA;AAAA,YACA,aAAe,EAAA,OAAA;AAAA,YACf,iBAAA;AAAA,YACA;AAAA,WACD;AAAA,SACF,CAAA;AAAA;AACH,KACD,CAAA;AAAA;AAEL,CAAC,CAAA;;;;;"}
1
+ {"version":3,"file":"module.cjs.js","sources":["../src/module.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 TechDocsCollatorDocumentTransformer,\n TechDocsCollatorEntityTransformer,\n} from '@backstage/plugin-search-backend-module-techdocs';\nimport { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\n\n/** @public */\nexport interface TechDocsCollatorEntityTransformerExtensionPoint {\n setTransformer(transformer: TechDocsCollatorEntityTransformer): void;\n setDocumentTransformer(\n transformer: TechDocsCollatorDocumentTransformer,\n ): void;\n}\n\n/**\n * Extension point used to customize the TechDocs collator entity transformer.\n *\n * @public\n */\nexport const techdocsCollatorEntityTransformerExtensionPoint =\n createExtensionPoint<TechDocsCollatorEntityTransformerExtensionPoint>({\n id: 'search.techdocsCollator.transformer',\n });\n\n/**\n * @public\n * Search backend module for the TechDocs index.\n */\nexport default createBackendModule({\n pluginId: 'search',\n moduleId: 'techdocs-collator',\n register(env) {\n let entityTransformer: TechDocsCollatorEntityTransformer | undefined;\n let documentTransformer: TechDocsCollatorDocumentTransformer | undefined;\n\n env.registerExtensionPoint(\n techdocsCollatorEntityTransformerExtensionPoint,\n {\n setTransformer(newTransformer) {\n if (entityTransformer) {\n throw new Error(\n 'TechDocs collator entity transformer may only be set once',\n );\n }\n entityTransformer = newTransformer;\n },\n setDocumentTransformer(newTransformer) {\n if (documentTransformer) {\n throw new Error(\n 'TechDocs collator document transformer may only be set once',\n );\n }\n documentTransformer = 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 scheduler: coreServices.scheduler,\n catalog: catalogServiceRef,\n indexRegistry: searchIndexRegistryExtensionPoint,\n },\n async init({\n config,\n logger,\n auth,\n httpAuth,\n discovery,\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 auth,\n httpAuth,\n logger,\n catalogClient: catalog,\n entityTransformer,\n documentTransformer,\n }),\n });\n },\n });\n },\n});\n"],"names":["createExtensionPoint","createBackendModule","coreServices","catalogServiceRef","searchIndexRegistryExtensionPoint","readSchedulerServiceTaskScheduleDefinitionFromConfig","DefaultTechDocsCollatorFactory"],"mappings":";;;;;;;;;AAgDO,MAAM,kDACXA,qCAAsE,CAAA;AAAA,EACpE,EAAI,EAAA;AACN,CAAC;AAMH,cAAeC,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,mBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,iBAAA;AACJ,IAAI,IAAA,mBAAA;AAEJ,IAAI,GAAA,CAAA,sBAAA;AAAA,MACF,+CAAA;AAAA,MACA;AAAA,QACE,eAAe,cAAgB,EAAA;AAC7B,UAAA,IAAI,iBAAmB,EAAA;AACrB,YAAA,MAAM,IAAI,KAAA;AAAA,cACR;AAAA,aACF;AAAA;AAEF,UAAoB,iBAAA,GAAA,cAAA;AAAA,SACtB;AAAA,QACA,uBAAuB,cAAgB,EAAA;AACrC,UAAA,IAAI,mBAAqB,EAAA;AACvB,YAAA,MAAM,IAAI,KAAA;AAAA,cACR;AAAA,aACF;AAAA;AAEF,UAAsB,mBAAA,GAAA,cAAA;AAAA;AACxB;AACF,KACF;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,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,OAAS,EAAAC,yBAAA;AAAA,QACT,aAAe,EAAAC;AAAA,OACjB;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,MAAA;AAAA,QACA,MAAA;AAAA,QACA,IAAA;AAAA,QACA,QAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,OAAA;AAAA,QACA;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;AAAA,SAC7B;AAEA,QAAA,MAAM,QAAW,GAAA,MAAA,CAAO,GAAI,CAAA,oCAAoC,CAC5D,GAAAC,qEAAA;AAAA,UACE,MAAA,CAAO,UAAU,oCAAoC;AAAA,SAEvD,GAAA,eAAA;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,IAAA;AAAA,YACA,QAAA;AAAA,YACA,MAAA;AAAA,YACA,aAAe,EAAA,OAAA;AAAA,YACf,iBAAA;AAAA,YACA;AAAA,WACD;AAAA,SACF,CAAA;AAAA;AACH,KACD,CAAA;AAAA;AAEL,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.2-next.3",
3
+ "version": "0.3.2",
4
4
  "description": "A module for the search backend that exports techdocs modules",
5
5
  "backstage": {
6
6
  "role": "backend-plugin-module",
@@ -59,23 +59,23 @@
59
59
  },
60
60
  "dependencies": {
61
61
  "@backstage/backend-common": "^0.25.0",
62
- "@backstage/backend-plugin-api": "1.0.2-next.2",
63
- "@backstage/catalog-client": "1.8.0-next.1",
64
- "@backstage/catalog-model": "1.7.0",
65
- "@backstage/config": "1.2.0",
66
- "@backstage/plugin-catalog-common": "1.1.0",
67
- "@backstage/plugin-catalog-node": "1.14.0-next.2",
68
- "@backstage/plugin-permission-common": "0.8.1",
69
- "@backstage/plugin-search-backend-node": "1.3.5-next.3",
70
- "@backstage/plugin-search-common": "1.2.14",
71
- "@backstage/plugin-techdocs-node": "1.12.13-next.3",
62
+ "@backstage/backend-plugin-api": "^1.0.2",
63
+ "@backstage/catalog-client": "^1.8.0",
64
+ "@backstage/catalog-model": "^1.7.1",
65
+ "@backstage/config": "^1.3.0",
66
+ "@backstage/plugin-catalog-common": "^1.1.1",
67
+ "@backstage/plugin-catalog-node": "^1.14.0",
68
+ "@backstage/plugin-permission-common": "^0.8.2",
69
+ "@backstage/plugin-search-backend-node": "^1.3.5",
70
+ "@backstage/plugin-search-common": "^1.2.15",
71
+ "@backstage/plugin-techdocs-node": "^1.12.13",
72
72
  "lodash": "^4.17.21",
73
73
  "node-fetch": "^2.7.0",
74
74
  "p-limit": "^3.1.0"
75
75
  },
76
76
  "devDependencies": {
77
- "@backstage/backend-test-utils": "1.1.0-next.3",
78
- "@backstage/cli": "0.29.0-next.3",
77
+ "@backstage/backend-test-utils": "^1.1.0",
78
+ "@backstage/cli": "^0.29.0",
79
79
  "msw": "^1.0.0"
80
80
  },
81
81
  "configSchema": "config.d.ts"