@ethersphere/bee-js 8.2.0 → 8.3.0

package/README.md

@@ -13,7 +13,7 @@
 
 > Write your code in CJS, MJS or TypeScript.
 
-> Intended to be used with Bee version 2.1.0.
+> Intended to be used with Bee version 2.2.0.
 
 ## Quick start
 
@@ -67,6 +67,20 @@ Loading this module through a script tag will make the `BeeJs` object available
 
 ## Usage
 
+### Upload via Swarm Gateway
+
+```js
+import { Bee, NULL_STAMP, SWARM_GATEWAY_URL } from '@ethersphere/bee-js'
+
+main()
+
+async function main() {
+  const bee = new Bee(SWARM_GATEWAY_URL)
+  const { reference } = await bee.uploadData(NULL_STAMP, 'Hello, World!')
+  console.log(reference)
+}
+```
+
 ### Create or select an existing postage batch
 
 Swarm incentivizes nodes in the network to store content, therefor all uploads require a paid
@@ -144,6 +158,18 @@ const bee = new Bee('http://localhost:1633')
 const uploadResult = await bee.uploadFilesFromDirectory(batchId, './path/to/gallery/')
 ```
 
+### Customize http/https agent and headers
+
+```js
+const bee = new Bee('http://localhost:1633', {
+  httpAgent: new http.Agent({ keepAlive: true }),
+  httpsAgent: new https.Agent({ keepAlive: true }),
+  headers: {
+    Authorization: 'Basic ' + Buffer.from('username:password').toString('base64'),
+  },
+})
+```
+
 [**Check out our examples repo for some more ideas on how to use `bee-js`**](https://github.com/ethersphere/examples-js)
 
 ## Documentation

package/dist/cjs/bee.js

@@ -24,7 +24,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Bee = void 0;
-const swarm_cid_1 = require("@ethersphere/swarm-cid");
 const cafe_utility_1 = require("cafe-utility");
 const signer_1 = require("./chunk/signer");
 const soc_1 = require("./chunk/soc");
@@ -89,6 +88,8 @@ class Bee {
             timeout: options?.timeout ?? false,
             headers: options?.headers,
             onRequest: options?.onRequest,
+            httpAgent: options?.httpAgent,
+            httpsAgent: options?.httpsAgent,
         };
     }
     /**
@@ -265,16 +266,16 @@ class Bee {
             const fileName = name ?? data.name;
             const contentType = data.type;
             const fileOptions = { contentType, ...options };
-            return (0, type_2.addCidConversionFunction)(await bzz.uploadFile(this.getRequestOptionsForCall(requestOptions), fileData, postageBatchId, fileName, fileOptions), swarm_cid_1.ReferenceType.MANIFEST);
+            return (0, type_2.addCidConversionFunction)(await bzz.uploadFile(this.getRequestOptionsForCall(requestOptions), fileData, postageBatchId, fileName, fileOptions), 'manifest');
         }
         else if ((0, type_2.isReadable)(data) && options?.tag && !options.size) {
             // TODO: Needed until https://github.com/ethersphere/bee/issues/2317 is resolved
             const result = await bzz.uploadFile(this.getRequestOptionsForCall(requestOptions), data, postageBatchId, name, options);
             await this.updateTag(options.tag, result.reference);
-            return (0, type_2.addCidConversionFunction)(result, swarm_cid_1.ReferenceType.MANIFEST);
+            return (0, type_2.addCidConversionFunction)(result, 'manifest');
         }
         else {
-            return (0, type_2.addCidConversionFunction)(await bzz.uploadFile(this.getRequestOptionsForCall(requestOptions), data, postageBatchId, name, options), swarm_cid_1.ReferenceType.MANIFEST);
+            return (0, type_2.addCidConversionFunction)(await bzz.uploadFile(this.getRequestOptionsForCall(requestOptions), data, postageBatchId, name, options), 'manifest');
         }
     }
     /**
@@ -291,7 +292,7 @@ class Bee {
      */
     async downloadFile(reference, path = '', options) {
         (0, type_2.assertRequestOptions)(options);
-        reference = (0, type_2.makeReferenceOrEns)(reference, swarm_cid_1.ReferenceType.MANIFEST);
+        reference = (0, type_2.makeReferenceOrEns)(reference, 'manifest');
         return bzz.downloadFile(this.getRequestOptionsForCall(options), reference, path);
     }
     /**
@@ -308,7 +309,7 @@ class Bee {
      */
     async downloadReadableFile(reference, path = '', options) {
         (0, type_2.assertRequestOptions)(options);
-        reference = (0, type_2.makeReferenceOrEns)(reference, swarm_cid_1.ReferenceType.MANIFEST);
+        reference = (0, type_2.makeReferenceOrEns)(reference, 'manifest');
         return bzz.downloadFileReadable(this.getRequestOptionsForCall(options), reference, path);
     }
     /**
@@ -334,7 +335,7 @@ class Bee {
             (0, type_2.assertCollectionUploadOptions)(options);
         }
         const data = await (0, collection_1.makeCollectionFromFileList)(fileList);
-        return (0, type_2.addCidConversionFunction)(await bzz.uploadCollection(this.getRequestOptionsForCall(requestOptions), data, postageBatchId, options), swarm_cid_1.ReferenceType.MANIFEST);
+        return (0, type_2.addCidConversionFunction)(await bzz.uploadCollection(this.getRequestOptionsForCall(requestOptions), data, postageBatchId, options), 'manifest');
     }
     /**
      * Upload Collection that you can assembly yourself.
@@ -352,7 +353,7 @@ class Bee {
         (0, collection_1.assertCollection)(collection);
         if (options)
             (0, type_2.assertCollectionUploadOptions)(options);
-        return (0, type_2.addCidConversionFunction)(await bzz.uploadCollection(this.getRequestOptionsForCall(this.requestOptions), collection, postageBatchId, options), swarm_cid_1.ReferenceType.MANIFEST);
+        return (0, type_2.addCidConversionFunction)(await bzz.uploadCollection(this.getRequestOptionsForCall(this.requestOptions), collection, postageBatchId, options), 'manifest');
     }
     /**
      * Upload collection of files.
@@ -376,7 +377,7 @@ class Bee {
         if (options)
             (0, type_2.assertCollectionUploadOptions)(options);
         const data = await (0, collection_node_1.makeCollectionFromFS)(dir);
-        return (0, type_2.addCidConversionFunction)(await bzz.uploadCollection(this.getRequestOptionsForCall(requestOptions), data, postageBatchId, options), swarm_cid_1.ReferenceType.MANIFEST);
+        return (0, type_2.addCidConversionFunction)(await bzz.uploadCollection(this.getRequestOptionsForCall(requestOptions), data, postageBatchId, options), 'manifest');
     }
     /**
      * Create a new Tag which is meant for tracking progres of syncing data across network.
@@ -743,7 +744,7 @@ class Bee {
         const canonicalTopic = (0, topic_1.makeTopic)(topic);
         const canonicalOwner = (0, eth_1.makeHexEthAddress)(owner);
         const reference = await (0, feed_2.createFeedManifest)(this.getRequestOptionsForCall(options), canonicalOwner, canonicalTopic, stamp);
-        return (0, type_2.addCidConversionFunction)({ reference }, swarm_cid_1.ReferenceType.FEED);
+        return (0, type_2.addCidConversionFunction)({ reference }, 'feed');
     }
     /**
      * Make a new feed reader for downloading feed updates.

package/dist/cjs/index.js

@@ -33,5 +33,6 @@ var status_1 = require("./modules/debug/status");
 Object.defineProperty(exports, "SUPPORTED_BEE_VERSION", { enumerable: true, get: function () { return status_1.SUPPORTED_BEE_VERSION; } });
 Object.defineProperty(exports, "SUPPORTED_BEE_VERSION_EXACT", { enumerable: true, get: function () { return status_1.SUPPORTED_BEE_VERSION_EXACT; } });
 __exportStar(require("./types"), exports);
+__exportStar(require("./utils/constants"), exports);
 __exportStar(require("./utils/error"), exports);
 exports.Utils = __importStar(require("./utils/expose"));

package/dist/cjs/modules/grantee.js

@@ -13,7 +13,7 @@ async function getGrantees(reference, requestOptions) {
     return {
         status: response.status,
         statusText: response.statusText,
-        data: response.data.data,
+        data: response.data,
     };
 }
 exports.getGrantees = getGrantees;
@@ -21,7 +21,7 @@ async function createGrantees(requestOptions, postageBatchId, grantees) {
     const response = await (0, http_1.http)(requestOptions, {
         method: 'post',
         url: granteeEndpoint,
-        data: { grantees: grantees },
+        data: { grantees },
         headers: {
             ...(0, headers_1.extractRedundantUploadHeaders)(postageBatchId),
         },

package/dist/cjs/utils/cid.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertCidToReference = exports.convertReferenceToCid = exports.SWARM_FEED_CODEC = exports.SWARM_MANIFEST_CODEC = void 0;
+const cafe_utility_1 = require("cafe-utility");
+exports.SWARM_MANIFEST_CODEC = 0xfa;
+exports.SWARM_FEED_CODEC = 0xfb;
+const CODEC_TABLE = {
+    [exports.SWARM_MANIFEST_CODEC]: 'manifest',
+    [exports.SWARM_FEED_CODEC]: 'feed',
+};
+function convertReferenceToCid(reference, type) {
+    if (reference.length !== 64) {
+        throw TypeError('Only 32-byte, non-encrypted references are supported');
+    }
+    const base32 = 'b';
+    const version = new Uint8Array([1]);
+    const codec = new Uint8Array([type === 'feed' ? exports.SWARM_FEED_CODEC : exports.SWARM_MANIFEST_CODEC]);
+    const unknown = new Uint8Array([1]);
+    const sha256 = new Uint8Array([27]);
+    const size = new Uint8Array([32]);
+    const header = cafe_utility_1.Binary.uint8ArrayToBase32(cafe_utility_1.Binary.concatBytes(version, codec, unknown, sha256, size)).replace(/\=+$/, '');
+    const hash = cafe_utility_1.Binary.uint8ArrayToBase32(cafe_utility_1.Binary.hexToUint8Array(reference)).replace(/\=+$/, '');
+    return `${base32}${header}${hash}`.toLowerCase();
+}
+exports.convertReferenceToCid = convertReferenceToCid;
+function convertCidToReference(cid) {
+    const bytes = cafe_utility_1.Binary.base32ToUint8Array(cid.toUpperCase().slice(1));
+    const codec = bytes[1];
+    if (!CODEC_TABLE[codec]) {
+        throw new Error('Unknown codec');
+    }
+    const reference = bytes.slice(-32);
+    return {
+        type: CODEC_TABLE[codec],
+        reference: cafe_utility_1.Binary.uint8ArrayToHex(reference),
+    };
+}
+exports.convertCidToReference = convertCidToReference;

package/dist/cjs/utils/constants.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NULL_TOPIC = exports.NULL_STAMP = exports.SWARM_GATEWAY_URL = void 0;
+exports.SWARM_GATEWAY_URL = 'https://api.gateway.ethswarm.org';
+exports.NULL_STAMP = '0000000000000000000000000000000000000000000000000000000000000000';
+exports.NULL_TOPIC = '0000000000000000000000000000000000000000000000000000000000000000';

package/dist/cjs/utils/expose.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NULL_TOPIC = exports.NULL_STAMP = exports.getRedundancyStats = exports.getRedundancyStat = exports.approximateOverheadForRedundancyLevel = exports.getStampUsage = exports.getStampTtlSeconds = exports.getStampMaximumCapacityBytes = exports.getStampEffectiveBytes = exports.getStampCostInPlur = exports.getStampCostInBzz = exports.getDepthForCapacity = exports.getAmountForTtl = exports.makeMaxTarget = exports.keccak256Hash = exports.toLittleEndian = exports.makeHexEthAddress = exports.makeEthereumWalletSigner = exports.makeEthAddress = exports.isHexEthAddress = exports.fromLittleEndian = exports.ethToSwarmAddress = exports.capitalizeAddressERC55 = exports.makeHexString = exports.isHexString = exports.intToHex = exports.hexToBytes = exports.bytesToHex = exports.assertPrefixedHexString = exports.assertHexString = exports.isFlexBytes = exports.isBytes = exports.flexBytesAtOffset = exports.bytesEqual = exports.bytesAtOffset = exports.assertFlexBytes = exports.assertBytes = exports.getFolderSize = exports.getCollectionSize = void 0;
+exports.convertReferenceToCid = exports.convertCidToReference = exports.getRedundancyStats = exports.getRedundancyStat = exports.approximateOverheadForRedundancyLevel = exports.getStampUsage = exports.getStampTtlSeconds = exports.getStampMaximumCapacityBytes = exports.getStampEffectiveBytes = exports.getStampCostInPlur = exports.getStampCostInBzz = exports.getDepthForCapacity = exports.getAmountForTtl = exports.makeMaxTarget = exports.keccak256Hash = exports.toLittleEndian = exports.makeHexEthAddress = exports.makeEthereumWalletSigner = exports.makeEthAddress = exports.isHexEthAddress = exports.fromLittleEndian = exports.ethToSwarmAddress = exports.capitalizeAddressERC55 = exports.makeHexString = exports.isHexString = exports.intToHex = exports.hexToBytes = exports.bytesToHex = exports.assertPrefixedHexString = exports.assertHexString = exports.isFlexBytes = exports.isBytes = exports.flexBytesAtOffset = exports.bytesEqual = exports.bytesAtOffset = exports.assertFlexBytes = exports.assertBytes = exports.getFolderSize = exports.getCollectionSize = void 0;
 var collection_1 = require("./collection");
 Object.defineProperty(exports, "getCollectionSize", { enumerable: true, get: function () { return collection_1.getCollectionSize; } });
 var collection_node_1 = require("./collection.node");
@@ -47,5 +47,6 @@ var redundancy_1 = require("./redundancy");
 Object.defineProperty(exports, "approximateOverheadForRedundancyLevel", { enumerable: true, get: function () { return redundancy_1.approximateOverheadForRedundancyLevel; } });
 Object.defineProperty(exports, "getRedundancyStat", { enumerable: true, get: function () { return redundancy_1.getRedundancyStat; } });
 Object.defineProperty(exports, "getRedundancyStats", { enumerable: true, get: function () { return redundancy_1.getRedundancyStats; } });
-exports.NULL_STAMP = '0000000000000000000000000000000000000000000000000000000000000000';
-exports.NULL_TOPIC = '0000000000000000000000000000000000000000000000000000000000000000';
+var cid_1 = require("./cid");
+Object.defineProperty(exports, "convertCidToReference", { enumerable: true, get: function () { return cid_1.convertCidToReference; } });
+Object.defineProperty(exports, "convertReferenceToCid", { enumerable: true, get: function () { return cid_1.convertReferenceToCid; } });

package/dist/cjs/utils/http.js

@@ -25,11 +25,6 @@ async function http(options, config) {
         const requestConfig = cafe_utility_1.Objects.deepMerge3(exports.DEFAULT_HTTP_CONFIG, config, options);
         maybeRunOnRequestHook(options, requestConfig);
         const response = await (0, axios_1.default)(requestConfig);
-        // Axios does not parse array of strings as JSON
-        if (Array.isArray(response.data) && response.data.every(element => typeof element === 'string')) {
-            const array = response.data;
-            response.data = { data: array };
-        }
         // TODO: https://github.com/axios/axios/pull/6253
         return response;
     }

package/dist/cjs/utils/tar.browser.js

@@ -15,6 +15,9 @@ class TarStream {
         });
     }
     beginFile(path, size) {
+        if (path.length > 100) {
+            throw new Error(`File name too long: ${path}`);
+        }
         const header = createHeader(path, size);
         this.pieces.push(header);
         this.currentFileSize = 0;

package/dist/cjs/utils/tar.js

@@ -8,6 +8,9 @@ class TarStream {
         this.currentFileSize = 0;
     }
     beginFile(path, size) {
+        if (path.length > 100) {
+            throw new Error(`File name too long: ${path}`);
+        }
         const header = createHeader(path, size);
         this.output.write(header);
         this.currentFileSize = 0;

package/dist/cjs/utils/type.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.assertTransactionHash = exports.makeTagUid = exports.assertAllTagsOptions = exports.assertFileData = exports.assertData = exports.assertCashoutOptions = exports.assertTransactionOptions = exports.assertPostageBatchOptions = exports.assertPublicKey = exports.assertPssMessageHandler = exports.assertAddressPrefix = exports.assertTag = exports.isTag = exports.assertCollectionUploadOptions = exports.assertFileUploadOptions = exports.assertUploadOptions = exports.assertRequestOptions = exports.assertBatchId = exports.assertAddress = exports.addCidConversionFunction = exports.makeReferenceOrEns = exports.assertReferenceOrEns = exports.assertReference = exports.assertPositiveInteger = exports.assertNonNegativeInteger = exports.assertInteger = exports.assertBoolean = exports.assertStrictlyObject = exports.isError = exports.isStrictlyObject = exports.isObject = exports.isInteger = exports.isReadable = void 0;
-const swarm_cid_1 = require("@ethersphere/swarm-cid");
 const stream_1 = require("stream");
 const types_1 = require("../types");
+const cid_1 = require("./cid");
 const error_1 = require("./error");
 const file_1 = require("./file");
 const hex_1 = require("./hex");
@@ -134,7 +134,7 @@ function makeReferenceOrEns(value, expectedCidType) {
         throw new TypeError('ReferenceCidOrEns has to be a string!');
     }
     try {
-        const result = (0, swarm_cid_1.decodeCid)(value);
+        const result = (0, cid_1.convertCidToReference)(value);
         if (result.type !== expectedCidType) {
             throw new error_1.BeeError(`CID was expected to be of type ${expectedCidType}, but got instead ${result.type ?? 'non-Swarm CID'}`);
         }
@@ -151,13 +151,13 @@ exports.makeReferenceOrEns = makeReferenceOrEns;
 /**
  * Function that adds getter which converts the reference into CID base32 encoded string.
  * @param result
- * @param cidType Type as described in the @ethersphere/swarm-cids-js -> ReferenceType
+ * @param cidType feed or manifest
  */
 function addCidConversionFunction(result, cidType) {
     return {
         ...result,
         cid() {
-            return (0, swarm_cid_1.encodeReference)(result.reference, cidType).toString();
+            return (0, cid_1.convertReferenceToCid)(result.reference, cidType);
         },
     };
 }