@meshtrade/api-node 1.30.2 → 1.32.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/dist/meshtrade/compliance/client/v1/client_pb.d.ts +17 -9
- package/dist/meshtrade/compliance/client/v1/client_pb.js +1 -1
- package/dist/meshtrade/compliance/client/v1/service_node_meshts.d.ts +46 -21
- package/dist/meshtrade/compliance/client/v1/service_node_meshts.js +98 -56
- package/dist/meshtrade/config/index.d.ts +160 -0
- package/dist/meshtrade/config/index.js +210 -0
- package/dist/meshtrade/iam/api_user/v1/api_user_pb.d.ts +12 -4
- package/dist/meshtrade/iam/api_user/v1/api_user_pb.js +1 -1
- package/dist/meshtrade/iam/api_user/v1/service_node_meshts.d.ts +46 -21
- package/dist/meshtrade/iam/api_user/v1/service_node_meshts.js +149 -65
- package/dist/meshtrade/iam/group/v1/group_pb.d.ts +8 -0
- package/dist/meshtrade/iam/group/v1/group_pb.js +1 -1
- package/dist/meshtrade/iam/group/v1/service_node_meshts.d.ts +46 -21
- package/dist/meshtrade/iam/group/v1/service_node_meshts.js +114 -58
- package/dist/meshtrade/iam/user/v1/service_node_meshts.d.ts +46 -21
- package/dist/meshtrade/iam/user/v1/service_node_meshts.js +141 -64
- package/dist/meshtrade/iam/user/v1/user_pb.d.ts +10 -2
- package/dist/meshtrade/iam/user/v1/user_pb.js +1 -1
- package/dist/meshtrade/{common/connectInterceptors.d.ts → interceptors/index.d.ts} +6 -64
- package/dist/meshtrade/{common/connectInterceptors.js → interceptors/index.js} +20 -90
- package/dist/meshtrade/ledger/transaction/v1/service_node_meshts.d.ts +46 -21
- package/dist/meshtrade/ledger/transaction/v1/service_node_meshts.js +90 -55
- package/dist/meshtrade/market_data/price/v1/service_node_meshts.d.ts +46 -21
- package/dist/meshtrade/market_data/price/v1/service_node_meshts.js +82 -54
- package/dist/meshtrade/reporting/account_report/v1/service_node_meshts.d.ts +46 -21
- package/dist/meshtrade/reporting/account_report/v1/service_node_meshts.js +90 -55
- package/dist/meshtrade/studio/instrument/v1/instrument_pb.d.ts +8 -0
- package/dist/meshtrade/studio/instrument/v1/instrument_pb.js +1 -1
- package/dist/meshtrade/trading/limit_order/v1/limit_order_pb.d.ts +16 -8
- package/dist/meshtrade/trading/limit_order/v1/limit_order_pb.js +1 -1
- package/dist/meshtrade/trading/limit_order/v1/service_node_meshts.d.ts +46 -21
- package/dist/meshtrade/trading/limit_order/v1/service_node_meshts.js +133 -63
- package/dist/meshtrade/trading/limit_order/v1/service_pb.js +1 -1
- package/dist/meshtrade/trading/market_order/v1/service_node_meshts.d.ts +46 -21
- package/dist/meshtrade/trading/market_order/v1/service_node_meshts.js +82 -54
- package/dist/meshtrade/wallet/account/v1/account_pb.d.ts +8 -0
- package/dist/meshtrade/wallet/account/v1/account_pb.js +1 -1
- package/dist/meshtrade/wallet/account/v1/service_node_meshts.d.ts +46 -21
- package/dist/meshtrade/wallet/account/v1/service_node_meshts.js +149 -65
- package/package.json +19 -2
- package/dist/meshtrade/common/config.d.ts +0 -50
- package/dist/meshtrade/common/config.js +0 -34
- package/dist/meshtrade/common/validation.d.ts +0 -62
- package/dist/meshtrade/common/validation.js +0 -77
|
@@ -7,62 +7,82 @@ exports.APIUserServiceNode = void 0;
|
|
|
7
7
|
const connect_1 = require("@connectrpc/connect");
|
|
8
8
|
const connect_node_1 = require("@connectrpc/connect-node");
|
|
9
9
|
const service_pb_1 = require("./service_pb");
|
|
10
|
-
const
|
|
11
|
-
const
|
|
12
|
-
const
|
|
10
|
+
const service_pb_2 = require("./service_pb");
|
|
11
|
+
const config_1 = require("../../../config");
|
|
12
|
+
const protovalidate_1 = require("@bufbuild/protovalidate");
|
|
13
|
+
const interceptors_1 = require("../../../interceptors");
|
|
13
14
|
/**
|
|
14
15
|
* Node.js client for interacting with the meshtrade.iam.api_user.v1 apiuser v1 API resource service.
|
|
15
16
|
* Uses Connect-ES with gRPC transport for Node.js gRPC communication.
|
|
16
17
|
*
|
|
17
|
-
* Supports
|
|
18
|
+
* Supports flexible authentication modes using functional options pattern:
|
|
18
19
|
*
|
|
19
20
|
* 1. **No Authentication** (public APIs):
|
|
20
21
|
* ```typescript
|
|
21
|
-
* const client = new APIUserServiceNode(
|
|
22
|
+
* const client = new APIUserServiceNode(
|
|
23
|
+
* WithServerUrl("http://localhost:10000")
|
|
24
|
+
* );
|
|
22
25
|
* ```
|
|
23
26
|
*
|
|
24
27
|
* 2. **API Key Authentication** (backend services):
|
|
25
28
|
* ```typescript
|
|
26
|
-
* const client = new APIUserServiceNode(
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
29
|
+
* const client = new APIUserServiceNode(
|
|
30
|
+
* WithAPIKey("your-api-key"),
|
|
31
|
+
* WithGroup("groups/01ARZ3NDEKTSV4YWVF8F5BH32"),
|
|
32
|
+
* WithServerUrl("https://api.example.com")
|
|
33
|
+
* );
|
|
31
34
|
* ```
|
|
32
35
|
*
|
|
33
36
|
* 3. **JWT Token Authentication** (Next.js backend with user session):
|
|
34
37
|
* ```typescript
|
|
35
|
-
* const client = new APIUserServiceNode(
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
38
|
+
* const client = new APIUserServiceNode(
|
|
39
|
+
* WithJWTAccessToken("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."),
|
|
40
|
+
* WithServerUrl("https://api.example.com")
|
|
41
|
+
* );
|
|
39
42
|
* ```
|
|
43
|
+
*
|
|
44
|
+
* 4. **JWT with Group Context** (user session with specific group):
|
|
45
|
+
* ```typescript
|
|
46
|
+
* const client = new APIUserServiceNode(
|
|
47
|
+
* WithJWTAccessToken("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."),
|
|
48
|
+
* WithGroup("groups/01ARZ3NDEKTSV4YWVF8F5BH32"),
|
|
49
|
+
* WithServerUrl("https://api.example.com")
|
|
50
|
+
* );
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
53
|
+
* Available options:
|
|
54
|
+
* - `WithAPIKey(key)` - API key authentication (mutually exclusive with JWT)
|
|
55
|
+
* - `WithJWTAccessToken(token)` - JWT authentication (mutually exclusive with API key)
|
|
56
|
+
* - `WithGroup(group)` - Group context (optional, works with both auth modes)
|
|
57
|
+
* - `WithServerUrl(url)` - Custom server URL (optional, defaults to production)
|
|
40
58
|
*/
|
|
41
59
|
class APIUserServiceNode {
|
|
42
60
|
/**
|
|
43
61
|
* Constructs an instance of APIUserServiceNode.
|
|
44
|
-
*
|
|
45
|
-
*
|
|
62
|
+
*
|
|
63
|
+
* Uses functional options pattern for flexible configuration:
|
|
64
|
+
* - `WithAPIKey(key)` - API key authentication
|
|
65
|
+
* - `WithJWTAccessToken(token)` - JWT authentication
|
|
66
|
+
* - `WithGroup(group)` - Group context (optional)
|
|
67
|
+
* - `WithServerUrl(url)` - Custom server URL (optional)
|
|
68
|
+
*
|
|
69
|
+
* @param {...ClientOption} opts - Variable number of configuration options
|
|
46
70
|
*/
|
|
47
|
-
constructor(
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
//
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
this._interceptors
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
// JWT authentication mode
|
|
63
|
-
this._interceptors.push((0, connectInterceptors_1.createJwtInterceptor)(this._config.jwtToken));
|
|
64
|
-
}
|
|
65
|
-
// If neither is configured, no authentication (public API mode)
|
|
71
|
+
constructor(...opts) {
|
|
72
|
+
// Build configuration from options
|
|
73
|
+
this._config = (0, config_1.buildConfigFromOptions)(...opts);
|
|
74
|
+
// Initialize validator for request validation
|
|
75
|
+
this._validator = (0, protovalidate_1.createValidator)();
|
|
76
|
+
this._interceptors = [];
|
|
77
|
+
this._interceptors.push((0, interceptors_1.createLoggingInterceptor)());
|
|
78
|
+
if (this._config.apiKey) {
|
|
79
|
+
this._interceptors.push((0, interceptors_1.createApiKeyInterceptor)(this._config.apiKey));
|
|
80
|
+
}
|
|
81
|
+
if (this._config.jwtToken) {
|
|
82
|
+
this._interceptors.push((0, interceptors_1.createJwtInterceptor)(this._config.jwtToken));
|
|
83
|
+
}
|
|
84
|
+
if (this._config.group) {
|
|
85
|
+
this._interceptors.push((0, interceptors_1.createGroupInterceptor)(this._config.group));
|
|
66
86
|
}
|
|
67
87
|
// Create the gRPC transport for Node.js with interceptors
|
|
68
88
|
// Note: gRPC transport uses HTTP/2 by default
|
|
@@ -77,35 +97,36 @@ class APIUserServiceNode {
|
|
|
77
97
|
* Returns a new client instance configured to send the specified group
|
|
78
98
|
* resource name in the request headers for subsequent API calls.
|
|
79
99
|
*
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
*
|
|
83
|
-
*
|
|
100
|
+
* This method creates a new client with the same authentication configuration
|
|
101
|
+
* but with the group context updated to the specified value.
|
|
102
|
+
*
|
|
103
|
+
* **Compatibility**: Works with all authentication modes:
|
|
104
|
+
* - **API key auth**: Creates new client with API key + new group
|
|
105
|
+
* - **JWT auth**: Creates new client with JWT + new group
|
|
106
|
+
* - **No auth**: Creates new client with standalone group interceptor
|
|
84
107
|
*
|
|
85
108
|
* @param {string} group - The operating group context to inject into the request
|
|
86
109
|
* in the format `groups/{ulid}` where {ulid} is a 26-character ULID.
|
|
87
110
|
* Example: 'groups/01ARZ3NDEKTSV4YWVF8F5BH32'
|
|
88
111
|
* @returns {APIUserServiceNode} A new, configured instance of the client.
|
|
89
|
-
* @throws {Error} If used with JWT authentication or no authentication
|
|
90
112
|
* @throws {Error} If the group format is invalid
|
|
91
113
|
*/
|
|
92
114
|
withGroup(group) {
|
|
93
|
-
//
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
if (
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
return new APIUserServiceNode(this._config, newInterceptors);
|
|
115
|
+
// Build new options array with existing auth and updated group
|
|
116
|
+
const newOpts = [];
|
|
117
|
+
// Add server URL
|
|
118
|
+
newOpts.push((0, config_1.WithServerUrl)(this._config.apiServerURL));
|
|
119
|
+
// Add authentication (preserve existing mode)
|
|
120
|
+
if (this._config.apiKey) {
|
|
121
|
+
newOpts.push((0, config_1.WithAPIKey)(this._config.apiKey));
|
|
122
|
+
}
|
|
123
|
+
else if (this._config.jwtToken) {
|
|
124
|
+
newOpts.push((0, config_1.WithJWTAccessToken)(this._config.jwtToken));
|
|
125
|
+
}
|
|
126
|
+
// Add the new group
|
|
127
|
+
newOpts.push((0, config_1.WithGroup)(group));
|
|
128
|
+
// Return a new client instance with updated configuration
|
|
129
|
+
return new APIUserServiceNode(...newOpts);
|
|
109
130
|
}
|
|
110
131
|
/**
|
|
111
132
|
* Retrieves an apiuser.
|
|
@@ -114,7 +135,14 @@ class APIUserServiceNode {
|
|
|
114
135
|
*/
|
|
115
136
|
getAPIUser(request) {
|
|
116
137
|
// Validate request
|
|
117
|
-
(
|
|
138
|
+
const result = this._validator.validate(service_pb_2.GetAPIUserRequestSchema, request);
|
|
139
|
+
if (result.kind === "invalid") {
|
|
140
|
+
const violations = result.violations.map(v => `${v.field.toString()}: ${v.message}`).join("; ");
|
|
141
|
+
throw new Error(`Validation failed: ${violations}`);
|
|
142
|
+
}
|
|
143
|
+
else if (result.kind === "error") {
|
|
144
|
+
throw result.error;
|
|
145
|
+
}
|
|
118
146
|
return this._client.getAPIUser(request);
|
|
119
147
|
}
|
|
120
148
|
/**
|
|
@@ -124,7 +152,14 @@ class APIUserServiceNode {
|
|
|
124
152
|
*/
|
|
125
153
|
createAPIUser(request) {
|
|
126
154
|
// Validate request
|
|
127
|
-
(
|
|
155
|
+
const result = this._validator.validate(service_pb_2.CreateAPIUserRequestSchema, request);
|
|
156
|
+
if (result.kind === "invalid") {
|
|
157
|
+
const violations = result.violations.map(v => `${v.field.toString()}: ${v.message}`).join("; ");
|
|
158
|
+
throw new Error(`Validation failed: ${violations}`);
|
|
159
|
+
}
|
|
160
|
+
else if (result.kind === "error") {
|
|
161
|
+
throw result.error;
|
|
162
|
+
}
|
|
128
163
|
return this._client.createAPIUser(request);
|
|
129
164
|
}
|
|
130
165
|
/**
|
|
@@ -134,7 +169,14 @@ class APIUserServiceNode {
|
|
|
134
169
|
*/
|
|
135
170
|
assignRolesToAPIUser(request) {
|
|
136
171
|
// Validate request
|
|
137
|
-
(
|
|
172
|
+
const result = this._validator.validate(service_pb_2.AssignRolesToAPIUserRequestSchema, request);
|
|
173
|
+
if (result.kind === "invalid") {
|
|
174
|
+
const violations = result.violations.map(v => `${v.field.toString()}: ${v.message}`).join("; ");
|
|
175
|
+
throw new Error(`Validation failed: ${violations}`);
|
|
176
|
+
}
|
|
177
|
+
else if (result.kind === "error") {
|
|
178
|
+
throw result.error;
|
|
179
|
+
}
|
|
138
180
|
return this._client.assignRolesToAPIUser(request);
|
|
139
181
|
}
|
|
140
182
|
/**
|
|
@@ -144,7 +186,14 @@ class APIUserServiceNode {
|
|
|
144
186
|
*/
|
|
145
187
|
revokeRolesFromAPIUser(request) {
|
|
146
188
|
// Validate request
|
|
147
|
-
(
|
|
189
|
+
const result = this._validator.validate(service_pb_2.RevokeRolesFromAPIUserRequestSchema, request);
|
|
190
|
+
if (result.kind === "invalid") {
|
|
191
|
+
const violations = result.violations.map(v => `${v.field.toString()}: ${v.message}`).join("; ");
|
|
192
|
+
throw new Error(`Validation failed: ${violations}`);
|
|
193
|
+
}
|
|
194
|
+
else if (result.kind === "error") {
|
|
195
|
+
throw result.error;
|
|
196
|
+
}
|
|
148
197
|
return this._client.revokeRolesFromAPIUser(request);
|
|
149
198
|
}
|
|
150
199
|
/**
|
|
@@ -154,7 +203,14 @@ class APIUserServiceNode {
|
|
|
154
203
|
*/
|
|
155
204
|
listAPIUsers(request) {
|
|
156
205
|
// Validate request
|
|
157
|
-
(
|
|
206
|
+
const result = this._validator.validate(service_pb_2.ListAPIUsersRequestSchema, request);
|
|
207
|
+
if (result.kind === "invalid") {
|
|
208
|
+
const violations = result.violations.map(v => `${v.field.toString()}: ${v.message}`).join("; ");
|
|
209
|
+
throw new Error(`Validation failed: ${violations}`);
|
|
210
|
+
}
|
|
211
|
+
else if (result.kind === "error") {
|
|
212
|
+
throw result.error;
|
|
213
|
+
}
|
|
158
214
|
return this._client.listAPIUsers(request);
|
|
159
215
|
}
|
|
160
216
|
/**
|
|
@@ -164,7 +220,14 @@ class APIUserServiceNode {
|
|
|
164
220
|
*/
|
|
165
221
|
searchAPIUsers(request) {
|
|
166
222
|
// Validate request
|
|
167
|
-
(
|
|
223
|
+
const result = this._validator.validate(service_pb_2.SearchAPIUsersRequestSchema, request);
|
|
224
|
+
if (result.kind === "invalid") {
|
|
225
|
+
const violations = result.violations.map(v => `${v.field.toString()}: ${v.message}`).join("; ");
|
|
226
|
+
throw new Error(`Validation failed: ${violations}`);
|
|
227
|
+
}
|
|
228
|
+
else if (result.kind === "error") {
|
|
229
|
+
throw result.error;
|
|
230
|
+
}
|
|
168
231
|
return this._client.searchAPIUsers(request);
|
|
169
232
|
}
|
|
170
233
|
/**
|
|
@@ -174,7 +237,14 @@ class APIUserServiceNode {
|
|
|
174
237
|
*/
|
|
175
238
|
activateAPIUser(request) {
|
|
176
239
|
// Validate request
|
|
177
|
-
(
|
|
240
|
+
const result = this._validator.validate(service_pb_2.ActivateAPIUserRequestSchema, request);
|
|
241
|
+
if (result.kind === "invalid") {
|
|
242
|
+
const violations = result.violations.map(v => `${v.field.toString()}: ${v.message}`).join("; ");
|
|
243
|
+
throw new Error(`Validation failed: ${violations}`);
|
|
244
|
+
}
|
|
245
|
+
else if (result.kind === "error") {
|
|
246
|
+
throw result.error;
|
|
247
|
+
}
|
|
178
248
|
return this._client.activateAPIUser(request);
|
|
179
249
|
}
|
|
180
250
|
/**
|
|
@@ -184,7 +254,14 @@ class APIUserServiceNode {
|
|
|
184
254
|
*/
|
|
185
255
|
deactivateAPIUser(request) {
|
|
186
256
|
// Validate request
|
|
187
|
-
(
|
|
257
|
+
const result = this._validator.validate(service_pb_2.DeactivateAPIUserRequestSchema, request);
|
|
258
|
+
if (result.kind === "invalid") {
|
|
259
|
+
const violations = result.violations.map(v => `${v.field.toString()}: ${v.message}`).join("; ");
|
|
260
|
+
throw new Error(`Validation failed: ${violations}`);
|
|
261
|
+
}
|
|
262
|
+
else if (result.kind === "error") {
|
|
263
|
+
throw result.error;
|
|
264
|
+
}
|
|
188
265
|
return this._client.deactivateAPIUser(request);
|
|
189
266
|
}
|
|
190
267
|
/**
|
|
@@ -194,7 +271,14 @@ class APIUserServiceNode {
|
|
|
194
271
|
*/
|
|
195
272
|
getAPIUserByKeyHash(request) {
|
|
196
273
|
// Validate request
|
|
197
|
-
(
|
|
274
|
+
const result = this._validator.validate(service_pb_2.GetAPIUserByKeyHashRequestSchema, request);
|
|
275
|
+
if (result.kind === "invalid") {
|
|
276
|
+
const violations = result.violations.map(v => `${v.field.toString()}: ${v.message}`).join("; ");
|
|
277
|
+
throw new Error(`Validation failed: ${violations}`);
|
|
278
|
+
}
|
|
279
|
+
else if (result.kind === "error") {
|
|
280
|
+
throw result.error;
|
|
281
|
+
}
|
|
198
282
|
return this._client.getAPIUserByKeyHash(request);
|
|
199
283
|
}
|
|
200
284
|
}
|
|
@@ -35,6 +35,14 @@ export type Group = Message<"meshtrade.iam.group.v1.Group"> & {
|
|
|
35
35
|
* @generated from field: string owner = 2;
|
|
36
36
|
*/
|
|
37
37
|
owner: string;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* Ownership hiearchy of groups that have access to this resource in the format groups/{group_id}.
|
|
41
|
+
* System set on creation.
|
|
42
|
+
*
|
|
43
|
+
* @generated from field: repeated string owners = 3;
|
|
44
|
+
*/
|
|
45
|
+
owners: string[];
|
|
38
46
|
/**
|
|
39
47
|
*
|
|
40
48
|
* Human-readable name for organizational identification and display.
|
|
@@ -9,7 +9,7 @@ const validate_pb_1 = require("../../../../buf/validate/validate_pb");
|
|
|
9
9
|
/**
|
|
10
10
|
* Describes the file meshtrade/iam/group/v1/group.proto.
|
|
11
11
|
*/
|
|
12
|
-
exports.file_meshtrade_iam_group_v1_group = (0, codegenv2_1.fileDesc)("
|
|
12
|
+
exports.file_meshtrade_iam_group_v1_group = (0, codegenv2_1.fileDesc)("CiJtZXNodHJhZGUvaWFtL2dyb3VwL3YxL2dyb3VwLnByb3RvEhZtZXNodHJhZGUuaWFtLmdyb3VwLnYxIqEDCgVHcm91cBK2AQoEbmFtZRgBIAEoCUKnAbpIowG6AZ8BChRuYW1lLmZvcm1hdC5vcHRpb25hbBIzbmFtZSBtdXN0IGJlIGVtcHR5IG9yIGluIHRoZSBmb3JtYXQgZ3JvdXBzL3tVTElEdjJ9GlJzaXplKHRoaXMpID09IDAgfHwgdGhpcy5tYXRjaGVzKCdeZ3JvdXBzL1swMTIzNDU2Nzg5QUJDREVGR0hKS01OUFFSU1RWV1hZWl17MjZ9JCcpEksKBW93bmVyGAIgASgJQjy6SDnIAQFyNDIvXmdyb3Vwcy9bMDEyMzQ1Njc4OUFCQ0RFRkdISktNTlBRUlNUVldYWVpdezI2fSSYASESTgoGb3duZXJzGAMgAygJQj66SDuSATgiNnI0Mi9eZ3JvdXBzL1swMTIzNDU2Nzg5QUJDREVGR0hKS01OUFFSU1RWV1hZWl17MjZ9JJgBIRIjCgxkaXNwbGF5X25hbWUYBCABKAlCDbpICsgBAXIFEAEY/wESHQoLZGVzY3JpcHRpb24YBSABKAlCCLpIBXIDGOgHQlIKHWNvLm1lc2h0cmFkZS5hcGkuaWFtLmdyb3VwLnYxWjFnaXRodWIuY29tL21lc2h0cmFkZS9hcGkvZ28vaWFtL2dyb3VwL3YxO2dyb3VwX3YxYgZwcm90bzM", [validate_pb_1.file_buf_validate_validate]);
|
|
13
13
|
/**
|
|
14
14
|
* Describes the message meshtrade.iam.group.v1.Group.
|
|
15
15
|
* Use `create(GroupSchema)` to create a new message.
|
|
@@ -1,59 +1,84 @@
|
|
|
1
|
-
import { Interceptor } from "@connectrpc/connect";
|
|
2
1
|
import { CreateGroupRequest, GetGroupRequest, ListGroupsRequest, ListGroupsResponse, SearchGroupsRequest, SearchGroupsResponse, UpdateGroupRequest } from "./service_pb";
|
|
3
2
|
import { Group } from "./group_pb";
|
|
4
|
-
import {
|
|
3
|
+
import { ClientOption } from "../../../config";
|
|
5
4
|
/**
|
|
6
5
|
* Node.js client for interacting with the meshtrade.iam.group.v1 group v1 API resource service.
|
|
7
6
|
* Uses Connect-ES with gRPC transport for Node.js gRPC communication.
|
|
8
7
|
*
|
|
9
|
-
* Supports
|
|
8
|
+
* Supports flexible authentication modes using functional options pattern:
|
|
10
9
|
*
|
|
11
10
|
* 1. **No Authentication** (public APIs):
|
|
12
11
|
* ```typescript
|
|
13
|
-
* const client = new GroupServiceNode(
|
|
12
|
+
* const client = new GroupServiceNode(
|
|
13
|
+
* WithServerUrl("http://localhost:10000")
|
|
14
|
+
* );
|
|
14
15
|
* ```
|
|
15
16
|
*
|
|
16
17
|
* 2. **API Key Authentication** (backend services):
|
|
17
18
|
* ```typescript
|
|
18
|
-
* const client = new GroupServiceNode(
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
19
|
+
* const client = new GroupServiceNode(
|
|
20
|
+
* WithAPIKey("your-api-key"),
|
|
21
|
+
* WithGroup("groups/01ARZ3NDEKTSV4YWVF8F5BH32"),
|
|
22
|
+
* WithServerUrl("https://api.example.com")
|
|
23
|
+
* );
|
|
23
24
|
* ```
|
|
24
25
|
*
|
|
25
26
|
* 3. **JWT Token Authentication** (Next.js backend with user session):
|
|
26
27
|
* ```typescript
|
|
27
|
-
* const client = new GroupServiceNode(
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
28
|
+
* const client = new GroupServiceNode(
|
|
29
|
+
* WithJWTAccessToken("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."),
|
|
30
|
+
* WithServerUrl("https://api.example.com")
|
|
31
|
+
* );
|
|
31
32
|
* ```
|
|
33
|
+
*
|
|
34
|
+
* 4. **JWT with Group Context** (user session with specific group):
|
|
35
|
+
* ```typescript
|
|
36
|
+
* const client = new GroupServiceNode(
|
|
37
|
+
* WithJWTAccessToken("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."),
|
|
38
|
+
* WithGroup("groups/01ARZ3NDEKTSV4YWVF8F5BH32"),
|
|
39
|
+
* WithServerUrl("https://api.example.com")
|
|
40
|
+
* );
|
|
41
|
+
* ```
|
|
42
|
+
*
|
|
43
|
+
* Available options:
|
|
44
|
+
* - `WithAPIKey(key)` - API key authentication (mutually exclusive with JWT)
|
|
45
|
+
* - `WithJWTAccessToken(token)` - JWT authentication (mutually exclusive with API key)
|
|
46
|
+
* - `WithGroup(group)` - Group context (optional, works with both auth modes)
|
|
47
|
+
* - `WithServerUrl(url)` - Custom server URL (optional, defaults to production)
|
|
32
48
|
*/
|
|
33
49
|
export declare class GroupServiceNode {
|
|
34
50
|
private _client;
|
|
35
51
|
private readonly _config;
|
|
36
52
|
private readonly _interceptors;
|
|
53
|
+
private readonly _validator;
|
|
37
54
|
/**
|
|
38
55
|
* Constructs an instance of GroupServiceNode.
|
|
39
|
-
*
|
|
40
|
-
*
|
|
56
|
+
*
|
|
57
|
+
* Uses functional options pattern for flexible configuration:
|
|
58
|
+
* - `WithAPIKey(key)` - API key authentication
|
|
59
|
+
* - `WithJWTAccessToken(token)` - JWT authentication
|
|
60
|
+
* - `WithGroup(group)` - Group context (optional)
|
|
61
|
+
* - `WithServerUrl(url)` - Custom server URL (optional)
|
|
62
|
+
*
|
|
63
|
+
* @param {...ClientOption} opts - Variable number of configuration options
|
|
41
64
|
*/
|
|
42
|
-
constructor(
|
|
65
|
+
constructor(...opts: ClientOption[]);
|
|
43
66
|
/**
|
|
44
67
|
* Returns a new client instance configured to send the specified group
|
|
45
68
|
* resource name in the request headers for subsequent API calls.
|
|
46
69
|
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
70
|
+
* This method creates a new client with the same authentication configuration
|
|
71
|
+
* but with the group context updated to the specified value.
|
|
72
|
+
*
|
|
73
|
+
* **Compatibility**: Works with all authentication modes:
|
|
74
|
+
* - **API key auth**: Creates new client with API key + new group
|
|
75
|
+
* - **JWT auth**: Creates new client with JWT + new group
|
|
76
|
+
* - **No auth**: Creates new client with standalone group interceptor
|
|
51
77
|
*
|
|
52
78
|
* @param {string} group - The operating group context to inject into the request
|
|
53
79
|
* in the format `groups/{ulid}` where {ulid} is a 26-character ULID.
|
|
54
80
|
* Example: 'groups/01ARZ3NDEKTSV4YWVF8F5BH32'
|
|
55
81
|
* @returns {GroupServiceNode} A new, configured instance of the client.
|
|
56
|
-
* @throws {Error} If used with JWT authentication or no authentication
|
|
57
82
|
* @throws {Error} If the group format is invalid
|
|
58
83
|
*/
|
|
59
84
|
withGroup(group: string): GroupServiceNode;
|