@intellegens/cornerstone-client 0.0.18 → 0.0.19

package/data/auth/User/index.d.ts

@@ -9,7 +9,7 @@ import { Claim } from "../../../data";
  * @param {Claim[]} claims The claims associated with the user.
  */
 export type User<TId> = {
-    id: TId;
+    id: TId | undefined;
     email: string;
     claims: Claim[];
 };

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@intellegens/cornerstone-client",
-  "version": "0.0.18",
+  "version": "0.0.19",
   "main": "index.js",
   "type": "module",
   "scripts": {
+    "clean": "node -e \"require('fs-extra').emptyDir('./dist');\"",
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "npm run transpile-types && tsc && tsc-alias",
+    "build": "npm run clean && npm run transpile-types && tsc && tsc-alias",
     "demo": "npm run build && npx vite build && npx tsx ./demo",
     "transpile-types": "cd ../utils/cli && npm run cli zod-gen -- --input '../../client/src/data/_jsonschema' --output '../../client/src/data/_generated'"
   },
@@ -19,6 +20,7 @@
     "eslint": "^9.21.0",
     "eslint-config-prettier": "^10.0.1",
     "express": "^4.21.2",
+    "fs-extra": "^11.3.0",
     "globals": "^16.0.0",
     "prettier": "^3.5.2",
     "tsc-alias": "^1.8.11",

package/services/api/index.d.ts

@@ -1,4 +1,4 @@
-export * from './ApiCrudControllerClient';
 export * from './ApiInitializationService';
 export * from './ApiReadControllerClient';
+export * from './ApiCrudControllerClient';
 export * from './UserManagementControllerClient';

package/services/api/index.js

@@ -1,4 +1,4 @@
-export * from './ApiCrudControllerClient';
 export * from './ApiInitializationService';
 export * from './ApiReadControllerClient';
+export * from './ApiCrudControllerClient';
 export * from './UserManagementControllerClient';

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

@@ -1,29 +0,0 @@
-import { ApiReadControllerClient } from '../../..';
-/**
- * Generic API client for consuming any Cornerstone CrudController
- *
- * @export
- * @class ApiReadControllerClient
- * @template TKey - Type of the entity key (e.g., number, string, GUID, etc.)
- * @template TDto - Data Transfer Object representing the entity
- */
-export declare class ApiCrudControllerClient<TKey, TDto> extends ApiReadControllerClient<TKey, TDto> {
-    /**
-     * Creates a new entity.
-     * @param dto - Insert request DTO
-     * @returns The created entity DTO
-     */
-    create(dto: TDto): Promise<TDto>;
-    /**
-     * Updates an existing entity.
-     * @param id - The ID of the entity to update
-     * @param dto - Update request DTO
-     * @returns The updated entity DTO
-     */
-    update(id: TKey, dto: TDto): Promise<TDto>;
-    /**
-     * Deletes an entity by ID.
-     * @param id - The ID of the entity to delete
-     */
-    delete(id: TKey): Promise<void>;
-}

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

@@ -1,74 +0,0 @@
-import { apiInitializationService, ApiReadControllerClient } from '../../..';
-/**
- * Generic API client for consuming any Cornerstone CrudController
- *
- * @export
- * @class ApiReadControllerClient
- * @template TKey - Type of the entity key (e.g., number, string, GUID, etc.)
- * @template TDto - Data Transfer Object representing the entity
- */
-export class ApiCrudControllerClient extends ApiReadControllerClient {
-    /**
-     * Creates a new entity.
-     * @param dto - Insert request DTO
-     * @returns The created entity DTO
-     */
-    async create(dto) {
-        try {
-            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/Create`);
-            const response = await fetch(url, {
-                method: 'POST',
-                headers: { 'Content-Type': 'application/json' },
-                body: JSON.stringify(dto),
-                credentials: 'include',
-            });
-            if (!response.ok)
-                throw new Error('Failed to create record');
-            return response.json();
-        }
-        catch (err) {
-            throw err instanceof Error ? err : new Error('Unknown error creating record');
-        }
-    }
-    /**
-     * Updates an existing entity.
-     * @param id - The ID of the entity to update
-     * @param dto - Update request DTO
-     * @returns The updated entity DTO
-     */
-    async update(id, dto) {
-        try {
-            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/Update?id=${encodeURIComponent(String(id))}`);
-            const response = await fetch(url, {
-                method: 'PUT',
-                headers: { 'Content-Type': 'application/json' },
-                body: JSON.stringify(dto),
-                credentials: 'include',
-            });
-            if (!response.ok)
-                throw new Error('Failed to update record');
-            return response.json();
-        }
-        catch (err) {
-            throw err instanceof Error ? err : new Error('Unknown error updating record');
-        }
-    }
-    /**
-     * Deletes an entity by ID.
-     * @param id - The ID of the entity to delete
-     */
-    async delete(id) {
-        try {
-            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/Delete?id=${encodeURIComponent(String(id))}`);
-            const response = await fetch(url, {
-                method: 'DELETE',
-                credentials: 'include',
-            });
-            if (!response.ok)
-                throw new Error('Failed to delete record');
-        }
-        catch (err) {
-            throw err instanceof Error ? err : new Error('Unknown error deleting record');
-        }
-    }
-}

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

@@ -1,34 +0,0 @@
-import { IIdentifiable, ReadSelectedDefinition } from '../../../../data';
-/**
- * Generic API client for consuming any Cornerstone ReadController
- *
- * @export
- * @class ApiReadControllerClient
- * @template TKey - Type of the entity key (e.g., number, string, GUID, etc.)
- * @template TDto - Data Transfer Object representing the entity
- */
-export declare class ApiReadControllerClient<TKey, TDto = IIdentifiable<TKey>> {
-    protected readonly baseControllerPath: string;
-    /**
-     * Constructor
-     * @param baseControllerPath Base path to API controller
-     */
-    constructor(baseControllerPath: string);
-    /**
-     * Fetches selected entities based on a filter definition.
-     * @param {any} definition - The filter definition object
-     * @returns {Promise<TDto[]>} List of entities that match the selection criteria
-     */
-    readSelected(definition: ReadSelectedDefinition): Promise<TDto[]>;
-    /**
-     * Fetches a single entity by its ID.
-     * @param {TKey} id - The ID of the entity
-     * @returns {Promise<TDto | undefined>} The requested entity
-     */
-    readSingle(id: TKey): Promise<TDto>;
-    /**
-     * Fetches all entities from the read controller.
-     * @returns {Promise<TDto[]>} List of all entities
-     */
-    readAll(): Promise<TDto[]>;
-}

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

@@ -1,74 +0,0 @@
-import { apiInitializationService } from '../../..';
-/**
- * Generic API client for consuming any Cornerstone ReadController
- *
- * @export
- * @class ApiReadControllerClient
- * @template TKey - Type of the entity key (e.g., number, string, GUID, etc.)
- * @template TDto - Data Transfer Object representing the entity
- */
-export class ApiReadControllerClient {
-    baseControllerPath;
-    /**
-     * Constructor
-     * @param baseControllerPath Base path to API controller
-     */
-    constructor(baseControllerPath) {
-        this.baseControllerPath = baseControllerPath;
-    }
-    /**
-     * Fetches selected entities based on a filter definition.
-     * @param {any} definition - The filter definition object
-     * @returns {Promise<TDto[]>} List of entities that match the selection criteria
-     */
-    async readSelected(definition) {
-        try {
-            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/ReadSelected`);
-            const response = await fetch(url, {
-                method: 'POST',
-                headers: { 'Content-Type': 'application/json' },
-                body: JSON.stringify(definition),
-                credentials: 'include',
-            });
-            if (!response.ok)
-                throw new Error('Failed to fetch selected records');
-            return response.json();
-        }
-        catch (err) {
-            throw err instanceof Error ? err : new Error('Unknown error fetching selected records');
-        }
-    }
-    /**
-     * Fetches a single entity by its ID.
-     * @param {TKey} id - The ID of the entity
-     * @returns {Promise<TDto | undefined>} The requested entity
-     */
-    async readSingle(id) {
-        try {
-            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/ReadSingle?id=${encodeURIComponent(String(id))}`);
-            const response = await fetch(url, { credentials: 'include' });
-            if (!response.ok)
-                throw new Error('Failed to fetch single record');
-            return response.json();
-        }
-        catch (err) {
-            throw err instanceof Error ? err : new Error('Unknown error fetching single record');
-        }
-    }
-    /**
-     * Fetches all entities from the read controller.
-     * @returns {Promise<TDto[]>} List of all entities
-     */
-    async readAll() {
-        try {
-            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/ReadAll`);
-            const response = await fetch(url, { credentials: 'include' });
-            if (!response.ok)
-                throw new Error('Failed to fetch all records');
-            return response.json();
-        }
-        catch (err) {
-            throw err instanceof Error ? err : new Error('Unknown error fetching all records');
-        }
-    }
-}

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

@@ -1,2 +0,0 @@
-export * from './ApiReadControllerClient';
-export * from './ApiCrudControllerClient';

package/services/api/client/index.js

@@ -1,2 +0,0 @@
-export * from './ApiReadControllerClient';
-export * from './ApiCrudControllerClient';

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

@@ -1,78 +0,0 @@
-/**
- * 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 relativeEndpointPathSections Relative endpoint path sections
-     * @return {Promise<string | undefined>} Returns the API endpoint's URL
-     * @throws {Error} Throws error if API base URL detection fails
-     */
-    getApiUrl(...relativeEndpointPathSections: string[]): Promise<string>;
-    /**
-     * Removes starting '/' character
-     * @param str String to remove the starting '/' character from
-     * @returns String with starting '/' character  removed
-     */
-    private removeStartsWithSlashChar;
-    /**
-     * Removes ending '/' character
-     * @param str String to remove the ending '/' character from
-     * @returns String with ending '/' character  removed
-     */
-    private removeEndsWithSlashChar;
-}
-/**
- * Singleton instance of ApiInitializationService
- */
-export declare const apiInitializationService: ApiInitializationService;

package/services/api/initialization/index.js

@@ -1,155 +0,0 @@
-/**
- * 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 relativeEndpointPathSections Relative endpoint path sections
-     * @return {Promise<string | undefined>} Returns the API endpoint's URL
-     * @throws {Error} Throws error if API base URL detection fails
-     */
-    async getApiUrl(...relativeEndpointPathSections) {
-        const apiBaseUrl = await this._getApiBaseUrl();
-        const domain = !apiBaseUrl ? '/' : `${this.removeEndsWithSlashChar(apiBaseUrl)}/`;
-        const path = relativeEndpointPathSections.map(section => this.removeStartsWithSlashChar(this.removeEndsWithSlashChar(section))).join('/');
-        return `${domain}${path}`;
-    }
-    /**
-     * Removes starting '/' character
-     * @param str String to remove the starting '/' character from
-     * @returns String with starting '/' character  removed
-     */
-    removeStartsWithSlashChar(str) {
-        return !str.startsWith('/') ? str : str.substring(1);
-    }
-    /**
-     * Removes ending '/' character
-     * @param str String to remove the ending '/' character from
-     * @returns String with ending '/' character  removed
-     */
-    removeEndsWithSlashChar(str) {
-        return !str.endsWith('/') ? str : str.substring(0, str.length - 1);
-    }
-}
-/**
- * Singleton instance of ApiInitializationService
- */
-export const apiInitializationService = new ApiInitializationService();