This commit is contained in:
Ricardo Espinoza 2020-01-24 12:58:22 -05:00
commit 38de0af9b9
16 changed files with 4646 additions and 9 deletions

View file

@ -57,7 +57,7 @@ import ParameterInputFull from '@/components/ParameterInputFull.vue';
import ParameterInputList from '@/components/ParameterInputList.vue';
import NodeCredentials from '@/components/NodeCredentials.vue';
import NodeWebhooks from '@/components/NodeWebhooks.vue';
import { get, set } from 'lodash';
import { get, set, unset } from 'lodash';
import { genericHelpers } from '@/components/mixins/genericHelpers';
import { nodeHelpers } from '@/components/mixins/nodeHelpers';
@ -369,9 +369,12 @@ export default mixins(
Vue.set(nodeParameters as object, path, data);
}
} else {
// For everything else
if (newValue === undefined) {
unset(nodeParameters as object, parameterPath);
} else {
set(nodeParameters as object, parameterPath, newValue);
}
}
// Get the parameters with the now new defaults according to the
// from the user actually defined parameters

View file

@ -30,6 +30,9 @@ export default Vue
},
computed: {
isMultiLineParameter () {
if (this.level > 4) {
return true;
}
const rows = this.getArgument('rows');
if (rows !== undefined && rows > 1) {
return true;
@ -37,6 +40,9 @@ export default Vue
return false;
},
level (): number {
return this.path.split('.').length;
},
},
props: [
'displayOptions',

View file

@ -0,0 +1,18 @@
import {
ICredentialType,
NodePropertyTypes,
} from 'n8n-workflow';
export class DisqusApi implements ICredentialType {
name = 'disqusApi';
displayName = 'Disqus API';
properties = [
{
displayName: 'Access Token',
name: 'accessToken',
type: 'string' as NodePropertyTypes,
default: '',
description: 'Visit your account details page, and grab the Access Token. See <a href="https://disqus.com/api/docs/auth/">Disqus auth</a>.'
},
];
}

View file

@ -0,0 +1,17 @@
import {
ICredentialType,
NodePropertyTypes,
} from 'n8n-workflow';
export class SegmentApi implements ICredentialType {
name = 'segmentApi';
displayName = 'Segment API';
properties = [
{
displayName: 'Write Key',
name: 'writekey',
type: 'string' as NodePropertyTypes,
default: '',
},
];
}

View file

@ -0,0 +1,784 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeTypeDescription,
INodeExecutionData,
INodeType,
} from 'n8n-workflow';
import { disqusApiRequest, disqusApiRequestAllItems } from './GenericFunctions';
export class Disqus implements INodeType {
description: INodeTypeDescription = {
displayName: 'Disqus',
name: 'disqus',
icon: 'file:disqus.png',
group: ['input'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Access data on Disqus',
defaults: {
name: 'Disqus',
color: '#22BB44',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'disqusApi',
required: true,
}
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'Forum',
value: 'forum',
},
],
default: 'forum',
description: 'The resource to operate on.',
},
// ----------------------------------
// forum
// ----------------------------------
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'forum',
],
},
},
options: [
{
name: 'Get',
value: 'get',
description: 'Returns forum details.',
},
{
name: 'Get All Categories',
value: 'getCategories',
description: 'Returns a list of categories within a forum.',
},
{
name: 'Get All Threads',
value: 'getThreads',
description: 'Returns a list of threads within a forum.',
},
{
name: 'Get All Posts',
value: 'getPosts',
description: 'Returns a list of posts within a forum.',
}
],
default: 'get',
description: 'The operation to perform.',
},
// ----------------------------------
// forum:get
// ----------------------------------
{
displayName: 'Forum name',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'get',
],
resource: [
'forum',
],
},
},
description: 'The short name(aka ID) of the forum to get.',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: [
'get',
],
resource: [
'forum',
],
},
},
default: {},
options: [
{
displayName: 'Attach',
name: 'attach',
type: 'multiOptions',
options: [
{
name: 'counters',
value: 'counters',
},
{
name: 'followsForum',
value: 'followsForum',
},
{
name: 'forumCanDisableAds',
value: 'forumCanDisableAds',
},
{
name: 'forumDaysAlive',
value: 'forumDaysAlive',
},
{
name: 'forumFeatures',
value: 'forumFeatures',
},
{
name: 'forumForumCategory',
value: 'forumForumCategory',
},
{
name: 'forumIntegration',
value: 'forumIntegration',
},
{
name: 'forumNewPolicy',
value: 'forumNewPolicy',
},
{
name: 'forumPermissions',
value: 'forumPermissions',
},
],
default: [],
description: 'The resource to operate on.',
},
{
displayName: 'Related',
name: 'related',
type: 'multiOptions',
options: [
{
name: 'author',
value: 'author',
},
],
default: [],
description: 'You may specify relations to include with your response',
},
],
},
// ----------------------------------
// forum:getPosts
// ----------------------------------
{
displayName: 'Forum name',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'getPosts',
],
resource: [
'forum',
],
},
},
description: 'The short name(aka ID) of the forum to get.',
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'forum',
],
operation: [
'getPosts',
],
},
},
default: false,
description: 'If all results should be returned or only up to a given limit.',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'forum',
],
operation: [
'getPosts',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 100,
},
default: 100,
description: 'How many results to return.',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: [
'getPosts',
],
resource: [
'forum',
],
},
},
default: {},
options: [
{
displayName: 'Filters',
name: 'filters',
type: 'multiOptions',
options: [
{
name: 'Has_Bad_Word',
value: 'Has_Bad_Word',
},
{
name: 'Has_Link',
value: 'Has_Link',
},
{
name: 'Has_Low_Rep_Author',
value: 'Has_Low_Rep_Author',
},
{
name: 'Has_Media',
value: 'Has_Media',
},
{
name: 'Is_Anonymous',
value: 'Is_Anonymous',
},
{
name: 'Is_Flagged',
value: 'Is_Flagged',
},
{
name: 'No_Issue',
value: 'No_Issue',
},
{
name: 'Is_At_Flag_Limit',
value: 'Is_At_Flag_Limit',
},
{
name: 'Is_Toxic',
value: 'Is_Toxic',
},
{
name: 'Modified_By_Rule',
value: 'Modified_By_Rule',
},
{
name: 'Shadow_Banned',
value: 'Shadow_Banned',
},
],
default: [],
description: 'You may specify filters for your response.'
},
{
displayName: 'Include',
name: 'include',
type: 'multiOptions',
options: [
{
name: 'approved',
value: 'approved',
},
],
default: [],
description: 'You may specify relations to include with your response.',
},
{
displayName: 'Order',
name: 'order',
type: 'options',
options: [
{
name: 'ASC',
value: 'asc',
},
{
name: 'DESC',
value: 'desc',
}
],
default: 'asc',
description: 'You may specify order to sort your response.',
},
{
displayName: 'Query',
name: 'query',
type: 'string',
default: '',
description: 'You may specify query forChoices: asc, desc your response.',
},
{
displayName: 'Related',
name: 'related',
type: 'multiOptions',
options: [
{
name: 'thread',
value: 'thread',
},
],
default: [],
description: 'You may specify relations to include with your response',
},
{
displayName: 'Since',
name: 'since',
type: 'dateTime',
default: '',
description: 'Unix timestamp (or ISO datetime standard)',
},
],
},
// ----------------------------------
// forum:getCategories
// ----------------------------------
{
displayName: 'Forum name',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'getCategories',
],
resource: [
'forum',
],
},
},
description: 'The short name(aka ID) of the forum to get Categories.',
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'forum',
],
operation: [
'getCategories',
],
},
},
default: false,
description: 'If all results should be returned or only up to a given limit.',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'forum',
],
operation: [
'getCategories',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 100,
},
default: 100,
description: 'How many results to return.',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: [
'getCategories',
],
resource: [
'forum',
],
},
},
default: {},
options: [
{
displayName: 'Order',
name: 'order',
type: 'options',
options: [
{
name: 'ASC',
value: 'asc',
},
{
name: 'DESC',
value: 'desc',
}
],
default: 'asc',
description: 'You may specify order to sort your response.',
},
],
},
// ----------------------------------
// forum:getThreads
// ----------------------------------
{
displayName: 'Forum name',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'getThreads',
],
resource: [
'forum',
],
},
},
description: 'The short name(aka ID) of the forum to get Threads.',
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'forum',
],
operation: [
'getThreads',
],
},
},
default: false,
description: 'If all results should be returned or only up to a given limit.',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'forum',
],
operation: [
'getThreads',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 100,
},
default: 100,
description: 'How many results to return.',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: [
'getThreads',
],
resource: [
'forum',
],
},
},
default: {},
options: [
{
displayName: 'Related',
name: 'related',
type: 'multiOptions',
options: [
{
name: 'author',
value: 'author',
},
{
name: 'forum',
value: 'forum',
},
],
default: [],
description: 'You may specify relations to include with your response',
},
{
displayName: 'Include',
name: 'include',
type: 'multiOptions',
options: [
{
name: 'closed',
value: 'closed',
},
{
name: 'open',
value: 'open',
},
{
name: 'killed',
value: 'killed',
},
],
default: [],
description: 'You may specify relations to include with your response.',
},
{
displayName: 'Order',
name: 'order',
type: 'options',
options: [
{
name: 'ASC',
value: 'asc',
},
{
name: 'DESC',
value: 'desc',
}
],
default: 'asc',
description: 'You may specify order to sort your response.',
},
{
displayName: 'Since',
name: 'since',
type: 'dateTime',
default: '',
description: 'Unix timestamp (or ISO datetime standard)',
},
{
displayName: 'Thread',
name: 'threadId',
type: 'string',
default: '',
description: 'Looks up a thread by ID. You may pass us the "ident"<br />query type instead of an ID by including "forum". You may<br />pass us the "link" query type to filter by URL. You must pass<br />the "forum" if you do not have the Pro API Access addon.',
},
],
}
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
const resource = this.getNodeParameter('resource', 0) as string;
const operation = this.getNodeParameter('operation', 0) as string;
let endpoint = '';
let requestMethod = '';
let body: IDataObject | Buffer;
let qs: IDataObject;
for (let i = 0; i < items.length; i++) {
body = {};
qs = {};
if (resource === 'forum') {
if (operation === 'get') {
// ----------------------------------
// get
// ----------------------------------
requestMethod = 'GET';
endpoint = 'forums/details.json';
const id = this.getNodeParameter('id', i) as string;
qs.forum = id;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
try {
const responseData = await disqusApiRequest.call(this, requestMethod, qs, endpoint);
returnData.push(responseData.response);
} catch (error) {
throw error;
}
} else if (operation === 'getPosts') {
// ----------------------------------
// getPosts
// ----------------------------------
requestMethod = 'GET';
endpoint = 'forums/listPosts.json';
const id = this.getNodeParameter('id', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
qs.forum = id;
qs.limit = 100;
try {
let responseData: IDataObject = {};
if(returnAll) {
responseData.response = await disqusApiRequestAllItems.call(this, requestMethod, qs, endpoint);
} else {
const limit = this.getNodeParameter('limit', i) as string;
qs.limit = limit;
responseData = await disqusApiRequest.call(this, requestMethod, qs, endpoint);
}
returnData.push.apply(returnData, responseData.response as IDataObject[]);
} catch (error) {
throw error;
}
} else if (operation === 'getCategories') {
// ----------------------------------
// getCategories
// ----------------------------------
requestMethod = 'GET';
endpoint = 'forums/listCategories.json';
const id = this.getNodeParameter('id', i) as string;
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
qs.forum = id;
qs.limit = 100;
try {
let responseData: IDataObject = {};
if(returnAll) {
responseData.response = await disqusApiRequestAllItems.call(this, requestMethod, qs, endpoint);
} else {
const limit = this.getNodeParameter('limit', i) as string;
qs.limit = limit;
responseData = await disqusApiRequest.call(this, requestMethod, qs, endpoint) as IDataObject;
}
returnData.push.apply(returnData, responseData.response as IDataObject[]) ;
} catch (error) {
throw error;
}
} else if (operation === 'getThreads') {
// ----------------------------------
// getThreads
// ----------------------------------
requestMethod = 'GET';
endpoint = 'forums/listThreads.json';
const id = this.getNodeParameter('id', i) as string;
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
qs.forum = id;
qs.limit = 100;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
try {
let responseData: IDataObject = {};
if(returnAll) {
responseData.response = await disqusApiRequestAllItems.call(this, requestMethod, qs, endpoint);
} else {
const limit = this.getNodeParameter('limit', i) as string;
qs.limit = limit;
responseData = await disqusApiRequest.call(this, requestMethod, qs, endpoint);
}
returnData.push.apply(returnData, responseData.response as IDataObject[]);
} catch (error) {
throw error;
}
} else {
throw new Error(`The operation "${operation}" is not known!`);
}
} else {
throw new Error(`The resource "${resource}" is not known!`);
}
}
return [this.helpers.returnJsonArray(returnData)];
}
}

View file

@ -0,0 +1,97 @@
import { OptionsWithUri } from 'request';
import {
IExecuteFunctions,
IExecuteSingleFunctions,
IHookFunctions,
ILoadOptionsFunctions,
} from 'n8n-core';
import { IDataObject } from 'n8n-workflow';
export async function disqusApiRequest(
this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions,
method: string,
qs: IDataObject = {},
uri?: string,
body: IDataObject = {},
option: IDataObject = {},
): Promise<any> { // tslint:disable-line:no-any
const credentials = this.getCredentials('disqusApi') as IDataObject;
qs.api_key = credentials.accessToken;
if (credentials === undefined) {
throw new Error('No credentials got returned!');
}
// Convert to query string into a format the API can read
const queryStringElements: string[] = [];
for (const key of Object.keys(qs)) {
if (Array.isArray(qs[key])) {
(qs[key] as string[]).forEach(value => {
queryStringElements.push(`${key}=${value}`);
});
} else {
queryStringElements.push(`${key}=${qs[key]}`);
}
}
let options: OptionsWithUri = {
method,
body,
uri: `https://disqus.com/api/3.0/${uri}?${queryStringElements.join('&')}`,
json: true
};
options = Object.assign({}, options, option);
if (Object.keys(options.body).length === 0) {
delete options.body;
}
try {
const result = await this.helpers.request!(options);
return result;
} catch (error) {
if (error.statusCode === 401) {
// Return a clear error
throw new Error('The Disqus credentials are not valid!');
}
if (error.error && error.error.error_summary) {
// Try to return the error prettier
throw new Error(`Disqus error response [${error.statusCode}]: ${error.error.error_summary}`);
}
// If that data does not exist for some reason return the actual error
throw error;
}
}
/**
* Make an API request to paginated flow endpoint
* and return all results
*/
export async function disqusApiRequestAllItems(
this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions,
method: string,
qs: IDataObject = {},
uri?: string,
body: IDataObject = {},
option: IDataObject = {},
): Promise<any> { // tslint:disable-line:no-any
const returnData: IDataObject[] = [];
let responseData;
try {
do {
responseData = await disqusApiRequest.call(this, method, qs, uri, body, option);
qs.cursor = responseData.cursor.id;
returnData.push.apply(returnData, responseData.response);
} while (
responseData.cursor.more === true &&
responseData.cursor.hasNext === true
);
return returnData;
} catch(error) {
throw error;
}
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 KiB

View file

@ -0,0 +1,36 @@
import { OptionsWithUri } from 'request';
import {
IExecuteFunctions,
IExecuteSingleFunctions,
IHookFunctions,
ILoadOptionsFunctions,
IWebhookFunctions,
} from 'n8n-core';
import { IDataObject } from 'n8n-workflow';
export async function segmentApiRequest(this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions | IWebhookFunctions, method: string, resource: string, body: any = {}, qs: IDataObject = {}, uri?: string, option: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
const credentials = this.getCredentials('segmentApi');
if (credentials === undefined) {
throw new Error('No credentials got returned!');
}
const base64Key = Buffer.from(`${credentials.writekey}:`).toString('base64');
const options: OptionsWithUri = {
headers: {
Authorization: `Basic ${base64Key}`,
'Content-Type': 'application/json',
},
method,
qs,
body,
uri: uri ||`https://api.segment.io/v1${resource}`,
json: true
};
if (!Object.keys(body).length) {
delete options.body;
}
try {
return await this.helpers.request!(options);
} catch (error) {
throw new Error('Segment Error: ' + error);
}
}

View file

@ -0,0 +1,508 @@
import { INodeProperties } from 'n8n-workflow';
export const identifyOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'identify',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create an identity',
},
],
default: 'create',
description: 'The operation to perform.',
},
] as INodeProperties[];
export const identifyFields = [
/* -------------------------------------------------------------------------- */
/* identify:create */
/* -------------------------------------------------------------------------- */
{
displayName: 'User ID',
name: 'userId',
type: 'string',
default: '',
displayOptions: {
show: {
resource: [
'identify',
],
operation: [
'create',
],
},
},
required: false,
},
{
displayName: 'Traits',
name: 'traits',
placeholder: 'Add Trait',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
displayOptions: {
show: {
resource: [
'identify',
],
operation: [
'create',
],
},
},
default: {},
options: [
{
name: 'traitsUi',
displayName: 'Trait',
values: [
{
displayName: 'Email',
name: 'email',
type: 'string',
default: '',
description: 'Email address of a user',
},
{
displayName: 'First Name',
name: 'firstname',
type: 'string',
default: '',
description: 'First name of a user',
},
{
displayName: 'Last Name',
name: 'lastname',
type: 'string',
default: '',
description: 'Last name of a user',
},
{
displayName: 'Gender',
name: 'gender',
type: 'string',
default: '',
description: 'Gender of a user',
},
{
displayName: 'Phone',
name: 'phone',
type: 'string',
default: '',
description: 'Phone number of a user',
},
{
displayName: 'Username',
name: 'username',
type: 'string',
default: '',
description: 'Users username',
},
{
displayName: 'Website',
name: 'website',
type: 'string',
default: '',
description: 'Website of a user',
},
{
displayName: 'Age',
name: 'age',
type: 'number',
default: 1,
description: 'Age of a user',
},
{
displayName: 'Avatar',
name: 'avatar',
type: 'string',
default: '',
description: 'URL to an avatar image for the user',
},
{
displayName: 'Birthday',
name: 'birthday',
type: 'dateTime',
default: '',
description: 'Users birthday',
},
{
displayName: 'Created At',
name: 'createdAt',
type: 'dateTime',
default: '',
description: 'Date the users account was first created',
},
{
displayName: 'Description',
name: 'description',
type: 'string',
typeOptions: {
alwaysOpenEditWindow: true,
},
default: '',
description: 'Description of the user',
},
{
displayName: 'ID',
name: 'id',
type: 'string',
default: '',
description: 'Unique ID in your database for a user',
},
{
displayName: 'Company',
name: 'company',
placeholder: 'Add Company',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
default: {},
options: [
{
name: 'companyUi',
displayName: 'Company',
values: [
{
displayName: 'ID',
name: 'id',
type: 'string',
default: '',
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
},
{
displayName: 'Industry',
name: 'industry',
type: 'string',
default: '',
},
{
displayName: 'Employee Count',
name: 'employeeCount',
type: 'number',
default: 1,
},
{
displayName: 'Plan',
name: 'plan',
type: 'string',
default: '',
},
]
},
],
},
{
displayName: 'Address',
name: 'address',
placeholder: 'Add Address',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
default: {},
options: [
{
name: 'addressUi',
displayName: 'Address',
values: [
{
displayName: 'Street',
name: 'street',
type: 'string',
default: '',
},
{
displayName: 'City',
name: 'city',
type: 'string',
default: '',
},
{
displayName: 'State',
name: 'state',
type: 'string',
default: '',
},
{
displayName: 'Postal Code',
name: 'postalCode',
type: 'string',
default: '',
},
{
displayName: 'Country',
name: 'country',
type: 'string',
default: '',
},
]
},
],
},
]
},
],
},
{
displayName: 'Context',
name: 'context',
placeholder: 'Add Context',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
displayOptions: {
show: {
resource: [
'identify',
],
operation: [
'create',
],
},
},
default: {},
options: [
{
name: 'contextUi',
displayName: 'Context',
values: [
{
displayName: 'Active',
name: 'active',
type: 'boolean',
default: '',
description: 'Whether a user is active',
},
{
displayName: 'IP',
name: 'ip',
type: 'string',
default: '',
description: 'Current users IP address.',
},
{
displayName: 'Locale',
name: 'locate',
type: 'string',
default: '',
description: 'Locale string for the current user, for example en-US.',
},
{
displayName: 'Page',
name: 'page',
type: 'string',
default: '',
description: 'Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and url',
},
{
displayName: 'Timezone',
name: 'timezone',
type: 'string',
default: '',
description: 'Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York',
},
{
displayName: 'App',
name: 'app',
placeholder: 'Add App',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
default: {},
options: [
{
name: 'appUi',
displayName: 'App',
values: [
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
},
{
displayName: 'Version',
name: 'version',
type: 'string',
default: '',
},
{
displayName: 'Build',
name: 'build',
type: 'string',
default: '',
},
]
},
],
},
{
displayName: 'Campaign',
name: 'campaign',
placeholder: 'Campaign App',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
default: {},
options: [
{
name: 'campaignUi',
displayName: 'Campaign',
values: [
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
},
{
displayName: 'Source',
name: 'source',
type: 'string',
default: '',
},
{
displayName: 'Medium',
name: 'medium',
type: 'string',
default: '',
},
{
displayName: 'Term',
name: 'term',
type: 'string',
default: '',
},
{
displayName: 'Content',
name: 'content',
type: 'string',
default: '',
},
]
},
],
},
{
displayName: 'Device',
name: 'device',
placeholder: 'Add Device',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
default: {},
options: [
{
name: 'deviceUi',
displayName: 'Device',
values: [
{
displayName: 'ID',
name: 'id',
type: 'string',
default: '',
},
{
displayName: 'Manufacturer',
name: 'manufacturer',
type: 'string',
default: '',
},
{
displayName: 'Model',
name: 'model',
type: 'string',
default: '',
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
},
{
displayName: 'Type',
name: 'type',
type: 'string',
default: '',
},
{
displayName: 'Version',
name: 'version',
type: 'string',
default: '',
},
],
},
],
},
]
},
],
},
{
displayName: 'Integration',
name: 'integrations',
placeholder: 'Add Integration',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
displayOptions: {
show: {
resource: [
'identify',
],
operation: [
'create',
],
},
},
default: {},
options: [
{
name: 'integrationsUi',
displayName: 'Integration',
values: [
{
displayName: 'All',
name: 'all',
type: 'boolean',
default: true,
},
{
displayName: 'Salesforce',
name: 'salesforce',
type: 'boolean',
default: false,
},
],
},
],
},
] as INodeProperties[];

View file

@ -0,0 +1,10 @@
import { IDataObject } from "n8n-workflow";
export interface IIdentify {
userId?: string;
anonymousId?: string;
traits?: IDataObject;
context?: IDataObject;
integrations?: IDataObject;
timestamp?: string;
}

View file

@ -0,0 +1,774 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
import {
segmentApiRequest,
} from './GenericFunctions';
import {
identifyFields,
identifyOperations,
} from './IdentifyDescription';
import {
IIdentify,
} from './IdentifyInterface';
import {
trackOperations,
trackFields,
} from './TrackDescription';
import { ITrack } from './TrackInterface';
import * as uuid from 'uuid/v4';
export class Segment implements INodeType {
description: INodeTypeDescription = {
displayName: 'Segment',
name: 'segment',
icon: 'file:segment.png',
group: ['output'],
version: 1,
subtitle: '={{$parameter["operation"] + ":" + $parameter["resource"]}}',
description: 'Consume Segment API',
defaults: {
name: 'Segment',
color: '#6ebb99',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'segmentApi',
required: true,
}
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'Identify',
value: 'identify',
description: 'Identify lets you tie a user to their actions.'
},
{
name: 'Track',
value: 'track',
description: 'Track lets you record events',
},
],
default: 'identify',
description: 'Resource to consume.',
},
...identifyOperations,
...trackOperations,
...identifyFields,
...trackFields,
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
const length = items.length as unknown as number;
const qs: IDataObject = {};
let responseData;
const resource = this.getNodeParameter('resource', 0) as string;
const operation = this.getNodeParameter('operation', 0) as string;
for (let i = 0; i < length; i++) {
if (resource === 'identify') {
//https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#identify
if (operation === 'create') {
const userId = this.getNodeParameter('userId', i) as string;
const traits = (this.getNodeParameter('traits', i) as IDataObject).traitsUi as IDataObject;
const context = (this.getNodeParameter('context', i) as IDataObject).contextUi as IDataObject;
const integrations = (this.getNodeParameter('integrations', i) as IDataObject).integrationsUi as IDataObject;
const body: IIdentify = {
traits: {
company: {},
address: {},
},
context: {
app: {},
campaign: {},
device: {},
},
integrations: {},
};
if (userId) {
body.userId = userId as string;
} else {
body.anonymousId = uuid();
}
if (traits) {
if (traits.email) {
body.traits!.email = traits.email as string;
}
if (traits.firstname) {
body.traits!.firstname = traits.firstname as string;
}
if (traits.lastname) {
body.traits!.lastname = traits.lastname as string;
}
if (traits.gender) {
body.traits!.gender = traits.gender as string;
}
if (traits.phone) {
body.traits!.phone = traits.phone as string;
}
if (traits.username) {
body.traits!.username = traits.username as string;
}
if (traits.website) {
body.traits!.website = traits.website as string;
}
if (traits.age) {
body.traits!.age = traits.age as number;
}
if (traits.avatar) {
body.traits!.avatar = traits.avatar as string;
}
if (traits.birthday) {
body.traits!.birthday = traits.birthday as string;
}
if (traits.createdAt) {
body.traits!.createdAt = traits.createdAt as string;
}
if (traits.description) {
body.traits!.description = traits.description as string;
}
if (traits.id) {
body.traits!.id = traits.id as string;
}
if (traits.company) {
const company = (traits.company as IDataObject).companyUi as IDataObject;
if (company) {
if (company.id) {
//@ts-ignore
body.traits.company.id = company.id as string;
}
if (company.name) {
//@ts-ignore
body.traits.company.name = company.name as string;
}
if (company.industry) {
//@ts-ignore
body.traits.company.industry = company.industry as string;
}
if (company.employeeCount) {
//@ts-ignore
body.traits.company.employeeCount = company.employeeCount as number;
}
if (company.plan) {
//@ts-ignore
body.traits.company.plan = company.plan as string;
}
}
}
if (traits.address) {
const address = (traits.address as IDataObject).addressUi as IDataObject;
if (address) {
if (address.street) {
//@ts-ignore
body.traits.address.street = address.street as string;
}
if (address.city) {
//@ts-ignore
body.traits.address.city = address.city as string;
}
if (address.state) {
//@ts-ignore
body.traits.address.state = address.state as string;
}
if (address.postalCode) {
//@ts-ignore
body.traits.address.postalCode = address.postalCode as string;
}
if (address.country) {
//@ts-ignore
body.traits.address.country = address.country as string;
}
}
}
}
if (context) {
if (context.active) {
body.context!.active = context.active as boolean;
}
if (context.ip) {
body.context!.ip = context.ip as string;
}
if (context.locate) {
body.context!.locate = context.locate as string;
}
if (context.page) {
body.context!.page = context.page as string;
}
if (context.timezone) {
body.context!.timezone = context.timezone as string;
}
if (context.timezone) {
body.context!.timezone = context.timezone as string;
}
if (context.app) {
const app = (context.app as IDataObject).appUi as IDataObject;
if (app) {
if (app.name) {
//@ts-ignore
body.context.app.name = app.name as string;
}
if (app.version) {
//@ts-ignore
body.context.app.version = app.version as string;
}
if (app.build) {
//@ts-ignore
body.context.app.build = app.build as string;
}
}
}
if (context.campaign) {
const campaign = (context.campaign as IDataObject).campaignUi as IDataObject;
if (campaign) {
if (campaign.name) {
//@ts-ignore
body.context.campaign.name = campaign.name as string;
}
if (campaign.source) {
//@ts-ignore
body.context.campaign.source = campaign.source as string;
}
if (campaign.medium) {
//@ts-ignore
body.context.campaign.medium = campaign.medium as string;
}
if (campaign.term) {
//@ts-ignore
body.context.campaign.term = campaign.term as string;
}
if (campaign.content) {
//@ts-ignore
body.context.campaign.content = campaign.content as string;
}
}
}
if (context.device) {
const device = (context.device as IDataObject).deviceUi as IDataObject;
if (device) {
if (device.id) {
//@ts-ignore
body.context.device.id = device.id as string;
}
if (device.manufacturer) {
//@ts-ignore
body.context.device.manufacturer = device.manufacturer as string;
}
if (device.model) {
//@ts-ignore
body.context.device.model = device.model as string;
}
if (device.type) {
//@ts-ignore
body.context.device.type = device.type as string;
}
if (device.version) {
//@ts-ignore
body.context.device.version = device.version as string;
}
}
}
}
if (integrations) {
if (integrations.all) {
body.integrations!.all = integrations.all as boolean;
}
if (integrations.salesforce) {
body.integrations!.salesforce = integrations.salesforce as boolean;
}
}
responseData = await segmentApiRequest.call(this, 'POST', '/identify', body);
}
}
if (resource === 'track') {
//https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#track
if (operation === 'event') {
const userId = this.getNodeParameter('userId', i) as string;
const event = this.getNodeParameter('event', i) as string;
const traits = (this.getNodeParameter('traits', i) as IDataObject).traitsUi as IDataObject;
const context = (this.getNodeParameter('context', i) as IDataObject).contextUi as IDataObject;
const integrations = (this.getNodeParameter('integrations', i) as IDataObject).integrationsUi as IDataObject;
const properties = (this.getNodeParameter('properties', i) as IDataObject).propertiesUi as IDataObject;
const body: ITrack = {
event,
traits: {
company: {},
address: {},
},
context: {
app: {},
campaign: {},
device: {},
},
integrations: {},
properties: {},
};
if (userId) {
body.userId = userId as string;
} else {
body.anonymousId = uuid();
}
if (traits) {
if (traits.email) {
body.traits!.email = traits.email as string;
}
if (traits.firstname) {
body.traits!.firstname = traits.firstname as string;
}
if (traits.lastname) {
body.traits!.lastname = traits.lastname as string;
}
if (traits.gender) {
body.traits!.gender = traits.gender as string;
}
if (traits.phone) {
body.traits!.phone = traits.phone as string;
}
if (traits.username) {
body.traits!.username = traits.username as string;
}
if (traits.website) {
body.traits!.website = traits.website as string;
}
if (traits.age) {
body.traits!.age = traits.age as number;
}
if (traits.avatar) {
body.traits!.avatar = traits.avatar as string;
}
if (traits.birthday) {
body.traits!.birthday = traits.birthday as string;
}
if (traits.createdAt) {
body.traits!.createdAt = traits.createdAt as string;
}
if (traits.description) {
body.traits!.description = traits.description as string;
}
if (traits.id) {
body.traits!.id = traits.id as string;
}
if (traits.company) {
const company = (traits.company as IDataObject).companyUi as IDataObject;
if (company) {
if (company.id) {
//@ts-ignore
body.traits.company.id = company.id as string;
}
if (company.name) {
//@ts-ignore
body.traits.company.name = company.name as string;
}
if (company.industry) {
//@ts-ignore
body.traits.company.industry = company.industry as string;
}
if (company.employeeCount) {
//@ts-ignore
body.traits.company.employeeCount = company.employeeCount as number;
}
if (company.plan) {
//@ts-ignore
body.traits.company.plan = company.plan as string;
}
}
}
if (traits.address) {
const address = (traits.address as IDataObject).addressUi as IDataObject;
if (address) {
if (address.street) {
//@ts-ignore
body.traits.address.street = address.street as string;
}
if (address.city) {
//@ts-ignore
body.traits.address.city = address.city as string;
}
if (address.state) {
//@ts-ignore
body.traits.address.state = address.state as string;
}
if (address.postalCode) {
//@ts-ignore
body.traits.address.postalCode = address.postalCode as string;
}
if (address.country) {
//@ts-ignore
body.traits.address.country = address.country as string;
}
}
}
}
if (context) {
if (context.active) {
body.context!.active = context.active as boolean;
}
if (context.ip) {
body.context!.ip = context.ip as string;
}
if (context.locate) {
body.context!.locate = context.locate as string;
}
if (context.page) {
body.context!.page = context.page as string;
}
if (context.timezone) {
body.context!.timezone = context.timezone as string;
}
if (context.timezone) {
body.context!.timezone = context.timezone as string;
}
if (context.app) {
const app = (context.app as IDataObject).appUi as IDataObject;
if (app) {
if (app.name) {
//@ts-ignore
body.context.app.name = app.name as string;
}
if (app.version) {
//@ts-ignore
body.context.app.version = app.version as string;
}
if (app.build) {
//@ts-ignore
body.context.app.build = app.build as string;
}
}
}
if (context.campaign) {
const campaign = (context.campaign as IDataObject).campaignUi as IDataObject;
if (campaign) {
if (campaign.name) {
//@ts-ignore
body.context.campaign.name = campaign.name as string;
}
if (campaign.source) {
//@ts-ignore
body.context.campaign.source = campaign.source as string;
}
if (campaign.medium) {
//@ts-ignore
body.context.campaign.medium = campaign.medium as string;
}
if (campaign.term) {
//@ts-ignore
body.context.campaign.term = campaign.term as string;
}
if (campaign.content) {
//@ts-ignore
body.context.campaign.content = campaign.content as string;
}
}
}
if (context.device) {
const device = (context.device as IDataObject).deviceUi as IDataObject;
if (device) {
if (device.id) {
//@ts-ignore
body.context.device.id = device.id as string;
}
if (device.manufacturer) {
//@ts-ignore
body.context.device.manufacturer = device.manufacturer as string;
}
if (device.model) {
//@ts-ignore
body.context.device.model = device.model as string;
}
if (device.type) {
//@ts-ignore
body.context.device.type = device.type as string;
}
if (device.version) {
//@ts-ignore
body.context.device.version = device.version as string;
}
}
}
}
if (integrations) {
if (integrations.all) {
body.integrations!.all = integrations.all as boolean;
}
if (integrations.salesforce) {
body.integrations!.salesforce = integrations.salesforce as boolean;
}
}
if (properties) {
if (properties.revenue) {
body.properties!.revenue = properties.revenue as number;
}
if (properties.currency) {
body.properties!.currency = properties.currency as string;
}
if (properties.value) {
body.properties!.value = properties.value as string;
}
}
responseData = await segmentApiRequest.call(this, 'POST', '/track', body);
}
//https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#page
if (operation === 'page') {
const userId = this.getNodeParameter('userId', i) as string;
const event = this.getNodeParameter('event', i) as string;
const traits = (this.getNodeParameter('traits', i) as IDataObject).traitsUi as IDataObject;
const context = (this.getNodeParameter('context', i) as IDataObject).contextUi as IDataObject;
const integrations = (this.getNodeParameter('integrations', i) as IDataObject).integrationsUi as IDataObject;
const properties = (this.getNodeParameter('properties', i) as IDataObject).propertiesUi as IDataObject;
const body: ITrack = {
event,
traits: {
company: {},
address: {},
},
context: {
app: {},
campaign: {},
device: {},
},
integrations: {},
properties: {},
};
if (userId) {
body.userId = userId as string;
} else {
body.anonymousId = uuid();
}
if (traits) {
if (traits.email) {
body.traits!.email = traits.email as string;
}
if (traits.firstname) {
body.traits!.firstname = traits.firstname as string;
}
if (traits.lastname) {
body.traits!.lastname = traits.lastname as string;
}
if (traits.gender) {
body.traits!.gender = traits.gender as string;
}
if (traits.phone) {
body.traits!.phone = traits.phone as string;
}
if (traits.username) {
body.traits!.username = traits.username as string;
}
if (traits.website) {
body.traits!.website = traits.website as string;
}
if (traits.age) {
body.traits!.age = traits.age as number;
}
if (traits.avatar) {
body.traits!.avatar = traits.avatar as string;
}
if (traits.birthday) {
body.traits!.birthday = traits.birthday as string;
}
if (traits.createdAt) {
body.traits!.createdAt = traits.createdAt as string;
}
if (traits.description) {
body.traits!.description = traits.description as string;
}
if (traits.id) {
body.traits!.id = traits.id as string;
}
if (traits.company) {
const company = (traits.company as IDataObject).companyUi as IDataObject;
if (company) {
if (company.id) {
//@ts-ignore
body.traits.company.id = company.id as string;
}
if (company.name) {
//@ts-ignore
body.traits.company.name = company.name as string;
}
if (company.industry) {
//@ts-ignore
body.traits.company.industry = company.industry as string;
}
if (company.employeeCount) {
//@ts-ignore
body.traits.company.employeeCount = company.employeeCount as number;
}
if (company.plan) {
//@ts-ignore
body.traits.company.plan = company.plan as string;
}
}
}
if (traits.address) {
const address = (traits.address as IDataObject).addressUi as IDataObject;
if (address) {
if (address.street) {
//@ts-ignore
body.traits.address.street = address.street as string;
}
if (address.city) {
//@ts-ignore
body.traits.address.city = address.city as string;
}
if (address.state) {
//@ts-ignore
body.traits.address.state = address.state as string;
}
if (address.postalCode) {
//@ts-ignore
body.traits.address.postalCode = address.postalCode as string;
}
if (address.country) {
//@ts-ignore
body.traits.address.country = address.country as string;
}
}
}
}
if (context) {
if (context.active) {
body.context!.active = context.active as boolean;
}
if (context.ip) {
body.context!.ip = context.ip as string;
}
if (context.locate) {
body.context!.locate = context.locate as string;
}
if (context.page) {
body.context!.page = context.page as string;
}
if (context.timezone) {
body.context!.timezone = context.timezone as string;
}
if (context.timezone) {
body.context!.timezone = context.timezone as string;
}
if (context.app) {
const app = (context.app as IDataObject).appUi as IDataObject;
if (app) {
if (app.name) {
//@ts-ignore
body.context.app.name = app.name as string;
}
if (app.version) {
//@ts-ignore
body.context.app.version = app.version as string;
}
if (app.build) {
//@ts-ignore
body.context.app.build = app.build as string;
}
}
}
if (context.campaign) {
const campaign = (context.campaign as IDataObject).campaignUi as IDataObject;
if (campaign) {
if (campaign.name) {
//@ts-ignore
body.context.campaign.name = campaign.name as string;
}
if (campaign.source) {
//@ts-ignore
body.context.campaign.source = campaign.source as string;
}
if (campaign.medium) {
//@ts-ignore
body.context.campaign.medium = campaign.medium as string;
}
if (campaign.term) {
//@ts-ignore
body.context.campaign.term = campaign.term as string;
}
if (campaign.content) {
//@ts-ignore
body.context.campaign.content = campaign.content as string;
}
}
}
if (context.device) {
const device = (context.device as IDataObject).deviceUi as IDataObject;
if (device) {
if (device.id) {
//@ts-ignore
body.context.device.id = device.id as string;
}
if (device.manufacturer) {
//@ts-ignore
body.context.device.manufacturer = device.manufacturer as string;
}
if (device.model) {
//@ts-ignore
body.context.device.model = device.model as string;
}
if (device.type) {
//@ts-ignore
body.context.device.type = device.type as string;
}
if (device.version) {
//@ts-ignore
body.context.device.version = device.version as string;
}
}
}
}
if (integrations) {
if (integrations.all) {
body.integrations!.all = integrations.all as boolean;
}
if (integrations.salesforce) {
body.integrations!.salesforce = integrations.salesforce as boolean;
}
}
if (properties) {
if (properties.name) {
body.properties!.name = properties.name as number;
}
if (properties.path) {
body.properties!.path = properties.path as string;
}
if (properties.referrer) {
body.properties!.referrer = properties.referrer as string;
}
if (properties.search) {
body.properties!.search = properties.search as string;
}
if (properties.title) {
body.properties!.title = properties.title as string;
}
if (properties.url) {
body.properties!.url = properties.url as string;
}
if (properties.keywords) {
body.properties!.keywords = properties.keywords as string;
}
}
responseData = await segmentApiRequest.call(this, 'POST', '/page', body);
}
}
if (Array.isArray(responseData)) {
returnData.push.apply(returnData, responseData as IDataObject[]);
} else {
returnData.push(responseData as IDataObject);
}
}
return [this.helpers.returnJsonArray(returnData)];
}
}

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,13 @@
import { IDataObject } from "n8n-workflow";
export interface ITrack {
event?: string;
userId?: string;
name?: string;
anonymousId?: string;
traits?: IDataObject;
context?: IDataObject;
timestamp?: string;
properties?: IDataObject;
integrations?: IDataObject;
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 KiB

File diff suppressed because it is too large Load diff

View file

@ -37,6 +37,7 @@
"dist/credentials/ClickUpApi.credentials.js",
"dist/credentials/CodaApi.credentials.js",
"dist/credentials/CopperApi.credentials.js",
"dist/credentials/DisqusApi.credentials.js",
"dist/credentials/DropboxApi.credentials.js",
"dist/credentials/EventbriteApi.credentials.js",
"dist/credentials/FreshdeskApi.credentials.js",
@ -74,6 +75,7 @@
"dist/credentials/Smtp.credentials.js",
"dist/credentials/StripeApi.credentials.js",
"dist/credentials/SalesmateApi.credentials.js",
"dist/credentials/SegmentApi.credentials.js",
"dist/credentials/TelegramApi.credentials.js",
"dist/credentials/TodoistApi.credentials.js",
"dist/credentials/TrelloApi.credentials.js",
@ -105,6 +107,7 @@
"dist/nodes/Copper/CopperTrigger.node.js",
"dist/nodes/Cron.node.js",
"dist/nodes/Discord/Discord.node.js",
"dist/nodes/Disqus/Disqus.node.js",
"dist/nodes/Dropbox/Dropbox.node.js",
"dist/nodes/EditImage.node.js",
"dist/nodes/EmailReadImap.node.js",
@ -172,6 +175,7 @@
"dist/nodes/Stripe/StripeTrigger.node.js",
"dist/nodes/Switch.node.js",
"dist/nodes/Salesmate/Salesmate.node.js",
"dist/nodes/Segment/Segment.node.js",
"dist/nodes/Telegram/Telegram.node.js",
"dist/nodes/Telegram/TelegramTrigger.node.js",
"dist/nodes/Todoist/Todoist.node.js",
@ -206,6 +210,7 @@
"@types/nodemailer": "^4.6.5",
"@types/redis": "^2.8.11",
"@types/request-promise-native": "~1.0.15",
"@types/uuid": "^3.4.6",
"@types/xml2js": "^0.4.3",
"gulp": "^4.0.0",
"jest": "^24.9.0",
@ -237,6 +242,7 @@
"redis": "^2.8.0",
"rhea": "^1.0.11",
"rss-parser": "^3.7.0",
"uuid": "^3.4.0",
"vm2": "^3.6.10",
"xlsx": "^0.14.3",
"xml2js": "^0.4.22"