@upcoming/bee-js 9.9.0 → 10.1.2

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

@@ -19,9 +19,9 @@ export async function getChequebookAddress(requestOptions) {
     name: 'response.data'
   });
   return {
-    chequebookAddress: Types.asString(body.chequebookAddress, {
+    chequebookAddress: new EthAddress(Types.asString(body.chequebookAddress, {
       name: 'chequebookAddress'
-    })
+    }))
   };
 }
 /**

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/types/index.js

@@ -4,16 +4,21 @@ export const BRANCHES = 128;
 export const CHUNK_SIZE = SECTION_SIZE * BRANCHES;
 export const PSS_TARGET_HEX_LENGTH_MAX = 4;
 /**
- * Minimal depth that can be used for creation of postage batch
+ * Minimum postage batch depth.
  */
 export const STAMPS_DEPTH_MIN = 17;
 /**
- * Maximal depth that can be used for creation of postage batch
+ * Maximum postage batch depth.
  */
 export const STAMPS_DEPTH_MAX = 255;
+/**
+ * Minimum tags API page size.
+ */
 export const TAGS_LIMIT_MIN = 1;
+/**
+ * Maximum tags API page size.
+ */
 export const TAGS_LIMIT_MAX = 1000;
-export const FEED_INDEX_HEX_LENGTH = 16;
 /**
  * Add redundancy to the data being uploaded so that downloaders can download it with better UX.
  * 0 value is default and does not add any redundancy to the file.

package/dist/mjs/utils/bytes.js

@@ -1,8 +1,13 @@
-import { Binary, Types } from 'cafe-utility';
+import { Binary, Objects, Types } from 'cafe-utility';
+import _debug from 'debug';
+const debug = _debug('bee-js:bytes');
 const DECODER = new TextDecoder();
 const ENCODER = new TextEncoder();
 export class Bytes {
   constructor(bytes, byteLength) {
+    if (!bytes) {
+      throw Error(`Bytes#constructor: constructor parameter is falsy: ${bytes}`);
+    }
     if (bytes instanceof Bytes) {
       this.bytes = bytes.bytes;
     } else if (typeof bytes === 'string') {
@@ -11,8 +16,20 @@ export class Bytes {
       }));
     } else if (bytes instanceof ArrayBuffer) {
       this.bytes = new Uint8Array(bytes);
-    } else {
+    } else if (bytes instanceof Uint8Array) {
       this.bytes = bytes;
+    } else {
+      const unknownInput = bytes;
+      const toHex = Objects.getDeep(unknownInput, 'toHex');
+      if (Types.isFunction(toHex)) {
+        const hex = toHex.call(unknownInput);
+        this.bytes = Binary.hexToUint8Array(Types.asHexString(hex, {
+          name: 'Bytes#constructor(bytes)'
+        }));
+      } else {
+        debug('bytes', bytes);
+        throw new Error(`Bytes#constructor: unsupported type: ${typeof bytes}`);
+      }
     }
     this.length = this.bytes.length;
     if (byteLength) {

package/dist/mjs/utils/duration.js

@@ -3,7 +3,7 @@ export class Duration {
   constructor(seconds) {
     this.seconds = Math.ceil(seconds);
     if (seconds < 0) {
-      throw Error('Duration cannot be negative');
+      this.seconds = 0;
     }
   }
   static fromMilliseconds(milliseconds) {
@@ -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/mjs/utils/type.js

@@ -158,6 +158,9 @@ export function preparePssMessageHandler(value) {
     }),
     onError: Types.asFunction(object.onError, {
       name: 'onError'
+    }),
+    onClose: Types.asFunction(object.onClose, {
+      name: 'onClose'
     })
   };
 }
@@ -171,6 +174,9 @@ export function prepareGsocMessageHandler(value) {
     }),
     onError: Types.asFunction(object.onError, {
       name: 'onError'
+    }),
+    onClose: Types.asFunction(object.onClose, {
+      name: 'onClose'
     })
   };
 }