@restorecommerce/protos 2.0.2 → 3.0.0

package/io/restorecommerce/resource_base.proto

@@ -17,8 +17,8 @@ service Service {
 }
 
 message FieldFilter {
-  string name = 1;
-  bool include = 2;
+  optional string name = 1;
+  optional bool include = 2;
 }
 
 message Sort {
@@ -28,7 +28,7 @@ message Sort {
     DESCENDING = 2;
   }
   string field = 1;
-  SortOrder order = 2;
+  optional SortOrder order = 2;
 }
 
 message Filter {
@@ -53,7 +53,7 @@ message Filter {
     DATE = 3;
     ARRAY = 4;
   }
-  ValueType type = 4;
+  optional ValueType type = 4;
   repeated io.restorecommerce.filter.FilterOp filters = 5; // for nested filtering and to make optional its in separate filter.proto file
 }
 
@@ -63,18 +63,18 @@ message FilterOp {
     and = 0;
     or = 1;
   }
-  Operator operator = 2;
+  optional Operator operator = 2;
 }
 
 message Search {
-  string search = 1; // search string
+  optional 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
+  optional bool case_sensitive = 3; // default search is case insensitive
 }
 
 message ReadRequest {
-  uint32 offset = 1;
-  uint32 limit = 2;
+  optional uint32 offset = 1;
+  optional uint32 limit = 2;
   repeated Sort sort = 3;
 
   /// Filter based on fieldName|operation, value|list
@@ -93,14 +93,14 @@ message ReadRequest {
   repeated string locales_limiter = 7;
 
   repeated string custom_queries = 8;
-  google.protobuf.Any custom_arguments = 9;
+  optional google.protobuf.Any custom_arguments = 9;
   io.restorecommerce.auth.Subject subject = 10;
-  Search search = 11;
+  optional Search search = 11;
 }
 
 message DeleteRequest {
   /// Request to purge the whole collection
-  bool collection = 1;
+  optional bool collection = 1;
   /// Delete specified documents
   repeated string ids = 2;
   io.restorecommerce.auth.Subject subject = 3;
@@ -116,7 +116,7 @@ message DeleteResponse {
 /// List of resources
 message ResourceList {
   repeated Resource items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -135,6 +135,6 @@ message ResourceResponse {
 
 /// Example resource
 message Resource {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
 }

package/io/restorecommerce/role.proto

@@ -8,9 +8,7 @@ import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/options.proto";
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "role";
-
+service RoleService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (RoleListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -21,16 +19,16 @@ service Service {
 }
 
 message Role {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3; // specifies the role of the user
-  string description = 4;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3; // specifies the role of the user
+  optional string description = 4;
   repeated string assignable_by_roles = 5; // role id who can assign this role
 }
 
 message RoleList {
   repeated Role items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 

package/io/restorecommerce/rule.proto

@@ -28,29 +28,29 @@ enum Effect {
 }
 
 message Rule {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;
-  string description = 4;
-  Target target = 5;
-  ContextQuery context_query = 6;
-  string condition = 7; // JS code
-  Effect effect = 8;
-  bool evaluation_cacheable = 9;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;
+  optional string description = 4;
+  optional Target target = 5;
+  optional ContextQuery context_query = 6;
+  optional string condition = 7; // JS code
+  optional Effect effect = 8;
+  optional bool evaluation_cacheable = 9;
 }
 
 message RuleRQ { // used for `whatIsAllowed` / reverse queries
-  string id = 1;
-  Target target = 2;
-  Effect effect = 3;
-  string condition = 4;
-  ContextQuery context_query = 5;
-  bool evaluation_cacheable = 6;
+  optional string id = 1;
+  optional Target target = 2;
+  optional Effect effect = 3;
+  optional string condition = 4;
+  optional ContextQuery context_query = 5;
+  optional bool evaluation_cacheable = 6;
 }
 
 message RuleList {
   repeated Rule items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -70,12 +70,10 @@ message RuleResponse {
 // The retrieved data can then be passed onto the request's context
 message ContextQuery {
   repeated io.restorecommerce.filter.FilterOp filters = 1;
-  string query = 2;
+  optional string query = 2;
 }
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "rule";
-
+service RuleService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (RuleListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };

package/io/restorecommerce/search.proto

@@ -6,15 +6,13 @@ import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/options.proto";
 
 // Service provides the CRUD operations
-service Service {
-  option (io.restorecommerce.options.service_name) = "search";
-
+service SearchService {
   rpc Search (SearchRequest) returns (SearchResponse);
 }
 
 message SearchRequest {
-  string collection = 1;
-  string text = 2;
+  optional string collection = 1;
+  optional string text = 2;
   repeated string acl = 3;
   io.restorecommerce.auth.Subject subject = 4;
 }

package/io/restorecommerce/status.proto

@@ -3,24 +3,29 @@ syntax = "proto3";
 package io.restorecommerce.status;
 
 message Status {
-  string id = 1;
-  uint32 code = 2;
-  string message = 3;
+  optional string id = 1;
+  optional uint32 code = 2;
+  optional string message = 3;
 }
 
 message StatusArray {
-repeated Status status = 1;
+  repeated Status status = 1;
 }
 
 message StatusObj {
-  Status status = 1;
+  optional Status status = 1;
 }
 
 message OperationStatusObj {
-  OperationStatus operation_status = 1;
+  optional OperationStatus operation_status = 1;
 }
 
 message OperationStatus {
-  uint32 code = 1;
-  string message = 2;
+  optional uint32 code = 1;
+  optional string message = 2;
+}
+
+message StatusListResponse {
+  repeated Status status = 1;
+  optional OperationStatus operation_status = 2;
 }

package/io/restorecommerce/tax.proto

@@ -15,9 +15,7 @@ import "io/restorecommerce/tax_type.proto";
 /*
 * Microservice definition.
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "tax";
-
+service TaxService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (TaxListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -33,7 +31,7 @@ message Deleted {
 
 message TaxList {
   repeated Tax items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -49,9 +47,9 @@ message TaxResponse {
 }
 
 message Tax {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string country_id = 3 [
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string country_id = 3 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.country.Country",
       target_service: "resource",
@@ -60,9 +58,9 @@ message Tax {
       field_name: "country",
     }
   ];
-  double rate = 4;
-  string variant = 5;
-  string type_id = 6 [
+  optional double rate = 4;
+  optional string variant = 5;
+  optional string type_id = 6 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.tax_type.TaxType",
       target_service: "resource",
@@ -72,3 +70,8 @@ message Tax {
     }
   ];
 }
+
+message VAT {
+  optional string tax_id = 1;
+  optional double vat = 2;
+}

package/io/restorecommerce/tax_type.proto

@@ -11,9 +11,7 @@ import "io/restorecommerce/options.proto";
 /*
 * Microservice definition.
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "tax_type";
-
+service TaxTypeService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (TaxTypeListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -23,13 +21,18 @@ service Service {
   rpc Upsert (TaxTypeList) returns (TaxTypeListResponse);
 }
 
+enum Behavior {
+  NONE = 0;
+  ADDITIVE_ON_GROSS = 1;
+}
+
 message Deleted {
-  string id = 1;
+  optional string id = 1;
 }
 
 message TaxTypeList {
   repeated TaxType items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -45,8 +48,9 @@ message TaxTypeResponse {
 }
 
 message TaxType {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string type = 3;
-  string description = 4;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string type = 3;
+  optional string description = 4;
+  optional Behavior behavior = 5;
 }

package/io/restorecommerce/timezone.proto

@@ -11,9 +11,7 @@ import "io/restorecommerce/options.proto";
 /*
 * Microservice definition.
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "timezone";
-
+service TimezoneService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (TimezoneListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -29,7 +27,7 @@ message Deleted {
 
 message TimezoneList {
   repeated Timezone items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -45,7 +43,7 @@ message TimezoneResponse {
 }
 
 message Timezone {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string description = 3;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string description = 3;
 }

package/io/restorecommerce/token.proto

@@ -9,9 +9,7 @@ import "io/restorecommerce/options.proto";
 /*
 * Microservice definition.
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "token";
-
+service TokenService {
   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) {
     option (io.restorecommerce.options.is_query) = true;
@@ -22,20 +20,20 @@ service Service {
 }
 
 message TokenData {
-  string id = 1;
-  google.protobuf.Any payload = 2;
-  double expires_in = 3;
-  string type = 4;
-  io.restorecommerce.auth.Subject subject = 5;
+  optional string id = 1;
+  optional google.protobuf.Any payload = 2;
+  optional double expires_in = 3;
+  optional string type = 4;
+  optional io.restorecommerce.auth.Subject subject = 5;
 }
 
 message Identifier {
-  string id = 1;
-  string type = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  optional string id = 1;
+  optional string type = 2;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message GrantId {
-  string grant_id = 1;
-  io.restorecommerce.auth.Subject subject = 2;
+  optional string grant_id = 1;
+  optional io.restorecommerce.auth.Subject subject = 2;
 }

package/io/restorecommerce/user.proto

@@ -19,9 +19,7 @@ import "io/restorecommerce/locale.proto";
 /**
  * The microservice for the user resource.
  */
-service Service {
-  option (io.restorecommerce.options.service_name) = "user";
-
+service UserService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (UserListWithRoleResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -60,8 +58,8 @@ service Service {
 */
 message LoginRequest {
   string identifier = 1; // User name or email
-  string password = 2; // Raw password
-  string token = 3;
+  optional string password = 2; // Raw password
+  optional string token = 3;
 }
 
 message OrgIDRequest {
@@ -75,9 +73,9 @@ message DeleteUsersByOrgResponse {
 }
 
 message FindRequest {
-  string id = 1; /// User ID
-  string name = 2;
-  string email = 3;
+  optional string id = 1; /// User ID
+  optional string name = 2;
+  optional string email = 3;
   io.restorecommerce.auth.Subject subject = 4;
 }
 
@@ -93,20 +91,20 @@ enum UserType {
 }
 
 message RegisterRequest {
-  string id = 1;
-  bool guest = 2;
-  io.restorecommerce.meta.Meta meta = 3;
-  string name = 4;
-  string first_name = 5;
-  string last_name = 6;
-  string email = 7;
-  string password = 8;
-  string timezone_id = 9;
-  string locale_id = 10;
-
-  string default_scope = 11; // default hierarchical scope
-  UserType user_type = 12;
-  string captcha_code = 13;
+  optional string id = 1;
+  optional bool guest = 2;
+  optional io.restorecommerce.meta.Meta meta = 3;
+  optional string name = 4;
+  optional string first_name = 5;
+  optional string last_name = 6;
+  optional string email = 7;
+  optional string password = 8;
+  optional string timezone_id = 9;
+  optional string locale_id = 10;
+
+  optional string default_scope = 11; // default hierarchical scope
+  optional UserType user_type = 12;
+  optional string captcha_code = 13;
 }
 
 message ActivateRequest {
@@ -129,7 +127,6 @@ message SendInvitationEmailRequest {
 }
 
 message ChangePasswordRequest {
-  string identifier = 1; /// user name or email
   string password = 2;
   string new_password = 3;
   io.restorecommerce.auth.Subject subject = 4;
@@ -215,7 +212,7 @@ message EmailChangeConfirmed {
  */
 message UserList {
   repeated User items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -266,19 +263,19 @@ message User {
     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
-  string first_name = 4;
-  string last_name = 5;
-  string email = 6; /// Email address, can be used for login
-  string new_email = 7; /// New email address; set by `requestEmailChange` and overrides actual email upon `confirmEmailChange`
-  bool active = 8; /// If the user was activated via the activation process
-  string activation_code = 9; /// Activation code used in the activation process
-  string password = 10; /// Raw password, not stored
-  string password_hash = 11; /// Encrypted password, stored
+  optional string id = 1; /// User ID, unique, key
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3; // The name of the user, can be used for login
+  optional string first_name = 4;
+  optional string last_name = 5;
+  optional string email = 6; /// Email address, can be used for login
+  optional string new_email = 7; /// New email address; set by `requestEmailChange` and overrides actual email upon `confirmEmailChange`
+  optional bool active = 8; /// If the user was activated via the activation process
+  optional string activation_code = 9; /// Activation code used in the activation process
+  optional string password = 10; /// Raw password, not stored
+  optional string password_hash = 11; /// Encrypted password, stored
   repeated io.restorecommerce.auth.RoleAssociation role_associations = 12; // A user can have multiple roles and different attributes coupled with each role
-  string timezone_id = 13 [
+  optional string timezone_id = 13 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.timezone.Timezone",
       target_service: "resource",
@@ -287,7 +284,7 @@ message User {
       field_name: "timezone",
     }
   ];  // timezone_id specifications
-  string locale_id = 14 [
+  optional string locale_id = 14 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.locale.Locale",
       target_service: "resource",
@@ -296,18 +293,18 @@ message User {
       field_name: "locale",
     }
   ];  // locale specifications
-  string default_scope = 15; // default hierarchical scope
-  bool unauthenticated = 16; // true in case in case of `register`; set to false after activation
-  bool guest = 17; /// Is the user a guest. A guest is a automatically generated user which can later be turned in a non-guest user.
-  io.restorecommerce.image.Image image = 18;
-  UserType user_type = 19;
-  bool invite = 20; // For user invitation
-  string invited_by_user_name = 21; // user who is inviting
-  string invited_by_user_first_name = 22; // First name of user inviting
-  string invited_by_user_last_name = 23; // Last name of user inviting
+  optional string default_scope = 15; // default hierarchical scope
+  optional bool unauthenticated = 16; // true in case in case of `register`; set to false after activation
+  optional bool guest = 17; /// Is the user a guest. A guest is a automatically generated user which can later be turned in a non-guest user.
+  optional io.restorecommerce.image.Image image = 18;
+  optional UserType user_type = 19;
+  optional bool invite = 20; // For user invitation
+  optional string invited_by_user_name = 21; // user who is inviting
+  optional string invited_by_user_first_name = 22; // First name of user inviting
+  optional string invited_by_user_last_name = 23; // Last name of user inviting
   repeated io.restorecommerce.auth.Tokens tokens = 24;
-  double last_access = 25;
-  google.protobuf.Any data = 26; /// additional data
+  optional double last_access = 25;
+  optional google.protobuf.Any data = 26; /// additional data
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@restorecommerce/protos",
-  "version": "2.0.2",
+  "version": "3.0.0",
   "description": "Protobuf descriptors for Restorecommerce services",
   "author": "n-fuse GmbH",
   "repository": {
@@ -15,5 +15,5 @@
     "protobufs"
   ],
   "scripts": {},
-  "gitHead": "2ec001696f611681778a13842a9e047f1db08059"
+  "gitHead": "95e7a13093fcfb008bb420881d1fdff5f081ed18"
 }