feat(server/web): album description (immich-app#3558)

* feat(server): add album description * chore: open api * fix: tests * show and edit description on the web * fix test * remove unused code * type event * format fix --------- Co-authored-by: Alex Tran <[email protected]>
freeton · Aug 6, 2023 · 2f26a7e · 2f26a7e
1 parent deaf81e
commit 2f26a7e
Show file tree

Hide file tree

Showing 28 changed files with 287 additions and 41 deletions.
diff --git a/cli/src/api/open-api/api.ts b/cli/src/api/open-api/api.ts
diff --git a/mobile/openapi/doc/AlbumResponseDto.md b/mobile/openapi/doc/AlbumResponseDto.md
diff --git a/mobile/openapi/doc/CreateAlbumDto.md b/mobile/openapi/doc/CreateAlbumDto.md
diff --git a/mobile/openapi/doc/UpdateAlbumDto.md b/mobile/openapi/doc/UpdateAlbumDto.md
diff --git a/mobile/openapi/lib/model/album_response_dto.dart b/mobile/openapi/lib/model/album_response_dto.dart
diff --git a/mobile/openapi/lib/model/create_album_dto.dart b/mobile/openapi/lib/model/create_album_dto.dart
diff --git a/mobile/openapi/lib/model/update_album_dto.dart b/mobile/openapi/lib/model/update_album_dto.dart
diff --git a/mobile/openapi/test/album_response_dto_test.dart b/mobile/openapi/test/album_response_dto_test.dart
diff --git a/mobile/openapi/test/create_album_dto_test.dart b/mobile/openapi/test/create_album_dto_test.dart
diff --git a/mobile/openapi/test/update_album_dto_test.dart b/mobile/openapi/test/update_album_dto_test.dart
diff --git a/server/immich-openapi-specs.json b/server/immich-openapi-specs.json
@@ -4754,6 +4754,9 @@
             "format": "date-time",
             "type": "string"
           },
+          "description": {
+            "type": "string"
+          },
           "id": {
             "type": "string"
           },
@@ -4786,6 +4789,7 @@
           "id",
           "ownerId",
           "albumName",
+          "description",
           "createdAt",
           "updatedAt",
           "albumThumbnailAssetId",
@@ -5264,6 +5268,9 @@
             },
             "type": "array"
           },
+          "description": {
+            "type": "string"
+          },
           "sharedWithUserIds": {
             "items": {
               "format": "uuid",
@@ -6903,6 +6910,9 @@
           "albumThumbnailAssetId": {
             "format": "uuid",
             "type": "string"
+          },
+          "description": {
+            "type": "string"
           }
         },
         "type": "object"

diff --git a/server/src/domain/album/album-response.dto.ts b/server/src/domain/album/album-response.dto.ts
@@ -7,6 +7,7 @@ export class AlbumResponseDto {
   id!: string;
   ownerId!: string;
   albumName!: string;
+  description!: string;
   createdAt!: Date;
   updatedAt!: Date;
   albumThumbnailAssetId!: string | null;
@@ -19,7 +20,7 @@ export class AlbumResponseDto {
   lastModifiedAssetTimestamp?: Date;
 }
 
-export function mapAlbum(entity: AlbumEntity): AlbumResponseDto {
+const _map = (entity: AlbumEntity, withAssets: boolean): AlbumResponseDto => {
   const sharedUsers: UserResponseDto[] = [];
 
   entity.sharedUsers?.forEach((user) => {
@@ -29,6 +30,7 @@ export function mapAlbum(entity: AlbumEntity): AlbumResponseDto {
 
   return {
     albumName: entity.albumName,
+    description: entity.description,
     albumThumbnailAssetId: entity.albumThumbnailAssetId,
     createdAt: entity.createdAt,
     updatedAt: entity.updatedAt,
@@ -37,33 +39,13 @@ export function mapAlbum(entity: AlbumEntity): AlbumResponseDto {
     owner: mapUser(entity.owner),
     sharedUsers,
     shared: sharedUsers.length > 0 || entity.sharedLinks?.length > 0,
-    assets: entity.assets?.map((asset) => mapAsset(asset)) || [],
+    assets: withAssets ? entity.assets?.map((asset) => mapAsset(asset)) || [] : [],
     assetCount: entity.assets?.length || 0,
   };
-}
-
-export function mapAlbumExcludeAssetInfo(entity: AlbumEntity): AlbumResponseDto {
-  const sharedUsers: UserResponseDto[] = [];
+};
 
-  entity.sharedUsers?.forEach((user) => {
-    const userDto = mapUser(user);
-    sharedUsers.push(userDto);
-  });
-
-  return {
-    albumName: entity.albumName,
-    albumThumbnailAssetId: entity.albumThumbnailAssetId,
-    createdAt: entity.createdAt,
-    updatedAt: entity.updatedAt,
-    id: entity.id,
-    ownerId: entity.ownerId,
-    owner: mapUser(entity.owner),
-    sharedUsers,
-    shared: sharedUsers.length > 0 || entity.sharedLinks?.length > 0,
-    assets: [],
-    assetCount: entity.assets?.length || 0,
-  };
-}
+export const mapAlbum = (entity: AlbumEntity) => _map(entity, true);
+export const mapAlbumExcludeAssetInfo = (entity: AlbumEntity) => _map(entity, false);
 
 export class AlbumCountResponseDto {
   @ApiProperty({ type: 'integer' })

diff --git a/server/src/domain/album/album.service.spec.ts b/server/src/domain/album/album.service.spec.ts
@@ -156,6 +156,7 @@ describe(AlbumService.name, () => {
 
       await expect(sut.create(authStub.admin, { albumName: 'Empty album' })).resolves.toEqual({
         albumName: 'Empty album',
+        description: '',
         albumThumbnailAssetId: null,
         assetCount: 0,
         assets: [],