chore: clean up

docs/docs/overview/comparison.md

@@ -0,0 +1,8 @@
+---
+sidebar_position: 2
+---
+
+# Comparison
+
+If you're new here and came from other asset self-hosting alternatives you might want to look at a comparison between Immich and your current solution.
+Here you can see a [comparison between the various OpenSource Photo Libraries](https://meichthys.github.io/foss_photo_libraries/) including Immich.

e2e/src/api/specs/person.e2e-spec.ts

@@ -1,7 +1,7 @@
-import { LoginResponseDto, PersonResponseDto } from '@immich/sdk';
+import { getPerson, LoginResponseDto, PersonResponseDto } from '@immich/sdk';
 import { uuidDto } from 'src/fixtures';
 import { errorDto } from 'src/responses';
-import { app, utils } from 'src/utils';
+import { app, asBearerAuth, utils } from 'src/utils';
 import request from 'supertest';
 import { beforeAll, beforeEach, describe, expect, it } from 'vitest';
 
@@ -203,6 +203,22 @@ describe('/people', () => {
         birthDate: '1990-01-01T00:00:00.000Z',
       });
     });
+
+    it('should create a favorite person', async () => {
+      const { status, body } = await request(app)
+        .post(`/people`)
+        .set('Authorization', `Bearer ${admin.accessToken}`)
+        .send({
+          name: 'New Favorite Person',
+          isFavorite: true,
+        });
+      expect(status).toBe(201);
+      expect(body).toMatchObject({
+        id: expect.any(String),
+        name: 'New Favorite Person',
+        isFavorite: true,
+      });
+    });
   });
 
   describe('PUT /people/:id', () => {
@@ -216,6 +232,7 @@ describe('/people', () => {
       { key: 'name', type: 'string' },
       { key: 'featureFaceAssetId', type: 'string' },
       { key: 'isHidden', type: 'boolean value' },
+      { key: 'isFavorite', type: 'boolean value' },
     ]) {
       it(`should not allow null ${key}`, async () => {
         const { status, body } = await request(app)
@@ -255,6 +272,24 @@ describe('/people', () => {
       expect(status).toBe(200);
       expect(body).toMatchObject({ birthDate: null });
     });
+
+    it('should mark a person as favorite', async () => {
+      const person = await utils.createPerson(admin.accessToken, {
+        name: 'visible_person',
+      });
+
+      expect(person.isFavorite).toBe(false);
+
+      const { status, body } = await request(app)
+        .put(`/people/${person.id}`)
+        .set('Authorization', `Bearer ${admin.accessToken}`)
+        .send({ isFavorite: true });
+      expect(status).toBe(200);
+      expect(body).toMatchObject({ isFavorite: true });
+
+      const person2 = await getPerson({ id: person.id }, { headers: asBearerAuth(admin.accessToken) });
+      expect(person2).toMatchObject({ id: person.id, isFavorite: true });
+    });
   });
 
   describe('POST /people/:id/merge', () => {

open-api/immich-openapi-specs.json

@@ -10427,7 +10427,7 @@
             "type": "string"
           },
           "isFavorite": {
-            "description": "This property was added in v1.124.0",
+            "description": "This property was added in v1.126.0",
             "type": "boolean"
           },
           "isHidden": {
@@ -10508,7 +10508,7 @@
             "type": "string"
           },
           "isFavorite": {
-            "description": "This property was added in v1.124.0",
+            "description": "This property was added in v1.126.0",
             "type": "boolean"
           },
           "isHidden": {

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

@@ -215,7 +215,7 @@ export type PersonWithFacesResponseDto = {
     birthDate: string | null;
     faces: AssetFaceWithoutPersonResponseDto[];
     id: string;
-    /** This property was added in v1.124.0 */
+    /** This property was added in v1.126.0 */
     isFavorite?: boolean;
     isHidden: boolean;
     name: string;
@@ -494,7 +494,7 @@ export type DuplicateResponseDto = {
 export type PersonResponseDto = {
     birthDate: string | null;
     id: string;
-    /** This property was added in v1.124.0 */
+    /** This property was added in v1.126.0 */
     isFavorite?: boolean;
     isHidden: boolean;
     name: string;

server/src/db.d.ts

@@ -3,16 +3,21 @@
  * Please do not edit it manually.
  */
 
-import type { ColumnType } from 'kysely';
+import type { ColumnType } from "kysely";
 
-export type ArrayType<T> = ArrayTypeImpl<T> extends (infer U)[] ? U[] : ArrayTypeImpl<T>;
+export type ArrayType<T> = ArrayTypeImpl<T> extends (infer U)[]
+  ? U[]
+  : ArrayTypeImpl<T>;
 
-export type ArrayTypeImpl<T> = T extends ColumnType<infer S, infer I, infer U> ? ColumnType<S[], I[], U[]> : T[];
+export type ArrayTypeImpl<T> = T extends ColumnType<infer S, infer I, infer U>
+  ? ColumnType<S[], I[], U[]>
+  : T[];
 
-export type AssetsStatusEnum = 'active' | 'deleted' | 'trashed';
+export type AssetsStatusEnum = "active" | "deleted" | "trashed";
 
-export type Generated<T> =
-  T extends ColumnType<infer S, infer I, infer U> ? ColumnType<S, I | undefined, U> : ColumnType<T, T | undefined, T>;
+export type Generated<T> = T extends ColumnType<infer S, infer I, infer U>
+  ? ColumnType<S, I | undefined, U>
+  : ColumnType<T, T | undefined, T>;
 
 export type Int8 = ColumnType<string, bigint | number | string, bigint | number | string>;
 
@@ -28,7 +33,7 @@ export type JsonPrimitive = boolean | number | string | null;
 
 export type JsonValue = JsonArray | JsonObject | JsonPrimitive;
 
-export type Sourcetype = 'exif' | 'machine-learning';
+export type Sourcetype = "exif" | "machine-learning";
 
 export type Timestamp = ColumnType<Date, Date | string, Date | string>;
 
@@ -323,11 +328,6 @@ export interface SocketIoAttachments {
   payload: Buffer | null;
 }
 
-export interface SystemConfig {
-  key: string;
-  value: string | null;
-}
-
 export interface SystemMetadata {
   key: string;
   value: Json;
@@ -353,6 +353,15 @@ export interface TagsClosure {
   id_descendant: string;
 }
 
+export interface TypeormMetadata {
+  database: string | null;
+  name: string | null;
+  schema: string | null;
+  table: string | null;
+  type: string;
+  value: string | null;
+}
+
 export interface UserMetadata {
   key: string;
   userId: string;
@@ -427,13 +436,13 @@ export interface DB {
   shared_links: SharedLinks;
   smart_search: SmartSearch;
   socket_io_attachments: SocketIoAttachments;
-  system_config: SystemConfig;
   system_metadata: SystemMetadata;
   tag_asset: TagAsset;
   tags: Tags;
   tags_closure: TagsClosure;
+  typeorm_metadata: TypeormMetadata;
   user_metadata: UserMetadata;
   users: Users;
-  'vectors.pg_vector_index_stat': VectorsPgVectorIndexStat;
+  "vectors.pg_vector_index_stat": VectorsPgVectorIndexStat;
   version_history: VersionHistory;
 }

server/src/dtos/person.dto.ts

@@ -33,7 +33,6 @@ export class PersonCreateDto {
   @ValidateBoolean({ optional: true })
   isHidden?: boolean;
 
-  @ApiProperty()
   @ValidateBoolean({ optional: true })
   isFavorite?: boolean;
 }
@@ -101,8 +100,7 @@ export class PersonResponseDto {
   isHidden!: boolean;
   @PropertyLifecycle({ addedAt: 'v1.107.0' })
   updatedAt?: Date;
-  @ApiProperty()
-  @PropertyLifecycle({ addedAt: 'v1.124.0' })
+  @PropertyLifecycle({ addedAt: 'v1.126.0' })
   isFavorite?: boolean;
 }