@restorecommerce/protos 3.1.2 → 4.0.0

package/CHANGELOG.md

@@ -3,6 +3,38 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.0.0](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@3.1.2...@restorecommerce/protos@4.0.0) (2023-06-28)
+
+
+### Bug Fixes
+
+* correct protos, facade calls, apollo route ([ff52c38](https://github.com/restorecommerce/libs/commit/ff52c38ee4e6c6236747d6921361b5e4131384a2))
+* **fix orga:** fix numbers in orga ([72c3885](https://github.com/restorecommerce/libs/commit/72c3885938fb5311222e3d75c64d45d25925e289))
+* **fulfillment.proto:** use Price everywhere ([c2a2cb5](https://github.com/restorecommerce/libs/commit/c2a2cb57cb84eac9e046413fc5f41dec7efc1132))
+* **fulfillment:** fix type errors ([615ab2c](https://github.com/restorecommerce/libs/commit/615ab2cf738708d8dffd20343ebf0953a0da7a78))
+
+
+### Features
+
+* **currency.proto:** add currency proto, update invoice.proto ([988d161](https://github.com/restorecommerce/libs/commit/988d161913d01fc88d383810a2bd963e9c75a2f8))
+* **invoice.proto:** adjust invoice.proto to ordering-srv and fulfillment-srv ([71ee108](https://github.com/restorecommerce/libs/commit/71ee1088eec9fc54b61ab189e988504180687902))
+* **invoice:** support multiple orders and fulfillments per invoice ([e2092a0](https://github.com/restorecommerce/libs/commit/e2092a081d886722fc7112a760b9a3a3fa434519))
+* **shop.proto:** add shop.proto, remove double addresses and more ([a872677](https://github.com/restorecommerce/libs/commit/a8726777447cf443809f3d7eba7d808e7339bbba))
+
+
+### BREAKING CHANGES
+
+* **invoice:** invoice has repeated references
+* **fulfillment.proto:** ordering, fulfillment, invoice
+* **currency.proto:** Significant changes in Invoice
+* **invoice.proto:** The invoicing-srv must be refactored!
+* **shop.proto:** significant changes in product.proto, order, organization, invoice, tax_type,
+fulfillment, customer, contact_point
+
+
+
+
+
 ## [3.1.2](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@3.1.1...@restorecommerce/protos@3.1.2) (2023-06-16)
 
 **Note:** Version bump only for package @restorecommerce/protos

package/io/restorecommerce/address.proto

@@ -110,3 +110,9 @@ message ShippingAddress {
   optional Contact contact = 2;
   optional string comments = 3;
 }
+
+message BillingAddress {
+  optional Address address = 1;
+  optional Contact contact = 2;
+  optional string comments = 3;
+}

package/io/restorecommerce/amount.proto

@@ -0,0 +1,36 @@
+syntax = "proto3";
+
+package io.restorecommerce.amount;
+
+// Used by resolvers
+import "io/restorecommerce/options.proto";
+import "io/restorecommerce/tax.proto";
+import "io/restorecommerce/currency.proto";
+
+message VAT {
+  optional string tax_id = 1 [
+    (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 double vat = 2;
+}
+  
+message Amount {
+  optional string currency_id = 1 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.currency.Currency",
+      target_service: "master_data",
+      target_sub_service: "currency",
+      target_method: "Read",
+      field_name: "currency",
+    }
+  ];
+  optional double gross = 2;
+  optional double net = 3;
+  repeated VAT vats = 4;
+}

package/io/restorecommerce/contact_point.proto

@@ -59,7 +59,7 @@ message ContactPoint {
   ];
   optional string website = 5;
   optional string email = 6;
-  optional string contact_point_type_id = 7 [
+  repeated string contact_point_type_ids = 7 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.contact_point_type.ContactPointType",
       target_service: "master_data",
@@ -87,4 +87,6 @@ message ContactPoint {
       field_name: "locale",
     }
   ];
+  optional string name = 11;
+  optional string description = 12;
 }

package/io/restorecommerce/currency.proto

@@ -0,0 +1,89 @@
+syntax = "proto3";
+
+package io.restorecommerce.currency;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+import "io/restorecommerce/options.proto";
+
+/*
+* Microservice definition.
+*/
+service CurrencyService {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (CurrencyListResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
+  rpc Create (CurrencyList) returns (CurrencyListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (CurrencyList) returns (CurrencyListResponse);
+  rpc Upsert (CurrencyList) returns (CurrencyListResponse);
+  rpc QueryExchangeRate (ExchangeRateQueryList) returns (ExchangeRateListResponse);
+}
+
+message Deleted {
+  string id = 1;
+}
+
+message CurrencyList {
+  repeated Currency items = 1;
+  optional uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message CurrencyListResponse {
+  repeated CurrencyResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message CurrencyResponse {
+  Currency payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message Currency {
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;
+  optional string symbol = 4;
+  optional string country_id = 5;
+  /*
+  * For custom exchange rates beyond market.
+  * Regular rates are retrived from API by calling QueryExchangeRate.
+  */
+  repeated ExchangeRate custom_exchange_rates = 6;
+}
+
+message ExchangeRate {
+  optional string to_currency_id = 1;
+  optional double rate = 3;
+  optional double expenses = 4; //fees
+  optional double amount = 5; // leave empty == 1.0
+}
+
+message ExchangeRateQuery {
+  optional string from_currency_id = 1;
+  optional string to_currency_id = 2;
+  optional double datetime = 3; // now in general case
+  optional double amount = 4; // leave empty == 1.0
+}
+
+message ExchangeRateQueryList {
+  repeated ExchangeRate items = 1;
+  optional uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message ExchangeRateResponse {
+  optional string from_currency_id = 1;
+  ExchangeRate payload = 3;
+  optional double timestamp = 2;
+  io.restorecommerce.status.Status status = 4;
+}
+
+message ExchangeRateListResponse {
+  repeated ExchangeRateResponse items = 1;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}

package/io/restorecommerce/customer.proto

@@ -10,7 +10,6 @@ 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";
 
@@ -47,14 +46,14 @@ message CustomerResponse {
 message Customer {
   optional string id = 1;
   optional io.restorecommerce.meta.Meta meta = 2;
-  oneof customer {
-    IndividualUser individual_user = 3;
-    OrgUser org_user = 4;
-    Guest guest = 5;
-  }
+  oneof type {
+    Private private = 3;
+    Commercial commercial = 4;
+    PublicSector public_sector = 5;
+  };
 }
 
-message IndividualUser {
+message Private {
   optional string user_id = 1 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.user.User",
@@ -64,16 +63,7 @@ message IndividualUser {
       field_name: "user",
     }
   ];
-  optional string address_id = 2 [
-    (io.restorecommerce.options.resolver) = {
-      target_type: ".io.restorecommerce.address.Address",
-      target_service: "master_data",
-      target_sub_service: "address",
-      target_method: "Read",
-      field_name: "address",
-    }
-  ];
-  repeated string contact_point_ids = 3 [
+  repeated string contact_point_ids = 2 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.contact_point.ContactPoint",
       target_service: "master_data",
@@ -84,17 +74,8 @@ message IndividualUser {
   ];
 }
 
-message OrgUser {
-  optional string user_id = 1 [
-    (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 organization_id = 2 [
+message Commercial {
+  optional string organization_id = 1 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.organization.Organization",
       target_service: "master_data",
@@ -105,24 +86,14 @@ message OrgUser {
   ];
 }
 
-message Guest {
-  bool guest = 1;
-  optional string address_id = 2 [
+message PublicSector {
+  optional string organization_id = 1 [
     (io.restorecommerce.options.resolver) = {
-      target_type: ".io.restorecommerce.address.Address",
-      target_service: "master_data",
-      target_sub_service: "address",
-      target_method: "Read",
-      field_name: "address",
-    }
-  ];
-  repeated string contact_point_ids = 3 [
-    (io.restorecommerce.options.resolver) = {
-      target_type: ".io.restorecommerce.contact_point.ContactPoint",
+      target_type: ".io.restorecommerce.organization.Organization",
       target_service: "master_data",
-      target_sub_service: "contact_point",
+      target_sub_service: "organization",
       target_method: "Read",
-      field_name: "contactPoints",
+      field_name: "organization",
     }
   ];
-}
+}

package/io/restorecommerce/file.proto

@@ -2,6 +2,8 @@ syntax = "proto3";
 
 package io.restorecommerce.file;
 
+import "io/restorecommerce/image.proto";
+
 message File {
   optional string id = 1;
   optional int64 index = 2;
@@ -11,6 +13,7 @@ message File {
   optional string url = 6;
   optional int64 bytes = 7;
   repeated string tags = 8;
+  optional io.restorecommerce.image.Image thumbnail = 9;
 }
 
 message FileList {

package/io/restorecommerce/fulfillment.proto

@@ -3,6 +3,7 @@ syntax = "proto3";
 package io.restorecommerce.fulfillment;
 
 import "google/protobuf/any.proto";
+import "io/restorecommerce/reference.proto";
 import "io/restorecommerce/resource_base.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
@@ -11,7 +12,8 @@ import "io/restorecommerce/address.proto";
 import "io/restorecommerce/country.proto";
 import "io/restorecommerce/product.proto";
 import "io/restorecommerce/options.proto";
-import "io/restorecommerce/tax.proto";
+import "io/restorecommerce/amount.proto";
+import "io/restorecommerce/invoice.proto";
 
 /**
 Microservice definition.
@@ -68,20 +70,30 @@ service FulfillmentService {
   Delete a batch of fulfillments from the database
   */
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+
+  /**
+  Requires Invoice Service
+  */
+  rpc CreateInvoice (InvoiceRequestList) returns (io.restorecommerce.invoice.InvoiceListResponse);
+
+  /**
+  Requires Invoice Service
+  */
+  rpc TriggerInvoice (InvoiceRequestList) returns (io.restorecommerce.status.StatusListResponse);
 }
 
 enum State {
-  Created = 0;
-  Invalid = 1;
-  Failed = 2;
-  Submitted = 3;
-  InTransit = 4;
-  Fulfilled = 5;
-  Withdrawn = 6;
-  Cancelled = 7;
+  FAILED = 0;
+  INVALID = 1;
+  CREATED = 2;
+  SUBMITTED = 3;
+  IN_TRANSIT = 4;
+  FULFILLED = 5;
+  WITHDRAWN = 6;
+  CANCELLED = 7;
 }
 
-message FulfillmentItem {
+message Item {
   optional string product_id = 1;
   optional string variant_id = 2;
   optional int32 quantity = 3;
@@ -100,10 +112,9 @@ message Parcel {
     }
   ];
   optional string variant_id = 3;
-  optional FulfillmentItem item = 4;
-  optional double price = 5;
-  repeated io.restorecommerce.tax.VAT vats = 6; //Set by service
-  optional io.restorecommerce.product.Package package = 7;
+  optional Item item = 4;
+  optional io.restorecommerce.amount.Amount amount = 5;
+  optional io.restorecommerce.product.Package package = 6;
 }
 
 message Label {
@@ -119,11 +130,14 @@ message Label {
 }
 
 message Packaging {
-  optional string reference_id = 1;
+  optional io.restorecommerce.reference.Reference reference = 1;
   repeated Parcel parcels = 2;
   optional io.restorecommerce.address.ShippingAddress sender = 3;
-  optional io.restorecommerce.address.ShippingAddress receiver = 4;
+  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;
 }
 
 message Event {
@@ -153,13 +167,12 @@ message Fulfillment {
   };
 
   optional string id = 1;
-  optional Packaging packaging = 2; //filled by user
+  optional Packaging packaging = 2; //set by user
   optional io.restorecommerce.meta.Meta meta = 3;
-  repeated Label labels = 4; //filled by service
-  repeated Tracking trackings = 5; //filled by service
-  optional State state = 6; //filled by service
-  optional double total_price = 7;
-  optional double total_vat = 8;
+  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
 }
 
 message FulfillmentList {
@@ -194,4 +207,16 @@ message FulfillmentIdList {
 
 message Deleted {
   string id = 1;
+}
+
+message InvoiceRequest {
+  optional string invoice_number = 1; // if given
+  optional string fulfillment_id = 2;
+  repeated string included_parcels = 3; // includes all on empty
+}
+
+message InvoiceRequestList {
+  repeated InvoiceRequest items = 1;
+  optional uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
 }

package/io/restorecommerce/fulfillment_product.proto

@@ -2,13 +2,15 @@ syntax = "proto3";
 
 package io.restorecommerce.fulfillment_product;
 
+import "io/restorecommerce/reference.proto";
 import "io/restorecommerce/resource_base.proto";
 import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/attribute.proto";
 import "io/restorecommerce/address.proto";
-import "io/restorecommerce/tax.proto";
+import "io/restorecommerce/amount.proto";
+import "io/restorecommerce/price.proto";
 import "io/restorecommerce/geometry.proto";
 import "io/restorecommerce/fulfillment_courier.proto";
 import "io/restorecommerce/fulfillment.proto";
@@ -39,8 +41,12 @@ message Preferences {
 message ProductQuery {
   optional io.restorecommerce.address.ShippingAddress sender = 1;
   optional io.restorecommerce.address.ShippingAddress receiver = 2;
-  repeated io.restorecommerce.fulfillment.FulfillmentItem items = 3;
+  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;
 }
 
@@ -65,25 +71,25 @@ message FulfillmentProduct {
   optional string courier_id = 4 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.fulfillment_courier.FulfillmentCourier",
-      target_service: "master_data",
+      target_service: "fulfillment",
       target_sub_service: "fulfillment_courier",
       target_method: "Read",
       field_name: "courier",
     }
   ];
   repeated string start_zones = 6;
-  repeated string destination_zones = 8;
-  repeated string tax_ids = 9;
-  repeated io.restorecommerce.attribute.Attribute attributes = 10;
-  repeated Variant variants = 11;
-  optional io.restorecommerce.meta.Meta meta = 12;
+  repeated string destination_zones = 7;
+  repeated string tax_ids = 8;
+  repeated io.restorecommerce.attribute.Attribute attributes = 9;
+  repeated Variant variants = 10;
+  optional io.restorecommerce.meta.Meta meta = 11;
 }
 
 message Variant {
   optional string id = 1;
   optional string name = 2;
   optional string description = 3;
-  optional double price = 4;
+  optional io.restorecommerce.price.Price price = 4;
   optional io.restorecommerce.geometry.BoundingBox3D max_size = 6;
   optional double max_weight = 7;
 }
@@ -106,16 +112,15 @@ message FulfillmentProductListResponse {
 }
 
 message PackingSolution {
-  optional double price = 1;
+  repeated io.restorecommerce.amount.Amount amounts = 1;
   optional double compactness = 2;
   optional double homogeneity = 3;
   optional double score = 4;
   repeated io.restorecommerce.fulfillment.Parcel parcels = 5;
-  repeated io.restorecommerce.tax.VAT vats = 6;
 }
 
 message PackingSolutionResponse {
-  optional string reference_id = 1;
+  optional io.restorecommerce.reference.Reference reference = 1;
   repeated PackingSolution solutions = 2;
   optional io.restorecommerce.status.Status status = 3;
 }