@ethersphere/bee-js 3.2.0 → 3.3.2-pre.0

package/dist/types/types/ky-options.d.ts

@@ -0,0 +1,221 @@
+/**
+ * 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 './ky-universal/common';
+import type { Hooks } from './ky-universal/hooks';
+import type { RetryOptions } from './ky-universal/retry';
+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()` 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/dist/types/types/ky-universal/common.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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/dist/types/types/ky-universal/hooks.d.ts

@@ -0,0 +1,92 @@
+/**
+ * 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 '../ky-options';
+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[];
+}

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

@@ -0,0 +1,38 @@
+/**
+ * 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/dist/types/utils/collection.browser.d.ts

@@ -0,0 +1,15 @@
+import { Collection } from '../types';
+/**
+ * Creates array in the format of Collection with data loaded from directory on filesystem.
+ * The function loads all the data into memory!
+ *
+ * @param dir path to the directory
+ */
+export declare function makeCollectionFromFS(dir: string): Promise<Collection<Uint8Array>>;
+/**
+ * Calculate folder size recursively
+ *
+ * @param dir the path to the folder to check
+ * @returns size in bytes
+ */
+export declare function getFolderSize(dir: string): Promise<number>;

package/dist/{src → types}/utils/collection.d.ts

@@ -1,13 +1,6 @@
 import { Collection } from '../types';
 export declare function isCollection(data: unknown): data is Collection<Uint8Array>;
 export declare function assertCollection(data: unknown): asserts data is Collection<Uint8Array>;
-/**
- * Creates array in the format of Collection with data loaded from directory on filesystem.
- * The function loads all the data into memory!
- *
- * @param dir path to the directory
- */
-export declare function makeCollectionFromFS(dir: string): Promise<Collection<Uint8Array>>;
 export declare function makeCollectionFromFileList(fileList: FileList | File[]): Promise<Collection<Uint8Array>>;
 /**
  * Calculate cumulative size of files
@@ -16,10 +9,3 @@ export declare function makeCollectionFromFileList(fileList: FileList | File[]):
  * @returns size in bytes
  */
 export declare function getCollectionSize(fileList: FileList | File[]): number;
-/**
- * Calculate folder size recursively
- *
- * @param dir the path to the folder to check
- * @returns size in bytes
- */
-export declare function getFolderSize(dir: string): Promise<number>;

package/dist/types/utils/collection.node.d.ts

@@ -0,0 +1,15 @@
+import { Collection } from '../types';
+/**
+ * Creates array in the format of Collection with data loaded from directory on filesystem.
+ * The function loads all the data into memory!
+ *
+ * @param dir path to the directory
+ */
+export declare function makeCollectionFromFS(dir: string): Promise<Collection<Uint8Array>>;
+/**
+ * Calculate folder size recursively
+ *
+ * @param dir the path to the folder to check
+ * @returns size in bytes
+ */
+export declare function getFolderSize(dir: string): Promise<number>;

package/dist/{src → types}/utils/expose.d.ts

@@ -1,4 +1,5 @@
-export { getCollectionSize, getFolderSize } from './collection';
+export { getCollectionSize } from './collection';
+export { getFolderSize } from './collection.node';
 export { Bytes, FlexBytes, isBytes, assertBytes, isFlexBytes, assertFlexBytes, bytesAtOffset, flexBytesAtOffset, bytesEqual, } from './bytes';
 export { HexString, PrefixedHexString, makeHexString, hexToBytes, bytesToHex, intToHex, isHexString, assertHexString, assertPrefixedHexString, } from './hex';
 export { EthAddress, makeEthAddress, makeHexEthAddress, isHexEthAddress, ethToSwarmAddress, toLittleEndian, fromLittleEndian, makeEthereumWalletSigner, } from './eth';

package/dist/{src → types}/utils/stream.d.ts

@@ -1,7 +1,6 @@
 /// <reference types="node" />
-import type { Readable as NodeReadableType } from 'stream';
-import { ReadableStream } from 'web-streams-polyfill/ponyfill';
-import { ReadableOptions as NodeReadableOptions } from 'readable-stream';
+import { Readable as NodeReadableNative, ReadableOptions as NodeReadableOptions } from 'stream';
+import { ReadableStream } from 'web-streams-polyfill';
 import { Readable } from '../types';
 /**
  * Validates if passed object is either browser's ReadableStream
@@ -9,9 +8,9 @@ import { Readable } from '../types';
  *
  * @param entry
  */
-export declare function isReadable(entry: unknown): entry is NodeReadableType;
+export declare function isReadable(entry: unknown): entry is Readable;
 export declare function isReadableStream(entry: unknown): entry is ReadableStream;
-export declare function isNodeReadable(entry: unknown): entry is NodeReadableType;
+export declare function isNodeReadable(entry: unknown): entry is NodeReadableNative;
 /**
  * Function that converts Node's Readable into WHATWG ReadableStream
  *
@@ -22,16 +21,20 @@ export declare function isNodeReadable(entry: unknown): entry is NodeReadableTyp
  * @licence Apache License 2.0 https://github.com/gwicke/node-web-streams/blob/master/LICENSE
  * @param nodeStream
  */
-export declare function readableNodeToWeb(nodeStream: NodeReadableType): ReadableStream<Uint8Array>;
+export declare function readableNodeToWeb(nodeStream: NodeReadableNative): ReadableStream<Uint8Array>;
 /**
  * Function that converts WHATWG ReadableStream into Node's Readable
  *
  * Taken over from https://github.com/gwicke/node-web-streams/blob/master/lib/conversions.js
- * Because it uses forked web-streams-polyfill that are outdated.
+ * Because it uses forked web-streams-polyfill that is outdated.
+ *
+ * **Warning!**
+ * If you want to use this function in browser you have to polyfill `stream` package with your bundler.
  *
  * @author https://github.com/gwicke
  * @licence Apache License 2.0 https://github.com/gwicke/node-web-streams/blob/master/LICENSE
  * @param webStream
+ * @param options
  */
-export declare function readableWebToNode(webStream: ReadableStream, options?: NodeReadableOptions): NodeReadableType;
+export declare function readableWebToNode(webStream: ReadableStream<unknown>, options?: NodeReadableOptions): NodeReadableNative;
 export declare function normalizeToReadableStream(stream: Readable): ReadableStream;