@react-querybuilder/core 8.17.0 → 8.19.0

package/dist/react-querybuilder_core.d.mts

@@ -871,7 +871,36 @@ type Result = ApplyDefaultOptions<PathsOptions, DefaultPathsOptions, SpecifiedOp
 // Types of property 'leavesOnly' are incompatible. Type 'string' is not assignable to type 'boolean'.
 ```
 */
-type ApplyDefaultOptions<Options extends object, Defaults extends Simplify<Omit<Required<Options>, RequiredKeysOf<Options>> & Partial<Record<RequiredKeysOf<Options>, never>>>, SpecifiedOptions extends Options> = If<IsAny<SpecifiedOptions>, Defaults, If<IsNever<SpecifiedOptions>, Defaults, Simplify<Merge<Defaults, { [Key in keyof SpecifiedOptions as Key extends OptionalKeysOf<Options> ? undefined extends SpecifiedOptions[Key] ? never : Key : Key]: SpecifiedOptions[Key] }> & Required<Options>>>>;
+type ApplyDefaultOptions<Options extends object, Defaults extends Simplify<Omit<Required<Options>, RequiredKeysOf<Options>> & Partial<Record<RequiredKeysOf<Options>, never>>>, SpecifiedOptions extends Options> = _ApplyDefaultOptions<Options, Defaults, SpecifiedOptions> extends infer Result extends Required<Options> // `extends Required<Options>` ensures that `ApplyDefaultOptions<SomeOption, ...>` is always assignable to `Required<SomeOption>`
+? Result : never;
+type _ApplyDefaultOptions<Options, Defaults, SpecifiedOptions> = If<IsAny<SpecifiedOptions>, Defaults, If<IsNever<SpecifiedOptions>, Defaults, Merge<Defaults, { [Key in keyof SpecifiedOptions as undefined extends Required<Options>[Key & keyof Options] ? Key : undefined extends SpecifiedOptions[Key] ? never : Key]: SpecifiedOptions[Key] }>>>;
+/**
+Collapses literal types in a union into their corresponding primitive types, when possible. For example, `CollapseLiterals<'foo' | 'bar' | (string & {})>` returns `string`.
+
+Note: This doesn't collapse literals within tagged types. For example, `CollapseLiterals<Tagged<'foo' | (string & {}), 'Tag'>>` returns `("foo" & Tag<"Tag", never>) | (string & Tag<"Tag", never>)` and not `string & Tag<"Tag", never>`.
+
+Use-case: For collapsing unions created using {@link LiteralUnion}.
+
+@example
+```
+import type {LiteralUnion} from 'type-fest';
+
+type A = CollapseLiterals<'foo' | 'bar' | (string & {})>;
+//=> string
+
+type B = CollapseLiterals<LiteralUnion<1 | 2 | 3, number>>;
+//=> number
+
+type C = CollapseLiterals<LiteralUnion<'onClick' | 'onChange', `on${string}`>>;
+//=> `on${string}`
+
+type D = CollapseLiterals<'click' | 'change' | (`on${string}` & {})>;
+//=> 'click' | 'change' | `on${string}`
+
+type E = CollapseLiterals<LiteralUnion<'foo' | 'bar', string> | null | undefined>;
+//=> string | null | undefined
+```
+*/
 //#endregion
 //#region ../../node_modules/type-fest/source/except.d.ts
 /**
@@ -1119,7 +1148,7 @@ type SetArrayRequired<TArray extends UnknownArray, Keys, Counter extends any[] =
 : never; // Should never happen
 //#endregion
 //#region src/types/options.d.ts
-type RequireAtLeastOne<ObjectType, KeysType extends keyof ObjectType> = { [Key in KeysType]-?: Required<Pick<ObjectType, Key>> & Partial<Pick<ObjectType, Exclude<KeysType, Key>>> }[KeysType] & Except<ObjectType, KeysType>;
+type RequireAtLeastOne<O, K extends keyof O> = { [P in K]-?: Required<Pick<O, P>> & Partial<Pick<O, Exclude<K, P>>> }[K] & Except<O, K>;
 type StringUnionToFlexibleOptionArray<Op extends string> = Array<Op extends unknown ? FlexibleOption<Op> : never>;
 type StringUnionToFullOptionArray<Op extends string> = Array<Op extends unknown ? FullOption<Op> : never>;
 /**
@@ -2552,6 +2581,10 @@ interface Classnames {
   * Classname(s) applied to async components in their "loading" state.
   */
   loading: Classname;
+  /**
+  * Classname(s) applied to value editors for relative date/time values.
+  */
+  valueDateTimeRelative: Classname;
 }
 /**
 * Placeholder strings for option lists.
@@ -2607,7 +2640,9 @@ interface BaseTranslations<LabelType = string> {
   operators: BaseTranslationWithPlaceholders;
   values: BaseTranslationWithPlaceholders;
   matchMode: BaseTranslation;
-  matchThreshold: BaseTranslation;
+  matchThreshold: BaseTranslation & {
+    placeholderName?: string;
+  };
   value: BaseTranslation;
   removeRule: BaseTranslationWithLabel<LabelType>;
   removeGroup: BaseTranslationWithLabel<LabelType>;
@@ -2917,6 +2952,7 @@ declare const standardClassnames: {
   readonly justified: "queryBuilder-justified";
   readonly hasSubQuery: "rule-hasSubQuery";
   readonly loading: "queryBuilder-loading";
+  readonly valueDateTimeRelative: "rule-value-dateTimeRelative";
 };
 /**
 * Default classnames for each component.
@@ -3021,20 +3057,23 @@ declare const splitBy: (str?: string, splitChar?: string) => string[];
 * // would return
 * 'this\\,\\,that, , the other, , , \\,'
 */
-declare const joinWith: (strArr: any[], joinChar?: string) => string;
+declare const joinWith: (strArr: unknown[], joinChar?: string) => string;
+type IsUnknown<T> = unknown extends T ? true : false;
+type Trimmed<T> = IsUnknown<T> extends true ? string : T;
 /**
 * Trims the value if it is a string. Otherwise returns the value as is.
 */
-declare const trimIfString: (val: any) => any;
+declare const trimIfString: <T>(val: T) => Trimmed<T>;
+type ToArrayResult<T> = IsUnknown<T> extends true ? string[] : T extends readonly (infer U)[] ? Trimmed<U>[] : T extends string ? string[] : T extends number ? number[] : never[];
 /**
 * Splits a string by comma then trims each element. Arrays are returned as is except
 * any string elements are trimmed.
 */
-declare const toArray: (a: any, {
+declare const toArray: <T>(a: T, {
   retainEmptyStrings
 }?: {
   retainEmptyStrings?: boolean;
-}) => any[];
+}) => ToArrayResult<T>;
 /**
 * Determines if an array is free of `null`/`undefined`.
 */
@@ -3751,7 +3790,7 @@ declare const numerifyValues: (rg: RuleGroupTypeAny, options: SetRequired<Format
 *
 * @group Export
 */
-declare const isValidValue: (value: any) => boolean;
+declare const isValidValue: (value: unknown) => 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
@@ -3759,7 +3798,7 @@ declare const isValidValue: (value: any) => boolean;
 *
 * @group Export
 */
-declare const shouldRenderAsNumber: (value: any, parseNumbers?: boolean) => boolean;
+declare const shouldRenderAsNumber: (value: unknown, 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
@@ -3868,6 +3907,8 @@ declare const bigIntJsonParseReviver: (_key: string, value: unknown) => unknown;
 /**
 * Default value processor used by {@link formatQuery} for "sql" format.
 *
+* @deprecated Prefer {@link defaultValueProcessorByRule}.
+*
 * @group Export
 */
 declare const defaultValueProcessor: ValueProcessorLegacy;
@@ -4020,7 +4061,7 @@ declare const numericRegex: RegExp;
 /**
 * Determines if a variable is a plain old JavaScript object, aka POJO.
 */
-declare const isPojo: (obj: any) => obj is Record<string, any>;
+declare const isPojo: (obj: unknown) => obj is Record<string, any>;
 /**
 * Simple helper to determine whether a value is null, undefined, or an empty string.
 */
@@ -4101,25 +4142,25 @@ declare const uniqByIdentifier: <T extends RequireAtLeastOne$1<{
 *
 * @group Option Lists
 */
-declare const isOptionGroupArray: (arr: any) => arr is OptionGroup<BaseOption>[];
+declare const isOptionGroupArray: (arr: unknown) => arr is OptionGroup<BaseOption>[];
 /**
 * Determines if an array is a flat array of {@link FlexibleOption}.
 *
 * @group Option Lists
 */
-declare const isFlexibleOptionArray: (arr: any) => arr is FlexibleOption[];
+declare const isFlexibleOptionArray: (arr: unknown) => arr is FlexibleOption[];
 /**
 * Determines if an array is a flat array of {@link FullOption}.
 *
 * @group Option Lists
 */
-declare const isFullOptionArray: (arr: any) => arr is FullOption[];
+declare const isFullOptionArray: (arr: unknown) => arr is FullOption[];
 /**
 * Determines if a {@link FlexibleOptionList} is a {@link FlexibleOptionGroup} array.
 *
 * @group Option Lists
 */
-declare const isFlexibleOptionGroupArray: (arr: any, {
+declare const isFlexibleOptionGroupArray: (arr: unknown, {
   allowEmpty
 }?: {
   allowEmpty?: boolean;
@@ -4129,7 +4170,7 @@ declare const isFlexibleOptionGroupArray: (arr: any, {
 *
 * @group Option Lists
 */
-declare const isFullOptionGroupArray: (arr: any, {
+declare const isFullOptionGroupArray: (arr: unknown, {
   allowEmpty
 }?: {
   allowEmpty?: boolean;
@@ -4204,7 +4245,7 @@ interface ParseNumberOptions {
 * If that returns `NaN`, the string is returned unchanged. Numeric values are returned
 * as-is regardless of the `parseNumbers` option.
 */
-declare const parseNumber: (val: any, {
+declare const parseNumber: (val: unknown, {
   parseNumbers,
   bigIntOnOverflow
 }?: ParseNumberOptions) => any;

package/dist/react-querybuilder_core.legacy-esm.d.ts

@@ -871,7 +871,36 @@ type Result = ApplyDefaultOptions<PathsOptions, DefaultPathsOptions, SpecifiedOp
 // Types of property 'leavesOnly' are incompatible. Type 'string' is not assignable to type 'boolean'.
 ```
 */
-type ApplyDefaultOptions<Options extends object, Defaults extends Simplify<Omit<Required<Options>, RequiredKeysOf<Options>> & Partial<Record<RequiredKeysOf<Options>, never>>>, SpecifiedOptions extends Options> = If<IsAny<SpecifiedOptions>, Defaults, If<IsNever<SpecifiedOptions>, Defaults, Simplify<Merge<Defaults, { [Key in keyof SpecifiedOptions as Key extends OptionalKeysOf<Options> ? undefined extends SpecifiedOptions[Key] ? never : Key : Key]: SpecifiedOptions[Key] }> & Required<Options>>>>;
+type ApplyDefaultOptions<Options extends object, Defaults extends Simplify<Omit<Required<Options>, RequiredKeysOf<Options>> & Partial<Record<RequiredKeysOf<Options>, never>>>, SpecifiedOptions extends Options> = _ApplyDefaultOptions<Options, Defaults, SpecifiedOptions> extends infer Result extends Required<Options> // `extends Required<Options>` ensures that `ApplyDefaultOptions<SomeOption, ...>` is always assignable to `Required<SomeOption>`
+? Result : never;
+type _ApplyDefaultOptions<Options, Defaults, SpecifiedOptions> = If<IsAny<SpecifiedOptions>, Defaults, If<IsNever<SpecifiedOptions>, Defaults, Merge<Defaults, { [Key in keyof SpecifiedOptions as undefined extends Required<Options>[Key & keyof Options] ? Key : undefined extends SpecifiedOptions[Key] ? never : Key]: SpecifiedOptions[Key] }>>>;
+/**
+Collapses literal types in a union into their corresponding primitive types, when possible. For example, `CollapseLiterals<'foo' | 'bar' | (string & {})>` returns `string`.
+
+Note: This doesn't collapse literals within tagged types. For example, `CollapseLiterals<Tagged<'foo' | (string & {}), 'Tag'>>` returns `("foo" & Tag<"Tag", never>) | (string & Tag<"Tag", never>)` and not `string & Tag<"Tag", never>`.
+
+Use-case: For collapsing unions created using {@link LiteralUnion}.
+
+@example
+```
+import type {LiteralUnion} from 'type-fest';
+
+type A = CollapseLiterals<'foo' | 'bar' | (string & {})>;
+//=> string
+
+type B = CollapseLiterals<LiteralUnion<1 | 2 | 3, number>>;
+//=> number
+
+type C = CollapseLiterals<LiteralUnion<'onClick' | 'onChange', `on${string}`>>;
+//=> `on${string}`
+
+type D = CollapseLiterals<'click' | 'change' | (`on${string}` & {})>;
+//=> 'click' | 'change' | `on${string}`
+
+type E = CollapseLiterals<LiteralUnion<'foo' | 'bar', string> | null | undefined>;
+//=> string | null | undefined
+```
+*/
 //#endregion
 //#region ../../node_modules/type-fest/source/except.d.ts
 /**
@@ -1119,7 +1148,7 @@ type SetArrayRequired<TArray extends UnknownArray, Keys, Counter extends any[] =
 : never; // Should never happen
 //#endregion
 //#region src/types/options.d.ts
-type RequireAtLeastOne<ObjectType, KeysType extends keyof ObjectType> = { [Key in KeysType]-?: Required<Pick<ObjectType, Key>> & Partial<Pick<ObjectType, Exclude<KeysType, Key>>> }[KeysType] & Except<ObjectType, KeysType>;
+type RequireAtLeastOne<O, K extends keyof O> = { [P in K]-?: Required<Pick<O, P>> & Partial<Pick<O, Exclude<K, P>>> }[K] & Except<O, K>;
 type StringUnionToFlexibleOptionArray<Op extends string> = Array<Op extends unknown ? FlexibleOption<Op> : never>;
 type StringUnionToFullOptionArray<Op extends string> = Array<Op extends unknown ? FullOption<Op> : never>;
 /**
@@ -2552,6 +2581,10 @@ interface Classnames {
   * Classname(s) applied to async components in their "loading" state.
   */
   loading: Classname;
+  /**
+  * Classname(s) applied to value editors for relative date/time values.
+  */
+  valueDateTimeRelative: Classname;
 }
 /**
 * Placeholder strings for option lists.
@@ -2607,7 +2640,9 @@ interface BaseTranslations<LabelType = string> {
   operators: BaseTranslationWithPlaceholders;
   values: BaseTranslationWithPlaceholders;
   matchMode: BaseTranslation;
-  matchThreshold: BaseTranslation;
+  matchThreshold: BaseTranslation & {
+    placeholderName?: string;
+  };
   value: BaseTranslation;
   removeRule: BaseTranslationWithLabel<LabelType>;
   removeGroup: BaseTranslationWithLabel<LabelType>;
@@ -2917,6 +2952,7 @@ declare const standardClassnames: {
   readonly justified: "queryBuilder-justified";
   readonly hasSubQuery: "rule-hasSubQuery";
   readonly loading: "queryBuilder-loading";
+  readonly valueDateTimeRelative: "rule-value-dateTimeRelative";
 };
 /**
 * Default classnames for each component.
@@ -3021,20 +3057,23 @@ declare const splitBy: (str?: string, splitChar?: string) => string[];
 * // would return
 * 'this\\,\\,that, , the other, , , \\,'
 */
-declare const joinWith: (strArr: any[], joinChar?: string) => string;
+declare const joinWith: (strArr: unknown[], joinChar?: string) => string;
+type IsUnknown<T> = unknown extends T ? true : false;
+type Trimmed<T> = IsUnknown<T> extends true ? string : T;
 /**
 * Trims the value if it is a string. Otherwise returns the value as is.
 */
-declare const trimIfString: (val: any) => any;
+declare const trimIfString: <T>(val: T) => Trimmed<T>;
+type ToArrayResult<T> = IsUnknown<T> extends true ? string[] : T extends readonly (infer U)[] ? Trimmed<U>[] : T extends string ? string[] : T extends number ? number[] : never[];
 /**
 * Splits a string by comma then trims each element. Arrays are returned as is except
 * any string elements are trimmed.
 */
-declare const toArray: (a: any, {
+declare const toArray: <T>(a: T, {
   retainEmptyStrings
 }?: {
   retainEmptyStrings?: boolean;
-}) => any[];
+}) => ToArrayResult<T>;
 /**
 * Determines if an array is free of `null`/`undefined`.
 */
@@ -3751,7 +3790,7 @@ declare const numerifyValues: (rg: RuleGroupTypeAny, options: SetRequired<Format
 *
 * @group Export
 */
-declare const isValidValue: (value: any) => boolean;
+declare const isValidValue: (value: unknown) => 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
@@ -3759,7 +3798,7 @@ declare const isValidValue: (value: any) => boolean;
 *
 * @group Export
 */
-declare const shouldRenderAsNumber: (value: any, parseNumbers?: boolean) => boolean;
+declare const shouldRenderAsNumber: (value: unknown, 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
@@ -3868,6 +3907,8 @@ declare const bigIntJsonParseReviver: (_key: string, value: unknown) => unknown;
 /**
 * Default value processor used by {@link formatQuery} for "sql" format.
 *
+* @deprecated Prefer {@link defaultValueProcessorByRule}.
+*
 * @group Export
 */
 declare const defaultValueProcessor: ValueProcessorLegacy;
@@ -4020,7 +4061,7 @@ declare const numericRegex: RegExp;
 /**
 * Determines if a variable is a plain old JavaScript object, aka POJO.
 */
-declare const isPojo: (obj: any) => obj is Record<string, any>;
+declare const isPojo: (obj: unknown) => obj is Record<string, any>;
 /**
 * Simple helper to determine whether a value is null, undefined, or an empty string.
 */
@@ -4101,25 +4142,25 @@ declare const uniqByIdentifier: <T extends RequireAtLeastOne$1<{
 *
 * @group Option Lists
 */
-declare const isOptionGroupArray: (arr: any) => arr is OptionGroup<BaseOption>[];
+declare const isOptionGroupArray: (arr: unknown) => arr is OptionGroup<BaseOption>[];
 /**
 * Determines if an array is a flat array of {@link FlexibleOption}.
 *
 * @group Option Lists
 */
-declare const isFlexibleOptionArray: (arr: any) => arr is FlexibleOption[];
+declare const isFlexibleOptionArray: (arr: unknown) => arr is FlexibleOption[];
 /**
 * Determines if an array is a flat array of {@link FullOption}.
 *
 * @group Option Lists
 */
-declare const isFullOptionArray: (arr: any) => arr is FullOption[];
+declare const isFullOptionArray: (arr: unknown) => arr is FullOption[];
 /**
 * Determines if a {@link FlexibleOptionList} is a {@link FlexibleOptionGroup} array.
 *
 * @group Option Lists
 */
-declare const isFlexibleOptionGroupArray: (arr: any, {
+declare const isFlexibleOptionGroupArray: (arr: unknown, {
   allowEmpty
 }?: {
   allowEmpty?: boolean;
@@ -4129,7 +4170,7 @@ declare const isFlexibleOptionGroupArray: (arr: any, {
 *
 * @group Option Lists
 */
-declare const isFullOptionGroupArray: (arr: any, {
+declare const isFullOptionGroupArray: (arr: unknown, {
   allowEmpty
 }?: {
   allowEmpty?: boolean;
@@ -4204,7 +4245,7 @@ interface ParseNumberOptions {
 * If that returns `NaN`, the string is returned unchanged. Numeric values are returned
 * as-is regardless of the `parseNumbers` option.
 */
-declare const parseNumber: (val: any, {
+declare const parseNumber: (val: unknown, {
   parseNumbers,
   bigIntOnOverflow
 }?: ParseNumberOptions) => any;