2020-01-27 01:32:27 -08:00
import * as formidable from 'formidable' ;
2020-01-20 13:52:34 -08:00
import {
IHookFunctions ,
IWebhookFunctions ,
} from 'n8n-core' ;
import {
IDataObject ,
ILoadOptionsFunctions ,
INodePropertyOptions ,
INodeType ,
2020-10-01 05:01:39 -07:00
INodeTypeDescription ,
2020-01-20 13:52:34 -08:00
IWebhookResponseData ,
} from 'n8n-workflow' ;
import {
jotformApiRequest ,
} from './GenericFunctions' ;
2020-01-27 01:32:27 -08:00
interface IQuestionData {
name : string ;
text : string ;
}
2020-01-20 13:52:34 -08:00
export class JotFormTrigger implements INodeType {
description : INodeTypeDescription = {
displayName : 'JotForm Trigger' ,
name : 'jotFormTrigger' ,
icon : 'file:jotform.png' ,
group : [ 'trigger' ] ,
version : 1 ,
description : 'Handle JotForm events via webhooks' ,
defaults : {
name : 'JotForm Trigger' ,
color : '#fa8900' ,
} ,
inputs : [ ] ,
outputs : [ 'main' ] ,
credentials : [
{
name : 'jotFormApi' ,
required : true ,
2020-10-22 06:46:03 -07:00
} ,
2020-01-20 13:52:34 -08:00
] ,
webhooks : [
{
name : 'default' ,
httpMethod : 'POST' ,
responseMode : 'onReceived' ,
path : 'webhook' ,
} ,
] ,
properties : [
{
displayName : 'Form' ,
name : 'form' ,
type : 'options' ,
required : true ,
typeOptions : {
2020-10-22 06:46:03 -07:00
loadOptionsMethod : 'getForms' ,
2020-01-20 13:52:34 -08:00
} ,
default : '' ,
description : '' ,
} ,
2020-01-27 01:32:27 -08:00
{
displayName : 'Resolve Data' ,
name : 'resolveData' ,
type : 'boolean' ,
default : true ,
description : 'By default does the webhook-data use internal keys instead of the names.<br />If this option gets activated it will resolve the keys automatically to the actual names.' ,
} ,
{
displayName : 'Only Answers' ,
name : 'onlyAnswers' ,
type : 'boolean' ,
default : true ,
description : 'Returns only the answers of the form and not any of the other data.' ,
} ,
2020-01-20 13:52:34 -08:00
] ,
} ;
methods = {
loadOptions : {
// Get all the available forms to display them to user so that he can
// select them easily
async getForms ( this : ILoadOptionsFunctions ) : Promise < INodePropertyOptions [ ] > {
const returnData : INodePropertyOptions [ ] = [ ] ;
const qs : IDataObject = {
limit : 1000 ,
} ;
const forms = await jotformApiRequest . call ( this , 'GET' , '/user/forms' , { } , qs ) ;
for ( const form of forms . content ) {
const formName = form . title ;
const formId = form . id ;
returnData . push ( {
name : formName ,
value : formId ,
} ) ;
}
return returnData ;
} ,
} ,
} ;
// @ts-ignore
webhookMethods = {
default : {
async checkExists ( this : IHookFunctions ) : Promise < boolean > {
const webhookData = this . getWorkflowStaticData ( 'node' ) ;
const formId = this . getNodeParameter ( 'form' ) as string ;
const endpoint = ` /form/ ${ formId } /webhooks ` ;
2020-01-26 23:22:10 -08:00
2020-01-20 13:52:34 -08:00
try {
2020-01-26 23:22:10 -08:00
const responseData = await jotformApiRequest . call ( this , 'GET' , endpoint ) ;
const webhookUrls = Object . values ( responseData . content ) ;
const webhookUrl = this . getNodeWebhookUrl ( 'default' ) ;
if ( ! webhookUrls . includes ( webhookUrl ) ) {
return false ;
}
const webhookIds = Object . keys ( responseData . content ) ;
webhookData . webhookId = webhookIds [ webhookUrls . indexOf ( webhookUrl ) ] ;
2020-01-20 13:52:34 -08:00
} catch ( e ) {
return false ;
}
return true ;
} ,
async create ( this : IHookFunctions ) : Promise < boolean > {
const webhookUrl = this . getNodeWebhookUrl ( 'default' ) ;
const webhookData = this . getWorkflowStaticData ( 'node' ) ;
const formId = this . getNodeParameter ( 'form' ) as string ;
const endpoint = ` /form/ ${ formId } /webhooks ` ;
const body : IDataObject = {
webhookURL : webhookUrl ,
//webhookURL: 'https://en0xsizp3qyt7f.x.pipedream.net/',
} ;
const { content } = await jotformApiRequest . call ( this , 'POST' , endpoint , body ) ;
webhookData . webhookId = Object . keys ( content ) [ 0 ] ;
return true ;
} ,
async delete ( this : IHookFunctions ) : Promise < boolean > {
let responseData ;
const webhookData = this . getWorkflowStaticData ( 'node' ) ;
const formId = this . getNodeParameter ( 'form' ) as string ;
const endpoint = ` /form/ ${ formId } /webhooks/ ${ webhookData . webhookId } ` ;
try {
responseData = await jotformApiRequest . call ( this , 'DELETE' , endpoint ) ;
} catch ( error ) {
return false ;
}
if ( responseData . message !== 'success' ) {
return false ;
}
delete webhookData . webhookId ;
return true ;
} ,
} ,
} ;
//@ts-ignore
async webhook ( this : IWebhookFunctions ) : Promise < IWebhookResponseData > {
const req = this . getRequestObject ( ) ;
2020-01-27 01:32:27 -08:00
const formId = this . getNodeParameter ( 'form' ) as string ;
const resolveData = this . getNodeParameter ( 'resolveData' , false ) as boolean ;
const onlyAnswers = this . getNodeParameter ( 'onlyAnswers' , false ) as boolean ;
const form = new formidable . IncomingForm ( ) ;
return new Promise ( ( resolve , reject ) = > {
form . parse ( req , async ( err , data , files ) = > {
const rawRequest = JSON . parse ( data . rawRequest as string ) ;
data . rawRequest = rawRequest ;
let returnData : IDataObject ;
if ( resolveData === false ) {
if ( onlyAnswers === true ) {
returnData = data . rawRequest as unknown as IDataObject ;
} else {
returnData = data ;
}
resolve ( {
workflowData : [
this . helpers . returnJsonArray ( returnData ) ,
] ,
} ) ;
}
// Resolve the data by requesting the information via API
const endpoint = ` /form/ ${ formId } /questions ` ;
const responseData = await jotformApiRequest . call ( this , 'GET' , endpoint , { } ) ;
// Create a dictionary to resolve the keys
const questionNames : IDataObject = { } ;
for ( const question of Object . values ( responseData . content ) as IQuestionData [ ] ) {
questionNames [ question . name ] = question . text ;
}
// Resolve the keys
let questionKey : string ;
const questionsData : IDataObject = { } ;
for ( const key of Object . keys ( rawRequest ) ) {
if ( ! key . includes ( '_' ) ) {
continue ;
}
questionKey = key . split ( '_' ) . slice ( 1 ) . join ( '_' ) ;
if ( questionNames [ questionKey ] === undefined ) {
continue ;
}
questionsData [ questionNames [ questionKey ] as string ] = rawRequest [ key ] ;
}
if ( onlyAnswers === true ) {
returnData = questionsData as unknown as IDataObject ;
} else {
// @ts-ignore
data . rawRequest = questionsData ;
returnData = data ;
}
resolve ( {
workflowData : [
this . helpers . returnJsonArray ( returnData ) ,
] ,
} ) ;
} ) ;
} ) ;
2020-01-20 13:52:34 -08:00
}
}