@upcoming/bee-js 0.3.0 → 0.5.0

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

@@ -1,4 +1,4 @@
-import type { BeeRequestOptions, DownloadRedundancyOptions, ReferenceInformation, UploadOptions, UploadRedundancyOptions } from '../types';
+import type { BeeRequestOptions, DownloadOptions, RedundantUploadOptions, ReferenceInformation } from '../types';
 import { UploadResult } from '../types';
 import { Bytes } from '../utils/bytes';
 import { BatchId, Reference } from '../utils/typed-bytes';
@@ -10,7 +10,7 @@ import { BatchId, Reference } from '../utils/typed-bytes';
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param options         Additional options like tag, encryption, pinning
  */
-export declare function upload(requestOptions: BeeRequestOptions, data: string | Uint8Array, postageBatchId: BatchId, options?: UploadOptions & UploadRedundancyOptions): Promise<UploadResult>;
+export declare function upload(requestOptions: BeeRequestOptions, data: string | Uint8Array, postageBatchId: BatchId, options?: RedundantUploadOptions): Promise<UploadResult>;
 /**
  * Requests content length for a reference
  *
@@ -24,11 +24,11 @@ export declare function head(requestOptions: BeeRequestOptions, reference: Refer
  * @param requestOptions Options for making requests
  * @param hash Bee content reference
  */
-export declare function download(requestOptions: BeeRequestOptions, reference: Reference | Uint8Array | string, options?: DownloadRedundancyOptions): Promise<Bytes>;
+export declare function download(requestOptions: BeeRequestOptions, reference: Reference | Uint8Array | string, options?: DownloadOptions): Promise<Bytes>;
 /**
  * Download data as a readable stream
  *
  * @param requestOptions Options for making requests
  * @param hash Bee content reference
  */
-export declare function downloadReadable(requestOptions: BeeRequestOptions, reference: Reference | Uint8Array | string, options?: DownloadRedundancyOptions): Promise<ReadableStream<Uint8Array>>;
+export declare function downloadReadable(requestOptions: BeeRequestOptions, reference: Reference | Uint8Array | string, options?: DownloadOptions): Promise<ReadableStream<Uint8Array>>;

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

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { Readable } from 'stream';
-import { BeeRequestOptions, Collection, CollectionUploadOptions, DownloadRedundancyOptions, FileData, FileUploadOptions, UploadHeaders, UploadRedundancyOptions, UploadResult } from '../types';
+import { BeeRequestOptions, Collection, CollectionUploadOptions, DownloadOptions, FileData, FileUploadOptions, UploadResult } from '../types';
 import { Bytes } from '../utils/bytes';
 import { BatchId, Reference } from '../utils/typed-bytes';
 /**
@@ -12,7 +12,7 @@ import { BatchId, Reference } from '../utils/typed-bytes';
  * @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(requestOptions: BeeRequestOptions, data: string | Uint8Array | Readable | ArrayBuffer, postageBatchId: BatchId, name?: string, options?: FileUploadOptions & UploadRedundancyOptions): Promise<UploadResult>;
+export declare function uploadFile(requestOptions: BeeRequestOptions, data: string | Uint8Array | Readable | ArrayBuffer, postageBatchId: BatchId, name?: string, options?: FileUploadOptions): Promise<UploadResult>;
 /**
  * Download single file as a buffer
  *
@@ -20,7 +20,7 @@ export declare function uploadFile(requestOptions: BeeRequestOptions, data: stri
  * @param hash Bee file or collection hash
  * @param path If hash is collection then this defines path to a single file in the collection
  */
-export declare function downloadFile(requestOptions: BeeRequestOptions, reference: Reference | string | Uint8Array, path?: string, options?: DownloadRedundancyOptions): Promise<FileData<Bytes>>;
+export declare function downloadFile(requestOptions: BeeRequestOptions, reference: Reference | string | Uint8Array, path?: string, options?: DownloadOptions): Promise<FileData<Bytes>>;
 /**
  * Download single file as a readable stream
  *
@@ -28,13 +28,8 @@ export declare function downloadFile(requestOptions: BeeRequestOptions, referenc
  * @param hash Bee file or collection hash
  * @param path If hash is collection then this defines path to a single file in the collection
  */
-export declare function downloadFileReadable(requestOptions: BeeRequestOptions, reference: Reference, path?: string, options?: DownloadRedundancyOptions): Promise<FileData<ReadableStream<Uint8Array>>>;
+export declare function downloadFileReadable(requestOptions: BeeRequestOptions, reference: Reference, path?: string, options?: DownloadOptions): Promise<FileData<ReadableStream<Uint8Array>>>;
 /*******************************************************************************************************************/
-export interface CollectionUploadHeaders extends UploadHeaders {
-    'swarm-index-document'?: string;
-    'swarm-error-document'?: string;
-}
-export declare function extractCollectionUploadHeaders(postageBatchId: BatchId, options?: CollectionUploadOptions & UploadRedundancyOptions): CollectionUploadHeaders & UploadRedundancyOptions;
 /**
  * Upload collection
  * @param requestOptions Options for making requests
@@ -42,4 +37,4 @@ export declare function extractCollectionUploadHeaders(postageBatchId: BatchId,
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param options
  */
-export declare function uploadCollection(requestOptions: BeeRequestOptions, collection: Collection, postageBatchId: BatchId, options?: CollectionUploadOptions & UploadRedundancyOptions): Promise<UploadResult>;
+export declare function uploadCollection(requestOptions: BeeRequestOptions, collection: Collection, postageBatchId: BatchId, options?: CollectionUploadOptions): Promise<UploadResult>;

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

@@ -1,4 +1,4 @@
-import type { BeeRequestOptions, EnvelopeWithBatchId, UploadOptions, UploadResult } from '../types';
+import type { BeeRequestOptions, DownloadOptions, EnvelopeWithBatchId, UploadOptions, UploadResult } from '../types';
 import { BatchId, Reference } from '../utils/typed-bytes';
 /**
  * Upload chunk to a Bee node
@@ -20,4 +20,4 @@ export declare function upload(requestOptions: BeeRequestOptions, data: Uint8Arr
  * @param hash Bee content reference
  *
  */
-export declare function download(requestOptions: BeeRequestOptions, reference: Reference | string | Uint8Array): Promise<Uint8Array>;
+export declare function download(requestOptions: BeeRequestOptions, reference: Reference | string | Uint8Array, options?: DownloadOptions): Promise<Uint8Array>;

package/dist/types/modules/debug/chequebook.d.ts

@@ -1,4 +1,4 @@
-import type { BeeRequestOptions, CashoutOptions, ChequebookAddressResponse, ChequebookBalanceResponse, LastCashoutActionResponse, LastChequesForPeerResponse, LastChequesResponse, NumberString } from '../../types';
+import type { BeeRequestOptions, ChequebookAddressResponse, ChequebookBalanceResponse, LastCashoutActionResponse, LastChequesForPeerResponse, LastChequesResponse, NumberString, TransactionOptions } from '../../types';
 import { PeerAddress, TransactionId } from '../../utils/typed-bytes';
 /**
  * Get the address of the chequebook contract used
@@ -26,7 +26,7 @@ export declare function getLastCashoutAction(requestOptions: BeeRequestOptions,
  * @param peer  Swarm address of peer
  * @param options
  */
-export declare function cashoutLastCheque(requestOptions: BeeRequestOptions, peer: PeerAddress, options?: CashoutOptions): Promise<TransactionId>;
+export declare function cashoutLastCheque(requestOptions: BeeRequestOptions, peer: PeerAddress, options?: TransactionOptions): Promise<TransactionId>;
 /**
  * Get last cheques for the peer
  *

package/dist/types/modules/debug/connectivity.d.ts

@@ -1,4 +1,4 @@
-import type { BeeRequestOptions, NodeAddresses, Peer, PingResponse, RemovePeerResponse, Topology } from '../../types';
+import type { BeeRequestOptions, Bin, NodeAddresses, Peer, PingResponse, RemovePeerResponse, Topology } from '../../types';
 import { PeerAddress } from '../../utils/typed-bytes';
 export declare function getNodeAddresses(requestOptions: BeeRequestOptions): Promise<NodeAddresses>;
 export declare function getPeers(requestOptions: BeeRequestOptions): Promise<Peer[]>;
@@ -6,3 +6,4 @@ export declare function getBlocklist(requestOptions: BeeRequestOptions): Promise
 export declare function removePeer(requestOptions: BeeRequestOptions, peer: PeerAddress): Promise<RemovePeerResponse>;
 export declare function getTopology(requestOptions: BeeRequestOptions): Promise<Topology>;
 export declare function pingPeer(requestOptions: BeeRequestOptions, peer: PeerAddress): Promise<PingResponse>;
+export declare function asBin(value: unknown, name: string): Bin;

package/dist/types/modules/grantee.d.ts

@@ -1,8 +1,8 @@
 import { BeeRequestOptions, GetGranteesResult, GranteesResult } from '../types';
-import { BatchId, Reference } from '../utils/typed-bytes';
+import { BatchId, PublicKey, Reference } from '../utils/typed-bytes';
 export declare function getGrantees(reference: Reference, requestOptions: BeeRequestOptions): Promise<GetGranteesResult>;
-export declare function createGrantees(requestOptions: BeeRequestOptions, postageBatchId: BatchId, grantees: string[]): Promise<GranteesResult>;
+export declare function createGrantees(requestOptions: BeeRequestOptions, postageBatchId: BatchId, grantees: PublicKey[]): Promise<GranteesResult>;
 export declare function patchGrantees(postageBatchId: BatchId, reference: Reference, historyRef: Reference, grantees: {
-    add?: string[];
-    revoke?: string[];
+    add?: PublicKey[];
+    revoke?: PublicKey[];
 }, requestOptions: BeeRequestOptions): Promise<GranteesResult>;

package/dist/types/types/debug.d.ts

@@ -39,7 +39,6 @@ export interface TransactionOptions {
      */
     gasLimit?: NumberString;
 }
-export type CashoutOptions = TransactionOptions;
 export interface CashoutResult {
     recipient: string;
     lastPayout: BZZ;

package/dist/types/types/index.d.ts

@@ -1,9 +1,10 @@
+import { Optional } from 'cafe-utility';
 import type { SingleOwnerChunk } from '../chunk/soc';
 import type { FeedUploadOptions } from '../feed';
 import type { FeedUpdateOptions, FetchFeedUpdateResponse } from '../modules/feed';
 import { Bytes } from '../utils/bytes';
 import type { BeeError } from '../utils/error';
-import { BatchId, EthAddress, Identifier, PrivateKey, Reference, Topic, TransactionId } from '../utils/typed-bytes';
+import { BatchId, EthAddress, Identifier, PrivateKey, PublicKey, Reference, Topic, TransactionId } from '../utils/typed-bytes';
 export * from './debug';
 export declare const SECTION_SIZE = 32;
 export declare const BRANCHES = 128;
@@ -22,7 +23,7 @@ export declare const TAGS_LIMIT_MAX = 1000;
 export declare const FEED_INDEX_HEX_LENGTH = 16;
 export type BeeRequestOptions = {
     baseURL?: string;
-    timeout?: number | false;
+    timeout?: number;
     headers?: Record<string, string>;
     onRequest?: (request: BeeRequest) => void;
     httpAgent?: unknown;
@@ -44,7 +45,7 @@ export interface GranteesResult {
 export interface GetGranteesResult {
     status: number;
     statusText: string;
-    data: string[];
+    grantees: PublicKey[];
 }
 /**
  * Result of upload calls.
@@ -61,7 +62,7 @@ export interface UploadResult {
     /**
      * History address of the uploaded data with ACT.
      */
-    historyAddress: string;
+    historyAddress: Optional<Reference>;
 }
 export interface UploadOptions {
     /**
@@ -116,7 +117,7 @@ export declare enum RedundancyLevel {
     INSANE = 3,
     PARANOID = 4
 }
-export interface UploadRedundancyOptions {
+export interface RedundantUploadOptions extends UploadOptions {
     redundancyLevel?: RedundancyLevel;
 }
 /**
@@ -135,7 +136,7 @@ export declare enum RedundancyStrategy {
     PROX = 2,
     RACE = 3
 }
-export interface DownloadRedundancyOptions {
+export interface DownloadOptions {
     /**
      * Specify the retrieve strategy on redundant data.
      */
@@ -148,6 +149,9 @@ export interface DownloadRedundancyOptions {
      * Specify the timeout for chunk retrieval. The default is 30 seconds.
      */
     timeoutMs?: number;
+    actPublisher?: PublicKey | Uint8Array | string;
+    actHistoryAddress?: Reference | Uint8Array | string;
+    actTimestamp?: string | number;
 }
 export interface FileUploadOptions extends UploadOptions {
     /**
@@ -162,6 +166,7 @@ export interface FileUploadOptions extends UploadOptions {
      * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post)
      */
     contentType?: string;
+    redundancyLevel?: RedundancyLevel;
 }
 export interface CollectionUploadOptions extends UploadOptions {
     /**
@@ -178,6 +183,7 @@ export interface CollectionUploadOptions extends UploadOptions {
      * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post)
      */
     errorDocument?: string;
+    redundancyLevel?: RedundancyLevel;
 }
 export interface UploadHeaders {
     'swarm-act'?: string;

package/dist/types/utils/collection.d.ts

@@ -2,7 +2,7 @@ import { Collection } from '../types';
 export declare function isCollection(data: unknown): data is Collection;
 export declare function assertCollection(data: unknown): asserts data is Collection;
 export declare function makeFilePath(file: File): string;
-export declare function makeCollectionFromFileList(fileList: FileList | File[]): Promise<Collection>;
+export declare function makeCollectionFromFileList(fileList: FileList | File[]): Collection;
 /**
  * Calculate cumulative size of files
  *

package/dist/types/utils/collection.node.d.ts

@@ -1,7 +1,6 @@
 import { Collection } from '../types';
 /**
  * Creates array in the format of Collection with data loaded from directory on filesystem.
- * The function loads all the data into memory!
  *
  * @param dir path to the directory
  */

package/dist/types/utils/expose.d.ts

@@ -1,4 +1,4 @@
-export { getCollectionSize } from './collection';
+export { getCollectionSize, makeCollectionFromFileList } from './collection';
 export { getFolderSize } from './collection.node';
 export { makeMaxTarget } from './pss';
 export { approximateOverheadForRedundancyLevel, getRedundancyStat, getRedundancyStats } from './redundancy';

package/dist/types/utils/headers.d.ts

@@ -1,6 +1,4 @@
-import { DownloadRedundancyOptions, EnvelopeWithBatchId, FileHeaders, UploadOptions, UploadRedundancyOptions } from '../types';
+import { EnvelopeWithBatchId, FileHeaders } from '../types';
 import { BatchId } from './typed-bytes';
 export declare function readFileHeaders(headers: Record<string, string>): FileHeaders;
-export declare function extractUploadHeaders(stamp: EnvelopeWithBatchId | BatchId | Uint8Array | string, options?: UploadOptions): Record<string, string>;
-export declare function extractRedundantUploadHeaders(postageBatchId: BatchId, options?: UploadOptions & UploadRedundancyOptions): Record<string, string>;
-export declare function extractDownloadHeaders(options?: DownloadRedundancyOptions): Record<string, string>;
+export declare function prepareRequestHeaders(stamp: BatchId | Uint8Array | string | EnvelopeWithBatchId | null, nullableOptions?: unknown): Record<string, string>;

package/dist/types/utils/tar-uploader.browser.d.ts

@@ -1,3 +1,3 @@
-import { BeeRequestOptions, Collection, CollectionUploadOptions, UploadRedundancyOptions } from '..';
+import { BeeRequestOptions, Collection, CollectionUploadOptions } from '..';
 import { BatchId } from './typed-bytes';
-export declare function uploadTar(requestOptions: BeeRequestOptions, collection: Collection, postageBatchId: BatchId, options?: CollectionUploadOptions & UploadRedundancyOptions): Promise<import("axios").AxiosResponse<unknown, any>>;
+export declare function uploadTar(requestOptions: BeeRequestOptions, collection: Collection, postageBatchId: BatchId, options?: CollectionUploadOptions): Promise<import("axios").AxiosResponse<unknown, any>>;

package/dist/types/utils/tar-uploader.d.ts

@@ -1,3 +1,3 @@
-import { BeeRequestOptions, Collection, CollectionUploadOptions, UploadRedundancyOptions } from '..';
+import { BeeRequestOptions, Collection, CollectionUploadOptions } from '..';
 import { BatchId } from './typed-bytes';
-export declare function uploadTar(requestOptions: BeeRequestOptions, collection: Collection, postageBatchId: BatchId, options?: CollectionUploadOptions & UploadRedundancyOptions): Promise<import("axios").AxiosResponse<unknown, any>>;
+export declare function uploadTar(requestOptions: BeeRequestOptions, collection: Collection, postageBatchId: BatchId, options?: CollectionUploadOptions): Promise<import("axios").AxiosResponse<unknown, any>>;

package/dist/types/utils/type.d.ts

@@ -1,29 +1,23 @@
 /// <reference types="node" />
 import * as stream from 'stream';
-import { AllTagsOptions, BeeRequestOptions, CashoutOptions, CollectionUploadOptions, FileUploadOptions, GsocMessageHandler, NumberString, PostageBatchOptions, PssMessageHandler, Tag, TransactionOptions, UploadOptions } from '../types';
+import { AllTagsOptions, BeeRequestOptions, CollectionUploadOptions, DownloadOptions, FileUploadOptions, GsocMessageHandler, NumberString, PostageBatchOptions, PssMessageHandler, RedundantUploadOptions, Tag, TransactionOptions, UploadOptions } from '../types';
 export declare function isReadable(obj: unknown): obj is stream.Readable;
 export declare function asNumberString(value: unknown, options?: {
     name?: string;
     min?: bigint;
     max?: bigint;
 }): NumberString;
-export declare function isInteger(value: unknown): value is number | NumberString;
-export declare function isObject(value: unknown): value is Record<string, unknown>;
-export declare function isStrictlyObject(value: unknown): value is Record<string, unknown>;
-export declare function assertStrictlyObject(value: unknown, name?: string): asserts value is object;
-export declare function assertBoolean(value: unknown, name?: string): asserts value is boolean;
-export declare function assertInteger(value: unknown, name?: string): asserts value is number | NumberString;
-export declare function assertNonNegativeInteger(value: unknown, name?: string): asserts value is number | NumberString;
-export declare function assertRequestOptions(value: unknown, name?: string): asserts value is BeeRequestOptions;
-export declare function assertUploadOptions(value: unknown, name?: string): asserts value is UploadOptions;
-export declare function assertFileUploadOptions(value: unknown): asserts value is FileUploadOptions;
-export declare function assertCollectionUploadOptions(value: unknown): asserts value is CollectionUploadOptions;
+export declare function prepareBeeRequestOptions(value: unknown): BeeRequestOptions;
+export declare function prepareDownloadOptions(value: unknown): DownloadOptions;
+export declare function prepareUploadOptions(value: unknown, name?: string): UploadOptions;
+export declare function prepareRedundantUploadOptions(value: unknown, name?: string): RedundantUploadOptions;
+export declare function prepareFileUploadOptions(value: unknown): FileUploadOptions;
+export declare function prepareCollectionUploadOptions(value: unknown): CollectionUploadOptions;
 export declare function isTag(value: unknown): value is Tag;
-export declare function assertPssMessageHandler(value: unknown): asserts value is PssMessageHandler;
-export declare function assertGsocMessageHandler(value: unknown): asserts value is GsocMessageHandler;
-export declare function assertPostageBatchOptions(value: unknown): asserts value is PostageBatchOptions;
-export declare function assertTransactionOptions(value: unknown, name?: string): asserts value is TransactionOptions;
-export declare function assertCashoutOptions(value: unknown): asserts value is CashoutOptions;
+export declare function preparePssMessageHandler(value: unknown): PssMessageHandler;
+export declare function prepareGsocMessageHandler(value: unknown): GsocMessageHandler;
+export declare function preparePostageBatchOptions(value: unknown): PostageBatchOptions;
+export declare function prepareTransactionOptions(value: unknown, name?: string): TransactionOptions;
 /**
  * Check whether the given parameter is valid data to upload
  * @param value
@@ -40,7 +34,7 @@ export declare function assertFileData(value: unknown): asserts value is string
  * Checks whether optional options for AllTags query are valid
  * @param options
  */
-export declare function assertAllTagsOptions(entry: unknown): asserts entry is AllTagsOptions;
+export declare function prepareAllTagsOptions(value: unknown): AllTagsOptions;
 /**
  * Utility functions that return Tag UID
  * @param tagUid

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@upcoming/bee-js",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "Javascript client for Bee",
   "keywords": [
     "bee",
@@ -63,7 +63,7 @@
   },
   "dependencies": {
     "axios": "^0.28.1",
-    "cafe-utility": "^27.6.0",
+    "cafe-utility": "^27.9.1",
     "isomorphic-ws": "^4.0.1",
     "semver": "^7.3.5",
     "ws": "^8.7.0"