directus/packages/drive/src/Storage.ts

import { MethodNotSupported } from './exceptions';
import {
	Response,
	SignedUrlResponse,
	ContentResponse,
	ExistsResponse,
	SignedUrlOptions,
	StatResponse,
	FileListResponse,
	DeleteResponse,
	Range,
} from './types';

export default abstract class Storage {
	/**
	 * Appends content to a file.
	 *
	 * Supported drivers: "local"
	 */
	append(location: string, content: Buffer | string): Promise<Response> {
		throw new MethodNotSupported('append', this.constructor.name);
	}

	/**
	 * Copy a file to a location.
	 *
	 * Supported drivers: "local", "s3", "gcs", "azure"
	 */
	copy(src: string, dest: string): Promise<Response> {
		throw new MethodNotSupported('copy', this.constructor.name);
	}

	/**
	 * Delete existing file.
	 * The value returned by this method will have a `wasDeleted` property that
	 * can be either a boolean (`true` if a file was deleted, `false` if there was
	 * no file to delete) or `null` (if no information about the file is available).
	 *
	 * Supported drivers: "local", "s3", "gcs", "azure"
	 */
	delete(location: string): Promise<DeleteResponse> {
		throw new MethodNotSupported('delete', this.constructor.name);
	}

	/**
	 * Returns the driver.
	 *
	 * Supported drivers: "local", "s3", "gcs", "azure"
	 */
	public driver(): unknown {
		throw new MethodNotSupported('driver', this.constructor.name);
	}

	/**
	 * Determines if a file or folder already exists.
	 *
	 * Supported drivers: "local", "s3", "gcs", "azure"
	 */
	exists(location: string): Promise<ExistsResponse> {
		throw new MethodNotSupported('exists', this.constructor.name);
	}

	/**
	 * Returns the file contents as a string.
	 *
	 * Supported drivers: "local", "s3", "gcs", "azure"
	 */
	get(location: string, encoding?: string): Promise<ContentResponse<string>> {
		throw new MethodNotSupported('get', this.constructor.name);
	}

	/**
	 * Returns the file contents as a Buffer.
	 *
	 * Supported drivers: "local", "s3", "gcs", "azure"
	 */
	getBuffer(location: string): Promise<ContentResponse<Buffer>> {
		throw new MethodNotSupported('getBuffer', this.constructor.name);
	}

	/**
	 * Returns signed url for an existing file.
	 *
	 * Supported drivers: "s3", "gcs", "azure"
	 */
	getSignedUrl(location: string, options?: SignedUrlOptions): Promise<SignedUrlResponse> {
		throw new MethodNotSupported('getSignedUrl', this.constructor.name);
	}

	/**
	 * Returns file's size and modification date.
	 *
	 * Supported drivers: "local", "s3", "gcs", "azure"
	 */
	getStat(location: string): Promise<StatResponse> {
		throw new MethodNotSupported('getStat', this.constructor.name);
	}

	/**
	 * Returns the stream for the given file.
	 *
	 * Supported drivers: "local", "s3", "gcs", "azure"
	 */
	getStream(location: string, range?: Range): NodeJS.ReadableStream {
		throw new MethodNotSupported('getStream', this.constructor.name);
	}

	/**
	 * Returns url for a given key. Note this method doesn't
	 * validates the existence of file or it's visibility
	 * status.
	 *
	 * Supported drivers: "s3", "gcs", "azure"
	 */
	getUrl(location: string): string {
		throw new MethodNotSupported('getUrl', this.constructor.name);
	}

	/**
	 * Move file to a new location.
	 *
	 * Supported drivers: "local", "s3", "gcs", "azure"
	 */
	move(src: string, dest: string): Promise<Response> {
		throw new MethodNotSupported('move', this.constructor.name);
	}

	/**
	 * Creates a new file.
	 * This method will create missing directories on the fly.
	 *
	 * Supported drivers: "local", "s3", "gcs", "azure"
	 */
	put(location: string, content: Buffer | NodeJS.ReadableStream | string): Promise<Response> {
		throw new MethodNotSupported('put', this.constructor.name);
	}

	/**
	 * Prepends content to a file.
	 *
	 * Supported drivers: "local"
	 */
	prepend(location: string, content: Buffer | string): Promise<Response> {
		throw new MethodNotSupported('prepend', this.constructor.name);
	}

	/**
	 * List files with a given prefix.
	 *
	 * Supported drivers: "local", "s3", "gcs", "azure"
	 */
	flatList(prefix?: string): AsyncIterable<FileListResponse> {
		throw new MethodNotSupported('flatList', this.constructor.name);
	}
}