@ethersphere/bee-js 2.1.0 → 3.2.0

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

@@ -1,125 +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
- */
-
-declare module 'ky-universal' {
-  type Options = import('./options').Options
-  type Input = import('./options').Input
-  type ResponsePromise = import('./response').ResponsePromise
-  const stop: unique symbol
-
-  interface KyInterface {
-    /**
-     Fetch the given `url` using the option `{method: 'get'}`.
-
-     @param url - `Request` object, `URL` object, or URL string.
-     @returns A promise with `Body` methods added.
-     */
-    get: (url: Input, options?: Options) => ResponsePromise
-    /**
-     Fetch the given `url` using the option `{method: 'post'}`.
-
-     @param url - `Request` object, `URL` object, or URL string.
-     @returns A promise with `Body` methods added.
-     */
-    post: (url: Input, options?: Options) => ResponsePromise
-    /**
-     Fetch the given `url` using the option `{method: 'put'}`.
-
-     @param url - `Request` object, `URL` object, or URL string.
-     @returns A promise with `Body` methods added.
-     */
-    put: (url: Input, options?: Options) => ResponsePromise
-    /**
-     Fetch the given `url` using the option `{method: 'delete'}`.
-
-     @param url - `Request` object, `URL` object, or URL string.
-     @returns A promise with `Body` methods added.
-     */
-    delete: (url: Input, options?: Options) => ResponsePromise
-    /**
-     Fetch the given `url` using the option `{method: 'patch'}`.
-
-     @param url - `Request` object, `URL` object, or URL string.
-     @returns A promise with `Body` methods added.
-     */
-    patch: (url: Input, options?: Options) => ResponsePromise
-    /**
-     Fetch the given `url` using the option `{method: 'head'}`.
-
-     @param url - `Request` object, `URL` object, or URL string.
-     @returns A promise with `Body` methods added.
-     */
-    head: (url: Input, options?: Options) => ResponsePromise
-    /**
-     Create a new Ky instance with complete new defaults.
-
-     @returns A new Ky instance.
-     */
-    create: (defaultOptions: Options) => KyInterface
-    /**
-     Create a new Ky instance with some defaults overridden with your own.
-
-     In contrast to `ky.create()`, `ky.extend()` inherits defaults from its parent.
-
-     @returns A new Ky instance.
-     */
-    extend: (defaultOptions: Options) => KyInterface
-    /**
-     A `Symbol` that can be returned by a `beforeRetry` hook to stop the retry. This will also short circuit the remaining `beforeRetry` hooks.
-
-     Note: Returning this symbol makes Ky abort and return with an `undefined` response. Be sure to check for a response before accessing any properties on it or use [optional chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Optional_chaining). It is also incompatible with body methods, such as `.json()` or `.text()`, because there is no response to parse. In general, we recommend throwing an error instead of returning this symbol, as that will cause Ky to abort and then throw, which avoids these limitations.
-
-     A valid use-case for `ky.stop` is to prevent retries when making requests for side effects, where the returned data is not important. For example, logging client activity to the server.
-
-     @example
-     ```
-     import ky from 'ky';
-
-     const options = {
-        hooks: {
-            beforeRetry: [
-                async ({request, options, error, retryCount}) => {
-                    const shouldStopRetry = await ky('https://example.com/api');
-                    if (shouldStopRetry) {
-                        return ky.stop;
-                    }
-                }
-            ]
-        }
-    };
-
-     // Note that response will be `undefined` in case `ky.stop` is returned.
-     const response = await ky.post('https://example.com', options);
-
-     // Using `.text()` or other body methods is not suppported.
-     const text = await ky('https://example.com', options).text();
-     ```
-     */
-    readonly stop: typeof stop
-    /**
-     Fetch the given `url`.
-
-     @param url - `Request` object, `URL` object, or URL string.
-     @returns A promise with `Body` method added.
-
-     @example
-     ```
-     import ky from 'ky';
-
-     const json = await ky('https://example.com', {json: {foo: true}}).json();
-
-     console.log(json);
-     //=> `{data: '🦄'}`
-     ```
-     */
-    (url: Input, options?: Options): ResponsePromise
-  }
-
-  const ky: KyInterface
-  export default ky
-  export { Options }
-}

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

@@ -1,235 +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 { LiteralUnion, Required } from './common.js'
-import type { Hooks } from './hooks.js'
-import type { RetryOptions } from './retry.js'
-
-export declare type SearchParamsInit = string | string[][] | Record<string, string> | URLSearchParams | undefined
-export declare type SearchParamsOption =
-  | SearchParamsInit
-  | Record<string, string | number | boolean>
-  | Array<Array<string | number | boolean>>
-export declare type HTTPMethod = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete'
-export declare type Input = string | URL | Request
-
-export interface DownloadProgress {
-  percent: number
-  transferredBytes: number
-  /**
-   Note: If it's not possible to retrieve the body size, it will be `0`.
-   */
-  totalBytes: number
-}
-
-export declare type KyHeadersInit = HeadersInit | Record<string, string | undefined>
-
-/**
- Options are the same as `window.fetch`, with some exceptions.
- */
-export interface Options extends Omit<RequestInit, 'headers'> {
-  /**
-   HTTP method used to make the request.
-
-   Internally, the standard methods (`GET`, `POST`, `PUT`, `PATCH`, `HEAD` and `DELETE`) are uppercased in order to avoid server errors due to case sensitivity.
-   */
-  method?: LiteralUnion<HTTPMethod, string>
-  /**
-   HTTP headers used to make the request.
-
-   You can pass a `Headers` instance or a plain object.
-
-   You can remove a header with `.extend()` by passing the header with an `undefined` value.
-
-   @example
-   ```
-   import ky from 'ky';
-
-   const url = 'https://sindresorhus.com';
-
-   const original = ky.create({
-        headers: {
-            rainbow: 'rainbow',
-            unicorn: 'unicorn'
-        }
-    });
-
-   const extended = original.extend({
-        headers: {
-            rainbow: undefined
-        }
-    });
-
-   const response = await extended(url).json();
-
-   console.log('rainbow' in response);
-   //=> false
-
-   console.log('unicorn' in response);
-   //=> true
-   ```
-   */
-  headers?: KyHeadersInit
-  /**
-   Shortcut for sending JSON. Use this instead of the `body` option.
-
-   Accepts any plain object or value, which will be `JSON.stringify()`'d and sent in the body with the correct header set.
-   */
-  json?: unknown
-  /**
-   User-defined JSON-parsing function.
-
-   Use-cases:
-   1. Parse JSON via the [`bourne` package](https://github.com/hapijs/bourne) to protect from prototype pollution.
-   2. Parse JSON with [`reviver` option of `JSON.parse()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse).
-
-   @default JSON.parse()
-
-   @example
-   ```
-   import ky from 'ky';
-   import bourne from '@hapijs/bourne';
-
-   const json = await ky('https://example.com', {
-        parseJson: text => bourne(text)
-    }).json();
-   ```
-   */
-  parseJson?: (text: string) => unknown
-  /**
-   Search parameters to include in the request URL. Setting this will override all existing search parameters in the input URL.
-
-   Accepts any value supported by [`URLSearchParams()`](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams/URLSearchParams).
-   */
-  searchParams?: SearchParamsOption
-  /**
-   A prefix to prepend to the `input` URL when making the request. It can be any valid URL, either relative or absolute. A trailing slash `/` is optional and will be added automatically, if needed, when it is joined with `input`. Only takes effect when `input` is a string. The `input` argument cannot start with a slash `/` when using this option.
-
-   Useful when used with [`ky.extend()`](#kyextenddefaultoptions) to create niche-specific Ky-instances.
-
-   Notes:
-   - After `prefixUrl` and `input` are joined, the result is resolved against the [base URL](https://developer.mozilla.org/en-US/docs/Web/API/Node/baseURI) of the page (if any).
-   - Leading slashes in `input` are disallowed when using this option to enforce consistency and avoid confusion about how the `input` URL is handled, given that `input` will not follow the normal URL resolution rules when `prefixUrl` is being used, which changes the meaning of a leading slash.
-
-   @example
-   ```
-   import ky from 'ky';
-
-   // On https://example.com
-
-   const response = await ky('unicorn', {prefixUrl: '/api'});
-   //=> 'https://example.com/api/unicorn'
-
-   const response = await ky('unicorn', {prefixUrl: 'https://cats.com'});
-   //=> 'https://cats.com/unicorn'
-   ```
-   */
-  prefixUrl?: URL | string
-  /**
-   An object representing `limit`, `methods`, `statusCodes` and `maxRetryAfter` fields for maximum retry count, allowed methods, allowed status codes and maximum [`Retry-After`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After) time.
-
-   If `retry` is a number, it will be used as `limit` and other defaults will remain in place.
-
-   If `maxRetryAfter` is set to `undefined`, it will use `options.timeout`. If [`Retry-After`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After) header is greater than `maxRetryAfter`, it will cancel the request.
-
-   Delays between retries is calculated with the function `0.3 * (2 ** (retry - 1)) * 1000`, where `retry` is the attempt number (starts from 1).
-
-   @example
-   ```
-   import ky from 'ky';
-
-   const json = await ky('https://example.com', {
-        retry: {
-            limit: 10,
-            methods: ['get'],
-            statusCodes: [413]
-        }
-    }).json();
-   ```
-   */
-  retry?: RetryOptions | number
-  /**
-   Timeout in milliseconds for getting a response. Can not be greater than 2147483647.
-   If set to `false`, there will be no timeout.
-
-   @default 10000
-   */
-  timeout?: number | false
-  /**
-   Hooks allow modifications during the request lifecycle. Hook functions may be async and are run serially.
-   */
-  hooks?: Hooks
-  /**
-   Throw an `HTTPError` when, after following redirects, the response has a non-2xx status code. To also throw for redirects instead of following them, set the [`redirect`](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch#Parameters) option to `'manual'`.
-
-   Setting this to `false` may be useful if you are checking for resource availability and are expecting error responses.
-
-   @default true
-   */
-  throwHttpErrors?: boolean
-  /**
-   Download progress event handler.
-
-   @param chunk - Note: It's empty for the first call.
-
-   @example
-   ```
-   import ky from 'ky';
-
-   const response = await ky('https://example.com', {
-        onDownloadProgress: (progress, chunk) => {
-            // Example output:
-            // `0% - 0 of 1271 bytes`
-            // `100% - 1271 of 1271 bytes`
-            console.log(`${progress.percent * 100}% - ${progress.transferredBytes} of ${progress.totalBytes} bytes`);
-        }
-    });
-   ```
-   */
-  onDownloadProgress?: (progress: DownloadProgress, chunk: Uint8Array) => void
-  /**
-   User-defined `fetch` function.
-   Has to be fully compatible with the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) standard.
-
-   Use-cases:
-   1. Use custom `fetch` implementations like [`isomorphic-unfetch`](https://www.npmjs.com/package/isomorphic-unfetch).
-   2. Use the `fetch` wrapper function provided by some frameworks that use server-side rendering (SSR).
-
-   @default fetch
-
-   @example
-   ```
-   import ky from 'ky';
-   import fetch from 'isomorphic-unfetch';
-
-   const json = await ky('https://example.com', {fetch}).json();
-   ```
-   */
-  fetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>
-}
-
-export declare type InternalOptions = Required<
-  Omit<Options, 'hooks' | 'retry'>,
-  'credentials' | 'fetch' | 'prefixUrl' | 'timeout'
-> & {
-  hooks: Required<Hooks>
-  retry: Required<RetryOptions>
-  prefixUrl: string
-}
-
-/**
- Normalized options passed to the `fetch` call and the `beforeRequest` hooks.
- */
-export interface NormalizedOptions extends RequestInit {
-  method: RequestInit['method']
-  credentials: RequestInit['credentials']
-  retry: RetryOptions
-  prefixUrl: string
-  onDownloadProgress: Options['onDownloadProgress']
-}
-
-export { RetryOptions }

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

@@ -1,38 +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
- */
-
-/**
- Returns a `Response` object with `Body` methods added for convenience. So you can, for example, call `ky.get(input).json()` directly without having to await the `Response` first. When called like that, an appropriate `Accept` header will be set depending on the body method used. Unlike the `Body` methods of `window.Fetch`; these will throw an `HTTPError` if the response status is not in the range of `200...299`. Also, `.json()` will return an empty string if the response status is `204` instead of throwing a parse error due to an empty body.
- */
-export interface ResponsePromise extends Promise<Response> {
-  arrayBuffer: () => Promise<ArrayBuffer>
-  blob: () => Promise<Blob>
-  formData: () => Promise<FormData>
-  /**
-   Get the response body as JSON.
-
-   @example
-   ```
-   import ky from 'ky';
-
-   const json = await ky(…).json();
-   ```
-
-   @example
-   ```
-   import ky from 'ky';
-
-   interface Result {
-        value: number;
-    }
-
-   const result = await ky(…).json<Result>();
-   ```
-   */
-  json: <T>() => Promise<T>
-  text: () => Promise<string>
-}

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

@@ -1,39 +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 interface RetryOptions {
-  /**
-   The number of times to retry failed requests.
-
-   @default 2
-   */
-  limit?: number
-  /**
-   The HTTP methods allowed to retry.
-
-   @default ['get', 'put', 'head', 'delete', 'options', 'trace']
-   */
-  methods?: string[]
-  /**
-   The HTTP status codes allowed to retry.
-
-   @default [408, 413, 429, 500, 502, 503, 504]
-   */
-  statusCodes?: number[]
-  /**
-   The HTTP status codes allowed to retry with a `Retry-After` header.
-
-   @default [413, 429, 503]
-   */
-  afterStatusCodes?: number[]
-  /**
-   If the `Retry-After` header is greater than `maxRetryAfter`, the request will be canceled.
-
-   @default Infinity
-   */
-  maxRetryAfter?: number
-}

package/src/types/tar-js.d.ts

@@ -1 +0,0 @@
-declare module 'tar-js'

package/src/types/webpack-bundle-analyzer/index.d.ts

@@ -1,13 +0,0 @@
-/**
- * We declare this module manually instead of using the @types/webpack-bundle-analyzer
- * because it relies on the old @types/webpack for v4 that cause incompatibilities with v5
- * because v5 ships its own definitions.
- */
-declare module 'webpack-bundle-analyzer' {
-  import { Compiler, WebpackPluginInstance } from 'webpack'
-
-  export class BundleAnalyzerPlugin implements WebpackPluginInstance {
-    constructor(options?: unknown)
-    apply(compiler: Compiler): void
-  }
-}

package/src/utils/bytes.ts

@@ -1,144 +0,0 @@
-/**
- * Helper type for dealing with fixed size byte arrays.
- *
- * It changes the type of `length` property of `Uint8Array` to the
- * generic `Length` type parameter which is runtime compatible with
- * the original, because it extends from the `number` type.
- */
-import { Data } from '../types'
-import { bytesToHex } from './hex'
-
-export interface Bytes<Length extends number> extends Uint8Array {
-  readonly length: Length
-}
-
-/**
- * Helper type for dealing with flexible sized byte arrays.
- *
- * The actual min and and max values are not stored in runtime, they
- * are only there to differentiate the type from the Uint8Array at
- * compile time.
- * @see BrandedType
- */
-export interface FlexBytes<Min extends number, Max extends number> extends Uint8Array {
-  readonly __min__: Min
-  readonly __max__: Max
-}
-
-/**
- * Type guard for Bytes<T> type
- *
- * @param b       The byte array
- * @param length  The length of the byte array
- */
-export function isBytes<Length extends number>(b: unknown, length: Length): b is Bytes<Length> {
-  return b instanceof Uint8Array && b.length === length
-}
-
-/**
- * Verifies if a byte array has a certain length
- *
- * @param b       The byte array
- * @param length  The specified length
- */
-export function assertBytes<Length extends number>(b: unknown, length: Length): asserts b is Bytes<Length> {
-  if (!isBytes(b, length)) {
-    throw new TypeError(`Parameter is not valid Bytes of length: ${length} !== ${(b as Uint8Array).length}`)
-  }
-}
-
-/**
- * Type guard for FlexBytes<Min,Max> type
- *
- * @param b       The byte array
- * @param min     Minimum size of the array
- * @param max     Maximum size of the array
- */
-export function isFlexBytes<Min extends number, Max extends number = Min>(
-  b: unknown,
-  min: Min,
-  max: Max,
-): b is FlexBytes<Min, Max> {
-  return b instanceof Uint8Array && b.length >= min && b.length <= max
-}
-
-/**
- * Verifies if a byte array has a certain length between min and max
- *
- * @param b       The byte array
- * @param min     Minimum size of the array
- * @param max     Maximum size of the array
- */
-export function assertFlexBytes<Min extends number, Max extends number = Min>(
-  b: unknown,
-  min: Min,
-  max: Max,
-): asserts b is FlexBytes<Min, Max> {
-  if (!isFlexBytes(b, min, max)) {
-    throw new TypeError(
-      `Parameter is not valid FlexBytes of  min: ${min}, max: ${max}, length: ${(b as Uint8Array).length}`,
-    )
-  }
-}
-
-/**
- * Return `length` bytes starting from `offset`
- *
- * @param data   The original data
- * @param offset The offset to start from
- * @param length The length of data to be returned
- */
-export function bytesAtOffset<Length extends number>(data: Uint8Array, offset: number, length: Length): Bytes<Length> {
-  const offsetBytes = data.slice(offset, offset + length) as Bytes<Length>
-
-  // We are returning strongly typed Bytes so we have to verify that length is really what we claim
-  assertBytes<Length>(offsetBytes, length)
-
-  return offsetBytes
-}
-
-/**
- * Return flex bytes starting from `offset`
- *
- * @param data   The original data
- * @param offset The offset to start from
- * @param _min   The minimum size of the data
- * @param _max   The maximum size of the data
- */
-export function flexBytesAtOffset<Min extends number, Max extends number>(
-  data: Uint8Array,
-  offset: number,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  _min: Min,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  _max: Max,
-): FlexBytes<Min, Max> {
-  return data.slice(offset) as FlexBytes<Min, Max>
-}
-
-/**
- * Returns true if two byte arrays are equal
- *
- * @param a Byte array to compare
- * @param b Byte array to compare
- */
-export function bytesEqual(a: Uint8Array, b: Uint8Array): boolean {
-  return a.length === b.length && a.every((value, index) => value === b[index])
-}
-
-/**
- * Returns a new byte array filled with zeroes with the specified length
- *
- * @param length The length of data to be returned
- */
-export function makeBytes<Length extends number>(length: Length): Bytes<Length> {
-  return new Uint8Array(length) as Bytes<Length>
-}
-
-export function wrapBytesWithHelpers(data: Uint8Array): Data {
-  return Object.assign(data, {
-    text: () => new TextDecoder('utf-8').decode(data),
-    json: () => JSON.parse(new TextDecoder('utf-8').decode(data)),
-    hex: () => bytesToHex(data),
-  })
-}