@sabuj0338/axios-friday 0.1.4 → 1.1.0

package/README.md

@@ -15,9 +15,9 @@ npm install @sabuj0338/axios-friday
 ## Usage
 
 ```python
-import Friday from '@sabuj0338/axios-friday'
+import { Friday } from "@sabuj0338/axios-friday";
 
-# Example, Configure first
+# Configure and use
 
 const baseURL = "https://sabuj0338.github.io/portfolio";
 
@@ -30,6 +30,49 @@ const friday = new Friday({
     # enableAccessToken: true,
 });
 
+# returns 'AxiosResponse'
+const response = await friday.get(new URL(baseURL));
+
+```
+
+## Example of using a class that Extends `Friday`
+
+```python
+import { Friday } from "@sabuj0338/axios-friday";
+import { AxiosResponse } from "axios";
+import Cookies from "js-cookie";
+import toast from "react-hot-toast";
+
+const BASE_API_URL = import.meta.env.VITE_BASE_API_URL;
+const REFRESH_TOKEN_API = import.meta.env.VITE_REFRESH_TOKEN_API;
+const REFRESH_TOKEN_KEY = import.meta.env.VITE_REFRESH_TOKEN_KEY;
+const ACCESS_TOKEN_KEY = import.meta.env.VITE_ACCESS_TOKEN_KEY;
+
+class MyFriday extends Friday {
+  constructor(baseURL: string = BASE_API_URL) {
+    super({
+      baseURL: baseURL,
+      refreshTokenEndpoint: REFRESH_TOKEN_API,
+      accessTokenKey: ACCESS_TOKEN_KEY,
+      refreshTokenKey: REFRESH_TOKEN_KEY,
+      enableRefreshToken: true,
+      enableAccessToken: true,
+    });
+  }
+
+  override resetTokens(res: AxiosResponse<any, any>) {
+    Cookies.set(ACCESS_TOKEN_KEY, res.data.tokens.access.token);
+    Cookies.set(REFRESH_TOKEN_KEY, res.data.tokens.refresh.token);
+  }
+
+  override throwError(message: string): void {
+    toast.error(message);
+  }
+}
+
+export const friday = new MyFriday();
+
+
 # returns 'AxiosResponse'
 const response = await friday.get(new URL(baseURL));
 

package/dist/index.d.mts

@@ -87,6 +87,17 @@ declare class Friday {
      * message you want to associate with the error that will be thrown.
      */
     throwError(errorMessage: string): void;
+    /**
+     * The `cleanUrl` function in TypeScript takes a URL as input, removes any empty parameters from the
+     * query string, and returns the cleaned URL.
+     * @param {string} url - The `cleanUrl` function takes a URL as a parameter and cleans up the query
+     * string by removing any empty parameters. If there are no query parameters, it returns the original
+     * URL.
+     * @returns The `cleanUrl` function returns a cleaned version of the input URL by removing any empty
+     * parameters from the query string. If the query string is empty after cleaning, it returns the base
+     * URL without the query string.
+     */
+    private cleanUrl;
     /**
      * The `get` function makes an asynchronous GET request using Axios with error handling and returns
      * the response data.

package/dist/index.d.ts

@@ -87,6 +87,17 @@ declare class Friday {
      * message you want to associate with the error that will be thrown.
      */
     throwError(errorMessage: string): void;
+    /**
+     * The `cleanUrl` function in TypeScript takes a URL as input, removes any empty parameters from the
+     * query string, and returns the cleaned URL.
+     * @param {string} url - The `cleanUrl` function takes a URL as a parameter and cleans up the query
+     * string by removing any empty parameters. If there are no query parameters, it returns the original
+     * URL.
+     * @returns The `cleanUrl` function returns a cleaned version of the input URL by removing any empty
+     * parameters from the query string. If the query string is empty after cleaning, it returns the base
+     * URL without the query string.
+     */
+    private cleanUrl;
     /**
      * The `get` function makes an asynchronous GET request using Axios with error handling and returns
      * the response data.

package/dist/index.js

@@ -86,6 +86,19 @@ var Friday = class {
         }
       );
     }
+    this.axiosInstance.interceptors.request.use(
+      (config) => {
+        if (config.url) {
+          const baseUrl = config.baseURL || "";
+          const fullUrl = new URL(config.url, baseUrl).toString();
+          config.url = this.cleanUrl(fullUrl).replace(baseUrl, "");
+        }
+        return config;
+      },
+      (error) => {
+        return Promise.reject(error);
+      }
+    );
   }
   /**
    * The function `refreshAccessToken` asynchronously refreshes the access token by making an API
@@ -98,9 +111,12 @@ var Friday = class {
       if (this.config.refreshTokenEndpoint == void 0) return;
       const refreshToken = this.getRefreshToken();
       if (refreshToken === void 0) throw new Error("Unauthorized Attempt!");
-      const res = await this.axiosInstance.post(this.config.refreshTokenEndpoint, {
-        refreshToken
-      });
+      const res = await this.axiosInstance.post(
+        this.config.refreshTokenEndpoint,
+        {
+          refreshToken
+        }
+      );
       if (res.status != 200)
         throw new Error("Refresh access token request failed!");
       this.resetTokens(res);
@@ -186,6 +202,28 @@ var Friday = class {
   throwError(errorMessage) {
     throw new Error(errorMessage);
   }
+  /**
+   * The `cleanUrl` function in TypeScript takes a URL as input, removes any empty parameters from the
+   * query string, and returns the cleaned URL.
+   * @param {string} url - The `cleanUrl` function takes a URL as a parameter and cleans up the query
+   * string by removing any empty parameters. If there are no query parameters, it returns the original
+   * URL.
+   * @returns The `cleanUrl` function returns a cleaned version of the input URL by removing any empty
+   * parameters from the query string. If the query string is empty after cleaning, it returns the base
+   * URL without the query string.
+   */
+  cleanUrl(url) {
+    const [base, query] = url.split("?");
+    if (!query) return url;
+    const searchParams = new URLSearchParams(query);
+    for (const [key, value] of searchParams.entries()) {
+      if (value === "") {
+        searchParams.delete(key);
+      }
+    }
+    const cleanedQuery = searchParams.toString();
+    return cleanedQuery ? `${base}?${cleanedQuery}` : base;
+  }
   /**
    * The `get` function makes an asynchronous GET request using Axios with error handling and returns
    * the response data.

package/dist/index.mjs

@@ -50,6 +50,19 @@ var Friday = class {
         }
       );
     }
+    this.axiosInstance.interceptors.request.use(
+      (config) => {
+        if (config.url) {
+          const baseUrl = config.baseURL || "";
+          const fullUrl = new URL(config.url, baseUrl).toString();
+          config.url = this.cleanUrl(fullUrl).replace(baseUrl, "");
+        }
+        return config;
+      },
+      (error) => {
+        return Promise.reject(error);
+      }
+    );
   }
   /**
    * The function `refreshAccessToken` asynchronously refreshes the access token by making an API
@@ -62,9 +75,12 @@ var Friday = class {
       if (this.config.refreshTokenEndpoint == void 0) return;
       const refreshToken = this.getRefreshToken();
       if (refreshToken === void 0) throw new Error("Unauthorized Attempt!");
-      const res = await this.axiosInstance.post(this.config.refreshTokenEndpoint, {
-        refreshToken
-      });
+      const res = await this.axiosInstance.post(
+        this.config.refreshTokenEndpoint,
+        {
+          refreshToken
+        }
+      );
       if (res.status != 200)
         throw new Error("Refresh access token request failed!");
       this.resetTokens(res);
@@ -150,6 +166,28 @@ var Friday = class {
   throwError(errorMessage) {
     throw new Error(errorMessage);
   }
+  /**
+   * The `cleanUrl` function in TypeScript takes a URL as input, removes any empty parameters from the
+   * query string, and returns the cleaned URL.
+   * @param {string} url - The `cleanUrl` function takes a URL as a parameter and cleans up the query
+   * string by removing any empty parameters. If there are no query parameters, it returns the original
+   * URL.
+   * @returns The `cleanUrl` function returns a cleaned version of the input URL by removing any empty
+   * parameters from the query string. If the query string is empty after cleaning, it returns the base
+   * URL without the query string.
+   */
+  cleanUrl(url) {
+    const [base, query] = url.split("?");
+    if (!query) return url;
+    const searchParams = new URLSearchParams(query);
+    for (const [key, value] of searchParams.entries()) {
+      if (value === "") {
+        searchParams.delete(key);
+      }
+    }
+    const cleanedQuery = searchParams.toString();
+    return cleanedQuery ? `${base}?${cleanedQuery}` : base;
+  }
   /**
    * The `get` function makes an asynchronous GET request using Axios with error handling and returns
    * the response data.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sabuj0338/axios-friday",
-  "version": "0.1.4",
+  "version": "1.1.0",
   "description": "Friday - a axios based api handling custom class. which has refresh token mechanism configured.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",