@ethersphere/bee-js 3.2.0 → 3.3.0

package/dist/types/modules/debug/status.d.ts

@@ -0,0 +1,72 @@
+import type { Health, NodeInfo } from '../../types/debug';
+import { Ky } from '../../types';
+import { BeeVersions } from '../../types/debug';
+export declare const SUPPORTED_BEE_VERSION_EXACT = "1.4.3-1213e063";
+export declare const SUPPORTED_API_VERSION = "2.0.0";
+export declare const SUPPORTED_DEBUG_API_VERSION = "1.2.1";
+export declare const SUPPORTED_BEE_VERSION: string;
+/**
+ * Get health of node
+ *
+ * @param ky Ky debug instance
+ */
+export declare function getHealth(ky: Ky): Promise<Health>;
+/**
+ * Get information about Bee node
+ *
+ * @param ky Ky debug instance
+ */
+export declare function getNodeInfo(ky: Ky): Promise<NodeInfo>;
+/**
+ * Connects to a node and checks if it is a supported Bee version by the bee-js
+ *
+ * @param ky Ky debug instance
+ *
+ * @returns true if the Bee node version is supported
+ * @deprecated Use `isSupportedExactVersion` instead
+ */
+export declare function isSupportedVersion(ky: Ky): Promise<boolean>;
+/**
+ * Connects to a node and checks if its version matches with the one that bee-js supports.
+ *
+ * Be aware that this is the most strict version check and most probably
+ * you will want to use more relaxed API-versions based checks like
+ * `isSupportedApiVersion`, `isSupportedMainApiVersion` or `isSupportedDebugApiVersion`
+ * based on your use-case.
+ *
+ * @param ky
+ */
+export declare function isSupportedExactVersion(ky: Ky): Promise<boolean>;
+/**
+ * Connects to a node and checks if its main's API version matches with the one that bee-js supports.
+ *
+ * This is useful if you are not using `BeeDebug` class (for anything else then this check)
+ * and want to make sure about compatibility.
+ *
+ * @param ky
+ */
+export declare function isSupportedMainApiVersion(ky: Ky): Promise<boolean>;
+/**
+ * Connects to a node and checks if its Debug API version matches with the one that bee-js supports.
+ *
+ * This is useful if you are not using `Bee` class in your application and want to make sure
+ * about compatibility.
+ *
+ * @param ky
+ */
+export declare function isSupportedDebugApiVersion(ky: Ky): Promise<boolean>;
+/**
+ * Connects to a node and checks if its Main and Debug API versions matches with the one that bee-js supports.
+ *
+ * This should be the main way how to check compatibility for your app and Bee node.
+ *
+ * @param ky
+ */
+export declare function isSupportedApiVersion(ky: Ky): Promise<boolean>;
+/**
+ * Returns object with all versions specified by the connected Bee node (properties prefixed with `bee*`)
+ * and versions that bee-js supports (properties prefixed with `supported*`).
+ *
+ * @param ky
+ */
+export declare function getVersions(ky: Ky): Promise<BeeVersions>;

package/dist/{src → types}/types/debug.d.ts

@@ -121,6 +121,14 @@ export interface Health {
     apiVersion: string;
     debugApiVersion: string;
 }
+export interface BeeVersions {
+    supportedBeeVersion: string;
+    supportedBeeApiVersion: string;
+    supportedBeeDebugApiVersion: string;
+    beeVersion: string;
+    beeApiVersion: string;
+    beeDebugApiVersion: string;
+}
 export declare enum BeeModes {
     FULL = "full",
     LIGHT = "light",

package/dist/{src → types}/types/index.d.ts

@@ -362,6 +362,7 @@ export interface FeedWriter extends FeedReader {
  * Interface for downloading single owner chunks
  */
 export interface SOCReader {
+    readonly owner: HexEthAddress;
     /**
      * Downloads a single owner chunk
      *

package/dist/types/utils/collection.browser.d.ts

@@ -0,0 +1,15 @@
+import { Collection } from '../types';
+/**
+ * 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
+ */
+export declare function makeCollectionFromFS(dir: string): Promise<Collection<Uint8Array>>;
+/**
+ * Calculate folder size recursively
+ *
+ * @param dir the path to the folder to check
+ * @returns size in bytes
+ */
+export declare function getFolderSize(dir: string): Promise<number>;

package/dist/{src → types}/utils/collection.d.ts

@@ -1,13 +1,6 @@
 import { Collection } from '../types';
 export declare function isCollection(data: unknown): data is Collection<Uint8Array>;
 export declare function assertCollection(data: unknown): asserts data is Collection<Uint8Array>;
-/**
- * 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
- */
-export declare function makeCollectionFromFS(dir: string): Promise<Collection<Uint8Array>>;
 export declare function makeCollectionFromFileList(fileList: FileList | File[]): Promise<Collection<Uint8Array>>;
 /**
  * Calculate cumulative size of files
@@ -16,10 +9,3 @@ export declare function makeCollectionFromFileList(fileList: FileList | File[]):
  * @returns size in bytes
  */
 export declare function getCollectionSize(fileList: FileList | File[]): number;
-/**
- * Calculate folder size recursively
- *
- * @param dir the path to the folder to check
- * @returns size in bytes
- */
-export declare function getFolderSize(dir: string): Promise<number>;

package/dist/types/utils/collection.node.d.ts

@@ -0,0 +1,15 @@
+import { Collection } from '../types';
+/**
+ * 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
+ */
+export declare function makeCollectionFromFS(dir: string): Promise<Collection<Uint8Array>>;
+/**
+ * Calculate folder size recursively
+ *
+ * @param dir the path to the folder to check
+ * @returns size in bytes
+ */
+export declare function getFolderSize(dir: string): Promise<number>;

package/dist/{src → types}/utils/expose.d.ts

@@ -1,4 +1,5 @@
-export { getCollectionSize, getFolderSize } from './collection';
+export { getCollectionSize } from './collection';
+export { getFolderSize } from './collection.node';
 export { Bytes, FlexBytes, isBytes, assertBytes, isFlexBytes, assertFlexBytes, bytesAtOffset, flexBytesAtOffset, bytesEqual, } from './bytes';
 export { HexString, PrefixedHexString, makeHexString, hexToBytes, bytesToHex, intToHex, isHexString, assertHexString, assertPrefixedHexString, } from './hex';
 export { EthAddress, makeEthAddress, makeHexEthAddress, isHexEthAddress, ethToSwarmAddress, toLittleEndian, fromLittleEndian, makeEthereumWalletSigner, } from './eth';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethersphere/bee-js",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Javascript client for Bee",
   "keywords": [
     "bee",
@@ -18,30 +18,42 @@
     "url": "https://github.com/ethersphere/bee-js/issues/"
   },
   "license": "BSD-3-Clause",
-  "main": "dist/index.min.js",
   "repository": {
     "type": "git",
     "url": "https://github.com/ethersphere/bee-js.git"
   },
+  "main": "dist/cjs/index.js",
+  "module": "dist/mjs/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/mjs/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "types": "dist/types/index.d.ts",
   "browser": {
-    "./dist/index.min.js": "./dist/index.browser.min.js",
-    "data": "data.browser"
+    "./src/utils/data.ts": "./src/utils/data.browser.ts",
+    "./dist/cjs/utils/data.js": "./dist/cjs/utils/data.browser.js",
+    "./dist/mjs/utils/data.js": "./dist/mjs/utils/data.browser.js",
+    "./dist/cjs/utils/collection.node.js": "./dist/cjs/utils/collection.browser.js",
+    "./dist/mjs/utils/collection.node.js": "./dist/mjs/utils/collection.browser.js",
+    "./src/utils/collection.node.ts": "./src/utils/collection.browser.ts"
   },
   "files": [
     "dist"
   ],
-  "types": "dist/src/index.d.ts",
   "scripts": {
-    "prepublishOnly": "rimraf dist && npm run compile:types && npm run compile:browser --env mode=production && npm run compile:node --env mode=production",
-    "compile:node": "webpack --progress --env target=node",
-    "compile:types": "tsc --emitDeclarationOnly --declaration",
-    "compile:browser": "webpack --progress --env target=web",
+    "prepublishOnly": "npm run build",
+    "build": "rimraf dist && npm run build:node && npm run build:types && npm run build:browser",
+    "build:node": "tsc -p tsconfig.json && tsc -p tsconfig-mjs.json && ./build-fixup",
+    "build:types": "tsc --emitDeclarationOnly --declaration --outDir dist/types",
+    "build:browser": "webpack --progress",
     "mock-ci": "npm run lint:check && npm run check:types && npm run test",
     "docs": "rimraf docs && typedoc",
-    "test": "npm run compile:browser && jest --verbose --selectProjects=node:unit node:integration dom:integration --config=jest.config.ts",
-    "test:integration:browser": "npm run compile:browser && jest --verbose --selectProjects=dom:integration --config=jest.config.ts",
+    "test": "npm run build:browser && jest --verbose --selectProjects=node:unit node:integration dom:integration --config=jest.config.ts",
+    "test:integration:browser": "npm run build:browser && jest --verbose --selectProjects=dom:integration --config=jest.config.ts",
     "test:integration:node": "jest --verbose --selectProjects=node:integration --config=jest.config.ts",
-    "test:integration": "npm run compile:browser && jest --verbose --selectProjects=node:integration dom:integration --config=jest.config.ts",
+    "test:integration": "npm run build:browser && jest --verbose --selectProjects=node:integration dom:integration --config=jest.config.ts",
     "test:unit": "jest --verbose --selectProjects=node:unit --config=jest.config.ts ",
     "test:node": "jest --verbose --selectProjects=node:unit node:integration --config=jest.config.ts",
     "test:browser": "npm run test:integration:browser",
@@ -51,7 +63,7 @@
     "depcheck": "depcheck ."
   },
   "dependencies": {
-    "@types/readable-stream": "^2.3.11",
+    "@types/readable-stream": "^2.3.13",
     "bufferutil": "^4.0.3",
     "cross-blob": "^2.0.1",
     "elliptic": "^6.5.4",
@@ -60,31 +72,33 @@
     "ky": "^0.25.1",
     "ky-universal": "^0.8.2",
     "readable-stream": "^3.6.0",
+    "semver": "^7.3.5",
     "tar-js": "^0.3.0",
     "utf-8-validate": "^5.0.8",
     "web-streams-polyfill": "^3.1.0",
-    "ws": "^7.5.0"
+    "ws": "^8.5.0"
   },
   "devDependencies": {
     "@babel/core": "^7.14.6",
     "@babel/plugin-proposal-class-properties": "^7.16.7",
     "@babel/plugin-transform-runtime": "^7.14.5",
-    "@babel/preset-env": "^7.14.7",
+    "@babel/preset-env": "^7.16.11",
     "@babel/preset-typescript": "^7.14.5",
     "@commitlint/cli": "^12.1.1",
     "@commitlint/config-conventional": "^16.0.0",
     "@fluffy-spoon/substitute": "^1.208.0",
-    "@jest/test-sequencer": "^27.0.5",
+    "@jest/test-sequencer": "^27.5.0",
     "@jest/types": "^27.0.2",
     "@types/content-disposition": "^0.5.4",
     "@types/debug": "^4.1.7",
     "@types/elliptic": "^6.4.12",
-    "@types/expect-puppeteer": "^4.4.5",
+    "@types/expect-puppeteer": "^4.4.7",
     "@types/glob": "^7.1.3",
     "@types/jest": "^26.0.23",
     "@types/jest-environment-puppeteer": "^4.4.1",
     "@types/node": "^15.12.4",
     "@types/puppeteer": "^5.4.3",
+    "@types/semver": "^7.3.9",
     "@types/ws": "^7.4.5",
     "@typescript-eslint/eslint-plugin": "^5.10.0",
     "@typescript-eslint/parser": "^5.10.0",
@@ -92,31 +106,33 @@
     "babel-loader": "^8.2.2",
     "debug": "^4.3.1",
     "depcheck": "^1.4.3",
-    "eslint": "^8.7.0",
+    "eslint": "^8.8.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-jest": "^25.7.0",
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-unused-imports": "^2.0.0",
     "glob": "^7.1.7",
     "husky": "^6.0.0",
-    "jest": "^27.0.5",
+    "jest": "^27.4.7",
     "jest-puppeteer": "^5.0.4",
     "nock": "^13.2.2",
     "prettier": "^2.3.1",
-    "puppeteer": "^9.1.1",
+    "puppeteer": "^13.2.0",
     "rimraf": "^3.0.2",
     "terser-webpack-plugin": "^5.3.0",
-    "ts-node": "^10.0.0",
+    "ts-node": "^10.4.0",
     "typedoc": "^0.22.11",
     "typedoc-plugin-markdown": "^3.11.12",
     "typescript": "^4.5.4",
-    "webpack": "^5.65.0",
+    "webpack": "^5.68.0",
     "webpack-bundle-analyzer": "^4.4.1",
     "webpack-cli": "^4.9.2"
   },
   "engines": {
     "node": ">=12.0.0",
     "npm": ">=6.0.0",
-    "bee": "1.4.1-238867f1"
+    "beeApiVersion": "2.0.0",
+    "beeDebugApiVersion": "1.2.1",
+    "bee": "1.4.3-1213e063"
   }
 }