@restorecommerce/protos 5.0.1 → 6.0.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 (9) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/io/restorecommerce/fulfillment.proto +46 -14
  3. package/io/restorecommerce/fulfillment_courier.proto +14 -2
  4. package/io/restorecommerce/fulfillment_product.proto +23 -6
  5. package/io/restorecommerce/order.proto +6 -4
  6. package/io/restorecommerce/price.proto +0 -10
  7. package/io/restorecommerce/product.proto +18 -8
  8. package/io/restorecommerce/shop.proto +0 -1
  9. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -3,6 +3,22 @@
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.0.0](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@5.0.1...@restorecommerce/protos@6.0.0) (2023-08-01)
7
+
8
+
9
+ ### Bug Fixes
10
+
11
+ * **fulfillment, order, price, product, shop:** fix missing resolvers, enum style guide, naming ([103172c](https://github.com/restorecommerce/libs/commit/103172c9b2e1544a88257cededc1b39a2731fd8c))
12
+
13
+
14
+ ### BREAKING CHANGES
15
+
16
+ * **fulfillment, order, price, product, shop:** changes in product require adjustments in example data
17
+
18
+
19
+
20
+
21
+
6
22
  ## [5.0.1](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@5.0.0...@restorecommerce/protos@5.0.1) (2023-07-25)
7
23
 
8
24
 
package/io/restorecommerce/fulfillment.proto CHANGED
@@ -17,6 +17,11 @@ import "io/restorecommerce/amount.proto";
17
17
  import "io/restorecommerce/invoice.proto";
18
18
  import "google/protobuf/timestamp.proto";
19
19
 
20
+ // Used by resolvers
21
+ import "io/restorecommerce/user.proto";
22
+ import "io/restorecommerce/customer.proto";
23
+ import "io/restorecommerce/shop.proto";
24
+
20
25
  /**
21
26
  Microservice definition.
22
27
  */
@@ -133,14 +138,13 @@ message Label {
133
138
  }
134
139
 
135
140
  message Packaging {
136
- optional io.restorecommerce.reference.Reference reference = 1;
137
- repeated Parcel parcels = 2;
138
- optional io.restorecommerce.address.ShippingAddress sender = 3;
139
- optional io.restorecommerce.address.ShippingAddress recipient = 4;
140
- optional string notify = 5;
141
- optional string export_type = 6;
142
- optional string export_description = 7;
143
- optional string invoice_number = 8;
141
+ repeated Parcel parcels = 1;
142
+ optional io.restorecommerce.address.ShippingAddress sender = 2;
143
+ optional io.restorecommerce.address.ShippingAddress recipient = 3;
144
+ optional string notify = 4;
145
+ optional string export_type = 5;
146
+ optional string export_description = 6;
147
+ optional string invoice_number = 7;
144
148
  }
145
149
 
146
150
  message Event {
@@ -170,12 +174,40 @@ message Fulfillment {
170
174
  };
171
175
 
172
176
  optional string id = 1;
173
- optional Packaging packaging = 2; //set by user
174
- optional io.restorecommerce.meta.Meta meta = 3;
175
- repeated Label labels = 4; //set by service
176
- repeated Tracking trackings = 5; //set by service
177
- repeated io.restorecommerce.amount.Amount total_amounts = 6; //set by service
178
- optional State state = 8; //set by service
177
+ optional io.restorecommerce.meta.Meta meta = 2;
178
+ optional string user_id = 3 [
179
+ (io.restorecommerce.options.resolver) = {
180
+ target_type: ".io.restorecommerce.user.User",
181
+ target_service: "identity",
182
+ target_sub_service: "user",
183
+ target_method: "Read",
184
+ field_name: "user",
185
+ }
186
+ ];
187
+ optional string customer_id = 4 [
188
+ (io.restorecommerce.options.resolver) = {
189
+ target_type: ".io.restorecommerce.customer.Customer",
190
+ target_service: "master_data",
191
+ target_sub_service: "customer",
192
+ target_method: "Read",
193
+ field_name: "customer",
194
+ }
195
+ ];
196
+ optional string shop_id = 5 [
197
+ (io.restorecommerce.options.resolver) = {
198
+ target_type: ".io.restorecommerce.shop.Shop",
199
+ target_service: "master_data",
200
+ target_sub_service: "shop",
201
+ target_method: "Read",
202
+ field_name: "shop",
203
+ }
204
+ ];
205
+ optional io.restorecommerce.reference.Reference reference = 6;
206
+ optional Packaging packaging = 7;
207
+ repeated Label labels = 8; //set by service
208
+ repeated Tracking trackings = 9; //set by service
209
+ repeated io.restorecommerce.amount.Amount total_amounts = 10; //set by service
210
+ optional State state = 11; //set by service
179
211
  }
180
212
 
181
213
  message FulfillmentList {
package/io/restorecommerce/fulfillment_courier.proto CHANGED
@@ -9,6 +9,9 @@ import "io/restorecommerce/auth.proto";
9
9
  import "io/restorecommerce/status.proto";
10
10
  import "io/restorecommerce/options.proto";
11
11
 
12
+ // Used by resolvers
13
+ import "io/restorecommerce/shop.proto";
14
+
12
15
  /**
13
16
  Microservice defination
14
17
  */
@@ -33,13 +36,22 @@ message FulfillmentCourier {
33
36
  };
34
37
 
35
38
  optional string id = 1;
39
+ optional io.restorecommerce.meta.Meta meta = 2;
40
+ optional string shop_ids = 3 [
41
+ (io.restorecommerce.options.resolver) = {
42
+ target_type: ".io.restorecommerce.shop.Shop",
43
+ target_service: "master_data",
44
+ target_sub_service: "shop",
45
+ target_method: "Read",
46
+ field_name: "shops",
47
+ }
48
+ ];
36
49
  optional string name = 4;
37
50
  optional string description = 5;
38
51
  optional string logo = 6;
39
52
  optional string website = 7;
40
53
  optional string stub_type = 8;
41
- optional google.protobuf.Any configuration = 10;
42
- optional io.restorecommerce.meta.Meta meta = 11;
54
+ optional google.protobuf.Any configuration = 9;
43
55
  }
44
56
 
45
57
  message FulfillmentCourierList {
package/io/restorecommerce/fulfillment_product.proto CHANGED
@@ -39,18 +39,35 @@ message Preferences {
39
39
  }
40
40
 
41
41
  message ProductQuery {
42
- optional io.restorecommerce.address.ShippingAddress sender = 1;
43
- optional io.restorecommerce.address.ShippingAddress receiver = 2;
44
- repeated io.restorecommerce.fulfillment.Item items = 3;
45
- optional Preferences preferences = 4;
46
- optional string reference = 5;
42
+ optional string customer_id = 1 [
43
+ (io.restorecommerce.options.resolver) = {
44
+ target_type: ".io.restorecommerce.customer.Customer",
45
+ target_service: "master_data",
46
+ target_sub_service: "customer",
47
+ target_method: "Read",
48
+ field_name: "customer",
49
+ }
50
+ ];
51
+ optional string shop_id = 2 [
52
+ (io.restorecommerce.options.resolver) = {
53
+ target_type: ".io.restorecommerce.shop.Shop",
54
+ target_service: "master_data",
55
+ target_sub_service: "shop",
56
+ target_method: "Read",
57
+ field_name: "shop",
58
+ }
59
+ ];
60
+ optional io.restorecommerce.address.ShippingAddress sender = 3;
61
+ optional io.restorecommerce.address.ShippingAddress recipient = 4;
62
+ repeated io.restorecommerce.fulfillment.Item items = 5;
63
+ optional Preferences preferences = 6;
64
+ optional io.restorecommerce.reference.Reference reference = 7;
47
65
  }
48
66
 
49
67
  message ProductQueryList {
50
68
  repeated ProductQuery items = 1;
51
69
  optional uint32 total_count = 2;
52
70
  io.restorecommerce.auth.Subject subject = 3;
53
- optional io.restorecommerce.reference.Reference reference = 4;
54
71
  }
55
72
 
56
73
  message FulfillmentProduct {
package/io/restorecommerce/order.proto CHANGED
@@ -18,6 +18,8 @@ import "io/restorecommerce/fulfillment_product.proto";
18
18
  import "io/restorecommerce/invoice.proto";
19
19
 
20
20
  // Used by resolvers
21
+ import "io/restorecommerce/user.proto";
22
+ import "io/restorecommerce/customer.proto";
21
23
  import "io/restorecommerce/shop.proto";
22
24
 
23
25
 
@@ -96,11 +98,11 @@ message Order {
96
98
  optional io.restorecommerce.meta.Meta meta = 2;
97
99
  optional string user_id = 3 [
98
100
  (io.restorecommerce.options.resolver) = {
99
- target_type: ".io.restorecommerce.customer.Customer",
100
- target_service: "master_data",
101
- target_sub_service: "customer",
101
+ target_type: ".io.restorecommerce.user.User",
102
+ target_service: "identity",
103
+ target_sub_service: "user",
102
104
  target_method: "Read",
103
- field_name: "customer",
105
+ field_name: "user",
104
106
  }
105
107
  ];
106
108
  optional string customer_id = 4 [
package/io/restorecommerce/price.proto CHANGED
@@ -4,7 +4,6 @@ package io.restorecommerce.price;
4
4
 
5
5
  // Used by resolvers
6
6
  import "io/restorecommerce/options.proto";
7
- import "io/restorecommerce/tax.proto";
8
7
  import "io/restorecommerce/currency.proto";
9
8
 
10
9
  message Price {
@@ -20,13 +19,4 @@ message Price {
20
19
  field_name: "currency",
21
20
  }
22
21
  ];
23
- repeated string tax_ids = 5 [
24
- (io.restorecommerce.options.resolver) = {
25
- target_type: ".io.restorecommerce.tax.Tax",
26
- target_service: "master_data",
27
- target_sub_service: "tax",
28
- target_method: "Read",
29
- field_name: "taxes",
30
- }
31
- ];
32
22
  }
package/io/restorecommerce/product.proto CHANGED
@@ -12,11 +12,13 @@ import "io/restorecommerce/status.proto";
12
12
  import "io/restorecommerce/attribute.proto";
13
13
  import "io/restorecommerce/geometry.proto";
14
14
  import "io/restorecommerce/price.proto";
15
- import "io/restorecommerce/property.proto";
16
15
  import "io/restorecommerce/options.proto";
17
16
 
18
17
  // Used by resolvers
19
18
  import "io/restorecommerce/manufacturer.proto";
19
+ import "io/restorecommerce/property.proto";
20
+ import "io/restorecommerce/shop.proto";
21
+ import "io/restorecommerce/tax.proto";
20
22
 
21
23
  service ProductService {
22
24
  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductListResponse) {
@@ -29,9 +31,9 @@ service ProductService {
29
31
  }
30
32
 
31
33
  enum AssociationType {
32
- Miscellaneous = 0;
33
- Accessory = 1;
34
- Recommendation = 2;
34
+ MISCELLANEOUS = 0;
35
+ ACCESSORY = 1;
36
+ RECOMMENDATION = 2;
35
37
  }
36
38
 
37
39
  message Association {
@@ -122,7 +124,15 @@ message IndividualProduct {
122
124
  }
123
125
  ];
124
126
  }
125
- repeated string tax_ids = 8;
127
+ repeated string tax_ids = 8 [
128
+ (io.restorecommerce.options.resolver) = {
129
+ target_type: ".io.restorecommerce.tax.Tax",
130
+ target_service: "master_data",
131
+ target_sub_service: "tax",
132
+ target_method: "Read",
133
+ field_name: "tax",
134
+ }
135
+ ];
126
136
  optional string gtin = 10;
127
137
  oneof nature {
128
138
  PhysicalProduct physical = 11;
@@ -175,7 +185,7 @@ message PhysicalVariant {
175
185
  repeated io.restorecommerce.image.Image images = 6;
176
186
  repeated io.restorecommerce.file.File files = 7;
177
187
  optional string stock_keeping_unit = 8;
178
- optional string template_variant = 9;
188
+ optional string parent_variant_id = 9;
179
189
  optional Package package = 10;
180
190
  repeated io.restorecommerce.property.Property properties = 11;
181
191
  }
@@ -189,7 +199,7 @@ message ServiceVariant {
189
199
  repeated io.restorecommerce.image.Image images = 6;
190
200
  repeated io.restorecommerce.file.File files = 7;
191
201
  optional string stock_keeping_unit = 8;
192
- optional string template_variant = 9;
202
+ optional string parent_variant_id = 9;
193
203
  repeated io.restorecommerce.property.Property properties = 10;
194
204
  }
195
205
 
@@ -202,7 +212,7 @@ message VirtualVariant {
202
212
  repeated io.restorecommerce.image.Image images = 6;
203
213
  repeated io.restorecommerce.file.File files = 7;
204
214
  optional string stock_keeping_unit = 8;
205
- optional string template_variant = 9;
215
+ optional string parent_variant_id = 9;
206
216
  repeated io.restorecommerce.property.Property properties = 10;
207
217
  }
208
218
 
package/io/restorecommerce/shop.proto CHANGED
@@ -9,7 +9,6 @@ import "io/restorecommerce/status.proto";
9
9
  import "io/restorecommerce/options.proto";
10
10
 
11
11
  // Used by resolvers
12
- import "io/restorecommerce/user.proto";
13
12
  import "io/restorecommerce/address.proto";
14
13
  import "io/restorecommerce/contact_point.proto";
15
14
  import "io/restorecommerce/organization.proto";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@restorecommerce/protos",
3
- "version": "5.0.1",
3
+ "version": "6.0.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": "40b9b296f7a67f4003279130b4ce5d63e0c406a0"
18
+ "gitHead": "dd04e19687392aadd033d1a953a0ce91009524d8"
19
19
  }