@backstage/plugin-search-backend-module-elasticsearch 1.3.20-next.1 → 1.4.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.
Files changed (5) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/alpha/package.json +1 -1
  3. package/dist/alpha.cjs.js +8 -0
  4. package/dist/alpha.cjs.js.map +1 -1
  5. package/package.json +6 -6
package/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # @backstage/plugin-search-backend-module-elasticsearch
2
2
 
3
+ ## 1.4.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 4d754e3: When using the New Backend System, the Elasticsearch provider will only be added if the `search.elasticsearch` config section exists.
8
+
9
+ ### Patch Changes
10
+
11
+ - Updated dependencies
12
+ - @backstage/backend-common@0.21.7
13
+ - @backstage/backend-plugin-api@0.6.17
14
+ - @backstage/plugin-search-backend-node@1.2.21
15
+ - @backstage/integration-aws-node@0.1.12
16
+ - @backstage/config@1.2.0
17
+ - @backstage/plugin-search-common@1.2.11
18
+
3
19
  ## 1.3.20-next.1
4
20
 
5
21
  ### Patch Changes
package/alpha/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-search-backend-module-elasticsearch",
3
- "version": "1.3.20-next.1",
3
+ "version": "1.4.0",
4
4
  "main": "../dist/alpha.cjs.js",
5
5
  "types": "../dist/alpha.d.ts"
6
6
  }
package/dist/alpha.cjs.js CHANGED
@@ -31,6 +31,14 @@ var alpha = backendPluginApi.createBackendModule({
31
31
  config: backendPluginApi.coreServices.rootConfig
32
32
  },
33
33
  async init({ searchEngineRegistry, logger, config }) {
34
+ const baseKey = "search.elasticsearch";
35
+ const baseConfig = config.getOptional(baseKey);
36
+ if (!baseConfig) {
37
+ logger.warn(
38
+ 'No configuration found under "search.elasticsearch" key. Skipping search engine inititalization.'
39
+ );
40
+ return;
41
+ }
34
42
  searchEngineRegistry.setSearchEngine(
35
43
  await pluginSearchBackendModuleElasticsearch.ElasticSearchSearchEngine.fromConfig({
36
44
  logger,
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 */\nimport {\n coreServices,\n createBackendModule,\n createExtensionPoint,\n} from '@backstage/backend-plugin-api';\nimport { searchEngineRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\nimport {\n ElasticSearchQueryTranslator,\n ElasticSearchSearchEngine,\n} from '@backstage/plugin-search-backend-module-elasticsearch';\n\n/** @alpha */\nexport interface ElasticSearchQueryTranslatorExtensionPoint {\n setTranslator(translator: ElasticSearchQueryTranslator): void;\n}\n\n/**\n * Extension point used to customize the ElasticSearch query translator.\n *\n * @alpha\n */\nexport const elasticsearchTranslatorExtensionPoint =\n createExtensionPoint<ElasticSearchQueryTranslatorExtensionPoint>({\n id: 'search.elasticsearchEngine.translator',\n });\n\n/**\n * Search backend module for the Elasticsearch engine.\n *\n * @alpha\n */\nexport default createBackendModule({\n pluginId: 'search',\n moduleId: 'elasticsearch-engine',\n register(env) {\n let translator: ElasticSearchQueryTranslator | undefined;\n\n env.registerExtensionPoint(elasticsearchTranslatorExtensionPoint, {\n setTranslator(newTranslator) {\n if (translator) {\n throw new Error(\n 'ElasticSearch query translator may only be set once',\n );\n }\n translator = newTranslator;\n },\n });\n\n env.registerInit({\n deps: {\n searchEngineRegistry: searchEngineRegistryExtensionPoint,\n logger: coreServices.logger,\n config: coreServices.rootConfig,\n },\n async init({ searchEngineRegistry, logger, config }) {\n searchEngineRegistry.setSearchEngine(\n await ElasticSearchSearchEngine.fromConfig({\n logger,\n config,\n translator,\n }),\n );\n },\n });\n },\n});\n"],"names":["createExtensionPoint","createBackendModule","searchEngineRegistryExtensionPoint","coreServices","ElasticSearchSearchEngine"],"mappings":";;;;;;;;AAoCO,MAAM,wCACXA,qCAAiE,CAAA;AAAA,EAC/D,EAAI,EAAA,uCAAA;AACN,CAAC,EAAA;AAOH,YAAeC,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,sBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,UAAA,CAAA;AAEJ,IAAA,GAAA,CAAI,uBAAuB,qCAAuC,EAAA;AAAA,MAChE,cAAc,aAAe,EAAA;AAC3B,QAAA,IAAI,UAAY,EAAA;AACd,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,qDAAA;AAAA,WACF,CAAA;AAAA,SACF;AACA,QAAa,UAAA,GAAA,aAAA,CAAA;AAAA,OACf;AAAA,KACD,CAAA,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,oBAAsB,EAAAC,0CAAA;AAAA,QACtB,QAAQC,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,UAAA;AAAA,OACvB;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,oBAAsB,EAAA,MAAA,EAAQ,QAAU,EAAA;AACnD,QAAqB,oBAAA,CAAA,eAAA;AAAA,UACnB,MAAMC,iEAA0B,UAAW,CAAA;AAAA,YACzC,MAAA;AAAA,YACA,MAAA;AAAA,YACA,UAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;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 */\nimport {\n coreServices,\n createBackendModule,\n createExtensionPoint,\n} from '@backstage/backend-plugin-api';\nimport { searchEngineRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\nimport {\n ElasticSearchQueryTranslator,\n ElasticSearchSearchEngine,\n} from '@backstage/plugin-search-backend-module-elasticsearch';\n\n/** @alpha */\nexport interface ElasticSearchQueryTranslatorExtensionPoint {\n setTranslator(translator: ElasticSearchQueryTranslator): void;\n}\n\n/**\n * Extension point used to customize the ElasticSearch query translator.\n *\n * @alpha\n */\nexport const elasticsearchTranslatorExtensionPoint =\n createExtensionPoint<ElasticSearchQueryTranslatorExtensionPoint>({\n id: 'search.elasticsearchEngine.translator',\n });\n\n/**\n * Search backend module for the Elasticsearch engine.\n *\n * @alpha\n */\nexport default createBackendModule({\n pluginId: 'search',\n moduleId: 'elasticsearch-engine',\n register(env) {\n let translator: ElasticSearchQueryTranslator | undefined;\n\n env.registerExtensionPoint(elasticsearchTranslatorExtensionPoint, {\n setTranslator(newTranslator) {\n if (translator) {\n throw new Error(\n 'ElasticSearch query translator may only be set once',\n );\n }\n translator = newTranslator;\n },\n });\n\n env.registerInit({\n deps: {\n searchEngineRegistry: searchEngineRegistryExtensionPoint,\n logger: coreServices.logger,\n config: coreServices.rootConfig,\n },\n async init({ searchEngineRegistry, logger, config }) {\n const baseKey = 'search.elasticsearch';\n const baseConfig = config.getOptional(baseKey);\n if (!baseConfig) {\n logger.warn(\n 'No configuration found under \"search.elasticsearch\" key. Skipping search engine inititalization.',\n );\n return;\n }\n\n searchEngineRegistry.setSearchEngine(\n await ElasticSearchSearchEngine.fromConfig({\n logger,\n config,\n translator,\n }),\n );\n },\n });\n },\n});\n"],"names":["createExtensionPoint","createBackendModule","searchEngineRegistryExtensionPoint","coreServices","ElasticSearchSearchEngine"],"mappings":";;;;;;;;AAoCO,MAAM,wCACXA,qCAAiE,CAAA;AAAA,EAC/D,EAAI,EAAA,uCAAA;AACN,CAAC,EAAA;AAOH,YAAeC,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,sBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,UAAA,CAAA;AAEJ,IAAA,GAAA,CAAI,uBAAuB,qCAAuC,EAAA;AAAA,MAChE,cAAc,aAAe,EAAA;AAC3B,QAAA,IAAI,UAAY,EAAA;AACd,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,qDAAA;AAAA,WACF,CAAA;AAAA,SACF;AACA,QAAa,UAAA,GAAA,aAAA,CAAA;AAAA,OACf;AAAA,KACD,CAAA,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,oBAAsB,EAAAC,0CAAA;AAAA,QACtB,QAAQC,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,UAAA;AAAA,OACvB;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,oBAAsB,EAAA,MAAA,EAAQ,QAAU,EAAA;AACnD,QAAA,MAAM,OAAU,GAAA,sBAAA,CAAA;AAChB,QAAM,MAAA,UAAA,GAAa,MAAO,CAAA,WAAA,CAAY,OAAO,CAAA,CAAA;AAC7C,QAAA,IAAI,CAAC,UAAY,EAAA;AACf,UAAO,MAAA,CAAA,IAAA;AAAA,YACL,mGAAA;AAAA,WACF,CAAA;AACA,UAAA,OAAA;AAAA,SACF;AAEA,QAAqB,oBAAA,CAAA,eAAA;AAAA,UACnB,MAAMC,iEAA0B,UAAW,CAAA;AAAA,YACzC,MAAA;AAAA,YACA,MAAA;AAAA,YACA,UAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;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-elasticsearch",
3
- "version": "1.3.20-next.1",
3
+ "version": "1.4.0",
4
4
  "description": "A module for the search backend that implements search using ElasticSearch",
5
5
  "backstage": {
6
6
  "role": "backend-plugin-module"
@@ -45,11 +45,11 @@
45
45
  "test": "backstage-cli package test"
46
46
  },
47
47
  "dependencies": {
48
- "@backstage/backend-common": "^0.21.7-next.1",
49
- "@backstage/backend-plugin-api": "^0.6.17-next.1",
48
+ "@backstage/backend-common": "^0.21.7",
49
+ "@backstage/backend-plugin-api": "^0.6.17",
50
50
  "@backstage/config": "^1.2.0",
51
51
  "@backstage/integration-aws-node": "^0.1.12",
52
- "@backstage/plugin-search-backend-node": "^1.2.21-next.1",
52
+ "@backstage/plugin-search-backend-node": "^1.2.21",
53
53
  "@backstage/plugin-search-common": "^1.2.11",
54
54
  "@elastic/elasticsearch": "^7.13.0",
55
55
  "@opensearch-project/opensearch": "^2.2.1",
@@ -60,8 +60,8 @@
60
60
  "winston": "^3.2.1"
61
61
  },
62
62
  "devDependencies": {
63
- "@backstage/backend-common": "^0.21.7-next.1",
64
- "@backstage/cli": "^0.26.3-next.1",
63
+ "@backstage/backend-common": "^0.21.7",
64
+ "@backstage/cli": "^0.26.3",
65
65
  "@elastic/elasticsearch-mock": "^1.0.0",
66
66
  "@short.io/opensearch-mock": "^0.3.1"
67
67
  },