@genesislcap/foundation-forms 14.488.1 → 14.488.2-FUI-2571.3

package/dist/foundation-forms.d.ts

@@ -179,6 +179,27 @@ export declare type ArrayRendererOptions = {
     showRowStatusIndicator?: boolean;
 };
 
+/**
+ * Flattens `buildReviewSections` output into a single ordered list.
+ * Section titles are prepended to field labels as "Title — Field".
+ */
+export declare function buildReviewFields(data: Record<string, any>, uiSchema: any, schema: any): Promise<ReviewField[]>;
+
+/**
+ * Builds the review panel's fields grouped into sections by their nearest `Group` layout.
+ * Ungrouped fields are collected into a single section with a `null` title (rendered with
+ * a placeholder heading). Falls back to a flat, single ungrouped section when no UI schema
+ * is available.
+ *
+ * Async because connected-select fields backed by `options.allOptionsResourceName` (rather
+ * than a static `options.data`) resolve their display label with a criteria-filtered fetch
+ * — see `resolveResourceOptionLabel`. The UI schema is walked synchronously to collect one
+ * value-resolution promise per field (preserving encounter order), then all promises settle
+ * in parallel via `Promise.all` before fields are added to their sections — so a slow fetch
+ * for one field can't reorder fields that resolved faster.
+ */
+export declare function buildReviewSections(data: Record<string, any>, uiSchema: any, schema: any): Promise<ReviewSection[]>;
+
 /**
  * Tracks the submission status and result for a single row in bulk insert mode.
  * @public
@@ -313,6 +334,12 @@ export declare type CategorizationRendererOptions = {
  */
 export declare type ChildUiSchemaResolver = (index: number, rowData: any, formData: any) => UiSchema;
 
+/**
+ * Recursively walks a UI schema element, collecting visible Control fields into `out`.
+ * Passes the nearest Group label down so children are labelled "Group — Field".
+ */
+export declare function collectReviewFields(element: any, data: any, out: ReviewField[], groupLabel: string | undefined, schema: any): void;
+
 /** @internal */
 export declare const comboboxRendererStyles: (prefix?: string) => string;
 
@@ -596,6 +623,13 @@ export declare function extractFieldsFromUiSchema(uiSchema: UiSchema): Array<{
     isHidden: boolean;
 }>;
 
+/**
+ * Filters review sections down to fields whose label or value contains `query`
+ * (case-insensitive). Sections left with no matching fields are dropped entirely.
+ * Returns `sections` unchanged when `query` is blank.
+ */
+export declare function filterReviewSections(sections: ReviewSection[], query: string): ReviewSection[];
+
 /**
  * Foundation filters component for automatically generated filters based on json schema
  * obtained from the api, supplied initial data or supplied JSON schema.
@@ -1196,6 +1230,12 @@ export declare class Form extends Form_base {
      * @internal
      */
     serverFieldErrors: ErrorObject[];
+    /**
+     * Reference to the json-forms child element — used to read live validation
+     * errors at submit time so review mode never activates when the form is invalid.
+     * @internal
+     */
+    jsonFormsEl: any;
     /**
      * Stores the approval message entered by the user.
      * @internal
@@ -1319,6 +1359,24 @@ export declare class Form extends Form_base {
      * @public
      */
     bulkInsert: boolean;
+    /**
+     * Text to appear on submit button
+     * @default Submit
+     * @public
+     */
+    submitButtonText: string;
+    /**
+     * Text to appear on submit button in bulk insert mode
+     * @default Submit AllS
+     * @public
+     */
+    bulkSubmitButtonText: string;
+    /**
+     * Text to appear on reset button
+     * @default Submit
+     * @public
+     */
+    resetButtonText: string;
     /**
      * Minimum number of items required in bulk insert mode.
      * @public
@@ -1339,16 +1397,68 @@ export declare class Form extends Form_base {
      * @internal
      */
     private userProvidedUiSchema;
+    /**
+     * When enabled, clicking submit with no validation errors shows a read-only preview
+     * of the form data before the final submission.
+     * @public
+     */
+    showSubmitReview: boolean;
+    /**
+     * Text to appear on reset button
+     * @public
+     */
+    reviewButtonText: string;
+    /**
+     * Heading shown at the top of the review panel.
+     * @public
+     */
+    reviewHeading: string;
+    /**
+     * Name of a top-level data field whose value is shown as an identifier next to the
+     * review heading (e.g. a record's primary key). No identifier is shown when unset.
+     * @public
+     */
+    reviewIdField: string;
     /**
      * Tracks the submission status for each row in bulk insert mode.
      * Key is the row index, value is the status object.
      * @public
      */
     rowSubmitStatuses: Map<number, BulkRowStatus>;
+    /**
+     * Whether the form is currently showing the submit-review preview panel.
+     * @internal
+     */
+    reviewMode: boolean;
+    /**
+     * Field label/value pairs rendered in the review panel, grouped into sections.
+     * @internal
+     */
+    reviewSections: ReviewSection[];
+    /**
+     * Value of `reviewIdField` resolved from the current form data, if set.
+     * @internal
+     */
+    get reviewRecordId(): string | undefined;
     /**
      * @internal
      */
     _submit(): Promise<void>;
+    /**
+     * Called from the review panel to go back to the form.
+     * @internal
+     */
+    backFromReview(): void;
+    /**
+     * Called from the review panel submit button to perform the actual submission.
+     * @internal
+     */
+    _submitFromReview(): Promise<void>;
+    /**
+     * Performs the actual API submission after review (or directly when review is disabled).
+     * @internal
+     */
+    private _performSubmit;
     /**
      * Handles bulk insert submission by iterating through items and submitting each separately.
      * Updates rowSubmitStatuses to provide row-level feedback.
@@ -1837,6 +1947,13 @@ declare const Form_base: (new (...args: any[]) => {
     focus(options?: FocusOptions): void;
 }) & typeof FoundationElement;
 
+/**
+ * Converts a raw field value to a display string for the review panel.
+ * Arrays of primitives are comma-joined; arrays of objects and plain objects
+ * are rendered as readable `key: value` lines.
+ */
+export declare function formatValueForReview(value: any): string;
+
 /**
  * Detail payload for the `data-change` event fired by {@link Form} and `JSONForms` whenever
  * the bound form data changes.
@@ -1862,6 +1979,12 @@ export declare type FormDataChangeEventDetail = {
     path?: string;
 };
 
+/** @internal */
+export declare const foundationFormReviewStyles: ElementStyles;
+
+/** @internal */
+export declare const foundationFormReviewTemplate: ViewTemplate<Review, any>;
+
 /** @internal */
 export declare const foundationFormStyles: ElementStyles;
 
@@ -1939,9 +2062,18 @@ export declare enum GenesisType {
  */
 export declare const getAnyOfErrorMessage: (errors: Array<any> | undefined, schema: any, controlPath: string | undefined, uiCustomMsg?: string) => string;
 
+/**
+ * Navigates a `/properties/`-separated path in data to support nested object scopes
+ * such as `ADDRESS/properties/STREET` produced by Group layout UI schemas.
+ */
+export declare function getDataValueAtPath(data: any, fieldName: string): any;
+
 /** @internal */
 export declare const getPrefixedForm: (prefix: any) => ViewTemplate<Form, any>;
 
+/** @internal */
+export declare const getPrefixedReview: (prefix: any) => ViewTemplate<Review, any>;
+
 /**
  * Fixed height (CSS value) for vertical categorization when `layout` is `{ type: 'vertical'; height?: string }`.
  * @public
@@ -2298,6 +2430,74 @@ export declare type RendererEntry = {
  */
 export declare const renderers: any[];
 
+/**
+ * For plain enum combobox fields (no options.data), applies the same `capitalCase`
+ * transform the renderer uses — e.g. `SEMI_ANNUAL` → `Semi Annual`.
+ * Navigates the JSON schema via the fieldName path to confirm the field is an enum
+ * before transforming. Returns `null` for non-enum fields.
+ */
+export declare function resolveEnumLabel(raw: any, fieldName: string, schema: any): string | null;
+
+/**
+ * Looks up the display label for a raw value from `options.data` (used by segmented,
+ * radio group, connected-select, and enum-with-explicit-data renderers). Honors
+ * `options.valueField`/`options.labelField` when set, defaulting to `value`/`label`.
+ * Returns `null` when no match found.
+ */
+export declare function resolveOptionLabel(raw: any, options: any): string | null;
+
+/**
+ * Resolves the display label for a connected-select field backed by
+ * `options.allOptionsResourceName` (a Data Server/Request Server resource) rather than a
+ * static `options.data` array — e.g. `ConnectedSelectControlRenderer` in async/remote mode.
+ * Fetches a single row via a criteria-filtered snapshot matching `valueField === raw`,
+ * then reads `labelField` off the returned row. Returns `null` when there's no resource
+ * to query, the resource can't be reached, or no row matches.
+ */
+export declare function resolveResourceOptionLabel(raw: any, options: any): Promise<string | null>;
+
+/**
+ * Read-only preview panel shown by `<foundation-form>` when `show-submit-review` is enabled.
+ * Renders the reviewed data grouped into sections with a header and a filter field.
+ * @public
+ */
+export declare class Review extends FASTElement {
+    prefix: string;
+    /**
+     * Title shown in the review header.
+     * @public
+     */
+    heading: string;
+    /**
+     * Optional identifier shown next to the heading, e.g. a record's primary key.
+     * @public
+     */
+    recordId: string;
+    /**
+     * Sections of label/value pairs to render, grouped by their nearest UI schema `Group`.
+     * @public
+     */
+    sections: ReviewSection[];
+    /**
+     * Free-text query filtering fields by label or value. Sections with no matching
+     * fields are hidden.
+     * @internal
+     */
+    filterText: string;
+    /** @internal */
+    get filteredSections(): ReviewSection[];
+}
+
+export declare type ReviewField = {
+    label: string;
+    value: string;
+};
+
+export declare type ReviewSection = {
+    title: string | null;
+    fields: ReviewField[];
+};
+
 /**
  * Detail payload for the `row-status-changed` event fired by {@link Form} whenever the
  * submission status of one or all bulk insert rows changes.

package/dist/react.cjs

@@ -17,6 +17,7 @@ const { StepperWrapper: StepperWrapperWC } = require('./esm/jsonforms/renderers/
 const { VerticalCategorizationWrapper: VerticalCategorizationWrapperWC } = require('./esm/jsonforms/renderers/VerticalCategorizationWrapperRenderer.js');
 const { DispatchRenderer: DispatchRendererWC } = require('./esm/jsonforms/renderers/dispatch-renderer.js');
 const { FoundationReactSlot: FoundationReactSlotWC } = require('./esm/jsonforms/renderers/foundation-react-slot.js');
+const { Review: ReviewWC } = require('./esm/review.js');
 
 function _mergeRefs(...refs) {
   return (value) => {
@@ -104,6 +105,11 @@ const Form = React.forwardRef(function Form(props, ref) {
   return React.createElement(customElements.getName(FormWC) ?? 'foundation-form', { ...rest, ref: _mergeRefs(_innerRef, ref) }, children);
 });
 
+const Review = React.forwardRef(function Review(props, ref) {
+  const { children, ...rest } = props;
+  return React.createElement(customElements.getName(ReviewWC) ?? 'foundation-form-review', { ...rest, ref }, children);
+});
+
 const Filters = React.forwardRef(function Filters(props, ref) {
   const { children, ...rest } = props;
   return React.createElement(customElements.getName(FiltersWC) ?? 'foundation-filters', { ...rest, ref }, children);
@@ -168,6 +174,7 @@ const FoundationReactSlot = React.forwardRef(function FoundationReactSlot(props,
 
 module.exports = {
   Form,
+  Review,
   Filters,
   JSONForms,
   ArrayListWrapper,

package/dist/react.mjs

@@ -15,6 +15,7 @@ import { StepperWrapper as StepperWrapperWC } from './esm/jsonforms/renderers/St
 import { VerticalCategorizationWrapper as VerticalCategorizationWrapperWC } from './esm/jsonforms/renderers/VerticalCategorizationWrapperRenderer.js';
 import { DispatchRenderer as DispatchRendererWC } from './esm/jsonforms/renderers/dispatch-renderer.js';
 import { FoundationReactSlot as FoundationReactSlotWC } from './esm/jsonforms/renderers/foundation-react-slot.js';
+import { Review as ReviewWC } from './esm/review.js';
 
 function _mergeRefs(...refs) {
   return (value) => {
@@ -102,6 +103,11 @@ export const Form = React.forwardRef(function Form(props, ref) {
   return React.createElement(customElements.getName(FormWC) ?? 'foundation-form', { ...rest, ref: _mergeRefs(_innerRef, ref) }, children);
 });
 
+export const Review = React.forwardRef(function Review(props, ref) {
+  const { children, ...rest } = props;
+  return React.createElement(customElements.getName(ReviewWC) ?? 'foundation-form-review', { ...rest, ref }, children);
+});
+
 export const Filters = React.forwardRef(function Filters(props, ref) {
   const { children, ...rest } = props;
   return React.createElement(customElements.getName(FiltersWC) ?? 'foundation-filters', { ...rest, ref }, children);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-forms",
   "description": "Genesis Foundation Forms",
-  "version": "14.488.1",
+  "version": "14.488.2-FUI-2571.3",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -59,13 +59,13 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.488.1",
-    "@genesislcap/genx": "14.488.1",
-    "@genesislcap/rollup-builder": "14.488.1",
-    "@genesislcap/ts-builder": "14.488.1",
-    "@genesislcap/uvu-playwright-builder": "14.488.1",
-    "@genesislcap/vite-builder": "14.488.1",
-    "@genesislcap/webpack-builder": "14.488.1",
+    "@genesislcap/foundation-testing": "14.488.2-FUI-2571.3",
+    "@genesislcap/genx": "14.488.2-FUI-2571.3",
+    "@genesislcap/rollup-builder": "14.488.2-FUI-2571.3",
+    "@genesislcap/ts-builder": "14.488.2-FUI-2571.3",
+    "@genesislcap/uvu-playwright-builder": "14.488.2-FUI-2571.3",
+    "@genesislcap/vite-builder": "14.488.2-FUI-2571.3",
+    "@genesislcap/webpack-builder": "14.488.2-FUI-2571.3",
     "@types/json-schema": "^7.0.11",
     "@types/papaparse": "^5.3.14"
   },
@@ -82,12 +82,12 @@
     }
   },
   "dependencies": {
-    "@genesislcap/foundation-comms": "14.488.1",
-    "@genesislcap/foundation-criteria": "14.488.1",
-    "@genesislcap/foundation-logger": "14.488.1",
-    "@genesislcap/foundation-notifications": "14.488.1",
-    "@genesislcap/foundation-ui": "14.488.1",
-    "@genesislcap/foundation-utils": "14.488.1",
+    "@genesislcap/foundation-comms": "14.488.2-FUI-2571.3",
+    "@genesislcap/foundation-criteria": "14.488.2-FUI-2571.3",
+    "@genesislcap/foundation-logger": "14.488.2-FUI-2571.3",
+    "@genesislcap/foundation-notifications": "14.488.2-FUI-2571.3",
+    "@genesislcap/foundation-ui": "14.488.2-FUI-2571.3",
+    "@genesislcap/foundation-utils": "14.488.2-FUI-2571.3",
     "@json-schema-tools/dereferencer": "^1.6.1",
     "@jsonforms/core": "^3.2.1",
     "@microsoft/fast-components": "2.30.6",
@@ -109,5 +109,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "59f08be328928035b4591fa97da580cc650f96c3"
+  "gitHead": "faafa39ff0c79190190672db8d6f26b6e51bd642"
 }