@intellegens/cornerstone-client 0.0.35 → 0.0.36

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

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

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

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

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

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

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

@@ -1,9 +1,3 @@
-export * from './ReadSelectedDefinitionDto';
-export * from './ReadSelectedSearchDefinitionDto';
-export * from './ReadSelectedSearchPropertyDefinitionDto';
-export * from './ReadSelectedOrderingDefinitionDto';
-export * from './ReadSelectedOrderingPropertyDefinitionDto';
-export * from './ReadSelectedPaginationDefinitionDto';
-export * from './ReadOptions';
-export * from './ReadResult';
-export * from './ReadResultMetadata';
+export * from './response';
+export * from './read';
+export * from './crud';

package/data/api/dto/index.js

@@ -1,9 +1,3 @@
-export * from './ReadSelectedDefinitionDto';
-export * from './ReadSelectedSearchDefinitionDto';
-export * from './ReadSelectedSearchPropertyDefinitionDto';
-export * from './ReadSelectedOrderingDefinitionDto';
-export * from './ReadSelectedOrderingPropertyDefinitionDto';
-export * from './ReadSelectedPaginationDefinitionDto';
-export * from './ReadOptions';
-export * from './ReadResult';
-export * from './ReadResultMetadata';
+export * from './response';
+export * from './read';
+export * from './crud';

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

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

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

@@ -1,4 +1,4 @@
-import { ReadSelectedPaginationDefinitionDto, ReadSelectedOrderingDefinitionDto, ReadSelectedSearchDefinitionDto } from '../..';
+import { ReadSelectedPaginationDefinitionDto, ReadSelectedOrderingDefinitionDto, ReadSelectedSearchDefinitionDto } from '../../..';
 /**
  * Defines the selection criteria for a controller to fetch multiple records
  */

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

@@ -1,4 +1,4 @@
-import { ReadSelectedOrderingPropertyDefinitionDto } from '../..';
+import { ReadSelectedOrderingPropertyDefinitionDto } from '../../..';
 /**
  * Represents the ordering definition for a controller.
  */

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

@@ -1,4 +1,4 @@
-import { ReadSelectedOrderingDirection } from '../..';
+import { ReadSelectedOrderingDirection } from '../../..';
 /**
  * Defines the ordering property for a controller.
  */

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

@@ -0,0 +1,18 @@
+import { ReadSelectedLogicalOperator, ReadSelectedSearchPropertyDefinitionDto } from '../../..';
+/**
+ * Defines the filtering options for a controller, including the logical operator and an array of property definitions.
+ */
+export type ReadSelectedSearchDefinitionDto = {
+    /**
+     * Logical operator to be used when applying the filters.
+     */
+    logicalOperator: ReadSelectedLogicalOperator;
+    /**
+     * Property-based search criteria.
+     */
+    propertyCriteria?: ReadSelectedSearchPropertyDefinitionDto[];
+    /**
+     * Nested search definitions for complex queries.
+     */
+    nestedSearchCriteria?: ReadSelectedSearchPropertyDefinitionDto[];
+};

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

@@ -1,4 +1,4 @@
-import { ReadSelectedComparisonOperator, ReadSelectedPropertyType } from '../..';
+import { ReadSelectedComparisonOperator, ReadSelectedPropertyType } from '../../..';
 /**
  * Defines a property used for searching in a controller.
  */
@@ -93,7 +93,7 @@ type Partial_ReadSelectedSearchPropertyDefinition_TypedComparisonOperators = {
     /**
      * The comparison operator to use for the search.
      */
-    comparisonOperator: ReadSelectedComparisonOperator.Equal | ReadSelectedComparisonOperator.NotEqual | ReadSelectedComparisonOperator.Contains | ReadSelectedComparisonOperator.StartsWith | ReadSelectedComparisonOperator.EndsWith;
+    comparisonOperator: ReadSelectedComparisonOperator.Equal | ReadSelectedComparisonOperator.NotEqual | ReadSelectedComparisonOperator.Contains | ReadSelectedComparisonOperator.StartsWith | ReadSelectedComparisonOperator.EndsWith | ReadSelectedComparisonOperator.IContains | ReadSelectedComparisonOperator.IStartsWith | ReadSelectedComparisonOperator.IEndsWith | ReadSelectedComparisonOperator.IEqual | ReadSelectedComparisonOperator.INotEqual;
 } | {
     /**
      * The type of the property value being searched.

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

@@ -0,0 +1,7 @@
+export * from './ReadMetadata';
+export * from './ReadSelectedSearchPropertyDefinitionDto';
+export * from './ReadSelectedOrderingDefinitionDto';
+export * from './ReadSelectedOrderingPropertyDefinitionDto';
+export * from './ReadSelectedPaginationDefinitionDto';
+export * from './ReadSelectedDefinitionDto';
+export * from './ReadSelectedSearchDefinitionDto';

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

@@ -0,0 +1,7 @@
+export * from './ReadMetadata';
+export * from './ReadSelectedSearchPropertyDefinitionDto';
+export * from './ReadSelectedOrderingDefinitionDto';
+export * from './ReadSelectedOrderingPropertyDefinitionDto';
+export * from './ReadSelectedPaginationDefinitionDto';
+export * from './ReadSelectedDefinitionDto';
+export * from './ReadSelectedSearchDefinitionDto';

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

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

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

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

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

@@ -0,0 +1,12 @@
+/**
+ * Represents an successful API response containing a result and metadata.
+ *
+ * @template T The type of result
+ * @template TMetadata The type of metadata
+ * @property {T} result - The result returned
+ * @property {TMetadata} metadata - Metadata about the result
+ */
+export type ApiSuccessResponse<T, TMetadata> = {
+    result: T;
+    metadata: TMetadata;
+};

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

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

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

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

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

@@ -0,0 +1,4 @@
+export * from './ApiResponse';
+export * from './ApiSuccessResponse';
+export * from './ApiError';
+export * from './EmptyMetadata';

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

@@ -0,0 +1,4 @@
+export * from './ApiResponse';
+export * from './ApiSuccessResponse';
+export * from './ApiError';
+export * from './EmptyMetadata';

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

@@ -1,4 +1,2 @@
-export * from './ReadSelectedComparisonOperator';
-export * from './ReadSelectedLogicalOperator';
-export * from './ReadSelectedOrderingDirection';
-export * from './ReadSelectedPropertyType';
+export * from './response';
+export * from './read';

package/data/api/enum/index.js

@@ -1,4 +1,2 @@
-export * from './ReadSelectedComparisonOperator';
-export * from './ReadSelectedLogicalOperator';
-export * from './ReadSelectedOrderingDirection';
-export * from './ReadSelectedPropertyType';
+export * from './response';
+export * from './read';

package/data/api/enum/{ReadSelectedComparisonOperator.d.ts → read/ReadSelectedComparisonOperator.d.ts}

@@ -45,5 +45,25 @@ export declare enum ReadSelectedComparisonOperator {
     /**
      * Represents the ends with comparison operator.
      */
-    EndsWith = 202
+    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
 }

package/data/api/enum/{ReadSelectedComparisonOperator.js → read/ReadSelectedComparisonOperator.js}

@@ -52,5 +52,25 @@ export var ReadSelectedComparisonOperator;
      * Represents the ends with comparison operator.
      */
     ReadSelectedComparisonOperator[ReadSelectedComparisonOperator["EndsWith"] = 202] = "EndsWith";
+    /**
+     * Represents the contains comparison operator (case-insensitive).
+     */
+    ReadSelectedComparisonOperator[ReadSelectedComparisonOperator["IContains"] = 203] = "IContains";
+    /**
+     * Represents the starts with comparison operator (case-insensitive).
+     */
+    ReadSelectedComparisonOperator[ReadSelectedComparisonOperator["IStartsWith"] = 204] = "IStartsWith";
+    /**
+     * Represents the ends with comparison operator (case-insensitive).
+     */
+    ReadSelectedComparisonOperator[ReadSelectedComparisonOperator["IEndsWith"] = 205] = "IEndsWith";
+    /**
+     * Represents the equal comparison operator (case-insensitive).
+     */
+    ReadSelectedComparisonOperator[ReadSelectedComparisonOperator["IEqual"] = 206] = "IEqual";
+    /**
+     * Represents the not equal comparison operator (case-insensitive).
+     */
+    ReadSelectedComparisonOperator[ReadSelectedComparisonOperator["INotEqual"] = 207] = "INotEqual";
     //#endregion
 })(ReadSelectedComparisonOperator || (ReadSelectedComparisonOperator = {}));

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

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

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

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

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

@@ -0,0 +1,7 @@
+/**
+ * Represents available error codes to be returned as part of the ApiResponse object
+ */
+export declare enum ApiErrorCodes {
+    NotFound = 404,
+    BadRequest = 400
+}

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

@@ -0,0 +1,8 @@
+/**
+ * Represents available error codes to be returned as part of the ApiResponse object
+ */
+export var ApiErrorCodes;
+(function (ApiErrorCodes) {
+    ApiErrorCodes[ApiErrorCodes["NotFound"] = 404] = "NotFound";
+    ApiErrorCodes[ApiErrorCodes["BadRequest"] = 400] = "BadRequest";
+})(ApiErrorCodes || (ApiErrorCodes = {}));

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

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

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

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

package/data/api/index.d.ts

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

package/data/api/index.js

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

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

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

package/data/api/interface/IIdentifiableSecondary.js

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

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

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

package/data/api/interface/index.js

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

package/package.json

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

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

@@ -1,5 +1,5 @@
 import { ApiReadControllerClient } from '../ApiReadControllerClient';
-import { IIdentifiable, ReadResult } from '../../../data';
+import { IIdentifiable, ApiSuccessResponse, EmptyMetadata } from '../../../data';
 import { IHttpService } from '../HttpService';
 /**
  * Generic API client for consuming any Cornerstone CrudController
@@ -21,14 +21,14 @@ export declare class ApiCrudControllerClient<TKey, TDto extends IIdentifiable<TK
      * @param dto - Insert request DTO
      * @returns The created entity DTO
      */
-    create(dto: TDto): Promise<ReadResult<TDto>>;
+    create(dto: TDto): Promise<ApiSuccessResponse<TDto, EmptyMetadata>>;
     /**
      * Updates an existing entity.
      * @param id - The ID of the entity to update
      * @param dto - Update request DTO
      * @returns The updated entity DTO
      */
-    update(id: TKey, dto: TDto): Promise<ReadResult<TDto>>;
+    update(id: TKey, dto: TDto): Promise<ApiSuccessResponse<TDto, EmptyMetadata>>;
     /**
      * Deletes an entity by ID.
      * @param id - The ID of the entity to delete

package/services/api/ApiCrudControllerClient/index.js

@@ -25,17 +25,21 @@ export class ApiCrudControllerClient extends ApiReadControllerClient {
     async create(dto) {
         try {
             const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/Create`);
-            const response = await this.httpService.request(url, {
+            const res = await this.httpService.request(url, {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json' },
                 body: JSON.stringify(dto),
                 credentials: 'include',
             });
-            if (!response.ok)
-                throw new Error('Failed to create record');
-            return response.json();
+            if (!res.ok)
+                throw undefined;
+            const { success, result, metadata, error } = (await res.json());
+            if (!success)
+                throw new Error(error.message);
+            return { result, metadata };
         }
         catch (err) {
+            // TODO: Extract error from well-formed response
             throw err instanceof Error ? err : new Error('Unknown error creating record');
         }
     }
@@ -48,17 +52,21 @@ export class ApiCrudControllerClient extends ApiReadControllerClient {
     async update(id, dto) {
         try {
             const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/Update?id=${encodeURIComponent(String(id))}`);
-            const response = await this.httpService.request(url, {
+            const res = await this.httpService.request(url, {
                 method: 'PUT',
                 headers: { 'Content-Type': 'application/json' },
                 body: JSON.stringify(dto),
                 credentials: 'include',
             });
-            if (!response.ok)
-                throw new Error('Failed to update record');
-            return response.json();
+            if (!res.ok)
+                throw undefined;
+            const { success, result, metadata, error } = (await res.json());
+            if (!success)
+                throw new Error(error.message);
+            return { result, metadata };
         }
         catch (err) {
+            // TODO: Extract error from well-formed response
             throw err instanceof Error ? err : new Error('Unknown error updating record');
         }
     }
@@ -74,9 +82,10 @@ export class ApiCrudControllerClient extends ApiReadControllerClient {
                 credentials: 'include',
             });
             if (!response.ok)
-                throw new Error('Failed to delete record');
+                throw undefined;
         }
         catch (err) {
+            // TODO: Extract error from well-formed response
             throw err instanceof Error ? err : new Error('Unknown error deleting record');
         }
     }

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

@@ -1,4 +1,4 @@
-import { IIdentifiable, ReadResult, ReadSelectedDefinitionDto, ReadOptions } from '../../../data';
+import { IIdentifiable, ApiSuccessResponse, ReadSelectedDefinitionDto, ReadMetadata, EmptyMetadata } from '../../../data';
 import { IHttpService } from '../HttpService';
 /**
  * Generic API client for consuming any Cornerstone ReadController
@@ -17,35 +17,25 @@ 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
      */
     protected get httpService(): IHttpService;
     /**
-     * Fetches selected entities based on a search definition.
-     * @param {any} definition - The search definition object
-     * @param options - Optional read options
-     * @returns {Promise<ReadResult<TDto>>} The result of the read operation with metadata
+     * Fetches all entities from the read controller.
+     * @returns {Promise<ApiSuccessResponse<TDto[], ReadMetadata>>} List of all entities with metadata
      */
-    readSelected(definition: ReadSelectedDefinitionDto, options?: ReadOptions): Promise<ReadResult<TDto>>;
+    readAll(): Promise<ApiSuccessResponse<TDto[], ReadMetadata>>;
     /**
-     * Fetches a single entity by its ID.
-     * @param {TKey} id - The ID of the entity
-     * @returns {Promise<TDto | undefined>} The requested entity
+     * Fetches selected entities based on a filter definition.
+     * @param {any} definition - The filter definition object
+     * @returns {Promise<ApiSuccessResponse<TDto[], ReadMetadata>>} The result of the read operation with metadata
      */
-    readSingle(id: TKey): Promise<ReadResult<TDto>>;
+    readSelected(definition: ReadSelectedDefinitionDto): Promise<ApiSuccessResponse<TDto[], ReadMetadata>>;
     /**
-     * Fetches all entities from the read controller.
-     * @param {ReadOptions} options - Optional read options
-     * @returns {Promise<ReadResult<TDto>>} List of all entities with metadata
+     * Fetches a single entity by its ID.
+     * @param {TKey} id - The ID of the entity
+     * @returns {Promise<ApiSuccessResponse<TDto, EmptyMetadata>>} The requested entity
      */
-    readAll(options?: ReadOptions): Promise<ReadResult<TDto>>;
+    readSingle(id: TKey): Promise<ApiSuccessResponse<TDto, EmptyMetadata>>;
 }

package/services/api/ApiReadControllerClient/index.js

@@ -20,21 +20,6 @@ export class ApiReadControllerClient {
     }
     // #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
      */
@@ -44,60 +29,70 @@ export class ApiReadControllerClient {
     // #endregion
     // #region API
     /**
-     * Fetches selected entities based on a search definition.
-     * @param {any} definition - The search definition object
-     * @param options - Optional read options
-     * @returns {Promise<ReadResult<TDto>>} The result of the read operation with metadata
+     * Fetches all entities from the read controller.
+     * @returns {Promise<ApiSuccessResponse<TDto[], ReadMetadata>>} List of all entities with metadata
      */
-    async readSelected(definition, options) {
+    async readAll() {
         try {
-            const url = (await apiInitializationService.getApiUrl(this.baseControllerPath, `/ReadSelected`)) + this.generateQueryParams(options);
-            const response = await this.httpService.request(url, {
+            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/ReadAll`);
+            const res = await this.httpService.request(url, { method: 'GET', credentials: 'include' });
+            if (!res.ok)
+                throw undefined;
+            const { success, result, metadata, error } = (await res.json());
+            if (!success)
+                throw new Error(error.message);
+            return { result, metadata };
+        }
+        catch (err) {
+            // TODO: Extract error from well-formed response
+            throw err instanceof Error ? err : new Error('Unknown error fetching all records');
+        }
+    }
+    /**
+     * Fetches selected entities based on a filter definition.
+     * @param {any} definition - The filter definition object
+     * @returns {Promise<ApiSuccessResponse<TDto[], ReadMetadata>>} The result of the read operation with metadata
+     */
+    async readSelected(definition) {
+        try {
+            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/ReadSelected`);
+            const res = await this.httpService.request(url, {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json' },
                 body: JSON.stringify(definition),
                 credentials: 'include',
             });
-            if (!response.ok)
-                throw new Error('Failed to fetch selected records');
-            return response.json();
+            if (!res.ok)
+                throw undefined;
+            const { success, result, metadata, error } = (await res.json());
+            if (!success)
+                throw new Error(error.message);
+            return { result, metadata };
         }
         catch (err) {
+            // TODO: Extract error from well-formed response
             throw err instanceof Error ? err : new Error('Unknown error fetching selected records');
         }
     }
     /**
      * Fetches a single entity by its ID.
      * @param {TKey} id - The ID of the entity
-     * @returns {Promise<TDto | undefined>} The requested entity
+     * @returns {Promise<ApiSuccessResponse<TDto, EmptyMetadata>>} The requested entity
      */
     async readSingle(id) {
         try {
             const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/ReadSingle?id=${encodeURIComponent(String(id))}`);
-            const response = await this.httpService.request(url, { method: 'GET', credentials: 'include' });
-            if (!response.ok)
-                throw new Error('Failed to fetch single record');
-            return response.json();
+            const res = await this.httpService.request(url, { method: 'GET', credentials: 'include' });
+            if (!res.ok)
+                throw undefined;
+            const { success, result, metadata, error } = (await res.json());
+            if (!success)
+                throw new Error(error.message);
+            return { result, metadata };
         }
         catch (err) {
+            // TODO: Extract error from well-formed response
             throw err instanceof Error ? err : new Error('Unknown error fetching single record');
         }
     }
-    /**
-     * Fetches all entities from the read controller.
-     * @param {ReadOptions} options - Optional read options
-     * @returns {Promise<ReadResult<TDto>>} List of all entities with metadata
-     */
-    async readAll(options) {
-        try {
-            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');
-            return response.json();
-        }
-        catch (err) {
-            throw err instanceof Error ? err : new Error('Unknown error fetching all records');
-        }
-    }
 }

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

@@ -1,6 +1,6 @@
 import { ApiCrudControllerClient } from '../ApiCrudControllerClient';
 import { IHttpService } from '../HttpService';
-import { ReadResult, UserDto, ClaimDto } from '../../../data';
+import { UserDto, ClaimDto, ReadMetadata, ApiSuccessResponse } 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<ReadResult<string>>;
+    getUserRoles(id: TKey): Promise<ApiSuccessResponse<string[], ReadMetadata>>;
     /**
      * 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<ReadResult<ClaimDto>>;
+    getUserClaims(id: TKey): Promise<ApiSuccessResponse<ClaimDto[], ReadMetadata>>;
     /**
      * Gets all available roles in the system
      * @returns List of all role names
      */
-    getAllRoles(): Promise<ReadResult<string>>;
+    getAllRoles(): Promise<ApiSuccessResponse<string[], ReadMetadata>>;
     /**
      * Changes the password for a user
      * @param id - The ID of the user

package/services/api/UserManagementControllerClient/index.js

@@ -25,15 +25,19 @@ export class UserManagementControllerClient extends ApiCrudControllerClient {
     async getUserRoles(id) {
         try {
             const url = await apiInitializationService.getApiUrl(this.baseControllerPath, 'GetUserRoles', encodeURIComponent(String(id)));
-            const response = await this.httpService.request(url, {
+            const res = await this.httpService.request(url, {
                 method: 'GET',
                 credentials: 'include',
             });
-            if (!response.ok)
-                throw new Error('Failed to fetch user roles');
-            return response.json();
+            if (!res.ok)
+                throw undefined;
+            const { success, result, metadata, error } = (await res.json());
+            if (!success)
+                throw new Error(error.message);
+            return { result, metadata };
         }
         catch (err) {
+            // TODO: Extract error from well-formed response
             throw err instanceof Error ? err : new Error('Unknown error fetching user roles');
         }
     }
@@ -45,15 +49,19 @@ export class UserManagementControllerClient extends ApiCrudControllerClient {
     async getUserClaims(id) {
         try {
             const url = await apiInitializationService.getApiUrl(this.baseControllerPath, 'GetUserClaims', encodeURIComponent(String(id)));
-            const response = await this.httpService.request(url, {
+            const res = await this.httpService.request(url, {
                 method: 'GET',
                 credentials: 'include',
             });
-            if (!response.ok)
-                throw new Error('Failed to fetch user claims');
-            return response.json();
+            if (!res.ok)
+                throw undefined;
+            const { success, result, metadata, error } = (await res.json());
+            if (!success)
+                throw new Error(error.message);
+            return { result, metadata };
         }
         catch (err) {
+            // TODO: Extract error from well-formed response
             throw err instanceof Error ? err : new Error('Unknown error fetching user claims');
         }
     }
@@ -64,15 +72,19 @@ export class UserManagementControllerClient extends ApiCrudControllerClient {
     async getAllRoles() {
         try {
             const url = await apiInitializationService.getApiUrl(this.baseControllerPath, 'GetAllRoles');
-            const response = await this.httpService.request(url, {
+            const res = await this.httpService.request(url, {
                 method: 'GET',
                 credentials: 'include',
             });
-            if (!response.ok)
-                throw new Error('Failed to fetch all roles');
-            return response.json();
+            if (!res.ok)
+                throw undefined;
+            const { success, result, metadata, error } = (await res.json());
+            if (!success)
+                throw new Error(error.message);
+            return { result, metadata };
         }
         catch (err) {
+            // TODO: Extract error from well-formed response
             throw err instanceof Error ? err : new Error('Unknown error fetching all roles');
         }
     }
@@ -93,12 +105,11 @@ export class UserManagementControllerClient extends ApiCrudControllerClient {
                 body: JSON.stringify(newPassword),
                 credentials: 'include',
             });
-            if (!response.ok) {
-                const errorText = await response.text();
-                throw new Error(errorText || 'Failed to change password');
-            }
+            if (!response.ok)
+                throw undefined;
         }
         catch (err) {
+            // TODO: Extract error from well-formed response
             throw err instanceof Error ? err : new Error('Unknown error changing password');
         }
     }

package/services/auth/client/AuthService/index.d.ts

@@ -1,4 +1,4 @@
-import { UserDto, UserInfoDto } from '../../../../data';
+import { ApiSuccessResponse, EmptyMetadata, UserDto, UserInfoDto } from '../../../../data';
 export { UserDto, UserInfoDto };
 /**
  * AuthService class is responsible for managing user authentication operations.
@@ -25,7 +25,7 @@ export declare class AuthService<TKey, TUser extends UserDto<TKey> = UserDto<TKe
      * @return {Promise<TUser>} Currently logged in user's details
      * @throws {Error} Error if fetch fails
      */
-    whoAmI(): Promise<TUser | undefined>;
+    whoAmI(): Promise<ApiSuccessResponse<TUser | undefined, EmptyMetadata>>;
     /**
      * Authenticates a user using their username and password, and retrieves user's details
      *
@@ -34,7 +34,7 @@ export declare class AuthService<TKey, TUser extends UserDto<TKey> = UserDto<TKe
      * @return {Promise<TUser>} Currently logged in user's details
      * @throws {Error} Error if fetch fails
      */
-    signin(username: string, password: string): Promise<TUser>;
+    signin(username: string, password: string): Promise<ApiSuccessResponse<TUser, EmptyMetadata>>;
     /**
      * Deauthenticates current user
      *
@@ -46,5 +46,5 @@ export declare class AuthService<TKey, TUser extends UserDto<TKey> = UserDto<TKe
      * If any API response returns an "Unauthenticated" response, call this method
      * to update local authentication state to unauthenticated
      */
-    _handleResponse401(): void;
+    _handleNoAuthApiResponse(): void;
 }

package/services/auth/client/AuthService/index.js

@@ -30,21 +30,24 @@ export class AuthService {
     async whoAmI() {
         try {
             const url = await apiInitializationService.getApiUrl('/auth/whoami');
-            const response = await fetch(url, { credentials: 'include' });
-            if (response.ok) {
-                const info = await response.json();
-                return (this.user = info.user);
-            }
-            else if (response.status === 401) {
-                return (this.user = undefined);
+            const res = await fetch(url, { credentials: 'include' });
+            if (!res.ok && res.status !== 401) {
+                this.user = undefined;
+                throw undefined;
             }
-            else {
+            if (!res.ok && res.status === 401) {
                 this.user = undefined;
-                throw new Error('Failed checking authentication status');
+                return { result: this.user, metadata: {} };
             }
+            const { success, result, metadata, error } = (await res.json());
+            if (!success)
+                throw new Error(error.message);
+            this.user = result;
+            return { result: this.user, metadata };
         }
-        catch (error) {
-            throw error instanceof Error ? error : new Error('Failed checking authentication status');
+        catch (err) {
+            // TODO: Extract error from well-formed response
+            throw err instanceof Error ? err : new Error('Failed checking authentication status');
         }
     }
     /**
@@ -58,27 +61,24 @@ export class AuthService {
     async signin(username, password) {
         try {
             const url = await apiInitializationService.getApiUrl('/auth/signin');
-            const response = await fetch(url, {
+            const res = await fetch(url, {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json' },
                 body: JSON.stringify({ username, password }),
                 credentials: 'include',
             });
-            if (response.ok) {
-                const user = await this.whoAmI();
-                if (user !== undefined) {
-                    return (this.user = user);
-                }
-                else {
-                    throw new Error('Failed signing in');
-                }
-            }
-            else {
-                throw new Error('Failed signing in');
-            }
+            if (!res.ok)
+                throw undefined;
+            // TODO: Handle tokens if not using cookies
+            const { result, metadata } = await this.whoAmI();
+            if (result === undefined)
+                throw undefined;
+            this.user = result;
+            return { result: this.user, metadata };
         }
-        catch (error) {
-            throw error instanceof Error ? error : new Error('Failed signing in');
+        catch (err) {
+            // TODO: Extract error from well-formed response
+            throw err instanceof Error ? err : new Error('Failed signing in');
         }
     }
     /**
@@ -90,24 +90,22 @@ export class AuthService {
     async signout() {
         try {
             const url = await apiInitializationService.getApiUrl('/auth/signout');
-            const response = await fetch(url, { credentials: 'include' });
-            if (response.ok) {
-                this.user = undefined;
-                return;
-            }
-            else {
-                throw new Error('Failed signing out');
-            }
+            const res = await fetch(url, { credentials: 'include' });
+            if (!res.ok)
+                throw undefined;
+            this.user = undefined;
+            return;
         }
-        catch (error) {
-            throw error instanceof Error ? error : new Error('Failed signing out');
+        catch (err) {
+            // TODO: Extract error from well-formed response
+            throw err instanceof Error ? err : new Error('Failed signing out');
         }
     }
     /**
      * If any API response returns an "Unauthenticated" response, call this method
      * to update local authentication state to unauthenticated
      */
-    _handleResponse401() {
+    _handleNoAuthApiResponse() {
         this.user = undefined;
     }
 }

package/services/auth/client/AuthorizationManagementControllerClient/index.d.ts

@@ -1,4 +1,4 @@
-import { RoleDto } from '../../../../data';
+import { ApiSuccessResponse, EmptyMetadata, ReadMetadata, RoleDto } from '../../../../data';
 /**
  * Client for authorization management operations
  *
@@ -17,19 +17,19 @@ export declare class AuthorizationManagementControllerClient {
      * @param includeClaims - Whether to include claims in the response
      * @returns List of all roles
      */
-    getAllRoles(includeClaims: boolean): Promise<RoleDto[]>;
-    /**
-     * Creates or updates a role
-     * @param roleDto - The role to create or update
-     * @returns The created or updated role
-     */
-    upsertRole(roleDto: RoleDto): Promise<RoleDto>;
+    getAllRoles(includeClaims: boolean): Promise<ApiSuccessResponse<RoleDto[], ReadMetadata>>;
     /**
      * Gets a role with its claims
      * @param roleName - The name of the role
      * @returns The role with its claims
      */
-    getRoleWithClaims(roleName: string): Promise<RoleDto>;
+    getRoleWithClaims(roleName: string): Promise<ApiSuccessResponse<RoleDto, ReadMetadata>>;
+    /**
+     * Creates or updates a role
+     * @param roleDto - The role to create or update
+     * @returns The created or updated role
+     */
+    upsertRole(roleDto: RoleDto): Promise<ApiSuccessResponse<RoleDto, EmptyMetadata>>;
     /**
      * Deletes a role
      * @param roleName - The name of the role to delete

package/services/auth/client/AuthorizationManagementControllerClient/index.js

@@ -22,17 +22,44 @@ export class AuthorizationManagementControllerClient {
     async getAllRoles(includeClaims) {
         try {
             const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/GetAllRoles?includeClaims=${includeClaims}`);
-            const response = await fetch(url, {
+            const res = await fetch(url, {
                 credentials: 'include',
             });
-            if (!response.ok)
-                throw new Error('Failed to fetch all roles');
-            return response.json();
+            if (!res.ok)
+                throw undefined;
+            const { success, result, metadata, error } = (await res.json());
+            if (!success)
+                throw new Error(error.message);
+            return { result, metadata };
         }
         catch (err) {
+            // TODO: Extract error from well-formed response
             throw err instanceof Error ? err : new Error('Unknown error fetching all roles');
         }
     }
+    /**
+     * Gets a role with its claims
+     * @param roleName - The name of the role
+     * @returns The role with its claims
+     */
+    async getRoleWithClaims(roleName) {
+        try {
+            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/GetRoleWithClaims/${encodeURIComponent(roleName)}`);
+            const res = await fetch(url, {
+                credentials: 'include',
+            });
+            if (!res.ok)
+                throw undefined;
+            const { success, result, metadata, error } = (await res.json());
+            if (!success)
+                throw new Error(error.message);
+            return { result, metadata };
+        }
+        catch (err) {
+            // TODO: Extract error from well-formed response
+            throw err instanceof Error ? err : new Error('Unknown error fetching role with claims');
+        }
+    }
     /**
      * Creates or updates a role
      * @param roleDto - The role to create or update
@@ -41,7 +68,7 @@ export class AuthorizationManagementControllerClient {
     async upsertRole(roleDto) {
         try {
             const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/UpsertRole`);
-            const response = await fetch(url, {
+            const res = await fetch(url, {
                 method: 'PUT',
                 headers: {
                     'Content-Type': 'application/json',
@@ -49,35 +76,18 @@ export class AuthorizationManagementControllerClient {
                 body: JSON.stringify(roleDto),
                 credentials: 'include',
             });
-            if (!response.ok) {
-                const errorText = await response.text();
-                throw new Error(errorText || 'Failed to upsert role');
-            }
-            return response.json();
+            if (!res.ok)
+                throw undefined;
+            const { success, result, metadata, error } = (await res.json());
+            if (!success)
+                throw new Error(error.message);
+            return { result, metadata };
         }
         catch (err) {
+            // TODO: Extract error from well-formed response
             throw err instanceof Error ? err : new Error('Unknown error upserting role');
         }
     }
-    /**
-     * Gets a role with its claims
-     * @param roleName - The name of the role
-     * @returns The role with its claims
-     */
-    async getRoleWithClaims(roleName) {
-        try {
-            const url = await apiInitializationService.getApiUrl(this.baseControllerPath, `/GetRoleWithClaims/${encodeURIComponent(roleName)}`);
-            const response = await fetch(url, {
-                credentials: 'include',
-            });
-            if (!response.ok)
-                throw new Error('Failed to fetch role with claims');
-            return response.json();
-        }
-        catch (err) {
-            throw err instanceof Error ? err : new Error('Unknown error fetching role with claims');
-        }
-    }
     /**
      * Deletes a role
      * @param roleName - The name of the role to delete
@@ -90,12 +100,11 @@ export class AuthorizationManagementControllerClient {
                 method: 'DELETE',
                 credentials: 'include',
             });
-            if (!response.ok) {
-                const errorText = await response.text();
-                throw new Error(errorText || 'Failed to delete role');
-            }
+            if (!response.ok)
+                throw undefined;
         }
         catch (err) {
+            // TODO: Extract error from well-formed response
             throw err instanceof Error ? err : new Error('Unknown error deleting role');
         }
     }

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

@@ -1,8 +0,0 @@
-/**
- * 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/ReadResult.d.ts

@@ -1,12 +0,0 @@
-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/ReadResultMetadata.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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/ReadSelectedSearchDefinitionDto.d.ts

@@ -1,18 +0,0 @@
-import { ReadSelectedSearchPropertyDefinitionDto, ReadSelectedLogicalOperator } from '../..';
-/**
- * Search definition that supports property searches and nested groups.
- */
-export type ReadSelectedSearchDefinitionDto = {
-    /**
-     * Logical operator (AND/OR) to combine search criteria.
-     */
-    logicalOperator: ReadSelectedLogicalOperator;
-    /**
-     * Property-based search criteria.
-     */
-    propertyCriteria?: ReadSelectedSearchPropertyDefinitionDto[];
-    /**
-     * Nested search definitions for complex queries.
-     */
-    nestedSearchCriteria?: ReadSelectedSearchDefinitionDto[];
-};

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

@@ -1,9 +0,0 @@
-/**
- * Type for entities that have a Guid property.
- */
-export type IIdentifiableByGuid = {
-    /**
-     * Gets or sets the Guid of the entity.
-     */
-    guid: string;
-};

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

@@ -1,11 +0,0 @@
-/**
- * Type for entities that can, but don't have to have an Id property.
- * If present, will be used as a primary key in the database, and if not it signifies an entity that was not yet
- * stored.
- */
-export type IOptionallyIdentifiable<TKey> = {
-    /**
-     * Gets or sets the Id of the entity.
-     */
-    id?: TKey;
-};