@tweedegolf/sab-adapter-azure-blob/dist/types/general.d.ts

Provides an abstraction layer for interacting with Microsoft Azure Blob Storage cloud service.

import { ResultObject, ResultObjectBoolean, ResultObjectBuckets, ResultObjectFiles, ResultObjectNumber, ResultObjectStream } from "./result";
import { FileBufferParams, FilePathParams, FileStreamParams } from "./add_file_params";
export declare enum StorageType {
    LOCAL = "local",
    GCS = "gcs",// Google Cloud Storage
    GS = "gs",// Google Cloud Storage
    S3 = "s3",// Amazon S3
    B2 = "b2",// BackBlaze B2
    AZURE = "azure",// Azure Storage Blob
    MINIO = "minio"
}
export interface AdapterConfig {
    bucketName?: string;
    [id: string]: any;
}
export interface StorageAdapterConfig extends AdapterConfig {
    type: string;
}
export interface Options {
    [id: string]: any;
}
export interface StreamOptions extends Options {
    start?: number;
    end?: number;
}
export interface IAdapter {
    getServiceClient(): any;
    serviceClient: any;
    /**
     * Returns the storage type, e.g. 'gcs', 'b2', 'local' etc.
     */
    getType(): string;
    /**
     * Same as `getType` but implemented as getter
     * @returns adapter type, e.g. 'gcs', 'b2', 'local' etc.
     */
    type: string;
    /**
     * Returns configuration settings that you've provided when instantiating as an object.
     * Use this only for debugging and with great care as it may expose sensitive information.
     *
     * The object contains the key `bucketName` which is the initial value that you've set during
     * initialization.
     *
     * The object also contains the key `options` which are only the options passed in during
     * initialization; if you want all options, including the default options use `getOptions()`
     *
     * @returns adapter configuration as object
     */
    getConfig(): AdapterConfig;
    /**
     * Same as `getConfiguration` but implemented as getter
     * @returns adapter configuration as object
     */
    config: AdapterConfig;
    getConfigError(): null | string;
    configError: null | string;
    getSelectedBucket(): null | string;
    setSelectedBucket(bucketName: null | string): void;
    bucketName: null | string;
    set(bucketName: null | string): void;
    /**
     * Returns an object that contains both the options passed with the configuration and the
     * default options of the storage type if not overruled by the options you passed in.
     */
    /**
     * @param bucketName name of the bucket to create, returns "ok" once the bucket has been created but
     * also when the bucket already exists.
     * @param options: additional options for creating a bucket such as access rights
     * @returns string or error
     */
    createBucket(bucketName: string, options?: Options): Promise<ResultObject>;
    /**
     * @param bucketName: deletes all file in the bucket.
     */
    clearBucket(bucketName?: string): Promise<ResultObject>;
    /**
     * deletes the bucket with the provided name
     * @param {string} bucketName name of the bucket
     * @returns {Promise<ResultObject>} a promise that always resolves in a ResultObject:
     * ```typescript
     * { error: null | string, value: null | string }
     * ```
     */
    deleteBucket(bucketName?: string): Promise<ResultObject>;
    /**
     * @returns an array of the names of the buckets in this storage
     */
    listBuckets(): Promise<ResultObjectBuckets>;
    /**
     * @param {filePathParams | FileBufferParams | FileStreamParams} params related to the file to be added
     * @returns the public url to the file
     * Called internally by addFileFromPath, addFileFromBuffer and addFileFromReadable
     */
    addFile(params: FilePathParams | FileBufferParams | FileStreamParams): Promise<ResultObject>;
    /**
     * @param {FilePathParams} params object that has the following keys:
     * ```typescript
     * {
     *  bucketName: string
     *  origPath: string //path to the file that you want to add, e.g. /home/user/Pictures/image1.jpg
     *  targetPath: string //path on the storage, you can add a path or only provide name of the file
     *  options?: object
     * }
     * ```
     * @returns {ResultObject} a promise that always resolves in a ResultObject:
     * ```typescript
     * {
     *  value: string | null
     *  error: string | null
     * }
     * ```
     */
    addFileFromPath(params: FilePathParams): Promise<ResultObject>;
    /**
     * @param {FileBufferParams} params
     * @property {string} FilePath.bucketName
     * @property {Buffer} FilePath.buffer - buffer
     * @property {string} FilePath.targetPath - path on the storage, you can add a path or only provide name of the file
     * @property {object} FilePath.options
     */
    addFileFromBuffer(params: FileBufferParams): Promise<ResultObject>;
    /**
     * @param {FileStreamParams} params object that contains the following keys:
     * ```typescript
     * {
     * bucketName: string
     * readable: Readable // stream from the local file, e.g. fs.createReadStream(path)
     * targetPath: string // path on the storage, you can add a path or only provide name of the file
     * options?: object
     * }
     * ```
     * @returns {ResultObject} a promise that always resolves in a ResultObject
     * ```typescript
     * {
     *  value: string | null // if success value is the public url to the file
     *  error: string | null // if fails error is the error message
     * }
     * ```
     */
    addFileFromStream(params: FileStreamParams): Promise<ResultObject>;
    /**
     * @param bucketName name of the bucket where the file is stored
     * @param fileName name of the file to be returned as a readable stream
     * @param start? the byte of the file where the stream starts (default: 0)
     * @param end? the byte in the file where the stream ends (default: last byte of file)
     */
    getFileAsStream(bucketName: string, fileName: string, options?: StreamOptions): Promise<ResultObjectStream>;
    getFileAsStream(fileName: string, options?: StreamOptions): Promise<ResultObjectStream>;
    getFileAsStream(arg1: string, arg2?: StreamOptions | string, arg3?: StreamOptions): Promise<ResultObjectStream>;
    /**
     * @param bucketName name of the bucket where the file is stored
     * @param fileName name of the file
     */
    getFileAsURL(bucketName: string, fileName: string, options?: Options): Promise<ResultObject>;
    getFileAsURL(fileName: string, options?: Options): Promise<ResultObject>;
    getFileAsURL(arg1: string, arg2?: Options | string, arg3?: Options): Promise<ResultObject>;
    /**
     * @param {string} bucketName name of the bucket where the file is stored
     * @param {string} fileName name of the file to be removed
     * @param {boolean} [allVersions = true] in case there are more versions of this file you can choose to remove
     * all of them in one go or delete only the latest version (only if applicable such as with Backblaze B2 and S3
     * when you've enabled versioning)
     */
    removeFile(bucketName: string, fileName: string, allVersions?: boolean): Promise<ResultObject>;
    removeFile(fileName: string, allVersions?: boolean): Promise<ResultObject>;
    removeFile(arg1: string, arg2?: boolean | string, arg3?: boolean): Promise<ResultObject>;
    /**
     * @param bucketName name of the bucket
     * @param numFiles optional, only works for S3 compatible storages: the maximal number of files to retrieve
     * @returns an array of tuples containing the file path and the file size of all files in the bucket.
     */
    listFiles(numFiles?: number): Promise<ResultObjectFiles>;
    listFiles(bucketName: string, numFiles?: number): Promise<ResultObjectFiles>;
    listFiles(arg1?: number | string, arg2?: number): Promise<ResultObjectFiles>;
    /**
     * @param bucketName name of the bucket where the file is stored
     * @param fileName name of the file
     * @returns the size of the file in bytes
     */
    sizeOf(bucketName: string, fileName: string): Promise<ResultObjectNumber>;
    /**
     * @param bucketName name of the bucket
     * @returns boolean
     */
    bucketExists(bucketName?: string): Promise<ResultObjectBoolean>;
    /**
     * @param bucketName name of the bucket where the file is stored
     * @param fileName name of the file
     */
    fileExists(bucketName: string, fileName: string): Promise<ResultObjectBoolean>;
}