@gitbeaker/requester-utils 38.9.0 → 38.11.0

package/README.md

@@ -224,6 +224,7 @@ import { RequesterUtils, BaseResource } from '@gitbeaker/requester-utils';
       <td align="center" valign="top" width="3.84%"><a href="http://spencersalisbury.com/"><img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/8053224?v=4&h=25&w=25&fit=cover&mask=circle&maxage=7d" alt="Spencer Salisbury"/></td>
       <td align="center" valign="top" width="3.84%"><a href="https://simonecorsi.dev/"><img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/5617452?v=4&h=25&w=25&fit=cover&mask=circle&maxage=7d" alt="Simone Corsi"/></td>
       <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>
+      <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>
     </tr>
 </p>
 

package/dist/index.d.ts

@@ -46,20 +46,27 @@ type RequestHandlerFn<T extends ResponseBodyTypes = ResponseBodyTypes> = (endpoi
 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;
 
-interface BaseResourceOptions<C> {
-    oauthToken?: string;
-    token?: string;
-    jobToken?: string;
+interface RootResourceOptions<C> {
+    requesterFn?: (resourceOptions: DefaultResourceOptions) => RequesterType;
     host?: string;
     prefixUrl?: string;
     rejectUnauthorized?: boolean;
     camelize?: C;
-    requesterFn?: (resourceOptions: DefaultResourceOptions) => RequesterType;
     queryTimeout?: number | null;
-    profileToken?: string;
     sudo?: string | number;
+    profileToken?: string;
     profileMode?: 'execution' | 'memory';
 }
+interface BaseRequestOptionsWithOAuthToken<C> extends RootResourceOptions<C> {
+    oauthToken: string;
+}
+interface BaseRequestOptionsWithAccessToken<C> extends RootResourceOptions<C> {
+    token: string;
+}
+interface BaseRequestOptionsWithJobToken<C> extends RootResourceOptions<C> {
+    jobToken: string;
+}
+type BaseResourceOptions<C> = BaseRequestOptionsWithOAuthToken<C> | BaseRequestOptionsWithAccessToken<C> | BaseRequestOptionsWithJobToken<C>;
 declare class BaseResource<C extends boolean = false> {
     readonly url: string;
     readonly requester: RequesterType;
@@ -69,7 +76,7 @@ declare class BaseResource<C extends boolean = false> {
     };
     readonly camelize: C | undefined;
     readonly rejectUnauthorized: boolean;
-    constructor({ token, jobToken, oauthToken, sudo, profileToken, requesterFn, camelize, profileMode, host, prefixUrl, rejectUnauthorized, queryTimeout, }?: BaseResourceOptions<C>);
+    constructor({ sudo, profileToken, camelize, requesterFn, profileMode, host, prefixUrl, rejectUnauthorized, queryTimeout, ...tokens }: BaseResourceOptions<C>);
 }
 
-export { BaseResource, BaseResourceOptions, Constructable, DefaultRequestOptions, DefaultResourceOptions, FormattedResponse, OptionsHandlerFn, RequestHandlerFn, RequestOptions, RequesterType, ResponseBodyTypes, createRequesterFn, defaultOptionsHandler, formatQuery, presetResourceArguments };
+export { BaseRequestOptionsWithAccessToken, BaseRequestOptionsWithJobToken, BaseRequestOptionsWithOAuthToken, BaseResource, BaseResourceOptions, Constructable, DefaultRequestOptions, DefaultResourceOptions, FormattedResponse, OptionsHandlerFn, RequestHandlerFn, RequestOptions, RequesterType, ResponseBodyTypes, RootResourceOptions, createRequesterFn, defaultOptionsHandler, formatQuery, presetResourceArguments };

package/dist/index.js

@@ -81,19 +81,17 @@ var BaseResource = class {
   camelize;
   rejectUnauthorized;
   constructor({
-    token,
-    jobToken,
-    oauthToken,
     sudo,
     profileToken,
-    requesterFn,
     camelize,
+    requesterFn,
     profileMode = "execution",
     host = "https://gitlab.com",
     prefixUrl = "",
     rejectUnauthorized = true,
-    queryTimeout = 3e5
-  } = {}) {
+    queryTimeout = 3e5,
+    ...tokens
+  }) {
     if (!requesterFn)
       throw new ReferenceError("requesterFn must be passed");
     this.url = [host, "api", "v4", prefixUrl].join("/");
@@ -101,12 +99,15 @@ var BaseResource = class {
     this.rejectUnauthorized = rejectUnauthorized;
     this.camelize = camelize;
     this.queryTimeout = queryTimeout;
-    if (oauthToken)
-      this.headers.authorization = `Bearer ${oauthToken}`;
-    else if (jobToken)
-      this.headers["job-token"] = jobToken;
-    else if (token)
-      this.headers["private-token"] = token;
+    if ("oauthToken" in tokens)
+      this.headers.authorization = `Bearer ${tokens.oauthToken}`;
+    else if ("jobToken" in tokens)
+      this.headers["job-token"] = tokens.jobToken;
+    else if ("token" in tokens)
+      this.headers["private-token"] = tokens.token;
+    else {
+      throw new ReferenceError("A token, oauthToken or jobToken must be passed");
+    }
     if (profileToken) {
       this.headers["X-Profile-Token"] = profileToken;
       this.headers["X-Profile-Mode"] = profileMode;

package/dist/index.mjs

@@ -79,19 +79,17 @@ var BaseResource = class {
   camelize;
   rejectUnauthorized;
   constructor({
-    token,
-    jobToken,
-    oauthToken,
     sudo,
     profileToken,
-    requesterFn,
     camelize,
+    requesterFn,
     profileMode = "execution",
     host = "https://gitlab.com",
     prefixUrl = "",
     rejectUnauthorized = true,
-    queryTimeout = 3e5
-  } = {}) {
+    queryTimeout = 3e5,
+    ...tokens
+  }) {
     if (!requesterFn)
       throw new ReferenceError("requesterFn must be passed");
     this.url = [host, "api", "v4", prefixUrl].join("/");
@@ -99,12 +97,15 @@ var BaseResource = class {
     this.rejectUnauthorized = rejectUnauthorized;
     this.camelize = camelize;
     this.queryTimeout = queryTimeout;
-    if (oauthToken)
-      this.headers.authorization = `Bearer ${oauthToken}`;
-    else if (jobToken)
-      this.headers["job-token"] = jobToken;
-    else if (token)
-      this.headers["private-token"] = token;
+    if ("oauthToken" in tokens)
+      this.headers.authorization = `Bearer ${tokens.oauthToken}`;
+    else if ("jobToken" in tokens)
+      this.headers["job-token"] = tokens.jobToken;
+    else if ("token" in tokens)
+      this.headers["private-token"] = tokens.token;
+    else {
+      throw new ReferenceError("A token, oauthToken or jobToken must be passed");
+    }
     if (profileToken) {
       this.headers["X-Profile-Token"] = profileToken;
       this.headers["X-Profile-Mode"] = profileMode;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitbeaker/requester-utils",
-  "version": "38.9.0",
+  "version": "38.11.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": "853426564867bc77e42f175aed7ea9903be1bfdc"
+  "gitHead": "a56ec27c45369470b16a25c9a18c8d52703dab0a"
 }