@backstage/plugin-search-backend-node 1.2.0-next.1 → 1.2.0
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 +30 -0
- package/alpha/package.json +1 -1
- package/dist/alpha.d.ts +1 -1
- package/dist/index.d.ts +7 -7
- package/package.json +8 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,35 @@
|
|
|
1
1
|
# @backstage/plugin-search-backend-node
|
|
2
2
|
|
|
3
|
+
## 1.2.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 1469daa409e: Exports services and extension points that can be used with the new backend system. For documentation on how to migrate, check out the [how to migrate to the new backend system guide](https://backstage.io/docs/features/search/how-to-guides/#how-to-migrate-your-backend-installation-to-use-search-together-with-the-new-backend-system).
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- Updated dependencies
|
|
12
|
+
- @backstage/backend-common@0.18.4
|
|
13
|
+
- @backstage/plugin-permission-common@0.7.5
|
|
14
|
+
- @backstage/backend-tasks@0.5.1
|
|
15
|
+
- @backstage/backend-plugin-api@0.5.1
|
|
16
|
+
- @backstage/config@1.0.7
|
|
17
|
+
- @backstage/errors@1.1.5
|
|
18
|
+
- @backstage/plugin-search-common@1.2.3
|
|
19
|
+
|
|
20
|
+
## 1.2.0-next.2
|
|
21
|
+
|
|
22
|
+
### Patch Changes
|
|
23
|
+
|
|
24
|
+
- Updated dependencies
|
|
25
|
+
- @backstage/backend-common@0.18.4-next.2
|
|
26
|
+
- @backstage/backend-plugin-api@0.5.1-next.2
|
|
27
|
+
- @backstage/backend-tasks@0.5.1-next.2
|
|
28
|
+
- @backstage/config@1.0.7
|
|
29
|
+
- @backstage/errors@1.1.5
|
|
30
|
+
- @backstage/plugin-permission-common@0.7.5-next.0
|
|
31
|
+
- @backstage/plugin-search-common@1.2.3-next.0
|
|
32
|
+
|
|
3
33
|
## 1.2.0-next.1
|
|
4
34
|
|
|
5
35
|
### Minor Changes
|
package/alpha/package.json
CHANGED
package/dist/alpha.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ import { RegisterCollatorParameters, RegisterDecoratorParameters } from '@backst
|
|
|
6
6
|
* @alpha
|
|
7
7
|
* Options for build method on {@link SearchIndexService}.
|
|
8
8
|
*/
|
|
9
|
-
|
|
9
|
+
type SearchIndexServiceStartOptions = {
|
|
10
10
|
searchEngine: SearchEngine;
|
|
11
11
|
collators: RegisterCollatorParameters[];
|
|
12
12
|
decorators: RegisterDecoratorParameters[];
|
package/dist/index.d.ts
CHANGED
|
@@ -12,7 +12,7 @@ import lunr from 'lunr';
|
|
|
12
12
|
* ScheduleTaskParameters
|
|
13
13
|
* @public
|
|
14
14
|
*/
|
|
15
|
-
|
|
15
|
+
type ScheduleTaskParameters = {
|
|
16
16
|
id: string;
|
|
17
17
|
task: TaskFunction;
|
|
18
18
|
scheduledRunner: TaskRunner;
|
|
@@ -49,7 +49,7 @@ declare class Scheduler {
|
|
|
49
49
|
* Options required to instantiate the index builder.
|
|
50
50
|
* @public
|
|
51
51
|
*/
|
|
52
|
-
|
|
52
|
+
type IndexBuilderOptions = {
|
|
53
53
|
searchEngine: SearchEngine;
|
|
54
54
|
logger: Logger;
|
|
55
55
|
};
|
|
@@ -122,7 +122,7 @@ declare class IndexBuilder {
|
|
|
122
122
|
* Options for instantiate NewlineDelimitedJsonCollatorFactory
|
|
123
123
|
* @public
|
|
124
124
|
*/
|
|
125
|
-
|
|
125
|
+
type NewlineDelimitedJsonCollatorFactoryOptions = {
|
|
126
126
|
type: string;
|
|
127
127
|
searchPattern: string;
|
|
128
128
|
reader: UrlReader;
|
|
@@ -182,7 +182,7 @@ declare class NewlineDelimitedJsonCollatorFactory implements DocumentCollatorFac
|
|
|
182
182
|
* Options for {@link BatchSearchEngineIndexer}
|
|
183
183
|
* @public
|
|
184
184
|
*/
|
|
185
|
-
|
|
185
|
+
type BatchSearchEngineOptions = {
|
|
186
186
|
batchSize: number;
|
|
187
187
|
};
|
|
188
188
|
/**
|
|
@@ -257,7 +257,7 @@ declare class LunrSearchEngineIndexer extends BatchSearchEngineIndexer {
|
|
|
257
257
|
* Type of translated query for the Lunr Search Engine.
|
|
258
258
|
* @public
|
|
259
259
|
*/
|
|
260
|
-
|
|
260
|
+
type ConcreteLunrQuery = {
|
|
261
261
|
lunrQueryBuilder: lunr.Index.QueryBuilder;
|
|
262
262
|
documentTypes?: string[];
|
|
263
263
|
pageSize: number;
|
|
@@ -266,7 +266,7 @@ declare type ConcreteLunrQuery = {
|
|
|
266
266
|
* Translator responsible for translating search term and filters to a query that the Lunr Search Engine understands.
|
|
267
267
|
* @public
|
|
268
268
|
*/
|
|
269
|
-
|
|
269
|
+
type LunrQueryTranslator = (query: SearchQuery) => ConcreteLunrQuery;
|
|
270
270
|
/**
|
|
271
271
|
* Lunr specific search engine implementation.
|
|
272
272
|
* @public
|
|
@@ -302,7 +302,7 @@ declare class MissingIndexError extends Error {
|
|
|
302
302
|
* Object resolved after a test pipeline is executed.
|
|
303
303
|
* @public
|
|
304
304
|
*/
|
|
305
|
-
|
|
305
|
+
type TestPipelineResult = {
|
|
306
306
|
/**
|
|
307
307
|
* If an error was emitted by the pipeline, it will be set here.
|
|
308
308
|
*/
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-search-backend-node",
|
|
3
3
|
"description": "A library for Backstage backend plugins that want to interact with the search backend plugin",
|
|
4
|
-
"version": "1.2.0
|
|
4
|
+
"version": "1.2.0",
|
|
5
5
|
"main": "./dist/index.cjs.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -34,13 +34,13 @@
|
|
|
34
34
|
"clean": "backstage-cli package clean"
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
|
-
"@backstage/backend-common": "^0.18.4
|
|
38
|
-
"@backstage/backend-plugin-api": "^0.5.1
|
|
39
|
-
"@backstage/backend-tasks": "^0.5.1
|
|
37
|
+
"@backstage/backend-common": "^0.18.4",
|
|
38
|
+
"@backstage/backend-plugin-api": "^0.5.1",
|
|
39
|
+
"@backstage/backend-tasks": "^0.5.1",
|
|
40
40
|
"@backstage/config": "^1.0.7",
|
|
41
41
|
"@backstage/errors": "^1.1.5",
|
|
42
|
-
"@backstage/plugin-permission-common": "^0.7.5
|
|
43
|
-
"@backstage/plugin-search-common": "^1.2.3
|
|
42
|
+
"@backstage/plugin-permission-common": "^0.7.5",
|
|
43
|
+
"@backstage/plugin-search-common": "^1.2.3",
|
|
44
44
|
"@types/lunr": "^2.3.3",
|
|
45
45
|
"lodash": "^4.17.21",
|
|
46
46
|
"lunr": "^2.3.9",
|
|
@@ -49,8 +49,8 @@
|
|
|
49
49
|
"winston": "^3.2.1"
|
|
50
50
|
},
|
|
51
51
|
"devDependencies": {
|
|
52
|
-
"@backstage/backend-common": "^0.18.4
|
|
53
|
-
"@backstage/cli": "^0.22.6
|
|
52
|
+
"@backstage/backend-common": "^0.18.4",
|
|
53
|
+
"@backstage/cli": "^0.22.6",
|
|
54
54
|
"@types/ndjson": "^2.0.1"
|
|
55
55
|
},
|
|
56
56
|
"files": [
|