@upcoming/bee-js 0.5.5 → 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
@@ -824,6 +822,11 @@ class Bee {
         }
         return (0, feed_1.makeFeedWriter)(this.getRequestOptionsForCall(options), topic, signer);
     }
+    async fetchLatestFeedUpdate(topic, owner, requestOptions) {
+        topic = new typed_bytes_1.Topic(topic);
+        owner = new typed_bytes_1.EthAddress(owner);
+        return (0, feed_2.fetchLatestFeedUpdate)(this.getRequestOptionsForCall(requestOptions), owner, topic);
+    }
     /**
      * Returns an object for reading single owner chunks
      *

package/dist/cjs/manifest/manifest.js

@@ -102,6 +102,9 @@ class MantarayNode {
     get fullPathString() {
         return DECODER.decode(this.fullPath);
     }
+    /**
+     * Returns the metadata at the `/` path to access idiomatic properties.
+     */
     getRootMetadata() {
         const node = this.find('/');
         if (node && node.metadata) {
@@ -109,6 +112,34 @@ class MantarayNode {
         }
         return cafe_utility_1.Optional.empty();
     }
+    /**
+     * Returns the `swarm-index-document` and `swarm-error-document` metadata values.
+     */
+    getDocsMetadata() {
+        const node = this.find('/');
+        if (!node || !node.metadata) {
+            return { indexDocument: null, errorDocument: null };
+        }
+        return {
+            indexDocument: node.metadata['website-index-document'] ?? null,
+            errorDocument: node.metadata['website-error-document'] ?? null,
+        };
+    }
+    /**
+     * Attempts to resolve the manifest as a feed, returning the latest update.
+     */
+    async resolveFeed(bee, requestOptions) {
+        const node = this.find('/');
+        if (!node || !node.metadata) {
+            return cafe_utility_1.Optional.empty();
+        }
+        const owner = node.metadata['swarm-feed-owner'];
+        const topic = node.metadata['swarm-feed-topic'];
+        return cafe_utility_1.Optional.of(await bee.fetchLatestFeedUpdate(topic, owner, requestOptions));
+    }
+    /**
+     * Gets the binary representation of the node.
+     */
     async marshal() {
         for (const fork of this.forks.values()) {
             if (!fork.node.selfAddress) {
@@ -135,8 +166,21 @@ class MantarayNode {
             : this.targetAddress, forkBitmap, ...forks), this.obfuscationKey);
         return cafe_utility_1.Binary.concatBytes(this.obfuscationKey, data);
     }
+    /**
+     * Downloads and unmarshals a MantarayNode from the given reference.
+     *
+     * Do not forget calling `loadRecursively` on the returned node to load the entire tree.
+     */
     static async unmarshal(bee, reference, options, requestOptions) {
         const data = (await bee.downloadData(reference, options, requestOptions)).toUint8Array();
+        return this.unmarshalFromData(data);
+    }
+    /**
+     * Unmarshals a MantarayNode from the given data.
+     *
+     * Do not forget calling `loadRecursively` on the returned node to load the entire tree.
+     */
+    static unmarshalFromData(data) {
         const obfuscationKey = data.subarray(0, 32);
         const decrypted = cafe_utility_1.Binary.xorCypher(data.subarray(32), obfuscationKey);
         const reader = new cafe_utility_1.Uint8ArrayReader(decrypted);
@@ -157,6 +201,9 @@ class MantarayNode {
         }
         return node;
     }
+    /**
+     * Adds a fork to the node.
+     */
     addFork(path, reference, metadata) {
         this.selfAddress = null;
         path = path instanceof Uint8Array ? path : ENCODER.encode(path);
@@ -196,6 +243,9 @@ class MantarayNode {
             }
         }
     }
+    /**
+     * Removes a fork from the node.
+     */
     removeFork(path) {
         this.selfAddress = null;
         path = path instanceof Uint8Array ? path : ENCODER.encode(path);
@@ -212,12 +262,18 @@ class MantarayNode {
             parent.addFork(cafe_utility_1.Binary.concatBytes(match.path, fork.prefix), fork.node.targetAddress, fork.node.metadata);
         }
     }
+    /**
+     * Calculates the self address of the node.
+     */
     async calculateSelfAddress() {
         if (this.selfAddress) {
             return new typed_bytes_1.Reference(this.selfAddress);
         }
         return new typed_bytes_1.Reference((await cafe_utility_1.MerkleTree.root(await this.marshal())).hash());
     }
+    /**
+     * Saves the node and its children recursively.
+     */
     async saveRecursively(bee, postageBatchId, options, requestOptions) {
         for (const fork of this.forks.values()) {
             await fork.node.saveRecursively(bee, postageBatchId, options, requestOptions);
@@ -226,6 +282,9 @@ class MantarayNode {
         this.selfAddress = result.reference.toUint8Array();
         return result;
     }
+    /**
+     * Loads the node and its children recursively.
+     */
     async loadRecursively(bee, options, requestOptions) {
         for (const fork of this.forks.values()) {
             const node = await MantarayNode.unmarshal(bee, fork.node.targetAddress, options, requestOptions);
@@ -236,10 +295,16 @@ class MantarayNode {
             await fork.node.loadRecursively(bee, options, requestOptions);
         }
     }
+    /**
+     * Finds a node in the tree by its path.
+     */
     find(path) {
         const [closest, match] = this.findClosest(path);
         return match.length === path.length ? closest : null;
     }
+    /**
+     * Finds the closest node in the tree to the given path.
+     */
     findClosest(path, current = new Uint8Array()) {
         path = path instanceof Uint8Array ? path : ENCODER.encode(path);
         if (path.length === 0) {
@@ -251,6 +316,11 @@ class MantarayNode {
         }
         return [this, current];
     }
+    /**
+     * Returns an array of all nodes in the tree which have a target address set.
+     *
+     * Must be called after `loadRecursively`.
+     */
     collect(nodes = []) {
         for (const fork of this.forks.values()) {
             if (!cafe_utility_1.Binary.equals(fork.node.targetAddress, __1.NULL_ADDRESS)) {
@@ -260,6 +330,19 @@ class MantarayNode {
         }
         return nodes;
     }
+    /**
+     * Returns a path:reference map of all nodes in the tree which have a target address set.
+     *
+     * Must be called after `loadRecursively`.
+     */
+    collectAndMap() {
+        const nodes = this.collect();
+        const result = {};
+        for (const node of nodes) {
+            result[node.fullPathString] = new typed_bytes_1.Reference(node.targetAddress).toHex();
+        }
+        return result;
+    }
     determineType() {
         let type = 0;
         if (!cafe_utility_1.Binary.equals(this.targetAddress, __1.NULL_ADDRESS) || cafe_utility_1.Binary.equals(this.path, PATH_SEPARATOR)) {

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;