@web3-storage/w3up-client/dist/src/capability/store.js

Client for the web3.storage w3up api

import { Store } from '@web3-storage/upload-client';
import { Store as StoreCapabilities } from '@web3-storage/capabilities';
import { Base } from '../base.js';
/**
 * Client for interacting with the `store/*` capabilities.
 */
export class StoreClient extends Base {
    /**
     * Store a DAG encoded as a CAR file.
     *
     * Required delegated capabilities:
     * - `store/add`
     *
     * @deprecated Use `client.capability.blob.add()` instead.
     * @param {Blob} car - CAR file data.
     * @param {import('../types.js').RequestOptions} [options]
     */
    async add(car, options = {}) {
        const conf = await this._invocationConfig([StoreCapabilities.add.can]);
        options.connection = this._serviceConf.upload;
        return Store.add(conf, car, options);
    }
    /**
     * Get details of a stored item.
     *
     * Required delegated capabilities:
     * - `store/get`
     *
     * @deprecated Use `client.capability.blob.get()` instead.
     * @param {import('../types.js').CARLink} link - Root data CID for the DAG that was stored.
     * @param {import('../types.js').RequestOptions} [options]
     */
    async get(link, options = {}) {
        const conf = await this._invocationConfig([StoreCapabilities.get.can]);
        options.connection = this._serviceConf.upload;
        return Store.get(conf, link, options);
    }
    /**
     * List CAR files stored to the resource.
     *
     * Required delegated capabilities:
     * - `store/list`
     *
     * @deprecated Use `client.capability.blob.list()` instead.
     * @param {import('../types.js').ListRequestOptions} [options]
     */
    async list(options = {}) {
        const conf = await this._invocationConfig([StoreCapabilities.list.can]);
        options.connection = this._serviceConf.upload;
        return Store.list(conf, options);
    }
    /**
     * Remove a stored CAR file by CAR CID.
     *
     * Required delegated capabilities:
     * - `store/remove`
     *
     * @deprecated Use `client.capability.blob.remove()` instead.
     * @param {import('../types.js').CARLink} link - CID of CAR file to remove.
     * @param {import('../types.js').RequestOptions} [options]
     */
    async remove(link, options = {}) {
        const conf = await this._invocationConfig([StoreCapabilities.remove.can]);
        options.connection = this._serviceConf.upload;
        return Store.remove(conf, link, options);
    }
}
//# sourceMappingURL=store.js.map