@backstage/plugin-search-backend-module-elasticsearch 1.7.3 → 1.7.4-next.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.
- package/CHANGELOG.md +12 -0
- package/dist/index.d.ts +17 -18
- package/dist/module.cjs.js +2 -2
- package/dist/module.cjs.js.map +1 -1
- package/package.json +8 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @backstage/plugin-search-backend-module-elasticsearch
|
|
2
2
|
|
|
3
|
+
## 1.7.4-next.0
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 3507fcd: Just some more circular dep cleanup
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/config@1.3.3-next.0
|
|
10
|
+
- @backstage/integration-aws-node@0.1.17-next.0
|
|
11
|
+
- @backstage/backend-plugin-api@1.4.1-next.0
|
|
12
|
+
- @backstage/plugin-search-backend-node@1.3.13-next.0
|
|
13
|
+
- @backstage/plugin-search-common@1.2.19-next.0
|
|
14
|
+
|
|
3
15
|
## 1.7.3
|
|
4
16
|
|
|
5
17
|
### Patch Changes
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
|
|
2
2
|
import { LoggerService } from '@backstage/backend-plugin-api';
|
|
3
|
-
import { ElasticSearchQueryTranslator as ElasticSearchQueryTranslator$1 } from '@backstage/plugin-search-backend-module-elasticsearch';
|
|
4
3
|
import { IndexableDocument, SearchQuery, IndexableResultSet } from '@backstage/plugin-search-common';
|
|
5
4
|
import { BatchSearchEngineIndexer, SearchEngine } from '@backstage/plugin-search-backend-node';
|
|
6
5
|
import { Config } from '@backstage/config';
|
|
@@ -12,23 +11,6 @@ import * as _opensearch_project_opensearch_lib_Transport from '@opensearch-proje
|
|
|
12
11
|
import * as _opensearch_project_opensearch from '@opensearch-project/opensearch';
|
|
13
12
|
import { Readable } from 'stream';
|
|
14
13
|
|
|
15
|
-
/** @public */
|
|
16
|
-
interface ElasticSearchQueryTranslatorExtensionPoint {
|
|
17
|
-
setTranslator(translator: ElasticSearchQueryTranslator$1): void;
|
|
18
|
-
}
|
|
19
|
-
/**
|
|
20
|
-
* Extension point used to customize the ElasticSearch query translator.
|
|
21
|
-
*
|
|
22
|
-
* @public
|
|
23
|
-
*/
|
|
24
|
-
declare const elasticsearchTranslatorExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<ElasticSearchQueryTranslatorExtensionPoint>;
|
|
25
|
-
/**
|
|
26
|
-
* Search backend module for the Elasticsearch engine.
|
|
27
|
-
*
|
|
28
|
-
* @public
|
|
29
|
-
*/
|
|
30
|
-
declare const _default: _backstage_backend_plugin_api.BackendFeature;
|
|
31
|
-
|
|
32
14
|
/**
|
|
33
15
|
* Typeguard to differentiate ElasticSearch client options which are compatible
|
|
34
16
|
* with OpenSearch vs. ElasticSearch clients. Useful when calling the
|
|
@@ -485,4 +467,21 @@ declare function decodePageCursor(pageCursor?: string): {
|
|
|
485
467
|
page: number;
|
|
486
468
|
};
|
|
487
469
|
|
|
470
|
+
/** @public */
|
|
471
|
+
interface ElasticSearchQueryTranslatorExtensionPoint {
|
|
472
|
+
setTranslator(translator: ElasticSearchQueryTranslator): void;
|
|
473
|
+
}
|
|
474
|
+
/**
|
|
475
|
+
* Extension point used to customize the ElasticSearch query translator.
|
|
476
|
+
*
|
|
477
|
+
* @public
|
|
478
|
+
*/
|
|
479
|
+
declare const elasticsearchTranslatorExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<ElasticSearchQueryTranslatorExtensionPoint>;
|
|
480
|
+
/**
|
|
481
|
+
* Search backend module for the Elasticsearch engine.
|
|
482
|
+
*
|
|
483
|
+
* @public
|
|
484
|
+
*/
|
|
485
|
+
declare const _default: _backstage_backend_plugin_api.BackendFeature;
|
|
486
|
+
|
|
488
487
|
export { type BaseElasticSearchClientOptions, type ElasticSearchAgentOptions, type ElasticSearchAliasAction, type ElasticSearchAuth, type ElasticSearchClientOptions, ElasticSearchClientWrapper, type ElasticSearchConcreteQuery, type ElasticSearchConnectionConstructor, type ElasticSearchCustomIndexTemplate, type ElasticSearchCustomIndexTemplateBody, type ElasticSearchElasticSearchClientOptions, type ElasticSearchHighlightConfig, type ElasticSearchHighlightOptions, type ElasticSearchIndexAction, type ElasticSearchNodeOptions, type ElasticSearchOptions, type ElasticSearchQueryConfig, type ElasticSearchQueryTranslator, type ElasticSearchQueryTranslatorExtensionPoint, type ElasticSearchQueryTranslatorOptions, ElasticSearchSearchEngine, ElasticSearchSearchEngineIndexer, type ElasticSearchSearchEngineIndexerOptions, type ElasticSearchTransportConstructor, type OpenSearchAuth, type OpenSearchConnectionConstructor, type OpenSearchElasticSearchClientOptions, type OpenSearchNodeOptions, decodePageCursor as decodeElasticSearchPageCursor, _default as default, elasticsearchTranslatorExtensionPoint, isOpenSearchCompatible };
|
package/dist/module.cjs.js
CHANGED
|
@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
|
|
|
4
4
|
|
|
5
5
|
var backendPluginApi = require('@backstage/backend-plugin-api');
|
|
6
6
|
var alpha = require('@backstage/plugin-search-backend-node/alpha');
|
|
7
|
-
var
|
|
7
|
+
var ElasticSearchSearchEngine = require('./engines/ElasticSearchSearchEngine.cjs.js');
|
|
8
8
|
|
|
9
9
|
const elasticsearchTranslatorExtensionPoint = backendPluginApi.createExtensionPoint({
|
|
10
10
|
id: "search.elasticsearchEngine.translator"
|
|
@@ -46,7 +46,7 @@ var feature = backendPluginApi.createBackendModule({
|
|
|
46
46
|
logger.info(`Index prefix will be used for indices: ${indexPrefix}`);
|
|
47
47
|
}
|
|
48
48
|
searchEngineRegistry.setSearchEngine(
|
|
49
|
-
await
|
|
49
|
+
await ElasticSearchSearchEngine.ElasticSearchSearchEngine.fromConfig({
|
|
50
50
|
logger,
|
|
51
51
|
config,
|
|
52
52
|
translator,
|
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 */\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 '
|
|
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 */\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 './engines/ElasticSearchSearchEngine';\n\n/** @public */\nexport interface ElasticSearchQueryTranslatorExtensionPoint {\n setTranslator(translator: ElasticSearchQueryTranslator): void;\n}\n\n/**\n * Extension point used to customize the ElasticSearch query translator.\n *\n * @public\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 * @public\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 initialization.',\n );\n return;\n }\n const indexPrefix = config.getOptionalString(\n 'search.elasticsearch.indexPrefix',\n );\n if (indexPrefix) {\n logger.info(`Index prefix will be used for indices: ${indexPrefix}`);\n }\n searchEngineRegistry.setSearchEngine(\n await ElasticSearchSearchEngine.fromConfig({\n logger,\n config,\n translator,\n indexPrefix,\n }),\n );\n },\n });\n },\n});\n"],"names":["createExtensionPoint","createBackendModule","searchEngineRegistryExtensionPoint","coreServices","ElasticSearchSearchEngine"],"mappings":";;;;;;;;AAoCO,MAAM,wCACXA,qCAAiE,CAAA;AAAA,EAC/D,EAAI,EAAA;AACN,CAAC;AAOH,cAAeC,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,sBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,UAAA;AAEJ,IAAA,GAAA,CAAI,uBAAuB,qCAAuC,EAAA;AAAA,MAChE,cAAc,aAAe,EAAA;AAC3B,QAAA,IAAI,UAAY,EAAA;AACd,UAAA,MAAM,IAAI,KAAA;AAAA,YACR;AAAA,WACF;AAAA;AAEF,QAAa,UAAA,GAAA,aAAA;AAAA;AACf,KACD,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,oBAAsB,EAAAC,wCAAA;AAAA,QACtB,QAAQC,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA;AAAA,OACvB;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,oBAAsB,EAAA,MAAA,EAAQ,QAAU,EAAA;AACnD,QAAA,MAAM,OAAU,GAAA,sBAAA;AAChB,QAAM,MAAA,UAAA,GAAa,MAAO,CAAA,WAAA,CAAY,OAAO,CAAA;AAC7C,QAAA,IAAI,CAAC,UAAY,EAAA;AACf,UAAO,MAAA,CAAA,IAAA;AAAA,YACL;AAAA,WACF;AACA,UAAA;AAAA;AAEF,QAAA,MAAM,cAAc,MAAO,CAAA,iBAAA;AAAA,UACzB;AAAA,SACF;AACA,QAAA,IAAI,WAAa,EAAA;AACf,UAAO,MAAA,CAAA,IAAA,CAAK,CAA0C,uCAAA,EAAA,WAAW,CAAE,CAAA,CAAA;AAAA;AAErE,QAAqB,oBAAA,CAAA,eAAA;AAAA,UACnB,MAAMC,oDAA0B,UAAW,CAAA;AAAA,YACzC,MAAA;AAAA,YACA,MAAA;AAAA,YACA,UAAA;AAAA,YACA;AAAA,WACD;AAAA,SACH;AAAA;AACF,KACD,CAAA;AAAA;AAEL,CAAC,CAAA;;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-search-backend-module-elasticsearch",
|
|
3
|
-
"version": "1.7.
|
|
3
|
+
"version": "1.7.4-next.0",
|
|
4
4
|
"description": "A module for the search backend that implements search using ElasticSearch",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "backend-plugin-module",
|
|
@@ -62,11 +62,11 @@
|
|
|
62
62
|
"test": "backstage-cli package test"
|
|
63
63
|
},
|
|
64
64
|
"dependencies": {
|
|
65
|
-
"@backstage/backend-plugin-api": "
|
|
66
|
-
"@backstage/config": "
|
|
67
|
-
"@backstage/integration-aws-node": "
|
|
68
|
-
"@backstage/plugin-search-backend-node": "
|
|
69
|
-
"@backstage/plugin-search-common": "
|
|
65
|
+
"@backstage/backend-plugin-api": "1.4.1-next.0",
|
|
66
|
+
"@backstage/config": "1.3.3-next.0",
|
|
67
|
+
"@backstage/integration-aws-node": "0.1.17-next.0",
|
|
68
|
+
"@backstage/plugin-search-backend-node": "1.3.13-next.0",
|
|
69
|
+
"@backstage/plugin-search-common": "1.2.19-next.0",
|
|
70
70
|
"@elastic/elasticsearch": "^7.13.0",
|
|
71
71
|
"@opensearch-project/opensearch": "^2.2.1",
|
|
72
72
|
"aws4": "^1.12.0",
|
|
@@ -75,8 +75,8 @@
|
|
|
75
75
|
"uuid": "^11.0.0"
|
|
76
76
|
},
|
|
77
77
|
"devDependencies": {
|
|
78
|
-
"@backstage/backend-test-utils": "
|
|
79
|
-
"@backstage/cli": "
|
|
78
|
+
"@backstage/backend-test-utils": "1.7.0-next.1",
|
|
79
|
+
"@backstage/cli": "0.33.1-next.1",
|
|
80
80
|
"@elastic/elasticsearch-mock": "^1.0.0",
|
|
81
81
|
"@short.io/opensearch-mock": "^0.4.0"
|
|
82
82
|
},
|