@rocket.chat/apps-engine/server/storage/AppSourceStorage.d.ts

The engine code for the Rocket.Chat Apps which manages, runs, translates, coordinates and all of that.

import type { IAppStorageItem } from './IAppStorageItem';
export declare abstract class AppSourceStorage {
    /**
     * Stores an app package (zip file) in the underlying
     * storage provided by the host
     *
     * @param item descriptor of the App
     * @param zip the app package file contents
     *
     * @returns the path in which the pacakge has been stored
     */
    abstract store(item: IAppStorageItem, zip: Buffer): Promise<string>;
    /**
     * Fetches an app's package file contents
     *
     * @param item descriptor of the App
     *
     * @returns buffer containing the file contents of the app's package
     */
    abstract fetch(item: IAppStorageItem): Promise<Buffer>;
    /**
     * Updates an app package (zip file) in the underlying
     * storage provided by the host
     *
     * @param item descriptor of the App
     * @param zip the app package file contents
     *
     * @returns the path in which the pacakge has been stored
     */
    abstract update(item: IAppStorageItem, zip: Buffer): Promise<string>;
    /**
     *
     * @param item descriptor of the App
     */
    abstract remove(item: IAppStorageItem): Promise<void>;
}