@ethersphere/bee-js 7.1.2 → 8.0.1

package/dist/mjs/bee.js

@@ -21,6 +21,7 @@ import * as debugStatus from "./modules/debug/status.js";
 import * as debugTag from "./modules/debug/tag.js";
 import * as transactions from "./modules/debug/transactions.js";
 import { createFeedManifest } from "./modules/feed.js";
+import * as grantee from "./modules/grantee.js";
 import * as pinning from "./modules/pinning.js";
 import * as pss from "./modules/pss.js";
 import * as status from "./modules/status.js";
@@ -150,10 +151,51 @@ export class Bee {
     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) {
+    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) {
+    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/mjs/modules/bytes.js

@@ -24,7 +24,8 @@ export async function upload(requestOptions, data, postageBatchId, options) {
   });
   return {
     reference: response.data.reference,
-    tagUid: response.headers['swarm-tag'] ? makeTagUid(response.headers['swarm-tag']) : undefined
+    tagUid: response.headers['swarm-tag'] ? makeTagUid(response.headers['swarm-tag']) : undefined,
+    historyAddress: response.headers['swarm-act-history-address'] || ''
   };
 }
 /**

package/dist/mjs/modules/bzz.js

@@ -41,7 +41,8 @@ export async function uploadFile(requestOptions, data, postageBatchId, name, opt
   });
   return {
     reference: response.data.reference,
-    tagUid: response.headers['swarm-tag'] ? makeTagUid(response.headers['swarm-tag']) : undefined
+    tagUid: response.headers['swarm-tag'] ? makeTagUid(response.headers['swarm-tag']) : undefined,
+    historyAddress: response.headers['swarm-act-history-address'] || ''
   };
 }
 /**
@@ -106,6 +107,7 @@ export async function uploadCollection(requestOptions, collection, postageBatchI
   const response = await uploadTar(requestOptions, collection, postageBatchId, options);
   return {
     reference: response.data.reference,
-    tagUid: response.headers['swarm-tag'] ? makeTagUid(response.headers['swarm-tag']) : undefined
+    tagUid: response.headers['swarm-tag'] ? makeTagUid(response.headers['swarm-tag']) : undefined,
+    historyAddress: response.headers['swarm-act-history-address'] || ''
   };
 }

package/dist/mjs/modules/chunk.js

@@ -1,6 +1,7 @@
 import { wrapBytesWithHelpers } from "../utils/bytes.js";
 import { extractUploadHeaders } from "../utils/headers.js";
 import { http } from "../utils/http.js";
+import { makeTagUid } from "../utils/type.js";
 const endpoint = 'chunks';
 /**
  * Upload chunk to a Bee node
@@ -25,7 +26,11 @@ export async function upload(requestOptions, data, postageBatchId, options) {
     },
     responseType: 'json'
   });
-  return response.data.reference;
+  return {
+    reference: response.data.reference,
+    tagUid: response.headers['swarm-tag'] ? makeTagUid(response.headers['swarm-tag']) : undefined,
+    historyAddress: response.headers['swarm-act-history-address'] || ''
+  };
 }
 /**
  * Download chunk data as a byte array

package/dist/mjs/modules/grantee.js

@@ -0,0 +1,52 @@
+import { extractRedundantUploadHeaders } from "../utils/headers.js";
+import { http } from "../utils/http.js";
+const granteeEndpoint = 'grantee';
+export async function getGrantees(reference, requestOptions) {
+  const response = await http(requestOptions, {
+    method: 'get',
+    url: `${granteeEndpoint}/${reference}`,
+    responseType: 'json'
+  });
+  return {
+    status: response.status,
+    statusText: response.statusText,
+    data: response.data.data
+  };
+}
+export async function createGrantees(requestOptions, postageBatchId, grantees) {
+  const response = await http(requestOptions, {
+    method: 'post',
+    url: granteeEndpoint,
+    data: {
+      grantees: grantees
+    },
+    headers: {
+      ...extractRedundantUploadHeaders(postageBatchId)
+    },
+    responseType: 'json'
+  });
+  return {
+    status: response.status,
+    statusText: response.statusText,
+    ref: response.data.ref,
+    historyref: response.data.historyref
+  };
+}
+export async function patchGrantees(postageBatchId, reference, historyRef, grantees, requestOptions) {
+  const response = await http(requestOptions, {
+    method: 'patch',
+    url: `${granteeEndpoint}/${reference}`,
+    data: grantees,
+    headers: {
+      ...extractRedundantUploadHeaders(postageBatchId),
+      'swarm-act-history-address': historyRef
+    },
+    responseType: 'json'
+  });
+  return {
+    status: response.status,
+    statusText: response.statusText,
+    ref: response.data.ref,
+    historyref: response.data.historyref
+  };
+}

package/dist/mjs/modules/soc.js

@@ -1,5 +1,6 @@
 import { extractUploadHeaders } from "../utils/headers.js";
 import { http } from "../utils/http.js";
+import { makeTagUid } from "../utils/type.js";
 const socEndpoint = 'soc';
 /**
  * Upload single owner chunk (SOC) to a Bee node
@@ -26,5 +27,9 @@ export async function upload(requestOptions, owner, identifier, signature, data,
       sig: signature
     }
   });
-  return response.data.reference;
+  return {
+    reference: response.data.reference,
+    tagUid: response.headers['swarm-tag'] ? makeTagUid(response.headers['swarm-tag']) : undefined,
+    historyAddress: response.headers['swarm-act-history-address'] || ''
+  };
 }

package/dist/mjs/utils/collection.js

@@ -3,7 +3,7 @@ export function isCollection(data) {
   if (!Array.isArray(data)) {
     return false;
   }
-  return data.every(entry => typeof entry === 'object' && entry.path && entry.size);
+  return data.every(entry => typeof entry === 'object' && entry.path && entry.size !== undefined);
 }
 export function assertCollection(data) {
   if (!isCollection(data)) {

package/dist/mjs/utils/headers.js

@@ -42,6 +42,9 @@ export 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/mjs/utils/http.js

@@ -21,6 +21,13 @@ export async function http(options, config) {
     const requestConfig = Objects.deepMerge3(DEFAULT_HTTP_CONFIG, config, options);
     maybeRunOnRequestHook(options, requestConfig);
     const response = await axios(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;
   } catch (e) {

package/dist/types/bee.d.ts

@@ -2,7 +2,7 @@
 import { Readable } from 'stream';
 import { Index, IndexBytes } from './feed';
 import { FeedType } from './feed/type';
-import type { Address, AddressPrefix, AllSettlements, AnyJson, BalanceResponse, BatchId, BeeOptions, BeeRequestOptions, BeeVersions, ChainState, ChequebookAddressResponse, ChequebookBalanceResponse, CollectionUploadOptions, Data, DebugStatus, ExtendedTag, FeedReader, FeedWriter, FileData, FileUploadOptions, Health, JsonFeedOptions, LastCashoutActionResponse, LastChequesForPeerResponse, LastChequesResponse, NodeAddresses, NodeInfo, NumberString, Peer, PeerBalance, Pin, PingResponse, PostageBatch, PostageBatchBuckets, PssMessageHandler, PssSubscription, PublicKey, RedistributionState, Reference, RemovePeerResponse, ReserveState, SOCReader, SOCWriter, Settlements, Signer, Tag, Topic, Topology, TransactionHash, TransactionInfo, UploadOptions, UploadRedundancyOptions, UploadResultWithCid, WalletBalance } from './types';
+import type { Address, AddressPrefix, AllSettlements, AnyJson, BalanceResponse, BatchId, BeeOptions, BeeRequestOptions, BeeVersions, ChainState, ChequebookAddressResponse, ChequebookBalanceResponse, CollectionUploadOptions, Data, DebugStatus, ExtendedTag, FeedReader, FeedWriter, FileData, FileUploadOptions, GetGranteesResult, GranteesResult, Health, JsonFeedOptions, LastCashoutActionResponse, LastChequesForPeerResponse, LastChequesResponse, NodeAddresses, NodeInfo, NumberString, Peer, PeerBalance, Pin, PingResponse, PostageBatch, PostageBatchBuckets, PssMessageHandler, PssSubscription, PublicKey, RedistributionState, Reference, RemovePeerResponse, ReserveState, SOCReader, SOCWriter, Settlements, Signer, Tag, Topic, Topology, TransactionHash, TransactionInfo, UploadOptions, UploadRedundancyOptions, UploadResultWithCid, WalletBalance } from './types';
 import { AllTagsOptions, CashoutOptions, Collection, FeedManifestResult, PostageBatchOptions, ReferenceCidOrEns, ReferenceOrEns, TransactionOptions, UploadResult } from './types';
 import { EthAddress } from './utils/eth';
 /**
@@ -75,7 +75,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 - `POST /chunks`](https://docs.ethswarm.org/api/#tag/Chunk/paths/~1chunks/post)
      */
-    uploadChunk(postageBatchId: string | BatchId, data: Uint8Array, options?: UploadOptions, requestOptions?: BeeRequestOptions): Promise<Reference>;
+    uploadChunk(postageBatchId: string | BatchId, data: Uint8Array, options?: UploadOptions, requestOptions?: BeeRequestOptions): Promise<UploadResult>;
     /**
      * Download chunk as a byte array
      *
@@ -87,10 +87,43 @@ export declare class Bee {
      * @see [Bee API reference - `GET /chunks`](https://docs.ethswarm.org/api/#tag/Chunk/paths/~1chunks~1{address}/get)
      */
     downloadChunk(reference: ReferenceOrEns | string, options?: BeeRequestOptions): Promise<Data>;
+    /**
+     * 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.
+     */
+    createGrantees(postageBatchId: string | BatchId, grantees: string[], requestOptions?: BeeRequestOptions): Promise<GranteesResult>;
+    /**
+     * 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.
+     */
+    getGrantees(reference: ReferenceOrEns | string, requestOptions?: BeeRequestOptions): Promise<GetGranteesResult>;
+    /**
+     * 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.
+     */
+    patchGrantees(postageBatchId: string | BatchId, reference: Reference | string, history: Reference | string, grantees: {
+        add?: string[];
+        revoke?: string[];
+    }, requestOptions?: BeeRequestOptions): Promise<GranteesResult>;
     /**
      * 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
@@ -431,7 +464,7 @@ export declare class Bee {
      *
      * @see [Bee docs - Feeds](https://docs.ethswarm.org/docs/develop/tools-and-features/feeds)
      */
-    setJsonFeed<T extends AnyJson>(postageBatchId: string | BatchId, topic: string, data: T, options?: JsonFeedOptions, requestOptions?: BeeRequestOptions): Promise<Reference>;
+    setJsonFeed<T extends AnyJson>(postageBatchId: string | BatchId, topic: string, data: T, options?: JsonFeedOptions, requestOptions?: BeeRequestOptions): Promise<UploadResult>;
     /**
      * High-level function that allows you to easily get data from feed.
      * Returned data are parsed using JSON.parse().

package/dist/types/chunk/soc.d.ts

@@ -1,4 +1,4 @@
-import { BatchId, BeeRequestOptions, PlainBytesReference, Reference, Signature, Signer, UploadOptions } from '../types';
+import { BatchId, BeeRequestOptions, PlainBytesReference, Signature, Signer, UploadOptions, UploadResult } from '../types';
 import { Bytes } from '../utils/bytes';
 import { EthAddress } from '../utils/eth';
 import { Chunk } from './cac';
@@ -44,7 +44,7 @@ export declare function makeSingleOwnerChunk(chunk: Chunk, identifier: Identifie
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param options         Upload options
  */
-export declare function uploadSingleOwnerChunk(requestOptions: BeeRequestOptions, chunk: SingleOwnerChunk, postageBatchId: BatchId, options?: UploadOptions): Promise<Reference>;
+export declare function uploadSingleOwnerChunk(requestOptions: BeeRequestOptions, chunk: SingleOwnerChunk, postageBatchId: BatchId, options?: UploadOptions): Promise<UploadResult>;
 /**
  * Helper function to create and upload SOC.
  *
@@ -55,7 +55,7 @@ export declare function uploadSingleOwnerChunk(requestOptions: BeeRequestOptions
  * @param data            The chunk data
  * @param options
  */
-export declare function uploadSingleOwnerChunkData(requestOptions: BeeRequestOptions, signer: Signer, postageBatchId: BatchId | string, identifier: Identifier, data: Uint8Array, options?: UploadOptions): Promise<Reference>;
+export declare function uploadSingleOwnerChunkData(requestOptions: BeeRequestOptions, signer: Signer, postageBatchId: BatchId | string, identifier: Identifier, data: Uint8Array, options?: UploadOptions): Promise<UploadResult>;
 /**
  * Helper function to download SOC.
  *

package/dist/types/feed/index.d.ts

@@ -1,5 +1,5 @@
 import { FeedUpdateOptions } from '../modules/feed';
-import { BatchId, BeeRequestOptions, BytesReference, FEED_INDEX_HEX_LENGTH, FeedReader, FeedWriter, PlainBytesReference, Reference, Signer, Topic, UploadOptions } from '../types';
+import { BatchId, BeeRequestOptions, BytesReference, FEED_INDEX_HEX_LENGTH, FeedReader, FeedWriter, PlainBytesReference, Signer, Topic, UploadOptions, UploadResult } from '../types';
 import { Bytes } from '../utils/bytes';
 import { EthAddress, HexEthAddress } from '../utils/eth';
 import { HexString } from '../utils/hex';
@@ -21,7 +21,7 @@ export interface FeedUpdate {
     reference: BytesReference;
 }
 export declare function findNextIndex(requestOptions: BeeRequestOptions, owner: HexEthAddress, topic: Topic, options?: FeedUpdateOptions): Promise<HexString<typeof FEED_INDEX_HEX_LENGTH>>;
-export declare function updateFeed(requestOptions: BeeRequestOptions, signer: Signer, topic: Topic, reference: BytesReference, postageBatchId: BatchId, options?: FeedUploadOptions): Promise<Reference>;
+export declare function updateFeed(requestOptions: BeeRequestOptions, signer: Signer, topic: Topic, reference: BytesReference, postageBatchId: BatchId, options?: FeedUploadOptions): Promise<UploadResult>;
 export declare function getFeedUpdateChunkReference(owner: EthAddress, topic: Topic, index: Index): PlainBytesReference;
 export declare function downloadFeedUpdate(requestOptions: BeeRequestOptions, owner: EthAddress, topic: Topic, index: Index): Promise<FeedUpdate>;
 export declare function makeFeedReader(requestOptions: BeeRequestOptions, type: FeedType, topic: Topic, owner: HexEthAddress): FeedReader;

package/dist/types/feed/json.d.ts

@@ -1,4 +1,4 @@
 import { Bee } from '../bee';
-import { AnyJson, BatchId, BeeRequestOptions, FeedReader, FeedWriter, JsonFeedOptions, Reference, UploadOptions } from '../types';
+import { AnyJson, BatchId, BeeRequestOptions, FeedReader, FeedWriter, JsonFeedOptions, UploadOptions, UploadResult } from '../types';
 export declare function getJsonData<T extends AnyJson>(bee: Bee, reader: FeedReader): Promise<T>;
-export declare function setJsonData(bee: Bee, writer: FeedWriter, postageBatchId: BatchId, data: AnyJson, options?: JsonFeedOptions & UploadOptions, requestOptions?: BeeRequestOptions): Promise<Reference>;
+export declare function setJsonData(bee: Bee, writer: FeedWriter, postageBatchId: BatchId, data: AnyJson, options?: JsonFeedOptions & UploadOptions, requestOptions?: BeeRequestOptions): Promise<UploadResult>;

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

@@ -1,4 +1,4 @@
-import type { BatchId, BeeRequestOptions, Data, Reference, ReferenceOrEns, UploadOptions } from '../types';
+import type { BatchId, BeeRequestOptions, Data, ReferenceOrEns, UploadOptions, UploadResult } from '../types';
 /**
  * Upload chunk to a Bee node
  *
@@ -11,7 +11,7 @@ import type { BatchId, BeeRequestOptions, Data, Reference, ReferenceOrEns, Uploa
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param options Additional options like tag, encryption, pinning
  */
-export declare function upload(requestOptions: BeeRequestOptions, data: Uint8Array, postageBatchId: BatchId, options?: UploadOptions): Promise<Reference>;
+export declare function upload(requestOptions: BeeRequestOptions, data: Uint8Array, postageBatchId: BatchId, options?: UploadOptions): Promise<UploadResult>;
 /**
  * Download chunk data as a byte array
  *

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

@@ -0,0 +1,7 @@
+import { BatchId, BeeRequestOptions, GetGranteesResult, GranteesResult } from '../types';
+export declare function getGrantees(reference: string, requestOptions: BeeRequestOptions): Promise<GetGranteesResult>;
+export declare function createGrantees(requestOptions: BeeRequestOptions, postageBatchId: BatchId, grantees: string[]): Promise<GranteesResult>;
+export declare function patchGrantees(postageBatchId: BatchId, reference: string, historyRef: string, grantees: {
+    add?: string[];
+    revoke?: string[];
+}, requestOptions: BeeRequestOptions): Promise<GranteesResult>;

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

@@ -1,4 +1,4 @@
-import { BatchId, BeeRequestOptions, Reference, UploadOptions } from '../types';
+import { BatchId, BeeRequestOptions, UploadOptions, UploadResult } from '../types';
 /**
  * Upload single owner chunk (SOC) to a Bee node
  *
@@ -10,4 +10,4 @@ import { BatchId, BeeRequestOptions, Reference, UploadOptions } from '../types';
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param options         Additional options like tag, encryption, pinning
  */
-export declare function upload(requestOptions: BeeRequestOptions, owner: string, identifier: string, signature: string, data: Uint8Array, postageBatchId: BatchId, options?: UploadOptions): Promise<Reference>;
+export declare function upload(requestOptions: BeeRequestOptions, owner: string, identifier: string, signature: string, data: Uint8Array, postageBatchId: BatchId, options?: UploadOptions): Promise<UploadResult>;

package/dist/types/types/index.d.ts

@@ -81,6 +81,17 @@ export interface BeeOptions extends BeeRequestOptions {
      */
     signer?: Signer | Uint8Array | string;
 }
+export interface GranteesResult {
+    status: number;
+    statusText: string;
+    ref: Reference;
+    historyref: Reference;
+}
+export interface GetGranteesResult {
+    status: number;
+    statusText: string;
+    data: string[];
+}
 export interface UploadResultWithCid extends UploadResult {
     /**
      * Function that converts the reference into Swarm CIDs
@@ -102,8 +113,17 @@ export interface UploadResult {
      * Automatically created tag's UID.
      */
     tagUid?: number;
+    /**
+     * History address of the uploaded data with ACT.
+     */
+    historyAddress: string;
 }
 export interface UploadOptions {
+    /**
+     * If set to true, an ACT will be created for the uploaded data.
+     *
+     */
+    act?: boolean;
     /**
      * Will pin the data locally in the Bee node as well.
      *
@@ -216,6 +236,7 @@ export interface CollectionUploadOptions extends UploadOptions {
     errorDocument?: string;
 }
 export interface UploadHeaders {
+    'swarm-act'?: string;
     'swarm-pin'?: string;
     'swarm-encrypt'?: string;
     'swarm-tag'?: string;
@@ -399,9 +420,9 @@ export interface FeedWriter extends FeedReader {
      * @param reference The reference to be stored in the new update
      * @param options   Additional options like `at`
      *
-     * @returns Reference that points at Single Owner Chunk that contains the new update and pointer to the updated chunk reference.
+     * @returns UpdateResult that points at Single Owner Chunk that contains the new update and pointer to the updated chunk reference.
      */
-    upload(postageBatchId: string | BatchId, reference: BytesReference | Reference, options?: FeedUploadOptions): Promise<Reference>;
+    upload(postageBatchId: string | BatchId, reference: BytesReference | Reference, options?: FeedUploadOptions): Promise<UploadResult>;
 }
 /**
  * Interface for downloading single owner chunks
@@ -426,7 +447,7 @@ export interface SOCWriter extends SOCReader {
      * @param data        The chunk payload data
      * @param options     Upload options
      */
-    upload: (postageBatchId: string | BatchId, identifier: Identifier, data: Uint8Array, options?: UploadOptions) => Promise<Reference>;
+    upload: (postageBatchId: string | BatchId, identifier: Identifier, data: Uint8Array, options?: UploadOptions) => Promise<UploadResult>;
 }
 /**
  * Interface representing Postage stamp batch.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethersphere/bee-js",
-  "version": "7.1.2",
+  "version": "8.0.1",
   "description": "Javascript client for Bee",
   "keywords": [
     "bee",