feat(server,web): hide faces

server/immich-openapi-specs.json

@@ -5895,12 +5895,16 @@
           },
           "thumbnailPath": {
             "type": "string"
+          },
+          "hidden": {
+            "type": "boolean"
           }
         },
         "required": [
           "id",
           "name",
-          "thumbnailPath"
+          "thumbnailPath",
+          "hidden"
         ]
       },
       "PersonUpdateDto": {
@@ -5913,6 +5917,10 @@
           "featureFaceAssetId": {
             "type": "string",
             "description": "Asset is used to get the feature face thumbnail."
+          },
+          "hidden": {
+            "type": "boolean",
+            "description": "Person visibility"
           }
         }
       },

server/src/domain/person/person.dto.ts

@@ -1,6 +1,7 @@
 import { AssetFaceEntity, PersonEntity } from '@app/infra/entities';
-import { IsOptional, IsString } from 'class-validator';
-import { ValidateUUID } from '../domain.util';
+import { Transform } from 'class-transformer';
+import { IsBoolean, IsOptional, IsString } from 'class-validator';
+import { toBoolean, ValidateUUID } from '../domain.util';
 
 export class PersonUpdateDto {
   /**
@@ -16,6 +17,14 @@ export class PersonUpdateDto {
   @IsOptional()
   @IsString()
   featureFaceAssetId?: string;
+
+  /**
+   * Person visibility
+   */
+  @IsOptional()
+  @IsBoolean()
+  @Transform(toBoolean)
+  hidden?: boolean;
 }
 
 export class MergePersonDto {
@@ -27,13 +36,15 @@ export class PersonResponseDto {
   id!: string;
   name!: string;
   thumbnailPath!: string;
+  hidden!: boolean;
 }
 
 export function mapPerson(person: PersonEntity): PersonResponseDto {
   return {
     id: person.id,
     name: person.name,
     thumbnailPath: person.thumbnailPath,
+    hidden: person.hidden,
   };
 }
 

server/src/domain/person/person.service.spec.ts

@@ -19,6 +19,7 @@ const responseDto: PersonResponseDto = {
   id: 'person-1',
   name: 'Person 1',
   thumbnailPath: '/path/to/thumbnail.jpg',
+  hidden: false,
 };
 
 describe(PersonService.name, () => {

server/src/domain/person/person.service.ts

@@ -21,6 +21,7 @@ export class PersonService {
     const people = await this.repository.getAll(authUser.id, { minimumFaceCount: 1 });
     const named = people.filter((person) => !!person.name);
     const unnamed = people.filter((person) => !person.name);
+
     return (
       [...named, ...unnamed]
         // with thumbnails
@@ -57,6 +58,13 @@ export class PersonService {
       await this.jobRepository.queue({ name: JobName.SEARCH_INDEX_ASSET, data: { ids } });
     }
 
+    if (dto.hidden !== undefined) {
+      person = await this.repository.update({ id, hidden: dto.hidden });
+      const assets = await this.repository.getAssets(authUser.id, id);
+      const ids = assets.map((asset) => asset.id);
+      await this.jobRepository.queue({ name: JobName.SEARCH_INDEX_ASSET, data: { ids } });
+    }
+
     if (dto.featureFaceAssetId) {
       const assetId = dto.featureFaceAssetId;
       const face = await this.repository.getFaceById({ personId: id, assetId });

server/src/infra/entities/person.entity.ts

@@ -35,4 +35,7 @@ export class PersonEntity {
 
   @OneToMany(() => AssetFaceEntity, (assetFace) => assetFace.person)
   faces!: AssetFaceEntity[];
+
+  @Column({ default: false })
+  hidden!: boolean;
 }

server/src/infra/migrations/1689281196844-AddHiddenFaces.ts

@@ -0,0 +1,14 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class Infra1689281196844 implements MigrationInterface {
+    name = 'Infra1689281196844'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "person" ADD "hidden" boolean NOT NULL DEFAULT false`);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "person" DROP COLUMN "hidden"`);
+    }
+
+}

server/test/fixtures.ts

@@ -1160,6 +1160,7 @@ export const personStub = {
     name: '',
     thumbnailPath: '/path/to/thumbnail.jpg',
     faces: [],
+    hidden: false,
   }),
   withName: Object.freeze<PersonEntity>({
     id: 'person-1',
@@ -1170,6 +1171,29 @@ export const personStub = {
     name: 'Person 1',
     thumbnailPath: '/path/to/thumbnail.jpg',
     faces: [],
+    hidden: false,
+  }),
+  isHidden: Object.freeze<PersonEntity>({
+    id: 'person-1',
+    createdAt: new Date('2021-01-01'),
+    updatedAt: new Date('2021-01-01'),
+    ownerId: userEntityStub.admin.id,
+    owner: userEntityStub.admin,
+    name: 'Person 1',
+    thumbnailPath: '/path/to/thumbnail.jpg',
+    faces: [],
+    hidden: false,
+  }),
+  isnotHidden: Object.freeze<PersonEntity>({
+    id: 'person-1',
+    createdAt: new Date('2021-01-01'),
+    updatedAt: new Date('2021-01-01'),
+    ownerId: userEntityStub.admin.id,
+    owner: userEntityStub.admin,
+    name: 'Person 1',
+    thumbnailPath: '/path/to/thumbnail.jpg',
+    faces: [],
+    hidden: true,
   }),
   noThumbnail: Object.freeze<PersonEntity>({
     id: 'person-1',
@@ -1180,6 +1204,7 @@ export const personStub = {
     name: '',
     thumbnailPath: '',
     faces: [],
+    hidden: false,
   }),
   newThumbnail: Object.freeze<PersonEntity>({
     id: 'person-1',
@@ -1190,6 +1215,7 @@ export const personStub = {
     name: '',
     thumbnailPath: '/new/path/to/thumbnail.jpg',
     faces: [],
+    hidden: false,
   }),
   primaryPerson: Object.freeze<PersonEntity>({
     id: 'person-1',
@@ -1200,6 +1226,7 @@ export const personStub = {
     name: 'Person 1',
     thumbnailPath: '/path/to/thumbnail',
     faces: [],
+    hidden: false,
   }),
   mergePerson: Object.freeze<PersonEntity>({
     id: 'person-2',
@@ -1210,6 +1237,7 @@ export const personStub = {
     name: 'Person 2',
     thumbnailPath: '/path/to/thumbnail',
     faces: [],
+    hidden: false,
   }),
 };