@backstage/plugin-search-backend-module-elasticsearch 1.1.5-next.0 → 1.2.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @backstage/plugin-search-backend-module-elasticsearch
 
+## 1.2.0-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.18.4-next.2
+  - @backstage/backend-plugin-api@0.5.1-next.2
+  - @backstage/config@1.0.7
+  - @backstage/plugin-search-backend-node@1.2.0-next.2
+  - @backstage/plugin-search-common@1.2.3-next.0
+
+## 1.2.0-next.1
+
+### Minor Changes
+
+- 1469daa409e: Search backend modules migrated to the new backend system. For documentation on how to migrate, check out the [how to migrate to the new backend system guide](https://backstage.io/docs/features/search/how-to-guides/#how-to-migrate-your-backend-installation-to-use-search-together-with-the-new-backend-system).
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-search-backend-node@1.2.0-next.1
+  - @backstage/backend-common@0.18.4-next.1
+  - @backstage/backend-plugin-api@0.5.1-next.1
+  - @backstage/config@1.0.7
+  - @backstage/plugin-search-common@1.2.3-next.0
+
 ## 1.1.5-next.0
 
 ### Patch Changes

package/alpha/package.json

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

package/dist/alpha.cjs.js

@@ -0,0 +1,40 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var backendCommon = require('@backstage/backend-common');
+var alpha = require('@backstage/plugin-search-backend-node/alpha');
+var pluginSearchBackendModuleElasticsearch = require('@backstage/plugin-search-backend-module-elasticsearch');
+
+const searchModuleElasticsearchEngine = backendPluginApi.createBackendModule(
+  (options) => ({
+    moduleId: "elasticsearchEngine",
+    pluginId: "search",
+    register(env) {
+      env.registerInit({
+        deps: {
+          searchEngineRegistry: alpha.searchEngineRegistryExtensionPoint,
+          logger: backendPluginApi.coreServices.logger,
+          config: backendPluginApi.coreServices.config
+        },
+        async init({ searchEngineRegistry, logger, config }) {
+          const searchEngine = await pluginSearchBackendModuleElasticsearch.ElasticSearchSearchEngine.fromConfig({
+            logger: backendCommon.loggerToWinstonLogger(logger),
+            config
+          });
+          if (options == null ? void 0 : options.translator) {
+            searchEngine.setTranslator(options.translator);
+          }
+          if (options == null ? void 0 : options.indexTemplate) {
+            searchEngine.setIndexTemplate(options.indexTemplate);
+          }
+          searchEngineRegistry.setSearchEngine(searchEngine);
+        }
+      });
+    }
+  })
+);
+
+exports.searchModuleElasticsearchEngine = searchModuleElasticsearchEngine;
+//# sourceMappingURL=alpha.cjs.js.map

package/dist/alpha.cjs.js.map

@@ -0,0 +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} from '@backstage/backend-plugin-api';\nimport { loggerToWinstonLogger } from '@backstage/backend-common';\nimport { searchEngineRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';\n\nimport {\n  ElasticSearchCustomIndexTemplate,\n  ElasticSearchQueryTranslator,\n  ElasticSearchSearchEngine,\n} from '@backstage/plugin-search-backend-module-elasticsearch';\n\n/**\n * @alpha\n * Options for {@link searchModuleElasticsearchEngine}.\n */\nexport type SearchModuleElasticsearchEngineOptions = {\n  translator?: ElasticSearchQueryTranslator;\n  indexTemplate?: ElasticSearchCustomIndexTemplate;\n};\n\n/**\n * @alpha\n * Search backend module for the Elasticsearch engine.\n */\nexport const searchModuleElasticsearchEngine = createBackendModule(\n  (options?: SearchModuleElasticsearchEngineOptions) => ({\n    moduleId: 'elasticsearchEngine',\n    pluginId: 'search',\n    register(env) {\n      env.registerInit({\n        deps: {\n          searchEngineRegistry: searchEngineRegistryExtensionPoint,\n          logger: coreServices.logger,\n          config: coreServices.config,\n        },\n        async init({ searchEngineRegistry, logger, config }) {\n          const searchEngine = await ElasticSearchSearchEngine.fromConfig({\n            logger: loggerToWinstonLogger(logger),\n            config: config,\n          });\n\n          // set custom translator if available\n          if (options?.translator) {\n            searchEngine.setTranslator(options.translator);\n          }\n\n          // set custom index template if available\n          if (options?.indexTemplate) {\n            searchEngine.setIndexTemplate(options.indexTemplate);\n          }\n\n          searchEngineRegistry.setSearchEngine(searchEngine);\n        },\n      });\n    },\n  }),\n);\n"],"names":["createBackendModule","searchEngineRegistryExtensionPoint","coreServices","ElasticSearchSearchEngine","loggerToWinstonLogger"],"mappings":";;;;;;;;;AAyCO,MAAM,+BAAkC,GAAAA,oCAAA;AAAA,EAC7C,CAAC,OAAsD,MAAA;AAAA,IACrD,QAAU,EAAA,qBAAA;AAAA,IACV,QAAU,EAAA,QAAA;AAAA,IACV,SAAS,GAAK,EAAA;AACZ,MAAA,GAAA,CAAI,YAAa,CAAA;AAAA,QACf,IAAM,EAAA;AAAA,UACJ,oBAAsB,EAAAC,wCAAA;AAAA,UACtB,QAAQC,6BAAa,CAAA,MAAA;AAAA,UACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,SACvB;AAAA,QACA,MAAM,IAAK,CAAA,EAAE,oBAAsB,EAAA,MAAA,EAAQ,QAAU,EAAA;AACnD,UAAM,MAAA,YAAA,GAAe,MAAMC,gEAAA,CAA0B,UAAW,CAAA;AAAA,YAC9D,MAAA,EAAQC,oCAAsB,MAAM,CAAA;AAAA,YACpC,MAAA;AAAA,WACD,CAAA,CAAA;AAGD,UAAA,IAAI,mCAAS,UAAY,EAAA;AACvB,YAAa,YAAA,CAAA,aAAA,CAAc,QAAQ,UAAU,CAAA,CAAA;AAAA,WAC/C;AAGA,UAAA,IAAI,mCAAS,aAAe,EAAA;AAC1B,YAAa,YAAA,CAAA,gBAAA,CAAiB,QAAQ,aAAa,CAAA,CAAA;AAAA,WACrD;AAEA,UAAA,oBAAA,CAAqB,gBAAgB,YAAY,CAAA,CAAA;AAAA,SACnD;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAAA,GACF,CAAA;AACF;;;;"}

package/dist/alpha.d.ts

@@ -0,0 +1,18 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { ElasticSearchQueryTranslator, ElasticSearchCustomIndexTemplate } from '@backstage/plugin-search-backend-module-elasticsearch';
+
+/**
+ * @alpha
+ * Options for {@link searchModuleElasticsearchEngine}.
+ */
+type SearchModuleElasticsearchEngineOptions = {
+    translator?: ElasticSearchQueryTranslator;
+    indexTemplate?: ElasticSearchCustomIndexTemplate;
+};
+/**
+ * @alpha
+ * Search backend module for the Elasticsearch engine.
+ */
+declare const searchModuleElasticsearchEngine: (options?: SearchModuleElasticsearchEngineOptions | undefined) => _backstage_backend_plugin_api.BackendFeature;
+
+export { SearchModuleElasticsearchEngineOptions, searchModuleElasticsearchEngine };

package/dist/index.d.ts

@@ -27,7 +27,7 @@ declare const isOpenSearchCompatible: (opts: ElasticSearchClientOptions) => opts
  *
  * @public
  */
-declare type ElasticSearchClientOptions = ElasticSearchElasticSearchClientOptions | OpenSearchElasticSearchClientOptions;
+type ElasticSearchClientOptions = ElasticSearchElasticSearchClientOptions | OpenSearchElasticSearchClientOptions;
 /**
  * Options used to configure the `@opensearch-project/opensearch` client.
  *
@@ -95,14 +95,14 @@ interface BaseElasticSearchClientOptions {
 /**
  * @public
  */
-declare type OpenSearchAuth = {
+type OpenSearchAuth = {
     username: string;
     password: string;
 };
 /**
  * @public
  */
-declare type ElasticSearchAuth = OpenSearchAuth | {
+type ElasticSearchAuth = OpenSearchAuth | {
     apiKey: string | {
         id: string;
         api_key: string;
@@ -196,7 +196,7 @@ interface ElasticSearchTransportConstructor {
  * Elasticsearch specific index template
  * @public
  */
-declare type ElasticSearchCustomIndexTemplate = {
+type ElasticSearchCustomIndexTemplate = {
     name: string;
     body: ElasticSearchCustomIndexTemplateBody;
 };
@@ -204,7 +204,7 @@ declare type ElasticSearchCustomIndexTemplate = {
  * Elasticsearch specific index template body
  * @public
  */
-declare type ElasticSearchCustomIndexTemplateBody = {
+type ElasticSearchCustomIndexTemplateBody = {
     /**
      * Array of wildcard (*) expressions used to match the names of data streams and indices during creation.
      */
@@ -225,7 +225,7 @@ declare type ElasticSearchCustomIndexTemplateBody = {
 /**
  * @public
  */
-declare type ElasticSearchAliasAction = {
+type ElasticSearchAliasAction = {
     remove: {
         index: any;
         alias: any;
@@ -249,7 +249,7 @@ declare type ElasticSearchAliasAction = {
 /**
  * @public
  */
-declare type ElasticSearchIndexAction = {
+type ElasticSearchIndexAction = {
     index: {
         _index: string;
         [key: string]: any;
@@ -306,7 +306,7 @@ declare class ElasticSearchClientWrapper {
  * Options for instantiate ElasticSearchSearchEngineIndexer
  * @public
  */
-declare type ElasticSearchSearchEngineIndexerOptions = {
+type ElasticSearchSearchEngineIndexerOptions = {
     type: string;
     indexPrefix: string;
     indexSeparator: string;
@@ -352,7 +352,7 @@ declare class ElasticSearchSearchEngineIndexer extends BatchSearchEngineIndexer
  * Search query that the elasticsearch engine understands.
  * @public
  */
-declare type ElasticSearchConcreteQuery = {
+type ElasticSearchConcreteQuery = {
     documentTypes?: string[];
     elasticSearchQuery: Object;
     pageSize: number;
@@ -361,19 +361,19 @@ declare type ElasticSearchConcreteQuery = {
  * Options available for the Elasticsearch specific query translator.
  * @public
  */
-declare type ElasticSearchQueryTranslatorOptions = {
+type ElasticSearchQueryTranslatorOptions = {
     highlightOptions?: ElasticSearchHighlightConfig;
 };
 /**
  * Elasticsearch specific query translator.
  * @public
  */
-declare type ElasticSearchQueryTranslator = (query: SearchQuery, options?: ElasticSearchQueryTranslatorOptions) => ElasticSearchConcreteQuery;
+type ElasticSearchQueryTranslator = (query: SearchQuery, options?: ElasticSearchQueryTranslatorOptions) => ElasticSearchConcreteQuery;
 /**
  * Options for instantiate ElasticSearchSearchEngine
  * @public
  */
-declare type ElasticSearchOptions = {
+type ElasticSearchOptions = {
     logger: Logger;
     config: Config;
     aliasPostfix?: string;
@@ -382,7 +382,7 @@ declare type ElasticSearchOptions = {
 /**
  * @public
  */
-declare type ElasticSearchHighlightOptions = {
+type ElasticSearchHighlightOptions = {
     fragmentDelimiter?: string;
     fragmentSize?: number;
     numFragments?: number;
@@ -390,7 +390,7 @@ declare type ElasticSearchHighlightOptions = {
 /**
  * @public
  */
-declare type ElasticSearchHighlightConfig = {
+type ElasticSearchHighlightConfig = {
     fragmentDelimiter: string;
     fragmentSize: number;
     numFragments: number;

package/package.json

@@ -1,14 +1,25 @@
 {
   "name": "@backstage/plugin-search-backend-module-elasticsearch",
   "description": "A module for the search backend that implements search using ElasticSearch",
-  "version": "1.1.5-next.0",
-  "main": "dist/index.cjs.js",
-  "types": "dist/index.d.ts",
+  "version": "1.2.0-next.2",
+  "main": "./dist/index.cjs.js",
+  "types": "./dist/index.d.ts",
   "license": "Apache-2.0",
   "publishConfig": {
-    "access": "public",
-    "main": "dist/index.cjs.js",
-    "types": "dist/index.d.ts"
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs.js"
+    },
+    "./alpha": {
+      "require": "./dist/alpha.cjs.js",
+      "types": "./dist/alpha.d.ts",
+      "default": "./dist/alpha.cjs.js"
+    },
+    "./package.json": "./package.json"
   },
   "backstage": {
     "role": "backend-plugin-module"
@@ -23,9 +34,11 @@
     "clean": "backstage-cli package clean"
   },
   "dependencies": {
+    "@backstage/backend-common": "^0.18.4-next.2",
+    "@backstage/backend-plugin-api": "^0.5.1-next.2",
     "@backstage/config": "^1.0.7",
-    "@backstage/plugin-search-backend-node": "^1.1.5-next.0",
-    "@backstage/plugin-search-common": "^1.2.2",
+    "@backstage/plugin-search-backend-node": "^1.2.0-next.2",
+    "@backstage/plugin-search-common": "^1.2.3-next.0",
     "@elastic/elasticsearch": "^7.13.0",
     "@opensearch-project/opensearch": "^2.0.0",
     "aws-os-connection": "^0.2.0",
@@ -36,14 +49,15 @@
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/backend-common": "^0.18.4-next.0",
-    "@backstage/cli": "^0.22.6-next.0",
+    "@backstage/backend-common": "^0.18.4-next.2",
+    "@backstage/cli": "^0.22.6-next.2",
     "@elastic/elasticsearch-mock": "^1.0.0",
     "@short.io/opensearch-mock": "^0.3.1"
   },
   "files": [
     "dist",
-    "config.d.ts"
+    "config.d.ts",
+    "alpha"
   ],
   "configSchema": "config.d.ts"
 }