@sabuj0338/axios-friday 0.1.2 → 0.1.3

package/dist/index.d.mts

@@ -1,5 +1,3 @@
-import { AxiosResponse } from 'axios';
-
 interface FridayOptions {
     enableThrowHttpError?: false;
     body?: object;
@@ -21,140 +19,5 @@ interface FridayConfig {
     enableAccessToken?: boolean;
     enableRefreshToken?: boolean;
 }
-declare class Friday {
-    private config;
-    private axiosInstance;
-    /**
-     * The constructor function initializes an Axios instance with a base URL and sets up a response
-     * interceptor to handle token expiration and refresh if configured to do so.
-     * @param {FridayConfig} config - The `config` parameter in the constructor function is of type
-     * `FridayConfig`. It is used to configure the Friday instance with settings such as `baseURL` and
-     * `enableRefreshToken`. The `axiosInstance` is created with the base URL specified in the `config`.
-     */
-    constructor({ baseURL, accessTokenKey, refreshTokenKey, refreshTokenEndpoint, enableAccessToken, enableRefreshToken, }: FridayConfig);
-    /**
-     * The function `refreshAccessToken` asynchronously refreshes the access token by making an API
-     * request using a refresh token and updating the access token in the app's storage.
-     * @returns The `refreshAccessToken` function is returning the access token after successfully
-     * refreshing it using the refresh token.
-     */
-    refreshAccessToken(): Promise<string | undefined>;
-    /**
-     * The function `resetTokens` sets the access token and refresh token in cookies based on the
-     * response data from an Axios request.
-     * @param res - The `res` parameter in the `resetTokens` function is an AxiosResponse object. It
-     * represents the response returned from an HTTP request made using Axios. The AxiosResponse object
-     * contains data such as the response data, status, headers, and more.
-     */
-    resetTokens(res: AxiosResponse<any, any>): void;
-    /**
-     * The function `getAccessToken` retrieves the access token from a cookie using the key specified in
-     * the configuration.
-     * @returns The `getAccessToken` method is returning a string value or `undefined`. It retrieves the
-     * access token from a cookie using the `accessTokenKey` specified in the configuration.
-     */
-    private getAccessToken;
-    /**
-     * Retrieves the refresh token from a cookie using the key specified in the configuration.
-     * @returns A string value or `undefined`. It retrieves the refresh token from a cookie using the
-     * `refreshTokenKey` specified in the configuration.
-     */
-    private getRefreshToken;
-    /**
-     * The function `getAuthorizationHeader` returns an object with an Authorization header containing a
-     * Bearer token if an access token is available.
-     * @returns If the `accessToken` is not `undefined`, an object with the `Authorization` header
-     * containing the access token in the format `Bearer ` is being returned. If the
-     * `accessToken` is `undefined`, then `undefined` is being returned.
-     */
-    private getAuthorizationHeader;
-    /**
-     * The function `handleError` in TypeScript handles errors by extracting error messages and
-     * optionally displaying them as a toast.
-     * @param {unknown} e - The parameter `e` in the `handleError` function is used to represent the
-     * error that needs to be handled. It can be of type `unknown`, which means it can be any type of
-     * value. The function checks if `e` is an AxiosError and extracts the error message accordingly.
-     * @param {FridayOptions} [options] - The `options` parameter in the `handleError` function is of type
-     * `FridayOptions`. It is an optional parameter that allows you to pass additional options to the
-     * function. These options can include properties like `showToast`, which is a boolean value
-     * indicating whether a toast message should be displayed
-     */
-    private handleError;
-    /**
-     * The throwError function in TypeScript throws an error with a specified error message.
-     * @param {string} errorMessage - The `errorMessage` parameter is a string that represents the
-     * message you want to associate with the error that will be thrown.
-     */
-    throwError(errorMessage: string): void;
-    /**
-     * The `get` function makes an asynchronous GET request using Axios with error handling and returns
-     * the response data.
-     * @param {URL} url - The `url` parameter in the `get` function is of type `URL`, which represents a
-     * Uniform Resource Locator and is used to specify the address of a resource on the internet. It is
-     * the endpoint from which the data will be fetched in the `get` request.
-     * @param {FridayOptions} [options] - The `options` parameter in the `get` function is of type
-     * `FridayOptions`. It is an optional parameter that can be passed to the function to provide
-     * additional configuration or settings for the HTTP request. This parameter allows for customization
-     * of the request behavior based on the specific needs of the application
-     * @returns The `get` function is returning the data from the response if the request is successful.
-     * If there is an error during the request, it will handle the error using the `handleError` method
-     * with the provided options.
-     */
-    get(url: URL, options?: FridayOptions): Promise<AxiosResponse<any, any> | undefined>;
-    /**
-     * This TypeScript function sends a POST request using Axios with optional parameters and handles any
-     * errors that occur.
-     * @param {URL} url - The `url` parameter in the `post` function is a URL object that represents the
-     * endpoint where the POST request will be sent. It specifies the location where the data will be
-     * posted to.
-     * @param {FridayOptions} [options] - The `options` parameter in the `post` function is an optional
-     * parameter of type `FridayOptions`. It is used to provide additional configuration options for the
-     * HTTP POST request, such as the request body and headers. If `options` is provided, the function
-     * will use the `body`
-     * @returns The `post` function is returning the data from the response if the request is successful.
-     * If there is an error during the request, it will handle the error using the `handleError` method
-     * and return the result of that handling.
-     */
-    post(url: URL, options?: FridayOptions): Promise<AxiosResponse<any, any> | undefined>;
-    /**
-     * This TypeScript function sends a PUT request using Axios with specified options and handles any
-     * errors that occur.
-     * @param {URL} url - The `url` parameter in the `put` function is a URL object that represents the
-     * URL where the PUT request will be sent. It is used to specify the destination of the request.
-     * @param {FridayOptions} [options] - The `options` parameter in the `put` function is an optional
-     * object that may contain the following properties:
-     * @returns The `put` function is returning the data from the response if the request is successful.
-     * If there is an error during the request, it will handle the error using the `handleError` method
-     * and return the result of that handling.
-     */
-    put(url: URL, options?: FridayOptions): Promise<AxiosResponse<any, any> | undefined>;
-    /**
-     * The `delete` function sends a DELETE request to a specified URL with optional headers and body,
-     * handling errors and returning the response data.
-     * @param {URL} url - The `url` parameter is a `URL` object that represents the URL of the resource
-     * you want to delete. It is used to specify the location of the resource that you want to delete.
-     * @param {FridayOptions} [options] - The `options` parameter in the `delete` function is an optional
-     * parameter of type `FridayOptions`. It is used to provide additional configuration options for the
-     * HTTP request, such as request body and headers. The function uses the `body` property from the
-     * `options` object as the data
-     * @returns The `delete` method is returning the data from the response if the request is successful.
-     * If there is an error during the request, it will handle the error and return the result of the
-     * `handleError` method with the provided options.
-     */
-    delete(url: URL, options?: FridayOptions): Promise<AxiosResponse<any, any> | undefined>;
-    /**
-     * The `upload` function makes an asynchronous POST request using Axios with error handling and returns
-     * the response data.
-     * @param {URL} url - The `url` parameter in the `upload` function is of type `URL`, representing the
-     * Uniform Resource Locator where the data will be uploaded. It specifies the endpoint to which the
-     * data will be sent in the `POST` request.
-     * @param {FormData} body - The `body` parameter in the `upload` function is of type `FormData`, which
-     * contains the data to be uploaded in the request. It includes the content that will be sent to the
-     * server in the upload operation.
-     * @returns The `upload` function is returning the data from the response if the request is successful.
-     * If an error occurs during the request, it will handle the error using the `handleError` method.
-     */
-    upload(url: URL, body: FormData): Promise<AxiosResponse<any, any> | undefined>;
-}
 
-export { type FridayConfig, type FridayOptions, Friday as default };
+export type { FridayConfig, FridayOptions };

package/dist/index.d.ts

@@ -1,5 +1,3 @@
-import { AxiosResponse } from 'axios';
-
 interface FridayOptions {
     enableThrowHttpError?: false;
     body?: object;
@@ -21,140 +19,5 @@ interface FridayConfig {
     enableAccessToken?: boolean;
     enableRefreshToken?: boolean;
 }
-declare class Friday {
-    private config;
-    private axiosInstance;
-    /**
-     * The constructor function initializes an Axios instance with a base URL and sets up a response
-     * interceptor to handle token expiration and refresh if configured to do so.
-     * @param {FridayConfig} config - The `config` parameter in the constructor function is of type
-     * `FridayConfig`. It is used to configure the Friday instance with settings such as `baseURL` and
-     * `enableRefreshToken`. The `axiosInstance` is created with the base URL specified in the `config`.
-     */
-    constructor({ baseURL, accessTokenKey, refreshTokenKey, refreshTokenEndpoint, enableAccessToken, enableRefreshToken, }: FridayConfig);
-    /**
-     * The function `refreshAccessToken` asynchronously refreshes the access token by making an API
-     * request using a refresh token and updating the access token in the app's storage.
-     * @returns The `refreshAccessToken` function is returning the access token after successfully
-     * refreshing it using the refresh token.
-     */
-    refreshAccessToken(): Promise<string | undefined>;
-    /**
-     * The function `resetTokens` sets the access token and refresh token in cookies based on the
-     * response data from an Axios request.
-     * @param res - The `res` parameter in the `resetTokens` function is an AxiosResponse object. It
-     * represents the response returned from an HTTP request made using Axios. The AxiosResponse object
-     * contains data such as the response data, status, headers, and more.
-     */
-    resetTokens(res: AxiosResponse<any, any>): void;
-    /**
-     * The function `getAccessToken` retrieves the access token from a cookie using the key specified in
-     * the configuration.
-     * @returns The `getAccessToken` method is returning a string value or `undefined`. It retrieves the
-     * access token from a cookie using the `accessTokenKey` specified in the configuration.
-     */
-    private getAccessToken;
-    /**
-     * Retrieves the refresh token from a cookie using the key specified in the configuration.
-     * @returns A string value or `undefined`. It retrieves the refresh token from a cookie using the
-     * `refreshTokenKey` specified in the configuration.
-     */
-    private getRefreshToken;
-    /**
-     * The function `getAuthorizationHeader` returns an object with an Authorization header containing a
-     * Bearer token if an access token is available.
-     * @returns If the `accessToken` is not `undefined`, an object with the `Authorization` header
-     * containing the access token in the format `Bearer ` is being returned. If the
-     * `accessToken` is `undefined`, then `undefined` is being returned.
-     */
-    private getAuthorizationHeader;
-    /**
-     * The function `handleError` in TypeScript handles errors by extracting error messages and
-     * optionally displaying them as a toast.
-     * @param {unknown} e - The parameter `e` in the `handleError` function is used to represent the
-     * error that needs to be handled. It can be of type `unknown`, which means it can be any type of
-     * value. The function checks if `e` is an AxiosError and extracts the error message accordingly.
-     * @param {FridayOptions} [options] - The `options` parameter in the `handleError` function is of type
-     * `FridayOptions`. It is an optional parameter that allows you to pass additional options to the
-     * function. These options can include properties like `showToast`, which is a boolean value
-     * indicating whether a toast message should be displayed
-     */
-    private handleError;
-    /**
-     * The throwError function in TypeScript throws an error with a specified error message.
-     * @param {string} errorMessage - The `errorMessage` parameter is a string that represents the
-     * message you want to associate with the error that will be thrown.
-     */
-    throwError(errorMessage: string): void;
-    /**
-     * The `get` function makes an asynchronous GET request using Axios with error handling and returns
-     * the response data.
-     * @param {URL} url - The `url` parameter in the `get` function is of type `URL`, which represents a
-     * Uniform Resource Locator and is used to specify the address of a resource on the internet. It is
-     * the endpoint from which the data will be fetched in the `get` request.
-     * @param {FridayOptions} [options] - The `options` parameter in the `get` function is of type
-     * `FridayOptions`. It is an optional parameter that can be passed to the function to provide
-     * additional configuration or settings for the HTTP request. This parameter allows for customization
-     * of the request behavior based on the specific needs of the application
-     * @returns The `get` function is returning the data from the response if the request is successful.
-     * If there is an error during the request, it will handle the error using the `handleError` method
-     * with the provided options.
-     */
-    get(url: URL, options?: FridayOptions): Promise<AxiosResponse<any, any> | undefined>;
-    /**
-     * This TypeScript function sends a POST request using Axios with optional parameters and handles any
-     * errors that occur.
-     * @param {URL} url - The `url` parameter in the `post` function is a URL object that represents the
-     * endpoint where the POST request will be sent. It specifies the location where the data will be
-     * posted to.
-     * @param {FridayOptions} [options] - The `options` parameter in the `post` function is an optional
-     * parameter of type `FridayOptions`. It is used to provide additional configuration options for the
-     * HTTP POST request, such as the request body and headers. If `options` is provided, the function
-     * will use the `body`
-     * @returns The `post` function is returning the data from the response if the request is successful.
-     * If there is an error during the request, it will handle the error using the `handleError` method
-     * and return the result of that handling.
-     */
-    post(url: URL, options?: FridayOptions): Promise<AxiosResponse<any, any> | undefined>;
-    /**
-     * This TypeScript function sends a PUT request using Axios with specified options and handles any
-     * errors that occur.
-     * @param {URL} url - The `url` parameter in the `put` function is a URL object that represents the
-     * URL where the PUT request will be sent. It is used to specify the destination of the request.
-     * @param {FridayOptions} [options] - The `options` parameter in the `put` function is an optional
-     * object that may contain the following properties:
-     * @returns The `put` function is returning the data from the response if the request is successful.
-     * If there is an error during the request, it will handle the error using the `handleError` method
-     * and return the result of that handling.
-     */
-    put(url: URL, options?: FridayOptions): Promise<AxiosResponse<any, any> | undefined>;
-    /**
-     * The `delete` function sends a DELETE request to a specified URL with optional headers and body,
-     * handling errors and returning the response data.
-     * @param {URL} url - The `url` parameter is a `URL` object that represents the URL of the resource
-     * you want to delete. It is used to specify the location of the resource that you want to delete.
-     * @param {FridayOptions} [options] - The `options` parameter in the `delete` function is an optional
-     * parameter of type `FridayOptions`. It is used to provide additional configuration options for the
-     * HTTP request, such as request body and headers. The function uses the `body` property from the
-     * `options` object as the data
-     * @returns The `delete` method is returning the data from the response if the request is successful.
-     * If there is an error during the request, it will handle the error and return the result of the
-     * `handleError` method with the provided options.
-     */
-    delete(url: URL, options?: FridayOptions): Promise<AxiosResponse<any, any> | undefined>;
-    /**
-     * The `upload` function makes an asynchronous POST request using Axios with error handling and returns
-     * the response data.
-     * @param {URL} url - The `url` parameter in the `upload` function is of type `URL`, representing the
-     * Uniform Resource Locator where the data will be uploaded. It specifies the endpoint to which the
-     * data will be sent in the `POST` request.
-     * @param {FormData} body - The `body` parameter in the `upload` function is of type `FormData`, which
-     * contains the data to be uploaded in the request. It includes the content that will be sent to the
-     * server in the upload operation.
-     * @returns The `upload` function is returning the data from the response if the request is successful.
-     * If an error occurs during the request, it will handle the error using the `handleError` method.
-     */
-    upload(url: URL, body: FormData): Promise<AxiosResponse<any, any> | undefined>;
-}
 
-export { type FridayConfig, type FridayOptions, Friday as default };
+export type { FridayConfig, FridayOptions };

package/dist/index.js

@@ -5,10 +5,6 @@ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
 var __copyProps = (to, from, except, desc) => {
   if (from && typeof from === "object" || typeof from === "function") {
     for (let key of __getOwnPropNames(from))
@@ -29,285 +25,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 
 // src/index.ts
 var src_exports = {};
-__export(src_exports, {
-  default: () => Friday
-});
 module.exports = __toCommonJS(src_exports);
+
+// src/friday.ts
 var import_axios = __toESM(require("axios"));
 var import_js_cookie = __toESM(require("js-cookie"));
-var Friday = class {
-  /* The above code is declaring a private property `config` of type `FridayConfig` in a TypeScript
-  class or interface. The `FridayConfig` type is likely a custom type defined elsewhere in the
-  codebase. This property can only be accessed within the class or interface where it is declared. */
-  config;
-  /* The above code is declaring a private property named `axiosInstance` of type `AxiosInstance`. This
-  property is likely used to store an instance of Axios, which is a popular library for making HTTP
-  requests in JavaScript and TypeScript. This property can be accessed and used within the class
-  where it is declared. */
-  axiosInstance;
-  /**
-   * The constructor function initializes an Axios instance with a base URL and sets up a response
-   * interceptor to handle token expiration and refresh if configured to do so.
-   * @param {FridayConfig} config - The `config` parameter in the constructor function is of type
-   * `FridayConfig`. It is used to configure the Friday instance with settings such as `baseURL` and
-   * `enableRefreshToken`. The `axiosInstance` is created with the base URL specified in the `config`.
-   */
-  constructor({
-    baseURL,
-    accessTokenKey = "access_token",
-    refreshTokenKey = "refresh_token",
-    refreshTokenEndpoint = "/api/refresh",
-    enableAccessToken = true,
-    enableRefreshToken = false
-  }) {
-    this.config = {
-      baseURL,
-      accessTokenKey,
-      refreshTokenKey,
-      refreshTokenEndpoint,
-      enableAccessToken,
-      enableRefreshToken
-    };
-    this.axiosInstance = import_axios.default.create({ baseURL: this.config.baseURL });
-    if (this.config.enableRefreshToken && this.config.refreshTokenEndpoint) {
-      this.axiosInstance.interceptors.response.use(
-        (response) => response,
-        async (error) => {
-          const originalRequest = error.config;
-          if (error.response.status === 401 && !originalRequest._retry) {
-            originalRequest._retry = true;
-            const newAccessToken = await this.refreshAccessToken();
-            originalRequest.headers.Authorization = `Bearer ${newAccessToken}`;
-            return this.axiosInstance(originalRequest);
-          }
-          return Promise.reject(error);
-        }
-      );
-    }
-  }
-  /**
-   * The function `refreshAccessToken` asynchronously refreshes the access token by making an API
-   * request using a refresh token and updating the access token in the app's storage.
-   * @returns The `refreshAccessToken` function is returning the access token after successfully
-   * refreshing it using the refresh token.
-   */
-  async refreshAccessToken() {
-    try {
-      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
-      });
-      if (res.status != 200)
-        throw new Error("Refresh access token request failed!");
-      this.resetTokens(res);
-      return this.getAccessToken();
-    } catch (error) {
-      throw error;
-    }
-  }
-  /**
-   * The function `resetTokens` sets the access token and refresh token in cookies based on the
-   * response data from an Axios request.
-   * @param res - The `res` parameter in the `resetTokens` function is an AxiosResponse object. It
-   * represents the response returned from an HTTP request made using Axios. The AxiosResponse object
-   * contains data such as the response data, status, headers, and more.
-   */
-  resetTokens(res) {
-    if (this.config.accessTokenKey) {
-      import_js_cookie.default.set(this.config.accessTokenKey, res.data.access_token);
-    }
-    if (this.config.refreshTokenKey) {
-      import_js_cookie.default.set(this.config.refreshTokenKey, res.data.refresh_token);
-    }
-  }
-  /**
-   * The function `getAccessToken` retrieves the access token from a cookie using the key specified in
-   * the configuration.
-   * @returns The `getAccessToken` method is returning a string value or `undefined`. It retrieves the
-   * access token from a cookie using the `accessTokenKey` specified in the configuration.
-   */
-  getAccessToken() {
-    return this.config.accessTokenKey && import_js_cookie.default.get(this.config.accessTokenKey);
-  }
-  /**
-   * Retrieves the refresh token from a cookie using the key specified in the configuration.
-   * @returns A string value or `undefined`. It retrieves the refresh token from a cookie using the
-   * `refreshTokenKey` specified in the configuration.
-   */
-  getRefreshToken() {
-    return this.config.refreshTokenKey && import_js_cookie.default.get(this.config.refreshTokenKey);
-  }
-  /**
-   * The function `getAuthorizationHeader` returns an object with an Authorization header containing a
-   * Bearer token if an access token is available.
-   * @returns If the `accessToken` is not `undefined`, an object with the `Authorization` header
-   * containing the access token in the format `Bearer ` is being returned. If the
-   * `accessToken` is `undefined`, then `undefined` is being returned.
-   */
-  getAuthorizationHeader() {
-    if (this.config.enableAccessToken != true) return;
-    const accessToken = this.getAccessToken();
-    if (accessToken === void 0) return;
-    return { Authorization: `Bearer ${accessToken}` };
-  }
-  /**
-   * The function `handleError` in TypeScript handles errors by extracting error messages and
-   * optionally displaying them as a toast.
-   * @param {unknown} e - The parameter `e` in the `handleError` function is used to represent the
-   * error that needs to be handled. It can be of type `unknown`, which means it can be any type of
-   * value. The function checks if `e` is an AxiosError and extracts the error message accordingly.
-   * @param {FridayOptions} [options] - The `options` parameter in the `handleError` function is of type
-   * `FridayOptions`. It is an optional parameter that allows you to pass additional options to the
-   * function. These options can include properties like `showToast`, which is a boolean value
-   * indicating whether a toast message should be displayed
-   */
-  handleError(e, options) {
-    if (options?.enableThrowHttpError == false) return;
-    let errorMessage;
-    if (e?.response) {
-      const error = e;
-      errorMessage = (error.response?.data).message;
-    } else {
-      errorMessage = e.message;
-    }
-    if (errorMessage) {
-      this.throwError(errorMessage);
-    }
-  }
-  /**
-   * The throwError function in TypeScript throws an error with a specified error message.
-   * @param {string} errorMessage - The `errorMessage` parameter is a string that represents the
-   * message you want to associate with the error that will be thrown.
-   */
-  throwError(errorMessage) {
-    throw new Error(errorMessage);
-  }
-  /**
-   * The `get` function makes an asynchronous GET request using Axios with error handling and returns
-   * the response data.
-   * @param {URL} url - The `url` parameter in the `get` function is of type `URL`, which represents a
-   * Uniform Resource Locator and is used to specify the address of a resource on the internet. It is
-   * the endpoint from which the data will be fetched in the `get` request.
-   * @param {FridayOptions} [options] - The `options` parameter in the `get` function is of type
-   * `FridayOptions`. It is an optional parameter that can be passed to the function to provide
-   * additional configuration or settings for the HTTP request. This parameter allows for customization
-   * of the request behavior based on the specific needs of the application
-   * @returns The `get` function is returning the data from the response if the request is successful.
-   * If there is an error during the request, it will handle the error using the `handleError` method
-   * with the provided options.
-   */
-  async get(url, options) {
-    try {
-      return await this.axiosInstance.get(url.href, {
-        headers: {
-          ...this.getAuthorizationHeader(),
-          "Content-Type": "application/json"
-        }
-      });
-    } catch (error) {
-      return this.handleError(error, options);
-    }
-  }
-  /**
-   * This TypeScript function sends a POST request using Axios with optional parameters and handles any
-   * errors that occur.
-   * @param {URL} url - The `url` parameter in the `post` function is a URL object that represents the
-   * endpoint where the POST request will be sent. It specifies the location where the data will be
-   * posted to.
-   * @param {FridayOptions} [options] - The `options` parameter in the `post` function is an optional
-   * parameter of type `FridayOptions`. It is used to provide additional configuration options for the
-   * HTTP POST request, such as the request body and headers. If `options` is provided, the function
-   * will use the `body`
-   * @returns The `post` function is returning the data from the response if the request is successful.
-   * If there is an error during the request, it will handle the error using the `handleError` method
-   * and return the result of that handling.
-   */
-  async post(url, options) {
-    try {
-      return await this.axiosInstance.post(url.href, options?.body, {
-        headers: {
-          ...options?.headers,
-          ...this.getAuthorizationHeader(),
-          "Content-Type": "application/json"
-        }
-      });
-    } catch (error) {
-      return this.handleError(error, options);
-    }
-  }
-  /**
-   * This TypeScript function sends a PUT request using Axios with specified options and handles any
-   * errors that occur.
-   * @param {URL} url - The `url` parameter in the `put` function is a URL object that represents the
-   * URL where the PUT request will be sent. It is used to specify the destination of the request.
-   * @param {FridayOptions} [options] - The `options` parameter in the `put` function is an optional
-   * object that may contain the following properties:
-   * @returns The `put` function is returning the data from the response if the request is successful.
-   * If there is an error during the request, it will handle the error using the `handleError` method
-   * and return the result of that handling.
-   */
-  async put(url, options) {
-    try {
-      return await this.axiosInstance.put(url.href, options?.body, {
-        headers: {
-          ...options?.headers,
-          ...this.getAuthorizationHeader(),
-          "Content-Type": "application/json"
-        }
-      });
-    } catch (error) {
-      return this.handleError(error, options);
-    }
-  }
-  /**
-   * The `delete` function sends a DELETE request to a specified URL with optional headers and body,
-   * handling errors and returning the response data.
-   * @param {URL} url - The `url` parameter is a `URL` object that represents the URL of the resource
-   * you want to delete. It is used to specify the location of the resource that you want to delete.
-   * @param {FridayOptions} [options] - The `options` parameter in the `delete` function is an optional
-   * parameter of type `FridayOptions`. It is used to provide additional configuration options for the
-   * HTTP request, such as request body and headers. The function uses the `body` property from the
-   * `options` object as the data
-   * @returns The `delete` method is returning the data from the response if the request is successful.
-   * If there is an error during the request, it will handle the error and return the result of the
-   * `handleError` method with the provided options.
-   */
-  async delete(url, options) {
-    try {
-      return await this.axiosInstance.delete(url.href, {
-        data: options?.body,
-        headers: {
-          ...options?.headers,
-          ...this.getAuthorizationHeader()
-        }
-      });
-    } catch (error) {
-      return this.handleError(error, options);
-    }
-  }
-  /**
-   * The `upload` function makes an asynchronous POST request using Axios with error handling and returns
-   * the response data.
-   * @param {URL} url - The `url` parameter in the `upload` function is of type `URL`, representing the
-   * Uniform Resource Locator where the data will be uploaded. It specifies the endpoint to which the
-   * data will be sent in the `POST` request.
-   * @param {FormData} body - The `body` parameter in the `upload` function is of type `FormData`, which
-   * contains the data to be uploaded in the request. It includes the content that will be sent to the
-   * server in the upload operation.
-   * @returns The `upload` function is returning the data from the response if the request is successful.
-   * If an error occurs during the request, it will handle the error using the `handleError` method.
-   */
-  async upload(url, body) {
-    try {
-      return await this.axiosInstance.post(url.href, body, {
-        headers: {
-          ...this.getAuthorizationHeader()
-        }
-      });
-    } catch (e) {
-      return this.handleError(e);
-    }
-  }
-};

package/dist/index.mjs

@@ -1,282 +1,3 @@
-// src/index.ts
+// src/friday.ts
 import axios from "axios";
 import Cookies from "js-cookie";
-var Friday = class {
-  /* The above code is declaring a private property `config` of type `FridayConfig` in a TypeScript
-  class or interface. The `FridayConfig` type is likely a custom type defined elsewhere in the
-  codebase. This property can only be accessed within the class or interface where it is declared. */
-  config;
-  /* The above code is declaring a private property named `axiosInstance` of type `AxiosInstance`. This
-  property is likely used to store an instance of Axios, which is a popular library for making HTTP
-  requests in JavaScript and TypeScript. This property can be accessed and used within the class
-  where it is declared. */
-  axiosInstance;
-  /**
-   * The constructor function initializes an Axios instance with a base URL and sets up a response
-   * interceptor to handle token expiration and refresh if configured to do so.
-   * @param {FridayConfig} config - The `config` parameter in the constructor function is of type
-   * `FridayConfig`. It is used to configure the Friday instance with settings such as `baseURL` and
-   * `enableRefreshToken`. The `axiosInstance` is created with the base URL specified in the `config`.
-   */
-  constructor({
-    baseURL,
-    accessTokenKey = "access_token",
-    refreshTokenKey = "refresh_token",
-    refreshTokenEndpoint = "/api/refresh",
-    enableAccessToken = true,
-    enableRefreshToken = false
-  }) {
-    this.config = {
-      baseURL,
-      accessTokenKey,
-      refreshTokenKey,
-      refreshTokenEndpoint,
-      enableAccessToken,
-      enableRefreshToken
-    };
-    this.axiosInstance = axios.create({ baseURL: this.config.baseURL });
-    if (this.config.enableRefreshToken && this.config.refreshTokenEndpoint) {
-      this.axiosInstance.interceptors.response.use(
-        (response) => response,
-        async (error) => {
-          const originalRequest = error.config;
-          if (error.response.status === 401 && !originalRequest._retry) {
-            originalRequest._retry = true;
-            const newAccessToken = await this.refreshAccessToken();
-            originalRequest.headers.Authorization = `Bearer ${newAccessToken}`;
-            return this.axiosInstance(originalRequest);
-          }
-          return Promise.reject(error);
-        }
-      );
-    }
-  }
-  /**
-   * The function `refreshAccessToken` asynchronously refreshes the access token by making an API
-   * request using a refresh token and updating the access token in the app's storage.
-   * @returns The `refreshAccessToken` function is returning the access token after successfully
-   * refreshing it using the refresh token.
-   */
-  async refreshAccessToken() {
-    try {
-      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
-      });
-      if (res.status != 200)
-        throw new Error("Refresh access token request failed!");
-      this.resetTokens(res);
-      return this.getAccessToken();
-    } catch (error) {
-      throw error;
-    }
-  }
-  /**
-   * The function `resetTokens` sets the access token and refresh token in cookies based on the
-   * response data from an Axios request.
-   * @param res - The `res` parameter in the `resetTokens` function is an AxiosResponse object. It
-   * represents the response returned from an HTTP request made using Axios. The AxiosResponse object
-   * contains data such as the response data, status, headers, and more.
-   */
-  resetTokens(res) {
-    if (this.config.accessTokenKey) {
-      Cookies.set(this.config.accessTokenKey, res.data.access_token);
-    }
-    if (this.config.refreshTokenKey) {
-      Cookies.set(this.config.refreshTokenKey, res.data.refresh_token);
-    }
-  }
-  /**
-   * The function `getAccessToken` retrieves the access token from a cookie using the key specified in
-   * the configuration.
-   * @returns The `getAccessToken` method is returning a string value or `undefined`. It retrieves the
-   * access token from a cookie using the `accessTokenKey` specified in the configuration.
-   */
-  getAccessToken() {
-    return this.config.accessTokenKey && Cookies.get(this.config.accessTokenKey);
-  }
-  /**
-   * Retrieves the refresh token from a cookie using the key specified in the configuration.
-   * @returns A string value or `undefined`. It retrieves the refresh token from a cookie using the
-   * `refreshTokenKey` specified in the configuration.
-   */
-  getRefreshToken() {
-    return this.config.refreshTokenKey && Cookies.get(this.config.refreshTokenKey);
-  }
-  /**
-   * The function `getAuthorizationHeader` returns an object with an Authorization header containing a
-   * Bearer token if an access token is available.
-   * @returns If the `accessToken` is not `undefined`, an object with the `Authorization` header
-   * containing the access token in the format `Bearer ` is being returned. If the
-   * `accessToken` is `undefined`, then `undefined` is being returned.
-   */
-  getAuthorizationHeader() {
-    if (this.config.enableAccessToken != true) return;
-    const accessToken = this.getAccessToken();
-    if (accessToken === void 0) return;
-    return { Authorization: `Bearer ${accessToken}` };
-  }
-  /**
-   * The function `handleError` in TypeScript handles errors by extracting error messages and
-   * optionally displaying them as a toast.
-   * @param {unknown} e - The parameter `e` in the `handleError` function is used to represent the
-   * error that needs to be handled. It can be of type `unknown`, which means it can be any type of
-   * value. The function checks if `e` is an AxiosError and extracts the error message accordingly.
-   * @param {FridayOptions} [options] - The `options` parameter in the `handleError` function is of type
-   * `FridayOptions`. It is an optional parameter that allows you to pass additional options to the
-   * function. These options can include properties like `showToast`, which is a boolean value
-   * indicating whether a toast message should be displayed
-   */
-  handleError(e, options) {
-    if (options?.enableThrowHttpError == false) return;
-    let errorMessage;
-    if (e?.response) {
-      const error = e;
-      errorMessage = (error.response?.data).message;
-    } else {
-      errorMessage = e.message;
-    }
-    if (errorMessage) {
-      this.throwError(errorMessage);
-    }
-  }
-  /**
-   * The throwError function in TypeScript throws an error with a specified error message.
-   * @param {string} errorMessage - The `errorMessage` parameter is a string that represents the
-   * message you want to associate with the error that will be thrown.
-   */
-  throwError(errorMessage) {
-    throw new Error(errorMessage);
-  }
-  /**
-   * The `get` function makes an asynchronous GET request using Axios with error handling and returns
-   * the response data.
-   * @param {URL} url - The `url` parameter in the `get` function is of type `URL`, which represents a
-   * Uniform Resource Locator and is used to specify the address of a resource on the internet. It is
-   * the endpoint from which the data will be fetched in the `get` request.
-   * @param {FridayOptions} [options] - The `options` parameter in the `get` function is of type
-   * `FridayOptions`. It is an optional parameter that can be passed to the function to provide
-   * additional configuration or settings for the HTTP request. This parameter allows for customization
-   * of the request behavior based on the specific needs of the application
-   * @returns The `get` function is returning the data from the response if the request is successful.
-   * If there is an error during the request, it will handle the error using the `handleError` method
-   * with the provided options.
-   */
-  async get(url, options) {
-    try {
-      return await this.axiosInstance.get(url.href, {
-        headers: {
-          ...this.getAuthorizationHeader(),
-          "Content-Type": "application/json"
-        }
-      });
-    } catch (error) {
-      return this.handleError(error, options);
-    }
-  }
-  /**
-   * This TypeScript function sends a POST request using Axios with optional parameters and handles any
-   * errors that occur.
-   * @param {URL} url - The `url` parameter in the `post` function is a URL object that represents the
-   * endpoint where the POST request will be sent. It specifies the location where the data will be
-   * posted to.
-   * @param {FridayOptions} [options] - The `options` parameter in the `post` function is an optional
-   * parameter of type `FridayOptions`. It is used to provide additional configuration options for the
-   * HTTP POST request, such as the request body and headers. If `options` is provided, the function
-   * will use the `body`
-   * @returns The `post` function is returning the data from the response if the request is successful.
-   * If there is an error during the request, it will handle the error using the `handleError` method
-   * and return the result of that handling.
-   */
-  async post(url, options) {
-    try {
-      return await this.axiosInstance.post(url.href, options?.body, {
-        headers: {
-          ...options?.headers,
-          ...this.getAuthorizationHeader(),
-          "Content-Type": "application/json"
-        }
-      });
-    } catch (error) {
-      return this.handleError(error, options);
-    }
-  }
-  /**
-   * This TypeScript function sends a PUT request using Axios with specified options and handles any
-   * errors that occur.
-   * @param {URL} url - The `url` parameter in the `put` function is a URL object that represents the
-   * URL where the PUT request will be sent. It is used to specify the destination of the request.
-   * @param {FridayOptions} [options] - The `options` parameter in the `put` function is an optional
-   * object that may contain the following properties:
-   * @returns The `put` function is returning the data from the response if the request is successful.
-   * If there is an error during the request, it will handle the error using the `handleError` method
-   * and return the result of that handling.
-   */
-  async put(url, options) {
-    try {
-      return await this.axiosInstance.put(url.href, options?.body, {
-        headers: {
-          ...options?.headers,
-          ...this.getAuthorizationHeader(),
-          "Content-Type": "application/json"
-        }
-      });
-    } catch (error) {
-      return this.handleError(error, options);
-    }
-  }
-  /**
-   * The `delete` function sends a DELETE request to a specified URL with optional headers and body,
-   * handling errors and returning the response data.
-   * @param {URL} url - The `url` parameter is a `URL` object that represents the URL of the resource
-   * you want to delete. It is used to specify the location of the resource that you want to delete.
-   * @param {FridayOptions} [options] - The `options` parameter in the `delete` function is an optional
-   * parameter of type `FridayOptions`. It is used to provide additional configuration options for the
-   * HTTP request, such as request body and headers. The function uses the `body` property from the
-   * `options` object as the data
-   * @returns The `delete` method is returning the data from the response if the request is successful.
-   * If there is an error during the request, it will handle the error and return the result of the
-   * `handleError` method with the provided options.
-   */
-  async delete(url, options) {
-    try {
-      return await this.axiosInstance.delete(url.href, {
-        data: options?.body,
-        headers: {
-          ...options?.headers,
-          ...this.getAuthorizationHeader()
-        }
-      });
-    } catch (error) {
-      return this.handleError(error, options);
-    }
-  }
-  /**
-   * The `upload` function makes an asynchronous POST request using Axios with error handling and returns
-   * the response data.
-   * @param {URL} url - The `url` parameter in the `upload` function is of type `URL`, representing the
-   * Uniform Resource Locator where the data will be uploaded. It specifies the endpoint to which the
-   * data will be sent in the `POST` request.
-   * @param {FormData} body - The `body` parameter in the `upload` function is of type `FormData`, which
-   * contains the data to be uploaded in the request. It includes the content that will be sent to the
-   * server in the upload operation.
-   * @returns The `upload` function is returning the data from the response if the request is successful.
-   * If an error occurs during the request, it will handle the error using the `handleError` method.
-   */
-  async upload(url, body) {
-    try {
-      return await this.axiosInstance.post(url.href, body, {
-        headers: {
-          ...this.getAuthorizationHeader()
-        }
-      });
-    } catch (e) {
-      return this.handleError(e);
-    }
-  }
-};
-export {
-  Friday as default
-};

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@sabuj0338/axios-friday",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Friday - a axios based api handling custom class. which has refresh token mechanism configured.",
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "files": [
     "dist/**/*"
   ],
@@ -17,10 +17,9 @@
   },
   "keywords": [
     "typescript",
-    "library",
     "axios",
-    "refresh",
-    "token"
+    "refresh token",
+    "authorization"
   ],
   "author": "Sabuj Islam <sabuj0338@gmail.com>",
   "license": "MIT",