@nulledexp/translatable-criteria 1.1.0 → 1.2.0

package/README.md

@@ -54,7 +54,7 @@ export const UserSchema = GetTypedCriteriaSchema({
   alias: ['users', 'user', 'publisher'],
   fields: ['uuid', 'email', 'username', 'created_at'],
   joins: [
-    { alias: 'posts', join_relation_type: 'one_to_many' },
+    { alias: 'posts', relation_type: 'one_to_many' },
     // other joins like 'permissions', 'addresses' can be defined here
   ],
 });
@@ -73,8 +73,8 @@ export const PostSchema = GetTypedCriteriaSchema({
     'metadata', // Example: for JSON filters
   ],
   joins: [
-    { alias: 'comments', join_relation_type: 'one_to_many' },
-    { alias: 'publisher', join_relation_type: 'many_to_one' },
+    { alias: 'comments', relation_type: 'one_to_many' },
+    { alias: 'publisher', relation_type: 'many_to_one' },
   ],
 });
 export type PostSchema = typeof PostSchema;

package/dist/criteria/criteria.d.ts

@@ -3,8 +3,17 @@ import { Cursor } from './cursor.js';
 import { Order, OrderDirection } from './order/order.js';
 import type { FilterPrimitive } from './filter/types/filter-primitive.types.js';
 import type { ICriteriaBase } from './types/criteria.interface.js';
-import type { JoinCriteriaParameterType, JoinParameterType, SpecificMatchingJoinConfig } from './types/join-utility.types.js';
+import type { JoinCriteriaParameterType, JoinParameterType, SpecificMatchingJoinConfig, StoredJoinDetails } from './types/join-utility.types.js';
 import { FilterOperator } from './types/operator.types.js';
+import type { FilterGroup } from './filter/filter-group.js';
+/**
+ * Abstract base class for constructing query criteria.
+ * It provides a fluent API for defining filters, joins, selections, ordering, and pagination.
+ * Concrete criteria types (e.g., RootCriteria, JoinCriteria) will extend this class.
+ *
+ * @template TSchema - The schema definition for the entity this criteria operates on.
+ * @template CurrentAlias - The selected alias for the entity from its schema.
+ */
 export declare abstract class Criteria<TSchema extends CriteriaSchema, CurrentAlias extends SelectedAliasOf<TSchema> = SelectedAliasOf<TSchema>> implements ICriteriaBase<TSchema, CurrentAlias> {
     protected readonly schema: TSchema;
     protected _alias: CurrentAlias;
@@ -12,25 +21,103 @@ export declare abstract class Criteria<TSchema extends CriteriaSchema, CurrentAl
     private readonly _joinManager;
     private readonly _source_name;
     private _take;
+    /**
+     * Stores the set of fields explicitly selected by the user.
+     * This is used when `_selectAll` is false.
+     * @protected
+     */
     protected _select: Set<FieldOfSchema<TSchema>>;
     private _selectAll;
+    /**
+     * Stores the cursor configuration for pagination, if set.
+     * @protected
+     */
     protected _cursor: Cursor<FieldOfSchema<TSchema>, FilterOperator.GREATER_THAN | FilterOperator.LESS_THAN> | undefined;
+    /**
+     * Initializes a new instance of the Criteria class.
+     * @param {TSchema} schema - The schema definition for the entity.
+     * @param {CurrentAlias} _alias - The alias to use for this entity in the query.
+     * @throws {Error} If the provided alias is not supported by the schema.
+     * @protected
+     */
     constructor(schema: TSchema, _alias: CurrentAlias);
-    get select(): FieldOfSchema<TSchema>[];
-    abstract resetCriteria(): ICriteriaBase<TSchema, CurrentAlias>;
+    /**
+     * Gets the currently selected fields.
+     * If `_selectAll` is true, it returns all fields from the schema.
+     * Otherwise, it returns the fields explicitly set via `setSelect`.
+     * @returns {Array<FieldOfSchema<TSchema>>} An array of selected field names.
+     */
+    get select(): Array<FieldOfSchema<TSchema>>;
+    /**
+     * Resets the selection to include all fields from the schema.
+     * Subsequent calls to `get select()` will return all schema fields
+     * until `setSelect()` is called again.
+     * @returns {this} The current criteria instance for chaining.
+     */
     resetSelect(): this;
+    /**
+     * Indicates whether all fields are currently configured to be selected.
+     * @returns {boolean} True if all fields are selected, false if specific fields are selected.
+     */
     get selectAll(): boolean;
+    /**
+     * Specifies which fields to select for the entity.
+     * Calling this method sets `selectAll` to false.
+     * @param {Array<FieldOfSchema<TSchema>>} selectFields - An array of field names to select.
+     * @returns {this} The current criteria instance for chaining.
+     * @throws {Error} If any of the specified fields are not defined in the schema.
+     */
     setSelect(selectFields: Array<FieldOfSchema<TSchema>>): this;
+    /**
+     * Gets the maximum number of records to return (LIMIT).
+     * @returns {number} The take value.
+     */
     get take(): number;
     private _skip;
+    /**
+     * Gets the number of records to skip (OFFSET).
+     * @returns {number} The skip value.
+     */
     get skip(): number;
     private _orders;
+    /**
+     * Gets the current ordering rules applied to this criteria.
+     * @returns {ReadonlyArray<Order<FieldOfSchema<TSchema>>>} A readonly array of order objects.
+     */
     get orders(): ReadonlyArray<Order<FieldOfSchema<TSchema>>>;
-    get joins(): import("./types/join-utility.types.js").StoredJoinDetails<TSchema>[];
-    get rootFilterGroup(): import("./index.js").FilterGroup<string>;
-    get sourceName(): TSchema["source_name"];
+    /**
+     * Gets the configured join details for this criteria.
+     * @returns {ReadonlyArray<StoredJoinDetails<TSchema>>} A readonly array of join configurations.
+     */
+    get joins(): ReadonlyArray<StoredJoinDetails<TSchema>>;
+    /**
+     * Gets the root filter group for this criteria, which holds all filter conditions.
+     * @returns {FilterGroup} The root filter group.
+     */
+    get rootFilterGroup(): FilterGroup;
+    /**
+     * Gets the source name (e.g., table name) for the entity of this criteria.
+     * @returns {TSchema['source_name']} The source name string.
+     */
+    get sourceName(): TSchema['source_name'];
+    /**
+     * Gets the alias used for the entity of this criteria.
+     * @returns {CurrentAlias} The alias string.
+     */
     get alias(): CurrentAlias;
+    /**
+     * Sets the maximum number of records to return (LIMIT).
+     * @param {number} amount - The number of records to take. Must be non-negative.
+     * @returns {this} The current criteria instance for chaining.
+     * @throws {Error} If the amount is negative.
+     */
     setTake(amount: number): this;
+    /**
+     * Sets the number of records to skip before starting to return records (OFFSET).
+     * @param {number} amount - The number of records to skip. Must be non-negative.
+     * @returns {this} The current criteria instance for chaining.
+     * @throws {Error} If the amount is negative.
+     */
     setSkip(amount: number): this;
     /**
      * Asserts that a given field name is defined within the current criteria's schema.
@@ -42,18 +129,92 @@ export declare abstract class Criteria<TSchema extends CriteriaSchema, CurrentAl
      * @throws {Error} If the field is not defined in the schema.
      */
     protected assetFieldOnSchema(field: FieldOfSchema<TSchema>): void;
+    /**
+     * Adds an ordering rule to the criteria.
+     * Multiple calls will append new ordering rules.
+     * @param {FieldOfSchema<TSchema>} field - The field to order by.
+     * @param {OrderDirection} direction - The direction of the ordering (ASC or DESC).
+     * @returns {this} The current criteria instance for chaining.
+     * @throws {Error} If the specified field is not defined in the schema.
+     */
     orderBy(field: FieldOfSchema<TSchema>, direction: OrderDirection): this;
+    /**
+     * Initializes the filter criteria with a single filter primitive.
+     * This replaces any existing filters in the root filter group.
+     * @template Operator - The specific filter operator type.
+     * @param {FilterPrimitive<FieldOfSchema<TSchema>, Operator>} filterPrimitive - The filter to apply.
+     * @returns {this} The current criteria instance for chaining.
+     * @throws {Error} If the specified field in filterPrimitive is not defined in the schema.
+     */
     where<Operator extends FilterOperator>(filterPrimitive: FilterPrimitive<FieldOfSchema<TSchema>, Operator>): this;
+    /**
+     * Adds a filter primitive to the current filter group using an AND logical operator.
+     * Requires `where()` to have been called first to initialize the filter group.
+     * @template Operator - The specific filter operator type.
+     * @param {FilterPrimitive<FieldOfSchema<TSchema>, Operator>} filterPrimitive - The filter to add.
+     * @returns {this} The current criteria instance for chaining.
+     * @throws {Error} If the specified field in filterPrimitive is not defined in the schema.
+     * @throws {Error} If `where()` has not been called first.
+     */
     andWhere<Operator extends FilterOperator>(filterPrimitive: FilterPrimitive<FieldOfSchema<TSchema>, Operator>): this;
+    /**
+     * Adds a filter primitive to the current filter group using an OR logical operator.
+     * Requires `where()` to have been called first to initialize the filter group.
+     * @template Operator - The specific filter operator type.
+     * @param {FilterPrimitive<FieldOfSchema<TSchema>, Operator>} filterPrimitive - The filter to add.
+     * @returns {this} The current criteria instance for chaining.
+     * @throws {Error} If the specified field in filterPrimitive is not defined in the schema.
+     * @throws {Error} If `where()` has not been called first.
+     */
     orWhere<Operator extends FilterOperator>(filterPrimitive: FilterPrimitive<FieldOfSchema<TSchema>, Operator>): this;
+    /**
+     * Adds a join to another criteria.
+     * @template TJoinSchema - The schema of the entity to join.
+     * @template TJoinedCriteriaAlias - The alias for the joined entity.
+     * @template TMatchingJoinConfig - The specific join configuration from the parent schema that matches the joined
+     *   alias.
+     * @param {JoinCriteriaParameterType<TSchema, TJoinSchema, TJoinedCriteriaAlias, TMatchingJoinConfig>} criteriaToJoin
+     * The criteria instance representing the entity to join (e.g., `InnerJoinCriteria`, `LeftJoinCriteria`).
+     * @param {JoinParameterType<TSchema, TJoinSchema, TMatchingJoinConfig>} joinParameter
+     * The parameters defining how the join should be performed (e.g., fields for simple join, pivot table details for
+     *   many-to-many).
+     * @returns {this} The current criteria instance for chaining.
+     * @throws {Error} If `criteriaToJoin` is a string (which is invalid).
+     * @throws {Error} If `parent_field` in `joinParameter` (or `parent_field.reference` for pivot joins) is not defined
+     *   in the parent schema.
+     * @throws {Error} If the join configuration for the given `criteriaToJoin.alias` is not found in the parent schema's
+     *   `joins` array.
+     * @throws {Error} If `joinParameter` is invalid for the `relation_type` defined in the schema (e.g., using
+     *   simple join input for many-to-many or vice-versa).
+     */
     join<TJoinSchema extends CriteriaSchema, TJoinedCriteriaAlias extends SelectedAliasOf<TJoinSchema>, TMatchingJoinConfig extends SpecificMatchingJoinConfig<TSchema, TJoinedCriteriaAlias>>(criteriaToJoin: JoinCriteriaParameterType<TSchema, TJoinSchema, TJoinedCriteriaAlias, TMatchingJoinConfig>, joinParameter: JoinParameterType<TSchema, TJoinSchema, TMatchingJoinConfig>): this;
     private assertIsValidJoinOptions;
+    /**
+     * Gets the current cursor configuration, if set.
+     * @returns {Cursor<FieldOfSchema<TSchema>, FilterOperator.GREATER_THAN | FilterOperator.LESS_THAN> | undefined}
+     * The cursor object or undefined.
+     */
     get cursor(): Cursor<FieldOfSchema<TSchema>, FilterOperator.GREATER_THAN | FilterOperator.LESS_THAN> | undefined;
+    /**
+     * Sets the cursor for pagination.
+     * @template Operator - The specific comparison operator for the cursor.
+     * @param {readonly [Omit<FilterPrimitive<FieldOfSchema<TSchema>, Operator>, 'operator'>] | readonly
+     *   [Omit<FilterPrimitive<FieldOfSchema<TSchema>, Operator>, 'operator'>,
+     *   Omit<FilterPrimitive<FieldOfSchema<TSchema>, Operator>, 'operator'>]} filterPrimitives - An array of one or two
+     *   filter primitives defining the cursor's fields and values.
+     * @param {Operator} operator - The comparison operator (GREATER_THAN or LESS_THAN).
+     * @param {OrderDirection} order - The primary order direction for pagination.
+     * @returns {this} The current criteria instance for chaining.
+     * @throws {Error} If filterPrimitives does not contain exactly 1 or 2 elements.
+     * @throws {Error} If any cursor field is not defined in the schema.
+     * @throws {Error} If any cursor value is undefined (null is allowed, per Cursor constructor).
+     * @throws {Error} If two cursor fields are provided and they are identical (per Cursor constructor).
+     */
     setCursor<Operator extends FilterOperator.GREATER_THAN | FilterOperator.LESS_THAN>(filterPrimitives: readonly [
         Omit<FilterPrimitive<FieldOfSchema<TSchema>, Operator>, 'operator'>
     ] | readonly [
         Omit<FilterPrimitive<FieldOfSchema<TSchema>, Operator>, 'operator'>,
         Omit<FilterPrimitive<FieldOfSchema<TSchema>, Operator>, 'operator'>
-    ], operator: Operator, order: OrderDirection): ICriteriaBase<TSchema, CurrentAlias>;
+    ], operator: Operator, order: OrderDirection): this;
 }
 //# sourceMappingURL=criteria.d.ts.map

package/dist/criteria/criteria.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"criteria.d.ts","sourceRoot":"","sources":["../../src/criteria/criteria.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,aAAa,EAEb,eAAe,EAChB,MAAM,yBAAyB,CAAC;AAIjC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAChF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EACV,yBAAyB,EACzB,iBAAiB,EACjB,0BAA0B,EAC3B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAM3D,8BAAsB,QAAQ,CAC5B,OAAO,SAAS,cAAc,EAC9B,YAAY,SAAS,eAAe,CAAC,OAAO,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,CACxE,YAAW,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC;IAgB7C,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO;IAClC,SAAS,CAAC,MAAM,EAAE,YAAY;IAfhC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAwC;IACvE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAsC;IACnE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAyB;IACtD,OAAO,CAAC,KAAK,CAAa;IAC1B,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAe;IAC7D,OAAO,CAAC,UAAU,CAAiB;IACnC,SAAS,CAAC,OAAO,EACb,MAAM,CACJ,aAAa,CAAC,OAAO,CAAC,EACtB,cAAc,CAAC,YAAY,GAAG,cAAc,CAAC,SAAS,CACvD,GACD,SAAS,CAAC;gBAGO,MAAM,EAAE,OAAO,EACxB,MAAM,EAAE,YAAY;IAShC,IAAI,MAAM,6BAKT;IAED,QAAQ,CAAC,aAAa,IAAI,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC;IAC9D,WAAW;IAMX,IAAI,SAAS,YAEZ;IAED,SAAS,CAAC,YAAY,EAAE,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAWrD,IAAI,IAAI,WAEP;IAED,OAAO,CAAC,KAAK,CAAa;IAE1B,IAAI,IAAI,WAEP;IAED,OAAO,CAAC,OAAO,CAA4C;IAE3D,IAAI,MAAM,IAAI,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAEzD;IAED,IAAI,KAAK,yEAER;IAED,IAAI,eAAe,6CAElB;IAED,IAAI,UAAU,2BAEb;IAED,IAAI,KAAK,iBAER;IAED,OAAO,CAAC,MAAM,EAAE,MAAM;IAOtB,OAAO,CAAC,MAAM,EAAE,MAAM;IAQtB;;;;;;;;OAQG;IACH,SAAS,CAAC,kBAAkB,CAAC,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC;IAM1D,OAAO,CAAC,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,cAAc;IAMhE,KAAK,CAAC,QAAQ,SAAS,cAAc,EACnC,eAAe,EAAE,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC;IAOpE,QAAQ,CAAC,QAAQ,SAAS,cAAc,EACtC,eAAe,EAAE,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC;IAOpE,OAAO,CAAC,QAAQ,SAAS,cAAc,EACrC,eAAe,EAAE,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC;IAOpE,IAAI,CACF,WAAW,SAAS,cAAc,EAClC,oBAAoB,SAAS,eAAe,CAAC,WAAW,CAAC,EACzD,mBAAmB,SAAS,0BAA0B,CACpD,OAAO,EACP,oBAAoB,CACrB,EAED,cAAc,EAAE,yBAAyB,CACvC,OAAO,EACP,WAAW,EACX,oBAAoB,EACpB,mBAAmB,CACpB,EACD,aAAa,EAAE,iBAAiB,CAAC,OAAO,EAAE,WAAW,EAAE,mBAAmB,CAAC;IA+B7E,OAAO,CAAC,wBAAwB;IAqChC,IAAI,MAAM,uGAET;IAED,SAAS,CACP,QAAQ,SAAS,cAAc,CAAC,YAAY,GAAG,cAAc,CAAC,SAAS,EAEvE,gBAAgB,EACZ,SAAS;QACP,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,EAAE,UAAU,CAAC;KACpE,GACD,SAAS;QACP,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,EAAE,UAAU,CAAC;QACnE,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,EAAE,UAAU,CAAC;KACpE,EACL,QAAQ,EAAE,QAAQ,EAClB,KAAK,EAAE,cAAc,GACpB,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC;CAWxC"}
+{"version":3,"file":"criteria.d.ts","sourceRoot":"","sources":["../../src/criteria/criteria.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,aAAa,EAEb,eAAe,EAChB,MAAM,yBAAyB,CAAC;AAIjC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAChF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EACV,yBAAyB,EACzB,iBAAiB,EACjB,0BAA0B,EAC1B,iBAAiB,EAClB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAO3D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D;;;;;;;GAOG;AACH,8BAAsB,QAAQ,CAC5B,OAAO,SAAS,cAAc,EAC9B,YAAY,SAAS,eAAe,CAAC,OAAO,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,CACxE,YAAW,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC;IA+B7C,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO;IAClC,SAAS,CAAC,MAAM,EAAE,YAAY;IA9BhC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAwC;IACvE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAsC;IACnE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAyB;IACtD,OAAO,CAAC,KAAK,CAAa;IAC1B;;;;OAIG;IACH,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAe;IAC7D,OAAO,CAAC,UAAU,CAAiB;IACnC;;;OAGG;IACH,SAAS,CAAC,OAAO,EACb,MAAM,CACJ,aAAa,CAAC,OAAO,CAAC,EACtB,cAAc,CAAC,YAAY,GAAG,cAAc,CAAC,SAAS,CACvD,GACD,SAAS,CAAC;IACd;;;;;;OAMG;gBAEkB,MAAM,EAAE,OAAO,EACxB,MAAM,EAAE,YAAY;IAUhC;;;;;OAKG;IACH,IAAI,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAK1C;IACD;;;;;OAKG;IACH,WAAW;IAKX;;;OAGG;IACH,IAAI,SAAS,IAAI,OAAO,CAEvB;IACD;;;;;;OAMG;IACH,SAAS,CAAC,YAAY,EAAE,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,IAAI;IAU5D;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,OAAO,CAAC,KAAK,CAAa;IAC1B;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,OAAO,CAAC,OAAO,CAA4C;IAC3D;;;OAGG;IACH,IAAI,MAAM,IAAI,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAEzD;IACD;;;OAGG;IACH,IAAI,KAAK,IAAI,aAAa,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAErD;IACD;;;OAGG;IACH,IAAI,eAAe,IAAI,WAAW,CAEjC;IACD;;;OAGG;IACH,IAAI,UAAU,IAAI,OAAO,CAAC,aAAa,CAAC,CAEvC;IACD;;;OAGG;IACH,IAAI,KAAK,IAAI,YAAY,CAExB;IACD;;;;;OAKG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAO7B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAQ7B;;;;;;;;OAQG;IACH,SAAS,CAAC,kBAAkB,CAAC,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC;IAM1D;;;;;;;OAOG;IACH,OAAO,CAAC,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,cAAc,GAAG,IAAI;IAKvE;;;;;;;OAOG;IACH,KAAK,CAAC,QAAQ,SAAS,cAAc,EACnC,eAAe,EAAE,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,GACjE,IAAI;IAKP;;;;;;;;OAQG;IACH,QAAQ,CAAC,QAAQ,SAAS,cAAc,EACtC,eAAe,EAAE,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,GACjE,IAAI;IAKP;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAQ,SAAS,cAAc,EACrC,eAAe,EAAE,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,GACjE,IAAI;IAKP;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CACF,WAAW,SAAS,cAAc,EAClC,oBAAoB,SAAS,eAAe,CAAC,WAAW,CAAC,EACzD,mBAAmB,SAAS,0BAA0B,CACpD,OAAO,EACP,oBAAoB,CACrB,EAED,cAAc,EAAE,yBAAyB,CACvC,OAAO,EACP,WAAW,EACX,oBAAoB,EACpB,mBAAmB,CACpB,EACD,aAAa,EAAE,iBAAiB,CAAC,OAAO,EAAE,WAAW,EAAE,mBAAmB,CAAC,GAC1E,IAAI;IAoCP,OAAO,CAAC,wBAAwB;IAoChC;;;;OAIG;IACH,IAAI,MAAM,IACN,MAAM,CACJ,aAAa,CAAC,OAAO,CAAC,EACtB,cAAc,CAAC,YAAY,GAAG,cAAc,CAAC,SAAS,CACvD,GACD,SAAS,CAEZ;IACD;;;;;;;;;;;;;;OAcG;IACH,SAAS,CACP,QAAQ,SAAS,cAAc,CAAC,YAAY,GAAG,cAAc,CAAC,SAAS,EAEvE,gBAAgB,EACZ,SAAS;QACP,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,EAAE,UAAU,CAAC;KACpE,GACD,SAAS;QACP,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,EAAE,UAAU,CAAC;QACnE,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,EAAE,UAAU,CAAC;KACpE,EACL,QAAQ,EAAE,QAAQ,EAClB,KAAK,EAAE,cAAc,GACpB,IAAI;CAWR"}

package/dist/criteria/criteria.js

@@ -3,6 +3,14 @@ import { CriteriaJoinManager } from './criteria-join-manager.js';
 import { Cursor } from './cursor.js';
 import { Order, OrderDirection } from './order/order.js';
 import { FilterOperator } from './types/operator.types.js';
+/**
+ * Abstract base class for constructing query criteria.
+ * It provides a fluent API for defining filters, joins, selections, ordering, and pagination.
+ * Concrete criteria types (e.g., RootCriteria, JoinCriteria) will extend this class.
+ *
+ * @template TSchema - The schema definition for the entity this criteria operates on.
+ * @template CurrentAlias - The selected alias for the entity from its schema.
+ */
 export class Criteria {
     schema;
     _alias;
@@ -10,9 +18,25 @@ export class Criteria {
     _joinManager = new CriteriaJoinManager();
     _source_name;
     _take = 0; // 0 = no limit
+    /**
+     * Stores the set of fields explicitly selected by the user.
+     * This is used when `_selectAll` is false.
+     * @protected
+     */
     _select = new Set([]);
     _selectAll = true;
+    /**
+     * Stores the cursor configuration for pagination, if set.
+     * @protected
+     */
     _cursor;
+    /**
+     * Initializes a new instance of the Criteria class.
+     * @param {TSchema} schema - The schema definition for the entity.
+     * @param {CurrentAlias} _alias - The alias to use for this entity in the query.
+     * @throws {Error} If the provided alias is not supported by the schema.
+     * @protected
+     */
     constructor(schema, _alias) {
         this.schema = schema;
         this._alias = _alias;
@@ -20,20 +44,43 @@ export class Criteria {
             throw new Error(`Unsupported alia ${this._alias} for schema ${schema.source_name}`);
         this._source_name = schema.source_name;
     }
+    /**
+     * Gets the currently selected fields.
+     * If `_selectAll` is true, it returns all fields from the schema.
+     * Otherwise, it returns the fields explicitly set via `setSelect`.
+     * @returns {Array<FieldOfSchema<TSchema>>} An array of selected field names.
+     */
     get select() {
         if (this._selectAll) {
             return [...this.schema.fields];
         }
         return Array.from(this._select);
     }
+    /**
+     * Resets the selection to include all fields from the schema.
+     * Subsequent calls to `get select()` will return all schema fields
+     * until `setSelect()` is called again.
+     * @returns {this} The current criteria instance for chaining.
+     */
     resetSelect() {
         this._selectAll = true;
         this._select.clear();
         return this;
     }
+    /**
+     * Indicates whether all fields are currently configured to be selected.
+     * @returns {boolean} True if all fields are selected, false if specific fields are selected.
+     */
     get selectAll() {
         return this._selectAll;
     }
+    /**
+     * Specifies which fields to select for the entity.
+     * Calling this method sets `selectAll` to false.
+     * @param {Array<FieldOfSchema<TSchema>>} selectFields - An array of field names to select.
+     * @returns {this} The current criteria instance for chaining.
+     * @throws {Error} If any of the specified fields are not defined in the schema.
+     */
     setSelect(selectFields) {
         for (const field of selectFields) {
             this.assetFieldOnSchema(field);
@@ -44,29 +91,63 @@ export class Criteria {
         }
         return this;
     }
+    /**
+     * Gets the maximum number of records to return (LIMIT).
+     * @returns {number} The take value.
+     */
     get take() {
         return this._take;
     }
     _skip = 0;
+    /**
+     * Gets the number of records to skip (OFFSET).
+     * @returns {number} The skip value.
+     */
     get skip() {
         return this._skip;
     }
     _orders = [];
+    /**
+     * Gets the current ordering rules applied to this criteria.
+     * @returns {ReadonlyArray<Order<FieldOfSchema<TSchema>>>} A readonly array of order objects.
+     */
     get orders() {
         return [...this._orders];
     }
+    /**
+     * Gets the configured join details for this criteria.
+     * @returns {ReadonlyArray<StoredJoinDetails<TSchema>>} A readonly array of join configurations.
+     */
     get joins() {
         return [...this._joinManager.getJoins()];
     }
+    /**
+     * Gets the root filter group for this criteria, which holds all filter conditions.
+     * @returns {FilterGroup} The root filter group.
+     */
     get rootFilterGroup() {
         return this._filterManager.getRootFilterGroup();
     }
+    /**
+     * Gets the source name (e.g., table name) for the entity of this criteria.
+     * @returns {TSchema['source_name']} The source name string.
+     */
     get sourceName() {
         return this._source_name;
     }
+    /**
+     * Gets the alias used for the entity of this criteria.
+     * @returns {CurrentAlias} The alias string.
+     */
     get alias() {
         return this._alias;
     }
+    /**
+     * Sets the maximum number of records to return (LIMIT).
+     * @param {number} amount - The number of records to take. Must be non-negative.
+     * @returns {this} The current criteria instance for chaining.
+     * @throws {Error} If the amount is negative.
+     */
     setTake(amount) {
         if (amount < 0) {
             throw new Error(`Take value cant be negative`);
@@ -74,6 +155,12 @@ export class Criteria {
         this._take = amount;
         return this;
     }
+    /**
+     * Sets the number of records to skip before starting to return records (OFFSET).
+     * @param {number} amount - The number of records to skip. Must be non-negative.
+     * @returns {this} The current criteria instance for chaining.
+     * @throws {Error} If the amount is negative.
+     */
     setSkip(amount) {
         if (amount < 0) {
             throw new Error(`Skip value cant be negative`);
@@ -94,26 +181,80 @@ export class Criteria {
         if (!this.schema.fields.includes(field))
             throw new Error(`The field '${String(field)}' is not defined in the schema '${this.schema.source_name}'.`);
     }
+    /**
+     * Adds an ordering rule to the criteria.
+     * Multiple calls will append new ordering rules.
+     * @param {FieldOfSchema<TSchema>} field - The field to order by.
+     * @param {OrderDirection} direction - The direction of the ordering (ASC or DESC).
+     * @returns {this} The current criteria instance for chaining.
+     * @throws {Error} If the specified field is not defined in the schema.
+     */
     orderBy(field, direction) {
         this.assetFieldOnSchema(field);
         this._orders.push(new Order(direction, field));
         return this;
     }
+    /**
+     * Initializes the filter criteria with a single filter primitive.
+     * This replaces any existing filters in the root filter group.
+     * @template Operator - The specific filter operator type.
+     * @param {FilterPrimitive<FieldOfSchema<TSchema>, Operator>} filterPrimitive - The filter to apply.
+     * @returns {this} The current criteria instance for chaining.
+     * @throws {Error} If the specified field in filterPrimitive is not defined in the schema.
+     */
     where(filterPrimitive) {
         this.assetFieldOnSchema(filterPrimitive.field);
         this._filterManager.where(filterPrimitive);
         return this;
     }
+    /**
+     * Adds a filter primitive to the current filter group using an AND logical operator.
+     * Requires `where()` to have been called first to initialize the filter group.
+     * @template Operator - The specific filter operator type.
+     * @param {FilterPrimitive<FieldOfSchema<TSchema>, Operator>} filterPrimitive - The filter to add.
+     * @returns {this} The current criteria instance for chaining.
+     * @throws {Error} If the specified field in filterPrimitive is not defined in the schema.
+     * @throws {Error} If `where()` has not been called first.
+     */
     andWhere(filterPrimitive) {
         this.assetFieldOnSchema(filterPrimitive.field);
         this._filterManager.andWhere(filterPrimitive);
         return this;
     }
+    /**
+     * Adds a filter primitive to the current filter group using an OR logical operator.
+     * Requires `where()` to have been called first to initialize the filter group.
+     * @template Operator - The specific filter operator type.
+     * @param {FilterPrimitive<FieldOfSchema<TSchema>, Operator>} filterPrimitive - The filter to add.
+     * @returns {this} The current criteria instance for chaining.
+     * @throws {Error} If the specified field in filterPrimitive is not defined in the schema.
+     * @throws {Error} If `where()` has not been called first.
+     */
     orWhere(filterPrimitive) {
         this.assetFieldOnSchema(filterPrimitive.field);
         this._filterManager.orWhere(filterPrimitive);
         return this;
     }
+    /**
+     * Adds a join to another criteria.
+     * @template TJoinSchema - The schema of the entity to join.
+     * @template TJoinedCriteriaAlias - The alias for the joined entity.
+     * @template TMatchingJoinConfig - The specific join configuration from the parent schema that matches the joined
+     *   alias.
+     * @param {JoinCriteriaParameterType<TSchema, TJoinSchema, TJoinedCriteriaAlias, TMatchingJoinConfig>} criteriaToJoin
+     * The criteria instance representing the entity to join (e.g., `InnerJoinCriteria`, `LeftJoinCriteria`).
+     * @param {JoinParameterType<TSchema, TJoinSchema, TMatchingJoinConfig>} joinParameter
+     * The parameters defining how the join should be performed (e.g., fields for simple join, pivot table details for
+     *   many-to-many).
+     * @returns {this} The current criteria instance for chaining.
+     * @throws {Error} If `criteriaToJoin` is a string (which is invalid).
+     * @throws {Error} If `parent_field` in `joinParameter` (or `parent_field.reference` for pivot joins) is not defined
+     *   in the parent schema.
+     * @throws {Error} If the join configuration for the given `criteriaToJoin.alias` is not found in the parent schema's
+     *   `joins` array.
+     * @throws {Error} If `joinParameter` is invalid for the `relation_type` defined in the schema (e.g., using
+     *   simple join input for many-to-many or vice-versa).
+     */
     join(criteriaToJoin, joinParameter) {
         if (typeof criteriaToJoin === 'string') {
             throw new Error(`Invalid criteriaToJoin: ${criteriaToJoin}`);
@@ -130,7 +271,10 @@ export class Criteria {
             ...joinParameter,
             parent_alias: this.alias,
             parent_source_name: this.sourceName,
-            parent_to_join_relation_type: joinConfig.join_relation_type,
+            relation_type: joinConfig.relation_type,
+            join_metadata: this.schema.joins.find((join) => join.alias === criteriaToJoin.alias)
+                ?.metadata ?? {},
+            parent_schema_metadata: this.schema.metadata ?? {},
         };
         this._joinManager.addJoin(criteriaToJoin, fullJoinParameters);
         return this;
@@ -142,7 +286,7 @@ export class Criteria {
                 'pivot_field' in field &&
                 'reference' in field);
         };
-        if (joinConfig.join_relation_type === 'many_to_many') {
+        if (joinConfig.relation_type === 'many_to_many') {
             if (!isPivotFieldObject(joinParameter.parent_field) ||
                 !isPivotFieldObject(joinParameter.join_field)) {
                 throw new Error(`Invalid JoinOptions for 'many_to_many' join. Expected parent_field and join_field to be objects with 'pivot_field' and 'reference' properties. Alias: '${String(joinConfig.alias)}'`);
@@ -151,13 +295,33 @@ export class Criteria {
         else {
             if (typeof joinParameter.parent_field !== 'string' ||
                 typeof joinParameter.join_field !== 'string') {
-                throw new Error(`Invalid JoinOptions for '${joinConfig.join_relation_type}' join. Expected parent_field and join_field to be strings. Alias: '${String(joinConfig.alias)}'`);
+                throw new Error(`Invalid JoinOptions for '${joinConfig.relation_type}' join. Expected parent_field and join_field to be strings. Alias: '${String(joinConfig.alias)}'`);
             }
         }
     }
+    /**
+     * Gets the current cursor configuration, if set.
+     * @returns {Cursor<FieldOfSchema<TSchema>, FilterOperator.GREATER_THAN | FilterOperator.LESS_THAN> | undefined}
+     * The cursor object or undefined.
+     */
     get cursor() {
         return this._cursor;
     }
+    /**
+     * Sets the cursor for pagination.
+     * @template Operator - The specific comparison operator for the cursor.
+     * @param {readonly [Omit<FilterPrimitive<FieldOfSchema<TSchema>, Operator>, 'operator'>] | readonly
+     *   [Omit<FilterPrimitive<FieldOfSchema<TSchema>, Operator>, 'operator'>,
+     *   Omit<FilterPrimitive<FieldOfSchema<TSchema>, Operator>, 'operator'>]} filterPrimitives - An array of one or two
+     *   filter primitives defining the cursor's fields and values.
+     * @param {Operator} operator - The comparison operator (GREATER_THAN or LESS_THAN).
+     * @param {OrderDirection} order - The primary order direction for pagination.
+     * @returns {this} The current criteria instance for chaining.
+     * @throws {Error} If filterPrimitives does not contain exactly 1 or 2 elements.
+     * @throws {Error} If any cursor field is not defined in the schema.
+     * @throws {Error} If any cursor value is undefined (null is allowed, per Cursor constructor).
+     * @throws {Error} If two cursor fields are provided and they are identical (per Cursor constructor).
+     */
     setCursor(filterPrimitives, operator, order) {
         if (filterPrimitives.length !== 1 && filterPrimitives.length !== 2) {
             throw new Error('The cursor must have exactly 1 or 2 elements');

package/dist/criteria/criteria.js.map

@@ -1 +1 @@
-{"version":3,"file":"criteria.js","sourceRoot":"","sources":["../../src/criteria/criteria.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAQzD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAM3D,MAAM,OAAgB,QAAQ;IAmBP;IACT;IAfK,cAAc,GAAG,IAAI,qBAAqB,EAAW,CAAC;IACtD,YAAY,GAAG,IAAI,mBAAmB,EAAW,CAAC;IAClD,YAAY,CAAyB;IAC9C,KAAK,GAAW,CAAC,CAAC,CAAC,eAAe;IAChC,OAAO,GAAgC,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC;IACrD,UAAU,GAAY,IAAI,CAAC;IACzB,OAAO,CAKH;IAEd,YACqB,MAAe,EACxB,MAAoB;QADX,WAAM,GAAN,MAAM,CAAS;QACxB,WAAM,GAAN,MAAM,CAAc;QAE9B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;YACrC,MAAM,IAAI,KAAK,CACb,oBAAoB,IAAI,CAAC,MAAM,eAAe,MAAM,CAAC,WAAW,EAAE,CACnE,CAAC;QAEJ,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC;IACzC,CAAC;IACD,IAAI,MAAM;QACR,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,OAAO,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAkC,CAAC;QAClE,CAAC;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAGD,WAAW;QACT,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,SAAS,CAAC,YAA2C;QACnD,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;YACjC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC;QACD,IAAI,YAAY,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACtD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;YACxB,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAEO,KAAK,GAAW,CAAC,CAAC;IAE1B,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAEO,OAAO,GAAyC,EAAE,CAAC;IAE3D,IAAI,MAAM;QACR,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,cAAc,CAAC,kBAAkB,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,OAAO,CAAC,MAAc;QACpB,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,CAAC,MAAc;QACpB,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACO,kBAAkB,CAAC,KAA6B;QACxD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;YACrC,MAAM,IAAI,KAAK,CACb,cAAc,MAAM,CAAC,KAAK,CAAC,mCAAmC,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,CAC1F,CAAC;IACN,CAAC;IACD,OAAO,CAAC,KAA6B,EAAE,SAAyB;QAC9D,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC/B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CACH,eAAkE;QAElE,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC/C,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,QAAQ,CACN,eAAkE;QAElE,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC/C,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CACL,eAAkE;QAElE,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC/C,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAQF,cAKC,EACD,aAA2E;QAE3E,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,2BAA2B,cAAc,EAAE,CAAC,CAAC;QAC/D,CAAC;QAED,OAAO,aAAa,CAAC,YAAY,KAAK,QAAQ;YAC5C,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,YAAY,CAAC,SAAS,CAAC;YAC/D,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QAExD,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CACvC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,cAAc,CAAC,KAAK,CAC9C,CAAC;QACF,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CACb,iCAAiC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,0BAA0B,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,CACnH,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,wBAAwB,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;QAEzD,MAAM,kBAAkB,GAAG;YACzB,GAAG,aAAa;YAChB,YAAY,EAAE,IAAI,CAAC,KAAK;YACxB,kBAAkB,EAAE,IAAI,CAAC,UAAU;YACnC,4BAA4B,EAAE,UAAU,CAAC,kBAAkB;SAC5D,CAAC;QACF,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC9D,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,wBAAwB,CAC9B,UAA+B,EAC/B,aAEyC;QAEzC,MAAM,kBAAkB,GAAG,CACzB,KAAU,EAC2C,EAAE;YACvD,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;gBACzB,KAAK,KAAK,IAAI;gBACd,aAAa,IAAI,KAAK;gBACtB,WAAW,IAAI,KAAK,CACrB,CAAC;QACJ,CAAC,CAAC;QACF,IAAI,UAAU,CAAC,kBAAkB,KAAK,cAAc,EAAE,CAAC;YACrD,IACE,CAAC,kBAAkB,CAAC,aAAa,CAAC,YAAY,CAAC;gBAC/C,CAAC,kBAAkB,CAAC,aAAa,CAAC,UAAU,CAAC,EAC7C,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,0JAA0J,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CACtL,CAAC;YACJ,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IACE,OAAO,aAAa,CAAC,YAAY,KAAK,QAAQ;gBAC9C,OAAO,aAAa,CAAC,UAAU,KAAK,QAAQ,EAC5C,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,4BAA4B,UAAU,CAAC,kBAAkB,uEAAuE,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAC5J,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,SAAS,CAGP,gBAOK,EACL,QAAkB,EAClB,KAAqB;QAErB,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACnE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAClE,CAAC;QAED,KAAK,MAAM,eAAe,IAAI,gBAAgB,EAAE,CAAC;YAC/C,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,MAAM,CAAC,gBAAgB,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}
+{"version":3,"file":"criteria.js","sourceRoot":"","sources":["../../src/criteria/criteria.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AASzD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAQ3D;;;;;;;GAOG;AACH,MAAM,OAAgB,QAAQ;IAkCP;IACT;IA9BK,cAAc,GAAG,IAAI,qBAAqB,EAAW,CAAC;IACtD,YAAY,GAAG,IAAI,mBAAmB,EAAW,CAAC;IAClD,YAAY,CAAyB;IAC9C,KAAK,GAAW,CAAC,CAAC,CAAC,eAAe;IAC1C;;;;OAIG;IACO,OAAO,GAAgC,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC;IACrD,UAAU,GAAY,IAAI,CAAC;IACnC;;;OAGG;IACO,OAAO,CAKH;IACd;;;;;;OAMG;IACH,YACqB,MAAe,EACxB,MAAoB;QADX,WAAM,GAAN,MAAM,CAAS;QACxB,WAAM,GAAN,MAAM,CAAc;QAE9B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;YACrC,MAAM,IAAI,KAAK,CACb,oBAAoB,IAAI,CAAC,MAAM,eAAe,MAAM,CAAC,WAAW,EAAE,CACnE,CAAC;QAEJ,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACH,IAAI,MAAM;QACR,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,OAAO,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAkC,CAAC;QAClE,CAAC;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IACD;;;;;OAKG;IACH,WAAW;QACT,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;OAGG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IACD;;;;;;OAMG;IACH,SAAS,CAAC,YAA2C;QACnD,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;YACjC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC;QACD,IAAI,YAAY,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACtD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;YACxB,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;OAGG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAEO,KAAK,GAAW,CAAC,CAAC;IAC1B;;;OAGG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAEO,OAAO,GAAyC,EAAE,CAAC;IAC3D;;;OAGG;IACH,IAAI,MAAM;QACR,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;IACD;;;OAGG;IACH,IAAI,KAAK;QACP,OAAO,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC3C,CAAC;IACD;;;OAGG;IACH,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,cAAc,CAAC,kBAAkB,EAAE,CAAC;IAClD,CAAC;IACD;;;OAGG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IACD;;;OAGG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IACD;;;;;OAKG;IACH,OAAO,CAAC,MAAc;QACpB,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACH,OAAO,CAAC,MAAc;QACpB,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACO,kBAAkB,CAAC,KAA6B;QACxD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;YACrC,MAAM,IAAI,KAAK,CACb,cAAc,MAAM,CAAC,KAAK,CAAC,mCAAmC,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,CAC1F,CAAC;IACN,CAAC;IACD;;;;;;;OAOG;IACH,OAAO,CAAC,KAA6B,EAAE,SAAyB;QAC9D,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC/B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;;;OAOG;IACH,KAAK,CACH,eAAkE;QAElE,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC/C,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;;;;OAQG;IACH,QAAQ,CACN,eAAkE;QAElE,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC/C,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;;;;OAQG;IACH,OAAO,CACL,eAAkE;QAElE,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC/C,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CAQF,cAKC,EACD,aAA2E;QAE3E,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,2BAA2B,cAAc,EAAE,CAAC,CAAC;QAC/D,CAAC;QAED,OAAO,aAAa,CAAC,YAAY,KAAK,QAAQ;YAC5C,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,YAAY,CAAC,SAAS,CAAC;YAC/D,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QAExD,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CACvC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,cAAc,CAAC,KAAK,CAC9C,CAAC;QACF,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CACb,iCAAiC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,0BAA0B,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,CACnH,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,wBAAwB,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;QAEzD,MAAM,kBAAkB,GAEgD;YACtE,GAAG,aAAa;YAChB,YAAY,EAAE,IAAI,CAAC,KAAK;YACxB,kBAAkB,EAAE,IAAI,CAAC,UAAU;YACnC,aAAa,EAAE,UAAU,CAAC,aAAa;YACvC,aAAa,EACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,cAAc,CAAC,KAAK,CAAC;gBACnE,EAAE,QAAQ,IAAI,EAAE;YACpB,sBAAsB,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE;SACnD,CAAC;QACF,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC9D,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,wBAAwB,CAC9B,UAA+B,EAC/B,aAEyC;QAEzC,MAAM,kBAAkB,GAAG,CACzB,KAAU,EAC2C,EAAE;YACvD,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;gBACzB,KAAK,KAAK,IAAI;gBACd,aAAa,IAAI,KAAK;gBACtB,WAAW,IAAI,KAAK,CACrB,CAAC;QACJ,CAAC,CAAC;QACF,IAAI,UAAU,CAAC,aAAa,KAAK,cAAc,EAAE,CAAC;YAChD,IACE,CAAC,kBAAkB,CAAC,aAAa,CAAC,YAAY,CAAC;gBAC/C,CAAC,kBAAkB,CAAC,aAAa,CAAC,UAAU,CAAC,EAC7C,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,0JAA0J,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CACtL,CAAC;YACJ,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IACE,OAAO,aAAa,CAAC,YAAY,KAAK,QAAQ;gBAC9C,OAAO,aAAa,CAAC,UAAU,KAAK,QAAQ,EAC5C,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,4BAA4B,UAAU,CAAC,aAAa,uEAAuE,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CACvJ,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IACD;;;;OAIG;IACH,IAAI,MAAM;QAMR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IACD;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAGP,gBAOK,EACL,QAAkB,EAClB,KAAqB;QAErB,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACnE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAClE,CAAC;QAED,KAAK,MAAM,eAAe,IAAI,gBAAgB,EAAE,CAAC;YAC/C,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,MAAM,CAAC,gBAAgB,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

package/dist/criteria/cursor.js

@@ -40,8 +40,8 @@ export class Cursor {
             if (!filter.field) {
                 throw new Error('Cursor field must be defined');
             }
-            if (filter.value === undefined || filter.value === null) {
-                throw new Error(`Cursor value for field ${filter.field} must be defined`);
+            if (filter.value === undefined) {
+                throw new Error(`Cursor value for field ${String(filter.field)} must be explicitly defined (can be null, but not undefined)`);
             }
         }
         if (filterPrimitive.length === 2 &&

package/dist/criteria/cursor.js.map

@@ -1 +1 @@
-{"version":3,"file":"cursor.js","sourceRoot":"","sources":["../../src/criteria/cursor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D;;;;;;;GAOG;AACH,MAAM,OAAO,MAAM;IAIjB;;;;;OAKG;IACM,OAAO,CAEgB;IAChC;;;;OAIG;IACM,KAAK,CAAiB;IAC/B;;;;;;;;;;;OAWG;IACH,YACE,eAKmE,EACnE,QAAkB,EAClB,KAAqB;QAErB,KAAK,MAAM,MAAM,IAAI,eAAe,EAAE,CAAC;YACrC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;YAClD,CAAC;YACD,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;gBACxD,MAAM,IAAI,KAAK,CACb,0BAA0B,MAAM,CAAC,KAAK,kBAAkB,CACzD,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IACE,eAAe,CAAC,MAAM,KAAK,CAAC;YAC5B,eAAe,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,eAAe,CAAC,CAAC,CAAC,EAAE,KAAK,EACtD,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC5E,CAAC;QAED,MAAM,WAAW,GAAG,eAAe,CAAC,GAAG,CACrC,CAAC,eAAe,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,EAAE,GAAG,eAAe,EAAE,QAAQ,EAAE,CAAC,CAClE,CAAC;QACF,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,WAAkC,CAAC;QAClD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF"}
+{"version":3,"file":"cursor.js","sourceRoot":"","sources":["../../src/criteria/cursor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D;;;;;;;GAOG;AACH,MAAM,OAAO,MAAM;IAIjB;;;;;OAKG;IACM,OAAO,CAEgB;IAChC;;;;OAIG;IACM,KAAK,CAAiB;IAC/B;;;;;;;;;;;OAWG;IACH,YACE,eAKmE,EACnE,QAAkB,EAClB,KAAqB;QAErB,KAAK,MAAM,MAAM,IAAI,eAAe,EAAE,CAAC;YACrC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;YAClD,CAAC;YACD,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CACb,0BAA0B,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,8DAA8D,CAC7G,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IACE,eAAe,CAAC,MAAM,KAAK,CAAC;YAC5B,eAAe,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,eAAe,CAAC,CAAC,CAAC,EAAE,KAAK,EACtD,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC5E,CAAC;QAED,MAAM,WAAW,GAAG,eAAe,CAAC,GAAG,CACrC,CAAC,eAAe,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,EAAE,GAAG,eAAe,EAAE,QAAQ,EAAE,CAAC,CAClE,CAAC;QACF,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,WAAkC,CAAC;QAClD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF"}

package/dist/criteria/join/inner.join-criteria.d.ts

@@ -22,6 +22,11 @@ export declare class InnerJoinCriteria<CSchema extends CriteriaSchema, Alias ext
      * @returns {TranslationOutput} The result of the visitor processing this join.
      */
     accept<TranslationContext, TranslationOutput>(visitor: ICriteriaVisitor<TranslationContext, TranslationOutput>, parameters: PivotJoin<CriteriaSchema, CSchema, JoinRelationType> | SimpleJoin<CriteriaSchema, CSchema, JoinRelationType>, context: TranslationContext): TranslationOutput;
+    /**
+     * Returns a new instance of `RootCriteria` with the same schema and alias configuration,
+     * but with all other states (filters, joins, ordering, pagination, selection) reset to their defaults.
+     * @returns {InnerJoinCriteria<CSchema, Alias>} A new, reset `RootCriteria` instance.
+     */
     resetCriteria(): InnerJoinCriteria<CSchema, Alias>;
 }
 //# sourceMappingURL=inner.join-criteria.d.ts.map

package/dist/criteria/join/inner.join-criteria.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"inner.join-criteria.d.ts","sourceRoot":"","sources":["../../../src/criteria/join/inner.join-criteria.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,eAAe,EAChB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAE5E;;;;;GAKG;AACH,qBAAa,iBAAiB,CAC5B,OAAO,SAAS,cAAc,EAC9B,KAAK,SAAS,eAAe,CAAC,OAAO,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,CACjE,SAAQ,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;IAChC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,kBAAkB,EAAE,iBAAiB,EAC1C,OAAO,EAAE,gBAAgB,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,EAChE,UAAU,EACN,SAAS,CAAC,cAAc,EAAE,OAAO,EAAE,gBAAgB,CAAC,GACpD,UAAU,CAAC,cAAc,EAAE,OAAO,EAAE,gBAAgB,CAAC,EACzD,OAAO,EAAE,kBAAkB,GAC1B,iBAAiB;IAQX,aAAa,IAAI,iBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC;CAG5D"}
+{"version":3,"file":"inner.join-criteria.d.ts","sourceRoot":"","sources":["../../../src/criteria/join/inner.join-criteria.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,eAAe,EAChB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAE5E;;;;;GAKG;AACH,qBAAa,iBAAiB,CAC5B,OAAO,SAAS,cAAc,EAC9B,KAAK,SAAS,eAAe,CAAC,OAAO,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,CACjE,SAAQ,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;IAChC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,kBAAkB,EAAE,iBAAiB,EAC1C,OAAO,EAAE,gBAAgB,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,EAChE,UAAU,EACN,SAAS,CAAC,cAAc,EAAE,OAAO,EAAE,gBAAgB,CAAC,GACpD,UAAU,CAAC,cAAc,EAAE,OAAO,EAAE,gBAAgB,CAAC,EACzD,OAAO,EAAE,kBAAkB,GAC1B,iBAAiB;IAOpB;;;;OAIG;IACH,aAAa,IAAI,iBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC;CAGnD"}

package/dist/criteria/join/inner.join-criteria.js

@@ -24,6 +24,11 @@ export class InnerJoinCriteria extends Criteria {
             : this.assetFieldOnSchema(parameters.join_field);
         return visitor.visitInnerJoin(this, parameters, context);
     }
+    /**
+     * Returns a new instance of `RootCriteria` with the same schema and alias configuration,
+     * but with all other states (filters, joins, ordering, pagination, selection) reset to their defaults.
+     * @returns {InnerJoinCriteria<CSchema, Alias>} A new, reset `RootCriteria` instance.
+     */
     resetCriteria() {
         return new InnerJoinCriteria(this.schema, this._alias);
     }

package/dist/criteria/join/inner.join-criteria.js.map

@@ -1 +1 @@
-{"version":3,"file":"inner.join-criteria.js","sourceRoot":"","sources":["../../../src/criteria/join/inner.join-criteria.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C;;;;;GAKG;AACH,MAAM,OAAO,iBAGX,SAAQ,QAAwB;IAChC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,OAAgE,EAChE,UAEyD,EACzD,OAA2B;QAE3B,OAAO,UAAU,CAAC,UAAU,KAAK,QAAQ;YACvC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC;YAC1D,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAEnD,OAAO,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAEQ,aAAa;QACpB,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACzD,CAAC;CACF"}
+{"version":3,"file":"inner.join-criteria.js","sourceRoot":"","sources":["../../../src/criteria/join/inner.join-criteria.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C;;;;;GAKG;AACH,MAAM,OAAO,iBAGX,SAAQ,QAAwB;IAChC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,OAAgE,EAChE,UAEyD,EACzD,OAA2B;QAE3B,OAAO,UAAU,CAAC,UAAU,KAAK,QAAQ;YACvC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC;YAC1D,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAEnD,OAAO,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IACD;;;;OAIG;IACH,aAAa;QACX,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACzD,CAAC;CACF"}

package/dist/criteria/join/left.join-criteria.d.ts

@@ -21,6 +21,11 @@ export declare class LeftJoinCriteria<CSchema extends CriteriaSchema, Alias exte
      * @returns {TranslationOutput} The result of the visitor processing this join.
      */
     accept<TranslationContext, TranslationOutput>(visitor: ICriteriaVisitor<TranslationContext, TranslationOutput>, parameters: PivotJoin<CriteriaSchema, CSchema, JoinRelationType> | SimpleJoin<CriteriaSchema, CSchema, JoinRelationType>, context: TranslationContext): TranslationOutput;
+    /**
+     * Returns a new instance of `RootCriteria` with the same schema and alias configuration,
+     * but with all other states (filters, joins, ordering, pagination, selection) reset to their defaults.
+     * @returns {LeftJoinCriteria<CSchema, Alias>} A new, reset `RootCriteria` instance.
+     */
     resetCriteria(): LeftJoinCriteria<CSchema, Alias>;
 }
 //# sourceMappingURL=left.join-criteria.d.ts.map

package/dist/criteria/join/left.join-criteria.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"left.join-criteria.d.ts","sourceRoot":"","sources":["../../../src/criteria/join/left.join-criteria.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,eAAe,EAChB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAE5E;;;;;GAKG;AACH,qBAAa,gBAAgB,CAC3B,OAAO,SAAS,cAAc,EAC9B,KAAK,SAAS,eAAe,CAAC,OAAO,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,CACjE,SAAQ,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;IAChC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,kBAAkB,EAAE,iBAAiB,EAC1C,OAAO,EAAE,gBAAgB,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,EAChE,UAAU,EACN,SAAS,CAAC,cAAc,EAAE,OAAO,EAAE,gBAAgB,CAAC,GACpD,UAAU,CAAC,cAAc,EAAE,OAAO,EAAE,gBAAgB,CAAC,EACzD,OAAO,EAAE,kBAAkB,GAC1B,iBAAiB;IAOpB,aAAa,IAAI,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC;CAGlD"}
+{"version":3,"file":"left.join-criteria.d.ts","sourceRoot":"","sources":["../../../src/criteria/join/left.join-criteria.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,eAAe,EAChB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAE5E;;;;;GAKG;AACH,qBAAa,gBAAgB,CAC3B,OAAO,SAAS,cAAc,EAC9B,KAAK,SAAS,eAAe,CAAC,OAAO,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,CACjE,SAAQ,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;IAChC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,kBAAkB,EAAE,iBAAiB,EAC1C,OAAO,EAAE,gBAAgB,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,EAChE,UAAU,EACN,SAAS,CAAC,cAAc,EAAE,OAAO,EAAE,gBAAgB,CAAC,GACpD,UAAU,CAAC,cAAc,EAAE,OAAO,EAAE,gBAAgB,CAAC,EACzD,OAAO,EAAE,kBAAkB,GAC1B,iBAAiB;IAOpB;;;;OAIG;IACH,aAAa,IAAI,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC;CAGlD"}

package/dist/criteria/join/left.join-criteria.js

@@ -23,6 +23,11 @@ export class LeftJoinCriteria extends Criteria {
             : this.assetFieldOnSchema(parameters.join_field);
         return visitor.visitLeftJoin(this, parameters, context);
     }
+    /**
+     * Returns a new instance of `RootCriteria` with the same schema and alias configuration,
+     * but with all other states (filters, joins, ordering, pagination, selection) reset to their defaults.
+     * @returns {LeftJoinCriteria<CSchema, Alias>} A new, reset `RootCriteria` instance.
+     */
     resetCriteria() {
         return new LeftJoinCriteria(this.schema, this._alias);
     }

package/dist/criteria/join/left.join-criteria.js.map

@@ -1 +1 @@
-{"version":3,"file":"left.join-criteria.js","sourceRoot":"","sources":["../../../src/criteria/join/left.join-criteria.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C;;;;;GAKG;AACH,MAAM,OAAO,gBAGX,SAAQ,QAAwB;IAChC;;;;;;;;;;OAUG;IACH,MAAM,CACJ,OAAgE,EAChE,UAEyD,EACzD,OAA2B;QAE3B,OAAO,UAAU,CAAC,UAAU,KAAK,QAAQ;YACvC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC;YAC1D,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAEnD,OAAO,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IACD,aAAa;QACX,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACxD,CAAC;CACF"}
+{"version":3,"file":"left.join-criteria.js","sourceRoot":"","sources":["../../../src/criteria/join/left.join-criteria.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C;;;;;GAKG;AACH,MAAM,OAAO,gBAGX,SAAQ,QAAwB;IAChC;;;;;;;;;;OAUG;IACH,MAAM,CACJ,OAAgE,EAChE,UAEyD,EACzD,OAA2B;QAE3B,OAAO,UAAU,CAAC,UAAU,KAAK,QAAQ;YACvC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC;YAC1D,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAEnD,OAAO,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IACD;;;;OAIG;IACH,aAAa;QACX,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACxD,CAAC;CACF"}

package/dist/criteria/join/outer.join-criteria.d.ts

@@ -22,6 +22,11 @@ export declare class OuterJoinCriteria<CSchema extends CriteriaSchema, Alias ext
      * @returns {TranslationOutput} The result of the visitor processing this join.
      */
     accept<TranslationContext, TranslationOutput>(visitor: ICriteriaVisitor<TranslationContext, TranslationOutput>, parameters: PivotJoin<CriteriaSchema, CSchema, JoinRelationType> | SimpleJoin<CriteriaSchema, CSchema, JoinRelationType>, context: TranslationContext): TranslationOutput;
+    /**
+     * Returns a new instance of `RootCriteria` with the same schema and alias configuration,
+     * but with all other states (filters, joins, ordering, pagination, selection) reset to their defaults.
+     * @returns {OuterJoinCriteria<CSchema, Alias>} A new, reset `RootCriteria` instance.
+     */
     resetCriteria(): OuterJoinCriteria<CSchema, Alias>;
 }
 //# sourceMappingURL=outer.join-criteria.d.ts.map

package/dist/criteria/join/outer.join-criteria.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"outer.join-criteria.d.ts","sourceRoot":"","sources":["../../../src/criteria/join/outer.join-criteria.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,eAAe,EAChB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAE5E;;;;;;GAMG;AACH,qBAAa,iBAAiB,CAC5B,OAAO,SAAS,cAAc,EAC9B,KAAK,SAAS,eAAe,CAAC,OAAO,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,CACjE,SAAQ,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;IAChC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,kBAAkB,EAAE,iBAAiB,EAC1C,OAAO,EAAE,gBAAgB,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,EAChE,UAAU,EACN,SAAS,CAAC,cAAc,EAAE,OAAO,EAAE,gBAAgB,CAAC,GACpD,UAAU,CAAC,cAAc,EAAE,OAAO,EAAE,gBAAgB,CAAC,EACzD,OAAO,EAAE,kBAAkB,GAC1B,iBAAiB;IAMpB,aAAa,IAAI,iBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC;CAGnD"}
+{"version":3,"file":"outer.join-criteria.d.ts","sourceRoot":"","sources":["../../../src/criteria/join/outer.join-criteria.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,eAAe,EAChB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAE5E;;;;;;GAMG;AACH,qBAAa,iBAAiB,CAC5B,OAAO,SAAS,cAAc,EAC9B,KAAK,SAAS,eAAe,CAAC,OAAO,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,CACjE,SAAQ,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;IAChC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,kBAAkB,EAAE,iBAAiB,EAC1C,OAAO,EAAE,gBAAgB,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,EAChE,UAAU,EACN,SAAS,CAAC,cAAc,EAAE,OAAO,EAAE,gBAAgB,CAAC,GACpD,UAAU,CAAC,cAAc,EAAE,OAAO,EAAE,gBAAgB,CAAC,EACzD,OAAO,EAAE,kBAAkB,GAC1B,iBAAiB;IAMpB;;;;OAIG;IACH,aAAa,IAAI,iBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC;CAGnD"}

package/dist/criteria/join/outer.join-criteria.js

@@ -24,6 +24,11 @@ export class OuterJoinCriteria extends Criteria {
             : this.assetFieldOnSchema(parameters.join_field);
         return visitor.visitOuterJoin(this, parameters, context);
     }
+    /**
+     * Returns a new instance of `RootCriteria` with the same schema and alias configuration,
+     * but with all other states (filters, joins, ordering, pagination, selection) reset to their defaults.
+     * @returns {OuterJoinCriteria<CSchema, Alias>} A new, reset `RootCriteria` instance.
+     */
     resetCriteria() {
         return new OuterJoinCriteria(this.schema, this._alias);
     }

package/dist/criteria/join/outer.join-criteria.js.map

@@ -1 +1 @@
-{"version":3,"file":"outer.join-criteria.js","sourceRoot":"","sources":["../../../src/criteria/join/outer.join-criteria.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C;;;;;;GAMG;AACH,MAAM,OAAO,iBAGX,SAAQ,QAAwB;IAChC;;;;;;;;;;OAUG;IACH,MAAM,CACJ,OAAgE,EAChE,UAEyD,EACzD,OAA2B;QAE3B,OAAO,UAAU,CAAC,UAAU,KAAK,QAAQ;YACvC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC;YAC1D,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QACnD,OAAO,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IACD,aAAa;QACX,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACzD,CAAC;CACF"}
+{"version":3,"file":"outer.join-criteria.js","sourceRoot":"","sources":["../../../src/criteria/join/outer.join-criteria.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C;;;;;;GAMG;AACH,MAAM,OAAO,iBAGX,SAAQ,QAAwB;IAChC;;;;;;;;;;OAUG;IACH,MAAM,CACJ,OAAgE,EAChE,UAEyD,EACzD,OAA2B;QAE3B,OAAO,UAAU,CAAC,UAAU,KAAK,QAAQ;YACvC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC;YAC1D,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QACnD,OAAO,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IACD;;;;OAIG;IACH,aAAa;QACX,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACzD,CAAC;CACF"}

package/dist/criteria/root.criteria.d.ts

@@ -23,6 +23,11 @@ export declare class RootCriteria<CSchema extends CriteriaSchema, Alias extends
      * @returns {TranslationOutput} The result of the visitor processing this root criteria and its components.
      */
     accept<TranslationContext, TranslationOutput>(visitor: ICriteriaVisitor<TranslationContext, TranslationOutput>, context: TranslationContext): TranslationOutput;
+    /**
+     * Returns a new instance of `RootCriteria` with the same schema and alias configuration,
+     * but with all other states (filters, joins, ordering, pagination, selection) reset to their defaults.
+     * @returns {RootCriteria<CSchema, Alias>} A new, reset `RootCriteria` instance.
+     */
     resetCriteria(): RootCriteria<CSchema, Alias>;
 }
 //# sourceMappingURL=root.criteria.d.ts.map

package/dist/criteria/root.criteria.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"root.criteria.d.ts","sourceRoot":"","sources":["../../src/criteria/root.criteria.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAE3E;;;;;;GAMG;AACH,qBAAa,YAAY,CACvB,OAAO,SAAS,cAAc,EAC9B,KAAK,SAAS,eAAe,CAAC,OAAO,CAAC,CACtC,SAAQ,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;IAChC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,kBAAkB,EAAE,iBAAiB,EAC1C,OAAO,EAAE,gBAAgB,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,EAChE,OAAO,EAAE,kBAAkB,GAC1B,iBAAiB;IAGpB,aAAa,IAAI,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC;CAG9C"}
+{"version":3,"file":"root.criteria.d.ts","sourceRoot":"","sources":["../../src/criteria/root.criteria.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAE3E;;;;;;GAMG;AACH,qBAAa,YAAY,CACvB,OAAO,SAAS,cAAc,EAC9B,KAAK,SAAS,eAAe,CAAC,OAAO,CAAC,CACtC,SAAQ,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;IAChC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,kBAAkB,EAAE,iBAAiB,EAC1C,OAAO,EAAE,gBAAgB,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,EAChE,OAAO,EAAE,kBAAkB,GAC1B,iBAAiB;IAGpB;;;;OAIG;IACH,aAAa,IAAI,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC;CAG9C"}

package/dist/criteria/root.criteria.js

@@ -23,6 +23,11 @@ export class RootCriteria extends Criteria {
     accept(visitor, context) {
         return visitor.visitRoot(this, context);
     }
+    /**
+     * Returns a new instance of `RootCriteria` with the same schema and alias configuration,
+     * but with all other states (filters, joins, ordering, pagination, selection) reset to their defaults.
+     * @returns {RootCriteria<CSchema, Alias>} A new, reset `RootCriteria` instance.
+     */
     resetCriteria() {
         return new RootCriteria(this.schema, this._alias);
     }

package/dist/criteria/root.criteria.js.map

@@ -1 +1 @@
-{"version":3,"file":"root.criteria.js","sourceRoot":"","sources":["../../src/criteria/root.criteria.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAIzC;;;;;;GAMG;AACH,MAAM,OAAO,YAGX,SAAQ,QAAwB;IAChC;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,OAAgE,EAChE,OAA2B;QAE3B,OAAO,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IACD,aAAa;QACX,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;CACF"}
+{"version":3,"file":"root.criteria.js","sourceRoot":"","sources":["../../src/criteria/root.criteria.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAIzC;;;;;;GAMG;AACH,MAAM,OAAO,YAGX,SAAQ,QAAwB;IAChC;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,OAAgE,EAChE,OAA2B;QAE3B,OAAO,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IACD;;;;OAIG;IACH,aAAa;QACX,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;CACF"}

package/dist/criteria/types/criteria.interface.d.ts

@@ -16,9 +16,13 @@ export interface ICriteriaBase<TSchema extends CriteriaSchema, CurrentAlias exte
      * Configures the criteria to select all available fields from the root entity
      * and any joined entities that also have `selectAll()` called or by default.
      * This overrides any previous specific selections made by `setSelect()`.
-     * @returns {ICriteriaBase<TSchema, CurrentAlias>} The current criteria instance for chaining.
+     * @returns {this} The current criteria instance for chaining.
+     */
+    resetSelect(): this;
+    /**
+     * Indicates whether all fields are currently selected for the root entity.
+     * @returns {boolean} True if all fields are selected, false otherwise.
      */
-    resetSelect(): ICriteriaBase<TSchema, CurrentAlias>;
     get selectAll(): boolean;
     /**
      * Sets the cursor for pagination. A cursor defines a point from which to fetch
@@ -35,10 +39,10 @@ export interface ICriteriaBase<TSchema extends CriteriaSchema, CurrentAlias exte
      * @param {OrderDirection} order - The direction of ordering that matches the cursor logic.
      *   If operator is GREATER_THAN, order should typically be ASC.
      *   If operator is LESS_THAN, order should typically be DESC.
-     * @returns {ICriteriaBase<TSchema, CurrentAlias>} The current criteria instance for chaining.
+     * @returns {this} The current criteria instance for chaining.
      * @throws {Error} If filterPrimitive does not contain exactly 1 or 2 elements.
      * @throws {Error} If any cursor field is not defined in the schema.
-     * @throws {Error} If any cursor value is null or undefined.
+     * @throws {Error} If any cursor value is undefined (null is allowed).
      * @throws {Error} If the two cursor fields are identical.
      */
     setCursor<Operator extends FilterOperator.GREATER_THAN | FilterOperator.LESS_THAN>(filterPrimitives: readonly [
@@ -46,8 +50,7 @@ export interface ICriteriaBase<TSchema extends CriteriaSchema, CurrentAlias exte
     ] | readonly [
         Omit<FilterPrimitive<FieldOfSchema<TSchema>, Operator>, 'operator'>,
         Omit<FilterPrimitive<FieldOfSchema<TSchema>, Operator>, 'operator'>
-    ], operator: Operator, order: OrderDirection): ICriteriaBase<TSchema, CurrentAlias>;
-    resetCriteria(): ICriteriaBase<TSchema, CurrentAlias>;
+    ], operator: Operator, order: OrderDirection): this;
     /**
      * Gets the current cursor configuration, if set.
      * @returns {Cursor<FieldOfSchema<TSchema>> | undefined} The cursor object or undefined.
@@ -57,10 +60,10 @@ export interface ICriteriaBase<TSchema extends CriteriaSchema, CurrentAlias exte
      * Specifies which fields to select for the root entity.
      * Calling this method disables `selectAll()` behavior.
      * @param {Array<FieldOfSchema<TSchema>>} selectFields - An array of field names to select.
-     * @returns {ICriteriaBase<TSchema, CurrentAlias>} The current criteria instance for chaining.
+     * @returns {this} The current criteria instance for chaining.
      * @throws {Error} If any of the specified fields are not defined in the schema.
      */
-    setSelect(selectFields: Array<FieldOfSchema<TSchema>>): ICriteriaBase<TSchema, CurrentAlias>;
+    setSelect(selectFields: Array<FieldOfSchema<TSchema>>): this;
     /**
      * Gets the currently selected fields. If `selectAll()` was last called or is default,
      * it returns all fields from the schema.
@@ -72,24 +75,24 @@ export interface ICriteriaBase<TSchema extends CriteriaSchema, CurrentAlias exte
      * Multiple calls to `orderBy` will append new ordering rules.
      * @param {FieldOfSchema<TSchema>} field - The field to order by.
      * @param {OrderDirection} direction - The direction of the ordering (ASC or DESC).
-     * @returns {ICriteriaBase<TSchema, CurrentAlias>} The current criteria instance for chaining.
+     * @returns {this} The current criteria instance for chaining.
      * @throws {Error} If the specified field is not defined in the schema.
      */
-    orderBy(field: FieldOfSchema<TSchema>, direction: OrderDirection): ICriteriaBase<TSchema, CurrentAlias>;
+    orderBy(field: FieldOfSchema<TSchema>, direction: OrderDirection): this;
     /**
      * Sets the maximum number of records to return (LIMIT).
      * @param {number} amount - The number of records to take. Must be non-negative.
-     * @returns {ICriteriaBase<TSchema, CurrentAlias>} The current criteria instance for chaining.
+     * @returns {this} The current criteria instance for chaining.
      * @throws {Error} If the amount is negative.
      */
-    setTake(amount: number): ICriteriaBase<TSchema, CurrentAlias>;
+    setTake(amount: number): this;
     /**
      * Sets the number of records to skip before starting to return records (OFFSET).
      * @param {number} amount - The number of records to skip. Must be non-negative.
-     * @returns {ICriteriaBase<TSchema, CurrentAlias>} The current criteria instance for chaining.
+     * @returns {this} The current criteria instance for chaining.
      * @throws {Error} If the amount is negative.
      */
-    setSkip(amount: number): ICriteriaBase<TSchema, CurrentAlias>;
+    setSkip(amount: number): this;
     /**
      * Gets the configured join details.
      * @returns {ReadonlyArray<StoredJoinDetails<TSchema>>} An array of join configurations.
@@ -129,26 +132,26 @@ export interface ICriteriaBase<TSchema extends CriteriaSchema, CurrentAlias exte
      * Initializes the filter criteria with a single filter primitive.
      * This replaces any existing filters.
      * @param {FilterPrimitive<FieldOfSchema<TSchema>>} filterPrimitive - The filter to apply.
-     * @returns {ICriteriaBase<TSchema, CurrentAlias>} The current criteria instance for chaining.
+     * @returns {this} The current criteria instance for chaining.
      * @throws {Error} If the specified field in filterPrimitive is not defined in the schema.
      */
-    where<Operator extends FilterOperator>(filterPrimitive: FilterPrimitive<FieldOfSchema<TSchema>, Operator>): ICriteriaBase<TSchema, CurrentAlias>;
+    where<Operator extends FilterOperator>(filterPrimitive: FilterPrimitive<FieldOfSchema<TSchema>, Operator>): this;
     /**
      * Adds a filter primitive to the current filter group using an AND logical operator.
      * @param {FilterPrimitive<FieldOfSchema<TSchema>>} filterPrimitive - The filter to add.
-     * @returns {ICriteriaBase<TSchema, CurrentAlias>} The current criteria instance for chaining.
+     * @returns {this} The current criteria instance for chaining.
      * @throws {Error} If the specified field in filterPrimitive is not defined in the schema.
      * @throws {Error} If `where()` has not been called first.
      */
-    andWhere<Operator extends FilterOperator>(filterPrimitive: FilterPrimitive<FieldOfSchema<TSchema>, Operator>): ICriteriaBase<TSchema, CurrentAlias>;
+    andWhere<Operator extends FilterOperator>(filterPrimitive: FilterPrimitive<FieldOfSchema<TSchema>, Operator>): this;
     /**
      * Adds a filter primitive, creating a new OR group with the existing filters.
      * @param {FilterPrimitive<FieldOfSchema<TSchema>>} filterPrimitive - The filter to add.
-     * @returns {ICriteriaBase<TSchema, CurrentAlias>} The current criteria instance for chaining.
+     * @returns {this} The current criteria instance for chaining.
      * @throws {Error} If the specified field in filterPrimitive is not defined in the schema.
      * @throws {Error} If `where()` has not been called first.
      */
-    orWhere<Operator extends FilterOperator>(filterPrimitive: FilterPrimitive<FieldOfSchema<TSchema>, Operator>): ICriteriaBase<TSchema, CurrentAlias>;
+    orWhere<Operator extends FilterOperator>(filterPrimitive: FilterPrimitive<FieldOfSchema<TSchema>, Operator>): this;
     /**
      * Adds a join to another criteria.
      * @template TJoinSchema - The schema of the entity to join.
@@ -158,11 +161,11 @@ export interface ICriteriaBase<TSchema extends CriteriaSchema, CurrentAlias exte
      * The criteria instance representing the entity to join (e.g., `InnerJoinCriteria`, `LeftJoinCriteria`).
      * @param {JoinParameterType<TSchema, TJoinSchema, TMatchingJoinConfig>} joinParameter
      * The parameters defining how the join should be performed (e.g., fields for simple join, pivot table details for many-to-many).
-     * @returns {ICriteriaBase<TSchema, CurrentAlias>} The current criteria instance for chaining.
+     * @returns {this} The current criteria instance for chaining.
      * @throws {Error} If the join configuration for the given alias is not found in the parent schema.
      * @throws {Error} If `parent_field` in `joinParameter` is not defined in the parent schema.
-     * @throws {Error} If `joinParameter` is invalid for the `join_relation_type` defined in the schema (e.g., using simple join input for many-to-many).
+     * @throws {Error} If `joinParameter` is invalid for the `relation_type` defined in the schema (e.g., using simple join input for many-to-many).
      */
-    join<TJoinSchema extends CriteriaSchema, TJoinedCriteriaAlias extends SelectedAliasOf<TJoinSchema>, TMatchingJoinConfig extends SpecificMatchingJoinConfig<TSchema, TJoinedCriteriaAlias>>(criteriaToJoin: JoinCriteriaParameterType<TSchema, TJoinSchema, TJoinedCriteriaAlias, TMatchingJoinConfig>, joinParameter: JoinParameterType<TSchema, TJoinSchema, TMatchingJoinConfig>): ICriteriaBase<TSchema, CurrentAlias>;
+    join<TJoinSchema extends CriteriaSchema, TJoinedCriteriaAlias extends SelectedAliasOf<TJoinSchema>, TMatchingJoinConfig extends SpecificMatchingJoinConfig<TSchema, TJoinedCriteriaAlias>>(criteriaToJoin: JoinCriteriaParameterType<TSchema, TJoinSchema, TJoinedCriteriaAlias, TMatchingJoinConfig>, joinParameter: JoinParameterType<TSchema, TJoinSchema, TMatchingJoinConfig>): this;
 }
 //# sourceMappingURL=criteria.interface.d.ts.map

package/dist/criteria/types/criteria.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"criteria.interface.d.ts","sourceRoot":"","sources":["../../../src/criteria/types/criteria.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,aAAa,EACb,eAAe,EAChB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAE7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EACV,iBAAiB,EACjB,yBAAyB,EACzB,iBAAiB,EACjB,0BAA0B,EAC3B,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2CAA2C,CAAC;AAEjF;;;;;GAKG;AACH,MAAM,WAAW,aAAa,CAC5B,OAAO,SAAS,cAAc,EAC9B,YAAY,SAAS,eAAe,CAAC,OAAO,CAAC;IAE7C;;;;;OAKG;IACH,WAAW,IAAI,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAEpD,IAAI,SAAS,IAAI,OAAO,CAAC;IACzB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,SAAS,CACP,QAAQ,SAAS,cAAc,CAAC,YAAY,GAAG,cAAc,CAAC,SAAS,EAEvE,gBAAgB,EACZ,SAAS;QACP,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,EAAE,UAAU,CAAC;KACpE,GACD,SAAS;QACP,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,EAAE,UAAU,CAAC;QACnE,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,EAAE,UAAU,CAAC;KACpE,EACL,QAAQ,EAAE,QAAQ,EAClB,KAAK,EAAE,cAAc,GACpB,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAExC,aAAa,IAAI,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IACtD;;;OAGG;IACH,IAAI,MAAM,IACN,MAAM,CACJ,aAAa,CAAC,OAAO,CAAC,EACtB,cAAc,CAAC,YAAY,GAAG,cAAc,CAAC,SAAS,CACvD,GACD,SAAS,CAAC;IAEd;;;;;;OAMG;IACH,SAAS,CACP,YAAY,EAAE,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAC1C,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAExC;;;;OAIG;IACH,IAAI,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IAE5C;;;;;;;OAOG;IACH,OAAO,CACL,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,EAC7B,SAAS,EAAE,cAAc,GACxB,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAExC;;;;;OAKG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAE9D;;;;;OAKG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAE9D;;;OAGG;IACH,IAAI,KAAK,IAAI,aAAa,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;IAEvD;;;OAGG;IACH,IAAI,eAAe,IAAI,WAAW,CAAC;IAEnC;;;OAGG;IACH,IAAI,KAAK,IAAI,YAAY,CAAC;IAE1B;;;OAGG;IACH,IAAI,UAAU,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC;IAEzC;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,MAAM,IAAI,SAAS,KAAK,EAAE,CAAC;IAE/B;;;;;;OAMG;IACH,KAAK,CAAC,QAAQ,SAAS,cAAc,EACnC,eAAe,EAAE,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,GACjE,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAExC;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,SAAS,cAAc,EACtC,eAAe,EAAE,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,GACjE,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAExC;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ,SAAS,cAAc,EACrC,eAAe,EAAE,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,GACjE,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAExC;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,WAAW,SAAS,cAAc,EAClC,oBAAoB,SAAS,eAAe,CAAC,WAAW,CAAC,EACzD,mBAAmB,SAAS,0BAA0B,CACpD,OAAO,EACP,oBAAoB,CACrB,EAED,cAAc,EAAE,yBAAyB,CACvC,OAAO,EACP,WAAW,EACX,oBAAoB,EACpB,mBAAmB,CACpB,EACD,aAAa,EAAE,iBAAiB,CAAC,OAAO,EAAE,WAAW,EAAE,mBAAmB,CAAC,GAC1E,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;CACzC"}
+{"version":3,"file":"criteria.interface.d.ts","sourceRoot":"","sources":["../../../src/criteria/types/criteria.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,aAAa,EACb,eAAe,EAChB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAE7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EACV,iBAAiB,EACjB,yBAAyB,EACzB,iBAAiB,EACjB,0BAA0B,EAC3B,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2CAA2C,CAAC;AAEjF;;;;;GAKG;AACH,MAAM,WAAW,aAAa,CAC5B,OAAO,SAAS,cAAc,EAC9B,YAAY,SAAS,eAAe,CAAC,OAAO,CAAC;IAE7C;;;;;OAKG;IACH,WAAW,IAAI,IAAI,CAAC;IACpB;;;OAGG;IACH,IAAI,SAAS,IAAI,OAAO,CAAC;IACzB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,SAAS,CACP,QAAQ,SAAS,cAAc,CAAC,YAAY,GAAG,cAAc,CAAC,SAAS,EAEvE,gBAAgB,EACZ,SAAS;QACP,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,EAAE,UAAU,CAAC;KACpE,GACD,SAAS;QACP,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,EAAE,UAAU,CAAC;QACnE,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,EAAE,UAAU,CAAC;KACpE,EACL,QAAQ,EAAE,QAAQ,EAClB,KAAK,EAAE,cAAc,GACpB,IAAI,CAAC;IAER;;;OAGG;IACH,IAAI,MAAM,IACN,MAAM,CACJ,aAAa,CAAC,OAAO,CAAC,EACtB,cAAc,CAAC,YAAY,GAAG,cAAc,CAAC,SAAS,CACvD,GACD,SAAS,CAAC;IAEd;;;;;;OAMG;IACH,SAAS,CAAC,YAAY,EAAE,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAE7D;;;;OAIG;IACH,IAAI,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IAE5C;;;;;;;OAOG;IACH,OAAO,CAAC,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,cAAc,GAAG,IAAI,CAAC;IAExE;;;;;OAKG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,IAAI,KAAK,IAAI,aAAa,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;IAEvD;;;OAGG;IACH,IAAI,eAAe,IAAI,WAAW,CAAC;IAEnC;;;OAGG;IACH,IAAI,KAAK,IAAI,YAAY,CAAC;IAE1B;;;OAGG;IACH,IAAI,UAAU,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC;IAEzC;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,MAAM,IAAI,SAAS,KAAK,EAAE,CAAC;IAE/B;;;;;;OAMG;IACH,KAAK,CAAC,QAAQ,SAAS,cAAc,EACnC,eAAe,EAAE,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,GACjE,IAAI,CAAC;IAER;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,SAAS,cAAc,EACtC,eAAe,EAAE,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,GACjE,IAAI,CAAC;IAER;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ,SAAS,cAAc,EACrC,eAAe,EAAE,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,GACjE,IAAI,CAAC;IAER;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,WAAW,SAAS,cAAc,EAClC,oBAAoB,SAAS,eAAe,CAAC,WAAW,CAAC,EACzD,mBAAmB,SAAS,0BAA0B,CACpD,OAAO,EACP,oBAAoB,CACrB,EAED,cAAc,EAAE,yBAAyB,CACvC,OAAO,EACP,WAAW,EACX,oBAAoB,EACpB,mBAAmB,CACpB,EACD,aAAa,EAAE,iBAAiB,CAAC,OAAO,EAAE,WAAW,EAAE,mBAAmB,CAAC,GAC1E,IAAI,CAAC;CACT"}

package/dist/criteria/types/join-parameter.types.d.ts

@@ -9,7 +9,7 @@ import type { CriteriaSchema, FieldOfSchema, JoinRelationType } from './schema.t
  */
 export type PivotJoin<ParentSchema extends CriteriaSchema, JoinSchema extends CriteriaSchema, TJoinRelationType extends JoinRelationType> = {
     /** The type of relationship from the parent to the joined entity (e.g., 'many_to_many'). */
-    parent_to_join_relation_type: TJoinRelationType;
+    relation_type: TJoinRelationType;
     /** The source name (e.g., table name) of the parent entity. */
     parent_source_name: ParentSchema['source_name'];
     /** The alias used for the parent entity in the query. */
@@ -38,6 +38,23 @@ export type PivotJoin<ParentSchema extends CriteriaSchema, JoinSchema extends Cr
          */
         reference: FieldOfSchema<JoinSchema>;
     };
+    /**
+     * Optional metadata associated with the parent schema definition.
+     * This can be used by translators to store or access additional,
+     * schema-specific information relevant to the join.
+     */
+    parent_schema_metadata: {
+        [key: string]: any;
+    };
+    /**
+     * Optional metadata specifically associated with this join configuration
+     * as defined in the parent schema's `joins` array.
+     * This can be used by translators to store or access additional,
+     * join-specific information.
+     */
+    join_metadata: {
+        [key: string]: any;
+    };
 };
 /**
  * Represents the fully resolved parameters for a simple join (one-to-one, one-to-many, many-to-one),
@@ -49,7 +66,7 @@ export type PivotJoin<ParentSchema extends CriteriaSchema, JoinSchema extends Cr
  */
 export type SimpleJoin<ParentSchema extends CriteriaSchema, JoinSchema extends CriteriaSchema, TJoinRelationType extends JoinRelationType> = {
     /** The type of relationship from the parent to the joined entity (e.g., 'one_to_one', 'many_to_one'). */
-    parent_to_join_relation_type: TJoinRelationType;
+    relation_type: TJoinRelationType;
     /** The source name (e.g., table name) of the parent entity. */
     parent_source_name: ParentSchema['source_name'];
     /** The alias used for the parent entity in the query. */
@@ -66,5 +83,22 @@ export type SimpleJoin<ParentSchema extends CriteriaSchema, JoinSchema extends C
      * @see FieldOfSchema<JoinSchema>
      */
     join_field: FieldOfSchema<JoinSchema>;
+    /**
+     * Optional metadata associated with the parent schema definition.
+     * This can be used by translators to store or access additional,
+     * schema-specific information relevant to the join.
+     */
+    parent_schema_metadata: {
+        [key: string]: any;
+    };
+    /**
+     * Optional metadata specifically associated with this join configuration
+     * as defined in the parent schema's `joins` array.
+     * This can be used by translators to store or access additional,
+     * join-specific information.
+     */
+    join_metadata: {
+        [key: string]: any;
+    };
 };
 //# sourceMappingURL=join-parameter.types.d.ts.map

package/dist/criteria/types/join-parameter.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"join-parameter.types.d.ts","sourceRoot":"","sources":["../../../src/criteria/types/join-parameter.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,aAAa,EACb,gBAAgB,EACjB,MAAM,mBAAmB,CAAC;AAE3B;;;;;;;GAOG;AACH,MAAM,MAAM,SAAS,CACnB,YAAY,SAAS,cAAc,EACnC,UAAU,SAAS,cAAc,EACjC,iBAAiB,SAAS,gBAAgB,IACxC;IACF,4FAA4F;IAC5F,4BAA4B,EAAE,iBAAiB,CAAC;IAChD,+DAA+D;IAC/D,kBAAkB,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC;IAChD,yDAAyD;IACzD,YAAY,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;IAE5C,uDAAuD;IACvD,iBAAiB,EAAE,MAAM,CAAC;IAC1B,wFAAwF;IACxF,YAAY,EAAE;QACZ,yEAAyE;QACzE,WAAW,EAAE,MAAM,CAAC;QACpB;;;;WAIG;QACH,SAAS,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;KACxC,CAAC;IACF,wFAAwF;IACxF,UAAU,EAAE;QACV,yEAAyE;QACzE,WAAW,EAAE,MAAM,CAAC;QACpB;;;;WAIG;QACH,SAAS,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;KACtC,CAAC;CACH,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,UAAU,CACpB,YAAY,SAAS,cAAc,EACnC,UAAU,SAAS,cAAc,EACjC,iBAAiB,SAAS,gBAAgB,IACxC;IACF,yGAAyG;IACzG,4BAA4B,EAAE,iBAAiB,CAAC;IAChD,+DAA+D;IAC/D,kBAAkB,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC;IAChD,yDAAyD;IACzD,YAAY,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;IAC5C;;;;OAIG;IACH,YAAY,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IAC1C;;;;OAIG;IACH,UAAU,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;CACvC,CAAC"}
+{"version":3,"file":"join-parameter.types.d.ts","sourceRoot":"","sources":["../../../src/criteria/types/join-parameter.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,aAAa,EACb,gBAAgB,EACjB,MAAM,mBAAmB,CAAC;AAE3B;;;;;;;GAOG;AACH,MAAM,MAAM,SAAS,CACnB,YAAY,SAAS,cAAc,EACnC,UAAU,SAAS,cAAc,EACjC,iBAAiB,SAAS,gBAAgB,IACxC;IACF,4FAA4F;IAC5F,aAAa,EAAE,iBAAiB,CAAC;IACjC,+DAA+D;IAC/D,kBAAkB,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC;IAChD,yDAAyD;IACzD,YAAY,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;IAE5C,uDAAuD;IACvD,iBAAiB,EAAE,MAAM,CAAC;IAC1B,wFAAwF;IACxF,YAAY,EAAE;QACZ,yEAAyE;QACzE,WAAW,EAAE,MAAM,CAAC;QACpB;;;;WAIG;QACH,SAAS,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;KACxC,CAAC;IACF,wFAAwF;IACxF,UAAU,EAAE;QACV,yEAAyE;QACzE,WAAW,EAAE,MAAM,CAAC;QACpB;;;;WAIG;QACH,SAAS,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;KACtC,CAAC;IACF;;;;OAIG;IACH,sBAAsB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAC/C;;;;;OAKG;IACH,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACvC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,UAAU,CACpB,YAAY,SAAS,cAAc,EACnC,UAAU,SAAS,cAAc,EACjC,iBAAiB,SAAS,gBAAgB,IACxC;IACF,yGAAyG;IACzG,aAAa,EAAE,iBAAiB,CAAC;IACjC,+DAA+D;IAC/D,kBAAkB,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC;IAChD,yDAAyD;IACzD,YAAY,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;IAC5C;;;;OAIG;IACH,YAAY,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IAC1C;;;;OAIG;IACH,UAAU,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACtC;;;;OAIG;IACH,sBAAsB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAC/C;;;;;OAKG;IACH,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACvC,CAAC"}

package/dist/criteria/types/join-utility.types.d.ts

@@ -40,7 +40,7 @@ export interface StoredJoinDetails<ParentSchema extends CriteriaSchema> {
 export type JoinCriteriaParameterType<ParentSchema extends CriteriaSchema, JoinedSchema extends CriteriaSchema, ActualJoinedAlias extends SelectedAliasOf<JoinedSchema>, MatchingConfigForActualAlias extends SchemaJoins<string> | never> = [MatchingConfigForActualAlias] extends [never] ? `Error: The alias '${ActualJoinedAlias}' of schema '${JoinedSchema['source_name']}' is not configured for join in '${ParentSchema['source_name']}'.` : AnyJoinCriteria<JoinedSchema, ActualJoinedAlias>;
 /**
  * Determines the expected shape of the join parameters object passed to the `.join()` method,
- * based on the `join_relation_type` defined in the `ParentSchema` for the `ActualJoinedAlias`.
+ * based on the `relation_type` defined in the `ParentSchema` for the `ActualJoinedAlias`.
  * If the `ActualJoinedAlias` is not a valid join alias, this type resolves to `never`.
  * For 'many_to_many' relations, it expects {@link PivotJoinInput}.
  * For other relations (one-to-one, one-to-many, many-to-one), it expects {@link SimpleJoinInput}.
@@ -50,20 +50,20 @@ export type JoinCriteriaParameterType<ParentSchema extends CriteriaSchema, Joine
  * @template MatchingConfigForActualAlias - The join configuration from `ParentSchema` that matches the alias of `JoinedSchema`.
  *                                         Should be `never` if no match is found.
  */
-export type JoinParameterType<ParentSchema extends CriteriaSchema, JoinedSchema extends CriteriaSchema, MatchingConfigForActualAlias extends SchemaJoins<string> | never> = [MatchingConfigForActualAlias] extends [never] ? never : MatchingConfigForActualAlias['join_relation_type'] extends 'many_to_many' ? PivotJoinInput<ParentSchema, JoinedSchema> : SimpleJoinInput<ParentSchema, JoinedSchema>;
+export type JoinParameterType<ParentSchema extends CriteriaSchema, JoinedSchema extends CriteriaSchema, MatchingConfigForActualAlias extends SchemaJoins<string> | never> = [MatchingConfigForActualAlias] extends [never] ? never : MatchingConfigForActualAlias['relation_type'] extends 'many_to_many' ? PivotJoinInput<ParentSchema, JoinedSchema> : SimpleJoinInput<ParentSchema, JoinedSchema>;
 /**
  * Extracts the specific join configuration object from the `ParentSchema`'s `joins` array
  * that matches the provided `JoinedSchemaSpecificAlias`.
- * This utility type is crucial for inferring the `join_relation_type` and other
+ * This utility type is crucial for inferring the `relation_type` and other
  * join-specific details defined in the parent schema.
  *
  * @template ParentSchema - The {@link CriteriaSchema} of the parent entity.
  * @template JoinedSchemaSpecificAlias - The specific alias of the joined entity,
  *                                       as defined in the `ParentSchema.joins` configuration.
  * @example
- * // Given UserSchema has a join defined as: { alias: 'posts', join_relation_type: 'one_to_many' }
+ * // Given UserSchema has a join defined as: { alias: 'posts', relation_type: 'one_to_many' }
  * // type UserPostsJoinConfig = SpecificMatchingJoinConfig<typeof UserSchema, 'posts'>;
- * // UserPostsJoinConfig would be: { alias: 'posts'; join_relation_type: 'one_to_many'; }
+ * // UserPostsJoinConfig would be: { alias: 'posts'; relation_type: 'one_to_many'; }
  */
 export type SpecificMatchingJoinConfig<ParentSchema extends CriteriaSchema, JoinedSchemaSpecificAlias extends string> = Extract<ParentSchema['joins'][number], {
     alias: JoinedSchemaSpecificAlias;

package/dist/criteria/types/join-utility.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"join-utility.types.d.ts","sourceRoot":"","sources":["../../../src/criteria/types/join-utility.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,eAAe,EAChB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAEvE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE7E;;;;GAIG;AACH,MAAM,MAAM,eAAe,CACzB,OAAO,SAAS,cAAc,EAC9B,KAAK,SAAS,eAAe,CAAC,OAAO,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,IAE/D,iBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC,GACjC,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,GAChC,iBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAEtC;;;;GAIG;AACH,MAAM,WAAW,iBAAiB,CAAC,YAAY,SAAS,cAAc;IACpE;;OAEG;IACH,UAAU,EACN,SAAS,CAAC,YAAY,EAAE,cAAc,EAAE,gBAAgB,CAAC,GACzD,UAAU,CAAC,YAAY,EAAE,cAAc,EAAE,gBAAgB,CAAC,CAAC;IAC/D;;OAEG;IACH,QAAQ,EAAE,eAAe,CAAC,cAAc,EAAE,eAAe,CAAC,cAAc,CAAC,CAAC,CAAC;CAC5E;AAED;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,yBAAyB,CACnC,YAAY,SAAS,cAAc,EACnC,YAAY,SAAS,cAAc,EACnC,iBAAiB,SAAS,eAAe,CAAC,YAAY,CAAC,EACvD,4BAA4B,SAAS,WAAW,CAAC,MAAM,CAAC,GAAG,KAAK,IAC9D,CAAC,4BAA4B,CAAC,SAAS,CAAC,KAAK,CAAC,GAC9C,qBAAqB,iBAAiB,gBAAgB,YAAY,CAAC,aAAa,CAAC,oCAAoC,YAAY,CAAC,aAAa,CAAC,IAAI,GACpJ,eAAe,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;AAErD;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,iBAAiB,CAC3B,YAAY,SAAS,cAAc,EACnC,YAAY,SAAS,cAAc,EACnC,4BAA4B,SAAS,WAAW,CAAC,MAAM,CAAC,GAAG,KAAK,IAC9D,CAAC,4BAA4B,CAAC,SAAS,CAAC,KAAK,CAAC,GAC9C,KAAK,GACL,4BAA4B,CAAC,oBAAoB,CAAC,SAAS,cAAc,GACvE,cAAc,CAAC,YAAY,EAAE,YAAY,CAAC,GAC1C,eAAe,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;AAElD;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,0BAA0B,CACpC,YAAY,SAAS,cAAc,EACnC,yBAAyB,SAAS,MAAM,IACtC,OAAO,CACT,YAAY,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,EAC7B;IAAE,KAAK,EAAE,yBAAyB,CAAA;CAAE,CACrC,CAAC"}
+{"version":3,"file":"join-utility.types.d.ts","sourceRoot":"","sources":["../../../src/criteria/types/join-utility.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,eAAe,EAChB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAEvE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE7E;;;;GAIG;AACH,MAAM,MAAM,eAAe,CACzB,OAAO,SAAS,cAAc,EAC9B,KAAK,SAAS,eAAe,CAAC,OAAO,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,IAE/D,iBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC,GACjC,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,GAChC,iBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAEtC;;;;GAIG;AACH,MAAM,WAAW,iBAAiB,CAAC,YAAY,SAAS,cAAc;IACpE;;OAEG;IACH,UAAU,EACN,SAAS,CAAC,YAAY,EAAE,cAAc,EAAE,gBAAgB,CAAC,GACzD,UAAU,CAAC,YAAY,EAAE,cAAc,EAAE,gBAAgB,CAAC,CAAC;IAC/D;;OAEG;IACH,QAAQ,EAAE,eAAe,CAAC,cAAc,EAAE,eAAe,CAAC,cAAc,CAAC,CAAC,CAAC;CAC5E;AAED;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,yBAAyB,CACnC,YAAY,SAAS,cAAc,EACnC,YAAY,SAAS,cAAc,EACnC,iBAAiB,SAAS,eAAe,CAAC,YAAY,CAAC,EACvD,4BAA4B,SAAS,WAAW,CAAC,MAAM,CAAC,GAAG,KAAK,IAC9D,CAAC,4BAA4B,CAAC,SAAS,CAAC,KAAK,CAAC,GAC9C,qBAAqB,iBAAiB,gBAAgB,YAAY,CAAC,aAAa,CAAC,oCAAoC,YAAY,CAAC,aAAa,CAAC,IAAI,GACpJ,eAAe,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;AAErD;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,iBAAiB,CAC3B,YAAY,SAAS,cAAc,EACnC,YAAY,SAAS,cAAc,EACnC,4BAA4B,SAAS,WAAW,CAAC,MAAM,CAAC,GAAG,KAAK,IAC9D,CAAC,4BAA4B,CAAC,SAAS,CAAC,KAAK,CAAC,GAC9C,KAAK,GACL,4BAA4B,CAAC,eAAe,CAAC,SAAS,cAAc,GAClE,cAAc,CAAC,YAAY,EAAE,YAAY,CAAC,GAC1C,eAAe,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;AAElD;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,0BAA0B,CACpC,YAAY,SAAS,cAAc,EACnC,yBAAyB,SAAS,MAAM,IACtC,OAAO,CACT,YAAY,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,EAC7B;IAAE,KAAK,EAAE,yBAAyB,CAAA;CAAE,CACrC,CAAC"}

package/dist/criteria/types/schema.types.d.ts

@@ -1,5 +1,9 @@
 /**
  * Defines the type of relationship for a join.
+ * - `one_to_one`: Represents a one-to-one relationship.
+ * - `one_to_many`: Represents a one-to-many relationship.
+ * - `many_to_one`: Represents a many-to-one relationship.
+ * - `many_to_many`: Represents a many-to-many relationship, typically involving a pivot table.
  */
 export type JoinRelationType = 'one_to_one' | 'one_to_many' | 'many_to_one' | 'many_to_many';
 /**
@@ -10,7 +14,17 @@ export type SchemaJoins<ValidAlias extends string> = {
     /** The alias used to refer to this join in criteria construction. */
     alias: ValidAlias;
     /** The type of relationship this join represents (e.g., 'one_to_many'). */
-    join_relation_type: JoinRelationType;
+    relation_type: JoinRelationType;
+    /**
+     * Optional metadata associated with this specific join configuration.
+     * This allows for storing arbitrary, translator-specific information
+     * or hints directly within the schema definition for a join.
+     * For example, it could hold database-specific join hints or
+     * information about how to handle the join in a particular ORM.
+     */
+    metadata?: {
+        [key: string]: any;
+    };
 };
 /**
  * Represents the schema definition for an entity, used by the Criteria system.
@@ -30,6 +44,16 @@ export type CriteriaSchema<TFields extends ReadonlyArray<string> = ReadonlyArray
     fields: TFields;
     /** An array of configurations for entities that can be joined from this entity. */
     joins: ReadonlyArray<SchemaJoins<JoinsAlias>>;
+    /**
+     * Optional metadata associated with the entire schema definition.
+     * This can be used to store arbitrary, translator-specific information
+     * or configuration relevant to the entity this schema represents.
+     * For example, it could hold information about custom data types,
+     * default behaviors, or ORM-specific settings.
+     */
+    metadata?: {
+        [key: string]: any;
+    };
 };
 /**
  * A helper function to infer and preserve the literal types of a schema definition.
@@ -42,7 +66,7 @@ export type CriteriaSchema<TFields extends ReadonlyArray<string> = ReadonlyArray
  *   source_name: 'users_table',
  *   alias: ['user', 'u'],
  *   fields: ['id', 'name', 'email'],
- *   joins: [{ alias: 'posts', join_relation_type: 'one_to_many' }]
+ *   joins: [{ alias: 'posts', relation_type: 'one_to_many' }]
  * });
  */
 export declare function GetTypedCriteriaSchema<const TInput extends CriteriaSchema>(schema: TInput): TInput;

package/dist/criteria/types/schema.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.types.d.ts","sourceRoot":"","sources":["../../../src/criteria/types/schema.types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,YAAY,GACZ,aAAa,GACb,aAAa,GACb,cAAc,CAAC;AAEnB;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,UAAU,SAAS,MAAM,IAAI;IACnD,qEAAqE;IACrE,KAAK,EAAE,UAAU,CAAC;IAClB,2EAA2E;IAC3E,kBAAkB,EAAE,gBAAgB,CAAC;CACtC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,CACxB,OAAO,SAAS,aAAa,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,EAC7D,QAAQ,SAAS,aAAa,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,EAC9D,WAAW,SAAS,MAAM,GAAG,MAAM,EACnC,UAAU,SAAS,MAAM,GAAG,MAAM,IAChC;IACF,iEAAiE;IACjE,WAAW,EAAE,WAAW,CAAC;IACzB,0EAA0E;IAC1E,KAAK,EAAE,QAAQ,CAAC;IAChB,yDAAyD;IACzD,MAAM,EAAE,OAAO,CAAC;IAChB,mFAAmF;IACnF,KAAK,EAAE,aAAa,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;CAC/C,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,CAAC,MAAM,SAAS,cAAc,EACxE,MAAM,EAAE,MAAM,GACb,MAAM,CAER;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,cAAc,IAChD,CAAC,CAAC,QAAQ,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;AAE1E;;;;GAIG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,cAAc,IAClD,CAAC,CAAC,OAAO,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC"}
+{"version":3,"file":"schema.types.d.ts","sourceRoot":"","sources":["../../../src/criteria/types/schema.types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GACxB,YAAY,GACZ,aAAa,GACb,aAAa,GACb,cAAc,CAAC;AAEnB;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,UAAU,SAAS,MAAM,IAAI;IACnD,qEAAqE;IACrE,KAAK,EAAE,UAAU,CAAC;IAClB,2EAA2E;IAC3E,aAAa,EAAE,gBAAgB,CAAC;IAChC;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACnC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,CACxB,OAAO,SAAS,aAAa,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,EAC7D,QAAQ,SAAS,aAAa,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,EAC9D,WAAW,SAAS,MAAM,GAAG,MAAM,EACnC,UAAU,SAAS,MAAM,GAAG,MAAM,IAChC;IACF,iEAAiE;IACjE,WAAW,EAAE,WAAW,CAAC;IACzB,0EAA0E;IAC1E,KAAK,EAAE,QAAQ,CAAC;IAChB,yDAAyD;IACzD,MAAM,EAAE,OAAO,CAAC;IAChB,mFAAmF;IACnF,KAAK,EAAE,aAAa,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;IAC9C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACnC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,CAAC,MAAM,SAAS,cAAc,EACxE,MAAM,EAAE,MAAM,GACb,MAAM,CAER;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,cAAc,IAChD,CAAC,CAAC,QAAQ,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;AAE1E;;;;GAIG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,cAAc,IAClD,CAAC,CAAC,OAAO,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC"}

package/dist/criteria/types/schema.types.js

@@ -9,7 +9,7 @@
  *   source_name: 'users_table',
  *   alias: ['user', 'u'],
  *   fields: ['id', 'name', 'email'],
- *   joins: [{ alias: 'posts', join_relation_type: 'one_to_many' }]
+ *   joins: [{ alias: 'posts', relation_type: 'one_to_many' }]
  * });
  */
 export function GetTypedCriteriaSchema(schema) {

package/dist/criteria/types/schema.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"schema.types.js","sourceRoot":"","sources":["../../../src/criteria/types/schema.types.ts"],"names":[],"mappings":"AA6CA;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,sBAAsB,CACpC,MAAc;IAEd,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"schema.types.js","sourceRoot":"","sources":["../../../src/criteria/types/schema.types.ts"],"names":[],"mappings":"AAiEA;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,sBAAsB,CACpC,MAAc;IAEd,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nulledexp/translatable-criteria",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "license": "MIT",
   "description": "A TypeScript library for building data-source agnostic, translatable query criteria. Define complex filtering, ordering, and join logic in a structured, type-safe way, then translate it to your specific data source using custom translators.",
   "keywords": [