@flowfuse/nr-assistant 0.1.0

package/.eslintrc

@@ -0,0 +1,32 @@
+{
+    "root": true,
+    "globals": {
+        "monaco": true,
+        "RED": true
+    },
+    "env": {
+        "browser": true,
+        "commonjs": true,
+        "es2021": true,
+        "mocha": true,
+        "jquery": true
+    },
+    "extends": [
+        "eslint:recommended", 
+        "standard"
+    ],
+    "plugins": [ "eslint-plugin-html", "no-only-tests" ],
+    "parserOptions": {
+        "ecmaVersion": 12
+    },
+    "rules": {
+        // Built-in rules
+        "indent": ["error", 4],
+        "object-shorthand": ["error"],
+        "no-console": ["error", { "allow": ["debug", "info", "warn", "error"] }],
+
+        // plugin:no-only-tests
+        "no-only-tests/no-only-tests": "error"
+
+    }
+}

package/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

package/.github/workflows/project-automation.yml

@@ -0,0 +1,10 @@
+name: Project automations
+on:
+  issues:
+    types:
+      - opened
+jobs:
+  add_to_product_board:
+    uses: flowfuse/.github/.github/workflows/project-automation.yml@main
+    secrets:
+      token: ${{ secrets.PROJECT_ACCESS_TOKEN }}

package/.github/workflows/release-publish.yml

@@ -0,0 +1,19 @@
+name: Release Published
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 16
+      - run: npm ci --omit=dev
+      - uses: JS-DevTools/npm-publish@v3
+        with:
+          token: ${{ secrets.NPM_PUBLISH_TOKEN }}
+          access: public

package/LICENSE

@@ -0,0 +1,178 @@
+Copyright (c) 2024-present FlowForge Inc, and other contributors, https://flowfuse.com/
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,53 @@
+# FlowFuse Node-RED Assistant
+
+A Node-RED plugin to assist FlowFuse users
+
+
+## Installation
+
+```bash
+npm install @flowfuse/nr-assistant
+```
+
+## Development
+
+Client-side portion of the plugin is in `index.js`. The server side code is in `index.js`
+
+## About
+
+This plugin is designed to assist users of the FlowFuse platform by providing tools to aid development of their Node-RED project.
+
+The capabilities it adds to Node-RED can be found in Node-RED editor on the main toolbar and within the function node editor.
+
+## NOTES:
+* Requires the settings.js file to contain the following:
+```json
+{
+    "flowforge": {
+        "assistant": {
+            "enabled": true
+            "url": "https://", // URL of the AI service
+            "token": "", // API token for the AI service
+            "requestTimeout": 60000 // Timeout value for the AI service request
+        }
+    }
+}
+```
+
+
+## Limitations
+
+* Only function node generation is currently supported.
+* Only a single function node can be generated at a time.
+* The codelens feature is only supported for the on-message editor.
+
+## Versioning
+
+While in development, the version number of this package will remain at `0.x.y`.
+`x` will be incremented for breaking changes, `y` for new features and patches.
+
+Once plugin and API are stable, the version number will be updated to 1.0.0 and full SemVer rules will be applied.
+
+## License
+
+Apache-2.0

package/index.html

@@ -0,0 +1,563 @@
+<script>
+    (function (RED, n) {
+        'use strict'
+        const AI_TIMEOUT = 90000 // default request timeout in milliseconds
+        const modulesAllowed = RED.settings.functionExternalModules !== false
+        const assistantOptions = {
+            enabled: false,
+            requestTimeout: AI_TIMEOUT
+        }
+        let assistantInitialised = false
+        debug('nr-assistant loading...')
+        RED.plugins.registerPlugin('flowfuse-nr-assistant', {
+            type: 'assistant',
+            name: 'Node-RED Assistant Plugin',
+            icon: 'font-awesome/fa-magic',
+            onadd: async function () {
+                RED.comms.subscribe('nr-assistant/#', (topic, msg) => {
+                    debug('comms', topic, msg)
+                    if (topic === 'nr-assistant/initialise') {
+                        assistantOptions.enabled = !!msg?.enabled
+                        assistantOptions.requestTimeout = msg?.requestTimeout || AI_TIMEOUT
+                        initAssistant(msg)
+                    }
+                })
+            }
+        })
+
+        function initAssistant () {
+            if (assistantInitialised) {
+                return
+            }
+            debug('nr-assistant initialising...')
+            if (!assistantOptions.enabled) {
+                console.warn('The FlowFuse Assistant is not enabled')
+                return
+            }
+
+            if (!window.monaco) {
+                console.warn('Monaco editor not found. Unable to register code lens provider. Consider using the Monaco editor for a better experience.')
+                return
+            } else {
+                const commandId = 'nr-assistant-fn-inline'
+                monaco.languages.registerCodeLensProvider('javascript', {
+                    provideCodeLenses: function (model, token) {
+                        const thisEditor = getMonacoEditorForModel(model)
+                        if (!thisEditor) {
+                            return
+                        }
+                        const node = RED.view.selection()?.nodes?.[0]
+
+                        // only support function nodes for now
+                        if (!node || !node.type === 'function') {
+                            return
+                        }
+                        // Only support the "on message" editor for now
+                        // determine which editor is active and if it the "on message" editor
+                        // if not, return nothing to prevent the code lens from showing
+                        let isFuncTabEditor
+                        let el = thisEditor.getDomNode()
+                        while (el && el.tagName !== 'FORM') {
+                            if (el.id === 'node-input-func-editor' || el.id === 'func-tab-body') {
+                                isFuncTabEditor = true
+                                break
+                            }
+                            el = el.parentNode
+                        }
+                        if (!isFuncTabEditor) {
+                            return
+                        }
+
+                        return {
+                            lenses: [
+                                {
+                                    range: {
+                                        startLineNumber: 1,
+                                        startColumn: 1,
+                                        endLineNumber: 2,
+                                        endColumn: 1
+                                    },
+                                    id: commandId
+                                }
+                            ],
+                            dispose: () => { }
+                        }
+                    },
+                    resolveCodeLens: function (model, codeLens, token) {
+                        if (codeLens.id !== commandId) {
+                            return codeLens
+                        }
+                        codeLens.command = {
+                            id: codeLens.id,
+                            title: 'Ask the FlowFuse Assistant 🪄',
+                            tooltip: 'Click to ask FlowFuse Assistant for help writing code',
+                            arguments: [model, codeLens, token]
+                        }
+                        return codeLens
+                    }
+                })
+
+                let previousPrompt = null
+                monaco.editor.registerCommand(commandId, function (accessor, model, codeLens, token) {
+                    const node = RED.view.selection()?.nodes?.[0]
+                    if (!node) {
+                        console.warn('No node selected') // should not happen
+                        return
+                    }
+                    if (!assistantOptions.enabled) {
+                        RED.notify('The FlowFuse Assistant is not enabled', 'warning')
+                        return
+                    }
+                    let xhr = null
+                    const nodeId = node.id
+                    const transactionId = `${nodeId}-${Date.now()}` // a unique id for this transaction
+                    const thisEditor = getMonacoEditorForModel(model)
+                    if (thisEditor) {
+                        if (!document.body.contains(thisEditor.getDomNode())) {
+                            console.warn('Editor is no longer in the DOM, cannot proceed.')
+                            return
+                        }
+                        // walk up the tree to find the parent div with an id and include that in context
+                        let parent = thisEditor.getDomNode().parentNode
+                        while (parent?.tagName !== 'FORM') {
+                            if (parent.id) {
+                                break
+                            }
+                            parent = parent.parentNode
+                        }
+                        // const editorSection = parent?.id || '' // FUTURE: determine the code section users code lens was triggered in. Will be used to help the assistant understand the context of the code
+                        const editorSection = 'on message' // hard coded for now since the code lens is only available in the "on message" editor in this first iteration
+
+                        // FUTURE: for including selected text in the context for features like "fix my code", "refactor this", "what is this?" etc
+                        // const userSelection = triggeredEditor.getSelection()
+                        // const selectedText = model.getValueInRange(userSelection)
+
+                        getUserInput({
+                            defaultInput: previousPrompt,
+                            title: 'FlowFuse Assistant : Function Code',
+                            explanation: 'The FlowFuse Assistant can help you write code.',
+                            description: 'Enter a short description of what you want the function to do.'
+                        }).then((prompt) => {
+                            if (prompt) {
+                                previousPrompt = prompt
+                                const data = {
+                                    prompt,
+                                    transactionId,
+                                    context: {
+                                        scope: 'inline', // inline denotes that the prompt is for a inline code (i.e. the monaco editor)
+                                        modulesAllowed,
+                                        codeSection: editorSection
+                                        // selection: selectedText // FUTURE: include the selected text in the context for features like "fix my code", "refactor this", "what is this?" etc
+                                    }
+                                }
+                                const busyNotification = showBusyNotification('Busy processing your request. Please wait...', function () {
+                                    if (xhr) {
+                                        xhr.abort('abort')
+                                        xhr = null
+                                    }
+                                })
+                                xhr = $.ajax({
+                                    url: 'nr-assistant/function', // /function denotes this is a request for NODE JavaScript code
+                                    type: 'POST',
+                                    data,
+                                    success: function (reply, textStatus, jqXHR) {
+                                        const responseData = reply?.data?.data
+                                        if (responseData?.func?.length > 0) {
+                                            const currentSelection = thisEditor.getSelection()
+                                            // ensure the editor is still present in the DOM
+                                            if (!document.body.contains(thisEditor.getDomNode())) {
+                                                console.warn('Editor is no longer in the DOM')
+                                                return
+                                            }
+                                            busyNotification.close()
+                                            thisEditor.focus()
+                                            // insert the generated code at the current cursor position overwriting any selected text
+                                            thisEditor.executeEdits('', [
+                                                {
+                                                    range: new monaco.Range(currentSelection.startLineNumber, currentSelection.startColumn, currentSelection.endLineNumber, currentSelection.endColumn),
+                                                    text: responseData.func
+                                                }
+                                            ])
+                                            // update the nodes output count the AI suggests a different number of outputs
+                                            if (typeof responseData?.outputs === 'number' && responseData.outputs >= 0) {
+                                                const outputsField = $('#node-input-outputs')
+                                                const currentOutputs = parseInt(outputsField.val())
+                                                if (!isNaN(currentOutputs) && typeof currentOutputs === 'number' && currentOutputs !== responseData.outputs) {
+                                                    outputsField.val(responseData.outputs)
+                                                    outputsField.trigger('change')
+                                                }
+                                            }
+
+                                            // update libs - get the current list of libs then scan the response for any new ones
+                                            // if the lib is not already in the list, add it
+                                            if (modulesAllowed) {
+                                                if (Array.isArray(responseData?.node_modules) && responseData.node_modules.length > 0) {
+                                                    const _libs = []
+                                                    const libs = $('#node-input-libs-container').editableList('items')
+                                                    libs.each(function (i) {
+                                                        const item = $(this)
+                                                        const v = item.find('.node-input-libs-var').val()
+                                                        let n = item.find('.node-input-libs-val').typedInput('type')
+                                                        if (n === '_custom_') {
+                                                            n = item.find('.node-input-libs-val').val()
+                                                        }
+                                                        if ((!v || (v === '')) ||
+                                                            (!n || (n === ''))) {
+                                                            return
+                                                        }
+                                                        _libs.push({
+                                                            var: v,
+                                                            module: n
+                                                        })
+                                                    })
+
+                                                    responseData.node_modules.forEach((lib) => {
+                                                        const existing = _libs.find(l => l.module === lib.module)
+                                                        if (!existing) {
+                                                            $('#node-input-libs-container').editableList('addItem', { var: lib.var, module: lib.module })
+                                                        }
+                                                    })
+                                                }
+                                            }
+                                        } else {
+                                            processAIErrorResponse(jqXHR, textStatus, 'No response from server')
+                                        }
+                                    },
+                                    error: (jqXHR, textStatus, errorThrown) => {
+                                        busyNotification.close()
+                                        if (textStatus === 'abort' || errorThrown === 'abort' || jqXHR.statusText === 'abort') {
+                                            // user cancelled
+                                            return
+                                        }
+                                        processAIErrorResponse(jqXHR, textStatus, errorThrown)
+                                    }
+                                })
+                            }
+                        })
+                    } else {
+                        console.warn('Could not find editor for model', model.uri.toString())
+                    }
+                })
+            }
+
+            // setup actions for function builder
+            const funcBuilderTitle = 'FlowFuse Function Node Assistant'
+            RED.actions.add('ff:nr-assistant-function-builder', showFunctionBuilderPrompt, { label: funcBuilderTitle })
+
+            // FUTURE: setup actions for flow builder
+            // const flowBuilderTitle = 'FlowFuse Flow Assistant'
+            // RED.actions.add('ff:nr-assistant-flow-builder', showFlowBuilderPrompt, { label: flowBuilderTitle })
+
+            // Add toolbar button
+            const toolbarMenuButton = $('<li><a id="red-ui-header-button-ff-ai" class="button fa fa-magic" href="#"></a></li>')
+            toolbarMenuButton.prependTo('.red-ui-header-toolbar')
+            toolbarMenuButton.on('click', function (e) {
+                RED.actions.invoke('ff:nr-assistant-function-builder')
+            })
+            RED.popover.tooltip(toolbarMenuButton, 'FlowFuse Assistant')
+            assistantInitialised = true
+        }
+
+        function getUserInput ({ title, explanation, description, placeholder, defaultInput } = {
+            title: 'FlowFuse Assistant',
+            explanation: 'The FlowFuse Assistant can help you create things.',
+            description: 'Enter a short description explaining what you want it to do.',
+            placeholder: '',
+            defaultInput: ''
+        }) {
+            const bodyText = []
+            if (explanation) {
+                bodyText.push(`<p style="">${explanation}</p>`)
+            }
+            if (description) {
+                bodyText.push(`<p>${description}</p>`)
+            }
+            const body = bodyText.join('')
+            return new Promise((resolve, reject) => {
+                const dialog = $('<div id="ff-nr-ai-dialog-input" class="hide red-ui-editor"></div>')
+                const containerDiv = $('<div style="height: 100%;display: flex;flex-direction: column; height: calc(100% - 12px);">')
+                if (body) {
+                    containerDiv.append('<div style="margin-bottom: 8px; margin-top: -10px">' + body + '</div>')
+                }
+                const form = $('<form id="ff-nr-ai-dialog-input-fields" style="flex-grow: 1; margin-bottom: 6px;"></form>')
+                const input = $('<textarea id="ff-nr-ai-dialog-input-editor" style="height:100%;width:100%; position:relative; resize: none;" maxlength="400" placeholder="' + (placeholder || '') + '">' + (defaultInput || '') + '</textarea>')
+                form.append(input)
+                containerDiv.append(form)
+                dialog.append(containerDiv)
+                const minHeight = 260 + (description ? 32 : 0) + (explanation ? 32 : 0)
+                const minWidth = 480
+                dialog.dialog({
+                    autoOpen: true,
+                    title: title || 'FlowFuse Assistant',
+                    modal: true,
+                    closeOnEscape: true,
+                    height: minHeight,
+                    width: minWidth,
+                    minHeight,
+                    minWidth,
+                    resizable: true,
+                    draggable: true,
+                    open: function (event, ui) {
+                        RED.keyboard.disable()
+                        input.focus()
+                        input.select()
+                    },
+                    close: function (event, ui) {
+                        RED.keyboard.enable()
+                    },
+                    buttons: [
+                        {
+                            text: 'Ask the FlowFuse Assistant 🪄',
+                            // class: 'primary',
+                            click: function () {
+                                const prompt = dialog.find('#ff-nr-ai-dialog-input-editor').val()
+                                resolve(prompt)
+                                $(this).dialog('close')
+                            }
+                        }
+                    ],
+                    cancel: function (event, ui) {
+                        resolve(null)
+                        $(this).dialog('close')
+                    }
+                })
+            })
+        }
+
+        let previousFunctionBuilderPrompt
+        function showFunctionBuilderPrompt (title) {
+            if (!assistantOptions.enabled) {
+                RED.notify('The FlowFuse Assistant is not enabled', 'warning')
+                return
+            }
+            getUserInput({
+                defaultInput: previousFunctionBuilderPrompt,
+                title: title || 'FlowFuse Assistant : Create A Function Node',
+                explanation: 'The FlowFuse Assistant can help you create a Function Node.',
+                description: 'Enter a short description of what you want it to do.'
+            }).then((prompt) => {
+                /** @type {JQueryXHR} */
+                let xhr = null
+                if (prompt) {
+                    previousFunctionBuilderPrompt = prompt
+                    const url = 'nr-assistant/function'
+                    const transactionId = generateId(8) + '-' + Date.now() // a unique id for this transaction
+                    const body = {
+                        prompt,
+                        transactionId,
+                        context: {
+                            scope: 'node', // "node" denotes that the prompt is for a generating a function node (as importable JSON flow code)
+                            modulesAllowed
+                        }
+                    }
+                    const busyNotification = showBusyNotification('Busy processing your request. Please wait...', function () {
+                        if (xhr) {
+                            xhr.abort('abort')
+                            xhr = null
+                        }
+                    })
+                    xhr = $.ajax({
+                        url,
+                        type: 'POST',
+                        data: body,
+                        timeout: assistantOptions.requestTimeout,
+                        success: (reply, textStatus, jqXHR) => {
+                            // console.log('showFunctionBuilderPrompt -> ajax -> success', reply)
+                            busyNotification.close()
+                            try {
+                                const flowJson = typeof reply?.data?.flow === 'string' ? JSON.parse(reply.data.flow) : reply?.data?.flow
+                                if (flowJson && Array.isArray(flowJson) && flowJson.length > 0) {
+                                    importFlow(flowJson)
+                                } else {
+                                    processAIErrorResponse(jqXHR, textStatus, 'No response from server')
+                                }
+                            } catch (error) {
+                                RED.notify('Sorry, something went wrong, please try again', 'error')
+                            }
+                        },
+                        error: (jqXHR, textStatus, errorThrown) => {
+                            // console.log('showFunctionBuilderPrompt -> ajax -> error', jqXHR, textStatus, errorThrown)
+                            busyNotification.close()
+                            if (textStatus === 'abort' || errorThrown === 'abort' || jqXHR.statusText === 'abort') {
+                                // user cancelled
+                                return
+                            }
+                            processAIErrorResponse(jqXHR, textStatus, errorThrown)
+                        }
+                    })
+                }
+            })
+        }
+
+        let previousFlowBuilderPrompt
+        // eslint-disable-next-line no-unused-vars
+        function showFlowBuilderPrompt (title) {
+            if (!assistantOptions.enabled) {
+                RED.notify('The FlowFuse Assistant is not enabled', 'warning')
+                return
+            }
+            getUserInput({
+                defaultInput: previousFlowBuilderPrompt,
+                title: title || 'FlowFuse Assistant : Flow Builder',
+                explanation: 'The FlowFuse Assistant can help you create a new flow.',
+                description: 'Enter a short description of what you want the flow to do.'
+            }).then((prompt) => {
+                /** @type {JQueryXHR} */
+                let xhr = null
+                if (prompt) {
+                    previousFlowBuilderPrompt = prompt
+                    const url = 'nr-assistant/flow'
+                    const transactionId = generateId(8) + '-' + Date.now() // a unique id for this transaction
+                    const body = {
+                        prompt,
+                        transactionId,
+                        context: {
+                            modulesAllowed
+                        }
+                    }
+                    const busyNotification = showBusyNotification('Busy processing your request. Please wait...', function () {
+                        if (xhr) {
+                            xhr.abort('abort')
+                            xhr = null
+                        }
+                    })
+                    xhr = $.ajax({
+                        url,
+                        type: 'POST',
+                        data: body,
+                        timeout: assistantOptions.requestTimeout,
+                        success: (reply, textStatus, jqXHR) => {
+                            busyNotification.close()
+                            try {
+                                const flowJson = typeof reply?.data?.flow === 'string' ? JSON.parse(reply.data.flow) : reply?.data?.flow
+                                if (flowJson && Array.isArray(flowJson) && flowJson.length > 0) {
+                                    importFlow(flowJson)
+                                } else {
+                                    processAIErrorResponse(jqXHR, textStatus, 'No response from server')
+                                }
+                            } catch (error) {
+                                RED.notify('Sorry, something went wrong, please try again', 'error')
+                            }
+                        },
+                        error: (jqXHR, textStatus, errorThrown) => {
+                            busyNotification.close()
+                            if (textStatus === 'abort' || errorThrown === 'abort' || jqXHR.statusText === 'abort') {
+                                // user cancelled
+                                return
+                            }
+                            processAIErrorResponse(jqXHR, textStatus, errorThrown)
+                        }
+                    })
+                }
+            })
+        }
+
+        /**
+         * Shows a busy notification with a cancel button
+         * @param {string} [message] - The message to display in the notification
+         * @param {function} [onCancel] - The function to call when the cancel button is clicked
+         * @param {object} [context] - The context object to pass to the onCancel callback function
+         * @returns {{close: () => {}}} - The notification object
+         */
+        function showBusyNotification (message, onCancel, context, poop) {
+            message = message || 'Busy processing your request. Please wait...'
+            const busyMessage = $('<div>')
+            $('<span>').text(message).appendTo(busyMessage)
+            $('<i>').addClass('fa fa-spinner fa-spin fa-fw').appendTo(busyMessage)
+            // eslint-disable-next-line prefer-const
+            let notification
+            const buttons = [
+                {
+                    text: 'cancel',
+                    click: function () {
+                        if (onCancel) {
+                            const result = onCancel(context)
+                            if (result === false) {
+                                return
+                            }
+                        }
+                        notification.close()
+                    }
+                }
+            ]
+            notification = showNotification(busyMessage, { type: 'success', timeout: 0, fixed: true, modal: true, buttons })
+            return notification
+        }
+
+        /**
+         * Shows a busy notification with a cancel button
+         * @param {string} message - The message to display in the notification
+         * @param {object} [options] - The options to pass to the notification
+         * @param {'error'|'warning'|'success'|'compact'} [options.type] - The type of notification to display
+         * @param {Number} [options.timeout] - How long the notification should be shown for, in milliseconds. Default: 5000. This is ignored if the fixed property is set.
+         * @param {boolean} [options.fixed] - Do not hide the notification after a timeout. This also prevents the click-to-close default behaviour of the notification.
+         * @param {boolean} [options.modal] - Whether the notification should be modal
+         * @param {array} [options.buttons] - An array of buttons to display in the notification. Each button should be an object with a text property and a click property. The click property should be a function to call when the button is clicked. The function will be passed the context object.
+         * @returns {{close: () => {}}} - The notification object
+         */
+        function showNotification (message, options) {
+            options = options || {}
+            options.type = options.type || 'success'
+            options.timeout = Object.prototype.hasOwnProperty.call(options, 'timeout') ? options.timeout : 5000
+            options.fixed = options.fixed || false
+            options.modal = options.modal || false
+            const pendingNotification = RED.notify(message, options)
+            return pendingNotification
+        }
+
+        function importFlow (flow, addFlow) {
+            let newNodes = flow
+            try {
+                if (typeof flow === 'string') {
+                    try {
+                        flow = flow.trim()
+                        if (flow.length === 0) {
+                            return
+                        }
+                        newNodes = JSON.parse(flow)
+                    } catch (err) {
+                        const e = new Error(RED._('clipboard.invalidFlow', { message: err.message }))
+                        e.code = 'NODE_RED'
+                        throw e
+                    }
+                }
+                const importOptions = { generateIds: true, addFlow }
+                RED.notify('Place your generated flow onto the workspace', 'compact')
+                RED.view.importNodes(newNodes, importOptions)
+            } catch (error) {
+                // console.log(error)
+                RED.notify('Sorry, something went wrong, please try again', 'error')
+            }
+        }
+
+        function processAIErrorResponse (jqXHR, textStatus, errorThrown) {
+            console.warn('error', jqXHR, textStatus, errorThrown)
+            RED.notify('Sorry, something went wrong, please try again', 'error')
+        }
+
+        function getMonacoEditorForModel (model) {
+            // Get the URI of the model, scan the editors for the model with the same URI
+            const modelUri = model.uri.toString()
+            const editors = monaco.editor.getEditors()
+            return editors.find(editor => editor && document.body.contains(editor.getDomNode()) && editor.getModel()?.uri?.toString() === modelUri)
+        }
+
+        function generateId (length = 16) {
+            if (typeof length !== 'number' || length < 1) {
+                throw new Error('Invalid length')
+            }
+            const iterations = Math.ceil(length / 2)
+            const bytes = []
+            for (let i = 0; i < iterations; i++) {
+                bytes.push(Math.round(0xff * Math.random()).toString(16).padStart(2, '0'))
+            }
+            return bytes.join('').substring(0, length)
+        }
+        function debug () {
+            if (RED.nrAssistant?.DEBUG) {
+                // eslint-disable-next-line no-console
+                console.log('[nr-assistant]', ...arguments)
+            }
+        }
+    }(RED, $))
+</script>

package/index.js

@@ -0,0 +1,76 @@
+module.exports = (RED) => {
+    const { default: got } = require('got')
+    RED.plugins.registerPlugin('flowfuse-nr-assistant', {
+        type: 'assistant',
+        name: 'Node-RED Assistant Plugin',
+        icon: 'font-awesome/fa-magic',
+        settings: {
+            '*': { exportable: true }
+        },
+        onadd: function () {
+            const assistantSettings = RED.settings.flowforge?.assistant || { enabled: false }
+            const clientSettings = {
+                enabled: assistantSettings.enabled !== false && !!assistantSettings.url,
+                requestTimeout: assistantSettings.requestTimeout || 60000
+            }
+            RED.comms.publish('nr-assistant/initialise', clientSettings, true /* retain */)
+
+            if (!assistantSettings || !assistantSettings.enabled) {
+                RED.log.info('FlowFuse Assistant Plugin is disabled')
+                return
+            }
+            if (!assistantSettings.url) {
+                RED.log.info('FlowFuse Assistant Plugin is missing url')
+                return
+            }
+
+            RED.log.info('FlowFuse Assistant Plugin loaded')
+
+            RED.httpAdmin.post('/nr-assistant/:method', RED.auth.needsPermission('write'), function (req, res) {
+                const method = req.params.method || 'fn'
+                // limit method to prevent path traversal
+                if (/[^a-zA-Z0-9-_]/.test(method)) {
+                    res.status(400)
+                    res.json({ status: 'error', message: 'Invalid method' })
+                    return
+                }
+                const input = req.body
+                const prompt = input.prompt
+                if (!input.prompt) {
+                    res.status(400)
+                    res.json({ status: 'error', message: 'prompt is required' })
+                    return
+                }
+                const body = {
+                    prompt, // this is the prompt to the AI
+                    promptHint: input.promptHint, // this is used to let the AI know what we are generating (`function node? Node JavaScript? flow?)
+                    context: input.context, // this is used to provide additional context to the AI (e.g. the selected text of the function node)
+                    transactionId: input.transactionId // used to correlate the request with the response
+                }
+                // join url & method (taking care of trailing slashes)
+                const url = `${assistantSettings.url.replace(/\/$/, '')}/${method.replace(/^\//, '')}`
+                got.post(url, {
+                    headers: {
+                        Accept: '*/*',
+                        'Accept-Language': 'en-GB,en-US;q=0.9,en;q=0.8,es;q=0.7',
+                        Authorization: `Bearer ${assistantSettings.token}`,
+                        'Content-Type': 'application/json'
+                    },
+                    json: body
+                }).then(response => {
+                    const data = JSON.parse(response.body)
+                    res.json({
+                        status: 'ok',
+                        data
+                    })
+                }).catch((error) => {
+                    const errorData = { status: 'error', message: 'Request to FlowFuse Assistant was unsuccessful', body: error.response?.body }
+                    const errorCode = error.response?.statusCode || 500
+                    res.status(errorCode).json({ status: 'error', message: errorData })
+                    console.warn('nr-assistant error:', error)
+                    RED.log.warn('FlowFuse Assistant request was unsuccessful')
+                })
+            })
+        }
+    })
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+    "name": "@flowfuse/nr-assistant",
+    "version": "0.1.0",
+    "description": "FlowFuse Node-RED assistant plugin",
+    "main": "index.js",
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 0",
+        "lint": "eslint -c .eslintrc --ext js,html *.js *.html",
+        "lint:fix": "eslint -c .eslintrc --ext js,html *.js  *.html --fix"
+    },
+    "keywords": [
+        "node-red",
+        "nodered",
+        "flowfuse",
+        "plugin",
+        "ai",
+        "lowcode"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/FlowFuse/nr-assistant.git"
+    },
+    "bugs": {
+        "url": "https://github.com/FlowFuse/nr-assistant/issues"
+    },
+    "homepage": "https://github.com/FlowFuse/nr-assistant#readme",
+    "author": "FlowFuse Inc.",
+    "license": "Apache-2.0",
+    "node-red": {
+        "version": ">=2.2.0",
+        "plugins": {
+            "flowfuse-nr-assistant": "index.js"
+        }
+    },
+    "engines": {
+        "node": ">=16.x"
+    },
+    "dependencies": {
+        "got": "^11.8.6"
+    },
+    "devDependencies": {
+        "eslint": "^8.48.0",
+        "eslint-config-standard": "^17.1.0",
+        "eslint-plugin-html": "7.1.0",
+        "eslint-plugin-no-only-tests": "^3.1.0"
+    }
+}