| Pattern | Inserts |
|---|
| $$ | Inserts a "$". |
| $& | Inserts the matched substring. |
| $` | Inserts the portion of the string that precedes the matched substring. |
| $\' | Inserts the portion of the string that follows the matched substring. |
| $n | Where n is a positive integer less than 100, inserts the nth parenthesized submatch string, provided the first argument was a RegExp object. Note that this is 1-indexed. If a group n is not present (e.g., if group is 3), it will be replaced as a literal (e.g., $3). |
| $ | Where Name is a capturing group name. If the group is not in the match, or not in the regular expression, or if a string was passed as the first argument to replace instead of a regular expression, this resolves to a literal (e.g., $). |
',
- },
- {
- displayName: 'Predefined Rule',
- name: 'predefinedRule',
- displayOptions: {
- show: {
- action: ['replace'],
- replaceMode: ['predefinedRule'],
- },
- },
- type: 'options',
- options: [
- {
- name: 'Tags',
- value: 'tags',
- description: 'Replace all tags',
- },
- {
- name: 'Character Groups',
- value: 'characterGroups',
- description: 'Replace all defined character groups',
- },
- ],
- default: 'tags',
- },
- {
- displayName: 'Only Recognised HTML',
- name: 'onlyRecognisedHTML',
- displayOptions: {
- show: {
- action: ['replace'],
- replaceMode: ['predefinedRule'],
- predefinedRule: ['tags'],
- },
- },
- type: 'boolean',
- default: false,
- },
- {
- displayName: 'Newline',
- name: 'newline',
- displayOptions: {
- show: {
- action: ['replace'],
- replaceMode: ['predefinedRule'],
- predefinedRule: ['characterGroups'],
- },
- },
- type: 'boolean',
- default: false,
- },
- {
- displayName: 'Newline Min',
- name: 'newlineMin',
- displayOptions: {
- show: {
- action: ['replace'],
- replaceMode: ['predefinedRule'],
- predefinedRule: ['characterGroups'],
- newline: [true],
- },
- },
- type: 'number',
- default: 1,
- },
- {
- displayName: 'Newline Max',
- name: 'newlineMax',
- displayOptions: {
- show: {
- action: ['replace'],
- replaceMode: ['predefinedRule'],
- predefinedRule: ['characterGroups'],
- newline: [true],
- },
- },
- type: 'number',
- default: 1,
- },
- {
- displayName: 'Number',
- name: 'number',
- displayOptions: {
- show: {
- action: ['replace'],
- replaceMode: ['predefinedRule'],
- predefinedRule: ['characterGroups'],
- },
- },
- type: 'boolean',
- default: false,
- },
- {
- displayName: 'Number Min',
- name: 'numberMin',
- displayOptions: {
- show: {
- action: ['replace'],
- replaceMode: ['predefinedRule'],
- predefinedRule: ['characterGroups'],
- number: [true],
- },
- },
- type: 'number',
- default: 1,
- },
- {
- displayName: 'Number Max',
- name: 'numberMax',
- displayOptions: {
- show: {
- action: ['replace'],
- replaceMode: ['predefinedRule'],
- predefinedRule: ['characterGroups'],
- number: [true],
- },
- },
- type: 'number',
- default: 1,
- },
- {
- displayName: 'Alpha',
- name: 'alpha',
- displayOptions: {
- show: {
- action: ['replace'],
- replaceMode: ['predefinedRule'],
- predefinedRule: ['characterGroups'],
- },
- },
- type: 'boolean',
- default: false,
- },
- {
- displayName: 'Alpha Min',
- name: 'alphaMin',
- displayOptions: {
- show: {
- action: ['replace'],
- replaceMode: ['predefinedRule'],
- predefinedRule: ['characterGroups'],
- alpha: [true],
- },
- },
- type: 'number',
- default: 1,
- },
- {
- displayName: 'Alpha Max',
- name: 'alphaMax',
- displayOptions: {
- show: {
- action: ['replace'],
- replaceMode: ['predefinedRule'],
- predefinedRule: ['characterGroups'],
- alpha: [true],
- },
- },
- type: 'number',
- default: 1,
- },
- {
- displayName: 'Whitespace',
- name: 'whitespace',
- displayOptions: {
- show: {
- action: ['replace'],
- replaceMode: ['predefinedRule'],
- predefinedRule: ['characterGroups'],
- },
- },
- type: 'boolean',
- default: false,
- },
- {
- displayName: 'Whitespace Min',
- name: 'whitespaceMin',
- displayOptions: {
- show: {
- action: ['replace'],
- replaceMode: ['predefinedRule'],
- predefinedRule: ['characterGroups'],
- whitespace: [true],
- },
- },
- type: 'number',
- default: 1,
- },
- {
- displayName: 'Whitespace Max',
- name: 'whitespaceMax',
- displayOptions: {
- show: {
- action: ['replace'],
- replaceMode: ['predefinedRule'],
- predefinedRule: ['characterGroups'],
- whitespace: [true],
- },
- },
- type: 'number',
- default: 1,
- },
- {
- displayName: 'Substring',
- name: 'substring',
- displayOptions: {
- show: {
- action: ['replace'],
- replaceMode: ['substring', 'extendedSubstring'],
- },
- },
- type: 'string',
- default: '',
- required: true,
- placeholder: 'sub',
- description: 'The substring to be replaced',
- },
- {
- displayName: 'Value',
- name: 'value',
- displayOptions: {
- show: {
- action: ['replace'],
- replaceMode: ['substring', 'extendedSubstring', 'predefinedRule'],
- },
- },
- type: 'string',
- default: '',
- placeholder: '',
- description: 'The value that should replace the substring',
- },
- {
- displayName: 'Replace All',
- name: 'replaceAll',
- displayOptions: {
- show: {
- action: ['replace'],
- replaceMode: ['substring', 'extendedSubstring'],
- },
- },
- type: 'boolean',
- default: true,
- placeholder: '',
- description:
- 'Whether all substrings should be replaced (not only the first)',
- },
- {
- displayName: 'Extended',
- name: 'extended',
- displayOptions: {
- show: {
- action: ['replace'],
- },
- },
- type: 'boolean',
- default: false,
- placeholder: '',
- description:
- 'Whether all escape characters should be used for replacement (\\n, \\r, \\t, ...)',
- },
- {
- displayName: 'Trim',
- name: 'trim',
- displayOptions: {
- show: {
- action: ['trim'],
- },
- },
- type: 'options',
- options: [
- {
- name: 'Trim Both',
- value: 'trimBoth',
- description: 'Removes characters from the beginning and end',
- },
- {
- name: 'Trim Start',
- value: 'trimStart',
- description: 'Removes characters from the beginning',
- },
- {
- name: 'Trim End',
- value: 'trimEnd',
- description: 'Removes characters from the end',
- },
- ],
- default: 'trimBoth',
- },
- {
- displayName: 'Trim String',
- name: 'trimString',
- displayOptions: {
- show: {
- action: ['trim'],
- },
- },
- type: 'string',
- default: ' ',
- required: true,
- description: 'The string to trim',
- },
- {
- displayName: 'Trim String as an Unit',
- name: 'trimStringUnit',
- displayOptions: {
- show: {
- action: ['trim'],
- },
- },
- type: 'boolean',
- default: true,
- required: true,
- description:
- 'Whether to use the trim chain as a whole unit and not each individual character in that chain',
- },
- {
- displayName: 'Pad',
- name: 'pad',
- displayOptions: {
- show: {
- action: ['pad'],
- },
- },
- type: 'options',
- options: [
- {
- name: 'Pad Start',
- value: 'padStart',
- description: 'Pad the string at the beginning',
- },
- {
- name: 'Pad End',
- value: 'padEnd',
- description: 'Pad the string at the end',
- },
- ],
- default: 'padStart',
- },
- {
- displayName: 'Target Length',
- name: 'targetLength',
- displayOptions: {
- show: {
- action: ['pad'],
- },
- },
- type: 'number',
- typeOptions: {
- minValue: 0,
- },
- default: 1,
- required: true,
- placeholder: '1',
- description: 'The length to which the string should be padded',
- },
- {
- displayName: 'Pad String',
- name: 'padString',
- displayOptions: {
- show: {
- action: ['pad'],
- },
- },
- type: 'string',
- default: ' ',
- required: true,
- description: 'The filling string',
- },
- {
- displayName: 'Start Position',
- name: 'startPosition',
- displayOptions: {
- show: {
- action: ['substring'],
- },
- },
- type: 'number',
- default: 0,
- placeholder: '0',
- description:
- 'The start position (string begins with 0). Can also be negativ.',
- },
- {
- displayName: 'End',
- name: 'end',
- displayOptions: {
- show: {
- action: ['substring'],
- },
- },
- type: 'options',
- options: [
- {
- name: 'Complete',
- value: 'complete',
- description: 'Selects everything to the end',
- },
- {
- name: 'Position',
- value: 'position',
- description:
- 'Selects everything up to the position (exclusive position). Can also be negative.',
- },
- {
- name: 'Length',
- value: 'length',
- description: 'The length of the selected rows',
- },
- ],
- default: 'complete',
- description: 'The end of the substring',
- },
- {
- displayName: 'Position',
- name: 'endPosition',
- displayOptions: {
- show: {
- action: ['substring'],
- end: ['position'],
- },
- },
- type: 'number',
- default: 1,
- placeholder: '1',
- description: 'The end position of the substring. Can also be negative.',
- },
- {
- displayName: 'Length',
- name: 'endLength',
- displayOptions: {
- show: {
- action: ['substring'],
- end: ['length'],
- },
- },
- typeOptions: {
- minValue: 0,
- },
- type: 'number',
- default: 1,
- placeholder: '1',
- description: 'The length of the substring',
- },
- {
- displayName: 'Times',
- name: 'times',
- displayOptions: {
- show: {
- action: ['repeat'],
- },
- },
- type: 'number',
- typeOptions: {
- minValue: 0,
- },
- default: 1,
- required: true,
- placeholder: '1',
- description: 'The number of times the string should be repeated',
- },
- ],
- },
- ],
- },
- ],
- },
- ],
- },
- ],
- };
+ description: INodeTypeDescription = {
+ displayName: 'TextManipulation',
+ name: 'textManipulation',
+ icon: 'file:TextManipulation.svg',
+ group: ['transform'],
+ version: 1,
+ description: 'Allows you to manipulate string values.',
+ defaults: {
+ name: 'TextManipulation',
+ },
+ inputs: [NodeConnectionType.Main],
+ outputs: [NodeConnectionType.Main],
+ properties: [
+ {
+ displayName: 'Keep Only Set',
+ name: 'keepOnlySet',
+ type: 'boolean',
+ default: false,
+ description:
+ 'Whether only the values set on this node should be kept and all others removed',
+ },
+ {
+ displayName: 'Texts with Manipulations',
+ name: 'textsWithManipulations',
+ placeholder: 'Add Texts Manipulations',
+ type: 'fixedCollection',
+ typeOptions: {
+ multipleValues: true,
+ sortable: true,
+ },
+ description: 'The texts to manipulate',
+ default: {},
+ options: [
+ {
+ name: 'textsWithManipulationsValues',
+ displayName: 'Texts with Manipulations',
+ values: [
+ {
+ displayName: 'Data Sources',
+ name: 'dataSources',
+ placeholder: 'Add Data Source',
+ type: 'fixedCollection',
+ typeOptions: {
+ multipleValues: true,
+ sortable: true,
+ },
+ description: 'The data sources for the manipulations',
+ default: {},
+ options: [
+ {
+ displayName: 'Data Source',
+ name: 'dataSource',
+ values: [
+ {
+ displayName: 'Read Operation',
+ name: 'readOperation',
+ type: 'options',
+ options: [
+ {
+ name: 'Text',
+ value: 'fromText',
+ description: 'Declare text directly',
+ },
+ {
+ name: 'Read From File',
+ value: 'fromFile',
+ description: 'Read text from file',
+ },
+ {
+ name: 'Read From JSON',
+ value: 'fromJSON',
+ description: 'Read text from JSON',
+ },
+ ],
+ default: 'fromText',
+ },
+ {
+ displayName: 'Binary Property',
+ name: 'binaryPropertyName',
+ required: true,
+ displayOptions: {
+ show: {
+ readOperation: ['fromFile'],
+ },
+ },
+ type: 'string',
+ default: 'data',
+ description:
+ 'Name of the binary property from which the binary data is to be read',
+ },
+ {
+ displayName: 'Decode With',
+ name: 'fileDecodeWith',
+ displayOptions: {
+ show: {
+ readOperation: ['fromFile'],
+ },
+ },
+ type: 'options',
+ options: encodeDecodeOptions,
+ default: 'utf8',
+ },
+ {
+ displayName: 'Strip BOM',
+ name: 'fileStripBOM',
+ displayOptions: {
+ show: {
+ readOperation: ['fromFile'],
+ fileDecodeWith: bomAware,
+ },
+ },
+ type: 'boolean',
+ default: true,
+ },
+ {
+ displayName: 'Get Manipulated Data',
+ name: 'getManipulatedData',
+ required: true,
+ displayOptions: {
+ show: {
+ readOperation: ['fromFile', 'fromJSON'],
+ },
+ },
+ type: 'boolean',
+ default: false,
+ description:
+ 'Whether to use the newly manipulated data instead of the raw data. If none are available, raw data is used.',
+ },
+ {
+ displayName: 'Source Key',
+ name: 'sourceKey',
+ required: true,
+ displayOptions: {
+ show: {
+ readOperation: ['fromJSON'],
+ },
+ },
+ type: 'string',
+ default: 'data',
+ description:
+ 'The name of the JSON key to get data from.It is also possible to define deep keys by using dot-notation like for example:"level1.level2.currentKey"',
+ },
+ {
+ displayName: 'Skip Non-String',
+ name: 'skipNonString',
+ required: true,
+ displayOptions: {
+ show: {
+ readOperation: ['fromJSON'],
+ },
+ },
+ type: 'boolean',
+ default: true,
+ description:
+ 'Whether to skip non-string data. If they are not skipped, they are automatically converted to a string.',
+ },
+ {
+ displayName: 'Text',
+ name: 'text',
+ required: true,
+ displayOptions: {
+ show: {
+ readOperation: ['fromText'],
+ },
+ },
+ type: 'string',
+ default: '',
+ description: 'Plain text',
+ },
+ {
+ displayName: 'Write Operation',
+ name: 'writeOperation',
+ type: 'options',
+ options: [
+ {
+ name: 'Write to File',
+ value: 'toFile',
+ description: 'Write the manipulated text to a file',
+ },
+ {
+ name: 'Write to JSON',
+ value: 'toJSON',
+ description: 'Write the manipulated text to a JSON key',
+ },
+ ],
+ default: 'toJSON',
+ },
+ {
+ displayName: 'Destination Binary Property',
+ name: 'destinationBinaryPropertyName',
+ required: true,
+ displayOptions: {
+ show: {
+ writeOperation: ['toFile'],
+ },
+ },
+ type: 'string',
+ default: 'data',
+ description:
+ 'Name of the binary property where the binary data should be written',
+ },
+ {
+ displayName: 'Encode With',
+ name: 'fileEncodeWith',
+ displayOptions: {
+ show: {
+ writeOperation: ['toFile'],
+ },
+ },
+ type: 'options',
+ options: encodeDecodeOptions,
+ default: 'utf8',
+ },
+ {
+ displayName: 'Add BOM',
+ name: 'fileAddBOM',
+ displayOptions: {
+ show: {
+ writeOperation: ['toFile'],
+ fileEncodeWith: bomAware,
+ },
+ },
+ type: 'boolean',
+ default: false,
+ },
+ {
+ displayName: 'File Name',
+ name: 'fileName',
+ type: 'string',
+ displayOptions: {
+ show: {
+ writeOperation: ['toFile'],
+ },
+ },
+ default: '',
+ placeholder: 'example.txt',
+ description: 'The file name to set',
+ },
+ {
+ displayName: 'Mime Type',
+ name: 'mimeType',
+ type: 'string',
+ displayOptions: {
+ show: {
+ writeOperation: ['toFile'],
+ },
+ },
+ default: 'text/plain',
+ placeholder: 'text/plain',
+ description:
+ 'The mime-type to set. By default will the mime-type for plan text be set.',
+ },
+ {
+ displayName: 'Destination Key',
+ name: 'destinationKey',
+ displayOptions: {
+ show: {
+ writeOperation: ['toJSON'],
+ },
+ },
+ type: 'string',
+ default: 'data',
+ required: true,
+ placeholder: 'data',
+ description:
+ 'The name the JSON key to copy data to. It is also possibleto define deep keys by using dot-notation like for example:"level1.level2.newKey".',
+ },
+ ],
+ },
+ ],
+ },
+ {
+ displayName: 'Manipulations',
+ name: 'manipulations',
+ placeholder: 'Add Manipulation',
+ type: 'fixedCollection',
+ typeOptions: {
+ multipleValues: true,
+ sortable: true,
+ },
+ description: 'The manipulations for the data sources',
+ default: {},
+ options: [
+ {
+ name: 'manipulation',
+ displayName: 'Manipulation',
+ values: [
+ {
+ displayName: 'Action',
+ name: 'action',
+ type: 'options',
+ options: [
+ {
+ name: 'Concat',
+ value: 'concat',
+ description: 'Add string to the beginning or/and end',
+ action: 'Add string to the beginning or and end',
+ },
+ {
+ name: 'Decode/Encode',
+ value: 'decodeEncode',
+ description: 'Decode and Encode string',
+ action: 'Decode and encode string',
+ },
+ {
+ name: 'Decode/Encode Entities',
+ value: 'decodeEncodeEntities',
+ description: 'Decode and Encode HTML & XML entities',
+ action: 'Decode and encode html xml entities',
+ },
+ {
+ name: 'Letter Case',
+ value: 'letterCase',
+ description: 'Upper and lowercase letters in a string',
+ action: 'Upper and lowercase letters in a string',
+ },
+ {
+ name: 'Normalize',
+ value: 'normalize',
+ description: 'Normalize a string',
+ action: 'Normalize a string',
+ },
+ {
+ name: 'Pad',
+ value: 'pad',
+ description: 'Pad the string at the beginning or end',
+ action: 'Pad the string at the beginning or end',
+ },
+ {
+ name: 'Repeat',
+ value: 'repeat',
+ description: 'Repeat the string',
+ action: 'Repeat the string',
+ },
+ {
+ name: 'Replace',
+ value: 'replace',
+ description: 'Replace a substring or regex',
+ action: 'Replace a substring or regex',
+ },
+ {
+ name: 'Substring',
+ value: 'substring',
+ description: 'Get a substring',
+ action: 'Get a substring',
+ },
+ {
+ name: 'Trim',
+ value: 'trim',
+ description: 'Removes characters from the beginning or/and end',
+ action: 'Removes characters from the beginning or and end',
+ },
+ ],
+ default: 'letterCase',
+ },
+ {
+ displayName: 'Normalize Form',
+ name: 'normalizeForm',
+ displayOptions: {
+ show: {
+ action: ['normalize'],
+ },
+ },
+ type: 'options',
+ options: [
+ {
+ name: 'NFC',
+ value: 'nfc',
+ description:
+ 'Canonical Decomposition, followed by Canonical Composition',
+ },
+ {
+ name: 'NFD',
+ value: 'nfd',
+ description: 'Canonical Decomposition',
+ },
+ {
+ name: 'NFKC',
+ value: 'nfkc',
+ description:
+ 'Compatibility Decomposition, followed by Canonical Composition',
+ },
+ {
+ name: 'NFKD',
+ value: 'nfkd',
+ description: 'Compatibility Decomposition',
+ },
+ ],
+ default: 'nfc',
+ },
+ {
+ displayName: 'Case Type',
+ name: 'caseType',
+ displayOptions: {
+ show: {
+ action: ['letterCase'],
+ },
+ },
+ type: 'options',
+ options: [
+ {
+ name: 'Camel Case',
+ value: 'camelCase',
+ description: 'Converts string to camel case',
+ },
+ {
+ name: 'Capitalize',
+ value: 'capitalize',
+ description: 'Capitalize text',
+ },
+ {
+ name: 'Kebab Case',
+ value: 'kebabCase',
+ description: 'Converts string to kebab case',
+ },
+ {
+ name: 'Locale Lower Case',
+ value: 'localeLowerCase',
+ description: 'Locale lower case all characters',
+ },
+ {
+ name: 'Locale Upper Case',
+ value: 'localeUpperCase',
+ description: 'Locale upper case all characters',
+ },
+ {
+ name: 'Lower Case',
+ value: 'lowerCase',
+ description: 'Lower case all characters',
+ },
+ {
+ name: 'Snake Case',
+ value: 'snakeCase',
+ description: 'Converts string to snake case',
+ },
+ {
+ name: 'Start Case',
+ value: 'startCase',
+ description: 'Converts string to start case',
+ },
+ {
+ name: 'Titlecase',
+ value: 'titlecase',
+ description: 'Titlecase text',
+ },
+ {
+ name: 'Upper Case',
+ value: 'upperCase',
+ description: 'Upper case all characters',
+ },
+ ],
+ default: 'lowerCase',
+ },
+ {
+ displayName: 'Language',
+ name: 'language',
+ displayOptions: {
+ show: {
+ action: ['letterCase'],
+ caseType: ['localeLowerCase', 'localeUpperCase'],
+ },
+ },
+ type: 'string',
+ default: 'en',
+ required: true,
+ description: 'Change the language of the localbase method',
+ },
+ {
+ displayName: 'Before',
+ name: 'before',
+ displayOptions: {
+ show: {
+ action: ['concat'],
+ },
+ },
+ type: 'string',
+ default: '',
+ description: 'String to be added at the beginning',
+ },
+ {
+ displayName: 'After',
+ name: 'after',
+ displayOptions: {
+ show: {
+ action: ['concat'],
+ },
+ },
+ type: 'string',
+ default: '',
+ description: 'String to be added at the end',
+ },
+ {
+ displayName: 'Decode With',
+ name: 'decodeWith',
+ displayOptions: {
+ show: {
+ action: ['decodeEncode'],
+ },
+ },
+ type: 'options',
+ options: encodeDecodeOptions,
+ default: 'utf8',
+ },
+ {
+ displayName: 'Decode With',
+ name: 'decodeWithEntities',
+ displayOptions: {
+ show: {
+ action: ['decodeEncodeEntities'],
+ },
+ },
+ type: 'options',
+ options: [
+ {
+ name: 'Html',
+ value: 'html',
+ },
+ {
+ name: 'Nothing',
+ value: 'nothing',
+ },
+ {
+ name: 'Url',
+ value: 'url',
+ },
+ {
+ name: 'Url Component',
+ value: 'urlComponent',
+ },
+ {
+ name: 'Xml',
+ value: 'xml',
+ },
+ ],
+ default: 'nothing',
+ },
+ {
+ displayName: 'Decode Mode',
+ name: 'entitiesDecodeMode',
+ displayOptions: {
+ show: {
+ action: ['decodeEncodeEntities'],
+ decodeWithEntities: ['xml', 'html'],
+ },
+ },
+ type: 'options',
+ options: [
+ {
+ name: 'Legacy',
+ value: 'legacy',
+ },
+ {
+ name: 'Strict',
+ value: 'strict',
+ },
+ ],
+ default: 'legacy',
+ },
+ {
+ displayName: 'Strip BOM',
+ name: 'stripBOM',
+ displayOptions: {
+ show: {
+ action: ['decodeEncode'],
+ decodeWith: bomAware,
+ },
+ },
+ type: 'boolean',
+ default: true,
+ },
+ {
+ displayName: 'Encode With',
+ name: 'encodeWith',
+ displayOptions: {
+ show: {
+ action: ['decodeEncode'],
+ },
+ },
+ type: 'options',
+ options: encodeDecodeOptions,
+ default: 'utf8',
+ },
+ {
+ displayName: 'Encode With',
+ name: 'encodeWithEntities',
+ displayOptions: {
+ show: {
+ action: ['decodeEncodeEntities'],
+ },
+ },
+ type: 'options',
+ options: [
+ {
+ name: 'Html',
+ value: 'html',
+ },
+ {
+ name: 'Nothing',
+ value: 'nothing',
+ },
+ {
+ name: 'Url',
+ value: 'url',
+ },
+ {
+ name: 'Url Component',
+ value: 'urlComponent',
+ },
+ {
+ name: 'Xml',
+ value: 'xml',
+ },
+ ],
+ default: 'nothing',
+ },
+ {
+ displayName: 'Encode Mode',
+ name: 'entitiesEncodeMode',
+ displayOptions: {
+ show: {
+ action: ['decodeEncodeEntities'],
+ encodeWithEntities: ['xml', 'html'],
+ },
+ },
+ type: 'options',
+ options: [
+ {
+ name: 'Extensive',
+ value: 'extensive',
+ },
+ {
+ name: 'UTF8',
+ value: 'utf8',
+ },
+ {
+ name: 'NonAscii',
+ value: 'nonAscii',
+ },
+ ],
+ default: 'extensive',
+ },
+ {
+ displayName: 'Add BOM',
+ name: 'addBOM',
+ displayOptions: {
+ show: {
+ action: ['decodeEncode'],
+ encodeWith: bomAware,
+ },
+ },
+ type: 'boolean',
+ default: false,
+ },
+ {
+ displayName: 'Replace Mode',
+ name: 'replaceMode',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ },
+ },
+ type: 'options',
+ options: [
+ {
+ name: 'Substring',
+ value: 'substring',
+ description: 'Replace a substring with a value',
+ },
+ {
+ name: 'Extended Substring',
+ value: 'extendedSubstring',
+ description:
+ 'Replace a substring including escape characters with a value',
+ },
+ {
+ name: 'Regex',
+ value: 'regex',
+ description: 'Replace regex with a pattern',
+ },
+ {
+ name: 'Predefined Rule',
+ value: 'predefinedRule',
+ description: 'Use a predefined rule to replace',
+ },
+ ],
+ default: 'substring',
+ },
+ {
+ displayName: 'Regex',
+ name: 'regex',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ replaceMode: ['regex'],
+ },
+ },
+ type: 'string',
+ default: '',
+ required: true,
+ placeholder: '.*',
+ description: 'Regular expression',
+ },
+ {
+ displayName: 'Pattern',
+ name: 'pattern',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ replaceMode: ['regex'],
+ },
+ },
+ type: 'string',
+ default: '',
+ placeholder: '$&',
+ // eslint-disable-next-line n8n-nodes-base/node-param-description-unencoded-angle-brackets
+ description:
+ '| Pattern | Inserts |
|---|
| $$ | Inserts a "$". |
| $& | Inserts the matched substring. |
| $` | Inserts the portion of the string that precedes the matched substring. |
| $\' | Inserts the portion of the string that follows the matched substring. |
| $n | Where n is a positive integer less than 100, inserts the nth parenthesized submatch string, provided the first argument was a RegExp object. Note that this is 1-indexed. If a group n is not present (e.g., if group is 3), it will be replaced as a literal (e.g., $3). |
| $ | Where Name is a capturing group name. If the group is not in the match, or not in the regular expression, or if a string was passed as the first argument to replace instead of a regular expression, this resolves to a literal (e.g., $). |
',
+ },
+ {
+ displayName: 'Predefined Rule',
+ name: 'predefinedRule',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ replaceMode: ['predefinedRule'],
+ },
+ },
+ type: 'options',
+ options: [
+ {
+ name: 'Tags',
+ value: 'tags',
+ description: 'Replace all tags',
+ },
+ {
+ name: 'Character Groups',
+ value: 'characterGroups',
+ description: 'Replace all defined character groups',
+ },
+ ],
+ default: 'tags',
+ },
+ {
+ displayName: 'Only Recognised HTML',
+ name: 'onlyRecognisedHTML',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ replaceMode: ['predefinedRule'],
+ predefinedRule: ['tags'],
+ },
+ },
+ type: 'boolean',
+ default: false,
+ },
+ {
+ displayName: 'Newline',
+ name: 'newline',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ replaceMode: ['predefinedRule'],
+ predefinedRule: ['characterGroups'],
+ },
+ },
+ type: 'boolean',
+ default: false,
+ },
+ {
+ displayName: 'Newline Min',
+ name: 'newlineMin',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ replaceMode: ['predefinedRule'],
+ predefinedRule: ['characterGroups'],
+ newline: [true],
+ },
+ },
+ type: 'number',
+ default: 1,
+ },
+ {
+ displayName: 'Newline Max',
+ name: 'newlineMax',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ replaceMode: ['predefinedRule'],
+ predefinedRule: ['characterGroups'],
+ newline: [true],
+ },
+ },
+ type: 'number',
+ default: 1,
+ },
+ {
+ displayName: 'Number',
+ name: 'number',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ replaceMode: ['predefinedRule'],
+ predefinedRule: ['characterGroups'],
+ },
+ },
+ type: 'boolean',
+ default: false,
+ },
+ {
+ displayName: 'Number Min',
+ name: 'numberMin',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ replaceMode: ['predefinedRule'],
+ predefinedRule: ['characterGroups'],
+ number: [true],
+ },
+ },
+ type: 'number',
+ default: 1,
+ },
+ {
+ displayName: 'Number Max',
+ name: 'numberMax',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ replaceMode: ['predefinedRule'],
+ predefinedRule: ['characterGroups'],
+ number: [true],
+ },
+ },
+ type: 'number',
+ default: 1,
+ },
+ {
+ displayName: 'Alpha',
+ name: 'alpha',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ replaceMode: ['predefinedRule'],
+ predefinedRule: ['characterGroups'],
+ },
+ },
+ type: 'boolean',
+ default: false,
+ },
+ {
+ displayName: 'Alpha Min',
+ name: 'alphaMin',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ replaceMode: ['predefinedRule'],
+ predefinedRule: ['characterGroups'],
+ alpha: [true],
+ },
+ },
+ type: 'number',
+ default: 1,
+ },
+ {
+ displayName: 'Alpha Max',
+ name: 'alphaMax',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ replaceMode: ['predefinedRule'],
+ predefinedRule: ['characterGroups'],
+ alpha: [true],
+ },
+ },
+ type: 'number',
+ default: 1,
+ },
+ {
+ displayName: 'Whitespace',
+ name: 'whitespace',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ replaceMode: ['predefinedRule'],
+ predefinedRule: ['characterGroups'],
+ },
+ },
+ type: 'boolean',
+ default: false,
+ },
+ {
+ displayName: 'Whitespace Min',
+ name: 'whitespaceMin',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ replaceMode: ['predefinedRule'],
+ predefinedRule: ['characterGroups'],
+ whitespace: [true],
+ },
+ },
+ type: 'number',
+ default: 1,
+ },
+ {
+ displayName: 'Whitespace Max',
+ name: 'whitespaceMax',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ replaceMode: ['predefinedRule'],
+ predefinedRule: ['characterGroups'],
+ whitespace: [true],
+ },
+ },
+ type: 'number',
+ default: 1,
+ },
+ {
+ displayName: 'Substring',
+ name: 'substring',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ replaceMode: ['substring', 'extendedSubstring'],
+ },
+ },
+ type: 'string',
+ default: '',
+ required: true,
+ placeholder: 'sub',
+ description: 'The substring to be replaced',
+ },
+ {
+ displayName: 'Value',
+ name: 'value',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ replaceMode: ['substring', 'extendedSubstring', 'predefinedRule'],
+ },
+ },
+ type: 'string',
+ default: '',
+ placeholder: '',
+ description: 'The value that should replace the substring',
+ },
+ {
+ displayName: 'Replace All',
+ name: 'replaceAll',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ replaceMode: ['substring', 'extendedSubstring'],
+ },
+ },
+ type: 'boolean',
+ default: true,
+ placeholder: '',
+ description:
+ 'Whether all substrings should be replaced (not only the first)',
+ },
+ {
+ displayName: 'Extended',
+ name: 'extended',
+ displayOptions: {
+ show: {
+ action: ['replace'],
+ },
+ },
+ type: 'boolean',
+ default: false,
+ placeholder: '',
+ description:
+ 'Whether all escape characters should be used for replacement (\\n, \\r, \\t, ...)',
+ },
+ {
+ displayName: 'Trim',
+ name: 'trim',
+ displayOptions: {
+ show: {
+ action: ['trim'],
+ },
+ },
+ type: 'options',
+ options: [
+ {
+ name: 'Trim Both',
+ value: 'trimBoth',
+ description: 'Removes characters from the beginning and end',
+ },
+ {
+ name: 'Trim Start',
+ value: 'trimStart',
+ description: 'Removes characters from the beginning',
+ },
+ {
+ name: 'Trim End',
+ value: 'trimEnd',
+ description: 'Removes characters from the end',
+ },
+ ],
+ default: 'trimBoth',
+ },
+ {
+ displayName: 'Trim String',
+ name: 'trimString',
+ displayOptions: {
+ show: {
+ action: ['trim'],
+ },
+ },
+ type: 'string',
+ default: ' ',
+ required: true,
+ description: 'The string to trim',
+ },
+ {
+ displayName: 'Trim String as an Unit',
+ name: 'trimStringUnit',
+ displayOptions: {
+ show: {
+ action: ['trim'],
+ },
+ },
+ type: 'boolean',
+ default: true,
+ required: true,
+ description:
+ 'Whether to use the trim chain as a whole unit and not each individual character in that chain',
+ },
+ {
+ displayName: 'Pad',
+ name: 'pad',
+ displayOptions: {
+ show: {
+ action: ['pad'],
+ },
+ },
+ type: 'options',
+ options: [
+ {
+ name: 'Pad Start',
+ value: 'padStart',
+ description: 'Pad the string at the beginning',
+ },
+ {
+ name: 'Pad End',
+ value: 'padEnd',
+ description: 'Pad the string at the end',
+ },
+ ],
+ default: 'padStart',
+ },
+ {
+ displayName: 'Target Length',
+ name: 'targetLength',
+ displayOptions: {
+ show: {
+ action: ['pad'],
+ },
+ },
+ type: 'number',
+ typeOptions: {
+ minValue: 0,
+ },
+ default: 1,
+ required: true,
+ placeholder: '1',
+ description: 'The length to which the string should be padded',
+ },
+ {
+ displayName: 'Pad String',
+ name: 'padString',
+ displayOptions: {
+ show: {
+ action: ['pad'],
+ },
+ },
+ type: 'string',
+ default: ' ',
+ required: true,
+ description: 'The filling string',
+ },
+ {
+ displayName: 'Start Position',
+ name: 'startPosition',
+ displayOptions: {
+ show: {
+ action: ['substring'],
+ },
+ },
+ type: 'number',
+ default: 0,
+ placeholder: '0',
+ description:
+ 'The start position (string begins with 0). Can also be negativ.',
+ },
+ {
+ displayName: 'End',
+ name: 'end',
+ displayOptions: {
+ show: {
+ action: ['substring'],
+ },
+ },
+ type: 'options',
+ options: [
+ {
+ name: 'Complete',
+ value: 'complete',
+ description: 'Selects everything to the end',
+ },
+ {
+ name: 'Position',
+ value: 'position',
+ description:
+ 'Selects everything up to the position (exclusive position). Can also be negative.',
+ },
+ {
+ name: 'Length',
+ value: 'length',
+ description: 'The length of the selected rows',
+ },
+ ],
+ default: 'complete',
+ description: 'The end of the substring',
+ },
+ {
+ displayName: 'Position',
+ name: 'endPosition',
+ displayOptions: {
+ show: {
+ action: ['substring'],
+ end: ['position'],
+ },
+ },
+ type: 'number',
+ default: 1,
+ placeholder: '1',
+ description: 'The end position of the substring. Can also be negative.',
+ },
+ {
+ displayName: 'Length',
+ name: 'endLength',
+ displayOptions: {
+ show: {
+ action: ['substring'],
+ end: ['length'],
+ },
+ },
+ typeOptions: {
+ minValue: 0,
+ },
+ type: 'number',
+ default: 1,
+ placeholder: '1',
+ description: 'The length of the substring',
+ },
+ {
+ displayName: 'Times',
+ name: 'times',
+ displayOptions: {
+ show: {
+ action: ['repeat'],
+ },
+ },
+ type: 'number',
+ typeOptions: {
+ minValue: 0,
+ },
+ default: 1,
+ required: true,
+ placeholder: '1',
+ description: 'The number of times the string should be repeated',
+ },
+ ],
+ },
+ ],
+ },
+ ],
+ },
+ ],
+ },
+ ],
+ };
- async execute(this: IExecuteFunctions): Promise
-
+