mirror of
https://github.com/Abdulazizzn/n8n-enterprise-unlocked.git
synced 2025-12-17 18:12:04 +00:00
feat(Code Node): create Code node (#3965)
* Introduce node deprecation (#3930) ✨ Introduce node deprecation * 🚧 Scaffold out Code node * 👕 Fix lint * 📘 Create types file * 🚚 Rename theme * 🔥 Remove unneeded prop * ⚡ Override keybindings * ⚡ Expand lintings * ⚡ Create editor content getter * 🚚 Ensure all helpers use `$` * ✨ Add autocompletion * ⚡ Filter out welcome note node * ⚡ Convey error line number * ⚡ Highlight error line * ⚡ Restore logging from node * ✨ More autocompletions * ⚡ Streamline completions * ✏️ Update placeholders * ⚡ Update linter to new methods * 🔥 Remove `$nodeItem` completions * ⚡ Re-update placeholders * 🎨 Fix formatting * 📦 Update `package-lock.json` * ⚡ Refresh with multi-line empty string * ⚡ Account for syntax errors * 🔥 Remove unneeded variant * ⚡ Minor improvements * ⚡ Add more autocompletions * 🚚 Rename extension * 🔥 Remove outdated comments * 🚚 Rename field * ✨ More autocompletions * ⚡ Fix up error display when empty text * 🔥 Remove logging * ✨ More error validation * 🐛 Fix `pairedItem` to `pairedItem()` * ⚡ Add item to validation info * 📦 Update `package-lock.json` * ⚡ Leftover fixes * ⚡ Set `insertNewlineAndIndent` * 📦 Update `package-lock.json` * 📦 Re-update `package-lock.json` * 👕 Add lint exception * 📘 Add type to mixin type * Clean up comment * ⚡ Refactor completion per new requirements * ⚡ Adjust placeholders * ⚡ Add `json` autocompletions for `$input` * 🎨 Set border * ⚡ Restore local completion source * ⚡ Implement autocompletion for imports * ⚡ Add `.*` to follow user typing on autocompletion * 📘 Fix typings in autocompletions * 👕 Add linting for use of `item()` * 📦 Update `package-lock.json` * 🐛 Fix for `$items(nodeName)[0]` * ⚡ Filter down built-in modules list * ⚡ Refactor error handling * ⚡ Linter and validation improvements * ⚡ Apply review feedback * ♻️ More general refactorings * ⚡ Add dot notation utility * Customize input handler * ⚡ Support `.json.` completions * ⚡ Adjust placeholder * ⚡ Sort imports * 🔥 Remove blank rows addition * ⚡ Add more error validation * 📦 Update `package-lock.json` * ⚡ Make date logging consistent * 🔧 Adjust linting highlight range * ⚡ Add line numbers to each item mode errors * ⚡ Allow for links in error descriptions * ⚡ More input validation * ⚡ Expand linting to loops * ⚡ Deprecate Function and Function Item nodes * 🐛 Fix placeholder syntax * 📘 Narrow down type * 🚚 Rename using kebab-case * 🔥 Remove `mapGetters` * ✏️ Fix casing * ⚡ Adjust import for type * ✏️ Fix quotes * 🐛 Fix `activeNode` reference * ⚡ Use constant * 🔥 Remove logging * ✏️ Fix typo * ⚡ Add missing `notice` * ✏️ Add tags * ✏️ Fix alias * ✏️ Update copy * 🔥 Remove wrong linting * ✏️ Update copy * ⚡ Add validation for `null` * ⚡ Add validation for non-object and non-array * ⚡ Add validation for non-array with json * ✏️ Intentionally use wrong spelling * ⚡ More validation * ✏️ More copy updates * ✏️ Placeholder updates * ⏪ Restore spelling * ⚡ Fix var name * ✏️ More copy updates * ⚡ Add luxon autocompletions * ⚡ Make scrollable * ⚡ Fix comma from merge conflict resolution * 📦 Update `package-lock.json` * 👕 Fix lint detail * 🎨 Set font family * ⚡ Bring in expressions fix * ♻️ Address feedback * ⚡ Exclude codemirror packages from render chunks * 🐛 Fix placeholder not showing on first load * feat(editor-ui): Replace `lezer` with `esprima` in client linter (#4192) * 🔥 Remove addition from misresolved conflict * ⚡ Replace `lezer` with `esprima` in client linter * ⚡ Add missing key * 📦 Update `package-lock.json` * ⚡ Match dependencies * 📦 Update `package-lock.json` * 📦 Re-update `package-lock.json` * ⚡ Match whitespace * 🐛 Fix selection * ⚡ Expand validation * 🔥 Remove validation * ✏️ Update copy * 🚚 Move to constants * ⚡ More `null` validation * ⚡ Support `all()` with index to access item * ⚡ Gloss over n8n syntax error * 🎨 Re-style diagnostic button * 🔥 Remove `item` as `itemAlias` * ⚡ Add linting for `item.json` in single item mode * ⚡ Refactor to add label info descriptions * ⚡ More autocompletions * 👕 Fix lint * ⚡ Simplify typings * feat(nodes-base): Multiline autocompletion for `code-node-editor` (#4220) * ⚡ Simplify typings * ⚡ Consolidate helpers in utils * ⚡ Multiline autocompletion for standalone vars * 🔥 Remove unneeded mixins * ✏️ Update copy * ✏️ Prep TODOs * ⚡ Multiline completion for `$input.method` + `$input.item` * 🔥 Remove unused method * 🔥 Remove another unused method * 🚚 Move luxon strings to helpers * ⚡ Multiline autocompletion for methods output * ⚡ Refactor to use optional chaining * 👕 Fix lint * ✏️ Update TODOs * ⚡ Multiline autocompletion for `json` fields * 📘 Add typings * ⚡ De-duplicate callback to forEach * 🐛 Fix autocompletions not working with leading whitespace * 🌐 Apply i18n * 👕 Fix lint * :constructor: Second-period var usage completions * 👕 Fix lint * 👕 Add exception * ⚡ Add completion telemetry * 📘 Add typing * ⚡ Major refactoring to organize * 🐛 Fix multiline `.all()[index]` * 🐛 Do not autoclose square brackets prior to `.json` * 🐛 Fix accessor for multiline `jsonField` completions * ⚡ Add completions for half-assignments * 🐛 Fix `jsonField` completions for `x.json` * ✏️ Improve comments * 🐛 Fix `.json[field]` for multiline matches * ⚡ Cleanup * 📦 Update `package-lock.json` * 👕 Fix lint * 🐛 Rely on original value for custom matcher * ⚡ Create `customMatcherJsonFieldCompletions` to simplify setup * 🐛 Include selector in `customMatcherJsonField` completions * ✏️ Make naming consistent * ✏️ Add docline * ⚡ Finish self-review cleanup * 🔥 Remove outdated comment * 📌 Pin luxon to major-minor * ✏️ Fix typo * 📦 Update `package-lock.json` * 📦 Update `package-lock.json` * 📦 Re-update `package-lock.json` * ➕ Add `luxon` for Gmail node * 📦 Update `package-lock.json` * ⚡ Replace Function with Code in suggested nodes * 🐛 Fix `$prevNode` completions * ✏️ Update `$execution.mode` copy * ⚡ Separate luxon getters from methods * ⚡ Adjusting linter to tolerate `.binary` * ⚡ Adjust top-level item keys check * ⚡ Anticipate user expecting `item` to pre-exist * ⚡ Add linting for legacy item access * ⚡ Add hint for attempted `items` access * ⚡ Add keybinding for toggling comments * ✏️ Update copy of `all`, `first`, `last` and `itemMatching` * 🐛 Make `input.all()` etc act on copies * 📦 Update `package-lock.json` * 🐛 Fix guard in `$input.last()` * ♻️ Address Jan's feedback * ⬆️ Upgrade `eslint-plugin-n8n-nodes-base` * 📦 Update `package-lock.json` * 🔥 Remove unneeded exceptions * ⚡ Restore placeholder logic * ⚡ Add placeholders to client * ⚡ Account for shadow item * ✏️ More completion info labels * 👕 Fix lint * ✏️ Update copy * ✏️ Update copy * ✏️ More copy updates * 📦 Update `package-lock.json` * ⚡ Add more validation * ⚡ Add placheolder on first load * Replace `Cmd` with `Mod` * 📦 Update `package-lock.json`
This commit is contained in:
Iván Ovejero
@@ -0,0 +1,302 @@
|
||||
import Vue from 'vue';
|
||||
import { isAllowedInDotNotation, escape, toVariableOption } from '../utils';
|
||||
import type { Completion, CompletionContext, CompletionResult } from '@codemirror/autocomplete';
|
||||
import type { IDataObject, IPinData, IRunData } from 'n8n-workflow';
|
||||
import type { CodeNodeEditorMixin } from '../types';
|
||||
|
||||
export const jsonFieldCompletions = (Vue as CodeNodeEditorMixin).extend({
|
||||
methods: {
|
||||
/**
|
||||
* - Complete `x.first().json.` to `.field`.
|
||||
* - Complete `x.last().json.` to `.field`.
|
||||
* - Complete `x.all()[index].json.` to `.field`.
|
||||
* - Complete `x.item.json.` to `.field`.
|
||||
*
|
||||
* - Complete `x.first().json[` to `['field']`.
|
||||
* - Complete `x.last().json[` to `['field']`.
|
||||
* - Complete `x.all()[index].json[` to `['field']`.
|
||||
* - Complete `x.item.json[` to `['field']`.
|
||||
*/
|
||||
matcherJsonFieldCompletions(
|
||||
context: CompletionContext,
|
||||
matcher: string,
|
||||
variablesToValues: Record<string, string>,
|
||||
): CompletionResult | null {
|
||||
const pattern = new RegExp(`(${escape(matcher)})\..*`);
|
||||
|
||||
const preCursor = context.matchBefore(pattern);
|
||||
|
||||
if (!preCursor || (preCursor.from === preCursor.to && !context.explicit)) return null;
|
||||
|
||||
const inputNodeName = this.getInputNodeName();
|
||||
|
||||
if (!inputNodeName) return null;
|
||||
|
||||
const [varName] = preCursor.text.split('.');
|
||||
|
||||
const originalValue = variablesToValues[varName];
|
||||
|
||||
if (!originalValue) return null;
|
||||
|
||||
for (const accessor of ['first', 'last', 'item']) {
|
||||
/**
|
||||
* const x = $input.first(); // accessor in original value
|
||||
* x.json
|
||||
*
|
||||
* const x = $input;
|
||||
* x.first().json // accessor in preCursor.text
|
||||
*/
|
||||
if (originalValue.includes(accessor) || preCursor.text.includes(accessor)) {
|
||||
const jsonOutput = this.getJsonOutput(inputNodeName, { accessor });
|
||||
|
||||
if (!jsonOutput) return null;
|
||||
|
||||
return this.toJsonFieldCompletions(preCursor, jsonOutput, matcher);
|
||||
}
|
||||
}
|
||||
|
||||
if (originalValue.includes('all')) {
|
||||
const match = originalValue.match(/\$(input|\(.*\))\.all\(\)\[(?<index>.+)\]$/);
|
||||
|
||||
if (!match?.groups?.index) return null;
|
||||
|
||||
const { index } = match.groups;
|
||||
|
||||
const jsonOutput = this.getJsonOutput(inputNodeName, { index: Number(index) });
|
||||
|
||||
if (!jsonOutput) return null;
|
||||
|
||||
return this.toJsonFieldCompletions(preCursor, jsonOutput, matcher);
|
||||
}
|
||||
|
||||
return null;
|
||||
},
|
||||
|
||||
/**
|
||||
* - Complete `$input.first().json.` to `.field`.
|
||||
* - Complete `$input.last().json.` to `.field`.
|
||||
* - Complete `$input.all()[index].json.` to `.field`.
|
||||
* - Complete `$input.item.json.` to `.field`.
|
||||
*
|
||||
* - Complete `$input.first().json[` to `['field']`.
|
||||
* - Complete `$input.last().json[` to `['field']`.
|
||||
* - Complete `$input.all()[index].json[` to `['field']`.
|
||||
* - Complete `$input.item.json[` to `['field']`.
|
||||
*/
|
||||
inputJsonFieldCompletions(context: CompletionContext): CompletionResult | null {
|
||||
const patterns = {
|
||||
first: /\$input\.first\(\)\.json(\[|\.).*/,
|
||||
last: /\$input\.last\(\)\.json(\[|\.).*/,
|
||||
item: /\$input\.item\.json(\[|\.).*/,
|
||||
all: /\$input\.all\(\)\[(?<index>\w+)\]\.json(\[|\.).*/,
|
||||
};
|
||||
|
||||
for (const [name, regex] of Object.entries(patterns)) {
|
||||
const preCursor = context.matchBefore(regex);
|
||||
|
||||
if (!preCursor || (preCursor.from === preCursor.to && !context.explicit)) continue;
|
||||
|
||||
const inputNodeName = this.getInputNodeName();
|
||||
|
||||
if (!inputNodeName) continue;
|
||||
|
||||
if (name === 'first' || name === 'last') {
|
||||
const jsonOutput = this.getJsonOutput(inputNodeName, { accessor: name });
|
||||
|
||||
if (!jsonOutput) continue;
|
||||
|
||||
return this.toJsonFieldCompletions(preCursor, jsonOutput, `$input.${name}().json`);
|
||||
}
|
||||
|
||||
if (name === 'item') {
|
||||
const jsonOutput = this.getJsonOutput(inputNodeName, { accessor: 'item' });
|
||||
|
||||
if (!jsonOutput) continue;
|
||||
|
||||
return this.toJsonFieldCompletions(preCursor, jsonOutput, '$input.item.json');
|
||||
}
|
||||
|
||||
if (name === 'all') {
|
||||
const match = preCursor.text.match(regex);
|
||||
|
||||
if (!match?.groups?.index) continue;
|
||||
|
||||
const { index } = match.groups;
|
||||
|
||||
const jsonOutput = this.getJsonOutput(inputNodeName, { index: Number(index) });
|
||||
|
||||
if (!jsonOutput) continue;
|
||||
|
||||
return this.toJsonFieldCompletions(preCursor, jsonOutput, `$input.all()[${index}].json`);
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
},
|
||||
|
||||
/**
|
||||
* Complete `$('nodeName').first().json.` to `.field`.
|
||||
* Complete `$('nodeName').last().json.` to `.field`.
|
||||
* Complete `$('nodeName').all()[index].json.` to `.field`.
|
||||
* Complete `$('nodeName').item.json.` to `.field`.
|
||||
*
|
||||
* Complete `$('nodeName').first().json[` to `['field']`.
|
||||
* Complete `$('nodeName').last().json[` to `['field']`.
|
||||
* Complete `$('nodeName').all()[index].json[` to `['field']`.
|
||||
* Complete `$('nodeName').item.json[` to `['field']`.
|
||||
*/
|
||||
selectorJsonFieldCompletions(context: CompletionContext): CompletionResult | null {
|
||||
const patterns = {
|
||||
first: /\$\((?<quotedNodeName>['"][\w\s]+['"])\)\.first\(\)\.json(\[|\.).*/,
|
||||
last: /\$\((?<quotedNodeName>['"][\w\s]+['"])\)\.last\(\)\.json(\[|\.).*/,
|
||||
item: /\$\((?<quotedNodeName>['"][\w\s]+['"])\)\.item\.json(\[|\.).*/,
|
||||
all: /\$\((?<quotedNodeName>['"][\w\s]+['"])\)\.all\(\)\[(?<index>\w+)\]\.json(\[|\.).*/,
|
||||
};
|
||||
|
||||
for (const [name, regex] of Object.entries(patterns)) {
|
||||
const preCursor = context.matchBefore(regex);
|
||||
|
||||
if (!preCursor || (preCursor.from === preCursor.to && !context.explicit)) continue;
|
||||
|
||||
const match = preCursor.text.match(regex);
|
||||
|
||||
if (!match?.groups?.quotedNodeName) continue;
|
||||
|
||||
const { quotedNodeName } = match.groups;
|
||||
|
||||
const selector = `$(${match.groups.quotedNodeName})`;
|
||||
|
||||
if (name === 'first' || name === 'last') {
|
||||
const jsonOutput = this.getJsonOutput(quotedNodeName, { accessor: name });
|
||||
|
||||
if (!jsonOutput) continue;
|
||||
|
||||
return this.toJsonFieldCompletions(preCursor, jsonOutput, `${selector}.${name}().json`);
|
||||
}
|
||||
|
||||
if (name === 'item') {
|
||||
const jsonOutput = this.getJsonOutput(quotedNodeName, { accessor: 'item' });
|
||||
|
||||
if (!jsonOutput) continue;
|
||||
|
||||
return this.toJsonFieldCompletions(preCursor, jsonOutput, `${selector}.item.json`);
|
||||
}
|
||||
|
||||
if (name === 'all') {
|
||||
const match = preCursor.text.match(regex);
|
||||
|
||||
if (!match?.groups?.index) continue;
|
||||
|
||||
const { index } = match.groups;
|
||||
|
||||
const jsonOutput = this.getJsonOutput(quotedNodeName, { index: Number(index) });
|
||||
|
||||
if (!jsonOutput) continue;
|
||||
|
||||
return this.toJsonFieldCompletions(
|
||||
preCursor,
|
||||
jsonOutput,
|
||||
`${selector}.all()[${index}].json`,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
},
|
||||
|
||||
getInputNodeName() {
|
||||
try {
|
||||
const activeNode = this.$store.getters.activeNode;
|
||||
const workflow = this.getCurrentWorkflow();
|
||||
const input = workflow.connectionsByDestinationNode[activeNode.name];
|
||||
|
||||
return input.main[0][0].node;
|
||||
} catch (_) {
|
||||
return null;
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* .json -> .json['field']
|
||||
* .json -> .json.field
|
||||
*/
|
||||
toJsonFieldCompletions(
|
||||
preCursor: NonNullable<ReturnType<CompletionContext['matchBefore']>>,
|
||||
jsonOutput: IDataObject,
|
||||
matcher: string, // e.g. `$input.first().json` or `x` (user-defined variable)
|
||||
) {
|
||||
if (preCursor.text.endsWith('.json[') || preCursor.text.endsWith(`${matcher}[`)) {
|
||||
const options: Completion[] = Object.keys(jsonOutput)
|
||||
.map((field) => `${matcher}['${field}']`)
|
||||
.map((label) => ({
|
||||
label,
|
||||
info: this.$locale.baseText('codeNodeEditor.completer.json'),
|
||||
}));
|
||||
|
||||
return {
|
||||
from: preCursor.from,
|
||||
options,
|
||||
};
|
||||
}
|
||||
|
||||
if (preCursor.text.endsWith('.json.') || preCursor.text.endsWith(`${matcher}.`)) {
|
||||
const options: Completion[] = Object.keys(jsonOutput)
|
||||
.filter(isAllowedInDotNotation)
|
||||
.map((field) => `${matcher}.${field}`)
|
||||
.map(toVariableOption);
|
||||
|
||||
return {
|
||||
from: preCursor.from,
|
||||
options,
|
||||
};
|
||||
}
|
||||
|
||||
return null;
|
||||
},
|
||||
|
||||
/**
|
||||
* Get the `json` output of a node from `runData` or `pinData`.
|
||||
*
|
||||
* `accessor` is the method or property used to find the item index.
|
||||
* `index` is only passed for `all()`.
|
||||
*/
|
||||
getJsonOutput(quotedNodeName: string, options?: { accessor?: string; index?: number }) {
|
||||
const nodeName = quotedNodeName.replace(/['"]/g, '');
|
||||
|
||||
const pinData: IPinData | undefined = this.$store.getters.pinData;
|
||||
|
||||
const nodePinData = pinData && pinData[nodeName];
|
||||
|
||||
if (nodePinData) {
|
||||
try {
|
||||
let itemIndex = options?.index ?? 0;
|
||||
|
||||
if (options?.accessor === 'last') {
|
||||
itemIndex = nodePinData.length - 1;
|
||||
}
|
||||
|
||||
return nodePinData[itemIndex].json;
|
||||
} catch (_) {}
|
||||
}
|
||||
|
||||
const runData: IRunData | null = this.$store.getters.getWorkflowRunData;
|
||||
|
||||
const nodeRunData = runData && runData[nodeName];
|
||||
|
||||
if (!nodeRunData) return null;
|
||||
|
||||
try {
|
||||
let itemIndex = options?.index ?? 0;
|
||||
|
||||
if (options?.accessor === 'last') {
|
||||
const inputItems = nodeRunData[0].data!.main[0]!;
|
||||
itemIndex = inputItems.length - 1;
|
||||
}
|
||||
|
||||
return nodeRunData[0].data!.main[0]![itemIndex].json;
|
||||
} catch (_) {
|
||||
return null;
|
||||
}
|
||||
},
|
||||
},
|
||||
});
|
||||
Reference in New Issue
Block a user