@backstage/search-common - npm Package Compare versions

Comparing version 0.0.0-nightly-20215923438 to 0.0.0-nightly-20217421937

CHANGELOG.md

 # @backstage/search-common
 
-## 0.0.0-nightly-20215923438
+## 0.0.0-nightly-20217421937
+
 ### Patch Changes
 
+- d9c13d535: Implements configuration and indexing functionality for ElasticSearch search engine. Adds indexing, searching and default translator for ElasticSearch and modifies default backend example-app to use ES if it is configured.
+
+  ## Example configurations:
+
+  ### AWS
+
+  Using AWS hosted ElasticSearch the only configuration options needed is the URL to the ElasticSearch service. The implementation assumes
+  that environment variables for AWS access key id and secret access key are defined in accordance to the [default AWS credential chain.](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-credentials-node.html).
+
+  ```yaml
+  search:
+    elasticsearch:
+      provider: aws
+      node: https://my-backstage-search-asdfqwerty.eu-west-1.es.amazonaws.com
+  ```
+
+  ### Elastic.co
+
+  Elastic Cloud hosted ElasticSearch uses a Cloud ID to determine the instance of hosted ElasticSearch to connect to. Additionally, username and password needs to be provided either directly or using environment variables like defined in [Backstage documentation.](https://backstage.io/docs/conf/writing#includes-and-dynamic-data)
+
+  ```yaml
+  search:
+    elasticsearch:
+      provider: elastic
+      cloudId: backstage-elastic:asdfqwertyasdfqwertyasdfqwertyasdfqwerty==
+      auth:
+        username: elastic
+        password: changeme
+  ```
+
+  ### Others
+
+  Other ElasticSearch instances can be connected to by using standard ElasticSearch authentication methods and exposed URL, provided that the cluster supports that. The configuration options needed are the URL to the node and authentication information. Authentication can be handled by either providing username/password or and API key or a bearer token. In case both username/password combination and one of the tokens are provided, token takes precedence. For more information how to create an API key, see [Elastic documentation on API keys](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html) and how to create a bearer token, see [Elastic documentation on tokens.](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html)
+
+  #### Configuration examples
+
+  ##### With username and password
+
+  ```yaml
+  search:
+    elasticsearch:
+      node: http://localhost:9200
+      auth:
+        username: elastic
+        password: changeme
+  ```
+
+  ##### With bearer token
+
+  ```yaml
+  search:
+    elasticsearch:
+      node: http://localhost:9200
+      auth:
+        bearer: token
+  ```
+
+  ##### With API key
+
+  ```yaml
+  search:
+    elasticsearch:
+      node: http://localhost:9200
+      auth:
+        apiKey: base64EncodedKey
+  ```
+
+- Updated dependencies
+  - @backstage/config@0.0.0-nightly-20217421937
+
+## 0.1.2
+
+### Patch Changes
+
 - db1c8f93b: The `<Search...Next /> set of components exported by the Search Plugin are now updated to use the Search Backend API. These will be made available as the default non-"next" versions in a follow-up release.
-  
+
   The interfaces for decorators and collators in the Search Backend have also seen minor, breaking revisions ahead of a general release. If you happen to be building on top of these interfaces, check and update your implementations accordingly. The APIs will be considered more stable in a follow-up release.

dist/index.d.ts

@@ -60,3 +60,27 @@ import { JsonObject } from '@backstage/config';
 }
+/**
+ * A type of function responsible for translating an abstract search query into
+ * a concrete query relevant to a particular search engine.
+ */
+declare type QueryTranslator = (query: SearchQuery) => unknown;
+/**
+ * Interface that must be implemented by specific search engines, responsible
+ * for performing indexing and querying and translating abstract queries into
+ * concrete, search engine-specific queries.
+ */
+interface SearchEngine {
+    /**
+     * Override the default translator provided by the SearchEngine.
+     */
+    setTranslator(translator: QueryTranslator): void;
+    /**
+     * Add the given documents to the SearchEngine index of the given type.
+     */
+    index(type: string, documents: IndexableDocument[]): Promise<void>;
+    /**
+     * Perform a search query against the SearchEngine.
+     */
+    query(query: SearchQuery): Promise<SearchResultSet>;
+}
 
-export { DocumentCollator, DocumentDecorator, IndexableDocument, SearchQuery, SearchResult, SearchResultSet };
+export { DocumentCollator, DocumentDecorator, IndexableDocument, QueryTranslator, SearchEngine, SearchQuery, SearchResult, SearchResultSet };

package.json

 {
   "name": "@backstage/search-common",
   "description": "Common functionalities for Search, to be shared between various search-enabled plugins",
-  "version": "0.0.0-nightly-20215923438",
+  "version": "0.0.0-nightly-20217421937",
   "main": "dist/index.cjs.js",
@@ -39,6 +39,6 @@ "types": "dist/index.d.ts",
   "dependencies": {
-    "@backstage/config": "^0.1.3"
+    "@backstage/config": "^0.0.0-nightly-20217421937"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.0.0-nightly-20215923438"
+    "@backstage/cli": "^0.0.0-nightly-20217421937"
   },
@@ -45,0 +45,0 @@ "jest": {

No alert changes

Improved metrics

Total package byte prevSize

7544

increased by97.59%

Lines of code

85

increased by39.34%

Dependency changes

• + Added@backstage/config@0.0.0-nightly-20250114022708(transitive)

• + Added@backstage/errors@0.0.0-nightly-20250114022708(transitive)

• + Added@backstage/types@0.0.0-nightly-20250114022708(transitive)

• + Addedms@2.1.3(transitive)

• + Addedserialize-error@8.1.0(transitive)

• + Addedtype-fest@0.20.2(transitive)

• - Removed@backstage/config@0.1.15(transitive)

• - Removed@backstage/types@0.1.3(transitive)

• - Removedlodash@4.17.21(transitive)

• Updated@backstage/config@^0.0.0-nightly-20217421937