feat: Add description (#2237)

* Added dto, logic to insert description and web implementation * create text field and update on remote database * Update description and save changes * styling * fix web test * fix server test * preserve description on metadata extraction job run * handle exif info is null situation * pr feedback * format openapi spec * update createAssetDto * refactor logic to service * move files * only owner can update description * Render description correctly in shared album * Render description correctly in shared link * disable description edit for not owner of asset on mobile * localization and clean up * fix test * Uses providers for description text (#2244) * uses providers for description text * comments * fixes initial data setting * fixes notifier --------- Co-authored-by: martyfuhry <martyfuhry@gmail.com>
2025-10-29 17:40:28 +00:00 · 2023-04-13 10:22:06 -05:00
parent 561b208508
commit a9859bc029
27 changed files with 843 additions and 178 deletions
--- a/mobile/lib/modules/asset_viewer/services/asset_description.service.dart
+++ b/mobile/lib/modules/asset_viewer/services/asset_description.service.dart
@@ -0,0 +1,62 @@
+import 'package:hooks_riverpod/hooks_riverpod.dart';
+import 'package:immich_mobile/shared/models/exif_info.dart';
+import 'package:immich_mobile/shared/providers/api.provider.dart';
+import 'package:immich_mobile/shared/providers/db.provider.dart';
+import 'package:immich_mobile/shared/services/api.service.dart';
+import 'package:isar/isar.dart';
+import 'package:openapi/api.dart';
+
+class AssetDescriptionService {
+  AssetDescriptionService(this._db, this._api);
+
+  final Isar _db;
+  final ApiService _api;
+
+  setDescription(
+    String description,
+    String remoteAssetId,
+    int localExifId,
+  ) async {
+    final result = await _api.assetApi.updateAsset(
+      remoteAssetId,
+      UpdateAssetDto(description: description),
+    );
+
+    if (result?.exifInfo?.description != null) {
+      var exifInfo = await _db.exifInfos.get(localExifId);
+
+      if (exifInfo != null) {
+        exifInfo.description = result!.exifInfo!.description;
+        await _db.writeTxn(
+          () => _db.exifInfos.put(exifInfo),
+        );
+      }
+    }
+  }
+
+  Future<String> readLatest(String assetRemoteId, int localExifId) async {
+    final latestAssetFromServer =
+        await _api.assetApi.getAssetById(assetRemoteId);
+    final localExifInfo = await _db.exifInfos.get(localExifId);
+
+    if (latestAssetFromServer != null && localExifInfo != null) {
+      localExifInfo.description =
+          latestAssetFromServer.exifInfo?.description ?? '';
+
+      await _db.writeTxn(
+        () => _db.exifInfos.put(localExifInfo),
+      );
+
+      return localExifInfo.description!;
+    }
+
+    return "";
+  }
+}
+
+final assetDescriptionServiceProvider = Provider(
+  (ref) => AssetDescriptionService(
+    ref.watch(dbProvider),
+    ref.watch(apiServiceProvider),
+  ),
+);