@ethersphere/bee-js 1.2.1 → 3.0.0

package/.github/workflows/check.yaml

@@ -1,57 +0,0 @@
-name: Check
-
-on:
-  push:
-    branches:
-      - 'master'
-  pull_request:
-    branches:
-      - '**'
-
-jobs:
-  check:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [14.x]
-
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      ## Try getting the node modules from cache, if failed npm ci
-      - uses: actions/cache@v2
-        id: cache-npm
-        with:
-          path: node_modules
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.OS }}-node-${{ env.cache-name }}-
-            ${{ runner.OS }}-node-
-            ${{ runner.OS }}-
-      - name: Install npm deps
-        if: steps.cache-npm.outputs.cache-hit != 'true'
-        run: npm ci
-
-      - name: Commit linting
-        uses: wagoid/commitlint-github-action@v2
-
-      - name: Code linting
-        run: npm run lint:check
-        env:
-          CI: true
-
-      - name: Dependency check
-        run: npm run depcheck
-
-      - name: Check typings
-        run: npm run check:types
-
-      - name: Build docs
-        run: npm run docs

package/.github/workflows/publish_npmjs.yaml

@@ -1,20 +0,0 @@
-# After new release is published on github, publish it to npmjs
-name: Publish on npmjs
-
-on:
-  release:
-    types: [published]
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 14
-          registry-url: 'https://registry.npmjs.org'
-      - run: npm ci
-      - run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/.github/workflows/release_github.yaml

@@ -1,20 +0,0 @@
-# On each new commit to master, create/update a PR with release
-# automatically bumps version and creates changelog as per conventional commits
-name: Release Github
-
-on:
-  push:
-    branches:
-      - master
-
-jobs:
-  release-please:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: GoogleCloudPlatform/release-please-action@v2
-        id: release
-        with:
-          token: ${{ secrets.REPO_GHA_PAT }}
-          release-type: node
-          package-name: bee-js
-          bump-minor-pre-major: true

package/.github/workflows/tests.yaml

@@ -1,128 +0,0 @@
-name: Tests
-
-on:
-  push:
-    branches:
-      - 'master'
-  pull_request:
-    branches:
-      - '**'
-
-env:
-  BEE_VERSION: '1.1.0-stateful'
-  BLOCKCHAIN_VERSION: '1.2.0-for-1.1.0-stateful'
-  BEE_ENV_PREFIX: 'swarm-test'
-  BEE_IMAGE_PREFIX: 'docker.pkg.github.com/ethersphere/bee-factory'
-  COMMIT_VERSION_TAG: 'false'
-  WORKERS: 4
-  BEE_API_URL: 'http://localhost:1633'
-  BEE_PEER_API_URL: 'http://localhost:11633'
-  BEE_DEBUG_API_URL: 'http://localhost:1635'
-  BEE_PEER_DEBUG_API_URL: 'http://localhost:11635'
-  BEE_TEST_CHEQUEBOOK: true
-
-jobs:
-  nodejs:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [12.x, 14.x, 16.x]
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 1
-
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - name: Auth to Github Package Docker Registry
-        run: |
-          echo "${{ secrets.GITHUB_TOKEN }}" | docker login https://docker.pkg.github.com -u ${GITHUB_ACTOR} --password-stdin
-
-      # Setup Bee environment
-      - name: Start Bee Factory environment
-        run: |
-          git clone --depth=1 https://github.com/ethersphere/bee-factory.git
-          chmod +x -R ./bee-factory/scripts
-          ./bee-factory/scripts/environment.sh start --detach --workers=$WORKERS
-
-      ## Try getting the node modules from cache, if failed npm ci
-      - uses: actions/cache@v2
-        id: cache-npm
-        with:
-          path: node_modules
-          key: ${{ runner.os }}-node-${{ matrix.node }}-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.OS }}-node-${{ matrix.node }}-${{ env.cache-name }}-
-            ${{ runner.OS }}-node-${{ matrix.node }}-
-
-      - name: Install npm deps
-        if: steps.cache-npm.outputs.cache-hit != 'true'
-        run: npm ci
-
-      - name: Run unit and integration tests for node
-        run: npm run test:node -- --detectOpenHandles
-
-      - name: Debug workflow if failed
-        if: failure()
-        run: |
-          KEYS=$(curl -sSf -X POST https://relay.tunshell.com/api/sessions)
-          curl -sSf -X POST -H "Content-Type: application/json" -d "{\"text\": \"**Bee JS**\nDebug -> \`sh <(curl -sSf https://lets.tunshell.com/init.sh) L $(echo $KEYS | jq -r .peer2_key) \${TUNSHELL_SECRET} relay.tunshell.com\`\"}" https://beehive.ethswarm.org/hooks/${{ secrets.WEBHOOK_KEY }}
-          echo "Connect to github actions node using"
-          echo "sh <(curl -sSf https://lets.tunshell.com/init.sh) L $(echo $KEYS | jq -r .peer2_key) \${TUNSHELL_SECRET} relay.tunshell.com"
-          curl -sSf https://lets.tunshell.com/init.sh | sh /dev/stdin T $(echo $KEYS | jq -r .peer1_key) ${{ secrets.TUNSHELL_SECRET }} relay.tunshell.com
-
-  browser:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [14.x]
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 1
-
-      - name: Auth to Github Package Docker Registry
-        run: |
-          echo "${{ secrets.GITHUB_TOKEN }}" | docker login https://docker.pkg.github.com -u ${GITHUB_ACTOR} --password-stdin
-
-      # Setup Bee environment
-      - name: Start Bee Factory environment
-        run: |
-          git clone --depth=1 https://github.com/ethersphere/bee-factory.git
-          chmod +x -R ./bee-factory/scripts
-          ./bee-factory/scripts/environment.sh start --detach --workers=$WORKERS
-
-      ## Try getting the node modules from cache, if failed npm ci
-      - uses: actions/cache@v2
-        id: cache-npm
-        with:
-          path: node_modules
-          key: ${{ runner.os }}-node-${{ matrix.node }}-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.OS }}-node-${{ matrix.node }}-${{ env.cache-name }}-
-            ${{ runner.OS }}-node-${{ matrix.node }}-
-
-      - name: Install npm deps
-        if: steps.cache-npm.outputs.cache-hit != 'true'
-        run: npm ci
-
-      - name: Run browser tests
-        run: npm run test:browser
-
-      - name: Debug workflow if failed
-        if: failure()
-        run: |
-          KEYS=$(curl -sSf -X POST https://relay.tunshell.com/api/sessions)
-          curl -sSf -X POST -H "Content-Type: application/json" -d "{\"text\": \"**Bee JS**\nDebug -> \`sh <(curl -sSf https://lets.tunshell.com/init.sh) L $(echo $KEYS | jq -r .peer2_key) \${TUNSHELL_SECRET} relay.tunshell.com\`\"}" https://beehive.ethswarm.org/hooks/${{ secrets.WEBHOOK_KEY }}
-          echo "Connect to github actions node using"
-          echo "sh <(curl -sSf https://lets.tunshell.com/init.sh) L $(echo $KEYS | jq -r .peer2_key) \${TUNSHELL_SECRET} relay.tunshell.com"
-          curl -sSf https://lets.tunshell.com/init.sh | sh /dev/stdin T $(echo $KEYS | jq -r .peer1_key) ${{ secrets.TUNSHELL_SECRET }} relay.tunshell.com

package/.huskyrc

@@ -1,5 +0,0 @@
-{
-  "hooks": {
-    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
-  }
-}

package/.prettierrc

@@ -1,13 +0,0 @@
-{
-  "printWidth": 120,
-  "tabWidth": 2,
-  "useTabs": false,
-  "bracketSpacing": true,
-  "semi": false,
-  "singleQuote": true,
-  "quoteProps": "as-needed",
-  "trailingComma": "all",
-  "endOfLine": "lf",
-  "arrowParens": "avoid",
-  "proseWrap": "always"
-}

package/.vscode/launch.json

@@ -1,49 +0,0 @@
-{
-  "version": "0.2.0",
-  "configurations": [
-      {
-        "name": "Run Jest tests",
-        "command": "npm run test",
-        "type": "node-terminal",
-        "request": "launch",
-        "env": {
-            "NODE_ENV": "development",
-            "BEE_API_URL": "http://localhost:1633",
-            "BEE_DEBUG_API_URL": "http://localhost:1635",
-            "BEE_PEER_API_URL": "http://localhost:11633",
-            "BEE_PEER_DEBUG_API_URL": "http://localhost:11635",
-            "BEE_TEST_CHEQUEBOOK": "true"
-        }
-      },
-
-      {
-        "name": "Run One Specific Node Jest test",
-        "command": "npm run test:node -- --testPathPattern ${file}",
-        "type": "node-terminal",
-        "request": "launch",
-        "env": {
-            "NODE_ENV": "development",
-            "BEE_API_URL": "http://localhost:1633",
-            "BEE_DEBUG_API_URL": "http://localhost:1635",
-            "BEE_PEER_API_URL": "http://localhost:11633",
-            "BEE_PEER_DEBUG_API_URL": "http://localhost:11635",
-            "BEE_TEST_CHEQUEBOOK": "true"
-        }
-      },
-
-      {
-        "name": "Run One Specific Browser Jest test",
-        "command": "npm run test:browser -- --testPathPattern ${file}",
-        "type": "node-terminal",
-        "request": "launch",
-        "env": {
-            "NODE_ENV": "development",
-            "BEE_API_URL": "http://localhost:1633",
-            "BEE_DEBUG_API_URL": "http://localhost:1635",
-            "BEE_PEER_API_URL": "http://localhost:11633",
-            "BEE_PEER_DEBUG_API_URL": "http://localhost:11635",
-            "BEE_TEST_CHEQUEBOOK": "true"
-        }
-      }
-  ]
-}

package/.vscode/settings.json

@@ -1,39 +0,0 @@
-{
-  "editor.codeActionsOnSave": {
-    // For ESLint
-    "source.fixAll.eslint": true,
-    // For TSLint
-    "source.fixAll.tslint": true,
-    // For Stylelint
-    "source.fixAll.stylelint": true
-  },
-  "eslint.validate": ["javascript", "typescript"],
-  "editor.formatOnSave": true,
-  "[javascript]": {
-    "editor.formatOnSave": false
-  },
-  "[typescript]": {
-    "editor.defaultFormatter": "dbaeumer.vscode-eslint",
-    "editor.codeActionsOnSave": {
-      "source.fixAll.eslint": true
-    },
-    "editor.formatOnSave": true
-  },
-  "[json]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode",
-    "editor.codeActionsOnSave": {
-      "source.fixAll.eslint": true
-    },
-    "editor.formatOnSave": true
-  },
-  "[markdown]": {
-    "editor.formatOnSave": false
-  },
-  "search.exclude": {
-    "**/node_modules": true,
-    "**/dist": true,
-    "**/coverage": true
-  },
-  "typescript.referencesCodeLens.enabled": true,
-  "jest.runAllTestsFirst": false
-}

package/CODEOWNERS

@@ -1 +0,0 @@
-* @nugaon @auhau

package/CODE_OF_CONDUCT.md

@@ -1,76 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to make participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-  advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies within all project spaces, and it also applies when
-an individual is representing the project or its community in public spaces.
-Examples of representing a project or community include using an official
-project e-mail address, posting via an official social media account, or acting
-as an appointed representative at an online or offline event. Representation of
-a project may be further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at info@ethswarm.org. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq

package/commitlint.config.js

@@ -1,3 +0,0 @@
-module.exports = {
-  extends: ['@commitlint/config-conventional'],
-}

package/dist/src/modules/stamps.d.ts

@@ -1,4 +0,0 @@
-import { BatchId, NumberString, PostageBatch, PostageBatchOptions } from '../types';
-export declare function getAllPostageBatches(url: string): Promise<PostageBatch[]>;
-export declare function getPostageBatch(url: string, postageBatchId: BatchId): Promise<PostageBatch>;
-export declare function createPostageBatch(url: string, amount: NumberString, depth: number, options?: PostageBatchOptions): Promise<BatchId>;

package/dist/src/utils/hooks.d.ts

@@ -1,31 +0,0 @@
-import { BeeRequest, BeeResponse } from '../types';
-declare type HookCallback<V> = (value: V) => V | Promise<V>;
-/**
- * Function that registers listener callback for all outgoing HTTP requests that bee-js makes.
- *
- * **Be Aware! This listener listens to all Bee/BeeDebug class instances without differentiation!**
- *
- * @param cb
- * @returns ID of the listener that can be used to stop the callback to receive new requests
- */
-export declare function onRequest(cb: HookCallback<BeeRequest>): number;
-/**
- * Function that stops forwarding new requests to associated listener callback
- * @param id ID that onRequest returned
- */
-export declare function clearOnRequest(id: number): void;
-/**
- * Function that registers listener callback for all incoming HTTP responses that bee-js made.
- *
- * **Be Aware! This listener listens to all Bee/BeeDebug class instances without differentiation!**
- *
- * @param cb
- * @returns ID of the listener that can be used to stop the callback to receive new responses
- */
-export declare function onResponse(cb: HookCallback<BeeResponse>): number;
-/**
- * Function that stops forwarding new responses to associated listener callback
- * @param id ID that onResponse returned
- */
-export declare function clearOnResponse(id: number): void;
-export {};

package/dist/src/utils/safe-axios.d.ts

@@ -1,8 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios';
-/**
- * Utility function that sets passed headers to ALL axios calls without distinction of Bee URLs.
- *
- * @param headers
- */
-export declare function setDefaultHeaders(headers: Record<string, string>): void;
-export declare function safeAxios<T>(config: AxiosRequestConfig): Promise<AxiosResponse<T>>;

package/jest-puppeteer.config.js

@@ -1,5 +0,0 @@
-module.exports = {
-  launch: {
-    dumpio: true, // Forwards browser console into test console for easier debugging
-  },
-}

package/jest.config.ts

@@ -1,170 +0,0 @@
-/* eslint-disable no-console */
-/*
- * For a detailed explanation regarding each configuration property and type check, visit:
- * https://jestjs.io/docs/en/configuration.html
- */
-import type { Config } from '@jest/types'
-import { glob } from 'glob'
-import * as Path from 'path'
-import { createPostageBatch, getPostageBatch } from './src/modules/stamps'
-import type { BatchId } from './src'
-
-/**
- * Get 'alias' configuration of Jest and Webpack for browser testing and compilation.
- */
-export async function getBrowserPathMapping(): Promise<{ [aliasNodeReference: string]: string }> {
-  const browserSourceFiles = await new Promise<{ [aliasNodeReference: string]: string }>((resolve, reject) => {
-    glob('src/**/*.browser.ts', (err, browserSourceCodes) => {
-      if (err) reject(err)
-      browserSourceCodes = browserSourceCodes.map(match => Path.resolve(__dirname, match))
-      const codePathMapping: { [nodeFullPath: string]: string } = {}
-      browserSourceCodes.map(browserFullPath => {
-        const filePathArray = browserFullPath.split('.')
-        filePathArray.pop()
-        filePathArray.pop() //remove 'browser.ts' from '**/*.browser.ts'
-        const nodeFullPath = filePathArray.join('.')
-        const aliasNodeReference = `/${nodeFullPath.split('/').pop()}$` //keep the last bit of node file referencing e.g. '/file-source$'
-
-        codePathMapping[aliasNodeReference] = browserFullPath
-      })
-
-      resolve(codePathMapping)
-    })
-  })
-
-  return browserSourceFiles
-}
-
-export default async (): Promise<Config.InitialOptions> => {
-  try {
-    const beeDebugUrl = process.env.BEE_DEBUG_API_URL || 'http://localhost:1635'
-    const beeDebugPeerUrl = process.env.BEE_PEER_DEBUG_API_URL || 'http://localhost:11635'
-
-    if (process.env.BEE_POSTAGE) {
-      try {
-        if (!(await getPostageBatch(beeDebugUrl, process.env.BEE_POSTAGE as BatchId)).usable) {
-          delete process.env.BEE_POSTAGE
-          console.log('BEE_POSTAGE stamp was found but is not usable')
-        } else {
-          console.log('Using configured BEE_POSTAGE stamp.')
-        }
-      } catch (e) {
-        delete process.env.BEE_POSTAGE
-        console.log('BEE_POSTAGE stamp was not found')
-      }
-    }
-
-    if (process.env.BEE_PEER_POSTAGE) {
-      try {
-        if (!(await getPostageBatch(beeDebugPeerUrl, process.env.BEE_PEER_POSTAGE as BatchId)).usable) {
-          delete process.env.BEE_PEER_POSTAGE
-          console.log('BEE_PEER_POSTAGE stamp was found but is not usable')
-        } else {
-          console.log('Using configured BEE_PEER_POSTAGE stamp.')
-        }
-      } catch (e) {
-        delete process.env.BEE_PEER_POSTAGE
-        console.log('BEE_PEER_POSTAGE stamp was not found')
-      }
-    }
-
-    if (!process.env.BEE_POSTAGE || !process.env.BEE_PEER_POSTAGE) {
-      console.log('Creating postage stamps...')
-
-      const stampsOrder: { url: string; env: string }[] = []
-
-      if (!process.env.BEE_POSTAGE) {
-        stampsOrder.push({ url: beeDebugUrl, env: 'BEE_POSTAGE' })
-      }
-
-      if (!process.env.BEE_PEER_POSTAGE) {
-        stampsOrder.push({ url: beeDebugPeerUrl, env: 'BEE_PEER_POSTAGE' })
-      }
-
-      const stamps = await Promise.all(stampsOrder.map(async order => createPostageBatch(order.url, '1', 20)))
-
-      for (let i = 0; i < stamps.length; i++) {
-        process.env[stampsOrder[i].env] = stamps[i]
-        console.log(`${stampsOrder[i].env}: ${stamps[i]}`)
-      }
-
-      console.log('Waiting for the stamps to be usable')
-      let allUsable = true
-      do {
-        for (let i = 0; i < stamps.length; i++) {
-          // eslint-disable-next-line max-depth
-          try {
-            // eslint-disable-next-line max-depth
-            if (!(await getPostageBatch(stampsOrder[i].url, stamps[i] as BatchId)).usable) {
-              allUsable = false
-              break
-            } else {
-              allUsable = true
-            }
-          } catch (e) {
-            allUsable = false
-            break
-          }
-        }
-
-        // eslint-disable-next-line no-loop-func
-        await new Promise<void>(resolve => setTimeout(() => resolve(), 1_000))
-      } while (!allUsable)
-      console.log('Usable, yey!')
-    }
-  } catch (e) {
-    // It is possible that for unit tests the Bee nodes does not run
-    // so we are only logging errors and not leaving them to propagate
-    console.error(e)
-  }
-
-  return {
-    // Indicates whether the coverage information should be collected while executing the test
-    // collectCoverage: false,
-
-    // The directory where Jest should output its coverage files
-    coverageDirectory: 'coverage',
-
-    // Custom sequencer that priorities running unit tests before integration tests
-    testSequencer: '<rootDir>/test-type-sequencer.js',
-
-    // An array of regexp pattern strings used to skip coverage collection
-    coveragePathIgnorePatterns: ['/node_modules/'],
-
-    // An array of directory names to be searched recursively up from the requiring module's location
-    moduleDirectories: ['node_modules'],
-
-    // Run tests from one or more projects
-    projects: [
-      // We don't have any DOM specific tests atm.
-      // {
-      //   displayName: 'dom:unit',
-      //   testRegex: 'test/unit/.*\\.browser\\.spec\\.ts',
-      //   moduleNameMapper: await getBrowserPathMapping(),
-      //   preset: 'jest-puppeteer',
-      // },
-      {
-        displayName: 'node:unit',
-        testEnvironment: 'node',
-        testRegex: 'test/unit/((?!\\.browser).)*\\.spec\\.ts',
-      },
-      {
-        displayName: 'dom:integration',
-        testRegex: 'test/integration/.*\\.browser\\.spec\\.ts',
-        moduleNameMapper: await getBrowserPathMapping(),
-        preset: 'jest-puppeteer',
-      },
-      {
-        displayName: 'node:integration',
-        testEnvironment: 'node',
-        testRegex: 'test/integration/((?!\\.browser).)*\\.spec\\.ts',
-      },
-    ] as unknown[] as string[], // bad types
-
-    // The root directory that Jest should scan for tests and modules within
-    rootDir: 'test',
-
-    // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-    testPathIgnorePatterns: ['/node_modules/'],
-  }
-}