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
2022-09-21 15:44:45 +02:00
committed by GitHub
parent a71f3622e2
commit ad73f8995c
58 changed files with 3151 additions and 703 deletions

View File

@@ -1,8 +1,9 @@
import { IExecuteFunctions } from 'n8n-core';
import { IExecuteFunctions, ILoadOptionsFunctions } from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
INodeListSearchResult,
INodeType,
INodeTypeDescription,
NodeOperationError,
@@ -26,6 +27,17 @@ import { labelFields, labelOperations } from './LabelDescription';
import { listFields, listOperations } from './ListDescription';
interface TrelloBoardType {
id: string;
name: string;
url: string;
desc: string;
}
// We retrieve the same fields. This is just to make it clear it's not actually
// getting boards back.
type TrelloCardType = TrelloBoardType;
export class Trello implements INodeType {
description: INodeTypeDescription = {
displayName: 'Trello',
@@ -115,6 +127,73 @@ export class Trello implements INodeType {
],
};
methods = {
listSearch: {
async searchBoards(
this: ILoadOptionsFunctions,
query?: string,
): Promise<INodeListSearchResult> {
if (!query) {
throw new NodeOperationError(this.getNode(), 'Query required for Trello search');
}
const searchResults = await apiRequest.call(
this,
'GET',
'search',
{},
{
query,
modelTypes: 'boards',
board_fields: 'name,url,desc',
// Enables partial word searching, only for the start of words though
partial: true,
// Seems like a good number since it isn't paginated. Default is 10.
boards_limit: 50,
},
);
return {
results: searchResults.boards.map((b: TrelloBoardType) => ({
name: b.name,
value: b.id,
url: b.url,
description: b.desc,
})),
};
},
async searchCards(
this: ILoadOptionsFunctions,
query?: string,
): Promise<INodeListSearchResult> {
if (!query) {
throw new NodeOperationError(this.getNode(), 'Query required for Trello search');
}
const searchResults = await apiRequest.call(
this,
'GET',
'search',
{},
{
query,
modelTypes: 'cards',
board_fields: 'name,url,desc',
// Enables partial word searching, only for the start of words though
partial: true,
// Seems like a good number since it isn't paginated. Default is 10.
cards_limit: 50,
},
);
return {
results: searchResults.cards.map((b: TrelloBoardType) => ({
name: b.name,
value: b.id,
url: b.url,
description: b.desc,
})),
};
},
},
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: INodeExecutionData[] = [];
@@ -160,7 +239,9 @@ export class Trello implements INodeType {
requestMethod = 'DELETE';
const id = this.getNodeParameter('id', i) as string;
const id = this.getNodeParameter('id', i, undefined, {
extractValue: true,
}) as string;
endpoint = `boards/${id}`;
} else if (operation === 'get') {
@@ -170,7 +251,7 @@ export class Trello implements INodeType {
requestMethod = 'GET';
const id = this.getNodeParameter('id', i) as string;
const id = this.getNodeParameter('id', i, undefined, { extractValue: true });
endpoint = `boards/${id}`;
@@ -183,7 +264,7 @@ export class Trello implements INodeType {
requestMethod = 'PUT';
const id = this.getNodeParameter('id', i) as string;
const id = this.getNodeParameter('id', i, undefined, { extractValue: true });
endpoint = `boards/${id}`;
@@ -286,7 +367,7 @@ export class Trello implements INodeType {
requestMethod = 'DELETE';
const id = this.getNodeParameter('id', i) as string;
const id = this.getNodeParameter('id', i, undefined, { extractValue: true });
endpoint = `cards/${id}`;
} else if (operation === 'get') {
@@ -296,7 +377,7 @@ export class Trello implements INodeType {
requestMethod = 'GET';
const id = this.getNodeParameter('id', i) as string;
const id = this.getNodeParameter('id', i, undefined, { extractValue: true });
endpoint = `cards/${id}`;
@@ -309,7 +390,7 @@ export class Trello implements INodeType {
requestMethod = 'PUT';
const id = this.getNodeParameter('id', i) as string;
const id = this.getNodeParameter('id', i, undefined, { extractValue: true });
endpoint = `cards/${id}`;
@@ -328,7 +409,9 @@ export class Trello implements INodeType {
// create
// ----------------------------------
const cardId = this.getNodeParameter('cardId', i) as string;
const cardId = this.getNodeParameter('cardId', i, undefined, {
extractValue: true,
}) as string;
qs.text = this.getNodeParameter('text', i) as string;
@@ -342,7 +425,9 @@ export class Trello implements INodeType {
requestMethod = 'DELETE';
const cardId = this.getNodeParameter('cardId', i) as string;
const cardId = this.getNodeParameter('cardId', i, undefined, {
extractValue: true,
}) as string;
const commentId = this.getNodeParameter('commentId', i) as string;
@@ -354,7 +439,9 @@ export class Trello implements INodeType {
requestMethod = 'PUT';
const cardId = this.getNodeParameter('cardId', i) as string;
const cardId = this.getNodeParameter('cardId', i, undefined, {
extractValue: true,
}) as string;
const commentId = this.getNodeParameter('commentId', i) as string;
@@ -473,7 +560,10 @@ export class Trello implements INodeType {
requestMethod = 'POST';
const cardId = this.getNodeParameter('cardId', i) as string;
const cardId = this.getNodeParameter('cardId', i, undefined, {
extractValue: true,
}) as string;
const url = this.getNodeParameter('url', i) as string;
Object.assign(qs, {
@@ -491,7 +581,10 @@ export class Trello implements INodeType {
requestMethod = 'DELETE';
const cardId = this.getNodeParameter('cardId', i) as string;
const cardId = this.getNodeParameter('cardId', i, undefined, {
extractValue: true,
}) as string;
const id = this.getNodeParameter('id', i) as string;
endpoint = `cards/${cardId}/attachments/${id}`;
@@ -502,7 +595,10 @@ export class Trello implements INodeType {
requestMethod = 'GET';
const cardId = this.getNodeParameter('cardId', i) as string;
const cardId = this.getNodeParameter('cardId', i, undefined, {
extractValue: true,
}) as string;
const id = this.getNodeParameter('id', i) as string;
endpoint = `cards/${cardId}/attachments/${id}`;
@@ -516,7 +612,9 @@ export class Trello implements INodeType {
requestMethod = 'GET';
const cardId = this.getNodeParameter('cardId', i) as string;
const cardId = this.getNodeParameter('cardId', i, undefined, {
extractValue: true,
}) as string;
endpoint = `cards/${cardId}/attachments`;
@@ -537,7 +635,10 @@ export class Trello implements INodeType {
requestMethod = 'POST';
const cardId = this.getNodeParameter('cardId', i) as string;
const cardId = this.getNodeParameter('cardId', i, undefined, {
extractValue: true,
}) as string;
const name = this.getNodeParameter('name', i) as string;
Object.assign(qs, { name });
@@ -553,7 +654,10 @@ export class Trello implements INodeType {
requestMethod = 'DELETE';
const cardId = this.getNodeParameter('cardId', i) as string;
const cardId = this.getNodeParameter('cardId', i, undefined, {
extractValue: true,
}) as string;
const id = this.getNodeParameter('id', i) as string;
endpoint = `cards/${cardId}/checklists/${id}`;
@@ -577,7 +681,9 @@ export class Trello implements INodeType {
requestMethod = 'GET';
const cardId = this.getNodeParameter('cardId', i) as string;
const cardId = this.getNodeParameter('cardId', i, undefined, {
extractValue: true,
}) as string;
endpoint = `cards/${cardId}/checklists`;
@@ -590,7 +696,10 @@ export class Trello implements INodeType {
requestMethod = 'GET';
const cardId = this.getNodeParameter('cardId', i) as string;
const cardId = this.getNodeParameter('cardId', i, undefined, {
extractValue: true,
}) as string;
const checkItemId = this.getNodeParameter('checkItemId', i) as string;
endpoint = `cards/${cardId}/checkItem/${checkItemId}`;
@@ -618,7 +727,10 @@ export class Trello implements INodeType {
requestMethod = 'DELETE';
const cardId = this.getNodeParameter('cardId', i) as string;
const cardId = this.getNodeParameter('cardId', i, undefined, {
extractValue: true,
}) as string;
const checkItemId = this.getNodeParameter('checkItemId', i) as string;
endpoint = `cards/${cardId}/checkItem/${checkItemId}`;
@@ -629,7 +741,10 @@ export class Trello implements INodeType {
requestMethod = 'PUT';
const cardId = this.getNodeParameter('cardId', i) as string;
const cardId = this.getNodeParameter('cardId', i, undefined, {
extractValue: true,
}) as string;
const checkItemId = this.getNodeParameter('checkItemId', i) as string;
endpoint = `cards/${cardId}/checkItem/${checkItemId}`;
@@ -643,7 +758,9 @@ export class Trello implements INodeType {
requestMethod = 'GET';
const cardId = this.getNodeParameter('cardId', i) as string;
const cardId = this.getNodeParameter('cardId', i, undefined, {
extractValue: true,
}) as string;
endpoint = `cards/${cardId}/checkItemStates`;
@@ -664,7 +781,10 @@ export class Trello implements INodeType {
requestMethod = 'POST';
const idBoard = this.getNodeParameter('boardId', i) as string;
const idBoard = this.getNodeParameter('boardId', i, undefined, {
extractValue: true,
}) as string;
const name = this.getNodeParameter('name', i) as string;
const color = this.getNodeParameter('color', i) as string;
@@ -705,7 +825,9 @@ export class Trello implements INodeType {
requestMethod = 'GET';
const idBoard = this.getNodeParameter('boardId', i) as string;
const idBoard = this.getNodeParameter('boardId', i, undefined, {
extractValue: true,
}) as string;
endpoint = `board/${idBoard}/labels`;
@@ -732,7 +854,10 @@ export class Trello implements INodeType {
requestMethod = 'POST';
const cardId = this.getNodeParameter('cardId', i) as string;
const cardId = this.getNodeParameter('cardId', i, undefined, {
extractValue: true,
}) as string;
const id = this.getNodeParameter('id', i) as string;
qs.value = id;
@@ -745,7 +870,10 @@ export class Trello implements INodeType {
requestMethod = 'DELETE';
const cardId = this.getNodeParameter('cardId', i) as string;
const cardId = this.getNodeParameter('cardId', i, undefined, {
extractValue: true,
}) as string;
const id = this.getNodeParameter('id', i) as string;
endpoint = `/cards/${cardId}/idLabels/${id}`;