refactor: star rating

i18n/en.json

@@ -1809,9 +1809,8 @@
   "rate_asset": "Rate Asset",
   "rating": "Star rating",
   "rating_clear": "Clear rating",
-  "rating_count": "{count, plural, one {# star} other {# stars}}",
+  "rating_count": "{count, plural, =-1 {Rejected} =0 {Unrated} one {# star} other {# stars}}",
   "rating_description": "Display the EXIF rating in the info panel",
-  "rating_set": "Rating set to {rating, plural, one {# star} other {# stars}}",
   "reaction_options": "Reaction options",
   "read_changelog": "Read Changelog",
   "readonly_mode_disabled": "Read-only mode disabled",

open-api/immich-openapi-specs.json

@@ -9407,10 +9407,11 @@
             "name": "rating",
             "required": false,
             "in": "query",
-            "description": "Filter by rating",
+            "description": "Filter by rating. -1 means rejected, null unrated, 1-5 the star rating",
             "schema": {
               "minimum": -1,
               "maximum": 5,
+              "nullable": true,
               "type": "number"
             }
           },
@@ -15875,6 +15876,7 @@
             "description": "Rating",
             "maximum": 5,
             "minimum": -1,
+            "nullable": true,
             "type": "number"
           },
           "timeZone": {
@@ -18986,9 +18988,10 @@
             "type": "string"
           },
           "rating": {
-            "description": "Filter by rating",
+            "description": "Filter by rating. -1 means rejected, null unrated, 1-5 the star rating",
             "maximum": 5,
             "minimum": -1,
+            "nullable": true,
             "type": "number"
           },
           "size": {
@@ -20712,9 +20715,10 @@
             "type": "array"
           },
           "rating": {
-            "description": "Filter by rating",
+            "description": "Filter by rating. -1 means rejected, null unrated, 1-5 the star rating",
             "maximum": 5,
             "minimum": -1,
+            "nullable": true,
             "type": "number"
           },
           "size": {
@@ -22086,9 +22090,10 @@
             "type": "string"
           },
           "rating": {
-            "description": "Filter by rating",
+            "description": "Filter by rating. -1 means rejected, null unrated, 1-5 the star rating",
             "maximum": 5,
             "minimum": -1,
+            "nullable": true,
             "type": "number"
           },
           "size": {
@@ -22320,9 +22325,10 @@
             "type": "array"
           },
           "rating": {
-            "description": "Filter by rating",
+            "description": "Filter by rating. -1 means rejected, null unrated, 1-5 the star rating",
             "maximum": 5,
             "minimum": -1,
+            "nullable": true,
             "type": "number"
           },
           "state": {
@@ -25099,6 +25105,7 @@
             "description": "Rating",
             "maximum": 5,
             "minimum": -1,
+            "nullable": true,
             "type": "number"
           },
           "visibility": {

open-api/typescript-sdk/src/fetch-client.ts

@@ -835,7 +835,7 @@ export type AssetBulkUpdateDto = {
     /** Longitude coordinate */
     longitude?: number;
     /** Rating */
-    rating?: number;
+    rating?: number | null;
     /** Time zone (IANA timezone) */
     timeZone?: string;
     /** Asset visibility */
@@ -945,7 +945,7 @@ export type UpdateAssetDto = {
     /** Longitude coordinate */
     longitude?: number;
     /** Rating */
-    rating?: number;
+    rating?: number | null;
     /** Asset visibility */
     visibility?: AssetVisibility;
 };
@@ -1709,8 +1709,8 @@ export type MetadataSearchDto = {
     personIds?: string[];
     /** Filter by preview file path */
     previewPath?: string;
-    /** Filter by rating */
-    rating?: number;
+    /** Filter by rating. -1 means rejected, null unrated, 1-5 the star rating */
+    rating?: number | null;
     /** Number of results to return */
     size?: number;
     /** Filter by state/province name */
@@ -1825,8 +1825,8 @@ export type RandomSearchDto = {
     ocr?: string;
     /** Filter by person IDs */
     personIds?: string[];
-    /** Filter by rating */
-    rating?: number;
+    /** Filter by rating. -1 means rejected, null unrated, 1-5 the star rating */
+    rating?: number | null;
     /** Number of results to return */
     size?: number;
     /** Filter by state/province name */
@@ -1901,8 +1901,8 @@ export type SmartSearchDto = {
     query?: string;
     /** Asset ID to use as search reference */
     queryAssetId?: string;
-    /** Filter by rating */
-    rating?: number;
+    /** Filter by rating. -1 means rejected, null unrated, 1-5 the star rating */
+    rating?: number | null;
     /** Number of results to return */
     size?: number;
     /** Filter by state/province name */
@@ -1967,8 +1967,8 @@ export type StatisticsSearchDto = {
     ocr?: string;
     /** Filter by person IDs */
     personIds?: string[];
-    /** Filter by rating */
-    rating?: number;
+    /** Filter by rating. -1 means rejected, null unrated, 1-5 the star rating */
+    rating?: number | null;
     /** Filter by state/province name */
     state?: string | null;
     /** Filter by tag IDs */
@@ -5422,7 +5422,7 @@ export function searchLargeAssets({ albumIds, city, country, createdAfter, creat
     model?: string | null;
     ocr?: string;
     personIds?: string[];
-    rating?: number;
+    rating?: number | null;
     size?: number;
     state?: string | null;
     tagIds?: string[] | null;

server/src/controllers/asset.controller.spec.ts

@@ -207,12 +207,28 @@ describe(AssetController.name, () => {
     });
 
     it('should reject invalid rating', async () => {
-      for (const test of [{ rating: 7 }, { rating: 3.5 }, { rating: null }]) {
+      for (const test of [{ rating: 7 }, { rating: 3.5 }, { rating: -2 }]) {
         const { status, body } = await request(ctx.getHttpServer()).put(`/assets/${factory.uuid()}`).send(test);
         expect(status).toBe(400);
         expect(body).toEqual(factory.responses.badRequest());
       }
     });
+
+    it('should convert rating 0 to null', async () => {
+      const assetId = factory.uuid();
+      const { status } = await request(ctx.getHttpServer()).put(`/assets/${assetId}`).send({ rating: 0 });
+      expect(service.update).toHaveBeenCalledWith(undefined, assetId, { rating: null });
+      expect(status).toBe(200);
+    });
+
+    it('should leave correct ratings as-is', async () => {
+      const assetId = factory.uuid();
+      for (const test of [{ rating: -1 }, { rating: 1 }, { rating: 5 }]) {
+        const { status } = await request(ctx.getHttpServer()).put(`/assets/${assetId}`).send(test);
+        expect(service.update).toHaveBeenCalledWith(undefined, assetId, test);
+        expect(status).toBe(200);
+      }
+    });
   });
 
   describe('GET /assets/statistics', () => {

server/src/dtos/asset.dto.ts

@@ -1,5 +1,5 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { Type } from 'class-transformer';
+import { Transform, Type } from 'class-transformer';
 import {
   IsArray,
   IsDateString,
@@ -57,11 +57,12 @@ export class UpdateAssetBase {
   longitude?: number;
 
   @ApiProperty({ description: 'Rating' })
-  @Optional()
+  @Optional({ nullable: true })
   @IsInt()
   @Max(5)
   @Min(-1)
-  rating?: number;
+  @Transform(({ value }) => (value === 0 ? null : value))
+  rating?: number | null;
 
   @ApiProperty({ description: 'Asset description' })
   @Optional()