@ethersphere/bee-js 5.1.1 → 5.1.2

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

@@ -1,17 +1,18 @@
-import { Ky, Reference, Tag } from '../types';
+import { Reference, Tag } from '../types';
+import type { Options as KyOptions } from 'ky';
 /**
  * Create new tag on the Bee node
  *
  * @param url Bee tag URL
  */
-export declare function createTag(ky: Ky): Promise<Tag>;
+export declare function createTag(kyOptions: KyOptions): Promise<Tag>;
 /**
  * Retrieve tag information from Bee node
  *
  * @param url Bee tag URL
  * @param uid UID of tag to be retrieved
  */
-export declare function retrieveTag(ky: Ky, uid: number): Promise<Tag>;
+export declare function retrieveTag(kyOptions: KyOptions, uid: number): Promise<Tag>;
 /**
  * Get limited listing of all tags.
  *
@@ -19,17 +20,17 @@ export declare function retrieveTag(ky: Ky, uid: number): Promise<Tag>;
  * @param offset
  * @param limit
  */
-export declare function getAllTags(ky: Ky, offset?: number, limit?: number): Promise<Tag[]>;
+export declare function getAllTags(kyOptions: KyOptions, offset?: number, limit?: number): Promise<Tag[]>;
 /**
  * Removes tag from the Bee node.
  * @param url
  * @param uid
  */
-export declare function deleteTag(ky: Ky, uid: number): Promise<void>;
+export declare function deleteTag(kyOptions: KyOptions, uid: number): Promise<void>;
 /**
  * Updates tag
  * @param url
  * @param uid
  * @param reference
  */
-export declare function updateTag(ky: Ky, uid: number, reference: Reference): Promise<void>;
+export declare function updateTag(kyOptions: KyOptions, uid: number, reference: Reference): Promise<void>;

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

@@ -80,7 +80,7 @@ export interface TransactionOptions {
      */
     gasLimit?: NumberString;
 }
-export declare type CashoutOptions = TransactionOptions & RequestOptions;
+export type CashoutOptions = TransactionOptions & RequestOptions;
 export interface CashoutResult {
     recipient: string;
     lastPayout: NumberString;

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

@@ -11,9 +11,9 @@ import type ky from 'ky-universal';
 import type { Readable as NativeReadable } from 'stream';
 import type { Readable as CompatibilityReadable } from 'readable-stream';
 import type { ReadableStream as ReadableStreamPonyfill } from 'web-streams-polyfill';
-import { Options as KyOptions } from './ky-options';
+import type { Options as KyOptions } from 'ky';
 export * from './debug';
-export declare type Ky = typeof ky;
+export type Ky = typeof ky;
 export interface Dictionary<T> {
     [Key: string]: T;
 }
@@ -48,34 +48,34 @@ export declare const FEED_INDEX_HEX_LENGTH = 16;
  *
  * @see [Bee docs - Store with Encryption](https://docs.ethswarm.org/docs/access-the-swarm/store-with-encryption)
  */
-export declare type Reference = HexString<typeof REFERENCE_HEX_LENGTH> | HexString<typeof ENCRYPTED_REFERENCE_HEX_LENGTH>;
+export type Reference = HexString<typeof REFERENCE_HEX_LENGTH> | HexString<typeof ENCRYPTED_REFERENCE_HEX_LENGTH>;
 /**
  * Type that represents either Swarm's reference in hex string or ESN domain (something.eth).
  */
-export declare type ReferenceOrEns = Reference | string;
+export type ReferenceOrEns = Reference | string;
 /**
  * Type that represents either Swarm's reference in hex string, ESN domain (something.eth) or CID using one of the Swarm's codecs.
  */
-export declare type ReferenceCidOrEns = ReferenceOrEns | string;
-export declare type PlainBytesReference = Bytes<typeof REFERENCE_BYTES_LENGTH>;
-export declare type EncryptedBytesReference = Bytes<typeof ENCRYPTED_REFERENCE_BYTES_LENGTH>;
-export declare type BytesReference = PlainBytesReference | EncryptedBytesReference;
-export declare type PublicKey = HexString<typeof PUBKEY_HEX_LENGTH>;
-export declare type Address = HexString<typeof ADDRESS_HEX_LENGTH>;
+export type ReferenceCidOrEns = ReferenceOrEns | string;
+export type PlainBytesReference = Bytes<typeof REFERENCE_BYTES_LENGTH>;
+export type EncryptedBytesReference = Bytes<typeof ENCRYPTED_REFERENCE_BYTES_LENGTH>;
+export type BytesReference = PlainBytesReference | EncryptedBytesReference;
+export type PublicKey = HexString<typeof PUBKEY_HEX_LENGTH>;
+export type Address = HexString<typeof ADDRESS_HEX_LENGTH>;
 /**
  * Type representing Readable stream that abstracts away implementation especially the difference between
  * browser and NodeJS versions as both are supported.
  */
-export declare type Readable = NativeReadable | CompatibilityReadable | ReadableStream | ReadableStreamPonyfill;
+export type Readable = NativeReadable | CompatibilityReadable | ReadableStream | ReadableStreamPonyfill;
 /**
  * BatchId is result of keccak256 hash so 64 hex string without prefix.
  */
-export declare type BatchId = HexString<typeof BATCH_ID_HEX_LENGTH>;
+export type BatchId = HexString<typeof BATCH_ID_HEX_LENGTH>;
 /**
  * AddressPrefix is an HexString of length equal or smaller then ADDRESS_HEX_LENGTH.
  * It represents PSS Address Prefix that is used to define address neighborhood that will receive the PSS message.
  */
-export declare type AddressPrefix = HexString;
+export type AddressPrefix = HexString;
 /**
  * Internal interface that represents configuration for creating a request with Ky
  */
@@ -151,8 +151,6 @@ export interface UploadOptions extends RequestOptions {
      *
      * Locally pinned data is possible to reupload to network if it disappear.
      *
-     * **Warning! Not allowed when node is in Gateway mode!**
-     *
      * @see [Bee docs - Pinning](https://docs.ethswarm.org/docs/access-the-swarm/pinning)
      * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/Collection/paths/~1bzz/post)
      */
@@ -160,8 +158,6 @@ export interface UploadOptions extends RequestOptions {
     /**
      * Will encrypt the uploaded data and return longer hash which also includes the decryption key.
      *
-     * **Warning! Not allowed when node is in Gateway mode!**
-     *
      * @see [Bee docs - Store with Encryption](https://docs.ethswarm.org/docs/access-the-swarm/store-with-encryption)
      * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/Collection/paths/~1bzz/post)
      * @see Reference
@@ -299,7 +295,7 @@ export interface CollectionEntry<T> {
 /**
  * Represents Collections
  */
-export declare type Collection<T> = Array<CollectionEntry<T>>;
+export type Collection<T> = Array<CollectionEntry<T>>;
 export interface PssSubscription {
     readonly topic: string;
     cancel: () => void;
@@ -315,8 +311,8 @@ export interface BeeGenericResponse {
 export interface ReferenceResponse {
     reference: Reference;
 }
-export declare type HttpMethod = 'GET' | 'DELETE' | 'POST' | 'PATCH' | 'PUT';
-export declare type HookCallback<V> = (value: V) => void | Promise<void>;
+export type HttpMethod = 'GET' | 'DELETE' | 'POST' | 'PATCH' | 'PUT';
+export type HookCallback<V> = (value: V) => void | Promise<void>;
 export interface BeeRequest {
     url: string;
     method: HttpMethod;
@@ -337,7 +333,7 @@ export declare const TOPIC_HEX_LENGTH = 64;
 /**
  * Hex string of length 64 chars without prefix that specifies topics for feed.
  */
-export declare type Topic = HexString<typeof TOPIC_HEX_LENGTH>;
+export type Topic = HexString<typeof TOPIC_HEX_LENGTH>;
 /**
  * Result of upload calls.
  */
@@ -448,7 +444,7 @@ export interface PostageBatchBuckets {
     bucketUpperBound: number;
     buckets?: BatchBucket[];
 }
-export declare type TransactionHash = BrandedString<'TransactionHash'>;
+export type TransactionHash = BrandedString<'TransactionHash'>;
 export interface TransactionInfo {
     transactionHash: TransactionHash;
     to: HexEthAddress;
@@ -493,14 +489,14 @@ export interface PostageBatchOptions extends RequestOptions {
 /**
  * With this type a number should be represented in a string
  */
-export declare type NumberString = FlavoredType<string, 'NumberString'>;
+export type NumberString = FlavoredType<string, 'NumberString'>;
 /*********************************************************
  * Ethereum compatible signing interfaces and definitions
  */
 export declare const SIGNATURE_HEX_LENGTH = 130;
 export declare const SIGNATURE_BYTES_LENGTH = 65;
-export declare type Signature = Bytes<typeof SIGNATURE_BYTES_LENGTH>;
-export declare type PrivateKeyBytes = Bytes<32>;
+export type Signature = Bytes<typeof SIGNATURE_BYTES_LENGTH>;
+export type PrivateKeyBytes = Bytes<32>;
 /**
  * Signing function that takes digest in Uint8Array  to be signed that has helpers to convert it
  * conveniently into other types like hex-string (non prefix).
@@ -508,8 +504,8 @@ export declare type PrivateKeyBytes = Bytes<32>;
  *
  * @see Data
  */
-declare type SyncSigner = (digest: Data) => Signature | HexString<typeof SIGNATURE_HEX_LENGTH> | string;
-declare type AsyncSigner = (digest: Data) => Promise<Signature | HexString<typeof SIGNATURE_HEX_LENGTH> | string>;
+type SyncSigner = (digest: Data) => Signature | HexString<typeof SIGNATURE_HEX_LENGTH> | string;
+type AsyncSigner = (digest: Data) => Promise<Signature | HexString<typeof SIGNATURE_HEX_LENGTH> | string>;
 /**
  * Interface for implementing Ethereum compatible signing.
  *
@@ -527,7 +523,7 @@ declare type AsyncSigner = (digest: Data) => Promise<Signature | HexString<typeo
  * @property address  The ethereum address of the signer in bytes.
  * @see hashWithEthereumPrefix
  */
-export declare type Signer = {
+export type Signer = {
     sign: SyncSigner | AsyncSigner;
     address: EthAddress;
 };
@@ -536,16 +532,16 @@ export declare type Signer = {
  *
  * See https://spin.atomicobject.com/2018/01/15/typescript-flexible-nominal-typing/
  */
-export declare type BrandedType<Type, Name> = Type & {
+export type BrandedType<Type, Name> = Type & {
     __tag__: Name;
 };
-export declare type BrandedString<Name> = BrandedType<string, Name>;
-export declare type FlavoredType<Type, Name> = Type & {
+export type BrandedString<Name> = BrandedType<string, Name>;
+export type FlavoredType<Type, Name> = Type & {
     __tag__?: Name;
 };
-export declare type AnyJson = boolean | number | string | null | JsonArray | JsonMap;
+export type AnyJson = boolean | number | string | null | JsonArray | JsonMap;
 interface JsonMap {
     [key: string]: AnyJson;
 }
-declare type JsonArray = Array<AnyJson>;
-declare type Fetch = (input: RequestInfo, init?: RequestInit) => Promise<Response>;
+type JsonArray = Array<AnyJson>;
+type Fetch = (input: RequestInfo, init?: RequestInit) => Promise<Response>;

package/dist/types/utils/eth.d.ts

@@ -1,9 +1,9 @@
 import { BrandedString, Signer } from '../types';
 import { HexString } from './hex';
 import { Bytes } from './bytes';
-export declare type OverlayAddress = BrandedString<'OverlayAddress'>;
-export declare type EthAddress = Bytes<20>;
-export declare type HexEthAddress = HexString<40>;
+export type OverlayAddress = BrandedString<'OverlayAddress'>;
+export type EthAddress = Bytes<20>;
+export type HexEthAddress = HexString<40>;
 export declare function makeEthAddress(address: EthAddress | Uint8Array | string | unknown): EthAddress;
 export declare function makeHexEthAddress(address: EthAddress | Uint8Array | string | unknown): HexEthAddress;
 /**

package/dist/types/utils/hex.d.ts

@@ -5,7 +5,7 @@ import { BrandedType, FlavoredType } from '../types';
  * For example for 32 bytes hex representation you have to use 64 length.
  * TODO: Make Length mandatory: https://github.com/ethersphere/bee-js/issues/208
  */
-export declare type HexString<Length extends number = number> = FlavoredType<string & {
+export type HexString<Length extends number = number> = FlavoredType<string & {
     readonly length: Length;
 }, 'HexString'>;
 /**
@@ -15,7 +15,7 @@ export declare type HexString<Length extends number = number> = FlavoredType<str
  * Because of that it does not contain the Length property as the variables
  * should be validated and converted to HexString ASAP.
  */
-export declare type PrefixedHexString = BrandedType<string, 'PrefixedHexString'>;
+export type PrefixedHexString = BrandedType<string, 'PrefixedHexString'>;
 /**
  * Creates unprefixed hex string from wide range of data.
  *

package/dist/types/utils/http.d.ts

@@ -1,8 +1,9 @@
-import type { BeeRequest, BeeResponse, HookCallback, Ky } from '../types';
-import { Options as KyOptions } from 'ky-universal';
+import type { BeeRequest, BeeResponse, HookCallback } from '../types';
+import type { Options as KyOptions } from 'ky-universal';
 import { KyRequestOptions } from '../types';
+export declare const DEFAULT_KY_CONFIG: KyOptions;
 interface KyResponse<T> extends Response {
-    data: T;
+    parsedData: T;
 }
 export declare function wrapRequestClosure(cb: HookCallback<BeeRequest>): (request: Request) => Promise<void>;
 export declare function wrapResponseClosure(cb: HookCallback<BeeResponse>): (request: Request, options: unknown, response: Response) => Promise<void>;
@@ -15,9 +16,8 @@ export declare function wrapResponseClosure(cb: HookCallback<BeeResponse>): (req
 export declare function filterHeaders(obj?: object): Record<string, string> | undefined;
 /**
  * Main utility function to make HTTP requests.
- * @param ky
+ * @param kyOptions
  * @param config
  */
-export declare function http<T>(ky: Ky, config: KyRequestOptions): Promise<KyResponse<T>>;
-export declare function makeDefaultKy(kyConfig: KyOptions): Ky;
+export declare function http<T>(kyOptions: KyOptions, config: KyRequestOptions): Promise<KyResponse<T>>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethersphere/bee-js",
-  "version": "5.1.1",
+  "version": "5.1.2",
   "description": "Javascript client for Bee",
   "keywords": [
     "bee",
@@ -50,13 +50,7 @@
     "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",
-    "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 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",
+    "test": "mocha",
     "check:types": "tsc --project tsconfig.test.json",
     "lint": "eslint --fix \"src/**/*.ts\" \"test/**/*.ts\" && prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
     "lint:check": "eslint \"src/**/*.ts\" \"test/**/*.ts\" && prettier --check \"src/**/*.ts\" \"test/**/*.ts\"",
@@ -71,72 +65,73 @@
     "fetch-blob": "2.1.2",
     "isomorphic-ws": "^4.0.1",
     "js-sha3": "^0.8.0",
-    "ky": "^0.25.1",
-    "ky-universal": "^0.8.2",
+    "ky": "^0.33.2",
+    "ky-universal": "^0.11.0",
     "semver": "^7.3.5",
     "tar-js": "^0.3.0",
     "utf-8-validate": "^5.0.9",
-    "web-streams-polyfill": "^4.0.0-beta.1",
+    "web-streams-polyfill": "^4.0.0-beta.3",
     "ws": "^8.7.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.17.10",
-    "@babel/core": "^7.18.2",
+    "@babel/cli": "^7.19.3",
+    "@babel/core": "^7.20.5",
     "@babel/plugin-proposal-class-properties": "^7.16.7",
     "@babel/plugin-transform-runtime": "^7.17.0",
-    "@babel/preset-env": "^7.17.10",
-    "@babel/preset-typescript": "^7.14.5",
+    "@babel/preset-env": "^7.20.2",
+    "@babel/preset-typescript": "^7.18.6",
     "@commitlint/cli": "^17.0.2",
-    "@commitlint/config-conventional": "^16.2.1",
+    "@commitlint/config-conventional": "^17.4.2",
     "@ethersphere/bee-factory": "^0.5.2",
     "@fluffy-spoon/substitute": "^1.208.0",
-    "@jest/test-sequencer": "^27.5.0",
-    "@jest/types": "^27.5.1",
+    "@naholyr/cross-env": "^1.0.0",
+    "@types/chai": "^4.3.4",
+    "@types/chai-as-promised": "^7.1.5",
     "@types/content-disposition": "^0.5.4",
     "@types/debug": "^4.1.7",
     "@types/elliptic": "^6.4.14",
-    "@types/expect-puppeteer": "^4.4.7",
-    "@types/glob": "^7.2.0",
-    "@types/jest": "^26.0.23",
-    "@types/jest-environment-puppeteer": "^4.4.1",
-    "@types/node": "^15.12.4",
-    "@types/puppeteer": "^5.4.5",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^18.11.11",
     "@types/semver": "^7.3.9",
+    "@types/sinon": "^10.0.13",
+    "@types/sinon-chai": "^3.2.9",
     "@types/ws": "^8.5.3",
-    "@typescript-eslint/eslint-plugin": "^5.10.0",
-    "@typescript-eslint/parser": "^5.26.0",
-    "babel-jest": "^28.1.0",
-    "babel-loader": "^8.2.5",
+    "@typescript-eslint/eslint-plugin": "^5.46.0",
+    "@typescript-eslint/parser": "^5.46.0",
+    "babel-loader": "^9.1.0",
     "babel-plugin-add-import-extension": "^1.6.0",
+    "chai": "^4.3.7",
+    "chai-as-promised": "^7.1.1",
+    "chai-parentheses": "^0.0.2",
     "cross-blob": "^2.0.1",
     "cross-env": "^7.0.3",
     "debug": "^4.3.4",
     "depcheck": "^1.4.3",
     "eslint": "^8.13.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-jest": "^25.7.0",
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-unused-imports": "^2.0.0",
-    "glob": "^8.0.1",
+    "expect": "^29.4.0",
     "husky": "^8.0.1",
-    "jest": "^27.5.1",
-    "jest-puppeteer": "^6.1.0",
-    "nock": "^13.2.4",
+    "mocha": "^10.2.0",
+    "nock": "^13.3.0",
+    "playwright-test": "^8.1.2",
     "prettier": "^2.6.2",
-    "puppeteer": "^14.1.0",
     "rimraf": "^3.0.2",
+    "sinon": "^15.0.1",
+    "sinon-chai": "^3.7.0",
     "terser-webpack-plugin": "^5.3.1",
-    "ts-node": "^10.8.0",
-    "typescript": "^4.5.4",
-    "webpack": "^5.72.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.5",
+    "webpack": "^5.75.0",
     "webpack-bundle-analyzer": "^4.5.0",
-    "webpack-cli": "^4.9.2"
+    "webpack-cli": "^5.0.1"
   },
   "engines": {
     "node": ">=14.0.0",
     "npm": ">=6.0.0",
     "beeApiVersion": "4.0.0",
     "beeDebugApiVersion": "4.0.0",
-    "bee": "1.10.0-904cbb08"
+    "bee": "1.11.1-1992b846"
   }
 }

package/dist/cjs/types/ky-options.js

@@ -1,8 +0,0 @@
-"use strict";
-/**
- * Types extracted from Ky as a backport for older Ky non-ESM version
- *
- * @author https://github.com/sindresorhus
- * @licence MIT https://github.com/sindresorhus/ky/blob/main/license
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/ky-universal/common.js

@@ -1,8 +0,0 @@
-"use strict";
-/**
- * Types extracted from Ky as a backport for older Ky non-ESM version
- *
- * @author https://github.com/sindresorhus
- * @licence MIT https://github.com/sindresorhus/ky/blob/main/license
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/ky-universal/hooks.js

@@ -1,8 +0,0 @@
-"use strict";
-/**
- * Types extracted from Ky as a backport for older Ky non-ESM version
- *
- * @author https://github.com/sindresorhus
- * @licence MIT https://github.com/sindresorhus/ky/blob/main/license
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/ky-universal/retry.js

@@ -1,8 +0,0 @@
-"use strict";
-/**
- * Types extracted from Ky as a backport for older Ky non-ESM version
- *
- * @author https://github.com/sindresorhus
- * @licence MIT https://github.com/sindresorhus/ky/blob/main/license
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/mjs/types/ky-options.js

@@ -1,7 +0,0 @@
-/**
- * Types extracted from Ky as a backport for older Ky non-ESM version
- *
- * @author https://github.com/sindresorhus
- * @licence MIT https://github.com/sindresorhus/ky/blob/main/license
- */
-export {};

package/dist/mjs/types/ky-universal/common.js

@@ -1,7 +0,0 @@
-/**
- * Types extracted from Ky as a backport for older Ky non-ESM version
- *
- * @author https://github.com/sindresorhus
- * @licence MIT https://github.com/sindresorhus/ky/blob/main/license
- */
-export {};

package/dist/mjs/types/ky-universal/hooks.js

@@ -1,7 +0,0 @@
-/**
- * Types extracted from Ky as a backport for older Ky non-ESM version
- *
- * @author https://github.com/sindresorhus
- * @licence MIT https://github.com/sindresorhus/ky/blob/main/license
- */
-export {};

package/dist/mjs/types/ky-universal/retry.js

@@ -1,7 +0,0 @@
-/**
- * Types extracted from Ky as a backport for older Ky non-ESM version
- *
- * @author https://github.com/sindresorhus
- * @licence MIT https://github.com/sindresorhus/ky/blob/main/license
- */
-export {};