weseek__growi/apps/app/src/features/page-bulk-export/interfaces/page-bulk-export.ts

import type {
  HasObjectId,
  IAttachment, IPage, IRevision, IUser, Ref,
} from '@growi/core';

export const PageBulkExportFormat = {
  md: 'md',
  pdf: 'pdf',
} as const;

export type PageBulkExportFormat = typeof PageBulkExportFormat[keyof typeof PageBulkExportFormat]

export const PageBulkExportJobInProgressStatus = {
  initializing: 'initializing', // preparing for export
  exporting: 'exporting', // exporting to fs
  uploading: 'uploading', // uploading to cloud storage
} as const;

export const PageBulkExportJobStatus = {
  ...PageBulkExportJobInProgressStatus,
  completed: 'completed',
  failed: 'failed',
} as const;

export type PageBulkExportJobStatus = typeof PageBulkExportJobStatus[keyof typeof PageBulkExportJobStatus]

export interface IPageBulkExportJob {
  user: Ref<IUser>, // user that started export job
  page: Ref<IPage>, // the root page of page tree to export
  lastExportedPagePath?: string, // the path of page that was exported to the fs last
  uploadId?: string, // upload ID of multipart upload of S3/GCS
  uploadKey?: string, // upload key of multipart upload of S3/GCS
  format: PageBulkExportFormat,
  completedAt?: Date, // the date at which job was completed
  attachment?: Ref<IAttachment>,
  status: PageBulkExportJobStatus,
}

export interface IPageBulkExportJobHasId extends IPageBulkExportJob, HasObjectId {}

// snapshot of page info to upload
export interface IPageBulkExportPageSnapshot {
  pageBulkExportJob: Ref<IPageBulkExportJob>,
  path: string, // page path when export was stared
  revision: Ref<IRevision>, // page revision when export was stared
}