@restorecommerce/protos 0.6.7 → 0.7.0

package/io/restorecommerce/user.proto

@@ -9,18 +9,30 @@ import "io/restorecommerce/attribute.proto";
 import "io/restorecommerce/image.proto";
 import "io/restorecommerce/status.proto";
 import "google/protobuf/any.proto";
+import "io/restorecommerce/role.proto";
+import "io/restorecommerce/options.proto";
+
+// Used by resolvers
+import "io/restorecommerce/timezone.proto";
+import "io/restorecommerce/locale.proto";
 
 /**
  * The microservice for the user resource.
  */
 service Service {
-  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (UserListResponse);
+  option (io.restorecommerce.options.service_name) = "user";
+
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (UserListWithRoleResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
   rpc Create (UserList) returns (UserListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
   rpc Update (UserList) returns (UserListResponse);
   rpc Upsert (UserList) returns (UserListResponse);
 
-  rpc Find (FindRequest) returns (UserListResponse);
+  rpc Find (FindRequest) returns (UserListResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
   rpc Register (RegisterRequest) returns (UserResponse);
   rpc Activate (ActivateRequest) returns (io.restorecommerce.status.OperationStatusObj);
   rpc ChangePassword (ChangePasswordRequest) returns (io.restorecommerce.status.OperationStatusObj);
@@ -30,11 +42,15 @@ service Service {
   rpc ConfirmEmailChange (ConfirmEmailChangeRequest) returns (io.restorecommerce.status.OperationStatusObj);
   rpc Unregister (UnregisterRequest) returns (io.restorecommerce.status.OperationStatusObj);
   rpc Login (LoginRequest) returns (UserResponse);
-  rpc FindByRole (FindByRoleRequest) returns (UserListResponse);
+  rpc FindByRole (FindByRoleRequest) returns (UserListResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
   rpc DeleteUsersByOrg (OrgIDRequest) returns (DeleteUsersByOrgResponse);
   rpc ConfirmUserInvitation (ConfirmUserInvitationRequest) returns (io.restorecommerce.status.OperationStatusObj);
   rpc SendInvitationEmail (SendInvitationEmailRequest) returns (io.restorecommerce.status.OperationStatusObj);
-  rpc FindByToken (FindByTokenRequest) returns (UserResponse);
+  rpc FindByToken (FindByTokenRequest) returns (UserResponse) {
+    option (io.restorecommerce.options.is_query) = true;
+  };
   rpc SendActivationEmail (SendActivationEmailRequest) returns (io.restorecommerce.status.OperationStatusObj);
 }
 
@@ -203,6 +219,17 @@ message UserList {
   io.restorecommerce.auth.Subject subject = 3;
 }
 
+message UserListWithRoleResponse {
+  repeated UserRoleResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message UserRoleResponse {
+  UserRole payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
 message UserListResponse {
   repeated UserResponse items = 1;
   uint32 total_count = 2;
@@ -243,8 +270,72 @@ message User {
   string password = 10; /// Raw password, not stored
   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;	// timezone_id specifications
-  string locale_id = 14;	// locale specifications
+  string timezone_id = 13 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.timezone.Timezone";
+      target_service: "resource";
+      target_sub_service: "timezone";
+      target_method: "Read";
+      field_name: "timezone";
+    }
+  ];  // timezone_id specifications
+  string locale_id = 14 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.locale.Locale";
+      target_service: "resource";
+      target_sub_service: "locale";
+      target_method: "Read";
+      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
+  repeated io.restorecommerce.auth.Tokens tokens = 24;
+  double last_access = 25;
+  google.protobuf.Any data = 26; /// additional data
+}
+
+/**
+ * A User resource with role
+ */
+message UserRole {
+  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
+  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 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.timezone.Timezone";
+      target_service: "resource";
+      target_sub_service: "timezone";
+      target_method: "Read";
+      field_name: "timezone";
+    }
+  ];	// timezone_id specifications
+  string locale_id = 14 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.locale.Locale";
+      target_service: "resource";
+      target_sub_service: "locale";
+      target_method: "Read";
+      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.
@@ -257,4 +348,5 @@ message User {
   repeated io.restorecommerce.auth.Tokens tokens = 24;
   double last_access = 25;
   google.protobuf.Any data = 26; /// additional data
+  repeated io.restorecommerce.role.Role role = 27;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@restorecommerce/protos",
-  "version": "0.6.7",
+  "version": "0.7.0",
   "description": "Protobuf descriptors for Restorecommerce services",
   "author": "n-fuse GmbH",
   "repository": {
@@ -15,5 +15,5 @@
     "protobufs"
   ],
   "scripts": {},
-  "gitHead": "bc9bea7088f12bf1e539559cb840ec4c66b2a5f9"
+  "gitHead": "2d453885b1c82df3e6aabbfbfe3b5a9c0b240277"
 }