feat: asset metadata (#20446)

server/src/services/asset-media.service.ts

@@ -423,6 +423,10 @@ export class AssetMediaService extends BaseService {
       sidecarPath: sidecarFile?.originalPath,
     });
 
+    if (dto.metadata) {
+      await this.assetRepository.upsertMetadata(asset.id, dto.metadata);
+    }
+
     if (sidecarFile) {
       await this.storageRepository.utimes(sidecarFile.originalPath, new Date(), new Date(dto.fileModifiedAt));
     }

server/src/services/asset.service.ts

@@ -9,12 +9,14 @@ import {
   AssetBulkUpdateDto,
   AssetJobName,
   AssetJobsDto,
+  AssetMetadataResponseDto,
+  AssetMetadataUpsertDto,
   AssetStatsDto,
   UpdateAssetDto,
   mapStats,
 } from 'src/dtos/asset.dto';
 import { AuthDto } from 'src/dtos/auth.dto';
-import { AssetStatus, AssetVisibility, JobName, JobStatus, Permission, QueueName } from 'src/enum';
+import { AssetMetadataKey, AssetStatus, AssetVisibility, JobName, JobStatus, Permission, QueueName } from 'src/enum';
 import { BaseService } from 'src/services/base.service';
 import { ISidecarWriteJob, JobItem, JobOf } from 'src/types';
 import { requireElevatedPermission } from 'src/utils/access';
@@ -93,7 +95,7 @@ export class AssetService extends BaseService {
       }
     }
 
-    await this.updateMetadata({ id, description, dateTimeOriginal, latitude, longitude, rating });
+    await this.updateExif({ id, description, dateTimeOriginal, latitude, longitude, rating });
 
     const asset = await this.assetRepository.update({ id, ...rest });
 
@@ -273,6 +275,31 @@ export class AssetService extends BaseService {
     });
   }
 
+  async getMetadata(auth: AuthDto, id: string): Promise<AssetMetadataResponseDto[]> {
+    await this.requireAccess({ auth, permission: Permission.AssetRead, ids: [id] });
+    return this.assetRepository.getMetadata(id);
+  }
+
+  async upsertMetadata(auth: AuthDto, id: string, dto: AssetMetadataUpsertDto): Promise<AssetMetadataResponseDto[]> {
+    await this.requireAccess({ auth, permission: Permission.AssetUpdate, ids: [id] });
+    return this.assetRepository.upsertMetadata(id, dto.items);
+  }
+
+  async getMetadataByKey(auth: AuthDto, id: string, key: AssetMetadataKey): Promise<AssetMetadataResponseDto> {
+    await this.requireAccess({ auth, permission: Permission.AssetRead, ids: [id] });
+
+    const item = await this.assetRepository.getMetadataByKey(id, key);
+    if (!item) {
+      throw new BadRequestException(`Metadata with key "${key}" not found for asset with id "${id}"`);
+    }
+    return item;
+  }
+
+  async deleteMetadataByKey(auth: AuthDto, id: string, key: AssetMetadataKey): Promise<void> {
+    await this.requireAccess({ auth, permission: Permission.AssetUpdate, ids: [id] });
+    return this.assetRepository.deleteMetadataByKey(id, key);
+  }
+
   async run(auth: AuthDto, dto: AssetJobsDto) {
     await this.requireAccess({ auth, permission: Permission.AssetUpdate, ids: dto.assetIds });
 
@@ -313,7 +340,7 @@ export class AssetService extends BaseService {
     return asset;
   }
 
-  private async updateMetadata(dto: ISidecarWriteJob) {
+  private async updateExif(dto: ISidecarWriteJob) {
     const { id, description, dateTimeOriginal, latitude, longitude, rating } = dto;
     const writes = _.omitBy({ description, dateTimeOriginal, latitude, longitude, rating }, _.isUndefined);
     if (Object.keys(writes).length > 0) {

server/src/services/sync.service.ts

@@ -74,6 +74,7 @@ export const SYNC_TYPES_ORDER = [
   SyncRequestType.PeopleV1,
   SyncRequestType.AssetFacesV1,
   SyncRequestType.UserMetadataV1,
+  SyncRequestType.AssetMetadataV1,
 ];
 
 const throwSessionRequired = () => {
@@ -156,6 +157,7 @@ export class SyncService extends BaseService {
       [SyncRequestType.AssetsV1]: () => this.syncAssetsV1(options, response, checkpointMap),
       [SyncRequestType.AssetExifsV1]: () => this.syncAssetExifsV1(options, response, checkpointMap),
       [SyncRequestType.PartnerAssetsV1]: () => this.syncPartnerAssetsV1(options, response, checkpointMap, session.id),
+      [SyncRequestType.AssetMetadataV1]: () => this.syncAssetMetadataV1(options, response, checkpointMap, auth),
       [SyncRequestType.PartnerAssetExifsV1]: () =>
         this.syncPartnerAssetExifsV1(options, response, checkpointMap, session.id),
       [SyncRequestType.AlbumsV1]: () => this.syncAlbumsV1(options, response, checkpointMap),
@@ -759,6 +761,33 @@ export class SyncService extends BaseService {
     }
   }
 
+  private async syncAssetMetadataV1(
+    options: SyncQueryOptions,
+    response: Writable,
+    checkpointMap: CheckpointMap,
+    auth: AuthDto,
+  ) {
+    const deleteType = SyncEntityType.AssetMetadataDeleteV1;
+    const deletes = this.syncRepository.assetMetadata.getDeletes(
+      { ...options, ack: checkpointMap[deleteType] },
+      auth.user.id,
+    );
+
+    for await (const { id, ...data } of deletes) {
+      send(response, { type: deleteType, ids: [id], data });
+    }
+
+    const upsertType = SyncEntityType.AssetMetadataV1;
+    const upserts = this.syncRepository.assetMetadata.getUpserts(
+      { ...options, ack: checkpointMap[upsertType] },
+      auth.user.id,
+    );
+
+    for await (const { updateId, ...data } of upserts) {
+      send(response, { type: upsertType, ids: [updateId], data });
+    }
+  }
+
   private async upsertBackfillCheckpoint(item: { type: SyncEntityType; sessionId: string; createId: string }) {
     const { type, sessionId, createId } = item;
     await this.syncCheckpointRepository.upsertAll([