feat(web): Add to Multiple Albums (#20072)

* Multi add to album picker:
- update modal for multi select
- Update add-to-album and add-to-album-action to work with new array return from AlbumPickerModal
- Add asset-utils.addAssetsToAlbums (incomplete)

* initial addToAlbums endpoint

* - fix endpoint
- add test

* - update return type
- make open-api

* - simplify return dto
- handle notification

* - fix returns
- clean up

* - update i18n
- format & check

* - checks

* - correct successId count
- fix assets_cannot_be_added language call

* tests

* foromat

* refactor

* - update successful add message to included total attempted

* - fix web test
- format i18n

* - fix open-api

* - fix imports to resolve checks

* - PR suggestions

* open-api

* refactor addAssetsToAlbums

* refactor it again

* - fix error returns and tests

* - swap icon for IconButton
- don't nest the buttons

* open-api

* - Cleanup multi-select button to match Thumbnail

* merge and openapi

* - remove onclick from icon element

* - fix double onClose call with keyboard shortcuts

* - spelling and formatting
- apply new api permission

* - open-api

* chore: styling

* translation

---------

Co-authored-by: Alex <alex.tran1502@gmail.com>

mobile/openapi/lib/api.dart

@@ -79,6 +79,8 @@ part 'model/album_user_add_dto.dart';
 part 'model/album_user_create_dto.dart';
 part 'model/album_user_response_dto.dart';
 part 'model/album_user_role.dart';
+part 'model/albums_add_assets_dto.dart';
+part 'model/albums_add_assets_response_dto.dart';
 part 'model/albums_response.dart';
 part 'model/albums_update.dart';
 part 'model/all_job_status_response_dto.dart';
@@ -113,6 +115,7 @@ part 'model/asset_visibility.dart';
 part 'model/audio_codec.dart';
 part 'model/auth_status_response_dto.dart';
 part 'model/avatar_update.dart';
+part 'model/bulk_id_error_reason.dart';
 part 'model/bulk_id_response_dto.dart';
 part 'model/bulk_ids_dto.dart';
 part 'model/clip_config.dart';

mobile/openapi/lib/api/albums_api.dart

@@ -91,6 +91,73 @@ class AlbumsApi {
     return null;
   }
 
+  /// This endpoint requires the `albumAsset.create` permission.
+  ///
+  /// Note: This method returns the HTTP [Response].
+  ///
+  /// Parameters:
+  ///
+  /// * [AlbumsAddAssetsDto] albumsAddAssetsDto (required):
+  ///
+  /// * [String] key:
+  ///
+  /// * [String] slug:
+  Future<Response> addAssetsToAlbumsWithHttpInfo(AlbumsAddAssetsDto albumsAddAssetsDto, { String? key, String? slug, }) async {
+    // ignore: prefer_const_declarations
+    final apiPath = r'/albums/assets';
+
+    // ignore: prefer_final_locals
+    Object? postBody = albumsAddAssetsDto;
+
+    final queryParams = <QueryParam>[];
+    final headerParams = <String, String>{};
+    final formParams = <String, String>{};
+
+    if (key != null) {
+      queryParams.addAll(_queryParams('', 'key', key));
+    }
+    if (slug != null) {
+      queryParams.addAll(_queryParams('', 'slug', slug));
+    }
+
+    const contentTypes = <String>['application/json'];
+
+
+    return apiClient.invokeAPI(
+      apiPath,
+      'PUT',
+      queryParams,
+      postBody,
+      headerParams,
+      formParams,
+      contentTypes.isEmpty ? null : contentTypes.first,
+    );
+  }
+
+  /// This endpoint requires the `albumAsset.create` permission.
+  ///
+  /// Parameters:
+  ///
+  /// * [AlbumsAddAssetsDto] albumsAddAssetsDto (required):
+  ///
+  /// * [String] key:
+  ///
+  /// * [String] slug:
+  Future<AlbumsAddAssetsResponseDto?> addAssetsToAlbums(AlbumsAddAssetsDto albumsAddAssetsDto, { String? key, String? slug, }) async {
+    final response = await addAssetsToAlbumsWithHttpInfo(albumsAddAssetsDto,  key: key, slug: slug, );
+    if (response.statusCode >= HttpStatus.badRequest) {
+      throw ApiException(response.statusCode, await _decodeBodyBytes(response));
+    }
+    // When a remote server returns no body with a status of 204, we shall not decode it.
+    // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
+    // FormatException when trying to decode an empty string.
+    if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
+      return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'AlbumsAddAssetsResponseDto',) as AlbumsAddAssetsResponseDto;
+    
+    }
+    return null;
+  }
+
   /// This endpoint requires the `albumUser.create` permission.
   ///
   /// Note: This method returns the HTTP [Response].

mobile/openapi/lib/api_client.dart

@@ -212,6 +212,10 @@ class ApiClient {
           return AlbumUserResponseDto.fromJson(value);
         case 'AlbumUserRole':
           return AlbumUserRoleTypeTransformer().decode(value);
+        case 'AlbumsAddAssetsDto':
+          return AlbumsAddAssetsDto.fromJson(value);
+        case 'AlbumsAddAssetsResponseDto':
+          return AlbumsAddAssetsResponseDto.fromJson(value);
         case 'AlbumsResponse':
           return AlbumsResponse.fromJson(value);
         case 'AlbumsUpdate':
@@ -280,6 +284,8 @@ class ApiClient {
           return AuthStatusResponseDto.fromJson(value);
         case 'AvatarUpdate':
           return AvatarUpdate.fromJson(value);
+        case 'BulkIdErrorReason':
+          return BulkIdErrorReasonTypeTransformer().decode(value);
         case 'BulkIdResponseDto':
           return BulkIdResponseDto.fromJson(value);
         case 'BulkIdsDto':

mobile/openapi/lib/api_helper.dart

@@ -79,6 +79,9 @@ String parameterToString(dynamic value) {
   if (value is AudioCodec) {
     return AudioCodecTypeTransformer().encode(value).toString();
   }
+  if (value is BulkIdErrorReason) {
+    return BulkIdErrorReasonTypeTransformer().encode(value).toString();
+  }
   if (value is CQMode) {
     return CQModeTypeTransformer().encode(value).toString();
   }

mobile/openapi/lib/model/albums_add_assets_dto.dart

@@ -0,0 +1,111 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.18
+
+// ignore_for_file: unused_element, unused_import
+// ignore_for_file: always_put_required_named_parameters_first
+// ignore_for_file: constant_identifier_names
+// ignore_for_file: lines_longer_than_80_chars
+
+part of openapi.api;
+
+class AlbumsAddAssetsDto {
+  /// Returns a new [AlbumsAddAssetsDto] instance.
+  AlbumsAddAssetsDto({
+    this.albumIds = const [],
+    this.assetIds = const [],
+  });
+
+  List<String> albumIds;
+
+  List<String> assetIds;
+
+  @override
+  bool operator ==(Object other) => identical(this, other) || other is AlbumsAddAssetsDto &&
+    _deepEquality.equals(other.albumIds, albumIds) &&
+    _deepEquality.equals(other.assetIds, assetIds);
+
+  @override
+  int get hashCode =>
+    // ignore: unnecessary_parenthesis
+    (albumIds.hashCode) +
+    (assetIds.hashCode);
+
+  @override
+  String toString() => 'AlbumsAddAssetsDto[albumIds=$albumIds, assetIds=$assetIds]';
+
+  Map<String, dynamic> toJson() {
+    final json = <String, dynamic>{};
+      json[r'albumIds'] = this.albumIds;
+      json[r'assetIds'] = this.assetIds;
+    return json;
+  }
+
+  /// Returns a new [AlbumsAddAssetsDto] instance and imports its values from
+  /// [value] if it's a [Map], null otherwise.
+  // ignore: prefer_constructors_over_static_methods
+  static AlbumsAddAssetsDto? fromJson(dynamic value) {
+    upgradeDto(value, "AlbumsAddAssetsDto");
+    if (value is Map) {
+      final json = value.cast<String, dynamic>();
+
+      return AlbumsAddAssetsDto(
+        albumIds: json[r'albumIds'] is Iterable
+            ? (json[r'albumIds'] as Iterable).cast<String>().toList(growable: false)
+            : const [],
+        assetIds: json[r'assetIds'] is Iterable
+            ? (json[r'assetIds'] as Iterable).cast<String>().toList(growable: false)
+            : const [],
+      );
+    }
+    return null;
+  }
+
+  static List<AlbumsAddAssetsDto> listFromJson(dynamic json, {bool growable = false,}) {
+    final result = <AlbumsAddAssetsDto>[];
+    if (json is List && json.isNotEmpty) {
+      for (final row in json) {
+        final value = AlbumsAddAssetsDto.fromJson(row);
+        if (value != null) {
+          result.add(value);
+        }
+      }
+    }
+    return result.toList(growable: growable);
+  }
+
+  static Map<String, AlbumsAddAssetsDto> mapFromJson(dynamic json) {
+    final map = <String, AlbumsAddAssetsDto>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = AlbumsAddAssetsDto.fromJson(entry.value);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  // maps a json object with a list of AlbumsAddAssetsDto-objects as value to a dart map
+  static Map<String, List<AlbumsAddAssetsDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
+    final map = <String, List<AlbumsAddAssetsDto>>{};
+    if (json is Map && json.isNotEmpty) {
+      // ignore: parameter_assignments
+      json = json.cast<String, dynamic>();
+      for (final entry in json.entries) {
+        map[entry.key] = AlbumsAddAssetsDto.listFromJson(entry.value, growable: growable,);
+      }
+    }
+    return map;
+  }
+
+  /// The list of required keys that must be present in a JSON.
+  static const requiredKeys = <String>{
+    'albumIds',
+    'assetIds',
+  };
+}
+

mobile/openapi/lib/model/albums_add_assets_response_dto.dart

@@ -0,0 +1,132 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.18
+
+// ignore_for_file: unused_element, unused_import
+// ignore_for_file: always_put_required_named_parameters_first
+// ignore_for_file: constant_identifier_names
+// ignore_for_file: lines_longer_than_80_chars
+
+part of openapi.api;
+
+class AlbumsAddAssetsResponseDto {
+  /// Returns a new [AlbumsAddAssetsResponseDto] instance.
+  AlbumsAddAssetsResponseDto({
+    required this.albumSuccessCount,
+    required this.assetSuccessCount,
+    this.error,
+    required this.success,
+  });
+
+  int albumSuccessCount;
+
+  int assetSuccessCount;
+
+  ///
+  /// Please note: This property should have been non-nullable! Since the specification file
+  /// does not include a default value (using the "default:" property), however, the generated
+  /// source code must fall back to having a nullable type.
+  /// Consider adding a "default:" property in the specification file to hide this note.
+  ///
+  BulkIdErrorReason? error;
+
+  bool success;
+
+  @override
+  bool operator ==(Object other) => identical(this, other) || other is AlbumsAddAssetsResponseDto &&
+    other.albumSuccessCount == albumSuccessCount &&
+    other.assetSuccessCount == assetSuccessCount &&
+    other.error == error &&
+    other.success == success;
+
+  @override
+  int get hashCode =>
+    // ignore: unnecessary_parenthesis
+    (albumSuccessCount.hashCode) +
+    (assetSuccessCount.hashCode) +
+    (error == null ? 0 : error!.hashCode) +
+    (success.hashCode);
+
+  @override
+  String toString() => 'AlbumsAddAssetsResponseDto[albumSuccessCount=$albumSuccessCount, assetSuccessCount=$assetSuccessCount, error=$error, success=$success]';
+
+  Map<String, dynamic> toJson() {
+    final json = <String, dynamic>{};
+      json[r'albumSuccessCount'] = this.albumSuccessCount;
+      json[r'assetSuccessCount'] = this.assetSuccessCount;
+    if (this.error != null) {
+      json[r'error'] = this.error;
+    } else {
+    //  json[r'error'] = null;
+    }
+      json[r'success'] = this.success;
+    return json;
+  }
+
+  /// Returns a new [AlbumsAddAssetsResponseDto] instance and imports its values from
+  /// [value] if it's a [Map], null otherwise.
+  // ignore: prefer_constructors_over_static_methods
+  static AlbumsAddAssetsResponseDto? fromJson(dynamic value) {
+    upgradeDto(value, "AlbumsAddAssetsResponseDto");
+    if (value is Map) {
+      final json = value.cast<String, dynamic>();
+
+      return AlbumsAddAssetsResponseDto(
+        albumSuccessCount: mapValueOfType<int>(json, r'albumSuccessCount')!,
+        assetSuccessCount: mapValueOfType<int>(json, r'assetSuccessCount')!,
+        error: BulkIdErrorReason.fromJson(json[r'error']),
+        success: mapValueOfType<bool>(json, r'success')!,
+      );
+    }
+    return null;
+  }
+
+  static List<AlbumsAddAssetsResponseDto> listFromJson(dynamic json, {bool growable = false,}) {
+    final result = <AlbumsAddAssetsResponseDto>[];
+    if (json is List && json.isNotEmpty) {
+      for (final row in json) {
+        final value = AlbumsAddAssetsResponseDto.fromJson(row);
+        if (value != null) {
+          result.add(value);
+        }
+      }
+    }
+    return result.toList(growable: growable);
+  }
+
+  static Map<String, AlbumsAddAssetsResponseDto> mapFromJson(dynamic json) {
+    final map = <String, AlbumsAddAssetsResponseDto>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = AlbumsAddAssetsResponseDto.fromJson(entry.value);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  // maps a json object with a list of AlbumsAddAssetsResponseDto-objects as value to a dart map
+  static Map<String, List<AlbumsAddAssetsResponseDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
+    final map = <String, List<AlbumsAddAssetsResponseDto>>{};
+    if (json is Map && json.isNotEmpty) {
+      // ignore: parameter_assignments
+      json = json.cast<String, dynamic>();
+      for (final entry in json.entries) {
+        map[entry.key] = AlbumsAddAssetsResponseDto.listFromJson(entry.value, growable: growable,);
+      }
+    }
+    return map;
+  }
+
+  /// The list of required keys that must be present in a JSON.
+  static const requiredKeys = <String>{
+    'albumSuccessCount',
+    'assetSuccessCount',
+    'success',
+  };
+}
+

mobile/openapi/lib/model/bulk_id_error_reason.dart

@@ -0,0 +1,91 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.18
+
+// ignore_for_file: unused_element, unused_import
+// ignore_for_file: always_put_required_named_parameters_first
+// ignore_for_file: constant_identifier_names
+// ignore_for_file: lines_longer_than_80_chars
+
+part of openapi.api;
+
+
+class BulkIdErrorReason {
+  /// Instantiate a new enum with the provided [value].
+  const BulkIdErrorReason._(this.value);
+
+  /// The underlying value of this enum member.
+  final String value;
+
+  @override
+  String toString() => value;
+
+  String toJson() => value;
+
+  static const duplicate = BulkIdErrorReason._(r'duplicate');
+  static const noPermission = BulkIdErrorReason._(r'no_permission');
+  static const notFound = BulkIdErrorReason._(r'not_found');
+  static const unknown = BulkIdErrorReason._(r'unknown');
+
+  /// List of all possible values in this [enum][BulkIdErrorReason].
+  static const values = <BulkIdErrorReason>[
+    duplicate,
+    noPermission,
+    notFound,
+    unknown,
+  ];
+
+  static BulkIdErrorReason? fromJson(dynamic value) => BulkIdErrorReasonTypeTransformer().decode(value);
+
+  static List<BulkIdErrorReason> listFromJson(dynamic json, {bool growable = false,}) {
+    final result = <BulkIdErrorReason>[];
+    if (json is List && json.isNotEmpty) {
+      for (final row in json) {
+        final value = BulkIdErrorReason.fromJson(row);
+        if (value != null) {
+          result.add(value);
+        }
+      }
+    }
+    return result.toList(growable: growable);
+  }
+}
+
+/// Transformation class that can [encode] an instance of [BulkIdErrorReason] to String,
+/// and [decode] dynamic data back to [BulkIdErrorReason].
+class BulkIdErrorReasonTypeTransformer {
+  factory BulkIdErrorReasonTypeTransformer() => _instance ??= const BulkIdErrorReasonTypeTransformer._();
+
+  const BulkIdErrorReasonTypeTransformer._();
+
+  String encode(BulkIdErrorReason data) => data.value;
+
+  /// Decodes a [dynamic value][data] to a BulkIdErrorReason.
+  ///
+  /// If [allowNull] is true and the [dynamic value][data] cannot be decoded successfully,
+  /// then null is returned. However, if [allowNull] is false and the [dynamic value][data]
+  /// cannot be decoded successfully, then an [UnimplementedError] is thrown.
+  ///
+  /// The [allowNull] is very handy when an API changes and a new enum value is added or removed,
+  /// and users are still using an old app with the old code.
+  BulkIdErrorReason? decode(dynamic data, {bool allowNull = true}) {
+    if (data != null) {
+      switch (data) {
+        case r'duplicate': return BulkIdErrorReason.duplicate;
+        case r'no_permission': return BulkIdErrorReason.noPermission;
+        case r'not_found': return BulkIdErrorReason.notFound;
+        case r'unknown': return BulkIdErrorReason.unknown;
+        default:
+          if (!allowNull) {
+            throw ArgumentError('Unknown enum value to decode: $data');
+          }
+      }
+    }
+    return null;
+  }
+
+  /// Singleton [BulkIdErrorReasonTypeTransformer] instance.
+  static BulkIdErrorReasonTypeTransformer? _instance;
+}
+