feat(Google Sheets Node): Overhaul of node

packages/nodes-base/nodes/Google/Sheet/v1/GenericFunctions.ts

@@ -0,0 +1,177 @@
+import { OptionsWithUri } from 'request';
+
+import { IExecuteFunctions, IExecuteSingleFunctions, ILoadOptionsFunctions } from 'n8n-core';
+
+import { ICredentialTestFunctions, IDataObject, NodeApiError } from 'n8n-workflow';
+
+import moment from 'moment-timezone';
+
+import jwt from 'jsonwebtoken';
+
+export interface IGoogleAuthCredentials {
+	delegatedEmail?: string;
+	email: string;
+	inpersonate: boolean;
+	privateKey: string;
+}
+
+export async function googleApiRequest(
+	this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions,
+	method: string,
+	resource: string,
+	// tslint:disable-next-line:no-any
+	body: any = {},
+	qs: IDataObject = {},
+	uri?: string,
+	headers: IDataObject = {},
+	// tslint:disable-next-line:no-any
+): Promise<any> {
+	const authenticationMethod = this.getNodeParameter(
+		'authentication',
+		0,
+		'serviceAccount',
+	) as string;
+	const options: OptionsWithUri = {
+		headers: {
+			'Content-Type': 'application/json',
+		},
+		method,
+		body,
+		qs,
+		uri: uri || `https://sheets.googleapis.com${resource}`,
+		json: true,
+	};
+	try {
+		if (Object.keys(headers).length !== 0) {
+			options.headers = Object.assign({}, options.headers, headers);
+		}
+		if (Object.keys(body).length === 0) {
+			delete options.body;
+		}
+
+		if (authenticationMethod === 'serviceAccount') {
+			const credentials = await this.getCredentials('googleApi');
+
+			const { access_token } = await getAccessToken.call(
+				this,
+				credentials as unknown as IGoogleAuthCredentials,
+			);
+
+			options.headers!.Authorization = `Bearer ${access_token}`;
+			//@ts-ignore
+			return await this.helpers.request(options);
+		} else {
+			//@ts-ignore
+			return await this.helpers.requestOAuth2.call(this, 'googleSheetsOAuth2Api', options);
+		}
+	} catch (error) {
+		if (error.code === 'ERR_OSSL_PEM_NO_START_LINE') {
+			error.statusCode = '401';
+		}
+
+		throw new NodeApiError(this.getNode(), error);
+	}
+}
+
+export async function googleApiRequestAllItems(
+	this: IExecuteFunctions | ILoadOptionsFunctions,
+	propertyName: string,
+	method: string,
+	endpoint: string,
+	// tslint:disable-next-line:no-any
+	body: any = {},
+	query: IDataObject = {},
+	// tslint:disable-next-line:no-any
+): Promise<any> {
+	const returnData: IDataObject[] = [];
+
+	let responseData;
+	query.maxResults = 100;
+
+	do {
+		responseData = await googleApiRequest.call(this, method, endpoint, body, query);
+		query.pageToken = responseData['nextPageToken'];
+		returnData.push.apply(returnData, responseData[propertyName]);
+	} while (responseData['nextPageToken'] !== undefined && responseData['nextPageToken'] !== '');
+
+	return returnData;
+}
+
+export function getAccessToken(
+	this:
+		| IExecuteFunctions
+		| IExecuteSingleFunctions
+		| ILoadOptionsFunctions
+		| ICredentialTestFunctions,
+	credentials: IGoogleAuthCredentials,
+): Promise<IDataObject> {
+	//https://developers.google.com/identity/protocols/oauth2/service-account#httprest
+
+	const scopes = [
+		'https://www.googleapis.com/auth/drive',
+		'https://www.googleapis.com/auth/drive.file',
+		'https://www.googleapis.com/auth/spreadsheets',
+	];
+
+	const now = moment().unix();
+
+	credentials.email = credentials.email.trim();
+	const privateKey = (credentials.privateKey as string).replace(/\\n/g, '\n').trim();
+
+	const signature = jwt.sign(
+		{
+			iss: credentials.email as string,
+			sub: credentials.delegatedEmail || (credentials.email as string),
+			scope: scopes.join(' '),
+			aud: `https://oauth2.googleapis.com/token`,
+			iat: now,
+			exp: now + 3600,
+		},
+		privateKey,
+		{
+			algorithm: 'RS256',
+			header: {
+				kid: privateKey,
+				typ: 'JWT',
+				alg: 'RS256',
+			},
+		},
+	);
+
+	const options: OptionsWithUri = {
+		headers: {
+			'Content-Type': 'application/x-www-form-urlencoded',
+		},
+		method: 'POST',
+		form: {
+			grant_type: 'urn:ietf:params:oauth:grant-type:jwt-bearer',
+			assertion: signature,
+		},
+		uri: 'https://oauth2.googleapis.com/token',
+		json: true,
+	};
+
+	//@ts-ignore
+	return this.helpers.request(options);
+}
+
+// Hex to RGB
+export function hexToRgb(hex: string) {
+	// Expand shorthand form (e.g. "03F") to full form (e.g. "0033FF")
+	const shorthandRegex = /^#?([a-f\d])([a-f\d])([a-f\d])$/i;
+	hex = hex.replace(shorthandRegex, (m, r, g, b) => {
+		return r + r + g + g + b + b;
+	});
+
+	const result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex);
+
+	if (result) {
+		return {
+			red: parseInt(result[1], 16),
+			green: parseInt(result[2], 16),
+			blue: parseInt(result[3], 16),
+		};
+	}
+
+	return null;
+}

packages/nodes-base/nodes/Google/Sheet/v1/GoogleSheet.ts

@@ -0,0 +1,603 @@
+import { IDataObject, NodeOperationError } from 'n8n-workflow';
+
+import { IExecuteFunctions, ILoadOptionsFunctions } from 'n8n-core';
+
+import { googleApiRequest } from './GenericFunctions';
+
+import { utils as xlsxUtils } from 'xlsx';
+
+import { get } from 'lodash';
+
+export interface ISheetOptions {
+	scope: string[];
+}
+
+export interface IGoogleAuthCredentials {
+	email: string;
+	privateKey: string;
+}
+
+export interface ISheetUpdateData {
+	range: string;
+	values: string[][];
+}
+
+export interface ILookupValues {
+	lookupColumn: string;
+	lookupValue: string;
+}
+
+export interface IToDeleteRange {
+	amount: number;
+	startIndex: number;
+	sheetId: number;
+}
+
+export interface IToDelete {
+	[key: string]: IToDeleteRange[] | undefined;
+	columns?: IToDeleteRange[];
+	rows?: IToDeleteRange[];
+}
+
+export type ValueInputOption = 'RAW' | 'USER_ENTERED';
+
+export type ValueRenderOption = 'FORMATTED_VALUE' | 'FORMULA' | 'UNFORMATTED_VALUE';
+
+export class GoogleSheet {
+	id: string;
+	executeFunctions: IExecuteFunctions | ILoadOptionsFunctions;
+
+	constructor(
+		spreadsheetId: string,
+		executeFunctions: IExecuteFunctions | ILoadOptionsFunctions,
+		options?: ISheetOptions | undefined,
+	) {
+		// options = <SheetOptions>options || {};
+		if (!options) {
+			options = {} as ISheetOptions;
+		}
+
+		this.executeFunctions = executeFunctions;
+		this.id = spreadsheetId;
+	}
+
+	/**
+	 * Encodes the range that also none latin character work
+	 *
+	 */
+	encodeRange(range: string): string {
+		if (range.includes('!')) {
+			const [sheet, ranges] = range.split('!');
+			range = `${encodeURIComponent(sheet)}!${ranges}`;
+		}
+		return range;
+	}
+
+	/**
+	 * Clears values from a sheet
+	 *
+	 */
+	async clearData(range: string): Promise<object> {
+		const body = {
+			spreadsheetId: this.id,
+			range,
+		};
+
+		const response = await googleApiRequest.call(
+			this.executeFunctions,
+			'POST',
+			`/v4/spreadsheets/${this.id}/values/${range}:clear`,
+			body,
+		);
+
+		return response;
+	}
+
+	/**
+	 * Returns the cell values
+	 */
+	async getData(
+		range: string,
+		valueRenderMode: ValueRenderOption,
+	): Promise<string[][] | undefined> {
+		const query = {
+			valueRenderOption: valueRenderMode,
+		};
+
+		const response = await googleApiRequest.call(
+			this.executeFunctions,
+			'GET',
+			`/v4/spreadsheets/${this.id}/values/${range}`,
+			{},
+			query,
+		);
+
+		return response.values as string[][] | undefined;
+	}
+
+	/**
+	 * Returns the sheets in a Spreadsheet
+	 */
+	async spreadsheetGetSheets() {
+		const query = {
+			fields: 'sheets.properties',
+		};
+
+		const response = await googleApiRequest.call(
+			this.executeFunctions,
+			'GET',
+			`/v4/spreadsheets/${this.id}`,
+			{},
+			query,
+		);
+
+		return response;
+	}
+
+	/**
+	 * Sets values in one or more ranges of a spreadsheet.
+	 */
+	async spreadsheetBatchUpdate(requests: IDataObject[]) {
+		// tslint:disable-line:no-any
+
+		const body = {
+			requests,
+		};
+
+		const response = await googleApiRequest.call(
+			this.executeFunctions,
+			'POST',
+			`/v4/spreadsheets/${this.id}:batchUpdate`,
+			body,
+		);
+
+		return response;
+	}
+
+	/**
+	 * Sets the cell values
+	 */
+	async batchUpdate(updateData: ISheetUpdateData[], valueInputMode: ValueInputOption) {
+		const body = {
+			data: updateData,
+			valueInputOption: valueInputMode,
+		};
+
+		const response = await googleApiRequest.call(
+			this.executeFunctions,
+			'POST',
+			`/v4/spreadsheets/${this.id}/values:batchUpdate`,
+			body,
+		);
+
+		return response;
+	}
+
+	/**
+	 * Sets the cell values
+	 */
+	async setData(range: string, data: string[][], valueInputMode: ValueInputOption) {
+		const body = {
+			valueInputOption: valueInputMode,
+			values: data,
+		};
+
+		const response = await googleApiRequest.call(
+			this.executeFunctions,
+			'POST',
+			`/v4/spreadsheets/${this.id}/values/${range}`,
+			body,
+		);
+
+		return response;
+	}
+
+	/**
+	 * Appends the cell values
+	 */
+	async appendData(range: string, data: string[][], valueInputMode: ValueInputOption) {
+		const body = {
+			range: decodeURIComponent(range),
+			values: data,
+		};
+
+		const query = {
+			valueInputOption: valueInputMode,
+		};
+
+		const response = await googleApiRequest.call(
+			this.executeFunctions,
+			'POST',
+			`/v4/spreadsheets/${this.id}/values/${range}:append`,
+			body,
+			query,
+		);
+
+		return response;
+	}
+
+	/**
+	 * Returns the given sheet data in a structured way
+	 */
+	structureData(
+		inputData: string[][],
+		startRow: number,
+		keys: string[],
+		addEmpty?: boolean,
+	): IDataObject[] {
+		const returnData = [];
+
+		let tempEntry: IDataObject, rowIndex: number, columnIndex: number, key: string;
+
+		for (rowIndex = startRow; rowIndex < inputData.length; rowIndex++) {
+			tempEntry = {};
+			for (columnIndex = 0; columnIndex < inputData[rowIndex].length; columnIndex++) {
+				key = keys[columnIndex];
+				if (key) {
+					// Only add the data for which a key was given and ignore all others
+					tempEntry[key] = inputData[rowIndex][columnIndex];
+				}
+			}
+			if (Object.keys(tempEntry).length || addEmpty === true) {
+				// Only add the entry if data got found to not have empty ones
+				returnData.push(tempEntry);
+			}
+		}
+
+		return returnData;
+	}
+
+	/**
+	 * Returns the given sheet data in a structured way using
+	 * the startRow as the one with the name of the key
+	 */
+	structureArrayDataByColumn(
+		inputData: string[][],
+		keyRow: number,
+		dataStartRow: number,
+	): IDataObject[] {
+		const keys: string[] = [];
+
+		if (keyRow < 0 || dataStartRow < keyRow || keyRow >= inputData.length) {
+			// The key row does not exist so it is not possible to structure data
+			return [];
+		}
+
+		// Create the keys array
+		for (let columnIndex = 0; columnIndex < inputData[keyRow].length; columnIndex++) {
+			keys.push(inputData[keyRow][columnIndex]);
+		}
+
+		return this.structureData(inputData, dataStartRow, keys);
+	}
+
+	async appendSheetData(
+		inputData: IDataObject[],
+		range: string,
+		keyRowIndex: number,
+		valueInputMode: ValueInputOption,
+		usePathForKeyRow: boolean,
+	): Promise<string[][]> {
+		const data = await this.convertStructuredDataToArray(
+			inputData,
+			range,
+			keyRowIndex,
+			usePathForKeyRow,
+		);
+		return this.appendData(range, data, valueInputMode);
+	}
+
+	getColumnWithOffset(startColumn: string, offset: number): string {
+		const columnIndex = xlsxUtils.decode_col(startColumn) + offset;
+		return xlsxUtils.encode_col(columnIndex);
+	}
+
+	/**
+	 * Updates data in a sheet
+	 *
+	 * @param {IDataObject[]} inputData Data to update Sheet with
+	 * @param {string} indexKey The name of the key which gets used to know which rows to update
+	 * @param {string} range The range to look for data
+	 * @param {number} keyRowIndex Index of the row which contains the keys
+	 * @param {number} dataStartRowIndex Index of the first row which contains data
+	 */
+	async updateSheetData(
+		inputData: IDataObject[],
+		indexKey: string,
+		range: string,
+		keyRowIndex: number,
+		dataStartRowIndex: number,
+		valueInputMode: ValueInputOption,
+		valueRenderMode: ValueRenderOption,
+		upsert = false,
+	): Promise<string[][]> {
+		// Get current data in Google Sheet
+		let rangeStart: string, rangeEnd: string, rangeFull: string;
+		let sheet: string | undefined = undefined;
+		if (range.includes('!')) {
+			[sheet, rangeFull] = range.split('!');
+		} else {
+			rangeFull = range;
+		}
+		[rangeStart, rangeEnd] = rangeFull.split(':');
+
+		const rangeStartSplit = rangeStart.match(/([a-zA-Z]{1,10})([0-9]{0,10})/);
+		const rangeEndSplit = rangeEnd.match(/([a-zA-Z]{1,10})([0-9]{0,10})/);
+
+		if (
+			rangeStartSplit === null ||
+			rangeStartSplit.length !== 3 ||
+			rangeEndSplit === null ||
+			rangeEndSplit.length !== 3
+		) {
+			throw new NodeOperationError(
+				this.executeFunctions.getNode(),
+				`The range "${range}" is not valid.`,
+			);
+		}
+
+		const keyRowRange = `${sheet ? sheet + '!' : ''}${rangeStartSplit[1]}${keyRowIndex + 1}:${
+			rangeEndSplit[1]
+		}${keyRowIndex + 1}`;
+
+		const sheetDatakeyRow = await this.getData(this.encodeRange(keyRowRange), valueRenderMode);
+
+		if (sheetDatakeyRow === undefined) {
+			throw new NodeOperationError(
+				this.executeFunctions.getNode(),
+				'Could not retrieve the key row!',
+			);
+		}
+
+		const keyColumnOrder = sheetDatakeyRow[0];
+
+		const keyIndex = keyColumnOrder.indexOf(indexKey);
+
+		if (keyIndex === -1) {
+			throw new NodeOperationError(
+				this.executeFunctions.getNode(),
+				`Could not find column for key "${indexKey}"!`,
+			);
+		}
+
+		const startRowIndex = rangeStartSplit[2] || dataStartRowIndex;
+		const endRowIndex = rangeEndSplit[2] || '';
+
+		const keyColumn = this.getColumnWithOffset(rangeStartSplit[1], keyIndex);
+		const keyColumnRange = `${
+			sheet ? sheet + '!' : ''
+		}${keyColumn}${startRowIndex}:${keyColumn}${endRowIndex}`;
+
+		const sheetDataKeyColumn = await this.getData(
+			this.encodeRange(keyColumnRange),
+			valueRenderMode,
+		);
+
+		if (sheetDataKeyColumn === undefined) {
+			throw new NodeOperationError(
+				this.executeFunctions.getNode(),
+				'Could not retrieve the key column!',
+			);
+		}
+
+		// TODO: The data till here can be cached optionally. Maybe add an option which can
+		//       can be activated if it is used in a loop and nothing else updates the data.
+
+		// Remove the first row which contains the key
+		sheetDataKeyColumn.shift();
+
+		// Create an Array which all the key-values of the Google Sheet
+		const keyColumnIndexLookup = sheetDataKeyColumn.map((rowContent) => rowContent[0]);
+
+		const updateData: ISheetUpdateData[] = [];
+		let itemKey: string | number | undefined | null;
+		let propertyName: string;
+		let itemKeyIndex: number;
+		let updateRowIndex: number;
+		let updateColumnName: string;
+		for (const inputItem of inputData) {
+			itemKey = inputItem[indexKey] as string;
+			// if ([undefined, null].includes(inputItem[indexKey] as string | undefined | null)) {
+			if (itemKey === undefined || itemKey === null) {
+				// Item does not have the indexKey so we can ignore it or append it if upsert true
+				if (upsert) {
+					const _data = await this.appendSheetData(
+						[inputItem],
+						this.encodeRange(range),
+						keyRowIndex,
+						valueInputMode,
+						false,
+					);
+				}
+				continue;
+			}
+
+			// Item does have the key so check if it exists in Sheet
+			itemKeyIndex = keyColumnIndexLookup.indexOf(itemKey as string);
+			if (itemKeyIndex === -1) {
+				// Key does not exist in the Sheet so it can not be updated so skip it or append it if upsert true
+				if (upsert) {
+					const _data = await this.appendSheetData(
+						[inputItem],
+						this.encodeRange(range),
+						keyRowIndex,
+						valueInputMode,
+						false,
+					);
+				}
+				continue;
+			}
+
+			// Get the row index in which the data should be updated
+			updateRowIndex = keyColumnIndexLookup.indexOf(itemKey) + dataStartRowIndex + 1;
+
+			// Check all the properties in the sheet and check which ones exist on the
+			// item and should be updated
+			for (propertyName of keyColumnOrder) {
+				if (propertyName === indexKey) {
+					// Ignore the key itself as that does not get changed it gets
+					// only used to find the correct row to update
+					continue;
+				}
+				if (inputItem[propertyName] === undefined || inputItem[propertyName] === null) {
+					// Property does not exist so skip it
+					continue;
+				}
+
+				// Property exists so add it to the data to update
+
+				// Get the column name in which the property data can be found
+				updateColumnName = this.getColumnWithOffset(
+					rangeStartSplit[1],
+					keyColumnOrder.indexOf(propertyName),
+				);
+
+				updateData.push({
+					range: `${sheet ? sheet + '!' : ''}${updateColumnName}${updateRowIndex}`,
+					values: [[inputItem[propertyName] as string]],
+				});
+			}
+		}
+
+		return this.batchUpdate(updateData, valueInputMode);
+	}
+
+	/**
+	 * Looks for a specific value in a column and if it gets found it returns the whole row
+	 *
+	 * @param {string[][]} inputData Data to to check for lookup value in
+	 * @param {number} keyRowIndex Index of the row which contains the keys
+	 * @param {number} dataStartRowIndex Index of the first row which contains data
+	 * @param {ILookupValues[]} lookupValues The lookup values which decide what data to return
+	 * @param {boolean} [returnAllMatches] Returns all the found matches instead of only the first one
+	 */
+	async lookupValues(
+		inputData: string[][],
+		keyRowIndex: number,
+		dataStartRowIndex: number,
+		lookupValues: ILookupValues[],
+		returnAllMatches?: boolean,
+	): Promise<IDataObject[]> {
+		const keys: string[] = [];
+
+		if (keyRowIndex < 0 || dataStartRowIndex < keyRowIndex || keyRowIndex >= inputData.length) {
+			// The key row does not exist so it is not possible to look up the data
+			throw new NodeOperationError(this.executeFunctions.getNode(), `The key row does not exist!`);
+		}
+
+		// Create the keys array
+		for (let columnIndex = 0; columnIndex < inputData[keyRowIndex].length; columnIndex++) {
+			keys.push(inputData[keyRowIndex][columnIndex]);
+		}
+
+		const returnData = [inputData[keyRowIndex]];
+
+		// Standardise values array, if rows is [[]], map it to [['']] (Keep the columns into consideration)
+		for (let rowIndex = 0; rowIndex < inputData?.length; rowIndex++) {
+			if (inputData[rowIndex].length === 0) {
+				for (let i = 0; i < keys.length; i++) {
+					inputData[rowIndex][i] = '';
+				}
+			} else if (inputData[rowIndex].length < keys.length) {
+				for (let i = 0; i < keys.length; i++) {
+					if (inputData[rowIndex][i] === undefined) {
+						inputData[rowIndex].push('');
+					}
+				}
+			}
+		}
+		// Loop over all the lookup values and try to find a row to return
+		let rowIndex: number;
+		let returnColumnIndex: number;
+
+		lookupLoop: for (const lookupValue of lookupValues) {
+			returnColumnIndex = keys.indexOf(lookupValue.lookupColumn);
+
+			if (returnColumnIndex === -1) {
+				throw new NodeOperationError(
+					this.executeFunctions.getNode(),
+					`The column "${lookupValue.lookupColumn}" could not be found!`,
+				);
+			}
+
+			// Loop over all the items and find the one with the matching value
+			for (rowIndex = dataStartRowIndex; rowIndex < inputData.length; rowIndex++) {
+				if (
+					inputData[rowIndex][returnColumnIndex]?.toString() === lookupValue.lookupValue.toString()
+				) {
+					returnData.push(inputData[rowIndex]);
+
+					if (returnAllMatches !== true) {
+						continue lookupLoop;
+					}
+				}
+			}
+
+			// If value could not be found add an empty one that the order of
+			// the returned items stays the same
+			if (returnAllMatches !== true) {
+				returnData.push([]);
+			}
+		}
+
+		return this.structureData(returnData, 1, keys, true);
+	}
+
+	async convertStructuredDataToArray(
+		inputData: IDataObject[],
+		range: string,
+		keyRowIndex: number,
+		usePathForKeyRow: boolean,
+	): Promise<string[][]> {
+		let startColumn, endColumn;
+		let sheet: string | undefined = undefined;
+		if (range.includes('!')) {
+			[sheet, range] = range.split('!');
+		}
+		[startColumn, endColumn] = range.split(':');
+
+		let getRange = `${startColumn}${keyRowIndex + 1}:${endColumn}${keyRowIndex + 1}`;
+
+		if (sheet !== undefined) {
+			getRange = `${sheet}!${getRange}`;
+		}
+
+		const keyColumnData = await this.getData(getRange, 'UNFORMATTED_VALUE');
+
+		if (keyColumnData === undefined) {
+			throw new NodeOperationError(
+				this.executeFunctions.getNode(),
+				'Could not retrieve the column data!',
+			);
+		}
+
+		const keyColumnOrder = keyColumnData[0];
+
+		const setData: string[][] = [];
+
+		let rowData: string[] = [];
+		inputData.forEach((item) => {
+			rowData = [];
+			keyColumnOrder.forEach((key) => {
+				const value = get(item, key) as string;
+				if (usePathForKeyRow && value !== undefined && value !== null) {
+					//match by key path
+					rowData.push(value!.toString());
+				} else if (
+					!usePathForKeyRow &&
+					item.hasOwnProperty(key) &&
+					item[key] !== null &&
+					item[key] !== undefined
+				) {
+					//match by exact key name
+					rowData.push(item[key]!.toString());
+				} else {
+					rowData.push('');
+				}
+			});
+			setData.push(rowData);
+		});
+
+		return setData;
+	}
+}

packages/nodes-base/nodes/Google/Sheet/v1/GoogleSheetsV1.node.ts

@@ -0,0 +1,502 @@
+import { IExecuteFunctions } from 'n8n-core';
+
+import {
+	ICredentialsDecrypted,
+	ICredentialTestFunctions,
+	IDataObject,
+	ILoadOptionsFunctions,
+	INodeCredentialTestResult,
+	INodeExecutionData,
+	INodePropertyOptions,
+	INodeType,
+	INodeTypeBaseDescription,
+	INodeTypeDescription,
+	NodeOperationError,
+} from 'n8n-workflow';
+
+import {
+	GoogleSheet,
+	ILookupValues,
+	ISheetUpdateData,
+	IToDelete,
+	ValueInputOption,
+	ValueRenderOption,
+} from './GoogleSheet';
+
+import {
+	getAccessToken,
+	googleApiRequest,
+	hexToRgb,
+	IGoogleAuthCredentials,
+} from './GenericFunctions';
+
+import { versionDescription } from './versionDescription';
+
+export class GoogleSheetsV1 implements INodeType {
+	description: INodeTypeDescription;
+
+	constructor(baseDescription: INodeTypeBaseDescription) {
+		this.description = {
+			...baseDescription,
+			...versionDescription,
+		};
+	}
+
+	methods = {
+		loadOptions: {
+			// Get all the sheets in a Spreadsheet
+			async getSheets(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
+				const spreadsheetId = this.getCurrentNodeParameter('sheetId') as string;
+
+				const sheet = new GoogleSheet(spreadsheetId, this);
+				const responseData = await sheet.spreadsheetGetSheets();
+
+				if (responseData === undefined) {
+					throw new NodeOperationError(this.getNode(), 'No data got returned');
+				}
+
+				const returnData: INodePropertyOptions[] = [];
+				for (const sheet of responseData.sheets!) {
+					if (sheet.properties!.sheetType !== 'GRID') {
+						continue;
+					}
+
+					returnData.push({
+						name: sheet.properties!.title as string,
+						value: sheet.properties!.sheetId as unknown as string,
+					});
+				}
+
+				return returnData;
+			},
+		},
+		credentialTest: {
+			async googleApiCredentialTest(
+				this: ICredentialTestFunctions,
+				credential: ICredentialsDecrypted,
+			): Promise<INodeCredentialTestResult> {
+				try {
+					const tokenRequest = await getAccessToken.call(
+						this,
+						credential.data! as unknown as IGoogleAuthCredentials,
+					);
+					if (!tokenRequest.access_token) {
+						return {
+							status: 'Error',
+							message: 'Could not generate a token from your private key.',
+						};
+					}
+				} catch (err) {
+					return {
+						status: 'Error',
+						message: `Private key validation failed: ${err.message}`,
+					};
+				}
+
+				return {
+					status: 'OK',
+					message: 'Connection successful!',
+				};
+			},
+		},
+	};
+
+	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
+		const operation = this.getNodeParameter('operation', 0) as string;
+		const resource = this.getNodeParameter('resource', 0) as string;
+
+		if (resource === 'sheet') {
+			const spreadsheetId = this.getNodeParameter('sheetId', 0) as string;
+
+			const sheet = new GoogleSheet(spreadsheetId, this);
+
+			let range = '';
+			if (!['create', 'delete', 'remove'].includes(operation)) {
+				range = this.getNodeParameter('range', 0) as string;
+			}
+
+			const options = this.getNodeParameter('options', 0, {}) as IDataObject;
+
+			const valueInputMode = (options.valueInputMode || 'RAW') as ValueInputOption;
+			const valueRenderMode = (options.valueRenderMode || 'UNFORMATTED_VALUE') as ValueRenderOption;
+
+			if (operation === 'append') {
+				// ----------------------------------
+				//         append
+				// ----------------------------------
+				try {
+					const keyRow = parseInt(this.getNodeParameter('keyRow', 0) as string, 10);
+
+					const items = this.getInputData();
+
+					const setData: IDataObject[] = [];
+					items.forEach((item) => {
+						setData.push(item.json);
+					});
+
+					const usePathForKeyRow = (options.usePathForKeyRow || false) as boolean;
+
+					// Convert data into array format
+					const _data = await sheet.appendSheetData(
+						setData,
+						sheet.encodeRange(range),
+						keyRow,
+						valueInputMode,
+						usePathForKeyRow,
+					);
+
+					// TODO: Should add this data somewhere
+					// TODO: Should have something like add metadata which does not get passed through
+
+					return this.prepareOutputData(items);
+				} catch (error) {
+					if (this.continueOnFail()) {
+						return this.prepareOutputData([{ json: { error: error.message } }]);
+					}
+					throw error;
+				}
+			} else if (operation === 'clear') {
+				// ----------------------------------
+				//         clear
+				// ----------------------------------
+				try {
+					await sheet.clearData(sheet.encodeRange(range));
+
+					const items = this.getInputData();
+					return this.prepareOutputData(items);
+				} catch (error) {
+					if (this.continueOnFail()) {
+						return this.prepareOutputData([{ json: { error: error.message } }]);
+					}
+					throw error;
+				}
+			} else if (operation === 'create') {
+				const returnData: IDataObject[] = [];
+
+				let responseData;
+				for (let i = 0; i < this.getInputData().length; i++) {
+					try {
+						const spreadsheetId = this.getNodeParameter('sheetId', i) as string;
+						const options = this.getNodeParameter('options', i, {}) as IDataObject;
+						const simple = this.getNodeParameter('simple', 0) as boolean;
+						const properties = { ...options };
+
+						if (options.tabColor) {
+							const { red, green, blue } = hexToRgb(options.tabColor as string)!;
+							properties.tabColor = { red: red / 255, green: green / 255, blue: blue / 255 };
+						}
+
+						const requests = [
+							{
+								addSheet: {
+									properties,
+								},
+							},
+						];
+
+						responseData = await googleApiRequest.call(
+							this,
+							'POST',
+							`/v4/spreadsheets/${spreadsheetId}:batchUpdate`,
+							{ requests },
+						);
+
+						if (simple === true) {
+							Object.assign(responseData, responseData.replies[0].addSheet.properties);
+							delete responseData.replies;
+						}
+						returnData.push(responseData);
+					} catch (error) {
+						if (this.continueOnFail()) {
+							returnData.push({ error: error.message });
+							continue;
+						}
+						throw error;
+					}
+				}
+
+				return [this.helpers.returnJsonArray(returnData)];
+			} else if (operation === 'delete') {
+				// ----------------------------------
+				//         delete
+				// ----------------------------------
+				try {
+					const requests: IDataObject[] = [];
+
+					const toDelete = this.getNodeParameter('toDelete', 0) as IToDelete;
+
+					const deletePropertyToDimensions: IDataObject = {
+						columns: 'COLUMNS',
+						rows: 'ROWS',
+					};
+
+					for (const propertyName of Object.keys(deletePropertyToDimensions)) {
+						if (toDelete[propertyName] !== undefined) {
+							toDelete[propertyName]!.forEach((range) => {
+								requests.push({
+									deleteDimension: {
+										range: {
+											sheetId: range.sheetId,
+											dimension: deletePropertyToDimensions[propertyName] as string,
+											startIndex: range.startIndex,
+											endIndex:
+												parseInt(range.startIndex.toString(), 10) +
+												parseInt(range.amount.toString(), 10),
+										},
+									},
+								});
+							});
+						}
+					}
+
+					const _data = await sheet.spreadsheetBatchUpdate(requests);
+
+					const items = this.getInputData();
+					return this.prepareOutputData(items);
+				} catch (error) {
+					if (this.continueOnFail()) {
+						return this.prepareOutputData([{ json: { error: error.message } }]);
+					}
+					throw error;
+				}
+			} else if (operation === 'lookup') {
+				// ----------------------------------
+				//         lookup
+				// ----------------------------------
+				try {
+					const sheetData = await sheet.getData(sheet.encodeRange(range), valueRenderMode);
+
+					if (sheetData === undefined) {
+						return [];
+					}
+
+					const dataStartRow = parseInt(this.getNodeParameter('dataStartRow', 0) as string, 10);
+					const keyRow = parseInt(this.getNodeParameter('keyRow', 0) as string, 10);
+
+					const items = this.getInputData();
+
+					const lookupValues: ILookupValues[] = [];
+					for (let i = 0; i < items.length; i++) {
+						lookupValues.push({
+							lookupColumn: this.getNodeParameter('lookupColumn', i) as string,
+							lookupValue: this.getNodeParameter('lookupValue', i) as string,
+						});
+					}
+
+					let returnData = await sheet.lookupValues(
+						sheetData,
+						keyRow,
+						dataStartRow,
+						lookupValues,
+						options.returnAllMatches as boolean | undefined,
+					);
+
+					if (returnData.length === 0 && options.continue && options.returnAllMatches) {
+						returnData = [{}];
+					} else if (
+						returnData.length === 1 &&
+						Object.keys(returnData[0]).length === 0 &&
+						!options.continue &&
+						!options.returnAllMatches
+					) {
+						returnData = [];
+					}
+
+					return [this.helpers.returnJsonArray(returnData)];
+				} catch (error) {
+					if (this.continueOnFail()) {
+						return [this.helpers.returnJsonArray({ error: error.message })];
+					}
+					throw error;
+				}
+			} else if (operation === 'read') {
+				// ----------------------------------
+				//         read
+				// ----------------------------------
+				try {
+					const rawData = this.getNodeParameter('rawData', 0) as boolean;
+
+					const sheetData = await sheet.getData(sheet.encodeRange(range), valueRenderMode);
+
+					let returnData: IDataObject[];
+					if (!sheetData) {
+						returnData = [];
+					} else if (rawData === true) {
+						const dataProperty = this.getNodeParameter('dataProperty', 0) as string;
+						returnData = [
+							{
+								[dataProperty]: sheetData,
+							},
+						];
+					} else {
+						const dataStartRow = parseInt(this.getNodeParameter('dataStartRow', 0) as string, 10);
+						const keyRow = parseInt(this.getNodeParameter('keyRow', 0) as string, 10);
+
+						returnData = sheet.structureArrayDataByColumn(sheetData, keyRow, dataStartRow);
+					}
+
+					if (returnData.length === 0 && options.continue) {
+						returnData = [{}];
+					}
+
+					return [this.helpers.returnJsonArray(returnData)];
+				} catch (error) {
+					if (this.continueOnFail()) {
+						return [this.helpers.returnJsonArray({ error: error.message })];
+					}
+					throw error;
+				}
+			} else if (operation === 'remove') {
+				const returnData: IDataObject[] = [];
+
+				let responseData;
+				for (let i = 0; i < this.getInputData().length; i++) {
+					try {
+						const sheetId = this.getNodeParameter('id', i) as string;
+						const spreadsheetId = this.getNodeParameter('sheetId', i) as string;
+
+						const requests = [
+							{
+								deleteSheet: {
+									sheetId,
+								},
+							},
+						];
+
+						responseData = await googleApiRequest.call(
+							this,
+							'POST',
+							`/v4/spreadsheets/${spreadsheetId}:batchUpdate`,
+							{ requests },
+						);
+						delete responseData.replies;
+						returnData.push(responseData);
+					} catch (error) {
+						if (this.continueOnFail()) {
+							returnData.push({ error: error.message });
+							continue;
+						}
+						throw error;
+					}
+				}
+
+				return [this.helpers.returnJsonArray(returnData)];
+			} else if (operation === 'update' || operation === 'upsert') {
+				// ----------------------------------
+				//         update/upsert
+				// ----------------------------------
+				const upsert = operation === 'upsert' ? true : false;
+				try {
+					const rawData = this.getNodeParameter('rawData', 0) as boolean;
+
+					const items = this.getInputData();
+
+					if (rawData === true) {
+						const dataProperty = this.getNodeParameter('dataProperty', 0) as string;
+
+						const updateData: ISheetUpdateData[] = [];
+						for (let i = 0; i < items.length; i++) {
+							updateData.push({
+								range,
+								values: items[i].json[dataProperty] as string[][],
+							});
+						}
+
+						const _data = await sheet.batchUpdate(updateData, valueInputMode);
+					} else {
+						const keyName = this.getNodeParameter('key', 0) as string;
+						const keyRow = parseInt(this.getNodeParameter('keyRow', 0) as string, 10);
+						const dataStartRow = parseInt(this.getNodeParameter('dataStartRow', 0) as string, 10);
+
+						const setData: IDataObject[] = [];
+						items.forEach((item) => {
+							setData.push(item.json);
+						});
+
+						const _data = await sheet.updateSheetData(
+							setData,
+							keyName,
+							range,
+							keyRow,
+							dataStartRow,
+							valueInputMode,
+							valueRenderMode,
+							upsert,
+						);
+					}
+					// TODO: Should add this data somewhere
+					// TODO: Should have something like add metadata which does not get passed through
+
+					return this.prepareOutputData(items);
+				} catch (error) {
+					if (this.continueOnFail()) {
+						return this.prepareOutputData([{ json: { error: error.message } }]);
+					}
+					throw error;
+				}
+			}
+		}
+
+		if (resource === 'spreadsheet') {
+			const returnData: IDataObject[] = [];
+
+			let responseData;
+
+			if (operation === 'create') {
+				// ----------------------------------
+				//         create
+				// ----------------------------------
+				// https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/create
+
+				for (let i = 0; i < this.getInputData().length; i++) {
+					try {
+						const title = this.getNodeParameter('title', i) as string;
+						const sheetsUi = this.getNodeParameter('sheetsUi', i, {}) as IDataObject;
+
+						const body = {
+							properties: {
+								title,
+								autoRecalc: undefined as undefined | string,
+								locale: undefined as undefined | string,
+							},
+							sheets: [] as IDataObject[],
+						};
+
+						const options = this.getNodeParameter('options', i, {}) as IDataObject;
+
+						if (Object.keys(sheetsUi).length) {
+							const data = [];
+							const sheets = sheetsUi.sheetValues as IDataObject[];
+							for (const sheet of sheets) {
+								const properties = sheet.propertiesUi as IDataObject;
+								if (properties) {
+									data.push({ properties });
+								}
+							}
+							body.sheets = data;
+						}
+
+						body.properties!.autoRecalc = options.autoRecalc
+							? (options.autoRecalc as string)
+							: undefined;
+						body.properties!.locale = options.locale ? (options.locale as string) : undefined;
+
+						responseData = await googleApiRequest.call(this, 'POST', `/v4/spreadsheets`, body);
+
+						returnData.push(responseData);
+					} catch (error) {
+						if (this.continueOnFail()) {
+							returnData.push({ error: error.message });
+							continue;
+						}
+						throw error;
+					}
+				}
+			}
+
+			return [this.helpers.returnJsonArray(returnData)];
+		}
+
+		return [];
+	}
+}

packages/nodes-base/nodes/Google/Sheet/v1/versionDescription.ts

@@ -0,0 +1,880 @@
+/* eslint-disable n8n-nodes-base/node-filename-against-convention */
+import { INodeTypeDescription } from 'n8n-workflow';
+
+export const versionDescription: INodeTypeDescription = {
+	displayName: 'Google Sheets ',
+	name: 'googleSheets',
+	icon: 'file:googleSheets.svg',
+	group: ['input', 'output'],
+	version: 1,
+	subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+	description: 'Read, update and write data to Google Sheets',
+	defaults: {
+		name: 'Google Sheets',
+	},
+	inputs: ['main'],
+	outputs: ['main'],
+	credentials: [
+		{
+			name: 'googleApi',
+			required: true,
+			displayOptions: {
+				show: {
+					authentication: ['serviceAccount'],
+				},
+			},
+			testedBy: 'googleApiCredentialTest',
+		},
+		{
+			name: 'googleSheetsOAuth2Api',
+			required: true,
+			displayOptions: {
+				show: {
+					authentication: ['oAuth2'],
+				},
+			},
+		},
+	],
+	properties: [
+		{
+			displayName: 'Authentication',
+			name: 'authentication',
+			type: 'options',
+			options: [
+				{
+					name: 'Service Account',
+					value: 'serviceAccount',
+				},
+				{
+					name: 'OAuth2',
+					value: 'oAuth2',
+				},
+			],
+			default: 'serviceAccount',
+		},
+		{
+			displayName: 'Resource',
+			name: 'resource',
+			type: 'options',
+			noDataExpression: true,
+			options: [
+				{
+					name: 'Spreadsheet',
+					value: 'spreadsheet',
+				},
+				{
+					name: 'Sheet',
+					value: 'sheet',
+				},
+			],
+			default: 'sheet',
+		},
+		{
+			displayName: 'Operation',
+			name: 'operation',
+			type: 'options',
+			noDataExpression: true,
+			displayOptions: {
+				show: {
+					resource: ['sheet'],
+				},
+			},
+			options: [
+				{
+					name: 'Append',
+					value: 'append',
+					description: 'Append data to a sheet',
+					action: 'Append data to a sheet',
+				},
+				{
+					name: 'Clear',
+					value: 'clear',
+					description: 'Clear data from a sheet',
+					action: 'Clear a sheet',
+				},
+				{
+					name: 'Create',
+					value: 'create',
+					description: 'Create a new sheet',
+					action: 'Create a sheet',
+				},
+				{
+					name: 'Create or Update',
+					value: 'upsert',
+					description:
+						'Create a new record, or update the current one if it already exists (upsert)',
+					action: 'Create or update a sheet',
+				},
+				{
+					name: 'Delete',
+					value: 'delete',
+					description: 'Delete columns and rows from a sheet',
+					action: 'Delete a sheet',
+				},
+				{
+					name: 'Lookup',
+					value: 'lookup',
+					description: 'Look up a specific column value and return the matching row',
+					action: 'Look up a column value in a sheet',
+				},
+				{
+					name: 'Read',
+					value: 'read',
+					description: 'Read data from a sheet',
+					action: 'Read a sheet',
+				},
+				{
+					name: 'Remove',
+					value: 'remove',
+					description: 'Remove a sheet',
+					action: 'Remove a sheet',
+				},
+				{
+					name: 'Update',
+					value: 'update',
+					description: 'Update rows in a sheet',
+					action: 'Update a sheet',
+				},
+			],
+			default: 'read',
+		},
+
+		// ----------------------------------
+		//         All
+		// ----------------------------------
+		{
+			displayName: 'Spreadsheet ID',
+			name: 'sheetId',
+			type: 'string',
+			displayOptions: {
+				show: {
+					resource: ['sheet'],
+				},
+			},
+			default: '',
+			required: true,
+			description:
+				'The ID of the Google Spreadsheet. Found as part of the sheet URL https://docs.google.com/spreadsheets/d/{ID}/.',
+		},
+		{
+			displayName: 'Range',
+			name: 'range',
+			type: 'string',
+			displayOptions: {
+				show: {
+					resource: ['sheet'],
+				},
+				hide: {
+					operation: ['create', 'delete', 'remove'],
+				},
+			},
+			default: 'A:F',
+			required: true,
+			description:
+				'The table range to read from or to append data to. See the Google <a href="https://developers.google.com/sheets/api/guides/values#writing">documentation</a> for the details. If it contains multiple sheets it can also be added like this: "MySheet!A:F"',
+		},
+
+		// ----------------------------------
+		//         Delete
+		// ----------------------------------
+		{
+			displayName: 'To Delete',
+			name: 'toDelete',
+			placeholder: 'Add Columns/Rows to delete',
+			description: 'Deletes columns and rows from a sheet',
+			type: 'fixedCollection',
+			typeOptions: {
+				multipleValues: true,
+			},
+			displayOptions: {
+				show: {
+					resource: ['sheet'],
+					operation: ['delete'],
+				},
+			},
+			default: {},
+			options: [
+				{
+					displayName: 'Columns',
+					name: 'columns',
+					values: [
+						{
+							displayName: 'Sheet Name or ID',
+							name: 'sheetId',
+							type: 'options',
+							typeOptions: {
+								loadOptionsMethod: 'getSheets',
+							},
+							options: [],
+							default: '',
+							required: true,
+							description:
+								'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
+						},
+						{
+							displayName: 'Start Index',
+							name: 'startIndex',
+							type: 'number',
+							typeOptions: {
+								minValue: 0,
+							},
+							default: 0,
+							description: 'The start index (0 based and inclusive) of column to delete',
+						},
+						{
+							displayName: 'Amount',
+							name: 'amount',
+							type: 'number',
+							typeOptions: {
+								minValue: 1,
+							},
+							default: 1,
+							description: 'Number of columns to delete',
+						},
+					],
+				},
+				{
+					displayName: 'Rows',
+					name: 'rows',
+					values: [
+						{
+							displayName: 'Sheet Name or ID',
+							name: 'sheetId',
+							type: 'options',
+							typeOptions: {
+								loadOptionsMethod: 'getSheets',
+							},
+							options: [],
+							default: '',
+							required: true,
+							description:
+								'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
+						},
+						{
+							displayName: 'Start Index',
+							name: 'startIndex',
+							type: 'number',
+							typeOptions: {
+								minValue: 0,
+							},
+							default: 0,
+							description: 'The start index (0 based and inclusive) of row to delete',
+						},
+						{
+							displayName: 'Amount',
+							name: 'amount',
+							type: 'number',
+							typeOptions: {
+								minValue: 1,
+							},
+							default: 1,
+							description: 'Number of rows to delete',
+						},
+					],
+				},
+			],
+		},
+
+		// ----------------------------------
+		//         Read
+		// ----------------------------------
+		{
+			displayName: 'RAW Data',
+			name: 'rawData',
+			type: 'boolean',
+			displayOptions: {
+				show: {
+					resource: ['sheet'],
+					operation: ['read'],
+				},
+			},
+			default: false,
+			description:
+				'Whether the data should be returned RAW instead of parsed into keys according to their header',
+		},
+		{
+			displayName: 'Data Property',
+			name: 'dataProperty',
+			type: 'string',
+			default: 'data',
+			displayOptions: {
+				show: {
+					resource: ['sheet'],
+					operation: ['read'],
+					rawData: [true],
+				},
+			},
+			description: 'The name of the property into which to write the RAW data',
+		},
+
+		// ----------------------------------
+		//         Update
+		// ----------------------------------
+		{
+			displayName: 'RAW Data',
+			name: 'rawData',
+			type: 'boolean',
+			displayOptions: {
+				show: {
+					resource: ['sheet'],
+					operation: ['update', 'upsert'],
+				},
+			},
+			default: false,
+			description: 'Whether the data supplied is RAW instead of parsed into keys',
+		},
+		{
+			displayName: 'Data Property',
+			name: 'dataProperty',
+			type: 'string',
+			default: 'data',
+			displayOptions: {
+				show: {
+					resource: ['sheet'],
+					operation: ['update', 'upsert'],
+					rawData: [true],
+				},
+			},
+			description: 'The name of the property from which to read the RAW data',
+		},
+
+		// ----------------------------------
+		//         Read & Update & lookupColumn
+		// ----------------------------------
+		{
+			displayName: 'Data Start Row',
+			name: 'dataStartRow',
+			type: 'number',
+			typeOptions: {
+				minValue: 1,
+			},
+			default: 1,
+			displayOptions: {
+				show: {
+					resource: ['sheet'],
+				},
+				hide: {
+					operation: ['append', 'create', 'clear', 'delete', 'remove'],
+					rawData: [true],
+				},
+			},
+			description:
+				'Index of the first row which contains the actual data and not the keys. Starts with 0.',
+		},
+
+		// ----------------------------------
+		//         Mixed
+		// ----------------------------------
+		{
+			displayName: 'Key Row',
+			name: 'keyRow',
+			type: 'number',
+			typeOptions: {
+				minValue: 0,
+			},
+			displayOptions: {
+				show: {
+					resource: ['sheet'],
+				},
+				hide: {
+					operation: ['clear', 'create', 'delete', 'remove'],
+					rawData: [true],
+				},
+			},
+			default: 0,
+			description:
+				'Index of the row which contains the keys. Starts at 0. The incoming node data is matched to the keys for assignment. The matching is case sensitive.',
+		},
+
+		// ----------------------------------
+		//         lookup
+		// ----------------------------------
+		{
+			displayName: 'Lookup Column',
+			name: 'lookupColumn',
+			type: 'string',
+			default: '',
+			placeholder: 'Email',
+			required: true,
+			displayOptions: {
+				show: {
+					resource: ['sheet'],
+					operation: ['lookup'],
+				},
+			},
+			description: 'The name of the column in which to look for value',
+		},
+		{
+			displayName: 'Lookup Value',
+			name: 'lookupValue',
+			type: 'string',
+			default: '',
+			placeholder: 'frank@example.com',
+			displayOptions: {
+				show: {
+					resource: ['sheet'],
+					operation: ['lookup'],
+				},
+			},
+			description: 'The value to look for in column',
+		},
+
+		// ----------------------------------
+		//         Update
+		// ----------------------------------
+		{
+			displayName: 'Key',
+			name: 'key',
+			type: 'string',
+			default: 'id',
+			displayOptions: {
+				show: {
+					resource: ['sheet'],
+					operation: ['update', 'upsert'],
+					rawData: [false],
+				},
+			},
+			description: 'The name of the key to identify which data should be updated in the sheet',
+		},
+
+		{
+			displayName: 'Options',
+			name: 'options',
+			type: 'collection',
+			placeholder: 'Add Option',
+			default: {},
+			displayOptions: {
+				show: {
+					resource: ['sheet'],
+					operation: ['append', 'lookup', 'read', 'update', 'upsert'],
+				},
+			},
+			options: [
+				{
+					displayName: 'Continue If Empty',
+					name: 'continue',
+					type: 'boolean',
+					default: false,
+					displayOptions: {
+						show: {
+							'/operation': ['lookup', 'read'],
+						},
+					},
+					// eslint-disable-next-line n8n-nodes-base/node-param-description-boolean-without-whether
+					description:
+						'By default, the workflow stops executing if the lookup/read does not return values',
+				},
+				{
+					displayName: 'Return All Matches',
+					name: 'returnAllMatches',
+					type: 'boolean',
+					default: false,
+					displayOptions: {
+						show: {
+							'/operation': ['lookup'],
+						},
+					},
+					// eslint-disable-next-line n8n-nodes-base/node-param-description-boolean-without-whether
+					description:
+						'By default only the first result gets returned. If options gets set all found matches get returned.',
+				},
+				{
+					displayName: 'Use Header Names as JSON Paths',
+					name: 'usePathForKeyRow',
+					type: 'boolean',
+					default: false,
+					displayOptions: {
+						show: {
+							'/operation': ['append'],
+						},
+					},
+					description:
+						'Whether you want to match the headers as path, for example, the row header "category.name" will match the "category" object and get the field "name" from it. By default "category.name" will match with the field with exact name, not nested object.',
+				},
+				{
+					displayName: 'Value Input Mode',
+					name: 'valueInputMode',
+					type: 'options',
+					displayOptions: {
+						show: {
+							'/operation': ['append', 'update', 'upsert'],
+						},
+					},
+					options: [
+						{
+							name: 'RAW',
+							value: 'RAW',
+							description: 'The values will not be parsed and will be stored as-is',
+						},
+						{
+							name: 'User Entered',
+							value: 'USER_ENTERED',
+							description:
+								'The values will be parsed as if the user typed them into the UI. Numbers will stay as numbers, but strings may be converted to numbers, dates, etc. following the same rules that are applied when entering text into a cell via the Google Sheets UI.',
+						},
+					],
+					default: 'RAW',
+					description: 'Determines how data should be interpreted',
+				},
+				{
+					displayName: 'Value Render Mode',
+					name: 'valueRenderMode',
+					type: 'options',
+					displayOptions: {
+						show: {
+							'/operation': ['lookup', 'read'],
+						},
+					},
+					options: [
+						{
+							name: 'Formatted Value',
+							value: 'FORMATTED_VALUE',
+							description:
+								"Values will be calculated & formatted in the reply according to the cell's formatting.Formatting is based on the spreadsheet's locale, not the requesting user's locale.For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return \"$1.23\"",
+						},
+						{
+							name: 'Formula',
+							value: 'FORMULA',
+							description:
+								'Values will not be calculated. The reply will include the formulas. For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return "=A1".',
+						},
+						{
+							name: 'Unformatted Value',
+							value: 'UNFORMATTED_VALUE',
+							description:
+								'Values will be calculated, but not formatted in the reply. For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return the number 1.23.',
+						},
+					],
+					default: 'UNFORMATTED_VALUE',
+					description: 'Determines how values should be rendered in the output',
+				},
+				{
+					displayName: 'Value Render Mode',
+					name: 'valueRenderMode',
+					type: 'options',
+					displayOptions: {
+						show: {
+							'/operation': ['update', 'upsert'],
+							'/rawData': [false],
+						},
+					},
+					options: [
+						{
+							name: 'Formatted Value',
+							value: 'FORMATTED_VALUE',
+							description:
+								"Values will be calculated & formatted in the reply according to the cell's formatting.Formatting is based on the spreadsheet's locale, not the requesting user's locale. For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return \"$1.23\".",
+						},
+						{
+							name: 'Formula',
+							value: 'FORMULA',
+							description:
+								'Values will not be calculated. The reply will include the formulas. For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return "=A1".',
+						},
+						{
+							name: 'Unformatted Value',
+							value: 'UNFORMATTED_VALUE',
+							description:
+								'Values will be calculated, but not formatted in the reply. For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return the number 1.23.',
+						},
+					],
+					default: 'UNFORMATTED_VALUE',
+					description: 'Determines how values should be rendered in the output',
+				},
+			],
+		},
+
+		{
+			displayName: 'Operation',
+			name: 'operation',
+			type: 'options',
+			noDataExpression: true,
+			displayOptions: {
+				show: {
+					resource: ['spreadsheet'],
+				},
+			},
+			options: [
+				{
+					name: 'Create',
+					value: 'create',
+					description: 'Create a spreadsheet',
+					action: 'Create a spreadsheet',
+				},
+			],
+			default: 'create',
+		},
+		// ----------------------------------
+		//         spreadsheet:create
+		// ----------------------------------
+		{
+			displayName: 'Title',
+			name: 'title',
+			type: 'string',
+			default: '',
+			displayOptions: {
+				show: {
+					resource: ['spreadsheet'],
+					operation: ['create'],
+				},
+			},
+			description: 'The title of the spreadsheet',
+		},
+		{
+			displayName: 'Sheets',
+			name: 'sheetsUi',
+			placeholder: 'Add Sheet',
+			type: 'fixedCollection',
+			typeOptions: {
+				multipleValues: true,
+			},
+			default: {},
+			displayOptions: {
+				show: {
+					resource: ['spreadsheet'],
+					operation: ['create'],
+				},
+			},
+			options: [
+				{
+					name: 'sheetValues',
+					displayName: 'Sheet',
+					values: [
+						{
+							displayName: 'Sheet Properties',
+							name: 'propertiesUi',
+							placeholder: 'Add Property',
+							type: 'collection',
+							default: {},
+							options: [
+								{
+									displayName: 'Hidden',
+									name: 'hidden',
+									type: 'boolean',
+									default: false,
+									description: 'Whether the Sheet should be hidden in the UI',
+								},
+								{
+									displayName: 'Title',
+									name: 'title',
+									type: 'string',
+									default: '',
+									description: 'Title of the property to create',
+								},
+							],
+						},
+					],
+				},
+			],
+		},
+		{
+			displayName: 'Options',
+			name: 'options',
+			type: 'collection',
+			placeholder: 'Add Option',
+			default: {},
+			displayOptions: {
+				show: {
+					resource: ['spreadsheet'],
+					operation: ['create'],
+				},
+			},
+			options: [
+				{
+					displayName: 'Locale',
+					name: 'locale',
+					type: 'string',
+					default: '',
+					placeholder: 'en_US',
+					description: `The locale of the spreadsheet in one of the following formats:
+					<ul>
+						<li>en (639-1)</li>
+						<li>fil (639-2 if no 639-1 format exists)</li>
+						<li>en_US (combination of ISO language an country)</li>
+					<ul>`,
+				},
+				{
+					displayName: 'Recalculation Interval',
+					name: 'autoRecalc',
+					type: 'options',
+					options: [
+						{
+							name: 'Default',
+							value: '',
+							description: 'Default value',
+						},
+						{
+							name: 'On Change',
+							value: 'ON_CHANGE',
+							description: 'Volatile functions are updated on every change',
+						},
+						{
+							name: 'Minute',
+							value: 'MINUTE',
+							description: 'Volatile functions are updated on every change and every minute',
+						},
+						{
+							name: 'Hour',
+							value: 'HOUR',
+							description: 'Volatile functions are updated on every change and hourly',
+						},
+					],
+					default: '',
+					description: 'Cell recalculation interval options',
+				},
+			],
+		},
+
+		// ----------------------------------
+		//         sheet:create
+		// ----------------------------------
+		{
+			displayName: 'Simplify',
+			name: 'simple',
+			type: 'boolean',
+			default: true,
+			displayOptions: {
+				show: {
+					resource: ['sheet'],
+					operation: ['create'],
+				},
+			},
+			description: 'Whether to return a simplified version of the response instead of the raw data',
+		},
+		{
+			displayName: 'Options',
+			name: 'options',
+			type: 'collection',
+			placeholder: 'Add Option',
+			default: {},
+			displayOptions: {
+				show: {
+					resource: ['sheet'],
+					operation: ['create'],
+				},
+			},
+			options: [
+				{
+					displayName: 'Grid Properties',
+					name: 'gridProperties',
+					type: 'collection',
+					placeholder: 'Add Property',
+					default: {},
+					options: [
+						{
+							displayName: 'Column Count',
+							name: 'columnCount',
+							type: 'number',
+							default: 0,
+							description: 'The number of columns in the grid',
+						},
+						{
+							displayName: 'Column Group Control After',
+							name: 'columnGroupControlAfter',
+							type: 'boolean',
+							default: false,
+							description: 'Whether the column grouping control toggle is shown after the group',
+						},
+						{
+							displayName: 'Frozen Column Count',
+							name: 'frozenColumnCount',
+							type: 'number',
+							default: 0,
+							description: 'The number of columns that are frozen in the grid',
+						},
+						{
+							displayName: 'Frozen Row Count',
+							name: 'frozenRowCount',
+							type: 'number',
+							default: 0,
+							description: 'The number of rows that are frozen in the grid',
+						},
+						{
+							displayName: 'Hide Gridlines',
+							name: 'hideGridlines',
+							type: 'boolean',
+							default: false,
+							description: "Whether the grid isn't showing gridlines in the UI",
+						},
+						{
+							displayName: 'Row Count',
+							name: 'rowCount',
+							type: 'number',
+							default: 0,
+							description: 'The number of rows in the grid',
+						},
+						{
+							displayName: 'Row Group Control After',
+							name: 'rowGroupControlAfter',
+							type: 'boolean',
+							default: false,
+							description: 'Whether the row grouping control toggle is shown after the group',
+						},
+					],
+					description: 'The type of the sheet',
+				},
+				{
+					displayName: 'Hidden',
+					name: 'hidden',
+					type: 'boolean',
+					default: false,
+					description: "Whether the sheet is hidden in the UI, false if it's visible",
+				},
+				{
+					displayName: 'Right To Left',
+					name: 'rightToLeft',
+					type: 'boolean',
+					default: false,
+					description: 'Whether the sheet is an RTL sheet instead of an LTR sheet',
+				},
+				{
+					displayName: 'Sheet ID',
+					name: 'sheetId',
+					type: 'number',
+					default: 0,
+					description:
+						'The ID of the sheet. Must be non-negative. This field cannot be changed once set.',
+				},
+				{
+					displayName: 'Sheet Index',
+					name: 'index',
+					type: 'number',
+					default: 0,
+					description: 'The index of the sheet within the spreadsheet',
+				},
+				{
+					displayName: 'Tab Color',
+					name: 'tabColor',
+					type: 'color',
+					default: '0aa55c',
+					description: 'The color of the tab in the UI',
+				},
+				{
+					displayName: 'Title',
+					name: 'title',
+					type: 'string',
+					default: '',
+					description: 'The Sheet name',
+				},
+			],
+		},
+
+		// ----------------------------------
+		//         sheet:remove
+		// ----------------------------------
+		{
+			displayName: 'Sheet ID',
+			name: 'id',
+			type: 'string',
+			default: '',
+			required: true,
+			displayOptions: {
+				show: {
+					resource: ['sheet'],
+					operation: ['remove'],
+				},
+			},
+			description: 'The ID of the sheet to delete',
+		},
+	],
+};