@backstage/plugin-search-common 0.3.4 → 0.3.5

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @backstage/plugin-search-common
 
+## 0.3.5
+
+### Patch Changes
+
+- 7d8acfc32e: `@beta` exports now replaced with `@public` exports
+- 484afdf1dc: Added an optional `rank` attribute to the `Result` type. This represents the result rank (starting at 1) for a given result in a result set for a given search.
+- Updated dependencies
+  - @backstage/plugin-permission-common@0.6.2
+
+## 0.3.5-next.1
+
+### Patch Changes
+
+- 7d8acfc32e: `@beta` exports now replaced with `@public` exports
+
+## 0.3.5-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-permission-common@0.6.2-next.0
+
 ## 0.3.4
 
 ### Patch Changes

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import { JsonObject } from '@backstage/types';
 import { Readable, Transform, Writable } from 'stream';
 
 /**
- * @beta
+ * @public
  */
 interface SearchQuery {
     term: string;
@@ -13,10 +13,10 @@ interface SearchQuery {
     pageCursor?: string;
 }
 /**
- * @beta
  * Metadata for result relevant document fields with matched terms highlighted
  * via wrapping in associated pre/post tags. The UI is expected to parse these
  * field excerpts by replacing wrapping tags with applicable UI elements for rendering.
+ * @public
  */
 interface ResultHighlight {
     /**
@@ -36,15 +36,30 @@ interface ResultHighlight {
     };
 }
 /**
- * @beta
+ * @public
  */
 interface Result<TDocument extends SearchDocument> {
+    /**
+     * The "type" of the given document. See: {@link DocumentCollatorFactory."type"}
+     */
     type: string;
+    /**
+     * The raw value of the document, as indexed.
+     */
     document: TDocument;
+    /**
+     * Optional result highlight. Useful for improving the search result
+     * display/experience.
+     */
     highlight?: ResultHighlight;
+    /**
+     * Optional result rank, where 1 is the first/top result returned. Useful for
+     * understanding search effectiveness in analytics.
+     */
+    rank?: number;
 }
 /**
- * @beta
+ * @public
  */
 interface ResultSet<TDocument extends SearchDocument> {
     results: Result<TDocument>[];
@@ -52,24 +67,24 @@ interface ResultSet<TDocument extends SearchDocument> {
     previousPageCursor?: string;
 }
 /**
- * @beta
+ * @public
  */
 declare type SearchResult = Result<SearchDocument>;
 /**
- * @beta
+ * @public
  */
 declare type SearchResultSet = ResultSet<SearchDocument>;
 /**
- * @beta
+ * @public
  */
 declare type IndexableResult = Result<IndexableDocument>;
 /**
- * @beta
+ * @public
  */
 declare type IndexableResultSet = ResultSet<IndexableDocument>;
 /**
  * Base properties that all search documents must include.
- * @beta
+ * @public
  */
 interface SearchDocument {
     /**
@@ -91,7 +106,7 @@ interface SearchDocument {
  * backends working directly with documents being inserted or retrieved from
  * search indexes. When dealing with documents in the frontend, use
  * {@link SearchDocument}.
- * @beta
+ * @public
  */
 declare type IndexableDocument = SearchDocument & {
     /**
@@ -107,9 +122,9 @@ declare type IndexableDocument = SearchDocument & {
 };
 /**
  * Information about a specific document type. Intended to be used in the
- * {@link @backstage/search-backend-node#IndexBuilder} to collect information
+ * {@link @backstage/plugin-search-backend-node#IndexBuilder} to collect information
  * about the types stored in the index.
- * @beta
+ * @public
  */
 declare type DocumentTypeInfo = {
     /**
@@ -120,7 +135,7 @@ declare type DocumentTypeInfo = {
 };
 /**
  * Factory class for instantiating collators.
- * @beta
+ * @public
  */
 interface DocumentCollatorFactory {
     /**
@@ -140,7 +155,7 @@ interface DocumentCollatorFactory {
 }
 /**
  * Factory class for instantiating decorators.
- * @beta
+ * @public
  */
 interface DocumentDecoratorFactory {
     /**
@@ -157,12 +172,12 @@ interface DocumentDecoratorFactory {
 /**
  * A type of function responsible for translating an abstract search query into
  * a concrete query relevant to a particular search engine.
- * @beta
+ * @public
  */
 declare type QueryTranslator = (query: SearchQuery) => unknown;
 /**
  * Options when querying a search engine.
- * @beta
+ * @public
  */
 declare type QueryRequestOptions = {
     token?: string;
@@ -171,7 +186,7 @@ declare type QueryRequestOptions = {
  * 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.
- * @beta
+ * @public
  */
 interface SearchEngine {
     /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-search-common",
   "description": "Common functionalities for Search, to be shared between various search-enabled plugins",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "private": false,
@@ -39,16 +39,16 @@
     "url": "https://github.com/backstage/backstage/issues"
   },
   "dependencies": {
-    "@backstage/plugin-permission-common": "^0.6.1",
+    "@backstage/plugin-permission-common": "^0.6.2",
     "@backstage/types": "^1.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.17.1"
+    "@backstage/cli": "^0.17.2"
   },
   "jest": {
     "roots": [
       ".."
     ]
   },
-  "gitHead": "96323f280ba32ee526c5b151cda42260aee927c9"
+  "gitHead": "e42cb3887e41f756c16380d757d93feda27f40ee"
 }