@restorecommerce/protos 6.10.5 → 6.11.0

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [6.11.0](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@6.10.5...@restorecommerce/protos@6.11.0) (2025-03-28)
+
+
+### Bug Fixes
+
+* **proto:** add order history ([6bce016](https://github.com/restorecommerce/libs/commit/6bce0168697c92fbd8f152cb4d94103bf7525851))
+* **proto:** add timestamps for order state changes ([07abde8](https://github.com/restorecommerce/libs/commit/07abde805f102f229adf0d5d17cc85d89e44b8a9))
+* **proto:** generic string for template.use_case ([7163625](https://github.com/restorecommerce/libs/commit/71636251c1f40a447b2dde72a26b0abcbca56709))
+* **protos:** add history to orders ([e1991c8](https://github.com/restorecommerce/libs/commit/e1991c8024d7248863676bff12b6f4eedbf5f666))
+
+
+### Features
+
+* **protos:** adjust rendering to comply with RC message pattern ([abf6d2c](https://github.com/restorecommerce/libs/commit/abf6d2c8ad1a5331a5793b5d25c74590b45c1210))
+
+
+
+
+
 ## [6.10.5](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@6.10.4...@restorecommerce/protos@6.10.5) (2025-01-21)
 
 

package/io/restorecommerce/currency.proto

@@ -22,6 +22,11 @@ service CurrencyService {
   rpc Upsert (CurrencyList) returns (CurrencyListResponse);
 }
 
+enum SymbolAlignment {
+  surfix = 0;
+  prefix = 1;
+}
+
 message CurrencyList {
   repeated Currency items = 1;
   optional uint32 total_count = 2;

package/io/restorecommerce/fulfillment.proto

@@ -91,13 +91,19 @@ service FulfillmentService {
 
 enum FulfillmentState {
   PENDING = 0;
-  INVALID = 1;
   SUBMITTED = 2;
-  IN_TRANSIT = 3;
-  COMPLETED = 4;
-  WITHDRAWN = 5;
-  CANCELLED = 6;
-  FAILED = 7;
+  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;
 }
 
 message Item {

package/io/restorecommerce/order.proto

@@ -3,6 +3,7 @@ syntax = "proto3";
 package io.restorecommerce.order;
 
 import "google/protobuf/any.proto";
+import "google/protobuf/timestamp.proto";
 
 import "io/restorecommerce/resource_base.proto";
 import "io/restorecommerce/meta.proto";
@@ -11,6 +12,7 @@ import "io/restorecommerce/status.proto";
 import "io/restorecommerce/options.proto";
 import "io/restorecommerce/address.proto";
 import "io/restorecommerce/amount.proto";
+import "io/restorecommerce/attribute.proto";
 import "io/restorecommerce/price.proto";
 import "io/restorecommerce/country.proto";
 import "io/restorecommerce/fulfillment.proto";
@@ -39,32 +41,31 @@ service OrderService {
   rpc Cancel (OrderIdList) returns (OrderListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
 
+  // Requires Notification Service - (re)sends current order state as email notification.
+  rpc Notify (OrderIdList) returns (io.restorecommerce.status.StatusListResponse);
+
   // Requires Fulfillment Service
-  // Evaluates plausibility of the Fulfillment that would result from given order.
-  rpc EvaluateFulfillment (OrderList) returns (io.restorecommerce.status.StatusListResponse) {
+  rpc QueryFulfillmentSolution (FulfillmentRequestList) returns (io.restorecommerce.fulfillment_product.FulfillmentSolutionListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
   // Requires Fulfillment Service
-  rpc QueryFulfillmentSolution (FulfillmentRequestList) returns (io.restorecommerce.fulfillment_product.FulfillmentSolutionListResponse) {
+  // Evaluates plausibility of the Fulfillment that would result from given order.
+  rpc EvaluateFulfillment (OrderList) returns (io.restorecommerce.status.StatusListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
   // Requires Fulfillment Service
   rpc CreateFulfillment (FulfillmentRequestList) returns (io.restorecommerce.fulfillment.FulfillmentListResponse);
-  // Requires Fulfillment Service
-  rpc TriggerFulfillment (FulfillmentRequestList) returns (io.restorecommerce.status.StatusListResponse);
-
   // Requires Invoice Service
   rpc CreateInvoice (OrderingInvoiceRequestList) returns (io.restorecommerce.invoice.InvoiceListResponse);
-  // Requires Invoice Service
-  rpc TriggerInvoice (OrderingInvoiceRequestList) returns (io.restorecommerce.status.StatusListResponse);
 }
 
 enum OrderState {
   PENDING = 0;
   SUBMITTED = 1;
   COMPLETED = 2;
-  WITHDRAWN = 3;
-  CANCELLED = 4;
+  CANCELLED = 3;
+  WITHDRAWN = 4;
+  INVALID = 5;
 }
 
 enum FulfillmentInvoiceMode {
@@ -72,6 +73,15 @@ enum FulfillmentInvoiceMode {
   EXCLUDE = 1;
 }
 
+message Event {
+  optional string id = 1;
+  optional uint32 code = 2;
+  optional string message = 3;
+  optional google.protobuf.Timestamp timestamp = 4;
+  optional OrderState state = 5;
+  repeated io.restorecommerce.attribute.Attribute attibutes = 6;
+}
+
 message Item {
   optional string id = 1;
   optional string product_id = 2 [
@@ -143,6 +153,7 @@ message Order {
   optional string customer_vat_id = 15;
   optional io.restorecommerce.fulfillment_product.Preferences packaging_preferences = 16;
   optional string payment_method_id = 17;
+  repeated Event history = 18;
 }
 
 message OrderIdList {
@@ -180,9 +191,9 @@ message Deleted {
 
 message FulfillmentRequest {
   optional string order_id = 1;
-  optional string export_type = 2; // @TODO: not used!
-  optional string export_description = 3; // @TODO: not used!
-  optional string invoice_number = 4; // @TODO: not used!
+  optional string export_type = 2;
+  optional string export_description = 3;
+  optional string invoice_number = 4;
   optional io.restorecommerce.address.ShippingAddress sender_address = 5;
   repeated string selected_items = 6; // select all on empty
   optional google.protobuf.Any data = 7;

package/io/restorecommerce/product.proto

@@ -32,10 +32,14 @@ service ProductService {
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
   rpc Update (ProductList) returns (ProductListResponse);
   rpc Upsert (ProductList) returns (ProductListResponse);
+
+  rpc GetVariant (IndividualProductVariantListRequest) returns (IndividualProductVariantListResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
 }
 
 enum AssociationType {
-  MISCELLANEOUS = 0;
+  MISCELLANEOUS = 0; // Use attributes then...
   ACCESSORY = 1;
   RECOMMENDATION = 2;
 }
@@ -54,6 +58,7 @@ message Association {
   optional AssociationType type = 3;
   repeated string tags = 4;
   optional google.protobuf.Any data = 5;
+  repeated io.restorecommerce.attribute.Attribute attibutes = 6;
 }
 
 // Product resource entity
@@ -85,6 +90,7 @@ message Product {
   repeated string tags = 7;
   repeated Association associations = 8;
   optional google.protobuf.Any data = 9;
+  repeated io.restorecommerce.attribute.Attribute attibutes = 10;
 }
 
 message IndividualProduct {
@@ -167,7 +173,7 @@ message ProductListResponse {
 
 message ProductResponse {
   optional Product payload = 1;
-  optional io.restorecommerce.status.Status status = 3;
+  optional io.restorecommerce.status.Status status = 2;
 }
 
 message Package {
@@ -191,7 +197,8 @@ message PhysicalVariant {
   optional bool active = 12;
   optional google.protobuf.Timestamp valid_from = 13;
   optional google.protobuf.Timestamp valid_to = 14;
-  optional Package package = 15; // size for shipping
+  repeated io.restorecommerce.attribute.Attribute attibutes = 15;
+  optional Package package = 16; // size for shipping
 }
 
 message ServiceVariant {
@@ -208,7 +215,8 @@ message ServiceVariant {
   repeated string tax_ids = 11;
   optional bool active = 12;
   optional google.protobuf.Timestamp valid_from = 13;
-  optional google.protobuf.Timestamp valid_to = 14; 
+  optional google.protobuf.Timestamp valid_to = 14;
+  repeated io.restorecommerce.attribute.Attribute attibutes = 15;
 }
 
 message VirtualVariant {
@@ -225,7 +233,8 @@ message VirtualVariant {
   repeated string tax_ids = 11;
   optional bool active = 12;
   optional google.protobuf.Timestamp valid_from = 13;
-  optional google.protobuf.Timestamp valid_to = 14; 
+  optional google.protobuf.Timestamp valid_to = 14;
+  repeated io.restorecommerce.attribute.Attribute attibutes = 15;
 }
 
 message Bundle {
@@ -235,6 +244,7 @@ message Bundle {
   repeated BundleProduct products = 4;
   optional io.restorecommerce.price.Price price = 5;
   optional Package pre_packaged = 6;
+  repeated io.restorecommerce.attribute.Attribute attibutes = 7;
 }
 
 message BundleProduct {
@@ -252,6 +262,96 @@ message BundleProduct {
   optional double price_ratio = 4; //Price ratio in relation to the bundle price
 }
 
-message Deleted {
+message IndividualProductVariantRequest {
+  optional string product_id = 1;
+  optional string variant_id = 2;
+}
+
+message IndividualProductVariantListRequest {
+  repeated IndividualProductVariantRequest items = 1;
+  optional uint32 total_count = 2;
+  optional io.restorecommerce.auth.Subject subject = 3;
+}
+
+message IndividualProductVariant {
   optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string variant_id = 3;
+  optional string name = 4;
+  optional string description = 5;
+  repeated string tags = 6;
+  repeated Association associations = 7;
+  optional google.protobuf.Any data = 8;
+  optional string taric_code = 9;
+  repeated string shop_ids = 10 [
+    (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 manufacturer_id = 11 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.manufacturer.Manufacturer",
+      target_service: "catalog",
+      target_sub_service: "manufacturer",
+      target_method: "Read",
+      field_name: "manufacturer",
+    }
+  ];
+  optional string origin_country_id = 12 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.country.Country",
+      target_service: "master_data",
+      target_sub_service: "country",
+      target_method: "Read",
+      field_name: "origin_country",
+    }
+  ];
+  oneof classification {
+    string prototype_id = 13 [
+      (io.restorecommerce.options.resolver) = {
+        target_type: ".io.restorecommerce.product_prototype.ProductPrototype",
+        target_service: "catalog",
+        target_sub_service: "product_prototype",
+        target_method: "Read",
+        field_name: "prototype",
+      }
+    ];
+    string category_id = 14 [
+      (io.restorecommerce.options.resolver) = {
+        target_type: ".io.restorecommerce.product_category.ProductCategory",
+        target_service: "catalog",
+        target_sub_service: "product_category",
+        target_method: "Read",
+        field_name: "category",
+      }
+    ];
+  }
+  optional string gtin = 15;
+  optional int32 stock_level = 16;
+  optional io.restorecommerce.price.Price price = 17;
+  repeated io.restorecommerce.image.Image images = 18;
+  repeated io.restorecommerce.file.File files = 19;
+  optional string stock_keeping_unit = 20;
+  repeated io.restorecommerce.property.Property properties = 21;
+  repeated string tax_ids = 22;
+  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;
+  optional Package package = 27; // size for shipping
 }
+
+message IndividualProductVariantResponse {
+  optional IndividualProductVariant payload = 1;
+  optional io.restorecommerce.status.Status status = 3;
+}
+
+message IndividualProductVariantListResponse {
+  repeated ProductResponse items = 1;
+  optional uint32 total_count = 2;
+  optional io.restorecommerce.status.OperationStatus operation_status = 3;
+}

package/io/restorecommerce/rendering.proto

@@ -3,32 +3,55 @@ syntax = "proto3";
 package io.restorecommerce.rendering;
 
 import "google/protobuf/any.proto";
+import "io/restorecommerce/status.proto";
+import "io/restorecommerce/auth.proto";
 
-message Payload {
-  // json with <key, template> pairs
-  // e.g. { 'subject': ..., 'message':....}
-  optional google.protobuf.Any templates = 1;
-  optional google.protobuf.Any data = 2;  // data to fill template with
-  optional string style_url = 3; // stylesheet URL
+/*
+Microservice definition.
+*/
+service RenderingService {
+  rpc Render (RenderRequestList) returns (RenderResponseList);
+}
 
+message RenderRequest {
   enum Strategy { // style-applying 'strategy'
     INLINE = 0;
     COPY = 1;
   }
-  optional Strategy strategy = 4;  // inlining, copying CSS into <style>, etc...
-  // rendering options JSON object
-  optional google.protobuf.Any options = 5;
-  // content type for rendering such as 'application/html' or 'application/text'
-  optional string content_type = 6;
+
+  message Template {
+    optional string id = 1;  // snippit name
+    optional bytes body = 2;
+    optional string charset = 3;
+  }
+
+  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'
 }
 
-message RenderRequest {
+message RenderRequestList {
   optional string id = 1; // identifies the render request payload
-  // List of templates with associated data and rendering options
-  repeated Payload payloads = 2;
+  repeated RenderRequest items = 2; // List of templates with associated data and rendering options
+  optional io.restorecommerce.auth.Subject subject = 3; 
+}
+
+message RenderResult {
+  optional string id = 1; // snippit name
+  optional bytes body = 2;
+  optional string charset = 3;
 }
 
 message RenderResponse {
-  optional string id = 1;
-  repeated google.protobuf.Any responses = 2;  // error or HTML contents
+ optional RenderResult payload = 1;
+ optional io.restorecommerce.status.Status status = 2;
 }
+
+message RenderResponseList {
+ optional string id = 1;
+ repeated RenderResponse items = 2;
+ optional io.restorecommerce.status.OperationStatus operation_status = 3;
+}

package/io/restorecommerce/template.proto

@@ -25,7 +25,7 @@ service TemplateService {
 }
 
 enum TemplateUseCase {
-  MISCELLANEOUS = 0;
+  MISCELLANEOUS = 0; // may use attributes for use case identication
   INVOICE_PDF = 1;
   INVOICE_EMAIL_BODY = 2;
   INVOICE_EMAIL_SUBJECT = 3;
@@ -35,6 +35,15 @@ 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;
 }
 
 message Deleted {
@@ -68,7 +77,7 @@ message Template {
   optional io.restorecommerce.meta.Meta meta = 2;
   optional string name = 3;
   optional string description = 4;
-  optional TemplateUseCase use_case = 5;
+  optional string use_case = 5; // URN or ENUM to identify what this template is used for
   optional uint32 ordinal = 6; // sort number
   optional string section = 7; // e.g. header, body, footer
   repeated io.restorecommerce.file.File bodies = 8; // e.g. text/html

package/package.json

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