@backstage/plugin-search-backend-module-elasticsearch 1.5.7-next.1 → 1.6.0

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @backstage/plugin-search-backend-module-elasticsearch
 
+## 1.6.0
+
+### Minor Changes
+
+- 3109c24: The export for the new backend system at the `/alpha` export is now also available via the main entry point, which means that you can remove the `/alpha` suffix from the import.
+
+### Patch Changes
+
+- d78b07c: Align the configuration schema with the docs and actual behavior of the code
+- 4b60e0c: Remove extension points from `/alpha` export, they're available from the main package already
+- 094eaa3: Remove references to in-repo backend-common
+- Updated dependencies
+  - @backstage/plugin-search-backend-node@1.3.3
+  - @backstage/backend-plugin-api@1.0.1
+  - @backstage/config@1.2.0
+  - @backstage/integration-aws-node@0.1.12
+  - @backstage/plugin-search-common@1.2.14
+
+## 1.5.7-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.0.1-next.1
+  - @backstage/config@1.2.0
+  - @backstage/integration-aws-node@0.1.12
+  - @backstage/plugin-search-backend-node@1.3.3-next.2
+  - @backstage/plugin-search-common@1.2.14
+
 ## 1.5.7-next.1
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-search-backend-module-elasticsearch__alpha",
-  "version": "1.5.7-next.1",
+  "version": "1.6.0",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -2,55 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var backendPluginApi = require('@backstage/backend-plugin-api');
-var alpha$1 = require('@backstage/plugin-search-backend-node/alpha');
-var pluginSearchBackendModuleElasticsearch = require('@backstage/plugin-search-backend-module-elasticsearch');
+var module$1 = require('./module.cjs.js');
 
-const elasticsearchTranslatorExtensionPoint = backendPluginApi.createExtensionPoint({
-  id: "search.elasticsearchEngine.translator"
-});
-var alpha = backendPluginApi.createBackendModule({
-  pluginId: "search",
-  moduleId: "elasticsearch-engine",
-  register(env) {
-    let translator;
-    env.registerExtensionPoint(elasticsearchTranslatorExtensionPoint, {
-      setTranslator(newTranslator) {
-        if (translator) {
-          throw new Error(
-            "ElasticSearch query translator may only be set once"
-          );
-        }
-        translator = newTranslator;
-      }
-    });
-    env.registerInit({
-      deps: {
-        searchEngineRegistry: alpha$1.searchEngineRegistryExtensionPoint,
-        logger: backendPluginApi.coreServices.logger,
-        config: backendPluginApi.coreServices.rootConfig
-      },
-      async init({ searchEngineRegistry, logger, config }) {
-        const baseKey = "search.elasticsearch";
-        const baseConfig = config.getOptional(baseKey);
-        if (!baseConfig) {
-          logger.warn(
-            'No configuration found under "search.elasticsearch" key.  Skipping search engine inititalization.'
-          );
-          return;
-        }
-        searchEngineRegistry.setSearchEngine(
-          await pluginSearchBackendModuleElasticsearch.ElasticSearchSearchEngine.fromConfig({
-            logger,
-            config,
-            translator
-          })
-        );
-      }
-    });
-  }
-});
+const _feature = module$1.default;
 
-exports.default = alpha;
-exports.elasticsearchTranslatorExtensionPoint = elasticsearchTranslatorExtensionPoint;
+exports.default = _feature;
 //# sourceMappingURL=alpha.cjs.js.map

package/dist/alpha.cjs.js.map

@@ -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        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;;;;;"}
+{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2024 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\nimport { default as feature } from './module';\n\n/** @alpha */\nconst _feature = feature;\nexport default _feature;\n"],"names":["feature"],"mappings":";;;;;;AAmBA,MAAM,QAAW,GAAAA;;;;"}

package/dist/alpha.d.ts

@@ -1,21 +1,6 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { ElasticSearchQueryTranslator } from '@backstage/plugin-search-backend-module-elasticsearch';
 
 /** @alpha */
-interface ElasticSearchQueryTranslatorExtensionPoint {
-    setTranslator(translator: ElasticSearchQueryTranslator): void;
-}
-/**
- * Extension point used to customize the ElasticSearch query translator.
- *
- * @alpha
- */
-declare const elasticsearchTranslatorExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<ElasticSearchQueryTranslatorExtensionPoint>;
-/**
- * Search backend module for the Elasticsearch engine.
- *
- * @alpha
- */
-declare const _default: _backstage_backend_plugin_api.BackendFeature;
+declare const _feature: _backstage_backend_plugin_api.BackendFeature;
 
-export { type ElasticSearchQueryTranslatorExtensionPoint, _default as default, elasticsearchTranslatorExtensionPoint };
+export { _feature as default };

package/dist/engines/ElasticSearchClientOptions.cjs.js

@@ -0,0 +1,8 @@
+'use strict';
+
+const isOpenSearchCompatible = (opts) => {
+  return ["aws", "opensearch"].includes(opts?.provider ?? "");
+};
+
+exports.isOpenSearchCompatible = isOpenSearchCompatible;
+//# sourceMappingURL=ElasticSearchClientOptions.cjs.js.map

package/dist/engines/ElasticSearchClientOptions.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ElasticSearchClientOptions.cjs.js","sources":["../../src/engines/ElasticSearchClientOptions.ts"],"sourcesContent":["/*\n * Copyright 2021 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 type { ConnectionOptions as TLSConnectionOptions } from 'tls';\n\n/**\n * Typeguard to differentiate ElasticSearch client options which are compatible\n * with OpenSearch vs. ElasticSearch clients. Useful when calling the\n * {@link ElasticSearchSearchEngine.newClient} method.\n *\n * @public\n */\nexport const isOpenSearchCompatible = (\n  opts: ElasticSearchClientOptions,\n): opts is OpenSearchElasticSearchClientOptions => {\n  return ['aws', 'opensearch'].includes(opts?.provider ?? '');\n};\n\n/**\n * Options used to configure the `@elastic/elasticsearch` client or the\n * `@opensearch-project/opensearch` client, depending on the given config. It\n * will be passed as an argument to the\n * {@link ElasticSearchSearchEngine.newClient} method.\n *\n * @public\n */\nexport type ElasticSearchClientOptions =\n  | ElasticSearchElasticSearchClientOptions\n  | OpenSearchElasticSearchClientOptions;\n\n/**\n * Options used to configure the `@opensearch-project/opensearch` client.\n *\n * They are drawn from the `ClientOptions` class of `@opensearch-project/opensearch`,\n * but are maintained separately so that this interface is not coupled to it.\n *\n * @public\n */\nexport interface OpenSearchElasticSearchClientOptions\n  extends BaseElasticSearchClientOptions {\n  provider?: 'aws' | 'opensearch';\n  region?: string;\n  service?: 'es' | 'aoss';\n  auth?: OpenSearchAuth;\n  connection?: OpenSearchConnectionConstructor;\n  node?: string | string[] | OpenSearchNodeOptions | OpenSearchNodeOptions[];\n  nodes?: string | string[] | OpenSearchNodeOptions | OpenSearchNodeOptions[];\n}\n\n/**\n * Options used to configure the `@elastic/elasticsearch` client.\n *\n * They are drawn from the `ClientOptions` class of `@elastic/elasticsearch`,\n * but are maintained separately so that this interface is not coupled to it.\n *\n * @public\n */\nexport interface ElasticSearchElasticSearchClientOptions\n  extends BaseElasticSearchClientOptions {\n  provider?: 'elastic';\n  auth?: ElasticSearchAuth;\n  Connection?: ElasticSearchConnectionConstructor;\n  node?:\n    | string\n    | string[]\n    | ElasticSearchNodeOptions\n    | ElasticSearchNodeOptions[];\n  nodes?:\n    | string\n    | string[]\n    | ElasticSearchNodeOptions\n    | ElasticSearchNodeOptions[];\n  cloud?: {\n    id: string;\n    username?: string;\n    password?: string;\n  };\n}\n\n/**\n * Base client options that are shared across `@opensearch-project/opensearch`\n * and `@elastic/elasticsearch` clients.\n *\n * @public\n */\nexport interface BaseElasticSearchClientOptions {\n  Transport?: ElasticSearchTransportConstructor;\n  maxRetries?: number;\n  requestTimeout?: number;\n  pingTimeout?: number;\n  sniffInterval?: number | boolean;\n  sniffOnStart?: boolean;\n  sniffEndpoint?: string;\n  sniffOnConnectionFault?: boolean;\n  resurrectStrategy?: 'ping' | 'optimistic' | 'none';\n  suggestCompression?: boolean;\n  compression?: 'gzip';\n  ssl?: TLSConnectionOptions;\n  agent?: ElasticSearchAgentOptions | ((opts?: any) => unknown) | false;\n  nodeFilter?: (connection: any) => boolean;\n  nodeSelector?: ((connections: any[]) => any) | string;\n  headers?: Record<string, any>;\n  opaqueIdPrefix?: string;\n  name?: string | symbol;\n  proxy?: string | URL;\n  enableMetaHeader?: boolean;\n  disablePrototypePoisoningProtection?: boolean | 'proto' | 'constructor';\n}\n\n/**\n * @public\n */\nexport type OpenSearchAuth = {\n  username: string;\n  password: string;\n};\n\n/**\n * @public\n */\nexport type ElasticSearchAuth =\n  | OpenSearchAuth\n  | {\n      apiKey:\n        | string\n        | {\n            id: string;\n            api_key: string;\n          };\n    };\n\n/**\n * @public\n */\nexport interface ElasticSearchNodeOptions {\n  url: URL;\n  id?: string;\n  agent?: ElasticSearchAgentOptions;\n  ssl?: TLSConnectionOptions;\n  headers?: Record<string, any>;\n  roles?: {\n    master: boolean;\n    data: boolean;\n    ingest: boolean;\n    ml: boolean;\n  };\n}\n\n/**\n * @public\n */\nexport interface OpenSearchNodeOptions {\n  url: URL;\n  id?: string;\n  agent?: ElasticSearchAgentOptions;\n  ssl?: TLSConnectionOptions;\n  headers?: Record<string, any>;\n  roles?: {\n    master: boolean;\n    data: boolean;\n    ingest: boolean;\n  };\n}\n\n/**\n * @public\n */\nexport interface ElasticSearchAgentOptions {\n  keepAlive?: boolean;\n  keepAliveMsecs?: number;\n  maxSockets?: number;\n  maxFreeSockets?: number;\n}\n\n/**\n * @public\n */\nexport interface ElasticSearchConnectionConstructor {\n  new (opts?: any): any;\n  statuses: {\n    ALIVE: string;\n    DEAD: string;\n  };\n  roles: {\n    MASTER: string;\n    DATA: string;\n    INGEST: string;\n    ML: string;\n  };\n}\n\n/**\n * @public\n */\nexport interface OpenSearchConnectionConstructor {\n  new (opts?: any): any;\n  statuses: {\n    ALIVE: string;\n    DEAD: string;\n  };\n  roles: {\n    MASTER: string;\n    DATA: string;\n    INGEST: string;\n  };\n}\n\n/**\n * @public\n */\nexport interface ElasticSearchTransportConstructor {\n  new (opts?: any): any;\n  sniffReasons: {\n    SNIFF_ON_START: string;\n    SNIFF_INTERVAL: string;\n    SNIFF_ON_CONNECTION_FAULT: string;\n    DEFAULT: string;\n  };\n}\n\n// todo(iamEAP) implement canary types to ensure we remain compatible through upgrades.\n"],"names":[],"mappings":";;AAwBa,MAAA,sBAAA,GAAyB,CACpC,IACiD,KAAA;AACjD,EAAA,OAAO,CAAC,KAAO,EAAA,YAAY,EAAE,QAAS,CAAA,IAAA,EAAM,YAAY,EAAE,CAAA,CAAA;AAC5D;;;;"}

package/dist/engines/ElasticSearchClientWrapper.cjs.js

@@ -0,0 +1,137 @@
+'use strict';
+
+var elasticsearch = require('@elastic/elasticsearch');
+var opensearch = require('@opensearch-project/opensearch');
+var ElasticSearchClientOptions = require('./ElasticSearchClientOptions.cjs.js');
+
+class ElasticSearchClientWrapper {
+  elasticSearchClient;
+  openSearchClient;
+  constructor(options) {
+    this.openSearchClient = options.openSearchClient;
+    this.elasticSearchClient = options.elasticSearchClient;
+  }
+  static fromClientOptions(options) {
+    if (ElasticSearchClientOptions.isOpenSearchCompatible(options)) {
+      return new ElasticSearchClientWrapper({
+        openSearchClient: new opensearch.Client(options)
+      });
+    }
+    return new ElasticSearchClientWrapper({
+      elasticSearchClient: new elasticsearch.Client(options)
+    });
+  }
+  search(options) {
+    const searchOptions = {
+      ignore_unavailable: true,
+      allow_no_indices: true
+    };
+    if (this.openSearchClient) {
+      return this.openSearchClient.search({
+        ...options,
+        ...searchOptions
+      });
+    }
+    if (this.elasticSearchClient) {
+      return this.elasticSearchClient.search({
+        ...options,
+        ...searchOptions
+      });
+    }
+    throw new Error("No client defined");
+  }
+  bulk(bulkOptions) {
+    if (this.openSearchClient) {
+      return this.openSearchClient.helpers.bulk(bulkOptions);
+    }
+    if (this.elasticSearchClient) {
+      return this.elasticSearchClient.helpers.bulk(bulkOptions);
+    }
+    throw new Error("No client defined");
+  }
+  putIndexTemplate(template) {
+    if (this.openSearchClient) {
+      return this.openSearchClient.indices.putIndexTemplate(template);
+    }
+    if (this.elasticSearchClient) {
+      return this.elasticSearchClient.indices.putIndexTemplate(template);
+    }
+    throw new Error("No client defined");
+  }
+  listIndices(options) {
+    if (this.openSearchClient) {
+      return this.openSearchClient.indices.get(options);
+    }
+    if (this.elasticSearchClient) {
+      return this.elasticSearchClient.indices.get(options);
+    }
+    throw new Error("No client defined");
+  }
+  indexExists(options) {
+    if (this.openSearchClient) {
+      return this.openSearchClient.indices.exists(options);
+    }
+    if (this.elasticSearchClient) {
+      return this.elasticSearchClient.indices.exists(options);
+    }
+    throw new Error("No client defined");
+  }
+  deleteIndex(options) {
+    if (this.openSearchClient) {
+      return this.openSearchClient.indices.delete(options);
+    }
+    if (this.elasticSearchClient) {
+      return this.elasticSearchClient.indices.delete(options);
+    }
+    throw new Error("No client defined");
+  }
+  /**
+   * @deprecated unused by the ElasticSearch Engine, will be removed in the future
+   */
+  getAliases(options) {
+    const { aliases } = options;
+    if (this.openSearchClient) {
+      return this.openSearchClient.cat.aliases({
+        format: "json",
+        name: aliases
+      });
+    }
+    if (this.elasticSearchClient) {
+      return this.elasticSearchClient.cat.aliases({
+        format: "json",
+        name: aliases
+      });
+    }
+    throw new Error("No client defined");
+  }
+  createIndex(options) {
+    if (this.openSearchClient) {
+      return this.openSearchClient.indices.create(options);
+    }
+    if (this.elasticSearchClient) {
+      return this.elasticSearchClient.indices.create(options);
+    }
+    throw new Error("No client defined");
+  }
+  updateAliases(options) {
+    const filteredActions = options.actions.filter(Boolean);
+    if (this.openSearchClient) {
+      return this.openSearchClient.indices.updateAliases({
+        body: {
+          actions: filteredActions
+        }
+      });
+    }
+    if (this.elasticSearchClient) {
+      return this.elasticSearchClient.indices.updateAliases({
+        body: {
+          actions: filteredActions
+        }
+      });
+    }
+    throw new Error("No client defined");
+  }
+}
+
+exports.ElasticSearchClientWrapper = ElasticSearchClientWrapper;
+//# sourceMappingURL=ElasticSearchClientWrapper.cjs.js.map

package/dist/engines/ElasticSearchClientWrapper.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ElasticSearchClientWrapper.cjs.js","sources":["../../src/engines/ElasticSearchClientWrapper.ts"],"sourcesContent":["/*\n * Copyright 2021 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\nimport { Client as ElasticSearchClient } from '@elastic/elasticsearch';\nimport { Client as OpenSearchClient } from '@opensearch-project/opensearch';\nimport { Readable } from 'stream';\nimport {\n  ElasticSearchClientOptions,\n  isOpenSearchCompatible,\n} from './ElasticSearchClientOptions';\nimport { ElasticSearchCustomIndexTemplate } from './types';\n\n/**\n * @public\n */\nexport type ElasticSearchAliasAction =\n  | {\n      remove: { index: any; alias: any };\n      add?: undefined;\n    }\n  | {\n      add: { indices: any; alias: any; index?: undefined };\n      remove?: undefined;\n    }\n  | {\n      add: { index: any; alias: any; indices?: undefined };\n      remove?: undefined;\n    }\n  | undefined;\n\n/**\n * @public\n */\nexport type ElasticSearchIndexAction = {\n  index: {\n    _index: string;\n    [key: string]: any;\n  };\n};\n\n/**\n * A wrapper class that exposes logical methods that are conditionally fired\n * against either a configured Elasticsearch client or a configured Opensearch\n * client.\n *\n * This is necessary because, despite its intention to be API-compatible, the\n * opensearch client does not support API key-based authentication. This is\n * also the sanest way to accomplish this while making typescript happy.\n *\n * In the future, if the differences between implementations become\n * unmaintainably divergent, we should split out the Opensearch and\n * Elasticsearch search engine implementations.\n *\n * @public\n */\nexport class ElasticSearchClientWrapper {\n  private readonly elasticSearchClient: ElasticSearchClient | undefined;\n  private readonly openSearchClient: OpenSearchClient | undefined;\n\n  private constructor(options: {\n    openSearchClient?: OpenSearchClient;\n    elasticSearchClient?: ElasticSearchClient;\n  }) {\n    this.openSearchClient = options.openSearchClient;\n    this.elasticSearchClient = options.elasticSearchClient;\n  }\n\n  static fromClientOptions(options: ElasticSearchClientOptions) {\n    if (isOpenSearchCompatible(options)) {\n      return new ElasticSearchClientWrapper({\n        openSearchClient: new OpenSearchClient(options),\n      });\n    }\n\n    return new ElasticSearchClientWrapper({\n      elasticSearchClient: new ElasticSearchClient(options),\n    });\n  }\n\n  search(options: { index: string | string[]; body: Object }) {\n    const searchOptions = {\n      ignore_unavailable: true,\n      allow_no_indices: true,\n    };\n\n    if (this.openSearchClient) {\n      return this.openSearchClient.search({\n        ...options,\n        ...searchOptions,\n      });\n    }\n\n    if (this.elasticSearchClient) {\n      return this.elasticSearchClient.search({\n        ...options,\n        ...searchOptions,\n      });\n    }\n\n    throw new Error('No client defined');\n  }\n\n  bulk(bulkOptions: {\n    datasource: Readable;\n    onDocument: () => ElasticSearchIndexAction;\n    refreshOnCompletion?: string | boolean;\n  }) {\n    if (this.openSearchClient) {\n      return this.openSearchClient.helpers.bulk(bulkOptions);\n    }\n\n    if (this.elasticSearchClient) {\n      return this.elasticSearchClient.helpers.bulk(bulkOptions);\n    }\n\n    throw new Error('No client defined');\n  }\n\n  putIndexTemplate(template: ElasticSearchCustomIndexTemplate) {\n    if (this.openSearchClient) {\n      return this.openSearchClient.indices.putIndexTemplate(template);\n    }\n\n    if (this.elasticSearchClient) {\n      return this.elasticSearchClient.indices.putIndexTemplate(template);\n    }\n\n    throw new Error('No client defined');\n  }\n\n  listIndices(options: { index: string }) {\n    if (this.openSearchClient) {\n      return this.openSearchClient.indices.get(options);\n    }\n\n    if (this.elasticSearchClient) {\n      return this.elasticSearchClient.indices.get(options);\n    }\n\n    throw new Error('No client defined');\n  }\n\n  indexExists(options: { index: string | string[] }) {\n    if (this.openSearchClient) {\n      return this.openSearchClient.indices.exists(options);\n    }\n\n    if (this.elasticSearchClient) {\n      return this.elasticSearchClient.indices.exists(options);\n    }\n\n    throw new Error('No client defined');\n  }\n\n  deleteIndex(options: { index: string | string[] }) {\n    if (this.openSearchClient) {\n      return this.openSearchClient.indices.delete(options);\n    }\n\n    if (this.elasticSearchClient) {\n      return this.elasticSearchClient.indices.delete(options);\n    }\n\n    throw new Error('No client defined');\n  }\n\n  /**\n   * @deprecated unused by the ElasticSearch Engine, will be removed in the future\n   */\n  getAliases(options: { aliases: string[] }) {\n    const { aliases } = options;\n\n    if (this.openSearchClient) {\n      return this.openSearchClient.cat.aliases({\n        format: 'json',\n        name: aliases,\n      });\n    }\n\n    if (this.elasticSearchClient) {\n      return this.elasticSearchClient.cat.aliases({\n        format: 'json',\n        name: aliases,\n      });\n    }\n\n    throw new Error('No client defined');\n  }\n\n  createIndex(options: { index: string }) {\n    if (this.openSearchClient) {\n      return this.openSearchClient.indices.create(options);\n    }\n\n    if (this.elasticSearchClient) {\n      return this.elasticSearchClient.indices.create(options);\n    }\n\n    throw new Error('No client defined');\n  }\n\n  updateAliases(options: { actions: ElasticSearchAliasAction[] }) {\n    const filteredActions = options.actions.filter(Boolean);\n\n    if (this.openSearchClient) {\n      return this.openSearchClient.indices.updateAliases({\n        body: {\n          actions: filteredActions,\n        },\n      });\n    }\n\n    if (this.elasticSearchClient) {\n      return this.elasticSearchClient.indices.updateAliases({\n        body: {\n          actions: filteredActions,\n        },\n      });\n    }\n\n    throw new Error('No client defined');\n  }\n}\n"],"names":["isOpenSearchCompatible","OpenSearchClient","ElasticSearchClient"],"mappings":";;;;;;AAoEO,MAAM,0BAA2B,CAAA;AAAA,EACrB,mBAAA,CAAA;AAAA,EACA,gBAAA,CAAA;AAAA,EAET,YAAY,OAGjB,EAAA;AACD,IAAA,IAAA,CAAK,mBAAmB,OAAQ,CAAA,gBAAA,CAAA;AAChC,IAAA,IAAA,CAAK,sBAAsB,OAAQ,CAAA,mBAAA,CAAA;AAAA,GACrC;AAAA,EAEA,OAAO,kBAAkB,OAAqC,EAAA;AAC5D,IAAI,IAAAA,iDAAA,CAAuB,OAAO,CAAG,EAAA;AACnC,MAAA,OAAO,IAAI,0BAA2B,CAAA;AAAA,QACpC,gBAAA,EAAkB,IAAIC,iBAAA,CAAiB,OAAO,CAAA;AAAA,OAC/C,CAAA,CAAA;AAAA,KACH;AAEA,IAAA,OAAO,IAAI,0BAA2B,CAAA;AAAA,MACpC,mBAAA,EAAqB,IAAIC,oBAAA,CAAoB,OAAO,CAAA;AAAA,KACrD,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,OAAO,OAAqD,EAAA;AAC1D,IAAA,MAAM,aAAgB,GAAA;AAAA,MACpB,kBAAoB,EAAA,IAAA;AAAA,MACpB,gBAAkB,EAAA,IAAA;AAAA,KACpB,CAAA;AAEA,IAAA,IAAI,KAAK,gBAAkB,EAAA;AACzB,MAAO,OAAA,IAAA,CAAK,iBAAiB,MAAO,CAAA;AAAA,QAClC,GAAG,OAAA;AAAA,QACH,GAAG,aAAA;AAAA,OACJ,CAAA,CAAA;AAAA,KACH;AAEA,IAAA,IAAI,KAAK,mBAAqB,EAAA;AAC5B,MAAO,OAAA,IAAA,CAAK,oBAAoB,MAAO,CAAA;AAAA,QACrC,GAAG,OAAA;AAAA,QACH,GAAG,aAAA;AAAA,OACJ,CAAA,CAAA;AAAA,KACH;AAEA,IAAM,MAAA,IAAI,MAAM,mBAAmB,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,KAAK,WAIF,EAAA;AACD,IAAA,IAAI,KAAK,gBAAkB,EAAA;AACzB,MAAA,OAAO,IAAK,CAAA,gBAAA,CAAiB,OAAQ,CAAA,IAAA,CAAK,WAAW,CAAA,CAAA;AAAA,KACvD;AAEA,IAAA,IAAI,KAAK,mBAAqB,EAAA;AAC5B,MAAA,OAAO,IAAK,CAAA,mBAAA,CAAoB,OAAQ,CAAA,IAAA,CAAK,WAAW,CAAA,CAAA;AAAA,KAC1D;AAEA,IAAM,MAAA,IAAI,MAAM,mBAAmB,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,iBAAiB,QAA4C,EAAA;AAC3D,IAAA,IAAI,KAAK,gBAAkB,EAAA;AACzB,MAAA,OAAO,IAAK,CAAA,gBAAA,CAAiB,OAAQ,CAAA,gBAAA,CAAiB,QAAQ,CAAA,CAAA;AAAA,KAChE;AAEA,IAAA,IAAI,KAAK,mBAAqB,EAAA;AAC5B,MAAA,OAAO,IAAK,CAAA,mBAAA,CAAoB,OAAQ,CAAA,gBAAA,CAAiB,QAAQ,CAAA,CAAA;AAAA,KACnE;AAEA,IAAM,MAAA,IAAI,MAAM,mBAAmB,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,YAAY,OAA4B,EAAA;AACtC,IAAA,IAAI,KAAK,gBAAkB,EAAA;AACzB,MAAA,OAAO,IAAK,CAAA,gBAAA,CAAiB,OAAQ,CAAA,GAAA,CAAI,OAAO,CAAA,CAAA;AAAA,KAClD;AAEA,IAAA,IAAI,KAAK,mBAAqB,EAAA;AAC5B,MAAA,OAAO,IAAK,CAAA,mBAAA,CAAoB,OAAQ,CAAA,GAAA,CAAI,OAAO,CAAA,CAAA;AAAA,KACrD;AAEA,IAAM,MAAA,IAAI,MAAM,mBAAmB,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,YAAY,OAAuC,EAAA;AACjD,IAAA,IAAI,KAAK,gBAAkB,EAAA;AACzB,MAAA,OAAO,IAAK,CAAA,gBAAA,CAAiB,OAAQ,CAAA,MAAA,CAAO,OAAO,CAAA,CAAA;AAAA,KACrD;AAEA,IAAA,IAAI,KAAK,mBAAqB,EAAA;AAC5B,MAAA,OAAO,IAAK,CAAA,mBAAA,CAAoB,OAAQ,CAAA,MAAA,CAAO,OAAO,CAAA,CAAA;AAAA,KACxD;AAEA,IAAM,MAAA,IAAI,MAAM,mBAAmB,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,YAAY,OAAuC,EAAA;AACjD,IAAA,IAAI,KAAK,gBAAkB,EAAA;AACzB,MAAA,OAAO,IAAK,CAAA,gBAAA,CAAiB,OAAQ,CAAA,MAAA,CAAO,OAAO,CAAA,CAAA;AAAA,KACrD;AAEA,IAAA,IAAI,KAAK,mBAAqB,EAAA;AAC5B,MAAA,OAAO,IAAK,CAAA,mBAAA,CAAoB,OAAQ,CAAA,MAAA,CAAO,OAAO,CAAA,CAAA;AAAA,KACxD;AAEA,IAAM,MAAA,IAAI,MAAM,mBAAmB,CAAA,CAAA;AAAA,GACrC;AAAA;AAAA;AAAA;AAAA,EAKA,WAAW,OAAgC,EAAA;AACzC,IAAM,MAAA,EAAE,SAAY,GAAA,OAAA,CAAA;AAEpB,IAAA,IAAI,KAAK,gBAAkB,EAAA;AACzB,MAAO,OAAA,IAAA,CAAK,gBAAiB,CAAA,GAAA,CAAI,OAAQ,CAAA;AAAA,QACvC,MAAQ,EAAA,MAAA;AAAA,QACR,IAAM,EAAA,OAAA;AAAA,OACP,CAAA,CAAA;AAAA,KACH;AAEA,IAAA,IAAI,KAAK,mBAAqB,EAAA;AAC5B,MAAO,OAAA,IAAA,CAAK,mBAAoB,CAAA,GAAA,CAAI,OAAQ,CAAA;AAAA,QAC1C,MAAQ,EAAA,MAAA;AAAA,QACR,IAAM,EAAA,OAAA;AAAA,OACP,CAAA,CAAA;AAAA,KACH;AAEA,IAAM,MAAA,IAAI,MAAM,mBAAmB,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,YAAY,OAA4B,EAAA;AACtC,IAAA,IAAI,KAAK,gBAAkB,EAAA;AACzB,MAAA,OAAO,IAAK,CAAA,gBAAA,CAAiB,OAAQ,CAAA,MAAA,CAAO,OAAO,CAAA,CAAA;AAAA,KACrD;AAEA,IAAA,IAAI,KAAK,mBAAqB,EAAA;AAC5B,MAAA,OAAO,IAAK,CAAA,mBAAA,CAAoB,OAAQ,CAAA,MAAA,CAAO,OAAO,CAAA,CAAA;AAAA,KACxD;AAEA,IAAM,MAAA,IAAI,MAAM,mBAAmB,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,cAAc,OAAkD,EAAA;AAC9D,IAAA,MAAM,eAAkB,GAAA,OAAA,CAAQ,OAAQ,CAAA,MAAA,CAAO,OAAO,CAAA,CAAA;AAEtD,IAAA,IAAI,KAAK,gBAAkB,EAAA;AACzB,MAAO,OAAA,IAAA,CAAK,gBAAiB,CAAA,OAAA,CAAQ,aAAc,CAAA;AAAA,QACjD,IAAM,EAAA;AAAA,UACJ,OAAS,EAAA,eAAA;AAAA,SACX;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAEA,IAAA,IAAI,KAAK,mBAAqB,EAAA;AAC5B,MAAO,OAAA,IAAA,CAAK,mBAAoB,CAAA,OAAA,CAAQ,aAAc,CAAA;AAAA,QACpD,IAAM,EAAA;AAAA,UACJ,OAAS,EAAA,eAAA;AAAA,SACX;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAEA,IAAM,MAAA,IAAI,MAAM,mBAAmB,CAAA,CAAA;AAAA,GACrC;AACF;;;;"}