@gandalan/weblibs 1.3.5 → 1.3.7

package/api/RESTClient.js

@@ -70,6 +70,7 @@ export class RESTClient
                 fileName = response.headers["content-disposition"].split(";")[1];
                 fileName = fileName.replace("filename=", "").trim();
             }
+
             this.lastError = "";
             return { data: response.data, filename: fileName, contentType: "application/pdf" };
         }
@@ -92,6 +93,7 @@ export class RESTClient
         {
             this.handleError(error);
         }
+
         return response;
     }
 

package/api/authUtils.js

@@ -51,14 +51,17 @@ export async function initIDAS(appToken)
     {
         mandantGuid = urlParams.get("m");
     }
+
     if (urlParams.has("a"))
     {
         apiBaseurl = urlParams.get("a");
     }
+
     if (urlParams.has("j"))
     {
         jwtToken = urlParams.get("j");
     }
+
     if (urlParams.has("t"))
     {
         jwtRefreshToken = urlParams.get("t");
@@ -87,7 +90,7 @@ export async function initIDAS(appToken)
 }
 
 /**
- * sets up authentication 
+ * sets up authentication
  *
  * @export
  * @async
@@ -121,6 +124,7 @@ export async function setup(settings)
             currentRefreshToken = refreshToken;
             startRefreshTimer(settings);
         }
+
         let mandantGuid = decoded["mandantGuid"] || "";
         if (mandantGuid)
         {

package/api/fluentApi.js

@@ -3,13 +3,13 @@ import { restClient } from "./fluentRestClient";
 /**
  * @typedef {Object} FluentApi
  * @property {string} baseUrl - The base URL for API requests.
- * @property {FluentAuthManager} authManager - The authentication manager.
+ * @property {import("./fluentAuthManager").FluentAuthManager} authManager - The authentication manager.
  * @property {function(string) : FluentApi} useBaseUrl - Sets the base URL for API requests and returns the FluentApi object.
- * @property {function(FluentAuthManager) : FluentApi} useAuthManager - Sets the auth manager and returns the FluentApi object.
- * @property {function(string) : object|Array<any>} get - Async function to perform GET requests.
- * @property {function(string, object|null) : object|Array<any>} put - Async function to perform PUT requests with a payload.
- * @property {function(string, object|null) : object|Array<any>} post - Async function to perform POST requests with a payload.
- * @property {function(string) : object|Array<any>} delete - Async function to perform DELETE requests.
+ * @property {function(fluentAuthManager) : FluentApi} useAuthManager - Sets the auth manager and returns the FluentApi object.
+ * @property {function(string) : Promise<object|Array<any>>} get - Async function to perform GET requests.
+ * @property {function(string, object|null) : Promise<object|Array<any>>} put - Async function to perform PUT requests with a payload.
+ * @property {function(string, object|null) : Promise<object|Array<any>>} post - Async function to perform POST requests with a payload.
+ * @property {function(string) : Promise<object|Array<any>>} delete - Async function to perform DELETE requests.
  */
 
 /**
@@ -102,7 +102,7 @@ export function createApi() {
          * Creates the REST client instance with the current configuration.
          *
          * @private
-         * @returns {FluentRestClient}
+         * @returns {import("./fluentRestClient").FluentRESTClient}
          */
         createRestClient() {
             return restClient().useBaseUrl(this.baseUrl).useToken(this.authManager?.token);

package/api/fluentAuthManager.js

@@ -20,6 +20,8 @@ import { popRefreshTokenFromUrl } from "./fluentAuthUtils";
  * @property {function} tryRefreshToken - Attempts to refresh the authentication token using the refresh token.
  * @property {function} updateUserSession - Updates the user session with the new token.
  * @property {function} redirectToLogin - Redirects to the login page.
+ * @property {function(string) : boolean} hasRight - Checks if the user has the specific right.
+ * @property {function(string) : boolean} hasRole - Checks if the user has the specific role.
  */
 
 /**
@@ -91,8 +93,9 @@ export function createAuthManager() {
          * @private
          */
         async ensureAuthenticated() {
-            if (this.token && isTokenValid(this.token))
+            if (this.token && isTokenValid(this.token)) {
                 return;
+            }
 
             try {
                 await this.authenticate();
@@ -112,11 +115,13 @@ export function createAuthManager() {
         async authenticate() { // benutzt bei existierendem JWT oder RefreshToken, wenn keins vorhanden ERROR
             console.log("authenticating:", this.token ? `token set, exp: ${jwtDecode(this.token).exp - (Date.now() / 1000)}` : "no token,", this.refreshToken, this.appToken);
 
-            if (this.token && isTokenValid(this.token))
+            if (this.token && isTokenValid(this.token)) {
                 return;
+            }
 
-            if (this.token && !this.refreshToken)
+            if (this.token && !this.refreshToken) {
                 this.refreshToken = getRefreshToken(this.token);
+            }
 
             if (!this.refreshToken) {
                 throw new Error("not authenticated");
@@ -161,6 +166,7 @@ export function createAuthManager() {
                 this.redirectToLogin();
                 throw "Redirect to login...";
             }
+
             return this;
         },
 
@@ -178,6 +184,7 @@ export function createAuthManager() {
                 this.updateUserSession((await res.json()));
                 return;
             }
+
             throw new Error("not authenticated");
         },
 
@@ -279,15 +286,17 @@ export function getRefreshToken(token) {
  * check if the token is still valid
  * - checks the expiry date and the JWT_SAFE_RENEWAL buffer
  *
- *  @export
+ * @export
  * @param {string} token
  * @returns {boolean}
  */
 export function isTokenValid(token) {
     try {
         const decoded = jwtDecode(token);
-        if (!decoded || !decoded.exp)
+        if (!decoded || !decoded.exp) {
             throw new Error("Invalid token");
+        }
+
         return (decoded.exp - JWT_SAFE_RENEWAL > Date.now() / 1000);
     }
     catch {

package/api/fluentAuthUtils.js

@@ -11,5 +11,6 @@ export function popRefreshTokenFromUrl() {
         window.history.replaceState({}, document.title, url);
         return refreshToken;
     }
+
     return null;
 }

package/api/fluentEnvUtils.js

@@ -36,5 +36,6 @@ export async function fetchEnvConfig(envConfig = "") {
         const data = await r.json();
         envConfigs[envConfig] = data;
     }
+
     return envConfigs[envConfig];
 }

package/api/fluentRestClient.js

@@ -51,8 +51,10 @@ export function restClient() {
             const finalUrl = `${this.baseUrl}${url}`;
             const headers = this.token ? { "Authorization": `Bearer ${this.token}` } : {};
             const res = await fetch(finalUrl, { method: "GET", headers });
-            if (res.ok)
+            if (res.ok) {
                 return await this._parseReponse(res);
+            }
+
             throw new Error(`GET ${finalUrl} failed: ${res.status} ${res.statusText}`);
         },
 
@@ -68,8 +70,10 @@ export function restClient() {
             const finalUrl = `${this.baseUrl}${url}`;
             const headers = this.token ? { "Authorization": `Bearer ${this.token}`, "Content-Type": "application/json" } : {};
             const res = await fetch(finalUrl, { method: "PUT", body: JSON.stringify(payload), headers });
-            if (res.ok)
+            if (res.ok) {
                 return await this._parseReponse(res);
+            }
+
             throw new Error(`PUT ${finalUrl} failed: ${res.status} ${res.statusText}`);
         },
 
@@ -95,8 +99,10 @@ export function restClient() {
             }
 
             const res = await fetch(finalUrl, { method: "POST", body, headers });
-            if (res.ok)
+            if (res.ok) {
                 return await this._parseReponse(res);
+            }
+
             throw new Error(`POST ${finalUrl} failed: ${res.status} ${res.statusText}`);
         },
 
@@ -111,18 +117,26 @@ export function restClient() {
             const finalUrl = `${this.baseUrl}${url}`;
             const headers = this.token ? { "Authorization": `Bearer ${this.token}` } : {};
             const res = await fetch(finalUrl, { method: "DELETE", headers });
-            if (res.ok)
+            if (res.ok) {
                 return await this._parseReponse(res);
+            }
+
             throw new Error(`DELETE ${finalUrl} failed: ${res.status} ${res.statusText}`);
         },
 
         async _parseReponse(res) {
             // check if repsonse is JSON, then return parsed JSON, otherwise return text
             const contentType = res.headers.get("content-type");
-            if (contentType && contentType.includes("application/json"))
-                return await res.json();
-            if (contentType && (contentType.includes("image") || contentType.includes("application/pdf")))
-                return await res.blob();
+            if (contentType) {
+                if (contentType.includes("application/json")) {
+                    return await res.json();
+                }
+
+                if (contentType.includes("image") || contentType.includes("application/pdf")) {
+                    return await res.blob();
+                }
+            }
+
             return await res.text();
         }
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gandalan/weblibs",
-  "version": "1.3.5",
+  "version": "1.3.7",
   "description": "WebLibs for Gandalan JS/TS/Svelte projects",
   "keywords": [
     "gandalan"