@intellegens/cornerstone-client 0.0.44 → 0.0.9999-alpha-1

package/data/api/dto/ReadResultMetadataDto.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Metadata associated with a paginated read result.
+ *
+ * @property {number} [totalCount]   - The total number of items available.
+ */
+export type ReadResultMetadataDto = {
+    totalCount?: number;
+};

package/data/api/dto/crud/{CrudMetadata.d.ts → CrudMetadataDto.d.ts}

@@ -1,4 +1,4 @@
 /**
  * Metadata associated with a crud result.
  */
-export type CrudMetadata = object;
+export type CrudMetadataDto = object;

package/data/api/dto/crud/index.d.ts

@@ -1 +1 @@
-export * from './CrudMetadata';
+export * from './CrudMetadataDto';

package/data/api/dto/crud/index.js

@@ -1 +1 @@
-export * from './CrudMetadata';
+export * from './CrudMetadataDto';

package/data/api/dto/index.d.ts

@@ -1,3 +1,4 @@
 export * from './response';
 export * from './read';
 export * from './crud';
+export * from './PropertyPathDto';

package/data/api/dto/index.js

@@ -1,3 +1,4 @@
 export * from './response';
 export * from './read';
 export * from './crud';
+export * from './PropertyPathDto';

package/data/api/dto/read/{ReadMetadata.d.ts → ReadMetadataDto.d.ts}

@@ -3,6 +3,6 @@
  *
  * @property {number} [totalCount] - The total number of items available.
  */
-export type ReadMetadata = {
+export type ReadMetadataDto = {
     totalCount?: number;
 };

package/data/api/dto/read/ReadSelectedOrderingPropertyDefinitionDto.d.ts

@@ -1,4 +1,4 @@
-import { ReadSelectedOrderingDirection } from '../../..';
+import { PropertyPathDto, ReadSelectedOrderingDirection } from '../../..';
 /**
  * Defines the ordering property for a controller.
  */
@@ -6,7 +6,7 @@ export type ReadSelectedOrderingPropertyDefinitionDto = {
     /**
      * Gets or sets the property path.
      */
-    propertyPath: string;
+    propertyPath: PropertyPathDto[];
     /**
      * Gets or sets the sort direction.
      */

package/data/api/dto/read/ReadSelectedSearchPropertyDefinitionDto.d.ts

@@ -1,4 +1,4 @@
-import { ReadSelectedComparisonOperator, ReadSelectedPropertyType } from '../../..';
+import { PropertyPathDto, ReadSelectedComparisonOperator, ReadSelectedPropertyType } from '../../..';
 /**
  * Defines a property used for searching in a controller.
  */
@@ -10,7 +10,7 @@ type Partial_ReadSelectedSearchPropertyDefinition_IndependentProperties = {
     /**
      * The path to the property being searched.
      */
-    propertyPath: string;
+    propertyPath: PropertyPathDto;
     /**
      * The comparison operator to use for the search.
      */

package/data/api/dto/read/index.d.ts

@@ -1,4 +1,4 @@
-export * from './ReadMetadata';
+export * from './ReadMetadataDto';
 export * from './ReadSelectedSearchPropertyDefinitionDto';
 export * from './ReadSelectedOrderingDefinitionDto';
 export * from './ReadSelectedOrderingPropertyDefinitionDto';

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

@@ -1,4 +1,4 @@
-export * from './ReadMetadata';
+export * from './ReadMetadataDto';
 export * from './ReadSelectedSearchPropertyDefinitionDto';
 export * from './ReadSelectedOrderingDefinitionDto';
 export * from './ReadSelectedOrderingPropertyDefinitionDto';

package/data/api/dto/response/{ApiError.d.ts → ApiErrorDto.d.ts}

@@ -2,7 +2,7 @@ import { ApiErrorCodes } from '../../..';
 /**
  * Default, empty metadata.
  */
-export type ApiError = {
+export type ApiErrorDto = {
     code: ApiErrorCodes;
     message: string;
 };

package/data/api/dto/response/ApiErrorDto.js

@@ -0,0 +1 @@
+export {};

package/data/api/dto/response/{ApiResponse.d.ts → ApiResponseDto.d.ts}

@@ -1,4 +1,4 @@
-import { ApiError } from '../../..';
+import { ApiErrorDto } from '../../..';
 /**
  * Represents an API response containing a result and metadata, or an error.
  *
@@ -7,9 +7,9 @@ import { ApiError } from '../../..';
  * @property {T} result - The result returned
  * @property {TMetadata} metadata - Metadata about the result
  */
-export type ApiResponse<T, TMetadata> = {
+export type ApiResponseDto<T, TMetadata> = {
     success: boolean;
     result: T;
     metadata: TMetadata;
-    error: ApiError;
+    error: ApiErrorDto;
 };

package/data/api/dto/response/ApiResponseDto.js

@@ -0,0 +1 @@
+export {};

package/data/api/dto/response/{ApiSuccessResponse.d.ts → ApiSuccessResponseDto.d.ts}

@@ -6,7 +6,7 @@
  * @property {T} result - The result returned
  * @property {TMetadata} metadata - Metadata about the result
  */
-export type ApiSuccessResponse<T, TMetadata> = {
+export type ApiSuccessResponseDto<T, TMetadata> = {
     result: T;
     metadata: TMetadata;
 };

package/data/api/dto/response/ApiSuccessResponseDto.js

@@ -0,0 +1 @@
+export {};

package/data/api/dto/response/EmptyMetadataDto.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Default, empty metadata.
+ */
+export type EmptyMetadataDto = object;

package/data/api/dto/response/EmptyMetadataDto.js

@@ -0,0 +1 @@
+export {};

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

@@ -1,4 +1,4 @@
-export * from './ApiResponse';
-export * from './ApiSuccessResponse';
-export * from './ApiError';
-export * from './EmptyMetadata';
+export * from './ApiResponseDto';
+export * from './ApiSuccessResponseDto';
+export * from './ApiErrorDto';
+export * from './EmptyMetadataDto';

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

@@ -1,4 +1,4 @@
-export * from './ApiResponse';
-export * from './ApiSuccessResponse';
-export * from './ApiError';
-export * from './EmptyMetadata';
+export * from './ApiResponseDto';
+export * from './ApiSuccessResponseDto';
+export * from './ApiErrorDto';
+export * from './EmptyMetadataDto';

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

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

package/data/api/interface/IConcurrencySafe.js

@@ -0,0 +1,2 @@
+;
+export {};

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

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

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

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

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

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

package/data/api/interface/index.js

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

package/index.d.ts

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

package/index.js

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

package/package.json

@@ -1,19 +1,25 @@
 {
   "name": "@intellegens/cornerstone-client",
-  "version": "0.0.44",
-  "main": "index.js",
+  "version": "0.0.9999-alpha-1",
+  "private": false,
+  "publishable": true,
+  "main": "./index.js",
+  "types": "./index.d.ts",
   "type": "module",
+  "author": "Intellegens",
+  "license": "MIT",
+  "description": "",
+  "keywords": [
+    "intellegens",
+    "cornerstone"
+  ],
   "scripts": {
-    "clean": "node -e \"require('fs-extra').emptyDir('./dist');\"",
+    "clean": "npx --yes rimraf '{dist}'",
     "test": "jest",
-    "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage",
+    "coverage": "jest --coverage",
     "build": "npm run clean && tsc && tsc-alias",
-    "demo": "npm run build && npx vite build && npx tsx ./demo"
+    "start": "npm run build && npx vite build && npx tsx ./demo"
   },
-  "author": "",
-  "license": "MIT",
-  "description": "",
   "devDependencies": {
     "@eslint/js": "^9.21.0",
     "@types/express": "^5.0.0",
@@ -22,7 +28,6 @@
     "eslint": "^9.21.0",
     "eslint-config-prettier": "^10.0.1",
     "express": "^4.21.2",
-    "fs-extra": "^11.3.0",
     "globals": "^16.0.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",

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

@@ -1,6 +1,7 @@
-import { ApiReadControllerClient } from '../ApiReadControllerClient';
-import { IIdentifiable, ApiSuccessResponse, EmptyMetadata } from '../../../data';
+import { ApiSuccessResponseDto, EmptyMetadataDto } from '../../../data/api/dto';
+import { IIdentifiable } from '../../../data/api/interface';
 import { IHttpService } from '../HttpService';
+import { ApiReadControllerClient } from '../ApiReadControllerClient';
 /**
  * Generic API client for consuming any Cornerstone CrudController
  *
@@ -19,19 +20,22 @@ export declare class ApiCrudControllerClient<TKey, TDto extends IIdentifiable<TK
     /**
      * Creates a new entity.
      * @param dto - Insert request DTO
+     * @param {AbortSignal} [signal] - Optional cancellation signal
      * @returns The created entity DTO
      */
-    create(dto: TDto): Promise<ApiSuccessResponse<TDto, EmptyMetadata>>;
+    createAsync(dto: TDto, signal?: AbortSignal): Promise<ApiSuccessResponseDto<TDto, 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
      */
-    update(id: TKey, dto: TDto): Promise<ApiSuccessResponse<TDto, EmptyMetadata>>;
+    updateAsync(id: TKey, dto: TDto, signal?: AbortSignal): Promise<ApiSuccessResponseDto<TDto, EmptyMetadataDto>>;
     /**
      * Deletes an entity by ID.
      * @param id - The ID of the entity to delete
+     * @param {AbortSignal} [signal] - Optional cancellation signal
      */
-    delete(id: TKey): Promise<void>;
+    deleteAsync(id: TKey, signal?: AbortSignal): Promise<void>;
 }

package/services/api/ApiCrudControllerClient/index.js

@@ -20,16 +20,18 @@ export class ApiCrudControllerClient extends ApiReadControllerClient {
     /**
      * Creates a new entity.
      * @param dto - Insert request DTO
+     * @param {AbortSignal} [signal] - Optional cancellation signal
      * @returns The created entity DTO
      */
-    async create(dto) {
+    async createAsync(dto, signal) {
         try {
-            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/Create`);
-            const res = await this.httpService.request(url, {
+            const url = await apiInitializationService.getApiUrlAsync(this.baseControllerPath, `/Create`);
+            const res = await this.httpService.requestAsync(url, {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json' },
                 body: JSON.stringify(dto),
                 credentials: 'include',
+                signal,
             });
             if (!res.ok)
                 throw undefined;
@@ -47,16 +49,18 @@ export class ApiCrudControllerClient extends ApiReadControllerClient {
      * 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
      */
-    async update(id, dto) {
+    async updateAsync(id, dto, signal) {
         try {
-            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/Update?id=${encodeURIComponent(String(id))}`);
-            const res = await this.httpService.request(url, {
+            const url = await apiInitializationService.getApiUrlAsync(this.baseControllerPath, `/Update?id=${encodeURIComponent(String(id))}`);
+            const res = await this.httpService.requestAsync(url, {
                 method: 'PUT',
                 headers: { 'Content-Type': 'application/json' },
                 body: JSON.stringify(dto),
                 credentials: 'include',
+                signal,
             });
             if (!res.ok)
                 throw undefined;
@@ -73,13 +77,15 @@ export class ApiCrudControllerClient extends ApiReadControllerClient {
     /**
      * Deletes an entity by ID.
      * @param id - The ID of the entity to delete
+     * @param {AbortSignal} [signal] - Optional cancellation signal
      */
-    async delete(id) {
+    async deleteAsync(id, signal) {
         try {
-            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/Delete?id=${encodeURIComponent(String(id))}`);
-            const response = await this.httpService.request(url, {
+            const url = await apiInitializationService.getApiUrlAsync(this.baseControllerPath, `/Delete?id=${encodeURIComponent(String(id))}`);
+            const response = await this.httpService.requestAsync(url, {
                 method: 'DELETE',
                 credentials: 'include',
+                signal,
             });
             if (!response.ok)
                 throw undefined;

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

@@ -1,3 +1,10 @@
+/**
+ * Generic shared settings interface - can represent any user-configured settings structure
+ * The actual properties depend on what users configure in their appsettings.json or environment variables
+ */
+type ISharedSettings = {
+    [key: string]: any;
+};
 import { IHttpService } from '../HttpService';
 /**
  * Central API configuration service, fetches and exposes Cornerstone API configuration
@@ -11,13 +18,16 @@ export declare class ApiInitializationService {
      *
      * 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.
      */
-    initialize({ httpService }?: {
+    initializeAsync({ httpService, signal }?: {
         httpService?: IHttpService;
+        signal?: AbortSignal;
     }): Promise<void>;
     private _httpService;
     /**
@@ -56,10 +66,11 @@ export declare class ApiInitializationService {
      * IMPORTANT: This method is not meant to be used in normal cases - when ever possible use the .getApiUrl(relativeEndpointPath: string) method instead.
      *
      * @async
+     * @param {AbortSignal} [signal] - Optional cancellation signal
      * @return {Promise<string | undefined>} Returns detected API base URL
      * @throws {Error} Throws error if either of the detection methods fails
      */
-    _getApiBaseUrl(): Promise<string | undefined>;
+    _getApiBaseUrlAsync(signal?: AbortSignal): Promise<string | undefined>;
     /**
      * Composes a full API URL for a provided endpoint path.
      *
@@ -68,7 +79,7 @@ export declare class ApiInitializationService {
      * @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>;
+    getApiUrlAsync(...relativeEndpointPathSections: string[]): Promise<string>;
     /**
      * Removes starting '/' character
      * @param str String to remove the starting '/' character from
@@ -81,8 +92,15 @@ 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
+    */
+    private _getAppConfigAsync;
 }
 /**
  * Singleton instance of ApiInitializationService
  */
 export declare const apiInitializationService: ApiInitializationService;
+export {};