feat: update to bee-js v13 (#266)

* feat: update to bee-js v13

* fix: fix core-sdk definitions

* fix: remove backslash escaping from page titles

* fix: add namespace modules (#270)

Author: Cafe137

README.md

@@ -34,6 +34,38 @@ This command generates static content into the `build` directory and can be serv
 Don't forget to find and replace the version number for the whole of the docs folder. 
 
 
+## API Reference (`docs/api`)
+
+Everything under `docs/api` is [typedoc](https://typedoc.org) output generated from the bee-js sources and committed to this repository, so the site builds without a bee-js checkout.
+
+### Regenerating
+
+The generator reads two clones that are not part of this repository:
+
+```
+$ git clone https://github.com/ethersphere/bee-js sources/bee-js
+$ git clone https://github.com/ethersphere/core-sdk sources/core-sdk
+$ npm --prefix sources/bee-js install
+```
+
+Check both out at the release you are documenting, then run:
+
+```
+$ npm run generate-api
+```
+
+This drives typedoc via `typedoc.config.mjs` and reshapes the output into the layout the site expects: it lifts the main entry point's pages out of the `bee-js/src` directory typedoc nests them in, flattens the `Utils` namespace into `docs/api/namespaces/Utils`, folds the namespace class pages into `docs/api/classes` alongside the rest, turns the generated index into `Overview.md`, reduces references to TypeScript's own `lib.*.d.ts` to a machine-independent form, and links the `@ethersphere/core-sdk` re-exports against the core-sdk clone (`scripts/fix-core-sdk-links.mjs`, also runnable on its own as `npm run fix-api-links`).
+
+Review the result as a diff against what is already committed. Anything unrelated to the bee-js release you are documenting means the toolchain moved, not the docs.
+
+### Things worth knowing before changing it
+
+- **`typedoc` and `typedoc-plugin-markdown` are pinned exactly.** A plugin upgrade rewrites unrelated pages and drowns the diff, so upgrade them deliberately, on their own.
+- **The `typescript` devDependency exists only for this step.** Nothing in this repository is TypeScript; typedoc compiles the bee-js sources with it, so it has to track what `sources/bee-js` requires or generation fails with type errors.
+- **`scripts/typedoc-frontmatter-titles.mjs` is not optional.** typedoc escapes markdown characters in page headings (`# Variable: NULL\_OWNER`), and Docusaurus takes the browser tab title, sidebar label, breadcrumbs and prev/next links from that raw heading without undoing the escapes. The plugin adds an unescaped frontmatter `title` instead. The escaping itself is not configurable upstream, and the heading has to stay escaped or MDX parses `\<V\>` as JSX.
+- **The namespace classes reach the reference through extra entry points.** The classes behind `bee.data`, `bee.stamp` and the rest live in `src/modules/*.ts` and are not exported from bee-js's `src/index.ts`, so typedoc would otherwise render them as the unlinkable type of a `Bee` property. `typedoc.config.mjs` adds `src/modules/*.ts` as entry points of their own to give them pages. Their names collide with exported types (`Data`, `Tag`, `Pin`, `Collection`, `Chunk`), which is harmless because each entry point is its own typedoc module — but it is also why nothing may fold those pages together with the exported types of the same name.
+- **Multiple entry points are what puts every page under `bee-js/src`.** typedoc names a module directory after each entry point's path, so the whole reference arrives one subtree down. `generate-api.mjs` moves that subtree up as one piece, which is what keeps the relative links inside it correct without rewriting any of them. Should bee-js move `src/modules` or rename the entry file, that lift is the first thing to break.
+
 ## Maintainers
 
 See what "Maintainer" means [here](https://github.com/ethersphere/repo-maintainer).

TASK.md

@@ -0,0 +1,10 @@
+# Current task
+
+There are several open issues with titles only. Maybe they are already fixed. Please assess them:
+
+-   New functions: getWithdrawableStake, withdrawSurplusStake and migrateStake
+-   New functions: withdrawBZZToExternalWallet and withdrawDAIToExternalWallet
+-   Deprecation: withdrawTokens and depositTokens
+-   new Bytes is unnecessary, simply use toHex() on the returned classes
+
+Please note that the methods in these issues are from before the namespace restructuring, so you'll have to cross-check with the wandered method names.

docs/api/Overview.md

@@ -17,30 +17,52 @@ sidebar_position: 0
 
 ## Classes
 
+- [Balance](classes/Balance.md)
 - [BatchId](classes/BatchId.md)
 - [Bee](classes/Bee.md)
 - [BeeArgumentError](classes/BeeArgumentError.md)
-- [BeeDev](classes/BeeDev.md)
 - [BeeError](classes/BeeError.md)
 - [BeeResponseError](classes/BeeResponseError.md)
 - [Bytes](classes/Bytes.md)
 - [BZZ](classes/BZZ.md)
+- [Cheque](classes/Cheque.md)
+- [Chequebook](classes/Chequebook.md)
+- [Chunk](classes/Chunk.md)
+- [ChunkBuilder](classes/ChunkBuilder.md)
+- [ChunkSplitter](classes/ChunkSplitter.md)
+- [Collection](classes/Collection.md)
+- [Connectivity](classes/Connectivity.md)
 - [DAI](classes/DAI.md)
+- [Data](classes/Data.md)
 - [Duration](classes/Duration.md)
 - [EthAddress](classes/EthAddress.md)
+- [Feed](classes/Feed.md)
 - [FeedIndex](classes/FeedIndex.md)
+- [File](classes/File.md)
+- [Grantee](classes/Grantee.md)
 - [Identifier](classes/Identifier.md)
 - [MantarayNode](classes/MantarayNode.md)
+- [Messaging](classes/Messaging.md)
 - [PeerAddress](classes/PeerAddress.md)
+- [Pin](classes/Pin.md)
 - [PrivateKey](classes/PrivateKey.md)
 - [PublicKey](classes/PublicKey.md)
 - [Reference](classes/Reference.md)
+- [Settlement](classes/Settlement.md)
 - [Signature](classes/Signature.md)
 - [Size](classes/Size.md)
+- [Soc](classes/Soc.md)
 - [Span](classes/Span.md)
+- [Stake](classes/Stake.md)
+- [Stamp](classes/Stamp.md)
 - [Stamper](classes/Stamper.md)
+- [Status](classes/Status.md)
+- [Storage](classes/Storage.md)
+- [Tag](classes/Tag.md)
 - [Topic](classes/Topic.md)
+- [Transaction](classes/Transaction.md)
 - [TransactionId](classes/TransactionId.md)
+- [Wallet](classes/Wallet.md)
 
 ## Interfaces
 
@@ -58,6 +80,7 @@ sidebar_position: 0
 - [Cheque](interfaces/Cheque.md)
 - [ChequebookAddressResponse](interfaces/ChequebookAddressResponse.md)
 - [ChequebookBalanceResponse](interfaces/ChequebookBalanceResponse.md)
+- [Chunk](interfaces/Chunk.md)
 - [CollectionEntry](interfaces/CollectionEntry.md)
 - [CollectionUploadOptions](interfaces/CollectionUploadOptions.md)
 - [Data](interfaces/Data.md)
@@ -98,6 +121,7 @@ sidebar_position: 0
 - [RemovePeerResponse](interfaces/RemovePeerResponse.md)
 - [ReserveState](interfaces/ReserveState.md)
 - [Settlements](interfaces/Settlements.md)
+- [SingleOwnerChunk](interfaces/SingleOwnerChunk.md)
 - [SOCReader](interfaces/SOCReader.md)
 - [SOCWriter](interfaces/SOCWriter.md)
 - [Tag](interfaces/Tag.md)
@@ -107,6 +131,7 @@ sidebar_position: 0
 - [TransactionResponse](interfaces/TransactionResponse.md)
 - [UploadHeaders](interfaces/UploadHeaders.md)
 - [UploadOptions](interfaces/UploadOptions.md)
+- [UploadProgress](interfaces/UploadProgress.md)
 - [UploadResult](interfaces/UploadResult.md)
 - [WalletBalance](interfaces/WalletBalance.md)
 
@@ -121,8 +146,8 @@ sidebar_position: 0
 ## Variables
 
 - [BRANCHES](variables/BRANCHES.md)
+- [capacityBreakpoints](variables/capacityBreakpoints.md)
 - [CHUNK\_SIZE](variables/CHUNK_SIZE.md)
-- [FEED\_INDEX\_HEX\_LENGTH](variables/FEED_INDEX_HEX_LENGTH.md)
 - [NULL\_ADDRESS](variables/NULL_ADDRESS.md)
 - [NULL\_IDENTIFIER](variables/NULL_IDENTIFIER.md)
 - [NULL\_OWNER](variables/NULL_OWNER.md)

docs/api/classes/BZZ.md

@@ -1,22 +1,22 @@
 # Class: BZZ
 
-Defined in: [bee-js/src/utils/tokens.ts:4](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L4)
+Defined in: [bee-js/src/utils/tokens.ts:4](https://github.com/ethersphere/bee-js/blob/bab2b2e5a3874187d29a1c1e6c70f2f645ed53c2/src/utils/tokens.ts#L4)
 
 ## Properties
 
 ### DIGITS
 
 > `readonly` `static` **DIGITS**: `16` = `16`
 
-Defined in: [bee-js/src/utils/tokens.ts:5](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L5)
+Defined in: [bee-js/src/utils/tokens.ts:5](https://github.com/ethersphere/bee-js/blob/bab2b2e5a3874187d29a1c1e6c70f2f645ed53c2/src/utils/tokens.ts#L5)
 
 ## Methods
 
 ### divide()
 
 > **divide**(`other`): `BZZ`
 
-Defined in: [bee-js/src/utils/tokens.ts:63](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L63)
+Defined in: [bee-js/src/utils/tokens.ts:71](https://github.com/ethersphere/bee-js/blob/bab2b2e5a3874187d29a1c1e6c70f2f645ed53c2/src/utils/tokens.ts#L71)
 
 Does not mutate the current BZZ instance.
 
@@ -40,7 +40,7 @@ New BZZ instance
 
 > **eq**(`other`): `boolean`
 
-Defined in: [bee-js/src/utils/tokens.ts:83](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L83)
+Defined in: [bee-js/src/utils/tokens.ts:91](https://github.com/ethersphere/bee-js/blob/bab2b2e5a3874187d29a1c1e6c70f2f645ed53c2/src/utils/tokens.ts#L91)
 
 #### Parameters
 
@@ -58,7 +58,7 @@ Defined in: [bee-js/src/utils/tokens.ts:83](https://github.com/ethersphere/bee-j
 
 > **exchangeToDAI**(`daiPerBzz`): [`DAI`](DAI.md)
 
-Defined in: [bee-js/src/utils/tokens.ts:87](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L87)
+Defined in: [bee-js/src/utils/tokens.ts:95](https://github.com/ethersphere/bee-js/blob/bab2b2e5a3874187d29a1c1e6c70f2f645ed53c2/src/utils/tokens.ts#L95)
 
 #### Parameters
 
@@ -76,7 +76,7 @@ Defined in: [bee-js/src/utils/tokens.ts:87](https://github.com/ethersphere/bee-j
 
 > **gt**(`other`): `boolean`
 
-Defined in: [bee-js/src/utils/tokens.ts:67](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L67)
+Defined in: [bee-js/src/utils/tokens.ts:75](https://github.com/ethersphere/bee-js/blob/bab2b2e5a3874187d29a1c1e6c70f2f645ed53c2/src/utils/tokens.ts#L75)
 
 #### Parameters
 
@@ -94,7 +94,7 @@ Defined in: [bee-js/src/utils/tokens.ts:67](https://github.com/ethersphere/bee-j
 
 > **gte**(`other`): `boolean`
 
-Defined in: [bee-js/src/utils/tokens.ts:71](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L71)
+Defined in: [bee-js/src/utils/tokens.ts:79](https://github.com/ethersphere/bee-js/blob/bab2b2e5a3874187d29a1c1e6c70f2f645ed53c2/src/utils/tokens.ts#L79)
 
 #### Parameters
 
@@ -112,7 +112,7 @@ Defined in: [bee-js/src/utils/tokens.ts:71](https://github.com/ethersphere/bee-j
 
 > **lt**(`other`): `boolean`
 
-Defined in: [bee-js/src/utils/tokens.ts:75](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L75)
+Defined in: [bee-js/src/utils/tokens.ts:83](https://github.com/ethersphere/bee-js/blob/bab2b2e5a3874187d29a1c1e6c70f2f645ed53c2/src/utils/tokens.ts#L83)
 
 #### Parameters
 
@@ -130,7 +130,7 @@ Defined in: [bee-js/src/utils/tokens.ts:75](https://github.com/ethersphere/bee-j
 
 > **lte**(`other`): `boolean`
 
-Defined in: [bee-js/src/utils/tokens.ts:79](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L79)
+Defined in: [bee-js/src/utils/tokens.ts:87](https://github.com/ethersphere/bee-js/blob/bab2b2e5a3874187d29a1c1e6c70f2f645ed53c2/src/utils/tokens.ts#L87)
 
 #### Parameters
 
@@ -148,7 +148,7 @@ Defined in: [bee-js/src/utils/tokens.ts:79](https://github.com/ethersphere/bee-j
 
 > **minus**(`other`): `BZZ`
 
-Defined in: [bee-js/src/utils/tokens.ts:53](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L53)
+Defined in: [bee-js/src/utils/tokens.ts:61](https://github.com/ethersphere/bee-js/blob/bab2b2e5a3874187d29a1c1e6c70f2f645ed53c2/src/utils/tokens.ts#L61)
 
 Does not mutate the current BZZ instance.
 
@@ -172,7 +172,7 @@ New BZZ instance
 
 > **plus**(`other`): `BZZ`
 
-Defined in: [bee-js/src/utils/tokens.ts:43](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L43)
+Defined in: [bee-js/src/utils/tokens.ts:51](https://github.com/ethersphere/bee-js/blob/bab2b2e5a3874187d29a1c1e6c70f2f645ed53c2/src/utils/tokens.ts#L51)
 
 Does not mutate the current BZZ instance.
 
@@ -196,19 +196,31 @@ New BZZ instance
 
 > **toDecimalString**(): `string`
 
-Defined in: [bee-js/src/utils/tokens.ts:29](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L29)
+Defined in: [bee-js/src/utils/tokens.ts:33](https://github.com/ethersphere/bee-js/blob/bab2b2e5a3874187d29a1c1e6c70f2f645ed53c2/src/utils/tokens.ts#L33)
 
 #### Returns
 
 `string`
 
 ***
 
+### toFloat()
+
+> **toFloat**(): `number`
+
+Defined in: [bee-js/src/utils/tokens.ts:37](https://github.com/ethersphere/bee-js/blob/bab2b2e5a3874187d29a1c1e6c70f2f645ed53c2/src/utils/tokens.ts#L37)
+
+#### Returns
+
+`number`
+
+***
+
 ### toPLURBigInt()
 
 > **toPLURBigInt**(): `bigint`
 
-Defined in: [bee-js/src/utils/tokens.ts:25](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L25)
+Defined in: [bee-js/src/utils/tokens.ts:29](https://github.com/ethersphere/bee-js/blob/bab2b2e5a3874187d29a1c1e6c70f2f645ed53c2/src/utils/tokens.ts#L29)
 
 #### Returns
 
@@ -220,7 +232,7 @@ Defined in: [bee-js/src/utils/tokens.ts:25](https://github.com/ethersphere/bee-j
 
 > **toPLURString**(): `string`
 
-Defined in: [bee-js/src/utils/tokens.ts:21](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L21)
+Defined in: [bee-js/src/utils/tokens.ts:25](https://github.com/ethersphere/bee-js/blob/bab2b2e5a3874187d29a1c1e6c70f2f645ed53c2/src/utils/tokens.ts#L25)
 
 #### Returns
 
@@ -232,7 +244,7 @@ Defined in: [bee-js/src/utils/tokens.ts:21](https://github.com/ethersphere/bee-j
 
 > **toSignificantDigits**(`digits`): `string`
 
-Defined in: [bee-js/src/utils/tokens.ts:33](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L33)
+Defined in: [bee-js/src/utils/tokens.ts:41](https://github.com/ethersphere/bee-js/blob/bab2b2e5a3874187d29a1c1e6c70f2f645ed53c2/src/utils/tokens.ts#L41)
 
 #### Parameters
 
@@ -250,7 +262,7 @@ Defined in: [bee-js/src/utils/tokens.ts:33](https://github.com/ethersphere/bee-j
 
 > `static` **fromDecimalString**(`string`): `BZZ`
 
-Defined in: [bee-js/src/utils/tokens.ts:13](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L13)
+Defined in: [bee-js/src/utils/tokens.ts:13](https://github.com/ethersphere/bee-js/blob/bab2b2e5a3874187d29a1c1e6c70f2f645ed53c2/src/utils/tokens.ts#L13)
 
 #### Parameters
 
@@ -264,11 +276,29 @@ Defined in: [bee-js/src/utils/tokens.ts:13](https://github.com/ethersphere/bee-j
 
 ***
 
+### fromFloat()
+
+> `static` **fromFloat**(`float`): `BZZ`
+
+Defined in: [bee-js/src/utils/tokens.ts:21](https://github.com/ethersphere/bee-js/blob/bab2b2e5a3874187d29a1c1e6c70f2f645ed53c2/src/utils/tokens.ts#L21)
+
+#### Parameters
+
+##### float
+
+`number`
+
+#### Returns
+
+`BZZ`
+
+***
+
 ### fromPLUR()
 
 > `static` **fromPLUR**(`plur`): `BZZ`
 
-Defined in: [bee-js/src/utils/tokens.ts:17](https://github.com/ethersphere/bee-js/blob/3abbe2b1b264d6b586511a56e93badb2236bd09d/src/utils/tokens.ts#L17)
+Defined in: [bee-js/src/utils/tokens.ts:17](https://github.com/ethersphere/bee-js/blob/bab2b2e5a3874187d29a1c1e6c70f2f645ed53c2/src/utils/tokens.ts#L17)
 
 #### Parameters