refactor: repositories (#15561)

* refactor: version history repository

* refactor: oauth repository

* refactor: trash repository

* refactor: telemetry repository

* refactor: metadata repository

* refactor: cron repository

* refactor: map repository

* refactor: server-info repository

* refactor: album user repository

* refactor: notification repository

server/src/interfaces/album-user.interface.ts

@@ -1,18 +0,0 @@
-import { Insertable, Selectable, Updateable } from 'kysely';
-import { AlbumsSharedUsersUsers } from 'src/db';
-
-export const IAlbumUserRepository = 'IAlbumUserRepository';
-
-export type AlbumPermissionId = {
-  albumsId: string;
-  usersId: string;
-};
-
-export interface IAlbumUserRepository {
-  create(albumUser: Insertable<AlbumsSharedUsersUsers>): Promise<Selectable<AlbumsSharedUsersUsers>>;
-  update(
-    id: AlbumPermissionId,
-    albumPermission: Updateable<AlbumsSharedUsersUsers>,
-  ): Promise<Selectable<AlbumsSharedUsersUsers>>;
-  delete(id: AlbumPermissionId): Promise<void>;
-}

server/src/interfaces/cron.interface.ts

@@ -1,20 +0,0 @@
-export const ICronRepository = 'ICronRepository';
-
-type CronBase = {
-  name: string;
-  start?: boolean;
-};
-
-export type CronCreate = CronBase & {
-  expression: string;
-  onTick: () => void;
-};
-
-export type CronUpdate = CronBase & {
-  expression?: string;
-};
-
-export interface ICronRepository {
-  create(cron: CronCreate): void;
-  update(cron: CronUpdate): void;
-}

server/src/interfaces/job.interface.ts

@@ -1,5 +1,5 @@
 import { ClassConstructor } from 'class-transformer';
-import { EmailImageAttachment } from 'src/interfaces/notification.interface';
+import { EmailImageAttachment } from 'src/repositories/notification.repository';
 
 export enum QueueName {
   THUMBNAIL_GENERATION = 'thumbnailGeneration',

server/src/interfaces/map.interface.ts

@@ -1,31 +0,0 @@
-export const IMapRepository = 'IMapRepository';
-
-export interface MapMarkerSearchOptions {
-  isArchived?: boolean;
-  isFavorite?: boolean;
-  fileCreatedBefore?: Date;
-  fileCreatedAfter?: Date;
-}
-
-export interface GeoPoint {
-  latitude: number;
-  longitude: number;
-}
-
-export interface ReverseGeocodeResult {
-  country: string | null;
-  state: string | null;
-  city: string | null;
-}
-
-export interface MapMarker extends ReverseGeocodeResult {
-  id: string;
-  lat: number;
-  lon: number;
-}
-
-export interface IMapRepository {
-  init(): Promise<void>;
-  reverseGeocode(point: GeoPoint): Promise<ReverseGeocodeResult>;
-  getMapMarkers(ownerIds: string[], albumIds: string[], options?: MapMarkerSearchOptions): Promise<MapMarker[]>;
-}

server/src/interfaces/metadata.interface.ts

@@ -1,71 +0,0 @@
-import { BinaryField, Tags } from 'exiftool-vendored';
-
-export const IMetadataRepository = 'IMetadataRepository';
-
-export interface ExifDuration {
-  Value: number;
-  Scale?: number;
-}
-
-type StringOrNumber = string | number;
-
-type TagsWithWrongTypes =
-  | 'FocalLength'
-  | 'Duration'
-  | 'Description'
-  | 'ImageDescription'
-  | 'RegionInfo'
-  | 'TagsList'
-  | 'Keywords'
-  | 'HierarchicalSubject'
-  | 'ISO';
-export interface ImmichTags extends Omit<Tags, TagsWithWrongTypes> {
-  ContentIdentifier?: string;
-  MotionPhoto?: number;
-  MotionPhotoVersion?: number;
-  MotionPhotoPresentationTimestampUs?: number;
-  MediaGroupUUID?: string;
-  ImagePixelDepth?: string;
-  FocalLength?: number;
-  Duration?: number | string | ExifDuration;
-  EmbeddedVideoType?: string;
-  EmbeddedVideoFile?: BinaryField;
-  MotionPhotoVideo?: BinaryField;
-  TagsList?: StringOrNumber[];
-  HierarchicalSubject?: StringOrNumber[];
-  Keywords?: StringOrNumber | StringOrNumber[];
-  ISO?: number | number[];
-
-  // Type is wrong, can also be number.
-  Description?: StringOrNumber;
-  ImageDescription?: StringOrNumber;
-
-  // Extended properties for image regions, such as faces
-  RegionInfo?: {
-    AppliedToDimensions: {
-      W: number;
-      H: number;
-      Unit: string;
-    };
-    RegionList: {
-      Area: {
-        // (X,Y) // center of the rectangle
-        X: number;
-        Y: number;
-        W: number;
-        H: number;
-        Unit: string;
-      };
-      Rotation?: number;
-      Type?: string;
-      Name?: string;
-    }[];
-  };
-}
-
-export interface IMetadataRepository {
-  teardown(): Promise<void>;
-  readTags(path: string): Promise<ImmichTags>;
-  writeTags(path: string, tags: Partial<Tags>): Promise<void>;
-  extractBinaryTag(tagName: string, path: string): Promise<Buffer>;
-}

server/src/interfaces/notification.interface.ts

@@ -1,101 +0,0 @@
-export const INotificationRepository = 'INotificationRepository';
-
-export type EmailImageAttachment = {
-  filename: string;
-  path: string;
-  cid: string;
-};
-
-export type SendEmailOptions = {
-  from: string;
-  to: string;
-  replyTo?: string;
-  subject: string;
-  html: string;
-  text: string;
-  imageAttachments?: EmailImageAttachment[];
-  smtp: SmtpOptions;
-};
-
-export type SmtpOptions = {
-  host: string;
-  port?: number;
-  username?: string;
-  password?: string;
-  ignoreCert?: boolean;
-};
-
-export enum EmailTemplate {
-  TEST_EMAIL = 'test',
-
-  // AUTH
-  WELCOME = 'welcome',
-  RESET_PASSWORD = 'reset-password',
-
-  // ALBUM
-  ALBUM_INVITE = 'album-invite',
-  ALBUM_UPDATE = 'album-update',
-}
-
-interface BaseEmailProps {
-  baseUrl: string;
-  customTemplate?: string;
-}
-
-export interface TestEmailProps extends BaseEmailProps {
-  displayName: string;
-}
-
-export interface WelcomeEmailProps extends BaseEmailProps {
-  displayName: string;
-  username: string;
-  password?: string;
-}
-
-export interface AlbumInviteEmailProps extends BaseEmailProps {
-  albumName: string;
-  albumId: string;
-  senderName: string;
-  recipientName: string;
-  cid?: string;
-}
-
-export interface AlbumUpdateEmailProps extends BaseEmailProps {
-  albumName: string;
-  albumId: string;
-  recipientName: string;
-  cid?: string;
-}
-
-export type EmailRenderRequest =
-  | {
-      template: EmailTemplate.TEST_EMAIL;
-      data: TestEmailProps;
-      customTemplate: string;
-    }
-  | {
-      template: EmailTemplate.WELCOME;
-      data: WelcomeEmailProps;
-      customTemplate: string;
-    }
-  | {
-      template: EmailTemplate.ALBUM_INVITE;
-      data: AlbumInviteEmailProps;
-      customTemplate: string;
-    }
-  | {
-      template: EmailTemplate.ALBUM_UPDATE;
-      data: AlbumUpdateEmailProps;
-      customTemplate: string;
-    };
-
-export type SendEmailResponse = {
-  messageId: string;
-  response: any;
-};
-
-export interface INotificationRepository {
-  renderEmail(request: EmailRenderRequest): Promise<{ html: string; text: string }>;
-  sendEmail(options: SendEmailOptions): Promise<SendEmailResponse>;
-  verifySmtp(options: SmtpOptions): Promise<true>;
-}

server/src/interfaces/oauth.interface.ts

@@ -1,22 +0,0 @@
-import { UserinfoResponse } from 'openid-client';
-
-export const IOAuthRepository = 'IOAuthRepository';
-
-export type OAuthConfig = {
-  clientId: string;
-  clientSecret: string;
-  issuerUrl: string;
-  mobileOverrideEnabled: boolean;
-  mobileRedirectUri: string;
-  profileSigningAlgorithm: string;
-  scope: string;
-  signingAlgorithm: string;
-};
-export type OAuthProfile = UserinfoResponse;
-
-export interface IOAuthRepository {
-  init(): void;
-  authorize(config: OAuthConfig, redirectUrl: string): Promise<string>;
-  getLogoutEndpoint(config: OAuthConfig): Promise<string | undefined>;
-  getProfile(config: OAuthConfig, url: string, redirectUrl: string): Promise<OAuthProfile>;
-}

server/src/interfaces/server-info.interface.ts

@@ -1,24 +0,0 @@
-export interface GitHubRelease {
-  id: number;
-  url: string;
-  tag_name: string;
-  name: string;
-  created_at: string;
-  published_at: string;
-  body: string;
-}
-
-export interface ServerBuildVersions {
-  nodejs: string;
-  ffmpeg: string;
-  libvips: string;
-  exiftool: string;
-  imagemagick: string;
-}
-
-export const IServerInfoRepository = 'IServerInfoRepository';
-
-export interface IServerInfoRepository {
-  getGitHubRelease(): Promise<GitHubRelease>;
-  getBuildVersions(): Promise<ServerBuildVersions>;
-}

server/src/interfaces/telemetry.interface.ts

@@ -1,23 +0,0 @@
-import { MetricOptions } from '@opentelemetry/api';
-import { ClassConstructor } from 'class-transformer';
-
-export const ITelemetryRepository = 'ITelemetryRepository';
-
-export interface MetricGroupOptions {
-  enabled: boolean;
-}
-
-export interface IMetricGroupRepository {
-  addToCounter(name: string, value: number, options?: MetricOptions): void;
-  addToGauge(name: string, value: number, options?: MetricOptions): void;
-  addToHistogram(name: string, value: number, options?: MetricOptions): void;
-  configure(options: MetricGroupOptions): this;
-}
-
-export interface ITelemetryRepository {
-  setup(options: { repositories: ClassConstructor<unknown>[] }): void;
-  api: IMetricGroupRepository;
-  host: IMetricGroupRepository;
-  jobs: IMetricGroupRepository;
-  repo: IMetricGroupRepository;
-}

server/src/interfaces/trash.interface.ts

@@ -1,8 +0,0 @@
-export const ITrashRepository = 'ITrashRepository';
-
-export interface ITrashRepository {
-  empty(userId: string): Promise<number>;
-  restore(userId: string): Promise<number>;
-  restoreAll(assetIds: string[]): Promise<number>;
-  getDeletedIds(): AsyncIterableIterator<{ id: string }>;
-}

server/src/interfaces/version-history.interface.ts

@@ -1,9 +0,0 @@
-import { VersionHistoryEntity } from 'src/entities/version-history.entity';
-
-export const IVersionHistoryRepository = 'IVersionHistoryRepository';
-
-export interface IVersionHistoryRepository {
-  create(version: Omit<VersionHistoryEntity, 'id' | 'createdAt'>): Promise<VersionHistoryEntity>;
-  getAll(): Promise<VersionHistoryEntity[]>;
-  getLatest(): Promise<VersionHistoryEntity | undefined>;
-}