@ethersphere/bee-js 10.0.1 → 10.1.1

package/dist/mjs/bee.js

@@ -1735,13 +1735,15 @@ export class Bee {
    *
    * @param postageBatchId Batch ID
    * @param requestOptions Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
+   * @param encryption Assume that uploads with this postage batch are encrypted, which skews the capacity.
+   * @param erasureCodeLevel Assume that uploads with this postage batch are erasure coded, which skews the capacity.
    *
    * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive)
    * @see [Bee Debug API reference - `GET /stamps/${id}`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1%7Bbatch_id%7D/get)
    */
-  async getPostageBatch(postageBatchId, requestOptions) {
+  async getPostageBatch(postageBatchId, requestOptions, encryption, erasureCodeLevel) {
     postageBatchId = new BatchId(postageBatchId);
-    return stamps.getPostageBatch(this.getRequestOptionsForCall(requestOptions), postageBatchId);
+    return stamps.getPostageBatch(this.getRequestOptionsForCall(requestOptions), postageBatchId, encryption, erasureCodeLevel);
   }
   /**
    * Return detailed information related to buckets for specific postage batch.

package/dist/mjs/modules/debug/stamps.js

@@ -78,6 +78,7 @@ export async function getAllPostageBatches(requestOptions) {
       name: 'batchTTL'
     }));
     const duration = Duration.fromSeconds(batchTTL);
+    const effectiveBytes = getStampEffectiveBytes(depth);
     return {
       batchID: new BatchId(Types.asString(x.batchID, {
         name: 'batchID'
@@ -102,14 +103,22 @@ export async function getAllPostageBatches(requestOptions) {
       }),
       usage,
       usageText: `${Math.round(usage * 100)}%`,
-      size: Size.fromBytes(getStampEffectiveBytes(depth)),
-      remainingSize: Size.fromBytes(Math.ceil(getStampEffectiveBytes(depth) * (1 - usage))),
+      size: Size.fromBytes(effectiveBytes),
+      remainingSize: Size.fromBytes(Math.ceil(effectiveBytes * (1 - usage))),
       theoreticalSize: Size.fromBytes(getStampTheoreticalBytes(depth)),
-      duration
+      duration,
+      calculateSize(encryption, redundancyLevel) {
+        const effectiveBytes = getStampEffectiveBytes(this.depth, encryption, redundancyLevel);
+        return Size.fromBytes(effectiveBytes);
+      },
+      calculateRemainingSize(encryption, redundancyLevel) {
+        const effectiveBytes = getStampEffectiveBytes(this.depth, encryption, redundancyLevel);
+        return Size.fromBytes(Math.ceil(effectiveBytes * (1 - this.usage)));
+      }
     };
   });
 }
-export async function getPostageBatch(requestOptions, postageBatchId) {
+export async function getPostageBatch(requestOptions, postageBatchId, encryption, erasureCodeLevel) {
   const response = await http(requestOptions, {
     method: 'get',
     url: `${STAMPS_ENDPOINT}/${postageBatchId}`,
@@ -132,6 +141,7 @@ export async function getPostageBatch(requestOptions, postageBatchId) {
     name: 'batchTTL'
   }));
   const duration = Duration.fromSeconds(batchTTL);
+  const effectiveBytes = getStampEffectiveBytes(depth, encryption, erasureCodeLevel);
   return {
     batchID: new BatchId(Types.asString(body.batchID, {
       name: 'batchID'
@@ -156,10 +166,18 @@ export async function getPostageBatch(requestOptions, postageBatchId) {
     }),
     usage,
     usageText: `${Math.round(usage * 100)}%`,
-    size: Size.fromBytes(getStampEffectiveBytes(depth)),
-    remainingSize: Size.fromBytes(Math.ceil(getStampEffectiveBytes(depth) * (1 - usage))),
+    size: Size.fromBytes(effectiveBytes),
+    remainingSize: Size.fromBytes(Math.ceil(effectiveBytes * (1 - usage))),
     theoreticalSize: Size.fromBytes(getStampTheoreticalBytes(depth)),
-    duration
+    duration,
+    calculateSize(encryption, redundancyLevel) {
+      const effectiveBytes = getStampEffectiveBytes(depth, encryption, redundancyLevel);
+      return Size.fromBytes(effectiveBytes);
+    },
+    calculateRemainingSize(encryption, redundancyLevel) {
+      const effectiveBytes = getStampEffectiveBytes(depth, encryption, redundancyLevel);
+      return Size.fromBytes(Math.ceil(effectiveBytes * (1 - usage)));
+    }
   };
 }
 export async function getPostageBatchBuckets(requestOptions, postageBatchId) {

package/dist/mjs/utils/duration.js

@@ -27,6 +27,32 @@ export class Duration {
   static fromEndDate(endDate, startDate) {
     return new Duration((endDate.getTime() - (startDate ?? new Date()).getTime()) / 1000);
   }
+  /**
+   * Parses a duration string and returns a `Duration` instance.
+   *
+   * Case insensitive. E.g. both `"28h"` and `"1D"` are valid.
+   *
+   * Whitespaces are ignored. E.g. both `"5 d"` and `"2weeks"` are valid.
+   *
+   * Decimal numbers are supported. E.g. `"1.5h"` is valid.
+   *
+   * Supported units:
+   *
+   * - ms, milli, millis, millisecond, milliseconds
+   * - s, sec, second, seconds
+   * - m, min, minute, minutes
+   * - h, hour, hours
+   * - d, day, days
+   * - w, week, weeks
+   * - month, months
+   * - y, year, years
+   *
+   * @param duration - A string representing a duration
+   * @returns a `Duration` instance
+   */
+  static parseFromString(duration) {
+    return Duration.fromSeconds(Dates.make(duration) / 1000);
+  }
   toSeconds() {
     return this.seconds;
   }

package/dist/mjs/utils/size.js

@@ -25,6 +25,31 @@ export class Size {
   static fromGigabytes(gigabytes) {
     return new Size(gigabytes * 1000 * 1000 * 1000);
   }
+  /**
+   * Parses a size string and returns a `Size` instance.
+   *
+   * Case insensitive. E.g. both `"28MB"` and `"1gb"` are valid.
+   *
+   * Whitespaces are ignored. E.g. both `"512 kb"` and `"2megabytes"` are valid.
+   *
+   * Decimal numbers are supported. E.g. `"1.5gb"` is valid.
+   *
+   * Uses 1000 as the base for conversions. E.g. 1kb = 1000 bytes.
+   * This is consistent with the effective stamp utilization table.
+   *
+   * Supported units:
+   * - b, byte, bytes
+   * - kb, kilobyte, kilobytes
+   * - mb, megabyte, megabytes
+   * - gb, gigabyte, gigabytes
+   * - tb, terabyte, terabytes
+   *
+   * @param size - A string representing a size
+   * @returns a `Size` instance
+   */
+  static parseFromString(size) {
+    return Size.fromBytes(Numbers.makeStorage(size, 1000));
+  }
   toBytes() {
     return this.bytes;
   }

package/dist/types/bee.d.ts

@@ -1158,11 +1158,13 @@ export declare class Bee {
      *
      * @param postageBatchId Batch ID
      * @param requestOptions Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
+     * @param encryption Assume that uploads with this postage batch are encrypted, which skews the capacity.
+     * @param erasureCodeLevel Assume that uploads with this postage batch are erasure coded, which skews the capacity.
      *
      * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive)
      * @see [Bee Debug API reference - `GET /stamps/${id}`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1%7Bbatch_id%7D/get)
      */
-    getPostageBatch(postageBatchId: BatchId | Uint8Array | string, requestOptions?: BeeRequestOptions): Promise<PostageBatch>;
+    getPostageBatch(postageBatchId: BatchId | Uint8Array | string, requestOptions?: BeeRequestOptions, encryption?: boolean, erasureCodeLevel?: RedundancyLevel): Promise<PostageBatch>;
     /**
      * Return detailed information related to buckets for specific postage batch.
      *

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

@@ -1,8 +1,8 @@
-import type { BeeRequestOptions, GlobalPostageBatch, NumberString, PostageBatch, PostageBatchBuckets, PostageBatchOptions } from '../../types';
+import type { BeeRequestOptions, GlobalPostageBatch, NumberString, PostageBatch, PostageBatchBuckets, PostageBatchOptions, RedundancyLevel } from '../../types';
 import { BatchId } from '../../utils/typed-bytes';
 export declare function getGlobalPostageBatches(requestOptions: BeeRequestOptions): Promise<GlobalPostageBatch[]>;
 export declare function getAllPostageBatches(requestOptions: BeeRequestOptions): Promise<PostageBatch[]>;
-export declare function getPostageBatch(requestOptions: BeeRequestOptions, postageBatchId: BatchId): Promise<PostageBatch>;
+export declare function getPostageBatch(requestOptions: BeeRequestOptions, postageBatchId: BatchId, encryption?: boolean, erasureCodeLevel?: RedundancyLevel): Promise<PostageBatch>;
 export declare function getPostageBatchBuckets(requestOptions: BeeRequestOptions, postageBatchId: BatchId): Promise<PostageBatchBuckets>;
 export declare function createPostageBatch(requestOptions: BeeRequestOptions, amount: NumberString, depth: number, options?: PostageBatchOptions): Promise<BatchId>;
 export declare function topUpBatch(requestOptions: BeeRequestOptions, id: BatchId, amount: NumberString): Promise<BatchId>;

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

@@ -450,6 +450,16 @@ export interface PostageBatch {
      * Theoretical size in bytes
      */
     theoreticalSize: Size;
+    /**
+     * Calculates the effective size of data that can be uploaded with this postage batch
+     * based on whether encryption is used and the desired redundancy level.
+     */
+    calculateSize(encryption: boolean, redundancyLevel: RedundancyLevel): Size;
+    /**
+     * Calculates the remaining size of data that can be uploaded with this postage batch
+     * based on whether encryption is used and the desired redundancy level.
+     */
+    calculateRemainingSize(encryption: boolean, redundancyLevel: RedundancyLevel): Size;
 }
 export interface BatchBucket {
     bucketID: number;

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

@@ -9,6 +9,30 @@ export declare class Duration {
     static fromWeeks(weeks: number): Duration;
     static fromYears(years: number): Duration;
     static fromEndDate(endDate: Date, startDate?: Date): Duration;
+    /**
+     * Parses a duration string and returns a `Duration` instance.
+     *
+     * Case insensitive. E.g. both `"28h"` and `"1D"` are valid.
+     *
+     * Whitespaces are ignored. E.g. both `"5 d"` and `"2weeks"` are valid.
+     *
+     * Decimal numbers are supported. E.g. `"1.5h"` is valid.
+     *
+     * Supported units:
+     *
+     * - ms, milli, millis, millisecond, milliseconds
+     * - s, sec, second, seconds
+     * - m, min, minute, minutes
+     * - h, hour, hours
+     * - d, day, days
+     * - w, week, weeks
+     * - month, months
+     * - y, year, years
+     *
+     * @param duration - A string representing a duration
+     * @returns a `Duration` instance
+     */
+    static parseFromString(duration: string): Duration;
     toSeconds(): number;
     toHours(): number;
     toDays(): number;

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

@@ -12,6 +12,29 @@ export declare class Size {
     static fromKilobytes(kilobytes: number): Size;
     static fromMegabytes(megabytes: number): Size;
     static fromGigabytes(gigabytes: number): Size;
+    /**
+     * Parses a size string and returns a `Size` instance.
+     *
+     * Case insensitive. E.g. both `"28MB"` and `"1gb"` are valid.
+     *
+     * Whitespaces are ignored. E.g. both `"512 kb"` and `"2megabytes"` are valid.
+     *
+     * Decimal numbers are supported. E.g. `"1.5gb"` is valid.
+     *
+     * Uses 1000 as the base for conversions. E.g. 1kb = 1000 bytes.
+     * This is consistent with the effective stamp utilization table.
+     *
+     * Supported units:
+     * - b, byte, bytes
+     * - kb, kilobyte, kilobytes
+     * - mb, megabyte, megabytes
+     * - gb, gigabyte, gigabytes
+     * - tb, terabyte, terabytes
+     *
+     * @param size - A string representing a size
+     * @returns a `Size` instance
+     */
+    static parseFromString(size: string): Size;
     toBytes(): number;
     toGigabytes(): number;
     toFormattedString(): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethersphere/bee-js",
-  "version": "10.0.1",
+  "version": "10.1.1",
   "description": "Javascript client for Bee",
   "keywords": [
     "bee",
@@ -62,7 +62,7 @@
   },
   "dependencies": {
     "axios": "^0.30.0",
-    "cafe-utility": "^31.0.0",
+    "cafe-utility": "^32.2.0",
     "debug": "^4.4.1",
     "isomorphic-ws": "^4.0.1",
     "semver": "^7.3.5",