@upcoming/bee-js 0.6.0 → 0.7.0

package/dist/mjs/bee.js

@@ -32,6 +32,7 @@ import { makeCollectionFromFS } from "./utils/collection.node.js";
 import { prepareWebsocketData } from "./utils/data.js";
 import { BeeArgumentError, BeeError } from "./utils/error.js";
 import { fileArrayBuffer, isFile } from "./utils/file.js";
+import { ResourceLocator } from "./utils/resource-locator.js";
 import { BZZ } from "./utils/tokens.js";
 import { asNumberString, assertData, assertFileData, makeTagUid, prepareAllTagsOptions, prepareBeeRequestOptions, prepareCollectionUploadOptions, prepareDownloadOptions, prepareFileUploadOptions, prepareGsocMessageHandler, preparePostageBatchOptions, preparePssMessageHandler, prepareRedundantUploadOptions, prepareTransactionOptions, prepareUploadOptions } from "./utils/type.js";
 import { BatchId, EthAddress, Identifier, PeerAddress, PrivateKey, PublicKey, Reference, Span, Topic, TransactionId } from "./utils/typed-bytes.js";
@@ -96,36 +97,34 @@ export 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 Reference(reference);
+  async downloadData(resource, options, requestOptions) {
     if (options) {
       options = prepareDownloadOptions(options);
     }
-    return bytes.download(this.getRequestOptionsForCall(requestOptions), reference, options);
+    return bytes.download(this.getRequestOptionsForCall(requestOptions), new 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 Reference(reference);
+  async downloadReadableData(resource, options, requestOptions) {
     if (options) {
       options = prepareDownloadOptions(options);
     }
-    return bytes.downloadReadable(this.getRequestOptionsForCall(requestOptions), reference, options);
+    return bytes.downloadReadable(this.getRequestOptionsForCall(requestOptions), new ResourceLocator(resource), options);
   }
   /**
    * Upload chunk to a Bee node
@@ -252,7 +251,7 @@ export 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
@@ -261,12 +260,11 @@ export 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 Reference(reference);
+  async downloadFile(resource, path = '', options, requestOptions) {
     if (options) {
       options = prepareDownloadOptions(options);
     }
-    return bzz.downloadFile(this.getRequestOptionsForCall(requestOptions), reference, path, options);
+    return bzz.downloadFile(this.getRequestOptionsForCall(requestOptions), new ResourceLocator(resource), path, options);
   }
   /**
    * Download single file as a readable stream

package/dist/mjs/modules/bytes.js

@@ -56,14 +56,13 @@ export async function head(requestOptions, reference) {
  * @param requestOptions Options for making requests
  * @param hash Bee content reference
  */
-export async function download(requestOptions, reference, options) {
-  reference = new Reference(reference);
+export async function download(requestOptions, resource, options) {
   if (options) {
     options = prepareDownloadOptions(options);
   }
   const response = await http(requestOptions, {
     responseType: 'arraybuffer',
-    url: `${endpoint}/${reference}`,
+    url: `${endpoint}/${resource}`,
     headers: prepareRequestHeaders(null, options)
   });
   return new Bytes(response.data);
@@ -74,14 +73,13 @@ export async function download(requestOptions, reference, options) {
  * @param requestOptions Options for making requests
  * @param hash Bee content reference
  */
-export async function downloadReadable(requestOptions, reference, options) {
-  reference = new Reference(reference);
+export async function downloadReadable(requestOptions, resource, options) {
   if (options) {
     options = prepareDownloadOptions(options);
   }
   const response = await http(requestOptions, {
     responseType: 'stream',
-    url: `${endpoint}/${reference}`,
+    url: `${endpoint}/${resource}`,
     headers: prepareRequestHeaders(null, options)
   });
   return response.data;

package/dist/mjs/modules/bzz.js

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

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

@@ -0,0 +1,13 @@
+import { Types } from 'cafe-utility';
+import { Reference } from "./typed-bytes.js";
+export class ResourceLocator {
+  constructor(raw) {
+    this.raw = raw;
+  }
+  toString() {
+    if (Types.isString(this.raw) && this.raw.includes('.eth')) {
+      return this.raw;
+    }
+    return new Reference(this.raw).toHex();
+  }
+}

package/dist/types/bee.d.ts

@@ -54,25 +54,25 @@ export declare 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)
      */
-    downloadData(reference: Reference | string | Uint8Array, options?: DownloadOptions, requestOptions?: BeeRequestOptions): Promise<Bytes>;
+    downloadData(resource: Reference | string | Uint8Array, options?: DownloadOptions, requestOptions?: BeeRequestOptions): Promise<Bytes>;
     /**
      * 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)
      */
-    downloadReadableData(reference: Reference | Uint8Array | string, options?: DownloadOptions, requestOptions?: BeeRequestOptions): Promise<ReadableStream<Uint8Array>>;
+    downloadReadableData(resource: Reference | Uint8Array | string, options?: DownloadOptions, requestOptions?: BeeRequestOptions): Promise<ReadableStream<Uint8Array>>;
     /**
      * Upload chunk to a Bee node
      *
@@ -146,7 +146,7 @@ export declare 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
@@ -155,7 +155,7 @@ export declare 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)
      */
-    downloadFile(reference: Reference | Uint8Array | string, path?: string, options?: DownloadOptions, requestOptions?: BeeRequestOptions): Promise<FileData<Bytes>>;
+    downloadFile(resource: Reference | Uint8Array | string, path?: string, options?: DownloadOptions, requestOptions?: BeeRequestOptions): Promise<FileData<Bytes>>;
     /**
      * Download single file as a readable stream
      *

package/dist/types/modules/bytes.d.ts

@@ -1,6 +1,7 @@
 import type { BeeRequestOptions, DownloadOptions, RedundantUploadOptions, ReferenceInformation } from '../types';
 import { UploadResult } from '../types';
 import { Bytes } from '../utils/bytes';
+import { ResourceLocator } from '../utils/resource-locator';
 import { BatchId, Reference } from '../utils/typed-bytes';
 /**
  * Upload data to a Bee node
@@ -24,11 +25,11 @@ export declare function head(requestOptions: BeeRequestOptions, reference: Refer
  * @param requestOptions Options for making requests
  * @param hash Bee content reference
  */
-export declare function download(requestOptions: BeeRequestOptions, reference: Reference | Uint8Array | string, options?: DownloadOptions): Promise<Bytes>;
+export declare function download(requestOptions: BeeRequestOptions, resource: ResourceLocator, options?: DownloadOptions): Promise<Bytes>;
 /**
  * Download data as a readable stream
  *
  * @param requestOptions Options for making requests
  * @param hash Bee content reference
  */
-export declare function downloadReadable(requestOptions: BeeRequestOptions, reference: Reference | Uint8Array | string, options?: DownloadOptions): Promise<ReadableStream<Uint8Array>>;
+export declare function downloadReadable(requestOptions: BeeRequestOptions, resource: ResourceLocator, options?: DownloadOptions): Promise<ReadableStream<Uint8Array>>;

package/dist/types/modules/bzz.d.ts

@@ -2,6 +2,7 @@
 import { Readable } from 'stream';
 import { BeeRequestOptions, Collection, CollectionUploadOptions, DownloadOptions, FileData, FileUploadOptions, UploadResult } from '../types';
 import { Bytes } from '../utils/bytes';
+import { ResourceLocator } from '../utils/resource-locator';
 import { BatchId, Reference } from '../utils/typed-bytes';
 /**
  * Upload single file
@@ -20,7 +21,7 @@ export declare function uploadFile(requestOptions: BeeRequestOptions, data: stri
  * @param hash Bee file or collection hash
  * @param path If hash is collection then this defines path to a single file in the collection
  */
-export declare function downloadFile(requestOptions: BeeRequestOptions, reference: Reference | string | Uint8Array, path?: string, options?: DownloadOptions): Promise<FileData<Bytes>>;
+export declare function downloadFile(requestOptions: BeeRequestOptions, resource: ResourceLocator, path?: string, options?: DownloadOptions): Promise<FileData<Bytes>>;
 /**
  * Download single file as a readable stream
  *

package/dist/types/utils/resource-locator.d.ts

@@ -0,0 +1,6 @@
+import { Reference } from './typed-bytes';
+export declare class ResourceLocator {
+    private raw;
+    constructor(raw: Reference | Uint8Array | string);
+    toString(): string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@upcoming/bee-js",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Javascript client for Bee",
   "keywords": [
     "bee",