flowquery 1.0.15 → 1.0.17

package/misc/apps/RAG/src/plugins/loaders/Form.ts

@@ -1,9 +1,9 @@
 /**
  * Form plugin - transforms configuration into Adaptive Card form format.
- * 
+ *
  * Adaptive Cards are platform-agnostic UI snippets that can be rendered in
  * Microsoft Teams, Outlook, Windows, and other applications.
- * 
+ *
  * This plugin creates customizable forms with various input types including:
  * - Text inputs (single and multi-line)
  * - Number inputs
@@ -11,24 +11,22 @@
  * - Dropdown/choice sets
  * - Toggle switches
  * - Choice sets (radio buttons, checkboxes)
- * 
+ *
  * Usage in FlowQuery:
  *   // Create a simple contact form:
- *   LOAD JSON FROM form('Contact Us', [
+ *   CALL form('Contact Us', [
  *     { id: 'name', type: 'text', label: 'Your Name', required: true },
  *     { id: 'email', type: 'text', label: 'Email', placeholder: 'you@example.com' },
  *     { id: 'message', type: 'textarea', label: 'Message' }
- *   ]) AS form
- *   RETURN form
+ *   ]) YIELD type, body, actions
  */
-
-import { FunctionDef, AsyncFunction } from 'flowquery/extensibility';
+import { AsyncFunction, FunctionDef } from "flowquery/extensibility";
 
 /**
  * Interface for Adaptive Card structure
  */
 interface AdaptiveCard {
-    type: 'AdaptiveCard';
+    type: "AdaptiveCard";
     $schema: string;
     version: string;
     body: AdaptiveCardElement[];
@@ -53,7 +51,17 @@ interface FormFieldConfig {
     /** Unique identifier for the field */
     id: string;
     /** Input type: text, textarea, number, date, time, datetime, toggle, dropdown, radio, checkbox */
-    type: 'text' | 'textarea' | 'number' | 'date' | 'time' | 'datetime' | 'toggle' | 'dropdown' | 'radio' | 'checkbox';
+    type:
+        | "text"
+        | "textarea"
+        | "number"
+        | "date"
+        | "time"
+        | "datetime"
+        | "toggle"
+        | "dropdown"
+        | "radio"
+        | "checkbox";
     /** Display label for the field */
     label: string;
     /** Placeholder text for input fields */
@@ -79,9 +87,9 @@ interface FormFieldConfig {
     /** Separator before this field */
     separator?: boolean;
     /** Field width: auto, stretch, or weighted value */
-    width?: 'auto' | 'stretch' | number;
+    width?: "auto" | "stretch" | number;
     /** Custom style for the label */
-    labelStyle?: 'default' | 'heading';
+    labelStyle?: "default" | "heading";
 }
 
 /**
@@ -95,22 +103,22 @@ interface FormConfig {
     /** Submit button configuration */
     submitButton?: {
         title?: string;
-        style?: 'default' | 'positive' | 'destructive';
+        style?: "default" | "positive" | "destructive";
         /** Action URL for form submission */
         url?: string;
         /** Action type: submit, openUrl, or custom */
-        actionType?: 'submit' | 'openUrl' | 'showCard';
+        actionType?: "submit" | "openUrl" | "showCard";
     };
     /** Additional action buttons */
     additionalActions?: Array<{
         title: string;
-        type: 'submit' | 'openUrl' | 'showCard';
+        type: "submit" | "openUrl" | "showCard";
         url?: string;
-        style?: 'default' | 'positive' | 'destructive';
+        style?: "default" | "positive" | "destructive";
         data?: any;
     }>;
     /** Card background style */
-    style?: 'default' | 'emphasis' | 'good' | 'attention' | 'warning' | 'accent';
+    style?: "default" | "emphasis" | "good" | "attention" | "warning" | "accent";
     /** Whether to show a reset/clear button */
     showResetButton?: boolean;
     /** Card schema version */
@@ -121,48 +129,48 @@ interface FormConfig {
  * Form class - creates customizable Adaptive Card forms.
  */
 @FunctionDef({
-    description: 'Creates a customizable Adaptive Card form with various input types',
-    category: 'async',
+    description: "Creates a customizable Adaptive Card form with various input types",
+    category: "async",
     parameters: [
         {
-            name: 'title',
-            description: 'Form title displayed at the top',
-            type: 'string',
-            required: true
+            name: "title",
+            description: "Form title displayed at the top",
+            type: "string",
+            required: true,
         },
         {
-            name: 'fields',
-            description: 'Array of field configurations defining the form inputs',
-            type: 'array',
-            required: true
+            name: "fields",
+            description: "Array of field configurations defining the form inputs",
+            type: "array",
+            required: true,
         },
         {
-            name: 'config',
-            description: 'Optional form configuration (submit button, additional actions, styling)',
-            type: 'object',
-            required: false
-        }
+            name: "config",
+            description: "Optional form configuration (submit button, additional actions, styling)",
+            type: "object",
+            required: false,
+        },
     ],
     output: {
-        description: 'Adaptive Card JSON object with form elements',
-        type: 'object',
+        description: "Adaptive Card JSON object with form elements",
+        type: "object",
         properties: {
-            type: { description: 'Always "AdaptiveCard"', type: 'string' },
-            $schema: { description: 'Adaptive Card schema URL', type: 'string' },
-            version: { description: 'Adaptive Card version', type: 'string' },
-            body: { description: 'Card body elements including form inputs', type: 'array' },
-            actions: { description: 'Card actions (submit, cancel, etc.)', type: 'array' }
-        }
+            type: { description: 'Always "AdaptiveCard"', type: "string" },
+            $schema: { description: "Adaptive Card schema URL", type: "string" },
+            version: { description: "Adaptive Card version", type: "string" },
+            body: { description: "Card body elements including form inputs", type: "array" },
+            actions: { description: "Card actions (submit, cancel, etc.)", type: "array" },
+        },
     },
     examples: [
-        "LOAD JSON FROM form('Contact Form', [{ id: 'name', type: 'text', label: 'Name', required: true }, { id: 'email', type: 'text', label: 'Email' }]) AS form RETURN form",
-        "LOAD JSON FROM form('Survey', [{ id: 'rating', type: 'dropdown', label: 'Rating', choices: ['1', '2', '3', '4', '5'] }, { id: 'subscribe', type: 'toggle', label: 'Subscribe', toggleTitle: 'Yes, send me updates' }], { submitButton: { title: 'Submit Survey', style: 'positive' } }) AS form RETURN form"
-    ]
+        "CALL form('Contact Form', [{ id: 'name', type: 'text', label: 'Name', required: true }, { id: 'email', type: 'text', label: 'Email' }]) YIELD type, body, actions",
+        "CALL form('Survey', [{ id: 'rating', type: 'dropdown', label: 'Rating', choices: ['1', '2', '3', '4', '5'] }, { id: 'subscribe', type: 'toggle', label: 'Subscribe', toggleTitle: 'Yes, send me updates' }], { submitButton: { title: 'Submit Survey', style: 'positive' } }) YIELD type, body, actions",
+    ],
 })
 export class Form extends AsyncFunction {
     /**
      * Creates an Adaptive Card form with the specified fields and configuration.
-     * 
+     *
      * @param title - Form title
      * @param fields - Array of field configurations
      * @param config - Optional form configuration
@@ -185,46 +193,46 @@ export class Form extends AsyncFunction {
         config: FormConfig
     ): AdaptiveCard {
         const card: AdaptiveCard = {
-            type: 'AdaptiveCard',
-            $schema: 'http://adaptivecards.io/schemas/adaptive-card.json',
-            version: config.version || '1.5',
+            type: "AdaptiveCard",
+            $schema: "http://adaptivecards.io/schemas/adaptive-card.json",
+            version: config.version || "1.5",
             body: [],
-            actions: []
+            actions: [],
         };
 
         // Add container with optional background style
         const container: AdaptiveCardElement = {
-            type: 'Container',
-            style: config.style || 'default',
-            items: []
+            type: "Container",
+            style: config.style || "default",
+            items: [],
         };
 
         // Add title
         container.items.push({
-            type: 'TextBlock',
+            type: "TextBlock",
             text: title,
-            weight: 'Bolder',
-            size: 'Large',
-            wrap: true
+            weight: "Bolder",
+            size: "Large",
+            wrap: true,
         });
 
         // Add description if provided
         if (config.description) {
             container.items.push({
-                type: 'TextBlock',
+                type: "TextBlock",
                 text: config.description,
                 isSubtle: true,
                 wrap: true,
-                spacing: 'Small'
+                spacing: "Small",
             });
         }
 
         // Add separator after header
         container.items.push({
-            type: 'TextBlock',
-            text: ' ',
+            type: "TextBlock",
+            text: " ",
             separator: true,
-            spacing: 'Medium'
+            spacing: "Medium",
         });
 
         // Add form fields
@@ -250,12 +258,12 @@ export class Form extends AsyncFunction {
         // Add label
         const labelText = field.required ? `${field.label} *` : field.label;
         elements.push({
-            type: 'TextBlock',
+            type: "TextBlock",
             text: labelText,
-            weight: field.labelStyle === 'heading' ? 'Bolder' : 'Default',
+            weight: field.labelStyle === "heading" ? "Bolder" : "Default",
             wrap: true,
             separator: field.separator || false,
-            spacing: field.separator ? 'Large' : 'Default'
+            spacing: field.separator ? "Large" : "Default",
         });
 
         // Add input based on type
@@ -270,36 +278,36 @@ export class Form extends AsyncFunction {
      */
     private createInputElement(field: FormFieldConfig): AdaptiveCardElement {
         switch (field.type) {
-            case 'text':
+            case "text":
                 return this.createTextInput(field, false);
-            
-            case 'textarea':
+
+            case "textarea":
                 return this.createTextInput(field, true);
-            
-            case 'number':
+
+            case "number":
                 return this.createNumberInput(field);
-            
-            case 'date':
+
+            case "date":
                 return this.createDateInput(field);
-            
-            case 'time':
+
+            case "time":
                 return this.createTimeInput(field);
-            
-            case 'datetime':
+
+            case "datetime":
                 return this.createDateTimeInputs(field);
-            
-            case 'toggle':
+
+            case "toggle":
                 return this.createToggleInput(field);
-            
-            case 'dropdown':
-                return this.createChoiceSet(field, 'compact');
-            
-            case 'radio':
-                return this.createChoiceSet(field, 'expanded');
-            
-            case 'checkbox':
-                return this.createChoiceSet(field, 'expanded', true);
-            
+
+            case "dropdown":
+                return this.createChoiceSet(field, "compact");
+
+            case "radio":
+                return this.createChoiceSet(field, "expanded");
+
+            case "checkbox":
+                return this.createChoiceSet(field, "expanded", true);
+
             default:
                 return this.createTextInput(field, false);
         }
@@ -310,11 +318,11 @@ export class Form extends AsyncFunction {
      */
     private createTextInput(field: FormFieldConfig, isMultiLine: boolean): AdaptiveCardElement {
         const input: AdaptiveCardElement = {
-            type: 'Input.Text',
+            type: "Input.Text",
             id: field.id,
-            placeholder: field.placeholder || '',
+            placeholder: field.placeholder || "",
             isMultiline: isMultiLine,
-            isRequired: field.required || false
+            isRequired: field.required || false,
         };
 
         if (field.defaultValue !== undefined) {
@@ -330,7 +338,7 @@ export class Form extends AsyncFunction {
         }
 
         if (isMultiLine) {
-            input.style = 'text';
+            input.style = "text";
         }
 
         return input;
@@ -341,10 +349,10 @@ export class Form extends AsyncFunction {
      */
     private createNumberInput(field: FormFieldConfig): AdaptiveCardElement {
         const input: AdaptiveCardElement = {
-            type: 'Input.Number',
+            type: "Input.Number",
             id: field.id,
-            placeholder: field.placeholder || '',
-            isRequired: field.required || false
+            placeholder: field.placeholder || "",
+            isRequired: field.required || false,
         };
 
         if (field.defaultValue !== undefined) {
@@ -371,9 +379,9 @@ export class Form extends AsyncFunction {
      */
     private createDateInput(field: FormFieldConfig): AdaptiveCardElement {
         const input: AdaptiveCardElement = {
-            type: 'Input.Date',
+            type: "Input.Date",
             id: field.id,
-            isRequired: field.required || false
+            isRequired: field.required || false,
         };
 
         if (field.defaultValue !== undefined) {
@@ -392,9 +400,9 @@ export class Form extends AsyncFunction {
      */
     private createTimeInput(field: FormFieldConfig): AdaptiveCardElement {
         const input: AdaptiveCardElement = {
-            type: 'Input.Time',
+            type: "Input.Time",
             id: field.id,
-            isRequired: field.required || false
+            isRequired: field.required || false,
         };
 
         if (field.defaultValue !== undefined) {
@@ -412,33 +420,39 @@ export class Form extends AsyncFunction {
      * Creates date and time inputs in a column set for datetime fields.
      */
     private createDateTimeInputs(field: FormFieldConfig): AdaptiveCardElement {
-        const dateValue = field.defaultValue ? String(field.defaultValue).split('T')[0] : undefined;
-        const timeValue = field.defaultValue ? String(field.defaultValue).split('T')[1]?.substring(0, 5) : undefined;
+        const dateValue = field.defaultValue ? String(field.defaultValue).split("T")[0] : undefined;
+        const timeValue = field.defaultValue
+            ? String(field.defaultValue).split("T")[1]?.substring(0, 5)
+            : undefined;
 
         return {
-            type: 'ColumnSet',
+            type: "ColumnSet",
             columns: [
                 {
-                    type: 'Column',
-                    width: 'stretch',
-                    items: [{
-                        type: 'Input.Date',
-                        id: `${field.id}_date`,
-                        isRequired: field.required || false,
-                        value: dateValue
-                    }]
+                    type: "Column",
+                    width: "stretch",
+                    items: [
+                        {
+                            type: "Input.Date",
+                            id: `${field.id}_date`,
+                            isRequired: field.required || false,
+                            value: dateValue,
+                        },
+                    ],
                 },
                 {
-                    type: 'Column',
-                    width: 'stretch',
-                    items: [{
-                        type: 'Input.Time',
-                        id: `${field.id}_time`,
-                        isRequired: field.required || false,
-                        value: timeValue
-                    }]
-                }
-            ]
+                    type: "Column",
+                    width: "stretch",
+                    items: [
+                        {
+                            type: "Input.Time",
+                            id: `${field.id}_time`,
+                            isRequired: field.required || false,
+                            value: timeValue,
+                        },
+                    ],
+                },
+            ],
         };
     }
 
@@ -447,16 +461,16 @@ export class Form extends AsyncFunction {
      */
     private createToggleInput(field: FormFieldConfig): AdaptiveCardElement {
         const input: AdaptiveCardElement = {
-            type: 'Input.Toggle',
+            type: "Input.Toggle",
             id: field.id,
             title: field.toggleTitle || field.label,
-            valueOn: 'true',
-            valueOff: 'false',
-            isRequired: field.required || false
+            valueOn: "true",
+            valueOff: "false",
+            isRequired: field.required || false,
         };
 
         if (field.defaultValue !== undefined) {
-            input.value = field.defaultValue ? 'true' : 'false';
+            input.value = field.defaultValue ? "true" : "false";
         }
 
         return input;
@@ -467,25 +481,25 @@ export class Form extends AsyncFunction {
      */
     private createChoiceSet(
         field: FormFieldConfig,
-        style: 'compact' | 'expanded',
+        style: "compact" | "expanded",
         isMultiSelect: boolean = false
     ): AdaptiveCardElement {
         const choices = this.normalizeChoices(field.choices || []);
 
         const input: AdaptiveCardElement = {
-            type: 'Input.ChoiceSet',
+            type: "Input.ChoiceSet",
             id: field.id,
             style: style,
             isMultiSelect: isMultiSelect,
             isRequired: field.required || false,
-            choices: choices
+            choices: choices,
         };
 
         if (field.defaultValue !== undefined) {
             input.value = String(field.defaultValue);
         }
 
-        if (field.placeholder && style === 'compact') {
+        if (field.placeholder && style === "compact") {
             input.placeholder = field.placeholder;
         }
 
@@ -495,9 +509,11 @@ export class Form extends AsyncFunction {
     /**
      * Normalizes choices to the expected format.
      */
-    private normalizeChoices(choices: Array<{ title: string; value: string }> | string[]): Array<{ title: string; value: string }> {
-        return choices.map(choice => {
-            if (typeof choice === 'string') {
+    private normalizeChoices(
+        choices: Array<{ title: string; value: string }> | string[]
+    ): Array<{ title: string; value: string }> {
+        return choices.map((choice) => {
+            if (typeof choice === "string") {
                 return { title: choice, value: choice };
             }
             return choice;
@@ -513,12 +529,12 @@ export class Form extends AsyncFunction {
         // Add submit button
         const submitConfig = config.submitButton || {};
         const submitAction: AdaptiveCardAction = {
-            type: this.getActionType(submitConfig.actionType || 'submit'),
-            title: submitConfig.title || 'Submit',
-            style: submitConfig.style || 'positive'
+            type: this.getActionType(submitConfig.actionType || "submit"),
+            title: submitConfig.title || "Submit",
+            style: submitConfig.style || "positive",
         };
 
-        if (submitConfig.actionType === 'openUrl' && submitConfig.url) {
+        if (submitConfig.actionType === "openUrl" && submitConfig.url) {
             submitAction.url = submitConfig.url;
         }
 
@@ -527,10 +543,10 @@ export class Form extends AsyncFunction {
         // Add reset button if requested
         if (config.showResetButton) {
             actions.push({
-                type: 'Action.Submit',
-                title: 'Reset',
-                style: 'default',
-                data: { action: 'reset' }
+                type: "Action.Submit",
+                title: "Reset",
+                style: "default",
+                data: { action: "reset" },
             });
         }
 
@@ -540,10 +556,10 @@ export class Form extends AsyncFunction {
                 const action: AdaptiveCardAction = {
                     type: this.getActionType(actionConfig.type),
                     title: actionConfig.title,
-                    style: actionConfig.style || 'default'
+                    style: actionConfig.style || "default",
                 };
 
-                if (actionConfig.type === 'openUrl' && actionConfig.url) {
+                if (actionConfig.type === "openUrl" && actionConfig.url) {
                     action.url = actionConfig.url;
                 }
 
@@ -563,14 +579,14 @@ export class Form extends AsyncFunction {
      */
     private getActionType(type: string): string {
         switch (type) {
-            case 'submit':
-                return 'Action.Submit';
-            case 'openUrl':
-                return 'Action.OpenUrl';
-            case 'showCard':
-                return 'Action.ShowCard';
+            case "submit":
+                return "Action.Submit";
+            case "openUrl":
+                return "Action.OpenUrl";
+            case "showCard":
+                return "Action.ShowCard";
             default:
-                return 'Action.Submit';
+                return "Action.Submit";
         }
     }
 }