mirror of
https://github.com/n8n-io/n8n.git
synced 2024-12-27 21:49:41 -08:00
375 lines
8.9 KiB
TypeScript
375 lines
8.9 KiB
TypeScript
import {
|
|
BINARY_ENCODING,
|
|
IExecuteFunctions,
|
|
} from 'n8n-core';
|
|
|
|
import {
|
|
INodeExecutionData,
|
|
INodeType,
|
|
INodeTypeDescription,
|
|
IDataObject,
|
|
} from 'n8n-workflow';
|
|
|
|
import {
|
|
read as xlsxRead,
|
|
utils as xlsxUtils,
|
|
write as xlsxWrite,
|
|
WritingOptions,
|
|
WorkBook,
|
|
} from 'xlsx';
|
|
|
|
|
|
/**
|
|
* Flattens an object with deep data
|
|
*
|
|
* @param {IDataObject} data The object to flatten
|
|
* @returns
|
|
*/
|
|
function flattenObject (data: IDataObject) {
|
|
const returnData: IDataObject = {};
|
|
for (const key1 of Object.keys(data)) {
|
|
if (data[key1] !== null && (typeof data[key1]) === 'object') {
|
|
const flatObject = flattenObject(data[key1] as IDataObject);
|
|
for (const key2 in flatObject) {
|
|
if (flatObject[key2] === undefined) {
|
|
continue;
|
|
}
|
|
returnData[`${key1}.${key2}`] = flatObject[key2];
|
|
}
|
|
} else {
|
|
returnData[key1] = data[key1];
|
|
}
|
|
}
|
|
return returnData;
|
|
}
|
|
|
|
|
|
export class SpreadsheetFile implements INodeType {
|
|
description: INodeTypeDescription = {
|
|
displayName: 'Spreadsheet File',
|
|
name: 'spreadsheetFile',
|
|
icon: 'fa:table',
|
|
group: ['transform'],
|
|
version: 1,
|
|
description: 'Reads and writes data from a spreadsheet file.',
|
|
defaults: {
|
|
name: 'Spreadsheet File',
|
|
color: '#2244FF',
|
|
},
|
|
inputs: ['main'],
|
|
outputs: ['main'],
|
|
properties: [
|
|
{
|
|
displayName: 'Operation',
|
|
name: 'operation',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'Read from file',
|
|
value: 'fromFile',
|
|
description: 'Reads data from a spreadsheet file',
|
|
},
|
|
{
|
|
name: 'Write to file',
|
|
value: 'toFile',
|
|
description: 'Writes the workflow data to a spreadsheet file',
|
|
},
|
|
],
|
|
default: 'fromFile',
|
|
description: 'The operation to perform.',
|
|
},
|
|
|
|
// ----------------------------------
|
|
// fromFile
|
|
// ----------------------------------
|
|
{
|
|
displayName: 'Binary Property',
|
|
name: 'binaryPropertyName',
|
|
type: 'string',
|
|
default: 'data',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
operation: [
|
|
'fromFile',
|
|
],
|
|
},
|
|
|
|
},
|
|
placeholder: '',
|
|
description: 'Name of the binary property from which to read<br />the binary data of the spreadsheet file.',
|
|
},
|
|
|
|
// ----------------------------------
|
|
// toFile
|
|
// ----------------------------------
|
|
{
|
|
displayName: 'File Format',
|
|
name: 'fileFormat',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'CSV',
|
|
value: 'csv',
|
|
description: 'Comma-separated values',
|
|
},
|
|
{
|
|
name: 'HTML',
|
|
value: 'html',
|
|
description: 'HTML Table',
|
|
},
|
|
{
|
|
name: 'ODS',
|
|
value: 'ods',
|
|
description: 'OpenDocument Spreadsheet',
|
|
},
|
|
{
|
|
name: 'RTF',
|
|
value: 'rtf',
|
|
description: 'Rich Text Format',
|
|
},
|
|
{
|
|
name: 'XLS',
|
|
value: 'xls',
|
|
description: 'Excel',
|
|
},
|
|
],
|
|
default: 'xls',
|
|
displayOptions: {
|
|
show: {
|
|
operation: [
|
|
'toFile'
|
|
],
|
|
},
|
|
},
|
|
description: 'The format of the file to save the data as.',
|
|
},
|
|
{
|
|
displayName: 'Binary Property',
|
|
name: 'binaryPropertyName',
|
|
type: 'string',
|
|
default: 'data',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
operation: [
|
|
'toFile',
|
|
],
|
|
},
|
|
},
|
|
placeholder: '',
|
|
description: 'Name of the binary property in which to save<br />the binary data of the spreadsheet file.',
|
|
},
|
|
|
|
{
|
|
displayName: 'Options',
|
|
name: 'options',
|
|
type: 'collection',
|
|
placeholder: 'Add Option',
|
|
default: {},
|
|
options: [
|
|
{
|
|
displayName: 'File Name',
|
|
name: 'fileName',
|
|
type: 'string',
|
|
displayOptions: {
|
|
show: {
|
|
'/operation': [
|
|
'toFile',
|
|
],
|
|
},
|
|
},
|
|
default: '',
|
|
description: 'File name to set in binary data. By default will "spreadsheet.<fileFormat>" be used.',
|
|
},
|
|
{
|
|
displayName: 'RAW Data',
|
|
name: 'rawData',
|
|
type: 'boolean',
|
|
displayOptions: {
|
|
show: {
|
|
'/operation': [
|
|
'fromFile'
|
|
],
|
|
},
|
|
},
|
|
default: false,
|
|
description: 'If the data should be returned RAW instead of parsed.',
|
|
},
|
|
{
|
|
displayName: 'Read As String',
|
|
name: 'readAsString',
|
|
type: 'boolean',
|
|
displayOptions: {
|
|
show: {
|
|
'/operation': [
|
|
'fromFile'
|
|
],
|
|
},
|
|
},
|
|
default: false,
|
|
description: 'In some cases and file formats, it is necessary to read<br />specifically as string else some special character get interpreted wrong.',
|
|
},
|
|
{
|
|
displayName: 'Sheet Name',
|
|
name: 'sheetName',
|
|
type: 'string',
|
|
displayOptions: {
|
|
show: {
|
|
'/operation': [
|
|
'fromFile',
|
|
],
|
|
},
|
|
},
|
|
default: 'Sheet',
|
|
description: 'Name of the sheet to read from in the spreadsheet (if supported). If not set, the first one gets chosen.',
|
|
},
|
|
{
|
|
displayName: 'Sheet Name',
|
|
name: 'sheetName',
|
|
type: 'string',
|
|
displayOptions: {
|
|
show: {
|
|
'/operation': [
|
|
'toFile',
|
|
],
|
|
'/fileFormat': [
|
|
'ods',
|
|
'xls',
|
|
],
|
|
},
|
|
},
|
|
default: 'Sheet',
|
|
description: 'Name of the sheet to create in the spreadsheet.',
|
|
},
|
|
],
|
|
},
|
|
]
|
|
};
|
|
|
|
|
|
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
|
|
|
|
const items = this.getInputData();
|
|
|
|
const operation = this.getNodeParameter('operation', 0) as string;
|
|
|
|
const newItems: INodeExecutionData[] = [];
|
|
|
|
if (operation === 'fromFile') {
|
|
// Read data from spreadsheet file to workflow
|
|
|
|
let item: INodeExecutionData;
|
|
for (let i = 0; i < items.length; i++) {
|
|
item = items[i];
|
|
|
|
const binaryPropertyName = this.getNodeParameter('binaryPropertyName', i) as string;
|
|
const options = this.getNodeParameter('options', i, {}) as IDataObject;
|
|
|
|
if (item.binary === undefined || item.binary[binaryPropertyName] === undefined) {
|
|
// Property did not get found on item
|
|
continue;
|
|
}
|
|
|
|
// Read the binary spreadsheet data
|
|
const binaryData = Buffer.from(item.binary[binaryPropertyName].data, BINARY_ENCODING);
|
|
let workbook;
|
|
if (options.readAsString === true) {
|
|
workbook = xlsxRead(binaryData.toString(), { type: 'string', raw: options.rawData as boolean });
|
|
} else {
|
|
workbook = xlsxRead(binaryData, { raw: options.rawData as boolean });
|
|
}
|
|
|
|
if (workbook.SheetNames.length === 0) {
|
|
throw new Error('Spreadsheet does not have any sheets!');
|
|
}
|
|
|
|
let sheetName = workbook.SheetNames[0];
|
|
if (options.sheetName) {
|
|
if (!workbook.SheetNames.includes(options.sheetName as string)) {
|
|
throw new Error(`Spreadsheet does not contain sheet called "${options.sheetName}"!`);
|
|
}
|
|
sheetName = options.sheetName as string;
|
|
}
|
|
|
|
// Convert it to json
|
|
const sheetJson = xlsxUtils.sheet_to_json(workbook.Sheets[sheetName]);
|
|
|
|
// Check if data could be found in file
|
|
if (sheetJson.length === 0) {
|
|
continue;
|
|
}
|
|
|
|
// Add all the found data columns to the workflow data
|
|
for (const rowData of sheetJson) {
|
|
newItems.push({ json: rowData } as INodeExecutionData);
|
|
}
|
|
}
|
|
|
|
return this.prepareOutputData(newItems);
|
|
} else if (operation === 'toFile') {
|
|
// Write the workflow data to spreadsheet file
|
|
const binaryPropertyName = this.getNodeParameter('binaryPropertyName', 0) as string;
|
|
const fileFormat = this.getNodeParameter('fileFormat', 0) as string;
|
|
const options = this.getNodeParameter('options', 0, {}) as IDataObject;
|
|
|
|
// Get the json data of the items and flatten it
|
|
let item: INodeExecutionData;
|
|
const itemData: IDataObject[] = [];
|
|
for (let itemIndex = 0; itemIndex < items.length; itemIndex++) {
|
|
item = items[itemIndex];
|
|
itemData.push(flattenObject(item.json));
|
|
}
|
|
|
|
const ws = xlsxUtils.json_to_sheet(itemData);
|
|
|
|
const wopts: WritingOptions = {
|
|
bookSST: false,
|
|
type: 'buffer'
|
|
};
|
|
|
|
if (fileFormat === 'csv') {
|
|
wopts.bookType = 'csv';
|
|
} else if (fileFormat === 'html') {
|
|
wopts.bookType = 'html';
|
|
} else if (fileFormat === 'rtf') {
|
|
wopts.bookType = 'rtf';
|
|
} else if (fileFormat === 'ods') {
|
|
wopts.bookType = 'ods';
|
|
} else if (fileFormat === 'xls') {
|
|
wopts.bookType = 'xlml';
|
|
}
|
|
|
|
// Convert the data in the correct format
|
|
const sheetName = options.sheetName as string || 'Sheet';
|
|
const wb: WorkBook = {
|
|
SheetNames: [sheetName],
|
|
Sheets: {
|
|
[sheetName]: ws,
|
|
}
|
|
};
|
|
const wbout = xlsxWrite(wb, wopts);
|
|
|
|
// Create a new item with only the binary spreadsheet data
|
|
const newItem: INodeExecutionData = {
|
|
json: {},
|
|
binary: {},
|
|
};
|
|
|
|
let fileName = `spreadsheet.${fileFormat}`;
|
|
if (options.fileName !== undefined) {
|
|
fileName = options.fileName as string;
|
|
}
|
|
|
|
newItem.binary![binaryPropertyName] = await this.helpers.prepareBinaryData(wbout, fileName);
|
|
|
|
const newItems = [];
|
|
newItems.push(newItem);
|
|
|
|
return this.prepareOutputData(newItems);
|
|
} else {
|
|
throw new Error(`The operation "${operation}" is not supported!`);
|
|
}
|
|
}
|
|
}
|