schema.graphql

type AccessLog {
  folder: Folder
  folderId: ID
  id: ID!
  ipAddress: String
  timestamp: DateTime!
  type: AccessType!
  user: User
  userAgent: String
  userId: ID
}

enum AccessType {
  Download
  View
}

"""
The `BigInt` scalar type represents non-fractional signed whole numeric values.
"""
scalar BigInt

type Branding {
  availableViews: [String!]
  defaultView: String
  folder: Folder
  folderId: ID
  folders: [Folder!]!
  footerTitle: String
  footerUrl: String
  headingAlignment: String
  headingFontKey: HeadingFontKey
  headingFontSize: Int
  id: ID!
  logoUrl: String
  mode: ThemeMode
  name: String
  primaryColor: PrimaryColor
  socialLinks: JSON
  thumbnailBorderRadius: Int
  thumbnailSize: Int
  thumbnailSpacing: Int
}

type ClientInfo {
  avifEnabled: Boolean!
  baseUrl: String!
  canWrite: Boolean!
}

type Comment {
  comment: String
  file: File
  id: ID
  systemGenerated: Boolean!
  timestamp: DateTime!
  user: User
  userId: ID
}

enum CommentPermissions {
  edit
  none
  read
}

"""
A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
"""
scalar DateTime

type File implements FileInterface {
  fileCreated: DateTime!
  fileHash: String!
  fileLastModified: DateTime!
  fileSize: BigInt!
  flag: FileFlag
  folder: Folder
  folderId: ID!
  id: ID!
  latestComment: DateTime
  name: String!
  rating: Int
  totalComments: Int
  type: FileType!
}

enum FileFlag {
  approved
  none
  rejected
}

interface FileInterface {
  fileCreated: DateTime!
  fileHash: String!
  fileLastModified: DateTime!
  fileSize: BigInt!
  flag: FileFlag
  folder: Folder
  folderId: ID!
  id: ID!
  latestComment: DateTime
  name: String!
  rating: Int
  totalComments: Int
  type: FileType!
}

enum FileType {
  File
  Image
  Video
}

type Folder {
  bannerImage: Image
  bannerSize: String
  bannerTextHAlign: String
  bannerTextVAlign: String
  branding: Branding
  brandingId: ID
  files: [FileInterface!]!
  folderLastModified: DateTime!
  heroImage: Image
  id: ID!
  name: String!
  parentId: ID
  parents: [Folder!]!
  permissions: FolderPermissions
  relativePath: String!
  subFolders: [Folder!]!
  subtitle: String
  title: String
  totalDirectSize: String!
  totalFiles: Int!
  totalFolders: Int!
  totalImages: Int!
  totalSize: String!
  users: [User!]
}

type FolderFileExport {
  file: FileInterface!
  relativePath: String!
}

type FolderFilesResult {
  files: [FolderFileExport!]!
  totalAvailable: Int!
  totalReturned: Int!
  truncated: Boolean!
}

enum FolderPermissions {
  Admin
  None
  View
}

enum FoldersSortType {
  folderLastModified
  name
}

enum HeadingFontKey {
  abrilFatface
  amaticSc
  atkinsonHyperlegibleMono
  atkinsonHyperlegibleNext
  bebasNeue
  dancingScript
  default
  inter
  jetbrainsMono
  libreBaskerville
  lora
  manrope
  merriweather
  merriweatherSans
  montserrat
  oleoScript
  pacifico
  pinyonScript
  poiretOne
  signika
  sourceSans3
}

type Image implements FileInterface {
  blurHash: String!
  fileCreated: DateTime!
  fileHash: String!
  fileLastModified: DateTime!
  fileSize: BigInt!
  flag: FileFlag
  folder: Folder
  folderId: ID!
  id: ID!
  imageRatio: Float
  latestComment: DateTime
  metadata: ImageMetadataSummary
  name: String!
  rating: Int
  totalComments: Int
  type: FileType!
}

type ImageMetadataSummary {
  Aperture: Float
  Artist: String
  Camera: String
  DateTimeEdit: String
  DateTimeOriginal: String
  ExposureTime: Float
  Height: Int
  ISO: Float
  Lens: String
  Rating: Int
  Width: Int
}

"""
The `JSON` scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).
"""
scalar JSON

enum LinkMode {
  final_delivery
  proof_no_downloads
}

type Mutation {
  addComment(comment: String, flag: FileFlag, id: ID!, nickName: String, rating: Int): FileInterface!
  auth(password: String!, user: String!): String!
  deleteBranding(id: ID!): Boolean!
  deleteUser(id: ID!): Boolean!
  editAdminUser(commentPermissions: CommentPermissions, enabled: Boolean, folderId: ID, id: ID, name: String, ntfy: String, ntfyEmail: Boolean, password: String, username: String): User!
  editBranding(availableViews: [String!], defaultView: String, footerTitle: String, footerUrl: String, headingAlignment: String, headingFontKey: HeadingFontKey, headingFontSize: Int, id: ID, logoUrl: String, mode: ThemeMode, name: String, primaryColor: PrimaryColor, socialLinks: JSON, thumbnailBorderRadius: Int, thumbnailSize: Int, thumbnailSpacing: Int): Branding!
  editFolder(bannerImageId: ID, bannerSize: String, bannerTextHAlign: String, bannerTextVAlign: String, folderId: ID!, heroImageId: ID, subtitle: String, title: String): Folder!
  editUser(commentPermissions: CommentPermissions, enabled: Boolean, folderId: ID, id: ID, linkMode: LinkMode, name: String, username: String, uuid: String): User!
  editUserDevice(enabled: Boolean!, name: String, notificationToken: String!, userId: ID!): UserDevice!
  generateThumbnails(folderId: ID): Boolean!
  generateZip(folderId: ID): String!
  renameFolder(folderId: ID!, newPath: String!, oldPath: String!): Folder!
  setFolderBranding(brandingId: ID, folderId: ID!): Folder!
}

enum PrimaryColor {
  blue
  cyan
  dark
  grape
  gray
  green
  indigo
  lime
  orange
  pink
  red
  teal
  violet
  yellow
}

type Query {
  accessLogs(folderId: ID!, includeChildren: Boolean, userId: ID, userType: UserType): [AccessLog!]!
  admins: [User!]!
  allFolders(id: ID!, limit: Int, sort: FoldersSortType): [Folder]!
  brandings: [Branding!]!
  clientInfo: ClientInfo
  comments(fileId: ID, folderId: ID): [Comment!]!
  file(id: ID!): FileInterface!
  folder(id: ID!): Folder!
  folderFiles(folderId: ID!, includeSubfolders: Boolean, limit: Int): FolderFilesResult!
  me: User
  searchFiles(folderId: ID, query: String!): [File!]!
  searchFolders(folderId: ID, query: String!): [Folder!]!
  serverInfo: ServerInfo
  tasks(folderId: ID): [Task!]!
  user(id: ID!): User!
  userDevices(notificationToken: String, userId: ID): [UserDevice!]!
  users(folderId: ID!, includeChildren: Boolean, includeParents: Boolean, sortByRecent: Boolean): [User!]!
}

type ServerInfo {
  cacheSize: BigInt!
  canWrite: Boolean!
  databaseUrl: String!
  dev: Boolean!
  developmentBuildSha: String
  host: String!
  latest: String!
  mediaSize: BigInt!
  usePolling: Boolean!
  version: String!
}

type Task {
  folder: Folder
  id: ID
  name: String!
  startTime: String
  status: String
  step: Int
  totalSteps: Int
}

enum ThemeMode {
  auto
  dark
  light
}

type User {
  commentPermissions: CommentPermissions
  deleted: Boolean
  enabled: Boolean
  folder: Folder
  folderId: ID!
  gravatar: String
  id: ID
  lastAccess: DateTime
  linkMode: LinkMode
  name: String
  ntfy: String
  ntfyEmail: Boolean
  userType: UserType
  username: String
  uuid: String
}

type UserDevice {
  enabled: Boolean!
  id: ID!
  name: String
  notificationToken: String
  userId: ID!
}

enum UserType {
  Admin
  All
  Link
  User
}

type Video implements FileInterface {
  duration: Float
  fileCreated: DateTime!
  fileHash: String!
  fileLastModified: DateTime!
  fileSize: BigInt!
  flag: FileFlag
  folder: Folder
  folderId: ID!
  id: ID!
  imageRatio: Float
  latestComment: DateTime
  metadata: VideoMetadataSummary
  name: String!
  rating: Int
  totalComments: Int
  type: FileType!
}

type VideoMetadataSummary {
  AudioCodec: String
  AudioCodecDescription: String
  Bitrate: Int
  Duration: Float
  Format: String
  Framerate: Float
  Height: Int
  VideoCodec: String
  VideoCodecDescription: String
  Width: Int
}