@ethersphere/bee-js 7.1.1 → 8.0.0

package/README.md

@@ -15,6 +15,22 @@
 
 > Intended to be used with Bee version 2.1.0.
 
+## Quick start
+
+Start a Swarm project using TypeScript:
+
+```sh
+npm init swarm-app@latest my-dapp node-ts
+```
+
+or using Vite and TypeScript:
+
+```sh
+npm init swarm-app@latest my-dapp vite-tsx
+```
+
+Supported types are `node`, `node-esm`, `node-ts` and `vite-tsx`. Replace `my-dapp` with your project name.
+
 ## Install
 
 ```sh

package/dist/cjs/bee.js

@@ -47,6 +47,7 @@ const debugStatus = __importStar(require("./modules/debug/status"));
 const debugTag = __importStar(require("./modules/debug/tag"));
 const transactions = __importStar(require("./modules/debug/transactions"));
 const feed_2 = require("./modules/feed");
+const grantee = __importStar(require("./modules/grantee"));
 const pinning = __importStar(require("./modules/pinning"));
 const pss = __importStar(require("./modules/pss"));
 const status = __importStar(require("./modules/status"));
@@ -178,10 +179,48 @@ class Bee {
         (0, type_2.assertReferenceOrEns)(reference);
         return chunk.download(this.getRequestOptionsForCall(options), reference);
     }
+    /**
+     * Create a grantees list from the given array of public keys.
+     *
+     * The grantees list can be obtained with the `getGrantees` method.
+     *
+     * @param postageBatchId - The ID of the postage batch.
+     * @param grantees - An array of public keys representing the grantees.
+     * @param requestOptions - Optional request options.
+     * @returns A promise that resolves to a `GranteesResult` object.
+     */
+    async createGrantees(postageBatchId, grantees, requestOptions) {
+        (0, type_2.assertBatchId)(postageBatchId);
+        return grantee.createGrantees(this.getRequestOptionsForCall(requestOptions), postageBatchId, grantees);
+    }
+    /**
+     * Retrieves the grantees for a given reference.
+     *
+     * @param reference - The reference.
+     * @param requestOptions - Optional request options.
+     * @returns A promise that resolves to a `GetGranteesResult` object.
+     */
+    async getGrantees(reference, requestOptions) {
+        return grantee.getGrantees(reference, this.getRequestOptionsForCall(requestOptions));
+    }
+    /**
+     * Updates the grantees of a specific reference and history.
+     *
+     * @param reference - The reference.
+     * @param history - The history.
+     * @param postageBatchId - The ID of the postage batch.
+     * @param grantees - The grantees.
+     * @param requestOptions - Optional request options.
+     * @returns A Promise that resolves to to a `GranteesResult` object.
+     */
+    async patchGrantees(postageBatchId, reference, history, grantees, requestOptions) {
+        (0, type_2.assertBatchId)(postageBatchId);
+        return grantee.patchGrantees(postageBatchId, reference, history, { add: grantees.add || [], revoke: grantees.revoke || [] }, this.getRequestOptionsForCall(requestOptions));
+    }
     /**
      * Upload single file to a Bee node.
      *
-     * **To make sure that you won't loose critical data it is highly recommended to also
+     * **To make sure that you won't lose critical data it is highly recommended to also
      * locally pin the data with `options.pin = true`**
      *
      * @param postageBatchId Postage BatchId to be used to upload the data with

package/dist/cjs/modules/bytes.js

@@ -28,6 +28,7 @@ async function upload(requestOptions, data, postageBatchId, options) {
     return {
         reference: response.data.reference,
         tagUid: response.headers['swarm-tag'] ? (0, type_1.makeTagUid)(response.headers['swarm-tag']) : undefined,
+        historyAddress: response.headers['swarm-act-history-address'] || '',
     };
 }
 exports.upload = upload;

package/dist/cjs/modules/bzz.js

@@ -45,6 +45,7 @@ async function uploadFile(requestOptions, data, postageBatchId, name, options) {
     return {
         reference: response.data.reference,
         tagUid: response.headers['swarm-tag'] ? (0, type_1.makeTagUid)(response.headers['swarm-tag']) : undefined,
+        historyAddress: response.headers['swarm-act-history-address'] || '',
     };
 }
 exports.uploadFile = uploadFile;
@@ -114,6 +115,7 @@ async function uploadCollection(requestOptions, collection, postageBatchId, opti
     return {
         reference: response.data.reference,
         tagUid: response.headers['swarm-tag'] ? (0, type_1.makeTagUid)(response.headers['swarm-tag']) : undefined,
+        historyAddress: response.headers['swarm-act-history-address'] || '',
     };
 }
 exports.uploadCollection = uploadCollection;

package/dist/cjs/modules/chunk.js

@@ -4,6 +4,7 @@ exports.download = exports.upload = void 0;
 const bytes_1 = require("../utils/bytes");
 const headers_1 = require("../utils/headers");
 const http_1 = require("../utils/http");
+const type_1 = require("../utils/type");
 const endpoint = 'chunks';
 /**
  * Upload chunk to a Bee node
@@ -28,7 +29,11 @@ async function upload(requestOptions, data, postageBatchId, options) {
         },
         responseType: 'json',
     });
-    return response.data.reference;
+    return {
+        reference: response.data.reference,
+        tagUid: response.headers['swarm-tag'] ? (0, type_1.makeTagUid)(response.headers['swarm-tag']) : undefined,
+        historyAddress: response.headers['swarm-act-history-address'] || '',
+    };
 }
 exports.upload = upload;
 /**

package/dist/cjs/modules/grantee.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.patchGrantees = exports.createGrantees = exports.getGrantees = void 0;
+const headers_1 = require("../utils/headers");
+const http_1 = require("../utils/http");
+const granteeEndpoint = 'grantee';
+async function getGrantees(reference, requestOptions) {
+    const response = await (0, http_1.http)(requestOptions, {
+        method: 'get',
+        url: `${granteeEndpoint}/${reference}`,
+        responseType: 'json',
+    });
+    return {
+        status: response.status,
+        statusText: response.statusText,
+        data: response.data.data,
+    };
+}
+exports.getGrantees = getGrantees;
+async function createGrantees(requestOptions, postageBatchId, grantees) {
+    const response = await (0, http_1.http)(requestOptions, {
+        method: 'post',
+        url: granteeEndpoint,
+        data: { grantees: grantees },
+        headers: {
+            ...(0, headers_1.extractRedundantUploadHeaders)(postageBatchId),
+        },
+        responseType: 'json',
+    });
+    return {
+        status: response.status,
+        statusText: response.statusText,
+        ref: response.data.ref,
+        historyref: response.data.historyref,
+    };
+}
+exports.createGrantees = createGrantees;
+async function patchGrantees(postageBatchId, reference, historyRef, grantees, requestOptions) {
+    const response = await (0, http_1.http)(requestOptions, {
+        method: 'patch',
+        url: `${granteeEndpoint}/${reference}`,
+        data: grantees,
+        headers: {
+            ...(0, headers_1.extractRedundantUploadHeaders)(postageBatchId),
+            'swarm-act-history-address': historyRef,
+        },
+        responseType: 'json',
+    });
+    return {
+        status: response.status,
+        statusText: response.statusText,
+        ref: response.data.ref,
+        historyref: response.data.historyref,
+    };
+}
+exports.patchGrantees = patchGrantees;

package/dist/cjs/modules/soc.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.upload = void 0;
 const headers_1 = require("../utils/headers");
 const http_1 = require("../utils/http");
+const type_1 = require("../utils/type");
 const socEndpoint = 'soc';
 /**
  * Upload single owner chunk (SOC) to a Bee node
@@ -27,6 +28,10 @@ async function upload(requestOptions, owner, identifier, signature, data, postag
         responseType: 'json',
         params: { sig: signature },
     });
-    return response.data.reference;
+    return {
+        reference: response.data.reference,
+        tagUid: response.headers['swarm-tag'] ? (0, type_1.makeTagUid)(response.headers['swarm-tag']) : undefined,
+        historyAddress: response.headers['swarm-act-history-address'] || '',
+    };
 }
 exports.upload = upload;

package/dist/cjs/utils/headers.js

@@ -46,6 +46,9 @@ function extractUploadHeaders(postageBatchId, options) {
     const headers = {
         'swarm-postage-batch-id': postageBatchId,
     };
+    if (options?.act) {
+        headers['swarm-act'] = String(options.act);
+    }
     if (options?.pin) {
         headers['swarm-pin'] = String(options.pin);
     }

package/dist/cjs/utils/http.js

@@ -25,6 +25,11 @@ 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-writer.browser.js

@@ -5,7 +5,7 @@ const file_1 = require("./file");
 async function writeTar(collection, tarStream) {
     for (const item of collection) {
         if (item.file) {
-            await tarStream.beginFile(item.path, item.file.size);
+            tarStream.beginFile(item.path, item.file.size);
             await tarStream.appendFile(new Uint8Array(await (0, file_1.fileArrayBuffer)(item.file)));
             await tarStream.endFile();
         }

package/dist/cjs/utils/tar-writer.js

@@ -4,7 +4,7 @@ exports.writeTar = void 0;
 const fs_1 = require("fs");
 async function writeTar(collection, tarStream) {
     for (const item of collection) {
-        await tarStream.beginFile(item.path, item.size);
+        tarStream.beginFile(item.path, item.size);
         if (item.fsPath) {
             const stream = (0, fs_1.createReadStream)(item.fsPath);
             for await (const chunk of stream) {

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

@@ -14,7 +14,7 @@ class TarStream {
             return newAcc;
         });
     }
-    async beginFile(path, size) {
+    beginFile(path, size) {
         const header = createHeader(path, size);
         this.pieces.push(header);
         this.currentFileSize = 0;
@@ -24,8 +24,10 @@ class TarStream {
         this.currentFileSize += data.length;
     }
     async endFile() {
-        const padding = 512 - (this.currentFileSize % 512);
-        this.pieces.push(new Uint8Array(padding));
+        const padding = this.currentFileSize % 512 === 0 ? 0 : 512 - (this.currentFileSize % 512);
+        if (padding > 0) {
+            this.pieces.push(new Uint8Array(padding));
+        }
     }
     async end() {
         this.pieces.push(createEndOfArchive());
@@ -33,30 +35,37 @@ class TarStream {
 }
 exports.TarStream = TarStream;
 function createHeader(path, size) {
-    const header = new Uint8Array(512); // Initialize header with zeros
     const encoder = new TextEncoder();
     function writeToBuffer(str, offset, length) {
         const bytes = encoder.encode(str);
         header.set(bytes.slice(0, length), offset);
     }
-    writeToBuffer(path, 0, 100); // File name
-    writeToBuffer('0000777', 100, 8); // File mode
-    writeToBuffer('0001750', 108, 8); // UID
-    writeToBuffer('0001750', 116, 8); // GID
-    writeToBuffer(size.toString(8).padStart(11, '0') + ' ', 124, 12); // File size
-    writeToBuffer(Math.floor(Date.now() / 1000).toString(8) + ' ', 136, 12); // Mod time
-    writeToBuffer('        ', 148, 8); // Checksum placeholder
-    writeToBuffer('0', 156, 1); // Typeflag
-    writeToBuffer('ustar  ', 257, 8); // Magic and version
-    for (let i = 345; i < 512; i++) {
-        header[i] = 0; // Fill remaining with zeros
-    }
+    // Initialize header with zeros
+    const header = new Uint8Array();
+    header.fill(0, 0, 512);
+    // File name, truncated to 100 characters if necessary
+    writeToBuffer(path.slice(0, 100).padEnd(100, '\0'), 0, 100);
+    // File mode (octal) and null-terminated
+    writeToBuffer('0000777\0', 100, 8);
+    // UID and GID (octal) and null-terminated
+    writeToBuffer('0001750\0', 108, 8); // UID
+    writeToBuffer('0001750\0', 116, 8); // GID
+    // File size in octal (11 chars) and null-terminated
+    writeToBuffer(size.toString(8).padStart(11, '0') + '\0', 124, 12);
+    // Modification time in octal and null-terminated
+    const modTime = Math.floor(new Date().getTime() / 1000);
+    writeToBuffer(modTime.toString(8).padStart(11, '0') + '\0', 136, 12);
+    // Checksum placeholder (8 spaces)
+    writeToBuffer('        ', 148, 8);
+    // Typeflag (normal file)
+    writeToBuffer('0', 156, 1);
+    // USTAR magic and version
+    writeToBuffer('ustar\0\0', 257, 8);
     // Calculate checksum
     let checksum = 0;
     for (let i = 0; i < 512; i++) {
         checksum += header[i];
     }
-    // Write checksum
     writeToBuffer(checksum.toString(8).padStart(6, '0') + '\0 ', 148, 8);
     return header;
 }

package/dist/cjs/utils/tar.js

@@ -7,43 +7,67 @@ class TarStream {
         this.output = new stream_1.PassThrough();
         this.currentFileSize = 0;
     }
-    async beginFile(path, size) {
+    beginFile(path, size) {
         const header = createHeader(path, size);
         this.output.write(header);
         this.currentFileSize = 0;
     }
     async appendFile(data) {
         return new Promise(resolve => {
-            this.output.write(data, () => {
+            if (!this.output.write(data)) {
+                this.output.once('drain', () => {
+                    resolve();
+                });
+            }
+            else {
                 resolve();
-            });
+            }
             this.currentFileSize += data.length;
         });
     }
     async endFile() {
-        const padding = 512 - (this.currentFileSize % 512);
-        this.output.write(Buffer.alloc(padding, 0));
+        const padding = this.currentFileSize % 512 === 0 ? 0 : 512 - (this.currentFileSize % 512);
+        if (padding > 0) {
+            this.output.write(Buffer.alloc(padding, 0));
+        }
     }
     async end() {
-        this.output.write(createEndOfArchive());
-        this.output.end();
+        return new Promise(resolve => {
+            this.output.write(createEndOfArchive());
+            this.output.end(() => {
+                resolve();
+            });
+        });
     }
 }
 exports.TarStream = TarStream;
 function createHeader(path, size) {
-    const header = Buffer.alloc(512, 0); // Initialize header with zeros
-    header.write(path, 0, 100); // File name
-    header.write('0000777', 100, 8); // File mode
-    header.write('0001750', 108, 8); // UID
-    header.write('0001750', 116, 8); // GID
-    header.write(size.toString(8).padStart(11, '0') + ' ', 124, 12); // File size
-    header.write(Math.floor(new Date().getTime() / 1000).toString(8) + ' ', 136, 12); // Mod time
-    header.write('        ', 148, 8); // Checksum placeholder
-    header.write('0', 156, 1); // Typeflag
-    header.write('ustar  ', 257, 8); // Magic and version
-    header.write('0'.repeat(8 * 12), 345, 8 * 12); // Fill remaining with zeros
-    const checksum = header.reduce((sum, elem) => sum + elem, 0);
-    header.write(checksum.toString(8).padStart(6, '0') + '\0 ', 148, 8); // Write checksum
+    // Initialize header with zeros
+    const header = Buffer.alloc(512, 0);
+    // File name, truncated to 100 characters if necessary
+    header.write(path.slice(0, 100).padEnd(100, '\0'), 0, 100);
+    // File mode (octal) and null-terminated
+    header.write('0000777\0', 100, 8);
+    // UID and GID (octal) and null-terminated
+    header.write('0001750\0', 108, 8); // UID
+    header.write('0001750\0', 116, 8); // GID
+    // File size in octal (11 chars) and null-terminated
+    header.write(size.toString(8).padStart(11, '0') + '\0', 124, 12);
+    // Modification time in octal and null-terminated
+    const modTime = Math.floor(new Date().getTime() / 1000);
+    header.write(modTime.toString(8).padStart(11, '0') + '\0', 136, 12);
+    // Checksum placeholder (8 spaces)
+    header.write('        ', 148, 8);
+    // Typeflag (normal file)
+    header.write('0', 156, 1);
+    // USTAR magic and version
+    header.write('ustar\0\0', 257, 8);
+    // Calculate checksum
+    let checksum = 0;
+    for (let i = 0; i < 512; i++) {
+        checksum += header[i];
+    }
+    header.write(checksum.toString(8).padStart(6, '0') + '\0 ', 148, 8);
     return header;
 }
 function createEndOfArchive() {