fix: remove retyping of modules with types (#125)

The types are incorrect and cause errors with modules that check the types of their deps.

Types for `is-electron` can be removed once cheton/is-electron#7 is resolved.

Fixes #109

BREAKING CHANGE: `ResponseWithURL` type is not exported any more as it uses a private name and causes an inconsistency between node and the browser

Author: achingbrain

src/http.js

@@ -9,7 +9,7 @@ const { AbortController } = require('native-abort-controller')
 const anySignal = require('any-signal')
 
 /**
- * @typedef {import('native-fetch').Response} Response
+ * @typedef {import('./types').ExtendedResponse} ExtendedResponse
  * @typedef {import('stream').Readable} NodeReadableStream
  * @typedef {import('stream').Duplex} NodeDuplexStream
  * @typedef {import('./types').HTTPOptions} HTTPOptions
@@ -88,7 +88,7 @@ class HTTP {
    *
    * @param {string | Request} resource
    * @param {HTTPOptions} options
-   * @returns {Promise<Response>}
+   * @returns {Promise<ExtendedResponse>}
    */
   async fetch (resource, options = {}) {
     /** @type {HTTPOptions} */
@@ -168,7 +168,6 @@ class HTTP {
   /**
    * @param {string | Request} resource
    * @param {HTTPOptions} options
-   * @returns {Promise<Response>}
    */
   post (resource, options = {}) {
     return this.fetch(resource, { ...options, method: 'POST' })
@@ -177,7 +176,6 @@ class HTTP {
   /**
    * @param {string | Request} resource
    * @param {HTTPOptions} options
-   * @returns {Promise<Response>}
    */
   get (resource, options = {}) {
     return this.fetch(resource, { ...options, method: 'GET' })
@@ -186,7 +184,6 @@ class HTTP {
   /**
    * @param {string | Request} resource
    * @param {HTTPOptions} options
-   * @returns {Promise<Response>}
    */
   put (resource, options = {}) {
     return this.fetch(resource, { ...options, method: 'PUT' })
@@ -195,7 +192,6 @@ class HTTP {
   /**
    * @param {string | Request} resource
    * @param {HTTPOptions} options
-   * @returns {Promise<Response>}
    */
   delete (resource, options = {}) {
     return this.fetch(resource, { ...options, method: 'DELETE' })
@@ -204,7 +200,6 @@ class HTTP {
   /**
    * @param {string | Request} resource
    * @param {HTTPOptions} options
-   * @returns {Promise<Response>}
    */
   options (resource, options = {}) {
     return this.fetch(resource, { ...options, method: 'OPTIONS' })
@@ -335,35 +330,30 @@ HTTP.streamToAsyncIterator = fromStream
 /**
  * @param {string | Request} resource
  * @param {HTTPOptions} [options]
- * @returns {Promise<Response>}
  */
 HTTP.post = (resource, options) => new HTTP(options).post(resource, options)
 
 /**
  * @param {string | Request} resource
  * @param {HTTPOptions} [options]
- * @returns {Promise<Response>}
  */
 HTTP.get = (resource, options) => new HTTP(options).get(resource, options)
 
 /**
  * @param {string | Request} resource
  * @param {HTTPOptions} [options]
- * @returns {Promise<Response>}
  */
 HTTP.put = (resource, options) => new HTTP(options).put(resource, options)
 
 /**
  * @param {string | Request} resource
  * @param {HTTPOptions} [options]
- * @returns {Promise<Response>}
  */
 HTTP.delete = (resource, options) => new HTTP(options).delete(resource, options)
 
 /**
  * @param {string | Request} resource
  * @param {HTTPOptions} [options]
- * @returns {Promise<Response>}
  */
 HTTP.options = (resource, options) => new HTTP(options).options(resource, options)
 

src/http/error.js

@@ -18,7 +18,7 @@ exports.AbortError = AbortError
 
 class HTTPError extends Error {
   /**
-   * @param {import('native-fetch').Response} response
+   * @param {Response} response
    */
   constructor (response) {
     super(response.statusText)

src/http/fetch.browser.js

@@ -136,6 +136,5 @@ class ResponseWithURL extends Response {
 module.exports = {
   fetch: fetchWith,
   Request,
-  Headers,
-  ResponseWithURL
+  Headers
 }

src/http/fetch.node.js

@@ -5,7 +5,6 @@ const { Request, Response, Headers, default: nativeFetch } = require('../fetch')
 const toStream = require('it-to-stream')
 const { Buffer } = require('buffer')
 /**
- * @typedef {import('native-fetch').BodyInit} BodyInit
  * @typedef {import('stream').Readable} NodeReadableStream
  *
  * @typedef {import('../types').FetchOptions} FetchOptions

src/types.d.ts

@@ -1,4 +1,3 @@
-import type { RequestInit, Response } from '../types/native-fetch'
 interface ProgressStatus {
   total: number
   loaded: number
@@ -51,3 +50,9 @@ export interface HTTPOptions extends FetchOptions {
    */
   handleError?: (rsp: Response) => Promise<void>
 }
+
+export interface ExtendedResponse extends Response {
+  iterator: () => AsyncGenerator<Uint8Array, void, undefined>
+
+  ndjson: () => AsyncGenerator<any, void, undefined>
+}