fetch-har 9.0.0 → 11.0.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2020, ReadMe
+Copyright (c) 2023, ReadMe
 
 Permission to use, copy, modify, and/or distribute this software for any purpose
 with or without fee is hereby granted, provided that the above copyright notice

package/README.md

@@ -1,4 +1,5 @@
 # fetch-har
+
 Make a [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) request from a HAR definition.
 
 [![CI](https://github.com/readmeio/fetch-har/workflows/CI/badge.svg)](https://github.com/readmeio/fetch-har/)
@@ -9,10 +10,10 @@ Make a [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) reque
 
 ## Features
 
-- Supports Node 14+ (including the native `fetch` implementation in Node 18!).
+- Supports Node 18+
 - Natively works in all browsers that support [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) without having to use any polyfils.
 - [Tested](https://github.com/readmeio/fetch-har/actions) across Chrome, Safari, Firefox on Mac, Windows, and Linux.
-- Requests can be mocked with [nock](https://npm.im/nock) or [fetch-mock](https://npm.im/fetch-mock).
+- Requests can be mocked with [`msw`](https://npm.im/msw) or [`fetch-mock`](https://npm.im/fetch-mock) (though the latter does not appear to be maintained).
 
 ## Installation
 
@@ -21,14 +22,10 @@ npm install --save fetch-har
 ```
 
 ## Usage
-```js
-require('isomorphic-fetch');
 
-// If executing from an environment that doesn't normally provide `fetch()` we'll automatically
-// polyfill in the `Blob`, `File`, and `FormData` APIs with the optional `formdata-node` package
-// (provided you've installed it).
-const fetchHAR = require('fetch-har').default;
-// import fetchHAR from 'fetch-har'); // Or if you're in an ESM codebase.
+```js
+import fetchHAR from 'fetch-har';
+// const fetchHAR = require('fetch-har');
 
 const har = {
   log: {
@@ -67,14 +64,11 @@ fetchHAR(har)
 ```
 
 ### API
-If you are executing `fetch-har` in a browser environment that supports the [FormData API](https://developer.mozilla.org/en-US/docs/Web/API/FormData) then you don't need to do anything. If you arent, however, you'll need to polyfill it.
-
-Unfortunately the most popular NPM package [form-data](https://npm.im/form-data) ships with a [non-spec compliant API](https://github.com/form-data/form-data/issues/124), and for this we don't recommend you use it, as if you use `fetch-har` to upload files it may not work.
-
-Though we recommend either [formdata-node](https://npm.im/formdata-node) or [formdata-polyfill](https://npm.im/formdata-polyfill) we prefer [formdata-node](https://npm.im/formdata-node) right now as it's CJS-compatible.
 
 #### Options
+
 ##### userAgent
+
 A custom `User-Agent` header to apply to your request. Please note that browsers have their own handling for these headers in `fetch()` calls so it may not work everywhere; it will always be sent in Node however.
 
 ```js
@@ -82,33 +76,22 @@ await fetchHAR(har, { userAgent: 'my-client/1.0' });
 ```
 
 ##### files
+
 An optional object map you can supply to use for `multipart/form-data` file uploads in leu of relying on if the HAR you have has [data URLs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs). It supports Node file buffers and the [File](https://developer.mozilla.org/en-US/docs/Web/API/File) API.
 
 ```js
-await fetchHAR(har, { files: {
-  'owlbert.png': await fs.readFile('./owlbert.png'),
-  'file.txt': document.querySelector('#some-file-input').files[0],
-} });
+await fetchHAR(har, {
+  files: {
+    'owlbert.png': await fs.readFile('./owlbert.png'),
+    'file.txt': document.querySelector('#some-file-input').files[0],
+  },
+});
 ```
 
 If you don't supply this option `fetch-har` will fallback to the data URL present within the supplied HAR. If no `files` option is present, and no data URL (via `param.value`) is present in the HAR, a fatal exception will be thrown.
 
-##### multipartEncoder
-> ❗ If you are using `fetch-har` in Node you may need this option to execute `multipart/form-data` requests!
-
-If you are running `fetch-har` within a Node environment and you're using `node-fetch@2`, or another `fetch` polyfill that does not support a spec-compliant `FormData` API, you will need to specify an encoder that will transform your `FormData` object into something that can be used with [Request.body](https://developer.mozilla.org/en-US/docs/Web/API/Request/body).
-
-We recommend [form-data-encoder](https://npm.im/form-data-encoder).
-
-```js
-const { FormDataEncoder } = require('form-data-encoder');
-
-await fetchHAR(har, { multipartEncoder: FormDataEncoder });
-```
-
-You do **not**, and shouldn't, need to use this option in browser environments.
-
 ##### init
+
 This optional argument lets you supply any option that's available to supply to the [Request constructor](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request).
 
 ```js
@@ -118,7 +101,7 @@ await fetchHAR(har, {
       'x-custom-header': 'buster',
     }),
   },
-})
+});
 ```
 
 > ❗ Note that if you supply `body` or `credentials` to this option they may be overridden by what your HAR requires.

package/dist/index.d.mts

@@ -0,0 +1,6 @@
+import { FetchHAROptions } from './types.mjs';
+import { Har } from 'har-format';
+
+declare function fetchHAR(har: Har, opts?: FetchHAROptions): Promise<Response>;
+
+export { fetchHAR as default };

package/dist/index.d.ts

@@ -1,22 +1,6 @@
-/// <reference types="node" />
-import type { Har } from 'har-format';
-interface RequestInitWithDuplex extends RequestInit {
-    /**
-     * `RequestInit#duplex` does not yet exist in the TS `lib.dom.d.ts` definition yet the native
-     * fetch implementation in Node 18+, `undici`, requires it for certain POST payloads.
-     *
-     * @see {@link https://github.com/microsoft/TypeScript-DOM-lib-generator/issues/1483}
-     * @see {@link https://github.com/nodejs/node/issues/46221}
-     * @see {@link https://fetch.spec.whatwg.org/#request-class}
-     * @see {@link https://github.com/microsoft/TypeScript/blob/main/lib/lib.dom.d.ts}
-     */
-    duplex?: 'half';
-}
-export interface FetchHAROptions {
-    userAgent?: string;
-    files?: Record<string, Blob | Buffer>;
-    multipartEncoder?: any;
-    init?: RequestInitWithDuplex;
-}
-export default function fetchHAR(har: Har, opts?: FetchHAROptions): Promise<Response>;
-export {};
+import { FetchHAROptions } from './types.js';
+import { Har } from 'har-format';
+
+declare function fetchHAR(har: Har, opts?: FetchHAROptions): Promise<Response>;
+
+export = fetchHAR;