@backstage/plugin-search-common 0.3.3-next.1 → 0.3.4

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @backstage/plugin-search-common
 
+## 0.3.4
+
+### Patch Changes
+
+- 3a74e203a8: Support generating highlighted matched terms in search result data
+- Updated dependencies
+  - @backstage/plugin-permission-common@0.6.1
+
+## 0.3.4-next.0
+
+### Patch Changes
+
+- 3a74e203a8: Support generating highlighted matched terms in search result data
+- Updated dependencies
+  - @backstage/plugin-permission-common@0.6.1-next.0
+
+## 0.3.3
+
+### Patch Changes
+
+- c8b295f2fb: - Introduce `SearchDocument` type. This type contains the subset of `IndexableDocument` properties relevant to the frontend, and is intended to be used for documents returned to the frontend from the search API.
+  - `SearchResultSet` is now a wrapper for documents of type `SearchDocument`, and is intended to be used in the frontend. This isn't a breaking change, since `IndexableDocument`s are valid `SearchDocument`s, so the old and new types are compatible.
+  - Introduce `IndexableResultSet` type, which wraps `IndexableDocument` instances in the same way as `SearchResultSet`.
+- Updated dependencies
+  - @backstage/plugin-permission-common@0.6.0
+
 ## 0.3.3-next.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -12,12 +12,36 @@ interface SearchQuery {
     types?: string[];
     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.
+ */
+interface ResultHighlight {
+    /**
+     * Prefix tag for wrapping terms to be highlighted.
+     */
+    preTag: string;
+    /**
+     * Postfix tag for wrapping terms to be highlighted.
+     */
+    postTag: string;
+    fields: {
+        /**
+         * Matched document fields and associated excerpts containing highlighted
+         * terms wrapped in preTag and postTag to be parsed and rendered in the UI.
+         */
+        [field: string]: string;
+    };
+}
 /**
  * @beta
  */
 interface Result<TDocument extends SearchDocument> {
     type: string;
     document: TDocument;
+    highlight?: ResultHighlight;
 }
 /**
  * @beta
@@ -170,4 +194,4 @@ interface SearchEngine {
     query(query: SearchQuery, options?: QueryRequestOptions): Promise<IndexableResultSet>;
 }
 
-export { DocumentCollatorFactory, DocumentDecoratorFactory, DocumentTypeInfo, IndexableDocument, IndexableResult, IndexableResultSet, QueryRequestOptions, QueryTranslator, Result, ResultSet, SearchDocument, SearchEngine, SearchQuery, SearchResult, SearchResultSet };
+export { DocumentCollatorFactory, DocumentDecoratorFactory, DocumentTypeInfo, IndexableDocument, IndexableResult, IndexableResultSet, QueryRequestOptions, QueryTranslator, Result, ResultHighlight, ResultSet, SearchDocument, SearchEngine, SearchQuery, SearchResult, SearchResultSet };

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.3-next.1",
+  "version": "0.3.4",
   "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.0-next.0",
+    "@backstage/plugin-permission-common": "^0.6.1",
     "@backstage/types": "^1.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.17.0-next.1"
+    "@backstage/cli": "^0.17.1"
   },
   "jest": {
     "roots": [
       ".."
     ]
   },
-  "gitHead": "57d12dcc35aeb6c33b09e51d1efc3408c574f109"
+  "gitHead": "96323f280ba32ee526c5b151cda42260aee927c9"
 }