@genesislcap/expression-builder 14.483.3-alpha-7a2e689.0 → 14.484.0

package/dist/expression-builder.d.ts

@@ -2,6 +2,12 @@ import { ElementStyles } from '@microsoft/fast-element';
 import { GenesisElement } from '@genesislcap/web-core';
 import { ViewTemplate } from '@microsoft/fast-element';
 
+/** @beta Detail payload for the `add-group` event. */
+export declare type AddGroupEventDetail = EventsDetailMap[Events.AddGroup];
+
+/** @beta Detail payload for the `add-rule` event. */
+export declare type AddRuleEventDetail = EventsDetailMap[Events.AddRule];
+
 /**
  * Basic `AND` and `OR` logical combinators which can be used in the model config.
  * @beta
@@ -18,6 +24,14 @@ declare type BinaryOperator = {
     nbInputs: 1;
 } & _Operator;
 
+/**
+ * @beta Detail payload for the `change` event fired by the expression builder component.
+ * Alias of `Types.Group` exposed as a plain identifier: `Group` is otherwise only reachable
+ * through the `Types` namespace re-export, which the generated React wrapper's detail-type
+ * resolution can't follow.
+ */
+export declare type ChangeEventDetail = Group;
+
 /**
  * Configuration for a boolean-type input, which has a boolean value and a checkbox.
  * @beta **/
@@ -191,6 +205,64 @@ declare type DateTimeInput = {
     validation?: (x: unknown) => string | null;
 };
 
+/** @beta Detail payload for the `del-group` event. */
+export declare type DelGroupEventDetail = EventsDetailMap[Events.DelGroup];
+
+/** @beta Detail payload for the `del-rule` event. */
+export declare type DelRuleEventDetail = EventsDetailMap[Events.DelRule];
+
+/** @beta Event names dispatched by the expression builder component family. */
+export declare enum Events {
+    AddGroup = "add-group",
+    DelGroup = "del-group",
+    AddRule = "add-rule",
+    DelRule = "del-rule",
+    UpdateGroup = "update-group",
+    UpdateRule = "update-rule",
+    FieldSelected = "field-selected",
+    OperatorSelected = "operator-selected",
+    ValueUpdated = "value-updated",
+    RemoveVarArg = "remove-variadic-operand"
+}
+
+/** @beta Maps each event name to the `detail` payload carried by its CustomEvent. */
+export declare type EventsDetailMap = {
+    [Events.AddGroup]: {
+        parentGroupId: string;
+        newGroup: Pick<GroupMetadata, 'level'>;
+    };
+    [Events.DelGroup]: {
+        groupId: string;
+    };
+    [Events.AddRule]: {
+        parentGroupId: string;
+    };
+    [Events.DelRule]: {
+        ruleId: string;
+    };
+    [Events.UpdateGroup]: {
+        groupId: string;
+        newData: Omit<Group, 'children'>;
+    };
+    [Events.UpdateRule]: {
+        ruleId: string;
+        newData: Rule;
+    };
+    [Events.FieldSelected]: {
+        fieldId: string;
+    };
+    [Events.OperatorSelected]: {
+        operatorId: string;
+    };
+    [Events.ValueUpdated]: {
+        value: any;
+        index: number;
+    };
+    [Events.RemoveVarArg]: {
+        index: number;
+    };
+};
+
 /**
  * Top level component to allow the user to build expressions. It produces a generic payload which doesn't have any system by itself
  * to evaluate or execute the built expression.
@@ -203,13 +275,13 @@ declare type DateTimeInput = {
  * where you want to use a different (e.g. domain specific) model then it will likely override then emit event and instead emit
  * it's own model. To check the underlying `Types.Group` model check the {@link ExpressionBuilder.model} property.
  *
- * @fires change - Fired when the expression model changes
- * @fires add-group - Bubbled when a nested group add is requested
- * @fires del-group - Bubbled when a group delete is requested
- * @fires add-rule - Bubbled when a rule add is requested
- * @fires del-rule - Bubbled when a rule delete is requested
- * @fires update-group - Bubbled when group data changes
- * @fires update-rule - Bubbled when rule data changes
+ * @fires change - Fired when the expression model changes. detail: `ChangeEventDetail`
+ * @fires add-group - Bubbled when a nested group add is requested. detail: `AddGroupEventDetail`
+ * @fires del-group - Bubbled when a group delete is requested. detail: `DelGroupEventDetail`
+ * @fires add-rule - Bubbled when a rule add is requested. detail: `AddRuleEventDetail`
+ * @fires del-rule - Bubbled when a rule delete is requested. detail: `DelRuleEventDetail`
+ * @fires update-group - Bubbled when group data changes. detail: `UpdateGroupEventDetail`
+ * @fires update-rule - Bubbled when rule data changes. detail: `UpdateRuleEventDetail`
  *
  * @beta
  */
@@ -381,6 +453,9 @@ declare type Field = {
     operators?: string[];
 } & FieldTypes;
 
+/** @beta Detail payload for the `field-selected` event. */
+export declare type FieldSelectedEventDetail = EventsDetailMap[Events.FieldSelected];
+
 /**
  * Union of all input types
  * @beta **/
@@ -518,6 +593,12 @@ declare type _Operator = {
     valueType?: FieldTypes;
 };
 
+/** @beta Detail payload for the `operator-selected` event. */
+export declare type OperatorSelectedEventDetail = EventsDetailMap[Events.OperatorSelected];
+
+/** @beta Detail payload for the `remove-variadic-operand` event. */
+export declare type RemoveVarArgEventDetail = EventsDetailMap[Events.RemoveVarArg];
+
 /**
  * A rule is a single constituent element of a larger expression, and is the smallest whole part of an expression.
  *
@@ -637,6 +718,15 @@ declare type UniraryOperator = {
     nbInputs: 0;
 } & _Operator;
 
+/** @beta Detail payload for the `update-group` event. */
+export declare type UpdateGroupEventDetail = EventsDetailMap[Events.UpdateGroup];
+
+/** @beta Detail payload for the `update-rule` event. */
+export declare type UpdateRuleEventDetail = EventsDetailMap[Events.UpdateRule];
+
+/** @beta Detail payload for the `value-updated` event. */
+export declare type ValueUpdatedEventDetail = EventsDetailMap[Events.ValueUpdated];
+
 /**
  * An operator which can have any number of values where `NumVals >= 1`, defaulting to 1. Example `one_of`.
  * @beta **/

package/dist/react.cjs

@@ -118,38 +118,38 @@ const ExpressionRule = React.forwardRef(function ExpressionRule(props, ref) {
   return React.createElement(customElements.getName(ExpressionRuleWC) ?? 'expression-rule', { ...rest, ref: _mergeRefs(_innerRef, ref) }, children);
 });
 
-const RuleOperator = React.forwardRef(function RuleOperator(props, ref) {
-  const { onOperatorSelected, children, ...rest } = props;
+const RuleField = React.forwardRef(function RuleField(props, ref) {
+  const { onFieldSelected, children, ...rest } = props;
   const _innerRef = React.useRef(null);
-  const _onOperatorSelectedRef = React.useRef(onOperatorSelected);
-  _onOperatorSelectedRef.current = onOperatorSelected;
+  const _onFieldSelectedRef = React.useRef(onFieldSelected);
+  _onFieldSelectedRef.current = onFieldSelected;
   React.useLayoutEffect(() => {
     const el = _innerRef.current;
     if (!el) return;
-    const _onOperatorSelectedFn = (e) => _onOperatorSelectedRef.current?.(e);
-    el.addEventListener('operator-selected', _onOperatorSelectedFn);
+    const _onFieldSelectedFn = (e) => _onFieldSelectedRef.current?.(e);
+    el.addEventListener('field-selected', _onFieldSelectedFn);
     return () => {
-      el.removeEventListener('operator-selected', _onOperatorSelectedFn);
+      el.removeEventListener('field-selected', _onFieldSelectedFn);
     };
   }, []);
-  return React.createElement(customElements.getName(RuleOperatorWC) ?? 'expression-rule-operator', { ...rest, ref: _mergeRefs(_innerRef, ref) }, children);
+  return React.createElement(customElements.getName(RuleFieldWC) ?? 'expression-rule-field', { ...rest, ref: _mergeRefs(_innerRef, ref) }, children);
 });
 
-const RuleField = React.forwardRef(function RuleField(props, ref) {
-  const { onFieldSelected, children, ...rest } = props;
+const RuleOperator = React.forwardRef(function RuleOperator(props, ref) {
+  const { onOperatorSelected, children, ...rest } = props;
   const _innerRef = React.useRef(null);
-  const _onFieldSelectedRef = React.useRef(onFieldSelected);
-  _onFieldSelectedRef.current = onFieldSelected;
+  const _onOperatorSelectedRef = React.useRef(onOperatorSelected);
+  _onOperatorSelectedRef.current = onOperatorSelected;
   React.useLayoutEffect(() => {
     const el = _innerRef.current;
     if (!el) return;
-    const _onFieldSelectedFn = (e) => _onFieldSelectedRef.current?.(e);
-    el.addEventListener('field-selected', _onFieldSelectedFn);
+    const _onOperatorSelectedFn = (e) => _onOperatorSelectedRef.current?.(e);
+    el.addEventListener('operator-selected', _onOperatorSelectedFn);
     return () => {
-      el.removeEventListener('field-selected', _onFieldSelectedFn);
+      el.removeEventListener('operator-selected', _onOperatorSelectedFn);
     };
   }, []);
-  return React.createElement(customElements.getName(RuleFieldWC) ?? 'expression-rule-field', { ...rest, ref: _mergeRefs(_innerRef, ref) }, children);
+  return React.createElement(customElements.getName(RuleOperatorWC) ?? 'expression-rule-operator', { ...rest, ref: _mergeRefs(_innerRef, ref) }, children);
 });
 
 const RuleValue = React.forwardRef(function RuleValue(props, ref) {
@@ -178,7 +178,7 @@ module.exports = {
   ExpressionBuilder,
   ExpressionGroup,
   ExpressionRule,
-  RuleOperator,
   RuleField,
+  RuleOperator,
   RuleValue,
 };

package/dist/react.mjs

@@ -116,38 +116,38 @@ export const ExpressionRule = React.forwardRef(function ExpressionRule(props, re
   return React.createElement(customElements.getName(ExpressionRuleWC) ?? 'expression-rule', { ...rest, ref: _mergeRefs(_innerRef, ref) }, children);
 });
 
-export const RuleOperator = React.forwardRef(function RuleOperator(props, ref) {
-  const { onOperatorSelected, children, ...rest } = props;
+export const RuleField = React.forwardRef(function RuleField(props, ref) {
+  const { onFieldSelected, children, ...rest } = props;
   const _innerRef = React.useRef(null);
-  const _onOperatorSelectedRef = React.useRef(onOperatorSelected);
-  _onOperatorSelectedRef.current = onOperatorSelected;
+  const _onFieldSelectedRef = React.useRef(onFieldSelected);
+  _onFieldSelectedRef.current = onFieldSelected;
   React.useLayoutEffect(() => {
     const el = _innerRef.current;
     if (!el) return;
-    const _onOperatorSelectedFn = (e) => _onOperatorSelectedRef.current?.(e);
-    el.addEventListener('operator-selected', _onOperatorSelectedFn);
+    const _onFieldSelectedFn = (e) => _onFieldSelectedRef.current?.(e);
+    el.addEventListener('field-selected', _onFieldSelectedFn);
     return () => {
-      el.removeEventListener('operator-selected', _onOperatorSelectedFn);
+      el.removeEventListener('field-selected', _onFieldSelectedFn);
     };
   }, []);
-  return React.createElement(customElements.getName(RuleOperatorWC) ?? 'expression-rule-operator', { ...rest, ref: _mergeRefs(_innerRef, ref) }, children);
+  return React.createElement(customElements.getName(RuleFieldWC) ?? 'expression-rule-field', { ...rest, ref: _mergeRefs(_innerRef, ref) }, children);
 });
 
-export const RuleField = React.forwardRef(function RuleField(props, ref) {
-  const { onFieldSelected, children, ...rest } = props;
+export const RuleOperator = React.forwardRef(function RuleOperator(props, ref) {
+  const { onOperatorSelected, children, ...rest } = props;
   const _innerRef = React.useRef(null);
-  const _onFieldSelectedRef = React.useRef(onFieldSelected);
-  _onFieldSelectedRef.current = onFieldSelected;
+  const _onOperatorSelectedRef = React.useRef(onOperatorSelected);
+  _onOperatorSelectedRef.current = onOperatorSelected;
   React.useLayoutEffect(() => {
     const el = _innerRef.current;
     if (!el) return;
-    const _onFieldSelectedFn = (e) => _onFieldSelectedRef.current?.(e);
-    el.addEventListener('field-selected', _onFieldSelectedFn);
+    const _onOperatorSelectedFn = (e) => _onOperatorSelectedRef.current?.(e);
+    el.addEventListener('operator-selected', _onOperatorSelectedFn);
     return () => {
-      el.removeEventListener('field-selected', _onFieldSelectedFn);
+      el.removeEventListener('operator-selected', _onOperatorSelectedFn);
     };
   }, []);
-  return React.createElement(customElements.getName(RuleFieldWC) ?? 'expression-rule-field', { ...rest, ref: _mergeRefs(_innerRef, ref) }, children);
+  return React.createElement(customElements.getName(RuleOperatorWC) ?? 'expression-rule-operator', { ...rest, ref: _mergeRefs(_innerRef, ref) }, children);
 });
 
 export const RuleValue = React.forwardRef(function RuleValue(props, ref) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/expression-builder",
   "description": "Genesis Foundation Expression Builder",
-  "version": "14.483.3-alpha-7a2e689.0",
+  "version": "14.484.0",
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
   "types": "dist/expression-builder.d.ts",
@@ -38,16 +38,16 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.483.3-alpha-7a2e689.0",
-    "@genesislcap/genx": "14.483.3-alpha-7a2e689.0",
-    "@genesislcap/rollup-builder": "14.483.3-alpha-7a2e689.0",
-    "@genesislcap/ts-builder": "14.483.3-alpha-7a2e689.0",
-    "@genesislcap/uvu-playwright-builder": "14.483.3-alpha-7a2e689.0",
-    "@genesislcap/vite-builder": "14.483.3-alpha-7a2e689.0",
-    "@genesislcap/webpack-builder": "14.483.3-alpha-7a2e689.0"
+    "@genesislcap/foundation-testing": "14.484.0",
+    "@genesislcap/genx": "14.484.0",
+    "@genesislcap/rollup-builder": "14.484.0",
+    "@genesislcap/ts-builder": "14.484.0",
+    "@genesislcap/uvu-playwright-builder": "14.484.0",
+    "@genesislcap/vite-builder": "14.484.0",
+    "@genesislcap/webpack-builder": "14.484.0"
   },
   "dependencies": {
-    "@genesislcap/web-core": "14.483.3-alpha-7a2e689.0",
+    "@genesislcap/web-core": "14.484.0",
     "rfdc": "1.4.1"
   },
   "repository": {
@@ -70,5 +70,5 @@
       "require": "./dist/react.cjs"
     }
   },
-  "gitHead": "a42f1a2c0cea394164712c9abdeb96f58775d5e7"
+  "gitHead": "1ec7b2318e2447c2cd3ad877666b6fd1f3b87c05"
 }