teableio/teable

import type { Readable as ReadableStream } from 'node:stream';
import { resolve } from 'path';
import { BadRequestException } from '@nestjs/common';
import { UploadType } from '@teable/openapi';
import { storageConfig } from '../../../configs/storage';
import type { IObjectMeta, IPresignParams, IPresignRes } from './types';

export default abstract class StorageAdapter {
  static readonly TEMPORARY_DIR = resolve(process.cwd(), '.temporary');

  static readonly getBucket = (type: UploadType) => {
    switch (type) {
      case UploadType.Table:
      case UploadType.Import:
        return storageConfig().privateBucket;
      case UploadType.Avatar:
      case UploadType.OAuth:
      case UploadType.Form:
      case UploadType.Plugin:
        return storageConfig().publicBucket;
      case UploadType.Comment:
        return storageConfig().privateBucket;
      default:
        throw new BadRequestException('Invalid upload type');
    }
  };

  static readonly getDir = (type: UploadType): string => {
    switch (type) {
      case UploadType.Table:
        return 'table';
      case UploadType.Avatar:
        return 'avatar';
      case UploadType.Form:
        return 'form';
      case UploadType.OAuth:
        return 'oauth';
      case UploadType.Import:
        return 'import';
      case UploadType.Plugin:
        return 'plugin';
      case UploadType.Comment:
        return 'comment';
      default:
        throw new BadRequestException('Invalid upload type');
    }
  };

  static readonly isPublicBucket = (bucket: string) => {
    return bucket === storageConfig().publicBucket;
  };

  /**
   * generate presigned url
   * @param bucket bucket name
   * @param dir storage dir
   * @param params presigned params, limit presigned url upload file
   * @returns presigned url and upload params
   */
  abstract presigned(bucket: string, dir: string, params: IPresignParams): Promise<IPresignRes>;

  /**
   * get object meta
   * @param bucket bucket name
   * @param path path name
   * @param token presigned token
   * @returns object meta
   */
  abstract getObjectMeta(bucket: string, path: string, token: string): Promise<IObjectMeta>;

  /**
   * get preview url
   * @param bucket bucket name
   * @param path path name
   * @param respHeaders response headers, example: { 'Content-Type': 'images/png' }
   */
  abstract getPreviewUrl(
    bucket: string,
    path: string,
    expiresIn?: number,
    respHeaders?: {
      // eslint-disable-next-line @typescript-eslint/no-explicit-any
      [key: string]: any;
    }
  ): Promise<string | undefined>;

  /**
   * uploadFile with file path
   * @param bucket bucket name
   * @param path path name
   * @param filePath file path
   * @param metadata Metadata of the object.
   */
  abstract uploadFileWidthPath(
    bucket: string,
    path: string,
    filePath: string,
    metadata: Record<string, unknown>
  ): Promise<{ hash: string; path: string }>;

  /**
   * uploadFile with file stream
   * @param bucket bucket name
   * @param path path name
   * @param stream file stream
   * @param metadata Metadata of the object.
   */
  abstract uploadFile(
    bucket: string,
    path: string,
    stream: Buffer | ReadableStream,
    metadata?: Record<string, unknown>
  ): Promise<{ hash: string; path: string }>;

  /**
   * cut image
   * @param bucket bucket name
   * @param path path name
   * @param width width
   * @param height height
   * @param newPath save as new path
   * @returns cut image url
   */
  abstract cropImage(
    bucket: string,
    path: string,
    width?: number,
    height?: number,
    newPath?: string
  ): Promise<string>;
}