@restorecommerce/protos 0.4.5

package/io/restorecommerce/tax_type.proto

@@ -0,0 +1,47 @@
+syntax = "proto3";
+
+package io.restorecommerce.tax_type;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+
+/*
+* Microservice definition.
+*/
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (TaxTypeListResponse);
+  rpc Create (TaxTypeList) returns (TaxTypeListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (TaxTypeList) returns (TaxTypeListResponse);
+  rpc Upsert (TaxTypeList) returns (TaxTypeListResponse);
+}
+
+message Deleted {
+  string id = 1;
+}
+
+message TaxTypeList {
+  repeated TaxType items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message TaxTypeListResponse {
+  repeated TaxTypeResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message TaxTypeResponse {
+  TaxType payload = 1;
+  io.restorecommerce.status.Status status = 3;
+}
+
+message TaxType {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string type = 3;
+  string description = 4;
+}

package/io/restorecommerce/timezone.proto

@@ -0,0 +1,46 @@
+syntax = "proto3";
+
+package io.restorecommerce.timezone;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+
+/*
+* Microservice definition.
+*/
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (TimezoneListResponse);
+  rpc Create (TimezoneList) returns (TimezoneListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (TimezoneList) returns (TimezoneListResponse);
+  rpc Upsert (TimezoneList) returns (TimezoneListResponse);
+}
+
+message Deleted {
+  string id = 1;
+}
+
+message TimezoneList {
+  repeated Timezone items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message TimezoneListResponse {
+  repeated TimezoneResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message TimezoneResponse {
+  Timezone payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message Timezone {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string description = 3;
+}

package/io/restorecommerce/token.proto

@@ -0,0 +1,36 @@
+syntax = "proto3";
+
+package io.restorecommerce.token;
+
+import "io/restorecommerce/auth.proto";
+import "google/protobuf/any.proto";
+
+/*
+* Microservice definition.
+*/
+service Service {
+  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 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).
+}
+
+message TokenData {
+  string id = 1;
+  google.protobuf.Any payload = 2;
+  double expires_in = 3;
+  string type = 4;
+  io.restorecommerce.auth.Subject subject = 5;
+}
+
+message Identifier {
+  string id = 1;
+  string type = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message GrantId {
+  string grant_id = 1;
+  io.restorecommerce.auth.Subject subject = 2;
+}

package/io/restorecommerce/user.proto

@@ -0,0 +1,258 @@
+syntax = "proto3";
+
+package io.restorecommerce.user;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/attribute.proto";
+import "io/restorecommerce/image.proto";
+import "io/restorecommerce/status.proto";
+
+/**
+ * The microservice for the user resource.
+ */
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (UserListResponse);
+  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 Register (RegisterRequest) returns (UserResponse);
+  rpc Activate (ActivateRequest) returns (io.restorecommerce.status.OperationStatusObj);
+  rpc ChangePassword (ChangePasswordRequest) returns (io.restorecommerce.status.OperationStatusObj);
+  rpc RequestPasswordChange (RequestPasswordChangeRequest) returns (io.restorecommerce.status.OperationStatusObj);
+  rpc RequestEmailChange (ChangeEmailRequest) returns (io.restorecommerce.status.OperationStatusObj);
+  rpc ConfirmPasswordChange (ConfirmPasswordChangeRequest) returns (io.restorecommerce.status.OperationStatusObj);
+  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 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 SendActivationEmail (SendActivationEmailRequest) returns (io.restorecommerce.status.OperationStatusObj);
+}
+
+/**
+* Request to verify password and retrieve the user's info.
+* Either name or email can be provided.
+*/
+message LoginRequest {
+  string identifier = 1; // User name or email
+  string password = 2; // Raw password
+  string token = 3;
+}
+
+message OrgIDRequest {
+  repeated string org_ids = 1;
+  io.restorecommerce.auth.Subject subject = 2;
+}
+
+message DeleteUsersByOrgResponse {
+  repeated string user_ids = 1;
+  io.restorecommerce.status.OperationStatus operation_status = 2;
+}
+
+message FindRequest {
+  string id = 1; /// User ID
+  string name = 2;
+  string email = 3;
+  io.restorecommerce.auth.Subject subject = 4;
+}
+
+message FindByTokenRequest {
+  string token = 1;
+}
+
+enum UserType {
+  ORG_USER = 0;
+  INDIVIDUAL_USER = 1;
+  GUEST = 2;
+  TECHNICAL_USER = 3;
+}
+
+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;
+}
+
+message ActivateRequest {
+  string identifier = 1; /// user name or email
+  string activation_code = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message ConfirmUserInvitationRequest {
+  string identifier = 1; // user name or email
+  string password = 2;
+  string activation_code = 3;
+  io.restorecommerce.auth.Subject subject = 4;
+}
+
+message SendInvitationEmailRequest {
+  string identifier = 1; // user name or email
+  string invited_by_user_identifier = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message ChangePasswordRequest {
+  string identifier = 1; /// user name or email
+  string password = 2;
+  string new_password = 3;
+  io.restorecommerce.auth.Subject subject = 4;
+}
+
+message RequestPasswordChangeRequest {
+  string identifier = 1; // user name or email
+  io.restorecommerce.auth.Subject subject = 2;
+}
+
+message ConfirmPasswordChangeRequest {
+  string identifier = 1; // user name or email
+  string activation_code = 2;
+  string password = 3;
+  io.restorecommerce.auth.Subject subject = 4;
+}
+
+message ChangeEmailRequest {
+  string identifier = 1; // user name or email
+  string new_email = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message ConfirmEmailChangeRequest {
+  string identifier = 1; // user name or email
+  string activation_code = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message UnregisterRequest {
+  string identifier = 1; /// User ID
+  io.restorecommerce.auth.Subject subject = 2;
+}
+
+message SendActivationEmailRequest {
+  string identifier = 1; /// User name or email
+  io.restorecommerce.auth.Subject subject = 2;
+}
+
+/**
+ * User deletion event.
+ * Send when a user was deleted or unregistered.
+ *
+ * Events:
+ * usersDeleted,
+ * unregistered,
+ */
+message Deleted {
+  string id = 1;
+}
+
+/**
+ * User password changed event.
+ *
+ * Events:
+ * passwordChanged,
+ */
+message PasswordChanged {
+  string id = 1; /// User ID
+  string password_hash = 2;
+}
+
+message PasswordChangeRequested {
+  string id = 1; // User ID
+}
+
+/**
+ * User email id changed event.
+ */
+message EmailChangeRequested {
+  string id = 1;
+  string activation_code = 2;
+  string new_email = 3;
+}
+
+message EmailChangeConfirmed {
+  string id = 1; /// User ID
+  string email = 2;
+}
+
+/**
+ * A list of User.
+ */
+message UserList {
+  repeated User items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message UserListResponse {
+  repeated UserResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message UserResponse {
+  User payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+/**
+ * User activation request.
+ */
+message Activate {
+  string id = 1; /// User ID
+}
+
+message FindByRoleRequest {
+  string role = 1;
+  repeated io.restorecommerce.attribute.Attribute attributes = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+/**
+ * A User resource.
+ */
+message User {
+  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;	// timezone_id specifications
+  string locale_id = 14;	// 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;
+}

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@restorecommerce/protos",
+  "version": "0.4.5",
+  "description": "Protobuf descriptors for Restorecommerce services",
+  "author": "n-fuse GmbH",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/restorecommerce/libs.git"
+  },
+  "license": "MIT",
+  "keywords": [
+    "restore",
+    "commerce",
+    "protos",
+    "protobufs"
+  ],
+  "scripts": {},
+  "gitHead": "9e4e1727b7aec6a7fd0e23e29fc01ba44fba4e59"
+}

package/test/test.proto

@@ -0,0 +1,71 @@
+syntax = "proto3";
+package test;
+
+import "google/protobuf/any.proto";
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/status.proto";
+
+service Test {
+  rpc Test (TestRequest) returns (TestResponse);
+  rpc Throw (TestRequest) returns (TestResponse);
+  rpc NotImplemented (TestRequest) returns (TestResponse);
+  rpc NotFound (TestRequest) returns (TestResponse);
+  rpc Create (TestBufferedDataList) returns (TestBufferedDataListResponse);
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (TestBufferedDataListResponse);
+}
+
+/**
+* Stream test service
+*/
+service Stream {
+  rpc BiStream (stream TestRequest) returns (stream StreamTestResponse);
+  rpc ResponseStream (TestRequest) returns (stream StreamTestResponse);
+  rpc RequestStream (stream TestRequest) returns (TestResponse);
+}
+
+message TestRequest {
+  string value = 1;
+}
+
+message StreamTestResponse {
+  string result = 1;
+}
+
+message TestResponse {
+  string result = 1;
+  io.restorecommerce.status.Status status = 4;
+}
+
+message TestEvent {
+  string value = 1;
+  int32 count = 2;
+};
+
+message TestBufferedData {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string value = 3;
+  int32 count = 4;
+  google.protobuf.Any data = 5;
+}
+
+message TestBufferedDataList {
+  repeated TestBufferedData items = 1;
+  uint32 total_count = 2;
+}
+
+message TestBufferedDataResponse {
+  TestBufferedData payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message TestBufferedDataListResponse {
+  repeated TestBufferedDataResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message ExtendMe {
+  int32 bar = 126;
+}