@restorecommerce/protos 5.0.0 → 6.0.0

package/CHANGELOG.md

@@ -3,6 +3,33 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [6.0.0](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@5.0.1...@restorecommerce/protos@6.0.0) (2023-08-01)
+
+
+### Bug Fixes
+
+* **fulfillment, order, price, product, shop:** fix missing resolvers, enum style guide, naming ([103172c](https://github.com/restorecommerce/libs/commit/103172c9b2e1544a88257cededc1b39a2731fd8c))
+
+
+### BREAKING CHANGES
+
+* **fulfillment, order, price, product, shop:** changes in product require adjustments in example data
+
+
+
+
+
+## [5.0.1](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@5.0.0...@restorecommerce/protos@5.0.1) (2023-07-25)
+
+
+### Bug Fixes
+
+* **fulfillment_product:** productQueryList uses reference_id:string instead of reference:Reference ([278afa8](https://github.com/restorecommerce/libs/commit/278afa89b5359765420744e1debca2387e366e15))
+
+
+
+
+
 # [5.0.0](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@4.2.0...@restorecommerce/protos@5.0.0) (2023-07-21)
 
 

package/io/restorecommerce/fulfillment.proto

@@ -17,6 +17,11 @@ import "io/restorecommerce/amount.proto";
 import "io/restorecommerce/invoice.proto";
 import "google/protobuf/timestamp.proto";
 
+// Used by resolvers
+import "io/restorecommerce/user.proto";
+import "io/restorecommerce/customer.proto";
+import "io/restorecommerce/shop.proto";
+
 /**
 Microservice definition.
 */
@@ -133,14 +138,13 @@ message Label {
 }
 
 message Packaging {
-  optional io.restorecommerce.reference.Reference reference = 1;
-  repeated Parcel parcels = 2;
-  optional io.restorecommerce.address.ShippingAddress sender = 3;
-  optional io.restorecommerce.address.ShippingAddress recipient = 4;
-  optional string notify = 5;
-  optional string export_type = 6;
-  optional string export_description = 7;
-  optional string invoice_number = 8;
+  repeated Parcel parcels = 1;
+  optional io.restorecommerce.address.ShippingAddress sender = 2;
+  optional io.restorecommerce.address.ShippingAddress recipient = 3;
+  optional string notify = 4;
+  optional string export_type = 5;
+  optional string export_description = 6;
+  optional string invoice_number = 7;
 }
 
 message Event {
@@ -170,12 +174,40 @@ message Fulfillment {
   };
 
   optional string id = 1;
-  optional Packaging packaging = 2; //set by user
-  optional io.restorecommerce.meta.Meta meta = 3;
-  repeated Label labels = 4; //set by service
-  repeated Tracking trackings = 5; //set by service
-  repeated io.restorecommerce.amount.Amount total_amounts = 6; //set by service
-  optional State state = 8; //set by service
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string user_id = 3 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.user.User",
+      target_service: "identity",
+      target_sub_service: "user",
+      target_method: "Read",
+      field_name: "user",
+    }
+  ];
+  optional string customer_id = 4 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.customer.Customer",
+      target_service: "master_data",
+      target_sub_service: "customer",
+      target_method: "Read",
+      field_name: "customer",
+    }
+  ];
+  optional string shop_id = 5 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.shop.Shop",
+      target_service: "master_data",
+      target_sub_service: "shop",
+      target_method: "Read",
+      field_name: "shop",
+    }
+  ];
+  optional io.restorecommerce.reference.Reference reference = 6;
+  optional Packaging packaging = 7;
+  repeated Label labels = 8; //set by service
+  repeated Tracking trackings = 9; //set by service
+  repeated io.restorecommerce.amount.Amount total_amounts = 10; //set by service
+  optional State state = 11; //set by service
 }
 
 message FulfillmentList {

package/io/restorecommerce/fulfillment_courier.proto

@@ -9,6 +9,9 @@ import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/options.proto";
 
+// Used by resolvers
+import "io/restorecommerce/shop.proto";
+
 /**
 Microservice defination
 */
@@ -33,13 +36,22 @@ message FulfillmentCourier {
   };
 
   optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string shop_ids = 3 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.shop.Shop",
+      target_service: "master_data",
+      target_sub_service: "shop",
+      target_method: "Read",
+      field_name: "shops",
+    }
+  ];
   optional string name = 4;
   optional string description = 5;
   optional string logo = 6;
   optional string website = 7;
   optional string stub_type = 8;
-  optional google.protobuf.Any configuration = 10;
-  optional io.restorecommerce.meta.Meta meta = 11;
+  optional google.protobuf.Any configuration = 9;
 }
 
 message FulfillmentCourierList {

package/io/restorecommerce/fulfillment_product.proto

@@ -39,15 +39,29 @@ message Preferences {
 }
 
 message ProductQuery {
-  optional io.restorecommerce.address.ShippingAddress sender = 1;
-  optional io.restorecommerce.address.ShippingAddress receiver = 2;
-  repeated io.restorecommerce.fulfillment.Item items = 3;
-  optional Preferences preferences = 4;
-  /*
-  * A forigner_key using the following pattern: `${collection}/${id}`
-  * most likly an order_id or fulfillment_id.
-  */
-  optional string reference_id = 5;
+  optional string customer_id = 1 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.customer.Customer",
+      target_service: "master_data",
+      target_sub_service: "customer",
+      target_method: "Read",
+      field_name: "customer",
+    }
+  ];
+  optional string shop_id = 2 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.shop.Shop",
+      target_service: "master_data",
+      target_sub_service: "shop",
+      target_method: "Read",
+      field_name: "shop",
+    }
+  ];
+  optional io.restorecommerce.address.ShippingAddress sender = 3;
+  optional io.restorecommerce.address.ShippingAddress recipient = 4;
+  repeated io.restorecommerce.fulfillment.Item items = 5;
+  optional Preferences preferences = 6;
+  optional io.restorecommerce.reference.Reference reference = 7;
 }
 
 message ProductQueryList {

package/io/restorecommerce/order.proto

@@ -18,6 +18,8 @@ import "io/restorecommerce/fulfillment_product.proto";
 import "io/restorecommerce/invoice.proto";
 
 // Used by resolvers
+import "io/restorecommerce/user.proto";
+import "io/restorecommerce/customer.proto";
 import "io/restorecommerce/shop.proto";
 
 
@@ -96,11 +98,11 @@ message Order {
   optional io.restorecommerce.meta.Meta meta = 2;
   optional string user_id = 3 [
     (io.restorecommerce.options.resolver) = {
-      target_type: ".io.restorecommerce.customer.Customer",
-      target_service: "master_data",
-      target_sub_service: "customer",
+      target_type: ".io.restorecommerce.user.User",
+      target_service: "identity",
+      target_sub_service: "user",
       target_method: "Read",
-      field_name: "customer",
+      field_name: "user",
     }
   ];
   optional string customer_id = 4 [

package/io/restorecommerce/price.proto

@@ -4,7 +4,6 @@ package io.restorecommerce.price;
 
 // Used by resolvers
 import "io/restorecommerce/options.proto";
-import "io/restorecommerce/tax.proto";
 import "io/restorecommerce/currency.proto";
 
 message Price {
@@ -20,13 +19,4 @@ message Price {
       field_name: "currency",
     }
   ];
-  repeated string tax_ids = 5 [
-    (io.restorecommerce.options.resolver) = {
-      target_type: ".io.restorecommerce.tax.Tax",
-      target_service: "master_data",
-      target_sub_service: "tax",
-      target_method: "Read",
-      field_name: "taxes",
-    }
-  ];
 }

package/io/restorecommerce/product.proto

@@ -12,11 +12,13 @@ import "io/restorecommerce/status.proto";
 import "io/restorecommerce/attribute.proto";
 import "io/restorecommerce/geometry.proto";
 import "io/restorecommerce/price.proto";
-import "io/restorecommerce/property.proto";
 import "io/restorecommerce/options.proto";
 
 // Used by resolvers
 import "io/restorecommerce/manufacturer.proto";
+import "io/restorecommerce/property.proto";
+import "io/restorecommerce/shop.proto";
+import "io/restorecommerce/tax.proto";
 
 service ProductService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductListResponse) {
@@ -29,9 +31,9 @@ service ProductService {
 }
 
 enum AssociationType {
-  Miscellaneous = 0;
-  Accessory = 1;
-  Recommendation = 2;
+  MISCELLANEOUS = 0;
+  ACCESSORY = 1;
+  RECOMMENDATION = 2;
 }
 
 message Association {
@@ -122,7 +124,15 @@ message IndividualProduct {
       }
     ];
   }
-  repeated string tax_ids = 8;
+  repeated string tax_ids = 8 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.tax.Tax",
+      target_service: "master_data",
+      target_sub_service: "tax",
+      target_method: "Read",
+      field_name: "tax",
+    }
+  ];
   optional string gtin = 10;
   oneof nature {
     PhysicalProduct physical = 11;
@@ -175,7 +185,7 @@ message PhysicalVariant {
   repeated io.restorecommerce.image.Image images = 6;
   repeated io.restorecommerce.file.File files = 7;
   optional string stock_keeping_unit = 8;
-  optional string template_variant = 9;
+  optional string parent_variant_id = 9;
   optional Package package = 10;
   repeated io.restorecommerce.property.Property properties = 11;
 }
@@ -189,7 +199,7 @@ message ServiceVariant {
   repeated io.restorecommerce.image.Image images = 6;
   repeated io.restorecommerce.file.File files = 7;
   optional string stock_keeping_unit = 8;
-  optional string template_variant = 9;
+  optional string parent_variant_id = 9;
   repeated io.restorecommerce.property.Property properties = 10;
 }
 
@@ -202,7 +212,7 @@ message VirtualVariant {
   repeated io.restorecommerce.image.Image images = 6;
   repeated io.restorecommerce.file.File files = 7;
   optional string stock_keeping_unit = 8;
-  optional string template_variant = 9;
+  optional string parent_variant_id = 9;
   repeated io.restorecommerce.property.Property properties = 10;
 }
 

package/io/restorecommerce/shop.proto

@@ -9,7 +9,6 @@ import "io/restorecommerce/status.proto";
 import "io/restorecommerce/options.proto";
 
 // Used by resolvers
-import "io/restorecommerce/user.proto";
 import "io/restorecommerce/address.proto";
 import "io/restorecommerce/contact_point.proto";
 import "io/restorecommerce/organization.proto";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@restorecommerce/protos",
-  "version": "5.0.0",
+  "version": "6.0.0",
   "description": "Protobuf descriptors for Restorecommerce services",
   "author": "n-fuse GmbH",
   "repository": {
@@ -15,5 +15,5 @@
     "protobufs"
   ],
   "scripts": {},
-  "gitHead": "10ce5d4cc82217c0f8148c0e609a904711484730"
+  "gitHead": "dd04e19687392aadd033d1a953a0ce91009524d8"
 }