@restorecommerce/protos 1.0.0 → 2.0.0

package/CHANGELOG.md

@@ -3,6 +3,39 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.0.0](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@1.1.0...@restorecommerce/protos@2.0.0) (2022-10-12)
+
+
+### Code Refactoring
+
+* **protos:** refactor protos for fulfillment-srv, ordering-srv, ready for migration tests ([bf8bfd3](https://github.com/restorecommerce/libs/commit/bf8bfd3a00e614857f6f4be35fb00224634ed066))
+
+
+### BREAKING CHANGES
+
+* **protos:** Address has new fields. Compatiblity must be checked.
+
+
+
+
+
+# [1.1.0](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@1.0.0...@restorecommerce/protos@1.1.0) (2022-10-04)
+
+
+### Bug Fixes
+
+* **protos:** added timezone on Job cron repeat options. ([d25a5c0](https://github.com/restorecommerce/libs/commit/d25a5c0740d8f04102691a5eb3b4c5745fbb75ad))
+* **protos:** restore subject id for auth subject ([150e663](https://github.com/restorecommerce/libs/commit/150e663c0c090721da9b7ce028714d5df7994972))
+
+
+### Features
+
+* **facade:** add subscriptions ([d9006e9](https://github.com/restorecommerce/libs/commit/d9006e9ebcd1522a67373f8ca8bfa751c551b36f))
+
+
+
+
+
 # [1.0.0](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@0.7.2...@restorecommerce/protos@1.0.0) (2022-08-25)
 
 

package/io/restorecommerce/address.proto

@@ -47,12 +47,43 @@ message AddressResponse {
   io.restorecommerce.status.Status status = 2;
 }
 
-message Address {
-  message GeoPoint {
-    double latitude = 1;
-    double longitude = 2;
-  }
+message GeoPoint {
+  double latitude = 1;
+  double longitude = 2;
+}
+
+message AddressAddition {
+  string field1 = 1;
+  string field2 = 2;
+}
+
+message BusinessAddress {
+  string name = 1;
+}
+
+message ResidentialAddress {
+  string title = 1;
+  string given_name = 2;
+  string mid_name = 3;
+  string family_name = 4;
+}
 
+message PackStation {
+  string provider = 1;
+  string station_number = 2;
+  string post_number = 3;
+}
+
+/**
+  Uses by Order-Srv and Fulfillment-Srv
+**/
+message ContactPerson {
+  string name = 1;
+  string email = 2;
+  string phone = 3;
+}
+
+message Address {
   string id = 1;
   io.restorecommerce.meta.Meta meta = 2;
   string postcode = 3;
@@ -65,17 +96,16 @@ message Address {
       field_name: "country",
     }
   ];
-  string locality = 5;
-  string street = 6;
-  string region = 7;
-
-  GeoPoint geo_coordinates = 8;
-  double altitude = 9;
-  string building_number = 10;
-  AddressAddition address_addition = 11;
-}
-
-message AddressAddition {
-  string field1 = 1;
-  string field2 = 2;
-}
+  string locality = 6;
+  string street = 7;
+  string region = 8;
+  GeoPoint geo_coordinates = 9;
+  double altitude = 10;
+  string building_number = 11;
+  AddressAddition address_addition = 12;
+  oneof type {
+    BusinessAddress business_address = 13;
+    ResidentialAddress residential_address = 14;
+    PackStation pack_station = 15;
+  }
+}

package/io/restorecommerce/auth.proto

@@ -8,11 +8,9 @@ import "io/restorecommerce/attribute.proto";
  */
 message Subject {
   string id = 1; // user id
-  string scope = 2; // target scope
-  repeated RoleAssociation role_associations = 3; //  role_associations of user creating the user
-  repeated HierarchicalScope hierarchical_scopes = 4; // HR scope of user creating the User
-  bool unauthenticated = 5; // for unauthenticated context
-  string token = 6;
+  string scope = 2; // target scope (ID of the target scoping entity)
+  bool unauthenticated = 3; // for unauthenticated context
+  string token = 4;
 }
 
 message Tokens {

package/io/restorecommerce/contact_point.proto

@@ -59,9 +59,9 @@ message ContactPoint {
       field_name: "physicalAddress",
     }
   ];
-  string website = 4;
-  string email = 5;
-  string contact_point_type_id = 6 [
+  string website = 5;
+  string email = 6;
+  string contact_point_type_id = 7 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.contact_point_type.ContactPointType",
       target_service: "resource",

package/io/restorecommerce/fulfillment.proto

@@ -8,7 +8,6 @@ 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/options.proto";
 
 /**
@@ -25,9 +24,24 @@ service Service {
   };
 
   /**
-  Creates and executes fulfillment orders
+  Creates fulfillment orders
   */
-  rpc Create (FulfillmentRequestList) returns (FulfillmentResponseList);
+  rpc Create (FulfillmentList) returns (FulfillmentResponseList);
+
+  /**
+  Updates fulfillment orders unless Status is beyond Ordered
+  */
+  rpc Update (FulfillmentList) returns (FulfillmentResponseList);
+
+  /**
+  Creates or Updates fulfillment orders unless Status is beyond Ordered
+  */
+  rpc Upsert (FulfillmentList) returns (FulfillmentResponseList);
+
+  /**
+  Creates, Executes and Updates fulfillment orders against API
+  */
+  rpc Submit (FulfillmentList) returns (FulfillmentResponseList);
 
   /**
   Track a batch of fulfillment orders
@@ -50,50 +64,38 @@ service Service {
 enum State {
   Undefined = 0;
   Invalid = 1;
-  Ordered = 2;
-  Shipping = 3;
-  Done= 4;
-  Cancelled = 5;
-  Failed = 6;
-}
-
-message Contact {
-  string name = 1;
-  string email = 2;
-  string phone = 3;
-}
-
-message Branch {
-  string provider = 1;
-  string branch_number = 2;
-  string post_number = 3;
+  Failed = 2;
+  Cancelled = 3;
+  Created = 4;
+  Submitted = 5;
+  Shipping = 6;
+  Done = 7;
 }
 
-message Packstation {
-  string provider = 1;
-  string station_number = 2;
-  string post_number = 3;
+message ShippingAddress {
+  io.restorecommerce.address.Address address = 1;
+  io.restorecommerce.address.ContactPerson contact_person = 2;
 }
 
-message Address {
-  string title = 1;
-  repeated string name = 2;
-  oneof type {
-    io.restorecommerce.address.Address address = 3;
-    Packstation packstation = 4;
-    Branch branch = 5;
-  };
-  io.restorecommerce.country.Country country = 6;
-  Contact contact = 7;
+message Item {
+  //Catalog item!
+  string item_id = 1;
+  string name = 2;
+  string description = 3;
+  string taric_code = 4;
+  int32 quantity = 5;
 }
 
 message Parcel {
-  message Item {
-    string item_id = 1;
-    int32 quantity = 2;
-  }
-
-  string product_id = 1;
+  string product_id = 1 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.fulfillment_product.FulfillmentProduct",
+      target_service: "resource",
+      target_sub_service: "fulfillment_product",
+      target_method: "Read",
+      field_name: "product",
+    }
+  ];
   string product_variant_id = 2;
   repeated Item items = 3;
   float weight_in_kg = 4;
@@ -102,14 +104,6 @@ message Parcel {
   float length_in_cm = 7;
 }
 
-message Order {
-  string reference_id = 1;
-  repeated Parcel parcels = 2;
-  Address sender = 3;
-  Address receiver = 4;
-  string notify = 5;
-}
-
 message Label {
   oneof type {
     string url = 1;
@@ -121,27 +115,37 @@ message Label {
   io.restorecommerce.status.Status status = 6; //API status
 }
 
-message FulfillmentRequest {
-  string id = 1;
-  Order order = 2;
-  io.restorecommerce.meta.Meta meta = 3;
-}
-
-message FulfillmentRequestList {
-  repeated FulfillmentRequest items = 1;
-  uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+message Order {
+  string reference_id = 1;
+  repeated Parcel parcels = 2;
+  ShippingAddress sender = 3;
+  ShippingAddress receiver = 4;
+  string notify = 5;
 }
 
 /**
 This is the message how it get stored to the database
 */
 message Fulfillment {
+  option (restorecommerce.options.kafka_subscriber) = {
+    plural: "fulfillment"
+    topic: "io.restorecommerce.fulfillment.resource"
+    created: "fulfillmentCreated"
+    updated: "fulfillmentUpdated"
+    deleted: "fulfillmentDeleted"
+  };
+
   string id = 1;
   Order order = 2;
   io.restorecommerce.meta.Meta meta = 3;
   repeated Label labels = 4; //filled by service
-  bool fulfilled = 5;
+  State state = 5;
+}
+
+message FulfillmentList {
+  repeated Fulfillment items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
 }
 
 message FulfillmentResponse {
@@ -181,7 +185,15 @@ message Tracking {
 }
 
 message TrackingResult {
-  Fulfillment fulfillment = 1;
+  Fulfillment fulfillment = 1 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.fulfillment.Fulfillment",
+      target_service: "resource",
+      target_sub_service: "fulfillment",
+      target_method: "Read",
+      field_name: "fulfillment",
+    }
+  ];
   repeated Tracking tracks = 2;
   io.restorecommerce.status.Status status = 3;
 }

package/io/restorecommerce/fulfillment_courier.proto

@@ -26,6 +26,14 @@ service Service {
 }
 
 message FulfillmentCourier {
+  option (restorecommerce.options.kafka_subscriber) = {
+    plural: "fulfillmentCouriers"
+    topic: "io.restorecommerce.fulfillment_courier.resource"
+    created: "fulfillmentCourierCreated"
+    updated: "fulfillmentCourierUpdated"
+    deleted: "fulfillmentCourierDeleted"
+  };
+
   string id = 1;
   string name = 4;
   string description = 5;

package/io/restorecommerce/fulfillment_product.proto

@@ -7,17 +7,22 @@ import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/attribute.proto";
-import "io/restorecommerce/order.proto";
+import "io/restorecommerce/fulfillment_courier.proto";
 import "io/restorecommerce/fulfillment.proto";
 
-
 /**
 Microservice defination
 */
 
 service Service {
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (FulfillmentProductResponseList);
-  rpc Find (QueryList) returns (PackingSolutionResponseList);
+  option (io.restorecommerce.options.service_name) = "fulfillment_product";
+
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (FulfillmentProductResponseList) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
+  rpc Find (QueryList) returns (PackingSolutionResponseList) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
   rpc Create (FulfillmentProductList) returns (FulfillmentProductResponseList);
   rpc Update (FulfillmentProductList) returns (FulfillmentProductResponseList);
   rpc Upsert (FulfillmentProductList) returns (FulfillmentProductResponseList);
@@ -34,7 +39,7 @@ message Preferences {
 message Query {
   io.restorecommerce.fulfillment.Address sender = 1;
   io.restorecommerce.fulfillment.Address receiver = 2;
-  repeated io.restorecommerce.order.Item goods = 3;
+  repeated io.restorecommerce.fulfillment.Item goods = 3;
   Preferences preferences = 4;
   string reference_id = 5;
 }
@@ -46,13 +51,27 @@ message QueryList {
 }
 
 message FulfillmentProduct {
+  option (restorecommerce.options.kafka_subscriber) = {
+    plural: "fulfillmentProduct"
+    topic: "io.restorecommerce.fulfillment_product.resource"
+    created: "fulfillmentProductCreated"
+    updated: "fulfillmentProductUpdated"
+    deleted: "fulfillmentProductDeleted"
+  };
+
   string id = 1;
   string name = 2;
   string description = 3;
-  string courier_id = 4;
-  //repeated io.restorecommerce.country.Country start_country = 5;
+  string courier_id = 4 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.fulfillment_courier.FulfillmentCourier",
+      target_service: "resource",
+      target_sub_service: "fulfillment_courier",
+      target_method: "Read",
+      field_name: "courier",
+    }
+  ];
   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;

package/io/restorecommerce/job.proto

@@ -96,11 +96,11 @@ message Repeat {
   string endDate = 4;
   uint32 count = 5;
   string jobId = 6; // To override the job ID - by default, the job ID is a unique generated by bull
+  string tz = 7; // time zone
 }
 
 // Data which is stored within a job instance
 message Data {
-  string timezone = 1;
   google.protobuf.Any payload = 2; // optional variable payload
   io.restorecommerce.meta.Meta meta = 3;
   string subject_id = 4; // id of job creator

package/io/restorecommerce/options.proto

@@ -23,3 +23,15 @@ message Resolver {
   string target_method = 4;
   string field_name = 5;
 }
+
+extend google.protobuf.MessageOptions {
+  KafkaSubscription kafka_subscriber = 31003;
+}
+
+message KafkaSubscription {
+  string plural = 1;
+  string topic = 2;
+  string created = 3;
+  string updated = 4;
+  string deleted = 5;
+}

package/io/restorecommerce/order.proto

@@ -7,9 +7,9 @@ import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/options.proto";
+import "io/restorecommerce/address.proto";
+import "io/restorecommerce/fulfillment.proto";
 
-// Used by resolvers
-import "io/restorecommerce/contact_point.proto";
 
 service Service {
   option (io.restorecommerce.options.service_name) = "order";
@@ -18,65 +18,23 @@ service Service {
     option (io.restorecommerce.options.is_query) = true;
   };
   rpc Create (OrderList) returns (OrderListResponse);
-  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
   rpc Update (OrderList) returns (OrderListResponse);
   rpc Upsert (OrderList) returns (OrderListResponse);
-  rpc TriggerFulfillment (OrderDataList) returns (FulfillmentResults);
-}
-
-
-message OrderList {
-  repeated Order items = 1;
-  uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
-}
-
-message OrderListResponse {
-  repeated OrderResponse items = 1;
-  uint32 total_count = 2;
-  io.restorecommerce.status.OperationStatus operation_status = 3;
-}
-
-message OrderResponse {
-  Order payload = 1;
-  io.restorecommerce.status.Status status = 2;
-}
-
-message Order {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;
-  string description = 4;
-  string status = 5;
-  string customer_reference = 6;
-  repeated Items items = 7;
-  // sum of all the quantity_price will be total_price
-  double total_price = 8;
-  // shipping address
-  string shipping_contact_point_id = 9 [
-    (io.restorecommerce.options.resolver) = {
-      target_type: ".io.restorecommerce.contact_point.ContactPoint",
-      target_service: "resource",
-      target_sub_service: "contact_point",
-      target_method: "Read",
-      field_name: "shippingContactPoint",
-    }
-  ];
-  string billing_contact_point_id = 10 [
-    (io.restorecommerce.options.resolver) = {
-      target_type: ".io.restorecommerce.contact_point.ContactPoint",
-      target_service: "resource",
-      target_sub_service: "contact_point",
-      target_method: "Read",
-      field_name: "billingContactPoint",
-    }
-  ];
-  double total_weight_in_kg = 11;
+  rpc Submit (OrderList) returns (OrderListResponse);
+  rpc Cancel (CancelRequestList) returns (OrderListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc TriggerFulfillment (TriggerFulfillmentRequestList) returns (io.restorecommerce.status.Status);
 }
 
-message Items {
-  double quantity_price = 1;
-  Item item = 2;
+enum State {
+  Undefined = 0;
+  Invalid = 1;
+  Failed = 2;
+  Cancelled = 3;
+  Created = 4;
+  Submitted = 5;
+  Shipping = 6;
+  Done = 7;
 }
 
 message Item {
@@ -91,56 +49,86 @@ message Item {
   int32 quantity = 8;
   int32 vat = 9;
   double price = 10;
-  string item_type = 11;
-  double taric_code = 12;
-  string stock_keeping_unit = 13;
-  double weight_in_kg = 14;
-  int32 length_in_cm = 15;
-  int32 width_in_cm = 16;
-  int32 height_in_cm = 17;
+  double quantity_price = 11;
+  string item_type = 12;
+  double taric_code = 13;
+  string stock_keeping_unit = 14;
+  double weight_in_kg = 15;
+  int32 length_in_cm = 16;
+  int32 width_in_cm = 17;
+  int32 height_in_cm = 18;
 }
 
-message Deleted {
+/**
+  Database Entity
+*/
+message Order {
+  option (restorecommerce.options.kafka_subscriber) = {
+    plural: "orders"
+    topic: "io.restorecommerce.orders.resource"
+    created: "orderCreated"
+    updated: "orderUpdated"
+    deleted: "orderDeleted"
+  };
+
   string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string name = 3;
+  string description = 4;
+  State state = 5;
+  string customer_reference = 6;
+  repeated Item items = 7;
+  double total_price = 8;
+  io.restorecommerce.address.Address shipping_address = 11;
+  io.restorecommerce.address.Address billing_address = 13;
+  string billing_email = 14;
+  io.restorecommerce.address.ContactPerson contact_person = 15;
+  string notification_email = 16;
+  repeated string fulfillment_ids = 17;
 }
 
-message OrderDataList {
-  repeated OrderData order_data = 1;
-  io.restorecommerce.meta.Meta meta = 2;
+message ShippingDetails {
+  string export_type = 1;
+  string export_description = 2;
+  string invoice_number = 3;
+  io.restorecommerce.address.Address sender_address = 5;
+  io.restorecommerce.address.ContactPerson contact_person = 15;
 }
 
-message OrderData {
-  string order_id = 1;
-  repeated Shipments shipments = 2;
+message TriggerFulfillmentRequest {
+  Order order = 1;
+  ShippingDetails shipping_details = 2;
+  repeated io.restorecommerce.fulfillment.Parcel parcels = 3;
 }
 
-message Shipments {
-  double total_weight_in_kg = 1;
-  // below properties are used for international packaging
-  double individual_weight_in_kg = 2; // each items weight
-  int32 amount = 3; // number of items
-  string export_type = 4;
-  string export_description = 5;
-  string customs_tariff_number = 6;
-  string invoice_number = 7;
-  double customs_value = 8;
+message TriggerFulfillmentRequestList {
+  repeated TriggerFulfillmentRequest items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
 }
 
-message FulfillmentResults {
-  repeated ResponseDetailsList fulfillmentResults =1;
+message OrderList {
+  repeated Order items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
 }
 
-message ResponseDetailsList {
-  OrderStatus Status = 1;
-  ErrorList error = 2;
+message OrderListResponse {
+  repeated OrderResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
 }
 
-message OrderStatus {
-  string OrderId = 1;
-  string OrderStatus =2;
+message OrderResponse {
+  Order payload = 1;
+  io.restorecommerce.status.Status status = 2;
 }
 
-message ErrorList {
-  repeated string code = 1;
-  repeated string message = 2;
+message CancelRequestList {
+  repeated string ids = 1;
+  io.restorecommerce.auth.Subject subject = 2;
 }
+
+message Deleted {
+  string id = 1;
+}

package/io/restorecommerce/resource_base.proto

@@ -66,6 +66,12 @@ message FilterOp {
   Operator operator = 2;
 }
 
+message Search {
+  string search = 1; // search string
+  repeated string fields = 2; // list of fields to be searched on entity (if not specified all indexed fields will be searched)
+  bool case_sensitive = 3; // default search is case insensitive
+}
+
 message ReadRequest {
   uint32 offset = 1;
   uint32 limit = 2;
@@ -76,7 +82,6 @@ message ReadRequest {
 
   /// Fields selector
   repeated FieldFilter field = 5;
-  repeated string search = 6;
 
   /** Check the query parameters of HTTP request.
     * If query parameter `locales` is given,
@@ -90,6 +95,7 @@ message ReadRequest {
   repeated string custom_queries = 8;
   google.protobuf.Any custom_arguments = 9;
   io.restorecommerce.auth.Subject subject = 10;
+  Search search = 11;
 }
 
 message DeleteRequest {
@@ -98,6 +104,8 @@ message DeleteRequest {
   /// Delete specified documents
   repeated string ids = 2;
   io.restorecommerce.auth.Subject subject = 3;
+  repeated string view = 4; // list of views to be dropped
+  repeated string analyzer = 5; // list of analyzers to be deleted
 }
 
 message DeleteResponse {

package/io/restorecommerce/search.proto

@@ -3,9 +3,12 @@ package io.restorecommerce.search;
 
 import "google/protobuf/any.proto";
 import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/options.proto";
 
 // Service provides the CRUD operations
 service Service {
+  option (io.restorecommerce.options.service_name) = "search";
+
   rpc Search (SearchRequest) returns (SearchResponse);
 }
 

package/io/restorecommerce/user.proto

@@ -258,6 +258,14 @@ message FindByRoleRequest {
  * A User resource.
  */
 message User {
+  option (restorecommerce.options.kafka_subscriber) = {
+    plural: "users"
+    topic: "io.restorecommerce.users.resource"
+    created: "userCreated"
+    updated: "userUpdated"
+    deleted: "userDeleted"
+  };
+
   string id = 1; /// User ID, unique, key
   io.restorecommerce.meta.Meta meta = 2;
   string name = 3; // The name of the user, can be used for login

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@restorecommerce/protos",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Protobuf descriptors for Restorecommerce services",
   "author": "n-fuse GmbH",
   "repository": {
@@ -15,5 +15,5 @@
     "protobufs"
   ],
   "scripts": {},
-  "gitHead": "2b25803ec9494c298f4f008a55485bc201c83bb8"
+  "gitHead": "120df12bc8544a9803f155daf6b2241733a31cc1"
 }