@gandalan/weblibs 1.5.11 → 1.5.13

package/README.md

@@ -8,6 +8,7 @@ Example:
 import { fetchEnvConfig, fluentApi, fluentIdasAuthManager } from '@gandalan/weblibs';
 
 async function initializeAuthAndApi() {
+    const serviceName = 'myService'
     const appToken = 'your-app-token';
     const envConfig = await fetchEnvConfig('dev'); // Replace 'dev' with your desired environment
 
@@ -16,8 +17,8 @@ async function initializeAuthAndApi() {
         return; // init() has redirected to login.
     }
 
-    globalThis.idas = fluentApi(envConfig.idas, authManager);   // IDAS-API instance
-    globalThis.api = fluentApi("/api/", authManager);           // Local API instance
+    globalThis.idas = fluentApi(envConfig.idas, authManager, serviceName);   // IDAS-API instance
+    globalThis.api = fluentApi("/api/", authManager, serviceName);           // Local API instance
 }
 ```
 

package/api/fluentApi.js

@@ -4,8 +4,10 @@ import { restClient } from "./fluentRestClient";
  * @typedef {Object} FluentApi
  * @property {string} baseUrl - The base URL for API requests.
  * @property {import("./fluentAuthManager").FluentAuthManager} authManager - The authentication manager.
+ * @property {string} serviceName - The name of the service using this API.
  * @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) : FluentApi} useServiceName - Sets the service name 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.
@@ -21,6 +23,7 @@ export function createApi() {
     return {
         authManager: {},
         baseUrl: "",
+        serviceName: "unknownService",
 
         /**
          * Sets the base URL for API requests.
@@ -44,6 +47,17 @@ export function createApi() {
             return this;
         },
 
+        /**
+         * Sets the service name for this API client.
+         *
+         * @param {string} name - The name of the service using this API.
+         * @return {FluentApi}
+         */
+        useServiceName(name) {
+            this.serviceName = name ?? this.serviceName;
+            return this;
+        },
+
         /**
           * Sends a GET request, ensuring authentication if needed.
           *
@@ -105,7 +119,10 @@ export function createApi() {
          * @returns {import("./fluentRestClient").FluentRESTClient}
          */
         createRestClient() {
-            return restClient().useBaseUrl(this.baseUrl).useToken(this.authManager?.token);
+            return restClient()
+                .useBaseUrl(this.baseUrl)
+                .useToken(this.authManager?.token)
+                .useUserAgent(`gandalan/weblibs-${this.serviceName}`);
         },
 
         /**
@@ -129,16 +146,18 @@ export function createApi() {
  *
  * - Requests will be sent to the url provided.
  * - Example usage:
- *   const api = fluentApi("https://jsonplaceholder.typicode.com/todos/", null);
+ *   const api = fluentApi("https://jsonplaceholder.typicode.com/todos/", null, "myService");
  *   api.get("1"); // Sends a GET request to https://jsonplaceholder.typicode.com/todos/1.
  *
  * @export
  * @param {string} url - The base URL for API requests.
  * @param {import("./fluentAuthManager").FluentAuthManager} authManager - The authentication manager instance.
+ * @param {string} serviceName - The name of the service using this API.
  * @return {FluentApi} Configured API instance for local use.
  */
-export function fluentApi(url, authManager) {
+export function fluentApi(url, authManager, serviceName) {
     return createApi()
         .useAuthManager(authManager)
-        .useBaseUrl(url);
+        .useBaseUrl(url)
+        .useServiceName(serviceName);
 }

package/api/fluentRestClient.js

@@ -4,6 +4,7 @@
  * @property {string} token - The JWT token for authorization.
  * @property {function(string) : FluentRESTClient} useBaseUrl - Function to set the base URL and return the FluentApi object.
  * @property {function(string) : FluentRESTClient} useToken - Function to set the JWT token and return the FluentApi object.
+ * @property {function(string) : FluentRESTClient} useUserAgent - Function to set the user agent and return the FluentApi object.
  * @property {function(string) : object|Array<any>} get - Async function to perform GET requests.
  * @property {function(string, object) : object|Array<any>} put - Async function to perform PUT requests with a payload.
  * @property {function(string, object|FormData) : object|Array<any>} post - Async function to perform POST requests with a payload.
@@ -18,6 +19,7 @@ export function restClient() {
     return {
         baseUrl: "",
         token: "",
+        userAgent: "",
 
         /**
          * set the base URL for all requests
@@ -39,6 +41,16 @@ export function restClient() {
             this.token = jwtToken; return this;
         },
 
+        /**
+         * set the user agent for all requests
+         *
+         * @param {string} [userAgent=""]
+         * @returns {FluentRESTClient}
+         */
+        useUserAgent(userAgent = "") {
+            this.userAgent = userAgent; return this;
+        },
+
         /**
          * GET request to the specified URL
          *
@@ -49,7 +61,7 @@ export function restClient() {
          */
         async get(url = "", auth = true) {
             const finalUrl = `${this.baseUrl}${url}`;
-            const headers = this.token ? { "Authorization": `Bearer ${this.token}` } : {};
+            const headers = this._createHeaders();
             const res = await fetch(finalUrl, { method: "GET", headers });
             if (res.ok) {
                 return await this._parseReponse(res);
@@ -68,7 +80,7 @@ export function restClient() {
          */
         async put(url = "", payload = {}) {
             const finalUrl = `${this.baseUrl}${url}`;
-            const headers = this.token ? { "Authorization": `Bearer ${this.token}`, "Content-Type": "application/json" } : {};
+            const headers = this._createHeaders("application/json");
             const res = await fetch(finalUrl, { method: "PUT", body: JSON.stringify(payload), headers });
             if (res.ok) {
                 return await this._parseReponse(res);
@@ -87,15 +99,16 @@ export function restClient() {
          */
         async post(url = "", payload = {}) {
             const finalUrl = `${this.baseUrl}${url}`;
-            const headers = this.token ? { "Authorization": `Bearer ${this.token}` } : {};
+            let headers;
 
             // Determine the body and headers based on the payload type
             let body;
             if (payload instanceof FormData) {
+                headers = this._createHeaders();
                 body = payload;
             } else {
+                headers = this._createHeaders("application/json");
                 body = JSON.stringify(payload);
-                headers["Content-Type"] = "application/json";
             }
 
             const res = await fetch(finalUrl, { method: "POST", body, headers });
@@ -115,7 +128,7 @@ export function restClient() {
          */
         async delete(url = "") {
             const finalUrl = `${this.baseUrl}${url}`;
-            const headers = this.token ? { "Authorization": `Bearer ${this.token}` } : {};
+            const headers = this._createHeaders();
             const res = await fetch(finalUrl, { method: "DELETE", headers });
             if (res.ok) {
                 return await this._parseReponse(res);
@@ -124,6 +137,14 @@ export function restClient() {
             throw new Error(`DELETE ${finalUrl} failed: ${res.status} ${res.statusText}`);
         },
 
+        _createHeaders(contentType) {
+            return new Headers({
+                ...(contentType && { "Content-Type": contentType }),
+                ...(this.token && { "Authorization": `Bearer ${this.token}` }),
+                ...(this.userAgent && { "User-Agent": this.userAgent })
+            });
+        },
+
         async _parseReponse(res) {
             // check if repsonse is JSON, then return parsed JSON, otherwise return text
             const contentType = res.headers.get("content-type");

package/package.json

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