@intellegens/cornerstone-client 0.0.5 → 0.0.6

package/README.md

@@ -33,16 +33,16 @@ http://localhost:3000
 This service provides way to load API configuration for a Cornerstone client application.
 
 ```ts
-import { ApiService } from '@intellegens/cornerstone-client';
-const apiService = new ApiService();
-await apiService.initialize();
+import { ApiInitializationService } from '@intellegens/cornerstone-client';
+const apiInitializationService = new ApiInitializationService();
+await apiInitializationService.initialize();
 ```
 
 or use the existing singleton instance
 
 ```ts
-import { apiService } from '@intellegens/cornerstone-client';
-await apiService.initialize();
+import { apiInitializationService } from '@intellegens/cornerstone-client';
+await apiInitializationService.initialize();
 ```
 
 #### API base URL detection
@@ -54,7 +54,7 @@ Detected by checking the `CORNERSTONE-API-BASEURL` response header and the `webs
 - If no API base URL is found, it defaults to `undefined`.
 
 ```ts
-const fetchUrl = `${await apiService.getApiUrl('/my/endpoint')}`;
+const fetchUrl = `${await apiInitializationService.getApiUrl('/my/endpoint')}`;
 ```
 
 ### Auth Service
@@ -68,14 +68,6 @@ await authService.initialize();
 const user = authService.user;
 ```
 
-or use the existing singleton instance
-
-```ts
-import { authService } from '@intellegens/cornerstone-client';
-await authService.initialize();
-const user = authService.user;
-```
-
 #### Methods
 
 ##### Who Am I

package/package.json

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

package/services/api/client/crud/index.d.ts

@@ -0,0 +1,9 @@
+import { ApiReadControllerClient } from '../read';
+/**
+ * Generic API client for consuming any Cornerstone ReadController
+ *
+ * @export
+ * @class ApiService
+ */
+export declare class ApiCrudControllerClient<TDto> extends ApiReadControllerClient<TDto> {
+}

package/services/api/client/crud/index.js

@@ -0,0 +1,9 @@
+import { ApiReadControllerClient } from '../read';
+/**
+ * Generic API client for consuming any Cornerstone ReadController
+ *
+ * @export
+ * @class ApiService
+ */
+export class ApiCrudControllerClient extends ApiReadControllerClient {
+}

package/services/api/client/index.d.ts

@@ -0,0 +1,2 @@
+export * from './read';
+export * from './crud';

package/services/api/client/index.js

@@ -0,0 +1,2 @@
+export * from './read';
+export * from './crud';

package/services/api/client/read/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generic API client for consuming any Cornerstone ReadController
+ *
+ * @export
+ * @class ApiService
+ */
+export declare class ApiReadControllerClient<TDto> {
+}

package/services/api/client/read/index.js

@@ -0,0 +1,8 @@
+/**
+ * Generic API client for consuming any Cornerstone ReadController
+ *
+ * @export
+ * @class ApiService
+ */
+export class ApiReadControllerClient {
+}

package/services/api/detection/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/detection/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/api/index.d.ts

@@ -1,66 +1,2 @@
-/**
- * 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;
+export * from './initialization';
+export * from './client';

package/services/api/index.js

@@ -1,139 +1,2 @@
-/**
- * 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();
+export * from './initialization';
+export * from './client';

package/services/api/initialization/index.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Central API configuration service, fetches and exposes Cornerstone API configuration
+ *
+ * @export
+ * @class ApiInitializationService
+ */
+export declare class ApiInitializationService {
+    /**
+     * 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 ApiInitializationService
+ */
+export declare const apiInitializationService: ApiInitializationService;

package/services/api/initialization/index.js

@@ -0,0 +1,139 @@
+/**
+ * Central API configuration service, fetches and exposes Cornerstone API configuration
+ *
+ * @export
+ * @class ApiInitializationService
+ */
+export class ApiInitializationService {
+    /**
+     * 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 ApiInitializationService
+ */
+export const apiInitializationService = new ApiInitializationService();

package/services/auth/index.d.ts

@@ -25,7 +25,7 @@ export declare class AuthService<TId, TUser = User<TId>> {
      * @return {Promise<TUser>} Currently logged in user's details
      * @throws {Error} Error if fetch fails
      */
-    whoAmI(): Promise<TUser>;
+    whoAmI(): Promise<TUser | undefined>;
     /**
      * Authenticates a user using their username and password, and retrieves user's details
      *
@@ -42,8 +42,9 @@ export declare class AuthService<TId, TUser = User<TId>> {
      * @throws {Error} Error if fetch fails
      */
     signout(): Promise<void>;
+    /**
+     * If any API response returns an "Unauthenticated" response, call this method
+     * to update local authentication state to unauthenticated
+     */
+    _handleResponse401(): void;
 }
-/**
- * Singleton instance of AuthService
- */
-export declare const authService: AuthService<unknown, User<unknown>>;

package/services/auth/index.js

@@ -1,4 +1,4 @@
-import { apiService } from '../api';
+import { apiInitializationService } from '../api';
 /**
  * AuthService class is responsible for managing user authentication operations.
  * It supports login, logout, and checking the current user's details.
@@ -29,13 +29,17 @@ export class AuthService {
      */
     async whoAmI() {
         try {
-            const url = await apiService.getApiUrl('/auth/whoami');
+            const url = await apiInitializationService.getApiUrl('/auth/whoami');
             const response = await fetch(url, { credentials: 'include' });
             if (response.ok) {
                 const info = await response.json();
                 return (this.user = info.user);
             }
+            else if (response.status === 401) {
+                return (this.user = undefined);
+            }
             else {
+                this.user = undefined;
                 throw new Error('Failed checking authentication status');
             }
         }
@@ -53,7 +57,7 @@ export class AuthService {
      */
     async signin(username, password) {
         try {
-            const url = await apiService.getApiUrl('/auth/signin');
+            const url = await apiInitializationService.getApiUrl('/auth/signin');
             const response = await fetch(url, {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json' },
@@ -61,7 +65,13 @@ export class AuthService {
                 credentials: 'include',
             });
             if (response.ok) {
-                return (this.user = await this.whoAmI());
+                const user = await this.whoAmI();
+                if (user !== undefined) {
+                    return (this.user = user);
+                }
+                else {
+                    throw new Error('Failed signing in');
+                }
             }
             else {
                 throw new Error('Failed signing in');
@@ -79,7 +89,7 @@ export class AuthService {
      */
     async signout() {
         try {
-            const url = await apiService.getApiUrl('/auth/signout');
+            const url = await apiInitializationService.getApiUrl('/auth/signout');
             const response = await fetch(url, { credentials: 'include' });
             if (response.ok) {
                 this.user = undefined;
@@ -93,8 +103,11 @@ export class AuthService {
             throw error instanceof Error ? error : new Error('Failed signing out');
         }
     }
+    /**
+     * If any API response returns an "Unauthenticated" response, call this method
+     * to update local authentication state to unauthenticated
+     */
+    _handleResponse401() {
+        this.user = undefined;
+    }
 }
-/**
- * Singleton instance of AuthService
- */
-export const authService = new AuthService();