@formio/uag 1.3.0 → 1.3.1

package/README.md

@@ -60,7 +60,7 @@ try {
 There is also a way to extend the functionality of the UAG through the use of modules, which is documented in the [Modules Readme](./module/Readme.md)
 
 ### Docker
-In addition to running the UAG in node.js, you can also run the UAG within the Docker environment. This enables a wide range of deployment options into common hosting environments such as AWS and Azure as well as allow for the use in common orchestration runtimes such as Kubernetes and Docker Compose. The container that you will use for running the UAG is as follows.
+In addition to running the UAG in Node.js, you can also run the UAG within the Docker environment. This enables a wide range of deployment options into common hosting environments such as AWS and Azure as well as allow for the use in common orchestration runtimes such as Kubernetes and Docker Compose. The container that you will use for running the UAG is as follows.
 
 ```
 formio/uag

package/lib/templates/allFieldsCollected.md

@@ -1,9 +1,8 @@
-**All required fields have been collected for <%= parentLabel %>!**
+**All required fields have been collected for <%= parentLabel %>.**
 <% if (parentDataPath) { %>
 This data was collected within the data path of **<%= parentDataPath %>**.
 <% } %>
 <%= dataSummary %>
-
 **Next Steps**:
 <% if (parent && parent.isTable) { %>
 1. Use the `get_form_fields` tool with the same `parent` parameter and `criteria` set to "optional" to check if there are optional fields. If so, ask the user if they wish to fill any of them out for this row.

package/lib/templates/fieldCollectedNext.md

@@ -2,7 +2,7 @@
 <% if (parent) { %>
 The following data is being collected for the nested component **<%= parent.label %> (<%= parent.type %>)**.  The parent `data_path` is **parent.data_path**, and all of the child data is collected within the path of **<%= parentDataPath %>**.
 <% } %>
-## Progress: <%= progress.collected %>/<%= progress.total %> required fields collected for <%= parentLabel %>.
+## Progress: <%= progress.collected %>/<%= progress.total %> all fields (required and optional) collected for <%= parentLabel %>.
 
 ## Remaining required fields for <%= parentLabel %>:
 <%= fields %>
@@ -11,4 +11,5 @@ Use the `collect_field_data` tool to provide values for the remaining required f
 <%= dataSummary %>
 
 **Next Steps**:
-1. Ask the user for any remaining required fields for <%= parentLabel %>.
+1. Ask the user for any remaining required fields for <%= parentLabel %>.
+2. If all "required" fields have been collected, then use the `get_form_fields` with `criteria` set to "optional" to get any additional fields the user wishes to also provide.

package/lib/templates/getFormFields.md

@@ -1,16 +1,11 @@
-<%= message %>## <%= type %> fields for <%= parentLabel %>
+## <%= type %> fields for <%= parentLabel %>
 <% if (parent) { %>
 All values for these fields should be stored within the `data_path`="<%= parentDataPath %>" (e.g. "<%= parentDataPath %>.exampleField")
 <% } %>
-### Summary
-- Total fields for <%= parentLabel %>: <%= totalFields %>
-- Total fields collected for <%= parentLabel %>: <% totalCollected %>
-- Number of <%= type %> fields for <%= parentLabel %>: <%= totalType %>
-- Number of <%= type %> fields collected for <%= parentLabel %>: <%= totalTypeCollected %>
-
-<%= rules %>
 
 ### <%= type %> fields for <%= parentLabel %>
 <%= fieldList %>
 
+<%= rules %>
+
 Once the user provides provides some context, use the `get_field_info` tool to understand how to validate and process the data that was collected. Make sure to set the `field_paths` to only the paths of the fields that the user has provided values for.

package/lib/templates/getFormFieldsInfo.md

@@ -3,4 +3,4 @@ Here is the field information for the fields requested.
 ### Field Information
 <%= fields %>
 
-Use the `collect_field_data` tool to collect field information that the user has provided.
+Use the `collect_field_data` tool to collect field information that the user has provided, or use the `submission_update` tool to update existing records with new or modified values.

package/lib/tools/collectData.js

@@ -63,7 +63,7 @@ const collectData = async (project) => {
                 }),
                 progress: {
                     collected: Object.keys(form_data).length,
-                    total: fields.required.components.length + Object.keys(form_data).length
+                    total: fields.total
                 }
             });
         }

package/lib/tools/getFormFields.js

@@ -13,10 +13,9 @@ const getFormFields = async (project) => {
         description: 'Get high level overview of the fields that are present in a form, and to understand the "rules" on how the data for each field type should be collected. The purpose of this tool is to determine what fields the user is requesting (and to understand how to format that values for that data), and use that to create a list of field data_path\'s that the user is providing context for. This list can then be provided to the `get_field_info` tool to determine the specific field level information for those fields (validation, required, collection rules, etc). PREREQUISITE: You must call the `get_forms` tool first to understand what forms are available to submit and the permissions associated with those forms.',
         inputSchema: (new SchemaBuilder_1.SchemaBuilder(project))
             .form_name()
-            .form_data()
             .criteria()
             .parent().schema,
-        execute: async ({ form_name, form_data, criteria, parent }, extra) => {
+        execute: async ({ form_name, criteria, parent }, extra) => {
             const form = await project.getForm(form_name);
             if (!form) {
                 return project.mcpResponse(template_1.ResponseTemplate.formNotFound, { formName: form_name }, true);
@@ -26,17 +25,8 @@ const getFormFields = async (project) => {
                 if (!parent?.data_path || !parent.type) {
                     parent = undefined;
                 }
-                // Get the submission data.
-                const submission = form.convertToSubmission(form_data);
                 // Get the fields at the specified data path (or root if not provided).
-                const fields = await form.getFields(submission, extra.authInfo, parent?.data_path);
-                // If the agent requests optional fields, but there are still requird fields to fill out, then force required
-                // and inform the agent of this change.
-                let message = '';
-                if (criteria == 'optional' && fields.required.components.length > 0) {
-                    criteria = 'required';
-                    message = 'You requested "optional" fields, but the user is not finished collecting required information. Please finish collecting the following required fields first.\n\n';
-                }
+                const fields = await form.getFields({ data: {} }, extra.authInfo, parent?.data_path);
                 // Determine which fields to show based on the criteria.
                 const criteriaFields = criteria === 'all' ?
                     [...fields.required.components, ...fields.optional.components] :
@@ -53,37 +43,14 @@ const getFormFields = async (project) => {
                 const criteriaRules = criteria === 'all' ?
                     { ...fields.required.rules, ...fields.optional.rules } :
                     criteria === 'required' ? fields.required.rules : fields.optional.rules;
-                let totalType = fields.total;
-                if (criteria === 'required') {
-                    totalType = fields.totalRequired;
-                }
-                else if (criteria === 'optional') {
-                    totalType = fields.total - fields.totalRequired;
-                }
-                const totalCollected = Object.keys(form_data || {}).length;
-                let totalTypeCollected = 0;
-                if (criteria === 'required') {
-                    totalTypeCollected = fields.totalRequiredCollected;
-                }
-                else if (criteria === 'optional') {
-                    totalTypeCollected = totalCollected - fields.totalRequiredCollected;
-                }
-                else {
-                    totalTypeCollected = totalCollected;
-                }
                 // Show the form fields based on the criteria.
                 return project.mcpResponse(template_1.ResponseTemplate.getFormFields, {
-                    message,
                     parent,
                     parentLabel: (0, utils_1.getParentLabel)(parent, form.form),
                     parentDataPath: (0, utils_1.getParentDataPath)(parent, fields.rowIndex),
                     type: (0, lodash_1.upperFirst)(criteria),
                     rules: project.uagTemplate?.renderTemplate(template_1.ResponseTemplate.fieldRules, { rules: Object.entries(criteriaRules) }),
-                    fieldList: project.uagTemplate?.renderTemplate(template_1.ResponseTemplate.fieldList, { fields: criteriaFields }),
-                    totalFields: fields.total,
-                    totalType,
-                    totalCollected,
-                    totalTypeCollected
+                    fieldList: project.uagTemplate?.renderTemplate(template_1.ResponseTemplate.fieldList, { fields: criteriaFields })
                 });
             }
             catch (err) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formio/uag",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "The Form.io Universal Agent Gateway (UAG).",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",