@gitbeaker/requester-utils 39.10.2 → 39.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +1 -0
  2. package/dist/index.d.mts +9 -9
  3. package/dist/index.d.ts +9 -9
  4. package/dist/index.js +7 -3
  5. package/dist/index.mjs +7 -3
  6. package/package.json +2 -2
package/README.md CHANGED
@@ -226,6 +226,7 @@ import { RequesterUtils, BaseResource } from '@gitbeaker/requester-utils';
226
226
  <td align="center" valign="top" width="3.84%"><a href="https://github.com/Bambii556"><img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/34485027?v=4&h=25&w=25&fit=cover&mask=circle&maxage=7d" alt="Bambii"/></td>
227
227
  <td align="center" valign="top" width="3.84%"><a href="https://github.com/ravewill"><img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/128541928?v=4&h=25&w=25&fit=cover&mask=circle&maxage=7d" alt="Will"/></td>
228
228
  <td align="center" valign="top" width="3.84%"><a href="https://github.com/ArnaudTA"><img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/33383276?v=4&h=25&w=25&fit=cover&mask=circle&maxage=7d" alt="ArnaudTA"/></td>
229
+ <td align="center" valign="top" width="3.84%"><a href="https://github.com/kouak"><img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/48335?v=4&h=25&w=25&fit=cover&mask=circle&maxage=7d" alt="Benjamin Beret"/></td>
229
230
  </tr>
230
231
  </p>
231
232
 
package/dist/index.d.mts CHANGED
@@ -7,7 +7,7 @@ interface FormattedResponse<T extends ResponseBodyTypes = ResponseBodyTypes> {
7
7
  interface Constructable<T = any> {
8
8
  new (...args: any[]): T;
9
9
  }
10
- type DefaultResourceOptions = {
10
+ type ResourceOptions = {
11
11
  headers: {
12
12
  [header: string]: string;
13
13
  };
@@ -26,11 +26,11 @@ type DefaultRequestOptions = {
26
26
  signal?: AbortSignal;
27
27
  };
28
28
  type RequestOptions = {
29
- headers: Record<string, string>;
29
+ headers?: Record<string, string>;
30
30
  timeout?: number;
31
- method: string;
31
+ method?: string;
32
32
  searchParams?: string;
33
- prefixUrl: string;
33
+ prefixUrl?: string;
34
34
  body?: string | FormData;
35
35
  asStream?: boolean;
36
36
  signal?: AbortSignal;
@@ -43,14 +43,14 @@ interface RequesterType {
43
43
  delete<T extends ResponseBodyTypes>(endpoint: string, options?: DefaultRequestOptions): Promise<FormattedResponse<T>>;
44
44
  }
45
45
  declare function formatQuery(params?: Record<string, unknown>): string;
46
- type OptionsHandlerFn = (serviceOptions: DefaultResourceOptions, requestOptions: DefaultRequestOptions) => Promise<RequestOptions>;
47
- declare function defaultOptionsHandler(resourceOptions: DefaultResourceOptions, { body, searchParams, sudo, signal, asStream, method, }?: DefaultRequestOptions): Promise<RequestOptions>;
46
+ type OptionsHandlerFn = (serviceOptions: ResourceOptions, requestOptions: RequestOptions) => Promise<RequestOptions>;
47
+ declare function defaultOptionsHandler(resourceOptions: ResourceOptions, { body, searchParams, sudo, signal, asStream, method, }?: DefaultRequestOptions): Promise<RequestOptions>;
48
48
  type RequestHandlerFn<T extends ResponseBodyTypes = ResponseBodyTypes> = (endpoint: string, options?: Record<string, unknown>) => Promise<FormattedResponse<T>>;
49
- declare function createRequesterFn(optionsHandler: OptionsHandlerFn, requestHandler: RequestHandlerFn): (serviceOptions: DefaultResourceOptions) => RequesterType;
49
+ declare function createRequesterFn(optionsHandler: OptionsHandlerFn, requestHandler: RequestHandlerFn): (serviceOptions: ResourceOptions) => RequesterType;
50
50
  declare function presetResourceArguments<T extends Record<string, Constructable>>(resources: T, customConfig?: Record<string, unknown>): T;
51
51
 
52
52
  interface RootResourceOptions<C> {
53
- requesterFn?: (resourceOptions: DefaultResourceOptions) => RequesterType;
53
+ requesterFn?: (resourceOptions: ResourceOptions) => RequesterType;
54
54
  host?: string;
55
55
  prefixUrl?: string;
56
56
  rejectUnauthorized?: boolean;
@@ -86,4 +86,4 @@ declare class BaseResource<C extends boolean = false> {
86
86
  constructor({ sudo, profileToken, camelize, requesterFn, profileMode, host, prefixUrl, rejectUnauthorized, queryTimeout, ...tokens }: BaseResourceOptions<C>);
87
87
  }
88
88
 
89
- export { BaseRequestOptionsWithAccessToken, BaseRequestOptionsWithJobToken, BaseRequestOptionsWithOAuthToken, BaseResource, BaseResourceOptions, Constructable, DefaultRequestOptions, DefaultResourceOptions, FormattedResponse, GitlabToken, OptionsHandlerFn, RequestHandlerFn, RequestOptions, RequesterType, ResponseBodyTypes, RootResourceOptions, createRequesterFn, defaultOptionsHandler, formatQuery, presetResourceArguments };
89
+ export { BaseRequestOptionsWithAccessToken, BaseRequestOptionsWithJobToken, BaseRequestOptionsWithOAuthToken, BaseResource, BaseResourceOptions, Constructable, DefaultRequestOptions, FormattedResponse, GitlabToken, OptionsHandlerFn, RequestHandlerFn, RequestOptions, RequesterType, ResourceOptions, ResponseBodyTypes, RootResourceOptions, createRequesterFn, defaultOptionsHandler, formatQuery, presetResourceArguments };
package/dist/index.d.ts CHANGED
@@ -7,7 +7,7 @@ interface FormattedResponse<T extends ResponseBodyTypes = ResponseBodyTypes> {
7
7
  interface Constructable<T = any> {
8
8
  new (...args: any[]): T;
9
9
  }
10
- type DefaultResourceOptions = {
10
+ type ResourceOptions = {
11
11
  headers: {
12
12
  [header: string]: string;
13
13
  };
@@ -26,11 +26,11 @@ type DefaultRequestOptions = {
26
26
  signal?: AbortSignal;
27
27
  };
28
28
  type RequestOptions = {
29
- headers: Record<string, string>;
29
+ headers?: Record<string, string>;
30
30
  timeout?: number;
31
- method: string;
31
+ method?: string;
32
32
  searchParams?: string;
33
- prefixUrl: string;
33
+ prefixUrl?: string;
34
34
  body?: string | FormData;
35
35
  asStream?: boolean;
36
36
  signal?: AbortSignal;
@@ -43,14 +43,14 @@ interface RequesterType {
43
43
  delete<T extends ResponseBodyTypes>(endpoint: string, options?: DefaultRequestOptions): Promise<FormattedResponse<T>>;
44
44
  }
45
45
  declare function formatQuery(params?: Record<string, unknown>): string;
46
- type OptionsHandlerFn = (serviceOptions: DefaultResourceOptions, requestOptions: DefaultRequestOptions) => Promise<RequestOptions>;
47
- declare function defaultOptionsHandler(resourceOptions: DefaultResourceOptions, { body, searchParams, sudo, signal, asStream, method, }?: DefaultRequestOptions): Promise<RequestOptions>;
46
+ type OptionsHandlerFn = (serviceOptions: ResourceOptions, requestOptions: RequestOptions) => Promise<RequestOptions>;
47
+ declare function defaultOptionsHandler(resourceOptions: ResourceOptions, { body, searchParams, sudo, signal, asStream, method, }?: DefaultRequestOptions): Promise<RequestOptions>;
48
48
  type RequestHandlerFn<T extends ResponseBodyTypes = ResponseBodyTypes> = (endpoint: string, options?: Record<string, unknown>) => Promise<FormattedResponse<T>>;
49
- declare function createRequesterFn(optionsHandler: OptionsHandlerFn, requestHandler: RequestHandlerFn): (serviceOptions: DefaultResourceOptions) => RequesterType;
49
+ declare function createRequesterFn(optionsHandler: OptionsHandlerFn, requestHandler: RequestHandlerFn): (serviceOptions: ResourceOptions) => RequesterType;
50
50
  declare function presetResourceArguments<T extends Record<string, Constructable>>(resources: T, customConfig?: Record<string, unknown>): T;
51
51
 
52
52
  interface RootResourceOptions<C> {
53
- requesterFn?: (resourceOptions: DefaultResourceOptions) => RequesterType;
53
+ requesterFn?: (resourceOptions: ResourceOptions) => RequesterType;
54
54
  host?: string;
55
55
  prefixUrl?: string;
56
56
  rejectUnauthorized?: boolean;
@@ -86,4 +86,4 @@ declare class BaseResource<C extends boolean = false> {
86
86
  constructor({ sudo, profileToken, camelize, requesterFn, profileMode, host, prefixUrl, rejectUnauthorized, queryTimeout, ...tokens }: BaseResourceOptions<C>);
87
87
  }
88
88
 
89
- export { BaseRequestOptionsWithAccessToken, BaseRequestOptionsWithJobToken, BaseRequestOptionsWithOAuthToken, BaseResource, BaseResourceOptions, Constructable, DefaultRequestOptions, DefaultResourceOptions, FormattedResponse, GitlabToken, OptionsHandlerFn, RequestHandlerFn, RequestOptions, RequesterType, ResponseBodyTypes, RootResourceOptions, createRequesterFn, defaultOptionsHandler, formatQuery, presetResourceArguments };
89
+ export { BaseRequestOptionsWithAccessToken, BaseRequestOptionsWithJobToken, BaseRequestOptionsWithOAuthToken, BaseResource, BaseResourceOptions, Constructable, DefaultRequestOptions, FormattedResponse, GitlabToken, OptionsHandlerFn, RequestHandlerFn, RequestOptions, RequesterType, ResourceOptions, ResponseBodyTypes, RootResourceOptions, createRequesterFn, defaultOptionsHandler, formatQuery, presetResourceArguments };
package/dist/index.js CHANGED
@@ -17,17 +17,17 @@ async function defaultOptionsHandler(resourceOptions, {
17
17
  sudo,
18
18
  signal,
19
19
  asStream = false,
20
- method = "get"
20
+ method = "GET"
21
21
  } = {}) {
22
22
  const { headers: preconfiguredHeaders, authHeaders, url } = resourceOptions;
23
23
  const headers = { ...preconfiguredHeaders };
24
24
  const defaultOptions = {
25
- headers,
26
25
  method,
27
26
  asStream,
28
27
  signal,
29
28
  prefixUrl: url
30
29
  };
30
+ defaultOptions.headers = headers;
31
31
  if (sudo)
32
32
  defaultOptions.headers.sudo = `${sudo}`;
33
33
  if (body) {
@@ -51,7 +51,11 @@ function createRequesterFn(optionsHandler, requestHandler) {
51
51
  const requester = {};
52
52
  methods.forEach((m) => {
53
53
  requester[m] = async (endpoint, options) => {
54
- const requestOptions = await optionsHandler(serviceOptions, { ...options, method: m });
54
+ const defaultRequestOptions = await defaultOptionsHandler(serviceOptions, {
55
+ ...options,
56
+ method: m.toUpperCase()
57
+ });
58
+ const requestOptions = await optionsHandler(serviceOptions, defaultRequestOptions);
55
59
  return requestHandler(endpoint, requestOptions);
56
60
  };
57
61
  });
package/dist/index.mjs CHANGED
@@ -15,17 +15,17 @@ async function defaultOptionsHandler(resourceOptions, {
15
15
  sudo,
16
16
  signal,
17
17
  asStream = false,
18
- method = "get"
18
+ method = "GET"
19
19
  } = {}) {
20
20
  const { headers: preconfiguredHeaders, authHeaders, url } = resourceOptions;
21
21
  const headers = { ...preconfiguredHeaders };
22
22
  const defaultOptions = {
23
- headers,
24
23
  method,
25
24
  asStream,
26
25
  signal,
27
26
  prefixUrl: url
28
27
  };
28
+ defaultOptions.headers = headers;
29
29
  if (sudo)
30
30
  defaultOptions.headers.sudo = `${sudo}`;
31
31
  if (body) {
@@ -49,7 +49,11 @@ function createRequesterFn(optionsHandler, requestHandler) {
49
49
  const requester = {};
50
50
  methods.forEach((m) => {
51
51
  requester[m] = async (endpoint, options) => {
52
- const requestOptions = await optionsHandler(serviceOptions, { ...options, method: m });
52
+ const defaultRequestOptions = await defaultOptionsHandler(serviceOptions, {
53
+ ...options,
54
+ method: m.toUpperCase()
55
+ });
56
+ const requestOptions = await optionsHandler(serviceOptions, defaultRequestOptions);
53
57
  return requestHandler(endpoint, requestOptions);
54
58
  };
55
59
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gitbeaker/requester-utils",
3
- "version": "39.10.2",
3
+ "version": "39.11.0",
4
4
  "description": "Utility functions for requester implementatons used in @gitbeaker",
5
5
  "license": "MIT",
6
6
  "engines": {
@@ -59,5 +59,5 @@
59
59
  "tsup": "^7.1.0",
60
60
  "typescript": "^5.1.6"
61
61
  },
62
- "gitHead": "17f6a01b467aad3371cab19a79470ac05a1adacd"
62
+ "gitHead": "e11325fa6896d2b6f02cfd54be83f8c366ad27f8"
63
63
  }