@flowfuse/nr-assistant 0.2.1-78d933c-202506111915.0 → 0.2.1

package/README.md

@@ -2,7 +2,32 @@
 
 A Node-RED plugin to assist FlowFuse users.
 
-This plugin can only be used within FlowFuse-managed Node-RED instances.
+
+**This plugin can only be used within FlowFuse-managed Node-RED instances.**
+
+FlowFuse is the Industrial application platform for building and operating custom industrial solutions that digitalize processes and operations. It integrates seamlessly into both IT and OT environments, leveraging Node-RED to enable teams to connect, collect, transform, and visualize data from industrial systems. Companies use FlowFuse to manage, scale, and secure their Node-RED-based applications across industrial environments.
+
+Sign-up to FlowFuse Cloud now to get started: https://app.flowfuse.com
+
+## About
+
+This plugin is designed to assist users of the FlowFuse platform by providing tools to aid development of their Node-RED instances including:
+* A function builder
+* Function node Code Lens
+* JSON generation in all typed inputs and JSON editors (like the inject node, change node, template node, etc)
+* Flows Explainer
+
+### Function Builder
+![flowfuse-assistant-function builder](https://github.com/user-attachments/assets/5efc4c24-a4e6-4d0c-b836-aebf97d3ca02)
+
+
+### JSON generator
+![flowfuse-assistant-json-generator](https://github.com/user-attachments/assets/d3271f64-a733-48dd-924b-0a946b9a6e7f)
+
+
+### Flows Explainer
+![flowfuse-assistant-flow-explainer](https://github.com/user-attachments/assets/3a8c17bb-066b-4264-9ad1-3a031bd2afee)
+
 
 ## Installation
 
@@ -14,11 +39,6 @@ npm install @flowfuse/nr-assistant
 
 Client-side portion of the plugin is in `index.html`. 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:
 
@@ -44,9 +64,11 @@ The `url` and `token` are for an AI service hosted by FlowFuse; it is not public
 
 ## Limitations
 
-* Only function node generation is currently supported.
+### Function Builder
 * Only a single function node can be generated at a time.
-* The codelens feature is only supported for the on-message editor.
+
+### Function Node Editor Codelens
+* The codelens feature is only supported for the on-message editor in the function node.
 
 ## Versioning
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@flowfuse/nr-assistant",
-    "version": "0.2.1-78d933c-202506111915.0",
+    "version": "0.2.1",
     "description": "FlowFuse Node-RED assistant plugin",
     "main": "index.js",
     "scripts": {

package/.eslintrc

@@ -1,32 +0,0 @@
-{
-    "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

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

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

@@ -1,10 +0,0 @@
-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/publish.yaml

@@ -1,51 +0,0 @@
-name: Build and push packages
-
-on:
-  workflow_dispatch:
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
-
-jobs:
-  build:
-    uses: 'flowfuse/github-actions-workflows/.github/workflows/build_node_package.yml@v0.39.0'
-    with:
-      node: '[
-              {"version": "16", "tests": true, "lint": false},
-              {"version": "18", "tests": true, "lint": true},
-              {"version": "20", "tests": true, "lint": true},
-            ]'
-
-  publish:
-    needs: build
-    if: |
-      ( github.event_name == 'push' && github.ref == 'refs/heads/main' ) ||
-      ( github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main' )
-    uses: 'flowfuse/github-actions-workflows/.github/workflows/publish_node_package.yml@v0.39.0'
-    with:
-      package_name: nr-assistant
-      publish_package: true
-    secrets:
-      npm_registry_token: ${{ secrets.NPM_PUBLISH_TOKEN }}
-
-  dispatch_nr_launcher:
-    name: Dispatch nr-launcher package build
-    needs: publish
-    runs-on: ubuntu-latest
-    steps:
-      - name: Generate a token
-        id: generate_token
-        uses: tibdex/github-app-token@3beb63f4bd073e61482598c45c71c1019b59b73a # v2.1.0
-        with:
-          app_id: ${{ secrets.GH_BOT_APP_ID }}
-          private_key: ${{ secrets.GH_BOT_APP_KEY }}
-      - name: Trigger nr-launcher package build
-        uses: benc-uk/workflow-dispatch@e2e5e9a103e331dad343f381a29e654aea3cf8fc # v1.2.4
-        with:
-          workflow: publish.yml
-          repo: flowfuse/nr-launcher
-          ref: main
-          token: ${{ steps.generate_token.outputs.token }}

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

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