@ethersphere/bee-js 3.1.0 → 3.2.0

package/dist/src/bee-debug.d.ts

@@ -1,4 +1,4 @@
-import type { Address, Peer, BalanceResponse, PeerBalance, ChequebookAddressResponse, ChequebookBalanceResponse, LastChequesResponse, LastChequesForPeerResponse, LastCashoutActionResponse, Settlements, AllSettlements, RemovePeerResponse, Topology, PingResponse, Health, NodeAddresses, ReserveState, ChainState, NumberString, ExtendedTag, PostageBatchBuckets, DebugPostageBatch, TransactionInfo, TransactionHash, NodesInfo } from './types';
+import type { Address, Peer, BalanceResponse, PeerBalance, ChequebookAddressResponse, ChequebookBalanceResponse, LastChequesResponse, LastChequesForPeerResponse, LastCashoutActionResponse, Settlements, AllSettlements, RemovePeerResponse, Topology, PingResponse, Health, NodeAddresses, ReserveState, ChainState, NumberString, ExtendedTag, PostageBatchBuckets, DebugPostageBatch, TransactionInfo, TransactionHash, NodeInfo } from './types';
 import { BatchId, BeeOptions, CashoutOptions, PostageBatchOptions, RequestOptions, Tag } from './types';
 export declare class BeeDebug {
     /**
@@ -120,7 +120,7 @@ export declare class BeeDebug {
     /**
      * Get mode information of node
      */
-    getNodeInfo(options?: RequestOptions): Promise<NodesInfo>;
+    getNodeInfo(options?: RequestOptions): Promise<NodeInfo>;
     /**
      * Connnects to a node and checks if it is a supported Bee version by the bee-js
      *

package/dist/src/modules/debug/status.d.ts

@@ -1,4 +1,4 @@
-import type { Health, NodesInfo } from '../../types/debug';
+import type { Health, NodeInfo } from '../../types/debug';
 import { Ky } from '../../types';
 export declare const SUPPORTED_BEE_VERSION_EXACT: string;
 export declare const SUPPORTED_BEE_VERSION: string;
@@ -13,7 +13,7 @@ export declare function getHealth(ky: Ky): Promise<Health>;
  *
  * @param ky Ky debug instance
  */
-export declare function getNodeInfo(ky: Ky): Promise<NodesInfo>;
+export declare function getNodeInfo(ky: Ky): Promise<NodeInfo>;
 /**
  * Connects to a node and checks if it is a supported Bee version by the bee-js
  *

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

@@ -126,10 +126,18 @@ export declare enum BeeModes {
     LIGHT = "light",
     DEV = "dev"
 }
-export interface NodesInfo {
+/**
+ * Information about Bee node and its configuration
+ */
+export interface NodeInfo {
     gatewayMode: boolean;
     beeMode: BeeModes;
 }
+/**
+ * Information about Bee node and its configuration
+ * @deprecated Use NodeInfo instead
+ */
+export declare type NodesInfo = NodeInfo;
 export interface RemovePeerResponse {
     message: string;
     code: 0;

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

@@ -11,6 +11,7 @@ import type ky from 'ky-universal';
 import type { Readable as NativeReadable } from 'stream';
 import type { Readable as CompatibilityReadable } from 'readable-stream';
 import type { ReadableStream as ReadableStreamPonyfill } from 'web-streams-polyfill/ponyfill';
+import { Options as KyOptions } from 'ky-universal';
 export * from './debug';
 export declare type Ky = typeof ky;
 export interface Dictionary<T> {
@@ -63,6 +64,17 @@ export declare type BatchId = HexString<typeof BATCH_ID_HEX_LENGTH>;
  * It represents PSS Address Prefix that is used to define address neighborhood that will receive the PSS message.
  */
 export declare type AddressPrefix = HexString;
+/**
+ * Internal interface that represents configuration for creating a request with Ky
+ */
+export interface KyRequestOptions extends Omit<KyOptions, 'searchParams'> {
+    path: string;
+    responseType?: 'json' | 'arraybuffer' | 'stream';
+    /**
+     * Overridden parameter that allows undefined as a value.
+     */
+    searchParams?: Record<string, string | number | boolean | undefined>;
+}
 export interface RequestOptions {
     /**
      * Timeout of requests in milliseconds
@@ -142,6 +154,17 @@ export interface UploadOptions extends RequestOptions {
      * @link Tag
      */
     tag?: number;
+    /**
+     * Determines if the uploaded data should be sent to the network immediately (eq. deferred=false) or in a deferred fashion (eq. deferred=true).
+     *
+     * With deferred style client uploads all the data to Bee node first and only then Bee node starts push the data to network itself. The progress of this upload can be tracked with tags.
+     * With non-deferred style client uploads the data to Bee which immediately starts pushing the data to network. The request is only finished once all the data was pushed through the Bee node to the network.
+     *
+     * In future there will be move to the non-deferred style and even the support for deferred upload will be removed from Bee itself.
+     *
+     * @default true
+     */
+    deferred?: boolean;
 }
 export interface FileUploadOptions extends UploadOptions {
     /**
@@ -372,14 +395,16 @@ export interface PostageBatch {
     bucketDepth: number;
     blockNumber: number;
     immutableFlag: boolean;
-}
-export interface DebugPostageBatch extends PostageBatch {
     /**
      * The time (in seconds) remaining until the batch expires; -1 signals that the batch never expires; 0 signals that the batch has already expired.
      */
     batchTTL: number;
     exists: boolean;
 }
+/**
+ * @deprecated Use PostageBatch instead.
+ */
+export declare type DebugPostageBatch = PostageBatch;
 export interface BatchBucket {
     bucketID: number;
     collisions: number;

package/dist/src/utils/error.d.ts

@@ -1,3 +1,4 @@
+import { KyRequestOptions } from '../types';
 export declare class BeeError extends Error {
     constructor(message: string);
 }
@@ -6,9 +7,27 @@ export declare class BeeArgumentError extends BeeError {
     constructor(message: string, value: unknown);
 }
 export declare class BeeRequestError extends BeeError {
-    constructor(message: string);
+    readonly requestOptions: KyRequestOptions;
+    /**
+     * @param message
+     * @param requestOptions KyOptions that were used to assemble the request. THIS MIGHT NOT BE COMPLETE! If custom Ky instance was used that has set defaults then these defaults are not visible in this object!
+     */
+    constructor(message: string, requestOptions: KyRequestOptions);
 }
 export declare class BeeResponseError extends BeeError {
     readonly status: number;
-    constructor(status: number, message: string);
+    readonly response: Response;
+    readonly responseBody: string;
+    readonly requestOptions: KyRequestOptions;
+    /**
+     * @param status HTTP status code number
+     * @param response Response returned from the server
+     * @param responseBody Response body as string which is returned from response.text() call
+     * @param requestOptions KyOptions that were used to assemble the request. THIS MIGHT NOT BE COMPLETE! If custom Ky instance was used that has set defaults then these defaults are not visible in this object!
+     * @param message
+     */
+    constructor(status: number, response: Response, responseBody: string, requestOptions: KyRequestOptions, message: string);
+}
+export declare class BeeNotAJsonError extends BeeError {
+    constructor();
 }

package/dist/src/utils/http.d.ts

@@ -1,13 +1,6 @@
 import type { BeeRequest, BeeResponse, HookCallback, Ky } from '../types';
 import { Options as KyOptions } from 'ky-universal';
-interface HttpOptions extends Omit<KyOptions, 'searchParams'> {
-    path: string;
-    responseType?: 'json' | 'arraybuffer' | 'stream';
-    /**
-     * Overridden parameter that allows undefined as a value.
-     */
-    searchParams?: Record<string, string | number | boolean | undefined>;
-}
+import { KyRequestOptions } from '../types';
 interface KyResponse<T> extends Response {
     data: T;
 }
@@ -20,6 +13,11 @@ export declare function wrapResponseClosure(cb: HookCallback<BeeResponse>): (req
  * @param obj
  */
 export declare function filterHeaders(obj?: object): Record<string, string> | undefined;
-export declare function http<T>(ky: Ky, config: HttpOptions): Promise<KyResponse<T>>;
+/**
+ * Main utility function to make HTTP requests.
+ * @param ky
+ * @param config
+ */
+export declare function http<T>(ky: Ky, config: KyRequestOptions): Promise<KyResponse<T>>;
 export declare function makeDefaultKy(kyConfig: KyOptions): Ky;
 export {};

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

@@ -12,6 +12,12 @@ export declare function isObject(value: unknown): value is Record<string, unknow
  * @param value
  */
 export declare function isStrictlyObject(value: unknown): value is object;
+/**
+ * Asserts if object is Error
+ *
+ * @param e
+ */
+export declare function isError(e: unknown): e is Error;
 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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethersphere/bee-js",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "Javascript client for Bee",
   "keywords": [
     "bee",
@@ -61,23 +61,23 @@
     "ky-universal": "^0.8.2",
     "readable-stream": "^3.6.0",
     "tar-js": "^0.3.0",
-    "utf-8-validate": "^5.0.5",
+    "utf-8-validate": "^5.0.8",
     "web-streams-polyfill": "^3.1.0",
     "ws": "^7.5.0"
   },
   "devDependencies": {
     "@babel/core": "^7.14.6",
-    "@babel/plugin-proposal-class-properties": "^7.14.5",
+    "@babel/plugin-proposal-class-properties": "^7.16.7",
     "@babel/plugin-transform-runtime": "^7.14.5",
     "@babel/preset-env": "^7.14.7",
     "@babel/preset-typescript": "^7.14.5",
     "@commitlint/cli": "^12.1.1",
-    "@commitlint/config-conventional": "^12.1.4",
+    "@commitlint/config-conventional": "^16.0.0",
     "@fluffy-spoon/substitute": "^1.208.0",
     "@jest/test-sequencer": "^27.0.5",
     "@jest/types": "^27.0.2",
-    "@types/content-disposition": "^0.5.3",
-    "@types/debug": "^4.1.5",
+    "@types/content-disposition": "^0.5.4",
+    "@types/debug": "^4.1.7",
     "@types/elliptic": "^6.4.12",
     "@types/expect-puppeteer": "^4.4.5",
     "@types/glob": "^7.1.3",
@@ -85,35 +85,34 @@
     "@types/jest-environment-puppeteer": "^4.4.1",
     "@types/node": "^15.12.4",
     "@types/puppeteer": "^5.4.3",
-    "@types/terser-webpack-plugin": "^5.0.3",
     "@types/ws": "^7.4.5",
-    "@typescript-eslint/eslint-plugin": "^4.28.0",
-    "@typescript-eslint/parser": "^4.28.0",
+    "@typescript-eslint/eslint-plugin": "^5.10.0",
+    "@typescript-eslint/parser": "^5.10.0",
     "babel-jest": "^27.0.5",
     "babel-loader": "^8.2.2",
     "debug": "^4.3.1",
-    "depcheck": "^1.4.0",
-    "eslint": "^7.29.0",
+    "depcheck": "^1.4.3",
+    "eslint": "^8.7.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-jest": "^24.3.6",
-    "eslint-plugin-prettier": "^3.4.0",
-    "eslint-plugin-unused-imports": "^1.1.1",
+    "eslint-plugin-jest": "^25.7.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-unused-imports": "^2.0.0",
     "glob": "^7.1.7",
     "husky": "^6.0.0",
     "jest": "^27.0.5",
     "jest-puppeteer": "^5.0.4",
-    "nock": "^13.1.0",
+    "nock": "^13.2.2",
     "prettier": "^2.3.1",
     "puppeteer": "^9.1.1",
     "rimraf": "^3.0.2",
-    "terser-webpack-plugin": "^5.1.3",
+    "terser-webpack-plugin": "^5.3.0",
     "ts-node": "^10.0.0",
-    "typedoc": "^0.21.0",
-    "typedoc-plugin-markdown": "^3.10.0",
-    "typescript": "^4.3.4",
-    "webpack": "^5.40.0",
+    "typedoc": "^0.22.11",
+    "typedoc-plugin-markdown": "^3.11.12",
+    "typescript": "^4.5.4",
+    "webpack": "^5.65.0",
     "webpack-bundle-analyzer": "^4.4.1",
-    "webpack-cli": "^4.7.2"
+    "webpack-cli": "^4.9.2"
   },
   "engines": {
     "node": ">=12.0.0",