@upcoming/bee-js 0.4.0 → 0.5.0

package/dist/mjs/feed/retrievable.js

@@ -9,9 +9,9 @@ import { getFeedUpdateChunkReference } from "./index.js";
  * @param ref
  * @param options
  */
-async function isChunkRetrievable(bee, reference, requestOptions) {
+async function isChunkRetrievable(bee, reference, options, requestOptions) {
   try {
-    await bee.downloadChunk(reference, requestOptions);
+    await bee.downloadChunk(reference, options, requestOptions);
     return true;
   } catch (e) {
     const status = Objects.getDeep(e, 'status');
@@ -36,7 +36,7 @@ function getAllSequenceUpdateReferences(owner, topic, index) {
   }
   return updateReferences;
 }
-export async function areAllSequentialFeedsUpdateRetrievable(bee, owner, topic, index, requestOptions) {
-  const chunkRetrievablePromises = getAllSequenceUpdateReferences(owner, topic, index).map(async reference => isChunkRetrievable(bee, reference, requestOptions));
+export async function areAllSequentialFeedsUpdateRetrievable(bee, owner, topic, index, options, requestOptions) {
+  const chunkRetrievablePromises = getAllSequenceUpdateReferences(owner, topic, index).map(async reference => isChunkRetrievable(bee, reference, options, requestOptions));
   return (await Promise.all(chunkRetrievablePromises)).every(result => result);
 }

package/dist/mjs/modules/bytes.js

@@ -1,8 +1,8 @@
-import { Types } from 'cafe-utility';
+import { Optional, Types } from 'cafe-utility';
 import { Bytes } from "../utils/bytes.js";
-import { extractDownloadHeaders, extractRedundantUploadHeaders } from "../utils/headers.js";
+import { prepareRequestHeaders } from "../utils/headers.js";
 import { http } from "../utils/http.js";
-import { makeTagUid } from "../utils/type.js";
+import { makeTagUid, prepareDownloadOptions } from "../utils/type.js";
 import { Reference } from "../utils/typed-bytes.js";
 const endpoint = 'bytes';
 /**
@@ -21,7 +21,7 @@ export async function upload(requestOptions, data, postageBatchId, options) {
     data,
     headers: {
       'content-type': 'application/octet-stream',
-      ...extractRedundantUploadHeaders(postageBatchId, options)
+      ...prepareRequestHeaders(postageBatchId, options)
     }
   });
   const body = Types.asObject(response.data, {
@@ -30,7 +30,7 @@ export async function upload(requestOptions, data, postageBatchId, options) {
   return {
     reference: new Reference(Types.asHexString(body.reference)),
     tagUid: response.headers['swarm-tag'] ? makeTagUid(response.headers['swarm-tag']) : undefined,
-    historyAddress: response.headers['swarm-act-history-address'] || ''
+    historyAddress: response.headers['swarm-act-history-address'] ? Optional.of(new Reference(response.headers['swarm-act-history-address'])) : Optional.empty()
   };
 }
 /**
@@ -58,10 +58,13 @@ export async function head(requestOptions, reference) {
  */
 export async function download(requestOptions, reference, options) {
   reference = new Reference(reference);
+  if (options) {
+    options = prepareDownloadOptions(options);
+  }
   const response = await http(requestOptions, {
     responseType: 'arraybuffer',
     url: `${endpoint}/${reference}`,
-    headers: extractDownloadHeaders(options)
+    headers: prepareRequestHeaders(null, options)
   });
   return new Bytes(response.data);
 }
@@ -73,10 +76,13 @@ export async function download(requestOptions, reference, options) {
  */
 export async function downloadReadable(requestOptions, reference, options) {
   reference = new Reference(reference);
+  if (options) {
+    options = prepareDownloadOptions(options);
+  }
   const response = await http(requestOptions, {
     responseType: 'stream',
     url: `${endpoint}/${reference}`,
-    headers: extractDownloadHeaders(options)
+    headers: prepareRequestHeaders(null, options)
   });
   return response.data;
 }

package/dist/mjs/modules/bzz.js

@@ -1,18 +1,12 @@
-import { Types } from 'cafe-utility';
+import { Optional, Types } from 'cafe-utility';
 import { Bytes } from "../utils/bytes.js";
 import { assertCollection } from "../utils/collection.js";
-import { extractDownloadHeaders, extractRedundantUploadHeaders, readFileHeaders } from "../utils/headers.js";
+import { prepareRequestHeaders, readFileHeaders } from "../utils/headers.js";
 import { http } from "../utils/http.js";
 import { uploadTar } from "../utils/tar-uploader.js";
 import { isReadable, makeTagUid } from "../utils/type.js";
 import { Reference } from "../utils/typed-bytes.js";
 const bzzEndpoint = 'bzz';
-function extractFileUploadHeaders(postageBatchId, options) {
-  const headers = extractRedundantUploadHeaders(postageBatchId, options);
-  if (options?.size) headers['content-length'] = String(options.size);
-  if (options?.contentType) headers['content-type'] = options.contentType;
-  return headers;
-}
 /**
  * Upload single file
  *
@@ -33,9 +27,7 @@ export async function uploadFile(requestOptions, data, postageBatchId, name, opt
     method: 'post',
     url: bzzEndpoint,
     data,
-    headers: {
-      ...extractFileUploadHeaders(postageBatchId, options)
-    },
+    headers: prepareRequestHeaders(postageBatchId, options),
     params: {
       name
     },
@@ -47,7 +39,7 @@ export async function uploadFile(requestOptions, data, postageBatchId, name, opt
   return {
     reference: new Reference(Types.asHexString(body.reference)),
     tagUid: response.headers['swarm-tag'] ? makeTagUid(response.headers['swarm-tag']) : undefined,
-    historyAddress: response.headers['swarm-act-history-address'] || ''
+    historyAddress: response.headers['swarm-act-history-address'] ? Optional.of(new Reference(response.headers['swarm-act-history-address'])) : Optional.empty()
   };
 }
 /**
@@ -63,7 +55,7 @@ export async function downloadFile(requestOptions, reference, path = '', options
     method: 'GET',
     responseType: 'arraybuffer',
     url: `${bzzEndpoint}/${reference}/${path}`,
-    headers: extractDownloadHeaders(options)
+    headers: prepareRequestHeaders(null, options)
   });
   const file = {
     ...readFileHeaders(response.headers),
@@ -84,7 +76,7 @@ export async function downloadFileReadable(requestOptions, reference, path = '',
     method: 'GET',
     responseType: 'stream',
     url: `${bzzEndpoint}/${reference}/${path}`,
-    headers: extractDownloadHeaders(options)
+    headers: prepareRequestHeaders(null, options)
   });
   const file = {
     ...readFileHeaders(response.headers),
@@ -92,16 +84,8 @@ export async function downloadFileReadable(requestOptions, reference, path = '',
   };
   return file;
 }
-export function extractCollectionUploadHeaders(postageBatchId, options) {
-  const headers = extractRedundantUploadHeaders(postageBatchId, options);
-  if (options?.indexDocument) {
-    headers['swarm-index-document'] = options.indexDocument;
-  }
-  if (options?.errorDocument) {
-    headers['swarm-error-document'] = options.errorDocument;
-  }
-  return headers;
-}
+/*******************************************************************************************************************/
+// Collections
 /**
  * Upload collection
  * @param requestOptions Options for making requests
@@ -118,6 +102,6 @@ export async function uploadCollection(requestOptions, collection, postageBatchI
   return {
     reference: new Reference(Types.asHexString(body.reference)),
     tagUid: response.headers['swarm-tag'] ? makeTagUid(response.headers['swarm-tag']) : undefined,
-    historyAddress: response.headers['swarm-act-history-address'] || ''
+    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,5 +1,5 @@
-import { Types } from 'cafe-utility';
-import { extractUploadHeaders } from "../utils/headers.js";
+import { Optional, Types } from 'cafe-utility';
+import { prepareRequestHeaders } from "../utils/headers.js";
 import { http } from "../utils/http.js";
 import { makeTagUid } from "../utils/type.js";
 import { Reference } from "../utils/typed-bytes.js";
@@ -23,7 +23,7 @@ export async function upload(requestOptions, data, stamp, options) {
     data,
     headers: {
       'content-type': 'application/octet-stream',
-      ...extractUploadHeaders(stamp, options)
+      ...prepareRequestHeaders(stamp, options)
     },
     responseType: 'json'
   });
@@ -35,7 +35,7 @@ export async function upload(requestOptions, data, stamp, options) {
       name: 'reference'
     })),
     tagUid: response.headers['swarm-tag'] ? makeTagUid(response.headers['swarm-tag']) : undefined,
-    historyAddress: response.headers['swarm-act-history-address'] || ''
+    historyAddress: response.headers['swarm-act-history-address'] ? Optional.of(new Reference(response.headers['swarm-act-history-address'])) : Optional.empty()
   };
 }
 /**
@@ -45,11 +45,12 @@ export async function upload(requestOptions, data, stamp, options) {
  * @param hash Bee content reference
  *
  */
-export async function download(requestOptions, reference) {
+export async function download(requestOptions, reference, options) {
   reference = new Reference(reference);
   const response = await http(requestOptions, {
     responseType: 'arraybuffer',
-    url: `${endpoint}/${reference}`
+    url: `${endpoint}/${reference}`,
+    headers: prepareRequestHeaders(null, options)
   });
   return new Uint8Array(response.data);
 }

package/dist/mjs/modules/feed.js

@@ -1,7 +1,7 @@
 import { Types } from 'cafe-utility';
 import { Bytes } from "../utils/bytes.js";
 import { BeeError } from "../utils/error.js";
-import { extractUploadHeaders } from "../utils/headers.js";
+import { prepareRequestHeaders } from "../utils/headers.js";
 import { http } from "../utils/http.js";
 import { FeedIndex, Reference } from "../utils/typed-bytes.js";
 const feedEndpoint = 'feeds';
@@ -19,7 +19,7 @@ export async function createFeedManifest(requestOptions, owner, topic, stamp, op
     method: 'post',
     responseType: 'json',
     url: `${feedEndpoint}/${owner}/${topic}`,
-    headers: extractUploadHeaders(stamp, options)
+    headers: prepareRequestHeaders(stamp, options)
   });
   const body = Types.asObject(response.data, {
     name: 'response.data'

package/dist/mjs/modules/grantee.js

@@ -1,7 +1,7 @@
 import { Types } from 'cafe-utility';
-import { extractRedundantUploadHeaders } from "../utils/headers.js";
+import { prepareRequestHeaders } from "../utils/headers.js";
 import { http } from "../utils/http.js";
-import { Reference } from "../utils/typed-bytes.js";
+import { PublicKey, Reference } from "../utils/typed-bytes.js";
 const granteeEndpoint = 'grantee';
 export async function getGrantees(reference, requestOptions) {
   const response = await http(requestOptions, {
@@ -11,13 +11,13 @@ export async function getGrantees(reference, requestOptions) {
   });
   const body = Types.asArray(response.data, {
     name: 'response.data'
-  }).map(x => Types.asString(x, {
+  }).map(x => new PublicKey(Types.asString(x, {
     name: 'grantee'
-  }));
+  })));
   return {
     status: response.status,
     statusText: response.statusText,
-    data: body
+    grantees: body
   };
 }
 export async function createGrantees(requestOptions, postageBatchId, grantees) {
@@ -25,11 +25,9 @@ export async function createGrantees(requestOptions, postageBatchId, grantees) {
     method: 'post',
     url: granteeEndpoint,
     data: {
-      grantees
-    },
-    headers: {
-      ...extractRedundantUploadHeaders(postageBatchId)
+      grantees: grantees.map(x => x.toCompressedHex())
     },
+    headers: prepareRequestHeaders(postageBatchId),
     responseType: 'json'
   });
   const body = Types.asObject(response.data, {
@@ -50,9 +48,12 @@ export async function patchGrantees(postageBatchId, reference, historyRef, grant
   const response = await http(requestOptions, {
     method: 'patch',
     url: `${granteeEndpoint}/${reference}`,
-    data: grantees,
+    data: {
+      add: grantees.add?.map(x => x.toCompressedHex()),
+      revoke: grantees.revoke?.map(x => x.toCompressedHex())
+    },
     headers: {
-      ...extractRedundantUploadHeaders(postageBatchId),
+      ...prepareRequestHeaders(postageBatchId),
       'swarm-act-history-address': historyRef.toHex()
     },
     responseType: 'json'

package/dist/mjs/modules/pss.js

@@ -1,5 +1,5 @@
 import WebSocket from 'isomorphic-ws';
-import { extractUploadHeaders } from "../utils/headers.js";
+import { prepareRequestHeaders } from "../utils/headers.js";
 import { http } from "../utils/http.js";
 const endpoint = 'pss';
 /**
@@ -22,7 +22,7 @@ export async function send(requestOptions, topic, target, data, postageBatchId,
     params: {
       recipient
     },
-    headers: extractUploadHeaders(postageBatchId)
+    headers: prepareRequestHeaders(postageBatchId)
   });
 }
 /**

package/dist/mjs/modules/soc.js

@@ -1,5 +1,5 @@
-import { Types } from 'cafe-utility';
-import { extractUploadHeaders } from "../utils/headers.js";
+import { Optional, Types } from 'cafe-utility';
+import { prepareRequestHeaders } from "../utils/headers.js";
 import { http } from "../utils/http.js";
 import { makeTagUid } from "../utils/type.js";
 import { Reference } from "../utils/typed-bytes.js";
@@ -22,7 +22,7 @@ export async function upload(requestOptions, owner, identifier, signature, data,
     data,
     headers: {
       'content-type': 'application/octet-stream',
-      ...extractUploadHeaders(stamp, options)
+      ...prepareRequestHeaders(stamp, options)
     },
     responseType: 'json',
     params: {
@@ -35,6 +35,6 @@ export async function upload(requestOptions, owner, identifier, signature, data,
   return {
     reference: new Reference(Types.asHexString(body.reference)),
     tagUid: response.headers['swarm-tag'] ? makeTagUid(response.headers['swarm-tag']) : undefined,
-    historyAddress: response.headers['swarm-act-history-address'] || ''
+    historyAddress: response.headers['swarm-act-history-address'] ? Optional.of(new Reference(response.headers['swarm-act-history-address'])) : Optional.empty()
   };
 }

package/dist/mjs/utils/collection.js

@@ -19,7 +19,7 @@ export function makeFilePath(file) {
   }
   throw new TypeError('file is not valid File object');
 }
-export async function makeCollectionFromFileList(fileList) {
+export function makeCollectionFromFileList(fileList) {
   return Array.from(fileList).map(file => ({
     path: makeFilePath(file),
     size: file.size,

package/dist/mjs/utils/collection.node.js

@@ -2,7 +2,6 @@ import fs from 'fs';
 import path from 'path';
 /**
  * Creates array in the format of Collection with data loaded from directory on filesystem.
- * The function loads all the data into memory!
  *
  * @param dir path to the directory
  */

package/dist/mjs/utils/expose.js

@@ -1,4 +1,4 @@
-export { getCollectionSize } from "./collection.js";
+export { getCollectionSize, makeCollectionFromFileList } from "./collection.js";
 export { getFolderSize } from "./collection.node.js";
 export { makeMaxTarget } from "./pss.js";
 export { approximateOverheadForRedundancyLevel, getRedundancyStat, getRedundancyStats } from "./redundancy.js";

package/dist/mjs/utils/headers.js

@@ -1,15 +1,17 @@
 import { Types } from 'cafe-utility';
 import { BeeError } from "./error.js";
 import { convertEnvelopeToMarshaledStamp } from "./stamps.js";
-import { BatchId } from "./typed-bytes.js";
-/**
- * Read the filename from the content-disposition header
- * See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition
- *
- * @param header the content-disposition header value
- *
- * @returns the filename
- */
+import { BatchId, PublicKey, Reference } from "./typed-bytes.js";
+export function readFileHeaders(headers) {
+  const name = readContentDispositionFilename(headers['content-disposition']);
+  const tagUid = readTagUid(headers['swarm-tag-uid']);
+  const contentType = headers['content-type'] || undefined;
+  return {
+    name,
+    tagUid,
+    contentType
+  };
+}
 function readContentDispositionFilename(header) {
   if (!header) {
     throw new BeeError('missing content-disposition header');
@@ -28,42 +30,69 @@ function readTagUid(header) {
   }
   return parseInt(header, 10);
 }
-export function readFileHeaders(headers) {
-  const name = readContentDispositionFilename(headers['content-disposition']);
-  const tagUid = readTagUid(headers['swarm-tag-uid']);
-  const contentType = headers['content-type'] || undefined;
-  return {
-    name,
-    tagUid,
-    contentType
-  };
-}
-export function extractUploadHeaders(stamp, options) {
-  if (!stamp) {
-    throw new BeeError('Stamp has to be specified!');
-  }
+export function prepareRequestHeaders(stamp, nullableOptions) {
   const headers = {};
   if (isEnvelopeWithBatchId(stamp)) {
     headers['swarm-postage-stamp'] = convertEnvelopeToMarshaledStamp(stamp).toHex();
-  } else {
+  } else if (stamp) {
     stamp = new BatchId(stamp);
     headers['swarm-postage-batch-id'] = stamp.toHex();
   }
-  if (options?.act) {
+  if (!nullableOptions) {
+    return headers;
+  }
+  const options = Types.asObject(nullableOptions);
+  if (options.size) {
+    headers['content-length'] = String(options.size);
+  }
+  if (options.contentType) {
+    headers['content-type'] = String(options.contentType);
+  }
+  if (options.redundancyLevel) {
+    headers['swarm-redundancy-level'] = String(options.redundancyLevel);
+  }
+  if (Types.isBoolean(options.act)) {
     headers['swarm-act'] = String(options.act);
   }
-  if (options?.pin) {
+  if (Types.isBoolean(options.pin)) {
     headers['swarm-pin'] = String(options.pin);
   }
-  if (options?.encrypt) {
-    headers['swarm-encrypt'] = String(options.encrypt);
+  if (Types.isBoolean(options.encrypt)) {
+    headers['swarm-encrypt'] = options.encrypt.toString();
   }
-  if (options?.tag) {
+  if (options.tag) {
     headers['swarm-tag'] = String(options.tag);
   }
-  if (typeof options?.deferred === 'boolean') {
+  if (Types.isBoolean(options.deferred)) {
     headers['swarm-deferred-upload'] = options.deferred.toString();
   }
+  if (options.redundancyStrategy) {
+    headers['swarm-redundancy-strategy'] = String(options.redundancyStrategy);
+  }
+  if (Types.isBoolean(options.fallback)) {
+    headers['swarm-redundancy-fallback-mode'] = options.fallback.toString();
+  }
+  if (options.timeoutMs) {
+    headers['swarm-chunk-retrieval-timeout'] = String(options.timeoutMs);
+  }
+  if (options.indexDocument) {
+    headers['swarm-index-document'] = String(options.indexDocument);
+  }
+  if (options.errorDocument) {
+    headers['swarm-error-document'] = String(options.errorDocument);
+  }
+  if (options.actPublisher) {
+    headers['swarm-act-publisher'] = new PublicKey(options.actPublisher).toCompressedHex();
+  }
+  if (options.actHistoryAddress) {
+    headers['swarm-act-history-address'] = new Reference(options.actHistoryAddress).toHex();
+  }
+  if (options.actTimestamp) {
+    headers['swarm-act-timestamp'] = String(options.actTimestamp);
+  }
+  if (options.actPublisher || options.actHistoryAddress || options.actTimestamp) {
+    headers['swarm-act'] = 'true';
+  }
   return headers;
 }
 function isEnvelopeWithBatchId(value) {
@@ -72,24 +101,4 @@ function isEnvelopeWithBatchId(value) {
   }
   const envelope = value;
   return envelope.issuer !== undefined && envelope.index !== undefined && envelope.signature !== undefined && envelope.timestamp !== undefined && envelope.batchId !== undefined;
-}
-export function extractRedundantUploadHeaders(postageBatchId, options) {
-  const headers = extractUploadHeaders(postageBatchId, options);
-  if (options?.redundancyLevel) {
-    headers['swarm-redundancy-level'] = String(options.redundancyLevel);
-  }
-  return headers;
-}
-export function extractDownloadHeaders(options) {
-  const headers = {};
-  if (options?.redundancyStrategy) {
-    headers['swarm-redundancy-strategy'] = String(options.redundancyStrategy);
-  }
-  if (options?.fallback === false) {
-    headers['swarm-redundancy-fallback-mode'] = 'false';
-  }
-  if (options?.timeoutMs !== undefined) {
-    headers['swarm-chunk-retrieval-timeout'] = String(options.timeoutMs);
-  }
-  return headers;
 }

package/dist/mjs/utils/http.js

@@ -19,6 +19,15 @@ export const DEFAULT_HTTP_CONFIG = {
  */
 export async function http(options, config) {
   const requestConfig = Objects.deepMerge3(DEFAULT_HTTP_CONFIG, config, options);
+  if (requestConfig.params) {
+    const keys = Object.keys(requestConfig.params);
+    for (const key of keys) {
+      const value = requestConfig.params[key];
+      if (value === undefined) {
+        delete requestConfig.params[key];
+      }
+    }
+  }
   let failedAttempts = 0;
   while (failedAttempts < MAX_FAILED_ATTEMPTS) {
     try {

package/dist/mjs/utils/tar-uploader.browser.js

@@ -1,4 +1,4 @@
-import { extractCollectionUploadHeaders } from "../modules/bzz.js";
+import { prepareRequestHeaders } from "./headers.js";
 import { http } from "./http.js";
 import { TarStream } from "./tar.js";
 import { writeTar } from "./tar-writer.js";
@@ -15,7 +15,7 @@ export async function uploadTar(requestOptions, collection, postageBatchId, opti
     headers: {
       'content-type': 'application/x-tar',
       'swarm-collection': 'true',
-      ...extractCollectionUploadHeaders(postageBatchId, options)
+      ...prepareRequestHeaders(postageBatchId, options)
     }
   });
   return response;

package/dist/mjs/utils/tar-uploader.js

@@ -1,4 +1,4 @@
-import { extractCollectionUploadHeaders } from "../modules/bzz.js";
+import { prepareRequestHeaders } from "./headers.js";
 import { http } from "./http.js";
 import { TarStream } from "./tar.js";
 import { writeTar } from "./tar-writer.js";
@@ -13,7 +13,7 @@ export async function uploadTar(requestOptions, collection, postageBatchId, opti
     headers: {
       'content-type': 'application/x-tar',
       'swarm-collection': 'true',
-      ...extractCollectionUploadHeaders(postageBatchId, options)
+      ...prepareRequestHeaders(postageBatchId, options)
     }
   });
   await writeTar(collection, tarStream);