feat: add automation/import-flow action

Closes #172

Author: andypalmi

resources/expertAutomations.js

@@ -6,9 +6,10 @@ const GET_NODES = 'automation/get-nodes'
 const EDIT_NODE = 'automation/open-node-edit'
 const SEARCH = 'automation/search'
 const ADD_FLOW_TAB = 'automation/add-flow-tab'
+const IMPORT_FLOW = 'automation/import-flow'
 
 /**
- * @typedef {SELECT_NODES|GET_NODES|EDIT_NODE|SEARCH|ADD_FLOW_TAB} ExpertAutomationsActionsEnum
+ * @typedef {SELECT_NODES|GET_NODES|EDIT_NODE|SEARCH|ADD_FLOW_TAB|IMPORT_FLOW} ExpertAutomationsActionsEnum
  */
 
 export class ExpertAutomations extends ExpertActionsInterface {
@@ -98,6 +99,28 @@ export class ExpertAutomations extends ExpertActionsInterface {
                 }
             }
         }
+,
+        [IMPORT_FLOW]: {
+            params: {
+                type: 'object',
+                properties: {
+                    flow: {
+                        type: ['string', 'array'],
+                        description: 'Flow JSON string or array to import onto the canvas'
+                    },
+                    addFlow: {
+                        type: 'boolean',
+                        description: 'Whether to create a new tab for the imported nodes (true) or import into the current tab (false). Default: false'
+                    },
+                    generateIds: {
+                        type: 'boolean',
+                        description: 'Whether to regenerate node IDs during import. Default: true.',
+                        default: true
+                    }
+                },
+                required: ['flow']
+            }
+        }
     })
 
     /**
@@ -200,7 +223,7 @@ export class ExpertAutomations extends ExpertActionsInterface {
                 throw e
             }
         }
-        this.RED.view.importNodes(newNodes, { generateIds, addFlow, notify })
+        this.RED.view.importNodes(newNodes, { generateIds, addFlow, notify, touchImport: true })
     }
 
     async addFlowTab (title) {
@@ -300,6 +323,10 @@ export class ExpertAutomations extends ExpertActionsInterface {
         }
             break
 
+        case IMPORT_FLOW:
+            this.importFlow(params.flow, { addFlow: params.addFlow, generateIds: params.generateIds ?? true })
+            result.success = true
+            break
         default:
             result.handled = false
             result.success = false

test/unit/resources/expertAutomations.test.js

@@ -65,7 +65,7 @@ describeMain('expertAutomations', () => {
         it('should have supported actions', () => {
             const supportedActions = expertAutomations.supportedActions
             supportedActions.should.be.an.Object()
-            supportedActions.should.only.have.keys('automation/get-nodes', 'automation/select-nodes', 'automation/open-node-edit', 'automation/search', 'automation/add-flow-tab')
+            supportedActions.should.only.have.keys('automation/get-nodes', 'automation/select-nodes', 'automation/open-node-edit', 'automation/search', 'automation/add-flow-tab', 'automation/import-flow')
         })
         it('should have hasAction method', () => {
             expertAutomations.should.have.property('hasAction').which.is.a.Function()
@@ -310,7 +310,7 @@ describeMain('expertAutomations', () => {
                 mockRED.view.importNodes.calledOnce.should.be.true()
                 const args = mockRED.view.importNodes.firstCall.args
                 args[0].should.deepEqual([{ id: '', type: 'tab', label: 'My New Flow', disabled: false, info: '', env: [] }])
-                args[1].should.deepEqual({ generateIds: true, addFlow: false, notify: false })
+                args[1].should.deepEqual({ generateIds: true, addFlow: false, notify: false, touchImport: true })
                 result.should.have.property('success', true)
                 result.should.have.property('handled', true)
             })
@@ -323,5 +323,20 @@ describeMain('expertAutomations', () => {
                 result.should.have.property('success', true)
             })
         })
+            describe('importFlow action', () => {
+                it('should import flow JSON', async () => {
+                    mockRED.view.importNodes = sinon.stub()
+                    mockRED._ = sinon.stub().returns('error')
+                    const flowJson = JSON.stringify([{ id: 'n1', type: 'inject' }])
+                    const result = {}
+                    await expertAutomations.invokeAction('automation/import-flow', {
+                        params: { flow: flowJson }
+                    }, result)
+                    mockRED.view.importNodes.calledOnce.should.be.true()
+                    const args = mockRED.view.importNodes.firstCall.args
+                    args[1].should.have.property('touchImport', true)
+                    result.should.have.property('success', true)
+                })
+            })
     })
 })

test/unit/resources/expertComms.test.js

@@ -951,7 +951,8 @@ describeMain('expertComms', function () {
             mockRED.view.importNodes.firstCall.args[1].should.eql({
                 generateIds: true,
                 addFlow: false,
-                notify: true
+                notify: true,
+                touchImport: true
             })
 
             eventSource.postMessage.calledOnce.should.be.true()