@intellegens/cornerstone-client 0.0.9999-alpha-41 → 0.0.9999-alpha-43

package/dist/data/api/dto/read/read-selected-search-definition-builder.d.ts

@@ -0,0 +1,167 @@
+import { ReadSelectedComparisonOperator, ReadSelectedPropertyType } from '../../..';
+import { ReadSelectedSearchDefinitionDto } from './read-selected-search-definition-dto';
+/**
+ * Builder class for constructing ReadSelectedSearchDefinitionDto with a fluent API.
+ *
+ * @example
+ * // Simple AND search with property criteria
+ * const search = SearchBuilder.and<User>()
+ *   .whereString('name', ReadSelectedComparisonOperator.IContains, 'John')
+ *   .whereNumber('age', ReadSelectedComparisonOperator.GreaterThan, 18)
+ *   .build();
+ *
+ * @example
+ * // OR search with nested criteria (specify nested type for intellisense)
+ * const search = SearchBuilder.or<User>()
+ *   .whereString('status', ReadSelectedComparisonOperator.Equal, 'active')
+ *   .nested<Address>('address', nested =>
+ *     nested.whereString('city', ReadSelectedComparisonOperator.Equal, 'NYC')
+ *   )
+ *   .build();
+ *
+ * @example
+ * // Complex nested search with collection criteria
+ * const search = SearchBuilder.and<Order>()
+ *   .whereString('status', ReadSelectedComparisonOperator.Equal, 'pending')
+ *   .any<OrderItem>('items', itemSearch =>
+ *     itemSearch.whereNumber('quantity', ReadSelectedComparisonOperator.GreaterThan, 5)
+ *   )
+ *   .group(sub => sub.or()
+ *     .whereString('priority', ReadSelectedComparisonOperator.Equal, 'high')
+ *     .whereString('priority', ReadSelectedComparisonOperator.Equal, 'urgent')
+ *   )
+ *   .build();
+ */
+export declare class SearchBuilder<T> {
+    private _logicalOperator;
+    private _searches;
+    private _propertyCriteria;
+    private _nestedCriteria;
+    private _nestedCollectionCriteria;
+    private constructor();
+    /**
+     * Creates a new builder with AND logical operator.
+     * All criteria added to this builder will be combined with AND.
+     */
+    static and<T>(): SearchBuilder<T>;
+    /**
+     * Creates a new builder with OR logical operator.
+     * All criteria added to this builder will be combined with OR.
+     */
+    static or<T>(): SearchBuilder<T>;
+    /**
+     * Sets the logical operator to AND.
+     */
+    and(): this;
+    /**
+     * Sets the logical operator to OR.
+     */
+    or(): this;
+    /**
+     * Adds a property comparison criterion.
+     *
+     * @param propertyName - The property to compare
+     * @param comparisonOperator - The comparison operator to use
+     * @param value - The value to compare against
+     * @param valueType - The type of the value
+     */
+    where<K extends keyof T>(propertyName: K, comparisonOperator: ReadSelectedComparisonOperator, value: unknown, valueType: ReadSelectedPropertyType): this;
+    /**
+     * Adds a string property comparison with common string operations.
+     */
+    whereString<K extends keyof T>(propertyName: K, comparisonOperator: ReadSelectedComparisonOperator.Equal | ReadSelectedComparisonOperator.NotEqual | ReadSelectedComparisonOperator.Contains | ReadSelectedComparisonOperator.StartsWith | ReadSelectedComparisonOperator.EndsWith | ReadSelectedComparisonOperator.IContains | ReadSelectedComparisonOperator.IStartsWith | ReadSelectedComparisonOperator.IEndsWith | ReadSelectedComparisonOperator.IEqual | ReadSelectedComparisonOperator.INotEqual, value: string): this;
+    /**
+     * Adds a number property comparison.
+     */
+    whereNumber<K extends keyof T>(propertyName: K, comparisonOperator: ReadSelectedComparisonOperator.Equal | ReadSelectedComparisonOperator.NotEqual | ReadSelectedComparisonOperator.LessThan | ReadSelectedComparisonOperator.LessOrEqual | ReadSelectedComparisonOperator.GreaterThan | ReadSelectedComparisonOperator.GreaterOrEqual, value: number, valueType?: ReadSelectedPropertyType.Int | ReadSelectedPropertyType.Short | ReadSelectedPropertyType.Long | ReadSelectedPropertyType.Decimal | ReadSelectedPropertyType.Double | ReadSelectedPropertyType.Float): this;
+    /**
+     * Adds a boolean property comparison.
+     */
+    whereBool<K extends keyof T>(propertyName: K, comparisonOperator: ReadSelectedComparisonOperator.Equal | ReadSelectedComparisonOperator.NotEqual, value: boolean): this;
+    /**
+     * Adds a date/time property comparison.
+     */
+    whereDate<K extends keyof T>(propertyName: K, comparisonOperator: ReadSelectedComparisonOperator.Equal | ReadSelectedComparisonOperator.NotEqual | ReadSelectedComparisonOperator.LessThan | ReadSelectedComparisonOperator.LessOrEqual | ReadSelectedComparisonOperator.GreaterThan | ReadSelectedComparisonOperator.GreaterOrEqual, value: string | Date, valueType?: ReadSelectedPropertyType.DateTime | ReadSelectedPropertyType.DateTimeOffset | ReadSelectedPropertyType.DateOnly | ReadSelectedPropertyType.TimeOnly | ReadSelectedPropertyType.TimeSpan): this;
+    /**
+     * Adds an isNull check for a property.
+     */
+    whereNull<K extends keyof T>(propertyName: K): this;
+    /**
+     * Adds an isNotNull check for a property.
+     */
+    whereNotNull<K extends keyof T>(propertyName: K): this;
+    /**
+     * Adds criteria for a nested object property (navigation property).
+     *
+     * @param propertyName - The navigation property name
+     * @param builderFn - A function that receives a new builder for the nested type
+     *
+     * @example
+     * // With explicit type for proper intellisense
+     * SearchBuilder.and<VehicleDto>()
+     *   .nested<PersonDto>('driver', nested =>
+     *     nested.whereString('name', ReadSelectedComparisonOperator.Contains, 'Alice')
+     *   )
+     *   .build();
+     */
+    nested<TNested, K extends keyof T = keyof T>(propertyName: K, builderFn: (builder: SearchBuilder<TNested>) => SearchBuilder<TNested>): this;
+    /**
+     * Adds criteria for a collection property with Any quantifier.
+     * Matches if at least one element in the collection satisfies the criteria.
+     *
+     * @param propertyName - The collection property name
+     * @param builderFn - A function that receives a new builder for the collection element type
+     *
+     * @example
+     * // With explicit type for proper intellisense
+     * SearchBuilder.and<VehicleDto>()
+     *   .any<PersonDto>('passengers', passengers =>
+     *     passengers.whereString('name', ReadSelectedComparisonOperator.Contains, 'Bob')
+     *   )
+     *   .build();
+     */
+    any<TElement, K extends keyof T = keyof T>(propertyName: K, builderFn: (builder: SearchBuilder<TElement>) => SearchBuilder<TElement>): this;
+    /**
+     * Adds criteria for a collection property with All quantifier.
+     * Matches if all elements in the collection satisfy the criteria.
+     *
+     * @param propertyName - The collection property name
+     * @param builderFn - A function that receives a new builder for the collection element type
+     *
+     * @example
+     * // With explicit type for proper intellisense
+     * SearchBuilder.and<VehicleDto>()
+     *   .all<PersonDto>('passengers', passengers =>
+     *     passengers.whereNumber('age', ReadSelectedComparisonOperator.GreaterThan, 18)
+     *   )
+     *   .build();
+     */
+    all<TElement, K extends keyof T = keyof T>(propertyName: K, builderFn: (builder: SearchBuilder<TElement>) => SearchBuilder<TElement>): this;
+    /**
+     * Adds a nested search group. Use this for complex logical groupings.
+     *
+     * @param builderFn - A function that receives a new builder for creating the nested search
+     *
+     * @example
+     * // (name contains 'John') AND ((age > 18) OR (status = 'verified'))
+     * SearchBuilder.and<User>()
+     *   .whereString('name', ReadSelectedComparisonOperator.IContains, 'John')
+     *   .group(sub => sub.or()
+     *     .whereNumber('age', ReadSelectedComparisonOperator.GreaterThan, 18)
+     *     .whereString('status', ReadSelectedComparisonOperator.Equal, 'verified')
+     *   )
+     *   .build();
+     */
+    group(builderFn: (builder: SearchBuilder<T>) => SearchBuilder<T>): this;
+    /**
+     * Adds an existing search definition as a nested search.
+     *
+     * @param search - An existing ReadSelectedSearchDefinitionDto
+     */
+    addSearch(search: ReadSelectedSearchDefinitionDto<T>): this;
+    /**
+     * Builds and returns the ReadSelectedSearchDefinitionDto.
+     */
+    build(): ReadSelectedSearchDefinitionDto<T>;
+    private toPascalCase;
+}

package/dist/data/api/dto/read/read-selected-search-definition-builder.js

@@ -0,0 +1,267 @@
+import { ReadSelectedCollectionOperator, ReadSelectedComparisonOperator, ReadSelectedLogicalOperator, ReadSelectedPropertyType } from '../../..';
+/**
+ * Builder class for constructing ReadSelectedSearchDefinitionDto with a fluent API.
+ *
+ * @example
+ * // Simple AND search with property criteria
+ * const search = SearchBuilder.and<User>()
+ *   .whereString('name', ReadSelectedComparisonOperator.IContains, 'John')
+ *   .whereNumber('age', ReadSelectedComparisonOperator.GreaterThan, 18)
+ *   .build();
+ *
+ * @example
+ * // OR search with nested criteria (specify nested type for intellisense)
+ * const search = SearchBuilder.or<User>()
+ *   .whereString('status', ReadSelectedComparisonOperator.Equal, 'active')
+ *   .nested<Address>('address', nested =>
+ *     nested.whereString('city', ReadSelectedComparisonOperator.Equal, 'NYC')
+ *   )
+ *   .build();
+ *
+ * @example
+ * // Complex nested search with collection criteria
+ * const search = SearchBuilder.and<Order>()
+ *   .whereString('status', ReadSelectedComparisonOperator.Equal, 'pending')
+ *   .any<OrderItem>('items', itemSearch =>
+ *     itemSearch.whereNumber('quantity', ReadSelectedComparisonOperator.GreaterThan, 5)
+ *   )
+ *   .group(sub => sub.or()
+ *     .whereString('priority', ReadSelectedComparisonOperator.Equal, 'high')
+ *     .whereString('priority', ReadSelectedComparisonOperator.Equal, 'urgent')
+ *   )
+ *   .build();
+ */
+export class SearchBuilder {
+    _logicalOperator;
+    _searches = [];
+    _propertyCriteria = [];
+    _nestedCriteria = [];
+    _nestedCollectionCriteria = [];
+    constructor(logicalOperator) {
+        this._logicalOperator = logicalOperator;
+    }
+    /**
+     * Creates a new builder with AND logical operator.
+     * All criteria added to this builder will be combined with AND.
+     */
+    static and() {
+        return new SearchBuilder(ReadSelectedLogicalOperator.And);
+    }
+    /**
+     * Creates a new builder with OR logical operator.
+     * All criteria added to this builder will be combined with OR.
+     */
+    static or() {
+        return new SearchBuilder(ReadSelectedLogicalOperator.Or);
+    }
+    /**
+     * Sets the logical operator to AND.
+     */
+    and() {
+        this._logicalOperator = ReadSelectedLogicalOperator.And;
+        return this;
+    }
+    /**
+     * Sets the logical operator to OR.
+     */
+    or() {
+        this._logicalOperator = ReadSelectedLogicalOperator.Or;
+        return this;
+    }
+    /**
+     * Adds a property comparison criterion.
+     *
+     * @param propertyName - The property to compare
+     * @param comparisonOperator - The comparison operator to use
+     * @param value - The value to compare against
+     * @param valueType - The type of the value
+     */
+    where(propertyName, comparisonOperator, value, valueType) {
+        this._propertyCriteria.push({
+            propertyName: this.toPascalCase(propertyName),
+            comparisonOperator,
+            value,
+            valueType,
+        });
+        return this;
+    }
+    /**
+     * Adds a string property comparison with common string operations.
+     */
+    whereString(propertyName, comparisonOperator, value) {
+        return this.where(propertyName, comparisonOperator, value, ReadSelectedPropertyType.String);
+    }
+    /**
+     * Adds a number property comparison.
+     */
+    whereNumber(propertyName, comparisonOperator, value, valueType = ReadSelectedPropertyType.Int) {
+        return this.where(propertyName, comparisonOperator, value, valueType);
+    }
+    /**
+     * Adds a boolean property comparison.
+     */
+    whereBool(propertyName, comparisonOperator, value) {
+        return this.where(propertyName, comparisonOperator, value, ReadSelectedPropertyType.Bool);
+    }
+    /**
+     * Adds a date/time property comparison.
+     */
+    whereDate(propertyName, comparisonOperator, value, valueType = ReadSelectedPropertyType.DateTime) {
+        const stringValue = value instanceof Date ? value.toISOString() : value;
+        return this.where(propertyName, comparisonOperator, stringValue, valueType);
+    }
+    /**
+     * Adds an isNull check for a property.
+     */
+    whereNull(propertyName) {
+        this._propertyCriteria.push({
+            propertyName: this.toPascalCase(propertyName),
+            comparisonOperator: ReadSelectedComparisonOperator.IsNull,
+            value: null,
+            valueType: ReadSelectedPropertyType.String,
+        });
+        return this;
+    }
+    /**
+     * Adds an isNotNull check for a property.
+     */
+    whereNotNull(propertyName) {
+        this._propertyCriteria.push({
+            propertyName: this.toPascalCase(propertyName),
+            comparisonOperator: ReadSelectedComparisonOperator.IsNotNull,
+            value: null,
+            valueType: ReadSelectedPropertyType.String,
+        });
+        return this;
+    }
+    /**
+     * Adds criteria for a nested object property (navigation property).
+     *
+     * @param propertyName - The navigation property name
+     * @param builderFn - A function that receives a new builder for the nested type
+     *
+     * @example
+     * // With explicit type for proper intellisense
+     * SearchBuilder.and<VehicleDto>()
+     *   .nested<PersonDto>('driver', nested =>
+     *     nested.whereString('name', ReadSelectedComparisonOperator.Contains, 'Alice')
+     *   )
+     *   .build();
+     */
+    nested(propertyName, builderFn) {
+        const nestedBuilder = SearchBuilder.and();
+        const configuredBuilder = builderFn(nestedBuilder);
+        this._nestedCriteria.push({
+            propertyName: this.toPascalCase(propertyName),
+            criteria: configuredBuilder.build(),
+        });
+        return this;
+    }
+    /**
+     * Adds criteria for a collection property with Any quantifier.
+     * Matches if at least one element in the collection satisfies the criteria.
+     *
+     * @param propertyName - The collection property name
+     * @param builderFn - A function that receives a new builder for the collection element type
+     *
+     * @example
+     * // With explicit type for proper intellisense
+     * SearchBuilder.and<VehicleDto>()
+     *   .any<PersonDto>('passengers', passengers =>
+     *     passengers.whereString('name', ReadSelectedComparisonOperator.Contains, 'Bob')
+     *   )
+     *   .build();
+     */
+    any(propertyName, builderFn) {
+        const nestedBuilder = SearchBuilder.and();
+        const configuredBuilder = builderFn(nestedBuilder);
+        this._nestedCollectionCriteria.push({
+            propertyName: this.toPascalCase(propertyName),
+            collectionOperator: ReadSelectedCollectionOperator.Any,
+            criteria: configuredBuilder.build(),
+        });
+        return this;
+    }
+    /**
+     * Adds criteria for a collection property with All quantifier.
+     * Matches if all elements in the collection satisfy the criteria.
+     *
+     * @param propertyName - The collection property name
+     * @param builderFn - A function that receives a new builder for the collection element type
+     *
+     * @example
+     * // With explicit type for proper intellisense
+     * SearchBuilder.and<VehicleDto>()
+     *   .all<PersonDto>('passengers', passengers =>
+     *     passengers.whereNumber('age', ReadSelectedComparisonOperator.GreaterThan, 18)
+     *   )
+     *   .build();
+     */
+    all(propertyName, builderFn) {
+        const nestedBuilder = SearchBuilder.and();
+        const configuredBuilder = builderFn(nestedBuilder);
+        this._nestedCollectionCriteria.push({
+            propertyName: this.toPascalCase(propertyName),
+            collectionOperator: ReadSelectedCollectionOperator.All,
+            criteria: configuredBuilder.build(),
+        });
+        return this;
+    }
+    /**
+     * Adds a nested search group. Use this for complex logical groupings.
+     *
+     * @param builderFn - A function that receives a new builder for creating the nested search
+     *
+     * @example
+     * // (name contains 'John') AND ((age > 18) OR (status = 'verified'))
+     * SearchBuilder.and<User>()
+     *   .whereString('name', ReadSelectedComparisonOperator.IContains, 'John')
+     *   .group(sub => sub.or()
+     *     .whereNumber('age', ReadSelectedComparisonOperator.GreaterThan, 18)
+     *     .whereString('status', ReadSelectedComparisonOperator.Equal, 'verified')
+     *   )
+     *   .build();
+     */
+    group(builderFn) {
+        const nestedBuilder = SearchBuilder.and();
+        const configuredBuilder = builderFn(nestedBuilder);
+        this._searches.push(configuredBuilder.build());
+        return this;
+    }
+    /**
+     * Adds an existing search definition as a nested search.
+     *
+     * @param search - An existing ReadSelectedSearchDefinitionDto
+     */
+    addSearch(search) {
+        this._searches.push(search);
+        return this;
+    }
+    /**
+     * Builds and returns the ReadSelectedSearchDefinitionDto.
+     */
+    build() {
+        const result = {
+            logicalOperator: this._logicalOperator,
+        };
+        if (this._searches.length > 0) {
+            result.searches = this._searches;
+        }
+        if (this._propertyCriteria.length > 0) {
+            result.propertyCriteria = this._propertyCriteria;
+        }
+        if (this._nestedCriteria.length > 0) {
+            result.nestedCriteria = this._nestedCriteria;
+        }
+        if (this._nestedCollectionCriteria.length > 0) {
+            result.nestedCollectionCriteria = this._nestedCollectionCriteria;
+        }
+        return result;
+    }
+    toPascalCase(str) {
+        if (typeof str !== 'string') {
+            return str.toString();
+        }
+        return str.charAt(0).toUpperCase() + str.slice(1);
+    }
+}

package/dist/data/api/dto/read/read-selected-search-definition-dto.d.ts

@@ -0,0 +1,33 @@
+import { ReadSelectedLogicalOperator, ReadSelectedNestedCollectionCriteriaDto, ReadSelectedNestedCriteriaDto, ReadSelectedSearchPropertyDefinitionDto } from '../../..';
+/**
+ * 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<T> = {
+    /**
+     * The logical operator to combine all criteria at this level.
+     */
+    logicalOperator: ReadSelectedLogicalOperator;
+    /**
+     * Recursive nested search definitions combined with the logical operator.
+     */
+    searches?: ReadSelectedSearchDefinitionDto<T>[];
+    /**
+     * Direct property value comparison criteria.
+     */
+    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/dist/data/api/dto/read/read-selected-search-definition-dto.js

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

package/dist/data/api/dto/read/read-selected-search-property-definition-dto.d.ts

@@ -0,0 +1,114 @@
+import { ReadSelectedComparisonOperator, ReadSelectedPropertyType } from '../../..';
+/**
+ * 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<T, TPropertyName extends keyof T> = Partial_ReadSelectedSearchPropertyDefinition_IndependentProperties<T, TPropertyName> & Partial_ReadSelectedSearchPropertyDefinition_TypedValueProperty & Partial_ReadSelectedSearchPropertyDefinition_TypedComparisonOperators;
+/**
+ * Defines independent properties
+ */
+type Partial_ReadSelectedSearchPropertyDefinition_IndependentProperties<T, TPropertyName extends keyof T> = {
+    /**
+     * 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.
+     */
+    propertyName: TPropertyName;
+    /**
+     * The comparison operator to use for the search.
+     */
+    comparisonOperator: ReadSelectedComparisonOperator;
+    /**
+     * The type of the property value being searched.
+     */
+    valueType: ReadSelectedPropertyType;
+    /**
+     * The value to compare against.
+     */
+    value: unknown;
+};
+/**
+ * Defines the dependence between the .valueType and the type of the .value properties
+ */
+type Partial_ReadSelectedSearchPropertyDefinition_TypedValueProperty = {
+    /**
+     * The type of the property value being searched.
+     */
+    valueType: ReadSelectedPropertyType.Bool;
+    /**
+     * The value to use for the search.
+     */
+    value: boolean;
+} | {
+    /**
+     * The type of the property value being searched.
+     */
+    valueType: ReadSelectedPropertyType.Int | ReadSelectedPropertyType.Short | ReadSelectedPropertyType.Long | ReadSelectedPropertyType.Decimal | ReadSelectedPropertyType.Double | ReadSelectedPropertyType.Float;
+    /**
+     * The value to use for the search.
+     */
+    value: number;
+} | {
+    /**
+     * The type of the property value being searched.
+     */
+    valueType: ReadSelectedPropertyType.String;
+    /**
+     * The value to use for the search.
+     */
+    value: string;
+} | {
+    /**
+     * The type of the property value being searched.
+     */
+    valueType: ReadSelectedPropertyType.DateTime | ReadSelectedPropertyType.DateTimeOffset | ReadSelectedPropertyType.TimeSpan | ReadSelectedPropertyType.DateOnly | ReadSelectedPropertyType.TimeOnly;
+    /**
+     * The value to use for the search.
+     */
+    value: string;
+};
+/**
+ * Defines the dependence between the .valueType and the type of the .comparisonOperator properties
+ */
+type Partial_ReadSelectedSearchPropertyDefinition_TypedComparisonOperators = {
+    /**
+     * The type of the property value being searched.
+     */
+    valueType: ReadSelectedPropertyType.Bool;
+    /**
+     * The comparison operator to use for the search.
+     */
+    comparisonOperator: ReadSelectedComparisonOperator.Equal | ReadSelectedComparisonOperator.NotEqual;
+} | {
+    /**
+     * The type of the property value being searched.
+     */
+    valueType: ReadSelectedPropertyType.Int | ReadSelectedPropertyType.Short | ReadSelectedPropertyType.Long | ReadSelectedPropertyType.Decimal | ReadSelectedPropertyType.Double | ReadSelectedPropertyType.Float;
+    /**
+     * The comparison operator to use for the search.
+     */
+    comparisonOperator: ReadSelectedComparisonOperator.Equal | ReadSelectedComparisonOperator.NotEqual | ReadSelectedComparisonOperator.LessThan | ReadSelectedComparisonOperator.LessOrEqual | ReadSelectedComparisonOperator.GreaterThan | ReadSelectedComparisonOperator.GreaterOrEqual;
+} | {
+    /**
+     * The type of the property value being searched.
+     */
+    valueType: ReadSelectedPropertyType.String;
+    /**
+     * The comparison operator to use for the search.
+     */
+    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.
+     */
+    valueType: ReadSelectedPropertyType.DateTime | ReadSelectedPropertyType.DateTimeOffset | ReadSelectedPropertyType.TimeSpan | ReadSelectedPropertyType.DateOnly | ReadSelectedPropertyType.TimeOnly;
+    /**
+     * The comparison operator to use for the search.
+     */
+    comparisonOperator: ReadSelectedComparisonOperator.Equal | ReadSelectedComparisonOperator.NotEqual | ReadSelectedComparisonOperator.LessThan | ReadSelectedComparisonOperator.LessOrEqual | ReadSelectedComparisonOperator.GreaterThan | ReadSelectedComparisonOperator.GreaterOrEqual;
+};
+export {};

package/dist/data/api/dto/read/read-selected-search-property-definition-dto.js

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

package/dist/data/api/dto/read-options-dto.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 ReadOptionsDto = {
+    includeTotalCount: boolean;
+};

package/dist/data/api/dto/read-options-dto.js

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

package/dist/data/api/dto/read-result-dto.d.ts

@@ -0,0 +1,12 @@
+import { ReadResultMetadataDto } from './read-result-metadata-dto';
+/**
+ * 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 ReadResultDto<T> = {
+    results: T[];
+    metadata: ReadResultMetadataDto;
+};

package/dist/data/api/dto/read-result-dto.js

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

package/dist/data/api/dto/read-result-metadata-dto.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/dist/data/api/dto/read-result-metadata-dto.js

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

package/dist/data/api/dto/response/api-error-dto.d.ts

@@ -0,0 +1,17 @@
+import { EmptyMetadataDto, ErrorCode, ValidationFailedMetadataDto } from '../../..';
+/**
+ * Default, empty metadata.
+ */
+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: Exclude<ErrorCode, ErrorCode.ValidationFailed>;
+    metadata: EmptyMetadataDto;
+};

package/dist/data/api/dto/response/api-error-dto.js

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

package/dist/data/api/dto/response/api-error-response-dto.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/dist/data/api/dto/response/api-error-response-dto.js

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

package/dist/data/api/dto/response/api-response-dto.d.ts

@@ -0,0 +1,3 @@
+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/dist/data/api/dto/response/api-response-dto.js

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