@restorecommerce/protos 0.6.7 → 0.7.0

package/io/restorecommerce/oauth.proto

@@ -4,12 +4,14 @@ package io.restorecommerce.oauth;
 
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/user.proto";
+import "io/restorecommerce/status.proto";
 import "google/protobuf/empty.proto";
 
 service Service {
   rpc AvailableServices(google.protobuf.Empty) returns (ServicesResponse);
   rpc GenerateLinks(google.protobuf.Empty) returns (GenerateLinksResponse);
   rpc ExchangeCode(ExchangeCodeRequest) returns (ExchangeCodeResponse);
+  rpc GetToken(GetTokenRequest) returns (GetTokenResponse);
 }
 
 message ServicesResponse {
@@ -31,3 +33,13 @@ message ExchangeCodeResponse {
   string email = 2;
   io.restorecommerce.auth.Tokens token = 3;
 }
+
+message GetTokenRequest {
+  io.restorecommerce.auth.Subject subject = 1;
+  string service = 2;
+}
+
+message GetTokenResponse {
+  io.restorecommerce.status.Status status = 1;
+  optional string token = 2;
+}

package/io/restorecommerce/options.proto

@@ -0,0 +1,25 @@
+syntax = "proto3";
+
+import "google/protobuf/descriptor.proto";
+
+package io.restorecommerce.options;
+
+extend google.protobuf.FieldOptions {
+  optional Resolver resolver = 31000;
+}
+
+extend google.protobuf.MethodOptions {
+  optional bool is_query = 31001;
+}
+
+extend google.protobuf.ServiceOptions {
+  optional string service_name = 31002;
+}
+
+message Resolver {
+  string target_type = 1;
+  string target_service = 2;
+  string target_sub_service = 3;
+  string target_method = 4;
+  string field_name = 5;
+}

package/io/restorecommerce/order.proto

@@ -6,9 +6,17 @@ 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";
+
+// Used by resolvers
+import "io/restorecommerce/contact_point.proto";
 
 service Service {
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (OrderListResponse);
+  option (io.restorecommerce.options.service_name) = "order";
+
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (OrderListResponse) {
+    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);
@@ -45,8 +53,24 @@ message Order {
   // sum of all the quantity_price will be total_price
   double total_price = 8;
   // shipping address
-  string shipping_contact_point_id = 9;
-  string billing_contact_point_id = 10;
+  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;
 }
 

package/io/restorecommerce/organization.proto

@@ -7,9 +7,18 @@ import "google/protobuf/any.proto";
 import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
+import "io/restorecommerce/options.proto";
+
+// Used by resolvers
+import "io/restorecommerce/address.proto";
+import "io/restorecommerce/contact_point.proto";
 
 service Service {
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (OrganizationListResponse);
+  option (io.restorecommerce.options.service_name) = "organization";
+
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (OrganizationListResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
   rpc Create (OrganizationList) returns (OrganizationListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
   rpc Update (OrganizationList) returns (OrganizationListResponse);
@@ -46,9 +55,33 @@ message OrganizationResponse {
 message Organization {
   string id = 1; /// Organization ID, unique, key
   io.restorecommerce.meta.Meta meta = 2;
-  string address_id = 3; /// Address for the organization
-  string parent_id = 4; //  Hierarchically superior organization; may be null
-  repeated string contact_point_ids = 6; // list of possible legal addresses of different types
+  string address_id = 3 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.address.Address";
+      target_service: "resource";
+      target_sub_service: "address";
+      target_method: "Read";
+      field_name: "address";
+    }
+  ]; /// Address for the organization
+  string parent_id = 4 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.organization.Organization";
+      target_service: "resource";
+      target_sub_service: "organization";
+      target_method: "Read";
+      field_name: "parent";
+    }
+  ]; //  Hierarchically superior organization; may be null
+  repeated string contact_point_ids = 6 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.contact_point.ContactPoint";
+      target_service: "resource";
+      target_sub_service: "contact_point";
+      target_method: "Read";
+      field_name: "contactPoints";
+    }
+  ]; // list of possible legal addresses of different types
   string website = 7;
   string email = 8;
   string logo = 9; // base64; arangoDB does not support blob storage

package/io/restorecommerce/ostorage.proto

@@ -9,12 +9,19 @@ import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/attribute.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/options.proto";
 
 service Service {
-  rpc Get (GetRequest) returns (stream ObjectResponse);
+  option (io.restorecommerce.options.service_name) = "object";
+
+  rpc Get (GetRequest) returns (stream ObjectResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
   rpc Put (stream Object) returns (PutResponse);
   rpc Delete (DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
-  rpc List (ListRequest) returns (ListResponse);
+  rpc List (ListRequest) returns (ListResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
   rpc Copy (CopyRequestList) returns (CopyResponseList);
   rpc Move (MoveRequestList) returns (MoveResponseList);
 }
@@ -185,4 +192,4 @@ message MoveResponseItem {
   string key = 3;
   io.restorecommerce.meta.Meta meta = 4;
   Options options = 5;
-}
+}

package/io/restorecommerce/payment.proto

@@ -2,8 +2,11 @@ syntax = "proto3";
 package io.restorecommerce.payment;
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
- 
+import "io/restorecommerce/options.proto";
+
 service Service {
+  option (io.restorecommerce.options.service_name) = "payment";
+
   // Wrapper for setup_authorization in ActiveMerchant
   rpc SetupAuthorization (SetupRequest) returns (SetupResponse);
 

package/io/restorecommerce/policy.proto

@@ -7,6 +7,7 @@ import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/rule.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
+import "io/restorecommerce/options.proto";
 
 /**
 * A Policy is defined by a set of Rules.
@@ -51,7 +52,11 @@ message PolicyResponse {
 }
 
 service Service {
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (PolicyListResponse);
+  option (io.restorecommerce.options.service_name) = "policy";
+
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (PolicyListResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
   rpc Create (PolicyList) returns (PolicyListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
   rpc Update (PolicyList) returns (PolicyListResponse);

package/io/restorecommerce/policy_set.proto

@@ -1,13 +1,14 @@
 syntax = "proto3";
 
 package io.restorecommerce.policy_set;
- 
+
 import "io/restorecommerce/resource_base.proto";
 import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/policy.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/rule.proto";
 import "io/restorecommerce/status.proto";
+import "io/restorecommerce/options.proto";
 
 message PolicySet {
   string id = 1;
@@ -45,9 +46,13 @@ message PolicySetRQ {
 }
 
 service Service {
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (PolicySetListResponse);
+  option (io.restorecommerce.options.service_name) = "policy_set";
+
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (PolicySetListResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
   rpc Create (PolicySetList) returns (PolicySetListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
   rpc Update (PolicySetList) returns (PolicySetListResponse);
   rpc Upsert (PolicySetList) returns (PolicySetListResponse);
-}
+}

package/io/restorecommerce/price_group.proto

@@ -6,12 +6,13 @@ 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";
 
 // PriceGroup resource
 message PriceGroup {
   string id = 1;
   io.restorecommerce.meta.Meta meta = 2;
-  string name = 3; 
+  string name = 3;
   string description = 4;
 }
 
@@ -37,7 +38,11 @@ message Deleted {
 }
 
 service Service {
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (PriceGroupListResponse);
+  option (io.restorecommerce.options.service_name) = "price_group";
+
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (PriceGroupListResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
   rpc Create (PriceGroupList) returns (PriceGroupListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
   rpc Update (PriceGroupList) returns (PriceGroupListResponse);

package/io/restorecommerce/product.proto

@@ -8,9 +8,17 @@ import "io/restorecommerce/image.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/attribute.proto";
+import "io/restorecommerce/options.proto";
+
+// Used by resolvers
+import "io/restorecommerce/manufacturer.proto";
 
 service Service {
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductListResponse);
+  option (io.restorecommerce.options.service_name) = "product";
+
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductListResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
   rpc Create (ProductList) returns (ProductListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
   rpc Update (ProductList) returns (ProductListResponse);
@@ -32,7 +40,15 @@ message Product {
   string id = 1;
   string name = 2;
   string description = 3;
-  string manufacturer_id = 4;
+  string manufacturer_id = 4 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.manufacturer.Manufacturer";
+      target_service: "catalog";
+      target_sub_service: "manufacturer";
+      target_method: "Read";
+      field_name: "manufacturer";
+    }
+  ];
   string taric_code = 5;
   oneof classification {
     Identifier prototype = 6;

package/io/restorecommerce/product_category.proto

@@ -7,6 +7,10 @@ import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/image.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
+import "io/restorecommerce/options.proto";
+
+// Used by resolvers
+import "io/restorecommerce/price_group.proto";
 
 // ProductCategory resource
 message ProductCategory {
@@ -14,7 +18,15 @@ message ProductCategory {
   io.restorecommerce.meta.Meta meta = 2;
   string name = 3;
   string description = 4;
-  string price_group_id = 5;
+  string price_group_id = 5 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.price_group.PriceGroup";
+      target_service: "catalog";
+      target_sub_service: "price_group";
+      target_method: "Read";
+      field_name: "priceGroup";
+    }
+  ];
   io.restorecommerce.image.Image image = 6;
   Parent parent = 7;
 }
@@ -45,7 +57,11 @@ message Parent {
 }
 
 service Service {
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductCategoryListResponse);
+  option (io.restorecommerce.options.service_name) = "product_category";
+
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductCategoryListResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
   rpc Create (ProductCategoryList) returns (ProductCategoryListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
   rpc Update (ProductCategoryList) returns (ProductCategoryListResponse);

package/io/restorecommerce/product_prototype.proto

@@ -6,12 +6,13 @@ 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";
 
 // ProductPrototype resource
 message ProductPrototype {
   string id = 1;
   io.restorecommerce.meta.Meta meta = 2;
-  string name = 3; 
+  string name = 3;
   string version = 4;
   string description = 5;
   string category_id = 6;
@@ -39,7 +40,11 @@ message Deleted {
 }
 
 service Service {
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductPrototypeListResponse);
+  option (io.restorecommerce.options.service_name) = "product_prototype";
+
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductPrototypeListResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
   rpc Create (ProductPrototypeList) returns (ProductPrototypeListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
   rpc Update (ProductPrototypeList) returns (ProductPrototypeListResponse);

package/io/restorecommerce/role.proto

@@ -6,9 +6,14 @@ 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";
 
 service Service {
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (RoleListResponse);
+  option (io.restorecommerce.options.service_name) = "role";
+
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (RoleListResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
   rpc Create (RoleList) returns (RoleListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
   rpc Update (RoleList) returns (RoleListResponse);

package/io/restorecommerce/rule.proto

@@ -8,7 +8,7 @@ import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/attribute.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/filter.proto";
-
+import "io/restorecommerce/options.proto";
 
 /**
 * Target specified by a Rule or a Request.
@@ -44,7 +44,7 @@ message RuleRQ { // used for `whatIsAllowed` / reverse queries
   Target target = 2;
   Effect effect = 3;
   string condition = 4;
-  ContextQuery context_query = 5; 
+  ContextQuery context_query = 5;
   bool evaluation_cacheable = 6;
 }
 
@@ -74,7 +74,11 @@ message ContextQuery {
 }
 
 service Service {
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (RuleListResponse);
+  option (io.restorecommerce.options.service_name) = "rule";
+
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (RuleListResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
   rpc Create (RuleList) returns (RuleListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
   rpc Update (RuleList) returns (RuleListResponse);

package/io/restorecommerce/tax.proto

@@ -6,12 +6,21 @@ 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";
+
+// Used by resolvers
+import "io/restorecommerce/country.proto";
+import "io/restorecommerce/tax_type.proto";
 
 /*
 * Microservice definition.
 */
 service Service {
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (TaxListResponse);
+  option (io.restorecommerce.options.service_name) = "tax";
+
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (TaxListResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
   rpc Create (TaxList) returns (TaxListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
   rpc Update (TaxList) returns (TaxListResponse);
@@ -42,8 +51,24 @@ message TaxResponse {
 message Tax {
   string id = 1;
   io.restorecommerce.meta.Meta meta = 2;
-  string country_id = 3;
+  string country_id = 3 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.country.Country";
+      target_service: "resource";
+      target_sub_service: "country";
+      target_method: "Read";
+      field_name: "country";
+    }
+  ];
   double rate = 4;
   string variant = 5;
-  string type_id = 6;
+  string type_id = 6 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.tax_type.TaxType";
+      target_service: "resource";
+      target_sub_service: "tax_type";
+      target_method: "Read";
+      field_name: "type";
+    }
+  ];
 }

package/io/restorecommerce/tax_type.proto

@@ -6,12 +6,17 @@ 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 Service {
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (TaxTypeListResponse);
+  option (io.restorecommerce.options.service_name) = "tax_type";
+
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (TaxTypeListResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
   rpc Create (TaxTypeList) returns (TaxTypeListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
   rpc Update (TaxTypeList) returns (TaxTypeListResponse);

package/io/restorecommerce/timezone.proto

@@ -6,12 +6,17 @@ 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 Service {
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (TimezoneListResponse);
+  option (io.restorecommerce.options.service_name) = "timezone";
+
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (TimezoneListResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
   rpc Create (TimezoneList) returns (TimezoneListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
   rpc Update (TimezoneList) returns (TimezoneListResponse);

package/io/restorecommerce/token.proto

@@ -4,13 +4,18 @@ package io.restorecommerce.token;
 
 import "io/restorecommerce/auth.proto";
 import "google/protobuf/any.proto";
+import "io/restorecommerce/options.proto";
 
 /*
 * Microservice definition.
 */
 service Service {
+  option (io.restorecommerce.options.service_name) = "token";
+
   rpc upsert (TokenData) returns (google.protobuf.Any); // creates or upserts ID_token to `Redis` and returns sucess or failure message
-  rpc find (Identifier) returns (google.protobuf.Any); // find id_token using access_token identifier (Return previously stored instance of an oidc-provider model)  
+  rpc find (Identifier) returns (google.protobuf.Any) {
+    option (io.restorecommerce.options.is_query) = true;
+  }; // find id_token using access_token identifier (Return previously stored instance of an oidc-provider model)
   rpc destroy (Identifier) returns (google.protobuf.Any); // removes the id_token from redis
   rpc revokeByGrantId (GrantId) returns (google.protobuf.Any); // Destroy/Drop/Remove a stored id_token by its grantId property reference.
   rpc consume (Identifier) returns (google.protobuf.Any);  // Mark a stored id_token as consumed (not yet expired though!). Future finds for this id should be fulfilled with an object containing additional property named "consumed" with a truthy value (timestamp, date, boolean, etc).
@@ -33,4 +38,4 @@ message Identifier {
 message GrantId {
   string grant_id = 1;
   io.restorecommerce.auth.Subject subject = 2;
-}
+}