@sabuj0338/axios-friday 1.1.0 → 1.2.0

package/dist/index.d.mts

@@ -12,6 +12,7 @@ interface FridayOptions {
  * @var refreshTokenEndpoint: an optional string property representing the API endpoint for refreshing tokens.
  * @var enableAccessToken: a optional boolean property indicating whether token access is enabled.
  * @var enableRefreshToken: a optional boolean property indicating whether token refresh is enabled.
+ * @var storage: a required string property representing the storage mechanism for tokens.
  */
 interface FridayConfig {
     baseURL: string;
@@ -20,6 +21,7 @@ interface FridayConfig {
     refreshTokenEndpoint?: string;
     enableAccessToken?: boolean;
     enableRefreshToken?: boolean;
+    storage?: 'cookie' | 'local';
 }
 
 declare class Friday {
@@ -32,7 +34,7 @@ declare class Friday {
      * `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);
+    constructor({ baseURL, accessTokenKey, refreshTokenKey, refreshTokenEndpoint, enableAccessToken, enableRefreshToken, storage, }: 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.
@@ -40,6 +42,17 @@ declare class Friday {
      * refreshing it using the refresh token.
      */
     refreshAccessToken(): Promise<string | undefined>;
+    /**
+     * The setTokens function stores a key-value pair either in a cookie or in local storage based on the
+     * configuration.
+     * @param {string} key - The `key` parameter is a string that represents the key under which the
+     * `value` will be stored in either a cookie or local storage, depending on the configuration set in
+     * `this.config.storage`.
+     * @param {string} value - The `value` parameter in the `setTokens` function represents the value that
+     * you want to store in either a cookie or local storage, based on the configuration set in
+     * `this.config.storage`.
+     */
+    private setTokens;
     /**
      * The function `resetTokens` sets the access token and refresh token in cookies based on the
      * response data from an Axios request.

package/dist/index.d.ts

@@ -12,6 +12,7 @@ interface FridayOptions {
  * @var refreshTokenEndpoint: an optional string property representing the API endpoint for refreshing tokens.
  * @var enableAccessToken: a optional boolean property indicating whether token access is enabled.
  * @var enableRefreshToken: a optional boolean property indicating whether token refresh is enabled.
+ * @var storage: a required string property representing the storage mechanism for tokens.
  */
 interface FridayConfig {
     baseURL: string;
@@ -20,6 +21,7 @@ interface FridayConfig {
     refreshTokenEndpoint?: string;
     enableAccessToken?: boolean;
     enableRefreshToken?: boolean;
+    storage?: 'cookie' | 'local';
 }
 
 declare class Friday {
@@ -32,7 +34,7 @@ declare class Friday {
      * `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);
+    constructor({ baseURL, accessTokenKey, refreshTokenKey, refreshTokenEndpoint, enableAccessToken, enableRefreshToken, storage, }: 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.
@@ -40,6 +42,17 @@ declare class Friday {
      * refreshing it using the refresh token.
      */
     refreshAccessToken(): Promise<string | undefined>;
+    /**
+     * The setTokens function stores a key-value pair either in a cookie or in local storage based on the
+     * configuration.
+     * @param {string} key - The `key` parameter is a string that represents the key under which the
+     * `value` will be stored in either a cookie or local storage, depending on the configuration set in
+     * `this.config.storage`.
+     * @param {string} value - The `value` parameter in the `setTokens` function represents the value that
+     * you want to store in either a cookie or local storage, based on the configuration set in
+     * `this.config.storage`.
+     */
+    private setTokens;
     /**
      * The function `resetTokens` sets the access token and refresh token in cookies based on the
      * response data from an Axios request.

package/dist/index.js

@@ -60,7 +60,8 @@ var Friday = class {
     refreshTokenKey = "refresh_token",
     refreshTokenEndpoint = "/api/refresh",
     enableAccessToken = true,
-    enableRefreshToken = false
+    enableRefreshToken = false,
+    storage = "cookie"
   }) {
     this.config = {
       baseURL,
@@ -68,7 +69,8 @@ var Friday = class {
       refreshTokenKey,
       refreshTokenEndpoint,
       enableAccessToken,
-      enableRefreshToken
+      enableRefreshToken,
+      storage
     };
     this.axiosInstance = import_axios.default.create({ baseURL: this.config.baseURL });
     if (this.config.enableRefreshToken && this.config.refreshTokenEndpoint) {
@@ -125,6 +127,23 @@ var Friday = class {
       throw error;
     }
   }
+  /**
+   * The setTokens function stores a key-value pair either in a cookie or in local storage based on the
+   * configuration.
+   * @param {string} key - The `key` parameter is a string that represents the key under which the
+   * `value` will be stored in either a cookie or local storage, depending on the configuration set in
+   * `this.config.storage`.
+   * @param {string} value - The `value` parameter in the `setTokens` function represents the value that
+   * you want to store in either a cookie or local storage, based on the configuration set in
+   * `this.config.storage`.
+   */
+  setTokens(key, value) {
+    if (this.config.storage == "cookie") {
+      import_js_cookie.default.set(key, value);
+    } else if (this.config.storage == "local") {
+      localStorage.setItem(key, value);
+    }
+  }
   /**
    * The function `resetTokens` sets the access token and refresh token in cookies based on the
    * response data from an Axios request.
@@ -134,10 +153,10 @@ var Friday = class {
    */
   resetTokens(res) {
     if (this.config.accessTokenKey) {
-      import_js_cookie.default.set(this.config.accessTokenKey, res.data.access_token);
+      this.setTokens(this.config.accessTokenKey, res.data.access_token);
     }
     if (this.config.refreshTokenKey) {
-      import_js_cookie.default.set(this.config.refreshTokenKey, res.data.refresh_token);
+      this.setTokens(this.config.refreshTokenKey, res.data.refresh_token);
     }
   }
   /**
@@ -147,7 +166,11 @@ var Friday = class {
    * 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);
+    if (this.config.storage == "cookie") {
+      return this.config.accessTokenKey && import_js_cookie.default.get(this.config.accessTokenKey);
+    } else if (this.config.storage == "local") {
+      return this.config.accessTokenKey && (localStorage.getItem(this.config.accessTokenKey) || void 0);
+    }
   }
   /**
    * Retrieves the refresh token from a cookie using the key specified in the configuration.

package/dist/index.mjs

@@ -24,7 +24,8 @@ var Friday = class {
     refreshTokenKey = "refresh_token",
     refreshTokenEndpoint = "/api/refresh",
     enableAccessToken = true,
-    enableRefreshToken = false
+    enableRefreshToken = false,
+    storage = "cookie"
   }) {
     this.config = {
       baseURL,
@@ -32,7 +33,8 @@ var Friday = class {
       refreshTokenKey,
       refreshTokenEndpoint,
       enableAccessToken,
-      enableRefreshToken
+      enableRefreshToken,
+      storage
     };
     this.axiosInstance = axios.create({ baseURL: this.config.baseURL });
     if (this.config.enableRefreshToken && this.config.refreshTokenEndpoint) {
@@ -89,6 +91,23 @@ var Friday = class {
       throw error;
     }
   }
+  /**
+   * The setTokens function stores a key-value pair either in a cookie or in local storage based on the
+   * configuration.
+   * @param {string} key - The `key` parameter is a string that represents the key under which the
+   * `value` will be stored in either a cookie or local storage, depending on the configuration set in
+   * `this.config.storage`.
+   * @param {string} value - The `value` parameter in the `setTokens` function represents the value that
+   * you want to store in either a cookie or local storage, based on the configuration set in
+   * `this.config.storage`.
+   */
+  setTokens(key, value) {
+    if (this.config.storage == "cookie") {
+      Cookies.set(key, value);
+    } else if (this.config.storage == "local") {
+      localStorage.setItem(key, value);
+    }
+  }
   /**
    * The function `resetTokens` sets the access token and refresh token in cookies based on the
    * response data from an Axios request.
@@ -98,10 +117,10 @@ var Friday = class {
    */
   resetTokens(res) {
     if (this.config.accessTokenKey) {
-      Cookies.set(this.config.accessTokenKey, res.data.access_token);
+      this.setTokens(this.config.accessTokenKey, res.data.access_token);
     }
     if (this.config.refreshTokenKey) {
-      Cookies.set(this.config.refreshTokenKey, res.data.refresh_token);
+      this.setTokens(this.config.refreshTokenKey, res.data.refresh_token);
     }
   }
   /**
@@ -111,7 +130,11 @@ var Friday = class {
    * access token from a cookie using the `accessTokenKey` specified in the configuration.
    */
   getAccessToken() {
-    return this.config.accessTokenKey && Cookies.get(this.config.accessTokenKey);
+    if (this.config.storage == "cookie") {
+      return this.config.accessTokenKey && Cookies.get(this.config.accessTokenKey);
+    } else if (this.config.storage == "local") {
+      return this.config.accessTokenKey && (localStorage.getItem(this.config.accessTokenKey) || void 0);
+    }
   }
   /**
    * Retrieves the refresh token from a cookie using the key specified in the configuration.

package/package.json

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