feat: formData support (#17)

Author: Gozala

.github/workflows/fetch.yml

@@ -14,6 +14,31 @@ on:
       - ".github/workflows/fetch.yml"
 
 jobs:
+  check:
+    name: Typecheck
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version:
+          - 16
+        project:
+          - fetch
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup node ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install
+        uses: bahmutov/npm-install@v1
+
+      - name: Typecheck
+        uses: gozala/[email protected]
+        with:
+          project: ${{matrix.project}}/tsconfig.json
+
   test:
     name: Test
     runs-on: ${{ matrix.os }}
@@ -22,7 +47,7 @@ jobs:
       matrix:
         node-version:
           - 14
-          - 15
+          - 16
         os:
           - ubuntu-latest
           - windows-latest
@@ -44,20 +69,8 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
 
-      - name: Restore yarn cache
-        id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-
-      - uses: actions/cache@v2
-        id: yarn-cache
-        with:
-          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
-
-      - name: Install dependencies
-        run: yarn install
+      - name: Install
+        uses: bahmutov/npm-install@v1
 
       - name: Test
         run: yarn --cwd ${{matrix.project}} test -- --colors
@@ -81,20 +94,8 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - name: Restore yarn cache
-        id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-
-      - uses: actions/cache@v2
-        id: yarn-cache
-        with:
-          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
-
       - name: Install
-        run: yarn install
+        uses: bahmutov/npm-install@v1
 
       - name: Build
         run: yarn --cwd ${{matrix.project}} build

.prettierignore

@@ -0,0 +1 @@
+fetch

fetch/.gitignore

@@ -3,6 +3,8 @@
 
 # Generated files
 dist/
+@types/
+*.tsbuildinfo
 
 # Logs
 logs

fetch/package.json

@@ -9,14 +9,15 @@
   "exports": {
     ".": {
       "import": "./src/index.js",
-      "require": "./dist/index.cjs"
+      "require": "./dist/index.cjs",
+      "types": "./@types/index.d.ts"
     },
     "./package.json": "./package.json"
   },
   "files": [
     "src",
     "dist",
-    "@types/index.d.ts"
+    "@types"
   ],
   "types": "./@types/index.d.ts",
   "engines": {
@@ -26,9 +27,9 @@
     "build": "rollup -c",
     "test": "node --experimental-modules ../node_modules/c8/bin/c8 --reporter=html --reporter=lcov --reporter=text --check-coverage node --experimental-modules ../node_modules/mocha/bin/mocha",
     "coverage": "c8 report --reporter=text-lcov | coveralls",
-    "test-types": "tsd",
+    "typecheck": "tsc --build",
     "lint": "xo",
-    "prepublishOnly": "node ./test/commonjs/test-artifact.js"
+    "prepublishOnly": "node ./test/commonjs/test-artifact.js && tsc --build"
   },
   "repository": {
     "type": "git",
@@ -67,12 +68,14 @@
     "p-timeout": "^3.2.0",
     "rollup": "^2.26.10",
     "tsd": "^0.13.1",
-    "xo": "^0.33.1"
+    "xo": "^0.33.1",
+    "typescript": "^4.4.4"
   },
   "dependencies": {
     "@web-std/blob": "^2.1.0",
     "data-uri-to-buffer": "^3.0.1",
-    "web-streams-polyfill": "^3.0.2"
+    "web-streams-polyfill": "^3.1.1",
+    "@ssttevee/multipart-parser": "^0.1.9"
   },
   "esm": {
     "sourceMap": true,

fetch/src/body.js

@@ -13,10 +13,9 @@ import WebStreams from 'web-streams-polyfill';
 
 import {FetchError} from './errors/fetch-error.js';
 import {FetchBaseError} from './errors/base.js';
-import {formDataIterator, getBoundary, getFormDataLength} from './utils/form-data.js';
+import {formDataIterator, getBoundary, getFormDataLength, toFormData} from './utils/form-data.js';
 import {isBlob, isURLSearchParameters, isFormData, isMultipartFormDataStream, isReadableStream} from './utils/is.js';
 import * as utf8 from './utils/utf8.js';
-
 const {readableHighWaterMark} = new Stream.Readable();
 
 const {ReadableStream} = WebStreams;
@@ -26,15 +25,12 @@ const INTERNALS = Symbol('Body internals');
  * Body mixin
  *
  * Ref: https://fetch.spec.whatwg.org/#body
- *
- * @param {BodyInit}  body  Readable stream
- * @param   Object  opts  Response options
- * @return  Void
+ * @implements {globalThis.Body}
  */
 
 export default class Body {
 	/**
-	 * @param {BodyInit|Stream} body
+	 * @param {BodyInit|Stream|null} body
 	 * @param {{size?:number}} options
 	 */
 	constructor(body, {
@@ -123,7 +119,7 @@ export default class Body {
 	/** @type {Headers|undefined} */
 	/* c8 ignore next 3 */
 	get headers() {
-		return null;
+		return undefined;
 	}
 
 	get body() {
@@ -176,6 +172,14 @@ export default class Body {
 		const buffer = await consumeBody(this);
 		return utf8.decode(buffer);
 	}
+
+	/**
+	 * @returns {Promise<FormData>}
+	 */
+
+	async formData() {
+		return toFormData(this)
+	}
 }
 
 // In browsers, all properties are enumerable.
@@ -185,7 +189,8 @@ Object.defineProperties(Body.prototype, {
 	arrayBuffer: {enumerable: true},
 	blob: {enumerable: true},
 	json: {enumerable: true},
-	text: {enumerable: true}
+	text: {enumerable: true},
+	formData: {enumerable: true}
 });
 
 /**
@@ -217,8 +222,9 @@ async function consumeBody(data) {
 
 	// Body is stream
 	// get ready to actually consume the body
+	/** @type {[Uint8Array|null, Uint8Array[], number]} */
 	const [buffer, chunks, limit] = data.size > 0 ?
-		[new Uint8Array(data.size), null, data.size] :
+		[new Uint8Array(data.size), [], data.size] :
 		[null, [], Infinity];
 	let offset = 0;
 
@@ -244,7 +250,7 @@ async function consumeBody(data) {
 
 		if (buffer) {
 			if (offset < buffer.byteLength) {
-				throw new FetchError(`Premature close of server response while trying to fetch ${data.url}`);
+				throw new FetchError(`Premature close of server response while trying to fetch ${data.url}`, 'premature-close');
 			} else {
 				return buffer;
 			}
@@ -254,11 +260,13 @@ async function consumeBody(data) {
 	} catch (error) {
 		if (error instanceof FetchBaseError) {
 			throw error;
+		// @ts-expect-error - we know it will have a name
 		} else if (error && error.name === 'AbortError') {
 			throw error;
 		} else {
+			const e = /** @type {import('./errors/fetch-error').SystemError} */(error)
 			// Other errors, such as incorrect content-encoding
-			throw new FetchError(`Invalid response body while trying to fetch ${data.url}: ${error.message}`, 'system', error);
+			throw new FetchError(`Invalid response body while trying to fetch ${data.url}: ${e.message}`, 'system', e);
 		}
 	}
 }
@@ -277,6 +285,7 @@ export const clone = instance => {
 		throw new Error('cannot clone body after it is used');
 	}
 
+	// @ts-expect-error - could be null
 	const [left, right] = body.tee();
 	instance[INTERNALS].body = left;
 	return right;
@@ -332,7 +341,6 @@ class StreamIterableIterator {
 	constructor(stream) {
 		this.stream = stream;
 		this.reader = null;
-		this.state = null;
 	}
 
 	/**
@@ -359,6 +367,9 @@ class StreamIterableIterator {
 		return /** @type {Promise<IteratorResult<T, void>>} */ (this.getReader().read());
 	}
 
+	/**
+	 * @returns {Promise<IteratorResult<T, void>>}
+	 */
 	async return() {
 		if (this.reader) {
 			await this.reader.cancel();
@@ -367,6 +378,11 @@ class StreamIterableIterator {
 		return {done: true, value: undefined};
 	}
 
+	/**
+	 * 
+	 * @param {any} error 
+	 * @returns {Promise<IteratorResult<T, void>>}
+	 */
 	async throw(error) {
 		await this.getReader().cancel(error);
 		return {done: true, value: undefined};
@@ -429,7 +445,7 @@ class AsyncIterablePump {
 	 */
 	async pull(controller) {
 		try {
-			while (controller.desiredSize > 0) {
+			while (controller.desiredSize || 0 > 0) {
 				// eslint-disable-next-line no-await-in-loop
 				const next = await this.source.next();
 				if (next.done) {
@@ -444,6 +460,9 @@ class AsyncIterablePump {
 		}
 	}
 
+	/**
+	 * @param {any} [reason]
+	 */
 	cancel(reason) {
 		if (reason) {
 			if (typeof this.source.throw === 'function') {
@@ -463,8 +482,8 @@ class AsyncIterablePump {
  */
 export const fromStream = source => {
 	const pump = new StreamPump(source);
-	const stream =
-		/** @type {ReadableStream<Uint8Array>} */(new ReadableStream(pump, pump));
+	const stream = new ReadableStream(pump, pump);
+	// @ts-ignore - web-streams-polyfill API is incompatible
 	return stream;
 };
 
@@ -490,6 +509,10 @@ class StreamPump {
 		this.close = this.close.bind(this);
 	}
 
+	/**
+	 * @param {Uint8Array} chunk
+	 * @returns 
+	 */
 	size(chunk) {
 		return chunk.byteLength;
 	}
@@ -509,6 +532,9 @@ class StreamPump {
 		this.resume();
 	}
 
+	/**
+	 * @param {any} [reason]
+	 */
 	cancel(reason) {
 		if (this.stream.destroy) {
 			this.stream.destroy(reason);
@@ -530,7 +556,7 @@ class StreamPump {
 					chunk :
 					Buffer.from(chunk);
 
-				const available = this.controller.desiredSize - bytes.byteLength;
+				const available = (this.controller.desiredSize || 0) - bytes.byteLength;
 				this.controller.enqueue(bytes);
 				if (available <= 0) {
 					this.pause();
@@ -561,6 +587,9 @@ class StreamPump {
 		}
 	}
 
+	/**
+	 * @param {Error} error 
+	 */
 	error(error) {
 		if (this.controller) {
 			this.controller.error(error);

fetch/src/errors/abort-error.js

@@ -4,6 +4,10 @@ import {FetchBaseError} from './base.js';
  * AbortError interface for cancelled requests
  */
 export class AbortError extends FetchBaseError {
+	/**
+	 * @param {string} message 
+	 * @param {string} [type]
+	 */
 	constructor(message, type = 'aborted') {
 		super(message, type);
 	}

fetch/src/errors/base.js

@@ -1,6 +1,10 @@
 'use strict';
 
 export class FetchBaseError extends Error {
+	/**
+	 * @param {string} message 
+	 * @param {string} type 
+	 */
 	constructor(message, type) {
 		super(message);
 		// Hide custom error implementation details from end-users