mirror of
https://github.com/n8n-io/n8n.git
synced 2024-11-10 14:44:05 -08:00
0448feec56
* ⚡ Initial setup
* 👕 Update `.eslintignore`
* 👕 Autofix node-param-default-missing (#3173)
* 🔥 Remove duplicate key
* 👕 Add exceptions
* 📦 Update package-lock.json
* 👕 Apply `node-class-description-inputs-wrong-trigger-node` (#3176)
* 👕 Apply `node-class-description-inputs-wrong-regular-node` (#3177)
* 👕 Apply `node-class-description-outputs-wrong` (#3178)
* 👕 Apply `node-execute-block-double-assertion-for-items` (#3179)
* 👕 Apply `node-param-default-wrong-for-collection` (#3180)
* 👕 Apply node-param-default-wrong-for-boolean (#3181)
* Autofixed default missing
* Autofixed booleans, worked well
* ⚡ Fix params
* ⏪ Undo exempted autofixes
* 📦 Update package-lock.json
* 👕 Apply node-class-description-missing-subtitle (#3182)
* ⚡ Fix missing comma
* 👕 Apply `node-param-default-wrong-for-fixed-collection` (#3184)
* 👕 Add exception for `node-class-description-missing-subtitle`
* 👕 Apply `node-param-default-wrong-for-multi-options` (#3185)
* 👕 Apply `node-param-collection-type-unsorted-items` (#3186)
* Missing coma
* 👕 Apply `node-param-default-wrong-for-simplify` (#3187)
* 👕 Apply `node-param-description-comma-separated-hyphen` (#3190)
* 👕 Apply `node-param-description-empty-string` (#3189)
* 👕 Apply `node-param-description-excess-inner-whitespace` (#3191)
* Rule looks good
* Add whitespace rule in eslint config
* :zao: fix
* 👕 Apply `node-param-description-identical-to-display-name` (#3193)
* 👕 Apply `node-param-description-missing-for-ignore-ssl-issues` (#3195)
* ⏪ Revert ":zao: fix"
This reverts commit ef8a76f3df.
* 👕 Apply `node-param-description-missing-for-simplify` (#3196)
* 👕 Apply `node-param-description-missing-final-period` (#3194)
* Rule working as intended
* Add rule to eslint
* 👕 Apply node-param-description-missing-for-return-all (#3197)
* ⚡ Restore `lintfix` command
Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
Co-authored-by: Omar Ajoue <krynble@gmail.com>
Co-authored-by: agobrech <ael.gobrecht@gmail.com>
Co-authored-by: Michael Kret <michael.k@radency.com>
644 lines
19 KiB
TypeScript
644 lines
19 KiB
TypeScript
import {
|
|
IExecuteFunctions,
|
|
} from 'n8n-core';
|
|
|
|
import {
|
|
IDataObject,
|
|
INodeExecutionData,
|
|
INodeType,
|
|
INodeTypeDescription,
|
|
} from 'n8n-workflow';
|
|
|
|
import {
|
|
segmentApiRequest,
|
|
} from './GenericFunctions';
|
|
|
|
import {
|
|
groupFields,
|
|
groupOperations,
|
|
} from './GroupDescription';
|
|
|
|
import {
|
|
identifyFields,
|
|
identifyOperations,
|
|
} from './IdentifyDescription';
|
|
|
|
import {
|
|
IIdentify,
|
|
} from './IdentifyInterface';
|
|
|
|
import {
|
|
trackFields,
|
|
trackOperations,
|
|
} from './TrackDescription';
|
|
|
|
import {
|
|
IGroup,
|
|
ITrack,
|
|
} from './TrackInterface';
|
|
|
|
import { v4 as uuid } from 'uuid';
|
|
|
|
export class Segment implements INodeType {
|
|
description: INodeTypeDescription = {
|
|
displayName: 'Segment',
|
|
name: 'segment',
|
|
icon: 'file:segment.svg',
|
|
group: ['output'],
|
|
version: 1,
|
|
subtitle: '={{$parameter["operation"] + ":" + $parameter["resource"]}}',
|
|
description: 'Consume Segment API',
|
|
defaults: {
|
|
name: 'Segment',
|
|
},
|
|
inputs: ['main'],
|
|
outputs: ['main'],
|
|
credentials: [
|
|
{
|
|
name: 'segmentApi',
|
|
required: true,
|
|
},
|
|
],
|
|
properties: [
|
|
{
|
|
displayName: 'Resource',
|
|
name: 'resource',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'Group',
|
|
value: 'group',
|
|
description: 'Group lets you associate an identified user with a group',
|
|
},
|
|
{
|
|
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.',
|
|
},
|
|
...groupOperations,
|
|
...groupFields,
|
|
...identifyOperations,
|
|
...trackOperations,
|
|
...identifyFields,
|
|
...trackFields,
|
|
],
|
|
};
|
|
|
|
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
|
|
const items = this.getInputData();
|
|
const returnData: IDataObject[] = [];
|
|
const length = items.length;
|
|
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++) {
|
|
try {
|
|
if (resource === 'group') {
|
|
//https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#group
|
|
if (operation === 'add') {
|
|
const userId = this.getNodeParameter('userId', i) as string;
|
|
const groupId = this.getNodeParameter('groupId', 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: IGroup = {
|
|
groupId,
|
|
traits: {
|
|
company: {},
|
|
address: {},
|
|
},
|
|
context: {
|
|
app: {},
|
|
campaign: {},
|
|
device: {},
|
|
},
|
|
integrations: {},
|
|
};
|
|
if (userId) {
|
|
body.userId = userId as string;
|
|
} else {
|
|
body.anonymousId = uuid();
|
|
}
|
|
if (traits) {
|
|
if (traits && traits.length !== 0) {
|
|
for (const trait of traits) {
|
|
body.traits![trait.key as string] = trait.value;
|
|
}
|
|
}
|
|
}
|
|
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', '/group', body);
|
|
}
|
|
}
|
|
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 context = (this.getNodeParameter('context', i) as IDataObject).contextUi as IDataObject;
|
|
const traits = (this.getNodeParameter('traits', i) as IDataObject).traitsUi as IDataObject[];
|
|
const integrations = (this.getNodeParameter('integrations', i) as IDataObject).integrationsUi as IDataObject;
|
|
const body: IIdentify = {
|
|
context: {
|
|
app: {},
|
|
campaign: {},
|
|
device: {},
|
|
},
|
|
traits: {},
|
|
integrations: {},
|
|
};
|
|
if (userId) {
|
|
body.userId = userId as string;
|
|
} else {
|
|
body.anonymousId = uuid();
|
|
}
|
|
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 (traits) {
|
|
if (traits && traits.length !== 0) {
|
|
for (const trait of traits) {
|
|
body.traits![trait.key as string] = trait.value;
|
|
}
|
|
}
|
|
}
|
|
|
|
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 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: {
|
|
},
|
|
context: {
|
|
app: {},
|
|
campaign: {},
|
|
device: {},
|
|
},
|
|
integrations: {},
|
|
properties: {},
|
|
};
|
|
if (userId) {
|
|
body.userId = userId as string;
|
|
} else {
|
|
body.anonymousId = uuid();
|
|
}
|
|
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 && properties.length !== 0) {
|
|
for (const property of properties) {
|
|
body.properties![property.key as string] = property.value;
|
|
}
|
|
}
|
|
}
|
|
|
|
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 name = this.getNodeParameter('name', i) as string;
|
|
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 = {
|
|
name,
|
|
traits: {},
|
|
context: {
|
|
app: {},
|
|
campaign: {},
|
|
device: {},
|
|
},
|
|
integrations: {},
|
|
properties: {},
|
|
};
|
|
if (userId) {
|
|
body.userId = userId as string;
|
|
} else {
|
|
body.anonymousId = uuid();
|
|
}
|
|
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 && properties.length !== 0) {
|
|
for (const property of properties) {
|
|
body.properties![property.key as string] = property.value;
|
|
}
|
|
}
|
|
}
|
|
responseData = await segmentApiRequest.call(this, 'POST', '/page', body);
|
|
}
|
|
}
|
|
} catch (error) {
|
|
if (this.continueOnFail()) {
|
|
returnData.push({ error: error.message });
|
|
continue;
|
|
}
|
|
throw error;
|
|
}
|
|
if (Array.isArray(responseData)) {
|
|
returnData.push.apply(returnData, responseData as IDataObject[]);
|
|
} else {
|
|
returnData.push(responseData as IDataObject);
|
|
}
|
|
}
|
|
return [this.helpers.returnJsonArray(returnData)];
|
|
}
|
|
}
|