@intellegens/cornerstone-client 0.0.28 → 0.0.30

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

@@ -0,0 +1,8 @@
+/**
+ * Options for configuring read operations.
+ *
+ * @property {boolean} includeTotalCount - Whether to include the total count of items in the response.
+ */
+export type ReadOptions = {
+    includeTotalCount: boolean;
+};

package/data/api/dto/ReadOptions.js

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

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

@@ -0,0 +1,12 @@
+import { ReadResultMetadata } from '../..';
+/**
+ * Represents a read result containing a collection of results and metadata.
+ *
+ * @template T The type of result in the collection.
+ * @property {T[]} items - The collection of results returned.
+ * @property {ReadResultMetadata} metadata - Metadata about the paginated result.
+ */
+export type ReadResult<T> = {
+    results: T[];
+    metadata: ReadResultMetadata;
+};

package/data/api/dto/ReadResult.js

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

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

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

package/data/api/dto/ReadResultMetadata.js

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

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

@@ -4,3 +4,6 @@ export * from './ReadSelectedFilteringPropertyDefinitionDto';
 export * from './ReadSelectedOrderingDefinitionDto';
 export * from './ReadSelectedOrderingPropertyDefinitionDto';
 export * from './ReadSelectedPaginationDefinitionDto';
+export * from './ReadOptions';
+export * from './ReadResult';
+export * from './ReadResultMetadata';

package/data/api/dto/index.js

@@ -4,3 +4,6 @@ export * from './ReadSelectedFilteringPropertyDefinitionDto';
 export * from './ReadSelectedOrderingDefinitionDto';
 export * from './ReadSelectedOrderingPropertyDefinitionDto';
 export * from './ReadSelectedPaginationDefinitionDto';
+export * from './ReadOptions';
+export * from './ReadResult';
+export * from './ReadResultMetadata';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intellegens/cornerstone-client",
-  "version": "0.0.28",
+  "version": "0.0.30",
   "main": "index.js",
   "type": "module",
   "scripts": {

package/services/api/ApiCrudControllerClient/index.js

@@ -1,6 +1,5 @@
 import { apiInitializationService } from '../ApiInitializationService';
 import { ApiReadControllerClient } from '../ApiReadControllerClient';
-import { defaultHttpService } from '../HttpService';
 /**
  * Generic API client for consuming any Cornerstone CrudController
  *
@@ -15,7 +14,7 @@ export class ApiCrudControllerClient extends ApiReadControllerClient {
      * @param baseControllerPath Base path to API controller
      * @param httpService HTTP service implementation to use for requests
      */
-    constructor(baseControllerPath, httpService = defaultHttpService) {
+    constructor(baseControllerPath, httpService) {
         super(baseControllerPath, httpService);
     }
     /**

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

@@ -1,4 +1,4 @@
-import { IIdentifiable, ReadSelectedDefinitionDto } from '../../../data';
+import { IIdentifiable, ReadResult, ReadSelectedDefinitionDto, ReadOptions } from '../../../data';
 import { IHttpService } from '../HttpService';
 /**
  * Generic API client for consuming any Cornerstone ReadController
@@ -17,6 +17,14 @@ export declare class ApiReadControllerClient<TKey, TDto extends IIdentifiable<TK
      */
     constructor(baseControllerPath: string, httpService?: IHttpService);
     private _httpService?;
+    /**
+     * Generates a query string from the provided options.
+     *
+     * @param {ReadOptions} options - An object containing query option parameters.
+     * @param {boolean} options.includeTotalCount - Whether to include the total count of items in the response.
+     * @return {string} A query string constructed from the provided options. Returns an empty string if no parameters are provided.
+     */
+    protected generateQueryParams(options?: ReadOptions): string;
     /**
      * Gets globally selected HTTP service
      */
@@ -24,18 +32,20 @@ export declare class ApiReadControllerClient<TKey, TDto extends IIdentifiable<TK
     /**
      * 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
+     * @param options - Optional read options
+     * @returns {Promise<ReadResult<TDto>>} The result of the read operation with metadata
      */
-    readSelected(definition: ReadSelectedDefinitionDto): Promise<TDto[]>;
+    readSelected(definition: ReadSelectedDefinitionDto, options?: ReadOptions): Promise<ReadResult<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>;
+    readSingle(id: TKey): Promise<ReadResult<TDto>>;
     /**
      * Fetches all entities from the read controller.
-     * @returns {Promise<TDto[]>} List of all entities
+     * @param {ReadOptions} options - Optional read options
+     * @returns {Promise<ReadResult<TDto>>} List of all entities with metadata
      */
-    readAll(): Promise<TDto[]>;
+    readAll(options?: ReadOptions): Promise<ReadResult<TDto>>;
 }

package/services/api/ApiReadControllerClient/index.js

@@ -1,5 +1,4 @@
 import { apiInitializationService } from '../ApiInitializationService';
-import { defaultHttpService } from '../HttpService';
 /**
  * Generic API client for consuming any Cornerstone ReadController
  *
@@ -15,12 +14,27 @@ export class ApiReadControllerClient {
      * @param baseControllerPath Base path to API controller
      * @param httpService HTTP service implementation to use for requests
      */
-    constructor(baseControllerPath, httpService = defaultHttpService) {
+    constructor(baseControllerPath, httpService) {
         this.baseControllerPath = baseControllerPath;
         this._httpService = httpService;
     }
     // #region HTTP service
     _httpService = undefined;
+    /**
+     * Generates a query string from the provided options.
+     *
+     * @param {ReadOptions} options - An object containing query option parameters.
+     * @param {boolean} options.includeTotalCount - Whether to include the total count of items in the response.
+     * @return {string} A query string constructed from the provided options. Returns an empty string if no parameters are provided.
+     */
+    generateQueryParams(options) {
+        if (!options)
+            return '';
+        const queryParams = [];
+        if (options.includeTotalCount)
+            queryParams.push(`includeTotalCount=${options.includeTotalCount}`);
+        return queryParams.length > 0 ? `?${queryParams.join('&')}` : '';
+    }
     /**
      * Gets globally selected HTTP service
      */
@@ -32,11 +46,12 @@ export class ApiReadControllerClient {
     /**
      * 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
+     * @param options - Optional read options
+     * @returns {Promise<ReadResult<TDto>>} The result of the read operation with metadata
      */
-    async readSelected(definition) {
+    async readSelected(definition, options) {
         try {
-            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/ReadSelected`);
+            const url = (await apiInitializationService.getApiUrl(this.baseControllerPath, `/ReadSelected`)) + this.generateQueryParams(options);
             const response = await this.httpService.request(url, {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json' },
@@ -70,11 +85,12 @@ export class ApiReadControllerClient {
     }
     /**
      * Fetches all entities from the read controller.
-     * @returns {Promise<TDto[]>} List of all entities
+     * @param {ReadOptions} options - Optional read options
+     * @returns {Promise<ReadResult<TDto>>} List of all entities with metadata
      */
-    async readAll() {
+    async readAll(options) {
         try {
-            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/ReadAll`);
+            const url = (await apiInitializationService.getApiUrl(this.baseControllerPath, `/ReadAll`)) + this.generateQueryParams(options);
             const response = await this.httpService.request(url, { method: 'GET', credentials: 'include' });
             if (!response.ok)
                 throw new Error('Failed to fetch all records');

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

@@ -1,6 +1,6 @@
 import { ApiCrudControllerClient } from '../ApiCrudControllerClient';
 import { IHttpService } from '../HttpService';
-import { UserDto } from '../../../data';
+import { ReadResult, UserDto, ClaimDto } from '../../../data';
 /**
  * Client for user management operations
  *
@@ -21,18 +21,18 @@ export declare class UserManagementControllerClient<TKey, TUser extends UserDto<
      * @param id - The ID of the user
      * @returns List of role names assigned to the user
      */
-    getUserRoles(id: TKey): Promise<string[]>;
+    getUserRoles(id: TKey): Promise<ReadResult<string>>;
     /**
      * Gets the claims assigned to a user
      * @param id - The ID of the user
      * @returns List of claims assigned to the user
      */
-    getUserClaims(id: TKey): Promise<Record<string, string>>;
+    getUserClaims(id: TKey): Promise<ReadResult<ClaimDto>>;
     /**
      * Gets all available roles in the system
      * @returns List of all role names
      */
-    getAllRoles(): Promise<string[]>;
+    getAllRoles(): Promise<ReadResult<string>>;
     /**
      * Changes the password for a user
      * @param id - The ID of the user

package/services/api/UserManagementControllerClient/index.js

@@ -1,6 +1,5 @@
 import { ApiCrudControllerClient } from '../ApiCrudControllerClient';
 import { apiInitializationService } from '../ApiInitializationService';
-import { defaultHttpService } from '../HttpService';
 /**
  * Client for user management operations
  *
@@ -15,7 +14,7 @@ export class UserManagementControllerClient extends ApiCrudControllerClient {
      * @param baseControllerPath Base path to API controller
      * @param httpService HTTP service implementation to use for requests
      */
-    constructor(baseControllerPath, httpService = defaultHttpService) {
+    constructor(baseControllerPath, httpService) {
         super(baseControllerPath, httpService);
     }
     /**
@@ -25,7 +24,7 @@ export class UserManagementControllerClient extends ApiCrudControllerClient {
      */
     async getUserRoles(id) {
         try {
-            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/GetUserRoles${encodeURIComponent(String(id))}`);
+            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, 'GetUserRoles', encodeURIComponent(String(id)));
             const response = await this.httpService.request(url, {
                 method: 'GET',
                 credentials: 'include',
@@ -45,7 +44,7 @@ export class UserManagementControllerClient extends ApiCrudControllerClient {
      */
     async getUserClaims(id) {
         try {
-            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/GetUserClaims/${encodeURIComponent(String(id))}`);
+            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, 'GetUserClaims', encodeURIComponent(String(id)));
             const response = await this.httpService.request(url, {
                 method: 'GET',
                 credentials: 'include',
@@ -64,7 +63,7 @@ export class UserManagementControllerClient extends ApiCrudControllerClient {
      */
     async getAllRoles() {
         try {
-            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/GetAllRoles`);
+            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, 'GetAllRoles');
             const response = await this.httpService.request(url, {
                 method: 'GET',
                 credentials: 'include',
@@ -85,7 +84,7 @@ export class UserManagementControllerClient extends ApiCrudControllerClient {
      */
     async changePassword(id, newPassword) {
         try {
-            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/ChangePassword/${encodeURIComponent(String(id))}`);
+            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, 'ChangePassword', encodeURIComponent(String(id)));
             const response = await this.httpService.request(url, {
                 method: 'POST',
                 headers: {