@backstage/plugin-search-backend-module-pg 0.5.56 → 0.5.57-next.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.
Files changed (4) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/config.schema.json +63 -0
  3. package/package.json +9 -9
  4. package/config.d.ts +0 -70
package/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # @backstage/plugin-search-backend-module-pg
2
2
 
3
+ ## 0.5.57-next.0
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+ - @backstage/plugin-search-backend-node@1.4.6-next.0
9
+ - @backstage/backend-plugin-api@1.9.3-next.0
10
+
3
11
  ## 0.5.56
4
12
 
5
13
  ### Patch Changes
package/config.schema.json ADDED
@@ -0,0 +1,63 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "search": {
6
+ "type": "object",
7
+ "properties": {
8
+ "pg": {
9
+ "type": "object",
10
+ "properties": {
11
+ "highlightOptions": {
12
+ "type": "object",
13
+ "properties": {
14
+ "useHighlight": {
15
+ "type": "boolean",
16
+ "description": "Used to enable to disable the highlight feature. The default value is true"
17
+ },
18
+ "maxWords": {
19
+ "type": "number",
20
+ "description": "Used to set the longest headlines to output. The default value is 35."
21
+ },
22
+ "minWords": {
23
+ "type": "number",
24
+ "description": "Used to set the shortest headlines to output. The default value is 15."
25
+ },
26
+ "shortWord": {
27
+ "type": "number",
28
+ "description": "Words of this length or less will be dropped at the start and end of a headline, unless they are query terms. The default value of three (3) eliminates common English articles."
29
+ },
30
+ "highlightAll": {
31
+ "type": "boolean",
32
+ "description": "If true the whole document will be used as the headline, ignoring the preceding three parameters. The default is false."
33
+ },
34
+ "maxFragments": {
35
+ "type": "number",
36
+ "description": "Maximum number of text fragments to display. The default value of zero selects a non-fragment-based headline generation method. A value greater than zero selects fragment-based headline generation (see the linked documentation above for more details)."
37
+ },
38
+ "fragmentDelimiter": {
39
+ "type": "string",
40
+ "description": "Delimiter string used to concatenate fragments. Defaults to \" ... \"."
41
+ }
42
+ },
43
+ "description": "Options for configuring highlight settings See https://www.postgresql.org/docs/current/textsearch-controls.html#TEXTSEARCH-HEADLINE"
44
+ },
45
+ "normalization": {
46
+ "type": [
47
+ "number",
48
+ "string"
49
+ ],
50
+ "description": "Ranking functions use an integer bit mask to control document length impact on rank. The default value is 0"
51
+ },
52
+ "indexerBatchSize": {
53
+ "type": "number",
54
+ "description": "Batch size to use when indexing"
55
+ }
56
+ },
57
+ "description": "Options for PG"
58
+ }
59
+ },
60
+ "description": "Configuration options for the search plugin"
61
+ }
62
+ }
63
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-search-backend-module-pg",
3
- "version": "0.5.56",
3
+ "version": "0.5.57-next.0",
4
4
  "description": "A module for the search backend that implements search using PostgreSQL",
5
5
  "backstage": {
6
6
  "role": "backend-plugin-module",
@@ -51,7 +51,7 @@
51
51
  "files": [
52
52
  "dist",
53
53
  "migrations",
54
- "config.d.ts"
54
+ "config.schema.json"
55
55
  ],
56
56
  "scripts": {
57
57
  "build": "backstage-cli package build",
@@ -63,16 +63,16 @@
63
63
  "test": "backstage-cli package test"
64
64
  },
65
65
  "dependencies": {
66
- "@backstage/backend-plugin-api": "^1.9.2",
67
- "@backstage/config": "^1.3.8",
68
- "@backstage/plugin-search-backend-node": "^1.4.5",
69
- "@backstage/plugin-search-common": "^1.2.24",
66
+ "@backstage/backend-plugin-api": "1.9.3-next.0",
67
+ "@backstage/config": "1.3.8",
68
+ "@backstage/plugin-search-backend-node": "1.4.6-next.0",
69
+ "@backstage/plugin-search-common": "1.2.24",
70
70
  "knex": "^3.0.0",
71
71
  "lodash": "^4.17.21"
72
72
  },
73
73
  "devDependencies": {
74
- "@backstage/backend-test-utils": "^1.11.4",
75
- "@backstage/cli": "^0.36.3"
74
+ "@backstage/backend-test-utils": "1.11.5-next.0",
75
+ "@backstage/cli": "0.36.4-next.0"
76
76
  },
77
- "configSchema": "config.d.ts"
77
+ "configSchema": "config.schema.json"
78
78
  }
package/config.d.ts DELETED
@@ -1,70 +0,0 @@
1
- /*
2
- * Copyright 2021 The Backstage Authors
3
- *
4
- * Licensed under the Apache License, Version 2.0 (the "License");
5
- * you may not use this file except in compliance with the License.
6
- * You may obtain a copy of the License at
7
- *
8
- * http://www.apache.org/licenses/LICENSE-2.0
9
- *
10
- * Unless required by applicable law or agreed to in writing, software
11
- * distributed under the License is distributed on an "AS IS" BASIS,
12
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
- * See the License for the specific language governing permissions and
14
- * limitations under the License.
15
- */
16
-
17
- export interface Config {
18
- /** Configuration options for the search plugin */
19
- search?: {
20
- /**
21
- * Options for PG
22
- */
23
- pg?: {
24
- /**
25
- * Options for configuring highlight settings
26
- * See https://www.postgresql.org/docs/current/textsearch-controls.html#TEXTSEARCH-HEADLINE
27
- */
28
- highlightOptions?: {
29
- /**
30
- * Used to enable to disable the highlight feature. The default value is true
31
- */
32
- useHighlight?: boolean;
33
- /**
34
- * Used to set the longest headlines to output. The default value is 35.
35
- */
36
- maxWords?: number;
37
- /**
38
- * Used to set the shortest headlines to output. The default value is 15.
39
- */
40
- minWords?: number;
41
- /**
42
- * Words of this length or less will be dropped at the start and end of a headline, unless they are query terms.
43
- * The default value of three (3) eliminates common English articles.
44
- */
45
- shortWord?: number;
46
- /**
47
- * If true the whole document will be used as the headline, ignoring the preceding three parameters. The default is false.
48
- */
49
- highlightAll?: boolean;
50
- /**
51
- * Maximum number of text fragments to display. The default value of zero selects a non-fragment-based headline generation method.
52
- * A value greater than zero selects fragment-based headline generation (see the linked documentation above for more details).
53
- */
54
- maxFragments?: number;
55
- /**
56
- * Delimiter string used to concatenate fragments. Defaults to " ... ".
57
- */
58
- fragmentDelimiter?: string;
59
- };
60
- /**
61
- * Ranking functions use an integer bit mask to control document length impact on rank. The default value is 0
62
- */
63
- normalization?: number | string;
64
- /**
65
- * Batch size to use when indexing
66
- */
67
- indexerBatchSize?: number;
68
- };
69
- };
70
- }