@react-querybuilder/core 8.23.1 → 8.24.0

package/dist/derivations.mjs

@@ -1,7 +1,7 @@
-import { $ as defaultCombinators, A as isFlexibleOptionGroupArray, B as uniqByName, Ct as queryBuilderFlagDefaults, D as getFirstOption, Dt as substringOperators, E as parseNumber, Et as standardClassnames, F as toFlatOptionArray, G as splitBy, H as uniqOptList, I as toFullOption, J as LogType, K as toArray, L as toFullOptionList, M as isFullOptionGroupArray, N as isOptionGroupArray, O as getOption, P as prepareOptionList, Q as defaultCombinatorLabelMap, R as toFullOptionMap, St as nullOperators, T as getParseNumberMethod, Tt as rootPath, U as joinWith, V as uniqOptGroups, W as nullFreeArray, X as betweenOperators, Y as TestID, Z as defaultCoalesceMs, _t as defaultPlaceholderValueLabel, at as defaultOperatorLabelMap, bt as groupInvalidReasons, ct as defaultPlaceholderFieldGroupLabel, dt as defaultPlaceholderLabel, et as defaultCombinatorsExtended, ft as defaultPlaceholderName, gt as defaultPlaceholderValueGroupLabel, ht as defaultPlaceholderOperatorName, it as defaultMaxHistory, j as isFullOptionArray, k as isFlexibleOptionArray, lt as defaultPlaceholderFieldLabel, mt as defaultPlaceholderOperatorLabel, nt as defaultJoinChar, ot as defaultOperatorNegationMap, pt as defaultPlaceholderOperatorGroupLabel, q as trimIfString, rt as defaultMatchModes, st as defaultOperators, tt as defaultControlClassnames, ut as defaultPlaceholderFieldName, vt as defaultPlaceholderValueName, wt as relationalOperators, xt as inOperators, yt as defaultTranslations, z as uniqByIdentifier } from "./utils-CP5Jqy1P.mjs";
+import { $ as defaultCombinators, A as isFlexibleOptionGroupArray, B as uniqByName, Ct as queryBuilderFlagDefaults, D as getFirstOption, Dt as substringOperators, E as parseNumber, Et as standardClassnames, F as toFlatOptionArray, G as splitBy, H as uniqOptList, I as toFullOption, J as LogType, K as toArray, L as toFullOptionList, M as isFullOptionGroupArray, N as isOptionGroupArray, O as getOption, P as prepareOptionList, Q as defaultCombinatorLabelMap, R as toFullOptionMap, St as nullOperators, T as getParseNumberMethod, Tt as rootPath, U as joinWith, V as uniqOptGroups, W as nullFreeArray, X as betweenOperators, Y as TestID, Z as defaultCoalesceMs, _t as defaultPlaceholderValueLabel, at as defaultOperatorLabelMap, bt as groupInvalidReasons, ct as defaultPlaceholderFieldGroupLabel, dt as defaultPlaceholderLabel, et as defaultCombinatorsExtended, ft as defaultPlaceholderName, gt as defaultPlaceholderValueGroupLabel, ht as defaultPlaceholderOperatorName, it as defaultMaxHistory, j as isFullOptionArray, k as isFlexibleOptionArray, lt as defaultPlaceholderFieldLabel, mt as defaultPlaceholderOperatorLabel, nt as defaultJoinChar, ot as defaultOperatorNegationMap, pt as defaultPlaceholderOperatorGroupLabel, q as trimIfString, rt as defaultMatchModes, st as defaultOperators, tt as defaultControlClassnames, ut as defaultPlaceholderFieldName, vt as defaultPlaceholderValueName, wt as relationalOperators, xt as inOperators, yt as defaultTranslations, z as uniqByIdentifier } from "./utils-DLZCoyAh.mjs";
 import { a as isRuleGroupType, c as isPojo, d as numericRegex, i as isRuleGroup, l as lc, n as objectEntries, o as isRuleGroupTypeIC, r as objectKeys, s as isRuleType, t as isUnsafeKey, u as nullOrUndefinedOrEmpty } from "./objectUtils-DDZ-KhV5.mjs";
 import { n as convertQuery, r as convertToIC, t as convertFromIC } from "./convertQuery-DaXv3h7S.mjs";
-import { a as getValueSourcesUtil, c as filterFieldsByComparator, i as resolveCandidateQuery, n as prepareRuleGroup, o as generateID, r as prepareRuleOrGroup, s as uuidV4regex, t as prepareRule } from "./prepareQueryObjects-Dmyf3Wi_.mjs";
+import { a as getValueSourcesUtil, c as filterFieldsByComparator, i as resolveCandidateQuery, n as prepareRuleGroup, o as generateID, r as prepareRuleOrGroup, s as uuidV4regex, t as prepareRule } from "./prepareQueryObjects-DawsH4e3.mjs";
 import { n as isValidationResult, t as isRuleOrGroupValid } from "./isRuleOrGroupValid-CIMZNkt4.mjs";
 import { transformQuery } from "./transformQuery.mjs";
 import { Immer, current, isDraft, produce, setAutoFreeze as setAutoFreeze$1 } from "immer";
@@ -48,6 +48,7 @@ const controlKeys = [
 	"ruleGroupHeaderElements",
 	"shiftActions",
 	"undoRedoActions",
+	"ungroupAction",
 	"valueEditor",
 	"valueSelector",
 	"valueSourceSelector"
@@ -458,6 +459,7 @@ const controlPropKeys = {
 		"toggleLockGroup",
 		"toggleMuteGroup",
 		"translations",
+		"ungroup",
 		"validationClassName",
 		"validationResult"
 	],
@@ -505,6 +507,7 @@ const controlPropKeys = {
 		"toggleLockGroup",
 		"toggleMuteGroup",
 		"translations",
+		"ungroup",
 		"validationClassName",
 		"validationResult"
 	],
@@ -541,6 +544,22 @@ const controlPropKeys = {
 		"titles",
 		"validation"
 	],
+	ungroupAction: [
+		"className",
+		"context",
+		"disabled",
+		"disabledTranslation",
+		"handleOnClick",
+		"label",
+		"level",
+		"path",
+		"ruleOrGroup",
+		"rules",
+		"schema",
+		"testID",
+		"title",
+		"validation"
+	],
 	valueEditor: [
 		"className",
 		"context",
@@ -641,6 +660,7 @@ const controlKind = {
 	ruleGroupHeaderElements: null,
 	shiftActions: null,
 	undoRedoActions: null,
+	ungroupAction: "action",
 	valueEditor: null,
 	valueSelector: null,
 	valueSourceSelector: "selector"
@@ -661,6 +681,7 @@ const strictAbortReasons = [
 	"target-not-found",
 	"parent-not-found",
 	"parent-not-a-group",
+	"target-not-a-group",
 	"destination-not-found",
 	"root-not-allowed",
 	"not-a-combinator-slot",
@@ -855,6 +876,7 @@ const ruleGroupClassnameSources = {
 	addRule: ["actionElement", "addRule"],
 	addGroup: ["actionElement", "addGroup"],
 	cloneGroup: ["actionElement", "cloneGroup"],
+	ungroup: ["actionElement", "ungroup"],
 	lockGroup: ["actionElement", "lockGroup"],
 	muteGroup: ["actionElement", "muteGroup"],
 	removeGroup: ["actionElement", "removeGroup"],
@@ -1514,6 +1536,7 @@ const mergeClassnames = (...args) => ({
 	addGroup: joinClassnamesByName("addGroup", args),
 	cloneRule: joinClassnamesByName("cloneRule", args),
 	cloneGroup: joinClassnamesByName("cloneGroup", args),
+	ungroup: joinClassnamesByName("ungroup", args),
 	removeGroup: joinClassnamesByName("removeGroup", args),
 	rule: joinClassnamesByName("rule", args),
 	fields: joinClassnamesByName("fields", args),
@@ -2019,6 +2042,81 @@ const removeInPlace = (query, pathOrID, options = {}) => {
 	} else parent.rules.splice(index, 1);
 	return query;
 };
+/**
+* Replaces a group with its own rules in its parent group, without mutating the original query.
+*
+* The group's `combinator`, `not`, `id`, `muted`, and `disabled` properties are discarded; its
+* rules keep their `id`s since they remain in the same query. An empty group is simply removed.
+*
+* @returns A new query with the group's rules promoted into its parent group.
+*
+* @group Query Tools
+*/
+const ungroup = (query, pathOrID, options = {}) => producerFor(options.freeze)(query, (q) => ungroupInPlace(q, pathOrID, options));
+/**
+* Replaces a group with its own rules in its parent group, in place.
+*
+* @returns The query (mutated in place) with the group's rules promoted into its parent group.
+*
+* @group Query Tools
+*/
+const ungroupInPlace = (query, pathOrID, options = {}) => {
+	const { onAbort } = options;
+	const path = Array.isArray(pathOrID) ? pathOrID : getPathOfID(pathOrID, query);
+	if (!path) {
+		onAbort?.({
+			reason: "target-not-found",
+			operation: "ungroup",
+			pathOrID
+		});
+		return query;
+	}
+	if (path.length === 0) {
+		onAbort?.({
+			reason: "root-not-allowed",
+			operation: "ungroup",
+			pathOrID
+		});
+		return query;
+	}
+	const ungroupGuardReason = getGuardAbortReason(query, path, options);
+	if (ungroupGuardReason) {
+		onAbort?.({
+			reason: ungroupGuardReason,
+			operation: "ungroup",
+			pathOrID
+		});
+		return query;
+	}
+	const target = findPath(path, query);
+	if (!target) {
+		onAbort?.({
+			reason: "target-not-found",
+			operation: "ungroup",
+			pathOrID
+		});
+		return query;
+	}
+	if (!isRuleGroup(target)) {
+		onAbort?.({
+			reason: "target-not-a-group",
+			operation: "ungroup",
+			pathOrID
+		});
+		return query;
+	}
+	const index = path.at(-1);
+	const parent = findPath(getParentPath(path), query);
+	if (target.rules.length === 0) {
+		if (!isRuleGroupType(parent) && parent.rules.length > 1) {
+			const idxStartDelete = index === 0 ? 0 : index - 1;
+			parent.rules.splice(idxStartDelete, 2);
+		} else parent.rules.splice(index, 1);
+		return query;
+	}
+	parent.rules.splice(index, 1, ...target.rules);
+	return query;
+};
 const getNextPath = (query, currentPath, newPathOrShiftDirection) => {
 	if (Array.isArray(newPathOrShiftDirection)) return newPathOrShiftDirection;
 	const ic = isRuleGroupTypeIC(query);
@@ -2357,7 +2455,7 @@ const groupInPlace = (query, sourcePathOrID, targetPathOrID, options = {}) => {
 //#endregion
 //#region src/utils/queryActions.ts
 /**
-* Builds the query builder's six mutation handlers as pure functions of the current query.
+* Builds the query builder's seven mutation handlers as pure functions of the current query.
 *
 * This is the framework-agnostic core of the action handlers in `useQueryBuilderSchema`. It owns
 * the policy that surrounds the query tools—disabled gating, the confirmation callback protocol,
@@ -2367,7 +2465,7 @@ const groupInPlace = (query, sourcePathOrID, targetPathOrID, options = {}) => {
 * @group Query Tools
 */
 const createQueryActions = (config = {}) => {
-	const { qbId, combinators, idGenerator, maxLevels = Infinity, queryDisabled, respectDisabled = true, disabledPaths, resetOnFieldChange, resetOnOperatorChange, getRuleDefaultOperator, getValueSources, getRuleDefaultValue, getMatchModes, freeze, onAddRule, onAddGroup, onRemove, onMoveRule, onMoveGroup, onGroupRule, onGroupGroup, onLog } = config;
+	const { qbId, combinators, idGenerator, maxLevels = Infinity, queryDisabled, respectDisabled = true, disabledPaths, resetOnFieldChange, resetOnOperatorChange, getRuleDefaultOperator, getValueSources, getRuleDefaultValue, getMatchModes, freeze, onAddRule, onAddGroup, onRemove, onMoveRule, onMoveGroup, onGroupRule, onGroupGroup, onUngroup, onLog } = config;
 	const log = (payload) => onLog?.({
 		qbId,
 		...payload
@@ -2607,6 +2705,39 @@ const createQueryActions = (config = {}) => {
 				clone
 			});
 			return newQuery;
+		},
+		ungroupRuleGroup: (query, path, context) => {
+			if (blocked(query, path)) {
+				log({
+					type: LogType.pathDisabled,
+					path,
+					query
+				});
+				return;
+			}
+			const ruleGroup = findPath(path, query);
+			if (path.length === 0 || !isRuleGroup(ruleGroup)) return void 0;
+			const nextQuery = ungroup(query, path, { freeze });
+			const callbackResult = onUngroup ? onUngroup(ruleGroup, path, query, nextQuery, context) : true;
+			if (!callbackResult) {
+				log({
+					type: LogType.onUngroupFalse,
+					ruleGroup,
+					path,
+					query,
+					nextQuery
+				});
+				return;
+			}
+			const newQuery = isRuleGroup(callbackResult) ? callbackResult : nextQuery;
+			log({
+				type: LogType.ungroup,
+				query,
+				newQuery,
+				path,
+				ruleGroup
+			});
+			return newQuery;
 		}
 	};
 };
@@ -2673,6 +2804,6 @@ const createRuleGroup = ({ combinators, addRuleToNewGroups, createRule: createRu
 	};
 };
 //#endregion
-export { LogType, TestID, add, addInPlace, betweenOperators, clsx, coerceBigIntValue, coerceInputType, controlKeys, controlKind, controlPropKeys, convertFromIC, convertQuery, convertToIC, createQueryActions, createRule, createRuleGroup, defaultCoalesceMs, defaultCombinatorLabelMap, defaultCombinators, defaultCombinatorsExtended, defaultControlClassnames, defaultJoinChar, defaultMatchModes, defaultMaxHistory, defaultOperatorLabelMap, defaultOperatorNegationMap, defaultOperators, defaultPlaceholderFieldGroupLabel, defaultPlaceholderFieldLabel, defaultPlaceholderFieldName, defaultPlaceholderLabel, defaultPlaceholderName, defaultPlaceholderOperatorGroupLabel, defaultPlaceholderOperatorLabel, defaultPlaceholderOperatorName, defaultPlaceholderValueGroupLabel, defaultPlaceholderValueLabel, defaultPlaceholderValueName, defaultTranslations, defaultValidator, derivePathInfo, deriveQueryBuilderClassNames, deriveRuleClassName, deriveRuleClassNames, deriveRuleContext, deriveRuleGroupClassNames, deriveRuleGroupContext, deriveRuleGroupOuterClassName, deriveRuleOuterClassName, exceedsMaxLevels, filterFieldsByComparator, findID, findPath, generateAccessibleDescription, generateID, getCommonAncestorPath, getFieldData, getFirstOption, getGuardAbortReason, getMatchModesUtil, getMultiValueUpdate, getOption, getParametersAsList, getParentPath, getParseNumberMethod, getPathOfID, getRuleDefaultValue, getRuleGroupCombinator, getRuleInputType, getRuleValidationResult, getRuleValueEditorType, getRuleValueSourceOptions, getRuleValues, getValidationClassNames, getValueEditorReset, getValueSelectorUpdate, getValueSourcesUtil, group, groupInPlace, groupInvalidReasons, hideValueControlsForOperator, inOperators, insert, insertInPlace, isAncestor, isBetweenOperator, isFlexibleOptionArray, isFlexibleOptionGroupArray, isFullOptionArray, isFullOptionGroupArray, isOptionGroupArray, isPojo, isRuleGroup, isRuleGroupType, isRuleGroupTypeIC, isRuleOrGroupValid, isRuleType, isUnsafeKey, isValidationResult, joinWith, lc, mergeAnyTranslation, mergeAnyTranslations, mergeClassnames, move, moveInPlace, normalizeValueSelectorValue, nullFreeArray, nullOperators, nullOrUndefinedOrEmpty, numericRegex, objectEntries, objectKeys, optionsEqual, parseNumber, pathIsDisabled, pathIsDisabledByPaths, pathsAreEqual, preferAnyProp, preferFlagProps, preferProp, prepareOptionList, prepareRule, prepareRuleGroup, prepareRuleOrGroup, queryBuilderFlagDefaults, regenerateID, regenerateIDs, relationalOperators, remove, removeInPlace, resolveCandidateQuery, resolveDefaultOperator, resolveOperatorList, resolveValueEditorType, resolveValueList, rootPath, setAutoFreeze, shouldCoalesce, signatureOf, splitBy, standardClassnames, strictAbortReasons, structuralSignature, substringOperators, toArray, toFlatOptionArray, toFullOption, toFullOptionList, toFullOptionMap, transformQuery, trimIfString, unchangedSignature, uniqByIdentifier, uniqByName, uniqOptGroups, uniqOptList, update, updateInPlace, uuidV4regex, valuesEqual };
+export { LogType, TestID, add, addInPlace, betweenOperators, clsx, coerceBigIntValue, coerceInputType, controlKeys, controlKind, controlPropKeys, convertFromIC, convertQuery, convertToIC, createQueryActions, createRule, createRuleGroup, defaultCoalesceMs, defaultCombinatorLabelMap, defaultCombinators, defaultCombinatorsExtended, defaultControlClassnames, defaultJoinChar, defaultMatchModes, defaultMaxHistory, defaultOperatorLabelMap, defaultOperatorNegationMap, defaultOperators, defaultPlaceholderFieldGroupLabel, defaultPlaceholderFieldLabel, defaultPlaceholderFieldName, defaultPlaceholderLabel, defaultPlaceholderName, defaultPlaceholderOperatorGroupLabel, defaultPlaceholderOperatorLabel, defaultPlaceholderOperatorName, defaultPlaceholderValueGroupLabel, defaultPlaceholderValueLabel, defaultPlaceholderValueName, defaultTranslations, defaultValidator, derivePathInfo, deriveQueryBuilderClassNames, deriveRuleClassName, deriveRuleClassNames, deriveRuleContext, deriveRuleGroupClassNames, deriveRuleGroupContext, deriveRuleGroupOuterClassName, deriveRuleOuterClassName, exceedsMaxLevels, filterFieldsByComparator, findID, findPath, generateAccessibleDescription, generateID, getCommonAncestorPath, getFieldData, getFirstOption, getGuardAbortReason, getMatchModesUtil, getMultiValueUpdate, getOption, getParametersAsList, getParentPath, getParseNumberMethod, getPathOfID, getRuleDefaultValue, getRuleGroupCombinator, getRuleInputType, getRuleValidationResult, getRuleValueEditorType, getRuleValueSourceOptions, getRuleValues, getValidationClassNames, getValueEditorReset, getValueSelectorUpdate, getValueSourcesUtil, group, groupInPlace, groupInvalidReasons, hideValueControlsForOperator, inOperators, insert, insertInPlace, isAncestor, isBetweenOperator, isFlexibleOptionArray, isFlexibleOptionGroupArray, isFullOptionArray, isFullOptionGroupArray, isOptionGroupArray, isPojo, isRuleGroup, isRuleGroupType, isRuleGroupTypeIC, isRuleOrGroupValid, isRuleType, isUnsafeKey, isValidationResult, joinWith, lc, mergeAnyTranslation, mergeAnyTranslations, mergeClassnames, move, moveInPlace, normalizeValueSelectorValue, nullFreeArray, nullOperators, nullOrUndefinedOrEmpty, numericRegex, objectEntries, objectKeys, optionsEqual, parseNumber, pathIsDisabled, pathIsDisabledByPaths, pathsAreEqual, preferAnyProp, preferFlagProps, preferProp, prepareOptionList, prepareRule, prepareRuleGroup, prepareRuleOrGroup, queryBuilderFlagDefaults, regenerateID, regenerateIDs, relationalOperators, remove, removeInPlace, resolveCandidateQuery, resolveDefaultOperator, resolveOperatorList, resolveValueEditorType, resolveValueList, rootPath, setAutoFreeze, shouldCoalesce, signatureOf, splitBy, standardClassnames, strictAbortReasons, structuralSignature, substringOperators, toArray, toFlatOptionArray, toFullOption, toFullOptionList, toFullOptionMap, transformQuery, trimIfString, unchangedSignature, ungroup, ungroupInPlace, uniqByIdentifier, uniqByName, uniqOptGroups, uniqOptList, update, updateInPlace, uuidV4regex, valuesEqual };
 
 //# sourceMappingURL=derivations.mjs.map