@upcoming/bee-js 9.9.0 → 10.1.2

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

@@ -20,7 +20,7 @@ async function getChequebookAddress(requestOptions) {
     });
     const body = cafe_utility_1.Types.asObject(response.data, { name: 'response.data' });
     return {
-        chequebookAddress: cafe_utility_1.Types.asString(body.chequebookAddress, { name: 'chequebookAddress' }),
+        chequebookAddress: new typed_bytes_1.EthAddress(cafe_utility_1.Types.asString(body.chequebookAddress, { name: 'chequebookAddress' })),
     };
 }
 exports.getChequebookAddress = getChequebookAddress;

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

@@ -46,6 +46,7 @@ async function getAllPostageBatches(requestOptions) {
         const usage = (0, stamps_1.getStampUsage)(utilization, depth, bucketDepth);
         const batchTTL = (0, workaround_1.normalizeBatchTTL)(cafe_utility_1.Types.asNumber(x.batchTTL, { name: 'batchTTL' }));
         const duration = duration_1.Duration.fromSeconds(batchTTL);
+        const effectiveBytes = (0, stamps_1.getStampEffectiveBytes)(depth);
         return {
             batchID: new typed_bytes_1.BatchId(cafe_utility_1.Types.asString(x.batchID, { name: 'batchID' })),
             utilization,
@@ -58,15 +59,23 @@ async function getAllPostageBatches(requestOptions) {
             immutableFlag: cafe_utility_1.Types.asBoolean(x.immutableFlag, { name: 'immutableFlag' }),
             usage,
             usageText: `${Math.round(usage * 100)}%`,
-            size: size_1.Size.fromBytes((0, stamps_1.getStampEffectiveBytes)(depth)),
-            remainingSize: size_1.Size.fromBytes(Math.ceil((0, stamps_1.getStampEffectiveBytes)(depth) * (1 - usage))),
+            size: size_1.Size.fromBytes(effectiveBytes),
+            remainingSize: size_1.Size.fromBytes(Math.ceil(effectiveBytes * (1 - usage))),
             theoreticalSize: size_1.Size.fromBytes((0, stamps_1.getStampTheoreticalBytes)(depth)),
             duration,
+            calculateSize(encryption, redundancyLevel) {
+                const effectiveBytes = (0, stamps_1.getStampEffectiveBytes)(this.depth, encryption, redundancyLevel);
+                return size_1.Size.fromBytes(effectiveBytes);
+            },
+            calculateRemainingSize(encryption, redundancyLevel) {
+                const effectiveBytes = (0, stamps_1.getStampEffectiveBytes)(this.depth, encryption, redundancyLevel);
+                return size_1.Size.fromBytes(Math.ceil(effectiveBytes * (1 - this.usage)));
+            },
         };
     });
 }
 exports.getAllPostageBatches = getAllPostageBatches;
-async function getPostageBatch(requestOptions, postageBatchId) {
+async function getPostageBatch(requestOptions, postageBatchId, encryption, erasureCodeLevel) {
     const response = await (0, http_1.http)(requestOptions, {
         method: 'get',
         url: `${STAMPS_ENDPOINT}/${postageBatchId}`,
@@ -79,6 +88,7 @@ async function getPostageBatch(requestOptions, postageBatchId) {
     const usage = (0, stamps_1.getStampUsage)(utilization, depth, bucketDepth);
     const batchTTL = (0, workaround_1.normalizeBatchTTL)(cafe_utility_1.Types.asNumber(body.batchTTL, { name: 'batchTTL' }));
     const duration = duration_1.Duration.fromSeconds(batchTTL);
+    const effectiveBytes = (0, stamps_1.getStampEffectiveBytes)(depth, encryption, erasureCodeLevel);
     return {
         batchID: new typed_bytes_1.BatchId(cafe_utility_1.Types.asString(body.batchID, { name: 'batchID' })),
         utilization,
@@ -91,10 +101,18 @@ async function getPostageBatch(requestOptions, postageBatchId) {
         immutableFlag: cafe_utility_1.Types.asBoolean(body.immutableFlag, { name: 'immutableFlag' }),
         usage,
         usageText: `${Math.round(usage * 100)}%`,
-        size: size_1.Size.fromBytes((0, stamps_1.getStampEffectiveBytes)(depth)),
-        remainingSize: size_1.Size.fromBytes(Math.ceil((0, stamps_1.getStampEffectiveBytes)(depth) * (1 - usage))),
+        size: size_1.Size.fromBytes(effectiveBytes),
+        remainingSize: size_1.Size.fromBytes(Math.ceil(effectiveBytes * (1 - usage))),
         theoreticalSize: size_1.Size.fromBytes((0, stamps_1.getStampTheoreticalBytes)(depth)),
         duration,
+        calculateSize(encryption, redundancyLevel) {
+            const effectiveBytes = (0, stamps_1.getStampEffectiveBytes)(depth, encryption, redundancyLevel);
+            return size_1.Size.fromBytes(effectiveBytes);
+        },
+        calculateRemainingSize(encryption, redundancyLevel) {
+            const effectiveBytes = (0, stamps_1.getStampEffectiveBytes)(depth, encryption, redundancyLevel);
+            return size_1.Size.fromBytes(Math.ceil(effectiveBytes * (1 - usage)));
+        },
     };
 }
 exports.getPostageBatch = getPostageBatch;

package/dist/cjs/types/index.js

@@ -14,23 +14,28 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.capacityBreakpoints = exports.RedundancyStrategy = exports.RedundancyLevel = exports.FEED_INDEX_HEX_LENGTH = exports.TAGS_LIMIT_MAX = exports.TAGS_LIMIT_MIN = exports.STAMPS_DEPTH_MAX = exports.STAMPS_DEPTH_MIN = exports.PSS_TARGET_HEX_LENGTH_MAX = exports.CHUNK_SIZE = exports.BRANCHES = exports.SECTION_SIZE = void 0;
+exports.capacityBreakpoints = exports.RedundancyStrategy = exports.RedundancyLevel = exports.TAGS_LIMIT_MAX = exports.TAGS_LIMIT_MIN = exports.STAMPS_DEPTH_MAX = exports.STAMPS_DEPTH_MIN = exports.PSS_TARGET_HEX_LENGTH_MAX = exports.CHUNK_SIZE = exports.BRANCHES = exports.SECTION_SIZE = void 0;
 __exportStar(require("./debug"), exports);
 exports.SECTION_SIZE = 32;
 exports.BRANCHES = 128;
 exports.CHUNK_SIZE = exports.SECTION_SIZE * exports.BRANCHES;
 exports.PSS_TARGET_HEX_LENGTH_MAX = 4;
 /**
- * Minimal depth that can be used for creation of postage batch
+ * Minimum postage batch depth.
  */
 exports.STAMPS_DEPTH_MIN = 17;
 /**
- * Maximal depth that can be used for creation of postage batch
+ * Maximum postage batch depth.
  */
 exports.STAMPS_DEPTH_MAX = 255;
+/**
+ * Minimum tags API page size.
+ */
 exports.TAGS_LIMIT_MIN = 1;
+/**
+ * Maximum tags API page size.
+ */
 exports.TAGS_LIMIT_MAX = 1000;
-exports.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/cjs/utils/bytes.js

@@ -1,11 +1,19 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseSizeToBytes = exports.Bytes = void 0;
 const cafe_utility_1 = require("cafe-utility");
+const debug_1 = __importDefault(require("debug"));
+const debug = (0, debug_1.default)('bee-js:bytes');
 const DECODER = new TextDecoder();
 const ENCODER = new TextEncoder();
 class Bytes {
     constructor(bytes, byteLength) {
+        if (!bytes) {
+            throw Error(`Bytes#constructor: constructor parameter is falsy: ${bytes}`);
+        }
         if (bytes instanceof Bytes) {
             this.bytes = bytes.bytes;
         }
@@ -15,9 +23,21 @@ 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 = cafe_utility_1.Objects.getDeep(unknownInput, 'toHex');
+            if (cafe_utility_1.Types.isFunction(toHex)) {
+                const hex = toHex.call(unknownInput);
+                this.bytes = cafe_utility_1.Binary.hexToUint8Array(cafe_utility_1.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) {
             if (Array.isArray(byteLength)) {

package/dist/cjs/utils/duration.js

@@ -6,7 +6,7 @@ class Duration {
     constructor(seconds) {
         this.seconds = Math.ceil(seconds);
         if (seconds < 0) {
-            throw Error('Duration cannot be negative');
+            this.seconds = 0;
         }
     }
     static fromMilliseconds(milliseconds) {
@@ -30,6 +30,32 @@ 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(cafe_utility_1.Dates.make(duration) / 1000);
+    }
     toSeconds() {
         return this.seconds;
     }

package/dist/cjs/utils/size.js

@@ -28,6 +28,31 @@ 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(cafe_utility_1.Numbers.makeStorage(size, 1000));
+    }
     toBytes() {
         return this.bytes;
     }

package/dist/cjs/utils/type.js

@@ -124,6 +124,7 @@ function preparePssMessageHandler(value) {
     return {
         onMessage: cafe_utility_1.Types.asFunction(object.onMessage, { name: 'onMessage' }),
         onError: cafe_utility_1.Types.asFunction(object.onError, { name: 'onError' }),
+        onClose: cafe_utility_1.Types.asFunction(object.onClose, { name: 'onClose' }),
     };
 }
 exports.preparePssMessageHandler = preparePssMessageHandler;
@@ -132,6 +133,7 @@ function prepareGsocMessageHandler(value) {
     return {
         onMessage: cafe_utility_1.Types.asFunction(object.onMessage, { name: 'onMessage' }),
         onError: cafe_utility_1.Types.asFunction(object.onError, { name: 'onError' }),
+        onClose: cafe_utility_1.Types.asFunction(object.onClose, { name: 'onClose' }),
     };
 }
 exports.prepareGsocMessageHandler = prepareGsocMessageHandler;