import { A as SetRequired, O as RuleType, S as RuleGroupTypeAny, _ as ValueProcessorLegacy, a as ExportOperatorMap, c as NLTranslationKey, d as ParameterizedSQL, f as RQBJsonLogic, g as ValueProcessorByRule, h as SQLPreset, i as ExportObjectFormats, l as NLTranslations, m as RuleProcessor, n as DiagnosticsResult, o as FormatQueryOptions, p as RuleGroupProcessor, r as ExportFormat, s as GroupVariantCondition, t as ConstituentWordOrder, u as ParameterizedNamedSQL, v as ValueProcessorOptions } from "./index-D5TXNIzF.js"; import { Column, Operators, SQL, Table } from "drizzle-orm"; import { WhereOptions } from "sequelize"; //#region src/utils/formatQuery/defaultRuleProcessorCEL.d.ts /** * Default rule processor used by {@link formatQuery} for "cel" format. * * @group Export */ declare const defaultRuleProcessorCEL: RuleProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleProcessorMongoDB.d.ts /** * Default rule processor used by {@link formatQuery} for "mongodb" format. * * Note that the "mongodb" format is deprecated in favor of the "mongodb_query" format. * * @group Export */ declare const defaultRuleProcessorMongoDB: RuleProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleProcessorSpEL.d.ts /** * Default rule processor used by {@link formatQuery} for "spel" format. * * @group Export */ declare const defaultRuleProcessorSpEL: RuleProcessor; //#endregion //#region src/utils/formatQuery/defaultValueProcessorByRule.d.ts /** * Default value processor used by {@link formatQuery} for "sql" format. * * @group Export */ declare const defaultValueProcessorByRule: ValueProcessorByRule; //#endregion //#region src/utils/formatQuery/defaultRuleGroupProcessorCEL.d.ts /** * Rule group processor used by {@link formatQuery} for "cel" format. * * @group Export */ declare const defaultRuleGroupProcessorCEL: RuleGroupProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleGroupProcessorDrizzle.d.ts /** * Default rule group processor used by {@link formatQuery} for the "drizzle" format. The returned * function can be assigned to the `where` property in the Drizzle relational queries API. * * @example * const where = formatQuery(query, 'drizzle'); * const results = db.query.users.findMany({ where }); * * @returns Function that takes a Drizzle table config and an object of Drizzle operators. * * @group Export */ declare const defaultRuleGroupProcessorDrizzle: RuleGroupProcessor<(columns: Record | Table, drizzleOperators: Operators) => SQL | undefined>; //#endregion //#region src/utils/formatQuery/defaultRuleGroupProcessorElasticSearch.d.ts /** * Rule group processor used by {@link formatQuery} for "elasticsearch" format. * * @group Export */ declare const defaultRuleGroupProcessorElasticSearch: RuleGroupProcessor>; //#endregion //#region src/utils/formatQuery/defaultRuleGroupProcessorJSONata.d.ts /** * Rule group processor used by {@link formatQuery} for "jsonata" format. * * @group Export */ declare const defaultRuleGroupProcessorJSONata: RuleGroupProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleGroupProcessorJsonLogic.d.ts /** * Rule group processor used by {@link formatQuery} for "jsonlogic" format. * * @group Export */ declare const defaultRuleGroupProcessorJsonLogic: RuleGroupProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleGroupProcessorLDAP.d.ts /** * Rule group processor used by {@link formatQuery} for "ldap" format. * * @group Export */ declare const defaultRuleGroupProcessorLDAP: RuleGroupProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleGroupProcessorMongoDB.d.ts /** * Rule group processor used by {@link formatQuery} for "mongodb" format. * * Note that the "mongodb" format is deprecated in favor of the "mongodb_query" format. * * @group Export */ declare const defaultRuleGroupProcessorMongoDB: RuleGroupProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleGroupProcessorMongoDBQuery.d.ts /** * Default fallback object used by {@link formatQuery} for "mongodb_query" format. * * @group Export */ declare const mongoDbFallback: { readonly $and: readonly [{ readonly $expr: true; }]; }; /** * Rule group processor used by {@link formatQuery} for "mongodb_query" format. * * @group Export */ declare const defaultRuleGroupProcessorMongoDBQuery: RuleGroupProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleGroupProcessorNL.d.ts /** * Rule group processor used by {@link formatQuery} for "natural_language" format. * * @group Export */ declare const defaultRuleGroupProcessorNL: RuleGroupProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleGroupProcessorParameterized.d.ts /** * Rule group processor used by {@link formatQuery} for "parameterized" and * "parameterized_named" formats. * * @group Export */ declare const defaultRuleGroupProcessorParameterized: RuleGroupProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleGroupProcessorPrisma.d.ts /** * Default fallback object used by {@link formatQuery} for "prisma" format. * * @group Export */ declare const prismaFallback: {}; /** * Rule group processor used by {@link formatQuery} for "prisma" format. * * @group Export */ declare const defaultRuleGroupProcessorPrisma: RuleGroupProcessor | undefined>; //#endregion //#region src/utils/formatQuery/defaultRuleGroupProcessorSequelize.d.ts /** * Rule group processor used by {@link formatQuery} for "sequelize" format. * * @group Export */ declare const defaultRuleGroupProcessorSequelize: RuleGroupProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleGroupProcessorSpEL.d.ts /** * Default rule processor used by {@link formatQuery} for "spel" format. * * @group Export */ declare const defaultRuleGroupProcessorSpEL: RuleGroupProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleGroupProcessorSQL.d.ts /** * Default rule processor used by {@link formatQuery} for "sql" format. * * @group Export */ declare const defaultRuleGroupProcessorSQL: RuleGroupProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleGroupProcessorDiagnostics.d.ts /** * Rule group processor used by {@link formatQuery} for "diagnostics" format. * * Produces a {@link DiagnosticsResult} containing an annotated copy of the query * tree (`query`) with `valid`, `reasons`, `path`, and `level` properties on every * rule and group; a flat `diagnostics` array; aggregate `stats`; and a per-field * `fieldSummary`. * * @group Export */ declare const defaultRuleGroupProcessorDiagnostics: RuleGroupProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleProcessorDrizzle.d.ts /** * Default rule processor used by {@link formatQuery} for the "drizzle" format. * * @group Export */ declare const defaultRuleProcessorDrizzle: RuleProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleProcessorElasticSearch.d.ts /** * Default rule processor used by {@link formatQuery} for "elasticsearch" format. * * @group Export */ declare const defaultRuleProcessorElasticSearch: RuleProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleProcessorJSONata.d.ts /** * Default rule processor used by {@link formatQuery} for "jsonata" format. * * @group Export */ declare const defaultRuleProcessorJSONata: RuleProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleProcessorJsonLogic.d.ts /** * Default rule processor used by {@link formatQuery} for "jsonlogic" format. * * @group Export */ declare const defaultRuleProcessorJsonLogic: RuleProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleProcessorLDAP.d.ts /** * Default rule processor used by {@link formatQuery} for "ldap" format. * * @group Export */ declare const defaultRuleProcessorLDAP: RuleProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleProcessorMongoDBQuery.d.ts /** * Default rule processor used by {@link formatQuery} for "mongodb_query" format. * * @group Export */ declare const defaultRuleProcessorMongoDBQuery: RuleProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleProcessorNL.d.ts /** * Default operator map used by {@link formatQuery} for "natural_language" format. * * @group Export */ declare const defaultExportOperatorMap: ExportOperatorMap; /** * Default operator processor used by {@link formatQuery} for "natural_language" format. * * @group Export */ declare const defaultOperatorProcessorNL: RuleProcessor; /** * Default rule processor used by {@link formatQuery} for "natural_language" format. * * @group Export */ declare const defaultRuleProcessorNL: RuleProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleProcessorParameterized.d.ts /** * Default rule processor used by {@link formatQuery} for "parameterized" and * "parameterized_named" formats. * * @group Export */ declare const defaultRuleProcessorParameterized: RuleProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleProcessorPrisma.d.ts /** * Default rule processor used by {@link formatQuery} for "prisma" format. * * @group Export */ declare const defaultRuleProcessorPrisma: RuleProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleProcessorSequelize.d.ts /** * Default rule processor used by {@link formatQuery} for the "sequelize" format. * * @group Export */ declare const defaultRuleProcessorSequelize: RuleProcessor; //#endregion //#region src/utils/formatQuery/defaultRuleProcessorSQL.d.ts /** * Default operator processor used by {@link formatQuery} for "sql" and "parameterized*" formats. * * @group Export */ declare const defaultOperatorProcessorSQL: RuleProcessor; /** * Default rule processor used by {@link formatQuery} for "sql" format. * * @group Export */ declare const defaultRuleProcessorSQL: RuleProcessor; //#endregion //#region src/utils/formatQuery/defaultValueProcessorNL.d.ts /** * Default value processor used by {@link formatQuery} for "natural_language" format. * * @group Export */ declare const defaultValueProcessorNL: ValueProcessorByRule; //#endregion //#region src/utils/formatQuery/formatQuery.d.ts /** * A collection of option presets for {@link formatQuery}, specifically for SQL-based formats. * * @group Export */ declare const sqlDialectPresets: Record; /** * A collection of option presets for {@link formatQuery}. * * @group Export */ declare const formatQueryOptionPresets: Record; /** * Generates a formatted (indented two spaces) JSON string from a query object. * * @group Export */ declare function formatQuery(ruleGroup: RuleGroupTypeAny): string; /** * Generates a result based on the provided rule group processor. * * @group Export */ declare function formatQuery(ruleGroup: RuleGroupTypeAny, options: FormatQueryOptions & { ruleGroupProcessor: RuleGroupProcessor; }): TResult; /** * Generates a {@link index!ParameterizedSQL ParameterizedSQL} object from a query object. * * @group Export */ declare function formatQuery(ruleGroup: RuleGroupTypeAny, options: "parameterized" | (FormatQueryOptions & { format: "parameterized"; })): ParameterizedSQL; /** * Generates a {@link index!ParameterizedNamedSQL ParameterizedNamedSQL} object from a query object. * * @group Export */ declare function formatQuery(ruleGroup: RuleGroupTypeAny, options: "parameterized_named" | (FormatQueryOptions & { format: "parameterized_named"; })): ParameterizedNamedSQL; /** * Generates a {@link index!RQBJsonLogic JsonLogic} object from a query object. * * @group Export */ declare function formatQuery(ruleGroup: RuleGroupTypeAny, options: "jsonlogic" | (FormatQueryOptions & { format: "jsonlogic"; })): RQBJsonLogic; /** * Generates an ElasticSearch query object from an RQB query object. * * NOTE: Support for the ElasticSearch format is experimental. * You may have better results exporting "sql" format then using * [ElasticSearch SQL](https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-sql.html). * * @group Export */ declare function formatQuery(ruleGroup: RuleGroupTypeAny, options: "elasticsearch" | (FormatQueryOptions & { format: "elasticsearch"; })): Record; /** * Generates a MongoDB query object from an RQB query object. * * This is equivalent to the "mongodb" format, but returns a JSON object * instead of a string. * * @group Export */ declare function formatQuery(ruleGroup: RuleGroupTypeAny, options: "mongodb_query" | (FormatQueryOptions & { format: "mongodb_query"; })): Record; /** * Generates a JSON.stringify'd MongoDB query object from an RQB query object. * * This is equivalent to the "mongodb_query" format, but returns a string * instead of a JSON object. * * @deprecated Use the "mongodb_query" format for greater flexibility. * * @group Export */ declare function formatQuery(ruleGroup: RuleGroupTypeAny, options: "mongodb" | (FormatQueryOptions & { format: "mongodb"; })): string; /** * Generates a Prisma ORM query object from an RQB query object. * * @group Export */ declare function formatQuery(ruleGroup: RuleGroupTypeAny, options: "prisma" | (FormatQueryOptions & { format: "prisma"; })): Record; /** * Generates a Drizzle ORM query function from an RQB query object. The function can * be assigned to the `where` property in the Drizzle relational queries API. * * @group Export */ declare function formatQuery(ruleGroup: RuleGroupTypeAny, options: "drizzle" | (FormatQueryOptions & { format: "drizzle"; })): ReturnType; /** * Generates a Sequelize query object from an RQB query object. The object can * be assigned to the `where` property in the Sequelize query functions. * * @group Export */ declare function formatQuery(ruleGroup: RuleGroupTypeAny, options: "sequelize" | (FormatQueryOptions & { format: "sequelize"; })): ReturnType; /** * Generates a JSONata query string from an RQB query object. * * NOTE: Either `parseNumbers: "strict-limited"` or `parseNumbers: true` * are recommended for this format. * * @group Export */ declare function formatQuery(ruleGroup: RuleGroupTypeAny, options: "jsonata" | (FormatQueryOptions & { format: "jsonata"; })): string; /** * Generates an LDAP query string from an RQB query object. * * @group Export */ declare function formatQuery(ruleGroup: RuleGroupTypeAny, options: "ldap" | (FormatQueryOptions & { format: "ldap"; })): string; /** * Generates a {@link DiagnosticsResult} from a query object, containing an annotated * query tree, a flat diagnostics array, aggregate stats, and a per-field summary. * * @group Export */ declare function formatQuery(ruleGroup: RuleGroupTypeAny, options: "diagnostics" | (FormatQueryOptions & { format: "diagnostics"; })): DiagnosticsResult; /** * Generates a formatted (indented two spaces) JSON string from a query object. * * @group Export */ declare function formatQuery(ruleGroup: RuleGroupTypeAny, options: FormatQueryOptions): string; /** * Generates a query string in the requested format. * * @group Export */ declare function formatQuery(ruleGroup: RuleGroupTypeAny, options: Exclude): string; /** * Generates a query string in the requested format. * * @group Export */ declare function formatQuery(ruleGroup: RuleGroupTypeAny, options: FormatQueryOptions & { format: Exclude; }): string; //#endregion //#region src/utils/formatQuery/utils.d.ts /** * Maps a {@link DefaultOperatorName} to a SQL operator. * * @group Export */ declare const mapSQLOperator: (rqbOperator: string) => string; /** * Maps a (lowercase) {@link DefaultOperatorName} to a MongoDB operator. * * @group Export */ declare const mongoOperators: { "=": string; "!=": string; "<": string; "<=": string; ">": string; ">=": string; in: string; notin: string; notIn: string; }; /** * Maps a (lowercase) {@link DefaultOperatorName} to a Prisma ORM operator. * * @group Export */ declare const prismaOperators: { "=": string; "!=": string; "<": string; "<=": string; ">": string; ">=": string; in: string; notin: string; }; /** * Maps a {@link DefaultCombinatorName} to a CEL combinator. * * @group Export */ declare const celCombinatorMap: { and: "&&"; or: "||"; }; /** * Register these operators with `jsonLogic` before applying the result * of `formatQuery(query, 'jsonlogic')`. * * @example * ``` * for (const [op, func] of Object.entries(jsonLogicAdditionalOperators)) { * jsonLogic.add_operation(op, func); * } * jsonLogic.apply({ "startsWith": [{ "var": "firstName" }, "Stev"] }, data); * ``` * * @group Export */ declare const jsonLogicAdditionalOperators: Record<"startsWith" | "endsWith", (a: string, b: string) => boolean>; /** * Returns a new query object with all `string`-type `value` properties converted * to `number` where appropriate. * * Used by {@link formatQuery} for the `json*` formats when `parseNumbers` is `true`. * * @group Export */ declare const numerifyValues: (rg: RuleGroupTypeAny, options: SetRequired) => RuleGroupTypeAny; /** * Determines whether a value is _anything_ except an empty `string` or `NaN`. * * @group Export */ declare const isValidValue: (value: any) => boolean; /** * Determines whether {@link formatQuery} should render the given value as a number. * As long as `parseNumbers` is `true`, `number` and `bigint` values will return `true` and * `string` values will return `true` if they test positive against {@link numericRegex}. * * @group Export */ declare const shouldRenderAsNumber: (value: any, parseNumbers?: boolean) => boolean; /** * Used by {@link formatQuery} to determine whether the given value processor is a * "legacy" value processor by counting the number of arguments. Legacy value * processors take 3 arguments (not counting any arguments with default values), while * rule-based value processors take no more than 2 arguments. * * @group Export */ declare const isValueProcessorLegacy: (valueProcessor: ValueProcessorLegacy | ValueProcessorByRule) => valueProcessor is ValueProcessorLegacy; /** * Converts the `quoteFieldNamesWith` option into an array of two strings. * If the option is a string, the array elements are both that string. * * @default * ['', ''] * * @group Export */ declare const getQuoteFieldNamesWithArray: (quoteFieldNamesWith?: null | string | [string, string]) => [string, string]; /** * Given a field name and relevant {@link ValueProcessorOptions}, returns the field name * wrapped in the configured quote character(s). * * @group Export */ declare const getQuotedFieldName: (fieldName: string, { quoteFieldNamesWith, fieldIdentifierSeparator }: ValueProcessorOptions) => string; /** * Given a [Constituent word order](https://en.wikipedia.org/wiki/Word_order#Constituent_word_orders) * like "svo" or "sov", returns a permutation of `["S", "V", "O"]` based on the first occurrence of * each letter in the input string (case insensitive). This widens the valid input from abbreviations * like "svo" to more expressive strings like "subject-verb-object" or "sub ver obj". Any missing * letters are appended in the default order "SVO" (e.g., "object" would yield `["O", "S", "V"]`). * * @group Export */ declare const normalizeConstituentWordOrder: (input: string) => ConstituentWordOrder; /** * Default translations used by {@link formatQuery} for "natural_language" format. * * @group Export */ declare const defaultNLTranslations: NLTranslations; /** * Used by {@link formatQuery} to get a translation based on certain conditions * for the "natural_language" format. * * @group Export */ declare const getNLTranslataion: (key: NLTranslationKey, translations: NLTranslations, conditions?: GroupVariantCondition[]) => string; type ProcessedMatchMode = { mode: "all"; threshold?: number | null | undefined; } | { mode: "none"; threshold?: number | null | undefined; } | { mode: "some"; threshold?: number | null | undefined; } | { mode: "atleast"; threshold: number; } | { mode: "atmost"; threshold: number; } | { mode: "exactly"; threshold: number; }; /** * Transforms * - `match: { mode: "atLeast", threshold: 1 }` to `match: { mode: "some" }` * - `match: { mode: "atMost", threshold: 0 }` to `match: { mode: "none" }`. * * Returns: * - Processed `{ mode, threshold }` object for valid subqueries * - `null` if match mode is not applicable for the rule * - `false` if match mode is valid, but either * 1. `threshold` is required and invalid, or * 2. `value` is not a valid rule group. */ declare const processMatchMode: (rule: RuleType) => null | false | ProcessedMatchMode; /** * "Replacer" method for JSON.stringify's second argument. Converts `bigint` values to * objects with a `$bigint` property having a value of a string representation of * the actual `bigint`-type value. * * Inverse of {@link bigIntJsonParseReviver}. * * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#use_within_json */ declare const bigIntJsonStringifyReplacer: (_key: string, value: unknown) => unknown; /** * "Reviver" method for JSON.parse's second argument. Converts objects having a single * `$bigint: string` property to an actual `bigint` value. * * Inverse of {@link bigIntJsonStringifyReplacer}. * * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#use_within_json */ declare const bigIntJsonParseReviver: (_key: string, value: unknown) => unknown; //#endregion //#region src/utils/formatQuery/index.d.ts /** * Default value processor used by {@link formatQuery} for "sql" format. * * @group Export */ declare const defaultValueProcessor: ValueProcessorLegacy; /** * @deprecated Prefer {@link defaultRuleProcessorMongoDB}. * * @group Export */ declare const defaultMongoDBValueProcessor: ValueProcessorLegacy; /** * @deprecated Prefer {@link defaultRuleProcessorCEL}. * * @group Export */ declare const defaultCELValueProcessor: ValueProcessorLegacy; /** * @deprecated Prefer {@link defaultRuleProcessorSpEL}. * * @group Export */ declare const defaultSpELValueProcessor: ValueProcessorLegacy; /** * @deprecated Renamed to {@link defaultRuleProcessorCEL}. * * @group Export */ declare const defaultValueProcessorCELByRule: RuleProcessor; /** * @deprecated Renamed to {@link defaultRuleProcessorMongoDB}. * * @group Export */ declare const defaultValueProcessorMongoDBByRule: RuleProcessor; /** * @deprecated Renamed to {@link defaultRuleProcessorSpEL}. * * @group Export */ declare const defaultValueProcessorSpELByRule: RuleProcessor; //#endregion export { bigIntJsonParseReviver, bigIntJsonStringifyReplacer, celCombinatorMap, defaultCELValueProcessor, defaultExportOperatorMap, defaultMongoDBValueProcessor, defaultNLTranslations, defaultOperatorProcessorNL, defaultOperatorProcessorSQL, defaultRuleGroupProcessorCEL, defaultRuleGroupProcessorDiagnostics, defaultRuleGroupProcessorDrizzle, defaultRuleGroupProcessorElasticSearch, defaultRuleGroupProcessorJSONata, defaultRuleGroupProcessorJsonLogic, defaultRuleGroupProcessorLDAP, defaultRuleGroupProcessorMongoDB, defaultRuleGroupProcessorMongoDBQuery, defaultRuleGroupProcessorNL, defaultRuleGroupProcessorParameterized, defaultRuleGroupProcessorPrisma, defaultRuleGroupProcessorSQL, defaultRuleGroupProcessorSequelize, defaultRuleGroupProcessorSpEL, defaultRuleProcessorCEL, defaultRuleProcessorDrizzle, defaultRuleProcessorElasticSearch, defaultRuleProcessorJSONata, defaultRuleProcessorJsonLogic, defaultRuleProcessorLDAP, defaultRuleProcessorMongoDB, defaultRuleProcessorMongoDBQuery, defaultRuleProcessorNL, defaultRuleProcessorParameterized, defaultRuleProcessorPrisma, defaultRuleProcessorSQL, defaultRuleProcessorSequelize, defaultRuleProcessorSpEL, defaultSpELValueProcessor, defaultValueProcessor, defaultValueProcessorByRule, defaultValueProcessorCELByRule, defaultValueProcessorMongoDBByRule, defaultValueProcessorNL, defaultValueProcessorSpELByRule, formatQuery, formatQueryOptionPresets, getNLTranslataion, getQuoteFieldNamesWithArray, getQuotedFieldName, isValidValue, isValueProcessorLegacy, jsonLogicAdditionalOperators, mapSQLOperator, mongoDbFallback, mongoOperators, normalizeConstituentWordOrder, numerifyValues, prismaFallback, prismaOperators, processMatchMode, shouldRenderAsNumber, sqlDialectPresets }; //# sourceMappingURL=formatQuery.d.ts.map