fix(server): use UserMetadataKey enum instead of string (#20209)

* fix(server): use UserMetadataKey enum instead of string

* fix: mobile

mobile/lib/infrastructure/repositories/sync_stream.repository.dart

@@ -20,8 +20,8 @@ import 'package:immich_mobile/infrastructure/entities/user.entity.drift.dart';
 import 'package:immich_mobile/infrastructure/entities/user_metadata.entity.drift.dart';
 import 'package:immich_mobile/infrastructure/repositories/db.repository.dart';
 import 'package:logging/logging.dart';
-import 'package:openapi/api.dart' as api show AssetVisibility, AlbumUserRole;
-import 'package:openapi/api.dart' hide AssetVisibility, AlbumUserRole;
+import 'package:openapi/api.dart' as api show AssetVisibility, AlbumUserRole, UserMetadataKey;
+import 'package:openapi/api.dart' hide AssetVisibility, AlbumUserRole, UserMetadataKey;
 
 class SyncStreamRepository extends DriftDatabaseRepository {
   final Logger _logger = Logger('DriftSyncStreamRepository');
@@ -647,11 +647,11 @@ extension on api.AssetVisibility {
       };
 }
 
-extension on String {
+extension on api.UserMetadataKey {
   UserMetadataKey toUserMetadataKey() => switch (this) {
-        "onboarding" => UserMetadataKey.onboarding,
-        "preferences" => UserMetadataKey.preferences,
-        "license" => UserMetadataKey.license,
+        api.UserMetadataKey.onboarding => UserMetadataKey.onboarding,
+        api.UserMetadataKey.preferences => UserMetadataKey.preferences,
+        api.UserMetadataKey.license => UserMetadataKey.license,
         _ => throw Exception('Unknown UserMetadataKey value: $this'),
       };
 }

open-api/immich-openapi-specs.json

@@ -14403,7 +14403,11 @@
       "SyncUserMetadataDeleteV1": {
         "properties": {
           "key": {
-            "type": "string"
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/UserMetadataKey"
+              }
+            ]
           },
           "userId": {
             "type": "string"
@@ -14418,7 +14422,11 @@
       "SyncUserMetadataV1": {
         "properties": {
           "key": {
-            "type": "string"
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/UserMetadataKey"
+              }
+            ]
           },
           "userId": {
             "type": "string"
@@ -16132,6 +16140,14 @@
         ],
         "type": "object"
       },
+      "UserMetadataKey": {
+        "enum": [
+          "preferences",
+          "license",
+          "onboarding"
+        ],
+        "type": "string"
+      },
       "UserPreferencesResponseDto": {
         "properties": {
           "albums": {

server/src/dtos/sync.dto.ts

@@ -301,14 +301,16 @@ export class SyncAssetFaceDeleteV1 {
 @ExtraModel()
 export class SyncUserMetadataV1 {
   userId!: string;
-  key!: string;
+  @ValidateEnum({ enum: UserMetadataKey, name: 'UserMetadataKey' })
+  key!: UserMetadataKey;
   value!: UserMetadata[UserMetadataKey];
 }
 
 @ExtraModel()
 export class SyncUserMetadataDeleteV1 {
   userId!: string;
-  key!: string;
+  @ValidateEnum({ enum: UserMetadataKey, name: 'UserMetadataKey' })
+  key!: UserMetadataKey;
 }
 
 @ExtraModel()

server/src/schema/tables/user-metadata-audit.table.ts

@@ -1,4 +1,5 @@
 import { PrimaryGeneratedUuidV7Column } from 'src/decorators';
+import { UserMetadataKey } from 'src/enum';
 import { Column, CreateDateColumn, Generated, Table, Timestamp } from 'src/sql-tools';
 
 @Table('user_metadata_audit')
@@ -10,7 +11,7 @@ export class UserMetadataAuditTable {
   userId!: string;
 
   @Column({ indexName: 'IDX_user_metadata_audit_key' })
-  key!: string;
+  key!: UserMetadataKey;
 
   @CreateDateColumn({ default: () => 'clock_timestamp()', indexName: 'IDX_user_metadata_audit_deleted_at' })
   deletedAt!: Generated<Timestamp>;