mirror of
https://github.com/Abdulazizzn/n8n-enterprise-unlocked.git
synced 2025-12-17 10:02:05 +00:00
feat: add resource locator parameter (#3932)
* ✨ Added resource locator interfaces to `n8n-workflow` package * ✅ Updating Trello node to use resource locator property type * ✨ Added resource locator prop to Delete Board` Trello operation * ✔️ Fiixing linting errors in Trello node * ✨ Added list mode to Trello test node * ⚡ Updating resource locator modes interface * ⚡ Updating Trello test node validation messages and placeholders * N8N-4175 resource locator component (#3812) * ✨ Implemented initial version of resource locator component * ✨ Implemented front-end validation for resource locator component. Improved responsiveness. Minor refactoring. * ⚡ Setting resource locator default state to list. Updating hover states and expand icon. * 🔨 Moving resource locator component to `ParameterInput` from `ParameterInputFull * 🔨 Moving `ResourceLocator` to a separate Vue component * 🔨 Implementing expression and drag'n'drop support in ResourceLocator` component * 🔨 Cleaning up `ResourceLocator` component code * ✨ Implemented resource locator selected mode persistance * 💄 Minor refactoring and fixes in `ResourceLocator` * 🔨 Updating `ResourceLocator` front-end validation logic * ⚡ Saving resource locator mode in node parameters * 💄 Updating the `ResourceLocator` component based on the design review * 🐛 Fixing resource locator mode parameters handling when loading node parameter values on front-end * 💄 Removing leftover unused CSS * ⚡ Updating interfaces to support resource locator value types * ⚡ Updating `ResourceLocator` component to work with object parameter values * 🔨 Cleaning up `ResourceLocator` and related components code * ⚡ Preventing `DraggableTarget` to be sticky if disabled * 🐛 Fixing a bug with resource locator value parameter * 👌 Adding new type alias for all possible node parameter value types * 👌 Updating `ResourceLocator` and related components based on PR review feedback * ⚡ Adding disabled mode to `ResourceLocator` component, fixing expression handling, minor refactoring. * 💄 Updating disabled state styling in `ResourceLocator` component * ⚡ Setting correct default value for test node and removing unnecessary logic * 💄 Added regex URL validation to Trello test node * ✨ Updating Trello test node with another (list mode only) test case * ✔️ Fixing linting error in Trello node * 🔨 Removing hardcoded custom modes and modes order * Add value extractor to routing node (#3777) * ✨ add value extractor to routing node * ✨ add value extractor to property modes * 🔊 improve error logging for value extractor * 🔥 remove old extractValue methods from RoutingNode * ⚡ extractValue inside getNodeParameter * 🔥 remove extract value test from RoutingNode * ✨ make value extraction optional * 🥅 move extract value so proper error messages are sent * 🚨 readd accidentally removed eslint-disable * ✨ add resource locator support extractValue * 🚨 remove unused import * 🐛 fix getting value of resource locator * 💄 Updating resource locator component styling and handling reset value action * ✨ create v2 of Trello node for resource locator * 💄 Updating ResourceLocator droppable & activeDrop classes and removing input padding-right * ⚡ Updating Trello test node with single-mode test case * ⚡ Updating field names in Trello node to avoid name clash * 💄 Updating test Trello node mode order and board:update parameter name * 💄 Updating test node parameter names and display options * List mode search endpoint (#3936) * 🚧 super basic version of the search endpoint This version is built using a hacked up version of the Google Drive node. I need to properly create a v2 for it but it's does work. * 🚧 fixed up type errors and return urls * ✨ add v3 of Google Drive node with RLC * ✨ add RLC to Google Drive Shared Drive operations * ♻️ address some small changes requested in review * 🐛 move list search out of /nodes/ and add check for required param * ✨ google drive folder search * ✨ google drive search sort by name * ✨ add searchable flag for RLC * ✏️ fix google drive wording for v3 * Trello and Airtable search backend (#3974) * ✨ add search to Trello boards * ✨ add RLC to Trello cards * ♻️ use new versioning system for Trello v2 * 🐛 move list search out of /nodes/ and add check for required param * ✨ re-add trello search methods * 🥅 throw error if RLC search isn't sent a method name This will likely be removed when the declarative style of search has been added. * ✨ add requires filter field to RLC search * ✨ add searchable flag to Trello searches * ✨ add RLC for cardId and boardId on all operations * ✨ add ID and URL RLC to Airtable * N8 n 4179 resource locator list mode (#3933) * ✨ Implemented initial version of list mode dropdown * ✨ Handling mode switching and expression support in list mode * 🔨 Removing `sortedModes` references * ⚡ Fixing list mode UI after latest mege * 💄 Updating padding-right for input fields with suffix slots * ✨ Minor fixes to validation, mode switching logic and styling * update error * 2 or more regex * update regex to be more strict * remove expr colors * update hint * 🚧 super basic version of the search endpoint This version is built using a hacked up version of the Google Drive node. I need to properly create a v2 for it but it's does work. * 🚧 fixed up type errors and return urls * begin list impl * ✨ add v3 of Google Drive node with RLC * fix ts issue * introduce dropdown * add more behavior * update design * show search * add filtering * push up selected * add keyboard nav * add loading * add caching * remove console * fix build issues * add debounce * fix click * keep event on focus * fix input size bug * add resource locator type * update type * update interface * update resource locator types * ✨ add search to Trello boards * ✨ add RLC to Google Drive Shared Drive operations * update * update name * add package * use stringify pckg * handle long vals * fix bug in url id modes * remove console log * add lazy loading * add lazy loading on filtering * clean up * make search clearable * add error state * ✨ add RLC to Trello cards * ♻️ address some small changes requested in review * ♻️ use new versioning system for Trello v2 * refactor a bit * fix how loading happens * clear after blur * update api * comment out test code * update api * relaod in case of error * update endpoint * 🐛 move list search out of /nodes/ and add check for required param * 🐛 move list search out of /nodes/ and add check for required param * update req handling * update endpoint * ✨ re-add trello search methods * 🥅 throw error if RLC search isn't sent a method name This will likely be removed when the declarative style of search has been added. * get api to work * update scroll handling * ✨ google drive folder search * ✨ add requires filter field to RLC search * ✨ google drive search sort by name * remove console * ✨ add searchable flag for RLC * ✨ add searchable flag to Trello searches * update searchable * ✨ add RLC for cardId and boardId on all operations * ✨ add ID and URL RLC to Airtable * fix up search * remove extra padding * add link button * update popper pos * format * fix formating * update mode change * add name urls * update regex and errors * upate error * update errors * update airtable regex * update trello regex rules * udpate param name * update * update param * update param * update drive node * update params * add keyboard nav * fix bug * update airtable default mode * fix default value issue * hide long selected value * update duplicate reqs * update node * clean up impl * dedupe resources * fix up nv * resort params * update icon * set placeholders * default to id mode * add telemetry * add refresh opt * clean up tmp val * revert test change * make placeholder optional * update validation * remove description as param hint * support more general values * fix links on long names * update resource item styles * update pos * update icon color * update link alt * check if required * move validation to workflow * update naming * only show warning at param level * show right border on focus * fix hover on all item * fix long names bug * fix expr bug * add expr * update legacy mode * fix up impl * clean up node types * clean up types * remove unnessary type * clean up types * clean up types * clean up types * clea n up localizaiton * remove unused key * clean up helpers * clean up paraminput * clean up paraminputfull * refactor into one loop * update component * update class names * update prop types * update name cases * update casing * clean up classes * clean up resource locator * update drop handling * update mode * add url for link mode * clear value by default * add placeholder * remove legacy hint * handle expr in legacy * fix typos * revert padding change * fix up spacing * update to link component * support urls for id * fix replacement * build Co-authored-by: Milorad Filipovic <milorad@n8n.io> Co-authored-by: Valya Bullions <valya@n8n.io> * refactor: Resource locator review changes (#4109) * ✨ Implemented initial version of list mode dropdown * ✨ Handling mode switching and expression support in list mode * 🔨 Removing `sortedModes` references * ⚡ Fixing list mode UI after latest mege * 💄 Updating padding-right for input fields with suffix slots * ✨ Minor fixes to validation, mode switching logic and styling * update error * 2 or more regex * update regex to be more strict * remove expr colors * update hint * 🚧 super basic version of the search endpoint This version is built using a hacked up version of the Google Drive node. I need to properly create a v2 for it but it's does work. * 🚧 fixed up type errors and return urls * begin list impl * ✨ add v3 of Google Drive node with RLC * fix ts issue * introduce dropdown * add more behavior * update design * show search * add filtering * push up selected * add keyboard nav * add loading * add caching * remove console * fix build issues * add debounce * fix click * keep event on focus * fix input size bug * add resource locator type * update type * update interface * update resource locator types * ✨ add search to Trello boards * ✨ add RLC to Google Drive Shared Drive operations * update * update name * add package * use stringify pckg * handle long vals * fix bug in url id modes * remove console log * add lazy loading * add lazy loading on filtering * clean up * make search clearable * add error state * ✨ add RLC to Trello cards * ♻️ address some small changes requested in review * ♻️ use new versioning system for Trello v2 * refactor a bit * fix how loading happens * clear after blur * update api * comment out test code * update api * relaod in case of error * update endpoint * 🐛 move list search out of /nodes/ and add check for required param * 🐛 move list search out of /nodes/ and add check for required param * update req handling * update endpoint * ✨ re-add trello search methods * 🥅 throw error if RLC search isn't sent a method name This will likely be removed when the declarative style of search has been added. * get api to work * update scroll handling * ✨ google drive folder search * ✨ add requires filter field to RLC search * ✨ google drive search sort by name * remove console * ✨ add searchable flag for RLC * ✨ add searchable flag to Trello searches * update searchable * ✨ add RLC for cardId and boardId on all operations * ✨ add ID and URL RLC to Airtable * fix up search * remove extra padding * add link button * update popper pos * format * fix formating * update mode change * add name urls * update regex and errors * upate error * update errors * update airtable regex * update trello regex rules * udpate param name * update * update param * update param * update drive node * update params * add keyboard nav * fix bug * update airtable default mode * fix default value issue * hide long selected value * update duplicate reqs * update node * clean up impl * dedupe resources * fix up nv * resort params * update icon * set placeholders * default to id mode * add telemetry * add refresh opt * clean up tmp val * revert test change * make placeholder optional * update validation * remove description as param hint * support more general values * fix links on long names * update resource item styles * update pos * update icon color * update link alt * check if required * move validation to workflow * update naming * only show warning at param level * show right border on focus * fix hover on all item * fix long names bug * ♻️ refactor extractValue to allow multiple props with same name * ♻️ use correct import for displayParameterPath * fix expr bug * add expr * update legacy mode * fix up impl * clean up node types * clean up types * ♻️ remove new version of google drive node * ♻️ removed versioned Trello node for RLC * remove unnessary type * ♻️ remove versioned Airtable not for RLC * clean up types * clean up types * clean up types * clea n up localizaiton * remove unused key * clean up helpers * clean up paraminput * clean up paraminputfull * refactor into one loop * update component * update class names * update prop types * update name cases * update casing * clean up classes * 💬 updated RLC URL regex error wording * clean up resource locator * update drop handling * update mode * 💬 reword value extractor errors * 🚨 remove unneeded eslint ignores for RLC modes * 💬 update Trello 400 error message * 🚨 re-add removed types in editor-ui Also ts-ignore something that was clean up in another commit. I've added a comment to fix after someone else can look at it. * 💬 remove hints from Google Drive RLCs * 🥅 rethrow correct errors in Trello node * ✨ add url for id mode on Google Drive * 🔥 remove unused Google Drive file * 🔊 change console.error to use logger instead * 🔀 fix bad merges * ♻️ small changes from review * ♻️ remove ts-ignore Co-authored-by: Milorad Filipovic <milorad@n8n.io> Co-authored-by: Mutasem <mutdmour@gmail.com> * fix build * update tests * fix bug with credential card * update popover component * fix expressions url * fix type issue * format * update alt * fix lint issues * fix eslint issues Co-authored-by: Milorad Filipovic <milorad@n8n.io> Co-authored-by: Milorad FIlipović <miloradfilipovic19@gmail.com> Co-authored-by: Valya <68596159+valya@users.noreply.github.com> Co-authored-by: Valya Bullions <valya@n8n.io>
This commit is contained in:
Mutasem Aldmour
@@ -7,11 +7,13 @@ import {
|
||||
IExecuteData,
|
||||
INode,
|
||||
INodeExecutionData,
|
||||
INodeParameterResourceLocator,
|
||||
INodeParameters,
|
||||
IRunExecutionData,
|
||||
IWorkflowDataProxyAdditionalKeys,
|
||||
IWorkflowDataProxyData,
|
||||
NodeParameterValue,
|
||||
NodeParameterValueType,
|
||||
Workflow,
|
||||
WorkflowDataProxy,
|
||||
WorkflowExecuteMode,
|
||||
@@ -351,14 +353,9 @@ export class Expression {
|
||||
timezone: string,
|
||||
additionalKeys: IWorkflowDataProxyAdditionalKeys,
|
||||
executeData?: IExecuteData,
|
||||
defaultValue:
|
||||
| NodeParameterValue
|
||||
| INodeParameters
|
||||
| NodeParameterValue[]
|
||||
| INodeParameters[]
|
||||
| undefined = undefined,
|
||||
defaultValue: NodeParameterValueType | undefined = undefined,
|
||||
selfData = {},
|
||||
): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | undefined {
|
||||
): NodeParameterValueType | undefined {
|
||||
if (parameterValue === undefined) {
|
||||
// Value is not set so return the default
|
||||
return defaultValue;
|
||||
@@ -423,7 +420,7 @@ export class Expression {
|
||||
* @memberof Workflow
|
||||
*/
|
||||
getParameterValue(
|
||||
parameterValue: NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[],
|
||||
parameterValue: NodeParameterValueType | INodeParameterResourceLocator,
|
||||
runExecutionData: IRunExecutionData | null,
|
||||
runIndex: number,
|
||||
itemIndex: number,
|
||||
@@ -435,17 +432,15 @@ export class Expression {
|
||||
executeData?: IExecuteData,
|
||||
returnObjectAsString = false,
|
||||
selfData = {},
|
||||
): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] {
|
||||
): NodeParameterValueType {
|
||||
// Helper function which returns true when the parameter is a complex one or array
|
||||
const isComplexParameter = (
|
||||
value: NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[],
|
||||
) => {
|
||||
const isComplexParameter = (value: NodeParameterValueType) => {
|
||||
return typeof value === 'object';
|
||||
};
|
||||
|
||||
// Helper function which resolves a parameter value depending on if it is simply or not
|
||||
const resolveParameterValue = (
|
||||
value: NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[],
|
||||
value: NodeParameterValueType,
|
||||
siblingParameters: INodeParameters,
|
||||
) => {
|
||||
if (isComplexParameter(value)) {
|
||||
@@ -519,7 +514,10 @@ export class Expression {
|
||||
const returnData: INodeParameters = {};
|
||||
// eslint-disable-next-line no-restricted-syntax
|
||||
for (const [key, value] of Object.entries(parameterValue)) {
|
||||
returnData[key] = resolveParameterValue(value, parameterValue);
|
||||
returnData[key] = resolveParameterValue(
|
||||
value as NodeParameterValueType,
|
||||
parameterValue as INodeParameters,
|
||||
);
|
||||
}
|
||||
|
||||
if (returnObjectAsString && typeof returnData === 'object') {
|
||||
|
||||
@@ -543,12 +543,13 @@ export interface IN8nRequestOperationPaginationOffset extends IN8nRequestOperati
|
||||
};
|
||||
}
|
||||
|
||||
export interface IGetNodeParameterOptions {
|
||||
extractValue?: boolean;
|
||||
}
|
||||
|
||||
export interface IExecuteFunctions {
|
||||
continueOnFail(): boolean;
|
||||
evaluateExpression(
|
||||
expression: string,
|
||||
itemIndex: number,
|
||||
): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[];
|
||||
evaluateExpression(expression: string, itemIndex: number): NodeParameterValueType;
|
||||
executeWorkflow(
|
||||
workflowInfo: IExecuteWorkflowInfo,
|
||||
inputData?: INodeExecutionData[],
|
||||
@@ -567,7 +568,8 @@ export interface IExecuteFunctions {
|
||||
parameterName: string,
|
||||
itemIndex: number,
|
||||
fallbackValue?: any,
|
||||
): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object;
|
||||
options?: IGetNodeParameterOptions,
|
||||
): NodeParameterValueType | object;
|
||||
getWorkflowDataProxy(itemIndex: number): IWorkflowDataProxyData;
|
||||
getWorkflowStaticData(type: string): IDataObject;
|
||||
getRestApiUrl(): string;
|
||||
@@ -597,10 +599,7 @@ export interface IExecuteFunctions {
|
||||
|
||||
export interface IExecuteSingleFunctions {
|
||||
continueOnFail(): boolean;
|
||||
evaluateExpression(
|
||||
expression: string,
|
||||
itemIndex: number | undefined,
|
||||
): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[];
|
||||
evaluateExpression(expression: string, itemIndex: number | undefined): NodeParameterValueType;
|
||||
getContext(type: string): IContextObject;
|
||||
getCredentials(type: string): Promise<ICredentialDataDecryptedObject>;
|
||||
getInputData(inputIndex?: number, inputName?: string): INodeExecutionData;
|
||||
@@ -610,7 +609,8 @@ export interface IExecuteSingleFunctions {
|
||||
getNodeParameter(
|
||||
parameterName: string,
|
||||
fallbackValue?: any,
|
||||
): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object;
|
||||
options?: IGetNodeParameterOptions,
|
||||
): NodeParameterValueType | object;
|
||||
getRestApiUrl(): string;
|
||||
getTimezone(): string;
|
||||
getExecuteData(): IExecuteData;
|
||||
@@ -659,16 +659,9 @@ export interface ILoadOptionsFunctions {
|
||||
getNodeParameter(
|
||||
parameterName: string,
|
||||
fallbackValue?: any,
|
||||
): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object;
|
||||
getCurrentNodeParameter(
|
||||
parameterName: string,
|
||||
):
|
||||
| NodeParameterValue
|
||||
| INodeParameters
|
||||
| NodeParameterValue[]
|
||||
| INodeParameters[]
|
||||
| object
|
||||
| undefined;
|
||||
options?: IGetNodeParameterOptions,
|
||||
): NodeParameterValueType | object;
|
||||
getCurrentNodeParameter(parameterName: string): NodeParameterValueType | object | undefined;
|
||||
getCurrentNodeParameters(): INodeParameters | undefined;
|
||||
getTimezone(): string;
|
||||
getRestApiUrl(): string;
|
||||
@@ -703,7 +696,8 @@ export interface IHookFunctions {
|
||||
getNodeParameter(
|
||||
parameterName: string,
|
||||
fallbackValue?: any,
|
||||
): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object;
|
||||
options?: IGetNodeParameterOptions,
|
||||
): NodeParameterValueType | object;
|
||||
getTimezone(): string;
|
||||
getWebhookDescription(name: string): IWebhookDescription | undefined;
|
||||
getWebhookName(): string;
|
||||
@@ -732,7 +726,8 @@ export interface IPollFunctions {
|
||||
getNodeParameter(
|
||||
parameterName: string,
|
||||
fallbackValue?: any,
|
||||
): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object;
|
||||
options?: IGetNodeParameterOptions,
|
||||
): NodeParameterValueType | object;
|
||||
getRestApiUrl(): string;
|
||||
getTimezone(): string;
|
||||
getWorkflow(): IWorkflowMetadata;
|
||||
@@ -765,7 +760,8 @@ export interface ITriggerFunctions {
|
||||
getNodeParameter(
|
||||
parameterName: string,
|
||||
fallbackValue?: any,
|
||||
): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object;
|
||||
options?: IGetNodeParameterOptions,
|
||||
): NodeParameterValueType | object;
|
||||
getRestApiUrl(): string;
|
||||
getTimezone(): string;
|
||||
getWorkflow(): IWorkflowMetadata;
|
||||
@@ -793,7 +789,8 @@ export interface IWebhookFunctions {
|
||||
getNodeParameter(
|
||||
parameterName: string,
|
||||
fallbackValue?: any,
|
||||
): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object;
|
||||
options?: IGetNodeParameterOptions,
|
||||
): NodeParameterValueType | object;
|
||||
getNodeWebhookUrl: (name: string) => string | undefined;
|
||||
getParamsData(): object;
|
||||
getQueryData(): object;
|
||||
@@ -898,12 +895,33 @@ export interface INodeExecuteFunctions {
|
||||
getExecuteWebhookFunctions: IGetExecuteWebhookFunctions;
|
||||
}
|
||||
|
||||
// The values a node property can have
|
||||
export type NodeParameterValue = string | number | boolean | undefined | null;
|
||||
|
||||
export interface INodeParameters {
|
||||
export type ResourceLocatorModes = 'id' | 'url' | 'list' | string;
|
||||
export interface IResourceLocatorResult {
|
||||
name: string;
|
||||
value: string;
|
||||
url?: string;
|
||||
}
|
||||
|
||||
export interface INodeParameterResourceLocator {
|
||||
mode: ResourceLocatorModes;
|
||||
value: NodeParameterValue;
|
||||
cachedResultName?: string;
|
||||
cachedResultUrl?: string;
|
||||
}
|
||||
|
||||
export type NodeParameterValueType =
|
||||
// TODO: Later also has to be possible to add multiple ones with the name name. So array has to be possible
|
||||
[key: string]: NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[];
|
||||
| NodeParameterValue
|
||||
| INodeParameters
|
||||
| INodeParameterResourceLocator
|
||||
| NodeParameterValue[]
|
||||
| INodeParameters[]
|
||||
| INodeParameterResourceLocator[];
|
||||
|
||||
export interface INodeParameters {
|
||||
[key: string]: NodeParameterValueType;
|
||||
}
|
||||
|
||||
export type NodePropertyTypes =
|
||||
@@ -919,7 +937,8 @@ export type NodePropertyTypes =
|
||||
| 'number'
|
||||
| 'options'
|
||||
| 'string'
|
||||
| 'credentialsSelect';
|
||||
| 'credentialsSelect'
|
||||
| 'resourceLocator';
|
||||
|
||||
export type CodeAutocompleteTypes = 'function' | 'functionItem';
|
||||
|
||||
@@ -967,7 +986,7 @@ export interface INodeProperties {
|
||||
name: string;
|
||||
type: NodePropertyTypes;
|
||||
typeOptions?: INodePropertyTypeOptions;
|
||||
default: NodeParameterValue | INodeParameters | INodeParameters[] | NodeParameterValue[];
|
||||
default: NodeParameterValueType;
|
||||
description?: string;
|
||||
hint?: string;
|
||||
displayOptions?: IDisplayOptions;
|
||||
@@ -980,7 +999,56 @@ export interface INodeProperties {
|
||||
credentialTypes?: Array<
|
||||
'extends:oAuth2Api' | 'extends:oAuth1Api' | 'has:authenticate' | 'has:genericAuth'
|
||||
>;
|
||||
extractValue?: INodePropertyValueExtractor;
|
||||
modes?: INodePropertyMode[];
|
||||
}
|
||||
|
||||
export interface INodePropertyModeTypeOptions {
|
||||
searchListMethod?: string; // Supported by: options
|
||||
searchFilterRequired?: boolean;
|
||||
searchable?: boolean;
|
||||
}
|
||||
|
||||
export interface INodePropertyMode {
|
||||
displayName: string;
|
||||
name: string;
|
||||
type: 'string' | 'list';
|
||||
hint?: string;
|
||||
validation?: Array<
|
||||
INodePropertyModeValidation | { (this: IExecuteSingleFunctions, value: string): void }
|
||||
>;
|
||||
placeholder?: string;
|
||||
url?: string;
|
||||
extractValue?: INodePropertyValueExtractor;
|
||||
initType?: string;
|
||||
entryTypes?: {
|
||||
[name: string]: {
|
||||
selectable?: boolean;
|
||||
hidden?: boolean;
|
||||
queryable?: boolean;
|
||||
data?: {
|
||||
request?: IHttpRequestOptions;
|
||||
output?: INodeRequestOutput;
|
||||
};
|
||||
};
|
||||
};
|
||||
search?: INodePropertyRouting;
|
||||
typeOptions?: INodePropertyModeTypeOptions;
|
||||
}
|
||||
|
||||
export interface INodePropertyModeValidation {
|
||||
type: string;
|
||||
properties: {};
|
||||
}
|
||||
|
||||
export interface INodePropertyRegexValidation extends INodePropertyModeValidation {
|
||||
type: 'regex';
|
||||
properties: {
|
||||
regex: string;
|
||||
errorMessage: string;
|
||||
};
|
||||
}
|
||||
|
||||
export interface INodePropertyOptions {
|
||||
name: string;
|
||||
value: string | number | boolean;
|
||||
@@ -989,12 +1057,39 @@ export interface INodePropertyOptions {
|
||||
routing?: INodePropertyRouting;
|
||||
}
|
||||
|
||||
export interface INodeListSearchItems extends INodePropertyOptions {
|
||||
icon?: string;
|
||||
url?: string;
|
||||
}
|
||||
|
||||
export interface INodeListSearchResult {
|
||||
results: INodeListSearchItems[];
|
||||
paginationToken?: unknown;
|
||||
}
|
||||
|
||||
export interface INodePropertyCollection {
|
||||
displayName: string;
|
||||
name: string;
|
||||
values: INodeProperties[];
|
||||
}
|
||||
|
||||
export interface INodePropertyValueExtractorBase {
|
||||
type: string;
|
||||
}
|
||||
|
||||
export interface INodePropertyValueExtractorRegex extends INodePropertyValueExtractorBase {
|
||||
type: 'regex';
|
||||
regex: string | RegExp;
|
||||
}
|
||||
|
||||
export interface INodePropertyValueExtractorFunction {
|
||||
(this: IExecuteSingleFunctions, value: string | NodeParameterValue):
|
||||
| Promise<string | NodeParameterValue>
|
||||
| (string | NodeParameterValue);
|
||||
}
|
||||
|
||||
export type INodePropertyValueExtractor = INodePropertyValueExtractorRegex;
|
||||
|
||||
export interface IParameterDependencies {
|
||||
[key: string]: string[];
|
||||
}
|
||||
@@ -1028,6 +1123,13 @@ export interface INodeType {
|
||||
loadOptions?: {
|
||||
[key: string]: (this: ILoadOptionsFunctions) => Promise<INodePropertyOptions[]>;
|
||||
};
|
||||
listSearch?: {
|
||||
[key: string]: (
|
||||
this: ILoadOptionsFunctions,
|
||||
filter?: string,
|
||||
paginationToken?: string,
|
||||
) => Promise<INodeListSearchResult>;
|
||||
};
|
||||
credentialTest?: {
|
||||
// Contains a group of functions that test credentials.
|
||||
[functionName: string]: ICredentialTestFunction;
|
||||
|
||||
@@ -23,9 +23,13 @@ import {
|
||||
INodeExecutionData,
|
||||
INodeIssueObjectProperty,
|
||||
INodeIssues,
|
||||
INodeParameterResourceLocator,
|
||||
INodeParameters,
|
||||
INodeProperties,
|
||||
INodePropertyCollection,
|
||||
INodePropertyMode,
|
||||
INodePropertyModeValidation,
|
||||
INodePropertyRegexValidation,
|
||||
INodeType,
|
||||
INodeVersionedType,
|
||||
IParameterDependencies,
|
||||
@@ -849,7 +853,6 @@ export function getNodeParameters(
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return nodeParameters;
|
||||
}
|
||||
|
||||
@@ -1125,6 +1128,37 @@ export function nodeIssuesToString(issues: INodeIssues, node?: INode): string[]
|
||||
return nodeIssues;
|
||||
}
|
||||
|
||||
/*
|
||||
* Validates resource locator node parameters based on validation ruled defined in each parameter mode
|
||||
*
|
||||
*/
|
||||
export const validateResourceLocatorParameter = (
|
||||
value: INodeParameterResourceLocator,
|
||||
parameterMode: INodePropertyMode,
|
||||
): string[] => {
|
||||
const valueToValidate = value?.value?.toString() || '';
|
||||
if (valueToValidate.startsWith('=')) {
|
||||
return [];
|
||||
}
|
||||
|
||||
const validationErrors: string[] = [];
|
||||
// Each mode can have multiple validations specified
|
||||
if (parameterMode.validation) {
|
||||
for (const validation of parameterMode.validation) {
|
||||
if (validation && (validation as INodePropertyModeValidation).type === 'regex') {
|
||||
const regexValidation = validation as INodePropertyRegexValidation;
|
||||
const regex = new RegExp(`^${regexValidation.properties.regex}$`);
|
||||
|
||||
if (!regex.test(valueToValidate)) {
|
||||
validationErrors.push(regexValidation.properties.errorMessage);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return validationErrors;
|
||||
};
|
||||
|
||||
/**
|
||||
* Adds an issue if the parameter is not defined
|
||||
*
|
||||
@@ -1136,14 +1170,16 @@ export function nodeIssuesToString(issues: INodeIssues, node?: INode): string[]
|
||||
export function addToIssuesIfMissing(
|
||||
foundIssues: INodeIssues,
|
||||
nodeProperties: INodeProperties,
|
||||
value: NodeParameterValue,
|
||||
value: NodeParameterValue | INodeParameterResourceLocator,
|
||||
) {
|
||||
// TODO: Check what it really has when undefined
|
||||
if (
|
||||
(nodeProperties.type === 'string' && (value === '' || value === undefined)) ||
|
||||
(nodeProperties.type === 'multiOptions' && Array.isArray(value) && value.length === 0) ||
|
||||
(nodeProperties.type === 'dateTime' && value === undefined) ||
|
||||
(nodeProperties.type === 'options' && (value === '' || value === undefined))
|
||||
(nodeProperties.type === 'options' && (value === '' || value === undefined)) ||
|
||||
(nodeProperties.type === 'resourceLocator' &&
|
||||
(!value || (typeof value === 'object' && !value.value)))
|
||||
) {
|
||||
// Parameter is required but empty
|
||||
if (foundIssues.parameters === undefined) {
|
||||
@@ -1176,6 +1212,10 @@ export function getParameterValueByPath(
|
||||
return get(nodeValues, path ? `${path}.${parameterName}` : parameterName);
|
||||
}
|
||||
|
||||
function isINodeParameterResourceLocator(value: unknown): value is INodeParameterResourceLocator {
|
||||
return typeof value === 'object' && value !== null && 'value' in value && 'mode' in value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns all the issues with the given node-values
|
||||
*
|
||||
@@ -1192,11 +1232,9 @@ export function getParameterIssues(
|
||||
node: INode,
|
||||
): INodeIssues {
|
||||
const foundIssues: INodeIssues = {};
|
||||
let value;
|
||||
|
||||
if (nodeProperties.required === true) {
|
||||
if (displayParameterPath(nodeValues, nodeProperties, path, node)) {
|
||||
value = getParameterValueByPath(nodeValues, nodeProperties.name, path);
|
||||
const value = getParameterValueByPath(nodeValues, nodeProperties.name, path);
|
||||
|
||||
if (
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-optional-chain
|
||||
@@ -1216,6 +1254,28 @@ export function getParameterIssues(
|
||||
}
|
||||
}
|
||||
|
||||
if (nodeProperties.type === 'resourceLocator') {
|
||||
if (displayParameterPath(nodeValues, nodeProperties, path, node)) {
|
||||
const value = getParameterValueByPath(nodeValues, nodeProperties.name, path);
|
||||
if (isINodeParameterResourceLocator(value)) {
|
||||
const mode = nodeProperties.modes?.find((option) => option.name === value.mode);
|
||||
if (mode) {
|
||||
const errors = validateResourceLocatorParameter(value, mode);
|
||||
errors.forEach((error) => {
|
||||
if (foundIssues.parameters === undefined) {
|
||||
foundIssues.parameters = {};
|
||||
}
|
||||
if (foundIssues.parameters[nodeProperties.name] === undefined) {
|
||||
foundIssues.parameters[nodeProperties.name] = [];
|
||||
}
|
||||
|
||||
foundIssues.parameters[nodeProperties.name].push(error);
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Check if there are any child parameters
|
||||
if (nodeProperties.options === undefined) {
|
||||
// There are none so nothing else to check
|
||||
@@ -1251,7 +1311,11 @@ export function getParameterIssues(
|
||||
let propertyOptions: INodePropertyCollection;
|
||||
for (propertyOptions of nodeProperties.options as INodePropertyCollection[]) {
|
||||
// Check if the option got set and if not skip it
|
||||
value = getParameterValueByPath(nodeValues, propertyOptions.name, basePath.slice(0, -1));
|
||||
const value = getParameterValueByPath(
|
||||
nodeValues,
|
||||
propertyOptions.name,
|
||||
basePath.slice(0, -1),
|
||||
);
|
||||
if (value === undefined) {
|
||||
continue;
|
||||
}
|
||||
|
||||
@@ -45,6 +45,7 @@ import {
|
||||
IN8nRequestOperations,
|
||||
INodeProperties,
|
||||
INodePropertyCollection,
|
||||
NodeParameterValueType,
|
||||
PostReceiveAction,
|
||||
} from './Interfaces';
|
||||
|
||||
@@ -580,13 +581,13 @@ export class RoutingNode {
|
||||
}
|
||||
|
||||
getParameterValue(
|
||||
parameterValue: NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[],
|
||||
parameterValue: NodeParameterValueType,
|
||||
itemIndex: number,
|
||||
runIndex: number,
|
||||
executeData: IExecuteData,
|
||||
additionalKeys?: IWorkflowDataProxyAdditionalKeys,
|
||||
returnObjectAsString = false,
|
||||
): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | string {
|
||||
): NodeParameterValueType {
|
||||
if (
|
||||
typeof parameterValue === 'object' ||
|
||||
(typeof parameterValue === 'string' && parameterValue.charAt(0) === '=')
|
||||
@@ -642,8 +643,15 @@ export class RoutingNode {
|
||||
if (nodeProperties.routing) {
|
||||
let parameterValue: string | undefined;
|
||||
if (basePath + nodeProperties.name && 'type' in nodeProperties) {
|
||||
// Extract value if it has extractValue defined or if it's a
|
||||
// resourceLocator component. Resource locators are likely to have extractors
|
||||
// and we can't know if the mode has one unless we dig all the way in.
|
||||
const shouldExtractValue =
|
||||
nodeProperties.extractValue !== undefined || nodeProperties.type === 'resourceLocator';
|
||||
parameterValue = executeSingleFunctions.getNodeParameter(
|
||||
basePath + nodeProperties.name,
|
||||
undefined,
|
||||
{ extractValue: shouldExtractValue },
|
||||
) as string;
|
||||
}
|
||||
|
||||
@@ -663,6 +671,7 @@ export class RoutingNode {
|
||||
{ ...additionalKeys, $value: parameterValue },
|
||||
false,
|
||||
) as string;
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
(returnData.options as Record<string, any>)[key] = propertyValue;
|
||||
}
|
||||
|
||||
@@ -40,7 +40,6 @@ import {
|
||||
IWorkflowExecuteAdditionalData,
|
||||
IWorkflowSettings,
|
||||
NodeHelpers,
|
||||
NodeParameterValue,
|
||||
ObservableObject,
|
||||
RoutingNode,
|
||||
WebhookSetupMethodNames,
|
||||
@@ -57,6 +56,7 @@ import {
|
||||
IObservableObject,
|
||||
IRun,
|
||||
IRunNodeResponse,
|
||||
NodeParameterValueType,
|
||||
} from './Interfaces';
|
||||
|
||||
function dedupe<T>(arr: T[]): T[] {
|
||||
@@ -437,10 +437,10 @@ export class Workflow {
|
||||
* @memberof Workflow
|
||||
*/
|
||||
renameNodeInExpressions(
|
||||
parameterValue: NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[],
|
||||
parameterValue: NodeParameterValueType,
|
||||
currentName: string,
|
||||
newName: string,
|
||||
): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] {
|
||||
): NodeParameterValueType {
|
||||
if (typeof parameterValue !== 'object') {
|
||||
// Reached the actual value
|
||||
if (typeof parameterValue === 'string' && parameterValue.charAt(0) === '=') {
|
||||
@@ -503,7 +503,7 @@ export class Workflow {
|
||||
for (const parameterName of Object.keys(parameterValue || {})) {
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
|
||||
returnData[parameterName] = this.renameNodeInExpressions(
|
||||
parameterValue![parameterName],
|
||||
parameterValue![parameterName as keyof typeof parameterValue],
|
||||
currentName,
|
||||
newName,
|
||||
);
|
||||
|
||||
@@ -24,7 +24,7 @@ import {
|
||||
IWorkflowDataProxyAdditionalKeys,
|
||||
IWorkflowDataProxyData,
|
||||
NodeHelpers,
|
||||
NodeParameterValue,
|
||||
NodeParameterValueType,
|
||||
Workflow,
|
||||
WorkflowExecuteMode,
|
||||
} from '.';
|
||||
@@ -178,11 +178,7 @@ export class WorkflowDataProxy {
|
||||
get(target, name, receiver) {
|
||||
name = name.toString();
|
||||
|
||||
let returnValue:
|
||||
| INodeParameters
|
||||
| NodeParameterValue
|
||||
| NodeParameterValue[]
|
||||
| INodeParameters[];
|
||||
let returnValue: NodeParameterValueType;
|
||||
if (name[0] === '&') {
|
||||
const key = name.slice(1);
|
||||
if (!that.siblingParameters.hasOwnProperty(key)) {
|
||||
|
||||
@@ -632,7 +632,7 @@ describe('RoutingNode', () => {
|
||||
};
|
||||
|
||||
for (const testData of tests) {
|
||||
test(testData.description, () => {
|
||||
test(testData.description, async () => {
|
||||
node.parameters = testData.input.nodeParameters;
|
||||
nodeType.description.properties = [testData.input.nodeTypeProperties];
|
||||
|
||||
@@ -669,7 +669,7 @@ describe('RoutingNode', () => {
|
||||
mode,
|
||||
);
|
||||
|
||||
const result = routingNode.getRequestOptionsFromParameters(
|
||||
const result = await routingNode.getRequestOptionsFromParameters(
|
||||
executeSingleFunctions,
|
||||
testData.input.nodeTypeProperties,
|
||||
itemIndex,
|
||||
|
||||
Reference in New Issue
Block a user