@upcoming/bee-js 0.6.0 → 0.7.0

package/dist/cjs/bee.js

@@ -58,6 +58,7 @@ const collection_node_1 = require("./utils/collection.node");
 const data_1 = require("./utils/data");
 const error_1 = require("./utils/error");
 const file_1 = require("./utils/file");
+const resource_locator_1 = require("./utils/resource-locator");
 const tokens_1 = require("./utils/tokens");
 const type_1 = require("./utils/type");
 const typed_bytes_1 = require("./utils/typed-bytes");
@@ -122,36 +123,34 @@ class Bee {
     /**
      * Download data as a byte array
      *
-     * @param reference Bee data reference in hex string (either 64 or 128 chars long) or ENS domain.
+     * @param resource Swarm reference, Swarm CID, or ENS domain
      * @param options Options that affects the request behavior
      * @throws TypeError if some of the input parameters is not expected type
      * @throws BeeArgumentError if there is passed ENS domain with invalid unicode characters
      * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download)
      * @see [Bee API reference - `GET /bytes`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes~1{reference}/get)
      */
-    async downloadData(reference, options, requestOptions) {
-        reference = new typed_bytes_1.Reference(reference);
+    async downloadData(resource, options, requestOptions) {
         if (options) {
             options = (0, type_1.prepareDownloadOptions)(options);
         }
-        return bytes.download(this.getRequestOptionsForCall(requestOptions), reference, options);
+        return bytes.download(this.getRequestOptionsForCall(requestOptions), new resource_locator_1.ResourceLocator(resource), options);
     }
     /**
      * Download data as a Readable stream
      *
-     * @param reference Bee data reference in hex string (either 64 or 128 chars long) or ENS domain.
+     * @param resource Swarm reference, Swarm CID, or ENS domain
      * @param options Options that affects the request behavior
      * @throws TypeError if some of the input parameters is not expected type
      * @throws BeeArgumentError if there is passed ENS domain with invalid unicode characters
      * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download)
      * @see [Bee API reference - `GET /bytes`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes~1{reference}/get)
      */
-    async downloadReadableData(reference, options, requestOptions) {
-        reference = new typed_bytes_1.Reference(reference);
+    async downloadReadableData(resource, options, requestOptions) {
         if (options) {
             options = (0, type_1.prepareDownloadOptions)(options);
         }
-        return bytes.downloadReadable(this.getRequestOptionsForCall(requestOptions), reference, options);
+        return bytes.downloadReadable(this.getRequestOptionsForCall(requestOptions), new resource_locator_1.ResourceLocator(resource), options);
     }
     /**
      * Upload chunk to a Bee node
@@ -276,7 +275,7 @@ class Bee {
     /**
      * Download single file.
      *
-     * @param reference Bee file reference in hex string (either 64 or 128 chars long), ENS domain or Swarm CID.
+     * @param resource Swarm reference, Swarm CID, or ENS domain
      * @param path If reference points to manifest, then this parameter defines path to the file
      * @param options Options that affects the request behavior
      * @throws TypeError if some of the input parameters is not expected type
@@ -285,12 +284,11 @@ class Bee {
      * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download)
      * @see [Bee API reference - `GET /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz~1%7Breference%7D~1%7Bpath%7D/get)
      */
-    async downloadFile(reference, path = '', options, requestOptions) {
-        reference = new typed_bytes_1.Reference(reference);
+    async downloadFile(resource, path = '', options, requestOptions) {
         if (options) {
             options = (0, type_1.prepareDownloadOptions)(options);
         }
-        return bzz.downloadFile(this.getRequestOptionsForCall(requestOptions), reference, path, options);
+        return bzz.downloadFile(this.getRequestOptionsForCall(requestOptions), new resource_locator_1.ResourceLocator(resource), path, options);
     }
     /**
      * Download single file as a readable stream

package/dist/cjs/modules/bytes.js

@@ -61,14 +61,13 @@ exports.head = head;
  * @param requestOptions Options for making requests
  * @param hash Bee content reference
  */
-async function download(requestOptions, reference, options) {
-    reference = new typed_bytes_1.Reference(reference);
+async function download(requestOptions, resource, options) {
     if (options) {
         options = (0, type_1.prepareDownloadOptions)(options);
     }
     const response = await (0, http_1.http)(requestOptions, {
         responseType: 'arraybuffer',
-        url: `${endpoint}/${reference}`,
+        url: `${endpoint}/${resource}`,
         headers: (0, headers_1.prepareRequestHeaders)(null, options),
     });
     return new bytes_1.Bytes(response.data);
@@ -80,14 +79,13 @@ exports.download = download;
  * @param requestOptions Options for making requests
  * @param hash Bee content reference
  */
-async function downloadReadable(requestOptions, reference, options) {
-    reference = new typed_bytes_1.Reference(reference);
+async function downloadReadable(requestOptions, resource, options) {
     if (options) {
         options = (0, type_1.prepareDownloadOptions)(options);
     }
     const response = await (0, http_1.http)(requestOptions, {
         responseType: 'stream',
-        url: `${endpoint}/${reference}`,
+        url: `${endpoint}/${resource}`,
         headers: (0, headers_1.prepareRequestHeaders)(null, options),
     });
     return response.data;

package/dist/cjs/modules/bzz.js

@@ -51,12 +51,11 @@ exports.uploadFile = uploadFile;
  * @param hash Bee file or collection hash
  * @param path If hash is collection then this defines path to a single file in the collection
  */
-async function downloadFile(requestOptions, reference, path = '', options) {
-    reference = new typed_bytes_1.Reference(reference);
+async function downloadFile(requestOptions, resource, path = '', options) {
     const response = await (0, http_1.http)(requestOptions, {
         method: 'GET',
         responseType: 'arraybuffer',
-        url: `${bzzEndpoint}/${reference}/${path}`,
+        url: `${bzzEndpoint}/${resource}/${path}`,
         headers: (0, headers_1.prepareRequestHeaders)(null, options),
     });
     const file = {

package/dist/cjs/utils/resource-locator.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourceLocator = void 0;
+const cafe_utility_1 = require("cafe-utility");
+const typed_bytes_1 = require("./typed-bytes");
+class ResourceLocator {
+    constructor(raw) {
+        this.raw = raw;
+    }
+    toString() {
+        if (cafe_utility_1.Types.isString(this.raw) && this.raw.includes('.eth')) {
+            return this.raw;
+        }
+        return new typed_bytes_1.Reference(this.raw).toHex();
+    }
+}
+exports.ResourceLocator = ResourceLocator;