refactor(server): album user route params

Co-authored-by: shenlong-tanwen <139912620+shalong-tanwen@users.noreply.github.com>

docs/static/archived-versions.json

@@ -1,7 +1,7 @@
 [
   {
-    "label": "v3.0.0",
-    "url": "https://docs.v3.0.0.archive.immich.app"
+    "label": "v3.0.1",
+    "url": "https://docs.v3.0.1.archive.immich.app"
   },
   {
     "label": "v2.7.5",

e2e/package.json

@@ -1,6 +1,6 @@
 {
   "name": "immich-e2e",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "",
   "main": "index.js",
   "type": "module",

machine-learning/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "immich-ml"
-version = "3.0.0"
+version = "3.0.1"
 description = ""
 authors = [{ name = "Hau Tran", email = "alex.tran1502@gmail.com" }]
 requires-python = ">=3.11,<4.0"

machine-learning/uv.lock

@@ -974,7 +974,7 @@ wheels = [
 
 [[package]]
 name = "immich-ml"
-version = "3.0.0"
+version = "3.0.1"
 source = { editable = "." }
 dependencies = [
     { name = "aiocache" },

mobile/android/fastlane/Fastfile

@@ -22,8 +22,8 @@ platform :android do
       task: 'bundle', 
       build_type: 'Release',
       properties: {
-        "android.injected.version.code" => 3053,
-        "android.injected.version.name" => "3.0.0",
+        "android.injected.version.code" => 3054,
+        "android.injected.version.name" => "3.0.1",
       }
     )
     upload_to_play_store(skip_upload_apk: true, skip_upload_images: true, skip_upload_screenshots: true, aab: '../build/app/outputs/bundle/release/app-release.aab', track: 'beta')
@@ -35,8 +35,8 @@ platform :android do
       task: 'bundle', 
       build_type: 'Release',
       properties: {
-        "android.injected.version.code" => 3053,
-        "android.injected.version.name" => "3.0.0",
+        "android.injected.version.code" => 3054,
+        "android.injected.version.name" => "3.0.1",
       }
     )
     upload_to_play_store(skip_upload_apk: true, skip_upload_images: true, skip_upload_screenshots: true, aab: '../build/app/outputs/bundle/release/app-release.aab')

mobile/ios/Runner/Info.plist

@@ -78,7 +78,7 @@
     <key>CFBundlePackageType</key>
     <string>APPL</string>
     <key>CFBundleShortVersionString</key>
-    <string>3.0.0</string>
+    <string>3.0.1</string>
     <key>CFBundleSignature</key>
     <string>????</string>
     <key>CFBundleURLTypes</key>

mobile/lib/domain/services/sync_stream.service.dart

@@ -25,6 +25,7 @@ enum SyncMigrationTask {
   v20260128_CopyExifWidthHeightToAsset, // Asset table has incorrect width and height for video ratio calculations.
   v20260128_ResetAssetV1, // Asset v2.5.0 has width and height information that were edited assets.
   v20260597_ResetAssetV1AssetV2, // Assets didn't include the uploadedAt column.
+  v20260701_ResetAlbumsV1, // Album user migration dropped the owner. Sync fresh albums from the server to re-populate them.
 }
 
 class SyncStreamService {
@@ -103,6 +104,12 @@ class SyncStreamService {
   }
 
   Future<void> _runPreSyncTasks(List<String> migrations, SemVer semVer) async {
+    if (!migrations.contains(SyncMigrationTask.v20260701_ResetAlbumsV1.name)) {
+      _logger.info("Running pre-sync task: v20260701_ResetAlbumsV1");
+      await _syncApiRepository.deleteSyncAck([SyncEntityType.albumV1]);
+      migrations.add(SyncMigrationTask.v20260701_ResetAlbumsV1.name);
+    }
+
     if (!migrations.contains(SyncMigrationTask.v20260128_ResetExifV1.name)) {
       _logger.info("Running pre-sync task: v20260128_ResetExifV1");
       await _syncApiRepository.deleteSyncAck([

mobile/openapi/README.md

@@ -3,7 +3,7 @@ Immich API
 
 This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 3.0.0
+- API version: 3.0.1
 - Generator version: 7.22.0
 - Build package: org.openapitools.codegen.languages.DartClientCodegen
 

mobile/openapi/lib/api/albums_api.dart

@@ -681,8 +681,10 @@ class AlbumsApi {
   /// Parameters:
   ///
   /// * [String] id (required):
+  ///   Album ID
   ///
   /// * [String] userId (required):
+  ///   Album user ID, or \"me\" to reference the current user
   Future<Response> removeUserFromAlbumWithHttpInfo(String id, String userId, { Future<void>? abortTrigger, }) async {
     // ignore: prefer_const_declarations
     final apiPath = r'/albums/{id}/user/{userId}'
@@ -718,8 +720,10 @@ class AlbumsApi {
   /// Parameters:
   ///
   /// * [String] id (required):
+  ///   Album ID
   ///
   /// * [String] userId (required):
+  ///   Album user ID, or \"me\" to reference the current user
   Future<void> removeUserFromAlbum(String id, String userId, { Future<void>? abortTrigger, }) async {
     final response = await removeUserFromAlbumWithHttpInfo(id, userId, abortTrigger: abortTrigger,);
     if (response.statusCode >= HttpStatus.badRequest) {
@@ -798,8 +802,10 @@ class AlbumsApi {
   /// Parameters:
   ///
   /// * [String] id (required):
+  ///   Album ID
   ///
   /// * [String] userId (required):
+  ///   Album user ID, or \"me\" to reference the current user
   ///
   /// * [UpdateAlbumUserDto] updateAlbumUserDto (required):
   Future<Response> updateAlbumUserWithHttpInfo(String id, String userId, UpdateAlbumUserDto updateAlbumUserDto, { Future<void>? abortTrigger, }) async {
@@ -837,8 +843,10 @@ class AlbumsApi {
   /// Parameters:
   ///
   /// * [String] id (required):
+  ///   Album ID
   ///
   /// * [String] userId (required):
+  ///   Album user ID, or \"me\" to reference the current user
   ///
   /// * [UpdateAlbumUserDto] updateAlbumUserDto (required):
   Future<void> updateAlbumUser(String id, String userId, UpdateAlbumUserDto updateAlbumUserDto, { Future<void>? abortTrigger, }) async {

mobile/pubspec.yaml

@@ -2,7 +2,7 @@ name: immich_mobile
 description: Immich - selfhosted backup media file on mobile phone
 
 publish_to: 'none'
-version: 3.0.0+3053
+version: 3.0.1+3054
 
 environment:
   sdk: '>=3.12.0 <4.0.0'

open-api/immich-openapi-specs.json

@@ -2702,6 +2702,7 @@
             "name": "id",
             "required": true,
             "in": "path",
+            "description": "Album ID",
             "schema": {
               "format": "uuid",
               "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
@@ -2712,6 +2713,7 @@
             "name": "userId",
             "required": true,
             "in": "path",
+            "description": "Album user ID, or \"me\" to reference the current user",
             "schema": {
               "type": "string"
             }
@@ -2762,6 +2764,7 @@
             "name": "id",
             "required": true,
             "in": "path",
+            "description": "Album ID",
             "schema": {
               "format": "uuid",
               "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
@@ -2772,6 +2775,7 @@
             "name": "userId",
             "required": true,
             "in": "path",
+            "description": "Album user ID, or \"me\" to reference the current user",
             "schema": {
               "type": "string"
             }
@@ -16206,7 +16210,7 @@
   "info": {
     "title": "Immich",
     "description": "Immich API",
-    "version": "3.0.0",
+    "version": "3.0.1",
     "contact": {}
   },
   "tags": [

package.json

@@ -1,6 +1,6 @@
 {
   "name": "immich-monorepo",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Monorepo for Immich",
   "type": "module",
   "private": true,

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@immich/cli",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Command Line Interface (CLI) for Immich",
   "repository": {
     "type": "git",

packages/sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@immich/sdk",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Auto-generated TypeScript SDK for the Immich API",
   "repository": {
     "type": "git",

packages/sdk/src/fetch-client.ts

@@ -1,6 +1,6 @@
 /**
  * Immich
- * 3.0.0
+ * 3.0.1
  * DO NOT MODIFY - This file has been generated using oazapfts.
  * See https://www.npmjs.com/package/oazapfts
  */

server/package.json

@@ -1,6 +1,6 @@
 {
   "name": "immich",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "",
   "author": "",
   "private": true,

server/src/controllers/album.controller.ts

@@ -7,6 +7,7 @@ import {
   AlbumsAddAssetsDto,
   AlbumsAddAssetsResponseDto,
   AlbumStatisticsResponseDto,
+  AlbumUserParamDto,
   CreateAlbumDto,
   GetAlbumsDto,
   UpdateAlbumDto,
@@ -18,7 +19,7 @@ import { MapMarkerResponseDto } from 'src/dtos/map.dto';
 import { ApiTag, Permission } from 'src/enum';
 import { Auth, Authenticated } from 'src/middleware/auth.guard';
 import { AlbumService } from 'src/services/album.service';
-import { ParseMeUUIDPipe, UUIDParamDto } from 'src/validation';
+import { UUIDParamDto } from 'src/validation';
 
 @ApiTags(ApiTag.Albums)
 @Controller('albums')
@@ -175,8 +176,7 @@ export class AlbumController {
   })
   updateAlbumUser(
     @Auth() auth: AuthDto,
-    @Param() { id }: UUIDParamDto,
-    @Param('userId', new ParseMeUUIDPipe({ version: '4' })) userId: string,
+    @Param() { id, userId }: AlbumUserParamDto,
     @Body() dto: UpdateAlbumUserDto,
   ): Promise<void> {
     return this.service.updateUser(auth, id, userId, dto);
@@ -190,11 +190,7 @@ export class AlbumController {
     description: 'Remove a user from an album. Use an ID of "me" to leave a shared album.',
     history: new HistoryBuilder().added('v1').beta('v1').stable('v2'),
   })
-  removeUserFromAlbum(
-    @Auth() auth: AuthDto,
-    @Param() { id }: UUIDParamDto,
-    @Param('userId', new ParseMeUUIDPipe({ version: '4' })) userId: string,
-  ): Promise<void> {
+  removeUserFromAlbum(@Auth() auth: AuthDto, @Param() { id, userId }: AlbumUserParamDto): Promise<void> {
     return this.service.removeUser(auth, id, userId);
   }
 }

server/src/dtos/album.dto.ts

@@ -140,6 +140,18 @@ export const AlbumResponseSchema = z
   })
   .meta({ id: 'AlbumResponseDto' });
 
+const AlbumUserParamSchema = z.object({
+  id: z.uuidv4().describe('Album ID'),
+  // TODO: disallow 'me' as a shortcut in v4 and type userId as uuidv4
+  userId: z
+    .string()
+    .refine((value) => value === 'me' || z.uuidv4().safeParse(value).success, {
+      error: 'Must be a UUID v4 or "me"',
+    })
+    .describe('Album user ID, or "me" to reference the current user'),
+});
+
+export class AlbumUserParamDto extends createZodDto(AlbumUserParamSchema) {}
 export class AddUsersDto extends createZodDto(AddUsersSchema) {}
 export class AlbumUserCreateDto extends createZodDto(AlbumUserCreateSchema) {}
 export class CreateAlbumDto extends createZodDto(CreateAlbumSchema) {}

server/src/validation.ts

@@ -1,4 +1,4 @@
-import { ArgumentMetadata, FileValidator, Injectable, ParseUUIDPipe } from '@nestjs/common';
+import { FileValidator, Injectable } from '@nestjs/common';
 import { createZodDto } from 'nestjs-zod';
 import sanitize from 'sanitize-filename';
 import { isIP, isIPRange } from 'validator';
@@ -74,16 +74,6 @@ export function IsNotSiblingOf<
   );
 }
 
-@Injectable()
-export class ParseMeUUIDPipe extends ParseUUIDPipe {
-  async transform(value: string, metadata: ArgumentMetadata) {
-    if (value == 'me') {
-      return value;
-    }
-    return super.transform(value, metadata);
-  }
-}
-
 @Injectable()
 export class FileNotEmptyValidator extends FileValidator {
   constructor(private requiredFields: string[]) {

web/package.json

@@ -1,6 +1,6 @@
 {
   "name": "immich-web",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "license": "GNU Affero General Public License version 3",
   "type": "module",
   "scripts": {

web/src/lib/components/shared-components/settings/SettingInputField.svelte

@@ -101,7 +101,9 @@
       {description}
     </p>
   {:else}
-    {@render descriptionSnippet?.()}
+    <div class="pb-2">
+      {@render descriptionSnippet?.()}
+    </div>
   {/if}
 
   {#if inputType !== SettingInputFieldType.PASSWORD}