@ibertran/fortytwo-intra-client 3.1.2 → 3.2.0

package/README.md

@@ -17,7 +17,7 @@ const client = new FortytwoIntraClient('your_client_id', 'your_client_secret');
 
 
 // Get a specific user by login
-const user = await client.get('users/jdoe');
+const user = await client.get('users/ibertran');
 console.log(user);
 ```
 
@@ -32,16 +32,18 @@ The `FortytwoIntraClient` class accepts three parameters:
 ### Configuration Options
 
 ```typescript
-interface Conf {
-  redirect_uri: string | null;      // OAuth redirect URI (default: null)
-  base_url: string;                 // API base URL (default: "https://api.intra.42.fr/v2/")
-  token_url: string;                // Token endpoint (default: "https://api.intra.42.fr/oauth/token")
-  oauth_url: string;                // OAuth endpoint (default: "https://api.intra.42.fr/oauth/authorize")
-  scopes: string[];                 // OAuth scopes (default: ["public"])
-  rate: number;                     // Requests per second (default: 2)
-  maxRetry: number;                 // Max retry attempts (default: 5)
-  logs: boolean;                    // Enable logging (default: true)
-  errors: boolean;                  // Enable error logging (default: true)
+interface FortytwoIntraClientConf {
+  redirect_uri: string | null;           // OAuth redirect URI (default: null)
+  base_url: string;                      // API base URL (default: "https://api.intra.42.fr/v2/")
+  token_url: string;                     // Token endpoint (default: "https://api.intra.42.fr/oauth/token")
+  oauth_url: string;                     // OAuth endpoint (default: "https://api.intra.42.fr/oauth/authorize")
+  token_info_url: string;                // Token info endpoint (default: "https://api.intra.42.fr/oauth/token/info")
+  scopes: string[];                      // OAuth scopes (default: ["public"])
+  rateLimitMaxRequests: number;          // Max requests per time window (default: 2)
+  rateLimitPerMilliseconds: number;      // Time window in milliseconds (default: 1200)
+  maxRetry: number;                      // Max retry attempts (default: 5)
+  logLine: boolean;                      // Enable request logging (default: true)
+  errLogBody: boolean;                   // Log error response bodies (default: true)
 }
 ```
 
@@ -49,10 +51,12 @@ interface Conf {
 
 ```typescript
 const client = new FortytwoIntraClient('your_client_id', 'your_client_secret', {
-  rate: 1,                        // 1 request per second
-  maxRetry: 3,                    // Retry up to 3 times
-  logs: false,                    // Disable logging
-  scopes: ['public', 'projects']  // Extended scopes
+  rateLimitMaxRequests: 1,              // 1 request per 1200ms
+  rateLimitPerMilliseconds: 1200,       // Time window
+  maxRetry: 3,                          // Retry up to 3 times
+  logLine: false,                       // Disable logging
+  errLogBody: false,                    // Disable error body logging
+  scopes: ['public', 'projects']        // Extended scopes
 });
 ```
 
@@ -189,16 +193,16 @@ Requests are automatically throttled based on the configured rate limit. The def
 
 ## Logging
 
-By default, the library logs all requests with status codes:
+By default, the library logs all requests with colored status codes and formatted parameters:
 
 ```
-✅ 200 GET    https://api.intra.42.fr/v2/users/jdoe
-✅ 200 GET    https://api.intra.42.fr/v2/campus/1
-🔄 429 GET    https://api.intra.42.fr/v2/projects retry 1/5
-✅ 200 GET    https://api.intra.42.fr/v2/projects retry 1/5
+200 GET    /v2/users/jdoe
+200 GET    /v2/campus { filter: { city: 'lyon' } }
+429 GET    /v2/projects
+200 GET    /v2/projects retry 1/5
 ```
 
-Disable logging by setting `logs: false` in the configuration.
+Disable logging by setting `logLine: false` in the configuration. Control error body logging with `errLogBody: false`.
 
 ## TypeScript Support
 

package/dist/HttpError.d.ts

@@ -1 +1,9 @@
+declare class HttpError extends Error {
+    status: number | null;
+    url: string | null;
+    details: any;
+    constructor(err: any);
+}
+export declare function simplifySuperagentError(err: any): HttpError;
+export declare function isSuperAgentError(err: any): boolean;
 export {};

package/dist/HttpError.js

@@ -1,23 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// class HttpError extends Error {
-//   status: number | null;
-//   url: string | null;
-//   details: any;
-//   constructor(err: any) {
-//     super(err.message || "Unknown API error");
-//     this.name = "HttpError";
-//     this.status = err.status || err.response?.status || null;
-//     this.url = err.config?.url || err.request?.responseURL || null;
-//     this.details = err.response?.data || null;
-//   }
-// }
-// export function simplifyAxiosError(err: any): HttpError {
-//   if (!err) {
-//     return new HttpError({ message: "Unknown error" });
-//   }
-//   return new HttpError(err);
-// }
-// export function isAxiosError(err: any): err is AxiosError {
-//   return err && err.isAxiosError === true;
-// }
+exports.simplifySuperagentError = simplifySuperagentError;
+exports.isSuperAgentError = isSuperAgentError;
+class HttpError extends Error {
+    status;
+    url;
+    details;
+    constructor(err) {
+        super(err.message || "Unknown API error");
+        this.name = "HttpError";
+        this.status = err.status || null;
+        this.url = err.response?.request?.url || null;
+        this.details = err.response?.body || null;
+    }
+}
+function simplifySuperagentError(err) {
+    if (!err) {
+        return new HttpError({ message: "Unknown error" });
+    }
+    return new HttpError(err);
+}
+function isSuperAgentError(err) {
+    return (err && typeof err === "object" && ("status" in err || "response" in err));
+}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { inputOptions } from "./types";
+import { FortytwoIntraClientError, isFortytwoIntraClientError } from "./lib/errors";
 export interface FortytwoIntraClientConf {
     redirect_uri: string | null;
     base_url: string;
@@ -54,3 +55,4 @@ export declare class FortytwoIntraClient {
     exchangeOAuthCode(code: string, redirect_uri?: string): Promise<any>;
     tokenInfos(options?: Omit<inputOptions, "body" | "perPage" | "maxPage">): Promise<any>;
 }
+export { FortytwoIntraClientError, isFortytwoIntraClientError };

package/dist/index.js

@@ -3,11 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FortytwoIntraClient = void 0;
+exports.isFortytwoIntraClientError = exports.FortytwoIntraClientError = exports.FortytwoIntraClient = void 0;
 const axios_1 = __importDefault(require("axios"));
 const axios_rate_limit_1 = __importDefault(require("axios-rate-limit"));
 const pagination_1 = require("./lib/pagination");
 const logs_1 = require("./lib/logs");
+const errors_1 = require("./lib/errors");
+Object.defineProperty(exports, "FortytwoIntraClientError", { enumerable: true, get: function () { return errors_1.FortytwoIntraClientError; } });
+Object.defineProperty(exports, "isFortytwoIntraClientError", { enumerable: true, get: function () { return errors_1.isFortytwoIntraClientError; } });
 const crypto_1 = __importDefault(require("crypto"));
 const defaultConf = {
     redirect_uri: null,
@@ -124,8 +127,11 @@ class FortytwoIntraClient {
                     return this.reqHandler(url, options);
                 }
                 else {
-                    if (this.throwOnError)
-                        throw err;
+                    const clientError = (0, errors_1.simplifyAxiosError)(err);
+                    if (this.throwOnError) {
+                        throw clientError;
+                    }
+                    return clientError;
                 }
             }
             else {
@@ -229,7 +235,7 @@ class FortytwoIntraClient {
         }
         const perPage = options.perPage || 100;
         let url = new URL(endpoint);
-        const initialRes = await this.reqHandler(url, {
+        const firstPage = await this.reqHandler(url, {
             method: "GET",
             attempt: 0,
             currpage: 1,
@@ -246,10 +252,10 @@ class FortytwoIntraClient {
         });
         let lastPage;
         try {
-            lastPage = Math.min((0, pagination_1.getLastPage)(initialRes.headers["link"]), options.maxPages || Infinity);
+            lastPage = Math.min((0, pagination_1.getLastPage)(firstPage.headers["link"]), options.maxPages || Infinity);
         }
         catch (err) {
-            return initialRes?.data;
+            return firstPage?.data;
         }
         const promises = [];
         for (let i = 2; i <= lastPage; i++) {
@@ -270,9 +276,8 @@ class FortytwoIntraClient {
                 }
             }));
         }
-        return Promise.all(promises).then((values) => {
-            return initialRes?.data.concat(...values.map((value) => value.data));
-        });
+        const followingPages = await Promise.all(promises);
+        return firstPage?.data.concat(...followingPages.map((value) => value.data));
     }
     URL(endpoint) {
         return new URL(endpoint, this.base_url);

package/dist/lib/errors.d.ts

@@ -0,0 +1,9 @@
+import { AxiosError } from "axios";
+export declare class FortytwoIntraClientError extends Error {
+    statusCode: number | null;
+    statusText: string | null;
+    data: any;
+    constructor(error: AxiosError);
+}
+export declare function simplifyAxiosError(error: AxiosError): FortytwoIntraClientError;
+export declare function isFortytwoIntraClientError(error: any): error is FortytwoIntraClientError;

package/dist/lib/errors.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FortytwoIntraClientError = void 0;
+exports.simplifyAxiosError = simplifyAxiosError;
+exports.isFortytwoIntraClientError = isFortytwoIntraClientError;
+class FortytwoIntraClientError extends Error {
+    statusCode;
+    statusText;
+    data;
+    constructor(error) {
+        const method = error.config?.method?.toUpperCase() ?? null;
+        const route = error.config?.url ?? null;
+        const statusCode = error.response?.status ?? NaN;
+        const statusText = error.response?.statusText ?? "Unknown";
+        const message = method && route
+            ? `${method} ${route} - HTTP ${statusCode} ${statusText}`
+            : error.message;
+        super(message);
+        this.name = "FortytwoIntraClientError";
+        this.statusCode = statusCode;
+        this.statusText = statusText;
+        this.data = error.response?.data;
+    }
+}
+exports.FortytwoIntraClientError = FortytwoIntraClientError;
+function simplifyAxiosError(error) {
+    return new FortytwoIntraClientError(error);
+}
+function isFortytwoIntraClientError(error) {
+    return error instanceof FortytwoIntraClientError;
+}

package/dist/lib/logs.js

@@ -2,12 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getLogLine = getLogLine;
 exports.getErrorLogLine = getErrorLogLine;
+const util_1 = require("util");
 const green = "\x1b[42m";
 const red = "\x1b[41m";
 const reset = "\x1b[0m";
+function formatQueryParams(params) {
+    const { per_page, page, ...filteredParams } = params;
+    const keys = Object.keys(filteredParams);
+    if (keys.length === 0)
+        return "";
+    return (0, util_1.inspect)(filteredParams, {
+        depth: Infinity,
+        compact: true,
+        breakLength: Infinity,
+        colors: true
+    });
+}
 function getLogLine(res, options) {
     const tokens = [];
-    // Get query parameters as object
     const queryParams = res.config?.params || {};
     tokens.push(`${green}${res.status}${reset}`);
     tokens.push(options.method.padEnd(6, " "));
@@ -16,20 +28,19 @@ function getLogLine(res, options) {
         const url = new URL(res.config.url);
         tokens.push(url.pathname);
     }
-    // Add query parameters as object if they exist
-    if (Object.keys(queryParams).length > 0) {
-        delete queryParams.per_page;
-        delete queryParams.page;
-        tokens.push(JSON.stringify(queryParams, null, 1));
+    // Add query parameters
+    const formattedParams = formatQueryParams(queryParams);
+    if (formattedParams) {
+        tokens.push(formattedParams);
     }
+    // Add pagination info
     if (options.currpage) {
-        tokens.push(`| page: ${options.currpage}/${options.lastPage === Infinity ? "unknown" : options.lastPage}`);
+        tokens.push(`| ${options.currpage}/${options.lastPage === Infinity ? "..." : options.lastPage}`);
     }
     return tokens.join(" ");
 }
 function getErrorLogLine(err, options) {
     const tokens = [];
-    // Get query parameters as object
     const queryParams = err.config?.params || {};
     tokens.push(`${red}${err.status}${reset}`);
     tokens.push(options.method.padEnd(6, " "));
@@ -38,9 +49,10 @@ function getErrorLogLine(err, options) {
         const url = new URL(err.config.url);
         tokens.push(url.pathname);
     }
-    // Add query parameters as object if they exist
-    if (Object.keys(queryParams).length > 0) {
-        tokens.push(JSON.stringify(queryParams));
+    // Add query parameters
+    const formattedParams = formatQueryParams(queryParams);
+    if (formattedParams) {
+        tokens.push(formattedParams);
     }
     return tokens.join(" ");
 }

package/dist/utils.d.ts

@@ -1 +1,4 @@
+import * as superagent from "superagent";
+import { Method } from "./types";
+export declare function initRequest(method: Method, url: URL): superagent.Request;
 export declare function getLastPage(header: string | undefined): number;

package/dist/utils.js

@@ -1,6 +1,56 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.initRequest = initRequest;
 exports.getLastPage = getLastPage;
+const superagent = __importStar(require("superagent"));
+function initRequest(method, url) {
+    const endpoint = url.toString();
+    switch (method) {
+        case "GET":
+            return superagent.get(endpoint);
+        case "POST":
+            return superagent.post(endpoint);
+        case "PATCH":
+            return superagent.patch(endpoint);
+        case "DELETE":
+            return superagent.delete(endpoint);
+        default:
+            throw Error("Invalid HTTP method");
+    }
+}
 function getLastPage(header) {
     if (!header) {
         throw Error("No pagination link header");

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@ibertran/fortytwo-intra-client",
-  "version": "3.1.2",
+  "version": "3.2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "author": {
+    "name": "Ian BERTRAND"
+  },
   "scripts": {
     "build": "tsc"
   },
@@ -12,8 +15,8 @@
   },
   "devDependencies": {
     "typescript": "^5.9.3",
-    "dotenv": "^16.6.1",
     "ts-node": "^10.9.2",
+    "dotenv": "^16.6.1",
     "express": "^4.18.2"
   },
   "files": [

package/dist/log.d.ts

@@ -1,4 +0,0 @@
-import { reqOptions } from "./types";
-import { AxiosResponse, AxiosError } from "axios";
-export declare function getLogLine(res: AxiosResponse, options: reqOptions): string;
-export declare function getErrorLogLine(err: AxiosError, options: reqOptions): string;

package/dist/log.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLogLine = getLogLine;
-exports.getErrorLogLine = getErrorLogLine;
-const green = "\x1b[42m";
-const red = "\x1b[41m";
-const reset = "\x1b[0m";
-function getLogLine(res, options) {
-    const tokens = [];
-    // Get query parameters as object
-    const queryParams = res.config?.params || {};
-    if (process.stdout.isTTY) {
-        tokens.push(`${green}${res.status}${reset}`);
-    }
-    else {
-        tokens.push(`${res.status}`);
-    }
-    tokens.push(options.method.padEnd(6, " "));
-    // Add the base URL path
-    if (res.config?.url) {
-        const url = new URL(res.config.url);
-        tokens.push(url.pathname);
-    }
-    // Add query parameters as object if they exist
-    if (Object.keys(queryParams).length > 0) {
-        tokens.push(JSON.stringify(queryParams));
-    }
-    return tokens.join(" ");
-}
-function getErrorLogLine(err, options) {
-    const tokens = [];
-    // Get query parameters as object
-    const queryParams = err.config?.params || {};
-    if (process.stdout.isTTY) {
-        tokens.push(`${red}${err.status}${reset}`);
-    }
-    else {
-        tokens.push(`${err.status}`);
-    }
-    tokens.push(options.method.padEnd(6, " "));
-    // Add the base URL path
-    if (err.config?.url) {
-        const url = new URL(err.config.url);
-        tokens.push(url.pathname);
-    }
-    // Add query parameters as object if they exist
-    if (Object.keys(queryParams).length > 0) {
-        tokens.push(JSON.stringify(queryParams));
-    }
-    return tokens.join(" ");
-}