update

Author: Tim-Leon

Cargo.toml

@@ -8,13 +8,15 @@ edition = "2021"
 default = ["server-api", "client-api"]
 client-api = []
 server-api = []
-
+metrics = ["opentelemetry-proto"]
 [dependencies]
 tonic-health = {version = "*", default-features = false, features = []}
 tonic-web = {version = "*", default-features = false, features = []}
 prost = {version = "*"}
 prost-types = {version = "*"}
 
+opentelemetry-proto = { version = "0.27.0", optional = true, features = ["full"] }
+
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 tonic-web-wasm-client = { version = "*", features = []}
 tonic = { version = "0.12.1", default-features = false, features = [

proto/auth.proto

@@ -50,15 +50,16 @@ message AccountLoginFinishResponse { string jwt_token = 1; }
 // SetupTwoFactorAuthenticationResponse <- Server Client ->
 // SetupVerifyTwoFactorAuthenticationRequest -> Server Client <-
 // SetupVerifyTwoFactorAuthenticationResponse <- Server
+// First the user gets the secrete, the user stores the secrete, the user uses the secrete to compute the first totp code and send that in for verification.
 message SetupTwoFactorAuthenticationRequest {}
 
-message SetupTwoFactorAuthenticationResponse { string qr_secret = 1; }
+message SetupTwoFactorAuthenticationResponse { string totp_secrete = 1; }
 
-message SetupVerifyTwoFactorAuthenticationRequest { string qr_code = 1; }
-/// Will return a status error message if qr_code is invalid.
-message SetupVerifyTwoFactorAuthenticationResponse {}
-/// Invalidates the users JWT-token
-message AccountLogoutRequest { string jwt_token = 1; }
+message SetupTwoFactorAuthenticationVerifyRequest { string totp_code = 1; }
+/// Will return a status error message if totp_code is invalid.
+message SetupTwoFactorAuthenticationVerifyResponse {}
+/// Invalidates the users JWT-token.
+message AccountLogoutRequest { string token = 1; }
 
 message AccountLogoutResponse {}
 

proto/backend_api.proto

@@ -7,6 +7,7 @@ import "search.proto";
 import "filesystem.proto";
 import "sync.proto";
 import "webhook.proto";
+import "share.proto";
 package backend_api;
 
 // Error model that is used is: https://cloud.google.com/apis/design/errors
@@ -96,12 +97,17 @@ service BackendApi {
   // rpc InviteUserToBucket(InviteUserToBucketRequest) returns
   // (InviteUserToBucketResponse) {}; // Used by Share-File system to invite a
   // user.
-  rpc CreateBucketShareLink(CreateBucketShareLinkRequest)
-      returns (CreateBucketShareLinkResponse) {
+  rpc CreateBucketShareToken(CreateBucketShareTokenRequest)
+      returns (CreateBucketShareTokenResponse) {
   };
+  rpc RegisterBucketSecreteShareLink(RegisterBucketSecreteShareLinkTokenRequest) returns (RegisterBucketSecreteShareLinkTokenResponse) {};
+  rpc GetBucketShareLinksPaginatable(GetBucketShareLinksPaginatableRequest) returns (GetBucketShareLinksPaginatableResponse) {};
+  rpc DeleteBucketShareLinks(DeleteBucketShareLinksRequest) returns (DeleteBucketShareLinksResponse) {};
+  rpc DeleteUsersFromSharedBucket(DeleteUsersFromSharedBucketRequest) returns (DeleteUsersFromSharedBucketResponse) {};
+
   rpc CreateWebhook(CreateWebhookRequest) returns (CreateWebhookResponse) {};
   // Used by user who have an account. Provide read/write access to bucket
-     // for an etirity.
+  // for an etirity.
   // rpc DeleteUserFromSharedBucket(DeleteUserFromSharedBucketRequest) returns
   // (DeleteUserFromSharedBucketResponse) {}; /// Used by Share-File system to
   // delete a user. rpc DeleteBucketShareLinks(DeleteBucketShareLinksRequest)

proto/bucket.proto

@@ -50,7 +50,8 @@ message BucketRedundancy {
 }
 
 message CreateBucketRequest {
-  string name = 1;
+  /// If no name is provided then the bucket generated UUID is used.
+  optional string name = 1;
   // Public,PrivateShared, Private,
   optional string visibility = 2;
   // The encryption algorithm used for the bucket. Currently only supports
@@ -60,13 +61,10 @@ message CreateBucketRequest {
   /// bucket are required to enter the password. The field doesn't affect
   /// encryption, only access control.
   optional string password = 4;
-  /// Redundancy settings TODO: Currently not supported.
-  // optional BucketRedundancy redundancy = 5;
-  // Optional description of the bucket.
+
   optional string description = 8;
-  // Storage class, Standard. Will later support Performant(That will use SSD or
-  // NVME?), Extra-Performant(NVME) with super fast ethernet.
-  string storage_class = 9;
+  /// The underlying storage engine to use. Look into storage-engine in documentation for more information.
+  string storage_engine_type = 9;
   // Tag the storage, like pictures, music, videos, etc.
   repeated string tags = 10;
   // When the bucket will expire.
@@ -79,8 +77,8 @@ message CreateBucketRequest {
   bool is_nsfw = 14;
   // If the bucket is searchable or not, Will end up costing more.
   bool is_searchable = 15;
-  /// If the user is allowed to clone and distribute the same content. If this
-  /// value is false for a bucket assume it's not okay to redustribute.
+  /// If the user ris allowed to clone and distribute the same content. If this
+  //  /// value is false for a bucket assume it's not okay to redistribute.
   bool is_bucket_cloneable = 16;
   /// If the bucket is non-sharable it will use zero-knowledge encryption.
   bool is_sharable = 17;
@@ -109,9 +107,7 @@ message DeleteBucketResponse {
 /// This api endpoint will be updated in the future to support more options and
 /// is not priority yet because of being complicated.
 message UpdateBucketRequest {
-  string bucket_id = 1;
-  string bucket_user_id = 2;
-
+  BucketGuid bucket_guid = 1;
   optional string name = 3;
   // Public,PrivateShared, Private,
   optional string visibility = 4;
@@ -207,6 +203,9 @@ message CloneBucketRequest {
   optional string new_bucket_type = 4;
   optional string new_bucket_encryption = 5;
   optional string new_bucket_password = 6;
+
+  bool should_abandon_partial = 7; /// If
+  bool should_overwrite = 8;
 }
 
 message CloneBucketResponse {}
@@ -217,7 +216,7 @@ message DeleteFilesInBucketRequest {
   repeated string filepaths = 3;
   /// Will remove the capacity form the bucket of x amount of bytes.
   /// Default this should be true in most cases.
-  /// Only false if the user intneds to keep the storage to be uploaded to later
+  /// Only false if the user intends to keep the storage to be uploaded to later
   /// on...
   bool is_capacity_destructive = 7;
 }

proto/bucket_collection.proto

@@ -0,0 +1,36 @@
+syntax = "proto3";
+package backend_api;
+
+message BucketGuid {
+  string user_id = 1;
+  string bucket_id = 2;
+}
+
+
+message CreateBucketCollectionRequest {
+  optional string name = 1;
+  repeated BucketGuid bucket_guid = 2;
+}
+
+message CreateBucketCollectionResponse {
+  string collection_id = 1;
+}
+
+message DeleteBucketCollectionRequest {
+  string collection_id = 1;
+}
+
+message DeleteBucketCollectionResponse {
+
+}
+
+message UpdateBucketCollectionRequest {
+  string collection_id = 1;
+  optional string name = 2;
+  repeated string bucket_guid = 3;
+}
+
+message UpdateBucketCollectionResponse {
+  string name = 1;
+  repeated string bucket_guid = 2;
+}

proto/bucket_permission.proto

@@ -1,81 +1,4 @@
 syntax = "proto3";
 package backend_api;
 import "google/protobuf/timestamp.proto";
-// Creates a bucket share link. This link can be either SecretShareLink or a
-// normal ShareLink, depending on if is_secret_share_link.
-message CreateBucketShareLinkRequest {
-  string user_id = 1;
-  string bucket_id = 2;
-  optional google.protobuf.Timestamp expires = 3;
-  optional uint32 usages = 4;
-  bool registered_users_only = 5;
-  bool view_permission = 6;
-  bool read_permission = 7;
-  bool write_permission = 8;
-  bool delete_file_permission = 9;
-  bool delete_bucket_permission = 10;
-  bool share_bucket_permission = 11;
-  bool clone_permission = 12;
-  bool search_permission = 13;
-  bool is_secret_share_link = 14;
-}
 
-message CreateBucketShareLinkResponse { string url = 1; }
-
-message GetBucketShareLinksRequest { string bucket_id = 1; }
-
-message GetBucketShareLinksResponse {
-  repeated string secret_share_link_urls = 1;
-  repeated string share_link_urls = 2;
-}
-
-message DeleteBucketShareLinksRequest { repeated string urls = 1; }
-
-message DeleteBucketShareLinksResponse { repeated string urls = 1; }
-
-message DeleteUserFromSharedBucketRequest {
-  string bucket_id = 1;
-  repeated string user_ids = 2;
-}
-
-message DeleteUserFromSharedBucketResponse {}
-
-message SharedUser {
-  string user_id = 1;
-  bool read_premission = 2;
-  bool write_permission = 3;
-  bool view_permission = 4;
-  bool copy_permission = 5;
-  string username = 6;
-  string email = 7;
-}
-
-message GetBucketSharedUsersRequest { string bucket_id = 1; }
-
-message GetBucketSharedUsersResponse {
-  string owner_id = 1;
-  string owner_username = 2;
-  repeated SharedUser shared_users = 3;
-}
-
-message GetUserBucketPermissionsRequest {
-  string bucket_id = 1;
-  string user_id = 2;
-}
-
-message GetUserBucketPermissionsResponse {
-  optional bool read_permission = 1;
-  optional bool write_permission = 2;
-  optional bool view_permission = 3;
-  optional bool copy_permission = 4;
-}
-
-message InviteUserToBucketRequest {
-  oneof user {
-    string user_id = 1;
-    string email = 2;
-    string username = 3;
-  }
-}
-
-message InviteUserToBucketResponse {}

proto/image.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+package backend_api;
+import "google/protobuf/timestamp.proto";
+
+message Scaling  {
+  optional int32 scale = 1;
+  optional int32 width = 2;
+  optional int32 height = 3;
+}
+
+message ResizeImageRequest {
+  string from_absolute_path = 1;
+  optional string to_absolute_path = 2;
+  optional Scaling scaling = 3;
+
+}

proto/metrics.proto

@@ -0,0 +1,31 @@
+syntax = "proto3";
+package backend_api;
+import "google/protobuf/timestamp.proto";
+
+
+/// Every storage engine will have a different performance.
+/// You can query the storage engines that are used by the specific name
+message GetStorageEngineMetrics {
+  /// The storage engine to be used.
+  string engine_name = 1;
+}
+
+message GetStorageEngineMetricsResponse {
+  string storage_engine_type = 1;
+  Metric latency = 2;
+  Metric throughput = 3;
+  Metric cost  = 4;
+
+}
+
+
+
+message Metric {
+  string name = 1;
+  repeated MetricValue series = 2;
+}
+
+message MetricValue {
+  google.protobuf.Timestamp  timestamp = 1;
+  string value = 2;
+}

proto/model.proto

@@ -8,8 +8,20 @@ Transcoder and compressor are optimized prebuilt components for a a specific
 task. Lambda is a function
 
 */
+
+message ArchiveCompressRequest {
+  repeated string source_filepath = 1;
+  optional string target_filepath = 2;
+  bool is_destructive = 3; /// IF the archive compression will delete all of the source_filepath
+
+}
+
+message ArchiveComp
+
+
 message ModelWorkflow {}
 
+
 message Compressor {
   string source_filepath = 1;
   optional string source_format = 2;

proto/notification.proto

@@ -0,0 +1,7 @@
+message GetNotificationsPaginatableRequest {
+  
+}
+
+message DeleteNotificationsRequest {
+
+}