@intellegens/cornerstone-client 0.0.0-experimental-upgrade-20260302-1

package/src/data/api/enum/read/ReadSelectedCollectionOperator.ts

@@ -0,0 +1,17 @@
+/**
+ * Represents the collection quantifier operators that can be used when searching collection properties.
+ * 
+ * The `Any` operator matches if at least one element in the collection satisfies the criteria.
+ * The `All` operator matches if all elements in the collection satisfy the criteria.
+ */
+export enum ReadSelectedCollectionOperator {
+  /**
+   * Matches if at least one element in the collection satisfies the criteria.
+   */
+  Any = 0,
+
+  /**
+   * Matches if all elements in the collection satisfy the criteria.
+   */
+  All = 1,
+}

package/src/data/api/enum/read/ReadSelectedComparisonOperator.ts

@@ -0,0 +1,96 @@
+/**
+ * Represents the basic comparison operators that can be used in a controller.
+ */
+export enum ReadSelectedComparisonOperator {
+  //#region Any type
+
+  /**
+   * Represents the equal comparison operator.
+   */
+  Equal = 0,
+
+  /**
+   * Represents the not equal comparison operator.
+   */
+  NotEqual = 1,
+
+  /**
+   * Represents the is null comparison operator.
+   */
+  IsNull = 2,
+
+  /**
+   * Represents the is not null comparison operator.
+   */
+  IsNotNull = 3,
+
+  //#endregion
+
+  //#region Number
+
+  /**
+   * Represents the less than comparison operator.
+   */
+  LessThan = 100,
+
+  /**
+   * Represents the less than or equal comparison operator.
+   */
+  LessOrEqual = 101,
+
+  /**
+   * Represents the greater than comparison operator.
+   */
+  GreaterThan = 102,
+
+  /**
+   * Represents the greater than or equal comparison operator.
+   */
+  GreaterOrEqual = 103,
+
+  //#endregion
+
+  //#region String
+
+  /**
+   * Represents the contains comparison operator.
+   */
+  Contains = 200,
+
+  /**
+   * Represents the starts with comparison operator.
+   */
+  StartsWith = 201,
+
+  /**
+   * Represents the ends with comparison operator.
+   */
+  EndsWith = 202,
+
+  /**
+   * Represents the contains comparison operator (case-insensitive).
+   */
+  IContains = 203,
+
+  /**
+   * Represents the starts with comparison operator (case-insensitive).
+   */
+  IStartsWith = 204,
+  
+  /**
+   * Represents the ends with comparison operator (case-insensitive).
+   */
+  IEndsWith = 205,
+
+  /**
+   * Represents the equal comparison operator (case-insensitive).
+   */
+  IEqual = 206,
+
+  /**
+   * Represents the not equal comparison operator (case-insensitive).
+   */
+  INotEqual = 207,
+
+  //#endregion
+}

package/src/data/api/enum/read/ReadSelectedLogicalOperator.ts

@@ -0,0 +1,16 @@
+/**
+ * Represents the logical operators that can be used in a controller.
+ * - The `And` operator combines multiple conditions, requiring all of them to be true.
+ * - The `Or` operator combines multiple conditions, requiring at least one of them to be true.
+ */
+export enum ReadSelectedLogicalOperator {
+  /**
+   * Represents the logical AND operator.
+   */
+  And = 0,
+
+  /**
+   * Represents the logical OR operator.
+   */
+  Or = 1,
+}

package/src/data/api/enum/read/ReadSelectedOrderingDirection.ts

@@ -0,0 +1,13 @@
+/**
+ * Represents options for ordering directions
+ */
+export enum ReadSelectedOrderingDirection {
+  /**
+   * Ascending ordering
+   */
+  Ascending = 0,
+  /**
+   * Descending ordering
+   */
+  Descending = 1,
+}

package/src/data/api/enum/read/ReadSelectedPropertyType.ts

@@ -0,0 +1,96 @@
+/**
+ * Represents the basic property types that can be used in a controller.
+ * - The ReadSelectedPropertyType enum defines the basic property types that can be used in a fetch controller. These types include boolean, integer, long, and string.
+ */
+export enum ReadSelectedPropertyType {
+  //#region Boolean
+
+  /**
+   * Represents a boolean property type.
+   */
+  Bool = 0,
+
+  //#endregion
+
+  //#region Number
+
+  /**
+   * Represents an integer property type.
+   */
+  Int = 100,
+
+  /**
+   * Represents a short property type.
+   */
+  Short = 101,
+
+  /**
+   * Represents a long property type.
+   */
+  Long = 102,
+
+  /**
+   * Represents a decimal property type.
+   */
+  Decimal = 103,
+
+  /**
+   * Represents a double property type.
+   */
+  Double = 104,
+
+  /**
+   * Represents a float property type.
+   */
+  Float = 105,
+
+  //#endregion
+
+  //#region string
+
+  /**
+   * Represents a string property type.
+   */
+  String = 200,
+
+  /**
+   * Represents a Guid property type.
+   */
+  Guid = 201,
+
+  //#endregion
+
+  //#region Time
+
+  /**
+   * Represents a DateTime property type.
+   */
+  DateTime = 300,
+
+  /**
+   * Represents a DateTimeOffset property type.
+   */
+  DateTimeOffset = 301,
+
+  /**
+   * Represents a TimeSpan property type.
+   */
+  TimeSpan = 302,
+
+  /**
+   * Represents a DateOnly property type.
+   */
+  DateOnly = 303,
+
+  /**
+   * Represents a TimeOnly property type.
+   */
+  TimeOnly = 304,
+
+  //#endregion
+
+  /**
+   *  Represents an Enum property type.
+   */
+  Enum = 400,
+}

package/src/data/api/enum/read/index.ts

@@ -0,0 +1,5 @@
+export * from './ReadSelectedCollectionOperator';
+export * from './ReadSelectedComparisonOperator';
+export * from './ReadSelectedLogicalOperator';
+export * from './ReadSelectedOrderingDirection';
+export * from './ReadSelectedPropertyType';

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

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

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

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

package/src/data/api/index.ts

@@ -0,0 +1,3 @@
+export * from './interface';
+export * from './dto';
+export * from './enum';

package/src/data/api/interface/ICommonIdentifiable.ts

@@ -0,0 +1,9 @@
+import {IIdentifiable} from "@data";
+
+
+export interface ICommonIdentifiable<TKey> extends IIdentifiable<TKey> {
+    /**
+     * Gets or sets the type of the entity.
+     */
+    type: string;
+}

package/src/data/api/interface/IConcurrencySafe.ts

@@ -0,0 +1,9 @@
+/**
+ * Interface for entities that have row versioning
+ */
+export interface IConcurrencySafe {
+  /**
+   * Row version
+   */
+  rowVersion: string;
+};

package/src/data/api/interface/IIdentifiable.ts

@@ -0,0 +1,12 @@
+import { IConcurrencySafe } from './IConcurrencySafe';
+
+/**
+ * Interface for entities that have a Id property.
+ * Will be used as a primary key in the database.
+ */
+export interface IIdentifiable<TKey> extends IConcurrencySafe {
+  /**
+   * Gets or sets the Id of the entity.
+   */
+  id: TKey;
+}

package/src/data/api/interface/IIdentifiableSecondary.ts

@@ -0,0 +1,9 @@
+/**
+ * Interface for entities that have a secondary Id property.
+ */
+export interface IIdentifiableSecondary<TKey> {
+  /**
+   * Gets or sets the secondary Id of the entity.
+   */
+  idSecondary: TKey;
+}

package/src/data/api/interface/index.ts

@@ -0,0 +1,3 @@
+export * from './IIdentifiable';
+export * from './IIdentifiableSecondary';
+export * from './IConcurrencySafe';

package/src/data/auth/dto/ClaimDto.ts

@@ -0,0 +1,4 @@
+export type ClaimDto = {
+  type: string;
+  value: string;
+};

package/src/data/auth/dto/RegisterRequestDto.ts

@@ -0,0 +1,4 @@
+export type RegisterRequestDto = {
+  username: string;
+  password: string;
+};

package/src/data/auth/dto/RoleDto.ts

@@ -0,0 +1,6 @@
+import { ClaimDto } from '@data';
+
+export type RoleDto = {
+  name: string;
+  claims: ClaimDto[];
+};

package/src/data/auth/dto/SignInRequestDto.ts

@@ -0,0 +1,4 @@
+export type SignInRequestDto = {
+  username: string;
+  password: string;
+};

package/src/data/auth/dto/TokensDto.ts

@@ -0,0 +1,4 @@
+export type TokensDto = {
+  accessToken?: string;
+  refreshToken?: string;
+};

package/src/data/auth/dto/UserDto.ts

@@ -0,0 +1,18 @@
+import { ClaimDto } from '@data';
+import { IIdentifiable } from '@data';
+
+/**
+ * Represents a user with an identifier and email address.
+ *
+ * @template TKey The type of the user identifier.
+ *
+ * @param {TKey} id The unique identifier for the user.
+ * @param {string} email The email address associated with the user.
+ * @param {string[]} roles The roles associated with the user.
+ * @param {ClaimDto[]} claims The claims associated with the user.
+ */
+export type UserDto<TKey> = IIdentifiable<TKey> & {
+  email: string;
+  roles: string[];
+  claims: ClaimDto[];
+};

package/src/data/auth/dto/UserInfoDto.ts

@@ -0,0 +1,15 @@
+import { UserDto } from '@data';
+
+/**
+ * Represents user information along with access token expiry.
+ *
+ * @template TKey The type of the user identifier.
+ * @template TUser The type of the user object, defaulting to `UserDto<TKey>`.
+ *
+ * @param {TUser} user The user object containing user details.
+ * @param {Date} accessTokenExpiry The date and time when the access token will expire.
+ */
+export type UserInfoDto<TKey, TUser = UserDto<TKey>> = {
+  user: TUser;
+  accessTokenExpiry: Date;
+};

package/src/data/auth/dto/index.ts

@@ -0,0 +1,5 @@
+export * from './ClaimDto';
+export * from './UserDto';
+export * from './UserInfoDto';
+export * from './RoleDto';
+export * from './RegisterRequestDto';

package/src/data/auth/index.ts

@@ -0,0 +1,2 @@
+export * from './dto';
+export * from './policy';

package/src/data/auth/policy.ts

@@ -0,0 +1,63 @@
+/**
+ * Interface for policies that can be checked.
+ *
+ * @interface IPolicy<TParams extends unknown[]>
+ * @template TParams - The type of the parameters that will be passed to the policy check function.
+ */
+export interface IPolicy<TParams extends unknown[]> {
+  /**
+   * Checks if the policy is valid for the given parameters.
+   *
+   * @param params - Parameters to pass to the policy check function.
+   * @return A promise that resolves if the policy is valid, rejects otherwise.
+   */
+  check(...params: TParams): Promise<boolean>;
+}
+
+/**
+ * Base class for policies. It implements the IPolicy interface.
+ *
+ * @class PolicyBase
+ * @template TParams - The type of the parameters that will be passed to the policy check function.
+ */
+export class PolicyBase<TParams extends unknown[]> implements IPolicy<TParams> {
+  /**
+   * Checks if the policy is valid for the given parameters.
+   *
+   * @return A promise that resolves if the policy is valid, rejects otherwise.
+   * @throws {Error} Error if not implemented.
+   */
+  public async check(): Promise<boolean> {
+    throw new Error('Not implemented');
+  }
+}
+
+/**
+ * Class for policies that can be checked.
+ *
+ * @class Policy
+ * @template TParams - The type of the parameters that will be passed to the policy check function.
+ */
+export class Policy<TParams extends unknown[]> extends PolicyBase<TParams> {
+  private readonly _verificationFn: (...params: TParams) => Promise<boolean>;
+
+  /**
+   * Creates a new policy.
+   *
+   * @param verificationFn - The function that will be used to verify the policy.
+   */
+  constructor(verificationFn: (...params: TParams) => Promise<boolean>) {
+    super();
+    this._verificationFn = verificationFn;
+  }
+
+  /**
+   * Checks if the policy is valid for the given parameters.
+   *
+   * @param params - Parameters to pass to the policy check function.
+   * @return A promise that resolves if the policy is valid, rejects otherwise.
+   */
+  public async check(...params: TParams): Promise<boolean> {
+    return this._verificationFn(...params);
+  }
+}

package/src/data/index.ts

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

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './services';
+export * from './data';
+export * from './adapters';
+export * from './utils';

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

@@ -0,0 +1,46 @@
+import { beforeEach, describe, expect, it } from 'vitest';
+import { ApiCrudControllerClient } from '.';
+import { FetchHttpService } from '../HttpService';
+
+type VehicleSlimDto = { id: number; brand: string; model: string };
+
+describe('ApiCrudControllerClient', () => {
+  let client: ApiCrudControllerClient<number, any, any, any, any>;
+  let fetchService: FetchHttpService;
+  const testId = 100;
+
+  beforeEach(() => {
+    fetchService = new FetchHttpService();
+    client = new ApiCrudControllerClient('/VehiclesSlim', fetchService);
+  });
+
+  it('should use injected HTTP service for create', async () => {
+    const newVehicle: VehicleSlimDto = { id: testId, brand: 'New Brand', model: 'New Model' };
+
+    const result = (await client.create(newVehicle)) as { ok: boolean; result: any };
+
+    expect(result.ok).toBe(true);
+    expect(result.result).toBeDefined();
+    expect(result.result.id).toBe(newVehicle.id);
+    expect(result.result.brand).toBe(newVehicle.brand);
+    expect(result.result.model).toBe(newVehicle.model);
+  });
+
+  it('should use injected HTTP service for update', async () => {
+    const updateVehicle: VehicleSlimDto = { id: testId, brand: 'Updated Brand', model: 'Updated Model' };
+
+    const result = (await client.update(testId, updateVehicle)) as { ok: boolean; result: any };
+
+    expect(result.ok).toBe(true);
+    expect(result.result).toBeDefined();
+    expect(result.result.id).toBe(updateVehicle.id);
+    expect(result.result.brand).toBe(updateVehicle.brand);
+    expect(result.result.model).toBe(updateVehicle.model);
+  });
+
+  it('should use injected HTTP service for delete', async () => {
+    const result = await client.delete(testId);
+
+    expect(result.ok).toBe(true);
+  });
+});

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

@@ -0,0 +1,135 @@
+import { apiInitializationService } from '../ApiInitializationService';
+import { ApiErrorResponseDto, ApiResponseDto, ApiSuccessResponseDto, EmptyMetadataDto } from '../../../data/api/dto';
+import { IIdentifiable } from '../../../data/api/interface';
+import { IHttpService } from '../HttpService';
+import { ApiReadControllerClient } from '../ApiReadControllerClient';
+import { ErrorCode } from '@data';
+import { fail, ok } from '@utils/result';
+
+/**
+ * Generic API client for consuming any Cornerstone CrudController
+ *
+ * @export
+ * @class ApiCrudControllerClient
+ * @template TKey - Type of the entity key (e.g., number, string, GUID, etc.)
+ * @template TDto - Data Transfer Object representing the entity
+ */
+
+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
+   * @param httpService HTTP service implementation to use for requests
+   */
+  constructor(baseControllerPath: string, httpService?: IHttpService) {
+    super(baseControllerPath, httpService);
+  }
+
+  /**
+   * Creates a new entity.
+   * @param dto - Insert request DTO
+   * @param {AbortSignal} [signal] - Optional cancellation signal
+   * @returns The created entity DTO
+   */
+  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, {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify(dto),
+        credentials: 'include',
+        signal,
+      });
+      if (!res.ok) {
+        return fail<ApiSuccessResponseDto<TSingleResultDto, EmptyMetadataDto>, ApiErrorResponseDto>(await res.json());
+      }
+
+      return ok<ApiSuccessResponseDto<TSingleResultDto, EmptyMetadataDto>, ApiErrorResponseDto>(await res.json());
+    } catch (err) {
+      console.error(err);
+
+      return fail<ApiSuccessResponseDto<TSingleResultDto, EmptyMetadataDto>, ApiErrorResponseDto>({
+        error: {
+          code: ErrorCode.UnknownError,
+          message: 'Unknown error occurred while creating the record.',
+          metadata: {} as EmptyMetadataDto,
+        },
+      });
+    }
+  }
+
+  /**
+   * Updates an existing entity.
+   * @param id - The ID of the entity to update
+   * @param dto - Update request DTO
+   * @param {AbortSignal} [signal] - Optional cancellation signal
+   * @returns The updated entity DTO
+   */
+  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, {
+        method: 'PUT',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify(dto),
+        credentials: 'include',
+        signal,
+      });
+
+      if (!res.ok) {
+        return fail<ApiSuccessResponseDto<TSingleResultDto, EmptyMetadataDto>, ApiErrorResponseDto>(await res.json());
+      }
+
+      return ok<ApiSuccessResponseDto<TSingleResultDto, EmptyMetadataDto>, ApiErrorResponseDto>(await res.json());
+    } catch (err) {
+      console.error(err);
+
+      return fail<ApiSuccessResponseDto<TSingleResultDto, EmptyMetadataDto>, ApiErrorResponseDto>({
+        error: {
+          code: ErrorCode.UnknownError,
+          message: `Unknown error occurred while updating the record with id ${id}`,
+          metadata: {} as EmptyMetadataDto,
+        },
+      });
+    }
+  }
+
+  /**
+   * Deletes an entity by ID.
+   * @param id - The ID of the entity to delete
+   * @param {AbortSignal} [signal] - Optional cancellation signal
+   */
+  public async delete(id: TKey, signal?: AbortSignal): Promise<ApiResponseDto<undefined, EmptyMetadataDto>> {
+    try {
+      const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/Delete?id=${encodeURIComponent(String(id))}`);
+      const res = await this.httpService.request(url, {
+        method: 'DELETE',
+        credentials: 'include',
+        signal,
+      });
+
+      if (!res.ok) {
+        return fail<ApiSuccessResponseDto<undefined, EmptyMetadataDto>, ApiErrorResponseDto>(await res.json());
+      }
+
+      return ok<ApiSuccessResponseDto<undefined, EmptyMetadataDto>, ApiErrorResponseDto>(await res.json());
+    } catch (err) {
+      console.error(err);
+
+      return fail<ApiSuccessResponseDto<undefined, EmptyMetadataDto>, ApiErrorResponseDto>({
+        error: {
+          code: ErrorCode.UnknownError,
+          message: `Unknown error occurred while deleting the record with id ${id}`,
+          metadata: {} as EmptyMetadataDto,
+        },
+      });
+    }
+  }
+}