@ethersphere/bee-js 3.0.0 → 3.1.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 } 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, NodesInfo } from './types';
 import { BatchId, BeeOptions, CashoutOptions, PostageBatchOptions, RequestOptions, Tag } from './types';
 export declare class BeeDebug {
     /**
@@ -117,6 +117,10 @@ export declare class BeeDebug {
      * Get health of node
      */
     getHealth(options?: RequestOptions): Promise<Health>;
+    /**
+     * Get mode information of node
+     */
+    getNodeInfo(options?: RequestOptions): Promise<NodesInfo>;
     /**
      * Connnects to a node and checks if it is a supported Bee version by the bee-js
      *

package/dist/src/bee.d.ts

@@ -57,6 +57,27 @@ export declare class Bee {
      * @see [Bee API reference - `GET /bytes`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes~1{reference}/get)
      */
     downloadReadableData(reference: Reference | string, options?: RequestOptions): Promise<ReadableStream<Uint8Array>>;
+    /**
+     * Upload chunk to a Bee node
+     *
+     * @param postageBatchId Postage BatchId to be used to upload the chunk with
+     * @param data    Raw chunk to be uploaded
+     * @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 /chunks`](https://docs.ethswarm.org/api/#tag/Chunk/paths/~1chunks/post)
+     */
+    uploadChunk(postageBatchId: string | BatchId, data: Uint8Array, options?: UploadOptions): Promise<Reference>;
+    /**
+     * Download chunk as a byte array
+     *
+     * @param reference Bee chunk 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 /chunks`](https://docs.ethswarm.org/api/#tag/Chunk/paths/~1chunks~1{reference}/get)
+     */
+    downloadChunk(reference: Reference | string, options?: RequestOptions): Promise<Data>;
     /**
      * Upload single file to a Bee node.
      *

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

@@ -1,5 +1,4 @@
-import type { BatchId, Ky, UploadOptions } from '../types';
-import { Reference } from '../types';
+import type { BatchId, Data, Ky, Reference, UploadOptions } from '../types';
 /**
  * Upload chunk to a Bee node
  *
@@ -20,11 +19,4 @@ export declare function upload(ky: Ky, data: Uint8Array, postageBatchId: BatchId
  * @param hash Bee content reference
  *
  */
-export declare function download(ky: Ky, hash: string): Promise<Uint8Array>;
-/**
- * Download chunk data as a readable stream
- *
- * @param ky Ky instance for given Bee class instance
- * @param hash Bee content reference
- */
-export declare function downloadReadable(ky: Ky, hash: string): Promise<ReadableStream<Uint8Array>>;
+export declare function download(ky: Ky, hash: string): Promise<Data>;

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

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

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

@@ -121,6 +121,15 @@ export interface Health {
     apiVersion: string;
     debugApiVersion: string;
 }
+export declare enum BeeModes {
+    FULL = "full",
+    LIGHT = "light",
+    DEV = "dev"
+}
+export interface NodesInfo {
+    gatewayMode: boolean;
+    beeMode: BeeModes;
+}
 export interface RemovePeerResponse {
     message: string;
     code: 0;

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

@@ -16,6 +16,10 @@ export declare type Ky = typeof ky;
 export interface Dictionary<T> {
     [Key: string]: T;
 }
+export declare const SPAN_SIZE = 8;
+export declare const SECTION_SIZE = 32;
+export declare const BRANCHES = 128;
+export declare const CHUNK_SIZE: number;
 export declare const ADDRESS_HEX_LENGTH = 64;
 export declare const PSS_TARGET_HEX_LENGTH_MAX = 6;
 export declare const PUBKEY_HEX_LENGTH = 66;

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

@@ -5,3 +5,4 @@ export { EthAddress, makeEthAddress, makeHexEthAddress, isHexEthAddress, ethToSw
 export { readableWebToNode, readableNodeToWeb, isReadableStream, isNodeReadable, normalizeToReadableStream, isReadable, } from './stream';
 export { keccak256Hash } from './hash';
 export { makeMaxTarget } from './pss';
+export { getStampUsage } from './stamps';

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

@@ -0,0 +1,12 @@
+import { DebugPostageBatch } from '../types';
+/**
+ * Utility function that calculates usage of postage batch based on its utilization, depth and bucket depth.
+ *
+ * Be aware for small depths (17, 18) this does not provide that much information as the provided set of distinct values
+ * is small.
+ *
+ * @param utilization
+ * @param depth
+ * @param bucketDepth
+ */
+export declare function getStampUsage({ utilization, depth, bucketDepth }: DebugPostageBatch): number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethersphere/bee-js",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Javascript client for Bee",
   "keywords": [
     "bee",
@@ -118,6 +118,6 @@
   "engines": {
     "node": ">=12.0.0",
     "npm": ">=6.0.0",
-    "bee": "1.4.0-8fa696a8"
+    "bee": "1.4.1-238867f1"
   }
 }