@backstage/plugin-search-common - npm Package Compare versions

Comparing version 0.0.0-nightly-20220610024824 to 0.0.0-nightly-20220611024121

CHANGELOG.md

 # @backstage/plugin-search-common
 
-## 0.0.0-nightly-20220610024824
+## 0.0.0-nightly-20220611024121
 
@@ -8,4 +8,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.0.0-nightly-20220610024824
+  - @backstage/plugin-permission-common@0.0.0-nightly-20220611024121
 
@@ -12,0 +13,0 @@ ## 0.3.5-next.1

dist/index.d.ts

@@ -42,5 +42,20 @@ /// <reference types="node" />
 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;
 }
@@ -47,0 +62,0 @@ /**

package.json

 {
   "name": "@backstage/plugin-search-common",
   "description": "Common functionalities for Search, to be shared between various search-enabled plugins",
-  "version": "0.0.0-nightly-20220610024824",
+  "version": "0.0.0-nightly-20220611024121",
   "main": "dist/index.cjs.js",
@@ -43,6 +43,6 @@ "types": "dist/index.d.ts",
     "@backstage/types": "^1.0.0",
-    "@backstage/plugin-permission-common": "^0.0.0-nightly-20220610024824"
+    "@backstage/plugin-permission-common": "^0.0.0-nightly-20220611024121"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.0.0-nightly-20220610024824"
+    "@backstage/cli": "^0.0.0-nightly-20220611024121"
   },
@@ -49,0 +49,0 @@ "jest": {

No alert changes

Improved metrics

Total package byte prevSize

16196

increased by4.05%

Lines of code

214

increased by7.54%

Dependency changes

• Updated@backstage/plugin-permission-common@^0.0.0-nightly-20220611024121