Skip to content

Commit 1577148

Browse files
author
ami3466
committed
Initial commit: FlowEngine Workflow Builder n8n node
0 parents  commit 1577148

File tree

17 files changed

+8284
-0
lines changed

17 files changed

+8284
-0
lines changed

.github/workflows/ci.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- main
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v4
15+
16+
- name: Use Node.js
17+
uses: actions/setup-node@v4
18+
with:
19+
node-version: '22'
20+
21+
- name: Install dependencies
22+
run: 'npm ci'
23+
24+
- name: Run lint
25+
run: 'npm run lint'
26+
27+
- name: Run build
28+
run: 'npm run build'

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
dist
2+
node_modules

.prettierrc.js

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
module.exports = {
2+
/**
3+
* https://prettier.io/docs/en/options.html#semicolons
4+
*/
5+
semi: true,
6+
7+
/**
8+
* https://prettier.io/docs/en/options.html#trailing-commas
9+
*/
10+
trailingComma: 'all',
11+
12+
/**
13+
* https://prettier.io/docs/en/options.html#bracket-spacing
14+
*/
15+
bracketSpacing: true,
16+
17+
/**
18+
* https://prettier.io/docs/en/options.html#tabs
19+
*/
20+
useTabs: true,
21+
22+
/**
23+
* https://prettier.io/docs/en/options.html#tab-width
24+
*/
25+
tabWidth: 2,
26+
27+
/**
28+
* https://prettier.io/docs/en/options.html#arrow-function-parentheses
29+
*/
30+
arrowParens: 'always',
31+
32+
/**
33+
* https://prettier.io/docs/en/options.html#quotes
34+
*/
35+
singleQuote: true,
36+
37+
/**
38+
* https://prettier.io/docs/en/options.html#quote-props
39+
*/
40+
quoteProps: 'as-needed',
41+
42+
/**
43+
* https://prettier.io/docs/en/options.html#end-of-line
44+
*/
45+
endOfLine: 'lf',
46+
47+
/**
48+
* https://prettier.io/docs/en/options.html#print-width
49+
*/
50+
printWidth: 100,
51+
};

.vscode/extensions.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"recommendations": [
3+
"dbaeumer.vscode-eslint",
4+
"EditorConfig.EditorConfig",
5+
"esbenp.prettier-vscode",
6+
]
7+
}

.vscode/launch.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"version": "0.2.0",
3+
"configurations": [
4+
{
5+
"name": "Attach to running n8n",
6+
"processId": "${command:PickProcess}",
7+
"request": "attach",
8+
"skipFiles": ["<node_internals>/**"],
9+
"type": "node"
10+
}
11+
]
12+
}

CHANGELOG.md

Whitespace-only changes.

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at jan@n8n.io. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

LICENSE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Copyright 2024 FlowEngine
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of
4+
this software and associated documentation files (the "Software"), to deal in
5+
the Software without restriction, including without limitation the rights to
6+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
7+
of the Software, and to permit persons to whom the Software is furnished to do
8+
so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19+
SOFTWARE.

README.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# n8n-nodes-flowengine-workflow-builder
2+
3+
This is an n8n community node. It lets you use [FlowEngine Workflow Builder](https://flowengine.cloud) in your n8n workflows.
4+
5+
FlowEngine Workflow Builder is an AI-powered workflow automation tool that helps you create and manage workflows using natural language.
6+
7+
[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
8+
9+
[Installation](#installation)
10+
[Operations](#operations)
11+
[Credentials](#credentials)
12+
[Compatibility](#compatibility)
13+
[Usage](#usage)
14+
[Resources](#resources)
15+
16+
## Installation
17+
18+
Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
19+
20+
## Operations
21+
22+
### FlowEngine Workflow Builder Node
23+
24+
- **Send Message**: Send a message to FlowEngine AI and receive an AI-generated response
25+
- Choose between Regular (faster, lower cost) or Boost (more powerful) models
26+
- Optionally continue existing conversations using Conversation ID
27+
28+
## Credentials
29+
30+
### FlowEngine Workflow Builder API
31+
32+
To use this node, you need a FlowEngine API key:
33+
34+
1. Sign up at [flowengine.cloud](https://flowengine.cloud)
35+
2. Go to [Settings](https://flowengine.cloud/settings)
36+
3. Generate a new API key
37+
4. Add the API key to your n8n credentials
38+
39+
## Compatibility
40+
41+
- Minimum n8n version: 1.0.0
42+
- Tested with n8n versions: 1.40.0+
43+
44+
## Usage
45+
46+
### Basic Chat with FlowEngine
47+
48+
1. Add the **FlowEngine Workflow Builder** node to your workflow
49+
2. Configure your FlowEngine Workflow Builder API credentials
50+
3. Enter your message in the Message field
51+
4. Choose the model (Regular or Boost)
52+
5. Execute to get an AI response
53+
54+
### Continuing Conversations
55+
56+
To maintain context across multiple messages:
57+
58+
1. After the first message, capture the `conversation_id` from the response
59+
2. Pass this `conversation_id` in the Additional Fields for subsequent messages
60+
61+
## Resources
62+
63+
- [n8n community nodes documentation](https://docs.n8n.io/integrations/#community-nodes)
64+
- [FlowEngine Documentation](https://flowengine.cloud/api-docs)
65+
- [FlowEngine Website](https://flowengine.cloud)
66+
67+
## License
68+
69+
[MIT](LICENSE.md)
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
import type {
2+
IAuthenticateGeneric,
3+
ICredentialTestRequest,
4+
ICredentialType,
5+
INodeProperties,
6+
} from 'n8n-workflow';
7+
8+
export class FlowEngineWorkflowBuilderApi implements ICredentialType {
9+
name = 'flowEngineWorkflowBuilderApi';
10+
11+
displayName = 'FlowEngine Workflow Builder API';
12+
13+
documentationUrl = 'https://flowengine.cloud/api-docs';
14+
15+
icon = 'file:flowengine.svg' as const;
16+
17+
properties: INodeProperties[] = [
18+
{
19+
displayName: 'API Key',
20+
name: 'apiKey',
21+
type: 'string',
22+
typeOptions: { password: true },
23+
default: '',
24+
required: true,
25+
description:
26+
'Your FlowEngine API key. Get it from Settings at flowengine.cloud/settings',
27+
},
28+
];
29+
30+
authenticate: IAuthenticateGeneric = {
31+
type: 'generic',
32+
properties: {
33+
headers: {
34+
Authorization: '=Bearer {{$credentials.apiKey}}',
35+
},
36+
},
37+
};
38+
39+
test: ICredentialTestRequest = {
40+
request: {
41+
baseURL: 'https://flowengine.cloud',
42+
url: '/api/v1/chat',
43+
method: 'POST',
44+
body: {
45+
message: 'Test connection',
46+
},
47+
},
48+
};
49+
}

0 commit comments

Comments
 (0)