diff --git a/packages/nodes-base/credentials/MongoDB.credentials.ts b/packages/nodes-base/credentials/MongoDB.credentials.ts new file mode 100644 index 0000000000..141f9194d2 --- /dev/null +++ b/packages/nodes-base/credentials/MongoDB.credentials.ts @@ -0,0 +1,45 @@ +import { + ICredentialType, + NodePropertyTypes, +} from 'n8n-workflow'; + + +export class MongoDB implements ICredentialType { + name = 'mongodb'; + displayName = 'MongoDB'; + properties = [ + { + displayName: 'Host', + name: 'host', + type: 'string' as NodePropertyTypes, + default: 'localhost', + }, + { + displayName: 'Database', + name: 'database', + type: 'string' as NodePropertyTypes, + default: '', + }, + { + displayName: 'User', + name: 'user', + type: 'string' as NodePropertyTypes, + default: '', + }, + { + displayName: 'Password', + name: 'password', + type: 'string' as NodePropertyTypes, + typeOptions: { + password: true, + }, + default: '', + }, + { + displayName: 'Port', + name: 'port', + type: 'number' as NodePropertyTypes, + default: 0 + }, + ]; +} diff --git a/packages/nodes-base/nodes/MongoDB/MongoDB.node.ts b/packages/nodes-base/nodes/MongoDB/MongoDB.node.ts new file mode 100644 index 0000000000..7cf44b6326 --- /dev/null +++ b/packages/nodes-base/nodes/MongoDB/MongoDB.node.ts @@ -0,0 +1,269 @@ +import { IExecuteFunctions } from 'n8n-core'; +import { + IDataObject, + INodeExecutionData, + INodeType, + INodeTypeDescription, +} from 'n8n-workflow'; + +import { MongoClient } from 'mongodb'; + + +/** + * Returns of copy of the items which only contains the json data and + * of that only the define properties + * + * @param {INodeExecutionData[]} items The items to copy + * @param {string[]} properties The properties it should include + * @returns + */ +function getItemCopy(items: INodeExecutionData[], properties: string[]): IDataObject[] { + // Prepare the data to insert and copy it to be returned + let newItem: IDataObject; + return items.map((item) => { + newItem = {}; + for (const property of properties) { + if (item.json[property] === undefined) { + newItem[property] = null; + } else { + newItem[property] = JSON.parse(JSON.stringify(item.json[property])); + } + } + return newItem; + }); +} + + +export class MongoDB implements INodeType { + description: INodeTypeDescription = { + displayName: 'MongoDB', + name: 'mongodb', + icon: 'file:mongodb.png', + group: ['input'], + version: 1, + description: 'Find, insert and update documents in MongoDB.', + defaults: { + name: 'MongoDB', + color: '#13AA52', + }, + inputs: ['main'], + outputs: ['main'], + credentials: [ + { + name: 'mongodb', + required: true, + } + ], + properties: [ + { + displayName: 'Operation', + name: 'operation', + type: 'options', + options: [ + { + name: 'Find', + value: 'find', + description: 'Find documents.', + }, + { + name: 'Insert', + value: 'insert', + description: 'Insert documents.', + }, + { + name: 'Update', + value: 'update', + description: 'Updates documents.', + }, + ], + default: 'find', + description: 'The operation to perform.', + }, + + { + displayName: 'Collection', + name: 'collection', + type: 'string', + required: true, + default: '', + description: 'MongoDB Collection' + }, + + // ---------------------------------- + // find + // ---------------------------------- + { + displayName: 'Query (JSON format)', + name: 'query', + type: 'string', + typeOptions: { + rows: 5, + }, + displayOptions: { + show: { + operation: [ + 'find' + ], + }, + }, + default: '{}', + placeholder: `{ "birth": { "$gt": "1950-01-01" } }`, + required: true, + description: 'MongoDB Find query.', + }, + + + // ---------------------------------- + // insert + // ---------------------------------- + { + displayName: 'Fields', + name: 'fields', + type: 'string', + displayOptions: { + show: { + operation: [ + 'insert' + ], + }, + }, + default: '', + placeholder: 'name,description', + description: 'Comma separated list of the fields to be included into the new document.', + }, + + + // ---------------------------------- + // update + // ---------------------------------- + { + displayName: 'Update Key', + name: 'updateKey', + type: 'string', + displayOptions: { + show: { + operation: [ + 'update' + ], + }, + }, + default: 'id', + required: true, + description: 'Name of the property which decides which rows in the database should be updated. Normally that would be "id".', + }, + { + displayName: 'Fields', + name: 'fields', + type: 'string', + displayOptions: { + show: { + operation: [ + 'update' + ], + }, + }, + default: '', + placeholder: 'name,description', + description: 'Comma separated list of the fields to be included into the new document.', + }, + + ] + }; + + + async execute(this: IExecuteFunctions): Promise { + + const credentials = this.getCredentials('mongodb'); + + if (credentials === undefined) { + throw new Error('No credentials got returned!'); + } + + let connectionUri = '' + + if (credentials.port) { + connectionUri = `mongodb://${credentials.user}:${credentials.password}@${credentials.host}:${credentials.port}` + } else { + connectionUri = `mongodb+srv://${credentials.user}:${credentials.password}@${credentials.host}` + } + + const client = await MongoClient.connect(connectionUri, { useNewUrlParser: true, useUnifiedTopology: true }); + const mdb = client.db(credentials.database as string); + + let returnItems = []; + + const items = this.getInputData(); + const operation = this.getNodeParameter('operation', 0) as string; + + if (operation === 'find') { + // ---------------------------------- + // find + // ---------------------------------- + + const queryResult = await mdb + .collection(this.getNodeParameter('collection', 0) as string) + .find(JSON.parse(this.getNodeParameter('query', 0) as string)) + .toArray(); + + returnItems = this.helpers.returnJsonArray(queryResult as IDataObject[]); + + } else if (operation === 'insert') { + // ---------------------------------- + // insert + // ---------------------------------- + + // Prepare the data to insert and copy it to be returned + const fields = (this.getNodeParameter('fields', 0) as string) + .split(',') + .map(f => f.trim()) + .filter(f => !!f) + + const insertItems = getItemCopy(items, fields); + + const { insertedIds } = await mdb + .collection(this.getNodeParameter('collection', 0) as string) + .insertMany(insertItems) + + // Add the id to the data + for (let i in insertedIds) { + returnItems.push({ + json: { + ...insertItems[i], + id: insertedIds[i] as string, + } + }); + } + } else if (operation === 'update') { + // ---------------------------------- + // update + // ---------------------------------- + + const fields = (this.getNodeParameter('fields', 0) as string) + .split(',') + .map(f => f.trim()) + .filter(f => !!f) + + // Prepare the data to update and copy it to be returned + const updateItems = getItemCopy(items, fields); + const updateKey = this.getNodeParameter('updateKey', 0) as string; + + for (let item of updateItems) { + if (item[updateKey] === undefined) { continue } + + const filter: { [key: string] :string } = {}; + filter[updateKey] = item[updateKey] as string; + + await mdb + .collection(this.getNodeParameter('collection', 0) as string) + .updateOne(filter, item) + } + + returnItems = this.helpers.returnJsonArray(updateItems as IDataObject[]); + + } else { + throw new Error(`The operation "${operation}" is not supported!`); + } + + return this.prepareOutputData(returnItems); + } +} diff --git a/packages/nodes-base/nodes/MongoDB/mongodb.png b/packages/nodes-base/nodes/MongoDB/mongodb.png new file mode 100644 index 0000000000..3d74fee894 Binary files /dev/null and b/packages/nodes-base/nodes/MongoDB/mongodb.png differ diff --git a/packages/nodes-base/package.json b/packages/nodes-base/package.json index 9a91e52bf0..bbe6c12b61 100644 --- a/packages/nodes-base/package.json +++ b/packages/nodes-base/package.json @@ -42,6 +42,7 @@ "dist/credentials/LinkFishApi.credentials.js", "dist/credentials/MailgunApi.credentials.js", "dist/credentials/MattermostApi.credentials.js", + "dist/credentials/MongoDB.credentials.js", "dist/credentials/NextCloudApi.credentials.js", "dist/credentials/OpenWeatherMapApi.credentials.js", "dist/credentials/PipedriveApi.credentials.js", @@ -86,6 +87,7 @@ "dist/nodes/Mailgun/Mailgun.node.js", "dist/nodes/Mattermost/Mattermost.node.js", "dist/nodes/Merge.node.js", + "dist/nodes/MongoDB/MongoDB.node.js", "dist/nodes/NextCloud/NextCloud.node.js", "dist/nodes/NoOp.node.js", "dist/nodes/OpenWeatherMap.node.js", @@ -124,6 +126,7 @@ "@types/imap-simple": "^4.2.0", "@types/jest": "^24.0.18", "@types/lodash.set": "^4.3.6", + "@types/mongodb": "^3.3.6", "@types/node": "^10.10.1", "@types/nodemailer": "^4.6.5", "@types/redis": "^2.8.11", @@ -147,6 +150,7 @@ "lodash.get": "^4.4.2", "lodash.set": "^4.3.2", "lodash.unset": "^4.5.2", + "mongodb": "^3.3.2", "n8n-core": "~0.14.0", "nodemailer": "^5.1.1", "pdf-parse": "^1.1.1",