@backstage/plugin-search-common 0.3.5-next.1 → 0.3.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +9 -0
- package/dist/index.d.ts +15 -0
- package/package.json +4 -4
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# @backstage/plugin-search-common
|
|
2
2
|
|
|
3
|
+
## 0.3.5
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 7d8acfc32e: `@beta` exports now replaced with `@public` exports
|
|
8
|
+
- 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.
|
|
9
|
+
- Updated dependencies
|
|
10
|
+
- @backstage/plugin-permission-common@0.6.2
|
|
11
|
+
|
|
3
12
|
## 0.3.5-next.1
|
|
4
13
|
|
|
5
14
|
### Patch Changes
|
package/dist/index.d.ts
CHANGED
|
@@ -39,9 +39,24 @@ interface ResultHighlight {
|
|
|
39
39
|
* @public
|
|
40
40
|
*/
|
|
41
41
|
interface Result<TDocument extends SearchDocument> {
|
|
42
|
+
/**
|
|
43
|
+
* The "type" of the given document. See: {@link DocumentCollatorFactory."type"}
|
|
44
|
+
*/
|
|
42
45
|
type: string;
|
|
46
|
+
/**
|
|
47
|
+
* The raw value of the document, as indexed.
|
|
48
|
+
*/
|
|
43
49
|
document: TDocument;
|
|
50
|
+
/**
|
|
51
|
+
* Optional result highlight. Useful for improving the search result
|
|
52
|
+
* display/experience.
|
|
53
|
+
*/
|
|
44
54
|
highlight?: ResultHighlight;
|
|
55
|
+
/**
|
|
56
|
+
* Optional result rank, where 1 is the first/top result returned. Useful for
|
|
57
|
+
* understanding search effectiveness in analytics.
|
|
58
|
+
*/
|
|
59
|
+
rank?: number;
|
|
45
60
|
}
|
|
46
61
|
/**
|
|
47
62
|
* @public
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-search-common",
|
|
3
3
|
"description": "Common functionalities for Search, to be shared between various search-enabled plugins",
|
|
4
|
-
"version": "0.3.5
|
|
4
|
+
"version": "0.3.5",
|
|
5
5
|
"main": "dist/index.cjs.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"private": false,
|
|
@@ -39,16 +39,16 @@
|
|
|
39
39
|
"url": "https://github.com/backstage/backstage/issues"
|
|
40
40
|
},
|
|
41
41
|
"dependencies": {
|
|
42
|
-
"@backstage/plugin-permission-common": "^0.6.2
|
|
42
|
+
"@backstage/plugin-permission-common": "^0.6.2",
|
|
43
43
|
"@backstage/types": "^1.0.0"
|
|
44
44
|
},
|
|
45
45
|
"devDependencies": {
|
|
46
|
-
"@backstage/cli": "^0.17.2
|
|
46
|
+
"@backstage/cli": "^0.17.2"
|
|
47
47
|
},
|
|
48
48
|
"jest": {
|
|
49
49
|
"roots": [
|
|
50
50
|
".."
|
|
51
51
|
]
|
|
52
52
|
},
|
|
53
|
-
"gitHead": "
|
|
53
|
+
"gitHead": "e42cb3887e41f756c16380d757d93feda27f40ee"
|
|
54
54
|
}
|