@upcoming/bee-js 0.3.0 → 0.5.0

package/dist/cjs/utils/type.js

@@ -23,12 +23,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeTagUid = exports.assertAllTagsOptions = exports.assertFileData = exports.assertData = exports.assertCashoutOptions = exports.assertTransactionOptions = exports.assertPostageBatchOptions = exports.assertGsocMessageHandler = exports.assertPssMessageHandler = exports.isTag = exports.assertCollectionUploadOptions = exports.assertFileUploadOptions = exports.assertUploadOptions = exports.assertRequestOptions = exports.assertNonNegativeInteger = exports.assertInteger = exports.assertBoolean = exports.assertStrictlyObject = exports.isStrictlyObject = exports.isObject = exports.isInteger = exports.asNumberString = exports.isReadable = void 0;
+exports.makeTagUid = exports.prepareAllTagsOptions = exports.assertFileData = exports.assertData = exports.prepareTransactionOptions = exports.preparePostageBatchOptions = exports.prepareGsocMessageHandler = exports.preparePssMessageHandler = exports.isTag = exports.prepareCollectionUploadOptions = exports.prepareFileUploadOptions = exports.prepareRedundantUploadOptions = exports.prepareUploadOptions = exports.prepareDownloadOptions = exports.prepareBeeRequestOptions = exports.asNumberString = exports.isReadable = void 0;
 const cafe_utility_1 = require("cafe-utility");
 const stream = __importStar(require("stream"));
 const types_1 = require("../types");
-const error_1 = require("./error");
 const file_1 = require("./file");
+const typed_bytes_1 = require("./typed-bytes");
 function isReadable(obj) {
     return typeof stream.Readable !== 'undefined' && obj instanceof stream.Readable;
 }
@@ -40,166 +40,119 @@ function asNumberString(value, options) {
     return cafe_utility_1.Types.asIntegerString(value, options);
 }
 exports.asNumberString = asNumberString;
-function isInteger(value) {
-    return ((typeof value === 'string' && /^-?(0|[1-9][0-9]*)$/g.test(value)) ||
-        (typeof value === 'number' &&
-            value > Number.MIN_SAFE_INTEGER &&
-            value < Number.MAX_SAFE_INTEGER &&
-            Number.isInteger(value)));
-}
-exports.isInteger = isInteger;
-function isObject(value) {
-    return value !== null && typeof value === 'object';
-}
-exports.isObject = isObject;
-function isStrictlyObject(value) {
-    return isObject(value) && !Array.isArray(value);
-}
-exports.isStrictlyObject = isStrictlyObject;
-function assertStrictlyObject(value, name = 'value') {
-    if (!isStrictlyObject(value)) {
-        throw new TypeError(`${name} has to be an object that is not null nor array!`);
-    }
-}
-exports.assertStrictlyObject = assertStrictlyObject;
-function assertBoolean(value, name = 'value') {
-    if (value !== true && value !== false)
-        throw new TypeError(`${name} is not boolean`);
-}
-exports.assertBoolean = assertBoolean;
-function assertInteger(value, name = 'value') {
-    if (!isInteger(value))
-        throw new TypeError(`${name} is not integer`);
-}
-exports.assertInteger = assertInteger;
-function assertNonNegativeInteger(value, name = 'Value') {
-    assertInteger(value, name);
-    if (Number(value) < 0)
-        throw new error_1.BeeArgumentError(`${name} has to be bigger or equal to zero`, value);
-}
-exports.assertNonNegativeInteger = assertNonNegativeInteger;
-function assertRequestOptions(value, name = 'RequestOptions') {
-    if (value === undefined) {
-        return;
-    }
-    if (!isStrictlyObject(value)) {
-        throw new TypeError(`${name} has to be an object!`);
-    }
-    const options = value;
-    if (options.timeout) {
-        assertNonNegativeInteger(options.timeout, `${name}.timeout`);
-    }
-}
-exports.assertRequestOptions = assertRequestOptions;
-function assertUploadOptions(value, name = 'UploadOptions') {
-    if (!isStrictlyObject(value)) {
-        throw new TypeError(`${name} has to be an object!`);
-    }
-    assertRequestOptions(value, name);
-    const options = value;
-    if (options.pin && typeof options.pin !== 'boolean') {
-        throw new TypeError(`options.pin property in ${name} has to be boolean or undefined!`);
-    }
-    if (options.encrypt && typeof options.encrypt !== 'boolean') {
-        throw new TypeError(`options.encrypt property in ${name} has to be boolean or undefined!`);
-    }
-    if (options.tag) {
-        if (typeof options.tag !== 'number') {
-            throw new TypeError(`options.tag property in ${name} has to be number or undefined!`);
-        }
-        assertNonNegativeInteger(options.tag, 'options.tag');
-    }
-}
-exports.assertUploadOptions = assertUploadOptions;
-function assertFileUploadOptions(value) {
-    assertUploadOptions(value, 'FileUploadOptions');
-    const options = value;
-    if (options.size) {
-        if (typeof options.size !== 'number') {
-            throw new TypeError('tag property in FileUploadOptions has to be number or undefined!');
-        }
-        assertNonNegativeInteger(options.size, 'options.size');
-    }
-    if (options.contentType && typeof options.contentType !== 'string') {
-        throw new TypeError('contentType property in FileUploadOptions has to be string or undefined!');
-    }
-}
-exports.assertFileUploadOptions = assertFileUploadOptions;
-function assertCollectionUploadOptions(value) {
-    assertUploadOptions(value, 'CollectionUploadOptions');
-    const options = value;
-    if (options.indexDocument && typeof options.indexDocument !== 'string') {
-        throw new TypeError('indexDocument property in CollectionUploadOptions has to be string or undefined!');
-    }
-    if (options.errorDocument && typeof options.errorDocument !== 'string') {
-        throw new TypeError('errorDocument property in CollectionUploadOptions has to be string or undefined!');
-    }
-}
-exports.assertCollectionUploadOptions = assertCollectionUploadOptions;
+function prepareBeeRequestOptions(value) {
+    const object = cafe_utility_1.Types.asObject(value, { name: 'BeeRequestOptions' });
+    return {
+        baseURL: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asString(x, { name: 'baseURL' }), object.baseURL),
+        timeout: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asInteger(x, { name: 'timeout', min: 0 }), object.timeout),
+        headers: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asStringMap(x, { name: 'headers' }), object.headers),
+        onRequest: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asFunction(x, { name: 'onRequest' }), object.onRequest),
+        httpAgent: object.httpAgent,
+        httpsAgent: object.httpsAgent,
+        endlesslyRetry: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asBoolean(x, { name: 'endlesslyRetry' }), object.endlesslyRetry),
+    };
+}
+exports.prepareBeeRequestOptions = prepareBeeRequestOptions;
+function prepareDownloadOptions(value) {
+    const object = cafe_utility_1.Types.asObject(value, { name: 'DownloadOptions' });
+    return {
+        redundancyStrategy: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asInteger(x, { name: 'redundancyStrategy' }), object.redundancyStrategy),
+        fallback: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asBoolean(x, { name: 'fallback' }), object.fallback),
+        timeoutMs: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asInteger(x, { name: 'timeoutMs', min: 0 }), object.timeoutMs),
+        actPublisher: cafe_utility_1.Types.asOptional(x => new typed_bytes_1.PublicKey(x), object.actPublisher),
+        actHistoryAddress: cafe_utility_1.Types.asOptional(x => new typed_bytes_1.Reference(x), object.actHistoryAddress),
+        actTimestamp: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asNumber(x, { name: 'actTimestamp' }), object.actTimestamp),
+    };
+}
+exports.prepareDownloadOptions = prepareDownloadOptions;
+function prepareUploadOptions(value, name = 'UploadOptions') {
+    const object = cafe_utility_1.Types.asObject(value, { name });
+    return {
+        act: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asBoolean(x, { name: 'act' }), object.act),
+        deferred: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asBoolean(x, { name: 'deferred' }), object.deferred),
+        encrypt: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asBoolean(x, { name: 'encrypt' }), object.encrypt),
+        pin: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asBoolean(x, { name: 'pin' }), object.pin),
+        tag: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asInteger(x, { name: 'tag', min: 0 }), object.tag),
+    };
+}
+exports.prepareUploadOptions = prepareUploadOptions;
+function prepareRedundantUploadOptions(value, name = 'UploadOptions') {
+    const uploadOptions = prepareUploadOptions(value, name);
+    const object = cafe_utility_1.Types.asObject(value, { name });
+    return {
+        ...uploadOptions,
+        redundancyLevel: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asInteger(x, { name: 'redundancyLevel', min: 0 }), object.redundancyLevel),
+    };
+}
+exports.prepareRedundantUploadOptions = prepareRedundantUploadOptions;
+function prepareFileUploadOptions(value) {
+    const uploadOptions = prepareUploadOptions(value, 'FileUploadOptions');
+    const object = cafe_utility_1.Types.asObject(value, { name: 'FileUploadOptions' });
+    return {
+        ...uploadOptions,
+        size: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asInteger(x, { name: 'size', min: 0 }), object.size),
+        contentType: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asString(x, { name: 'contentType' }), object.contentType),
+        redundancyLevel: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asInteger(x, { name: 'redundancyLevel', min: 0 }), object.redundancyLevel),
+    };
+}
+exports.prepareFileUploadOptions = prepareFileUploadOptions;
+function prepareCollectionUploadOptions(value) {
+    const uploadOptions = prepareUploadOptions(value, 'CollectionUploadOptions');
+    const object = cafe_utility_1.Types.asObject(value, { name: 'CollectionUploadOptions' });
+    return {
+        ...uploadOptions,
+        errorDocument: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asString(x, { name: 'errorDocument' }), object.errorDocument),
+        indexDocument: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asString(x, { name: 'indexDocument' }), object.indexDocument),
+        redundancyLevel: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asInteger(x, { name: 'redundancyLevel', min: 0 }), object.redundancyLevel),
+    };
+}
+exports.prepareCollectionUploadOptions = prepareCollectionUploadOptions;
 function isTag(value) {
-    if (!isStrictlyObject(value)) {
+    try {
+        const object = cafe_utility_1.Types.asObject(value, { name: 'Tag' });
+        cafe_utility_1.Types.asInteger(object.uid, { name: 'Tag.uid' });
+        return true;
+    }
+    catch {
         return false;
     }
-    return Boolean(value.uid);
 }
 exports.isTag = isTag;
-function assertPssMessageHandler(value) {
+function preparePssMessageHandler(value) {
     const object = cafe_utility_1.Types.asObject(value, { name: 'PssMessageHandler' });
-    cafe_utility_1.Types.asFunction(object.onMessage, { name: 'onMessage' });
-    cafe_utility_1.Types.asFunction(object.onError, { name: 'onError' });
+    return {
+        onMessage: cafe_utility_1.Types.asFunction(object.onMessage, { name: 'onMessage' }),
+        onError: cafe_utility_1.Types.asFunction(object.onError, { name: 'onError' }),
+    };
 }
-exports.assertPssMessageHandler = assertPssMessageHandler;
-function assertGsocMessageHandler(value) {
+exports.preparePssMessageHandler = preparePssMessageHandler;
+function prepareGsocMessageHandler(value) {
     const object = cafe_utility_1.Types.asObject(value, { name: 'GsocMessageHandler' });
-    cafe_utility_1.Types.asFunction(object.onMessage, { name: 'onMessage' });
-    cafe_utility_1.Types.asFunction(object.onError, { name: 'onError' });
-}
-exports.assertGsocMessageHandler = assertGsocMessageHandler;
-function assertPostageBatchOptions(value) {
-    if (value === undefined) {
-        return;
-    }
-    assertStrictlyObject(value);
-    const options = value;
-    assertRequestOptions(options, 'PostageBatchOptions');
-    if (options?.gasPrice) {
-        assertNonNegativeInteger(options.gasPrice);
-    }
-    if (options?.immutableFlag !== undefined) {
-        assertBoolean(options.immutableFlag);
-    }
-    if (options?.waitForUsable !== undefined) {
-        assertBoolean(options.waitForUsable);
-    }
-    if (options?.waitForUsableTimeout !== undefined) {
-        assertNonNegativeInteger(options.waitForUsableTimeout, 'options.waitForUsableTimeout');
-    }
-}
-exports.assertPostageBatchOptions = assertPostageBatchOptions;
-function assertTransactionOptions(value, name = 'TransactionOptions') {
-    if (value === undefined) {
-        return;
-    }
-    assertStrictlyObject(value, name);
-    const options = value;
-    if (options?.gasLimit) {
-        assertNonNegativeInteger(options.gasLimit, name);
-    }
-    if (options?.gasPrice) {
-        assertNonNegativeInteger(options.gasPrice, name);
-    }
-}
-exports.assertTransactionOptions = assertTransactionOptions;
-function assertCashoutOptions(value) {
-    if (value === undefined) {
-        return;
-    }
-    assertStrictlyObject(value);
-    const options = value;
-    assertRequestOptions(options, 'CashoutOptions');
-    assertTransactionOptions(options, 'CashoutOptions');
-}
-exports.assertCashoutOptions = assertCashoutOptions;
+    return {
+        onMessage: cafe_utility_1.Types.asFunction(object.onMessage, { name: 'onMessage' }),
+        onError: cafe_utility_1.Types.asFunction(object.onError, { name: 'onError' }),
+    };
+}
+exports.prepareGsocMessageHandler = prepareGsocMessageHandler;
+function preparePostageBatchOptions(value) {
+    const object = cafe_utility_1.Types.asObject(value, { name: 'PostageBatchOptions' });
+    return {
+        gasPrice: cafe_utility_1.Types.asOptional(x => asNumberString(x, { name: 'gasPrice' }), object.gasPrice),
+        immutableFlag: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asBoolean(x, { name: 'immutableFlag' }), object.immutableFlag),
+        label: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asString(x, { name: 'label' }), object.label),
+        waitForUsable: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asBoolean(x, { name: 'waitForUsable' }), object.waitForUsable),
+        waitForUsableTimeout: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asInteger(x, { name: 'waitForUsableTimeout', min: 0 }), object.waitForUsableTimeout),
+    };
+}
+exports.preparePostageBatchOptions = preparePostageBatchOptions;
+function prepareTransactionOptions(value, name = 'TransactionOptions') {
+    const object = cafe_utility_1.Types.asObject(value, { name });
+    return {
+        gasLimit: cafe_utility_1.Types.asOptional(x => asNumberString(x, { name: 'gasLimit', min: 0n }), object.gasLimit),
+        gasPrice: cafe_utility_1.Types.asOptional(x => asNumberString(x, { name: 'gasPrice', min: 0n }), object.gasPrice),
+    };
+}
+exports.prepareTransactionOptions = prepareTransactionOptions;
 /**
  * Check whether the given parameter is valid data to upload
  * @param value
@@ -226,53 +179,28 @@ exports.assertFileData = assertFileData;
  * Checks whether optional options for AllTags query are valid
  * @param options
  */
-function assertAllTagsOptions(entry) {
-    if (entry !== undefined && !isStrictlyObject(entry)) {
-        throw new TypeError('options has to be an object or undefined!');
-    }
-    assertRequestOptions(entry, 'AllTagsOptions');
-    const options = entry;
-    if (options?.limit !== undefined) {
-        if (typeof options.limit !== 'number') {
-            throw new TypeError('AllTagsOptions.limit has to be a number or undefined!');
-        }
-        if (options.limit < types_1.TAGS_LIMIT_MIN) {
-            throw new error_1.BeeArgumentError(`AllTagsOptions.limit has to be at least ${types_1.TAGS_LIMIT_MIN}`, options.limit);
-        }
-        if (options.limit > types_1.TAGS_LIMIT_MAX) {
-            throw new error_1.BeeArgumentError(`AllTagsOptions.limit has to be at most ${types_1.TAGS_LIMIT_MAX}`, options.limit);
-        }
-    }
-    if (options?.offset !== undefined) {
-        assertNonNegativeInteger(options.offset, 'AllTagsOptions.offset');
-    }
-}
-exports.assertAllTagsOptions = assertAllTagsOptions;
+function prepareAllTagsOptions(value) {
+    const object = cafe_utility_1.Types.asObject(value, { name: 'AllTagsOptions' });
+    return {
+        limit: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asInteger(x, { name: 'limit', min: types_1.TAGS_LIMIT_MIN, max: types_1.TAGS_LIMIT_MAX }), object.limit),
+        offset: cafe_utility_1.Types.asOptional(x => cafe_utility_1.Types.asInteger(x, { name: 'offset', min: 0 }), object.offset),
+    };
+}
+exports.prepareAllTagsOptions = prepareAllTagsOptions;
 /**
  * Utility functions that return Tag UID
  * @param tagUid
  */
 function makeTagUid(tagUid) {
     if (tagUid === undefined || tagUid === null) {
-        throw new TypeError('TagUid was expected but got undefined or null instead!');
+        throw new TypeError(`Expected number | Tag | string from tagUid, got: ${tagUid}`);
     }
     if (isTag(tagUid)) {
         return tagUid.uid;
     }
-    else if (typeof tagUid === 'number') {
-        assertNonNegativeInteger(tagUid, 'UID');
-        return tagUid;
-    }
-    else if (typeof tagUid === 'string') {
-        const int = parseInt(tagUid);
-        if (isNaN(int)) {
-            throw new TypeError('Passed tagUid string is not valid integer!');
-        }
-        if (int < 0) {
-            throw new TypeError(`TagUid was expected to be positive non-negative integer! Got ${int}`);
-        }
-        return int;
+    else if (typeof tagUid === 'number' || typeof tagUid === 'string') {
+        return cafe_utility_1.Types.asNumber(tagUid, { name: 'tagUid', min: 0 });
     }
-    throw new TypeError('tagUid has to be either Tag or a number (UID)!');
+    throw new TypeError(`Expected number | Tag | string from tagUid, got: ${tagUid}`);
 }
 exports.makeTagUid = makeTagUid;