n8n/packages/nodes-base/nodes/Matrix/Matrix.node.ts
Jan 4573d503dc
Add matrix integration (#1046)
* Added Matrix integration node

* fix: Improve code quality and add new operation

- Changed operation names to match casing (all camelCase)
- Ordering operation names to be alphabetical
- Creating a read all operation to fetch all messages from a room
- Added node subtitle

* fix: add element index so that expressions work on multiple items

* feature: added possibility to upload and send media to Matrix

- Also replacing Promises.all() + Array.map() For a regular for as it messes up ordering

* refactor: merging upload + send Media in a single action

* refactor: improved code quality and endpoints

- Removed sync entirely as a better way to retrieve messages is now
implemeented
- Added rooms dropdown to operations
- Added option to paginate or retrieve all room messages
- Removed option to upload media from text contents. Only files are
accepted now
- Room members has bem moved from the Rooms resource to a standalone
with Get All operation

*  Small improvements

*  Added filters to get messages

*  Minor improvements to Matrix-Integration

Co-authored-by: Omar Ajoue <krynble@gmail.com>
Co-authored-by: ricardo <ricardoespinoza105@gmail.com>
2020-10-12 10:05:16 +02:00

173 lines
3.5 KiB
TypeScript

import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
ILoadOptionsFunctions,
INodeExecutionData,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
import {
handleMatrixCall,
matrixApiRequest,
} from './GenericFunctions';
import {
accountOperations
} from './AccountDescription';
import {
eventFields,
eventOperations,
} from './EventDescription';
import {
mediaFields,
mediaOperations,
} from './MediaDescription';
import {
messageFields,
messageOperations,
} from './MessageDescription';
import {
roomFields,
roomOperations,
} from './RoomDescription';
import {
roomMemberFields,
roomMemberOperations,
} from './RoomMemberDescription';
export class Matrix implements INodeType {
description: INodeTypeDescription = {
displayName: 'Matrix',
name: 'matrix',
icon: 'file:matrix.png',
group: ['output'],
version: 1,
description: 'Consume Matrix API',
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
defaults: {
name: 'Matrix',
color: '#772244',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'matrixApi',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'Account',
value: 'account',
},
{
name: 'Event',
value: 'event',
},
{
name: 'Media',
value: 'media',
},
{
name: 'Message',
value: 'message',
},
{
name: 'Room',
value: 'room',
},
{
name: 'Room Member',
value: 'roomMember',
},
],
default: 'message',
description: 'The resource to operate on.',
},
...accountOperations,
...eventOperations,
...eventFields,
...mediaOperations,
...mediaFields,
...messageOperations,
...messageFields,
...roomOperations,
...roomFields,
...roomMemberOperations,
...roomMemberFields,
]
};
methods = {
loadOptions: {
async getChannels(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const joinedRoomsResponse = await matrixApiRequest.call(this, 'GET', '/joined_rooms');
await Promise.all(joinedRoomsResponse.joined_rooms.map(async (roomId: string) => {
try {
const roomNameResponse = await matrixApiRequest.call(this, 'GET', `/rooms/${roomId}/state/m.room.name`);
returnData.push({
name: roomNameResponse.name,
value: roomId,
});
} catch (e) {
// TODO: Check, there is probably another way to get the name of this private-chats
returnData.push({
name: `Unknown: ${roomId}`,
value: roomId,
});
}
}));
returnData.sort((a, b) => {
if (a.name < b.name) { return -1; }
if (a.name > b.name) { return 1; }
return 0;
});
return returnData;
},
}
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData() as IDataObject[];
const returnData: IDataObject[] = [];
const resource = this.getNodeParameter('resource', 0) as string;
const operation = this.getNodeParameter('operation', 0) as string;
for (let i = 0; i < items.length; i++) {
const responseData = await handleMatrixCall.call(this, items[i], i, resource, operation);
if (Array.isArray(responseData)) {
returnData.push.apply(returnData, responseData as IDataObject[]);
} else {
returnData.push(responseData as IDataObject);
}
}
return [this.helpers.returnJsonArray(returnData)];
}
}