Skip to content

High performance self-hosted photo and video management solution.

refactor: deduplicate MemoryType and ReactionType enums (#11479)

Michel Heusschenb73f7fe16f19
diff --git a/mobile/lib/models/activities/activity.model.dart b/mobile/lib/models/activities/activity.model.dart
index 9cb3d0790c..6adb80dca9 100644
--- a/mobile/lib/models/activities/activity.model.dart
+++ b/mobile/lib/models/activities/activity.model.dart
@@ -43,7 +43,7 @@ class Activity {
assetId = dto.assetId,
comment = dto.comment,
createdAt = dto.createdAt,
- type = dto.type == ActivityResponseDtoTypeEnum.comment
+ type = dto.type == ReactionType.comment
? ActivityType.comment
: ActivityType.like,
user = User.fromSimpleUserDto(dto.user);
diff --git a/mobile/openapi/lib/model/activity_response_dto.dart b/mobile/openapi/lib/model/activity_response_dto.dart
index cd7a4f482f..bfffd8485b 100644
--- a/mobile/openapi/lib/model/activity_response_dto.dart
+++ b/mobile/openapi/lib/model/activity_response_dto.dart
@@ -29,7 +29,7 @@ class ActivityResponseDto {
String id;
- ActivityResponseDtoTypeEnum type;
+ ReactionType type;
UserResponseDto user;
@@ -86,7 +86,7 @@ class ActivityResponseDto {
comment: mapValueOfType<String>(json, r'comment'),
createdAt: mapDateTime(json, r'createdAt', r'')!,
id: mapValueOfType<String>(json, r'id')!,
- type: ActivityResponseDtoTypeEnum.fromJson(json[r'type'])!,
+ type: ReactionType.fromJson(json[r'type'])!,
user: UserResponseDto.fromJson(json[r'user'])!,
);
}
@@ -143,77 +143,3 @@ class ActivityResponseDto {
};
}
-
-class ActivityResponseDtoTypeEnum {
- /// Instantiate a new enum with the provided [value].
- const ActivityResponseDtoTypeEnum._(this.value);
-
- /// The underlying value of this enum member.
- final String value;
-
- @override
- String toString() => value;
-
- String toJson() => value;
-
- static const comment = ActivityResponseDtoTypeEnum._(r'comment');
- static const like = ActivityResponseDtoTypeEnum._(r'like');
-
- /// List of all possible values in this [enum][ActivityResponseDtoTypeEnum].
- static const values = <ActivityResponseDtoTypeEnum>[
- comment,
- like,
- ];
-
- static ActivityResponseDtoTypeEnum? fromJson(dynamic value) => ActivityResponseDtoTypeEnumTypeTransformer().decode(value);
-
- static List<ActivityResponseDtoTypeEnum> listFromJson(dynamic json, {bool growable = false,}) {
- final result = <ActivityResponseDtoTypeEnum>[];
- if (json is List && json.isNotEmpty) {
- for (final row in json) {
- final value = ActivityResponseDtoTypeEnum.fromJson(row);
- if (value != null) {
- result.add(value);
- }
- }
- }
- return result.toList(growable: growable);
- }
-}
-
-/// Transformation class that can [encode] an instance of [ActivityResponseDtoTypeEnum] to String,
-/// and [decode] dynamic data back to [ActivityResponseDtoTypeEnum].
-class ActivityResponseDtoTypeEnumTypeTransformer {
- factory ActivityResponseDtoTypeEnumTypeTransformer() => _instance ??= const ActivityResponseDtoTypeEnumTypeTransformer._();
-
- const ActivityResponseDtoTypeEnumTypeTransformer._();
-
- String encode(ActivityResponseDtoTypeEnum data) => data.value;
-
- /// Decodes a [dynamic value][data] to a ActivityResponseDtoTypeEnum.
- ///
- /// 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.
- ActivityResponseDtoTypeEnum? decode(dynamic data, {bool allowNull = true}) {
- if (data != null) {
- switch (data) {
- case r'comment': return ActivityResponseDtoTypeEnum.comment;
- case r'like': return ActivityResponseDtoTypeEnum.like;
- default:
- if (!allowNull) {
- throw ArgumentError('Unknown enum value to decode: $data');
- }
- }
- }
- return null;
- }
-
- /// Singleton [ActivityResponseDtoTypeEnumTypeTransformer] instance.
- static ActivityResponseDtoTypeEnumTypeTransformer? _instance;
-}
-
-
diff --git a/mobile/openapi/lib/model/memory_response_dto.dart b/mobile/openapi/lib/model/memory_response_dto.dart
index 06e0e3114b..f794be53cd 100644
--- a/mobile/openapi/lib/model/memory_response_dto.dart
+++ b/mobile/openapi/lib/model/memory_response_dto.dart
@@ -56,7 +56,7 @@ class MemoryResponseDto {
///
DateTime? seenAt;
- MemoryResponseDtoTypeEnum type;
+ MemoryType type;
DateTime updatedAt;
@@ -133,7 +133,7 @@ class MemoryResponseDto {
memoryAt: mapDateTime(json, r'memoryAt', r'')!,
ownerId: mapValueOfType<String>(json, r'ownerId')!,
seenAt: mapDateTime(json, r'seenAt', r''),
- type: MemoryResponseDtoTypeEnum.fromJson(json[r'type'])!,
+ type: MemoryType.fromJson(json[r'type'])!,
updatedAt: mapDateTime(json, r'updatedAt', r'')!,
);
}
@@ -194,74 +194,3 @@ class MemoryResponseDto {
};
}
-
-class MemoryResponseDtoTypeEnum {
- /// Instantiate a new enum with the provided [value].
- const MemoryResponseDtoTypeEnum._(this.value);
-
- /// The underlying value of this enum member.
- final String value;
-
- @override
- String toString() => value;
-
- String toJson() => value;
-
- static const onThisDay = MemoryResponseDtoTypeEnum._(r'on_this_day');
-
- /// List of all possible values in this [enum][MemoryResponseDtoTypeEnum].
- static const values = <MemoryResponseDtoTypeEnum>[
- onThisDay,
- ];
-
- static MemoryResponseDtoTypeEnum? fromJson(dynamic value) => MemoryResponseDtoTypeEnumTypeTransformer().decode(value);
-
- static List<MemoryResponseDtoTypeEnum> listFromJson(dynamic json, {bool growable = false,}) {
- final result = <MemoryResponseDtoTypeEnum>[];
- if (json is List && json.isNotEmpty) {
- for (final row in json) {
- final value = MemoryResponseDtoTypeEnum.fromJson(row);
- if (value != null) {
- result.add(value);
- }
- }
- }
- return result.toList(growable: growable);
- }
-}
-
-/// Transformation class that can [encode] an instance of [MemoryResponseDtoTypeEnum] to String,
-/// and [decode] dynamic data back to [MemoryResponseDtoTypeEnum].
-class MemoryResponseDtoTypeEnumTypeTransformer {
- factory MemoryResponseDtoTypeEnumTypeTransformer() => _instance ??= const MemoryResponseDtoTypeEnumTypeTransformer._();
-
- const MemoryResponseDtoTypeEnumTypeTransformer._();
-
- String encode(MemoryResponseDtoTypeEnum data) => data.value;
-
- /// Decodes a [dynamic value][data] to a MemoryResponseDtoTypeEnum.
- ///
- /// 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.
- MemoryResponseDtoTypeEnum? decode(dynamic data, {bool allowNull = true}) {
- if (data != null) {
- switch (data) {
- case r'on_this_day': return MemoryResponseDtoTypeEnum.onThisDay;
- default:
- if (!allowNull) {
- throw ArgumentError('Unknown enum value to decode: $data');
- }
- }
- }
- return null;
- }
-
- /// Singleton [MemoryResponseDtoTypeEnumTypeTransformer] instance.
- static MemoryResponseDtoTypeEnumTypeTransformer? _instance;
-}
-
-
diff --git a/open-api/immich-openapi-specs.json b/open-api/immich-openapi-specs.json
index 3e1744d570..5a327f1d34 100644
--- a/open-api/immich-openapi-specs.json
+++ b/open-api/immich-openapi-specs.json
@@ -7216,11 +7216,7 @@
"type": "string"
},
"type": {
- "enum": [
- "comment",
- "like"
- ],
- "type": "string"
+ "$ref": "#/components/schemas/ReactionType"
},
"user": {
"$ref": "#/components/schemas/UserResponseDto"
@@ -9311,10 +9307,7 @@
"type": "string"
},
"type": {
- "enum": [
- "on_this_day"
- ],
- "type": "string"
+ "$ref": "#/components/schemas/MemoryType"
},
"updatedAt": {
"format": "date-time",
diff --git a/open-api/typescript-sdk/src/fetch-client.ts b/open-api/typescript-sdk/src/fetch-client.ts
index 7b43a6f3ff..85575893f0 100644
--- a/open-api/typescript-sdk/src/fetch-client.ts
+++ b/open-api/typescript-sdk/src/fetch-client.ts
@@ -26,7 +26,7 @@ export type ActivityResponseDto = {
comment?: string | null;
createdAt: string;
id: string;
- "type": Type;
+ "type": ReactionType;
user: UserResponseDto;
};
export type ActivityCreateDto = {
@@ -572,7 +572,7 @@ export type MemoryResponseDto = {
memoryAt: string;
ownerId: string;
seenAt?: string;
- "type": Type2;
+ "type": MemoryType;
updatedAt: string;
};
export type MemoryCreateDto = {
@@ -3065,10 +3065,6 @@ export enum ReactionType {
Comment = "comment",
Like = "like"
}
-export enum Type {
- Comment = "comment",
- Like = "like"
-}
export enum UserAvatarColor {
Primary = "primary",
Pink = "pink",
@@ -3164,9 +3160,6 @@ export enum MapTheme {
Light = "light",
Dark = "dark"
}
-export enum Type2 {
- OnThisDay = "on_this_day"
-}
export enum MemoryType {
OnThisDay = "on_this_day"
}
diff --git a/server/src/dtos/activity.dto.ts b/server/src/dtos/activity.dto.ts
index 4a3de208ff..4bc0065244 100644
--- a/server/src/dtos/activity.dto.ts
+++ b/server/src/dtos/activity.dto.ts
@@ -19,6 +19,7 @@ export type MaybeDuplicate<T> = { duplicate: boolean; value: T };
export class ActivityResponseDto {
id!: string;
createdAt!: Date;
+ @ApiProperty({ enumName: 'ReactionType', enum: ReactionType })
type!: ReactionType;
user!: UserResponseDto;
assetId!: string | null;
@@ -53,7 +54,7 @@ export class ActivitySearchDto extends ActivityDto {
userId?: string;
}
-const isComment = (dto: ActivityCreateDto) => dto.type === 'comment';
+const isComment = (dto: ActivityCreateDto) => dto.type === ReactionType.COMMENT;
export class ActivityCreateDto extends ActivityDto {
@IsEnum(ReactionType)
diff --git a/server/src/dtos/memory.dto.ts b/server/src/dtos/memory.dto.ts
index ecd62785f8..c9db4b04e0 100644
--- a/server/src/dtos/memory.dto.ts
+++ b/server/src/dtos/memory.dto.ts
@@ -61,6 +61,7 @@ export class MemoryResponseDto {
memoryAt!: Date;
seenAt?: Date;
ownerId!: string;
+ @ApiProperty({ enumName: 'MemoryType', enum: MemoryType })
type!: MemoryType;
data!: MemoryData;
isSaved!: boolean;
diff --git a/web/src/lib/components/asset-viewer/activity-viewer.svelte b/web/src/lib/components/asset-viewer/activity-viewer.svelte
index 4664dcc3c5..050802e1d0 100644
--- a/web/src/lib/components/asset-viewer/activity-viewer.svelte
+++ b/web/src/lib/components/asset-viewer/activity-viewer.svelte
@@ -8,7 +8,6 @@
import { isTenMinutesApart } from '$lib/utils/timesince';
import {
ReactionType,
- Type,
createActivity,
deleteActivity,
getActivities,
@@ -111,15 +110,15 @@
await deleteActivity({ id: reaction.id });
reactions.splice(index, 1);
reactions = reactions;
- if (isLiked && reaction.type === 'like' && reaction.id == isLiked.id) {
+ if (isLiked && reaction.type === ReactionType.Like && reaction.id == isLiked.id) {
dispatch('deleteLike');
} else {
dispatch('deleteComment');
}
- const deleteMessages: Record<Type, string> = {
- [Type.Comment]: $t('comment_deleted'),
- [Type.Like]: $t('like_deleted'),
+ const deleteMessages: Record<ReactionType, string> = {
+ [ReactionType.Comment]: $t('comment_deleted'),
+ [ReactionType.Like]: $t('like_deleted'),
};
notificationController.show({
message: deleteMessages[reaction.type],
@@ -172,7 +171,7 @@
style="height: {divHeight}px;padding-bottom: {chatHeight}px"
>
{#each reactions as reaction, index (reaction.id)}
- {#if reaction.type === 'comment'}
+ {#if reaction.type === ReactionType.Comment}
<div class="flex dark:bg-gray-800 bg-gray-200 py-3 pl-3 mt-3 rounded-lg gap-4 justify-start">
<div class="flex items-center">
<UserAvatar user={reaction.user} size="sm" />
@@ -216,7 +215,7 @@
{timeSince(luxon.DateTime.fromISO(reaction.createdAt, { locale: $locale }))}
</div>
{/if}
- {:else if reaction.type === 'like'}
+ {:else if reaction.type === ReactionType.Like}
<div class="relative">
<div class="flex py-3 pl-3 mt-3 gap-4 items-center text-sm">
<div class="text-red-600"><Icon path={mdiHeart} size={20} /></div>