@nulledexp/translatable-criteria 1.0.4 → 1.2.0

package/dist/criteria/types/operator.types.js

@@ -36,18 +36,55 @@ export var FilterOperator;
     /** Checks if a string value does not contain a specific substring. */
     FilterOperator["NOT_CONTAINS"] = "NOT_CONTAINS";
     /**
-     * Checks if a field, representing a collection of predefined choices
-     * (where multiple can be selected), contains a specific choice.
-     * The specific database implementation might vary (e.g., MySQL SET type,
-     * a text field with delimited values, or a JSON array).
+     * Checks if a field, representing a collection of values (e.g., MySQL SET type
+     * or a text field with comma-delimited values), contains a specific value.
+     * Expects a single value.
      */
     FilterOperator["SET_CONTAINS"] = "SET_CONTAINS";
     /**
-     * Checks if a field, representing a collection of predefined choices
-     * (where multiple can be selected), does NOT contain a specific choice.
-     * The specific database implementation might vary.
+     * Checks if a field, representing a collection of values (e.g., MySQL SET type
+     * or a text field with comma-delimited values), does NOT contain a specific value.
+     * Expects a single value.
      */
     FilterOperator["SET_NOT_CONTAINS"] = "SET_NOT_CONTAINS";
+    /**
+     * Checks if a field, representing a collection of values (e.g., MySQL SET type
+     * or a text field with comma-delimited values), contains AT LEAST ONE of the specified values.
+     * Expects an array of values.
+     */
+    FilterOperator["SET_CONTAINS_ANY"] = "SET_CONTAINS_ANY";
+    /**
+     * Checks if a field, representing a collection of values (e.g., MySQL SET type
+     * or a text field with comma-delimited values), contains ALL of the specified values.
+     * Expects an array of values.
+     */
+    FilterOperator["SET_CONTAINS_ALL"] = "SET_CONTAINS_ALL";
+    /**
+     * Checks if a value is within a specified range (inclusive).
+     * Expects an array or tuple of two values: [min, max].
+     */
+    FilterOperator["BETWEEN"] = "BETWEEN";
+    /**
+     * Checks if a value is outside a specified range (inclusive).
+     * Expects an array or tuple of two values: [min, max].
+     */
+    FilterOperator["NOT_BETWEEN"] = "NOT_BETWEEN";
+    /**
+     * Checks if a string value matches a regular expression pattern.
+     * The specific regex syntax may depend on the database.
+     * Expects a string representing the regular expression.
+     */
+    FilterOperator["MATCHES_REGEX"] = "MATCHES_REGEX";
+    /**
+     * Checks if a string value matches a pattern (case-insensitive).
+     * Expects a string for the pattern.
+     */
+    FilterOperator["ILIKE"] = "ILIKE";
+    /**
+     * Checks if a string value does not match a pattern (case-insensitive).
+     * Expects a string for the pattern.
+     */
+    FilterOperator["NOT_ILIKE"] = "NOT_ILIKE";
     /**
      * Checks if a JSON column contains a specific value or path.
      * The specific implementation depends on the database (e.g., JSON_CONTAINS in MySQL, @> in PostgreSQL for JSONB).
@@ -58,7 +95,6 @@ export var FilterOperator;
      * The specific implementation depends on the database.
      */
     FilterOperator["JSON_NOT_CONTAINS"] = "JSON_NOT_CONTAINS";
-    // --- Array Operators ---
     /**
      * Checks if a column representing an array contains a specific element.
      * The underlying column could be a native array type (e.g., PostgreSQL)

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

@@ -1 +1 @@
-{"version":3,"file":"operator.types.js","sourceRoot":"","sources":["../../../src/criteria/types/operator.types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAN,IAAY,cAiFX;AAjFD,WAAY,cAAc;IACxB,2BAA2B;IAC3B,8BAAY,CAAA;IACZ,6BAA6B;IAC7B,mCAAiB,CAAA;IACjB,iDAAiD;IACjD,oCAAkB,CAAA;IAClB,6DAA6D;IAC7D,+CAA6B,CAAA;IAC7B,8CAA8C;IAC9C,iCAAe,CAAA;IACf,0DAA0D;IAC1D,4CAA0B,CAAA;IAC1B,wFAAwF;IACxF,+BAAa,CAAA;IACb,yDAAyD;IACzD,uCAAqB,CAAA;IACrB,6DAA6D;IAC7D,2BAAS,CAAA;IACT,iEAAiE;IACjE,mCAAiB,CAAA;IACjB,iCAAiC;IACjC,qCAAmB,CAAA;IACnB,qCAAqC;IACrC,6CAA2B,CAAA;IAC3B,sGAAsG;IACtG,uCAAqB,CAAA;IACrB,iEAAiE;IACjE,6CAA2B,CAAA;IAC3B,+DAA+D;IAC/D,yCAAuB,CAAA;IACvB,sEAAsE;IACtE,+CAA6B,CAAA;IAC7B;;;;;OAKG;IACH,+CAA6B,CAAA;IAC7B;;;;OAIG;IACH,uDAAqC,CAAA;IAErC;;;OAGG;IACH,iDAA+B,CAAA;IAC/B;;;OAGG;IACH,yDAAuC,CAAA;IAEvC,0BAA0B;IAC1B;;;;OAIG;IACH,mEAAiD,CAAA;IACjD;;;OAGG;IACH,6EAA2D,CAAA;IAC3D;;;OAGG;IACH,2EAAyD,CAAA;IACzD;;;;OAIG;IACH,+CAA6B,CAAA;AAC/B,CAAC,EAjFW,cAAc,KAAd,cAAc,QAiFzB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,2EAA2E;IAC3E,8BAAW,CAAA;IACX,kFAAkF;IAClF,4BAAS,CAAA;AACX,CAAC,EALW,eAAe,KAAf,eAAe,QAK1B"}
+{"version":3,"file":"operator.types.js","sourceRoot":"","sources":["../../../src/criteria/types/operator.types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAN,IAAY,cAmHX;AAnHD,WAAY,cAAc;IACxB,2BAA2B;IAC3B,8BAAY,CAAA;IACZ,6BAA6B;IAC7B,mCAAiB,CAAA;IACjB,iDAAiD;IACjD,oCAAkB,CAAA;IAClB,6DAA6D;IAC7D,+CAA6B,CAAA;IAC7B,8CAA8C;IAC9C,iCAAe,CAAA;IACf,0DAA0D;IAC1D,4CAA0B,CAAA;IAC1B,wFAAwF;IACxF,+BAAa,CAAA;IACb,yDAAyD;IACzD,uCAAqB,CAAA;IACrB,6DAA6D;IAC7D,2BAAS,CAAA;IACT,iEAAiE;IACjE,mCAAiB,CAAA;IACjB,iCAAiC;IACjC,qCAAmB,CAAA;IACnB,qCAAqC;IACrC,6CAA2B,CAAA;IAC3B,sGAAsG;IACtG,uCAAqB,CAAA;IACrB,iEAAiE;IACjE,6CAA2B,CAAA;IAC3B,+DAA+D;IAC/D,yCAAuB,CAAA;IACvB,sEAAsE;IACtE,+CAA6B,CAAA;IAC7B;;;;OAIG;IACH,+CAA6B,CAAA;IAC7B;;;;OAIG;IACH,uDAAqC,CAAA;IACrC;;;;OAIG;IACH,uDAAqC,CAAA;IACrC;;;;OAIG;IACH,uDAAqC,CAAA;IACrC;;;OAGG;IACH,qCAAmB,CAAA;IACnB;;;OAGG;IACH,6CAA2B,CAAA;IAC3B;;;;OAIG;IACH,iDAA+B,CAAA;IAC/B;;;OAGG;IACH,iCAAe,CAAA;IACf;;;OAGG;IACH,yCAAuB,CAAA;IACvB;;;OAGG;IACH,iDAA+B,CAAA;IAC/B;;;OAGG;IACH,yDAAuC,CAAA;IACvC;;;;OAIG;IACH,mEAAiD,CAAA;IACjD;;;OAGG;IACH,6EAA2D,CAAA;IAC3D;;;OAGG;IACH,2EAAyD,CAAA;IACzD;;;;OAIG;IACH,+CAA6B,CAAA;AAC/B,CAAC,EAnHW,cAAc,KAAd,cAAc,QAmHzB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,2EAA2E;IAC3E,8BAAW,CAAA;IACX,kFAAkF;IAClF,4BAAS,CAAA;AACX,CAAC,EALW,eAAe,KAAf,eAAe,QAK1B"}

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.0.4",
+  "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": [