@restorecommerce/protos 0.4.11 → 0.5.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.5.0](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@0.4.11...@restorecommerce/protos@0.5.0) (2022-01-28)
+
+
+### Bug Fixes
+
+* **fix generated interfaces: convert snake_case to camelcase:** snake_case to camelCase ([bf78c27](https://github.com/restorecommerce/libs/commit/bf78c27a1e776d716c711c0b633acd7609ca4561))
+
+
+### Features
+
+* **add protos for fulfillment-product solution proposals:** packsol ([ce6f78f](https://github.com/restorecommerce/libs/commit/ce6f78f34a39924aa30c50857ad751b9ac3be396))
+
+
+### BREAKING CHANGES
+
+* **add protos for fulfillment-product solution proposals:** fulfillment.proto, fulfillment-courier.proto and fulfillment-product.proto have
+changed completely
+
+
+
+
+
 ## [0.4.11](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@0.4.10...@restorecommerce/protos@0.4.11) (2021-12-09)
 
 

package/io/restorecommerce/fulfillment.proto

@@ -6,9 +6,9 @@ import "google/protobuf/any.proto";
 import "io/restorecommerce/resource_base.proto";
 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/meta.proto";
 
 /**
 Microservice definition.
@@ -20,25 +20,10 @@ service Service {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (FulfillmentResponseList);
 
   /**
-  Creates but does not execute fulfillment orders
+  Creates and executes fulfillment orders
   */
   rpc Create (FulfillmentRequestList) returns (FulfillmentResponseList);
 
-  /**
-  Updates but does not execute fulfillment orders
-  */
-  rpc Update (FulfillmentRequestList) returns (FulfillmentResponseList);
-
-  /**
-  Upserts but does not execute fulfillment orders
-  */
-  rpc Upsert (FulfillmentRequestList) returns (FulfillmentResponseList);
-
-  /**
-  Executes and Upserts fulfillment orders
-  */
-  rpc Order (FulfillmentRequestList) returns (FulfillmentResponseList);
-
   /**
   Track a batch of fulfillment orders
   */
@@ -47,7 +32,7 @@ service Service {
   /**
   Cancel a batch of fulfillment orders
   */
-  rpc Cancel (CancelRequestList) returns (CancelResultList);
+  rpc Cancel (CancelRequestList) returns (FulfillmentResponseList);
 
   /**
   Delete a batch of fulfillments from the database
@@ -56,17 +41,13 @@ service Service {
 }
 
 enum State {
-  Incomplete = 0;
-  Ordered = 1;
-  Processing = 2;
-  Done=3;
-  Cancelled = 4;
-  Failed = 5;
-}
-
-message Origin {
-  string country = 1;
-  string iso_code = 2;
+  Undefined = 0;
+  Invalid = 1;
+  Ordered = 2;
+  Shipping = 3;
+  Done= 4;
+  Cancelled = 5;
+  Failed = 6;
 }
 
 message Contact {
@@ -76,13 +57,15 @@ message Contact {
 }
 
 message Branch {
-  string branch_number = 1;
-  string post_number = 2;
+  string provider = 1;
+  string branch_number = 2;
+  string post_number = 3;
 }
 
 message Packstation {
-  string station_number = 1;
-  string post_number = 2;
+  string provider = 1;
+  string station_number = 2;
+  string post_number = 3;
 }
 
 message Address {
@@ -98,17 +81,25 @@ message Address {
 }
 
 message Parcel {
-  int32 quantity = 1;
-  float weight = 2;
-  float height = 3;
-  float width = 4;
-  float length = 5;
+  message Item {
+    string item_id = 1;
+    int32 quantity = 2;
+  }
+
+  string product_id = 1;
+  string product_variant_id = 2;
+  repeated Item items = 3;
+  float weight_in_kg = 4;
+  float height_in_cm = 5;
+  float width_in_cm = 6;
+  float length_in_cm = 7;
 }
 
 message Order {
-  repeated Parcel parcels = 1;
-  Address sender = 2;
-  Address receiver = 3;
+  string reference_id = 1;
+  repeated Parcel parcels = 2;
+  Address sender = 3;
+  Address receiver = 4;
   string notify = 5;
 }
 
@@ -118,24 +109,15 @@ message Label {
     string pdf = 2;
     string png = 3;
   }
-  string shipment_id = 4; //filled on Order
+  string shipment_number = 4; //filled on Order
   State state = 5; //update by Track
   io.restorecommerce.status.Status status = 6; //API status
 }
 
-message Event {
-  io.restorecommerce.status.Status status = 1;
-  string timestamp = 2;
-  string location = 3;
-  google.protobuf.Any details = 4;
-}
-
 message FulfillmentRequest {
   string id = 1;
-  string courier_id = 2;
-  string product_id = 3;
-  Order order = 4;
-  io.restorecommerce.meta.Meta meta = 5;
+  Order order = 2;
+  io.restorecommerce.meta.Meta meta = 3;
 }
 
 message FulfillmentRequestList {
@@ -149,11 +131,10 @@ This is the message how it get stored to the database
 */
 message Fulfillment {
   string id = 1;
-  string courier_id = 2;
-  string product_id = 3;
-  Order order = 4;
-  io.restorecommerce.meta.Meta meta = 5;
-  Label label = 6; //filled on Order
+  Order order = 2;
+  io.restorecommerce.meta.Meta meta = 3;
+  repeated Label labels = 4; //filled by service
+  bool fulfilled = 5;
 }
 
 message FulfillmentResponse {
@@ -168,8 +149,9 @@ message FulfillmentResponseList {
 }
 
 message TrackingRequest {
-  string order_id = 1;
-  google.protobuf.Any options = 2;
+  string fulfillment_id = 1;
+  repeated string shipment_numbers = 2; //optional
+  google.protobuf.Any options = 3;
 }
 
 message TrackingRequestList {
@@ -177,15 +159,28 @@ message TrackingRequestList {
   io.restorecommerce.auth.Subject subject = 2;
 }
 
-message Tracking {
-  string fulfillment_id = 1;
-  repeated Event events = 2;
+message Event {
+  int64 timestamp = 1;
+  string location = 2;
   google.protobuf.Any details = 3;
   io.restorecommerce.status.Status status = 4;
 }
 
+message Tracking {
+  string shipment_number = 1;
+  repeated Event events = 3;
+  google.protobuf.Any details = 4;
+  io.restorecommerce.status.Status status = 5;
+}
+
+message TrackingResult {
+  Fulfillment fulfillment = 1;
+  repeated Tracking tracks = 2;
+  io.restorecommerce.status.Status status = 3;
+}
+
 message TrackingResultList {
-  repeated Tracking items = 1;
+  repeated TrackingResult items = 1;
   io.restorecommerce.status.OperationStatus operation_status = 2;
 }
 
@@ -194,11 +189,6 @@ message CancelRequestList {
   io.restorecommerce.auth.Subject subject = 2;
 }
 
-message CancelResultList {
-  repeated io.restorecommerce.status.Status items = 1;
-  io.restorecommerce.status.OperationStatus operation_status = 2;
-}
-
 message Deleted {
   string id = 1;
 }

package/io/restorecommerce/fulfillment_courier.proto

@@ -2,48 +2,48 @@ syntax = "proto3";
 
 package io.restorecommerce.fulfillment_courier;
 
+import "google/protobuf/any.proto";
 import "io/restorecommerce/resource_base.proto";
 import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
-import "google/protobuf/any.proto";
 
 /**
 Microservice defination   
 */
 
 service Service {
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (CourierResponseList);
-  rpc Create (CourierList) returns (CourierResponseList);
-  rpc Update (CourierList) returns (CourierResponseList);
-  rpc Upsert (CourierList) returns (CourierResponseList);
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (FulfillmentCourierResponseList);
+  rpc Create (FulfillmentCourierList) returns (FulfillmentCourierResponseList);
+  rpc Update (FulfillmentCourierList) returns (FulfillmentCourierResponseList);
+  rpc Upsert (FulfillmentCourierList) returns (FulfillmentCourierResponseList);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
 }
 
-message Courier {
+message FulfillmentCourier {
   string id = 1;
   string name = 4;
   string description = 5;
   string logo = 6;
   string website = 7;
   string stub_type = 8;
-  google.protobuf.Any configuration = 9;
-  io.restorecommerce.meta.Meta meta = 10;
+  google.protobuf.Any configuration = 10;
+  io.restorecommerce.meta.Meta meta = 11;
 }
 
-message CourierList  {
-  repeated Courier items = 1;
+message FulfillmentCourierList {
+  repeated FulfillmentCourier items = 1;
   uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
-message CourierResponse  {
-  Courier payload = 1;
+message FulfillmentCourierResponse {
+  FulfillmentCourier payload = 1;
   io.restorecommerce.status.Status status = 2;
 }
 
-message CourierResponseList  {
-  repeated CourierResponse items = 1;
+message FulfillmentCourierResponseList {
+  repeated FulfillmentCourierResponse items = 1;
   uint32 total_count = 2;
   io.restorecommerce.status.OperationStatus operation_status = 3;
 }

package/io/restorecommerce/fulfillment_product.proto

@@ -6,44 +6,37 @@ import "io/restorecommerce/resource_base.proto";
 import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
-import "io/restorecommerce/fulfillment.proto";
-import "io/restorecommerce/country.proto";
 import "io/restorecommerce/attribute.proto";
+import "io/restorecommerce/order.proto";
+import "io/restorecommerce/fulfillment.proto";
+
 
 /**
 Microservice defination
 */
 
 service Service {
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductResponseList);
-  rpc Find (QueryList) returns (ProductResponseList);
-/*      - start_address
-      - destination_address
-      - good[]:
-        - quantity
-        - weight
-        - height
-        - width
-        - depth*/
-
-  rpc Create (ProductList) returns (ProductResponseList);
-  rpc Update (ProductList) returns (ProductResponseList);
-  rpc Upsert (ProductList) returns (ProductResponseList);
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (FulfillmentProductResponseList);
+  rpc Find (QueryList) returns (PackingSolutionResponseList);
+  rpc Create (FulfillmentProductList) returns (FulfillmentProductResponseList);
+  rpc Update (FulfillmentProductList) returns (FulfillmentProductResponseList);
+  rpc Upsert (FulfillmentProductList) returns (FulfillmentProductResponseList);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
 }
 
-message Good {
-  double quantity = 1;
-  double weight = 2;
-  double height = 3;
-  double width = 4;
-  double length = 5;
+message Preferences {
+  repeated io.restorecommerce.attribute.Attribute couriers = 1; //ID, name or type
+  float pricing = 2;
+  float compactness = 3;
+  float homogeneity = 4;
 }
 
 message Query {
   io.restorecommerce.fulfillment.Address sender = 1;
-  io.restorecommerce.fulfillment.Address receiver  = 2;
-  repeated Good good = 3;
+  io.restorecommerce.fulfillment.Address receiver = 2;
+  repeated io.restorecommerce.order.Item goods = 3;
+  Preferences preferences = 4;
+  string reference_id = 5;
 }
 
 message QueryList {
@@ -52,16 +45,16 @@ message QueryList {
   io.restorecommerce.auth.Subject subject = 3;
 }
 
-message Product {
+message FulfillmentProduct {
   string id = 1;
   string name = 2;
   string description = 3;
   string courier_id = 4;
-  repeated io.restorecommerce.country.Country start_country = 5;
-  repeated string start_zone = 6;
-  repeated io.restorecommerce.country.Country destination_country = 7;
-  repeated string destination_zone = 8;
-  repeated string tax_id = 9;
+  //repeated io.restorecommerce.country.Country start_country = 5;
+  repeated string start_zones = 6;
+  //repeated io.restorecommerce.country.Country destination_country = 7;
+  repeated string destination_zones = 8;
+  repeated string tax_ids = 9;
   repeated io.restorecommerce.attribute.Attribute attributes = 10;
   repeated Variant variants = 11;
   io.restorecommerce.meta.Meta meta = 12;
@@ -79,19 +72,39 @@ message Variant {
   double max_volume = 9;
 }
 
-message ProductList {
-  repeated Product items = 1;
+message FulfillmentProductList {
+  repeated FulfillmentProduct items = 1;
   uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
-message ProductResponse {
-  Product payload = 1;
+message FulfillmentProductResponse {
+  FulfillmentProduct payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message FulfillmentProductResponseList {
+  repeated FulfillmentProductResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message PackingSolution {
+  string reference_id = 1;
+  float price = 2;
+  float compactness = 3;
+  float homogeneity = 4;
+  float score = 5;
+  repeated io.restorecommerce.fulfillment.Parcel parcels = 6;
+}
+
+message PackingSolutionResponse {
+  repeated PackingSolution solutions = 1;
   io.restorecommerce.status.Status status = 2;
 }
 
-message ProductResponseList {
-  repeated ProductResponse items = 1;
+message PackingSolutionResponseList {
+  repeated PackingSolutionResponse items = 1;
   uint32 total_count = 2;
   io.restorecommerce.status.OperationStatus operation_status = 3;
 }

package/io/restorecommerce/graph.proto

@@ -1,8 +1,10 @@
 syntax = "proto3";
 package io.restorecommerce.graph;
+
 import "google/protobuf/any.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
+import "io/restorecommerce/resource_base.proto";
 
 // Service provides the CRUD operations
 service Service {
@@ -10,69 +12,81 @@ service Service {
 }
 
 message TraversalRequest {
-  message StartVertices {
-    repeated string vertices = 1;
-  }
-
   // Document handle either _id or _key value
   oneof vertex {
-    string start_vertex = 1;
-    StartVertices start_vertices = 2;
+    Vertices vertices = 1;
+    Collection collection = 2;
   }
-
-  // Filter based on fieldName|operation, value|list
   Options opts = 3;
-  string collection_name = 4;
-  string edge_name = 5;
-  bool data = 6;
-  bool path = 7;
-  bool aql = 8;
-  io.restorecommerce.auth.Subject subject = 9;
+  bool path = 4;
+  io.restorecommerce.auth.Subject subject = 5;
+  repeated Filters filters = 6;
 }
 
-message TraversalResponse {
-  repeated VertexFields vertex_fields = 1;
-  google.protobuf.Any paths = 2;
-  google.protobuf.Any data = 3;
-  io.restorecommerce.status.OperationStatus operation_status = 4;
+message Vertices {
+  string collection_name = 1;
+  repeated string start_vertex_id = 2;
 }
 
-message VertexFields {
-  string id = 1;
-  string key = 2;
-  string rev = 3;
+message Collection {
+  string collection_name = 1;
+  uint32 limit = 2;
+  uint32 offset = 3;
+  repeated io.restorecommerce.resourcebase.Sort sort = 4;
 }
 
 message Options {
- string sort = 1; // JS code
- string direction = 2; // either inbound or outbound
- uint32 min_depth = 3; // ANDed with any existing filters): visits only nodes in at least the given depth
- string start_vertex = 4; // id of the startVertex
- string visitor = 5; // JS code
- string item_order = 6; // item iteration order can be "forward" or "backward"
- string strategy = 7; // traversal strategy can be "depthfirst" or "breadthfirst"
- repeated Filter filter = 8; // JS code
- string init = 9; // JS code
- uint32 max_iterations = 10; // maximum number of iterations in each traversal
- uint32 max_depth = 11; // ANDed with any existing filters visits only nodes in at most the given depth
- Uniqueness uniqueness = 12; // specifies uniqueness for vertices and edges visited
- string order = 13; //  "preorder", "postorder" or "preorder-expander"
- string graph_name = 14; // name of graph that contains the edges
- repeated Expander expander = 15; // JS code
- string edge_collection = 16; // name of the collection that contains the edges
- bool lowest_common_ancestor = 17;
+ repeated string include_vertex = 1; // to include vertices
+ repeated string exclude_vertex = 2; // to exclude vertices
+ repeated string include_edge = 3; // to include vertices
+ repeated string exclude_edge = 4; // to exclude vertices
+ Direction direction = 5; // either inbound or outbound, defaults to outbound direction
+ enum Direction {
+   OUTBOUND = 0;
+   INBOUND = 1;
+ }
 }
 
-message Filter {
-  string vertex = 1; // exclude these vertices
-}
 
-message Expander {
-  string edge = 1; // expand these edges
-  string direction = 2;
+message Filters {
+  string entity = 1; // entity on which the filters are applied
+  string edge = 2; // if edge is specified depending on the direction filter are applied only for those entities
+  repeated Filter filter = 3;
+  enum Operator {
+    and = 0;
+    or = 1;
+  }
+  Operator operator = 4;
 }
 
-message Uniqueness {
-  string vertices = 1; // "none"|"global"|"path" for unique vertices
-  string edges = 2; // "none"|"global"|"path" for unique edges
+message Filter {
+  string field = 1;
+  enum Operation {
+    eq = 0;
+    lt = 1;
+    lte = 2;
+    gt = 3;
+    gte = 4;
+    isEmpty = 5;
+    iLike = 6;
+    in = 7;
+    neq = 8;
+  }
+  Operation operation = 2;
+  string value = 3;
+  enum ValueType {
+    STRING = 0; // default value type if not specified
+    NUMBER = 1;
+    BOOLEAN = 2;
+    DATE = 3;
+    ARRAY = 4;
+  }
+  ValueType type = 4;
+  repeated Filters filters = 5;
 }
+
+message TraversalResponse {
+  google.protobuf.Any data = 1; // vertices
+  google.protobuf.Any paths = 2; // traversed vertices paths
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@restorecommerce/protos",
-  "version": "0.4.11",
+  "version": "0.5.0",
   "description": "Protobuf descriptors for Restorecommerce services",
   "author": "n-fuse GmbH",
   "repository": {
@@ -15,5 +15,5 @@
     "protobufs"
   ],
   "scripts": {},
-  "gitHead": "162ea83a0b06d629c84f760e69bb07ca412800fe"
+  "gitHead": "39da173ebfb2496f76bd0cb8f041925b2be775ea"
 }