@guayaba/workflow-piece-google-docs 0.4.1

package/src/lib/auth.ts

@@ -0,0 +1,84 @@
+import { AppConnectionValueForAuthProperty, PieceAuth, Property } from '@guayaba/workflows-framework';
+import { AppConnectionType } from '@guayaba/workflows-shared';
+import { google } from 'googleapis';
+import { OAuth2Client } from 'googleapis-common';
+
+export const googleDocsScopes = [
+	'https://www.googleapis.com/auth/documents',
+	'https://www.googleapis.com/auth/drive.readonly',
+	'https://www.googleapis.com/auth/drive',
+];
+
+export const googleDocsAuth = [PieceAuth.OAuth2({
+	description: '',
+	authUrl: 'https://accounts.google.com/o/oauth2/auth',
+	tokenUrl: 'https://oauth2.googleapis.com/token',
+	required: true,
+	scope: googleDocsScopes,
+}), PieceAuth.CustomAuth({
+	displayName: 'Service Account (Advanced)',
+	description: 'Authenticate via service account from https://console.cloud.google.com/ > IAM & Admin > Service Accounts > Create Service Account > Keys > Add key.  <br> <br> You can optionally use domain-wide delegation (https://support.google.com/a/answer/162106?hl=en#zippy=%2Cset-up-domain-wide-delegation-for-a-client) to access documents without adding the service account to each one. <br> <br> **Note:** Without a user email, the service account only has access to files/folders you explicitly share with it.',
+	required: true,
+	props: {
+		serviceAccount: Property.LongText({
+			displayName: 'Service Account JSON Key',
+			required: true,
+		}),
+		userEmail: Property.ShortText({
+			displayName: 'User Email',
+			required: false,
+			description: 'Email address of the user to impersonate for domain-wide delegation.',
+		}),
+	},
+	validate: async ({ auth }) => {
+		try {
+			await getAccessToken({
+				type: AppConnectionType.CUSTOM_AUTH,
+				props: { ...auth },
+			});
+		} catch (e) {
+			return {
+				valid: false,
+				error: (e as Error).message,
+			};
+		}
+		return {
+			valid: true,
+		};
+	},
+})];
+
+export type GoogleDocsAuthValue = AppConnectionValueForAuthProperty<typeof googleDocsAuth>;
+
+export async function createGoogleClient(auth: GoogleDocsAuthValue): Promise<OAuth2Client> {
+	if (auth.type === AppConnectionType.CUSTOM_AUTH) {
+		let serviceAccount;
+		try {
+			serviceAccount = JSON.parse(auth.props.serviceAccount);
+		} catch {
+			throw new Error('Invalid Service Account JSON Key. Please provide a valid JSON string.');
+		}
+		return new google.auth.JWT({
+			email: serviceAccount.client_email,
+			key: serviceAccount.private_key,
+			scopes: googleDocsScopes,
+			subject: auth.props.userEmail,
+		});
+	}
+	const authClient = new OAuth2Client();
+	authClient.setCredentials(auth);
+	return authClient;
+}
+
+export const getAccessToken = async (auth: GoogleDocsAuthValue): Promise<string> => {
+	if (auth.type === AppConnectionType.CUSTOM_AUTH) {
+		const googleClient = await createGoogleClient(auth);
+		const response = await googleClient.getAccessToken();
+		if (response.token) {
+			return response.token;
+		} else {
+			throw new Error('Could not retrieve access token from service account json');
+		}
+	}
+	return auth.access_token;
+};

package/src/lib/common/index.ts

@@ -0,0 +1,56 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { Property } from '@guayaba/workflows-framework';
+import { HttpMethod, httpClient, AuthenticationType } from '@guayaba/workflows-common';
+
+export const docsCommon = {
+	baseUrl: 'https://docs.googleapis.com/v1',
+	title: Property.ShortText({
+		displayName: 'Document Title',
+		required: true,
+	}),
+	body: Property.LongText({
+		displayName: 'Document Content',
+		required: true,
+	}),
+
+	// Creates an empty document with the title provided
+	createDocument: async (title: string, accessToken: string) => {
+		const createRequest = await httpClient.sendRequest({
+			url: `${docsCommon.baseUrl}/documents`,
+			method: HttpMethod.POST,
+			authentication: {
+				type: AuthenticationType.BEARER_TOKEN,
+				token: accessToken,
+			},
+			body: {
+				title: title,
+			},
+		});
+
+		return createRequest.body;
+	},
+
+	// Writes provided content to the end of an existing document
+	writeToDocument: async (documentId: string, body: string, accessToken: string) => {
+		const writeRequest = await httpClient.sendRequest({
+			url: `${docsCommon.baseUrl}/documents/${documentId}:batchUpdate`,
+			method: HttpMethod.POST,
+			authentication: {
+				type: AuthenticationType.BEARER_TOKEN,
+				token: accessToken,
+			},
+			body: {
+				requests: [
+					{
+						insertText: {
+							text: body,
+							endOfSegmentLocation: {},
+						},
+					},
+				],
+			},
+		});
+
+		return writeRequest.body;
+	},
+};

package/src/lib/common/props.ts

@@ -0,0 +1,54 @@
+import { googleDocsAuth, createGoogleClient, GoogleDocsAuthValue } from '../auth';
+import { DropdownOption, Property } from '@guayaba/workflows-framework';
+import { google, drive_v3 } from 'googleapis';
+
+export const folderIdProp = Property.Dropdown({
+	displayName: 'Folder',
+	refreshers: [],
+	auth: googleDocsAuth,
+	required: false,
+	options: async ({ auth }) => {
+		if (!auth) {
+			return {
+				disabled: true,
+				placeholder: 'Please connect to your Google Drive account.',
+				options: [],
+			};
+		}
+		const authValue = auth as GoogleDocsAuthValue;
+
+		const authClient = await createGoogleClient(authValue);
+
+		const drive = google.drive({ version: 'v3', auth: authClient });
+
+		const options: DropdownOption<string>[] = [];
+
+		let nextPageToken;
+
+		do {
+			const response: any = await drive.files.list({
+				q: "mimeType='application/vnd.google-apps.folder' and trashed = false",
+				supportsAllDrives: true,
+                orderBy:'createdTime desc',
+				includeItemsFromAllDrives: true,
+				pageToken: nextPageToken,
+			});
+
+			const fileList: drive_v3.Schema$FileList = response.data;
+
+			if (fileList.files) {
+				for (const file of fileList.files)
+					options.push({
+						label: file.name!,
+						value: file.id!,
+					});
+			}
+			nextPageToken = response.data.nextPageToken;
+		} while (nextPageToken);
+
+		return {
+			disabled: false,
+			options,
+		};
+	},
+});

package/src/lib/triggers/new-document.ts

@@ -0,0 +1,101 @@
+import { googleDocsAuth, createGoogleClient } from '../auth';
+import { DedupeStrategy, Polling, pollingHelper } from '@guayaba/workflows-common';
+import {
+	AppConnectionValueForAuthProperty,
+	createTrigger,
+	TriggerStrategy,
+} from '@guayaba/workflows-framework';
+import { folderIdProp } from '../common/props';
+import dayjs from 'dayjs';
+import { google, drive_v3 } from 'googleapis';
+
+type Props = {
+	folderId?: string;
+};
+
+const polling: Polling<AppConnectionValueForAuthProperty<typeof googleDocsAuth>, Props> = {
+	strategy: DedupeStrategy.TIMEBASED,
+	async items({ auth, propsValue, lastFetchEpochMS }) {
+		const folderId = propsValue.folderId;
+
+		const q = ["mimeType='application/vnd.google-apps.document'", 'trashed = false'];
+		if (lastFetchEpochMS) {
+			q.push(`createdTime > '${dayjs(lastFetchEpochMS).toISOString()}'`);
+		}
+		if (folderId) {
+			q.push(`'${folderId}' in parents`);
+		}
+
+		const authClient = await createGoogleClient(auth);
+
+		const drive = google.drive({ version: 'v3', auth: authClient });
+
+		let nextPageToken;
+		const items = [];
+
+		do {
+			const response: any = await drive.files.list({
+				q: q.join(' and '),
+				fields: '*',
+				orderBy: 'createdTime desc',
+				supportsAllDrives: true,
+				includeItemsFromAllDrives: true,
+				pageToken: nextPageToken,
+			});
+
+			const fileList: drive_v3.Schema$FileList = response.data;
+
+			if (fileList.files) {
+				items.push(...fileList.files);
+			}
+
+			if (lastFetchEpochMS === 0) break;
+
+			nextPageToken = response.data.nextPageToken;
+		} while (nextPageToken);
+
+		return items.map((item) => ({
+			epochMilliSeconds: dayjs(item.createdTime).valueOf(),
+			data: item,
+		}));
+	},
+};
+
+export const newDocumentTrigger = createTrigger({
+	auth: googleDocsAuth,
+	name: 'new-document',
+	displayName: 'New Document',
+	description: 'Triggers when a new document is added to a specific folder(optional).',
+	type: TriggerStrategy.POLLING,
+	props: {
+		folderId: folderIdProp,
+	},
+	async onEnable(context) {
+		await pollingHelper.onEnable(polling, {
+			auth: context.auth,
+			store: context.store,
+			propsValue: context.propsValue,
+		});
+	},
+	async onDisable(context) {
+		await pollingHelper.onDisable(polling, {
+			auth: context.auth,
+			store: context.store,
+			propsValue: context.propsValue,
+		});
+	},
+	async test(context) {
+		return await pollingHelper.test(polling, context);
+	},
+	async run(context) {
+		return await pollingHelper.poll(polling, context);
+	},
+	sampleData: {
+		kind: 'drive#file',
+		mimeType: 'application/vnd.google-apps.document',
+		webViewLink:
+			'https://docs.google.com/document/d/1_9xjsrYFgHVvgqYwAJ8KcsDcNU/edit?usp=drivesdk',
+		id: '1_9xjsrYFgHVvgqYwAJ8KcsDcN3AzPelsux',
+		name: 'Test Document',
+	},
+});

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "extends": "../../../../tsconfig.base.json",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    }
+  ],
+  "compilerOptions": {
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  }
+}

package/tsconfig.lib.json

@@ -0,0 +1,15 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "rootDir": ".",
+    "baseUrl": ".",
+    "paths": {},
+    "outDir": "./dist",
+    "declaration": true,
+    "declarationMap": true,
+    "types": ["node"]
+  },
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"],
+  "include": ["src/**/*.ts"]
+}