@intellegens/cornerstone-client 0.0.9999-alpha-3 → 0.0.9999-alpha-5

package/data/api/enum/read/index.js

@@ -1,3 +1,4 @@
+export * from './ReadSelectedCollectionOperator';
 export * from './ReadSelectedComparisonOperator';
 export * from './ReadSelectedLogicalOperator';
 export * from './ReadSelectedOrderingDirection';

package/data/api/enum/response/ErrorCode.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Represents available error codes to be returned as part of the ApiResponse object
+ */
+export declare enum ErrorCode {
+    InternalServerError = 500,
+    NotFound = 404,
+    BadRequest = 400,
+    NotImplemented = 501,
+    Unauthorized = 401,
+    GatewayTimeout = 504,
+    ValidationFailed = 422,
+    UnknownError = 599
+}

package/data/api/enum/response/ErrorCode.js

@@ -0,0 +1,14 @@
+/**
+ * Represents available error codes to be returned as part of the ApiResponse object
+ */
+export var ErrorCode;
+(function (ErrorCode) {
+    ErrorCode[ErrorCode["InternalServerError"] = 500] = "InternalServerError";
+    ErrorCode[ErrorCode["NotFound"] = 404] = "NotFound";
+    ErrorCode[ErrorCode["BadRequest"] = 400] = "BadRequest";
+    ErrorCode[ErrorCode["NotImplemented"] = 501] = "NotImplemented";
+    ErrorCode[ErrorCode["Unauthorized"] = 401] = "Unauthorized";
+    ErrorCode[ErrorCode["GatewayTimeout"] = 504] = "GatewayTimeout";
+    ErrorCode[ErrorCode["ValidationFailed"] = 422] = "ValidationFailed";
+    ErrorCode[ErrorCode["UnknownError"] = 599] = "UnknownError";
+})(ErrorCode || (ErrorCode = {}));

package/data/api/enum/response/index.d.ts

@@ -1 +1 @@
-export * from './ApiErrorCodes';
+export * from './ErrorCode';

package/data/api/enum/response/index.js

@@ -1 +1 @@
-export * from './ApiErrorCodes';
+export * from './ErrorCode';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intellegens/cornerstone-client",
-  "version": "0.0.9999-alpha-3",
+  "version": "0.0.9999-alpha-5",
   "private": false,
   "publishable": true,
   "main": "./index.js",

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

@@ -1,4 +1,4 @@
-import { ApiSuccessResponseDto, EmptyMetadataDto } from '../../../data/api/dto';
+import { ApiResponseDto, EmptyMetadataDto } from '../../../data/api/dto';
 import { IIdentifiable } from '../../../data/api/interface';
 import { IHttpService } from '../HttpService';
 import { ApiReadControllerClient } from '../ApiReadControllerClient';
@@ -23,7 +23,7 @@ export declare class ApiCrudControllerClient<TKey, TDto extends IIdentifiable<TK
      * @param {AbortSignal} [signal] - Optional cancellation signal
      * @returns The created entity DTO
      */
-    createAsync(dto: TDto, signal?: AbortSignal): Promise<ApiSuccessResponseDto<TDto, EmptyMetadataDto>>;
+    createAsync(dto: TDto, signal?: AbortSignal): Promise<ApiResponseDto<TDto, EmptyMetadataDto>>;
     /**
      * Updates an existing entity.
      * @param id - The ID of the entity to update
@@ -31,11 +31,11 @@ export declare class ApiCrudControllerClient<TKey, TDto extends IIdentifiable<TK
      * @param {AbortSignal} [signal] - Optional cancellation signal
      * @returns The updated entity DTO
      */
-    updateAsync(id: TKey, dto: TDto, signal?: AbortSignal): Promise<ApiSuccessResponseDto<TDto, EmptyMetadataDto>>;
+    updateAsync(id: TKey, dto: TDto, signal?: AbortSignal): Promise<ApiResponseDto<TDto, EmptyMetadataDto>>;
     /**
      * Deletes an entity by ID.
      * @param id - The ID of the entity to delete
      * @param {AbortSignal} [signal] - Optional cancellation signal
      */
-    deleteAsync(id: TKey, signal?: AbortSignal): Promise<void>;
+    deleteAsync(id: TKey, signal?: AbortSignal): Promise<ApiResponseDto<null, EmptyMetadataDto>>;
 }

package/services/api/ApiCrudControllerClient/index.js

@@ -1,5 +1,7 @@
 import { apiInitializationService } from '../ApiInitializationService';
 import { ApiReadControllerClient } from '../ApiReadControllerClient';
+import { ErrorCode } from '../../../data';
+import { fail } from '../../../utils/result';
 /**
  * Generic API client for consuming any Cornerstone CrudController
  *
@@ -33,16 +35,20 @@ export class ApiCrudControllerClient extends ApiReadControllerClient {
                 credentials: 'include',
                 signal,
             });
-            if (!res.ok)
-                throw undefined;
-            const { success, result, metadata, error } = (await res.json());
-            if (!success)
-                throw new Error(error.message);
-            return { result, metadata };
+            if (!res.ok) {
+                return (await res.json());
+            }
+            return (await res.json());
         }
         catch (err) {
-            // TODO: Extract error from well-formed response
-            throw err instanceof Error ? err : new Error('Unknown error creating record');
+            console.error(err);
+            return fail({
+                error: {
+                    code: ErrorCode.UnknownError,
+                    message: 'Unknown error occurred while creating the record.',
+                    metadata: {},
+                },
+            });
         }
     }
     /**
@@ -62,16 +68,20 @@ export class ApiCrudControllerClient extends ApiReadControllerClient {
                 credentials: 'include',
                 signal,
             });
-            if (!res.ok)
-                throw undefined;
-            const { success, result, metadata, error } = (await res.json());
-            if (!success)
-                throw new Error(error.message);
-            return { result, metadata };
+            if (!res.ok) {
+                return (await res.json());
+            }
+            return (await res.json());
         }
         catch (err) {
-            // TODO: Extract error from well-formed response
-            throw err instanceof Error ? err : new Error('Unknown error updating record');
+            console.error(err);
+            return fail({
+                error: {
+                    code: ErrorCode.UnknownError,
+                    message: `Unknown error occurred while updating the record with id ${id}`,
+                    metadata: {},
+                },
+            });
         }
     }
     /**
@@ -82,17 +92,25 @@ export class ApiCrudControllerClient extends ApiReadControllerClient {
     async deleteAsync(id, signal) {
         try {
             const url = await apiInitializationService.getApiUrlAsync(this.baseControllerPath, `/Delete?id=${encodeURIComponent(String(id))}`);
-            const response = await this.httpService.requestAsync(url, {
+            const res = await this.httpService.requestAsync(url, {
                 method: 'DELETE',
                 credentials: 'include',
                 signal,
             });
-            if (!response.ok)
-                throw undefined;
+            if (!res.ok) {
+                return { ok: false, ...(await res.json()) };
+            }
+            return (await res.json());
         }
         catch (err) {
-            // TODO: Extract error from well-formed response
-            throw err instanceof Error ? err : new Error('Unknown error deleting record');
+            console.error(err);
+            return fail({
+                error: {
+                    code: ErrorCode.UnknownError,
+                    message: `Unknown error occurred while deleting the record with id ${id}`,
+                    metadata: {},
+                },
+            });
         }
     }
 }

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

@@ -13,29 +13,6 @@ import { IHttpService } from '../HttpService';
  * @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.
-     * - Fetches shared settings from the server.
-     *
-     * @async
-     * @param httpService - HTTP service implementation to use for requests
-     * @param {AbortSignal} [signal] - Optional cancellation signal
-     * @return {Promise<void>} Resolves when initialization is complete.
-     */
-    initializeAsync({ httpService, signal }?: {
-        httpService?: IHttpService;
-        signal?: AbortSignal;
-    }): Promise<void>;
-    private _httpService;
-    /**
-     * Gets configured HTTP service
-     * @returns
-     */
-    _getHttpService(): IHttpService;
-    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.
@@ -56,6 +33,30 @@ export declare class ApiInitializationService {
      * 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;
+    appConfig?: ISharedSettings | undefined;
+    private _httpService;
+    private _apiBaseUrlPromise;
+    /**
+     * 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.
+     * - Fetches shared settings from the server.
+     *
+     * @async
+     * @param httpService - HTTP service implementation to use for requests
+     * @param {AbortSignal} [signal] - Optional cancellation signal
+     * @return {Promise<void>} Resolves when initialization is complete.
+     */
+    initializeAsync({ httpService, signal, }?: {
+        httpService?: IHttpService;
+        signal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Gets configured HTTP service
+     * @returns
+     */
+    _getHttpService(): IHttpService;
     /**
      * Tries detecting API base URL by multiple methods
      *
@@ -92,11 +93,10 @@ export declare class ApiInitializationService {
      * @returns String with ending '/' character  removed
      */
     private removeEndsWithSlashChar;
-    appConfig?: ISharedSettings | undefined;
     /**
-    * Fetches initialization info (shared settings) from the server
-    * @returns Promise that resolves to shared settings or undefined if the request fails
-    */
+     * Fetches initialization info (shared settings) from the server
+     * @returns Promise that resolves to shared settings or undefined if the request fails
+     */
     private _getAppConfigAsync;
 }
 /**

package/services/api/ApiInitializationService/index.js

@@ -6,6 +6,33 @@ import { defaultHttpService } from '../HttpService';
  * @class ApiInitializationService
  */
 export class ApiInitializationService {
+    /**
+     * 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;
+    // #region HTTP service
+    /**
+     * 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;
+    // #endregion
+    // #region API Base URL detection
+    /**
+     * 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;
+    // #region config App
+    appConfig;
+    _httpService = defaultHttpService;
+    _apiBaseUrlPromise = undefined;
     /**
      * Initializes the API configuration
      *
@@ -18,7 +45,7 @@ export class ApiInitializationService {
      * @param {AbortSignal} [signal] - Optional cancellation signal
      * @return {Promise<void>} Resolves when initialization is complete.
      */
-    async initializeAsync({ httpService, signal } = {}) {
+    async initializeAsync({ httpService, signal, } = {}) {
         // Store configuration
         if (httpService !== undefined)
             this._httpService = httpService;
@@ -27,8 +54,6 @@ export class ApiInitializationService {
         // Initialize app config
         await this._getAppConfigAsync();
     }
-    // #region HTTP service
-    _httpService = defaultHttpService;
     /**
      * Gets configured HTTP service
      * @returns
@@ -36,29 +61,6 @@ export class ApiInitializationService {
     _getHttpService() {
         return this._httpService;
     }
-    // #endregion
-    // #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
      *
@@ -89,7 +91,10 @@ export class ApiInitializationService {
             this._apiBaseError = undefined;
             // Check CORNERSTONE-API-BASEURL header for API base URL
             try {
-                const currentUrlResponse = await this._httpService.requestAsync(window.location.href, { method: 'GET', signal });
+                const currentUrlResponse = await this._httpService.requestAsync(window.location.href, {
+                    method: 'GET',
+                    signal,
+                });
                 const apiHeader = currentUrlResponse.headers['CORNERSTONE-API-BASEURL'] || currentUrlResponse.headers['cornerstone-api-baseurl'] || null;
                 if (apiHeader) {
                     this._apiBaseUrlDetected = true;
@@ -105,7 +110,10 @@ export class ApiInitializationService {
             }
             // Check ./websettings.json header for API base URL
             try {
-                const webSettingsResponse = await this._httpService.requestAsync('./websettings.json', { method: 'GET', signal });
+                const webSettingsResponse = await this._httpService.requestAsync('./websettings.json', {
+                    method: 'GET',
+                    signal,
+                });
                 if (webSettingsResponse.status === 404)
                     return (this._apiBaseUrl = undefined);
                 const webSettings = await webSettingsResponse.json();
@@ -160,6 +168,7 @@ export class ApiInitializationService {
     removeStartsWithSlashChar(str) {
         return !str.startsWith('/') ? str : str.substring(1);
     }
+    // #endregion
     /**
      * Removes ending '/' character
      * @param str String to remove the ending '/' character from
@@ -168,27 +177,22 @@ export class ApiInitializationService {
     removeEndsWithSlashChar(str) {
         return !str.endsWith('/') ? str : str.substring(0, str.length - 1);
     }
-    // #endregion
-    // #region config App
-    appConfig;
     /**
-    * Fetches initialization info (shared settings) from the server
-    * @returns Promise that resolves to shared settings or undefined if the request fails
-    */
+     * Fetches initialization info (shared settings) from the server
+     * @returns Promise that resolves to shared settings or undefined if the request fails
+     */
     async _getAppConfigAsync() {
         try {
-            const response = await fetch(`${this._apiBaseUrl}/api/system/init`, { credentials: 'include' });
-            if (!response.ok)
-                throw new Error('Failed to get app config');
-            const apiResponse = await response.json();
-            // Check if the API response indicates success
-            if (!apiResponse.success || !apiResponse.result) {
-                throw new Error(apiResponse.error?.message || 'Server returned unsuccessful response');
+            const response = await fetch(`${this._apiBaseUrl}/system/init`, { credentials: 'include' });
+            if (!response.ok) {
+                throw (await response.json());
             }
+            const apiResponse = await response.json();
             // Return the settings from the nested structure
             this.appConfig = apiResponse.result.settings;
         }
         catch (error) {
+            console.error('Failed to get app config', error);
             this.appConfig = undefined;
         }
     }

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

@@ -1,4 +1,4 @@
-import { ApiSuccessResponseDto, EmptyMetadataDto, ReadMetadataDto, ReadSelectedDefinitionDto } from '../../../data/api/dto';
+import { ApiResponseDto, EmptyMetadataDto, ReadMetadataDto, ReadSelectedDefinitionDto } from '../../../data/api/dto';
 import { IIdentifiable } from '../../../data/api/interface';
 import { IHttpService } from '../HttpService';
 /**
@@ -22,19 +22,19 @@ export declare class ApiReadControllerClient<TKey, TDto extends IIdentifiable<TK
      * @param {AbortSignal} [signal] - Optional cancellation signal
      * @returns {Promise<ApiSuccessResponseDto<TDto>[], ReadMetadataDto>>} List of all entities with metadata
      */
-    readAllAsync(signal?: AbortSignal): Promise<ApiSuccessResponseDto<TDto[], ReadMetadataDto>>;
+    readAllAsync(signal?: AbortSignal): Promise<ApiResponseDto<TDto[], ReadMetadataDto>>;
     /**
      * Fetches selected entities based on a filter definition.
      * @param {any} definition - The filter definition object
      * @param {AbortSignal} [signal] - Optional cancellation signal
      * @returns {Promise<ApiSuccessResponseDto<TDto>[], ReadMetadataDto>>} The result of the read operation with metadata
      */
-    readSelectedAsync(definition: ReadSelectedDefinitionDto, signal?: AbortSignal): Promise<ApiSuccessResponseDto<TDto[], ReadMetadataDto>>;
+    readSelectedAsync(definition: ReadSelectedDefinitionDto<TDto>, signal?: AbortSignal): Promise<ApiResponseDto<TDto[], ReadMetadataDto>>;
     /**
      * Fetches a single entity by its ID.
      * @param {TKey} id - The ID of the entity
      * @param {AbortSignal} [signal] - Optional cancellation signal
      * @returns {Promise<ApiSuccessResponseDto<TDto, EmptyMetadataDto>>} The requested entity
      */
-    readSingleAsync(id: TKey, signal?: AbortSignal): Promise<ApiSuccessResponseDto<TDto, EmptyMetadataDto>>;
+    readSingleAsync(id: TKey, signal?: AbortSignal): Promise<ApiResponseDto<TDto, EmptyMetadataDto>>;
 }

package/services/api/ApiReadControllerClient/index.js

@@ -1,4 +1,6 @@
 import { apiInitializationService } from '../ApiInitializationService';
+import { fail } from '../../../utils/result';
+import { ErrorCode } from '../../../data';
 /**
  * Base client for read-only API controllers
  */
@@ -32,16 +34,20 @@ export class ApiReadControllerClient {
         try {
             const url = await apiInitializationService.getApiUrlAsync(this.baseControllerPath, `/ReadAll`);
             const res = await this.httpService.requestAsync(url, { method: 'GET', credentials: 'include', signal });
-            if (!res.ok)
-                throw undefined;
-            const { success, result, metadata, error } = (await res.json());
-            if (!success)
-                throw new Error(error.message);
-            return { result, metadata };
+            if (!res.ok) {
+                return fail(await res.json());
+            }
+            return (await res.json());
         }
         catch (err) {
-            // TODO: Extract error from well-formed response
-            throw err instanceof Error ? err : new Error('Unknown error fetching all records');
+            console.error(err);
+            return fail({
+                error: {
+                    code: ErrorCode.UnknownError,
+                    message: 'Unknown error fetching all records',
+                    metadata: {},
+                },
+            });
         }
     }
     /**
@@ -60,16 +66,20 @@ export class ApiReadControllerClient {
                 credentials: 'include',
                 signal,
             });
-            if (!res.ok)
-                throw undefined;
-            const { success, result, metadata, error } = (await res.json());
-            if (!success)
-                throw new Error(error.message);
-            return { result, metadata };
+            if (!res.ok) {
+                return (await res.json());
+            }
+            return (await res.json());
         }
         catch (err) {
-            // TODO: Extract error from well-formed response
-            throw err instanceof Error ? err : new Error('Unknown error fetching selected records');
+            console.error(err);
+            return fail({
+                error: {
+                    code: ErrorCode.UnknownError,
+                    message: 'Unknown error fetching selected records',
+                    metadata: {},
+                },
+            });
         }
     }
     /**
@@ -82,16 +92,20 @@ export class ApiReadControllerClient {
         try {
             const url = await apiInitializationService.getApiUrlAsync(this.baseControllerPath, `/ReadSingle?id=${encodeURIComponent(String(id))}`);
             const res = await this.httpService.requestAsync(url, { method: 'GET', credentials: 'include', signal });
-            if (!res.ok)
-                throw undefined;
-            const { success, result, metadata, error } = (await res.json());
-            if (!success)
-                throw new Error(error.message);
-            return { result, metadata };
+            if (!res.ok) {
+                return (await res.json());
+            }
+            return (await res.json());
         }
         catch (err) {
-            // TODO: Extract error from well-formed response
-            throw err instanceof Error ? err : new Error('Unknown error fetching single record');
+            console.error(err);
+            return fail({
+                error: {
+                    code: ErrorCode.UnknownError,
+                    message: `Unknown error fetching record with id ${id}`,
+                    metadata: {},
+                },
+            });
         }
     }
 }

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

@@ -1,6 +1,6 @@
 import { ApiCrudControllerClient } from '../ApiCrudControllerClient';
 import { IHttpService } from '../HttpService';
-import { UserDto, ClaimDto, ReadMetadataDto, ApiSuccessResponseDto } from '../../../data';
+import { ApiResponseDto, ClaimDto, EmptyMetadataDto, ReadMetadataDto, UserDto } from '../../../data';
 /**
  * Client for user management operations
  *
@@ -22,20 +22,20 @@ export declare class UserManagementControllerClient<TKey, TUser extends UserDto<
      * @param {AbortSignal} [signal] - Optional cancellation signal
      * @returns List of role names assigned to the user
      */
-    getUserRolesAsync(id: TKey, signal?: AbortSignal): Promise<ApiSuccessResponseDto<string[], ReadMetadataDto>>;
+    getUserRolesAsync(id: TKey, signal?: AbortSignal): Promise<ApiResponseDto<string[], ReadMetadataDto>>;
     /**
      * Gets the claims assigned to a user
      * @param id - The ID of the user
      * @param {AbortSignal} [signal] - Optional cancellation signal
      * @returns List of claims assigned to the user
      */
-    getUserClaimsAsync(id: TKey, signal?: AbortSignal): Promise<ApiSuccessResponseDto<ClaimDto[], ReadMetadataDto>>;
+    getUserClaimsAsync(id: TKey, signal?: AbortSignal): Promise<ApiResponseDto<ClaimDto[], ReadMetadataDto>>;
     /**
      * Gets all available roles in the system
      * @param {AbortSignal} [signal] - Optional cancellation signal
      * @returns List of all role names
      */
-    getAllRolesAsync(signal?: AbortSignal): Promise<ApiSuccessResponseDto<string[], ReadMetadataDto>>;
+    getAllRolesAsync(signal?: AbortSignal): Promise<ApiResponseDto<string[], ReadMetadataDto>>;
     /**
      * Changes the password for a user
      * @param id - The ID of the user
@@ -43,5 +43,5 @@ export declare class UserManagementControllerClient<TKey, TUser extends UserDto<
      * @param {AbortSignal} [signal] - Optional cancellation signal
      * @returns Promise that resolves when the password is changed successfully
      */
-    changePasswordAsync(id: TKey, newPassword: string, signal?: AbortSignal): Promise<void>;
+    changePasswordAsync(id: TKey, newPassword: string, signal?: AbortSignal): Promise<ApiResponseDto<undefined, EmptyMetadataDto>>;
 }