@mediaryorg/contracts 1.0.8 → 2.0.0

package/proto/auth/v1/auth.proto

@@ -2,8 +2,6 @@ syntax = "proto3";
 
 package auth.v1;
 
-import "user/v1/user.proto";
-
 service AuthService {
   rpc Register(RegisterRequest) returns (RegisterResponse);
 
@@ -25,58 +23,14 @@ service AuthService {
   rpc AdminValidateSession(AdminValidateSessionRequest) returns (AdminValidateSessionResponse);
 }
 
-message LoginResponse {
-  user.v1.User user = 1;
-  string session_id = 2;
-  int64 max_age_ms = 3;
-}
-
-message ConfirmEmailResponse {
-  user.v1.User user = 1;
-  string session_id = 2;
-  int64 max_age_ms = 3;
-}
-
-message OauthCallbackResponse {
-  user.v1.User user = 1;
-  string session_id = 2;
-  int64 max_age_ms = 3;
-}
-
-message AdminLoginResponse {
-  user.v1.User user = 1;
-  string session_id = 2;
-  int64 max_age_ms = 3;
-}
-
-message ValidateSessionResponse {
-  bool valid = 1;
-  user.v1.User user = 2;
-}
-
-message AdminValidateSessionResponse {
-  bool valid = 1;
-  user.v1.User user = 2;
-}
-
-message ResendVerificationResponse {
-  string message = 1;
-}
-
-message RequestPasswordResetResponse {
-  string message = 1;
-}
-
-message SetNewPasswordResponse {
-  string message = 1;
+// Identity-only view of a user emitted by auth-service.
+message AuthUser {
+  string id = 1;
+  string email = 2;
+  string role = 3;
+  bool is_verified = 4;
 }
 
-message LogoutResponse {}
-
-message AdminLogoutResponse {}
-
-// --- Requests ---
-
 message RegisterRequest {
   string name = 1;
   string email = 2;
@@ -94,33 +48,64 @@ message LoginRequest {
   string password = 2;
 }
 
+message LoginResponse {
+  AuthUser user = 1;
+  string session_id = 2;
+  int64 max_age_ms = 3;
+}
+
 message LogoutRequest {
   string session_id = 1;
 }
 
+message LogoutResponse {}
+
 message ValidateSessionRequest {
   string session_id = 1;
 }
 
+message ValidateSessionResponse {
+  bool valid = 1;
+  AuthUser user = 2;
+}
+
 message ConfirmEmailRequest {
   string email = 1;
   string code = 2;
 }
 
+message ConfirmEmailResponse {
+  AuthUser user = 1;
+  string session_id = 2;
+  int64 max_age_ms = 3;
+}
+
 message ResendVerificationRequest {
   string email = 1;
 }
 
+message ResendVerificationResponse {
+  string message = 1;
+}
+
 message RequestPasswordResetRequest {
   string email = 1;
 }
 
+message RequestPasswordResetResponse {
+  string message = 1;
+}
+
 message SetNewPasswordRequest {
   string email = 1;
   string code = 2;
   string password = 3;
 }
 
+message SetNewPasswordResponse {
+  string message = 1;
+}
+
 message OauthConnectRequest {
   string provider = 1;
 }
@@ -135,15 +120,34 @@ message OauthCallbackRequest {
   string state = 3;
 }
 
+message OauthCallbackResponse {
+  AuthUser user = 1;
+  string session_id = 2;
+  int64 max_age_ms = 3;
+}
+
 message AdminLoginRequest {
   string email = 1;
   string password = 2;
 }
 
+message AdminLoginResponse {
+  AuthUser user = 1;
+  string session_id = 2;
+  int64 max_age_ms = 3;
+}
+
 message AdminLogoutRequest {
   string session_id = 1;
 }
 
+message AdminLogoutResponse {}
+
 message AdminValidateSessionRequest {
   string session_id = 1;
 }
+
+message AdminValidateSessionResponse {
+  bool valid = 1;
+  AuthUser user = 2;
+}

package/proto/collection/v1/collection.proto

@@ -0,0 +1,120 @@
+syntax = "proto3";
+
+package collection.v1;
+
+service CollectionService {
+  // Global catalog of media collections (Movies, Series, Books, ...).
+  rpc ListCollections(ListCollectionsRequest) returns (ListCollectionsResponse);
+  rpc GetCollectionById(GetCollectionByIdRequest) returns (GetCollectionByIdResponse);
+  rpc GetCollectionByName(GetCollectionByNameRequest) returns (GetCollectionByNameResponse);
+  rpc SeedInitialCollections(SeedInitialCollectionsRequest) returns (SeedInitialCollectionsResponse);
+
+  // Per-user enabled collections.
+  rpc GetUserCollections(GetUserCollectionsRequest) returns (GetUserCollectionsResponse);
+  rpc GetAllCollectionsWithUserStatus(GetAllCollectionsWithUserStatusRequest) returns (GetAllCollectionsWithUserStatusResponse);
+  rpc GetAvailableCollections(GetAvailableCollectionsRequest) returns (GetAvailableCollectionsResponse);
+  rpc AddCollectionToUser(AddCollectionToUserRequest) returns (AddCollectionToUserResponse);
+  rpc RemoveCollectionFromUser(RemoveCollectionFromUserRequest) returns (RemoveCollectionFromUserResponse);
+  rpc InitializeDefaultCollections(InitializeDefaultCollectionsRequest) returns (InitializeDefaultCollectionsResponse);
+}
+
+message Collection {
+  string id = 1;
+  string name = 2;
+  string created_at = 3;
+  string updated_at = 4;
+  // Number of Media records linked to the collection (returned by list/get).
+  int32 media_count = 5;
+}
+
+message CollectionWithUserStatus {
+  Collection collection = 1;
+  bool is_added = 2;
+}
+
+message UserCollection {
+  string id = 1;
+  string user_id = 2;
+  string collection_id = 3;
+  Collection collection = 4;
+  string created_at = 5;
+  string updated_at = 6;
+}
+
+message ListCollectionsRequest {}
+
+message ListCollectionsResponse {
+  repeated Collection items = 1;
+}
+
+message GetCollectionByIdRequest {
+  string collection_id = 1;
+}
+
+message GetCollectionByIdResponse {
+  Collection collection = 1;
+}
+
+message GetCollectionByNameRequest {
+  string name = 1;
+}
+
+message GetCollectionByNameResponse {
+  Collection collection = 1;
+}
+
+message SeedInitialCollectionsRequest {}
+
+message SeedInitialCollectionsResponse {
+  repeated Collection items = 1;
+}
+
+message GetUserCollectionsRequest {
+  string user_id = 1;
+}
+
+message GetUserCollectionsResponse {
+  repeated Collection items = 1;
+}
+
+message GetAllCollectionsWithUserStatusRequest {
+  string user_id = 1;
+}
+
+message GetAllCollectionsWithUserStatusResponse {
+  repeated CollectionWithUserStatus items = 1;
+}
+
+message GetAvailableCollectionsRequest {
+  string user_id = 1;
+}
+
+message GetAvailableCollectionsResponse {
+  repeated Collection items = 1;
+}
+
+message AddCollectionToUserRequest {
+  string user_id = 1;
+  string collection_id = 2;
+}
+
+message AddCollectionToUserResponse {
+  UserCollection user_collection = 1;
+}
+
+message RemoveCollectionFromUserRequest {
+  string user_id = 1;
+  string collection_id = 2;
+}
+
+message RemoveCollectionFromUserResponse {
+  string collection_id = 1;
+}
+
+message InitializeDefaultCollectionsRequest {
+  string user_id = 1;
+}
+
+message InitializeDefaultCollectionsResponse {
+  repeated UserCollection items = 1;
+}

package/proto/favorite/v1/favorite.proto

@@ -0,0 +1,79 @@
+syntax = "proto3";
+
+package favorite.v1;
+
+service FavoriteService {
+  rpc CheckMultipleFavorites(CheckMultipleFavoritesRequest) returns (CheckMultipleFavoritesResponse);
+  rpc ToggleFavorite(ToggleFavoriteRequest) returns (ToggleFavoriteResponse);
+  rpc IsFavorite(IsFavoriteRequest) returns (IsFavoriteResponse);
+  rpc ListUserFavorites(ListUserFavoritesRequest) returns (ListUserFavoritesResponse);
+  rpc RemoveAllForMedia(RemoveAllForMediaRequest) returns (RemoveAllForMediaResponse);
+}
+
+message Favorite {
+  string id = 1;
+  string user_id = 2;
+  string media_id = 3;
+  string created_at = 4;
+}
+
+message CheckMultipleFavoritesRequest {
+  string user_id = 1;
+  repeated string media_ids = 2;
+}
+
+// `results` is a `media_id -> bool` map (matches the legacy REST shape).
+message CheckMultipleFavoritesResponse {
+  map<string, bool> results = 1;
+}
+
+message ToggleFavoriteRequest {
+  string user_id = 1;
+  string media_id = 2;
+}
+
+message ToggleFavoriteResponse {
+  bool is_in_favorites = 1;
+}
+
+message IsFavoriteRequest {
+  string user_id = 1;
+  string media_id = 2;
+}
+
+message IsFavoriteResponse {
+  bool is_in_favorites = 1;
+}
+
+message ListUserFavoritesRequest {
+  string user_id = 1;
+  optional string search = 2;
+  optional string collection_id = 3;
+  int32 page = 4;
+  int32 limit = 5;
+  string sort_by = 6;
+  string sort_order = 7;
+}
+
+message FavoritePaginationMeta {
+  int32 page = 1;
+  int32 limit = 2;
+  int32 total = 3;
+  int32 total_pages = 4;
+  bool has_next_page = 5;
+  bool has_prev_page = 6;
+}
+
+message ListUserFavoritesResponse {
+  repeated Favorite data = 1;
+  FavoritePaginationMeta meta = 2;
+}
+
+// Used as a side-effect by library/media when content disappears.
+message RemoveAllForMediaRequest {
+  string media_id = 1;
+}
+
+message RemoveAllForMediaResponse {
+  int32 removed_count = 1;
+}

package/proto/image/v1/image.proto

@@ -0,0 +1,73 @@
+syntax = "proto3";
+
+package image.v1;
+
+service ImageService {
+  // Returns the binary image (proxied + optionally resized).
+  // Useful when the gateway streams it back to the client. Size hints are
+  // advisory; the implementation may ignore them.
+  rpc ProxyImage(ProxyImageRequest) returns (ProxyImageResponse);
+
+  // Resolves a TMDB poster path (e.g. "/abc.jpg") to an absolute URL.
+  rpc GetTmdbPosterUrl(GetTmdbPosterUrlRequest) returns (GetTmdbPosterUrlResponse);
+
+  // Uploads a single image to object storage (R2) and returns its public URL.
+  rpc UploadImage(UploadImageRequest) returns (UploadImageResponse);
+
+  // Removes an image from object storage by its public URL or key.
+  rpc DeleteImage(DeleteImageRequest) returns (DeleteImageResponse);
+}
+
+// TMDB poster size variants accepted by the legacy controller.
+enum TmdbPosterSize {
+  TMDB_POSTER_SIZE_UNSPECIFIED = 0;
+  TMDB_POSTER_SIZE_W92 = 1;
+  TMDB_POSTER_SIZE_W154 = 2;
+  TMDB_POSTER_SIZE_W185 = 3;
+  TMDB_POSTER_SIZE_W342 = 4;
+  TMDB_POSTER_SIZE_W500 = 5;
+  TMDB_POSTER_SIZE_W780 = 6;
+  TMDB_POSTER_SIZE_ORIGINAL = 7;
+}
+
+message ProxyImageRequest {
+  string url = 1;
+  optional int32 width = 2;
+  optional int32 height = 3;
+}
+
+message ProxyImageResponse {
+  bytes data = 1;
+  string content_type = 2;
+  int64 content_length = 3;
+}
+
+message GetTmdbPosterUrlRequest {
+  string poster_path = 1;
+  TmdbPosterSize size = 2;
+}
+
+message GetTmdbPosterUrlResponse {
+  string url = 1;
+}
+
+message UploadImageRequest {
+  // Raw file bytes. Allowed mime types: image/jpeg, image/png, image/webp.
+  // Max size: 4 MiB.
+  bytes data = 1;
+  string original_name = 2;
+  string mime_type = 3;
+}
+
+message UploadImageResponse {
+  string url = 1;
+  string original_name = 2;
+  int64 size = 3;
+}
+
+message DeleteImageRequest {
+  // Either a full URL (with public-host prefix) or just the storage key.
+  string url_or_key = 1;
+}
+
+message DeleteImageResponse {}

package/proto/library/v1/library.proto

@@ -0,0 +1,144 @@
+syntax = "proto3";
+
+package library.v1;
+
+import "media/v1/media.proto";
+
+service LibraryService {
+  rpc AddFromSearch(AddFromSearchRequest) returns (AddFromSearchResponse);
+  rpc GetUserLibrary(GetUserLibraryRequest) returns (GetUserLibraryResponse);
+  rpc GetLibraryItem(GetLibraryItemRequest) returns (GetLibraryItemResponse);
+  rpc UpdateLibraryItem(UpdateLibraryItemRequest) returns (UpdateLibraryItemResponse);
+  rpc RemoveFromLibrary(RemoveFromLibraryRequest) returns (RemoveFromLibraryResponse);
+  rpc IsInLibrary(IsInLibraryRequest) returns (IsInLibraryResponse);
+  rpc GetGenres(GetGenresRequest) returns (GetGenresResponse);
+}
+
+// Mirrors prisma enum Status (PLANNED/IN_PROGRESS/COMPLETED/DROPPED).
+enum LibraryItemStatus {
+  LIBRARY_ITEM_STATUS_UNSPECIFIED = 0;
+  LIBRARY_ITEM_STATUS_PLANNED = 1;
+  LIBRARY_ITEM_STATUS_IN_PROGRESS = 2;
+  LIBRARY_ITEM_STATUS_COMPLETED = 3;
+  LIBRARY_ITEM_STATUS_DROPPED = 4;
+}
+
+message LibraryItem {
+  string id = 1;
+  string user_id = 2;
+  string media_id = 3;
+  LibraryItemStatus status = 4;
+  optional double rating = 5;
+  optional string notes = 6;
+  string added_at = 7;
+  string updated_at = 8;
+  // Embedded media snapshot for the read paths (denormalized view).
+  media.v1.Media media = 9;
+  // Pre-aggregated counts to avoid extra round-trips on the gateway side.
+  int32 library_count = 10;
+  int32 reviews_count = 11;
+  bool is_favorite = 12;
+}
+
+// Compact search hit accepted by AddFromSearch (mirrors AddFromSearchDto.searchResult).
+message LibrarySearchHit {
+  string id = 1;
+  string title = 2;
+  optional string subtitle = 3;
+  optional string image_url = 4;
+  optional string year = 5;
+  string type = 6;
+  string source = 7;
+  optional string external_id = 8;
+  optional double rating = 9;
+  repeated string genres = 10;
+}
+
+message AddFromSearchRequest {
+  string user_id = 1;
+  LibrarySearchHit search_result = 2;
+  optional LibraryItemStatus status = 3;
+  optional double rating = 4;
+  optional string notes = 5;
+}
+
+message AddFromSearchResponse {
+  LibraryItem item = 1;
+}
+
+message GetUserLibraryRequest {
+  string user_id = 1;
+  repeated LibraryItemStatus statuses = 2;
+  optional string collection_name = 3;
+  optional media.v1.MediaSource source = 4;
+  optional string search = 5;
+  repeated string genres = 6;
+  optional double min_rating = 7;
+  optional double max_rating = 8;
+  optional int32 min_year = 9;
+  optional int32 max_year = 10;
+  int32 page = 11;
+  int32 limit = 12;
+  // addedAt | rating | title | releaseYear | favorites
+  string sort_by = 13;
+  string sort_order = 14;
+}
+
+message LibraryPaginationMeta {
+  int32 page = 1;
+  int32 limit = 2;
+  int32 total = 3;
+  int32 total_pages = 4;
+  bool has_next_page = 5;
+  bool has_prev_page = 6;
+}
+
+message GetUserLibraryResponse {
+  repeated LibraryItem data = 1;
+  LibraryPaginationMeta meta = 2;
+}
+
+message GetLibraryItemRequest {
+  string user_id = 1;
+  string media_id = 2;
+}
+
+message GetLibraryItemResponse {
+  LibraryItem item = 1;
+}
+
+message UpdateLibraryItemRequest {
+  string user_id = 1;
+  string media_id = 2;
+  optional LibraryItemStatus status = 3;
+  optional double rating = 4;
+  optional string notes = 5;
+}
+
+message UpdateLibraryItemResponse {
+  LibraryItem item = 1;
+}
+
+message RemoveFromLibraryRequest {
+  string user_id = 1;
+  string media_id = 2;
+}
+
+message RemoveFromLibraryResponse {}
+
+message IsInLibraryRequest {
+  string user_id = 1;
+  string media_id = 2;
+}
+
+message IsInLibraryResponse {
+  bool is_in_library = 1;
+}
+
+message GetGenresRequest {
+  string user_id = 1;
+}
+
+message GetGenresResponse {
+  repeated string genres = 1;
+}