@ethersphere/bee-js 12.2.2 → 12.3.0

package/dist/mjs/bee.js

@@ -1,4 +1,5 @@
-import { Binary, Objects, System, Types } from 'cafe-utility';
+import { Binary, Objects, System } from 'cafe-utility';
+import { z } from 'zod';
 import { makeContentAddressedChunk, unmarshalContentAddressedChunk } from "./chunk/cac.js";
 import { downloadSingleOwnerChunk, makeSOCAddress, makeSingleOwnerChunk, unmarshalSingleOwnerChunk, uploadSingleOwnerChunkData } from "./chunk/soc.js";
 import { makeFeedReader, makeFeedWriter } from "./feed/index.js";
@@ -34,9 +35,10 @@ 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 { AllTagsOptionsSchema, BeeRequestOptionsSchema, CollectionUploadOptionsSchema, DownloadOptionsSchema, FileUploadOptionsSchema, GsocMessageHandlerSchema, PostageBatchOptionsSchema, PssMessageHandlerSchema, RedundantUploadOptionsSchema, TransactionOptionsSchema, UploadOptionsSchema } from "./utils/schema.js";
 import { getAmountForDuration, getDepthForSize, getStampCost, getStampDuration } from "./utils/stamps.js";
 import { BZZ, DAI } 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 { asNumberString, assertData, assertFileData, makeTagUid } from "./utils/type.js";
 import { BatchId, EthAddress, Identifier, PeerAddress, PrivateKey, PublicKey, Reference, Signature, Span, Topic, TransactionId } from "./utils/typed-bytes.js";
 import { assertBeeUrl, stripLastSlash } from "./utils/url.js";
 /**
@@ -90,7 +92,7 @@ export class Bee {
     postageBatchId = new BatchId(postageBatchId);
     assertData(data);
     if (options) {
-      options = prepareRedundantUploadOptions(options);
+      options = RedundantUploadOptionsSchema.parse(options);
     }
     return bytes.upload(this.getRequestOptionsForCall(requestOptions), data, postageBatchId, options);
   }
@@ -126,7 +128,7 @@ export class Bee {
    */
   async downloadData(resource, options, requestOptions) {
     if (options) {
-      options = prepareDownloadOptions(options);
+      options = DownloadOptionsSchema.parse(options);
     }
     return bytes.download(this.getRequestOptionsForCall(requestOptions), new ResourceLocator(resource), options);
   }
@@ -148,7 +150,7 @@ export class Bee {
    */
   async downloadReadableData(resource, options, requestOptions) {
     if (options) {
-      options = prepareDownloadOptions(options);
+      options = DownloadOptionsSchema.parse(options);
     }
     return bytes.downloadReadable(this.getRequestOptionsForCall(requestOptions), new ResourceLocator(resource), options);
   }
@@ -170,7 +172,7 @@ export class Bee {
     const isSOC = 'identifier' in data && 'signature' in data && 'owner' in data;
     data = data instanceof Uint8Array ? data : data.data;
     if (options) {
-      options = prepareUploadOptions(options);
+      options = UploadOptionsSchema.parse(options);
     }
     if (data.length < Span.LENGTH) {
       throw new BeeArgumentError(`Chunk has to have size of at least ${Span.LENGTH}.`, data);
@@ -201,7 +203,7 @@ export class Bee {
   async downloadChunk(reference, options, requestOptions) {
     reference = new Reference(reference);
     if (options) {
-      options = prepareDownloadOptions(options);
+      options = DownloadOptionsSchema.parse(options);
     }
     return chunk.download(this.getRequestOptionsForCall(requestOptions), reference, options);
   }
@@ -274,7 +276,7 @@ export class Bee {
     postageBatchId = new BatchId(postageBatchId);
     assertFileData(data);
     if (options) {
-      options = prepareFileUploadOptions(options);
+      options = FileUploadOptionsSchema.parse(options);
     }
     if (name && typeof name !== 'string') {
       throw new TypeError('name has to be string or undefined!');
@@ -284,8 +286,8 @@ export class Bee {
       const fileName = name ?? data.name;
       const contentType = data.type;
       const fileOptions = {
-        contentType,
-        ...options
+        ...options,
+        contentType
       };
       return bzz.uploadFile(this.getRequestOptionsForCall(requestOptions), fileData, postageBatchId, fileName, fileOptions);
     } else {
@@ -305,7 +307,7 @@ export class Bee {
    */
   async downloadFile(resource, path = '', options, requestOptions) {
     if (options) {
-      options = prepareDownloadOptions(options);
+      options = DownloadOptionsSchema.parse(options);
     }
     return bzz.downloadFile(this.getRequestOptionsForCall(requestOptions), new ResourceLocator(resource), path, options);
   }
@@ -323,7 +325,7 @@ export class Bee {
   async downloadReadableFile(reference, path = '', options, requestOptions) {
     reference = new Reference(reference);
     if (options) {
-      options = prepareDownloadOptions(options);
+      options = DownloadOptionsSchema.parse(options);
     }
     return bzz.downloadFileReadable(this.getRequestOptionsForCall(requestOptions), reference, path, options);
   }
@@ -347,7 +349,7 @@ export class Bee {
   async uploadFiles(postageBatchId, fileList, options, requestOptions) {
     postageBatchId = new BatchId(postageBatchId);
     if (options) {
-      options = prepareCollectionUploadOptions(options);
+      options = CollectionUploadOptionsSchema.parse(options);
     }
     const data = makeCollectionFromFileList(fileList);
     return bzz.uploadCollection(this.getRequestOptionsForCall(requestOptions), data, postageBatchId, options);
@@ -421,7 +423,7 @@ export class Bee {
     postageBatchId = new BatchId(postageBatchId);
     assertCollection(collection);
     if (options) {
-      options = prepareCollectionUploadOptions(options);
+      options = CollectionUploadOptionsSchema.parse(options);
     }
     return bzz.uploadCollection(this.getRequestOptionsForCall(requestOptions), collection, postageBatchId, options);
   }
@@ -444,7 +446,7 @@ export class Bee {
   async uploadFilesFromDirectory(postageBatchId, dir, options, requestOptions) {
     postageBatchId = new BatchId(postageBatchId);
     if (options) {
-      options = prepareCollectionUploadOptions(options);
+      options = CollectionUploadOptionsSchema.parse(options);
     }
     const data = await makeCollectionFromFS(dir);
     return bzz.uploadCollection(this.getRequestOptionsForCall(requestOptions), data, postageBatchId, options);
@@ -473,7 +475,7 @@ export class Bee {
    */
   async getAllTags(options, requestOptions) {
     if (options) {
-      options = prepareAllTagsOptions(options);
+      options = AllTagsOptionsSchema.parse(options);
     }
     return tag.getAllTags(this.getRequestOptionsForCall(requestOptions), options?.offset, options?.limit);
   }
@@ -614,7 +616,7 @@ export class Bee {
     owner = new EthAddress(owner);
     topic = new Topic(topic);
     if (options) {
-      options = prepareDownloadOptions(options);
+      options = DownloadOptionsSchema.parse(options);
     }
     if (!index) {
       try {
@@ -674,7 +676,7 @@ export class Bee {
    * @see [Bee API reference - `GET /pss`](https://docs.ethswarm.org/api/#tag/Postal-Service-for-Swarm/paths/~1pss~1subscribe~1{topic}/get)
    */
   pssSubscribe(topic, handler) {
-    handler = preparePssMessageHandler(handler);
+    handler = PssMessageHandlerSchema.parse(handler);
     const ws = pss.subscribe(this.url, topic, this.requestOptions.headers);
     let cancelled = false;
     const cancel = () => {
@@ -851,7 +853,7 @@ export class Bee {
   gsocSubscribe(address, identifier, handler) {
     address = new EthAddress(address);
     identifier = new Identifier(identifier);
-    handler = prepareGsocMessageHandler(handler);
+    handler = GsocMessageHandlerSchema.parse(handler);
     const socAddress = makeSOCAddress(identifier, address);
     const ws = gsoc.subscribe(this.url, socAddress, this.requestOptions.headers);
     let cancelled = false;
@@ -904,7 +906,7 @@ export class Bee {
     topic = new Topic(topic);
     owner = new EthAddress(owner);
     if (options) {
-      options = prepareUploadOptions(options);
+      options = UploadOptionsSchema.parse(options);
     }
     return createFeedManifest(this.getRequestOptionsForCall(requestOptions), owner, topic, postageBatchId, options);
   }
@@ -1273,7 +1275,7 @@ export class Bee {
   async cashoutLastCheque(address, options, requestOptions) {
     address = new PeerAddress(address);
     if (options) {
-      prepareTransactionOptions(options);
+      options = TransactionOptionsSchema.parse(options);
     }
     return chequebook.cashoutLastCheque(this.getRequestOptionsForCall(requestOptions), address, options);
   }
@@ -1502,7 +1504,7 @@ export class Bee {
       name: 'amount'
     });
     if (options) {
-      options = preparePostageBatchOptions(options);
+      options = PostageBatchOptionsSchema.parse(options);
     }
     if (depth < STAMPS_DEPTH_MIN || depth > STAMPS_DEPTH_MAX) {
       throw new BeeArgumentError(`Depth has to be between ${STAMPS_DEPTH_MIN}..${STAMPS_DEPTH_MAX}`, depth);
@@ -1540,7 +1542,7 @@ export class Bee {
     const amount = getAmountForDuration(duration, chainState.currentPrice, this.network === 'gnosis' ? 5 : 15);
     const depth = getDepthForSize(size, encryption, erasureCodeLevel);
     if (options) {
-      options = preparePostageBatchOptions(options);
+      options = PostageBatchOptionsSchema.parse(options);
     }
     return this.createPostageBatch(amount, depth, options, requestOptions);
   }
@@ -1736,6 +1738,27 @@ export class Bee {
     const amount = getAmountForDuration(duration, chainState.currentPrice, this.network === 'gnosis' ? 5 : 15);
     return getStampCost(batch.depth, amount);
   }
+  /**
+   * Updates the label of a certain postage batch.
+   *
+   * @param postageBatchId Batch ID of the postage batch to update.
+   * @param label New label for the postage batch.
+   * @param requestOptions Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
+   */
+  async updatePostageBatchLabel(postageBatchId, label, requestOptions) {
+    postageBatchId = new BatchId(postageBatchId);
+    return stamps.updatePostageBatchLabel(this.getRequestOptionsForCall(requestOptions), postageBatchId, label);
+  }
+  /**
+   * Renames a storage. This is a convenience method that calls {@link updatePostageBatchLabel}.
+   *
+   * @param postageBatchId Batch ID of the postage batch to update.
+   * @param newName New name for the storage.
+   * @param requestOptions Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
+   */
+  async renameStorage(postageBatchId, newLabel, requestOptions) {
+    return this.updatePostageBatchLabel(postageBatchId, newLabel, requestOptions);
+  }
   /**
    * Calculates the `amount` and expected duration extension for topping up a postage batch with a given BZZ value.
    *
@@ -1812,11 +1835,7 @@ export class Bee {
    */
   async diluteBatch(postageBatchId, depth, requestOptions) {
     postageBatchId = new BatchId(postageBatchId);
-    depth = Types.asNumber(depth, {
-      name: 'depth',
-      min: 18,
-      max: 255
-    });
+    depth = z.number().int().min(18).max(255).parse(depth);
     return stamps.diluteBatch(this.getRequestOptionsForCall(requestOptions), postageBatchId, depth);
   }
   /**
@@ -1834,6 +1853,16 @@ export class Bee {
     postageBatchId = new BatchId(postageBatchId);
     return stamps.getPostageBatch(this.getRequestOptionsForCall(requestOptions), postageBatchId, encryption, erasureCodeLevel);
   }
+  /**
+   * Returns details for specific globally available postage batch.
+   *
+   * @param postageBatchId Batch ID
+   * @param requestOptions Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
+   */
+  async getGlobalPostageBatch(postageBatchId, requestOptions) {
+    postageBatchId = new BatchId(postageBatchId);
+    return stamps.getGlobalPostageBatch(this.getRequestOptionsForCall(requestOptions), postageBatchId);
+  }
   /**
    * Return detailed information related to buckets for specific postage batch.
    *
@@ -1987,7 +2016,7 @@ export class Bee {
       name: 'amount'
     });
     if (options) {
-      options = prepareTransactionOptions(options);
+      options = TransactionOptionsSchema.parse(options);
     }
     return stake.stake(this.getRequestOptionsForCall(requestOptions), amountString, options);
   }
@@ -2018,7 +2047,7 @@ export class Bee {
   }
   getRequestOptionsForCall(requestOptions) {
     if (requestOptions) {
-      requestOptions = prepareBeeRequestOptions(requestOptions);
+      requestOptions = BeeRequestOptionsSchema.parse(requestOptions);
     }
     return requestOptions ? Objects.deepMerge2(this.requestOptions, requestOptions) : this.requestOptions;
   }

package/dist/mjs/chunk/cac.js

@@ -1,4 +1,5 @@
-import { Binary, Types } from 'cafe-utility';
+import { Binary } from 'cafe-utility';
+import { z } from 'zod';
 import { Bytes } from "../utils/bytes.js";
 import { Span } from "../utils/typed-bytes.js";
 import { calculateChunkAddress } from "./bmt.js";
@@ -10,8 +11,9 @@ export function unmarshalContentAddressedChunk(data) {
   return makeContentAddressedChunk(data.toUint8Array().slice(Span.LENGTH), Span.fromSlice(data.toUint8Array(), 0));
 }
 export function makeContentAddressedChunk(rawPayload, span) {
-  if (Types.isString(rawPayload)) {
-    rawPayload = Bytes.fromUtf8(rawPayload);
+  const asString = z.string().safeParse(rawPayload);
+  if (asString.success) {
+    rawPayload = Bytes.fromUtf8(asString.data);
   }
   if (rawPayload.length < MIN_PAYLOAD_SIZE || rawPayload.length > MAX_PAYLOAD_SIZE) {
     throw new RangeError(`payload size ${rawPayload.length} exceeds limits [${MIN_PAYLOAD_SIZE}, ${MAX_PAYLOAD_SIZE}]`);

package/dist/mjs/feed/index.js

@@ -1,4 +1,5 @@
-import { Binary, Optional, Types } from 'cafe-utility';
+import { Binary, Optional } from 'cafe-utility';
+import { z } from 'zod';
 import { makeContentAddressedChunk, unmarshalContentAddressedChunk } from "../chunk/cac.js";
 import { unmarshalSingleOwnerChunk, uploadSingleOwnerChunkData, uploadSingleOwnerChunkWithWrappedChunk } from "../chunk/soc.js";
 import * as bytes from "../modules/bytes.js";
@@ -43,7 +44,8 @@ export async function updateFeedWithPayload(requestOptions, signer, topic, data,
     const rootChunk = unmarshalContentAddressedChunk(await chunkAPI.download(requestOptions, uploadResult.reference));
     return uploadSingleOwnerChunkWithWrappedChunk(requestOptions, signer, postageBatchId, identifier, rootChunk, options);
   }
-  return uploadSingleOwnerChunkData(requestOptions, signer, postageBatchId, identifier, Types.isString(data) ? Bytes.fromUtf8(data).toUint8Array() : data, options);
+  const dataString = z.string().safeParse(data);
+  return uploadSingleOwnerChunkData(requestOptions, signer, postageBatchId, identifier, dataString.success ? Bytes.fromUtf8(dataString.data).toUint8Array() : data, options);
 }
 export function getFeedUpdateChunkReference(owner, topic, index) {
   const identifier = makeFeedIdentifier(topic, index);

package/dist/mjs/modules/bytes.js

@@ -1,8 +1,10 @@
-import { Optional, Types } from 'cafe-utility';
+import { Optional } from 'cafe-utility';
+import { UploadResultBody } from "../types/schema/upload.js";
 import { Bytes } from "../utils/bytes.js";
 import { prepareRequestHeaders } from "../utils/headers.js";
 import { http } from "../utils/http.js";
-import { makeTagUid, prepareDownloadOptions } from "../utils/type.js";
+import { DownloadOptionsSchema } from "../utils/schema.js";
+import { makeTagUid } from "../utils/type.js";
 import { Reference } from "../utils/typed-bytes.js";
 const endpoint = 'bytes';
 /**
@@ -24,11 +26,9 @@ export async function upload(requestOptions, data, postageBatchId, options) {
       ...prepareRequestHeaders(postageBatchId, options)
     }
   });
-  const body = Types.asObject(response.data, {
-    name: 'response.data'
-  });
+  const body = UploadResultBody.parse(response.data);
   return {
-    reference: new Reference(Types.asHexString(body.reference)),
+    reference: body.reference,
     tagUid: response.headers['swarm-tag'] ? makeTagUid(response.headers['swarm-tag']) : undefined,
     historyAddress: response.headers['swarm-act-history-address'] ? Optional.of(new Reference(response.headers['swarm-act-history-address'])) : Optional.empty()
   };
@@ -58,7 +58,7 @@ export async function head(requestOptions, reference) {
  */
 export async function download(requestOptions, resource, options) {
   if (options) {
-    options = prepareDownloadOptions(options);
+    options = DownloadOptionsSchema.parse(options);
   }
   const response = await http(requestOptions, {
     responseType: 'arraybuffer',
@@ -75,7 +75,7 @@ export async function download(requestOptions, resource, options) {
  */
 export async function downloadReadable(requestOptions, resource, options) {
   if (options) {
-    options = prepareDownloadOptions(options);
+    options = DownloadOptionsSchema.parse(options);
   }
   const response = await http(requestOptions, {
     responseType: 'stream',

package/dist/mjs/modules/bzz.js

@@ -1,4 +1,5 @@
-import { Optional, Types } from 'cafe-utility';
+import { Optional } from 'cafe-utility';
+import { UploadResultBody } from "../types/schema/upload.js";
 import { Bytes } from "../utils/bytes.js";
 import { assertCollection } from "../utils/collection.js";
 import { prepareRequestHeaders, readFileHeaders } from "../utils/headers.js";
@@ -33,11 +34,9 @@ export async function uploadFile(requestOptions, data, postageBatchId, name, opt
     },
     responseType: 'json'
   });
-  const body = Types.asObject(response.data, {
-    name: 'response.data'
-  });
+  const body = UploadResultBody.parse(response.data);
   return {
-    reference: new Reference(Types.asHexString(body.reference)),
+    reference: body.reference,
     tagUid: response.headers['swarm-tag'] ? makeTagUid(response.headers['swarm-tag']) : undefined,
     historyAddress: response.headers['swarm-act-history-address'] ? Optional.of(new Reference(response.headers['swarm-act-history-address'])) : Optional.empty()
   };
@@ -95,11 +94,9 @@ export async function downloadFileReadable(requestOptions, reference, path = '',
 export async function uploadCollection(requestOptions, collection, postageBatchId, options) {
   assertCollection(collection);
   const response = await uploadTar(requestOptions, collection, postageBatchId, options);
-  const body = Types.asObject(response.data, {
-    name: 'response.data'
-  });
+  const body = UploadResultBody.parse(response.data);
   return {
-    reference: new Reference(Types.asHexString(body.reference)),
+    reference: body.reference,
     tagUid: response.headers['swarm-tag'] ? makeTagUid(response.headers['swarm-tag']) : undefined,
     historyAddress: response.headers['swarm-act-history-address'] ? Optional.of(new Reference(response.headers['swarm-act-history-address'])) : Optional.empty()
   };

package/dist/mjs/modules/chunk.js

@@ -1,4 +1,5 @@
-import { Optional, Types } from 'cafe-utility';
+import { Optional } from 'cafe-utility';
+import { UploadResultBody } from "../types/schema/upload.js";
 import { prepareRequestHeaders } from "../utils/headers.js";
 import { http } from "../utils/http.js";
 import { makeTagUid } from "../utils/type.js";
@@ -27,13 +28,9 @@ export async function upload(requestOptions, data, stamp, options) {
     },
     responseType: 'json'
   });
-  const body = Types.asObject(response.data, {
-    name: 'response.data'
-  });
+  const body = UploadResultBody.parse(response.data);
   return {
-    reference: new Reference(Types.asString(body.reference, {
-      name: 'reference'
-    })),
+    reference: body.reference,
     tagUid: response.headers['swarm-tag'] ? makeTagUid(response.headers['swarm-tag']) : undefined,
     historyAddress: response.headers['swarm-act-history-address'] ? Optional.of(new Reference(response.headers['swarm-act-history-address'])) : Optional.empty()
   };

package/dist/mjs/modules/debug/balance.js

@@ -1,7 +1,5 @@
-import { Types } from 'cafe-utility';
+import { GetAllBalancesResponse, GetPeerBalanceResponse } from "../../types/schema/balance.js";
 import { http } from "../../utils/http.js";
-import { BZZ } from "../../utils/tokens.js";
-import { asNumberString } from "../../utils/type.js";
 const balancesEndpoint = 'balances';
 const consumedEndpoint = 'consumed';
 /**
@@ -14,24 +12,7 @@ export async function getAllBalances(requestOptions) {
     url: balancesEndpoint,
     responseType: 'json'
   });
-  const body = Types.asObject(response.data, {
-    name: 'response.data'
-  });
-  const balances = Types.asArray(body.balances, {
-    name: 'balances'
-  }).map(x => Types.asObject(x, {
-    name: 'balance'
-  }));
-  return {
-    balances: balances.map(x => ({
-      peer: Types.asString(x.peer, {
-        name: 'peer'
-      }),
-      balance: BZZ.fromPLUR(asNumberString(x.balance, {
-        name: 'balance'
-      }))
-    }))
-  };
+  return GetAllBalancesResponse.parse(response.data);
 }
 /**
  * Get the balances with a specific peer including prepaid services
@@ -44,17 +25,7 @@ export async function getPeerBalance(requestOptions, address) {
     url: `${balancesEndpoint}/${address}`,
     responseType: 'json'
   });
-  const body = Types.asObject(response.data, {
-    name: 'response.data'
-  });
-  return {
-    peer: Types.asString(body.peer, {
-      name: 'peer'
-    }),
-    balance: BZZ.fromPLUR(asNumberString(body.balance, {
-      name: 'balance'
-    }))
-  };
+  return GetPeerBalanceResponse.parse(response.data);
 }
 /**
  * Get the past due consumption balances with all known peers
@@ -66,24 +37,7 @@ export async function getPastDueConsumptionBalances(requestOptions) {
     url: consumedEndpoint,
     responseType: 'json'
   });
-  const body = Types.asObject(response.data, {
-    name: 'response.data'
-  });
-  const balances = Types.asArray(body.balances, {
-    name: 'balances'
-  }).map(x => Types.asObject(x, {
-    name: 'balance'
-  }));
-  return {
-    balances: balances.map(x => ({
-      peer: Types.asString(x.peer, {
-        name: 'peer'
-      }),
-      balance: BZZ.fromPLUR(asNumberString(x.balance, {
-        name: 'balance'
-      }))
-    }))
-  };
+  return GetAllBalancesResponse.parse(response.data);
 }
 /**
  * Get the past due consumption balance with a specific peer
@@ -96,15 +50,5 @@ export async function getPastDueConsumptionPeerBalance(requestOptions, address)
     url: `${consumedEndpoint}/${address}`,
     responseType: 'json'
   });
-  const body = Types.asObject(response.data, {
-    name: 'response.data'
-  });
-  return {
-    peer: Types.asString(body.peer, {
-      name: 'peer'
-    }),
-    balance: BZZ.fromPLUR(asNumberString(body.balance, {
-      name: 'balance'
-    }))
-  };
+  return GetPeerBalanceResponse.parse(response.data);
 }