n8n/packages/nodes-base/nodes/Segment/TrackDescription.ts

672 lines
13 KiB
TypeScript
Raw Normal View History

import {
INodeProperties,
} from 'n8n-workflow';
2020-01-23 09:27:28 -08:00
export const trackOperations: INodeProperties[] = [
2020-01-23 09:27:28 -08:00
{
displayName: 'Operation',
name: 'operation',
type: 'options',
refactor: Apply more nodelinting rules (#3324) * :pencil2: Alphabetize lint rules * :fire: Remove duplicates * :zap: Update `lintfix` script * :shirt: Apply `node-param-operation-without-no-data-expression` (#3329) * :shirt: Apply `node-param-operation-without-no-data-expression` * :shirt: Add exceptions * :shirt: Apply `node-param-description-weak` (#3328) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-value-duplicate` (#3331) * :shirt: Apply `node-param-description-miscased-json` (#3337) * :shirt: Apply `node-param-display-name-excess-inner-whitespace` (#3335) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-type-options-missing-from-limit` (#3336) * Rule workig as intended * :pencil2: Uncomment rules Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-name-duplicate` (#3338) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-wrong-for-simplify` (#3334) * :zap: fix * :zap: exceptions * :zap: changed rule ignoring from file to line * :shirt: Apply `node-param-resource-without-no-data-expression` (#3339) * :shirt: Apply `node-param-display-name-untrimmed` (#3341) * :shirt: Apply `node-param-display-name-miscased-id` (#3340) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-resource-with-plural-option` (#3342) * :shirt: Apply `node-param-description-wrong-for-upsert` (#3333) * :zap: fix * :zap: replaced record with contact in description * :zap: fix Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-description-identical-to-name` (#3343) * :shirt: Apply `node-param-option-name-containing-star` (#3347) * :shirt: Apply `node-param-display-name-wrong-for-update-fields` (#3348) * :shirt: Apply `node-param-option-name-wrong-for-get-all` (#3345) * :zap: fix * :zap: exceptions * :shirt: Apply node-param-display-name-wrong-for-simplify (#3344) * Rule working as intended * Uncomented other rules * :shirt: Undo and add exceptions Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :zap: Alphabetize lint rules * :zap: Restore `lintfix` script Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com> Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
2022-05-20 14:47:24 -07:00
noDataExpression: true,
2020-01-23 09:27:28 -08:00
displayOptions: {
show: {
resource: [
'track',
],
},
},
options: [
{
name: 'Event',
value: 'event',
description: 'Record the actions your users perform. Every action triggers an event, which can also have associated properties.',
2020-01-23 09:27:28 -08:00
},
{
name: 'Page',
value: 'page',
description: 'Record page views on your website, along with optional extra information about the page being viewed',
2020-01-23 09:27:28 -08:00
},
],
default: 'event',
},
];
2020-01-23 09:27:28 -08:00
export const trackFields: INodeProperties[] = [
2020-01-23 09:27:28 -08:00
/* -------------------------------------------------------------------------- */
/* track:event */
/* -------------------------------------------------------------------------- */
{
displayName: 'User ID',
name: 'userId',
type: 'string',
default: '',
displayOptions: {
show: {
resource: [
'track',
],
operation: [
'event',
],
},
},
},
{
displayName: 'Event',
name: 'event',
type: 'string',
default: '',
displayOptions: {
show: {
resource: [
'track',
],
operation: [
'event',
],
},
},
description: 'Name of the action that a user has performed',
2020-01-23 09:27:28 -08:00
required: true,
},
{
displayName: 'Context',
name: 'context',
placeholder: 'Add Context',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
displayOptions: {
show: {
resource: [
'track',
],
operation: [
'event',
],
},
},
default: {},
options: [
{
name: 'contextUi',
displayName: 'Context',
values: [
{
displayName: 'Active',
name: 'active',
type: 'boolean',
refactor: Apply `eslint-plugin-n8n-nodes-base` autofixable rules (#3174) * :zap: Initial setup * :shirt: Update `.eslintignore` * :shirt: Autofix node-param-default-missing (#3173) * :fire: Remove duplicate key * :shirt: Add exceptions * :package: Update package-lock.json * :shirt: Apply `node-class-description-inputs-wrong-trigger-node` (#3176) * :shirt: Apply `node-class-description-inputs-wrong-regular-node` (#3177) * :shirt: Apply `node-class-description-outputs-wrong` (#3178) * :shirt: Apply `node-execute-block-double-assertion-for-items` (#3179) * :shirt: Apply `node-param-default-wrong-for-collection` (#3180) * :shirt: Apply node-param-default-wrong-for-boolean (#3181) * Autofixed default missing * Autofixed booleans, worked well * :zap: Fix params * :rewind: Undo exempted autofixes * :package: Update package-lock.json * :shirt: Apply node-class-description-missing-subtitle (#3182) * :zap: Fix missing comma * :shirt: Apply `node-param-default-wrong-for-fixed-collection` (#3184) * :shirt: Add exception for `node-class-description-missing-subtitle` * :shirt: Apply `node-param-default-wrong-for-multi-options` (#3185) * :shirt: Apply `node-param-collection-type-unsorted-items` (#3186) * Missing coma * :shirt: Apply `node-param-default-wrong-for-simplify` (#3187) * :shirt: Apply `node-param-description-comma-separated-hyphen` (#3190) * :shirt: Apply `node-param-description-empty-string` (#3189) * :shirt: Apply `node-param-description-excess-inner-whitespace` (#3191) * Rule looks good * Add whitespace rule in eslint config * :zao: fix * :shirt: Apply `node-param-description-identical-to-display-name` (#3193) * :shirt: Apply `node-param-description-missing-for-ignore-ssl-issues` (#3195) * :rewind: Revert ":zao: fix" This reverts commit ef8a76f3dfedffd1bdccf3178af8a8d90cf5a55c. * :shirt: Apply `node-param-description-missing-for-simplify` (#3196) * :shirt: Apply `node-param-description-missing-final-period` (#3194) * Rule working as intended * Add rule to eslint * :shirt: Apply node-param-description-missing-for-return-all (#3197) * :zap: 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>
2022-04-22 09:29:51 -07:00
default: false,
2020-01-23 09:27:28 -08:00
description: 'Whether a user is active',
},
{
displayName: 'IP',
name: 'ip',
type: 'string',
default: '',
description: 'Current users IP address',
2020-01-23 09:27:28 -08:00
},
{
displayName: 'Locale',
name: 'locate',
type: 'string',
default: '',
description: 'Locale string for the current user, for example en-US',
2020-01-23 09:27:28 -08:00
},
{
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: '',
},
2020-10-22 06:46:03 -07:00
],
2020-01-23 09:27:28 -08:00
},
],
},
{
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: '',
},
2020-10-22 06:46:03 -07:00
],
2020-01-23 09:27:28 -08:00
},
],
},
{
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: '',
},
],
},
],
},
2020-10-22 06:46:03 -07:00
],
2020-01-23 09:27:28 -08:00
},
],
},
{
displayName: 'Integration',
name: 'integrations',
placeholder: 'Add Integration',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
displayOptions: {
show: {
resource: [
'track',
],
operation: [
'event',
],
},
},
default: {},
options: [
{
name: 'integrationsUi',
displayName: 'Integration',
values: [
{
displayName: 'All',
name: 'all',
type: 'boolean',
default: true,
},
{
displayName: 'Salesforce',
name: 'salesforce',
type: 'boolean',
default: false,
},
],
},
],
},
{
displayName: 'Properties',
name: 'properties',
placeholder: 'Add Properties',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
2020-01-23 09:27:28 -08:00
},
displayOptions: {
show: {
resource: [
'track',
],
operation: [
'event',
],
},
},
default: {},
options: [
{
name: 'propertiesUi',
displayName: 'Property',
2020-01-23 09:27:28 -08:00
values: [
{
displayName: 'Key',
name: 'key',
2020-01-23 09:27:28 -08:00
type: 'string',
default: '',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
2020-01-23 09:27:28 -08:00
default: '',
},
],
},
],
},
/* -------------------------------------------------------------------------- */
/* track:page */
/* -------------------------------------------------------------------------- */
{
displayName: 'User ID',
name: 'userId',
type: 'string',
default: '',
displayOptions: {
show: {
resource: [
'track',
],
operation: [
'page',
],
},
},
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
displayOptions: {
show: {
resource: [
'track',
],
operation: [
'page',
],
},
},
description: 'Name of the page For example, most sites have a “Signup” page that can be useful to tag, so you can see users as they move through your funnel',
},
{
displayName: 'Context',
name: 'context',
placeholder: 'Add Context',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
displayOptions: {
show: {
resource: [
'track',
],
operation: [
'page',
],
},
},
default: {},
options: [
{
name: 'contextUi',
displayName: 'Context',
values: [
{
displayName: 'Active',
name: 'active',
type: 'boolean',
refactor: Apply `eslint-plugin-n8n-nodes-base` autofixable rules (#3174) * :zap: Initial setup * :shirt: Update `.eslintignore` * :shirt: Autofix node-param-default-missing (#3173) * :fire: Remove duplicate key * :shirt: Add exceptions * :package: Update package-lock.json * :shirt: Apply `node-class-description-inputs-wrong-trigger-node` (#3176) * :shirt: Apply `node-class-description-inputs-wrong-regular-node` (#3177) * :shirt: Apply `node-class-description-outputs-wrong` (#3178) * :shirt: Apply `node-execute-block-double-assertion-for-items` (#3179) * :shirt: Apply `node-param-default-wrong-for-collection` (#3180) * :shirt: Apply node-param-default-wrong-for-boolean (#3181) * Autofixed default missing * Autofixed booleans, worked well * :zap: Fix params * :rewind: Undo exempted autofixes * :package: Update package-lock.json * :shirt: Apply node-class-description-missing-subtitle (#3182) * :zap: Fix missing comma * :shirt: Apply `node-param-default-wrong-for-fixed-collection` (#3184) * :shirt: Add exception for `node-class-description-missing-subtitle` * :shirt: Apply `node-param-default-wrong-for-multi-options` (#3185) * :shirt: Apply `node-param-collection-type-unsorted-items` (#3186) * Missing coma * :shirt: Apply `node-param-default-wrong-for-simplify` (#3187) * :shirt: Apply `node-param-description-comma-separated-hyphen` (#3190) * :shirt: Apply `node-param-description-empty-string` (#3189) * :shirt: Apply `node-param-description-excess-inner-whitespace` (#3191) * Rule looks good * Add whitespace rule in eslint config * :zao: fix * :shirt: Apply `node-param-description-identical-to-display-name` (#3193) * :shirt: Apply `node-param-description-missing-for-ignore-ssl-issues` (#3195) * :rewind: Revert ":zao: fix" This reverts commit ef8a76f3dfedffd1bdccf3178af8a8d90cf5a55c. * :shirt: Apply `node-param-description-missing-for-simplify` (#3196) * :shirt: Apply `node-param-description-missing-final-period` (#3194) * Rule working as intended * Add rule to eslint * :shirt: Apply node-param-description-missing-for-return-all (#3197) * :zap: 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>
2022-04-22 09:29:51 -07:00
default: false,
2020-01-23 09:27:28 -08:00
description: 'Whether a user is active',
},
{
displayName: 'IP',
name: 'ip',
type: 'string',
default: '',
description: 'Current users IP address',
2020-01-23 09:27:28 -08:00
},
{
displayName: 'Locale',
name: 'locate',
type: 'string',
default: '',
description: 'Locale string for the current user, for example en-US',
2020-01-23 09:27:28 -08:00
},
{
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: '',
},
2020-10-22 06:46:03 -07:00
],
2020-01-23 09:27:28 -08:00
},
],
},
{
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: '',
},
2020-10-22 06:46:03 -07:00
],
2020-01-23 09:27:28 -08:00
},
],
},
{
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: '',
},
],
},
],
},
2020-10-22 06:46:03 -07:00
],
2020-01-23 09:27:28 -08:00
},
],
},
{
displayName: 'Integration',
name: 'integrations',
placeholder: 'Add Integration',
type: 'fixedCollection',
typeOptions: {
multipleValues: false,
},
displayOptions: {
show: {
resource: [
'track',
],
operation: [
'page',
],
},
},
default: {},
options: [
{
name: 'integrationsUi',
displayName: 'Integration',
values: [
{
displayName: 'All',
name: 'all',
type: 'boolean',
default: true,
},
{
displayName: 'Salesforce',
name: 'salesforce',
type: 'boolean',
default: false,
},
],
},
],
},
{
displayName: 'Properties',
name: 'properties',
placeholder: 'Add Properties',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
2020-01-23 09:27:28 -08:00
},
displayOptions: {
show: {
resource: [
'track',
],
operation: [
'page',
],
},
},
default: {},
options: [
{
name: 'propertiesUi',
displayName: 'Property',
2020-01-23 09:27:28 -08:00
values: [
{
displayName: 'Key',
name: 'key',
2020-01-23 09:27:28 -08:00
type: 'string',
default: '',
},
{
displayName: 'Value',
name: 'value',
2020-01-23 09:27:28 -08:00
type: 'string',
default: '',
},
],
},
],
},
];