@ethersphere/bee-js 2.0.0 → 3.1.0

package/src/types/index.ts

@@ -1,566 +0,0 @@
-import type { Identifier, SingleOwnerChunk } from '../chunk/soc'
-import type { ChunkReference, FeedUploadOptions } from '../feed'
-import type { FeedType } from '../feed/type'
-import type { FeedUpdateOptions, FetchFeedUpdateResponse } from '../modules/feed'
-import type { Bytes } from '../utils/bytes'
-import type { BeeError } from '../utils/error'
-import type { EthAddress, HexEthAddress } from '../utils/eth'
-import type { HexString } from '../utils/hex'
-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/ponyfill'
-
-export * from './debug'
-
-export type Ky = typeof ky
-
-export interface Dictionary<T> {
-  [Key: string]: T
-}
-
-export const ADDRESS_HEX_LENGTH = 64
-export const PSS_TARGET_HEX_LENGTH_MAX = 4
-export const PUBKEY_HEX_LENGTH = 66
-export const BATCH_ID_HEX_LENGTH = 64
-export const REFERENCE_HEX_LENGTH = 64
-export const ENCRYPTED_REFERENCE_HEX_LENGTH = 128
-export const REFERENCE_BYTES_LENGTH = 32
-export const ENCRYPTED_REFERENCE_BYTES_LENGTH = 64
-
-/**
- * Minimal depth that can be used for creation of postage batch
- */
-export const STAMPS_DEPTH_MIN = 17
-
-/**
- * Maximal depth that can be used for creation of postage batch
- */
-export const STAMPS_DEPTH_MAX = 255
-
-export const TAGS_LIMIT_MIN = 1
-export const TAGS_LIMIT_MAX = 1000
-
-/**
- * Generic reference that can be either non-encrypted reference which is a hex string of length 64 or encrypted
- * reference which is a hex string of length 128.
- *
- * Encrypted reference consists of two parts. The reference address itself (like non-encrypted reference) and decryption key.
- *
- * @see [Bee docs - Store with Encryption](https://docs.ethswarm.org/docs/access-the-swarm/store-with-encryption)
- */
-export type Reference = HexString<typeof REFERENCE_HEX_LENGTH> | HexString<typeof ENCRYPTED_REFERENCE_HEX_LENGTH>
-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 type Readable = NativeReadable | CompatibilityReadable | ReadableStream | ReadableStreamPonyfill
-
-/**
- * BatchId is result of keccak256 hash so 64 hex string without prefix.
- */
-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 type AddressPrefix = HexString
-
-export interface RequestOptions {
-  /**
-   * Timeout of requests in milliseconds
-   */
-  timeout?: number
-
-  /**
-   * Configure backoff mechanism for requests retries.
-   * Specifies how many retries will be performed before failing a request.
-   * Retries are performed for GET, PUT, HEAD, DELETE, OPTIONS and TRACE requests.
-   * Default is 2.
-   */
-  retry?: number
-
-  /**
-   * User defined Fetch compatible function
-   */
-  fetch?: Fetch
-}
-
-export interface BeeOptions extends RequestOptions {
-  /**
-   * Signer object or private key of the Signer in form of either hex string or Uint8Array that will be default signer for the instance.
-   */
-  signer?: Signer | Uint8Array | string
-
-  /**
-   * Object that contains default headers that will be present
-   * in all outgoing bee-js requests for instance of Bee class.
-   */
-  defaultHeaders?: Record<string, string>
-
-  /**
-   * Function that registers listener callback for all outgoing HTTP requests that Bee instance makes.
-   */
-  onRequest?: HookCallback<BeeRequest>
-
-  /**
-   * Function that registers listener callback for all incoming HTTP responses that Bee instance made.
-   */
-  onResponse?: HookCallback<BeeResponse>
-}
-
-/**
- * Result of upload calls.
- */
-export interface UploadResult {
-  /**
-   * Reference of the uploaded data
-   */
-  reference: Reference
-
-  /**
-   * Automatically created tag's UID.
-   *
-   * There is bug in Bee, that does not return correct CORS header (Access-Control-Expose-Headers) for the `Swarm-Tag` to be exposed
-   * in browser when uploading collection. The `tagUid` is marked as optional even though in 99% of results
-   * it is present. The Optional mark will be removed with next Bee release.
-   * TODO: Remove Optional with next Bee release: https://github.com/ethersphere/bee-js/issues/406
-   */
-  tagUid?: number
-}
-
-export interface UploadOptions extends RequestOptions {
-  /**
-   * Will pin the data locally in the Bee node as well.
-   *
-   * 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)
-   */
-  pin?: boolean
-
-  /**
-   * 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
-   */
-  encrypt?: boolean
-
-  /**
-   * Tags keep track of syncing the data with network. This option allows attach existing Tag UUID to the uploaded data.
-   *
-   * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/Collection/paths/~1bzz/post)
-   * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/access-the-swarm/syncing)
-   * @link Tag
-   */
-  tag?: number
-}
-
-export interface FileUploadOptions extends UploadOptions {
-  /**
-   * Specifies Content-Length for the given data. It is required when uploading with Readable.
-   *
-   * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/File)
-   */
-  size?: number
-
-  /**
-   * Specifies given Content-Type so when loaded in browser the file is correctly represented.
-   *
-   * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/File)
-   */
-  contentType?: string
-}
-
-export interface CollectionUploadOptions extends UploadOptions {
-  /**
-   * Default file to be returned when the root hash of collection is accessed.
-   *
-   * @see [Bee docs - Upload a directory](https://docs.ethswarm.org/docs/access-the-swarm/upload-a-directory)
-   * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/File)
-   */
-  indexDocument?: string
-
-  /**
-   * Configure custom error document to be returned when a specified path can not be found in collection.
-   *
-   * @see [Bee docs - Upload a directory](https://docs.ethswarm.org/docs/access-the-swarm/upload-a-directory)
-   * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/File)
-   */
-  errorDocument?: string
-}
-
-export interface UploadHeaders {
-  'swarm-pin'?: string
-  'swarm-encrypt'?: string
-  'swarm-tag'?: string
-  'swarm-postage-batch-id'?: string
-}
-
-/**
- * Object that contains infromation about progress of upload of data to network.
- *
- * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/access-the-swarm/syncing)
- */
-export interface Tag {
-  /**
-   * Number of all chunks that the data will be split into.
-   */
-  total: number
-
-  /**
-   * Number of chunks that is locally stored in the Bee node.
-   */
-  processed: number
-
-  /**
-   * Number of chunks that arrived to their designated destination in the network
-   */
-  synced: number
-
-  /**
-   * Unique identifier
-   */
-  uid: number
-
-  /**
-   * When the upload process started
-   */
-  startedAt: string
-}
-
-export interface AllTagsOptions extends RequestOptions {
-  limit?: number
-  offset?: number
-}
-
-export interface FileHeaders {
-  name?: string
-  tagUid?: number
-  contentType?: string
-}
-
-export interface FileData<T> extends FileHeaders {
-  data: T
-}
-
-export interface Pin {
-  reference: string
-}
-
-/**
- * Helper interface that adds utility functions
- * to work more conveniently with bytes in normal
- * user scenarios.
- *
- * Concretely: text(), hex(), json()
- */
-export interface Data extends Uint8Array {
-  /**
-   * Converts the binary data using UTF-8 decoding into string.
-   */
-  text(): string
-
-  /**
-   * Converts the binary data into hex-string.
-   */
-  hex(): HexString
-
-  /**
-   * Converts the binary data into string which is then parsed into JSON.
-   */
-  json(): Record<string, unknown>
-}
-
-/**
- * Object represents a file and some of its metadata in [[Directory]] object.
- */
-export interface CollectionEntry<T> {
-  data: T
-
-  /**
-   *
-   */
-  path: string
-}
-
-/**
- * Represents Collections
- */
-export type Collection<T> = Array<CollectionEntry<T>>
-
-export interface PssSubscription {
-  readonly topic: string
-  cancel: () => void
-}
-
-export interface PssMessageHandler {
-  onMessage: (message: Data, subscription: PssSubscription) => void
-  onError: (error: BeeError, subscription: PssSubscription) => void
-}
-
-export interface BeeGenericResponse {
-  message: string
-  code: number
-}
-
-export interface ReferenceResponse {
-  reference: Reference
-}
-
-export type HttpMethod = 'GET' | 'DELETE' | 'POST' | 'PATCH' | 'PUT'
-
-export type HookCallback<V> = (value: V) => void | Promise<void>
-
-export interface BeeRequest {
-  url: string
-  method: HttpMethod
-  headers?: Record<string, string>
-  params?: Record<string, unknown>
-}
-
-export interface BeeResponse {
-  headers: Record<string, string>
-  status: number
-  statusText?: string
-  request: BeeRequest
-}
-
-/*********************************************************
- * Writers and Readers interfaces
- */
-
-export const TOPIC_BYTES_LENGTH = 32
-export const TOPIC_HEX_LENGTH = 64
-
-/**
- * Hex string of length 64 chars without prefix that specifies topics for feed.
- */
-export type Topic = HexString<typeof TOPIC_HEX_LENGTH>
-
-/**
- * FeedReader is an interface for downloading feed updates
- */
-export interface FeedReader {
-  readonly type: FeedType
-  readonly owner: HexEthAddress
-  readonly topic: Topic
-  /**
-   * Download the latest feed update
-   */
-  download(options?: FeedUpdateOptions): Promise<FetchFeedUpdateResponse>
-}
-
-export interface JsonFeedOptions extends RequestOptions {
-  /**
-   * Valid only for `get` action, where either this `address` or `signer` has
-   * to be specified.
-   */
-  address?: EthAddress | Uint8Array | string
-
-  /**
-   * Custom Signer object or private key in either binary or hex form.
-   * This required for `set` action, and optional for `get` although
-   * if not specified for `get` then `address` option has to be specified.
-   */
-  signer?: Signer | Uint8Array | string
-  type?: FeedType
-}
-
-/**
- * FeedWriter is an interface for updating feeds
- */
-export interface FeedWriter extends FeedReader {
-  /**
-   * Upload a new feed update
-   *
-   * @param postageBatchId Postage BatchId to be used to upload the data with
-   * @param reference The reference to be stored in the new update
-   * @param options   Additional options like `at`
-   *
-   * @returns Reference that points at Single Owner Chunk that contains the new update and pointer to the updated chunk reference.
-   */
-  upload(
-    postageBatchId: string | BatchId,
-    reference: ChunkReference | Reference,
-    options?: FeedUploadOptions,
-  ): Promise<Reference>
-}
-
-/**
- * Interface for downloading single owner chunks
- */
-export interface SOCReader {
-  /**
-   * Downloads a single owner chunk
-   *
-   * @param identifier  The identifier of the chunk
-   */
-  download: (identifier: Identifier) => Promise<SingleOwnerChunk>
-}
-
-/**
- * Interface for downloading and uploading single owner chunks
- */
-export interface SOCWriter extends SOCReader {
-  /**
-   * Uploads a single owner chunk
-   *
-   * @param identifier  The identifier of the chunk
-   * @param data        The chunk payload data
-   * @param options     Upload options
-   */
-  upload: (
-    postageBatchId: string | BatchId,
-    identifier: Identifier,
-    data: Uint8Array,
-    options?: UploadOptions,
-  ) => Promise<Reference>
-}
-
-/**
- * Interface representing Postage stamp batch.
- */
-export interface PostageBatch {
-  batchID: BatchId
-  utilization: number
-  usable: boolean
-  label: '' | string
-  depth: number
-  amount: string
-  bucketDepth: number
-  blockNumber: number
-  immutableFlag: boolean
-}
-
-export interface DebugPostageBatch extends PostageBatch {
-  /**
-   * The time (in seconds) remaining until the batch expires; -1 signals that the batch never expires; 0 signals that the batch has already expired.
-   */
-  batchTTL: number
-
-  exists: boolean
-}
-
-export interface BatchBucket {
-  bucketID: number
-  collisions: number
-}
-
-export interface PostageBatchBuckets {
-  depth: number
-  bucketDepth: number
-  bucketUpperBound: number
-  buckets?: BatchBucket[]
-}
-
-export type TransactionHash = BrandedString<'TransactionHash'>
-
-export interface TransactionInfo {
-  transactionHash: TransactionHash
-  to: HexEthAddress
-  nonce: number
-  gasPrice: NumberString
-  gasLimit: number
-  data: string
-  created: string
-  description: string
-  value: string
-}
-
-/**
- * Options for creation of postage batch
- */
-export interface PostageBatchOptions extends RequestOptions {
-  /**
-   * Sets label for the postage batch
-   */
-  label?: string
-
-  /**
-   * Sets gas price in Wei for the transaction that creates the postage batch
-   */
-  gasPrice?: NumberString
-  immutableFlag?: boolean
-}
-
-/**
- * With this type a number should be represented in a string
- */
-export type NumberString = FlavoredType<string, 'NumberString'>
-
-/*********************************************************
- * Ethereum compatible signing interfaces and definitions
- */
-
-export const SIGNATURE_HEX_LENGTH = 130
-export const SIGNATURE_BYTES_LENGTH = 65
-
-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).
- * Result of the signing can be returned either in Uint8Array or hex string form.
- *
- * @see Data
- */
-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.
- *
- * In order to be compatible with Ethereum and its signing method `personal_sign`, the data
- * that are passed to sign() function should be prefixed with: `\x19Ethereum Signed Message:\n${data.length}`, hashed
- * and only then signed.
- * If you are wrapping another signer tool/library (like Metamask or some other Ethereum wallet), you might not have
- * to do this prefixing manually if you use the `personal_sign` method. Check documentation of the tool!
- * If you are writing your own storage for keys, then you have to prefix the data manually otherwise the Bee node
- * will reject the chunks signed by you!
- *
- * For example see the hashWithEthereumPrefix() function.
- *
- * @property sign     The sign function that can be sync or async. This function takes non-prefixed data. See above.
- * @property address  The ethereum address of the signer in bytes.
- * @see hashWithEthereumPrefix
- */
-export type Signer = {
-  sign: SyncSigner | AsyncSigner
-  address: EthAddress
-}
-
-/**
- * These type are used to create new nominal types
- *
- * See https://spin.atomicobject.com/2018/01/15/typescript-flexible-nominal-typing/
- */
-export type BrandedType<Type, Name> = Type & { __tag__: Name }
-
-export type BrandedString<Name> = BrandedType<string, Name>
-
-export type FlavoredType<Type, Name> = Type & { __tag__?: Name }
-
-// JSON typings
-// by @indiescripter at https://github.com/microsoft/TypeScript/issues/1897#issuecomment-338650717
-export type AnyJson = boolean | number | string | null | JsonArray | JsonMap
-interface JsonMap {
-  [key: string]: AnyJson
-}
-type JsonArray = Array<AnyJson>
-
-type Fetch = (input: RequestInfo, init?: RequestInit) => Promise<Response>

package/src/types/ky-universal/common.d.ts

@@ -1,17 +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 declare type Primitive = null | undefined | string | number | boolean | symbol | bigint
-export declare type Required<T, K extends keyof T = keyof T> = T &
-  {
-    [P in K]-?: T[P]
-  }
-export declare type LiteralUnion<LiteralType extends BaseType, BaseType extends Primitive> =
-  | LiteralType
-  | (BaseType & {
-      _?: never
-    })

package/src/types/ky-universal/hooks.d.ts

@@ -1,103 +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
- */
-
-import type { NormalizedOptions } from './options.js'
-
-export declare const stop: unique symbol
-
-export declare type BeforeRequestHook = (
-  request: Request,
-  options: NormalizedOptions,
-) => Request | Response | void | Promise<Request | Response | void>
-export declare type BeforeRetryState = {
-  request: Request
-  response: Response
-  options: NormalizedOptions
-  error: Error
-  retryCount: number
-}
-export declare type BeforeRetryHook = (options: BeforeRetryState) => typeof stop | void | Promise<typeof stop | void>
-export declare type AfterResponseHook = (
-  request: Request,
-  options: NormalizedOptions,
-  response: Response,
-) => Response | void | Promise<Response | void>
-
-export interface Hooks {
-  /**
-   This hook enables you to modify the request right before it is sent. Ky will make no further changes to the request after this. The hook function receives normalized input and options as arguments. You could, forf example, modiy `options.headers` here.
-
-   A [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) can be returned from this hook to completely avoid making a HTTP request. This can be used to mock a request, check an internal cache, etc. An **important** consideration when returning a `Response` from this hook is that all the following hooks will be skipped, so **ensure you only return a `Response` from the last hook**.
-
-   @default []
-   */
-  beforeRequest?: BeforeRequestHook[]
-  /**
-   This hook enables you to modify the request right before retry. Ky will make no further changes to the request after this. The hook function receives an object with the normalized request and options, an error instance, and the retry count. You could, for example, modify `request.headers` here.
-
-   If the request received a response, the error will be of type `HTTPError` and the `Response` object will be available at `error.response`. Be aware that some types of errors, such as network errors, inherently mean that a response was not received. In that case, the error will not be an instance of `HTTPError`.
-
-   You can prevent Ky from retrying the request by throwing an error. Ky will not handle it in any way and the error will be propagated to the request initiator. The rest of the `beforeRetry` hooks will not be called in this case. Alternatively, you can return the [`ky.stop`](#ky.stop) symbol to do the same thing but without propagating an error (this has some limitations, see `ky.stop` docs for details).
-
-   @example
-   ```
-   import ky from 'ky';
-
-   const response = await ky('https://example.com', {
-        hooks: {
-            beforeRetry: [
-                async ({request, options, error, retryCount}) => {
-                    const token = await ky('https://example.com/refresh-token');
-                    options.headers.set('Authorization', `token ${token}`);
-                }
-            ]
-        }
-    });
-   ```
-
-   @default []
-   */
-  beforeRetry?: BeforeRetryHook[]
-  /**
-   This hook enables you to read and optionally modify the response. The hook function receives normalized input, options, and a clone of the response as arguments. The return value of the hook function will be used by Ky as the response object if it's an instance of [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response).
-
-   @default []
-
-   @example
-   ```
-   import ky from 'ky';
-
-   const response = await ky('https://example.com', {
-        hooks: {
-            afterResponse: [
-                (_input, _options, response) => {
-                    // You could do something with the response, for example, logging.
-                    log(response);
-
-                    // Or return a `Response` instance to overwrite the response.
-                    return new Response('A different response', {status: 200});
-                },
-
-                // Or retry with a fresh token on a 403 error
-                async (input, options, response) => {
-                    if (response.status === 403) {
-                        // Get a fresh token
-                        const token = await ky('https://example.com/token').text();
-
-                        // Retry with the token
-                        options.headers.set('Authorization', `token ${token}`);
-
-                        return ky(input, options);
-                    }
-                }
-            ]
-        }
-    });
-   ```
-   */
-  afterResponse?: AfterResponseHook[]
-}