import type { AwaitIterable, HTTPRPCOptions } from '../index.js';
import type { PinRemoteAPI } from './remote/index.js';
import type { HTTPRPCClient } from '../lib/core.js';
import type { CID } from 'multiformats/cid';
export interface PinAddOptions extends HTTPRPCOptions {
    /**
     * If true, pin all blocked linked to from the pinned CID
     */
    recursive?: boolean;
    /**
     * Whether to preload all blocks pinned during this operation
     */
    preload?: boolean;
    /**
     * Internal option used to control whether to create a repo write lock during a pinning operation
     */
    lock?: boolean;
    /**
     * An optional name for created pin(s)
     */
    name?: string;
}
export interface PinAddAllOptions extends HTTPRPCOptions {
    /**
     * Whether to preload all blocks pinned during this operation
     */
    preload?: boolean;
    /**
     * Internal option used to control whether to create a repo write lock during a pinning operation
     */
    lock?: boolean;
    /**
     * An optional name for created pin(s)
     */
    name?: string;
}
export type PinAddInput = CID | PinAddInputWithOptions;
export interface PinAddInputWithOptions {
    /**
     * A CID to pin - nb. you must pass either `cid` or `path`, not both
     */
    cid?: CID;
    /**
     * An IPFS path to pin - nb. you must pass either `cid` or `path`, not both
     */
    path?: string;
    /**
     * If true, pin all blocked linked to from the pinned CID
     */
    recursive?: boolean;
    /**
     * A human readable string to store with this pin
     */
    comments?: string;
    /**
     * An optional name for the created pin
     */
    name?: string;
}
export type PinType = 'recursive' | 'direct' | 'indirect' | 'all';
export type PinQueryType = 'recursive' | 'direct' | 'indirect' | 'all';
export interface PinLsOptions extends HTTPRPCOptions {
    /**
     * Path(s) to specific object(s) to be listed
     */
    paths?: CID | CID[] | string | string[];
    /**
     * The type of pinned keys to list. Can be "direct", "indirect", "recursive", or "all".
     *
     * @default "all"
     */
    type?: PinQueryType;
    /**
     * Limit returned pins to ones with names that contain the value provided (case-sensitive, partial match).
     * Implies names=true.
     */
    name?: string;
    /**
     * Include pin names in the output (slower, disabled by default).
     *
     * @default false
     */
    names?: boolean;
}
export interface PinLsResult {
    cid: CID;
    type: PinType | string;
    metadata?: Record<string, any>;
    name?: string;
}
export interface PinRmOptions extends HTTPRPCOptions {
    recursive?: boolean;
}
export interface PinRmAllInput {
    cid?: CID;
    path?: string;
    recursive?: boolean;
}
export interface PinUpdateOptions extends HTTPRPCOptions {
    /**
     * Remove the old pin
     *
     * @default true
     */
    unpin?: boolean;
}
export interface PinAPI {
    /**
     * Adds an IPFS block to the pinset and also stores it to the IPFS
     * repo. pinset is the set of hashes currently pinned (not gc'able)
     *
     * @example
     * ```js
     * const cid = CID.parse('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u')
     * const pinned of ipfs.pin.add(cid))
     * console.log(pinned)
     * // Logs:
     * // CID('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u')
     * ```
     */
    add(cid: string | CID, options?: PinAddOptions): Promise<CID>;
    /**
     * Adds multiple IPFS blocks to the pinset and also stores it to the IPFS
     * repo. pinset is the set of hashes currently pinned (not gc'able)
     *
     * @example
     * ```js
     * const cid = CID.parse('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u')
     * for await (const cid of ipfs.pin.addAll([cid])) {
     *   console.log(cid)
     * }
     * // Logs:
     * // CID('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u')
     * ```
     */
    addAll(source: AwaitIterable<PinAddInput>, options?: PinAddAllOptions): AsyncIterable<CID>;
    /**
     * List all the objects pinned to local storage
     *
     * @example
     * ```js
     * for await (const { cid, type } of ipfs.pin.ls()) {
     *   console.log({ cid, type })
     * }
     * // { cid: CID(Qmc5XkteJdb337s7VwFBAGtiaoj2QCEzyxtNRy3iMudc3E), type: 'recursive' }
     * // { cid: CID(QmZbj5ruYneZb8FuR9wnLqJCpCXMQudhSdWhdhp5U1oPWJ), type: 'indirect' }
     * // { cid: CID(QmSo73bmN47gBxMNqbdV6rZ4KJiqaArqJ1nu5TvFhqqj1R), type: 'indirect' }
     *
     * const paths = [
     *   CID.parse('Qmc5..'),
     *   CID.parse('QmZb..'),
     *   CID.parse('QmSo..')
     * ]
     * for await (const { cid, type } of ipfs.pin.ls({ paths })) {
     *   console.log({ cid, type })
     * }
     * // { cid: CID(Qmc5XkteJdb337s7VwFBAGtiaoj2QCEzyxtNRy3iMudc3E), type: 'recursive' }
     * // { cid: CID(QmZbj5ruYneZb8FuR9wnLqJCpCXMQudhSdWhdhp5U1oPWJ), type: 'indirect' }
     * // { cid: CID(QmSo73bmN47gBxMNqbdV6rZ4KJiqaArqJ1nu5TvFhqqj1R), type: 'indirect' }
     * ```
     */
    ls(options?: PinLsOptions): AsyncIterable<PinLsResult>;
    /**
     * Unpin this block from your repo
     *
     * @example
     * ```js
     * const cid = CID.parse('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u')
     * const result = await ipfs.pin.rm(cid)
     * console.log(result)
     * // prints the CID that was unpinned
     * // CID('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u')
     * ```
     */
    rm(ipfsPath: string | CID, options?: PinRmOptions): Promise<CID>;
    /**
     * Unpin one or more blocks from your repo
     *
     * @example
     * ```js
     * const source = [
     *   CID.parse('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u')
     * ]
     * for await (const cid of ipfs.pin.rmAll(source)) {
     *   console.log(cid)
     * }
     * // prints the CIDs that were unpinned
     * // CID('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u')
     * ```
     */
    rmAll(source: AwaitIterable<PinRmAllInput>, options?: HTTPRPCOptions): AsyncIterable<CID>;
    /**
     * Update a recursive pin
     *
     * @example
     * ```js
     * const oldCid = CID.parse('bafyreigdnpedjym3lvesqlllbry7zxjcp6fdvsusrh2mesqsdhd4idmzoq')
     * const newCid = CID.parse('bafyreibt45jsjrdasabryzkzn7muhvigwyn2mmuw4hk26zr23fzyitmmy4')
     * const result = await ipfs.pin.update(oldCid, newCid)
     * console.log(result)
     * // [CID('bafyreigdnpedjym3lvesqlllbry7zxjcp6fdvsusrh2mesqsdhd4idmzoq'), CID('bafyreibt45jsjrdasabryzkzn7muhvigwyn2mmuw4hk26zr23fzyitmmy4')]
     * ```
     */
    update(from: string | CID, to: string | CID, options?: PinUpdateOptions): Promise<CID[]>;
    remote: PinRemoteAPI;
}
export declare function createPin(client: HTTPRPCClient): PinAPI;
//# sourceMappingURL=index.d.ts.map