@backstage/plugin-search-common 1.2.3-next.0 → 1.2.3
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 +8 -0
- package/dist/index.d.ts +8 -8
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
package/dist/index.d.ts
CHANGED
|
@@ -71,19 +71,19 @@ interface ResultSet<TDocument extends SearchDocument> {
|
|
|
71
71
|
/**
|
|
72
72
|
* @public
|
|
73
73
|
*/
|
|
74
|
-
|
|
74
|
+
type SearchResult = Result<SearchDocument>;
|
|
75
75
|
/**
|
|
76
76
|
* @public
|
|
77
77
|
*/
|
|
78
|
-
|
|
78
|
+
type SearchResultSet = ResultSet<SearchDocument>;
|
|
79
79
|
/**
|
|
80
80
|
* @public
|
|
81
81
|
*/
|
|
82
|
-
|
|
82
|
+
type IndexableResult = Result<IndexableDocument>;
|
|
83
83
|
/**
|
|
84
84
|
* @public
|
|
85
85
|
*/
|
|
86
|
-
|
|
86
|
+
type IndexableResultSet = ResultSet<IndexableDocument>;
|
|
87
87
|
/**
|
|
88
88
|
* Base properties that all search documents must include.
|
|
89
89
|
* @public
|
|
@@ -110,7 +110,7 @@ interface SearchDocument {
|
|
|
110
110
|
* {@link SearchDocument}.
|
|
111
111
|
* @public
|
|
112
112
|
*/
|
|
113
|
-
|
|
113
|
+
type IndexableDocument = SearchDocument & {
|
|
114
114
|
/**
|
|
115
115
|
* Optional authorization information to be used when determining whether this
|
|
116
116
|
* search result should be visible to a given user.
|
|
@@ -128,7 +128,7 @@ declare type IndexableDocument = SearchDocument & {
|
|
|
128
128
|
* about the types stored in the index.
|
|
129
129
|
* @public
|
|
130
130
|
*/
|
|
131
|
-
|
|
131
|
+
type DocumentTypeInfo = {
|
|
132
132
|
/**
|
|
133
133
|
* The {@link @backstage/plugin-permission-common#Permission} that controls
|
|
134
134
|
* visibility of resources associated with this collator's documents.
|
|
@@ -176,12 +176,12 @@ interface DocumentDecoratorFactory {
|
|
|
176
176
|
* a concrete query relevant to a particular search engine.
|
|
177
177
|
* @public
|
|
178
178
|
*/
|
|
179
|
-
|
|
179
|
+
type QueryTranslator = (query: SearchQuery) => unknown;
|
|
180
180
|
/**
|
|
181
181
|
* Options when querying a search engine.
|
|
182
182
|
* @public
|
|
183
183
|
*/
|
|
184
|
-
|
|
184
|
+
type QueryRequestOptions = {
|
|
185
185
|
token?: string;
|
|
186
186
|
};
|
|
187
187
|
/**
|
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": "1.2.3
|
|
4
|
+
"version": "1.2.3",
|
|
5
5
|
"main": "dist/index.cjs.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"publishConfig": {
|
|
@@ -38,11 +38,11 @@
|
|
|
38
38
|
"url": "https://github.com/backstage/backstage/issues"
|
|
39
39
|
},
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@backstage/plugin-permission-common": "^0.7.5
|
|
41
|
+
"@backstage/plugin-permission-common": "^0.7.5",
|
|
42
42
|
"@backstage/types": "^1.0.2"
|
|
43
43
|
},
|
|
44
44
|
"devDependencies": {
|
|
45
|
-
"@backstage/cli": "^0.22.6
|
|
45
|
+
"@backstage/cli": "^0.22.6"
|
|
46
46
|
},
|
|
47
47
|
"jest": {
|
|
48
48
|
"roots": [
|