@ethersphere/bee-js 7.1.2 → 8.0.0

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;
     }