isomorphic-git 1.41.8 → 1.42.0

package/managers/index.cjs

@@ -32,7 +32,7 @@ var crypto$1 = require('crypto');
  * @property {Object} [agent] - An HTTP or HTTPS agent that manages connections for the HTTP client (Node.js only)
  * @property {AsyncIterableIterator<Uint8Array>} [body] - An async iterator of Uint8Arrays that make up the body of POST requests
  * @property {ProgressCallback} [onProgress] - Reserved for future use (emitting `GitProgressEvent`s)
- * @property {object} [signal] - Reserved for future use (canceling a request)
+ * @property {AbortSignal} [signal] - Signal to abort the HTTP request
  * @property {Object} [fetchOptions={}] - Additional options to pass to fetch (Web) or simple-get (Node)
  */
 
@@ -3029,6 +3029,7 @@ class GitRemoteHTTP {
    * @param {string} args.service - The Git service (e.g., "git-upload-pack").
    * @param {string} args.url - The URL of the remote repository.
    * @param {Object<string, string>} args.headers - HTTP headers to include in the request.
+   * @param {AbortSignal} [args.signal] - Signal to abort the operation.
    * @param {1 | 2} args.protocolVersion - The Git protocol version to use.
    * @returns {Promise<Object>} - The parsed response from the remote repository.
    * @throws {HttpError} - If the HTTP request fails.
@@ -3045,6 +3046,7 @@ class GitRemoteHTTP {
     service,
     url: _origUrl,
     headers,
+    signal,
     protocolVersion,
   }) {
     let { url, auth } = extractAuthFromUrl(_origUrl);
@@ -3065,6 +3067,7 @@ class GitRemoteHTTP {
         method: 'GET',
         url: `${proxifiedURL}/info/refs?service=${service}`,
         headers,
+        signal,
       });
 
       // the default loop behavior
@@ -3140,6 +3143,7 @@ class GitRemoteHTTP {
    * @param {Object<string, string>} [args.headers] - HTTP headers to include in the request.
    * @param {any} args.body - The request body to send.
    * @param {any} args.auth - Authentication credentials.
+   * @param {AbortSignal} [args.signal] - Signal to abort the operation.
    * @returns {Promise<GitHttpResponse>} - The HTTP response from the remote repository.
    * @throws {HttpError} - If the HTTP request fails.
    */
@@ -3152,6 +3156,7 @@ class GitRemoteHTTP {
     auth,
     body,
     headers,
+    signal,
   }) {
     // We already have the "correct" auth value at this point, but
     // we need to strip out the username/password from the URL yet again.
@@ -3170,6 +3175,7 @@ class GitRemoteHTTP {
       url: `${url}/${service}`,
       body,
       headers,
+      signal,
     });
     if (res.statusCode !== 200) {
       const { response } = stringifyBody(res);

package/managers/index.d.cts

@@ -51,9 +51,9 @@ export type GitHttpRequest = {
      */
     onProgress?: ProgressCallback | undefined;
     /**
-     * - Reserved for future use (canceling a request)
+     * - Signal to abort the HTTP request
      */
-    signal?: object;
+    signal?: AbortSignal | undefined;
     /**
      * - Additional options to pass to fetch (Web) or simple-get (Node)
      */
@@ -731,13 +731,14 @@ export class GitRemoteHTTP {
      * @param {string} args.service - The Git service (e.g., "git-upload-pack").
      * @param {string} args.url - The URL of the remote repository.
      * @param {Object<string, string>} args.headers - HTTP headers to include in the request.
+     * @param {AbortSignal} [args.signal] - Signal to abort the operation.
      * @param {1 | 2} args.protocolVersion - The Git protocol version to use.
      * @returns {Promise<Object>} - The parsed response from the remote repository.
      * @throws {HttpError} - If the HTTP request fails.
      * @throws {SmartHttpError} - If the response cannot be parsed.
      * @throws {UserCanceledError} - If the user cancels the operation.
      */
-    static discover({ http, onProgress, onAuth, onAuthSuccess, onAuthFailure, corsProxy, service, url: _origUrl, headers, protocolVersion, }: {
+    static discover({ http, onProgress, onAuth, onAuthSuccess, onAuthFailure, corsProxy, service, url: _origUrl, headers, signal, protocolVersion, }: {
         http: HttpClient;
         onProgress?: ProgressCallback | undefined;
         onAuth?: AuthCallback | undefined;
@@ -749,6 +750,7 @@ export class GitRemoteHTTP {
         headers: {
             [x: string]: string;
         };
+        signal?: AbortSignal | undefined;
         protocolVersion: 1 | 2;
     }): Promise<any>;
     /**
@@ -763,10 +765,11 @@ export class GitRemoteHTTP {
      * @param {Object<string, string>} [args.headers] - HTTP headers to include in the request.
      * @param {any} args.body - The request body to send.
      * @param {any} args.auth - Authentication credentials.
+     * @param {AbortSignal} [args.signal] - Signal to abort the operation.
      * @returns {Promise<GitHttpResponse>} - The HTTP response from the remote repository.
      * @throws {HttpError} - If the HTTP request fails.
      */
-    static connect({ http, onProgress, corsProxy, service, url, auth, body, headers, }: {
+    static connect({ http, onProgress, corsProxy, service, url, auth, body, headers, signal, }: {
         http: HttpClient;
         onProgress?: ProgressCallback | undefined;
         corsProxy?: string | undefined;
@@ -777,6 +780,7 @@ export class GitRemoteHTTP {
         } | undefined;
         body: any;
         auth: any;
+        signal?: AbortSignal | undefined;
     }): Promise<GitHttpResponse>;
 }
 /**

package/managers/index.d.ts

@@ -50,9 +50,9 @@ export type GitHttpRequest = {
      */
     onProgress?: ProgressCallback | undefined;
     /**
-     * - Reserved for future use (canceling a request)
+     * - Signal to abort the HTTP request
      */
-    signal?: object;
+    signal?: AbortSignal | undefined;
     /**
      * - Additional options to pass to fetch (Web) or simple-get (Node)
      */
@@ -730,13 +730,14 @@ export class GitRemoteHTTP {
      * @param {string} args.service - The Git service (e.g., "git-upload-pack").
      * @param {string} args.url - The URL of the remote repository.
      * @param {Object<string, string>} args.headers - HTTP headers to include in the request.
+     * @param {AbortSignal} [args.signal] - Signal to abort the operation.
      * @param {1 | 2} args.protocolVersion - The Git protocol version to use.
      * @returns {Promise<Object>} - The parsed response from the remote repository.
      * @throws {HttpError} - If the HTTP request fails.
      * @throws {SmartHttpError} - If the response cannot be parsed.
      * @throws {UserCanceledError} - If the user cancels the operation.
      */
-    static discover({ http, onProgress, onAuth, onAuthSuccess, onAuthFailure, corsProxy, service, url: _origUrl, headers, protocolVersion, }: {
+    static discover({ http, onProgress, onAuth, onAuthSuccess, onAuthFailure, corsProxy, service, url: _origUrl, headers, signal, protocolVersion, }: {
         http: HttpClient;
         onProgress?: ProgressCallback | undefined;
         onAuth?: AuthCallback | undefined;
@@ -748,6 +749,7 @@ export class GitRemoteHTTP {
         headers: {
             [x: string]: string;
         };
+        signal?: AbortSignal | undefined;
         protocolVersion: 1 | 2;
     }): Promise<any>;
     /**
@@ -762,10 +764,11 @@ export class GitRemoteHTTP {
      * @param {Object<string, string>} [args.headers] - HTTP headers to include in the request.
      * @param {any} args.body - The request body to send.
      * @param {any} args.auth - Authentication credentials.
+     * @param {AbortSignal} [args.signal] - Signal to abort the operation.
      * @returns {Promise<GitHttpResponse>} - The HTTP response from the remote repository.
      * @throws {HttpError} - If the HTTP request fails.
      */
-    static connect({ http, onProgress, corsProxy, service, url, auth, body, headers, }: {
+    static connect({ http, onProgress, corsProxy, service, url, auth, body, headers, signal, }: {
         http: HttpClient;
         onProgress?: ProgressCallback | undefined;
         corsProxy?: string | undefined;
@@ -776,6 +779,7 @@ export class GitRemoteHTTP {
         } | undefined;
         body: any;
         auth: any;
+        signal?: AbortSignal | undefined;
     }): Promise<GitHttpResponse>;
 }
 /**

package/managers/index.js

@@ -25,7 +25,7 @@ import pako from 'pako';
  * @property {Object} [agent] - An HTTP or HTTPS agent that manages connections for the HTTP client (Node.js only)
  * @property {AsyncIterableIterator<Uint8Array>} [body] - An async iterator of Uint8Arrays that make up the body of POST requests
  * @property {ProgressCallback} [onProgress] - Reserved for future use (emitting `GitProgressEvent`s)
- * @property {object} [signal] - Reserved for future use (canceling a request)
+ * @property {AbortSignal} [signal] - Signal to abort the HTTP request
  * @property {Object} [fetchOptions={}] - Additional options to pass to fetch (Web) or simple-get (Node)
  */
 
@@ -3022,6 +3022,7 @@ class GitRemoteHTTP {
    * @param {string} args.service - The Git service (e.g., "git-upload-pack").
    * @param {string} args.url - The URL of the remote repository.
    * @param {Object<string, string>} args.headers - HTTP headers to include in the request.
+   * @param {AbortSignal} [args.signal] - Signal to abort the operation.
    * @param {1 | 2} args.protocolVersion - The Git protocol version to use.
    * @returns {Promise<Object>} - The parsed response from the remote repository.
    * @throws {HttpError} - If the HTTP request fails.
@@ -3038,6 +3039,7 @@ class GitRemoteHTTP {
     service,
     url: _origUrl,
     headers,
+    signal,
     protocolVersion,
   }) {
     let { url, auth } = extractAuthFromUrl(_origUrl);
@@ -3058,6 +3060,7 @@ class GitRemoteHTTP {
         method: 'GET',
         url: `${proxifiedURL}/info/refs?service=${service}`,
         headers,
+        signal,
       });
 
       // the default loop behavior
@@ -3133,6 +3136,7 @@ class GitRemoteHTTP {
    * @param {Object<string, string>} [args.headers] - HTTP headers to include in the request.
    * @param {any} args.body - The request body to send.
    * @param {any} args.auth - Authentication credentials.
+   * @param {AbortSignal} [args.signal] - Signal to abort the operation.
    * @returns {Promise<GitHttpResponse>} - The HTTP response from the remote repository.
    * @throws {HttpError} - If the HTTP request fails.
    */
@@ -3145,6 +3149,7 @@ class GitRemoteHTTP {
     auth,
     body,
     headers,
+    signal,
   }) {
     // We already have the "correct" auth value at this point, but
     // we need to strip out the username/password from the URL yet again.
@@ -3163,6 +3168,7 @@ class GitRemoteHTTP {
       url: `${url}/${service}`,
       body,
       headers,
+      signal,
     });
     if (res.statusCode !== 200) {
       const { response } = stringifyBody(res);