@ethersphere/bee-dashboard 0.8.0 → 0.11.2

package/lib/src/pages/status/SetupSteps/ChequebookDeployFund.d.ts

@@ -0,0 +1,3 @@
+import type { ReactElement } from 'react';
+declare const ChequebookDeployFund: () => ReactElement | null;
+export default ChequebookDeployFund;

package/lib/src/pages/status/SetupSteps/DebugConnectionCheck.d.ts

@@ -0,0 +1,2 @@
+import { ReactElement } from 'react';
+export default function NodeConnectionCheck(): ReactElement | null;

package/lib/src/pages/status/SetupSteps/EthereumConnectionCheck.d.ts

@@ -0,0 +1,2 @@
+import { ReactElement } from 'react';
+export default function EthereumConnectionCheck(): ReactElement | null;

package/lib/src/pages/status/SetupSteps/NodeConnectionCheck.d.ts

@@ -0,0 +1,2 @@
+import { ReactElement } from 'react';
+export default function NodeConnectionCheck(): ReactElement | null;

package/lib/src/pages/status/SetupSteps/PeerConnection.d.ts

@@ -0,0 +1,2 @@
+import { ReactElement } from 'react';
+export default function PeerConnection(): ReactElement | null;

package/lib/src/pages/status/SetupSteps/VersionCheck.d.ts

@@ -0,0 +1,2 @@
+import { ReactElement } from 'react';
+export default function VersionCheck(): ReactElement | null;

package/lib/src/pages/status/index.d.ts

@@ -0,0 +1,2 @@
+import type { ReactElement } from 'react';
+export default function NodeSetupWorkflow(): ReactElement;

package/lib/src/providers/Bee.d.ts

@@ -0,0 +1,45 @@
+import type { ChequebookAddressResponse, Health, LastChequesResponse, NodeAddresses, Peer, Topology } from '@ethersphere/bee-js';
+import { ReactChild, ReactElement } from 'react';
+import type { Balance, ChequebookBalance, Settlements } from '../types';
+interface Status {
+    all: boolean;
+    version: boolean;
+    blockchainConnection: boolean;
+    debugApiConnection: boolean;
+    apiConnection: boolean;
+    topology: boolean;
+    chequebook: boolean;
+}
+interface ContextInterface {
+    status: Status;
+    latestPublishedVersion?: string;
+    latestUserVersion?: string;
+    latestUserVersionExact?: string;
+    isLatestBeeVersion: boolean;
+    latestBeeVersionUrl: string;
+    error: Error | null;
+    apiHealth: boolean;
+    debugApiHealth: Health | null;
+    nodeAddresses: NodeAddresses | null;
+    topology: Topology | null;
+    chequebookAddress: ChequebookAddressResponse | null;
+    peers: Peer[] | null;
+    chequebookBalance: ChequebookBalance | null;
+    peerBalances: Balance[] | null;
+    peerCheques: LastChequesResponse | null;
+    settlements: Settlements | null;
+    latestBeeRelease: LatestBeeRelease | null;
+    isLoading: boolean;
+    isRefreshing: boolean;
+    lastUpdate: number | null;
+    start: (frequency?: number) => void;
+    stop: () => void;
+    refresh: () => Promise<void>;
+}
+export declare const Context: import("react").Context<ContextInterface>;
+export declare const Consumer: import("react").Consumer<ContextInterface>;
+interface Props {
+    children: ReactChild;
+}
+export declare function Provider({ children }: Props): ReactElement;
+export {};

package/lib/src/providers/File.d.ts

@@ -0,0 +1,13 @@
+import { ReactChild, ReactElement } from 'react';
+import { SwarmFile } from '../utils/SwarmFile';
+interface ContextInterface {
+    files: SwarmFile[];
+    setFiles: (files: SwarmFile[]) => void;
+}
+export declare const Context: import("react").Context<ContextInterface>;
+export declare const Consumer: import("react").Consumer<ContextInterface>;
+interface Props {
+    children: ReactChild;
+}
+export declare function Provider({ children }: Props): ReactElement;
+export {};

package/lib/src/providers/Platform.d.ts

@@ -0,0 +1,23 @@
+import { ReactChild, ReactElement } from 'react';
+export declare enum Platforms {
+    macOS = 0,
+    Linux = 1,
+    Windows = 2,
+    iOS = 3,
+    Android = 4
+}
+export declare enum SupportedPlatforms {
+    macOS = 0,
+    Linux = 1
+}
+interface ContextInterface {
+    platform: SupportedPlatforms;
+    setPlatform: (platform: SupportedPlatforms) => void;
+}
+export declare const Context: import("react").Context<ContextInterface>;
+export declare const Consumer: import("react").Consumer<ContextInterface>;
+interface Props {
+    children: ReactChild;
+}
+export declare function Provider({ children }: Props): ReactElement;
+export {};

package/lib/src/providers/Settings.d.ts

@@ -0,0 +1,21 @@
+import { Bee, BeeDebug } from '@ethersphere/bee-js';
+import { ReactChild, ReactElement } from 'react';
+interface ContextInterface {
+    apiUrl: string;
+    apiDebugUrl: string;
+    beeApi: Bee | null;
+    beeDebugApi: BeeDebug | null;
+    setApiUrl: (url: string) => void;
+    setDebugApiUrl: (url: string) => void;
+    lockedApiSettings: boolean;
+}
+export declare const Context: import("react").Context<ContextInterface>;
+export declare const Consumer: import("react").Consumer<ContextInterface>;
+interface Props {
+    children: ReactChild;
+    beeApiUrl?: string;
+    beeDebugApiUrl?: string;
+    lockedApiSettings?: boolean;
+}
+export declare function Provider({ children, beeApiUrl, beeDebugApiUrl, lockedApiSettings: extLockedApiSettings, }: Props): ReactElement;
+export {};

package/lib/src/providers/Stamps.d.ts

@@ -0,0 +1,22 @@
+import { PostageBatch } from '@ethersphere/bee-js';
+import { ReactChild, ReactElement } from 'react';
+export interface EnrichedPostageBatch extends PostageBatch {
+    usage: number;
+    usageText: string;
+}
+interface ContextInterface {
+    stamps: EnrichedPostageBatch[] | null;
+    error: Error | null;
+    isLoading: boolean;
+    lastUpdate: number | null;
+    start: (frequency?: number) => void;
+    stop: () => void;
+    refresh: () => Promise<void>;
+}
+export declare const Context: import("react").Context<ContextInterface>;
+export declare const Consumer: import("react").Consumer<ContextInterface>;
+interface Props {
+    children: ReactChild;
+}
+export declare function Provider({ children }: Props): ReactElement;
+export {};

package/lib/src/reportWebVitals.d.ts

@@ -0,0 +1,3 @@
+import { ReportHandler } from 'web-vitals';
+declare const reportWebVitals: (onPerfEntry?: ReportHandler | undefined) => void;
+export default reportWebVitals;

package/lib/src/routes.d.ts

@@ -0,0 +1,15 @@
+import type { ReactElement } from 'react';
+export declare enum ROUTES {
+    INFO = "/",
+    FILES = "/files",
+    UPLOAD = "/files/upload",
+    UPLOAD_IN_PROGRESS = "/files/upload/workflow",
+    DOWNLOAD = "/files/download",
+    HASH = "/files/hash/:hash",
+    ACCOUNTING = "/accounting",
+    SETTINGS = "/settings",
+    STAMPS = "/stamps",
+    STATUS = "/status"
+}
+declare const BaseRouter: () => ReactElement;
+export default BaseRouter;

package/lib/src/setupTests.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package/lib/src/theme.d.ts

@@ -0,0 +1,7 @@
+import { Theme } from '@material-ui/core/styles';
+declare module '@material-ui/core/styles/createPalette' {
+    interface TypeBackground {
+        appBar: string;
+    }
+}
+export declare const theme: Theme;

package/lib/src/types.d.ts

@@ -0,0 +1,19 @@
+import type { Token } from './models/Token';
+export interface ChequebookBalance {
+    totalBalance: Token;
+    availableBalance: Token;
+}
+export interface Balance {
+    peer: string;
+    balance: Token;
+}
+export interface Settlement {
+    peer: string;
+    received: Token;
+    sent: Token;
+}
+export interface Settlements {
+    totalReceived: Token;
+    totalSent: Token;
+    settlements: Settlement[];
+}

package/lib/src/utils/SwarmFile.d.ts

@@ -0,0 +1,10 @@
+export declare class SwarmFile {
+    name: string;
+    path: string;
+    type: string;
+    size: number;
+    webkitRelativePath: string;
+    arrayBuffer: () => Promise<ArrayBuffer>;
+    private data;
+    constructor(file: File);
+}

package/lib/src/utils/date.d.ts

@@ -0,0 +1 @@
+export declare function getPrettyDateString(date: Date): string;

package/lib/src/utils/file.d.ts

@@ -0,0 +1,7 @@
+import { FileData } from '@ethersphere/bee-js';
+import { SwarmFile } from './SwarmFile';
+export declare function detectIndexHtml(files: SwarmFile[]): string | false;
+export declare function getHumanReadableFileSize(bytes: number): string;
+export declare function convertBeeFileToBrowserFile(file: FileData<ArrayBuffer>): Partial<File>;
+export declare function convertManifestToFiles(files: Record<string, string>): SwarmFile[];
+export declare function getAssetNameFromFiles(files: SwarmFile[]): string;

package/lib/src/utils/hash.d.ts

@@ -0,0 +1 @@
+export declare function shortenHash(hash: string, sliceLength?: number): string;

package/lib/src/utils/index.d.ts

@@ -0,0 +1,52 @@
+import { BigNumber } from 'bignumber.js';
+/**
+ * Test if value is an integer
+ *
+ * @param value Value to be tested if it is an integer
+ *
+ * @returns True if the passed in value is integer
+ */
+export declare function isInteger(value: unknown): value is BigNumber | bigint;
+/**
+ *Convert value into a BigNumber if not already
+ *
+ * @param value Value to be converted
+ *
+ * @throws {TypeError} if the value is not convertible to a BigNumber
+ *
+ * @returns BigNumber - but it may still be NaN or Infinite
+ */
+export declare function makeBigNumber(value: BigNumber | BigInt | number | string): BigNumber | never;
+export declare type PromiseSettlements<T> = {
+    fulfilled: PromiseFulfilledResult<T>[];
+    rejected: PromiseRejectedResult[];
+};
+export declare type UnwrappedPromiseSettlements<T> = {
+    fulfilled: T[];
+    rejected: string[];
+};
+export declare function sleepMs(ms: number): Promise<void>;
+/**
+ * Maps the returned results of `Promise.allSettled` to an object
+ * with `fulfilled` and `rejected` arrays for easy access.
+ *
+ * The results still need to be unwrapped to get the fulfilled values or rejection reasons.
+ */
+export declare function mapPromiseSettlements<T>(promises: PromiseSettledResult<T>[]): PromiseSettlements<T>;
+/**
+ * Maps the returned values of `Promise.allSettled` to an object
+ * with `fulfilled` and `rejected` arrays for easy access.
+ *
+ * For rejected promises, the value is the stringified `reason`,
+ * or `'Unknown error'` string when it is unavailable.
+ */
+export declare function unwrapPromiseSettlements<T>(promiseSettledResults: PromiseSettledResult<T>[]): UnwrappedPromiseSettlements<T>;
+/**
+ * Wraps a `Promise<T>` or async function inside a new `Promise<T>`,
+ * which retries the original function up to `maxRetries` times,
+ * waiting `delayMs` milliseconds between failed attempts.
+ *
+ * If all attempts fail, then this `Promise<T>` also rejects.
+ */
+export declare function makeRetriablePromise<T>(fn: () => Promise<T>, maxRetries?: number, delayMs?: number): Promise<T>;
+export declare function extractSwarmHash(string: string): string | null;

package/lib/src/utils/local-storage.d.ts

@@ -0,0 +1,12 @@
+export declare enum HISTORY_KEYS {
+    UPLOAD_HISTORY = "UPLOAD_HISTORY",
+    DOWNLOAD_HISTORY = "DOWNLOAD_HISTORY"
+}
+export interface HistoryItem {
+    createdAt: number;
+    name: string;
+    hash: string;
+}
+export declare function putHistory(key: string, hash: string, name: string): void;
+export declare function getHistorySafe(key: string): HistoryItem[];
+export declare function determineHistoryName(hash: string, indexDocument?: string | null): string;

package/lib/src/utils/threshold.d.ts

@@ -0,0 +1,22 @@
+interface Threshold {
+    minimumValue: number;
+    explanation: string;
+    score: number;
+}
+declare type Thresholds = {
+    connectedPeers: Threshold[];
+    population: Threshold[];
+    depth: Threshold[];
+};
+declare type ThresholdValue = {
+    score: number;
+    maximumScore: number;
+    explanation: string;
+};
+export declare type ThresholdValues = {
+    connectedPeers: ThresholdValue;
+    population: ThresholdValue;
+    depth: ThresholdValue;
+};
+export declare function pickThreshold(key: keyof Thresholds, value: number): ThresholdValue;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethersphere/bee-dashboard",
-  "version": "0.8.0",
+  "version": "0.11.2",
   "description": "An app which helps users to setup their Bee node and do actions like cash out cheques",
   "keywords": [
     "bee",
@@ -15,6 +15,8 @@
   "bin": {
     "bee-dashboard": "./serve.js"
   },
+  "main": "lib/App.js",
+  "types": "lib/src/App.d.ts",
   "bugs": {
     "url": "https://github.com/ethersphere/bee-dashboard/issues/"
   },
@@ -24,72 +26,101 @@
     "url": "https://github.com/ethersphere/bee-dashboard.git"
   },
   "dependencies": {
-    "@ethersphere/bee-js": "2.1.0",
+    "@ethersphere/bee-js": "3.0.0",
+    "@ethersphere/manifest-js": "^1.0.0",
     "@material-ui/core": "4.12.3",
     "@material-ui/icons": "4.11.2",
     "@material-ui/lab": "4.0.0-alpha.57",
-    "@types/react-router": "5.1.13",
-    "@types/react-router-dom": "5.1.7",
-    "axios": "0.21.1",
+    "axios": "0.24.0",
     "bignumber.js": "9.0.1",
-    "feather-icons": "4.28.0",
-    "formik": "2.2.8",
+    "file-saver": "^2.0.5",
+    "formik": "2.2.9",
     "formik-material-ui": "3.0.1",
+    "jszip": "^3.7.1",
     "material-ui-dropzone": "3.5.0",
-    "notistack": "1.0.9",
+    "notistack": "1.0.10",
     "opener": "1.5.2",
     "qrcode.react": "1.0.1",
-    "react": "17.0.2",
-    "react-copy-to-clipboard": "5.0.3",
-    "react-dom": "17.0.2",
+    "react": ">= 17.0.2",
+    "react-copy-to-clipboard": "5.0.4",
+    "react-dom": ">= 17.0.2",
     "react-feather": "2.0.9",
     "react-identicons": "1.2.5",
+    "react-router": "5.2.0",
     "react-router-dom": "5.2.0",
-    "react-syntax-highlighter": "15.4.3",
-    "semver": "7.3.2",
+    "react-syntax-highlighter": "15.4.4",
+    "semver": "7.3.5",
     "serve-handler": "6.1.3"
   },
   "devDependencies": {
-    "@testing-library/jest-dom": "5.12.0",
-    "@testing-library/react": "11.2.6",
-    "@testing-library/user-event": "13.1.5",
-    "@types/jest": "26.0.22",
-    "@types/node": "14.14.41",
-    "@types/qrcode.react": "1.0.1",
-    "@types/react": "17.0.3",
-    "@types/react-copy-to-clipboard": "5.0.0",
-    "@types/react-dom": "17.0.3",
-    "@types/react-syntax-highlighter": "13.5.0",
-    "@types/semver": "7.3.6",
-    "eslint": "7.32.0",
-    "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-jest": "24.4.0",
-    "eslint-plugin-prettier": "3.4.1",
-    "eslint-plugin-react": "7.24.0",
-    "prettier": "2.3.2",
+    "@babel/core": "7.16.0",
+    "@babel/plugin-proposal-class-properties": "7.16.0",
+    "@babel/plugin-transform-runtime": "7.16.4",
+    "@babel/preset-env": "7.16.4",
+    "@babel/preset-react": "7.16.0",
+    "@babel/preset-typescript": "7.16.0",
+    "@commitlint/config-conventional": "14.1.0",
+    "@testing-library/jest-dom": "5.15.0",
+    "@testing-library/react": "12.1.2",
+    "@types/file-saver": "2.0.4",
+    "@types/jest": "27.0.2",
+    "@types/qrcode.react": "1.0.2",
+    "@types/react": "17.0.34",
+    "@types/react-copy-to-clipboard": "5.0.2",
+    "@types/react-dom": "17.0.11",
+    "@types/react-router": "5.1.17",
+    "@types/react-router-dom": "5.3.2",
+    "@types/react-syntax-highlighter": "13.5.2",
+    "@types/semver": "7.3.9",
+    "@typescript-eslint/eslint-plugin": "4.33.0",
+    "@typescript-eslint/parser": "4.33.0",
+    "babel-eslint": "10.1.0",
+    "babel-loader": "8.1.0",
+    "babel-plugin-syntax-dynamic-import": "6.18.0",
+    "babel-plugin-tsconfig-paths": "1.0.2",
+    "depcheck": "1.4.2",
+    "eslint": "7.24.0",
+    "eslint-config-prettier": "8.2.0",
+    "eslint-config-react-app": "6.0.0",
+    "eslint-plugin-flowtype": "5.10.0",
+    "eslint-plugin-import": "2.25.2",
+    "eslint-plugin-jest": "24.3.5",
+    "eslint-plugin-jsx-a11y": "6.4.1",
+    "eslint-plugin-prettier": "3.4.0",
+    "eslint-plugin-react": "7.23.2",
+    "eslint-plugin-react-hooks": "4.2.0",
+    "eslint-plugin-testing-library": "3.10.2",
+    "file-loader": "6.2.0",
+    "prettier": "2.4.1",
     "react-scripts": "4.0.3",
-    "typescript": "4.2.4",
-    "web-vitals": "1.1.1"
+    "ts-node": "^10.4.0",
+    "typescript": "4.4.4",
+    "web-vitals": "2.1.2",
+    "webpack": "4.44.2",
+    "webpack-cli": "^4.9.1"
+  },
+  "peerDependencies": {
+    "react": ">= 17.0.2",
+    "react-dom": ">= 17.0.2"
   },
   "scripts": {
     "prepare": "npm run build",
     "start": "react-scripts start",
     "build": "react-scripts build",
+    "build:component": "TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\"}' webpack --mode=production",
+    "compile:types": "tsc --project tsconfig.lib.json --emitDeclarationOnly --declaration",
     "test": "react-scripts test",
     "serve": "node ./serve.js",
+    "depcheck": "depcheck .",
     "lint": "eslint --fix \"src/**/*.ts\" \"src/**/*.tsx\" && prettier --write \"src/**/*.ts\" \"src/**/*.tsx\"",
-    "lint:check": "eslint \"src/**/*.ts\" \"src/**/*.tsx\" && prettier --check \"src/**/*.ts\" \"src/**/*.tsx\""
+    "lint:check": "eslint \"src/**/*.ts\" \"src/**/*.tsx\" && prettier --check \"src/**/*.ts\" \"src/**/*.tsx\"",
+    "check:types": "tsc --project tsconfig.lib.json"
   },
   "files": [
+    "lib",
     "build",
     "serve.js"
   ],
-  "eslintConfig": {
-    "extends": [
-      "react-app",
-      "react-app/jest"
-    ]
-  },
   "browserslist": {
     "production": [
       ">0.2%",