@backstage/plugin-search-backend-module-elasticsearch 1.5.6-next.2 → 1.5.7-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 +27 -0
  2. package/alpha/package.json +1 -1
  3. package/config.d.ts +105 -143
  4. package/package.json +6 -7
package/CHANGELOG.md CHANGED
@@ -1,5 +1,32 @@
1
1
  # @backstage/plugin-search-backend-module-elasticsearch
2
2
 
3
+ ## 1.5.7-next.0
4
+
5
+ ### Patch Changes
6
+
7
+ - d78b07c: Align the configuration schema with the docs and actual behavior of the code
8
+ - 094eaa3: Remove references to in-repo backend-common
9
+ - Updated dependencies
10
+ - @backstage/plugin-search-backend-node@1.3.3-next.0
11
+ - @backstage/backend-plugin-api@1.0.1-next.0
12
+ - @backstage/config@1.2.0
13
+ - @backstage/integration-aws-node@0.1.12
14
+ - @backstage/plugin-search-common@1.2.14
15
+
16
+ ## 1.5.6
17
+
18
+ ### Patch Changes
19
+
20
+ - d425fc4: Modules, plugins, and services are now `BackendFeature`, not a function that returns a feature.
21
+ - 5726390: Internal refactor to use `LoggerService` and `DatabaseService` instead of the legacy `Logger` and `PluginDatabaseManager` types.
22
+ - Updated dependencies
23
+ - @backstage/backend-common@0.25.0
24
+ - @backstage/backend-plugin-api@1.0.0
25
+ - @backstage/config@1.2.0
26
+ - @backstage/integration-aws-node@0.1.12
27
+ - @backstage/plugin-search-backend-node@1.3.2
28
+ - @backstage/plugin-search-common@1.2.14
29
+
3
30
  ## 1.5.6-next.2
4
31
 
5
32
  ### Patch Changes
package/alpha/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-search-backend-module-elasticsearch__alpha",
3
- "version": "1.5.6-next.2",
3
+ "version": "1.5.7-next.0",
4
4
  "main": "../dist/alpha.cjs.js",
5
5
  "types": "../dist/alpha.d.ts"
6
6
  }
package/config.d.ts CHANGED
@@ -80,165 +80,127 @@ export interface Config {
80
80
  */
81
81
  rejectUnauthorized?: boolean;
82
82
  };
83
- } & (
84
- | {
85
- // elastic = Elastic.co ElasticSearch provider
86
- provider: 'elastic';
87
-
88
- /**
89
- * Elastic.co CloudID
90
- * See: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html#authentication
91
- */
92
- cloudId: string;
93
-
94
- auth: {
95
- username: string;
83
+ };
84
+ } & (
85
+ | {
86
+ // elastic = Elastic.co ElasticSearch provider
87
+ provider: 'elastic';
96
88
 
97
- /**
98
- * @visibility secret
99
- */
100
- password: string;
101
- };
102
- }
89
+ /**
90
+ * Elastic.co CloudID
91
+ * See: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html#authentication
92
+ */
93
+ cloudId: string;
103
94
 
104
- /**
105
- * AWS = Amazon Elasticsearch Service provider
106
- *
107
- * Authentication is handled using the default AWS credentials provider chain
108
- */
109
- | {
110
- provider: 'aws';
95
+ auth: {
96
+ username: string;
111
97
 
112
98
  /**
113
- * Node configuration.
114
- * URL AWS ES endpoint to connect to.
115
- * Eg. https://my-es-cluster.eu-west-1.es.amazonaws.com
99
+ * @visibility secret
116
100
  */
117
- node: string;
101
+ password: string;
102
+ };
103
+ }
118
104
 
119
- /**
120
- * The AWS region.
121
- * Only needed if using a custom DNS record.
122
- */
123
- region?: string;
105
+ /**
106
+ * AWS = Amazon Elasticsearch Service provider
107
+ *
108
+ * Authentication is handled using the default AWS credentials provider chain
109
+ */
110
+ | {
111
+ provider: 'aws';
124
112
 
125
- /**
126
- * The AWS service used for request signature.
127
- * Either 'es' for "Managed Clusters" or 'aoss' for "Serverless".
128
- * Only needed if using a custom DNS record.
129
- */
130
- service?: 'es' | 'aoss';
131
- }
113
+ /**
114
+ * Node configuration.
115
+ * URL AWS ES endpoint to connect to.
116
+ * Eg. https://my-es-cluster.eu-west-1.es.amazonaws.com
117
+ */
118
+ node: string;
132
119
 
133
- /**
134
- * Standard ElasticSearch
135
- *
136
- * Includes self-hosted clusters and others that provide direct connection via an endpoint
137
- * and authentication method (see possible authentication options below)
138
- */
139
- | {
140
- /**
141
- * Node configuration.
142
- * URL/URLS to ElasticSearch node to connect to.
143
- * Either direct URL like 'https://localhost:9200' or with credentials like 'https://username:password@localhost:9200'
144
- */
145
- node: string | string[];
120
+ /**
121
+ * The AWS region.
122
+ * Only needed if using a custom DNS record.
123
+ */
124
+ region?: string;
146
125
 
147
- /**
148
- * Authentication credentials for ElasticSearch
149
- * If both ApiKey/Bearer token and username+password is provided, tokens take precedence
150
- */
151
- auth?:
152
- | {
153
- username: string;
154
-
155
- /**
156
- * @visibility secret
157
- */
158
- password: string;
159
- }
160
- | {
161
- /**
162
- * Base64 Encoded API key to be used to connect to the cluster.
163
- * See: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html
164
- *
165
- * @visibility secret
166
- */
167
- apiKey: string;
168
- };
169
- /* TODO(kuangp): unsupported until @elastic/elasticsearch@7.14 is released
170
- | {
126
+ /**
127
+ * The AWS service used for request signature.
128
+ * Either 'es' for "Managed Clusters" or 'aoss' for "Serverless".
129
+ * Only needed if using a custom DNS record.
130
+ */
131
+ service?: 'es' | 'aoss';
132
+ }
171
133
 
172
134
  /**
173
- * Bearer authentication token to connect to the cluster.
174
- * See: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html
135
+ * Standard ElasticSearch
175
136
  *
176
- * @visibility secret
177
- *
178
- bearer: string;
179
- };*/
180
- }
181
-
182
- /**
183
- * AWS = In house hosting Open Search
184
- */
185
- | {
186
- provider: 'opensearch';
187
- /**
188
- * Node configuration.
189
- * URL/URLS to OpenSearch node to connect to.
190
- * Either direct URL like 'https://localhost:9200' or with credentials like 'https://username:password@localhost:9200'
191
- */
192
- node: string | string[];
137
+ * Includes self-hosted clusters and others that provide direct connection via an endpoint
138
+ * and authentication method (see possible authentication options below)
139
+ */
140
+ | {
141
+ /**
142
+ * Node configuration.
143
+ * URL/URLS to ElasticSearch node to connect to.
144
+ * Either direct URL like 'https://localhost:9200' or with credentials like 'https://username:password@localhost:9200'
145
+ */
146
+ node: string | string[];
193
147
 
194
- /**
195
- * Authentication credentials for OpenSearch
196
- * If both ApiKey/Bearer token and username+password is provided, tokens take precedence
197
- */
198
- auth?:
199
- | {
200
- username: string;
201
-
202
- /**
203
- * @visibility secret
204
- */
205
- password: string;
206
- }
207
- | {
208
- /**
209
- * @visibility secret
210
- */
211
- apiKey: string;
212
- };
213
- }
214
- );
148
+ /**
149
+ * Authentication credentials for ElasticSearch
150
+ * If both ApiKey/Bearer token and username+password is provided, tokens take precedence
151
+ */
152
+ auth?:
153
+ | {
154
+ username: string;
155
+
156
+ /**
157
+ * @visibility secret
158
+ */
159
+ password: string;
160
+ }
161
+ | {
162
+ /**
163
+ * Base64 Encoded API key to be used to connect to the cluster.
164
+ * See: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html
165
+ *
166
+ * @visibility secret
167
+ */
168
+ apiKey: string;
169
+ };
170
+ }
215
171
 
216
172
  /**
217
- * Authentication credentials for ElasticSearch. These are fallback
218
- * credentials - in most cases, for known specific ES implementations, the
219
- * respective auth block inside the clientOptions above will be used.
220
- *
221
- * If both ApiKey/Bearer token and username+password is provided, tokens
222
- * take precedence
173
+ * AWS = In house hosting Open Search
223
174
  */
224
- auth?:
225
- | {
226
- username: string;
175
+ | {
176
+ provider: 'opensearch';
177
+ /**
178
+ * Node configuration.
179
+ * URL/URLS to OpenSearch node to connect to.
180
+ * Either direct URL like 'https://localhost:9200' or with credentials like 'https://username:password@localhost:9200'
181
+ */
182
+ node: string | string[];
227
183
 
228
- /**
229
- * @visibility secret
230
- */
231
- password: string;
232
- }
233
- | {
234
- /**
235
- * Base64 Encoded API key to be used to connect to the cluster.
236
- * See: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html
237
- *
238
- * @visibility secret
239
- */
240
- apiKey: string;
241
- };
242
- };
184
+ /**
185
+ * Authentication credentials for OpenSearch
186
+ * If both ApiKey/Bearer token and username+password is provided, tokens take precedence
187
+ */
188
+ auth?:
189
+ | {
190
+ username: string;
191
+
192
+ /**
193
+ * @visibility secret
194
+ */
195
+ password: string;
196
+ }
197
+ | {
198
+ /**
199
+ * @visibility secret
200
+ */
201
+ apiKey: string;
202
+ };
203
+ }
204
+ );
243
205
  };
244
206
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-search-backend-module-elasticsearch",
3
- "version": "1.5.6-next.2",
3
+ "version": "1.5.7-next.0",
4
4
  "description": "A module for the search backend that implements search using ElasticSearch",
5
5
  "backstage": {
6
6
  "role": "backend-plugin-module",
@@ -24,6 +24,7 @@
24
24
  "default": "./dist/index.cjs.js"
25
25
  },
26
26
  "./alpha": {
27
+ "backstage": "@backstage/BackendFeature",
27
28
  "require": "./dist/alpha.cjs.js",
28
29
  "types": "./dist/alpha.d.ts",
29
30
  "default": "./dist/alpha.cjs.js"
@@ -47,11 +48,10 @@
47
48
  "test": "backstage-cli package test"
48
49
  },
49
50
  "dependencies": {
50
- "@backstage/backend-common": "^0.25.0-next.2",
51
- "@backstage/backend-plugin-api": "^1.0.0-next.2",
51
+ "@backstage/backend-plugin-api": "^1.0.1-next.0",
52
52
  "@backstage/config": "^1.2.0",
53
53
  "@backstage/integration-aws-node": "^0.1.12",
54
- "@backstage/plugin-search-backend-node": "^1.3.2-next.2",
54
+ "@backstage/plugin-search-backend-node": "^1.3.3-next.0",
55
55
  "@backstage/plugin-search-common": "^1.2.14",
56
56
  "@elastic/elasticsearch": "^7.13.0",
57
57
  "@opensearch-project/opensearch": "^2.2.1",
@@ -61,9 +61,8 @@
61
61
  "uuid": "^9.0.0"
62
62
  },
63
63
  "devDependencies": {
64
- "@backstage/backend-common": "^0.25.0-next.2",
65
- "@backstage/backend-test-utils": "^1.0.0-next.2",
66
- "@backstage/cli": "^0.27.1-next.2",
64
+ "@backstage/backend-test-utils": "^1.0.1-next.0",
65
+ "@backstage/cli": "^0.28.0-next.0",
67
66
  "@elastic/elasticsearch-mock": "^1.0.0",
68
67
  "@short.io/opensearch-mock": "^0.3.1"
69
68
  },