@gitbeaker/requester-utils 38.7.0 → 38.8.0

package/dist/index.d.ts

@@ -4,13 +4,6 @@ interface FormattedResponse<T extends ResponseBodyTypes = ResponseBodyTypes> {
     headers: Record<string, string>;
     status: number;
 }
-interface RequesterType {
-    get<T extends ResponseBodyTypes>(endpoint: string, options?: Record<string, unknown>): Promise<FormattedResponse<T>>;
-    post<T extends ResponseBodyTypes>(endpoint: string, options?: Record<string, unknown>): Promise<FormattedResponse<T>>;
-    put<T extends ResponseBodyTypes>(endpoint: string, options?: Record<string, unknown>): Promise<FormattedResponse<T>>;
-    patch<T extends ResponseBodyTypes>(endpoint: string, options?: Record<string, unknown>): Promise<FormattedResponse<T>>;
-    delete<T extends ResponseBodyTypes>(endpoint: string, options?: Record<string, unknown>): Promise<FormattedResponse<T>>;
-}
 interface Constructable<T = any> {
     new (...args: any[]): T;
 }
@@ -18,16 +11,16 @@ type DefaultResourceOptions = {
     headers: {
         [header: string]: string;
     };
-    requestTimeout: number;
     url: string;
     rejectUnauthorized: boolean;
 };
 type DefaultRequestOptions = {
     body?: FormData | Record<string, unknown>;
     searchParams?: Record<string, unknown>;
-    sudo?: string;
+    sudo?: string | number;
     method?: string;
     asStream?: boolean;
+    signal?: AbortSignal;
 };
 type RequestOptions = {
     headers: Record<string, string>;
@@ -37,10 +30,18 @@ type RequestOptions = {
     prefixUrl: string;
     body?: string | FormData;
     asStream?: boolean;
+    signal?: AbortSignal;
 };
+interface RequesterType {
+    get<T extends ResponseBodyTypes>(endpoint: string, options?: DefaultRequestOptions): Promise<FormattedResponse<T>>;
+    post<T extends ResponseBodyTypes>(endpoint: string, options?: DefaultRequestOptions): Promise<FormattedResponse<T>>;
+    put<T extends ResponseBodyTypes>(endpoint: string, options?: DefaultRequestOptions): Promise<FormattedResponse<T>>;
+    patch<T extends ResponseBodyTypes>(endpoint: string, options?: DefaultRequestOptions): Promise<FormattedResponse<T>>;
+    delete<T extends ResponseBodyTypes>(endpoint: string, options?: DefaultRequestOptions): Promise<FormattedResponse<T>>;
+}
 declare function formatQuery(params?: Record<string, unknown>): string;
 type OptionsHandlerFn = (serviceOptions: DefaultResourceOptions, requestOptions: DefaultRequestOptions) => Promise<RequestOptions>;
-declare function defaultOptionsHandler(resourceOptions: DefaultResourceOptions, { body, searchParams, sudo, asStream, method }?: DefaultRequestOptions): Promise<RequestOptions>;
+declare function defaultOptionsHandler(resourceOptions: DefaultResourceOptions, { body, searchParams, sudo, signal, asStream, method, }?: DefaultRequestOptions): Promise<RequestOptions>;
 type RequestHandlerFn<T extends ResponseBodyTypes = ResponseBodyTypes> = (endpoint: string, options?: Record<string, unknown>) => Promise<FormattedResponse<T>>;
 declare function createRequesterFn(optionsHandler: OptionsHandlerFn, requestHandler: RequestHandlerFn): (serviceOptions: DefaultResourceOptions) => RequesterType;
 declare function presetResourceArguments<T extends Record<string, Constructable>>(resources: T, customConfig?: Record<string, unknown>): T;
@@ -54,7 +55,7 @@ interface BaseResourceOptions<C> {
     rejectUnauthorized?: boolean;
     camelize?: C;
     requesterFn?: (resourceOptions: DefaultResourceOptions) => RequesterType;
-    requestTimeout?: number;
+    queryTimeout?: number | null;
     profileToken?: string;
     sudo?: string | number;
     profileMode?: 'execution' | 'memory';
@@ -62,13 +63,13 @@ interface BaseResourceOptions<C> {
 declare class BaseResource<C extends boolean = false> {
     readonly url: string;
     readonly requester: RequesterType;
-    readonly requestTimeout: number;
+    readonly queryTimeout: number | null;
     readonly headers: {
         [header: string]: string;
     };
     readonly camelize: C | undefined;
     readonly rejectUnauthorized: boolean;
-    constructor({ token, jobToken, oauthToken, sudo, profileToken, requesterFn, camelize, profileMode, host, prefixUrl, rejectUnauthorized, requestTimeout, }?: BaseResourceOptions<C>);
+    constructor({ token, jobToken, oauthToken, sudo, profileToken, requesterFn, camelize, profileMode, host, prefixUrl, rejectUnauthorized, queryTimeout, }?: BaseResourceOptions<C>);
 }
 
 export { BaseResource, BaseResourceOptions, Constructable, DefaultRequestOptions, DefaultResourceOptions, FormattedResponse, OptionsHandlerFn, RequestHandlerFn, RequestOptions, RequesterType, ResponseBodyTypes, createRequesterFn, defaultOptionsHandler, formatQuery, presetResourceArguments };

package/dist/index.js

@@ -1,7 +1,7 @@
 'use strict';
 
-var xcase = require('xcase');
 var qs = require('qs');
+var xcase = require('xcase');
 
 // src/RequesterUtils.ts
 function formatQuery(params = {}) {
@@ -11,18 +11,25 @@ function formatQuery(params = {}) {
 function isFormData(object) {
   return typeof object === "object" && object.constructor.name === "FormData";
 }
-function defaultOptionsHandler(resourceOptions, { body, searchParams, sudo, asStream = false, method = "get" } = {}) {
-  const { headers: preconfiguredHeaders, requestTimeout, url } = resourceOptions;
+function defaultOptionsHandler(resourceOptions, {
+  body,
+  searchParams,
+  sudo,
+  signal,
+  asStream = false,
+  method = "get"
+} = {}) {
+  const { headers: preconfiguredHeaders, url } = resourceOptions;
   const headers = { ...preconfiguredHeaders };
   const defaultOptions = {
     headers,
-    timeout: requestTimeout,
     method,
     asStream,
+    signal,
     prefixUrl: url
   };
   if (sudo)
-    defaultOptions.headers.sudo = sudo;
+    defaultOptions.headers.sudo = `${sudo}`;
   if (body) {
     if (isFormData(body)) {
       defaultOptions.body = body;
@@ -69,7 +76,7 @@ function presetResourceArguments(resources, customConfig = {}) {
 var BaseResource = class {
   url;
   requester;
-  requestTimeout;
+  queryTimeout;
   headers;
   camelize;
   rejectUnauthorized;
@@ -85,7 +92,7 @@ var BaseResource = class {
     host = "https://gitlab.com",
     prefixUrl = "",
     rejectUnauthorized = true,
-    requestTimeout = 3e5
+    queryTimeout = 3e5
   } = {}) {
     if (!requesterFn)
       throw new ReferenceError("requesterFn must be passed");
@@ -93,7 +100,7 @@ var BaseResource = class {
     this.headers = {};
     this.rejectUnauthorized = rejectUnauthorized;
     this.camelize = camelize;
-    this.requestTimeout = requestTimeout;
+    this.queryTimeout = queryTimeout;
     if (oauthToken)
       this.headers.authorization = `Bearer ${oauthToken}`;
     else if (jobToken)

package/dist/index.mjs

@@ -1,5 +1,5 @@
-import { decamelizeKeys } from 'xcase';
 import { stringify } from 'qs';
+import { decamelizeKeys } from 'xcase';
 
 // src/RequesterUtils.ts
 function formatQuery(params = {}) {
@@ -9,18 +9,25 @@ function formatQuery(params = {}) {
 function isFormData(object) {
   return typeof object === "object" && object.constructor.name === "FormData";
 }
-function defaultOptionsHandler(resourceOptions, { body, searchParams, sudo, asStream = false, method = "get" } = {}) {
-  const { headers: preconfiguredHeaders, requestTimeout, url } = resourceOptions;
+function defaultOptionsHandler(resourceOptions, {
+  body,
+  searchParams,
+  sudo,
+  signal,
+  asStream = false,
+  method = "get"
+} = {}) {
+  const { headers: preconfiguredHeaders, url } = resourceOptions;
   const headers = { ...preconfiguredHeaders };
   const defaultOptions = {
     headers,
-    timeout: requestTimeout,
     method,
     asStream,
+    signal,
     prefixUrl: url
   };
   if (sudo)
-    defaultOptions.headers.sudo = sudo;
+    defaultOptions.headers.sudo = `${sudo}`;
   if (body) {
     if (isFormData(body)) {
       defaultOptions.body = body;
@@ -67,7 +74,7 @@ function presetResourceArguments(resources, customConfig = {}) {
 var BaseResource = class {
   url;
   requester;
-  requestTimeout;
+  queryTimeout;
   headers;
   camelize;
   rejectUnauthorized;
@@ -83,7 +90,7 @@ var BaseResource = class {
     host = "https://gitlab.com",
     prefixUrl = "",
     rejectUnauthorized = true,
-    requestTimeout = 3e5
+    queryTimeout = 3e5
   } = {}) {
     if (!requesterFn)
       throw new ReferenceError("requesterFn must be passed");
@@ -91,7 +98,7 @@ var BaseResource = class {
     this.headers = {};
     this.rejectUnauthorized = rejectUnauthorized;
     this.camelize = camelize;
-    this.requestTimeout = requestTimeout;
+    this.queryTimeout = queryTimeout;
     if (oauthToken)
       this.headers.authorization = `Bearer ${oauthToken}`;
     else if (jobToken)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitbeaker/requester-utils",
-  "version": "38.7.0",
+  "version": "38.8.0",
   "description": "Utility functions for requester implementatons used in @gitbeaker",
   "license": "MIT",
   "engines": {
@@ -59,5 +59,5 @@
     "tsup": "^6.7.0",
     "typescript": "^5.0.4"
   },
-  "gitHead": "e35a0e9745a64004accbb644d7ddc40acacb7315"
+  "gitHead": "fecce64a1a754794ad6e133eca04f36215914495"
 }