@ethersphere/bee-js 1.2.1 → 3.0.0

package/dist/src/bee.d.ts

@@ -1,10 +1,7 @@
-/// <reference types="node" />
-import type { Readable } from 'stream';
-import { AxiosRequestConfig } from 'axios';
 import { FeedType } from './feed/type';
 import { EthAddress } from './utils/eth';
-import { AllTagsOptions, NumberString, PostageBatchOptions } from './types';
-import type { Tag, FileData, Reference, UploadOptions, PublicKey, AddressPrefix, PssMessageHandler, PssSubscription, CollectionUploadOptions, FileUploadOptions, Data, Signer, FeedReader, FeedWriter, SOCWriter, SOCReader, Topic, BeeOptions, JsonFeedOptions, AnyJson, Pin, PostageBatch, BatchId } from './types';
+import { AllTagsOptions, Collection, Readable, RequestOptions, UploadResult } from './types';
+import type { Tag, FileData, Reference, UploadOptions, PublicKey, AddressPrefix, PssMessageHandler, PssSubscription, CollectionUploadOptions, FileUploadOptions, Data, Signer, FeedReader, FeedWriter, SOCWriter, SOCReader, Topic, BeeOptions, JsonFeedOptions, AnyJson, Pin, BatchId } from './types';
 /**
  * The main component that abstracts operations available on the main Bee API.
  *
@@ -20,6 +17,11 @@ export declare class Bee {
      * Default Signer object used for signing operations, mainly Feeds.
      */
     readonly signer?: Signer;
+    /**
+     * Ky instance that defines connection to Bee node
+     * @private
+     */
+    private readonly ky;
     /**
      * @param url URL on which is the main API of Bee node exposed
      * @param options
@@ -30,30 +32,31 @@ export declare class Bee {
      *
      * @param postageBatchId Postage BatchId to be used to upload the data with
      * @param data    Data to be uploaded
-     * @param options Additional options like tag, encryption, pinning, content-type
+     * @param options Additional options like tag, encryption, pinning, content-type and request options
      *
      * @returns reference is a content hash of the data
      * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/access-the-swarm/upload-and-download)
      * @see [Bee API reference - `POST /bytes`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes/post)
      */
-    uploadData(postageBatchId: string | BatchId, data: string | Uint8Array, options?: UploadOptions): Promise<Reference>;
+    uploadData(postageBatchId: string | BatchId, data: string | Uint8Array, options?: UploadOptions): Promise<UploadResult>;
     /**
      * Download data as a byte array
      *
      * @param reference Bee data reference
+     * @param options Options that affects the request behavior
      * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/access-the-swarm/upload-and-download)
      * @see [Bee API reference - `GET /bytes`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes~1{reference}/get)
      */
-    downloadData(reference: Reference | string): Promise<Data>;
+    downloadData(reference: Reference | string, options?: RequestOptions): Promise<Data>;
     /**
      * Download data as a Readable stream
      *
      * @param reference Bee data reference
-     * @param axiosOptions optional - alter default options of axios HTTP client
+     * @param options Options that affects the request behavior
      * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/access-the-swarm/upload-and-download)
      * @see [Bee API reference - `GET /bytes`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes~1{reference}/get)
      */
-    downloadReadableData(reference: Reference | string, axiosOptions?: AxiosRequestConfig): Promise<Readable>;
+    downloadReadableData(reference: Reference | string, options?: RequestOptions): Promise<ReadableStream<Uint8Array>>;
     /**
      * Upload single file to a Bee node.
      *
@@ -63,72 +66,92 @@ export declare class Bee {
      * @param postageBatchId Postage BatchId to be used to upload the data with
      * @param data    Data or file to be uploaded
      * @param name    Optional name of the uploaded file
-     * @param options Additional options like tag, encryption, pinning, content-type
+     * @param options Additional options like tag, encryption, pinning, content-type and request options
      *
      * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
      * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/access-the-swarm/upload-and-download)
      * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/File/paths/~1bzz/post)
      * @returns reference is a content hash of the file
      */
-    uploadFile(postageBatchId: string | BatchId, data: string | Uint8Array | Readable | File, name?: string, options?: FileUploadOptions): Promise<Reference>;
+    uploadFile(postageBatchId: string | BatchId, data: string | Uint8Array | Readable | File, name?: string, options?: FileUploadOptions): Promise<UploadResult>;
     /**
      * Download single file.
      *
      * @param reference Bee file reference
      * @param path If reference points to manifest, then this parameter defines path to the file
+     * @param options Options that affects the request behavior
      *
      * @see Data
      * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/access-the-swarm/upload-and-download)
      * @see [Bee API reference - `GET /bzz`](https://docs.ethswarm.org/api/#tag/Collection/paths/~1bzz~1{reference}~1{path}/get)
      */
-    downloadFile(reference: Reference | string, path?: string): Promise<FileData<Data>>;
+    downloadFile(reference: Reference | string, path?: string, options?: RequestOptions): Promise<FileData<Data>>;
     /**
      * Download single file as a readable stream
      *
      * @param reference Hash reference to file
      * @param path If reference points to manifest / collections, then this parameter defines path to the file
+     * @param options Options that affects the request behavior
      *
      * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/access-the-swarm/upload-and-download)
      * @see [Bee API reference - `GET /bzz`](https://docs.ethswarm.org/api/#tag/Collection/paths/~1bzz~1{reference}~1{path}/get)
      */
-    downloadReadableFile(reference: Reference | string, path?: string): Promise<FileData<Readable>>;
+    downloadReadableFile(reference: Reference | string, path?: string, options?: RequestOptions): Promise<FileData<ReadableStream<Uint8Array>>>;
     /**
      * Upload collection of files to a Bee node
      *
      * Uses the FileList API from the browser.
      *
+     * The returned `UploadResult.tag` might be undefined if called in CORS-enabled environment.
+     * This will be fixed upon next Bee release. https://github.com/ethersphere/bee-js/issues/406
+     *
      * @param postageBatchId Postage BatchId to be used to upload the data with
      * @param fileList list of files to be uploaded
-     * @param options Additional options like tag, encryption, pinning
+     * @param options Additional options like tag, encryption, pinning and request options
      *
      * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
      * @see [Bee docs - Upload directory](https://docs.ethswarm.org/docs/access-the-swarm/upload-a-directory/)
      * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/Collection/paths/~1bzz/post)
      */
-    uploadFiles(postageBatchId: string | BatchId, fileList: FileList | File[], options?: CollectionUploadOptions): Promise<Reference>;
+    uploadFiles(postageBatchId: string | BatchId, fileList: FileList | File[], options?: CollectionUploadOptions): Promise<UploadResult>;
+    /**
+     * Upload Collection that you can assembly yourself.
+     *
+     * The returned `UploadResult.tag` might be undefined if called in CORS-enabled environment.
+     * This will be fixed upon next Bee release. https://github.com/ethersphere/bee-js/issues/406
+     *
+     * @param postageBatchId
+     * @param collection
+     * @param options Collections and request options
+     */
+    uploadCollection(postageBatchId: string | BatchId, collection: Collection<Uint8Array | Readable>, options?: CollectionUploadOptions): Promise<UploadResult>;
     /**
      * Upload collection of files.
      *
      * Available only in Node.js as it uses the `fs` module.
      *
+     * The returned `UploadResult.tag` might be undefined if called in CORS-enabled environment.
+     * This will be fixed upon next Bee release. https://github.com/ethersphere/bee-js/issues/406
+     *
      * @param postageBatchId Postage BatchId to be used to upload the data with
      * @param dir the path of the files to be uploaded
-     * @param options Additional options like tag, encryption, pinning
+     * @param options Additional options like tag, encryption, pinning and request options
      *
      * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
      * @see [Bee docs - Upload directory](https://docs.ethswarm.org/docs/access-the-swarm/upload-a-directory/)
      * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/Collection/paths/~1bzz/post)
      */
-    uploadFilesFromDirectory(postageBatchId: string | BatchId, dir: string, options?: CollectionUploadOptions): Promise<Reference>;
+    uploadFilesFromDirectory(postageBatchId: string | BatchId, dir: string, options?: CollectionUploadOptions): Promise<UploadResult>;
     /**
      * Create a new Tag which is meant for tracking progres of syncing data across network.
      *
      * **Warning! Not allowed when node is in Gateway mode!**
      *
+     * @param options Options that affects the request behavior
      * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/access-the-swarm/syncing)
      * @see [Bee API reference - `POST /tags`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags/post)
      */
-    createTag(): Promise<Tag>;
+    createTag(options?: RequestOptions): Promise<Tag>;
     /**
      * Fetches all tags.
      *
@@ -136,7 +159,7 @@ export declare class Bee {
      *
      * **Warning! Not allowed when node is in Gateway mode!**
      *
-     * @param options
+     * @param options Options that affects the request behavior
      * @throws TypeError if limit or offset are not numbers or undefined
      * @throws BeeArgumentError if limit or offset have invalid options
      *
@@ -150,26 +173,28 @@ export declare class Bee {
      * **Warning! Not allowed when node is in Gateway mode!**
      *
      * @param tagUid UID or tag object to be retrieved
+     * @param options Options that affects the request behavior
      * @throws TypeError if tagUid is in not correct format
      *
      * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/access-the-swarm/syncing)
      * @see [Bee API reference - `GET /tags/{uid}`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags~1{uid}/get)
      *
      */
-    retrieveTag(tagUid: number | Tag): Promise<Tag>;
+    retrieveTag(tagUid: number | Tag, options?: RequestOptions): Promise<Tag>;
     /**
      * Delete Tag
      *
      * **Warning! Not allowed when node is in Gateway mode!**
      *
      * @param tagUid UID or tag object to be retrieved
+     * @param options Options that affects the request behavior
      * @throws TypeError if tagUid is in not correct format
      * @throws BeeResponse error if something went wrong on the Bee node side while deleting the tag.
      *
      * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/access-the-swarm/syncing)
      * @see [Bee API reference - `DELETE /tags/{uid}`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags~1{uid}/delete)
      */
-    deleteTag(tagUid: number | Tag): Promise<void>;
+    deleteTag(tagUid: number | Tag, options?: RequestOptions): Promise<void>;
     /**
      * Update tag's total chunks count.
      *
@@ -180,63 +205,79 @@ export declare class Bee {
      *
      * @param tagUid UID or tag object to be retrieved
      * @param reference The root reference that contains all the chunks to be counted
+     * @param options Options that affects the request behavior
      * @throws TypeError if tagUid is in not correct format
      * @throws BeeResponse error if something went wrong on the Bee node side while deleting the tag.
      *
      * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/access-the-swarm/syncing)
      * @see [Bee API reference - `PATCH /tags/{uid}`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags~1{uid}/patch)
      */
-    updateTag(tagUid: number | Tag, reference: Reference | string): Promise<void>;
+    updateTag(tagUid: number | Tag, reference: Reference | string, options?: RequestOptions): Promise<void>;
     /**
      * Pin local data with given reference
      *
      * **Warning! Not allowed when node is in Gateway mode!**
      *
      * @param reference Data reference
+     * @param options Options that affects the request behavior
      * @throws TypeError if reference is in not correct format
      *
      * @see [Bee docs - Pinning](https://docs.ethswarm.org/docs/access-the-swarm/pinning)
      */
-    pin(reference: Reference | string): Promise<void>;
+    pin(reference: Reference | string, options?: RequestOptions): Promise<void>;
     /**
      * Unpin local data with given reference
      *
      * **Warning! Not allowed when node is in Gateway mode!**
      *
      * @param reference Data reference
+     * @param options Options that affects the request behavior
      * @throws TypeError if reference is in not correct format
      *
      * @see [Bee docs - Pinning](https://docs.ethswarm.org/docs/access-the-swarm/pinning)
      */
-    unpin(reference: Reference | string): Promise<void>;
+    unpin(reference: Reference | string, options?: RequestOptions): Promise<void>;
     /**
      * Get list of all locally pinned references
      *
      * **Warning! Not allowed when node is in Gateway mode!**
      *
+     * @param options Options that affects the request behavior
      * @see [Bee docs - Pinning](https://docs.ethswarm.org/docs/access-the-swarm/pinning)
      */
-    getAllPins(): Promise<Reference[]>;
+    getAllPins(options?: RequestOptions): Promise<Reference[]>;
     /**
      * Get pinning status of chunk with given reference
      *
      * **Warning! Not allowed when node is in Gateway mode!**
      *
      * @param reference Bee data reference
+     * @param options Options that affects the request behavior
      * @throws TypeError if reference is in not correct format
      *
      * @see [Bee docs - Pinning](https://docs.ethswarm.org/docs/access-the-swarm/pinning)
      */
-    getPin(reference: Reference | string): Promise<Pin>;
+    getPin(reference: Reference | string, options?: RequestOptions): Promise<Pin>;
     /**
      * Instructs the Bee node to reupload a locally pinned data into the network.
      *
      * @param reference
-     * @param axiosOptions
+     * @param options Options that affects the request behavior
      * @throws BeeArgumentError if the reference is not locally pinned
      * @throws TypeError if reference is in not correct format
+     *
+     * @see [Bee API reference - `PUT /stewardship`](https://docs.ethswarm.org/api/#tag/Stewardship/paths/~1stewardship~1{reference}/put)
+     */
+    reuploadPinnedData(reference: Reference | string, options?: RequestOptions): Promise<void>;
+    /**
+     * Checks if content specified by reference is retrievable from the network.
+     *
+     * @param reference The checked content
+     * @param options Options that affects the request behavior
+     *
+     * @see [Bee API reference - `GET /stewardship`](https://docs.ethswarm.org/api/#tag/Stewardship/paths/~1stewardship~1{reference}/get)
      */
-    reuploadPinnedData(reference: Reference | string, axiosOptions?: AxiosRequestConfig): Promise<void>;
+    isReferenceRetrievable(reference: Reference | string, options?: RequestOptions): Promise<boolean>;
     /**
      * Send data to recipient or target with Postal Service for Swarm.
      *
@@ -252,15 +293,16 @@ export declare class Bee {
      *
      * @param postageBatchId Postage BatchId that will be assigned to sent message
      * @param topic Topic name
-     * @param target Target message address prefix
+     * @param target Target message address prefix. Has a limit on length. Recommend to use `Utils.Pss.makeMaxTarget()` to get the most specific target that Bee node will accept.
      * @param data Message to be sent
      * @param recipient Recipient public key
+     * @param options Options that affects the request behavior
      * @throws TypeError if `data`, `batchId`, `target` or `recipient` are in invalid format
      *
      * @see [Bee docs - PSS](https://docs.ethswarm.org/docs/dapps-on-swarm/pss)
      * @see [Bee API reference - `POST /pss`](https://docs.ethswarm.org/api/#tag/Postal-Service-for-Swarm/paths/~1pss~1send~1{topic}~1{targets}/post)
      */
-    pssSend(postageBatchId: string | BatchId, topic: string, target: AddressPrefix, data: string | Uint8Array, recipient?: string | PublicKey): Promise<void>;
+    pssSend(postageBatchId: string | BatchId, topic: string, target: AddressPrefix, data: string | Uint8Array, recipient?: string | PublicKey, options?: RequestOptions): Promise<void>;
     /**
      * Subscribe to messages for given topic with Postal Service for Swarm
      *
@@ -314,31 +356,34 @@ export declare class Bee {
      * @param type            The type of the feed, can be 'epoch' or 'sequence'
      * @param topic           Topic in hex or bytes
      * @param owner           Owner's ethereum address in hex or bytes
+     * @param options Options that affects the request behavior
      *
      * @see [Bee docs - Feeds](https://docs.ethswarm.org/docs/dapps-on-swarm/feeds)
      * @see [Bee API reference - `POST /feeds`](https://docs.ethswarm.org/api/#tag/Feed/paths/~1feeds~1{owner}~1{topic}/post)
      */
-    createFeedManifest(postageBatchId: string | BatchId, type: FeedType, topic: Topic | Uint8Array | string, owner: EthAddress | Uint8Array | string): Promise<Reference>;
+    createFeedManifest(postageBatchId: string | BatchId, type: FeedType, topic: Topic | Uint8Array | string, owner: EthAddress | Uint8Array | string, options?: RequestOptions): Promise<Reference>;
     /**
      * Make a new feed reader for downloading feed updates.
      *
      * @param type    The type of the feed, can be 'epoch' or 'sequence'
      * @param topic   Topic in hex or bytes
      * @param owner   Owner's ethereum address in hex or bytes
+     * @param options Options that affects the request behavior
      *
      * @see [Bee docs - Feeds](https://docs.ethswarm.org/docs/dapps-on-swarm/feeds)
      */
-    makeFeedReader(type: FeedType, topic: Topic | Uint8Array | string, owner: EthAddress | Uint8Array | string): FeedReader;
+    makeFeedReader(type: FeedType, topic: Topic | Uint8Array | string, owner: EthAddress | Uint8Array | string, options?: RequestOptions): FeedReader;
     /**
      * Make a new feed writer for updating feeds
      *
      * @param type    The type of the feed, can be 'epoch' or 'sequence'
      * @param topic   Topic in hex or bytes
      * @param signer  The signer's private key or a Signer instance that can sign data
+     * @param options Options that affects the request behavior
      *
      * @see [Bee docs - Feeds](https://docs.ethswarm.org/docs/dapps-on-swarm/feeds)
      */
-    makeFeedWriter(type: FeedType, topic: Topic | Uint8Array | string, signer?: Signer | Uint8Array | string): FeedWriter;
+    makeFeedWriter(type: FeedType, topic: Topic | Uint8Array | string, signer?: Signer | Uint8Array | string, options?: RequestOptions): FeedWriter;
     /**
      * High-level function that allows you to easily set JSON data to feed.
      * JSON-like data types are supported.
@@ -391,76 +436,37 @@ export declare class Bee {
      * Returns an object for reading single owner chunks
      *
      * @param ownerAddress The ethereum address of the owner
-     *
+     * @param options Options that affects the request behavior
      * @see [Bee docs - Chunk Types](https://docs.ethswarm.org/docs/dapps-on-swarm/chunk-types#single-owner-chunks)
      */
-    makeSOCReader(ownerAddress: EthAddress | Uint8Array | string): SOCReader;
+    makeSOCReader(ownerAddress: EthAddress | Uint8Array | string, options?: RequestOptions): SOCReader;
     /**
      * Returns an object for reading and writing single owner chunks
      *
      * @param signer The signer's private key or a Signer instance that can sign data
-     *
+     * @param options Options that affects the request behavior
      * @see [Bee docs - Chunk Types](https://docs.ethswarm.org/docs/dapps-on-swarm/chunk-types#single-owner-chunks)
      */
-    makeSOCWriter(signer?: Signer | Uint8Array | string): SOCWriter;
-    /**
-     * Creates new postage batch from the funds that the node has available in its Ethereum account.
-     *
-     * For better understanding what each parameter means and what are the optimal values please see
-     * [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive).
-     *
-     * **WARNING: THIS CREATES TRANSACTIONS THAT SPENDS MONEY**
-     * **Warning! Not allowed when node is in Gateway mode!**
-     *
-     * @param amount Amount that represents the value per chunk, has to be greater or equal zero.
-     * @param depth Logarithm of the number of chunks that can be stamped with the batch.
-     * @param options Options for creation of postage batch
-     * @throws BeeArgumentError when negative amount or depth is specified
-     * @throws TypeError if non-integer value is passed to amount or depth
-     *
-     * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
-     * @see [Bee API reference - `POST /stamps`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1{amount}~1{depth}/post)
-     * @deprecated Use DebugBee for postage batch management
-     */
-    createPostageBatch(amount: NumberString, depth: number, options?: PostageBatchOptions): Promise<BatchId>;
-    /**
-     * Return details for specific postage batch.
-     *
-     * **Warning! Not allowed when node is in Gateway mode!**
-     *
-     * @param postageBatchId Batch ID
-     *
-     * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
-     * @see [Bee API reference - `GET /stamps/${id}`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1{id}/get)
-     * @deprecated Use DebugBee for postage batch management
-     */
-    getPostageBatch(postageBatchId: BatchId | string): Promise<PostageBatch>;
-    /**
-     * Return all postage batches that has the node available.
-     *
-     * **Warning! Not allowed when node is in Gateway mode!**
-     *
-     * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
-     * @see [Bee API reference - `GET /stamps`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps/get)
-     * @deprecated Use DebugBee for postage batch management
-     */
-    getAllPostageBatch(): Promise<PostageBatch[]>;
+    makeSOCWriter(signer?: Signer | Uint8Array | string, options?: RequestOptions): SOCWriter;
     /**
      * Ping the Bee node to see if there is a live Bee node on the given URL.
      *
+     * @param options Options that affects the request behavior
      * @throws If connection was not successful throw error
      */
-    checkConnection(): Promise<void> | never;
+    checkConnection(options?: RequestOptions): Promise<void> | never;
     /**
      * Ping the Bee node to see if there is a live Bee node on the given URL.
      *
+     * @param options Options that affects the request behavior
      * @returns true if successful, false on error
      */
-    isConnected(): Promise<boolean>;
+    isConnected(options?: RequestOptions): Promise<boolean>;
     /**
      * @param signer
      * @private
      * @throws BeeError if either no Signer was passed or no default Signer was specified for the instance
      */
     private resolveSigner;
+    private getKy;
 }

package/dist/src/chunk/soc.d.ts

@@ -1,6 +1,6 @@
 import { Bytes } from '../utils/bytes';
 import { Chunk, ChunkAddress } from './cac';
-import { UploadOptions, Signature, Signer, BatchId, Reference } from '../types';
+import { UploadOptions, Signature, Signer, BatchId, Reference, Ky } from '../types';
 import { EthAddress } from '../utils/eth';
 export declare type Identifier = Bytes<32>;
 /**
@@ -39,23 +39,23 @@ export declare function makeSingleOwnerChunk(chunk: Chunk, identifier: Identifie
  *
  * It uses the Chunk API and calculates the address before uploading.
  *
- * @param url             The url of the Bee service
+ * @param ky              Ky instance
  * @param chunk           A chunk object
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param options         Upload options
  */
-export declare function uploadSingleOwnerChunk(url: string, chunk: SingleOwnerChunk, postageBatchId: BatchId, options?: UploadOptions): Promise<Reference>;
+export declare function uploadSingleOwnerChunk(ky: Ky, chunk: SingleOwnerChunk, postageBatchId: BatchId, options?: UploadOptions): Promise<Reference>;
 /**
  * Helper function to create and upload SOC.
  *
- * @param url             The url of the Bee service
+ * @param ky              Ky instance
  * @param signer          The singer interface for signing the chunk
  * @param postageBatchId
  * @param identifier      The identifier of the chunk
  * @param data            The chunk data
  * @param options
  */
-export declare function uploadSingleOwnerChunkData(url: string, signer: Signer, postageBatchId: BatchId | string, identifier: Identifier, data: Uint8Array, options?: UploadOptions): Promise<Reference>;
+export declare function uploadSingleOwnerChunkData(ky: Ky, signer: Signer, postageBatchId: BatchId | string, identifier: Identifier, data: Uint8Array, options?: UploadOptions): Promise<Reference>;
 /**
  * Helper function to download SOC.
  *
@@ -63,4 +63,4 @@ export declare function uploadSingleOwnerChunkData(url: string, signer: Signer,
  * @param ownerAddress  The singer interface for signing the chunk
  * @param identifier    The identifier of the chunk
  */
-export declare function downloadSingleOwnerChunk(url: string, ownerAddress: EthAddress, identifier: Identifier): Promise<SingleOwnerChunk>;
+export declare function downloadSingleOwnerChunk(ky: Ky, ownerAddress: EthAddress, identifier: Identifier): Promise<SingleOwnerChunk>;

package/dist/src/feed/index.d.ts

@@ -1,6 +1,6 @@
 import { Identifier } from '../chunk/soc';
 import { FeedUpdateOptions } from '../modules/feed';
-import { Reference, UploadOptions, Signer, FeedReader, FeedWriter, Topic, BatchId } from '../types';
+import { Reference, UploadOptions, Signer, FeedReader, FeedWriter, Topic, BatchId, Ky } from '../types';
 import { Bytes } from '../utils/bytes';
 import { HexString } from '../utils/hex';
 import { EthAddress, HexEthAddress } from '../utils/eth';
@@ -25,11 +25,11 @@ export declare function isEpoch(epoch: unknown): epoch is Epoch;
 export declare function makeSequentialFeedIdentifier(topic: Topic, index: number): Identifier;
 export declare function makeFeedIndexBytes(s: string): IndexBytes;
 export declare function makeFeedIdentifier(topic: Topic, index: Index): Identifier;
-export declare function uploadFeedUpdate(url: string, signer: Signer, topic: Topic, index: Index, reference: ChunkReference, postageBatchId: BatchId, options?: FeedUploadOptions): Promise<Reference>;
-export declare function findNextIndex(url: string, owner: HexEthAddress, topic: Topic, options?: FeedUpdateOptions): Promise<HexString<typeof INDEX_HEX_LENGTH>>;
-export declare function updateFeed(url: string, signer: Signer, topic: Topic, reference: ChunkReference, postageBatchId: BatchId, options?: FeedUploadOptions): Promise<Reference>;
+export declare function uploadFeedUpdate(ky: Ky, signer: Signer, topic: Topic, index: Index, reference: ChunkReference, postageBatchId: BatchId, options?: FeedUploadOptions): Promise<Reference>;
+export declare function findNextIndex(ky: Ky, owner: HexEthAddress, topic: Topic, options?: FeedUpdateOptions): Promise<HexString<typeof INDEX_HEX_LENGTH>>;
+export declare function updateFeed(ky: Ky, signer: Signer, topic: Topic, reference: ChunkReference, postageBatchId: BatchId, options?: FeedUploadOptions): Promise<Reference>;
 export declare function verifyChunkReference(data: Uint8Array): ChunkReference;
-export declare function downloadFeedUpdate(url: string, owner: EthAddress, topic: Topic, index: Index): Promise<FeedUpdate>;
-export declare function makeFeedReader(url: string, type: FeedType, topic: Topic, owner: HexEthAddress): FeedReader;
-export declare function makeFeedWriter(url: string, type: FeedType, topic: Topic, signer: Signer): FeedWriter;
+export declare function downloadFeedUpdate(ky: Ky, owner: EthAddress, topic: Topic, index: Index): Promise<FeedUpdate>;
+export declare function makeFeedReader(ky: Ky, type: FeedType, topic: Topic, owner: HexEthAddress): FeedReader;
+export declare function makeFeedWriter(ky: Ky, type: FeedType, topic: Topic, signer: Signer): FeedWriter;
 export {};

package/dist/src/feed/json.d.ts

@@ -1,4 +1,4 @@
-import { FeedWriter, FeedReader, AnyJson, BatchId, Reference } from '../types';
+import { FeedWriter, FeedReader, AnyJson, BatchId, Reference, RequestOptions } from '../types';
 import { Bee } from '../bee';
 export declare function getJsonData<T extends AnyJson>(bee: Bee, reader: FeedReader): Promise<T>;
-export declare function setJsonData(bee: Bee, writer: FeedWriter, postageBatchId: BatchId, data: AnyJson): Promise<Reference>;
+export declare function setJsonData(bee: Bee, writer: FeedWriter, postageBatchId: BatchId, data: AnyJson, options?: RequestOptions): Promise<Reference>;

package/dist/src/modules/bytes.d.ts

@@ -1,28 +1,25 @@
-/// <reference types="node" />
-import type { AxiosRequestConfig } from 'axios';
-import type { Readable } from 'stream';
-import { BatchId, Data, Reference, UploadOptions } from '../types';
+import type { BatchId, Data, Ky, Reference, UploadOptions } from '../types';
+import { UploadResult } from '../types';
 /**
  * Upload data to a Bee node
  *
- * @param url             Bee URL
+ * @param ky              Ky instance
  * @param data            Data to be uploaded
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param options         Additional options like tag, encryption, pinning
  */
-export declare function upload(url: string, data: string | Uint8Array, postageBatchId: BatchId, options?: UploadOptions): Promise<Reference>;
+export declare function upload(ky: Ky, data: string | Uint8Array, postageBatchId: BatchId, options?: UploadOptions): Promise<UploadResult>;
 /**
  * Download data as a byte array
  *
- * @param url  Bee URL
+ * @param ky
  * @param hash Bee content reference
  */
-export declare function download(url: string, hash: Reference): Promise<Data>;
+export declare function download(ky: Ky, hash: Reference): Promise<Data>;
 /**
  * Download data as a readable stream
  *
- * @param url  Bee URL
+ * @param ky
  * @param hash Bee content reference
- * @param axiosOptions optional - alter default options of axios HTTP client
  */
-export declare function downloadReadable(url: string, hash: Reference, axiosOptions?: AxiosRequestConfig): Promise<Readable>;
+export declare function downloadReadable(ky: Ky, hash: Reference): Promise<ReadableStream<Uint8Array>>;

package/dist/src/modules/bzz.d.ts

@@ -1,40 +1,35 @@
-/// <reference types="node" />
-import { BatchId, Collection, CollectionUploadOptions, Data, FileData, FileUploadOptions, Reference } from '../types';
-import { AxiosRequestConfig } from 'axios';
-import { Readable } from 'stream';
+import { BatchId, Collection, CollectionUploadOptions, Data, FileData, FileUploadOptions, Ky, Readable, UploadResult } from '../types';
 /**
  * Upload single file
  *
- * @param url Bee URL
+ * @param ky
  * @param data Files data
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param name Name that will be attached to the uploaded file. Wraps the data into manifest with set index document.
  * @param options
  */
-export declare function uploadFile(url: string, data: string | Uint8Array | Readable | ArrayBuffer, postageBatchId: BatchId, name?: string, options?: FileUploadOptions): Promise<Reference>;
+export declare function uploadFile(ky: Ky, data: string | Uint8Array | Readable | ArrayBuffer, postageBatchId: BatchId, name?: string, options?: FileUploadOptions): Promise<UploadResult>;
 /**
  * Download single file as a buffer
  *
- * @param url  Bee URL
+ * @param ky Ky instance for given Bee class instance
  * @param hash Bee file or collection hash
  * @param path If hash is collection then this defines path to a single file in the collection
- * @param axiosOptions optional - alter default options of axios HTTP client
  */
-export declare function downloadFile(url: string, hash: string, path?: string, axiosOptions?: AxiosRequestConfig): Promise<FileData<Data>>;
+export declare function downloadFile(ky: Ky, hash: string, path?: string): Promise<FileData<Data>>;
 /**
  * Download single file as a readable stream
  *
- * @param url  Bee URL
+ * @param ky Ky instance for given Bee class instance
  * @param hash Bee file or collection hash
  * @param path If hash is collection then this defines path to a single file in the collection
- * @param axiosOptions optional - alter default options of axios HTTP client
  */
-export declare function downloadFileReadable(url: string, hash: string, path?: string, axiosOptions?: AxiosRequestConfig): Promise<FileData<Readable>>;
+export declare function downloadFileReadable(ky: Ky, hash: string, path?: string): Promise<FileData<ReadableStream<Uint8Array>>>;
 /**
  * Upload collection
- * @param url Bee URL
+ * @param ky Ky instance for given Bee class instance
  * @param collection Collection of Uint8Array buffers to upload
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param options
  */
-export declare function uploadCollection(url: string, collection: Collection<Uint8Array>, postageBatchId: BatchId, options?: CollectionUploadOptions): Promise<Reference>;
+export declare function uploadCollection(ky: Ky, collection: Collection<Uint8Array>, postageBatchId: BatchId, options?: CollectionUploadOptions): Promise<UploadResult>;

package/dist/src/modules/chunk.d.ts

@@ -1,7 +1,4 @@
-/// <reference types="node" />
-import type { AxiosRequestConfig } from 'axios';
-import type { Readable } from 'stream';
-import type { BatchId, UploadOptions } from '../types';
+import type { BatchId, Ky, UploadOptions } from '../types';
 import { Reference } from '../types';
 /**
  * Upload chunk to a Bee node
@@ -10,25 +7,24 @@ import { Reference } from '../types';
  * The span stores the length of the payload in uint64 little endian encoding.
  * Upload expects the chuck data to be set accordingly.
  *
- * @param url     Bee URL
+ * @param ky Ky instance
  * @param data    Chunk data to be uploaded
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param options Additional options like tag, encryption, pinning
  */
-export declare function upload(url: string, data: Uint8Array, postageBatchId: BatchId, options?: UploadOptions): Promise<Reference>;
+export declare function upload(ky: Ky, data: Uint8Array, postageBatchId: BatchId, options?: UploadOptions): Promise<Reference>;
 /**
  * Download chunk data as a byte array
  *
- * @param url  Bee URL
+ * @param ky Ky instance for given Bee class instance
  * @param hash Bee content reference
  *
  */
-export declare function download(url: string, hash: string): Promise<Uint8Array>;
+export declare function download(ky: Ky, hash: string): Promise<Uint8Array>;
 /**
  * Download chunk data as a readable stream
  *
- * @param url  Bee URL
+ * @param ky Ky instance for given Bee class instance
  * @param hash Bee content reference
- * @param axiosOptions optional - alter default options of axios HTTP client
  */
-export declare function downloadReadable(url: string, hash: string, axiosOptions: AxiosRequestConfig): Promise<Readable>;
+export declare function downloadReadable(ky: Ky, hash: string): Promise<ReadableStream<Uint8Array>>;