vodorod/Dorod-Sky
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

n8n integration (#1940)

Browse Source
This commit is contained in:
LawyZheng
2025-03-20 01:32:55 +08:00
committed by GitHub
parent 05433d68d2
commit d764f5dd12
19 changed files with 13899 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
integrations/n8n/nodes/Skyvern/Skyvern.node.json Normal file
View File

@@ -0,0 +1,21 @@
{
"node": "n8n-nodes-skyvern",
"nodeVersion": "1.0",
"codexVersion": "1.0",
"categories": [
"Miscellaneous",
"Utility"
],
"resources": {
"credentialDocumentation": [
{
"url": ""
}
],
"primaryDocumentation": [
{
"url": ""
}
]
}
}

423
integrations/n8n/nodes/Skyvern/Skyvern.node.ts Normal file
View File

@@ -0,0 +1,423 @@
import { FieldType, IDataObject, IExecuteSingleFunctions, IHttpRequestMethods, IHttpRequestOptions, ILoadOptionsFunctions, INodePropertyOptions, INodeType, INodeTypeDescription, NodeConnectionType, ResourceMapperField, ResourceMapperFields } from 'n8n-workflow';
const fetch = require('node-fetch');
export class Skyvern implements INodeType {
description: INodeTypeDescription = {
displayName: 'Skyvern',
name: 'skyvern',
icon: 'file:skyvern.png', // eslint-disable-line
group: ['transform'],
description: 'Node to interact with Skyvern',
defaults: {
name: 'Skyvern',
},
inputs: [NodeConnectionType.Main], // eslint-disable-line
outputs: [NodeConnectionType.Main], // eslint-disable-line
credentials: [
{
name: 'skyvernApi',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
noDataExpression: true,
options: [
{
name: 'Task',
value: 'task',
},
{
name: 'Workflow',
value: 'workflow',
},
],
default: 'task',
},
{
displayName: 'Operation',
name: 'taskOperation',
type: 'options',
required: true,
default: 'dispatch',
options: [
{
name: 'Dispatch a Task',
value: 'dispatch',
description: 'Dispatch a task to execute asynchronously',
},
{
name: 'Get a Task',
value: 'get',
description: 'Get a task by ID',
},
],
displayOptions: {
show: {
resource: ['task'],
},
},
routing: {
request: {
baseURL: '={{$credentials.baseUrl}}',
method: '={{ $value === "dispatch" ? "POST" : "GET" }}' as IHttpRequestMethods,
url: '={{"/api/" + ($parameter["taskOptions"]["engine"] ? $parameter["taskOptions"]["engine"] : "v2") + "/tasks"}}',
},
send: {
preSend: [
async function (this: IExecuteSingleFunctions, requestOptions: IHttpRequestOptions): Promise<IHttpRequestOptions> {
const taskOperation = this.getNodeParameter('taskOperation');
if (taskOperation === "get") return requestOptions;
const taskOptions: IDataObject = this.getNodeParameter('taskOptions') as IDataObject;
if (taskOptions["engine"] !== "v1") return requestOptions;
// trigger the generate task v1 logic
const credentials = await this.getCredentials('skyvernApi');
const userPrompt = this.getNodeParameter('userPrompt');
const response = await fetch(credentials['baseUrl'] + '/api/v1/generate/task', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-api-key': credentials['apiKey'],
},
body: JSON.stringify({
prompt: userPrompt,
}),
});
if (!response.ok) {
throw new Error('Request to generate Task V1 failed'); // eslint-disable-line
}
const data = await response.json();
requestOptions.body = {
url: data.url,
navigation_goal: data.navigation_goal,
navigation_payload: data.navigation_payload,
data_extraction_goal: data.data_extraction_goal,
extracted_information_schema: data.extracted_information_schema,
};
return requestOptions;
},
],
},
},
},
{
displayName: 'User Prompt',
description: 'The prompt for Skyvern to execute',
name: 'userPrompt',
type: 'string',
required: true,
default: '',
placeholder: 'eg: Navigate to the Hacker News homepage and get the top 3 posts.',
displayOptions: {
show: {
resource: ['task'],
taskOperation: ['dispatch'],
},
},
routing: {
request: {
body: {
user_prompt: '={{$value}}',
},
},
},
},
{
displayName: 'URL',
description: 'The URL to navigate to',
name: 'url',
type: 'string',
default: '',
placeholder: 'eg: https://news.ycombinator.com/',
displayOptions: {
show: {
resource: ['task'],
taskOperation: ['dispatch'],
},
},
routing: {
request: {
body: {
url: '={{$value ? $value : null}}',
},
},
},
},
{
displayName: 'Task ID',
description: 'The ID of the task',
name: 'taskId',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: ['task'],
taskOperation: ['get'],
},
},
routing: {
request: {
method: 'GET',
url: '={{"/api/" + ($parameter["taskOptions"]["engine"] ? $parameter["taskOptions"]["engine"] : "v2") + "/tasks/" + $value}}',
},
},
},
{
displayName: 'Task Options',
name: 'taskOptions',
type: 'collection',
description: 'Optional Configuration for the task',
placeholder: 'Add Task Options',
default: {},
options: [
{
displayName: 'Engine',
name: 'engine',
type: 'options',
default: 'v2',
options: [
{
name: 'TaskV1',
value: 'v1',
},
{
name: 'TaskV2',
value: 'v2',
},
],
},
],
displayOptions: {
show: {
resource: ['task'],
},
},
},
{
displayName: 'Workflow Title or ID', // eslint-disable-line
description: 'The title of the workflow. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
name: 'workflowId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getWorkflows',
loadOptionsDependsOn: ['resource'],
},
required: true,
default: '',
displayOptions: {
show: {
resource: ['workflow'],
},
},
},
{
displayName: 'Workflow Operation',
name: 'workflowOperation',
type: 'options',
required: true,
default: 'get',
options: [
{
name: 'Get a Workflow Run',
value: 'get',
description: 'Get a workflow run by ID',
},
{
name: 'Dispatch a Workflow Run',
value: 'dispatch',
description: 'Dispatch a workflow run to execute asynchronously',
},
],
displayOptions: {
show: {
resource: ['workflow'],
},
},
routing: {
request: {
baseURL: '={{$credentials.baseUrl}}',
method: '={{ $value === "dispatch" ? "POST" : "GET" }}' as IHttpRequestMethods,
},
},
},
{
displayName: 'Workflow Run ID',
description: 'The ID of the workflow run',
name: 'workflowRunId',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: ['workflow'],
workflowOperation: ['get'],
},
},
routing: {
request: {
url: '={{"/api/v1/workflows/" + $parameter["workflowId"] + "/runs/" + $value}}',
},
},
},
{
displayName: 'Workflow Run Parameters',
name: 'workflowRunParameters',
type: 'resourceMapper',
noDataExpression: true,
description: 'The JSON-formatted parameters to pass the workflow run to execute',
required: true,
default: {
mappingMode: 'defineBelow',
value: null,
},
displayOptions: {
show: {
resource: ['workflow'],
workflowOperation: ['dispatch'],
},
},
typeOptions: {
loadOptionsDependsOn: ['workflowId'],
resourceMapper: {
resourceMapperMethod: 'getWorkflowRunParameters',
mode: 'update',
fieldWords: {
singular: 'workflowRunParameter',
plural: 'workflowRunParameters',
},
addAllFields: true,
multiKeyMatch: true,
},
},
routing: {
request: {
url: '={{"/api/v1/workflows/" + $parameter["workflowId"] + "/run"}}',
body: {
data: '={{$value["value"]}}',
},
},
},
},
],
version: 1,
};
methods = {
loadOptions: {
async getWorkflows(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const resource = this.getCurrentNodeParameter('resource') as string;
if (resource !== 'workflow') return [];
const credentials = await this.getCredentials('skyvernApi');
const response = await fetch(credentials['baseUrl'] + '/api/v1/workflows?page_size=100', {
headers: {
'x-api-key': credentials['apiKey'],
},
});
if (!response.ok) {
throw new Error('Request to get workflows failed'); // eslint-disable-line
}
const data = await response.json();
return data.map((workflow: any) => ({
name: workflow.title,
value: workflow.workflow_permanent_id,
}));
},
},
resourceMapping: {
async getWorkflowRunParameters(this: ILoadOptionsFunctions): Promise<ResourceMapperFields> {
const resource = this.getCurrentNodeParameter('resource') as string;
if (resource !== 'workflow') return { fields: [] };
const workflowOperation = this.getCurrentNodeParameter('workflowOperation') as string;
if (workflowOperation !== 'dispatch') return { fields: [] };
const workflowId = this.getCurrentNodeParameter('workflowId') as string;
if (!workflowId) return { fields: [] };
const credentials = await this.getCredentials('skyvernApi');
const response = await fetch(credentials['baseUrl'] + '/api/v1/workflows/' + workflowId, {
headers: {
'x-api-key': credentials['apiKey'],
},
});
if (!response.ok) {
throw new Error('Request to get workflow failed'); // eslint-disable-line
}
const workflow = await response.json();
const parameters: any[] = workflow.workflow_definition.parameters;
const fields: ResourceMapperField[] = await Promise.all(
parameters.filter((parameter: any) => parameter.parameter_type === 'workflow' || parameter.parameter_type === 'credential')
.map(async (parameter: any) => {
let options: INodePropertyOptions[] | undefined = undefined;
let parameterType: FieldType | undefined = undefined;
if (parameter.parameter_type === 'credential') {
const response = await fetch(credentials['baseUrl'] + '/api/v1/credentials', {
headers: {
'x-api-key': credentials['apiKey'],
},
});
if (!response.ok) {
throw new Error('Request to get credentials failed'); // eslint-disable-line
}
const data = await response.json();
options = data.map((credential: any) => ({
name: credential.name,
value: credential.credential_id,
}));
parameterType = 'options';
}else{
const parameter_type_map: Record<string, string> = {
'string': 'string',
'integer': 'number',
'float': 'number',
'boolean': 'boolean',
'json': 'json',
'file_url': 'url',
}
parameterType = parameter_type_map[parameter.workflow_parameter_type] as FieldType;
}
return {
id: parameter.key,
displayName: parameter.key,
defaultMatch: true,
canBeUsedToMatch: false,
required: parameter.default_value === undefined || parameter.default_value === null,
display: true,
type: parameterType,
options: options,
};
})
);
// HACK: If there are no parameters, add a empty field to avoid the resource mapper from crashing
if (fields.length === 0) {
fields.push({
id: 'NO_PARAMETERS',
displayName: 'No Parameters',
defaultMatch: false,
canBeUsedToMatch: false,
required: false,
display: true,
type: 'string',
});
}
return {
fields: fields,
}
},
},
}
}

BIN
integrations/n8n/nodes/Skyvern/skyvern.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 27 KiB