flydrive/build/drivers/gcs/types.d.ts

File storage library with unified API to manage files across multiple cloud storage providers like S3, GCS, R2 and so on

import type { GetSignedUrlConfig, Storage, StorageOptions } from '@google-cloud/storage';
import type { ObjectVisibility } from '../../src/types.js';
/**
 * The base set of options that are always needed to
 * create GCS driver instance
 */
type GCSDriverBaseOptions = {
    /**
     * The bucket from which to read and write files
     */
    bucket: string;
    /**
     * The default visibility of all the objects within the
     * bucket. The property is only considered when the
     * bucket is not using uniformACL.
     */
    visibility: ObjectVisibility;
    /**
     * Is bucket using uniform ACL? Defaults to "true".
     *
     * When set to "true", the visibility setting of FlyDrive
     * will have no impact.
     */
    usingUniformAcl?: boolean;
    /**
     * Configure a custom URL builder for creating public and
     * temporary URLs
     */
    urlBuilder?: {
        /**
         * Custom implementation for creating public URLs
         */
        generateURL?(key: string, bucket: string, storage: Storage): Promise<string>;
        /**
         * Custom implementation for creating signed/temporary URLs
         */
        generateSignedURL?(key: string, bucket: string, config: GetSignedUrlConfig, storage: Storage): Promise<string>;
        /**
         * Custom implementation for creating signed/temporary URLs for uploading files
         */
        generateSignedUploadURL?(key: string, bucket: string, config: GetSignedUrlConfig, storage: Storage): Promise<string>;
    };
};
/**
 * Configuration options accepted by the GCS driver
 */
export type GCSDriverOptions = ({
    /**
     * An instance of the GCS storage class. If not provided,
     * one must provide other options to establish a connection
     */
    storage: Storage;
} & GCSDriverBaseOptions) | (StorageOptions & GCSDriverBaseOptions);
export {};