@nulledexp/translatable-criteria 1.0.0 → 1.0.1

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

@@ -0,0 +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"}

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

@@ -0,0 +1,27 @@
+import type { CriteriaSchema, JoinRelationType, SelectedAliasOf } from '../types/schema.types.js';
+import type { PivotJoin, SimpleJoin } from '../types/join-parameter.types.js';
+import { Criteria } from '../criteria.js';
+import type { ICriteriaVisitor } from '../types/visitor-interface.types.js';
+/**
+ * Represents an OUTER JOIN (typically FULL OUTER JOIN) criteria.
+ * It extends the base {@link Criteria} and defines how it's visited by a {@link ICriteriaVisitor}.
+ * Note: Full OUTER JOIN support can vary between database systems.
+ * @template CSchema - The {@link CriteriaSchema} of the entity being joined.
+ * @template Alias - The selected alias for the joined entity from its schema.
+ */
+export declare class OuterJoinCriteria<CSchema extends CriteriaSchema, Alias extends SelectedAliasOf<CSchema> = SelectedAliasOf<CSchema>> extends Criteria<CSchema, Alias> {
+    /**
+     * Accepts a criteria visitor to process this outer join criteria.
+     * It first validates the join field against the schema before dispatching to the visitor.
+     * @template TranslationContext - The type of the context object passed during traversal.
+     * @template TranslationOutput - The type of the result returned by visitor methods.
+     * @param {ICriteriaVisitor<TranslationContext, TranslationOutput>} visitor - The visitor instance.
+     * @param {PivotJoin<CriteriaSchema, CSchema, JoinRelationType> | SimpleJoin<CriteriaSchema, CSchema, JoinRelationType>} parameters -
+     *   The fully resolved parameters for this join, including parent and join field details.
+     * @param {TranslationContext} context - The context object to be passed to the visitor.
+     * @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;
+    resetCriteria(): OuterJoinCriteria<CSchema, Alias>;
+}
+//# sourceMappingURL=outer.join-criteria.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,31 @@
+import { Criteria } from '../criteria.js';
+/**
+ * Represents an OUTER JOIN (typically FULL OUTER JOIN) criteria.
+ * It extends the base {@link Criteria} and defines how it's visited by a {@link ICriteriaVisitor}.
+ * Note: Full OUTER JOIN support can vary between database systems.
+ * @template CSchema - The {@link CriteriaSchema} of the entity being joined.
+ * @template Alias - The selected alias for the joined entity from its schema.
+ */
+export class OuterJoinCriteria extends Criteria {
+    /**
+     * Accepts a criteria visitor to process this outer join criteria.
+     * It first validates the join field against the schema before dispatching to the visitor.
+     * @template TranslationContext - The type of the context object passed during traversal.
+     * @template TranslationOutput - The type of the result returned by visitor methods.
+     * @param {ICriteriaVisitor<TranslationContext, TranslationOutput>} visitor - The visitor instance.
+     * @param {PivotJoin<CriteriaSchema, CSchema, JoinRelationType> | SimpleJoin<CriteriaSchema, CSchema, JoinRelationType>} parameters -
+     *   The fully resolved parameters for this join, including parent and join field details.
+     * @param {TranslationContext} context - The context object to be passed to the visitor.
+     * @returns {TranslationOutput} The result of the visitor processing this join.
+     */
+    accept(visitor, parameters, context) {
+        typeof parameters.join_field === 'object'
+            ? this.assetFieldOnSchema(parameters.join_field.reference)
+            : this.assetFieldOnSchema(parameters.join_field);
+        return visitor.visitOuterJoin(this, parameters, context);
+    }
+    resetCriteria() {
+        return new OuterJoinCriteria(this.schema, this._alias);
+    }
+}
+//# sourceMappingURL=outer.join-criteria.js.map

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

@@ -0,0 +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"}

package/dist/criteria/order/order.d.ts

@@ -0,0 +1,20 @@
+export declare const OrderDirection: {
+    readonly ASC: "ASC";
+    readonly DESC: "DESC";
+};
+export type OrderDirection = keyof typeof OrderDirection;
+export type OrderByPrimitive<T extends string = string> = {
+    direction: OrderDirection;
+    field: T;
+};
+export declare class Order<T extends string = string> {
+    protected readonly _direction: OrderDirection;
+    protected readonly _field: T;
+    protected _sequenceId: number;
+    constructor(_direction: OrderDirection, _field: T);
+    get sequenceId(): number;
+    get field(): T;
+    get direction(): OrderDirection;
+    toPrimitive(): OrderByPrimitive<T>;
+}
+//# sourceMappingURL=order.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"order.d.ts","sourceRoot":"","sources":["../../../src/criteria/order/order.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc;;;CAGjB,CAAC;AACX,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,cAAc,CAAC;AAGzD,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI;IACxD,SAAS,EAAE,cAAc,CAAC;IAC1B,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEF,qBAAa,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAGxC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,cAAc;IAC7C,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;IAH9B,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;gBAET,UAAU,EAAE,cAAc,EAC1B,MAAM,EAAE,CAAC;IAM9B,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED,IAAI,KAAK,IAAI,CAAC,CAEb;IAED,IAAI,SAAS,IAAI,cAAc,CAE9B;IAED,WAAW,IAAI,gBAAgB,CAAC,CAAC,CAAC;CAMnC"}

package/dist/criteria/order/order.js

@@ -0,0 +1,32 @@
+export const OrderDirection = {
+    ASC: 'ASC',
+    DESC: 'DESC',
+};
+let globalOrderSequence = 0;
+export class Order {
+    _direction;
+    _field;
+    _sequenceId;
+    constructor(_direction, _field) {
+        this._direction = _direction;
+        this._field = _field;
+        globalOrderSequence++;
+        this._sequenceId = globalOrderSequence;
+    }
+    get sequenceId() {
+        return this._sequenceId;
+    }
+    get field() {
+        return this._field;
+    }
+    get direction() {
+        return this._direction;
+    }
+    toPrimitive() {
+        return {
+            direction: this._direction,
+            field: this._field,
+        };
+    }
+}
+//# sourceMappingURL=order.js.map

package/dist/criteria/order/order.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"order.js","sourceRoot":"","sources":["../../../src/criteria/order/order.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;CACJ,CAAC;AAGX,IAAI,mBAAmB,GAAW,CAAC,CAAC;AAMpC,MAAM,OAAO,KAAK;IAGK;IACA;IAHX,WAAW,CAAS;IAC9B,YACqB,UAA0B,EAC1B,MAAS;QADT,eAAU,GAAV,UAAU,CAAgB;QAC1B,WAAM,GAAN,MAAM,CAAG;QAE5B,mBAAmB,EAAE,CAAC;QACtB,IAAI,CAAC,WAAW,GAAG,mBAAmB,CAAC;IACzC,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,WAAW;QACT,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,KAAK,EAAE,IAAI,CAAC,MAAM;SACnB,CAAC;IACJ,CAAC;CACF"}

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

@@ -0,0 +1,28 @@
+import { Criteria } from './criteria.js';
+import type { CriteriaSchema, SelectedAliasOf } from './types/schema.types.js';
+import type { ICriteriaVisitor } from './types/visitor-interface.types.js';
+/**
+ * Represents the root criteria for a query.
+ * This is the main entry point for building a query and defines the primary entity being queried.
+ * It extends the base {@link Criteria} and defines how it's visited by a {@link ICriteriaVisitor}.
+ * @template CSchema - The {@link CriteriaSchema} of the root entity.
+ * @template Alias - The selected alias for the root entity from its schema.
+ */
+export declare class RootCriteria<CSchema extends CriteriaSchema, Alias extends SelectedAliasOf<CSchema>> extends Criteria<CSchema, Alias> {
+    /**
+     * Accepts a criteria visitor to process this root criteria.
+     * This method is the entry point for the visitor pattern to traverse the criteria tree.
+     * @template TranslationContext - The type of the context object passed during traversal (e.g., a query builder
+     *   instance).
+     * @template TranslationOutput - The type of the result returned by visitor methods (e.g., the modified query builder
+     *   or a query string).
+     * @param {ICriteriaVisitor<TranslationContext, TranslationOutput>} visitor - The visitor instance responsible for
+     *   translating criteria parts.
+     * @param {TranslationContext} context - The context object to be passed to the visitor (e.g., an initial query
+     *   builder or an empty string for SQL).
+     * @returns {TranslationOutput} The result of the visitor processing this root criteria and its components.
+     */
+    accept<TranslationContext, TranslationOutput>(visitor: ICriteriaVisitor<TranslationContext, TranslationOutput>, context: TranslationContext): TranslationOutput;
+    resetCriteria(): RootCriteria<CSchema, Alias>;
+}
+//# sourceMappingURL=root.criteria.d.ts.map

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

@@ -0,0 +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"}

package/dist/criteria/root.criteria.js

@@ -0,0 +1,30 @@
+import { Criteria } from './criteria.js';
+/**
+ * Represents the root criteria for a query.
+ * This is the main entry point for building a query and defines the primary entity being queried.
+ * It extends the base {@link Criteria} and defines how it's visited by a {@link ICriteriaVisitor}.
+ * @template CSchema - The {@link CriteriaSchema} of the root entity.
+ * @template Alias - The selected alias for the root entity from its schema.
+ */
+export class RootCriteria extends Criteria {
+    /**
+     * Accepts a criteria visitor to process this root criteria.
+     * This method is the entry point for the visitor pattern to traverse the criteria tree.
+     * @template TranslationContext - The type of the context object passed during traversal (e.g., a query builder
+     *   instance).
+     * @template TranslationOutput - The type of the result returned by visitor methods (e.g., the modified query builder
+     *   or a query string).
+     * @param {ICriteriaVisitor<TranslationContext, TranslationOutput>} visitor - The visitor instance responsible for
+     *   translating criteria parts.
+     * @param {TranslationContext} context - The context object to be passed to the visitor (e.g., an initial query
+     *   builder or an empty string for SQL).
+     * @returns {TranslationOutput} The result of the visitor processing this root criteria and its components.
+     */
+    accept(visitor, context) {
+        return visitor.visitRoot(this, context);
+    }
+    resetCriteria() {
+        return new RootCriteria(this.schema, this._alias);
+    }
+}
+//# sourceMappingURL=root.criteria.js.map

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

@@ -0,0 +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"}

package/dist/criteria/translator/criteria-translator.d.ts

@@ -0,0 +1,45 @@
+import type { CriteriaSchema, JoinRelationType, SelectedAliasOf } from '../types/schema.types.js';
+import type { RootCriteria } from '../root.criteria.js';
+import type { PivotJoin, SimpleJoin } from '../types/join-parameter.types.js';
+import type { FilterGroup } from '../filter/filter-group.js';
+import type { InnerJoinCriteria } from '../join/inner.join-criteria.js';
+import type { LeftJoinCriteria } from '../join/left.join-criteria.js';
+import type { OuterJoinCriteria } from '../join/outer.join-criteria.js';
+import type { Filter } from '../filter/filter.js';
+import type { ICriteriaVisitor } from '../types/visitor-interface.types.js';
+import type { FilterOperator } from '../types/operator.types.js';
+/**
+ * Abstract Class for translating criteria into various query formats
+ * @template TranslationContext - The target format (e.g., QueryBuilder, raw SQL string, etc.)
+ * @template TranslationOutput - The output format by default its Source (Only specify this if
+ * you really need something like a memory translator and the output would be different
+ * from the TranslationContext itself)
+ * @template RootSchema - The schema type for the root criteria
+ * @example
+ * // TypeORM QueryBuilder translator
+ * class TypeORMTranslator implements CriteriaTranslator<SelectQueryBuilder<Entity>> {
+ *  ...Concrete implementation
+ * }
+ *
+ * // Raw MySQL translator
+ * export class MysqlTranslator extends CriteriaTranslator<string, string> { {
+ *  ...Concrete implementation
+ * }
+ */
+export declare abstract class CriteriaTranslator<TranslationContext, TranslationOutput = TranslationContext, TFilterVisitorOutput extends any = any> implements ICriteriaVisitor<TranslationContext, TranslationOutput, TFilterVisitorOutput> {
+    /**
+     * Translates a criteria into the target source format
+     * @param criteria - The criteria to translate
+     * @param source - The source object to translate into (e.g., QueryBuilder instance, or raw SQL string)
+     * @returns The modified source or the output format if specified
+     */
+    translate<RootCriteriaSchema extends CriteriaSchema>(criteria: RootCriteria<RootCriteriaSchema, SelectedAliasOf<RootCriteriaSchema>>, source: TranslationContext): TranslationOutput;
+    abstract visitRoot<RootCriteriaSchema extends CriteriaSchema, RootAlias extends SelectedAliasOf<RootCriteriaSchema>>(criteria: RootCriteria<RootCriteriaSchema, RootAlias>, context: TranslationContext): TranslationOutput;
+    abstract visitInnerJoin<ParentCSchema extends CriteriaSchema, JoinCriteriaSchema extends CriteriaSchema, JoinAlias extends SelectedAliasOf<JoinCriteriaSchema>>(criteria: InnerJoinCriteria<JoinCriteriaSchema, JoinAlias>, parameters: PivotJoin<ParentCSchema, JoinCriteriaSchema, JoinRelationType> | SimpleJoin<ParentCSchema, JoinCriteriaSchema, JoinRelationType>, context: TranslationContext): TranslationOutput;
+    abstract visitLeftJoin<ParentCSchema extends CriteriaSchema, JoinCriteriaSchema extends CriteriaSchema, JoinAlias extends SelectedAliasOf<JoinCriteriaSchema>>(criteria: LeftJoinCriteria<JoinCriteriaSchema, JoinAlias>, parameters: PivotJoin<ParentCSchema, JoinCriteriaSchema, JoinRelationType> | SimpleJoin<ParentCSchema, JoinCriteriaSchema, JoinRelationType>, context: TranslationContext): TranslationOutput;
+    abstract visitOuterJoin<ParentCSchema extends CriteriaSchema, JoinCriteriaSchema extends CriteriaSchema, JoinAlias extends SelectedAliasOf<JoinCriteriaSchema>>(criteria: OuterJoinCriteria<JoinCriteriaSchema, JoinAlias>, parameters: PivotJoin<ParentCSchema, JoinCriteriaSchema, JoinRelationType> | SimpleJoin<ParentCSchema, JoinCriteriaSchema, JoinRelationType>, context: TranslationContext): TranslationOutput;
+    abstract visitFilter<FieldType extends string, Operator extends FilterOperator>(filter: Filter<FieldType, Operator>, currentAlias: string): TFilterVisitorOutput;
+    abstract visitAndGroup<FieldType extends string>(group: FilterGroup<FieldType>, currentAlias: string, context: TranslationContext): TranslationOutput;
+    abstract visitOrGroup<FieldType extends string>(group: FilterGroup<FieldType>, currentAlias: string, context: TranslationContext): TranslationOutput;
+}
+//# sourceMappingURL=criteria-translator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"criteria-translator.d.ts","sourceRoot":"","sources":["../../../src/criteria/translator/criteria-translator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,eAAe,EAChB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAC7D,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,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAEjE;;;;;;;;;;;;;;;;;GAiBG;AACH,8BAAsB,kBAAkB,CACtC,kBAAkB,EAClB,iBAAiB,GAAG,kBAAkB,EACtC,oBAAoB,SAAS,GAAG,GAAG,GAAG,CACtC,YACE,gBAAgB,CACd,kBAAkB,EAClB,iBAAiB,EACjB,oBAAoB,CACrB;IAEH;;;;;OAKG;IACH,SAAS,CAAC,kBAAkB,SAAS,cAAc,EACjD,QAAQ,EAAE,YAAY,CACpB,kBAAkB,EAClB,eAAe,CAAC,kBAAkB,CAAC,CACpC,EACD,MAAM,EAAE,kBAAkB,GACzB,iBAAiB;IAIpB,QAAQ,CAAC,SAAS,CAChB,kBAAkB,SAAS,cAAc,EACzC,SAAS,SAAS,eAAe,CAAC,kBAAkB,CAAC,EAErD,QAAQ,EAAE,YAAY,CAAC,kBAAkB,EAAE,SAAS,CAAC,EACrD,OAAO,EAAE,kBAAkB,GAC1B,iBAAiB;IAEpB,QAAQ,CAAC,cAAc,CACrB,aAAa,SAAS,cAAc,EACpC,kBAAkB,SAAS,cAAc,EACzC,SAAS,SAAS,eAAe,CAAC,kBAAkB,CAAC,EAErD,QAAQ,EAAE,iBAAiB,CAAC,kBAAkB,EAAE,SAAS,CAAC,EAC1D,UAAU,EACN,SAAS,CAAC,aAAa,EAAE,kBAAkB,EAAE,gBAAgB,CAAC,GAC9D,UAAU,CAAC,aAAa,EAAE,kBAAkB,EAAE,gBAAgB,CAAC,EACnE,OAAO,EAAE,kBAAkB,GAC1B,iBAAiB;IAEpB,QAAQ,CAAC,aAAa,CACpB,aAAa,SAAS,cAAc,EACpC,kBAAkB,SAAS,cAAc,EACzC,SAAS,SAAS,eAAe,CAAC,kBAAkB,CAAC,EAErD,QAAQ,EAAE,gBAAgB,CAAC,kBAAkB,EAAE,SAAS,CAAC,EACzD,UAAU,EACN,SAAS,CAAC,aAAa,EAAE,kBAAkB,EAAE,gBAAgB,CAAC,GAC9D,UAAU,CAAC,aAAa,EAAE,kBAAkB,EAAE,gBAAgB,CAAC,EACnE,OAAO,EAAE,kBAAkB,GAC1B,iBAAiB;IAEpB,QAAQ,CAAC,cAAc,CACrB,aAAa,SAAS,cAAc,EACpC,kBAAkB,SAAS,cAAc,EACzC,SAAS,SAAS,eAAe,CAAC,kBAAkB,CAAC,EAErD,QAAQ,EAAE,iBAAiB,CAAC,kBAAkB,EAAE,SAAS,CAAC,EAC1D,UAAU,EACN,SAAS,CAAC,aAAa,EAAE,kBAAkB,EAAE,gBAAgB,CAAC,GAC9D,UAAU,CAAC,aAAa,EAAE,kBAAkB,EAAE,gBAAgB,CAAC,EACnE,OAAO,EAAE,kBAAkB,GAC1B,iBAAiB;IAEpB,QAAQ,CAAC,WAAW,CAClB,SAAS,SAAS,MAAM,EACxB,QAAQ,SAAS,cAAc,EAE/B,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,EACnC,YAAY,EAAE,MAAM,GACnB,oBAAoB;IAEvB,QAAQ,CAAC,aAAa,CAAC,SAAS,SAAS,MAAM,EAC7C,KAAK,EAAE,WAAW,CAAC,SAAS,CAAC,EAC7B,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,kBAAkB,GAC1B,iBAAiB;IAEpB,QAAQ,CAAC,YAAY,CAAC,SAAS,SAAS,MAAM,EAC5C,KAAK,EAAE,WAAW,CAAC,SAAS,CAAC,EAC7B,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,kBAAkB,GAC1B,iBAAiB;CACrB"}

package/dist/criteria/translator/criteria-translator.js

@@ -0,0 +1,30 @@
+/**
+ * Abstract Class for translating criteria into various query formats
+ * @template TranslationContext - The target format (e.g., QueryBuilder, raw SQL string, etc.)
+ * @template TranslationOutput - The output format by default its Source (Only specify this if
+ * you really need something like a memory translator and the output would be different
+ * from the TranslationContext itself)
+ * @template RootSchema - The schema type for the root criteria
+ * @example
+ * // TypeORM QueryBuilder translator
+ * class TypeORMTranslator implements CriteriaTranslator<SelectQueryBuilder<Entity>> {
+ *  ...Concrete implementation
+ * }
+ *
+ * // Raw MySQL translator
+ * export class MysqlTranslator extends CriteriaTranslator<string, string> { {
+ *  ...Concrete implementation
+ * }
+ */
+export class CriteriaTranslator {
+    /**
+     * Translates a criteria into the target source format
+     * @param criteria - The criteria to translate
+     * @param source - The source object to translate into (e.g., QueryBuilder instance, or raw SQL string)
+     * @returns The modified source or the output format if specified
+     */
+    translate(criteria, source) {
+        return criteria.accept(this, source);
+    }
+}
+//# sourceMappingURL=criteria-translator.js.map

package/dist/criteria/translator/criteria-translator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"criteria-translator.js","sourceRoot":"","sources":["../../../src/criteria/translator/criteria-translator.ts"],"names":[],"mappings":"AAeA;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,OAAgB,kBAAkB;IAWtC;;;;;OAKG;IACH,SAAS,CACP,QAGC,EACD,MAA0B;QAE1B,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACvC,CAAC;CAiEF"}

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

@@ -0,0 +1,166 @@
+import type { CriteriaSchema, FieldOfSchema, SelectedAliasOf } from './schema.types.js';
+import type { FilterGroup } from '../filter/filter-group.js';
+import type { Cursor } from '../cursor.js';
+import type { Order, OrderDirection } from '../order/order.js';
+import { FilterOperator } from './operator.types.js';
+import type { StoredJoinDetails, JoinCriteriaParameterType, JoinParameterType, SpecificMatchingJoinConfig } from './join-utility.types.js';
+import type { FilterPrimitive } from '../filter/types/filter-primitive.types.js';
+/**
+ * Base interface for defining query criteria.
+ * It provides methods for filtering, joining, selecting fields, ordering, and paginating results.
+ * @template TSchema - The schema definition for the primary entity.
+ * @template CurrentAlias - The selected alias for the primary entity from its schema.
+ */
+export interface ICriteriaBase<TSchema extends CriteriaSchema, CurrentAlias extends SelectedAliasOf<TSchema>> {
+    /**
+     * 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.
+     */
+    resetSelect(): ICriteriaBase<TSchema, CurrentAlias>;
+    get selectAll(): boolean;
+    /**
+     * Sets the cursor for pagination. A cursor defines a point from which to fetch
+     * the next or previous set of results. It typically uses a combination of
+     * unique and ordered fields.
+     *
+     * @param {Array<Omit<FilterPrimitive<FieldOfSchema<TSchema>>, 'operator'>>} filterPrimitive -
+     *   An array of exactly two filter primitives (without the operator)
+     *   defining the fields and their values for the cursor.
+     *   Example: `[{ field: 'created_at', value: '2023-10-26T10:00:00Z' }, { field: 'uuid', value: 'some-uuid' }]`
+     * @param {FilterOperator.GREATER_THAN | FilterOperator.LESS_THAN} operator -
+     *   The comparison operator to apply to the cursor fields (e.g., fetch records
+     *   greater than or less than the cursor values).
+     * @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.
+     * @throws {Error} If filterPrimitive does not contain exactly 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 the two cursor fields are identical.
+     */
+    setCursor<Operator extends FilterOperator.GREATER_THAN | FilterOperator.LESS_THAN>(filterPrimitive: [
+        Omit<FilterPrimitive<FieldOfSchema<TSchema>, Operator>, 'operator'>,
+        Omit<FilterPrimitive<FieldOfSchema<TSchema>, Operator>, 'operator'>
+    ], operator: Operator, order: OrderDirection): ICriteriaBase<TSchema, CurrentAlias>;
+    resetCriteria(): ICriteriaBase<TSchema, CurrentAlias>;
+    /**
+     * Gets the current cursor configuration, if set.
+     * @returns {Cursor<FieldOfSchema<TSchema>> | undefined} The cursor object or undefined.
+     */
+    get cursor(): Cursor<FieldOfSchema<TSchema>, FilterOperator.GREATER_THAN | FilterOperator.LESS_THAN> | undefined;
+    /**
+     * 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.
+     * @throws {Error} If any of the specified fields are not defined in the schema.
+     */
+    setSelect(selectFields: Array<FieldOfSchema<TSchema>>): ICriteriaBase<TSchema, CurrentAlias>;
+    /**
+     * Gets the currently selected fields. If `selectAll()` was last called or is default,
+     * it returns all fields from the schema.
+     * @returns {Array<FieldOfSchema<TSchema>>} An array of selected field names.
+     */
+    get select(): Array<FieldOfSchema<TSchema>>;
+    /**
+     * Adds an ordering rule to the criteria.
+     * 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.
+     * @throws {Error} If the specified field is not defined in the schema.
+     */
+    orderBy(field: FieldOfSchema<TSchema>, direction: OrderDirection): ICriteriaBase<TSchema, CurrentAlias>;
+    /**
+     * 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.
+     * @throws {Error} If the amount is negative.
+     */
+    setTake(amount: number): ICriteriaBase<TSchema, CurrentAlias>;
+    /**
+     * 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.
+     * @throws {Error} If the amount is negative.
+     */
+    setSkip(amount: number): ICriteriaBase<TSchema, CurrentAlias>;
+    /**
+     * Gets the configured join details.
+     * @returns {ReadonlyArray<StoredJoinDetails<TSchema>>} An array of join configurations.
+     */
+    get joins(): ReadonlyArray<StoredJoinDetails<TSchema>>;
+    /**
+     * Gets the root filter group for this criteria.
+     * @returns {FilterGroup} The root filter group.
+     */
+    get rootFilterGroup(): FilterGroup;
+    /**
+     * Gets the alias for the root entity of this criteria.
+     * @returns {CurrentAlias} The alias string.
+     */
+    get alias(): CurrentAlias;
+    /**
+     * Gets the source name (e.g., table name) for the root entity of this criteria.
+     * @returns {TSchema['source_name']} The source name string.
+     */
+    get sourceName(): TSchema['source_name'];
+    /**
+     * Gets the current take value (LIMIT).
+     * @returns {number} The take value.
+     */
+    get take(): number;
+    /**
+     * Gets the current skip value (OFFSET).
+     * @returns {number} The skip value.
+     */
+    get skip(): number;
+    /**
+     * Gets the current ordering rules.
+     * @returns {readonly Order[]} An array of order objects.
+     */
+    get orders(): readonly Order[];
+    /**
+     * 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.
+     * @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>;
+    /**
+     * 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.
+     * @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>;
+    /**
+     * 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.
+     * @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>;
+    /**
+     * 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 {ICriteriaBase<TSchema, CurrentAlias>} 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).
+     */
+    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>;
+}
+//# sourceMappingURL=criteria.interface.d.ts.map

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

@@ -0,0 +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,eAAe,EAAE;QACf,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,EACD,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"}

package/dist/criteria/types/criteria.interface.js

@@ -0,0 +1,2 @@
+import { FilterOperator } from './operator.types.js';
+//# sourceMappingURL=criteria.interface.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"criteria.interface.js","sourceRoot":"","sources":["../../../src/criteria/types/criteria.interface.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/criteria/types/filter-expression.interface.d.ts

@@ -0,0 +1,7 @@
+import type { FilterGroupPrimitive, FilterPrimitive } from '../filter/types/filter-primitive.types.js';
+import type { CriteriaSchema, FieldOfSchema } from './schema.types.js';
+import type { FilterOperator } from './operator.types.js';
+export interface IFilterExpression {
+    toPrimitive(): FilterPrimitive<FieldOfSchema<CriteriaSchema>, FilterOperator> | FilterGroupPrimitive;
+}
+//# sourceMappingURL=filter-expression.interface.d.ts.map

package/dist/criteria/types/filter-expression.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter-expression.interface.d.ts","sourceRoot":"","sources":["../../../src/criteria/types/filter-expression.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,eAAe,EAChB,MAAM,2CAA2C,CAAC;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACvE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D,MAAM,WAAW,iBAAiB;IAChC,WAAW,IACP,eAAe,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,cAAc,CAAC,GAC9D,oBAAoB,CAAC;CAC1B"}

package/dist/criteria/types/filter-expression.interface.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=filter-expression.interface.js.map

package/dist/criteria/types/filter-expression.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter-expression.interface.js","sourceRoot":"","sources":["../../../src/criteria/types/filter-expression.interface.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,54 @@
+import type { CriteriaSchema, FieldOfSchema } from './schema.types.js';
+/**
+ * Represents the input parameters for a many-to-many join via a pivot table.
+ * This is the shape the user provides to the .join() method.
+ * @template ParentSchema - The {@link CriteriaSchema} of the parent entity.
+ * @template JoinSchema - The {@link CriteriaSchema} of the entity to be joined.
+ */
+export type PivotJoinInput<ParentSchema extends CriteriaSchema, JoinSchema extends CriteriaSchema> = {
+    /** The source name (table name) of the pivot table. */
+    pivot_source_name: string;
+    /** Configuration for the join field on the parent side, referencing the pivot table. */
+    parent_field: {
+        /** The field name in the pivot table that links to the parent schema. */
+        pivot_field: string;
+        /**
+         * The field name in the parent schema that the pivot table field references.
+         * Must be a valid field defined in `ParentSchema['fields']`.
+         * @see FieldOfSchema<ParentSchema>
+         */
+        reference: FieldOfSchema<ParentSchema>;
+    };
+    /** Configuration for the join field on the joined side, referencing the pivot table. */
+    join_field: {
+        /** The field name in the pivot table that links to the joined schema. */
+        pivot_field: string;
+        /**
+         * The field name in the joined schema that the pivot table field references.
+         * Must be a valid field defined in `JoinSchema['fields']`.
+         * @see FieldOfSchema<JoinSchema>
+         */
+        reference: FieldOfSchema<JoinSchema>;
+    };
+};
+/**
+ * Represents the input parameters for a simple join (one-to-one, one-to-many, many-to-one).
+ * This is the shape the user provides to the .join() method.
+ * @template ParentSchema - The {@link CriteriaSchema} of the parent entity.
+ * @template JoinSchema - The {@link CriteriaSchema} of the entity to be joined.
+ */
+export type SimpleJoinInput<ParentSchema extends CriteriaSchema, JoinSchema extends CriteriaSchema> = {
+    /**
+     * The field name in the parent schema used for the join condition.
+     * Must be a valid field defined in `ParentSchema['fields']`.
+     * @see FieldOfSchema<ParentSchema>
+     */
+    parent_field: FieldOfSchema<ParentSchema>;
+    /**
+     * The field name in the joined schema used for the join condition.
+     * Must be a valid field defined in `JoinSchema['fields']`.
+     * @see FieldOfSchema<JoinSchema>
+     */
+    join_field: FieldOfSchema<JoinSchema>;
+};
+//# sourceMappingURL=join-input.types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"join-input.types.d.ts","sourceRoot":"","sources":["../../../src/criteria/types/join-input.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAEvE;;;;;GAKG;AACH,MAAM,MAAM,cAAc,CACxB,YAAY,SAAS,cAAc,EACnC,UAAU,SAAS,cAAc,IAC/B;IACF,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;;;;;GAKG;AACH,MAAM,MAAM,eAAe,CACzB,YAAY,SAAS,cAAc,EACnC,UAAU,SAAS,cAAc,IAC/B;IACF;;;;OAIG;IACH,YAAY,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IAC1C;;;;OAIG;IACH,UAAU,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;CACvC,CAAC"}

package/dist/criteria/types/join-input.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=join-input.types.js.map

package/dist/criteria/types/join-input.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"join-input.types.js","sourceRoot":"","sources":["../../../src/criteria/types/join-input.types.ts"],"names":[],"mappings":""}