@restorecommerce/protos 6.11.0 → 6.11.2

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.11.2](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@6.11.1...@restorecommerce/protos@6.11.2) (2025-05-14)
+
+
+### Bug Fixes
+
+* **protos:** add collection (name) to message Deleted for kafka DeletedAll event ([807ca4c](https://github.com/restorecommerce/libs/commit/807ca4cce3624720c6a2436afdee407ec181029c))
+* **protos:** add costums declaration to fulfillment ([0797faa](https://github.com/restorecommerce/libs/commit/0797faa53388cbc81340203d58c92340f7443514))
+* **protos:** fix typos in proto, load meta in acs decorater, refactor logger filePath detector ([8f02eee](https://github.com/restorecommerce/libs/commit/8f02eee6460b9c48f2f8416b08017f6ba11caf4e))
+
+
+
+
+
+## [6.11.1](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@6.11.0...@restorecommerce/protos@6.11.1) (2025-03-31)
+
+
+### Bug Fixes
+
+* **proto:** add layout to rendering template array ([bcf636f](https://github.com/restorecommerce/libs/commit/bcf636f3ea19662a9f30b110137976eda60a0abb))
+* **protos:** rename template use-cases ([0a578ac](https://github.com/restorecommerce/libs/commit/0a578ac076b5f5ba2fcb784d8b9db3ba76168943))
+* **protos:** render response with repeated bodies ([a2f4df9](https://github.com/restorecommerce/libs/commit/a2f4df979155721ba50af264648c41e99e5a2224))
+* **protos:** resolve enum error ([22b33a1](https://github.com/restorecommerce/libs/commit/22b33a18e5504ef5a0f00a653dadcbc69ad81277))
+
+
+
+
+
 # [6.11.0](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@6.10.5...@restorecommerce/protos@6.11.0) (2025-03-28)
 
 

package/io/restorecommerce/country.proto

@@ -46,7 +46,9 @@ message Country {
   optional string id = 1;
   optional io.restorecommerce.meta.Meta meta = 2;
   optional string name = 3;
-  optional string country_code = 4;
+  optional string country_code = 4; // primaly used in target application (fallback)
   optional string geographical_name = 5;
   repeated string economic_areas = 6;
+  optional string country_code_alpha_2 = 7; // ISO 3166-1 alpha-2
+  optional string country_code_alpha_3 = 8; // ISO 3166-1 alpha-3
 }

package/io/restorecommerce/file.proto

@@ -4,19 +4,28 @@ package io.restorecommerce.file;
 
 import "io/restorecommerce/image.proto";
 
+message Blob {
+  bytes data = 1;
+  string encoding = 2;
+}
+
 message File {
   optional string id = 1;
   optional uint32 ordinal = 2;
   optional string caption = 3;
   optional string filename = 4;
   optional string content_type = 5;
-  optional string url = 6;
-  optional int64 bytes = 7;
-  repeated string tags = 8;
-  optional io.restorecommerce.image.Image thumbnail = 9;
+  oneof type {
+    string url = 6;
+    Blob blob = 7;
+  }
+  optional int64 bytes = 8;
+  repeated string tags = 9;
+  optional io.restorecommerce.image.Image thumbnail = 10;
 }
 
 message FileList {
   repeated File items = 1;
   optional uint32 total_count = 2;
-}
+}
+

package/io/restorecommerce/fulfillment.proto

@@ -9,12 +9,12 @@ import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/address.proto";
-import "io/restorecommerce/country.proto";
 import "io/restorecommerce/product.proto";
 import "io/restorecommerce/options.proto";
 import "io/restorecommerce/price.proto";
 import "io/restorecommerce/amount.proto";
 import "io/restorecommerce/invoice.proto";
+import "io/restorecommerce/file.proto";
 import "google/protobuf/timestamp.proto";
 
 // Used by resolvers
@@ -91,26 +91,41 @@ service FulfillmentService {
 
 enum FulfillmentState {
   PENDING = 0;
-  SUBMITTED = 2;
-  SUBMIT_NOTIFIED = 3;
-  IN_TRANSIT = 4;
-  TRANSIT_NOTIFIED = 5;
-  COMPLETED = 6;
-  COMPLETION_NOTIFIED = 7;
-  CANCELLED = 8;
-  CANCELATION_NOTIFIED = 9;
-  WITHDRAWN = 10;
-  WITHDRAW_NOTIFIED = 11;
-  FAILED = 12;
-  FAIL_NOTIFIED = 13;
-  INVALID = 14;
+  SUBMITTED = 1;
+  IN_TRANSIT = 2;
+  COMPLETE = 3;
+  CANCELLED = 4;
+  WITHDRAWN = 5;
+  RETOURE = 6;
+  RETOURE_COMPLETE = 7;
+  FAILED = 8;
+  INVALID = 9;
+}
+
+enum ExportType {
+  OTHER = 0;
+  PRESENT = 1;
+  COMMERCIAL_SAMPLE = 2;
+  DOCUMENT = 3;
+  RETURN_OF_GOODS = 4;
+  COMMERCIAL_GOODS = 5;
+}
+
+enum ShippingCondition {
+  DDU = 0;
+  DPA = 1;
+  DAP = 2;
+  DDP = 3;
+  DDX = 4;
+  DXV = 5;
 }
 
 message Item {
   optional string product_id = 1;
   optional string variant_id = 2;
   optional int32 quantity = 3;
-  optional io.restorecommerce.product.Package package = 4;
+  optional string harmonizedSystemCode = 4;
+  optional io.restorecommerce.amount.Amount amount = 5;
 }
 
 message Parcel {
@@ -128,19 +143,35 @@ message Parcel {
   repeated Item items = 4;
   optional io.restorecommerce.price.Price price = 5;
   optional io.restorecommerce.amount.Amount amount = 6;
-  optional io.restorecommerce.product.Package package = 8;
+  optional io.restorecommerce.product.Package package = 7;
 }
 
 message Label {
-  oneof type {
-    string url = 1;
-    string pdf = 2;
-    string png = 3;
-  }
-  optional string parcel_id = 4;
-  optional string shipment_number = 5; //filled on Order
-  optional FulfillmentState state = 6; //update by Track
-  optional io.restorecommerce.status.Status status = 7; //API status
+  optional string id = 1;
+  optional string parcel_id = 2;
+  optional io.restorecommerce.file.File file = 3; 
+  optional string shipment_number = 4; //filled on Order
+  optional FulfillmentState state = 5; //update by Track
+  optional io.restorecommerce.status.Status status = 6; //API status
+}
+
+message Charge {
+  optional string description = 1;
+  optional io.restorecommerce.amount.Amount charge = 2; 
+}
+
+message CustomsDeclaration {
+  optional string export_type = 1; // should be ExportType (but unconstrained)
+  optional string export_description = 2;
+  optional string invoice_number = 3;
+  optional string consignee_ref = 4;
+  optional string shipper_ref = 5;
+  optional string MRN = 6;
+  optional string permit_number = 7; // for e.g. rare goods
+  optional string attestation = 8; // for e.g. medical goods
+  optional string shipping_condition = 9; // should be ShippingCondition (unconstrained)
+  repeated Charge charges = 10; 
+  optional bool notify = 11;
 }
 
 message Packaging {
@@ -148,9 +179,7 @@ message Packaging {
   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;
+  optional CustomsDeclaration customs_declaration = 5;
 }
 
 message Event {

package/io/restorecommerce/fulfillment_courier.proto

@@ -6,6 +6,7 @@ import "google/protobuf/any.proto";
 import "io/restorecommerce/resource_base.proto";
 import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/attribute.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/options.proto";
 
@@ -26,6 +27,10 @@ service FulfillmentCourierService {
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
 }
 
+enum SupportedAPI {
+  DHLRest = 0;
+}
+
 message FulfillmentCourier {
   option (restorecommerce.options.kafka_subscriber) = {
     plural: "fulfillmentCouriers"
@@ -50,10 +55,10 @@ message FulfillmentCourier {
   optional string description = 5;
   optional string logo = 6;
   optional string website = 7;
-  optional string stub_type = 8; // obsolete, use api
-  optional string credential_id = 9;
-  optional google.protobuf.Any configuration = 10;
-  optional string api = 11;
+  optional string credential_id = 8;
+  optional google.protobuf.Any configuration = 9;
+  optional string api = 10; // should be SupportedAPI (but unconstrained)
+  repeated io.restorecommerce.attribute.Attribute attributes = 11; 
 }
 
 message FulfillmentCourierList {

package/io/restorecommerce/product.proto

@@ -33,9 +33,35 @@ service ProductService {
   rpc Update (ProductList) returns (ProductListResponse);
   rpc Upsert (ProductList) returns (ProductListResponse);
 
+  /*
+   * Response with resolved product-variants in a flatten message
+   */
   rpc GetVariant (IndividualProductVariantListRequest) returns (IndividualProductVariantListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
+
+  /* 
+   * Response with resolved product-variants
+   * Claims a requested quantity from stock level permanently.
+   * Response with an error status if requested quantity is not in stock.
+   */
+  rpc ClaimVariant (IndividualProductVariantListRequest) returns (IndividualProductVariantListResponse);
+  
+  /* 
+   * Response with resolved product-variants
+   * Releases a requested quantity back to stock level.
+   */
+  rpc ReleaseVariant (IndividualProductVariantListRequest) returns (IndividualProductVariantListResponse);
+
+  /* 
+   * Claim all products assigned to a session permanently
+   */
+  rpc ResolveSession (Session) returns (IndividualProductVariantListResponse);
+
+  /*
+   * Drop session and instantly release all claimed products
+   */
+  rpc DropSession (Session) returns (IndividualProductVariantListResponse);
 }
 
 enum AssociationType {
@@ -262,9 +288,24 @@ message BundleProduct {
   optional double price_ratio = 4; //Price ratio in relation to the bundle price
 }
 
+message Session {
+  optional string id = 1; // get a new id if empty
+  optional google.protobuf.Timestamp from = 2; // required field to start a session
+  optional google.protobuf.Timestamp to = 3; // leave empty for auto max session
+}
+
 message IndividualProductVariantRequest {
+  message Localization {
+    optional string country_id = 1;
+    optional string locale_id = 2;
+    optional string currency_id = 3;
+  }
+
   optional string product_id = 1;
   optional string variant_id = 2;
+  optional uint32 quantity = 3;
+  optional Session session = 4;
+  optional Localization localization = 5; // for taxing, currency, etc.?
 }
 
 message IndividualProductVariantListRequest {
@@ -341,7 +382,7 @@ message IndividualProductVariant {
   optional bool active = 23;
   optional google.protobuf.Timestamp valid_from = 24;
   optional google.protobuf.Timestamp valid_to = 25;
-  repeated io.restorecommerce.attribute.Attribute attibutes = 26;
+  repeated io.restorecommerce.attribute.Attribute attributes = 26;
   optional Package package = 27; // size for shipping
 }
 
@@ -351,7 +392,8 @@ message IndividualProductVariantResponse {
 }
 
 message IndividualProductVariantListResponse {
-  repeated ProductResponse items = 1;
+  repeated IndividualProductVariantResponse items = 1;
   optional uint32 total_count = 2;
   optional io.restorecommerce.status.OperationStatus operation_status = 3;
+  optional Session session = 4;
 }

package/io/restorecommerce/rendering.proto

@@ -22,15 +22,17 @@ message RenderRequest {
   message Template {
     optional string id = 1;  // snippit name
     optional bytes body = 2;
-    optional string charset = 3;
+    optional bytes layout = 3;
+    optional string charset = 4; // defaults to utf-8
   }
 
-  repeated Template templates = 1;
-  optional google.protobuf.Any data = 2;  // data to fill template with
-  optional string style_url = 3; // stylesheet URL
-  optional Strategy strategy = 4; // inlining, copying CSS into <style>, etc...
-  optional google.protobuf.Any options = 5; // rendering options JSON object
-  optional string content_type = 6; // content type for rendering such as 'application/html' or 'application/text'
+  optional string id = 1;
+  repeated Template templates = 2;
+  optional google.protobuf.Any data = 3;  // data to fill template with
+  optional string style_url = 4; // stylesheet URL
+  optional Strategy strategy = 5; // inlining, copying CSS into <style>, etc...
+  optional google.protobuf.Any options = 6; // rendering options JSON object
+  optional string content_type = 7; // content type for rendering such as 'application/html' or 'application/text'
 }
 
 message RenderRequestList {
@@ -40,9 +42,15 @@ message RenderRequestList {
 }
 
 message RenderResult {
+  message Bodies {
+    optional string id = 1; // snippit name
+    optional bytes body = 2;
+    optional string charset = 3; // defaults to utf-8
+  }
+  
   optional string id = 1; // snippit name
-  optional bytes body = 2;
-  optional string charset = 3;
+  repeated Bodies bodies = 2;
+  optional string content_type = 7; // content type for rendering such as 'application/html' or 'application/text'
 }
 
 message RenderResponse {

package/io/restorecommerce/resource_base.proto

@@ -141,4 +141,5 @@ message Resource {
 
 message Deleted {
   optional string id = 1;
+  optional string collection = 2;
 }

package/io/restorecommerce/template.proto

@@ -35,15 +35,18 @@ enum TemplateUseCase {
   REGISTRATION_EMAIL_SUBJECT = 7;
   CHANGE_PASSWORD_EMAIL_BODY = 8;
   CHANGE_PASSWORD_EMAIL_SUBJECT = 9;
-  ORDER_CONFIRMATION_EMAIL = 10;
-  ORDER_COMPLETION_EMAIL = 11;
-  ORDER_CANCELATION_PENDING_EMAIL = 12;
-  ORDER_CANCELATION_CONFIRMED_EMAIL = 13;
-  FULFILLMENT_CONFIRMATION_EMAIL = 14;
-  FULFILLMENT_COMPLETION_EMAIL = 15;
-  FULFILLMENT_CANCELATION_PENDING_EMAIL = 16;
-  FULFILLMENT_CANCELATION_CONFIRMED_EMAIL = 17;
-  FULFILLMENT_FAILED_EMAIL = 18;
+  ORDER_PRENDING_EMAIL = 10;
+  ORDER_SUBMITTED_EMAIL = 11;
+  ORDER_COMPLETION_EMAIL = 12;
+  ORDER_CANCELATION_EMAIL = 13;
+  ORDER_WITHDRAWN_EMAIL = 14;
+  ORDER_INVALID_EMAIL = 15;
+  FULFILLMENT_PENDING_EMAIL = 16;
+  FULFILLMENT_SUBMITTED_EMAIL = 17;
+  FULFILLMENT_COMPLETION_EMAIL = 18;
+  FULFILLMENT_CANCELATION_EMAIL = 19;
+  FULFILLMENT_WITHDRAWN_EMAIL = 20;
+  FULFILLMENT_FAILED_EMAIL = 21;
 }
 
 message Deleted {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@restorecommerce/protos",
-  "version": "6.11.0",
+  "version": "6.11.2",
   "description": "Protobuf descriptors for Restorecommerce services",
   "author": "n-fuse GmbH",
   "repository": {
@@ -15,5 +15,5 @@
     "protobufs"
   ],
   "scripts": {},
-  "gitHead": "f012a26b1a15f57c68ceca3e9d53dd5d172cf824"
+  "gitHead": "7e6127b5e0c68b998bfa54364d23fa6461bf1b76"
 }