@restorecommerce/protos 6.4.1 → 6.7.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 +33 -0
- package/io/restorecommerce/credential.proto +2 -2
- package/io/restorecommerce/fulfillment_product.proto +2 -2
- package/io/restorecommerce/location.proto +1 -1
- package/io/restorecommerce/notification_req.proto +3 -3
- package/io/restorecommerce/organization.proto +2 -2
- package/io/restorecommerce/ostorage.proto +1 -1
- package/io/restorecommerce/resource_base.proto +5 -5
- package/io/restorecommerce/user.proto +52 -43
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,39 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [6.7.0](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@6.6.0...@restorecommerce/protos@6.7.0) (2024-01-24)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Features
|
|
10
|
+
|
|
11
|
+
* unauthenticated tokens ([fe89507](https://github.com/restorecommerce/libs/commit/fe895071c137bf15c68c03f1c5545612f2614bdc))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
# [6.6.0](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@6.4.1...@restorecommerce/protos@6.6.0) (2024-01-10)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Features
|
|
21
|
+
|
|
22
|
+
* **user.proto:** add properties to UserRole ([82b408c](https://github.com/restorecommerce/libs/commit/82b408ca4ba2c673d58b32a99e0705b3d0ad87c1))
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
# [6.5.0](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@6.4.1...@restorecommerce/protos@6.5.0) (2023-12-22)
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
### Features
|
|
32
|
+
|
|
33
|
+
* **user.proto:** add properties to UserRole ([82b408c](https://github.com/restorecommerce/libs/commit/82b408ca4ba2c673d58b32a99e0705b3d0ad87c1))
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
|
|
6
39
|
## [6.4.1](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@6.4.0...@restorecommerce/protos@6.4.1) (2023-11-25)
|
|
7
40
|
|
|
8
41
|
|
|
@@ -47,5 +47,5 @@ message Credential {
|
|
|
47
47
|
optional string description = 4;
|
|
48
48
|
optional string user = 5;
|
|
49
49
|
optional string pass = 6;
|
|
50
|
-
optional google.protobuf.Any credentials = 7;
|
|
51
|
-
}
|
|
50
|
+
optional google.protobuf.Any credentials = 7; // additional credentials as auth key or certificates etc
|
|
51
|
+
}
|
|
@@ -34,7 +34,7 @@ service FulfillmentProductService {
|
|
|
34
34
|
}
|
|
35
35
|
|
|
36
36
|
message Preferences {
|
|
37
|
-
repeated io.restorecommerce.attribute.Attribute couriers = 1; //ID, name or type
|
|
37
|
+
repeated io.restorecommerce.attribute.Attribute couriers = 1; // ID, name or type
|
|
38
38
|
repeated io.restorecommerce.attribute.Attribute options = 2;
|
|
39
39
|
}
|
|
40
40
|
|
|
@@ -148,4 +148,4 @@ message PackingSolutionListResponse {
|
|
|
148
148
|
|
|
149
149
|
message Deleted {
|
|
150
150
|
optional string id = 1;
|
|
151
|
-
}
|
|
151
|
+
}
|
|
@@ -7,7 +7,7 @@ import "io/restorecommerce/reference.proto";
|
|
|
7
7
|
|
|
8
8
|
service NotificationReqService {
|
|
9
9
|
// direct notifications
|
|
10
|
-
rpc Send (NotificationReq) returns (io.restorecommerce.status.OperationStatusObj);
|
|
10
|
+
rpc Send (NotificationReq) returns (io.restorecommerce.status.OperationStatusObj); // generic fallback
|
|
11
11
|
}
|
|
12
12
|
|
|
13
13
|
// mimics nodemailer properties for easy configuration
|
|
@@ -33,8 +33,8 @@ message NotificationReq {
|
|
|
33
33
|
}
|
|
34
34
|
optional string subject = 3;
|
|
35
35
|
optional string body = 4; // text/HTML content
|
|
36
|
-
optional string transport = 5;
|
|
37
|
-
optional string provider = 6;
|
|
36
|
+
optional string transport = 5; // 'email', 'log', ... default == 'log'
|
|
37
|
+
optional string provider = 6; // specific transport provider, eg: 'console' for transport == 'log'
|
|
38
38
|
repeated Attachment attachments = 7;
|
|
39
39
|
optional io.restorecommerce.reference.Reference reference = 8;
|
|
40
40
|
}
|
|
@@ -54,7 +54,7 @@ message OrganizationResponse {
|
|
|
54
54
|
}
|
|
55
55
|
|
|
56
56
|
message Organization {
|
|
57
|
-
optional string id = 1;
|
|
57
|
+
optional string id = 1; // Organization ID, unique, key
|
|
58
58
|
optional io.restorecommerce.meta.Meta meta = 2;
|
|
59
59
|
optional string parent_id = 3 [
|
|
60
60
|
(io.restorecommerce.options.resolver) = {
|
|
@@ -91,5 +91,5 @@ message Organization {
|
|
|
91
91
|
field_name: "paymentMethods",
|
|
92
92
|
}
|
|
93
93
|
];
|
|
94
|
-
optional google.protobuf.Any data = 14;
|
|
94
|
+
optional google.protobuf.Any data = 14; // additional data
|
|
95
95
|
}
|
|
@@ -146,7 +146,7 @@ message Response {
|
|
|
146
146
|
|
|
147
147
|
message ListRequest {
|
|
148
148
|
optional string bucket = 1;
|
|
149
|
-
optional io.restorecommerce.filter.FilterOp filters = 2;
|
|
149
|
+
optional io.restorecommerce.filter.FilterOp filters = 2; // Filter based on fieldName|operation, value|list
|
|
150
150
|
optional io.restorecommerce.auth.Subject subject = 3;
|
|
151
151
|
optional int32 max_keys = 4;
|
|
152
152
|
optional string prefix = 5;
|
|
@@ -77,10 +77,10 @@ message ReadRequest {
|
|
|
77
77
|
optional uint32 limit = 2;
|
|
78
78
|
repeated Sort sorts = 3;
|
|
79
79
|
|
|
80
|
-
|
|
80
|
+
// Filter based on fieldName|operation, value|list
|
|
81
81
|
repeated FilterOp filters = 4; // repeated filters
|
|
82
82
|
|
|
83
|
-
|
|
83
|
+
// Fields selector
|
|
84
84
|
repeated FieldFilter fields = 5;
|
|
85
85
|
|
|
86
86
|
/** Check the query parameters of HTTP request.
|
|
@@ -99,9 +99,9 @@ message ReadRequest {
|
|
|
99
99
|
}
|
|
100
100
|
|
|
101
101
|
message DeleteRequest {
|
|
102
|
-
|
|
102
|
+
// Request to purge the whole collection
|
|
103
103
|
optional bool collection = 1;
|
|
104
|
-
|
|
104
|
+
// Delete specified documents
|
|
105
105
|
repeated string ids = 2;
|
|
106
106
|
optional io.restorecommerce.auth.Subject subject = 3;
|
|
107
107
|
repeated string views = 4; // list of views to be dropped
|
|
@@ -137,4 +137,4 @@ message ResourceResponse {
|
|
|
137
137
|
message Resource {
|
|
138
138
|
optional string id = 1;
|
|
139
139
|
optional io.restorecommerce.meta.Meta meta = 2;
|
|
140
|
-
}
|
|
140
|
+
}
|
|
@@ -51,6 +51,7 @@ service UserService {
|
|
|
51
51
|
option (io.restorecommerce.options.is_query) = true;
|
|
52
52
|
};
|
|
53
53
|
rpc SendActivationEmail (SendActivationEmailRequest) returns (io.restorecommerce.status.OperationStatusObj);
|
|
54
|
+
rpc GetUnauthenticatedSubjectTokenForTenant(TenantRequest) returns (TenantResponse);
|
|
54
55
|
}
|
|
55
56
|
|
|
56
57
|
/**
|
|
@@ -63,6 +64,14 @@ message LoginRequest {
|
|
|
63
64
|
optional string token = 3;
|
|
64
65
|
}
|
|
65
66
|
|
|
67
|
+
message TenantRequest {
|
|
68
|
+
optional string domain = 1;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
message TenantResponse {
|
|
72
|
+
optional string token = 1;
|
|
73
|
+
}
|
|
74
|
+
|
|
66
75
|
message OrgIDRequest {
|
|
67
76
|
repeated string org_ids = 1;
|
|
68
77
|
optional io.restorecommerce.auth.Subject subject = 2;
|
|
@@ -74,7 +83,7 @@ message DeleteUsersByOrgResponse {
|
|
|
74
83
|
}
|
|
75
84
|
|
|
76
85
|
message FindRequest {
|
|
77
|
-
optional string id = 1;
|
|
86
|
+
optional string id = 1; // User ID
|
|
78
87
|
optional string name = 2;
|
|
79
88
|
optional string email = 3;
|
|
80
89
|
io.restorecommerce.auth.Subject subject = 4;
|
|
@@ -110,7 +119,7 @@ message RegisterRequest {
|
|
|
110
119
|
}
|
|
111
120
|
|
|
112
121
|
message ActivateRequest {
|
|
113
|
-
optional string identifier = 1;
|
|
122
|
+
optional string identifier = 1; // user name or email
|
|
114
123
|
optional string activation_code = 2;
|
|
115
124
|
optional io.restorecommerce.auth.Subject subject = 3;
|
|
116
125
|
}
|
|
@@ -159,12 +168,12 @@ message ConfirmEmailChangeRequest {
|
|
|
159
168
|
}
|
|
160
169
|
|
|
161
170
|
message UnregisterRequest {
|
|
162
|
-
optional string identifier = 1;
|
|
171
|
+
optional string identifier = 1; // User ID
|
|
163
172
|
optional io.restorecommerce.auth.Subject subject = 2;
|
|
164
173
|
}
|
|
165
174
|
|
|
166
175
|
message SendActivationEmailRequest {
|
|
167
|
-
optional string identifier = 1;
|
|
176
|
+
optional string identifier = 1; // User name or email
|
|
168
177
|
optional io.restorecommerce.auth.Subject subject = 2;
|
|
169
178
|
}
|
|
170
179
|
|
|
@@ -187,7 +196,7 @@ message Deleted {
|
|
|
187
196
|
* passwordChanged,
|
|
188
197
|
*/
|
|
189
198
|
message PasswordChanged {
|
|
190
|
-
optional string id = 1;
|
|
199
|
+
optional string id = 1; // User ID
|
|
191
200
|
optional string password_hash = 2;
|
|
192
201
|
}
|
|
193
202
|
|
|
@@ -205,7 +214,7 @@ message EmailChangeRequested {
|
|
|
205
214
|
}
|
|
206
215
|
|
|
207
216
|
message EmailChangeConfirmed {
|
|
208
|
-
optional string id = 1;
|
|
217
|
+
optional string id = 1; // User ID
|
|
209
218
|
optional string email = 2;
|
|
210
219
|
}
|
|
211
220
|
|
|
@@ -244,7 +253,7 @@ message UserResponse {
|
|
|
244
253
|
* User activation request.
|
|
245
254
|
*/
|
|
246
255
|
message Activate {
|
|
247
|
-
optional string id = 1;
|
|
256
|
+
optional string id = 1; // User ID
|
|
248
257
|
}
|
|
249
258
|
|
|
250
259
|
message FindByRoleRequest {
|
|
@@ -265,17 +274,17 @@ message User {
|
|
|
265
274
|
deleted: "userDeleted"
|
|
266
275
|
};
|
|
267
276
|
|
|
268
|
-
optional string id = 1;
|
|
277
|
+
optional string id = 1; // User ID, unique, key
|
|
269
278
|
optional io.restorecommerce.meta.Meta meta = 2;
|
|
270
279
|
optional string name = 3; // The name of the user, can be used for login
|
|
271
280
|
optional string first_name = 4;
|
|
272
281
|
optional string last_name = 5;
|
|
273
|
-
optional string email = 6;
|
|
274
|
-
optional string new_email = 7;
|
|
275
|
-
optional bool active = 8;
|
|
276
|
-
optional string activation_code = 9;
|
|
277
|
-
optional string password = 10;
|
|
278
|
-
optional string password_hash = 11;
|
|
282
|
+
optional string email = 6; // Email address, can be used for login
|
|
283
|
+
optional string new_email = 7; // New email address; set by `requestEmailChange` and overrides actual email upon `confirmEmailChange`
|
|
284
|
+
optional bool active = 8; // If the user was activated via the activation process
|
|
285
|
+
optional string activation_code = 9; // Activation code used in the activation process
|
|
286
|
+
optional string password = 10; // Raw password, not stored
|
|
287
|
+
optional string password_hash = 11; // Encrypted password, stored
|
|
279
288
|
repeated io.restorecommerce.auth.RoleAssociation role_associations = 12; // A user can have multiple roles and different attributes coupled with each role
|
|
280
289
|
optional string timezone_id = 13 [
|
|
281
290
|
(io.restorecommerce.options.resolver) = {
|
|
@@ -296,34 +305,34 @@ message User {
|
|
|
296
305
|
}
|
|
297
306
|
]; // locale specifications
|
|
298
307
|
optional string default_scope = 15; // default hierarchical scope
|
|
299
|
-
optional bool
|
|
300
|
-
optional
|
|
301
|
-
optional
|
|
302
|
-
optional
|
|
303
|
-
optional
|
|
304
|
-
optional string
|
|
305
|
-
optional string
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
optional google.protobuf.Any data = 26;
|
|
308
|
+
optional bool guest = 16; // Is the user a guest. A guest is a automatically generated user which can later be turned in a non-guest user.
|
|
309
|
+
optional io.restorecommerce.image.Image image = 17;
|
|
310
|
+
optional UserType user_type = 18;
|
|
311
|
+
optional bool invite = 19; // true if user has been invited by another user
|
|
312
|
+
optional string invited_by_user_name = 20; // User who is inviting
|
|
313
|
+
optional string invited_by_user_first_name = 21; // First name of user inviting
|
|
314
|
+
optional string invited_by_user_last_name = 22; // Last name of user inviting
|
|
315
|
+
repeated io.restorecommerce.auth.Tokens tokens = 23;
|
|
316
|
+
optional google.protobuf.Timestamp last_access = 24; // When the user has last been used
|
|
317
|
+
repeated io.restorecommerce.attribute.Attribute properties = 25; // additional properties
|
|
318
|
+
optional google.protobuf.Any data = 26; // additional data
|
|
310
319
|
}
|
|
311
320
|
|
|
312
321
|
/**
|
|
313
322
|
* A User resource with role
|
|
314
323
|
*/
|
|
315
324
|
message UserRole {
|
|
316
|
-
optional string id = 1;
|
|
325
|
+
optional string id = 1; // User ID, unique, key
|
|
317
326
|
optional io.restorecommerce.meta.Meta meta = 2;
|
|
318
327
|
optional string name = 3; // The name of the user, can be used for login
|
|
319
328
|
optional string first_name = 4;
|
|
320
329
|
optional string last_name = 5;
|
|
321
|
-
optional string email = 6;
|
|
322
|
-
optional string new_email = 7;
|
|
323
|
-
optional bool active = 8;
|
|
324
|
-
optional string activation_code = 9;
|
|
325
|
-
optional string password = 10;
|
|
326
|
-
optional string password_hash = 11;
|
|
330
|
+
optional string email = 6; // Email address, can be used for login
|
|
331
|
+
optional string new_email = 7; // New email address; set by `requestEmailChange` and overrides actual email upon `confirmEmailChange`
|
|
332
|
+
optional bool active = 8; // If the user was activated via the activation process
|
|
333
|
+
optional string activation_code = 9; // Activation code used in the activation process
|
|
334
|
+
optional string password = 10; // Raw password, not stored
|
|
335
|
+
optional string password_hash = 11; // Encrypted password, stored
|
|
327
336
|
repeated io.restorecommerce.auth.RoleAssociation role_associations = 12; // A user can have multiple roles and different attributes coupled with each role
|
|
328
337
|
optional string timezone_id = 13 [
|
|
329
338
|
(io.restorecommerce.options.resolver) = {
|
|
@@ -344,16 +353,16 @@ message UserRole {
|
|
|
344
353
|
}
|
|
345
354
|
]; // locale specifications
|
|
346
355
|
optional string default_scope = 15; // default hierarchical scope
|
|
347
|
-
optional bool
|
|
348
|
-
optional
|
|
349
|
-
optional
|
|
350
|
-
optional
|
|
351
|
-
optional
|
|
352
|
-
optional string
|
|
353
|
-
optional string
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
optional google.protobuf.Any data = 26;
|
|
356
|
+
optional bool guest = 16; // Is the user a guest. A guest is a automatically generated user which can later be turned in a non-guest user.
|
|
357
|
+
optional io.restorecommerce.image.Image image = 17;
|
|
358
|
+
optional UserType user_type = 18;
|
|
359
|
+
optional bool invite = 19; // true if user has been invited by another user
|
|
360
|
+
optional string invited_by_user_name = 20; // User who is inviting
|
|
361
|
+
optional string invited_by_user_first_name = 21; // First name of user inviting
|
|
362
|
+
optional string invited_by_user_last_name = 22; // Last name of user inviting
|
|
363
|
+
repeated io.restorecommerce.auth.Tokens tokens = 23;
|
|
364
|
+
optional google.protobuf.Timestamp last_access = 24; // When the user has last been used
|
|
365
|
+
repeated io.restorecommerce.attribute.Attribute properties = 25; // additional properties
|
|
366
|
+
optional google.protobuf.Any data = 26; // additional data
|
|
358
367
|
repeated io.restorecommerce.role.Role roles = 27;
|
|
359
368
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@restorecommerce/protos",
|
|
3
|
-
"version": "6.
|
|
3
|
+
"version": "6.7.0",
|
|
4
4
|
"description": "Protobuf descriptors for Restorecommerce services",
|
|
5
5
|
"author": "n-fuse GmbH",
|
|
6
6
|
"repository": {
|
|
@@ -15,5 +15,5 @@
|
|
|
15
15
|
"protobufs"
|
|
16
16
|
],
|
|
17
17
|
"scripts": {},
|
|
18
|
-
"gitHead": "
|
|
18
|
+
"gitHead": "0f4eb157696b9edf666420f6b64e904a17338421"
|
|
19
19
|
}
|