isomorphic-git 1.41.8 → 1.42.0

package/http/node/index.cjs

@@ -27,7 +27,7 @@ var get = _interopDefault(require('simple-get'));
  * @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)
  */
 
@@ -198,6 +198,7 @@ async function request({
   agent,
   fetchOptions = {},
   body,
+  signal,
 }) {
   // If we can, we should send it as a single buffer so it sets a Content-Length header.
   if (body && Array.isArray(body)) {
@@ -215,6 +216,7 @@ async function request({
         headers,
         agent,
         body,
+        signal: signal ?? fetchOptions.signal,
       },
       (err, res) => {
         if (err) return reject(err)

package/http/node/index.d.cts

@@ -34,9 +34,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)
      */
@@ -83,4 +83,4 @@ declare namespace index {
  * @param {GitHttpRequest} request
  * @returns {Promise<GitHttpResponse>}
  */
-export function request({ onProgress, url, method, headers, agent, fetchOptions, body, }: GitHttpRequest): Promise<GitHttpResponse>;
+export function request({ onProgress, url, method, headers, agent, fetchOptions, body, signal, }: GitHttpRequest): Promise<GitHttpResponse>;

package/http/node/index.d.ts

@@ -33,9 +33,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)
      */
@@ -82,4 +82,4 @@ declare namespace index {
  * @param {GitHttpRequest} request
  * @returns {Promise<GitHttpResponse>}
  */
-export function request({ onProgress, url, method, headers, agent, fetchOptions, body, }: GitHttpRequest): Promise<GitHttpResponse>;
+export function request({ onProgress, url, method, headers, agent, fetchOptions, body, signal, }: GitHttpRequest): Promise<GitHttpResponse>;

package/http/node/index.js

@@ -21,7 +21,7 @@ import get from 'simple-get';
  * @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)
  */
 
@@ -192,6 +192,7 @@ async function request({
   agent,
   fetchOptions = {},
   body,
+  signal,
 }) {
   // If we can, we should send it as a single buffer so it sets a Content-Length header.
   if (body && Array.isArray(body)) {
@@ -209,6 +210,7 @@ async function request({
         headers,
         agent,
         body,
+        signal: signal ?? fetchOptions.signal,
       },
       (err, res) => {
         if (err) return reject(err)

package/http/web/index.cjs

@@ -23,7 +23,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
  * @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)
  */
 
@@ -142,13 +142,20 @@ async function request({
   headers = {},
   fetchOptions = {},
   body,
+  signal,
 }) {
   // streaming uploads aren't possible yet in the browser
   if (body) {
     // @ts-expect-error
     body = await collect(body);
   }
-  const res = await fetch(url, { ...fetchOptions, method, headers, body });
+  const res = await fetch(url, {
+    ...fetchOptions,
+    method,
+    headers,
+    body,
+    signal: signal ?? fetchOptions.signal,
+  });
   const iter =
     // @ts-expect-error
     res.body && res.body.getReader

package/http/web/index.d.cts

@@ -34,9 +34,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)
      */
@@ -83,4 +83,4 @@ declare namespace index {
  * @param {GitHttpRequest} request
  * @returns {Promise<GitHttpResponse>}
  */
-export function request({ onProgress, url, method, headers, fetchOptions, body, }: GitHttpRequest): Promise<GitHttpResponse>;
+export function request({ onProgress, url, method, headers, fetchOptions, body, signal, }: GitHttpRequest): Promise<GitHttpResponse>;

package/http/web/index.d.ts

@@ -33,9 +33,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)
      */
@@ -82,4 +82,4 @@ declare namespace index {
  * @param {GitHttpRequest} request
  * @returns {Promise<GitHttpResponse>}
  */
-export function request({ onProgress, url, method, headers, fetchOptions, body, }: GitHttpRequest): Promise<GitHttpResponse>;
+export function request({ onProgress, url, method, headers, fetchOptions, body, signal, }: GitHttpRequest): Promise<GitHttpResponse>;

package/http/web/index.js

@@ -19,7 +19,7 @@
  * @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)
  */
 
@@ -138,13 +138,20 @@ async function request({
   headers = {},
   fetchOptions = {},
   body,
+  signal,
 }) {
   // streaming uploads aren't possible yet in the browser
   if (body) {
     // @ts-expect-error
     body = await collect(body);
   }
-  const res = await fetch(url, { ...fetchOptions, method, headers, body });
+  const res = await fetch(url, {
+    ...fetchOptions,
+    method,
+    headers,
+    body,
+    signal: signal ?? fetchOptions.signal,
+  });
   const iter =
     // @ts-expect-error
     res.body && res.body.getReader

package/http/web/index.umd.js

@@ -25,7 +25,7 @@
    * @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)
    */
 
@@ -144,13 +144,20 @@
     headers = {},
     fetchOptions = {},
     body,
+    signal,
   }) {
     // streaming uploads aren't possible yet in the browser
     if (body) {
       // @ts-expect-error
       body = await collect(body);
     }
-    const res = await fetch(url, { ...fetchOptions, method, headers, body });
+    const res = await fetch(url, {
+      ...fetchOptions,
+      method,
+      headers,
+      body,
+      signal: signal ?? fetchOptions.signal,
+    });
     const iter =
       // @ts-expect-error
       res.body && res.body.getReader

package/index.cjs

@@ -35,7 +35,7 @@ var diff3Merge = _interopDefault(require('diff3'));
  * @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)
  */
 
@@ -7123,11 +7123,17 @@ const worthWalking = (filepath, root) => {
   if (filepath === '.' || root == null || root.length === 0 || root === '.') {
     return true
   }
-  if (root.length >= filepath.length) {
-    return root.startsWith(filepath)
-  } else {
-    return filepath.startsWith(root)
+  // A shared prefix only counts when it lands on a path component boundary,
+  // otherwise the root 'src' would also pull in 'src2/a.js' and 'srcfoo.txt'.
+  const base = root.endsWith('/') ? root.slice(0, -1) : root;
+  if (base === '.') {
+    return true
+  }
+  if (base.length >= filepath.length) {
+    // Keep walking while filepath is still an ancestor of the wanted root.
+    return base === filepath || base.startsWith(`${filepath}/`)
   }
+  return filepath.startsWith(`${base}/`)
 };
 
 // @ts-check
@@ -9391,6 +9397,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.
@@ -9407,6 +9414,7 @@ class GitRemoteHTTP {
     service,
     url: _origUrl,
     headers,
+    signal,
     protocolVersion,
   }) {
     let { url, auth } = extractAuthFromUrl(_origUrl);
@@ -9427,6 +9435,7 @@ class GitRemoteHTTP {
         method: 'GET',
         url: `${proxifiedURL}/info/refs?service=${service}`,
         headers,
+        signal,
       });
 
       // the default loop behavior
@@ -9502,6 +9511,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.
    */
@@ -9514,6 +9524,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.
@@ -9532,6 +9543,7 @@ class GitRemoteHTTP {
       url: `${url}/${service}`,
       body,
       headers,
+      signal,
     });
     if (res.statusCode !== 200) {
       const { response } = stringifyBody(res);
@@ -9767,8 +9779,8 @@ function filterCapabilities(server, client) {
 
 const pkg = {
   name: 'isomorphic-git',
-  version: '1.41.8',
-  agent: 'git/isomorphic-git@1.41.8',
+  version: '1.42.0',
+  agent: 'git/isomorphic-git@1.42.0',
 };
 
 class FIFO {
@@ -12077,6 +12089,30 @@ async function getConfigAll({
  *
  */
 
+// Assign `value` at the `/`-separated `path` inside `root`, creating the
+// intermediate objects as we go.
+//
+// Ref names come straight off the wire, so a path segment must never be allowed
+// to walk out of `root` and into the prototype chain. The `hasOwnProperty` check
+// takes care of inherited keys such as `constructor` by shadowing them with a
+// fresh object; `__proto__` gets no such treatment because assigning it invokes
+// the setter instead of creating an own property, so refs containing it are
+// dropped.
+//
+// NB: deliberately not a JSDoc comment. `__tests__/__helpers__/generate-docs.cjs`
+// turns every documented function in `src/api` into a public doc page.
+function assignRefPath(root, path, value) {
+  const parts = path.split('/');
+  const last = parts.pop();
+  if (last === '__proto__' || parts.includes('__proto__')) return
+  let o = root;
+  for (const part of parts) {
+    if (!Object.prototype.hasOwnProperty.call(o, part)) o[part] = {};
+    o = o[part];
+  }
+  o[last] = value;
+}
+
 /**
  * List a remote servers branches, tags, and capabilities.
  *
@@ -12141,25 +12177,11 @@ async function getRemoteInfo({
     // Convert the flat list into an object tree, because I figure 99% of the time
     // that will be easier to use.
     for (const [ref, oid] of remote.refs) {
-      const parts = ref.split('/');
-      const last = parts.pop();
-      let o = result;
-      for (const part of parts) {
-        o[part] = o[part] || {};
-        o = o[part];
-      }
-      o[last] = oid;
+      assignRefPath(result, ref, oid);
     }
     // Merge symrefs on top of refs to more closely match actual git repo layouts
     for (const [symref, ref] of remote.symrefs) {
-      const parts = symref.split('/');
-      const last = parts.pop();
-      let o = result;
-      for (const part of parts) {
-        o[part] = o[part] || {};
-        o = o[part];
-      }
-      o[last] = ref;
+      assignRefPath(result, symref, ref);
     }
     return result
   } catch (err) {
@@ -14333,6 +14355,7 @@ async function writeReceivePackRequest({
  * @param {boolean} [args.delete = false]
  * @param {string} [args.url]
  * @param {string} [args.corsProxy]
+ * @param {AbortSignal} [args.signal]
  * @param {Object<string, string>} [args.headers]
  *
  * @returns {Promise<PushResult>}
@@ -14356,6 +14379,7 @@ async function _push({
   delete: _delete = false,
   corsProxy,
   headers = {},
+  signal,
 }) {
   const ref = _ref || (await _currentBranch({ fs, gitdir }));
   if (typeof ref === 'undefined') {
@@ -14404,6 +14428,7 @@ async function _push({
     url,
     headers,
     protocolVersion: 1,
+    signal,
   });
   const auth = httpRemote.auth; // hack to get new credentials from CredentialManager API
   let fullRemoteRef;
@@ -14559,6 +14584,7 @@ async function _push({
     auth,
     headers,
     body: [...packstream1, ...packstream2],
+    signal,
   });
   const { packfile, progress } = await GitSideBand.demux(res.body);
   if (onMessage) {
@@ -14635,6 +14661,7 @@ async function _push({
  * @param {string} [args.corsProxy] - Optional [CORS proxy](https://www.npmjs.com/%40isomorphic-git/cors-proxy). Overrides value in repo config.
  * @param {Object<string, string>} [args.headers] - Additional headers to include in HTTP requests, similar to git's `extraHeader` config
  * @param {object} [args.cache] - a [cache](cache.md) object
+ * @param {AbortSignal} [args.signal] - Optional signal to abort the push operation
  *
  * @returns {Promise<PushResult>} Resolves successfully when push completes with a detailed description of the operation from the server.
  * @see PushResult
@@ -14672,6 +14699,7 @@ async function push({
   corsProxy,
   headers = {},
   cache = {},
+  signal,
 }) {
   try {
     assertParameter('fs', fs);
@@ -14699,6 +14727,7 @@ async function push({
       delete: _delete,
       corsProxy,
       headers,
+      signal,
     })
   } catch (err) {
     err.caller = 'git.push';

package/index.d.cts

@@ -302,9 +302,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)
      */
@@ -1660,17 +1660,6 @@ export function getConfigAll({ fs, dir, gitdir, path, }: {
     gitdir?: string | undefined;
     path: string;
 }): Promise<Array<any>>;
-/**
- *
- * @typedef {Object} GetRemoteInfoResult - The object returned has the following schema:
- * @property {string[]} capabilities - The list of capabilities returned by the server (part of the Git protocol)
- * @property {Object} [refs]
- * @property {string} [HEAD] - The default branch of the remote
- * @property {Object<string, string>} [refs.heads] - The branches on the remote
- * @property {Object<string, string>} [refs.pull] - The special branches representing pull requests (non-standard)
- * @property {Object<string, string>} [refs.tags] - The tags on the remote
- *
- */
 /**
  * List a remote servers branches, tags, and capabilities.
  *
@@ -2517,6 +2506,7 @@ export function pull({ fs: _fs, http, onProgress, onMessage, onAuth, onAuthSucce
  * @param {string} [args.corsProxy] - Optional [CORS proxy](https://www.npmjs.com/%40isomorphic-git/cors-proxy). Overrides value in repo config.
  * @param {Object<string, string>} [args.headers] - Additional headers to include in HTTP requests, similar to git's `extraHeader` config
  * @param {object} [args.cache] - a [cache](cache.md) object
+ * @param {AbortSignal} [args.signal] - Optional signal to abort the push operation
  *
  * @returns {Promise<PushResult>} Resolves successfully when push completes with a detailed description of the operation from the server.
  * @see PushResult
@@ -2534,7 +2524,7 @@ export function pull({ fs: _fs, http, onProgress, onMessage, onAuth, onAuthSucce
  * console.log(pushResult)
  *
  */
-export function push({ fs, http, onProgress, onMessage, onAuth, onAuthSuccess, onAuthFailure, onPrePush, dir, gitdir, ref, remoteRef, remote, url, force, delete: _delete, corsProxy, headers, cache, }: {
+export function push({ fs, http, onProgress, onMessage, onAuth, onAuthSuccess, onAuthFailure, onPrePush, dir, gitdir, ref, remoteRef, remote, url, force, delete: _delete, corsProxy, headers, cache, signal, }: {
     fs: FsClient;
     http: HttpClient;
     onProgress?: ProgressCallback | undefined;
@@ -2556,6 +2546,7 @@ export function push({ fs, http, onProgress, onMessage, onAuth, onAuthSuccess, o
         [x: string]: string;
     } | undefined;
     cache?: object;
+    signal?: AbortSignal | undefined;
 }): Promise<PushResult>;
 /**
  *
@@ -4504,7 +4495,7 @@ declare namespace NoCommitError {
  * @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)
  */
 /**

package/index.d.ts

@@ -301,9 +301,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)
      */
@@ -1659,17 +1659,6 @@ export function getConfigAll({ fs, dir, gitdir, path, }: {
     gitdir?: string | undefined;
     path: string;
 }): Promise<Array<any>>;
-/**
- *
- * @typedef {Object} GetRemoteInfoResult - The object returned has the following schema:
- * @property {string[]} capabilities - The list of capabilities returned by the server (part of the Git protocol)
- * @property {Object} [refs]
- * @property {string} [HEAD] - The default branch of the remote
- * @property {Object<string, string>} [refs.heads] - The branches on the remote
- * @property {Object<string, string>} [refs.pull] - The special branches representing pull requests (non-standard)
- * @property {Object<string, string>} [refs.tags] - The tags on the remote
- *
- */
 /**
  * List a remote servers branches, tags, and capabilities.
  *
@@ -2516,6 +2505,7 @@ export function pull({ fs: _fs, http, onProgress, onMessage, onAuth, onAuthSucce
  * @param {string} [args.corsProxy] - Optional [CORS proxy](https://www.npmjs.com/%40isomorphic-git/cors-proxy). Overrides value in repo config.
  * @param {Object<string, string>} [args.headers] - Additional headers to include in HTTP requests, similar to git's `extraHeader` config
  * @param {object} [args.cache] - a [cache](cache.md) object
+ * @param {AbortSignal} [args.signal] - Optional signal to abort the push operation
  *
  * @returns {Promise<PushResult>} Resolves successfully when push completes with a detailed description of the operation from the server.
  * @see PushResult
@@ -2533,7 +2523,7 @@ export function pull({ fs: _fs, http, onProgress, onMessage, onAuth, onAuthSucce
  * console.log(pushResult)
  *
  */
-export function push({ fs, http, onProgress, onMessage, onAuth, onAuthSuccess, onAuthFailure, onPrePush, dir, gitdir, ref, remoteRef, remote, url, force, delete: _delete, corsProxy, headers, cache, }: {
+export function push({ fs, http, onProgress, onMessage, onAuth, onAuthSuccess, onAuthFailure, onPrePush, dir, gitdir, ref, remoteRef, remote, url, force, delete: _delete, corsProxy, headers, cache, signal, }: {
     fs: FsClient;
     http: HttpClient;
     onProgress?: ProgressCallback | undefined;
@@ -2555,6 +2545,7 @@ export function push({ fs, http, onProgress, onMessage, onAuth, onAuthSuccess, o
         [x: string]: string;
     } | undefined;
     cache?: object;
+    signal?: AbortSignal | undefined;
 }): Promise<PushResult>;
 /**
  *
@@ -4503,7 +4494,7 @@ declare namespace NoCommitError {
  * @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)
  */
 /**