@cyprnet/node-red-contrib-uibuilder-formgen 0.4.11

package/examples/portalsmith-formgen-example.json

@@ -0,0 +1,531 @@
+[
+  {
+    "id": "formgen-example-flow",
+    "type": "tab",
+    "label": "PortalSmith FormGen Example",
+    "disabled": false,
+    "info": "Example flow demonstrating PortalSmith form generation and message handling.\n\nSETUP:\n1. Inject node provides schema and triggers generation\n2. uibuilder-formgen node generates the portal\n3. IMPORTANT: You must add a uibuilder node manually:\n   - Drag a uibuilder node onto the flow\n   - Configure: name='form-jobapp', url='form-jobapp', sourceFolder='src'\n   - Connect uibuilder OUTPUT to 'message-router' INPUT\n   - Connect response nodes OUTPUT to uibuilder INPUT:\n     * 'send-draft-response' output → uibuilder input\n     * 'submit-success-response' output → uibuilder input\n     * 'export-success-response' output → uibuilder input\n\nMESSAGE FLOW:\n- Frontend → uibuilder node → message-router → handlers → file nodes\n- Response handlers → uibuilder node → Frontend (via websocket)\n\nACTIONS:\n- Save Draft: saves to localStorage + sends draft:save to Node-RED\n- Load Draft: loads from localStorage or requests from Node-RED\n- Submit: validates form, sends submit message, waits for submit:ok\n- Export: sends export message, receives export:file with download link\n- CopyBlock: renders template with form data, copies to clipboard",
+    "env": []
+  },
+  {
+    "id": "inject-schema",
+    "type": "inject",
+    "z": "formgen-example-flow",
+    "name": "Generate Job App Form",
+    "props": [
+      {
+        "p": "payload"
+      },
+      {
+        "p": "schema",
+        "v": "",
+        "vt": "json"
+      },
+      {
+        "p": "uibuilder",
+        "v": "form-jobapp",
+        "vt": "str"
+      },
+      {
+        "p": "options",
+        "v": "{\"overwrite\":true,\"storageMode\":\"file\",\"exportFormats\":[\"json\",\"csv\",\"html\"]}",
+        "vt": "json"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payload": "",
+    "payloadType": "date",
+    "x": 150,
+    "y": 100,
+    "wires": [
+      [
+        "load-schema-file"
+      ]
+    ]
+  },
+  {
+    "id": "load-schema-file",
+    "type": "file in",
+    "z": "formgen-example-flow",
+    "name": "Load Schema",
+    "filename": "/home/david/dev/portalsmith/node-red-contrib-uibuilder-formgen/examples/schemas/job_application.json",
+    "format": "utf8",
+    "chunk": false,
+    "sendError": false,
+    "encoding": "none",
+    "allProps": false,
+    "x": 350,
+    "y": 100,
+    "wires": [
+      [
+        "parse-schema"
+      ]
+    ]
+  },
+  {
+    "id": "parse-schema",
+    "type": "function",
+    "z": "formgen-example-flow",
+    "name": "Parse Schema",
+    "func": "// Parse the schema file and set msg.schema\nmsg.schema = JSON.parse(msg.payload);\nreturn msg;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 550,
+    "y": 100,
+    "wires": [
+      [
+        "uibuilder-formgen-node"
+      ]
+    ]
+  },
+  {
+    "id": "uibuilder-formgen-node",
+    "type": "uibuilder-formgen",
+    "z": "formgen-example-flow",
+    "name": "Generate Portal",
+    "uibuilderUrl": "/uibuilder",
+    "instanceName": "formgen",
+    "overwrite": true,
+    "storageMode": "file",
+    "exportFormats": "[\"json\",\"csv\",\"html\"]",
+    "x": 750,
+    "y": 100,
+    "wires": [
+      [
+        "debug-output"
+      ]
+    ]
+  },
+  {
+    "id": "debug-output",
+    "type": "debug",
+    "z": "formgen-example-flow",
+    "name": "Generation Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "payload",
+    "targetType": "full",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 950,
+    "y": 100,
+    "wires": []
+  },
+  {
+    "id": "message-router",
+    "type": "switch",
+    "z": "formgen-example-flow",
+    "name": "Route by Type",
+    "property": "payload.type",
+    "propertyType": "msg",
+    "rules": [
+      {
+        "t": "eq",
+        "v": "draft:save",
+        "vt": "str"
+      },
+      {
+        "t": "eq",
+        "v": "draft:get",
+        "vt": "str"
+      },
+      {
+        "t": "eq",
+        "v": "submit",
+        "vt": "str"
+      },
+      {
+        "t": "eq",
+        "v": "export",
+        "vt": "str"
+      }
+    ],
+    "checkall": "true",
+    "repair": false,
+    "outputs": 4,
+    "x": 150,
+    "y": 200,
+    "wires": [
+      [
+        "save-draft"
+      ],
+      [
+        "get-draft"
+      ],
+      [
+        "handle-submit"
+      ],
+      [
+        "handle-export"
+      ]
+    ]
+  },
+  {
+    "id": "save-draft",
+    "type": "function",
+    "z": "formgen-example-flow",
+    "name": "Prepare Draft Save",
+    "func": "// Prepare draft file path\n// NOTE: Update userDir path to match your Node-RED userDir\n// You can find it in Node-RED settings or use: RED.settings.userDir\nconst formId = msg.payload.formId || 'unknown';\nconst userDir = process.env.NODE_RED_HOME || process.env.HOME + '/.node-red';\nconst draftsDir = userDir + '/portalsmith/drafts';\n\nmsg.filename = draftsDir + '/' + formId + '.json';\nmsg.payload = msg.payload.payload || msg.payload.data || {};\n\nreturn msg;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 550,
+    "y": 160,
+    "wires": [
+      [
+        "ensure-drafts-dir",
+        "file-write-draft"
+      ]
+    ]
+  },
+  {
+    "id": "ensure-drafts-dir",
+    "type": "function",
+    "z": "formgen-example-flow",
+    "name": "Ensure Dir",
+    "func": "const fs = require('fs-extra');\nconst path = require('path');\nconst dir = path.dirname(msg.filename);\nfs.ensureDirSync(dir);\nreturn msg;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 750,
+    "y": 160,
+    "wires": [
+      [
+        "file-write-draft"
+      ]
+    ]
+  },
+  {
+    "id": "file-write-draft",
+    "type": "file",
+    "z": "formgen-example-flow",
+    "name": "Write Draft",
+    "filename": "",
+    "appendNewline": true,
+    "createDir": true,
+    "overwriteFile": "true",
+    "encoding": "utf8",
+    "x": 950,
+    "y": 160,
+    "wires": [
+      [
+        "draft-saved-response"
+      ]
+    ]
+  },
+  {
+    "id": "draft-saved-response",
+    "type": "function",
+    "z": "formgen-example-flow",
+    "name": "Draft Saved",
+    "func": "// Draft saved successfully\nnode.warn('Draft saved: ' + msg.filename);\nreturn null;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 1150,
+    "y": 160,
+    "wires": [
+      []
+    ]
+  },
+  {
+    "id": "get-draft",
+    "type": "function",
+    "z": "formgen-example-flow",
+    "name": "Prepare Draft Get",
+    "func": "// Prepare draft file path\n// NOTE: Update userDir path to match your Node-RED userDir\nconst formId = msg.payload.formId || 'unknown';\nconst userDir = process.env.NODE_RED_HOME || process.env.HOME + '/.node-red';\nconst draftsDir = userDir + '/portalsmith/drafts';\n\nmsg.filename = draftsDir + '/' + formId + '.json';\n\nreturn msg;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 550,
+    "y": 200,
+    "wires": [
+      [
+        "file-read-draft"
+      ]
+    ]
+  },
+  {
+    "id": "file-read-draft",
+    "type": "file in",
+    "z": "formgen-example-flow",
+    "name": "Read Draft",
+    "filename": "",
+    "format": "utf8",
+    "chunk": false,
+    "sendError": false,
+    "encoding": "none",
+    "allProps": false,
+    "x": 750,
+    "y": 200,
+    "wires": [
+      [
+        "send-draft-response"
+      ]
+    ]
+  },
+  {
+    "id": "send-draft-response",
+    "type": "function",
+    "z": "formgen-example-flow",
+    "name": "Send Draft Response",
+    "func": "// Parse draft and send back to uibuilder\n// Get formId from the original request (stored in flow context or from filename)\nconst filename = msg.filename || '';\nconst formIdMatch = filename.match(/([^/]+)\\.json$/);\nconst formId = formIdMatch ? formIdMatch[1] : 'unknown';\n\ntry {\n    const draftData = JSON.parse(msg.payload);\n    \n    // Send back to uibuilder instance\n    return {\n        payload: {\n            type: 'draft',\n            formId: formId,\n            data: draftData.data || draftData\n        }\n    };\n} catch (e) {\n    node.error('Failed to parse draft: ' + e.message);\n    return null;\n}",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 950,
+    "y": 200,
+    "wires": [
+      []
+    ]
+  },
+  {
+    "id": "handle-submit",
+    "type": "function",
+    "z": "formgen-example-flow",
+    "name": "Prepare Submit",
+    "func": "// Prepare submission file path\n// NOTE: Update userDir path to match your Node-RED userDir\nconst formId = msg.payload.formId || 'unknown';\nconst userDir = process.env.NODE_RED_HOME || process.env.HOME + '/.node-red';\nconst submissionsDir = userDir + '/portalsmith/submissions';\n\n// Create NDJSON entry\nconst submission = {\n    formId: formId,\n    timestamp: msg.payload.meta?.timestamp || new Date().toISOString(),\n    userAgent: msg.payload.meta?.userAgent || 'unknown',\n    data: msg.payload.payload || {}\n};\n\nmsg.filename = submissionsDir + '/' + formId + '.ndjson';\nmsg.payload = JSON.stringify(submission) + '\\n';\n\nreturn msg;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 550,
+    "y": 240,
+    "wires": [
+      [
+        "ensure-submissions-dir",
+        "file-append-submission"
+      ]
+    ]
+  },
+  {
+    "id": "ensure-submissions-dir",
+    "type": "function",
+    "z": "formgen-example-flow",
+    "name": "Ensure Dir",
+    "func": "const fs = require('fs-extra');\nconst path = require('path');\nconst dir = path.dirname(msg.filename);\nfs.ensureDirSync(dir);\nreturn msg;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 750,
+    "y": 240,
+    "wires": [
+      [
+        "file-append-submission"
+      ]
+    ]
+  },
+  {
+    "id": "file-append-submission",
+    "type": "file",
+    "z": "formgen-example-flow",
+    "name": "Append Submission",
+    "filename": "",
+    "appendNewline": false,
+    "createDir": true,
+    "overwriteFile": "false",
+    "encoding": "utf8",
+    "x": 950,
+    "y": 240,
+    "wires": [
+      [
+        "submit-success-response"
+      ]
+    ]
+  },
+  {
+    "id": "submit-success-response",
+    "type": "function",
+    "z": "formgen-example-flow",
+    "name": "Submit Success",
+    "func": "// Submission saved successfully\nnode.warn('Submission saved: ' + msg.filename);\n\n// Extract formId from filename\nconst filename = msg.filename || '';\nconst formIdMatch = filename.match(/([^/]+)\\.ndjson$/);\nconst formId = formIdMatch ? formIdMatch[1] : 'unknown';\n\n// Send confirmation back to uibuilder\nreturn {\n    payload: {\n        type: 'submit:ok',\n        formId: formId,\n        message: 'Submission received successfully'\n    }\n};",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 1150,
+    "y": 240,
+    "wires": [
+      []
+    ]
+  },
+  {
+    "id": "handle-export",
+    "type": "switch",
+    "z": "formgen-example-flow",
+    "name": "Route Export Format",
+    "property": "payload.format",
+    "propertyType": "msg",
+    "rules": [
+      {
+        "t": "eq",
+        "v": "json",
+        "vt": "str"
+      },
+      {
+        "t": "eq",
+        "v": "csv",
+        "vt": "str"
+      },
+      {
+        "t": "eq",
+        "v": "html",
+        "vt": "str"
+      }
+    ],
+    "checkall": "true",
+    "repair": false,
+    "outputs": 3,
+    "x": 550,
+    "y": 280,
+    "wires": [
+      [
+        "export-json"
+      ],
+      [
+        "export-csv"
+      ],
+      [
+        "export-html"
+      ]
+    ]
+  },
+  {
+    "id": "export-json",
+    "type": "function",
+    "z": "formgen-example-flow",
+    "name": "Export JSON",
+    "func": "// NOTE: Update userDir path to match your Node-RED userDir\nconst formId = msg.payload.formId || 'unknown';\nconst format = 'json';\nconst userDir = process.env.NODE_RED_HOME || process.env.HOME + '/.node-red';\nconst exportsDir = userDir + '/portalsmith/exports';\nconst timestamp = new Date().toISOString().replace(/[:.]/g, '-');\nconst filename = `${formId}_${timestamp}.json`;\n\nmsg.filename = exportsDir + '/' + filename;\nmsg.payload = JSON.stringify(msg.payload.payload || {}, null, 2);\n\nreturn msg;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 750,
+    "y": 260,
+    "wires": [
+      [
+        "ensure-exports-dir",
+        "file-write-export"
+      ]
+    ]
+  },
+  {
+    "id": "export-csv",
+    "type": "function",
+    "z": "formgen-example-flow",
+    "name": "Export CSV",
+    "func": "// NOTE: Update userDir path to match your Node-RED userDir\nconst formId = msg.payload.formId || 'unknown';\nconst format = 'csv';\nconst userDir = process.env.NODE_RED_HOME || process.env.HOME + '/.node-red';\nconst exportsDir = userDir + '/portalsmith/exports';\nconst timestamp = new Date().toISOString().replace(/[:.]/g, '-');\nconst filename = `${formId}_${timestamp}.csv`;\n\nconst data = msg.payload.payload || {};\nconst keys = Object.keys(data);\nconst values = keys.map(k => {\n    const v = data[k];\n    if (typeof v === 'object') return JSON.stringify(v);\n    return String(v).replace(/\"/g, '\"\"');\n});\n\n// Simple CSV: header row + data row\nmsg.filename = exportsDir + '/' + filename;\nmsg.payload = '\"' + keys.join('\",\"') + '\\n\"' + values.join('\",\"') + '\"';\n\nreturn msg;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 750,
+    "y": 280,
+    "wires": [
+      [
+        "ensure-exports-dir",
+        "file-write-export"
+      ]
+    ]
+  },
+  {
+    "id": "export-html",
+    "type": "function",
+    "z": "formgen-example-flow",
+    "name": "Export HTML",
+    "func": "// NOTE: Update userDir path to match your Node-RED userDir\nconst formId = msg.payload.formId || 'unknown';\nconst format = 'html';\nconst userDir = process.env.NODE_RED_HOME || process.env.HOME + '/.node-red';\nconst exportsDir = userDir + '/portalsmith/exports';\nconst timestamp = new Date().toISOString().replace(/[:.]/g, '-');\nconst filename = `${formId}_${timestamp}.html`;\n\nconst data = msg.payload.payload || {};\n\n// Simple printable HTML\nlet html = '<!DOCTYPE html>\\n<html>\\n<head>\\n<meta charset=\"utf-8\">\\n<title>Form Export</title>\\n<style>body{font-family:Arial,sans-serif;padding:20px;}table{border-collapse:collapse;width:100%;}th,td{border:1px solid #ddd;padding:8px;text-align:left;}th{background-color:#f2f2f2;}</style>\\n</head>\\n<body>\\n<h1>Form Export</h1>\\n<table>\\n';\n\nfor (const [key, value] of Object.entries(data)) {\n    html += `<tr><th>${escapeHtml(String(key))}</th><td>${escapeHtml(String(value))}</td></tr>\\n`;\n}\n\nhtml += '</table>\\n</body>\\n</html>';\n\nfunction escapeHtml(s) {\n    return String(s).replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/\"/g, '&quot;').replace(/'/g, '&#039;');\n}\n\nmsg.filename = exportsDir + '/' + filename;\nmsg.payload = html;\n\nreturn msg;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 750,
+    "y": 300,
+    "wires": [
+      [
+        "ensure-exports-dir",
+        "file-write-export"
+      ]
+    ]
+  },
+  {
+    "id": "ensure-exports-dir",
+    "type": "function",
+    "z": "formgen-example-flow",
+    "name": "Ensure Dir",
+    "func": "const fs = require('fs-extra');\nconst path = require('path');\nconst dir = path.dirname(msg.filename);\nfs.ensureDirSync(dir);\nreturn msg;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 950,
+    "y": 280,
+    "wires": [
+      [
+        "file-write-export"
+      ]
+    ]
+  },
+  {
+    "id": "file-write-export",
+    "type": "file",
+    "z": "formgen-example-flow",
+    "name": "Write Export",
+    "filename": "",
+    "appendNewline": true,
+    "createDir": true,
+    "overwriteFile": "true",
+    "encoding": "utf8",
+    "x": 1150,
+    "y": 280,
+    "wires": [
+      [
+        "export-success-response"
+      ]
+    ]
+  },
+  {
+    "id": "export-success-response",
+    "type": "function",
+    "z": "formgen-example-flow",
+    "name": "Export Success",
+    "func": "// Export saved successfully\nconst filename = msg.filename.split('/').pop();\nconst format = filename.split('.').pop();\n\nnode.warn('Export saved: ' + msg.filename);\n\n// Send file info back to uibuilder\nreturn {\n    payload: {\n        type: 'export:file',\n        format: format,\n        filename: filename,\n        path: msg.filename\n    }\n};",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 1350,
+    "y": 280,
+    "wires": [
+      []
+    ]
+  }
+]
+

package/examples/schema-builder-integration.json

@@ -0,0 +1,109 @@
+[
+  {
+    "id": "schema-builder-flow",
+    "type": "tab",
+    "label": "Schema Builder Integration",
+    "disabled": false,
+    "info": "Example flow showing how to connect the schema builder to the formgen node.\n\nSETUP:\n1. Add a uibuilder node for 'formgen-builder' instance\n2. Add a uibuilder node for your target form instance (e.g., 'form-jobapp')\n3. Connect builder uibuilder OUTPUT to 'builder-router' INPUT\n4. Connect 'generate-form' OUTPUT to target uibuilder INPUT (for formgen node)\n5. Connect formgen node OUTPUT to builder uibuilder INPUT (for success response)\n\nFLOW:\n- Builder sends {type: 'generate', schema: {...}} to Node-RED\n- Router forwards to formgen node\n- Formgen generates form and sends response back\n- Response sent back to builder for confirmation",
+    "env": []
+  },
+  {
+    "id": "builder-router",
+    "type": "switch",
+    "z": "schema-builder-flow",
+    "name": "Route Builder Messages",
+    "property": "payload.type",
+    "propertyType": "msg",
+    "rules": [
+      {
+        "t": "eq",
+        "v": "generate",
+        "vt": "str"
+      }
+    ],
+    "checkall": "true",
+    "repair": false,
+    "outputs": 1,
+    "x": 350,
+    "y": 100,
+    "wires": [
+      [
+        "prepare-formgen"
+      ]
+    ]
+  },
+  {
+    "id": "prepare-formgen",
+    "type": "function",
+    "z": "schema-builder-flow",
+    "name": "Prepare for FormGen",
+    "func": "// Extract schema from builder message\n// Builder sends: {type: 'generate', schema: {...}}\n// FormGen expects: msg.schema or msg.payload\n\nmsg.schema = msg.payload.schema || msg.payload;\nmsg.uibuilder = msg.uibuilder || msg.targetInstance || 'form-jobapp'; // Target instance\nmsg.options = {\n    overwrite: true,\n    storageMode: 'file',\n    exportFormats: ['json', 'csv', 'html']\n};\n\nreturn msg;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 550,
+    "y": 100,
+    "wires": [
+      [
+        "uibuilder-formgen-node"
+      ]
+    ]
+  },
+  {
+    "id": "uibuilder-formgen-node",
+    "type": "uibuilder-formgen",
+    "z": "schema-builder-flow",
+    "name": "Generate Form",
+    "uibuilderUrl": "/uibuilder",
+    "instanceName": "form-jobapp",
+    "overwrite": true,
+    "storageMode": "file",
+    "exportFormats": "[\"json\",\"csv\",\"html\"]",
+    "x": 750,
+    "y": 100,
+    "wires": [
+      [
+        "format-response"
+      ]
+    ]
+  },
+  {
+    "id": "format-response",
+    "type": "function",
+    "z": "schema-builder-flow",
+    "name": "Format Response",
+    "func": "// Format response for builder\n// Send back to builder uibuilder instance\n\nreturn {\n    payload: {\n        type: 'generated',\n        status: msg.payload.status,\n        instance: msg.payload.instance,\n        url: msg.payload.url,\n        path: msg.payload.path,\n        files: msg.payload.files,\n        schemaSummary: msg.payload.schemaSummary\n    }\n};",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 950,
+    "y": 100,
+    "wires": [
+      [
+        "debug-output"
+      ]
+    ]
+  },
+  {
+    "id": "debug-output",
+    "type": "debug",
+    "z": "schema-builder-flow",
+    "name": "Generation Result",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "payload",
+    "targetType": "full",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 1150,
+    "y": 100,
+    "wires": []
+  }
+]
+