@intellegens/cornerstone-client 0.0.9999-alpha-3 → 0.0.9999-alpha-4

package/adapters/CollectionViewAdapter/index.d.ts

@@ -1,5 +1,4 @@
-import { IIdentifiable, ReadSelectedOrderingDirection, ReadSelectedSearchDefinitionDto } from '../../data';
-import { PropertyPathDto } from '../../data';
+import { IIdentifiable, PropertyPathDto, ReadSelectedOrderingDirection, ReadSelectedSearchDefinitionDto } from '../../data';
 /**
  * Used with CollectionViewAdapter, a simplified configuration object for handling reading/writing from/to ReadSelectedDefinitionDto.
  *
@@ -12,38 +11,41 @@ import { PropertyPathDto } from '../../data';
  * @property {number} [pagination.pageSize] - Number of items/rows to be fetched for the current page.
  * @property {number} [pagination.pageNumber] - Current page index (skips fetching `(n-1) * pageSize` items/rows).
  *
- * @property {object} sorting - Sorting configuration
- * @property {PropertyPathDto[]} [sorting.sortByPath] - Array of column/property names that are sortable.
- * @property {ReadSelectedOrderingDirection} [sorting.sortDirection] - Enum for ascending/descending sort order.
+ * @property {object} ordering - Ordering configuration
+ * @property {string[]} [ordering.orderByPath] - Array of column/property names that are sortable.
+ * @property {ReadSelectedOrderingDirection} [ordering.orderDirection] - Enum for ascending/descending sort order.
  *
- * @property {object} searching - Search configuration
- * @property {PropertyPathDto[]} [searching.textSearchablePaths] - Array of column/property names that are searchable where the value type is string.
- * @property {PropertyPathDto[]} [searching.numericSearchablePaths] - Array of column/property names that are searchable where the value type is number.
- * @property {ReadSelectedSearchDefinitionDto} [searching.searchDefinition] - The search definition by which the collection will be filtered.
+ * @property {object} search - Search configuration
+ * @property {(keyof TDto)[]} [search.textSearchableProperties] - Array of column/property names that are searchable where the value type is string.
+ * @property {(keyof TDto)[]} [search.numericSearchableProperties] - Array of column/property names that are searchable where the value type is number.
+ * @property {ReadSelectedSearchDefinitionDto<TDto>} [search.searchDefinition] - The search definition by which the collection will be filtered.
  */
-export type CollectionViewAdapterOptions = {
+export type CollectionViewAdapterOptions<TDto> = {
     pagination: {
         useTotalItemCount: boolean;
         pageSize?: number;
         pageNumber?: number;
     };
-    sorting: {
-        sortByPath?: PropertyPathDto[];
-        sortDirection?: ReadSelectedOrderingDirection;
+    ordering: {
+        maxActiveOrderingColumns: number;
+        orderByPaths: {
+            orderByPath: PropertyPathDto;
+            orderDirection: ReadSelectedOrderingDirection;
+        }[];
     };
-    searching: {
-        textSearchablePaths?: PropertyPathDto[];
-        numericSearchablePaths?: PropertyPathDto[];
-        searchDefinition?: ReadSelectedSearchDefinitionDto;
+    search: {
+        textSearchableProperties?: (keyof TDto)[];
+        numericSearchableProperties?: (keyof TDto)[];
+        searchDefinition?: ReadSelectedSearchDefinitionDto<TDto>;
     };
 };
 /**
- * TS class for handling sorting, filtering and paginating collections
+ * TS class for handling ordering, filtering and paginating collections
  *
  * @param controllerName - specify the target endpoint controller name.
  * @param dataChangedCallback - Function invoked whenever the data changes.
  * Receives a loading state flag and the updated data collection.
- * @param options - Optional settings of type `CollectionViewAdapterOptions<TDto>` to customize the behavior of the adapter.
+ * @param options - Optional settings of type CollectionViewAdapter to customize the behavior of the adapter.
  */
 export declare class CollectionViewAdapter<TKey, TDto extends IIdentifiable<TKey>> {
     private _readClient;
@@ -52,25 +54,29 @@ export declare class CollectionViewAdapter<TKey, TDto extends IIdentifiable<TKey
     private _defaultOptions;
     private _initialOptions;
     private _currentOptions;
-    constructor(controllerName: string, dataChangedCallback: (isLoading: boolean, data: TDto[] | undefined, error: string | undefined) => void, options?: CollectionViewAdapterOptions);
+    constructor(controllerName: string, dataChangedCallback: (isLoading: boolean, data: TDto[] | undefined, error: string | undefined) => void, options?: CollectionViewAdapterOptions<TDto>);
     /**
      * Allows for adding any filtering criteria. Label is required to distinguish custom search categories (e.g. searchTerm, dateRange, anyCustom ...)
      */
-    setSearchDefinition(searchDefinition: ReadSelectedSearchDefinitionDto): Promise<TDto[]>;
+    setSearchDefinition(searchDefinition: ReadSelectedSearchDefinitionDto<TDto>): Promise<TDto[]>;
     /**
-     * Public method for sorting the collection by property path / column name.
+     * Compares two PropertyPathDto arrays for equality
+     */
+    private _arePropertyPathsEqual;
+    /**
+     * Public method for ordering the collection by property path / column name.
      *
      * @param propertyPath - must match camel-cased property/column name being sorted
-     * @param sortDirection - use `ReadSelectedOrderingDirection` enum choices
+     * @param orderDirection - use `ReadSelectedOrderingDirection` enum choices
      */
-    setSorting(propertyPath: PropertyPathDto, sortDirection: ReadSelectedOrderingDirection): Promise<TDto[]>;
+    setOrdering(propertyPath: PropertyPathDto, orderDirection: ReadSelectedOrderingDirection): Promise<TDto[]>;
     /**
-     * Returns the camel-cased property path of the current column/property on which sorting is applied, along with the `ReadSelectedOrderingDirection` direction
+     * Returns the property name of the current columns/properties on which ordering is applied, along with the `ReadSelectedOrderingDirection` direction
      */
-    getCurrentSort(): {
-        sortByPath: PropertyPathDto | undefined;
-        sortDirection: ReadSelectedOrderingDirection | undefined;
-    };
+    getCurrentOrdering(): {
+        orderByPath: PropertyPathDto;
+        orderDirection: ReadSelectedOrderingDirection;
+    }[];
     /**
      * Returns the current page's page number
      */
@@ -103,7 +109,7 @@ export declare class CollectionViewAdapter<TKey, TDto extends IIdentifiable<TKey
      * Callback function invoked whenever data changes.
      * Receives a loading state flag and the updated data collection.
      */
-    private _dataChangedCallback;
+    private readonly _dataChangedCallback;
     /**
      * Timeout reference used to debounce calls to `_fetchCurrentPageData`.
      */

package/adapters/CollectionViewAdapter/index.js

@@ -1,13 +1,12 @@
-import { ReadSelectedOrderingDirection } from '../../data';
 import { toPascalCase } from '../../utils';
 import { ApiReadControllerClient } from '../../services';
 /**
- * TS class for handling sorting, filtering and paginating collections
+ * TS class for handling ordering, filtering and paginating collections
  *
  * @param controllerName - specify the target endpoint controller name.
  * @param dataChangedCallback - Function invoked whenever the data changes.
  * Receives a loading state flag and the updated data collection.
- * @param options - Optional settings of type `CollectionViewAdapterOptions<TDto>` to customize the behavior of the adapter.
+ * @param options - Optional settings of type CollectionViewAdapter to customize the behavior of the adapter.
  */
 export class CollectionViewAdapter {
     _readClient;
@@ -19,13 +18,13 @@ export class CollectionViewAdapter {
             pageSize: 10,
             pageNumber: 1,
         },
-        sorting: {
-            sortByPath: [],
-            sortDirection: ReadSelectedOrderingDirection.Ascending,
+        ordering: {
+            maxActiveOrderingColumns: 1,
+            orderByPaths: [],
         },
-        searching: {
-            textSearchablePaths: [],
-            numericSearchablePaths: [],
+        search: {
+            textSearchableProperties: [],
+            numericSearchableProperties: [],
         },
     };
     _initialOptions;
@@ -37,54 +36,71 @@ export class CollectionViewAdapter {
                 ...this._defaultOptions.pagination,
                 ...options?.pagination,
             },
-            sorting: {
-                ...this._defaultOptions.sorting,
-                ...options?.sorting,
+            ordering: {
+                ...this._defaultOptions.ordering,
+                ...options?.ordering,
             },
-            searching: {
-                ...this._defaultOptions.searching,
-                ...options?.searching,
+            search: {
+                ...this._defaultOptions.search,
+                ...options?.search,
             },
         };
         this._currentOptions = {
             pagination: { ...this._initialOptions.pagination },
-            sorting: { ...this._initialOptions.sorting },
-            searching: { ...this._initialOptions.searching },
+            ordering: { ...this._initialOptions.ordering },
+            search: { ...this._initialOptions.search },
         };
         this._dataChangedCallback = dataChangedCallback;
         this._fetchCurrentPageData();
     }
-    //#region SEARCHING ------------------------------------------
+    //#region SEARCH
     /**
      * Allows for adding any filtering criteria. Label is required to distinguish custom search categories (e.g. searchTerm, dateRange, anyCustom ...)
      */
     setSearchDefinition(searchDefinition) {
-        this._currentOptions.searching.searchDefinition = searchDefinition;
+        this._currentOptions.search.searchDefinition = searchDefinition;
         this._currentOptions.pagination.pageNumber = 1; // Reset to first page
         return this._fetchCurrentPageData();
     }
-    //#endregion -----------------------------------------------
-    //#region SORTING ------------------------------------------
+    //#endregion
+    //#region ORDERING
     /**
-     * Public method for sorting the collection by property path / column name.
+     * Compares two PropertyPathDto arrays for equality
+     */
+    _arePropertyPathsEqual(path1, path2) {
+        if (path1.length !== path2.length)
+            return false;
+        return path1.every((segment, index) => segment === path2[index]);
+    }
+    /**
+     * Public method for ordering the collection by property path / column name.
      *
      * @param propertyPath - must match camel-cased property/column name being sorted
-     * @param sortDirection - use `ReadSelectedOrderingDirection` enum choices
+     * @param orderDirection - use `ReadSelectedOrderingDirection` enum choices
      */
-    setSorting(propertyPath, sortDirection) {
-        this._currentOptions.sorting.sortByPath = [propertyPath];
-        this._currentOptions.sorting.sortDirection = sortDirection;
+    setOrdering(propertyPath, orderDirection) {
+        // Remove any existing ordering for this property path
+        this._currentOptions.ordering.orderByPaths = this._currentOptions.ordering.orderByPaths.filter(p => !this._arePropertyPathsEqual(p.orderByPath, propertyPath));
+        // Add the new ordering at the beginning
+        this._currentOptions.ordering.orderByPaths.unshift({
+            orderByPath: propertyPath,
+            orderDirection: orderDirection,
+        });
+        // Limit to maxActiveOrderingColumns
+        if (this._currentOptions.ordering.orderByPaths.length > this._currentOptions.ordering.maxActiveOrderingColumns) {
+            this._currentOptions.ordering.orderByPaths = this._currentOptions.ordering.orderByPaths.slice(0, this._currentOptions.ordering.maxActiveOrderingColumns);
+        }
         this._currentOptions.pagination.pageNumber = 1; // Reset to first page
         return this._fetchCurrentPageData();
     }
     /**
-     * Returns the camel-cased property path of the current column/property on which sorting is applied, along with the `ReadSelectedOrderingDirection` direction
+     * Returns the property name of the current columns/properties on which ordering is applied, along with the `ReadSelectedOrderingDirection` direction
      */
-    getCurrentSort() {
-        return { sortByPath: this._currentOptions.sorting.sortByPath?.[0], sortDirection: this._currentOptions.sorting.sortDirection };
+    getCurrentOrdering() {
+        return this._currentOptions.ordering.orderByPaths;
     }
-    //#endregion -----------------------------------------------
-    //#region PAGINATION ---------------------------------------
+    //#endregion
+    //#region PAGINATION
     /**
      * Returns the current page's page number
      */
@@ -126,7 +142,7 @@ export class CollectionViewAdapter {
     get totalItemCount() {
         return this._totalItemCount;
     }
-    //#endregion -----------------------------------------------
+    //#endregion
     /**
      * Callback function invoked whenever data changes.
      * Receives a loading state flag and the updated data collection.
@@ -198,10 +214,13 @@ export class CollectionViewAdapter {
             abortController = new AbortController();
             this._currentAbortController = abortController;
             const definition = this._parseOptionsToDefinition();
-            const { result, metadata } = await this._readClient.readSelectedAsync(definition, abortController?.signal);
-            this._pageData = result;
-            if (this._currentOptions.pagination.useTotalItemCount && metadata.totalCount !== undefined) {
-                this._totalItemCount = metadata.totalCount;
+            const response = await this._readClient.readSelectedAsync(definition, abortController?.signal);
+            if (!response.ok) {
+                throw response.error;
+            }
+            this._pageData = response.result;
+            if (this._currentOptions.pagination.useTotalItemCount && response.metadata.totalCount !== undefined) {
+                this._totalItemCount = response.metadata.totalCount;
             }
             else {
                 const pageSize = this._currentOptions.pagination.pageSize;
@@ -245,16 +264,18 @@ export class CollectionViewAdapter {
                 limit: this._currentOptions.pagination.pageSize,
             },
         };
-        // Apply sorting
-        const sortPaths = this._currentOptions.sorting.sortByPath;
-        const sortDirection = this._currentOptions.sorting.sortDirection;
-        if (sortPaths && sortPaths.length > 0) {
+        // Apply ordering
+        const orderByPaths = this._currentOptions.ordering.orderByPaths;
+        if (orderByPaths && orderByPaths.length > 0) {
             definition.orderingDefinition = {
-                order: [{ propertyPath: sortPaths.map(path => toPascalCase(path)), direction: sortDirection ?? ReadSelectedOrderingDirection.Ascending }],
+                order: orderByPaths.map(orderPath => ({
+                    propertyPath: orderPath.orderByPath.map(x => toPascalCase(x)),
+                    direction: orderPath.orderDirection,
+                })),
             };
         }
         // Apply search
-        definition.searchDefinition = this._currentOptions.searching.searchDefinition;
+        definition.searchDefinition = this._currentOptions.search.searchDefinition;
         return definition;
     }
     /**

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

@@ -2,7 +2,7 @@ import { ReadSelectedPaginationDefinitionDto, ReadSelectedOrderingDefinitionDto,
 /**
  * Defines the selection criteria for a controller to fetch multiple records
  */
-export type ReadSelectedDefinitionDto = {
+export type ReadSelectedDefinitionDto<T> = {
     /**
      * Pagination definition
      */
@@ -14,5 +14,5 @@ export type ReadSelectedDefinitionDto = {
     /**
      * Search definition (supports both simple search and nested logical groups)
      */
-    searchDefinition?: ReadSelectedSearchDefinitionDto;
+    searchDefinition?: ReadSelectedSearchDefinitionDto<T>;
 };

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

@@ -0,0 +1,22 @@
+import { ReadSelectedCollectionOperator, ReadSelectedSearchDefinitionDto } from '../../..';
+/**
+ * Defines criteria for searching within a collection navigation property using quantifiers (Any/All).
+ *
+ * This DTO allows navigation into a collection property and applying search criteria
+ * with a quantifier to determine if any or all elements match.
+ */
+export type ReadSelectedNestedCollectionCriteriaDto<T, TPropertyName extends keyof T> = {
+    /**
+     * The name of the collection navigation property to navigate into.
+     */
+    propertyName: TPropertyName;
+    /**
+     * The quantifier operator determining whether any or all elements must match.
+     */
+    collectionOperator: ReadSelectedCollectionOperator;
+    /**
+     * The search criteria to apply to elements in the collection.
+     * Type should be ReadSelectedSearchDefinitionDto of the collection element type.
+     */
+    criteria: ReadSelectedSearchDefinitionDto<unknown>;
+};

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

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

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

@@ -0,0 +1,18 @@
+import { ReadSelectedSearchDefinitionDto } from '../../..';
+/**
+ * Defines criteria for searching within a nested object property.
+ *
+ * This DTO allows navigation into a nested object property and applying search criteria
+ * to that nested object. The property name must refer to a navigation property (not a collection).
+ */
+export type ReadSelectedNestedCriteriaDto<T, TPropertyName extends keyof T> = {
+    /**
+     * The name of the navigation property to navigate into.
+     */
+    propertyName: TPropertyName;
+    /**
+     * The search criteria to apply to the nested object.
+     * Type should be ReadSelectedSearchDefinitionDto of the nested object type.
+     */
+    criteria: ReadSelectedSearchDefinitionDto<unknown>;
+};

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

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

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

@@ -6,9 +6,9 @@ export type ReadSelectedOrderingPropertyDefinitionDto = {
     /**
      * Gets or sets the property path.
      */
-    propertyPath: PropertyPathDto[];
+    propertyPath: PropertyPathDto;
     /**
-     * Gets or sets the sort direction.
+     * Gets or sets the ordering direction.
      */
     direction: ReadSelectedOrderingDirection;
 };

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

@@ -1,18 +1,33 @@
-import { ReadSelectedLogicalOperator, ReadSelectedSearchPropertyDefinitionDto } from '../../..';
+import { ReadSelectedLogicalOperator, ReadSelectedNestedCollectionCriteriaDto, ReadSelectedNestedCriteriaDto, ReadSelectedSearchPropertyDefinitionDto } from '../../..';
 /**
- * Defines the filtering options for a controller, including the logical operator and an array of property definitions.
+ * Defines the search criteria for a controller using a recursive structure.
+ *
+ * This DTO supports complex search queries with:
+ * - Logical operators (AND/OR) to combine multiple criteria
+ * - Direct property value comparisons via `propertyCriteria`
+ * - Nested searches via `searches` for recursive query composition
+ * - Navigation into nested objects via `nestedCriteria`
+ * - Collection quantifier queries (Any/All) via `nestedCollectionCriteria`
  */
-export type ReadSelectedSearchDefinitionDto = {
+export type ReadSelectedSearchDefinitionDto<T> = {
     /**
-     * Logical operator to be used when applying the filters.
+     * The logical operator to combine all criteria at this level.
      */
     logicalOperator: ReadSelectedLogicalOperator;
     /**
-     * Property-based search criteria.
+     * Recursive nested search definitions combined with the logical operator.
      */
-    propertyCriteria?: ReadSelectedSearchPropertyDefinitionDto[];
+    searches?: ReadSelectedSearchDefinitionDto<T>[];
     /**
-     * Nested search definitions for complex queries.
+     * Direct property value comparison criteria.
      */
-    nestedSearchCriteria?: ReadSelectedSearchDefinitionDto[];
+    propertyCriteria?: ReadSelectedSearchPropertyDefinitionDto<T, keyof T>[];
+    /**
+     * Criteria for searching within nested object properties.
+     */
+    nestedCriteria?: ReadSelectedNestedCriteriaDto<T, keyof T>[];
+    /**
+     * Criteria for searching within collection properties using Any/All quantifiers.
+     */
+    nestedCollectionCriteria?: ReadSelectedNestedCollectionCriteriaDto<T, keyof T>[];
 };

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

@@ -1,16 +1,23 @@
-import { PropertyPathDto, ReadSelectedComparisonOperator, ReadSelectedPropertyType } from '../../..';
+import { ReadSelectedComparisonOperator, ReadSelectedPropertyType } from '../../..';
 /**
- * Defines a property used for searching in a controller.
+ * Defines a direct property value comparison criteria for searching.
+ *
+ * This DTO represents a leaf-level search criterion that compares a single property
+ * against a value using a comparison operator. For nested property searches, use
+ * `ReadSelectedNestedCriteriaDto` or `ReadSelectedNestedCollectionCriteriaDto`.
  */
-export type ReadSelectedSearchPropertyDefinitionDto = Partial_ReadSelectedSearchPropertyDefinition_IndependentProperties & Partial_ReadSelectedSearchPropertyDefinition_TypedValueProperty & Partial_ReadSelectedSearchPropertyDefinition_TypedComparisonOperators;
+export type ReadSelectedSearchPropertyDefinitionDto<T, TPropertyName extends keyof T> = Partial_ReadSelectedSearchPropertyDefinition_IndependentProperties<T, TPropertyName> & Partial_ReadSelectedSearchPropertyDefinition_TypedValueProperty & Partial_ReadSelectedSearchPropertyDefinition_TypedComparisonOperators;
 /**
  * Defines independent properties
  */
-type Partial_ReadSelectedSearchPropertyDefinition_IndependentProperties = {
+type Partial_ReadSelectedSearchPropertyDefinition_IndependentProperties<T, TPropertyName extends keyof T> = {
     /**
-     * The path to the property being searched.
+     * The name of the property to compare.
+     *
+     * This must be a direct property on the target type, not a nested property path.
+     * Use nested criteria DTOs for navigation.
      */
-    propertyPath: PropertyPathDto;
+    propertyName: TPropertyName;
     /**
      * The comparison operator to use for the search.
      */
@@ -20,7 +27,7 @@ type Partial_ReadSelectedSearchPropertyDefinition_IndependentProperties = {
      */
     valueType: ReadSelectedPropertyType;
     /**
-     * The value to use for the search.
+     * The value to compare against.
      */
     value: unknown;
 };

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

@@ -1,5 +1,7 @@
 export * from './ReadMetadataDto';
 export * from './ReadSelectedSearchPropertyDefinitionDto';
+export * from './ReadSelectedNestedCriteriaDto';
+export * from './ReadSelectedNestedCollectionCriteriaDto';
 export * from './ReadSelectedOrderingDefinitionDto';
 export * from './ReadSelectedOrderingPropertyDefinitionDto';
 export * from './ReadSelectedPaginationDefinitionDto';

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

@@ -1,5 +1,7 @@
 export * from './ReadMetadataDto';
 export * from './ReadSelectedSearchPropertyDefinitionDto';
+export * from './ReadSelectedNestedCriteriaDto';
+export * from './ReadSelectedNestedCollectionCriteriaDto';
 export * from './ReadSelectedOrderingDefinitionDto';
 export * from './ReadSelectedOrderingPropertyDefinitionDto';
 export * from './ReadSelectedPaginationDefinitionDto';

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

@@ -1,8 +1,17 @@
-import { ApiErrorCodes } from '../../..';
+import { EmptyMetadataDto, ErrorCode, ValidationFailedMetadataDto } from '../../..';
 /**
  * Default, empty metadata.
  */
-export type ApiErrorDto = {
-    code: ApiErrorCodes;
+export type ApiErrorDto<TMetadata extends ApiErrorMetadataDto = ApiErrorMetadataDto> = {
     message: string;
+    details?: string;
+    traceId?: string;
+    timestamp?: string;
+} & TMetadata;
+export type ApiErrorMetadataDto = {
+    code: ErrorCode.ValidationFailed;
+    metadata: ValidationFailedMetadataDto;
+} | {
+    code: Omit<number, ErrorCode.ValidationFailed>;
+    metadata: EmptyMetadataDto;
 };

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

@@ -0,0 +1,11 @@
+import { ApiErrorDto, ApiErrorMetadataDto } from '../../..';
+/**
+ * Represents an API response containing an error and empty metadata.
+ */
+export type ApiErrorResponseDto<TErrorMetadata extends ApiErrorMetadataDto = ApiErrorMetadataDto> = {
+    ok: false;
+    /**
+     * The error object containing information about the error
+     */
+    error: ApiErrorDto<TErrorMetadata>;
+};

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

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

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

@@ -1,15 +1,3 @@
-import { ApiErrorDto } 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 ApiResponseDto<T, TMetadata> = {
-    success: boolean;
-    result: T;
-    metadata: TMetadata;
-    error: ApiErrorDto;
-};
+import { ApiErrorMetadataDto, ApiErrorResponseDto, ApiSuccessResponseDto } from '../../../../data';
+import { Result } from '../../../../utils/result';
+export type ApiResponseDto<T, TMetadata extends object, TErrorMetadata extends ApiErrorMetadataDto = ApiErrorMetadataDto> = Result<ApiSuccessResponseDto<T, TMetadata>, ApiErrorResponseDto<TErrorMetadata>>;

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

@@ -1,5 +1,5 @@
 /**
- * Represents an successful API response containing a result and metadata.
+ * Represents a successful API response containing a result and metadata.
  *
  * @template T The type of result
  * @template TMetadata The type of metadata
@@ -7,6 +7,7 @@
  * @property {TMetadata} metadata - Metadata about the result
  */
 export type ApiSuccessResponseDto<T, TMetadata> = {
+    ok: true;
     result: T;
     metadata: TMetadata;
 };

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

@@ -0,0 +1,25 @@
+declare const __brand: unique symbol;
+/**
+ * Utility type for creating branded types that are nominally different but structurally identical.
+ * This enables compile-time type safety for values that would otherwise have the same runtime structure.
+ *
+ * @template T - The brand identifier string literal type
+ *
+ * @example
+ * ```typescript
+ * type UserId = Brand<'userId'>;
+ * type OrderId = Brand<'orderId'>;
+ *
+ * const userId: UserId = { [__brand]: 'userId' } as UserId;
+ * const orderId: OrderId = userId; // Type error! Different brands
+ * ```
+ */
+export type Brand<T extends string> = {
+    [__brand]: T;
+};
+/**
+ * Default, empty metadata.
+ */
+export type EmptyMetadataDto = Brand<'emptyMetadata'>;
+export type ValidationFailedMetadataDto = Brand<'validationFailedMetadata'>;
+export {};

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

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

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

@@ -1,4 +1,5 @@
 export * from './ApiResponseDto';
 export * from './ApiSuccessResponseDto';
 export * from './ApiErrorDto';
-export * from './EmptyMetadataDto';
+export * from './MetadataDto';
+export * from './ApiErrorResponseDto';

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

@@ -1,4 +1,5 @@
 export * from './ApiResponseDto';
 export * from './ApiSuccessResponseDto';
 export * from './ApiErrorDto';
-export * from './EmptyMetadataDto';
+export * from './MetadataDto';
+export * from './ApiErrorResponseDto';

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

@@ -0,0 +1,16 @@
+/**
+ * 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 declare 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/data/api/enum/read/ReadSelectedCollectionOperator.js

@@ -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 var ReadSelectedCollectionOperator;
+(function (ReadSelectedCollectionOperator) {
+    /**
+     * Matches if at least one element in the collection satisfies the criteria.
+     */
+    ReadSelectedCollectionOperator[ReadSelectedCollectionOperator["Any"] = 0] = "Any";
+    /**
+     * Matches if all elements in the collection satisfy the criteria.
+     */
+    ReadSelectedCollectionOperator[ReadSelectedCollectionOperator["All"] = 1] = "All";
+})(ReadSelectedCollectionOperator || (ReadSelectedCollectionOperator = {}));

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

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