@ethersphere/bee-js 9.7.0 → 9.8.0

package/dist/mjs/bee.js

@@ -695,7 +695,8 @@ export class Bee {
     for (let i = 0n; i < 0xffffn; i++) {
       const signer = new PrivateKey(Binary.numberToUint256(start + i, 'BE'));
       const socAddress = makeSOCAddress(identifier, signer.publicKey().address());
-      const actualProximity = 256 - Binary.proximity(socAddress.toUint8Array(), targetOverlay.toUint8Array(), 256);
+      // TODO: test the significance of the hardcoded 256
+      const actualProximity = 256 - Binary.proximity(socAddress.toUint8Array(), targetOverlay.toUint8Array());
       if (actualProximity <= 256 - proximity) {
         return signer;
       }

package/dist/mjs/manifest/manifest.js

@@ -1,6 +1,8 @@
 import { Binary, MerkleTree, Optional, Uint8ArrayReader } from 'cafe-utility';
+import _debug from 'debug';
 import { NULL_ADDRESS } from "../index.js";
 import { Reference } from "../utils/typed-bytes.js";
+const debug = _debug('bee-js:manifest');
 const ENCODER = new TextEncoder();
 const DECODER = new TextDecoder();
 const TYPE_VALUE = 2;
@@ -60,6 +62,11 @@ export class Fork {
       data.push(new Uint8Array(30 - this.prefix.length));
     }
     data.push(this.node.selfAddress);
+    debug('marshalling fork', {
+      prefixLength: this.prefix.length,
+      prefix: DECODER.decode(this.prefix),
+      address: Binary.uint8ArrayToHex(this.node.selfAddress)
+    });
     if (this.node.metadata) {
       const metadataBytes = Binary.padEndToMultiple(new Uint8Array([0x00, 0x00, ...ENCODER.encode(JSON.stringify(this.node.metadata))]), 32, 0x0a);
       const metadataLengthBytes = Binary.numberToUint16(metadataBytes.length - 2, 'BE');
@@ -74,6 +81,12 @@ export class Fork {
     const prefix = reader.read(prefixLength);
     reader.read(30 - prefixLength);
     const selfAddress = reader.read(addressLength);
+    debug('unmarshalling fork', {
+      prefixLength,
+      prefix: DECODER.decode(prefix),
+      addressLength,
+      address: Binary.uint8ArrayToHex(selfAddress)
+    });
     let metadata = undefined;
     if (isType(type, TYPE_WITH_METADATA)) {
       const metadataLength = Binary.uint16ToNumber(reader.read(2), 'BE');
@@ -232,6 +245,10 @@ export class MantarayNode {
   addFork(path, reference, metadata) {
     this.selfAddress = null;
     path = path instanceof Uint8Array ? path : ENCODER.encode(path);
+    debug('adding fork', {
+      path: DECODER.decode(path),
+      reference: new Reference(reference).represent()
+    });
     // TODO: this should not be ignored
     // eslint-disable-next-line @typescript-eslint/no-this-alias
     let tip = this;

package/dist/mjs/utils/chunk-stream.js

@@ -39,6 +39,7 @@ export async function streamDirectory(bee, dir, postageBatchId, onUploadProgress
   for (const file of files) {
     total += totalChunks(file.size);
   }
+  let hasIndexHtml = false;
   async function onChunk(chunk) {
     await queue.enqueue(async () => {
       await bee.uploadChunk(postageBatchId, chunk.build(), options, requestOptions);
@@ -69,10 +70,20 @@ export async function streamDirectory(bee, dir, postageBatchId, onUploadProgress
       Filename: filename
     });
     if (file.path === 'index.html') {
-      mantaray.addFork('/', NULL_ADDRESS, {
-        'website-index-document': 'index.html'
-      });
+      hasIndexHtml = true;
+    }
+  }
+  if (hasIndexHtml || options?.indexDocument || options?.errorDocument) {
+    const metadata = {};
+    if (options?.indexDocument) {
+      metadata['website-index-document'] = options.indexDocument;
+    } else if (hasIndexHtml) {
+      metadata['website-index-document'] = 'index.html';
+    }
+    if (options?.errorDocument) {
+      metadata['website-error-document'] = options.errorDocument;
     }
+    mantaray.addFork('/', NULL_ADDRESS, metadata);
   }
   return mantaray.saveRecursively(bee, postageBatchId, options, requestOptions);
 }

package/dist/mjs/utils/http.js

@@ -1,6 +1,8 @@
 import axios from 'axios';
 import { Dates, Objects, Strings, System } from 'cafe-utility';
+import _debug from 'debug';
 import { BeeResponseError } from "../index.js";
+const debug = _debug('bee-js:http');
 const {
   AxiosError
 } = axios;
@@ -37,6 +39,12 @@ export async function http(options, config) {
   let failedAttempts = 0;
   while (failedAttempts < MAX_FAILED_ATTEMPTS) {
     try {
+      debug(`${requestConfig.method || 'get'} ${Strings.joinUrl([requestConfig.baseURL, requestConfig.url])}`, {
+        headers: {
+          ...requestConfig.headers
+        },
+        params: requestConfig.params
+      });
       maybeRunOnRequestHook(options, requestConfig);
       const response = await axios(requestConfig);
       return response;
@@ -59,7 +67,7 @@ function maybeRunOnRequestHook(options, requestConfig) {
   if (options.onRequest) {
     options.onRequest({
       method: requestConfig.method || 'GET',
-      url: Strings.joinUrl(requestConfig.baseURL, requestConfig.url),
+      url: Strings.joinUrl([requestConfig.baseURL, requestConfig.url]),
       headers: {
         ...requestConfig.headers
       },

package/dist/types/bee.d.ts

@@ -193,7 +193,7 @@ export declare class Bee {
      */
     uploadFiles(postageBatchId: BatchId | Uint8Array | string, fileList: FileList | File[], options?: CollectionUploadOptions, requestOptions?: BeeRequestOptions): Promise<UploadResult>;
     hashDirectory(dir: string): Promise<Reference>;
-    streamDirectory(postageBatchId: BatchId | Uint8Array | string, dir: string, onUploadProgress?: (progress: UploadProgress) => void, options?: UploadOptions, requestOptions?: BeeRequestOptions): Promise<UploadResult>;
+    streamDirectory(postageBatchId: BatchId | Uint8Array | string, dir: string, onUploadProgress?: (progress: UploadProgress) => void, options?: CollectionUploadOptions, requestOptions?: BeeRequestOptions): Promise<UploadResult>;
     streamFiles(postageBatchId: BatchId | Uint8Array | string, files: File[] | FileList, onUploadProgress?: (progress: UploadProgress) => void, options?: UploadOptions, requestOptions?: BeeRequestOptions): Promise<UploadResult>;
     /**
      * Upload Collection that you can assembly yourself.

package/dist/types/utils/chunk-stream.d.ts

@@ -1,6 +1,6 @@
-import { Bee, BeeRequestOptions, UploadOptions, UploadResult } from '..';
+import { Bee, BeeRequestOptions, CollectionUploadOptions, UploadOptions, UploadResult } from '..';
 import { BatchId } from './typed-bytes';
 import { UploadProgress } from './upload-progress';
 export declare function hashDirectory(dir: string): Promise<import("./typed-bytes").Reference>;
-export declare function streamDirectory(bee: Bee, dir: string, postageBatchId: BatchId | string | Uint8Array, onUploadProgress?: (progress: UploadProgress) => void, options?: UploadOptions, requestOptions?: BeeRequestOptions): Promise<UploadResult>;
+export declare function streamDirectory(bee: Bee, dir: string, postageBatchId: BatchId | string | Uint8Array, onUploadProgress?: (progress: UploadProgress) => void, options?: CollectionUploadOptions, requestOptions?: BeeRequestOptions): Promise<UploadResult>;
 export declare function streamFiles(_bee: Bee, _files: File[] | FileList, _postageBatchId: BatchId, _onUploadProgress?: (progress: UploadProgress) => void, _options?: UploadOptions, _requestOptions?: BeeRequestOptions): Promise<UploadResult>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethersphere/bee-js",
-  "version": "9.7.0",
+  "version": "9.8.0",
   "description": "Javascript client for Bee",
   "keywords": [
     "bee",
@@ -55,14 +55,15 @@
     "build:node": "tsc -p tsconfig.json && tsc -p tsconfig-mjs.json && ./build-fixup && babel --plugins \"babel-plugin-add-import-extension\" --out-dir dist/mjs/ dist/mjs/",
     "build:types": "tsc --emitDeclarationOnly --declaration --outDir dist/types",
     "build:browser": "webpack --progress",
-    "test": "jest --config=jest.config.ts --runInBand --verbose",
+    "test": "jest --config=jest.config.ts --runInBand --verbose --forceExit",
     "check": "tsc --project tsconfig.test.json",
     "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\" && prettier --check \"src/**/*.ts\" \"test/**/*.ts\"",
     "depcheck": "depcheck ."
   },
   "dependencies": {
     "axios": "^0.30.0",
-    "cafe-utility": "^28.1.0",
+    "cafe-utility": "^31.0.0",
+    "debug": "^4.4.1",
     "isomorphic-ws": "^4.0.1",
     "semver": "^7.3.5",
     "ws": "^8.7.0"
@@ -78,6 +79,7 @@
     "@commitlint/config-conventional": "^17.4.2",
     "@jest/types": "^29.6.3",
     "@naholyr/cross-env": "^1.0.0",
+    "@types/debug": "^4.1.12",
     "@types/jest": "^29.5.13",
     "@types/node": "^18.11.11",
     "@types/semver": "^7.3.9",