lightspeed-retail-sdk 3.3.2 → 3.3.4

package/README.md

@@ -2,9 +2,9 @@
 
 A modern JavaScript SDK for interacting with the Lightspeed Retail API. This SDK provides a convenient, secure, and flexible way to access Lightspeed Retail's features—including customer, item, and order management.
 
-**Current Version: 3.3.2** — Refactor: extract endpoints for maintainability and improve endpoint testing. Enhanced query param encoding and pagination logic for consistency.
+**Current Version: 3.3.4** — improve error checking on token refresh to prevent false email warnings.
 
-## **🆕 Recent Updates (v3.3.2)**
+## **🆕 Recent Updates (v3.3.4)**
 
 - **Add centralized query param builder for API requests**: Add centralized query param builder for API requests. Supports input as object, string, or array, and manages relations/load_relations. Ensures no double-encoding of parameters and handles special cases for 'or' and 'timeStamp'.
 - **🎯 Enhanced Parameter Support**: All main getter methods now support both legacy and new object-based parameters with full backward compatibility
@@ -66,7 +66,7 @@ const items = await sdk.getItems({
 ## Table of Contents
 
 - [Another Unofficial Lightspeed Retail V3 API SDK](#another-unofficial-lightspeed-retail-v3-api-sdk)
-  - [**🆕 Recent Updates (v3.3.2)**](#-recent-updates-v332)
+  - [**🆕 Recent Updates (v3.3.4)**](#-recent-updates-v334)
   - [🚀 Key Features](#-key-features)
   - [🔄 Migrating from 3.1.x](#-migrating-from-31x)
     - [Backward Compatibility](#backward-compatibility)

package/dist/src/core/LightspeedSDK.cjs

@@ -207,8 +207,9 @@ class LightspeedSDKCore {
     // Token management
     async getToken() {
         const now = new Date();
-        const bufferTime = 1 * 60 * 1000; // 1 minute buffer
+        const bufferTime = 5 * 60 * 1000; // 5-minute buffer
         const storedTokens = await this.tokenStorage.getTokens();
+        // Check if the token is still valid
         if (storedTokens.access_token && storedTokens.expires_at) {
             const expiryTime = new Date(storedTokens.expires_at);
             if (expiryTime.getTime() - now.getTime() > bufferTime) {
@@ -216,17 +217,35 @@ class LightspeedSDKCore {
                 return this.token;
             }
         }
-        const refreshToken = storedTokens.refresh_token || this.refreshToken;
-        if (!refreshToken) {
-            throw new Error("No refresh token available");
+        // Prevent concurrent refresh attempts
+        if (this.refreshInProgress) {
+            console.log("🔄 Token refresh already in progress. Waiting...");
+            while(this.refreshInProgress){
+                await sleep(100); // Wait for the ongoing refresh to complete
+            }
+            // After waiting, check if the token is now valid
+            const updatedTokens = await this.tokenStorage.getTokens();
+            if (updatedTokens.access_token && updatedTokens.expires_at) {
+                const expiryTime = new Date(updatedTokens.expires_at);
+                if (expiryTime.getTime() - now.getTime() > bufferTime) {
+                    this.token = updatedTokens.access_token;
+                    return this.token;
+                }
+            }
+        // If still invalid, proceed to refresh
         }
-        const body = {
-            grant_type: "refresh_token",
-            client_id: this.clientID,
-            client_secret: this.clientSecret,
-            refresh_token: refreshToken
-        };
+        this.refreshInProgress = true; // Lock the refresh process
         try {
+            const refreshToken = storedTokens.refresh_token || this.refreshToken;
+            if (!refreshToken) {
+                throw new Error("No refresh token available");
+            }
+            const body = {
+                grant_type: "refresh_token",
+                client_id: this.clientID,
+                client_secret: this.clientSecret,
+                refresh_token: refreshToken
+            };
             const response = await (0, _axios.default)({
                 url: this.tokenUrl,
                 method: "post",
@@ -237,6 +256,7 @@ class LightspeedSDKCore {
             });
             const tokenData = response.data;
             const expiresAt = new Date(now.getTime() + tokenData.expires_in * 1000);
+            // Save the new tokens
             await this.tokenStorage.setTokens({
                 access_token: tokenData.access_token,
                 refresh_token: tokenData.refresh_token,
@@ -245,8 +265,20 @@ class LightspeedSDKCore {
             });
             this.token = tokenData.access_token;
             this.tokenExpiry = expiresAt;
+            console.log("✅ Token refresh successful");
             return this.token;
         } catch (error) {
+            console.error("❌ Token refresh failed:", error.message);
+            // Check if the token was refreshed by another process
+            const updatedTokens = await this.tokenStorage.getTokens();
+            if (updatedTokens.access_token && updatedTokens.expires_at) {
+                const expiryTime = new Date(updatedTokens.expires_at);
+                if (expiryTime.getTime() - now.getTime() > bufferTime) {
+                    console.log("🔄 Token was refreshed by another process. Skipping failure email.");
+                    return updatedTokens.access_token;
+                }
+            }
+            // If the token is still invalid, send the failure email
             const helpMsg = "\n❌ Token refresh failed. Your refresh token may be expired or revoked.\n" + "👉 Please re-authenticate using the SDK's CLI or obtain a new refresh token.\n" + "Original error: " + ((error === null || error === void 0 ? void 0 : error.message) || error);
             console.error(helpMsg);
             process.emitWarning(helpMsg, {
@@ -255,81 +287,8 @@ class LightspeedSDKCore {
             // Send email notification about token refresh failure
             await sendTokenRefreshFailureEmail(error, this.accountID);
             throw new Error(helpMsg);
-        }
-    }
-    // Core API request handler
-    async executeApiRequest(options, retries = 0) {
-        await this.handleRateLimit(options);
-        const token = await this.getToken();
-        if (!token) throw new Error("Error Fetching Token");
-        options.headers = {
-            Authorization: `Bearer ${token}`,
-            "Content-Type": "application/json",
-            ...options.headers
-        };
-        // Centralized query param handling
-        if (options.params) {
-            const queryString = buildQueryParams(options.params);
-            if (queryString) {
-                // Remove any trailing ? or & from url
-                options.url = options.url.replace(/[?&]+$/, "");
-                options.url += (options.url.includes("?") ? "&" : "?") + queryString;
-            }
-            delete options.params; // Don't let axios try to re-encode
-        }
-        try {
-            const res = await (0, _axios.default)(options);
-            this.lastResponse = res;
-            if (options.method === "GET") {
-                var _res_data_attributes, _res_data_attributes1;
-                // Handle successful response with no data or empty data
-                if (!res.data || Object.keys(res.data).length === 0) {
-                    return {
-                        data: {},
-                        next: null,
-                        previous: null
-                    };
-                }
-                // Check if response has the expected structure but with empty arrays
-                const dataKeys = Object.keys(res.data).filter((key)=>key !== "@attributes");
-                if (dataKeys.length > 0) {
-                    const firstDataKey = dataKeys[0];
-                    const firstDataValue = res.data[firstDataKey];
-                // No need to log for empty arrays - this is normal
-                }
-                // Handle successful response with data
-                return {
-                    data: res.data,
-                    next: (_res_data_attributes = res.data["@attributes"]) === null || _res_data_attributes === void 0 ? void 0 : _res_data_attributes.next,
-                    previous: (_res_data_attributes1 = res.data["@attributes"]) === null || _res_data_attributes1 === void 0 ? void 0 : _res_data_attributes1.prev
-                };
-            } else {
-                return res.data;
-            }
-        } catch (err) {
-            var _err_response;
-            // Handle 401 auth errors with automatic retry
-            if (((_err_response = err.response) === null || _err_response === void 0 ? void 0 : _err_response.status) === 401 && !options._authRetryAttempted) {
-                console.log("🔄 401 error - forcing token refresh and retrying...");
-                options._authRetryAttempted = true;
-                this.token = null;
-                try {
-                    await this.refreshTokens();
-                    return this.executeApiRequest(options, retries);
-                } catch (refreshError) {
-                    console.error("Failed to refresh tokens:", refreshError.message);
-                    throw refreshError;
-                }
-            }
-            // Handle retryable errors
-            if (this.isRetryableError(err) && retries < this.maxRetries) {
-                this.handleError(`Network Error Retrying in 2 seconds...`, err.message, false);
-                await sleep(2000);
-                return this.executeApiRequest(options, retries + 1);
-            } else {
-                // Simple error handling - let the calling method decide how to handle it
-                throw err;
-            }
+        } finally{
+            this.refreshInProgress = false; // Release the lock
         }
     }
     // Paginated data fetching
@@ -491,6 +450,7 @@ class LightspeedSDKCore {
         this.lastResponse = null;
         this.token = null;
         this.tokenExpiry = null;
+        this.refreshInProgress = false;
         // Token storage interface - defaults to in-memory if not provided
         this.tokenStorage = tokenStorage || new InMemoryTokenStorage();
     }

package/dist/src/core/LightspeedSDK.mjs

@@ -144,6 +144,7 @@ export class LightspeedSDKCore {
     this.lastResponse = null;
     this.token = null;
     this.tokenExpiry = null;
+    this.refreshInProgress = false;
 
     // Token storage interface - defaults to in-memory if not provided
     this.tokenStorage = tokenStorage || new InMemoryTokenStorage();
@@ -216,10 +217,11 @@ export class LightspeedSDKCore {
   // Token management
   async getToken() {
     const now = new Date();
-    const bufferTime = 1 * 60 * 1000; // 1 minute buffer
+    const bufferTime = 5 * 60 * 1000; // 5-minute buffer
 
     const storedTokens = await this.tokenStorage.getTokens();
 
+    // Check if the token is still valid
     if (storedTokens.access_token && storedTokens.expires_at) {
       const expiryTime = new Date(storedTokens.expires_at);
       if (expiryTime.getTime() - now.getTime() > bufferTime) {
@@ -228,20 +230,40 @@ export class LightspeedSDKCore {
       }
     }
 
-    const refreshToken = storedTokens.refresh_token || this.refreshToken;
-
-    if (!refreshToken) {
-      throw new Error("No refresh token available");
+    // Prevent concurrent refresh attempts
+    if (this.refreshInProgress) {
+      console.log("🔄 Token refresh already in progress. Waiting...");
+      while (this.refreshInProgress) {
+        await sleep(100); // Wait for the ongoing refresh to complete
+      }
+      // After waiting, check if the token is now valid
+      const updatedTokens = await this.tokenStorage.getTokens();
+      if (updatedTokens.access_token && updatedTokens.expires_at) {
+        const expiryTime = new Date(updatedTokens.expires_at);
+        if (expiryTime.getTime() - now.getTime() > bufferTime) {
+          this.token = updatedTokens.access_token;
+          return this.token;
+        }
+      }
+      // If still invalid, proceed to refresh
     }
 
-    const body = {
-      grant_type: "refresh_token",
-      client_id: this.clientID,
-      client_secret: this.clientSecret,
-      refresh_token: refreshToken,
-    };
+    this.refreshInProgress = true; // Lock the refresh process
 
     try {
+      const refreshToken = storedTokens.refresh_token || this.refreshToken;
+
+      if (!refreshToken) {
+        throw new Error("No refresh token available");
+      }
+
+      const body = {
+        grant_type: "refresh_token",
+        client_id: this.clientID,
+        client_secret: this.clientSecret,
+        refresh_token: refreshToken,
+      };
+
       const response = await axios({
         url: this.tokenUrl,
         method: "post",
@@ -252,6 +274,7 @@ export class LightspeedSDKCore {
       const tokenData = response.data;
       const expiresAt = new Date(now.getTime() + tokenData.expires_in * 1000);
 
+      // Save the new tokens
       await this.tokenStorage.setTokens({
         access_token: tokenData.access_token,
         refresh_token: tokenData.refresh_token,
@@ -262,8 +285,24 @@ export class LightspeedSDKCore {
       this.token = tokenData.access_token;
       this.tokenExpiry = expiresAt;
 
+      console.log("✅ Token refresh successful");
       return this.token;
     } catch (error) {
+      console.error("❌ Token refresh failed:", error.message);
+
+      // Check if the token was refreshed by another process
+      const updatedTokens = await this.tokenStorage.getTokens();
+      if (updatedTokens.access_token && updatedTokens.expires_at) {
+        const expiryTime = new Date(updatedTokens.expires_at);
+        if (expiryTime.getTime() - now.getTime() > bufferTime) {
+          console.log(
+            "🔄 Token was refreshed by another process. Skipping failure email."
+          );
+          return updatedTokens.access_token;
+        }
+      }
+
+      // If the token is still invalid, send the failure email
       const helpMsg =
         "\n❌ Token refresh failed. Your refresh token may be expired or revoked.\n" +
         "👉 Please re-authenticate using the SDK's CLI or obtain a new refresh token.\n" +
@@ -276,97 +315,8 @@ export class LightspeedSDKCore {
       await sendTokenRefreshFailureEmail(error, this.accountID);
 
       throw new Error(helpMsg);
-    }
-  }
-
-  // Core API request handler
-  async executeApiRequest(options, retries = 0) {
-    await this.handleRateLimit(options);
-
-    const token = await this.getToken();
-    if (!token) throw new Error("Error Fetching Token");
-
-    options.headers = {
-      Authorization: `Bearer ${token}`,
-      "Content-Type": "application/json",
-      ...options.headers,
-    };
-
-    // Centralized query param handling
-    if (options.params) {
-      const queryString = buildQueryParams(options.params);
-      if (queryString) {
-        // Remove any trailing ? or & from url
-        options.url = options.url.replace(/[?&]+$/, "");
-        options.url += (options.url.includes("?") ? "&" : "?") + queryString;
-      }
-      delete options.params; // Don't let axios try to re-encode
-    }
-
-    try {
-      const res = await axios(options);
-      this.lastResponse = res;
-
-      if (options.method === "GET") {
-        // Handle successful response with no data or empty data
-        if (!res.data || Object.keys(res.data).length === 0) {
-          return {
-            data: {},
-            next: null,
-            previous: null,
-          };
-        }
-
-        // Check if response has the expected structure but with empty arrays
-        const dataKeys = Object.keys(res.data).filter(
-          (key) => key !== "@attributes"
-        );
-        if (dataKeys.length > 0) {
-          const firstDataKey = dataKeys[0];
-          const firstDataValue = res.data[firstDataKey];
-
-          // No need to log for empty arrays - this is normal
-        }
-
-        // Handle successful response with data
-        return {
-          data: res.data,
-          next: res.data["@attributes"]?.next,
-          previous: res.data["@attributes"]?.prev,
-        };
-      } else {
-        return res.data;
-      }
-    } catch (err) {
-      // Handle 401 auth errors with automatic retry
-      if (err.response?.status === 401 && !options._authRetryAttempted) {
-        console.log("🔄 401 error - forcing token refresh and retrying...");
-
-        options._authRetryAttempted = true;
-        this.token = null;
-
-        try {
-          await this.refreshTokens();
-          return this.executeApiRequest(options, retries);
-        } catch (refreshError) {
-          console.error("Failed to refresh tokens:", refreshError.message);
-          throw refreshError;
-        }
-      }
-
-      // Handle retryable errors
-      if (this.isRetryableError(err) && retries < this.maxRetries) {
-        this.handleError(
-          `Network Error Retrying in 2 seconds...`,
-          err.message,
-          false
-        );
-        await sleep(2000);
-        return this.executeApiRequest(options, retries + 1);
-      } else {
-        // Simple error handling - let the calling method decide how to handle it
-        throw err;
-      }
+    } finally {
+      this.refreshInProgress = false; // Release the lock
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lightspeed-retail-sdk",
-  "version": "3.3.2",
+  "version": "3.3.4",
   "description": "Another unofficial Lightspeed Retail API SDK for Node.js",
   "type": "module",
   "main": "dist/index.cjs",