@ibertran/fortytwo-intra-client 5.0.0 → 5.1.0

package/README.md

@@ -140,6 +140,27 @@ const allProjects = await client.getAll("projects", {
 });
 ```
 
+### Raw Requests
+
+The `rawRequest` method takes a plain [axios request config](https://axios-http.com/docs/req_config), injects the access token, and returns the raw `AxiosResponse`. Relative URLs are resolved against the client's `base_url` unless `baseURL` is set in the config.
+
+Unlike the other methods, it does not retry, log, validate, or wrap errors: failures are thrown as `AxiosError`.
+
+```typescript
+// Full axios config, raw response
+const res = await client.rawRequest({
+	method: "get",
+	url: "campus/9/users",
+	params: { "page[size]": 100 },
+});
+console.log(res.status, res.headers["x-total"], res.data);
+
+// With a user token (V2 client only)
+const me = await client.rawRequest({ url: "me" }, tokens);
+```
+
+`rawRequest` is available on both `FortytwoIntraClient` and `FortytwoIntraV3Client`. On the V2 client, requests still go through the rate limiter.
+
 ## OAuth Authentication
 
 ### Authorization Flow

package/dist/index.d.ts

@@ -1,5 +1,6 @@
+import { AxiosRequestConfig, AxiosResponse } from "axios";
 import z from "zod";
-import { inputOptions } from "./types";
+import { inputOptions, userToken } from "./types";
 export { FortytwoIntraV3Client } from "./intraV3";
 export * from "./errors/httpError";
 export * from "./errors/validationError";
@@ -32,9 +33,12 @@ export declare class FortytwoIntraClient {
     private maxRetry;
     private logLine;
     private errLogBody;
-    private access_token;
+    private authorization;
+    private tokenRequest;
     constructor(client_id: string, client_secret: string, conf: Partial<FortytwoIntraClientConf>);
     private generateToken;
+    private isTokenValid;
+    private getAccessToken;
     private fetch;
     private reqHandler;
     private logSuccess;
@@ -64,6 +68,7 @@ export declare class FortytwoIntraClient {
     getAll<S extends z.ZodType>(endpoint: URL | string, options: Omit<inputOptions, "body"> & {
         schema: S;
     }): Promise<z.infer<S>>;
+    rawRequest<T = any, D = any>(config: AxiosRequestConfig<D>, token?: userToken): Promise<AxiosResponse<T, D>>;
     URL(endpoint: string): URL;
     getOAuthUrl(options?: {
         redirect_uri?: string;

package/dist/index.js

@@ -80,7 +80,8 @@ class FortytwoIntraClient {
     maxRetry;
     logLine;
     errLogBody;
-    access_token;
+    authorization;
+    tokenRequest = null;
     constructor(client_id, client_secret, conf) {
         this.client_id = client_id;
         this.client_secret = client_secret;
@@ -103,7 +104,7 @@ class FortytwoIntraClient {
         this.maxRetry = config.maxRetry;
         this.logLine = config.logLine;
         this.errLogBody = config.errLogBody;
-        this.access_token = null;
+        this.authorization = null;
     }
     async generateToken() {
         const res = await this.axiosInstance.post(this.token_url, {
@@ -112,15 +113,31 @@ class FortytwoIntraClient {
             client_secret: this.client_secret,
             scope: this.scopes.join(" "),
         });
-        return res.data.access_token;
+        const { access_token, expires_in } = zod_1.default
+            .object({ access_token: zod_1.default.string(), expires_in: zod_1.default.number() })
+            .parse(res.data);
+        return { access_token, expires_at: Date.now() + expires_in * 1_000 };
+    }
+    isTokenValid() {
+        return this.authorization !== null && this.authorization.expires_at - 30_000 > Date.now();
+    }
+    async getAccessToken(token) {
+        if (token) {
+            return token.access_token;
+        }
+        if (!this.isTokenValid()) {
+            // Share a single in-flight token request between concurrent callers
+            this.tokenRequest ??= this.generateToken().finally(() => {
+                this.tokenRequest = null;
+            });
+            this.authorization = await this.tokenRequest;
+        }
+        return this.authorization.access_token;
     }
     async fetch(url, options) {
         const { method, body, query } = options;
-        if (!options.token && !this.access_token) {
-            this.access_token = await this.generateToken();
-        }
         // Attach access_token
-        const accessToken = options.token ? options.token.access_token : this.access_token;
+        const accessToken = await this.getAccessToken(options.token);
         // Extract query parameters from URL and combine with options.query
         const urlParams = {};
         url.searchParams.forEach((value, key) => {
@@ -155,7 +172,7 @@ class FortytwoIntraClient {
                 const status = err.response?.status;
                 if (maxRetry > 0 && attempt < maxRetry && status && this.retryOn.includes(status)) {
                     if (status === 401) {
-                        this.access_token = null;
+                        this.authorization = null;
                     }
                     options.attempt++;
                     return this.reqHandler(url, options);
@@ -322,6 +339,17 @@ class FortytwoIntraClient {
         const allData = [...firstPage.data, ...otherPages.flatMap((res) => res.data)];
         return this.validate(allData, options.schema);
     }
+    async rawRequest(config, token) {
+        const accessToken = await this.getAccessToken(token);
+        return this.axiosInstance.request({
+            baseURL: this.base_url,
+            ...config,
+            headers: {
+                ...config.headers,
+                Authorization: `Bearer ${accessToken}`,
+            },
+        });
+    }
     URL(endpoint) {
         return new URL(endpoint, this.base_url);
     }

package/dist/intraV3/index.d.ts

@@ -1,3 +1,4 @@
+import { AxiosRequestConfig, AxiosResponse } from "axios";
 import z from "zod";
 import { inputOptions } from "../types";
 export * from "../errors/httpError";
@@ -25,10 +26,12 @@ export declare class FortytwoIntraV3Client {
     private logLine;
     private errLogBody;
     private authorization;
+    private tokenRequest;
     constructor(credentials: Credentials, conf?: Partial<FortytwoIntraClientConf>);
     private generateToken;
     private isTokenValid;
     private isRefreshTokenValid;
+    private getAccessToken;
     private fetch;
     private reqHandler;
     private logSuccess;
@@ -54,5 +57,6 @@ export declare class FortytwoIntraV3Client {
     delete<S extends z.ZodType>(endpoint: URL | string, options: Omit<inputOptions, "perPage" | "maxPages"> & {
         schema: S;
     }): Promise<z.infer<S>>;
+    rawRequest<T = any, D = any>(config: AxiosRequestConfig<D>): Promise<AxiosResponse<T, D>>;
     URL(endpoint: string): URL;
 }

package/dist/intraV3/index.js

@@ -65,6 +65,7 @@ class FortytwoIntraV3Client {
     logLine;
     errLogBody;
     authorization;
+    tokenRequest = null;
     constructor(credentials, conf = {}) {
         this.credentials = credentials;
         const config = { ...defaultConf, ...conf };
@@ -102,13 +103,20 @@ class FortytwoIntraV3Client {
     isRefreshTokenValid() {
         return (this.authorization !== null && this.authorization.refresh_expires_at - 30000 > Date.now());
     }
-    async fetch(url, options) {
-        const { method, body, query } = options;
+    async getAccessToken() {
         if (!this.isTokenValid()) {
-            this.authorization = await this.generateToken();
+            // Share a single in-flight token request between concurrent callers
+            this.tokenRequest ??= this.generateToken().finally(() => {
+                this.tokenRequest = null;
+            });
+            this.authorization = await this.tokenRequest;
         }
+        return this.authorization.access_token;
+    }
+    async fetch(url, options) {
+        const { method, body, query } = options;
         // Attach access_token
-        const accessToken = this.authorization?.access_token;
+        const accessToken = await this.getAccessToken();
         // Extract query parameters from URL and combine with options.query
         const urlParams = {};
         url.searchParams.forEach((value, key) => {
@@ -259,6 +267,17 @@ class FortytwoIntraV3Client {
         });
         return this.validate(res.data, options.schema);
     }
+    async rawRequest(config) {
+        const accessToken = await this.getAccessToken();
+        return this.axiosInstance.request({
+            baseURL: this.base_url,
+            ...config,
+            headers: {
+                ...config.headers,
+                Authorization: `Bearer ${accessToken}`,
+            },
+        });
+    }
     URL(endpoint) {
         return new URL(endpoint, this.base_url);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ibertran/fortytwo-intra-client",
-	"version": "5.0.0",
+	"version": "5.1.0",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"author": {