n8n/packages/nodes-base/nodes/Microsoft/OneDrive/MicrosoftOneDrive.node.ts

234 lines
8.9 KiB
TypeScript
Raw Normal View History

2020-03-22 12:43:35 -07:00
import {
BINARY_ENCODING,
2020-03-29 15:43:26 -07:00
IExecuteFunctions,
2020-03-22 12:43:35 -07:00
} from 'n8n-core';
import {
2020-03-29 15:43:26 -07:00
IBinaryKeyData,
2020-03-22 12:43:35 -07:00
IDataObject,
INodeExecutionData,
INodeType,
2020-03-29 15:43:26 -07:00
INodeTypeDescription,
2020-03-22 12:43:35 -07:00
} from 'n8n-workflow';
import {
microsoftApiRequest,
microsoftApiRequestAllItems,
} from './GenericFunctions';
import {
fileFields,
2020-03-29 15:43:26 -07:00
fileOperations,
2020-03-22 12:43:35 -07:00
} from './FileDescription';
import {
2020-03-29 15:43:26 -07:00
folderFields,
2020-03-22 12:43:35 -07:00
folderOperations,
2020-03-29 15:43:26 -07:00
} from './FolderDescription';
2020-03-22 12:43:35 -07:00
export class MicrosoftOneDrive implements INodeType {
description: INodeTypeDescription = {
displayName: 'Microsoft OneDrive',
name: 'microsoftOneDrive',
icon: 'file:oneDrive.png',
group: ['input'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consume Microsoft OneDrive API.',
defaults: {
name: 'Microsoft OneDrive',
color: '#1d4bab',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'microsoftOneDriveOAuth2Api',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'File',
value: 'file',
},
{
name: 'Folder',
value: 'folder',
},
],
default: 'file',
description: 'The resource to operate on.',
},
...fileOperations,
...fileFields,
...folderOperations,
...folderFields,
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
const length = items.length as unknown as number;
const qs: IDataObject = {};
let responseData;
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 === 'file') {
//https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_copy?view=odsp-graph-online
if (operation === 'copy') {
const fileId = this.getNodeParameter('fileId', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const parentReference = this.getNodeParameter('parentReference', i) as IDataObject;
const body: IDataObject = {};
if (parentReference) {
body.parentReference = { ...parentReference };
}
if (additionalFields.name) {
body.name = additionalFields.name as string;
}
responseData = await microsoftApiRequest.call(this, 'POST', `/drive/items/${fileId}/copy`, body, {}, undefined, {}, { json: true, resolveWithFullResponse: true });
responseData = { location : responseData.headers.location };
2020-03-28 17:13:56 -07:00
returnData.push(responseData as IDataObject);
2020-03-22 12:43:35 -07:00
}
//https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_delete?view=odsp-graph-online
if (operation === 'delete') {
const fileId = this.getNodeParameter('fileId', i) as string;
responseData = await microsoftApiRequest.call(this, 'DELETE', `/drive/items/${fileId}`);
responseData = { success: true };
2020-03-28 17:13:56 -07:00
returnData.push(responseData as IDataObject);
2020-03-22 12:43:35 -07:00
}
//https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_list_children?view=odsp-graph-online
if (operation === 'download') {
const fileId = this.getNodeParameter('fileId', i) as string;
const dataPropertyNameDownload = this.getNodeParameter('binaryPropertyName', i) as string;
responseData = await microsoftApiRequest.call(this, 'GET', `/drive/items/${fileId}`);
2020-03-29 15:43:26 -07:00
const fileName = responseData.name;
2020-03-22 12:43:35 -07:00
if (responseData.file === undefined) {
throw new Error('The ID you provided does not belong to a file.');
}
2020-03-29 15:43:26 -07:00
let mimeType: string | undefined;
if (responseData.file.mimeType) {
mimeType = responseData.file.mimeType;
}
2020-03-22 12:43:35 -07:00
responseData = await microsoftApiRequest.call(this, 'GET', `/drive/items/${fileId}/content`, {}, {}, undefined, {}, { encoding: null, resolveWithFullResponse: true });
const newItem: INodeExecutionData = {
json: items[i].json,
binary: {},
};
2020-03-29 15:43:26 -07:00
if (mimeType === undefined && responseData.headers['content-type']) {
2020-03-22 12:43:35 -07:00
mimeType = responseData.headers['content-type'];
}
if (items[i].binary !== undefined) {
// Create a shallow copy of the binary data so that the old
// data references which do not get changed still stay behind
// but the incoming data does not get changed.
Object.assign(newItem.binary, items[i].binary);
}
items[i] = newItem;
const data = Buffer.from(responseData.body);
2020-03-29 15:43:26 -07:00
items[i].binary![dataPropertyNameDownload] = await this.helpers.prepareBinaryData(data as unknown as Buffer, fileName, mimeType);
2020-03-22 12:43:35 -07:00
}
//https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_get?view=odsp-graph-online
if (operation === 'get') {
const fileId = this.getNodeParameter('fileId', i) as string;
responseData = await microsoftApiRequest.call(this, 'GET', `/drive/items/${fileId}`);
2020-03-28 17:13:56 -07:00
returnData.push(responseData as IDataObject);
2020-03-22 12:43:35 -07:00
}
//https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_search?view=odsp-graph-online
if (operation === 'search') {
const query = this.getNodeParameter('query', i) as string;
2020-03-29 15:43:26 -07:00
responseData = await microsoftApiRequestAllItems.call(this, 'value', 'GET', `/drive/root/search(q='${query}')`);
2020-03-22 12:43:35 -07:00
responseData = responseData.filter((item: IDataObject) => item.file);
2020-03-29 15:43:26 -07:00
returnData.push.apply(returnData, responseData as IDataObject[]);
2020-03-22 12:43:35 -07:00
}
//https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_put_content?view=odsp-graph-online#example-upload-a-new-file
if (operation === 'upload') {
const parentId = this.getNodeParameter('parentId', i) as string;
2020-03-29 15:43:26 -07:00
const isBinaryData = this.getNodeParameter('binaryData', i) as boolean;
const fileName = this.getNodeParameter('fileName', i) as string;
2020-03-22 12:43:35 -07:00
2020-03-29 15:43:26 -07:00
if (isBinaryData) {
2020-03-22 12:43:35 -07:00
const binaryPropertyName = this.getNodeParameter('binaryPropertyName', 0) as string;
if (items[i].binary === undefined) {
throw new Error('No binary data exists on item!');
}
//@ts-ignore
if (items[i].binary[binaryPropertyName] === undefined) {
throw new Error(`No binary data property "${binaryPropertyName}" does not exists on item!`);
}
const binaryData = (items[i].binary as IBinaryKeyData)[binaryPropertyName];
const body = Buffer.from(binaryData.data, BINARY_ENCODING);
2020-03-29 15:43:26 -07:00
responseData = await microsoftApiRequest.call(this, 'PUT', `/drive/items/${parentId}:/${fileName || binaryData.fileName}:/content`, body, {}, undefined, { 'Content-Type': binaryData.mimeType, 'Content-length': body.length }, {} );
2020-03-22 12:43:35 -07:00
2020-03-29 15:43:26 -07:00
returnData.push(JSON.parse(responseData) as IDataObject);
2020-03-22 12:43:35 -07:00
} else {
2020-03-29 15:43:26 -07:00
const body = this.getNodeParameter('fileContent', i) as string;
2020-03-22 12:43:35 -07:00
if (fileName === '') {
2020-03-29 15:43:26 -07:00
throw new Error('File name must be set!');
2020-03-22 12:43:35 -07:00
}
2020-03-29 15:43:26 -07:00
responseData = await microsoftApiRequest.call(this, 'PUT', `/drive/items/${parentId}:/${fileName}:/content`, body , {}, undefined, { 'Content-Type': 'text/plain' } );
2020-03-28 17:13:56 -07:00
returnData.push(responseData as IDataObject);
2020-03-22 12:43:35 -07:00
}
}
}
if (resource === 'folder') {
2020-03-29 19:39:43 -07:00
//https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_post_children?view=odsp-graph-online
if (operation === 'create') {
const name = this.getNodeParameter('name', i) as string;
2020-04-03 08:19:35 -07:00
const options = this.getNodeParameter('options', i) as IDataObject;
2020-03-29 19:39:43 -07:00
const body: IDataObject = {
name,
folder: {},
};
2020-04-03 08:19:35 -07:00
let endpoint = '/drive/root/children';
if (options.parentFolderId) {
endpoint = `/drive/items/${options.parentFolderId}/children`;
}
responseData = await microsoftApiRequest.call(this, 'POST', endpoint, body);
2020-03-29 19:39:43 -07:00
returnData.push(responseData);
}
2020-03-22 12:43:35 -07:00
//https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_list_children?view=odsp-graph-online
if (operation === 'getChildren') {
const folderId = this.getNodeParameter('folderId', i) as string;
responseData = await microsoftApiRequestAllItems.call(this, 'value', 'GET', `/drive/items/${folderId}/children`);
2020-03-29 15:43:26 -07:00
returnData.push.apply(returnData, responseData as IDataObject[]);
2020-03-22 12:43:35 -07:00
}
//https://docs.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_search?view=odsp-graph-online
if (operation === 'search') {
const query = this.getNodeParameter('query', i) as string;
2020-03-29 15:43:26 -07:00
responseData = await microsoftApiRequestAllItems.call(this, 'value', 'GET', `/drive/root/search(q='${query}')`);
2020-03-22 12:43:35 -07:00
responseData = responseData.filter((item: IDataObject) => item.folder);
2020-03-29 15:43:26 -07:00
returnData.push.apply(returnData, responseData as IDataObject[]);
2020-03-22 12:43:35 -07:00
}
}
}
if (resource === 'file' && operation === 'download') {
// For file downloads the files get attached to the existing items
return this.prepareOutputData(items);
} else {
return [this.helpers.returnJsonArray(returnData)];
}
}
}