@intellegens/cornerstone-client 0.0.9999-alpha-13 → 0.0.9999-alpha-15

package/dist/adapters/CollectionViewAdapter/index.d.ts

@@ -47,7 +47,7 @@ export type CollectionViewAdapterOptions<TDto> = {
  * Receives a loading state flag and the updated data collection.
  * @param options - Optional settings of type CollectionViewAdapter to customize the behavior of the adapter.
  */
-export declare class CollectionViewAdapter<TKey, TDto extends IIdentifiable<TKey>> {
+export declare class CollectionViewAdapter<TKey, TDto extends IIdentifiable<TKey>, TDetailsDto extends IIdentifiable<TKey>> {
     private _readClient;
     private _isLoading;
     private _pageData;

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

@@ -10,7 +10,7 @@ import { ApiReadControllerClient } from '../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 IIdentifiable<TKey>> extends ApiReadControllerClient<TKey, TDto> {
+export declare class ApiCrudControllerClient<TKey, TResultDto extends IIdentifiable<TKey>, TSingleResultDto extends IIdentifiable<TKey>, TInsertRequestDto, TUpdateRequestDto> extends ApiReadControllerClient<TKey, TResultDto, TSingleResultDto> {
     /**
      * Constructor
      * @param baseControllerPath Base path to API controller
@@ -23,7 +23,7 @@ export declare class ApiCrudControllerClient<TKey, TDto extends IIdentifiable<TK
      * @param {AbortSignal} [signal] - Optional cancellation signal
      * @returns The created entity DTO
      */
-    create(dto: TDto, signal?: AbortSignal): Promise<ApiResponseDto<TDto, EmptyMetadataDto>>;
+    create(dto: TInsertRequestDto, signal?: AbortSignal): Promise<ApiResponseDto<TSingleResultDto, EmptyMetadataDto>>;
     /**
      * Updates an existing entity.
      * @param id - The ID of the entity to update
@@ -31,7 +31,7 @@ export declare class ApiCrudControllerClient<TKey, TDto extends IIdentifiable<TK
      * @param {AbortSignal} [signal] - Optional cancellation signal
      * @returns The updated entity DTO
      */
-    update(id: TKey, dto: TDto, signal?: AbortSignal): Promise<ApiResponseDto<TDto, EmptyMetadataDto>>;
+    update(id: TKey, dto: TUpdateRequestDto, signal?: AbortSignal): Promise<ApiResponseDto<TSingleResultDto, EmptyMetadataDto>>;
     /**
      * Deletes an entity by ID.
      * @param id - The ID of the entity to delete

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

@@ -4,7 +4,7 @@ import { IHttpService } from '../HttpService';
 /**
  * Base client for read-only API controllers
  */
-export declare class ApiReadControllerClient<TKey, TDto extends IIdentifiable<TKey>> {
+export declare class ApiReadControllerClient<TKey, TResultDto extends IIdentifiable<TKey>, TSingleResultDto extends IIdentifiable<TKey>> {
     protected readonly baseControllerPath: string;
     /**
      * Constructor
@@ -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
      */
-    readAll(signal?: AbortSignal): Promise<ApiResponseDto<TDto[], ReadMetadataDto>>;
+    readAll(signal?: AbortSignal): Promise<ApiResponseDto<TResultDto[], 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
      */
-    readSelected(definition: ReadSelectedDefinitionDto<TDto>, signal?: AbortSignal): Promise<ApiResponseDto<TDto[], ReadMetadataDto>>;
+    readSelected(definition: ReadSelectedDefinitionDto<TResultDto>, signal?: AbortSignal): Promise<ApiResponseDto<TResultDto[], 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
      */
-    readSingle(id: TKey, signal?: AbortSignal): Promise<ApiResponseDto<TDto, EmptyMetadataDto>>;
+    readSingle(id: TKey, signal?: AbortSignal): Promise<ApiResponseDto<TSingleResultDto, EmptyMetadataDto>>;
 }

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

@@ -9,7 +9,7 @@ import { ApiResponseDto, ClaimDto, EmptyMetadataDto, ReadMetadataDto, UserDto }
  * @template TKey - Type of the entity key (e.g., number, string, GUID, etc.)
  * @template TUser - Data Transfer Object representing the user entity
  */
-export declare class UserManagementControllerClient<TKey, TUser extends UserDto<TKey>> extends ApiCrudControllerClient<TKey, TUser> {
+export declare class UserManagementControllerClient<TKey, TResultDto extends UserDto<TKey>, TSingleResultDto extends UserDto<TKey>, TInsertRequestDto extends UserDto<TKey>, TUpdateRequestDto extends UserDto<TKey>> extends ApiCrudControllerClient<TKey, TResultDto, TSingleResultDto, TInsertRequestDto, TUpdateRequestDto> {
     /**
      * Constructor
      * @param baseControllerPath Base path to API controller

package/package.json

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

package/src/adapters/CollectionViewAdapter/index.ts

@@ -51,8 +51,8 @@ export type CollectionViewAdapterOptions<TDto> = {
  * Receives a loading state flag and the updated data collection.
  * @param options - Optional settings of type CollectionViewAdapter to customize the behavior of the adapter.
  */
-export class CollectionViewAdapter<TKey, TDto extends IIdentifiable<TKey>> {
-  private _readClient: ApiReadControllerClient<TKey, TDto>;
+export class CollectionViewAdapter<TKey, TDto extends IIdentifiable<TKey>, TDetailsDto extends IIdentifiable<TKey>> {
+  private _readClient: ApiReadControllerClient<TKey, TDto, TDetailsDto>;
 
   private _isLoading = false;
   private _pageData: TDto[] = [];
@@ -81,7 +81,7 @@ export class CollectionViewAdapter<TKey, TDto extends IIdentifiable<TKey>> {
     dataChangedCallback: (isLoading: boolean, data: TDto[] | undefined, error: string | undefined) => void,
     options?: CollectionViewAdapterOptions<TDto>,
   ) {
-    this._readClient = new ApiReadControllerClient<TKey, TDto>(controllerName);
+    this._readClient = new ApiReadControllerClient<TKey, TDto, TDetailsDto>(controllerName);
 
     this._initialOptions = {
       pagination: {

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

@@ -15,7 +15,13 @@ import { fail, ok } from '@utils/result';
  * @template TDto - Data Transfer Object representing the entity
  */
 
-export class ApiCrudControllerClient<TKey, TDto extends IIdentifiable<TKey>> extends ApiReadControllerClient<TKey, TDto> {
+export class ApiCrudControllerClient<
+  TKey,
+  TResultDto extends IIdentifiable<TKey>,
+  TSingleResultDto extends IIdentifiable<TKey>,
+  TInsertRequestDto,
+  TUpdateRequestDto,
+> extends ApiReadControllerClient<TKey, TResultDto, TSingleResultDto> {
   /**
    * Constructor
    * @param baseControllerPath Base path to API controller
@@ -31,7 +37,7 @@ export class ApiCrudControllerClient<TKey, TDto extends IIdentifiable<TKey>> ext
    * @param {AbortSignal} [signal] - Optional cancellation signal
    * @returns The created entity DTO
    */
-  public async create(dto: TDto, signal?: AbortSignal): Promise<ApiResponseDto<TDto, EmptyMetadataDto>> {
+  public async create(dto: TInsertRequestDto, signal?: AbortSignal): Promise<ApiResponseDto<TSingleResultDto, EmptyMetadataDto>> {
     try {
       const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/Create`);
       const res = await this.httpService.request(url, {
@@ -42,14 +48,14 @@ export class ApiCrudControllerClient<TKey, TDto extends IIdentifiable<TKey>> ext
         signal,
       });
       if (!res.ok) {
-        return fail<ApiSuccessResponseDto<TDto, EmptyMetadataDto>, ApiErrorResponseDto>(await res.json());
+        return fail<ApiSuccessResponseDto<TSingleResultDto, EmptyMetadataDto>, ApiErrorResponseDto>(await res.json());
       }
 
-      return ok<ApiSuccessResponseDto<TDto, EmptyMetadataDto>, ApiErrorResponseDto>(await res.json());
+      return ok<ApiSuccessResponseDto<TSingleResultDto, EmptyMetadataDto>, ApiErrorResponseDto>(await res.json());
     } catch (err) {
       console.error(err);
 
-      return fail<ApiSuccessResponseDto<TDto, EmptyMetadataDto>, ApiErrorResponseDto>({
+      return fail<ApiSuccessResponseDto<TSingleResultDto, EmptyMetadataDto>, ApiErrorResponseDto>({
         error: {
           code: ErrorCode.UnknownError,
           message: 'Unknown error occurred while creating the record.',
@@ -66,7 +72,7 @@ export class ApiCrudControllerClient<TKey, TDto extends IIdentifiable<TKey>> ext
    * @param {AbortSignal} [signal] - Optional cancellation signal
    * @returns The updated entity DTO
    */
-  public async update(id: TKey, dto: TDto, signal?: AbortSignal): Promise<ApiResponseDto<TDto, EmptyMetadataDto>> {
+  public async update(id: TKey, dto: TUpdateRequestDto, signal?: AbortSignal): Promise<ApiResponseDto<TSingleResultDto, EmptyMetadataDto>> {
     try {
       const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/Update?id=${encodeURIComponent(String(id))}`);
       const res = await this.httpService.request(url, {
@@ -78,14 +84,14 @@ export class ApiCrudControllerClient<TKey, TDto extends IIdentifiable<TKey>> ext
       });
 
       if (!res.ok) {
-        return fail<ApiSuccessResponseDto<TDto, EmptyMetadataDto>, ApiErrorResponseDto>(await res.json());
+        return fail<ApiSuccessResponseDto<TSingleResultDto, EmptyMetadataDto>, ApiErrorResponseDto>(await res.json());
       }
 
-      return ok<ApiSuccessResponseDto<TDto, EmptyMetadataDto>, ApiErrorResponseDto>(await res.json());
+      return ok<ApiSuccessResponseDto<TSingleResultDto, EmptyMetadataDto>, ApiErrorResponseDto>(await res.json());
     } catch (err) {
       console.error(err);
 
-      return fail<ApiSuccessResponseDto<TDto, EmptyMetadataDto>, ApiErrorResponseDto>({
+      return fail<ApiSuccessResponseDto<TSingleResultDto, EmptyMetadataDto>, ApiErrorResponseDto>({
         error: {
           code: ErrorCode.UnknownError,
           message: `Unknown error occurred while updating the record with id ${id}`,

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

@@ -15,7 +15,7 @@ import { ErrorCode } from '@data';
 /**
  * Base client for read-only API controllers
  */
-export class ApiReadControllerClient<TKey, TDto extends IIdentifiable<TKey>> {
+export class ApiReadControllerClient<TKey, TResultDto extends IIdentifiable<TKey>, TSingleResultDto extends IIdentifiable<TKey>> {
   /**
    * Constructor
    * @param baseControllerPath Base path to API controller
@@ -46,20 +46,20 @@ export class ApiReadControllerClient<TKey, TDto extends IIdentifiable<TKey>> {
    * @param {AbortSignal} [signal] - Optional cancellation signal
    * @returns {Promise<ApiSuccessResponseDto<TDto>[], ReadMetadataDto>>} List of all entities with metadata
    */
-  public async readAll(signal?: AbortSignal): Promise<ApiResponseDto<TDto[], ReadMetadataDto>> {
+  public async readAll(signal?: AbortSignal): Promise<ApiResponseDto<TResultDto[], ReadMetadataDto>> {
     try {
       const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/ReadAll`);
       const res = await this.httpService.request(url, { method: 'GET', credentials: 'include', signal });
 
       if (!res.ok) {
-        return fail<ApiSuccessResponseDto<TDto[], ReadMetadataDto>, ApiErrorResponseDto>(await res.json());
+        return fail<ApiSuccessResponseDto<TResultDto[], ReadMetadataDto>, ApiErrorResponseDto>(await res.json());
       }
 
-      return ok<ApiSuccessResponseDto<TDto[], ReadMetadataDto>, ApiErrorResponseDto>(await res.json());
+      return ok<ApiSuccessResponseDto<TResultDto[], ReadMetadataDto>, ApiErrorResponseDto>(await res.json());
     } catch (err) {
       console.error(err);
 
-      return fail<ApiSuccessResponseDto<TDto[], ReadMetadataDto>, ApiErrorResponseDto>({
+      return fail<ApiSuccessResponseDto<TResultDto[], ReadMetadataDto>, ApiErrorResponseDto>({
         error: {
           code: ErrorCode.UnknownError,
           message: 'Unknown error fetching all records',
@@ -75,7 +75,7 @@ export class ApiReadControllerClient<TKey, TDto extends IIdentifiable<TKey>> {
    * @param {AbortSignal} [signal] - Optional cancellation signal
    * @returns {Promise<ApiSuccessResponseDto<TDto>[], ReadMetadataDto>>} The result of the read operation with metadata
    */
-  public async readSelected(definition: ReadSelectedDefinitionDto<TDto>, signal?: AbortSignal): Promise<ApiResponseDto<TDto[], ReadMetadataDto>> {
+  public async readSelected(definition: ReadSelectedDefinitionDto<TResultDto>, signal?: AbortSignal): Promise<ApiResponseDto<TResultDto[], ReadMetadataDto>> {
     try {
       const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/ReadSelected`);
       const res = await this.httpService.request(url, {
@@ -87,14 +87,14 @@ export class ApiReadControllerClient<TKey, TDto extends IIdentifiable<TKey>> {
       });
 
       if (!res.ok) {
-        return fail<ApiSuccessResponseDto<TDto[], ReadMetadataDto>, ApiErrorResponseDto>(await res.json());
+        return fail<ApiSuccessResponseDto<TResultDto[], ReadMetadataDto>, ApiErrorResponseDto>(await res.json());
       }
 
-      return ok<ApiSuccessResponseDto<TDto[], ReadMetadataDto>, ApiErrorResponseDto>(await res.json());
+      return ok<ApiSuccessResponseDto<TResultDto[], ReadMetadataDto>, ApiErrorResponseDto>(await res.json());
     } catch (err) {
       console.error(err);
 
-      return fail<ApiSuccessResponseDto<TDto[], ReadMetadataDto>, ApiErrorResponseDto>({
+      return fail<ApiSuccessResponseDto<TResultDto[], ReadMetadataDto>, ApiErrorResponseDto>({
         error: {
           code: ErrorCode.UnknownError,
           message: 'Unknown error fetching selected records',
@@ -110,20 +110,20 @@ export class ApiReadControllerClient<TKey, TDto extends IIdentifiable<TKey>> {
    * @param {AbortSignal} [signal] - Optional cancellation signal
    * @returns {Promise<ApiSuccessResponseDto<TDto, EmptyMetadataDto>>} The requested entity
    */
-  public async readSingle(id: TKey, signal?: AbortSignal): Promise<ApiResponseDto<TDto, EmptyMetadataDto>> {
+  public async readSingle(id: TKey, signal?: AbortSignal): Promise<ApiResponseDto<TSingleResultDto, EmptyMetadataDto>> {
     try {
       const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/ReadSingle?id=${encodeURIComponent(String(id))}`);
       const res = await this.httpService.request(url, { method: 'GET', credentials: 'include', signal });
 
       if (!res.ok) {
-        return fail<ApiSuccessResponseDto<TDto, EmptyMetadataDto>, ApiErrorResponseDto>(await res.json());
+        return fail<ApiSuccessResponseDto<TSingleResultDto, EmptyMetadataDto>, ApiErrorResponseDto>(await res.json());
       }
 
-      return ok<ApiSuccessResponseDto<TDto, EmptyMetadataDto>, ApiErrorResponseDto>(await res.json());
+      return ok<ApiSuccessResponseDto<TSingleResultDto, EmptyMetadataDto>, ApiErrorResponseDto>(await res.json());
     } catch (err) {
       console.error(err);
 
-      return fail<ApiSuccessResponseDto<TDto, EmptyMetadataDto>, ApiErrorResponseDto>({
+      return fail<ApiSuccessResponseDto<TSingleResultDto, EmptyMetadataDto>, ApiErrorResponseDto>({
         error: {
           code: ErrorCode.UnknownError,
           message: `Unknown error fetching record with id ${id}`,

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

@@ -12,7 +12,13 @@ import { fail, ok } from '@utils/result';
  * @template TKey - Type of the entity key (e.g., number, string, GUID, etc.)
  * @template TUser - Data Transfer Object representing the user entity
  */
-export class UserManagementControllerClient<TKey, TUser extends UserDto<TKey>> extends ApiCrudControllerClient<TKey, TUser> {
+export class UserManagementControllerClient<
+  TKey,
+  TResultDto extends UserDto<TKey>,
+  TSingleResultDto extends UserDto<TKey>,
+  TInsertRequestDto extends UserDto<TKey>,
+  TUpdateRequestDto extends UserDto<TKey>,
+> extends ApiCrudControllerClient<TKey, TResultDto, TSingleResultDto, TInsertRequestDto, TUpdateRequestDto> {
   /**
    * Constructor
    * @param baseControllerPath Base path to API controller

package/tests/ApiClients.test.ts

@@ -52,7 +52,7 @@ describe('API Clients with HTTP Service Abstraction', () => {
   });
 
   describe('ApiReadControllerClient', () => {
-    let client: ApiReadControllerClient<number, any>;
+    let client: ApiReadControllerClient<number, any, any>;
 
     beforeEach(() => {
       client = new ApiReadControllerClient('/api/test', mockHttpService);
@@ -145,7 +145,7 @@ describe('API Clients with HTTP Service Abstraction', () => {
   });
 
   describe('ApiCrudControllerClient', () => {
-    let client: ApiCrudControllerClient<number, any>;
+    let client: ApiCrudControllerClient<number, any, any, any, any>;
 
     beforeEach(() => {
       client = new ApiCrudControllerClient('/api/crud', mockHttpService);
@@ -212,7 +212,7 @@ describe('API Clients with HTTP Service Abstraction', () => {
   });
 
   describe('UserManagementControllerClient', () => {
-    let client: UserManagementControllerClient<number, any>;
+    let client: UserManagementControllerClient<number, any, any, any, any>;
 
     beforeEach(() => {
       client = new UserManagementControllerClient('/api/users', mockHttpService);