@gitbeaker/requester-utils 43.5.0 → 43.6.0

package/LICENSE.md

@@ -1,7 +1,7 @@
 # The MIT License
 
 Copyright (c)
-**2023 Justin Dalrymple**
+**2025 Justin Dalrymple**
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -26,11 +26,13 @@
 </div>
 
 <p align="center">
-   <a href="https://gitlab.com/jdalrymple/gitbeaker/-/commits/main"><img alt="pipeline status" src="https://gitlab.com/jdalrymple/gitbeaker/badges/main/pipeline.svg?ignore_skipped=true" /></a>
-   <a href="https://gitlab.com/jdalrymple/gitbeaker/-/commits/main"><img alt="coverage report" src="https://gitlab.com/jdalrymple/gitbeaker/badges/main/coverage.svg?job=test:unit:utils" /></a>
-  <a href="https://codeclimate.com/github/jdalrymple/gitbeaker">
-    <img src="https://codeclimate.com/github/jdalrymple/gitbeaker/badges/gpa.svg" alt="Code Climate maintainability">
+  <a href="https://dl.circleci.com/status-badge/redirect/gh/jdalrymple/gitbeaker/tree/main">
+    <img alt="CircleCI" src="https://dl.circleci.com/status-badge/img/gh/jdalrymple/gitbeaker/tree/main.svg?style=svg" />
   </a>
+  <a href="https://codecov.io/gh/jdalrymple/gitbeaker">
+    <img alt="Requester Utils Coverage" src="https://img.shields.io/codecov/c/github/jdalrymple/gitbeaker?flag=requester-utils&logo=codecov&label=coverage"/>
+  </a>
+
   <a href="https://github.com/intuit/auto">
     <img src="https://img.shields.io/badge/release-auto.svg?colorA=888888&colorB=9B065A&label=auto" alt="Auto">
   </a>
@@ -230,6 +232,7 @@ import { RequesterUtils, BaseResource } from '@gitbeaker/requester-utils';
       <td align="center" valign="top" width="0.33%"><a href="https://github.com/kayw-geek"><img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/29700073?v=4&h=25&w=25&fit=cover&mask=circle&maxage=7d" alt="Kay W."/></td>
       <td align="center" valign="top" width="0.33%"><a href="https://ffflorian.dev/"><img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/5497598?v=4&h=25&w=25&fit=cover&mask=circle&maxage=7d" alt="Florian Imdahl"/></td>
       <td align="center" valign="top" width="0.33%"><a href="https://github.com/lanthier"><img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/9666344?v=4&h=25&w=25&fit=cover&mask=circle&maxage=7d" alt="lanthier"/></td>
+      <td align="center" valign="top" width="0.33%"><a href="https://github.com/Teo-ShaoWei"><img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/6925907?v=4&h=25&w=25&fit=cover&mask=circle&maxage=7d" alt="ShaoWei Teo"/></td>
     </tr>
 </p>
 

package/dist/index.d.mts

@@ -1,3 +1,5 @@
+import { Agent } from 'http';
+
 type RateLimiterFn = () => Promise<number>;
 type RateLimiters = Record<string, RateLimiterFn | {
     method: string;
@@ -24,9 +26,9 @@ type ResourceOptions = {
         [authHeader: string]: () => Promise<string>;
     };
     url: string;
-    rejectUnauthorized: boolean;
     rateLimits?: RateLimitOptions;
     rateLimitDuration?: number;
+    agent?: Agent;
 };
 type DefaultRequestOptions = {
     body?: FormData | Record<string, unknown>;
@@ -46,6 +48,7 @@ type RequestOptions = {
     asStream?: boolean;
     signal?: AbortSignal;
     rateLimiters?: Record<string, RateLimiterFn>;
+    agent?: Agent;
 };
 interface RequesterType {
     get<T extends ResponseBodyTypes>(endpoint: string, options?: DefaultRequestOptions): Promise<FormattedResponse<T>>;
@@ -55,20 +58,22 @@ interface RequesterType {
     delete<T extends ResponseBodyTypes>(endpoint: string, options?: DefaultRequestOptions): Promise<FormattedResponse<T>>;
 }
 type RequestHandlerFn<T extends ResponseBodyTypes = ResponseBodyTypes> = (endpoint: string, options?: Record<string, unknown>) => Promise<FormattedResponse<T>>;
-declare function generateRateLimiterFn(limit: number, interval: number): () => Promise<number>;
+declare function generateRateLimiterFn(limit: number, interval: number): () => Promise<any>;
 declare function formatQuery(params?: Record<string, unknown>): string;
 type OptionsHandlerFn = (serviceOptions: ResourceOptions, requestOptions: RequestOptions) => Promise<RequestOptions>;
 declare function defaultOptionsHandler(resourceOptions: ResourceOptions, { body, searchParams, sudo, signal, asStream, method, }?: DefaultRequestOptions): Promise<RequestOptions>;
 declare function createRateLimiters(rateLimitOptions?: RateLimitOptions, rateLimitDuration?: number): RateLimiters;
 declare function createRequesterFn(optionsHandler: OptionsHandlerFn, requestHandler: RequestHandlerFn): (serviceOptions: ResourceOptions) => RequesterType;
-declare function presetResourceArguments<T extends Record<string, Constructable>>(resources: T, customConfig?: Record<string, unknown>): T;
+type PresetConstructors<T> = {
+    [K in keyof T]: T[K];
+};
+declare function presetResourceArguments<T extends Record<string, any>>(resources: T, customConfig?: Record<string, unknown>): PresetConstructors<T>;
 declare function getMatchingRateLimiter(endpoint: string, rateLimiters?: RateLimiters, method?: string): RateLimiterFn;
 
 interface RootResourceOptions<C> {
     requesterFn?: (resourceOptions: ResourceOptions) => RequesterType;
     host?: string;
     prefixUrl?: string;
-    rejectUnauthorized?: boolean;
     camelize?: C;
     queryTimeout?: number | null;
     rateLimitDuration?: number;
@@ -76,6 +81,7 @@ interface RootResourceOptions<C> {
     profileToken?: string;
     profileMode?: 'execution' | 'memory';
     rateLimits?: RateLimitOptions;
+    agent?: Agent;
 }
 type GitlabToken = string | (() => Promise<string>);
 interface BaseRequestOptionsWithOAuthToken<C> extends RootResourceOptions<C> {
@@ -100,8 +106,7 @@ declare class BaseResource<C extends boolean = false> {
         [authHeader: string]: () => Promise<string>;
     };
     readonly camelize: C | undefined;
-    readonly rejectUnauthorized: boolean;
-    constructor({ sudo, profileToken, camelize, requesterFn, profileMode, host, prefixUrl, rejectUnauthorized, queryTimeout, rateLimitDuration, rateLimits, ...tokens }: BaseResourceOptions<C>);
+    constructor({ sudo, profileToken, camelize, requesterFn, agent, profileMode, host, prefixUrl, queryTimeout, rateLimitDuration, rateLimits, ...tokens }: BaseResourceOptions<C>);
 }
 
 declare class GitbeakerRequestError extends Error {

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { Agent } from 'http';
+
 type RateLimiterFn = () => Promise<number>;
 type RateLimiters = Record<string, RateLimiterFn | {
     method: string;
@@ -24,9 +26,9 @@ type ResourceOptions = {
         [authHeader: string]: () => Promise<string>;
     };
     url: string;
-    rejectUnauthorized: boolean;
     rateLimits?: RateLimitOptions;
     rateLimitDuration?: number;
+    agent?: Agent;
 };
 type DefaultRequestOptions = {
     body?: FormData | Record<string, unknown>;
@@ -46,6 +48,7 @@ type RequestOptions = {
     asStream?: boolean;
     signal?: AbortSignal;
     rateLimiters?: Record<string, RateLimiterFn>;
+    agent?: Agent;
 };
 interface RequesterType {
     get<T extends ResponseBodyTypes>(endpoint: string, options?: DefaultRequestOptions): Promise<FormattedResponse<T>>;
@@ -55,20 +58,22 @@ interface RequesterType {
     delete<T extends ResponseBodyTypes>(endpoint: string, options?: DefaultRequestOptions): Promise<FormattedResponse<T>>;
 }
 type RequestHandlerFn<T extends ResponseBodyTypes = ResponseBodyTypes> = (endpoint: string, options?: Record<string, unknown>) => Promise<FormattedResponse<T>>;
-declare function generateRateLimiterFn(limit: number, interval: number): () => Promise<number>;
+declare function generateRateLimiterFn(limit: number, interval: number): () => Promise<any>;
 declare function formatQuery(params?: Record<string, unknown>): string;
 type OptionsHandlerFn = (serviceOptions: ResourceOptions, requestOptions: RequestOptions) => Promise<RequestOptions>;
 declare function defaultOptionsHandler(resourceOptions: ResourceOptions, { body, searchParams, sudo, signal, asStream, method, }?: DefaultRequestOptions): Promise<RequestOptions>;
 declare function createRateLimiters(rateLimitOptions?: RateLimitOptions, rateLimitDuration?: number): RateLimiters;
 declare function createRequesterFn(optionsHandler: OptionsHandlerFn, requestHandler: RequestHandlerFn): (serviceOptions: ResourceOptions) => RequesterType;
-declare function presetResourceArguments<T extends Record<string, Constructable>>(resources: T, customConfig?: Record<string, unknown>): T;
+type PresetConstructors<T> = {
+    [K in keyof T]: T[K];
+};
+declare function presetResourceArguments<T extends Record<string, any>>(resources: T, customConfig?: Record<string, unknown>): PresetConstructors<T>;
 declare function getMatchingRateLimiter(endpoint: string, rateLimiters?: RateLimiters, method?: string): RateLimiterFn;
 
 interface RootResourceOptions<C> {
     requesterFn?: (resourceOptions: ResourceOptions) => RequesterType;
     host?: string;
     prefixUrl?: string;
-    rejectUnauthorized?: boolean;
     camelize?: C;
     queryTimeout?: number | null;
     rateLimitDuration?: number;
@@ -76,6 +81,7 @@ interface RootResourceOptions<C> {
     profileToken?: string;
     profileMode?: 'execution' | 'memory';
     rateLimits?: RateLimitOptions;
+    agent?: Agent;
 }
 type GitlabToken = string | (() => Promise<string>);
 interface BaseRequestOptionsWithOAuthToken<C> extends RootResourceOptions<C> {
@@ -100,8 +106,7 @@ declare class BaseResource<C extends boolean = false> {
         [authHeader: string]: () => Promise<string>;
     };
     readonly camelize: C | undefined;
-    readonly rejectUnauthorized: boolean;
-    constructor({ sudo, profileToken, camelize, requesterFn, profileMode, host, prefixUrl, rejectUnauthorized, queryTimeout, rateLimitDuration, rateLimits, ...tokens }: BaseResourceOptions<C>);
+    constructor({ sudo, profileToken, camelize, requesterFn, agent, profileMode, host, prefixUrl, queryTimeout, rateLimitDuration, rateLimits, ...tokens }: BaseResourceOptions<C>);
 }
 
 declare class GitbeakerRequestError extends Error {

package/dist/index.js

@@ -29,12 +29,13 @@ async function defaultOptionsHandler(resourceOptions, {
   asStream = false,
   method = "GET"
 } = {}) {
-  const { headers: preconfiguredHeaders, authHeaders, url } = resourceOptions;
+  const { headers: preconfiguredHeaders, authHeaders, url, agent } = resourceOptions;
   const defaultOptions = {
     method,
     asStream,
     signal,
-    prefixUrl: url
+    prefixUrl: url,
+    agent
   };
   defaultOptions.headers = { ...preconfiguredHeaders };
   if (sudo) defaultOptions.headers.sudo = `${sudo}`;
@@ -88,20 +89,27 @@ function createRequesterFn(optionsHandler, requestHandler) {
     return requester;
   };
 }
-function extendClass(Base, customConfig) {
-  return class extends Base {
-    constructor(...options) {
-      const [config, ...opts] = options;
-      super({ ...customConfig, ...config }, ...opts);
+function createPresetConstructor(Constructor, presetConfig) {
+  return class extends Constructor {
+    constructor(...args) {
+      const [config, ...rest] = args;
+      super({ ...presetConfig, ...config }, ...rest);
     }
   };
 }
 function presetResourceArguments(resources, customConfig = {}) {
-  const updated = {};
-  Object.entries(resources).filter(([, s]) => typeof s === "function").forEach(([k, r]) => {
-    updated[k] = extendClass(r, customConfig);
+  const result = {};
+  Object.entries(resources).forEach(([key, Constructor]) => {
+    if (typeof Constructor === "function") {
+      result[key] = createPresetConstructor(
+        Constructor,
+        customConfig
+      );
+    } else {
+      result[key] = Constructor;
+    }
   });
-  return updated;
+  return result;
 }
 function getMatchingRateLimiter(endpoint, rateLimiters = {}, method = "GET") {
   const sortedEndpoints = Object.keys(rateLimiters).sort().reverse();
@@ -160,16 +168,15 @@ var BaseResource = class {
   headers;
   authHeaders;
   camelize;
-  rejectUnauthorized;
   constructor({
     sudo,
     profileToken,
     camelize,
     requesterFn,
+    agent,
     profileMode = "execution",
     host = "https://gitlab.com",
     prefixUrl = "",
-    rejectUnauthorized = true,
     queryTimeout = 3e5,
     rateLimitDuration = 60,
     rateLimits = DEFAULT_RATE_LIMITS,
@@ -179,7 +186,6 @@ var BaseResource = class {
     this.url = [host, "api", "v4", prefixUrl].join("/");
     this.headers = {};
     this.authHeaders = {};
-    this.rejectUnauthorized = rejectUnauthorized;
     this.camelize = camelize;
     this.queryTimeout = queryTimeout;
     if ("oauthToken" in tokens)
@@ -196,7 +202,7 @@ var BaseResource = class {
       this.headers["X-Profile-Mode"] = profileMode;
     }
     if (sudo) this.headers.Sudo = `${sudo}`;
-    this.requester = requesterFn({ ...this, rateLimits, rateLimitDuration });
+    this.requester = requesterFn({ ...this, rateLimits, rateLimitDuration, agent });
   }
 };
 

package/dist/index.mjs

@@ -23,12 +23,13 @@ async function defaultOptionsHandler(resourceOptions, {
   asStream = false,
   method = "GET"
 } = {}) {
-  const { headers: preconfiguredHeaders, authHeaders, url } = resourceOptions;
+  const { headers: preconfiguredHeaders, authHeaders, url, agent } = resourceOptions;
   const defaultOptions = {
     method,
     asStream,
     signal,
-    prefixUrl: url
+    prefixUrl: url,
+    agent
   };
   defaultOptions.headers = { ...preconfiguredHeaders };
   if (sudo) defaultOptions.headers.sudo = `${sudo}`;
@@ -82,20 +83,27 @@ function createRequesterFn(optionsHandler, requestHandler) {
     return requester;
   };
 }
-function extendClass(Base, customConfig) {
-  return class extends Base {
-    constructor(...options) {
-      const [config, ...opts] = options;
-      super({ ...customConfig, ...config }, ...opts);
+function createPresetConstructor(Constructor, presetConfig) {
+  return class extends Constructor {
+    constructor(...args) {
+      const [config, ...rest] = args;
+      super({ ...presetConfig, ...config }, ...rest);
     }
   };
 }
 function presetResourceArguments(resources, customConfig = {}) {
-  const updated = {};
-  Object.entries(resources).filter(([, s]) => typeof s === "function").forEach(([k, r]) => {
-    updated[k] = extendClass(r, customConfig);
+  const result = {};
+  Object.entries(resources).forEach(([key, Constructor]) => {
+    if (typeof Constructor === "function") {
+      result[key] = createPresetConstructor(
+        Constructor,
+        customConfig
+      );
+    } else {
+      result[key] = Constructor;
+    }
   });
-  return updated;
+  return result;
 }
 function getMatchingRateLimiter(endpoint, rateLimiters = {}, method = "GET") {
   const sortedEndpoints = Object.keys(rateLimiters).sort().reverse();
@@ -154,16 +162,15 @@ var BaseResource = class {
   headers;
   authHeaders;
   camelize;
-  rejectUnauthorized;
   constructor({
     sudo,
     profileToken,
     camelize,
     requesterFn,
+    agent,
     profileMode = "execution",
     host = "https://gitlab.com",
     prefixUrl = "",
-    rejectUnauthorized = true,
     queryTimeout = 3e5,
     rateLimitDuration = 60,
     rateLimits = DEFAULT_RATE_LIMITS,
@@ -173,7 +180,6 @@ var BaseResource = class {
     this.url = [host, "api", "v4", prefixUrl].join("/");
     this.headers = {};
     this.authHeaders = {};
-    this.rejectUnauthorized = rejectUnauthorized;
     this.camelize = camelize;
     this.queryTimeout = queryTimeout;
     if ("oauthToken" in tokens)
@@ -190,7 +196,7 @@ var BaseResource = class {
       this.headers["X-Profile-Mode"] = profileMode;
     }
     if (sudo) this.headers.Sudo = `${sudo}`;
-    this.requester = requesterFn({ ...this, rateLimits, rateLimitDuration });
+    this.requester = requesterFn({ ...this, rateLimits, rateLimitDuration, agent });
   }
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitbeaker/requester-utils",
-  "version": "43.5.0",
+  "version": "43.6.0",
   "description": "Utility functions for requester implementatons used in @gitbeaker",
   "license": "MIT",
   "engines": {
@@ -49,13 +49,14 @@
   "dependencies": {
     "picomatch-browser": "^2.2.6",
     "qs": "^6.14.0",
-    "rate-limiter-flexible": "^7.2.0",
+    "rate-limiter-flexible": "^8.0.1",
     "xcase": "^2.0.1"
   },
   "devDependencies": {
     "@types/node": "^24.3.0",
+    "@types/qs": "^6.14.0",
     "tsup": "^8.5.0",
     "typescript": "^5.9.2"
   },
-  "gitHead": "faad2c9e72b04588356ad081f9b79417039c03bc"
+  "gitHead": "bdafa8ad001658674492b09a948f02fb22cd45a9"
 }