@apillon/sdk/dist/types/storage.d.ts

▶◀ Apillon SDK for NodeJS ▶◀

/// <reference types="node" />
/// <reference types="node" />
import { IApillonPagination } from './apillon';
export declare enum StorageContentType {
    DIRECTORY = 1,
    FILE = 2
}
export declare enum FileStatus {
    UPLOAD_REQUEST_GENERATED = 1,
    UPLOADED = 2,
    AVAILABLE_ON_IPFS = 3,
    AVAILABLE_ON_IPFS_AND_REPLICATED = 4
}
export declare enum BucketType {
    STORAGE = 1,
    HOSTING = 2,
    NFT_METADATA = 3
}
export interface IStorageBucketContentRequest extends IApillonPagination {
    directoryUuid?: string;
    markedForDeletion?: boolean;
}
export interface IBucketFilesRequest extends IApillonPagination {
    fileStatus?: FileStatus;
    /**
     * Search files by upload session UUID
     */
    sessionUuid?: string;
}
export interface FileMetadata {
    fileName: string;
    content: Buffer;
    /**
     * File [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types)
     */
    contentType?: string;
    /**
     * Virtual file path. Empty for root. Must not contain fileName.
     *
     * The path field can be used to place file in virtual directories inside a bucket. If directories do not yet exist, they will be automatically generated.
     *
     * For example, an images/icons path creates images directory in a bucket and icons directory inside it. File will then be created in the icons directory.
     */
    path?: string;
    /**
     * The file's UUID, obtained after uploadig
     */
    fileUuid?: string;
    /**
     * The file's CID on IPFS
     */
    CID?: string;
}
export type FileUploadResult = Omit<FileMetadata, 'content'> & {
    url?: string;
};
export interface IFileUploadRequest {
    /**
     * Wrap uploaded files to IPFS directory.
     *
     * Files in session can be wrapped to CID on IPFS via wrapWithDirectory parameter. This means that the directory gets its own CID and its content cannot be modified afterwards.
     *
     * @docs [IPFS docs](https://dweb-primer.ipfs.io/files-on-ipfs/wrap-directories-around-content#explanation)
     */
    wrapWithDirectory?: boolean;
    /**
     * Path to wrapped directory inside bucket.
     *
     * Mandatory when `wrapWithDirectory` is true.
     *
     * @example `main-dir` --> Files get uploaded to a folder named `main-dir` in the bucket.
     *
     * @example `main-dir/sub-dir` --> Files get uploaded to a subfolder in the location `/main-dir/sub-dir`.
     */
    directoryPath?: string;
    /**
     * If set to true, the upload action will wait until files receive a CID from IPFS before returning a result
     * @default false
     * @deprecated New implementation precalculates CIDs for all files before uploading them to IPFS
     */
    awaitCid?: boolean;
    /**
     * If set to true, will ignore all the files inside the .gitignore file, including .git and .gitignore itself
     * @default true
     */
    ignoreFiles?: boolean;
}
export interface IFileUploadResponse {
    files: FileMetadata[];
    sessionUuid: string;
}
export interface IPNSListRequest extends IApillonPagination {
    /**
     * IPNS name, that is used to access ipns content on ipfs gateway
     */
    ipnsName?: string;
    /**
     * IPFS value (CID), to which this ipns points
     */
    ipnsValue?: string;
}
export interface ICreateIpns {
    name: string;
    description?: string;
    /**
     * CID to which this IPNS name will point.
     * If this property is specified, API executes ipns publish which sets ipnsName and ipnsValue properties
     */
    cid?: string;
}
export interface StorageInfo {
    /**
     * Available storage space in bytes
     */
    availableStorage: number;
    /**
     * Used storage in bytes. When `usedStorage` reaches available storage, upload to buckets will be blocked (error 40006003)
     */
    usedStorage: number;
    /**
     * Monthly available bandwidth (upload and download)
     */
    availableBandwidth: number;
    /**
     * Bandwidth used in current month. If `usedBandwidth` reaches available bandwidth, requests to the IPFS gateway will be blocked
     */
    usedBandwidth: number;
}
export interface IpfsClusterInfo {
    /**
     * Secret for this project, which can be used to generate tokens to access content of IPFS gateway
     * @docs [Generate an IPFS link](https://wiki.apillon.io/build/2-storage-api.html#get-or-generate-link-for-ipfs)
     */
    secret: string;
    /**
     * Project unique identifier
     */
    projectUuid: string;
    /**
     * Gateway that can used to access content via CIDs.
     */
    ipfsGateway: string;
    /**
     * Gateway that can be used to access content via IPNS name.
     */
    ipnsGateway: string;
}
//# sourceMappingURL=storage.d.ts.map