✨ Add Google Docs node (#1831)

* ✨ Add Google Docs node * Implement continueOnFail * Add insert:Table and insert/delete:TableRow,TableColumn * Lint fixes * Fix typos, casing and enhance code readability * Enhance code readability & apply review changes * ⚡ Review Google Docs node * Apply review changes * Minor fix * Improvements * Clean up * Enhance inputs descriptions * Removed unused type fields * Minor fix * ⚡ Small improvements * ⚡ Small change * Use Document URL insead of ID and support adding content at creation * Refactored node to make it more user friendly * Improve get operation * Add simple output to get operation * Add service account * Apply review suggestions * Improvements * Enable continueOnFail * ⚡ Minor improvements Co-authored-by: dali <servfrdali@yahoo.fr> Co-authored-by: Iván Ovejero <ivov.src@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2025-12-17 10:02:05 +00:00 · 2021-06-27 05:48:24 -04:00
parent ce885e5071
commit 2ec52cf207
8 changed files with 1878 additions and 0 deletions
--- a/packages/nodes-base/nodes/Google/Docs/GenericFunctions.ts
+++ b/packages/nodes-base/nodes/Google/Docs/GenericFunctions.ts
@@ -0,0 +1,142 @@
+import {
+	OptionsWithUri,
+} from 'request';
+
+import {
+	IExecuteFunctions,
+	ILoadOptionsFunctions,
+} from 'n8n-core';
+
+import {
+	IDataObject,
+	NodeApiError,
+	NodeOperationError,
+} from 'n8n-workflow';
+
+import * as moment from 'moment-timezone';
+
+import * as jwt from 'jsonwebtoken';
+
+export async function googleApiRequest(
+	this: IExecuteFunctions | ILoadOptionsFunctions,
+	method: string,
+	endpoint: string,
+	body: IDataObject = {},
+	qs?: IDataObject,
+	uri?: string,
+) {
+	const authenticationMethod = this.getNodeParameter('authentication', 0, 'serviceAccount') as string;
+
+	const options: OptionsWithUri = {
+		headers: {
+			'Content-Type': 'application/json',
+		},
+		method,
+		body,
+		qs,
+		uri: uri || `https://docs.googleapis.com/v1${endpoint}`,
+		json: true,
+	};
+
+	if (!Object.keys(body).length) {
+		delete options.body;
+	}
+	try {
+
+		if (authenticationMethod === 'serviceAccount') {
+			const credentials = this.getCredentials('googleApi');
+
+			if (credentials === undefined) {
+				throw new NodeOperationError(this.getNode(), 'No credentials got returned!');
+			}
+
+			const { access_token } = await getAccessToken.call(this, credentials as IDataObject);
+
+			options.headers!.Authorization = `Bearer ${access_token}`;
+			return await this.helpers.request!(options);
+		} else {
+			//@ts-ignore
+			return await this.helpers.requestOAuth2.call(this, 'googleDocsOAuth2Api', options);
+		}
+	} catch (error) {
+		throw new NodeApiError(this.getNode(), error);
+	}
+}
+
+export async function googleApiRequestAllItems(this: IExecuteFunctions | ILoadOptionsFunctions, propertyName: string, method: string, endpoint: string, body: IDataObject = {}, qs?: IDataObject, uri?: string): Promise<any> { // tslint:disable-line:no-any
+
+	const returnData: IDataObject[] = [];
+
+	let responseData;
+	const query: IDataObject = { ...qs };
+	query.maxResults = 100;
+	query.pageSize = 100;
+
+	do {
+		responseData = await googleApiRequest.call(this, method, endpoint, body, query, uri);
+		query.pageToken = responseData['nextPageToken'];
+		returnData.push.apply(returnData, responseData[propertyName]);
+	} while (
+		responseData['nextPageToken'] !== undefined &&
+		responseData['nextPageToken'] !== ''
+	);
+
+	return returnData;
+}
+
+function getAccessToken(this: IExecuteFunctions | ILoadOptionsFunctions, credentials: IDataObject): Promise<IDataObject> {
+	//https://developers.google.com/identity/protocols/oauth2/service-account#httprest
+
+	const scopes = [
+		'https://www.googleapis.com/auth/documents',
+		'https://www.googleapis.com/auth/drive',
+		'https://www.googleapis.com/auth/drive.file',
+	];
+
+	const now = moment().unix();
+
+	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,
+		},
+		credentials.privateKey as string,
+		{
+			algorithm: 'RS256',
+			header: {
+				'kid': credentials.privateKey as string,
+				'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,
+	};
+
+	return this.helpers.request!(options);
+}
+
+export const hasKeys = (obj = {}) => Object.keys(obj).length > 0;
+export const extractID = (url: string) => {
+	const regex = new RegExp('https://docs.google.com/document/d/([a-zA-Z0-9-_]+)/');
+	const results = regex.exec(url);
+	return results ? results[1] : undefined;
+};
+export const upperFirst = (str: string) => {
+	return str[0].toUpperCase() + str.substr(1);
+};