@intellegens/cornerstone-client 0.0.2 → 0.0.3

package/README.md

@@ -28,46 +28,76 @@ http://localhost:3000
 
 ## API reference
 
-### Config Service
+### API Service
 
-This service provides way to load configuration for a Cornerstone client application.
+This service provides way to load API configuration for a Cornerstone client application.
 
 ```ts
-import { Config } from './index.js';
-await configAPI.initialize();
+import { ApiService } from '@intellegens/cornerstone-client';
+const apiService = new ApiService();
+await apiService.initialize();
 ```
 
-#### API base URL
+or use the existing singleton instance
+
+```ts
+import { apiService } from '@intellegens/cornerstone-client';
+await apiService.initialize();
+```
+
+#### API base URL detection
 
 Detected by checking the `CORNERSTONE-API-BASEURL` response header and the `websettings.json` file.
 
-- First, it checks the response headers of the current URL for the 'CORNERSTONE-API-BASEURL ' header.
+- First, it checks the response headers of the current URL for the `CORNERSTONE-API-BASEURL` header.
 - If the header is not found, it attempts to load the `websettings.json` file and looks for an `api` field.
 - If no API base URL is found, it defaults to `undefined`.
 
+```ts
+const fetchUrl = `${await apiService.getApiUrl('/my/endpoint')}`;
+```
+
 ### Auth Service
 
 This service provides authentication methods for managing user sessions in a Cornerstone client application.
 
-#### Usage
+```ts
+import { AuthService } from './index.js';
+const authService = new AuthService();
+await authService.initialize();
+const user = authService.user;
+```
 
-To use the Auth service, first create an instance by passing the API URL. Then, you can use the login, logout, and whoAmI methods to authenticate and manage the user session.
+or use the existing singleton instance
 
 ```ts
-import { Auth } from './index.js';
-const authAPI = new Auth('https://your-api-url.com');
+import { authService } from '@intellegens/cornerstone-client';
+await authService.initialize();
+const user = authService.user;
 ```
 
 #### Methods
 
-- login(username: string, password: string): Promise<User | undefined>
+##### Who Am I
 
-This method logs the user in by sending the provided username and password to the API. If the login is successful, it returns the authenticated User object.
+```ts
+authService.whoAmI(): Promise<User | undefined>
+```
 
-- logout(): Promise<User | undefined>
+This method checks the current session and returns the User object for the logged-in user. If no user is logged in, it returns undefined.
 
-This method logs the user out by sending a request to the API to end the session. It returns undefined if the logout is successful
+##### Sign in
 
-- whoAmI(): Promise<User | undefined>
+```ts
+authService.signin(username: string, password: string): Promise<User | undefined>
+```
 
-This method checks the current session and returns the User object for the logged-in user. If no user is logged in, it returns undefined.
+This method logs the user in by sending the provided username and password to the API. If the login is successful, it returns the authenticated User object.
+
+##### Sign out
+
+```ts
+authService.logout(): Promise<User | undefined>
+```
+
+This method logs the user out by sending a request to the API to end the session. It returns undefined if the logout is successful

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intellegens/cornerstone-client",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "main": "index.js",
   "type": "module",
   "scripts": {

package/services/api/index.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Central API configuration service, fetches and exposes Cornerstone API configuration
+ *
+ * @export
+ * @class ApiService
+ */
+export declare class ApiService {
+    /**
+     * Initializes the API configuration
+     *
+     * This method calls all methods that need to be called during the API configuration phase:
+     * - Starts detection of API base URL.
+     *
+     * @async
+     * @return {Promise<void>} Resolves when initialization is complete.
+     */
+    initialize(): Promise<void>;
+    private _apiBaseUrlPromise;
+    /**
+     * If API base URL detection was completed
+     * IMPORTANT: This property is not meant to be used in normal cases - when ever possible use the .getApiUrl(relativeEndpointPath: string) method instead.
+     */
+    _apiBaseUrlDetected: boolean;
+    /**
+     * If API base URL detection was completed, this property will hold the method by which detection was performed
+     * IMPORTANT: This property is not meant to be used in normal cases - when ever possible use the .getApiUrl(relativeEndpointPath: string) method instead.
+     */
+    _apiBaseUrlDetectionMethod: string | undefined;
+    /**
+     * If API base URL detection was completed, this property will hold the detected API base URL
+     * IMPORTANT: This property is not meant to be used in normal cases - when ever possible use the .getApiUrl(relativeEndpointPath: string) method instead.
+     */
+    _apiBaseUrl: string | undefined;
+    /**
+     * If API base URL detection has failed, this property will hold the error with which it has failed
+     * IMPORTANT: This property is not meant to be used in normal cases - when ever possible use the .getApiUrl(relativeEndpointPath: string) method instead.
+     */
+    _apiBaseError: Error | undefined;
+    /**
+     * Tries detecting API base URL by multiple methods
+     *
+     * - Checks the response headers of the current URL for the `CORNERSTONE-API-BASEURL` header.
+     * - Attempts to load the `websettings.json` file and looks for an `api` field.
+     * - Defaults to `undefined`.
+     *
+     * IMPORTANT: This method is not meant to be used in normal cases - when ever possible use the .getApiUrl(relativeEndpointPath: string) method instead.
+     *
+     * @async
+     * @return {Promise<string | undefined>} Returns detected API base URL
+     * @throws {Error} Throws error if either of the detection methods fails
+     */
+    _getApiBaseUrl(): Promise<string | undefined>;
+    /**
+     * Composes a full API URL for a provided endpoint path.
+     *
+     * @async
+     * @param relativeEndpointPath Relative endpoint path
+     * @return {Promise<string | undefined>} Returns the API endpoint's URL
+     * @throws {Error} Throws error if API base URL detection fails
+     */
+    getApiUrl(relativeEndpointPath: string): Promise<string>;
+}
+/**
+ * Singleton instance of ApiService
+ */
+export declare const apiService: ApiService;

package/services/api/index.js

@@ -0,0 +1,139 @@
+/**
+ * Central API configuration service, fetches and exposes Cornerstone API configuration
+ *
+ * @export
+ * @class ApiService
+ */
+export class ApiService {
+    /**
+     * Initializes the API configuration
+     *
+     * This method calls all methods that need to be called during the API configuration phase:
+     * - Starts detection of API base URL.
+     *
+     * @async
+     * @return {Promise<void>} Resolves when initialization is complete.
+     */
+    async initialize() {
+        // (Pre)detect API base URL
+        await this._getApiBaseUrl();
+    }
+    // #region API Base URL detection
+    _apiBaseUrlPromise = undefined;
+    /**
+     * If API base URL detection was completed
+     * IMPORTANT: This property is not meant to be used in normal cases - when ever possible use the .getApiUrl(relativeEndpointPath: string) method instead.
+     */
+    _apiBaseUrlDetected = false;
+    /**
+     * If API base URL detection was completed, this property will hold the method by which detection was performed
+     * IMPORTANT: This property is not meant to be used in normal cases - when ever possible use the .getApiUrl(relativeEndpointPath: string) method instead.
+     */
+    _apiBaseUrlDetectionMethod = undefined;
+    /**
+     * If API base URL detection was completed, this property will hold the detected API base URL
+     * IMPORTANT: This property is not meant to be used in normal cases - when ever possible use the .getApiUrl(relativeEndpointPath: string) method instead.
+     */
+    _apiBaseUrl = undefined;
+    /**
+     * If API base URL detection has failed, this property will hold the error with which it has failed
+     * IMPORTANT: This property is not meant to be used in normal cases - when ever possible use the .getApiUrl(relativeEndpointPath: string) method instead.
+     */
+    _apiBaseError = undefined;
+    /**
+     * Tries detecting API base URL by multiple methods
+     *
+     * - Checks the response headers of the current URL for the `CORNERSTONE-API-BASEURL` header.
+     * - Attempts to load the `websettings.json` file and looks for an `api` field.
+     * - Defaults to `undefined`.
+     *
+     * IMPORTANT: This method is not meant to be used in normal cases - when ever possible use the .getApiUrl(relativeEndpointPath: string) method instead.
+     *
+     * @async
+     * @return {Promise<string | undefined>} Returns detected API base URL
+     * @throws {Error} Throws error if either of the detection methods fails
+     */
+    async _getApiBaseUrl() {
+        // Check if API already detected; don't reattempt detection
+        if (this._apiBaseUrlDetected)
+            return this._apiBaseUrl;
+        // Check if detection already in progress; don't allow multiple detections in parallel
+        if (this._apiBaseUrlPromise)
+            return this._apiBaseUrlPromise;
+        // Detect API base URL
+        return (this._apiBaseUrlPromise = new Promise((resolve, reject) => (async () => {
+            // Reset
+            this._apiBaseUrlDetected = false;
+            this._apiBaseUrlDetectionMethod = undefined;
+            this._apiBaseUrl = undefined;
+            this._apiBaseError = undefined;
+            // Check CORNERSTONE-API-BASEURL header for API base URL
+            try {
+                const currentUrlResponse = await fetch(window.location.href, { method: 'GET' });
+                const apiHeader = currentUrlResponse.headers.get('CORNERSTONE-API-BASEURL');
+                if (apiHeader) {
+                    this._apiBaseUrlDetected = true;
+                    this._apiBaseUrlDetectionMethod = 'GET / Header:CORNERSTONE-API-BASEURL';
+                    this._apiBaseUrl = apiHeader;
+                    this._apiBaseError = undefined;
+                    this._apiBaseUrlPromise = undefined;
+                    return resolve(this._apiBaseUrl);
+                }
+            }
+            catch (err) {
+                this._apiBaseError = err instanceof Error ? err : new Error('Failed loading API base URL from response header!');
+            }
+            // Check ./websettings.json header for API base URL
+            try {
+                const webSettingsResponse = await fetch('./websettings.json', { method: 'GET' });
+                if (webSettingsResponse.status === 404)
+                    return (this._apiBaseUrl = undefined);
+                const webSettings = await webSettingsResponse.json();
+                if (webSettings?.api) {
+                    this._apiBaseUrlDetected = true;
+                    this._apiBaseUrlDetectionMethod = 'GET websettings.json';
+                    this._apiBaseUrl = webSettings.api;
+                    this._apiBaseError = undefined;
+                    this._apiBaseUrlPromise = undefined;
+                    return resolve(this._apiBaseUrl);
+                }
+            }
+            catch (err) {
+                this._apiBaseError = err instanceof Error ? err : new Error('Failed loading API base URL from settings file!');
+            }
+            // Check if error caught during any of the detection methods
+            if (this._apiBaseError !== undefined) {
+                this._apiBaseUrlDetected = false;
+                this._apiBaseUrlDetectionMethod = undefined;
+                this._apiBaseUrl = undefined;
+                this._apiBaseUrlPromise = undefined;
+                return reject(this._apiBaseError);
+            }
+            // Default to no API found
+            this._apiBaseUrlDetected = true;
+            this._apiBaseUrlDetectionMethod = undefined;
+            this._apiBaseUrl = undefined;
+            this._apiBaseError = undefined;
+            this._apiBaseUrlPromise = undefined;
+            return resolve(this._apiBaseUrl);
+        })()));
+    }
+    /**
+     * Composes a full API URL for a provided endpoint path.
+     *
+     * @async
+     * @param relativeEndpointPath Relative endpoint path
+     * @return {Promise<string | undefined>} Returns the API endpoint's URL
+     * @throws {Error} Throws error if API base URL detection fails
+     */
+    async getApiUrl(relativeEndpointPath) {
+        const apiBaseUrl = await this._getApiBaseUrl();
+        const domain = !apiBaseUrl ? `` : apiBaseUrl?.endsWith('/') ? apiBaseUrl : `${apiBaseUrl}/`;
+        const path = !relativeEndpointPath.startsWith('/') ? relativeEndpointPath : relativeEndpointPath.substring(1);
+        return `${domain}${path}`;
+    }
+}
+/**
+ * Singleton instance of ApiService
+ */
+export const apiService = new ApiService();

package/services/auth/index.d.ts

@@ -1,46 +1,49 @@
 import { User, UserInfo } from './types';
 export { User, UserInfo };
 /**
- * Auth class is responsible for managing user authentication operations.
+ * AuthService class is responsible for managing user authentication operations.
  * It supports login, logout, and checking the current user's details.
  *
  * @export
- * @class Auth
+ * @class AuthService
  */
-export declare class Auth<TId, TUser = User<TId>> {
-    private _apiUrl;
+export declare class AuthService<TId, TUser = User<TId>> {
+    /**
+     * Holds currently authenticated user's details
+     */
     user: TUser | undefined;
     /**
-     * Creates an instance of Auth.
+     * Initializes the Authentication status by checking with the API if the current user is authenticated or not
      *
-     * @param {string} apiUrl
-     * @memberof Auth
+     * @async
+     * @return {Promise<void>} Resolves when initialization is complete.
      */
-    constructor(apiUrl: string);
+    initialize(): Promise<void>;
     /**
-     * Retrieves the current user's details if they are logged in.
+     * Checks if user is authenticated and retrieves the current user's details if they are
      *
-     * @return {Promise<TUser>} Currently logged in user
+     * @return {Promise<TUser>} Currently logged in user's details
      * @throws {Error} Error if fetch fails
-     * @memberof Auth
      */
     whoAmI(): Promise<TUser>;
     /**
-     * Logs in a user using their username and password, and retrieves the user data.
+     * Authenticates a user using their username and password, and retrieves user's details
      *
      * @param {string} username Login credentials: username
      * @param {string} password Login credentials: password
-     * @return {Promise<TUser>} Currently logged in user
+     * @return {Promise<TUser>} Currently logged in user's details
      * @throws {Error} Error if fetch fails
-     * @memberof Auth
      */
-    login(username: string, password: string): Promise<TUser>;
+    signin(username: string, password: string): Promise<TUser>;
     /**
-     * Logs out the current user and clears their authentication state.
+     * Deauthenticates current user
      *
      * @return {Promise<void>}
      * @throws {Error} Error if fetch fails
-     * @memberof Auth
      */
-    logout(): Promise<void>;
+    signout(): Promise<void>;
 }
+/**
+ * Singleton instance of AuthService
+ */
+export declare const authService: AuthService<unknown, User<unknown>>;

package/services/auth/index.js

@@ -1,32 +1,36 @@
+import { apiService } from '../api';
 /**
- * Auth class is responsible for managing user authentication operations.
+ * AuthService class is responsible for managing user authentication operations.
  * It supports login, logout, and checking the current user's details.
  *
  * @export
- * @class Auth
+ * @class AuthService
  */
-export class Auth {
-    _apiUrl;
+export class AuthService {
+    /**
+     * Holds currently authenticated user's details
+     */
     user = undefined;
     /**
-     * Creates an instance of Auth.
+     * Initializes the Authentication status by checking with the API if the current user is authenticated or not
      *
-     * @param {string} apiUrl
-     * @memberof Auth
+     * @async
+     * @return {Promise<void>} Resolves when initialization is complete.
      */
-    constructor(apiUrl) {
-        this._apiUrl = apiUrl;
+    async initialize() {
+        // Check user's authentication status
+        await this.whoAmI();
     }
     /**
-     * Retrieves the current user's details if they are logged in.
+     * Checks if user is authenticated and retrieves the current user's details if they are
      *
-     * @return {Promise<TUser>} Currently logged in user
+     * @return {Promise<TUser>} Currently logged in user's details
      * @throws {Error} Error if fetch fails
-     * @memberof Auth
      */
     async whoAmI() {
         try {
-            const response = await fetch(`${this._apiUrl}/auth/who-am-i`, { credentials: 'include' });
+            const url = await apiService.getApiUrl('/auth/whoami');
+            const response = await fetch(url, { credentials: 'include' });
             if (response.ok) {
                 const info = await response.json();
                 return (this.user = info.user);
@@ -40,17 +44,17 @@ export class Auth {
         }
     }
     /**
-     * Logs in a user using their username and password, and retrieves the user data.
+     * Authenticates a user using their username and password, and retrieves user's details
      *
      * @param {string} username Login credentials: username
      * @param {string} password Login credentials: password
-     * @return {Promise<TUser>} Currently logged in user
+     * @return {Promise<TUser>} Currently logged in user's details
      * @throws {Error} Error if fetch fails
-     * @memberof Auth
      */
-    async login(username, password) {
+    async signin(username, password) {
         try {
-            const response = await fetch(`${this._apiUrl}/auth/signin`, {
+            const url = await apiService.getApiUrl('/auth/signin');
+            const response = await fetch(url, {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json' },
                 body: JSON.stringify({ username, password }),
@@ -60,33 +64,37 @@ export class Auth {
                 return (this.user = await this.whoAmI());
             }
             else {
-                throw new Error('Failed user login');
+                throw new Error('Failed signing in');
             }
         }
         catch (error) {
-            throw error instanceof Error ? error : new Error('Failed user login');
+            throw error instanceof Error ? error : new Error('Failed signing in');
         }
     }
     /**
-     * Logs out the current user and clears their authentication state.
+     * Deauthenticates current user
      *
      * @return {Promise<void>}
      * @throws {Error} Error if fetch fails
-     * @memberof Auth
      */
-    async logout() {
+    async signout() {
         try {
-            const response = await fetch(`${this._apiUrl}/auth/logout`, { credentials: 'include' });
+            const url = await apiService.getApiUrl('/auth/signout');
+            const response = await fetch(url, { credentials: 'include' });
             if (response.ok) {
                 this.user = undefined;
                 return;
             }
             else {
-                throw new Error('Failed user logout');
+                throw new Error('Failed signing out');
             }
         }
         catch (error) {
-            throw error instanceof Error ? error : new Error('Failed user logout');
+            throw error instanceof Error ? error : new Error('Failed signing out');
         }
     }
 }
+/**
+ * Singleton instance of AuthService
+ */
+export const authService = new AuthService();

package/services/auth/types/user-info.d.ts

@@ -7,10 +7,6 @@ import { User } from './user';
  *
  * @param {TUser} user The user object containing user details.
  * @param {Date} accessTokenExpiry The date and time when the access token will expire.
- *
- * @typedef {Object} UserInfo
- * @property {TUser} user The user object.
- * @property {Date} accessTokenExpiry The expiry date of the access token.
  */
 export type UserInfo<TId, TUser = User<TId>> = {
     user: TUser;

package/services/auth/types/user.d.ts

@@ -5,10 +5,6 @@
  *
  * @param {TId} id The unique identifier for the user.
  * @param {string} email The email address associated with the user.
- *
- * @typedef {Object} User
- * @property {TId} id The unique identifier of the user.
- * @property {string} email The email address of the user.
  */
 export type User<TId> = {
     id: TId;

package/services/config/index.d.ts

@@ -1,17 +1,10 @@
 /**
- * Configuration class for managing the API
+ * Central configuration service, fetches and exposes Cornerstone configuration
  *
  * @export
- * @class Config
+ * @class ConfigService
  */
-export declare class Config {
-    /**
-     * The base URL of the API. It is undefined by default and gets populated through the initialization process.
-     *
-     * @type {(string | undefined)}
-     * @memberof Config
-     */
-    apiBaseUrl: string | undefined;
+export declare class ConfigService {
     /**
      * Initializes the configuration by detecting the API base URL.
      *
@@ -19,19 +12,36 @@ export declare class Config {
      *
      * @async
      * @return {Promise<void>} Resolves when the API base URL is detected.
-     * @memberof Config
      */
     initialize(): Promise<void>;
+    private _apiBaseUrlDetected;
+    private _apiBaseUrlDetectionMethod;
+    private _apiBaseUrl;
+    private _apiBaseError;
+    private _apiBaseUrlPromise;
     /**
      * Detects the API base URL by checking the `CORNERSTONE-API-BASEURL` header and the `websettings.json` file.
      *
-     * First, it checks the response headers of the current URL for the 'CORNERSTONE-API-BASEURL' header.
-     * If the header is not found, it attempts to load the `websettings.json` file and looks for an `api` field.
-     * If no API base URL is found, it defaults to `undefined`.
+     * - First, it checks the response headers of the current URL for the `CORNERSTONE-API-BASEURL` header.
+     * - If the header is not found, it attempts to load the `websettings.json` file and looks for an `api` field.
+     * - If no API base URL is found, it defaults to `undefined`.
      *
+     * @async
      * @return {Promise<string | undefined>} Returns the API base URL
-     * @throws {Error} Throws error if fetch fails
-     * @memberof Config
+     * @throws {Error} Throws error if either of the detection methods fails
+     */
+    _getApiBaseUrl(): Promise<string | undefined>;
+    /**
+     * Returns a full URL for a provided endpoint path.
+     *
+     * @async
+     * @param relativeEndpointPath Relative endpoint path
+     * @return {Promise<string | undefined>} Returns the API endpoint's URL
+     * @throws {Error} Throws error if API base URL detection fails
      */
-    detectApiBaseUrl(): Promise<string | undefined>;
+    getApiUrl(relativeEndpointPath: string): Promise<string>;
 }
+/**
+ * Singleton instance of ConfigService
+ */
+export declare const configService: ConfigService;

package/services/config/index.js

@@ -1,17 +1,10 @@
 /**
- * Configuration class for managing the API
+ * Central configuration service, fetches and exposes Cornerstone configuration
  *
  * @export
- * @class Config
+ * @class ConfigService
  */
-export class Config {
-    /**
-     * The base URL of the API. It is undefined by default and gets populated through the initialization process.
-     *
-     * @type {(string | undefined)}
-     * @memberof Config
-     */
-    apiBaseUrl = undefined;
+export class ConfigService {
     /**
      * Initializes the configuration by detecting the API base URL.
      *
@@ -19,51 +12,109 @@ export class Config {
      *
      * @async
      * @return {Promise<void>} Resolves when the API base URL is detected.
-     * @memberof Config
      */
     async initialize() {
-        await this.detectApiBaseUrl();
+        // (Pre)detect API base URL
+        await this._getApiBaseUrl();
     }
+    // #region API Base URL detection
+    _apiBaseUrlDetected = false;
+    _apiBaseUrlDetectionMethod = undefined;
+    _apiBaseUrl = undefined;
+    _apiBaseError = undefined;
+    _apiBaseUrlPromise = undefined;
     /**
      * Detects the API base URL by checking the `CORNERSTONE-API-BASEURL` header and the `websettings.json` file.
      *
-     * First, it checks the response headers of the current URL for the 'CORNERSTONE-API-BASEURL' header.
-     * If the header is not found, it attempts to load the `websettings.json` file and looks for an `api` field.
-     * If no API base URL is found, it defaults to `undefined`.
+     * - First, it checks the response headers of the current URL for the `CORNERSTONE-API-BASEURL` header.
+     * - If the header is not found, it attempts to load the `websettings.json` file and looks for an `api` field.
+     * - If no API base URL is found, it defaults to `undefined`.
      *
+     * @async
      * @return {Promise<string | undefined>} Returns the API base URL
-     * @throws {Error} Throws error if fetch fails
-     * @memberof Config
+     * @throws {Error} Throws error if either of the detection methods fails
      */
-    async detectApiBaseUrl() {
-        // Initialize a globally tracked error
-        let error = undefined;
-        // Check CORNERSTONE-API-BASEURL header for API base URL
-        try {
-            const currentUrlResponse = await fetch(window.location.href, { method: 'GET' });
-            const apiHeader = currentUrlResponse.headers.get('CORNERSTONE-API-BASEURL');
-            if (apiHeader)
-                return (this.apiBaseUrl = apiHeader);
-        }
-        catch (err) {
-            error = err instanceof Error ? err : new Error('Failed loading configuration from response header!');
-        }
-        // Check ./websettings.json header for API base URL
-        try {
-            const webSettingsResponse = await fetch('./websettings.json', { method: 'GET' });
-            if (webSettingsResponse.status === 404)
-                return (this.apiBaseUrl = undefined);
-            const webSettings = await webSettingsResponse.json();
-            if (webSettings?.api)
-                return (this.apiBaseUrl = webSettings.api);
-        }
-        catch (err) {
-            error = err instanceof Error ? err : new Error('Failed loading configuration from settings file!');
-        }
-        // Check if error caught
-        if (error !== undefined)
-            throw error;
-        // Default to no API found
-        return (this.apiBaseUrl = undefined);
+    async _getApiBaseUrl() {
+        // Check if API already detected; don't reattempt detection
+        if (this._apiBaseUrlDetected)
+            return this._apiBaseUrl;
+        // Check if detection already in progress; don't allow multiple detections in parallel
+        if (this._apiBaseUrlPromise)
+            return this._apiBaseUrlPromise;
+        // Detect API base URL
+        return (this._apiBaseUrlPromise = new Promise((resolve, reject) => (async () => {
+            // Reset
+            this._apiBaseUrlDetected = false;
+            this._apiBaseUrlDetectionMethod = undefined;
+            this._apiBaseUrl = undefined;
+            this._apiBaseError = undefined;
+            // Check CORNERSTONE-API-BASEURL header for API base URL
+            try {
+                const currentUrlResponse = await fetch(window.location.href, { method: 'GET' });
+                const apiHeader = currentUrlResponse.headers.get('CORNERSTONE-API-BASEURL');
+                if (apiHeader) {
+                    this._apiBaseUrlDetected = true;
+                    this._apiBaseUrlDetectionMethod = 'GET / Header:CORNERSTONE-API-BASEURL';
+                    this._apiBaseUrl = apiHeader;
+                    this._apiBaseError = undefined;
+                    this._apiBaseUrlPromise = undefined;
+                    return resolve(this._apiBaseUrl);
+                }
+            }
+            catch (err) {
+                this._apiBaseError = err instanceof Error ? err : new Error('Failed loading configuration from response header!');
+            }
+            // Check ./websettings.json header for API base URL
+            try {
+                const webSettingsResponse = await fetch('./websettings.json', { method: 'GET' });
+                if (webSettingsResponse.status === 404)
+                    return (this._apiBaseUrl = undefined);
+                const webSettings = await webSettingsResponse.json();
+                if (webSettings?.api) {
+                    this._apiBaseUrlDetected = true;
+                    this._apiBaseUrlDetectionMethod = 'GET websettings.json';
+                    this._apiBaseUrl = webSettings.api;
+                    this._apiBaseError = undefined;
+                    this._apiBaseUrlPromise = undefined;
+                    return resolve(this._apiBaseUrl);
+                }
+            }
+            catch (err) {
+                this._apiBaseError = err instanceof Error ? err : new Error('Failed loading configuration from settings file!');
+            }
+            // Check if error caught during any of the detection methods
+            if (this._apiBaseError !== undefined) {
+                this._apiBaseUrlDetected = false;
+                this._apiBaseUrlDetectionMethod = undefined;
+                this._apiBaseUrl = undefined;
+                this._apiBaseUrlPromise = undefined;
+                return reject(this._apiBaseError);
+            }
+            // Default to no API found
+            this._apiBaseUrlDetected = true;
+            this._apiBaseUrlDetectionMethod = undefined;
+            this._apiBaseUrl = undefined;
+            this._apiBaseError = undefined;
+            this._apiBaseUrlPromise = undefined;
+            return resolve(this._apiBaseUrl);
+        })()));
+    }
+    /**
+     * Returns a full URL for a provided endpoint path.
+     *
+     * @async
+     * @param relativeEndpointPath Relative endpoint path
+     * @return {Promise<string | undefined>} Returns the API endpoint's URL
+     * @throws {Error} Throws error if API base URL detection fails
+     */
+    async getApiUrl(relativeEndpointPath) {
+        const apiBaseUrl = await this._getApiBaseUrl();
+        const domain = !apiBaseUrl ? `` : apiBaseUrl?.endsWith('/') ? apiBaseUrl : `${apiBaseUrl}/`;
+        const path = !relativeEndpointPath.startsWith('/') ? relativeEndpointPath : relativeEndpointPath.substring(1);
+        return `${domain}${path}`;
     }
 }
+/**
+ * Singleton instance of ConfigService
+ */
+export const configService = new ConfigService();

package/services/index.d.ts

@@ -1,2 +1,2 @@
-export * from './config';
+export * from './api';
 export * from './auth';

package/services/index.js

@@ -1,2 +1,2 @@
-export * from './config';
+export * from './api';
 export * from './auth';