Monday.com node

This commit is contained in:
ricardo 2020-03-26 15:39:31 -04:00
parent f0f4a04c74
commit 9320d415d6
6 changed files with 1111 additions and 2 deletions

View file

@ -0,0 +1,17 @@
import {
ICredentialType,
NodePropertyTypes,
} from 'n8n-workflow';
export class MondayApi implements ICredentialType {
name = 'mondayApi';
displayName = 'Monday.com API';
properties = [
{
displayName: 'Token V2',
name: 'apiToken',
type: 'string' as NodePropertyTypes,
default: '',
},
];
}

View file

@ -0,0 +1,619 @@
import { INodeProperties } from "n8n-workflow";
export const boardOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'board',
],
},
},
options: [
{
name: 'Add Column',
value: 'addColumn',
description: 'Add column to a board',
},
{
name: 'Archive',
value: 'archive',
description: 'Archive a board',
},
{
name: 'Create',
value: 'create',
description: 'Create a new board',
},
{
name: 'Create Group',
value: 'createGroup',
description: 'Create a group in a board',
},
{
name: 'Create Item',
value: 'createItem',
description: `Create a item in a board's group`,
},
{
name: 'Get',
value: 'get',
description: 'Get a board',
},
{
name: 'Get All',
value: 'getAll',
description: 'Get all boards',
},
{
name: 'Get Columns',
value: 'getColumns',
description: `Get board's columns`,
},
{
name: 'Get Groups',
value: 'getGroups',
description: `Get board's groups`,
},
],
default: 'create',
description: 'The operation to perform.',
},
] as INodeProperties[];
export const boardFields = [
/* -------------------------------------------------------------------------- */
/* board:addColumn */
/* -------------------------------------------------------------------------- */
{
displayName: 'Board ID',
name: 'boardId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getBoards',
},
required: true,
displayOptions: {
show: {
resource: [
'board',
],
operation: [
'addColumn',
],
},
},
},
{
displayName: 'Title',
name: 'title',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'board',
],
operation: [
'addColumn',
],
},
},
},
{
displayName: 'Column Type',
name: 'columnType',
type: 'options',
options: [
{
name: 'Country',
value: 'country',
},
{
name: 'Checkbox',
value: 'checkbox',
},
{
name: 'Date',
value: 'date',
},
{
name: 'Dropdown',
value: 'dropdown',
},
{
name: 'Email',
value: 'email',
},
{
name: 'Hour',
value: 'hour',
},
{
name: 'Link',
value: 'Link',
},
{
name: 'Long Text',
value: 'longText',
},
{
name: 'Numbers',
value: 'numbers',
},
{
name: 'People',
value: 'people',
},
{
name: 'Person',
value: 'person',
},
{
name: 'Phone',
value: 'phone',
},
{
name: 'Rating',
value: 'rating',
},
{
name: 'Status',
value: 'status',
},
{
name: 'Tags',
value: 'tags',
},
{
name: 'Team',
value: 'team',
},
{
name: 'Text',
value: 'text',
},
{
name: 'Timeline',
value: 'timeline',
},
{
name: 'Timezone',
value: 'timezone',
},
{
name: 'Week',
value: 'week',
},
{
name: 'World Clock',
value: 'worldClock',
},
],
required: true,
displayOptions: {
show: {
resource: [
'board',
],
operation: [
'addColumn',
],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: [
'addColumn',
],
resource: [
'board',
],
},
},
default: {},
options: [
{
displayName: 'Defauls',
name: 'defaults',
type: 'json',
typeOptions: {
alwaysOpenEditWindow: true,
},
default: '',
description: `The new column's defaults.`,
},
],
},
/* -------------------------------------------------------------------------- */
/* board:archive */
/* -------------------------------------------------------------------------- */
{
displayName: 'Board ID',
name: 'boardId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getBoards',
},
required: true,
displayOptions: {
show: {
resource: [
'board',
],
operation: [
'archive',
],
},
},
},
/* -------------------------------------------------------------------------- */
/* board:create */
/* -------------------------------------------------------------------------- */
{
displayName: 'Name',
name: 'name',
type: 'string',
required: true,
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'board',
],
},
},
default: '',
description: `The board's name`,
},
{
displayName: 'Kind',
name: 'kind',
type: 'options',
options: [
{
name: 'Share',
value: 'share',
},
{
name: 'Public',
value: 'public',
},
{
name: 'Private',
value: 'private',
},
],
required: true,
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'board',
],
},
},
default: '',
description: `The board's kind (public / private / share)`,
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'board',
],
},
},
default: {},
options: [
{
displayName: 'Template ID',
name: 'templateId',
type: 'number',
typeOptions: {
minValue: 0,
},
default: 0,
description: 'Optional board template id',
},
],
},
/* -------------------------------------------------------------------------- */
/* board:createGroup */
/* -------------------------------------------------------------------------- */
{
displayName: 'Board ID',
name: 'boardId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getBoards',
},
required: true,
displayOptions: {
show: {
resource: [
'board',
],
operation: [
'createGroup',
],
},
},
},
{
displayName: 'Name',
name: 'name',
type: 'string',
required: true,
displayOptions: {
show: {
operation: [
'createGroup',
],
resource: [
'board',
],
},
},
default: '',
description: `The group name`,
},
/* -------------------------------------------------------------------------- */
/* board:createItem */
/* -------------------------------------------------------------------------- */
{
displayName: 'Board ID',
name: 'boardId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getBoards',
},
required: true,
displayOptions: {
show: {
resource: [
'board',
],
operation: [
'createItem',
],
},
},
},
{
displayName: 'Group ID',
name: 'groupId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getGroups',
loadOptionsDependsOn: 'boardId',
},
required: true,
displayOptions: {
show: {
resource: [
'board',
],
operation: [
'createItem',
],
},
},
},
{
displayName: 'Name',
name: 'name',
type: 'string',
required: true,
displayOptions: {
show: {
operation: [
'createItem',
],
resource: [
'board',
],
},
},
default: '',
description: `The new item's name.`,
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: [
'createItem',
],
resource: [
'board',
],
},
},
default: {},
options: [
{
displayName: 'Column Values',
name: 'columnValues',
type: 'json',
typeOptions: {
alwaysOpenEditWindow: true,
},
default: '',
description: 'The column values of the new item',
},
],
},
/* -------------------------------------------------------------------------- */
/* board:deleteGroup */
/* -------------------------------------------------------------------------- */
{
displayName: 'Board ID',
name: 'boardId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getBoards',
},
required: true,
displayOptions: {
show: {
resource: [
'board',
],
operation: [
'deleteGroup',
],
},
},
},
{
displayName: 'Group ID',
name: 'groupId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getGroups',
loadOptionsDependsOn: 'boardId',
},
required: true,
displayOptions: {
show: {
resource: [
'board',
],
operation: [
'deleteGroup',
],
},
},
},
/* -------------------------------------------------------------------------- */
/* board:get */
/* -------------------------------------------------------------------------- */
{
displayName: 'Board ID',
name: 'boardId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'board',
],
operation: [
'get',
],
},
},
},
/* -------------------------------------------------------------------------- */
/* board:getAll */
/* -------------------------------------------------------------------------- */
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'board',
],
operation: [
'getAll',
],
},
},
default: false,
description: 'If all results should be returned or only up to a given limit.',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'board',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 100,
},
default: 50,
description: 'How many results to return.',
},
/* -------------------------------------------------------------------------- */
/* board:getColumns */
/* -------------------------------------------------------------------------- */
{
displayName: 'Board ID',
name: 'boardId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getBoards',
},
required: true,
displayOptions: {
show: {
resource: [
'board',
],
operation: [
'getColumns',
],
},
},
},
/* -------------------------------------------------------------------------- */
/* board:getGroups */
/* -------------------------------------------------------------------------- */
{
displayName: 'Board ID',
name: 'boardId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getBoards',
},
required: true,
displayOptions: {
show: {
resource: [
'board',
],
operation: [
'getGroups',
],
},
},
},
] as INodeProperties[];

View file

@ -0,0 +1,62 @@
import { OptionsWithUri } from 'request';
import {
IExecuteFunctions,
ILoadOptionsFunctions,
} from 'n8n-core';
import {
IDataObject,
IHookFunctions,
IWebhookFunctions
} from 'n8n-workflow';
export async function mondayApiRequest(this: IExecuteFunctions | IWebhookFunctions | IHookFunctions | ILoadOptionsFunctions, body: any = {}, option: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
const credentials = this.getCredentials('mondayApi');
if (credentials === undefined) {
throw new Error('No credentials got returned!');
}
const endpoint = 'https://api.monday.com/v2/';
let options: OptionsWithUri = {
headers: {
'Content-Type': 'application/json',
'Authorization': credentials.apiToken,
},
method: 'POST',
body,
uri: endpoint,
json: true
};
options = Object.assign({}, options, option);
try {
return await this.helpers.request!(options);
} catch (error) {
if (error.response) {
const errorMessage = error.response.body.error_message;
throw new Error(`Monday error response [${error.statusCode}]: ${errorMessage}`);
}
throw error;
}
}
export async function mondayApiRequestAllItems(this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions, propertyName: string, body: any = {}): Promise<any> { // tslint:disable-line:no-any
const returnData: IDataObject[] = [];
let responseData;
body.variables.limit = 50;
body.variables.page = 1;
do {
responseData = await mondayApiRequest.call(this, body);
returnData.push.apply(returnData, responseData['data'][propertyName]);
body.variables.page++;
} while (
responseData['data'][propertyName].length > 0
);
return returnData;
}

View file

@ -0,0 +1,409 @@
import {
BINARY_ENCODING,
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
ILoadOptionsFunctions,
INodeTypeDescription,
INodeExecutionData,
INodeType,
INodePropertyOptions,
} from 'n8n-workflow';
import {
mondayApiRequest,
mondayApiRequestAllItems,
} from './GenericFunctions';
import {
boardFields,
boardOperations,
} from './BoardDescription';
import { snakeCase } from 'change-case';
interface IGraphqlBody {
query: string;
variables: IDataObject;
}
export class Monday implements INodeType {
description: INodeTypeDescription = {
displayName: 'Monday.com',
name: 'monday.com',
icon: 'file:monday.png',
group: ['output'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consume Monday.com API',
defaults: {
name: 'Monday.com',
color: '#000000',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'mondayApi',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'Board',
value: 'board',
},
],
default: 'board',
description: 'Resource to consume.',
},
...boardOperations,
...boardFields,
],
};
methods = {
loadOptions: {
// Get all the available boards to display them to user so that he can
// select them easily
async getBoards(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const body = {
query:
`query ($page: Int, $limit: Int) {
boards (page: $page, limit: $limit){
id
description
name
}
}`,
variables: {
page: 1,
},
};
const boards = await mondayApiRequestAllItems.call(this, 'boards', body);
for (const board of boards) {
const boardName = board.name;
const boardId = board.id;
const boardDescription = board.description;
returnData.push({
name: boardName,
value: boardId,
description: boardDescription,
});
}
return returnData;
},
// Get all the available groups to display them to user so that he can
// select them easily
async getGroups(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const boardId = parseInt(this.getCurrentNodeParameter('boardId') as string, 10);
const body = {
query:
`query ($boardId: Int!) {
boards ( ids: [$boardId]){
groups () {
id
title
}
}
}`,
variables: {
boardId,
},
};
const { data } = await mondayApiRequest.call(this, body);
const groups = data.boards[0].groups;
for (const group of groups) {
const groupName = group.title;
const groupId = group.id;
returnData.push({
name: groupName,
value: groupId,
});
}
return returnData;
},
},
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
const length = items.length as unknown as number;
let responseData;
const qs: IDataObject = {};
const resource = this.getNodeParameter('resource', 0) as string;
const operation = this.getNodeParameter('operation', 0) as string;
for (let i = 0; i < length; i++) {
if (resource === 'board') {
if (operation === 'addColumn') {
const boardId = parseInt(this.getNodeParameter('boardId', i) as string, 10);
const title = this.getNodeParameter('title', i) as string;
const columnType = this.getNodeParameter('columnType', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const body: IGraphqlBody = {
query:
`mutation ($boardId: Int!, $title: String!, $columnType: ColumnType, $defaults: JSON ) {
create_column (board_id: $boardId, title: $title, column_type: $columnType, defaults: $defaults) {
id
}
}`,
variables: {
boardId,
title,
columnType: snakeCase(columnType),
},
};
if (additionalFields.defaults) {
try {
JSON.parse(additionalFields.defaults as string);
} catch (e) {
throw new Error('Defauls must be a valid JSON');
}
body.variables.defaults = JSON.stringify(JSON.parse(additionalFields.defaults as string));
}
responseData = await mondayApiRequest.call(this, body);
responseData = responseData.data.create_column;
}
if (operation === 'archive') {
const boardId = parseInt(this.getNodeParameter('boardId', i) as string, 10);
const body: IGraphqlBody = {
query:
`mutation ($id: Int!) {
archive_board (board_id: $id) {
id
}
}`,
variables: {
id: boardId,
},
};
responseData = await mondayApiRequest.call(this, body);
responseData = responseData.data.archive_board;
}
if (operation === 'create') {
const name = this.getNodeParameter('name', i) as string;
const kind = this.getNodeParameter('kind', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const body: IGraphqlBody = {
query:
`mutation ($name: String!, $kind: BoardKind!, $templateId: Int) {
create_board (board_name: $name, board_kind: $kind, template_id: $templateId) {
id
}
}`,
variables: {
name,
kind,
},
};
if (additionalFields.templateId) {
body.variables.templateId = additionalFields.templateId as number;
}
responseData = await mondayApiRequest.call(this, body);
responseData = responseData.data.create_board;
}
if (operation === 'createGroup') {
const boardId = parseInt(this.getNodeParameter('boardId', i) as string, 10);
const name = this.getNodeParameter('name', i) as string;
const body: IGraphqlBody = {
query:
`mutation ($boardId: Int!, $groupName: String!) {
create_group (board_id: $boardId, group_name: $groupName) {
id
}
}`,
variables: {
boardId,
groupName: name,
},
};
responseData = await mondayApiRequest.call(this, body);
responseData = responseData.data.create_group;
}
if (operation === 'createItem') {
const boardId = parseInt(this.getNodeParameter('boardId', i) as string, 10);
const groupId = this.getNodeParameter('groupId', i) as string;
const itemName = this.getNodeParameter('name', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const body: IGraphqlBody = {
query:
`mutation ($boardId: Int!, $groupId: String!, $itemName: String!, $columnValues: JSON) {
create_item (board_id: $boardId, group_id: $groupId, item_name: $itemName, column_values: $columnValues) {
id
}
}`,
variables: {
boardId,
groupId,
itemName,
},
};
if (additionalFields.columnValues) {
try {
JSON.parse(additionalFields.columnValues as string);
} catch (e) {
throw new Error('Custom Values must be a valid JSON');
}
body.variables.columnValues = JSON.stringify(JSON.parse(additionalFields.columnValues as string));
}
responseData = await mondayApiRequest.call(this, body);
responseData = responseData.data.create_item;
}
if (operation === 'deleteGroup') {
const boardId = parseInt(this.getNodeParameter('boardId', i) as string, 10);
const groupId = this.getNodeParameter('groupId', i) as string;
const body: IGraphqlBody = {
query:
`mutation ($boardId: Int!, $groupId: String!) {
delete_group (board_id: $boardId, group_id: $groupId) {
id
}
}`,
variables: {
boardId,
groupId,
},
};
responseData = await mondayApiRequest.call(this, body);
responseData = responseData.data.delete_group;
}
if (operation === 'get') {
const boardId = parseInt(this.getNodeParameter('boardId', i) as string, 10);
const body: IGraphqlBody = {
query:
`query ($id: [Int]) {
boards (ids: $id){
id
name
description
state
board_folder_id
board_kind
owner() {
id
}
}
}`,
variables: {
id: boardId,
},
};
responseData = await mondayApiRequest.call(this, body);
responseData = responseData.data.boards;
}
if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
const body: IGraphqlBody = {
query:
`query ($page: Int, $limit: Int) {
boards (page: $page, limit: $limit){
id
name
description
state
board_folder_id
board_kind
owner() {
id
}
}
}`,
variables: {
page: 1,
},
};
if (returnAll === true) {
responseData = await mondayApiRequestAllItems.call(this, 'boards', body);
} else {
body.variables.limit = this.getNodeParameter('limit', i) as number,
responseData = await mondayApiRequest.call(this, body);
responseData = responseData.data.boards;
}
}
if (operation === 'getColumns') {
const boardId = parseInt(this.getNodeParameter('boardId', i) as string, 10);
const body: IGraphqlBody = {
query:
`query ($boardId: [Int]) {
boards (ids: $boardId){
columns() {
id
title
type
settings_str
archived
}
}
}`,
variables: {
page: 1,
boardId,
},
};
responseData = await mondayApiRequest.call(this, body);
responseData = responseData.data.boards[0].columns;
}
if (operation === 'getGroups') {
const boardId = parseInt(this.getNodeParameter('boardId', i) as string, 10);
const body: IGraphqlBody = {
query:
`query ($boardId: [Int]) {
boards (ids: $boardId, ){
id
groups() {
title
color
position
archived
}
}
}`,
variables: {
boardId,
},
};
responseData = await mondayApiRequest.call(this, body);
responseData = responseData.data.boards[0].groups;
}
}
if (Array.isArray(responseData)) {
returnData.push.apply(returnData, responseData as IDataObject[]);
} else {
returnData.push(responseData as IDataObject);
}
}
return [this.helpers.returnJsonArray(returnData)];
}
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB

View file

@ -74,7 +74,8 @@
"dist/credentials/MandrillApi.credentials.js",
"dist/credentials/MattermostApi.credentials.js",
"dist/credentials/MauticApi.credentials.js",
"dist/credentials/MoceanApi.credentials.js",
"dist/credentials/MoceanApi.credentials.js",
"dist/credentials/MondayApi.credentials.js",
"dist/credentials/MongoDb.credentials.js",
"dist/credentials/Msg91Api.credentials.js",
"dist/credentials/MySql.credentials.js",
@ -184,7 +185,8 @@
"dist/nodes/Mautic/Mautic.node.js",
"dist/nodes/Mautic/MauticTrigger.node.js",
"dist/nodes/Merge.node.js",
"dist/nodes/Mocean/Mocean.node.js",
"dist/nodes/Mocean/Mocean.node.js",
"dist/nodes/Monday/Monday.node.js",
"dist/nodes/MongoDb/MongoDb.node.js",
"dist/nodes/MoveBinaryData.node.js",
"dist/nodes/Msg91/Msg91.node.js",