memories/src/types.ts

export type IFileInfo = {
  /** Same as fileid */
  id: number;
  /** Database file ID */
  fileid: number;
  /** Full file name, e.g. /pi/test/Qx0dq7dvEXA.jpg */
  filename: string;
  /** Original file name, e.g. /files/admin/pi/test/Qx0dq7dvEXA.jpg */
  originalFilename: string;
  /** Base name of file e.g. Qx0dq7dvEXA.jpg */
  basename: string;
};

export type IDay = {
  /** Day ID */
  dayid: number;
  /** Number of photos in this day */
  count: number;
  /** Rows in the day */
  rows?: IRow[];
  /** List of photos for this day */
  detail?: IPhoto[];
};

export type IPhoto = {
  /** Nextcloud ID of file */
  fileid: number;
  /**
   * Vue key unique to this object.
   * 1/ File ID by default.
   * 2/ Indexed if duplicates present.
   * 3/ Face ID for people views.
   */
  key?: string;
  /** Etag from server */
  etag?: string;
  /** Base name of file */
  basename?: string;
  /** Mime type of file */
  mimetype?: string;
  /** Bit flags */
  flag: number;
  /** DayID from server */
  dayid: number;
  /** Width of full image */
  w?: number;
  /** Height of full image */
  h?: number;
  /** Live Photo identifier */
  liveid?: string;

  /** Grid display width px */
  dispW?: number;
  /** Grid display height px */
  dispH?: number;
  /** Grid display X px */
  dispX?: number;
  /** Grid display Y px */
  dispY?: number;
  /** Grid display row id (relative to head) */
  dispRowNum?: number;

  /** Reference to day object */
  d?: IDay;
  /** Reference to exif object */
  imageInfo?: IImageInfo | null;

  /** Face detection ID */
  faceid?: number;
  /** Face dimensions */
  facerect?: IFaceRect;

  /** Video flag from server */
  isvideo?: boolean;
  /** Video duration from server */
  video_duration?: number;
  /** Favorite flag from server */
  isfavorite?: boolean;
  /** Local file from native */
  islocal?: boolean;

  /** AUID of file (optional, NativeX) */
  auid?: number;
  /** Epoch of file (optional, NativeX) */
  epoch?: number;
  /** File size (optional) */
  size?: number;

  /** Date taken UTC value (lazy fetched) */
  datetaken?: number;
};

export interface IImageInfo {
  fileid: number;
  etag: string;
  h: number;
  w: number;
  datetaken: number;

  permissions: string;
  basename: string;
  mimetype: string;
  size: number;

  filename?: string;
  address?: string;
  tags?: { [id: string]: string };

  exif?: IExif;

  clusters?: {
    albums?: IAlbum[];
    recognize?: IFace[];
    facerecognition?: IFace[];
  };
}

export interface IExif {
  Rotation?: number;
  Orientation?: number;
  ImageWidth?: number;
  ImageHeight?: number;
  Megapixels?: number;

  Title?: string;
  Description?: string;
  Make?: string;
  Model?: string;

  DateTimeEpoch?: number;
  OffsetTimeOriginal?: string;
  OffsetTime?: string;
  LocationTZID?: string;

  ExposureTime?: number;
  ShutterSpeed?: number;
  ShutterSpeedValue?: number;
  Aperture?: number;
  ApertureValue?: number;
  ISO?: number;
  FNumber?: number;
  FocalLength?: number;

  GPSAltitude?: number;
  GPSLatitude?: number;
  GPSLongitude?: number;
}

export interface IFolder extends IPhoto {
  /** Path to folder */
  path: string;
  /** Photos for preview images */
  previews?: IPhoto[];
  /** Name of folder */
  name: string;
}

export type ClusterTypes = 'tags' | 'albums' | 'places' | 'recognize' | 'facerecognition' | 'plus';

export interface ICluster {
  /** A unique identifier for the cluster */
  cluster_id: number | string;
  /** Type of cluster */
  cluster_type: ClusterTypes;
  /** Number of images in this cluster */
  count: number;
  /** Name of cluster */
  name: string;

  /** Preview loading failed */
  previewError?: boolean;
}

export interface IAlbum extends ICluster {
  /** ID of album */
  album_id: number;
  /** Owner of album */
  user: string;
  /** Display name of album owner */
  user_display?: string;
  /** Created timestamp */
  created: number;
  /** Location string */
  location: string;
  /** File ID of last added photo */
  last_added_photo: number;
}

export interface IFace extends ICluster {
  /** User for face */
  user_id: string;
}

export interface IFaceRect {
  w: number;
  h: number;
  x: number;
  y: number;
}

export type IRow = {
  /** Vue Recycler identifier */
  id?: string;
  /** Row ID from head */
  num: number;
  /** Day ID */
  dayId: number;
  /** Refrence to day object */
  day: IDay;
  /** Whether this is a head row */
  type: IRowType;
  /** [Head only] Title of the header */
  name?: string;
  /** [Head only] Boolean if the entire day is selected */
  selected?: boolean;
  /** Main list of photo items */
  photos?: IPhoto[];

  /** Height in px of the row */
  size: number;
  /** Count of placeholders to create */
  pct?: number;
  /** Don't remove dom element */
  virtualSticky?: boolean;
};
export type IHeadRow = IRow & {
  type: IRowType.HEAD;
  selected: boolean;
  super?: string;
};
export enum IRowType {
  HEAD = 0,
  PHOTOS = 1,
}

export type ITick = {
  /** Day ID */
  dayId: number;
  /** Display top position */
  topF: number;
  /** Display top position (truncated to 1 decimal pt) */
  top: number;
  /** Y coordinate on recycler */
  y: number;
  /** Cumulative number of photos before this tick */
  count: number;
  /** Is a new month */
  isMonth: boolean;
  /** Text if any (e.g. year) */
  text?: string | number;
  /** Whether this tick should be shown */
  s?: boolean;
  /** Key for vue component */
  key?: number;
};

export type IConfig = {
  // general stuff
  version: string;
  vod_disable: boolean;
  video_default_quality: string;
  places_gis: number;

  // enabled apps
  systemtags_enabled: boolean;
  albums_enabled: boolean;
  recognize_installed: boolean;
  recognize_enabled: boolean;
  facerecognition_installed: boolean;
  facerecognition_enabled: boolean;
  preview_generator_enabled: boolean;

  // general settings
  timeline_path: string;
  enable_top_memories: boolean;

  // viewer settings
  high_res_cond_default: 'always' | 'zoom' | 'never';
  livephoto_autoplay: boolean;
  sidebar_filepath: boolean;

  // folder settings
  folders_path: string;
  show_hidden_folders: boolean;
  sort_folder_month: boolean;

  // album settings
  sort_album_month: boolean;

  // local settings
  square_thumbs: boolean;
  high_res_cond: IConfig['high_res_cond_default'] | null;
  show_face_rect: boolean;
  album_list_sort: 1 | 2;
};