refactor(mobile): introduce Album & User classes (#1561)

replace usages of AlbumResponseDto with Album replace usages of UserResponseDto with User
2025-10-29 17:40:28 +00:00 · 2023-02-06 08:13:32 +01:00
parent 527aa61a87
commit 2139853dd9
25 changed files with 475 additions and 255 deletions
--- a/mobile/lib/modules/album/ui/add_to_album_bottom_sheet.dart
+++ b/mobile/lib/modules/album/ui/add_to_album_bottom_sheet.dart
@@ -8,10 +8,10 @@ import 'package:immich_mobile/modules/album/providers/shared_album.provider.dart
 import 'package:immich_mobile/modules/album/services/album.service.dart';
 import 'package:immich_mobile/modules/album/ui/add_to_album_sliverlist.dart';
 import 'package:immich_mobile/routing/router.dart';
+import 'package:immich_mobile/shared/models/album.dart';
 import 'package:immich_mobile/shared/models/asset.dart';
 import 'package:immich_mobile/shared/ui/drag_sheet.dart';
 import 'package:immich_mobile/shared/ui/immich_toast.dart';
-import 'package:openapi/api.dart';

 class AddToAlbumBottomSheet extends HookConsumerWidget {
  /// The asset to add to an album
@@ -39,22 +39,22 @@ class AddToAlbumBottomSheet extends HookConsumerWidget {
      [],
    );

-    void addToAlbum(AlbumResponseDto album) async {
+    void addToAlbum(Album album) async {
      final result = await albumService.addAdditionalAssetToAlbum(
        assets,
-        album.id,
+        album,
      );

      if (result != null) {
        if (result.alreadyInAlbum.isNotEmpty) {
          ImmichToast.show(
            context: context,
-            msg: 'Already in ${album.albumName}',
+            msg: 'Already in ${album.name}',
          );
        } else {
          ImmichToast.show(
            context: context,
-            msg: 'Added to ${album.albumName}',
+            msg: 'Added to ${album.name}',
          );
        }
      }
--- a/mobile/lib/modules/album/ui/add_to_album_sliverlist.dart
+++ b/mobile/lib/modules/album/ui/add_to_album_sliverlist.dart
@@ -1,14 +1,13 @@
 import 'package:flutter/material.dart';
 import 'package:hooks_riverpod/hooks_riverpod.dart';
 import 'package:immich_mobile/modules/album/ui/album_thumbnail_listtile.dart';
-import 'package:openapi/api.dart';
+import 'package:immich_mobile/shared/models/album.dart';

 class AddToAlbumSliverList extends HookConsumerWidget {
-
  /// The asset to add to an album
-  final List<AlbumResponseDto> albums;
-  final List<AlbumResponseDto> sharedAlbums;
-  final void Function(AlbumResponseDto) onAddToAlbum;
+  final List<Album> albums;
+  final List<Album> sharedAlbums;
+  final void Function(Album) onAddToAlbum;

  const AddToAlbumSliverList({
    Key? key,
@@ -21,36 +20,36 @@ class AddToAlbumSliverList extends HookConsumerWidget {
  Widget build(BuildContext context, WidgetRef ref) {
    return SliverList(
      delegate: SliverChildBuilderDelegate(
-        childCount: albums.length + (sharedAlbums.isEmpty ? 0 : 1),
-        (context, index) {
-          // Build shared expander
-          if (index == 0 && sharedAlbums.isNotEmpty) {
-              return Padding(
-                padding: const EdgeInsets.only(bottom: 8),
-                child: ExpansionTile(
-                  title: const Text('Shared'),
-                  tilePadding: const EdgeInsets.symmetric(horizontal: 10.0),
-                  leading: const Icon(Icons.group),
-                  children: sharedAlbums.map((album) => 
-                    AlbumThumbnailListTile(
+          childCount: albums.length + (sharedAlbums.isEmpty ? 0 : 1),
+          (context, index) {
+        // Build shared expander
+        if (index == 0 && sharedAlbums.isNotEmpty) {
+          return Padding(
+            padding: const EdgeInsets.only(bottom: 8),
+            child: ExpansionTile(
+              title: const Text('Shared'),
+              tilePadding: const EdgeInsets.symmetric(horizontal: 10.0),
+              leading: const Icon(Icons.group),
+              children: sharedAlbums
+                  .map(
+                    (album) => AlbumThumbnailListTile(
                      album: album,
                      onTap: () => onAddToAlbum(album),
                    ),
-                  ).toList(),
-                ),
-              );
-          }
-
-          // Build albums list
-          final offset = index - (sharedAlbums.isNotEmpty ? 1 : 0);
-          final album = albums[offset];
-          return AlbumThumbnailListTile(
-            album: album,
-            onTap: () => onAddToAlbum(album),
+                  )
+                  .toList(),
+            ),
          );
        }
-      ),

+        // Build albums list
+        final offset = index - (sharedAlbums.isNotEmpty ? 1 : 0);
+        final album = albums[offset];
+        return AlbumThumbnailListTile(
+          album: album,
+          onTap: () => onAddToAlbum(album),
+        );
+      }),
    );
  }
 }
--- a/mobile/lib/modules/album/ui/album_thumbnail_card.dart
+++ b/mobile/lib/modules/album/ui/album_thumbnail_card.dart
@@ -5,6 +5,7 @@ import 'package:flutter/material.dart';
 import 'package:hive/hive.dart';
 import 'package:immich_mobile/constants/hive_box.dart';
 import 'package:immich_mobile/routing/router.dart';
+import 'package:immich_mobile/shared/models/album.dart';
 import 'package:immich_mobile/utils/image_url_builder.dart';
 import 'package:openapi/api.dart';

@@ -14,7 +15,7 @@ class AlbumThumbnailCard extends StatelessWidget {
    required this.album,
  }) : super(key: key);

-  final AlbumResponseDto album;
+  final Album album;

  @override
  Widget build(BuildContext context) {
@@ -72,7 +73,7 @@ class AlbumThumbnailCard extends StatelessWidget {
              child: SizedBox(
                width: cardSize,
                child: Text(
-                  album.albumName,
+                  album.name,
                  style: const TextStyle(
                    fontWeight: FontWeight.bold,
                  ),
--- a/mobile/lib/modules/album/ui/album_thumbnail_listtile.dart
+++ b/mobile/lib/modules/album/ui/album_thumbnail_listtile.dart
@@ -5,6 +5,7 @@ import 'package:flutter/material.dart';
 import 'package:hive/hive.dart';
 import 'package:immich_mobile/constants/hive_box.dart';
 import 'package:immich_mobile/routing/router.dart';
+import 'package:immich_mobile/shared/models/album.dart';
 import 'package:immich_mobile/utils/image_url_builder.dart';
 import 'package:openapi/api.dart';

@@ -15,7 +16,7 @@ class AlbumThumbnailListTile extends StatelessWidget {
    this.onTap,
  }) : super(key: key);

-  final AlbumResponseDto album;
+  final Album album;
  final void Function()? onTap;

  @override
@@ -80,7 +81,7 @@ class AlbumThumbnailListTile extends StatelessWidget {
                crossAxisAlignment: CrossAxisAlignment.start,
                children: [
                  Text(
-                    album.albumName,
+                    album.name,
                    style: const TextStyle(
                      fontWeight: FontWeight.bold,
                    ),
--- a/mobile/lib/modules/album/ui/album_viewer_appbar.dart
+++ b/mobile/lib/modules/album/ui/album_viewer_appbar.dart
@@ -9,21 +9,19 @@ import 'package:immich_mobile/modules/album/providers/asset_selection.provider.d
 import 'package:immich_mobile/modules/album/providers/shared_album.provider.dart';
 import 'package:immich_mobile/modules/album/services/album.service.dart';
 import 'package:immich_mobile/routing/router.dart';
+import 'package:immich_mobile/shared/models/album.dart';
 import 'package:immich_mobile/shared/ui/immich_toast.dart';
 import 'package:immich_mobile/shared/views/immich_loading_overlay.dart';
-import 'package:openapi/api.dart';

 class AlbumViewerAppbar extends HookConsumerWidget with PreferredSizeWidget {
  const AlbumViewerAppbar({
    Key? key,
-    required this.albumInfo,
+    required this.album,
    required this.userId,
-    required this.albumId,
  }) : super(key: key);

-  final AlbumResponseDto albumInfo;
+  final Album album;
  final String userId;
-  final String albumId;

  @override
  Widget build(BuildContext context, WidgetRef ref) {
@@ -34,19 +32,18 @@ class AlbumViewerAppbar extends HookConsumerWidget with PreferredSizeWidget {
    final newAlbumTitle = ref.watch(albumViewerProvider).editTitleText;
    final isEditAlbum = ref.watch(albumViewerProvider).isEditAlbum;

-    void onDeleteAlbumPressed(String albumId) async {
+    void onDeleteAlbumPressed() async {
      ImmichLoadingOverlayController.appLoader.show();

-      bool isSuccess =
-          await ref.watch(albumServiceProvider).deleteAlbum(albumId);
+      bool isSuccess = await ref.watch(albumServiceProvider).deleteAlbum(album);

      if (isSuccess) {
-        if (albumInfo.shared) {
-          ref.watch(sharedAlbumProvider.notifier).deleteAlbum(albumId);
+        if (album.shared) {
+          ref.watch(sharedAlbumProvider.notifier).deleteAlbum(album);
          AutoRouter.of(context)
              .navigate(const TabControllerRoute(children: [SharingRoute()]));
        } else {
-          ref.watch(albumProvider.notifier).deleteAlbum(albumId);
+          ref.watch(albumProvider.notifier).deleteAlbum(album);
          AutoRouter.of(context)
              .navigate(const TabControllerRoute(children: [LibraryRoute()]));
        }
@@ -62,11 +59,11 @@ class AlbumViewerAppbar extends HookConsumerWidget with PreferredSizeWidget {
      ImmichLoadingOverlayController.appLoader.hide();
    }

-    void onLeaveAlbumPressed(String albumId) async {
+    void onLeaveAlbumPressed() async {
      ImmichLoadingOverlayController.appLoader.show();

      bool isSuccess =
-          await ref.watch(sharedAlbumProvider.notifier).leaveAlbum(albumId);
+          await ref.watch(sharedAlbumProvider.notifier).leaveAlbum(album);

      if (isSuccess) {
        AutoRouter.of(context)
@@ -84,20 +81,20 @@ class AlbumViewerAppbar extends HookConsumerWidget with PreferredSizeWidget {
      ImmichLoadingOverlayController.appLoader.hide();
    }

-    void onRemoveFromAlbumPressed(String albumId) async {
+    void onRemoveFromAlbumPressed() async {
      ImmichLoadingOverlayController.appLoader.show();

      bool isSuccess =
          await ref.watch(sharedAlbumProvider.notifier).removeAssetFromAlbum(
-                albumId,
-                selectedAssetsInAlbum.map((a) => a.id).toList(),
+                album,
+                selectedAssetsInAlbum,
              );

      if (isSuccess) {
        Navigator.pop(context);
        ref.watch(assetSelectionProvider.notifier).disableMultiselection();
        ref.watch(albumProvider.notifier).getAllAlbums();
-        ref.invalidate(sharedAlbumDetailProvider(albumId));
+        ref.invalidate(sharedAlbumDetailProvider(album.id));
      } else {
        Navigator.pop(context);
        ImmichToast.show(
@@ -113,27 +110,27 @@ class AlbumViewerAppbar extends HookConsumerWidget with PreferredSizeWidget {

    buildBottomSheetActionButton() {
      if (isMultiSelectionEnable) {
-        if (albumInfo.ownerId == userId) {
+        if (album.ownerId == userId) {
          return ListTile(
            leading: const Icon(Icons.delete_sweep_rounded),
            title: const Text(
              'album_viewer_appbar_share_remove',
              style: TextStyle(fontWeight: FontWeight.bold),
            ).tr(),
-            onTap: () => onRemoveFromAlbumPressed(albumId),
+            onTap: () => onRemoveFromAlbumPressed(),
          );
        } else {
          return const SizedBox();
        }
      } else {
-        if (albumInfo.ownerId == userId) {
+        if (album.ownerId == userId) {
          return ListTile(
            leading: const Icon(Icons.delete_forever_rounded),
            title: const Text(
              'album_viewer_appbar_share_delete',
              style: TextStyle(fontWeight: FontWeight.bold),
            ).tr(),
-            onTap: () => onDeleteAlbumPressed(albumId),
+            onTap: () => onDeleteAlbumPressed(),
          );
        } else {
          return ListTile(
@@ -142,7 +139,7 @@ class AlbumViewerAppbar extends HookConsumerWidget with PreferredSizeWidget {
              'album_viewer_appbar_share_leave',
              style: TextStyle(fontWeight: FontWeight.bold),
            ).tr(),
-            onTap: () => onLeaveAlbumPressed(albumId),
+            onTap: () => onLeaveAlbumPressed(),
          );
        }
      }
@@ -180,7 +177,7 @@ class AlbumViewerAppbar extends HookConsumerWidget with PreferredSizeWidget {
          onPressed: () async {
            bool isSuccess = await ref
                .watch(albumViewerProvider.notifier)
-                .changeAlbumTitle(albumId, userId, newAlbumTitle);
+                .changeAlbumTitle(album, newAlbumTitle);

            if (!isSuccess) {
              ImmichToast.show(
--- a/mobile/lib/modules/album/ui/album_viewer_editable_title.dart
+++ b/mobile/lib/modules/album/ui/album_viewer_editable_title.dart
@@ -3,21 +3,20 @@ import 'package:flutter/material.dart';
 import 'package:flutter_hooks/flutter_hooks.dart';
 import 'package:hooks_riverpod/hooks_riverpod.dart';
 import 'package:immich_mobile/modules/album/providers/album_viewer.provider.dart';
-import 'package:openapi/api.dart';
+import 'package:immich_mobile/shared/models/album.dart';

 class AlbumViewerEditableTitle extends HookConsumerWidget {
-  final AlbumResponseDto albumInfo;
+  final Album album;
  final FocusNode titleFocusNode;
  const AlbumViewerEditableTitle({
    Key? key,
-    required this.albumInfo,
+    required this.album,
    required this.titleFocusNode,
  }) : super(key: key);

  @override
  Widget build(BuildContext context, WidgetRef ref) {
-    final titleTextEditController =
-        useTextEditingController(text: albumInfo.albumName);
+    final titleTextEditController = useTextEditingController(text: album.name);
    final isDarkTheme = Theme.of(context).brightness == Brightness.dark;

    void onFocusModeChange() {
@@ -50,9 +49,7 @@ class AlbumViewerEditableTitle extends HookConsumerWidget {
      onTap: () {
        FocusScope.of(context).requestFocus(titleFocusNode);

-        ref
-            .watch(albumViewerProvider.notifier)
-            .setEditTitleText(albumInfo.albumName);
+        ref.watch(albumViewerProvider.notifier).setEditTitleText(album.name);
        ref.watch(albumViewerProvider.notifier).enableEditAlbum();

        if (titleTextEditController.text == 'Untitled') {