@genesislcap/foundation-forms 14.488.0 → 14.488.1-FUI-2571.1

package/dist/custom-elements.json

@@ -191,6 +191,36 @@
               "description": "When enabled, transforms the form into bulk insert mode where multiple records can be added.\nThe JSON schema will be wrapped as an array, and each item will be submitted separately.",
               "privacy": "public"
             },
+            {
+              "kind": "field",
+              "name": "submitButtonText",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Submit'",
+              "description": "Text to appear on submit button",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "bulkSubmitButtonText",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Submit All'",
+              "description": "Text to appear on submit button in bulk insert mode",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "resetButtonText",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Reset'",
+              "description": "Text to appear on reset button",
+              "privacy": "public"
+            },
             {
               "kind": "field",
               "name": "bulkInsertMinItems",
@@ -210,6 +240,44 @@
               "description": "Maximum number of items allowed in bulk insert mode. If not set, no maximum is enforced.",
               "privacy": "public"
             },
+            {
+              "kind": "field",
+              "name": "showSubmitReview",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "When enabled, clicking submit with no validation errors shows a read-only preview\nof the form data before the final submission.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "reviewButtonText",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Review'",
+              "description": "Text to appear on reset button",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "reviewHeading",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Review'",
+              "description": "Heading shown at the top of the review panel.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "reviewIdField",
+              "type": {
+                "text": "string"
+              },
+              "description": "Name of a top-level data field whose value is shown as an identifier next to the\nreview heading (e.g. a record's primary key). No identifier is shown when unset.",
+              "privacy": "public"
+            },
             {
               "kind": "field",
               "name": "rowSubmitStatuses",
@@ -607,6 +675,33 @@
               "description": "When enabled, transforms the form into bulk insert mode where multiple records can be added.\nThe JSON schema will be wrapped as an array, and each item will be submitted separately.",
               "fieldName": "bulkInsert"
             },
+            {
+              "name": "submit-button-text",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Submit'",
+              "description": "Text to appear on submit button",
+              "fieldName": "submitButtonText"
+            },
+            {
+              "name": "bulk-submit-button-text",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Submit All'",
+              "description": "Text to appear on submit button in bulk insert mode",
+              "fieldName": "bulkSubmitButtonText"
+            },
+            {
+              "name": "reset-button-text",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Reset'",
+              "description": "Text to appear on reset button",
+              "fieldName": "resetButtonText"
+            },
             {
               "name": "bulk-insert-min-items",
               "type": {
@@ -623,6 +718,40 @@
               },
               "description": "Maximum number of items allowed in bulk insert mode. If not set, no maximum is enforced.",
               "fieldName": "bulkInsertMaxItems"
+            },
+            {
+              "name": "show-submit-review",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "When enabled, clicking submit with no validation errors shows a read-only preview\nof the form data before the final submission.",
+              "fieldName": "showSubmitReview"
+            },
+            {
+              "name": "review-button-text",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Review'",
+              "description": "Text to appear on reset button",
+              "fieldName": "reviewButtonText"
+            },
+            {
+              "name": "review-heading",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Review'",
+              "description": "Heading shown at the top of the review panel.",
+              "fieldName": "reviewHeading"
+            },
+            {
+              "name": "review-id-field",
+              "type": {
+                "text": "string"
+              },
+              "description": "Name of a top-level data field whose value is shown as an identifier next to the\nreview heading (e.g. a record's primary key). No identifier is shown when unset.",
+              "fieldName": "reviewIdField"
             }
           ],
           "mixins": [
@@ -703,6 +832,30 @@
             "package": "./form.template"
           }
         },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./review"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./review.styles"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./review.template"
+          }
+        },
         {
           "kind": "js",
           "name": "MulticolumnDropdownControlRendererEntry",
@@ -875,6 +1028,119 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/review.styles.ts",
+      "declarations": [],
+      "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/review.template.ts",
+      "declarations": [],
+      "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/review.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Read-only preview panel shown by `<foundation-form>` when `show-submit-review` is enabled.\nRenders the reviewed data grouped into sections with a header and a filter field.",
+          "name": "Review",
+          "members": [
+            {
+              "kind": "field",
+              "name": "prefix",
+              "type": {
+                "text": "string"
+              },
+              "default": "'rapid'"
+            },
+            {
+              "kind": "field",
+              "name": "heading",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Review'",
+              "description": "Title shown in the review header.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "recordId",
+              "type": {
+                "text": "string"
+              },
+              "description": "Optional identifier shown next to the heading, e.g. a record's primary key.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "sections",
+              "type": {
+                "text": "ReviewSection[]"
+              },
+              "default": "[]",
+              "description": "Sections of label/value pairs to render, grouped by their nearest UI schema `Group`.",
+              "privacy": "public"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "design-system-prefix",
+              "type": {
+                "text": "string"
+              },
+              "default": "'rapid'",
+              "fieldName": "prefix"
+            },
+            {
+              "name": "heading",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Review'",
+              "description": "Title shown in the review header.",
+              "fieldName": "heading"
+            },
+            {
+              "name": "record-id",
+              "type": {
+                "text": "string"
+              },
+              "description": "Optional identifier shown next to the heading, e.g. a record's primary key.",
+              "fieldName": "recordId"
+            }
+          ],
+          "superclass": {
+            "name": "FASTElement",
+            "package": "@microsoft/fast-element"
+          },
+          "tagName": "foundation-form-review",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "Review",
+          "declaration": {
+            "name": "Review",
+            "module": "src/review.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "foundation-form-review",
+          "declaration": {
+            "name": "Review",
+            "module": "src/review.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/types.ts",
@@ -2011,6 +2277,14 @@
             "package": "./csv-parser"
           }
         },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./review-utils"
+          }
+        },
         {
           "kind": "js",
           "name": "*",
@@ -2067,11 +2341,365 @@
       "declarations": [],
       "exports": []
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/utils/review-utils.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "buildReviewFields",
+          "return": {
+            "type": {
+              "text": "ReviewField[]"
+            }
+          },
+          "parameters": [
+            {
+              "name": "data",
+              "type": {
+                "text": "Record<string, any>"
+              }
+            },
+            {
+              "name": "uiSchema",
+              "type": {
+                "text": "any"
+              }
+            },
+            {
+              "name": "schema",
+              "type": {
+                "text": "any"
+              }
+            }
+          ],
+          "description": "Flattens `buildReviewSections` output into a single ordered list.\nSection titles are prepended to field labels as \"Title — Field\"."
+        },
+        {
+          "kind": "function",
+          "name": "buildReviewSections",
+          "return": {
+            "type": {
+              "text": "ReviewSection[]"
+            }
+          },
+          "parameters": [
+            {
+              "name": "data",
+              "type": {
+                "text": "Record<string, any>"
+              }
+            },
+            {
+              "name": "uiSchema",
+              "type": {
+                "text": "any"
+              }
+            },
+            {
+              "name": "schema",
+              "type": {
+                "text": "any"
+              }
+            }
+          ],
+          "description": "Builds the review panel's fields grouped into sections by their nearest `Group` layout.\nUngrouped fields are collected into a single section with a `null` title (rendered with\na placeholder heading). Falls back to a flat, single ungrouped section when no UI schema\nis available."
+        },
+        {
+          "kind": "function",
+          "name": "filterReviewSections",
+          "return": {
+            "type": {
+              "text": "ReviewSection[]"
+            }
+          },
+          "parameters": [
+            {
+              "name": "sections",
+              "type": {
+                "text": "ReviewSection[]"
+              }
+            },
+            {
+              "name": "query",
+              "type": {
+                "text": "string"
+              }
+            }
+          ],
+          "description": "Filters review sections down to fields whose label or value contains `query`\n(case-insensitive). Sections left with no matching fields are dropped entirely.\nReturns `sections` unchanged when `query` is blank."
+        },
+        {
+          "kind": "function",
+          "name": "collectReviewFields",
+          "return": {
+            "type": {
+              "text": "void"
+            }
+          },
+          "parameters": [
+            {
+              "name": "element",
+              "type": {
+                "text": "any"
+              }
+            },
+            {
+              "name": "data",
+              "type": {
+                "text": "any"
+              }
+            },
+            {
+              "name": "out",
+              "type": {
+                "text": "ReviewField[]"
+              }
+            },
+            {
+              "name": "groupLabel",
+              "type": {
+                "text": "string | undefined"
+              }
+            },
+            {
+              "name": "schema",
+              "type": {
+                "text": "any"
+              }
+            }
+          ],
+          "description": "Recursively walks a UI schema element, collecting visible Control fields into `out`.\nPasses the nearest Group label down so children are labelled \"Group — Field\"."
+        },
+        {
+          "kind": "function",
+          "name": "resolveOptionLabel",
+          "return": {
+            "type": {
+              "text": "string | null"
+            }
+          },
+          "parameters": [
+            {
+              "name": "raw",
+              "type": {
+                "text": "any"
+              }
+            },
+            {
+              "name": "options",
+              "type": {
+                "text": "any"
+              }
+            }
+          ],
+          "description": "Looks up the display label for a raw value from `options.data` (used by segmented,\nradio group, and enum-with-explicit-data renderers). Returns `null` when no match found."
+        },
+        {
+          "kind": "function",
+          "name": "resolveEnumLabel",
+          "return": {
+            "type": {
+              "text": "string | null"
+            }
+          },
+          "parameters": [
+            {
+              "name": "raw",
+              "type": {
+                "text": "any"
+              }
+            },
+            {
+              "name": "fieldName",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "name": "schema",
+              "type": {
+                "text": "any"
+              }
+            }
+          ],
+          "description": "For plain enum combobox fields (no options.data), applies the same `capitalCase`\ntransform the renderer uses — e.g. `SEMI_ANNUAL` → `Semi Annual`.\nNavigates the JSON schema via the fieldName path to confirm the field is an enum\nbefore transforming. Returns `null` for non-enum fields."
+        },
+        {
+          "kind": "function",
+          "name": "getDataValueAtPath",
+          "return": {
+            "type": {
+              "text": "any"
+            }
+          },
+          "parameters": [
+            {
+              "name": "data",
+              "type": {
+                "text": "any"
+              }
+            },
+            {
+              "name": "fieldName",
+              "type": {
+                "text": "string"
+              }
+            }
+          ],
+          "description": "Navigates a `/properties/`-separated path in data to support nested object scopes\nsuch as `ADDRESS/properties/STREET` produced by Group layout UI schemas."
+        },
+        {
+          "kind": "function",
+          "name": "formatValueForReview",
+          "return": {
+            "type": {
+              "text": "string"
+            }
+          },
+          "parameters": [
+            {
+              "name": "value",
+              "type": {
+                "text": "any"
+              }
+            }
+          ],
+          "description": "Converts a raw field value to a display string for the review panel.\nArrays of primitives are comma-joined; arrays of objects and plain objects\nare rendered as readable `key: value` lines."
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "buildReviewFields",
+          "declaration": {
+            "name": "buildReviewFields",
+            "module": "src/utils/review-utils.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "buildReviewSections",
+          "declaration": {
+            "name": "buildReviewSections",
+            "module": "src/utils/review-utils.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "filterReviewSections",
+          "declaration": {
+            "name": "filterReviewSections",
+            "module": "src/utils/review-utils.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "collectReviewFields",
+          "declaration": {
+            "name": "collectReviewFields",
+            "module": "src/utils/review-utils.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "resolveOptionLabel",
+          "declaration": {
+            "name": "resolveOptionLabel",
+            "module": "src/utils/review-utils.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "resolveEnumLabel",
+          "declaration": {
+            "name": "resolveEnumLabel",
+            "module": "src/utils/review-utils.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "getDataValueAtPath",
+          "declaration": {
+            "name": "getDataValueAtPath",
+            "module": "src/utils/review-utils.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "formatValueForReview",
+          "declaration": {
+            "name": "formatValueForReview",
+            "module": "src/utils/review-utils.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/utils/schema-utils.ts",
-      "declarations": [],
-      "exports": []
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "extractErrorScopes",
+          "return": {
+            "type": {
+              "text": "string[]"
+            }
+          },
+          "parameters": [
+            {
+              "name": "errors",
+              "type": {
+                "text": "ErrorObject[]"
+              }
+            }
+          ],
+          "description": "Converts AJV validation errors to the JSON Schema scope strings they correspond to\n(e.g. `#/properties/ADDRESS/properties/STREET`). Used to match errors back to UI\nschema controls for features like categorization-tab error indicators."
+        },
+        {
+          "kind": "function",
+          "name": "uiSchemaHasAnyError",
+          "return": {
+            "type": {
+              "text": "boolean"
+            }
+          },
+          "parameters": [
+            {
+              "name": "uiSchema",
+              "type": {
+                "text": "UiSchemaElement | UiSchema"
+              }
+            },
+            {
+              "name": "errorScopes",
+              "type": {
+                "text": "string[]"
+              }
+            }
+          ],
+          "description": "Returns true when `uiSchema` (or any of its descendants) has a scope that appears\nin `errorScopes`. Walks both `elements` and `options.childElements`."
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "extractErrorScopes",
+          "declaration": {
+            "name": "extractErrorScopes",
+            "module": "src/utils/schema-utils.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "uiSchemaHasAnyError",
+          "declaration": {
+            "name": "uiSchemaHasAnyError",
+            "module": "src/utils/schema-utils.ts"
+          }
+        }
+      ]
     },
     {
       "kind": "javascript-module",