@guayaba/workflow-piece-google-docs 0.4.1

package/src/i18n/ru.json

@@ -0,0 +1,52 @@
+{
+  "Google Docs": "Google Docs",
+  "Create and edit documents online": "Создание и редактирование документов онлайн",
+  "Create Document": "Создать документ",
+  "Edit template file": "Редактировать файл шаблона",
+  "Read Document": "Читать документ",
+  "Find Document": "Найти документ",
+  "Custom API Call": "Пользовательский вызов API",
+  "Append text to google docs": "Добавить текст в Google docs",
+  "Create a document on Google Docs": "Создать документ на Google Docs",
+  "Edit a template file and replace the values with the ones provided": "Отредактируйте файл шаблона и замените введенные значения",
+  "Read a document from Google Docs": "Читать документ от Google Docs",
+  "Search for document by name.": "Поиск документа по имени.",
+  "Make a custom API call to a specific endpoint": "Сделать пользовательский API вызов к определенной конечной точке",
+  "Appends text to google docs": "Добавляет текст в Google docs",
+  "Document Title": "Заголовок документа",
+  "Document Content": "Содержимое документа",
+  "Destination File": "Файл назначения",
+  "Variables": "Переменные",
+  "Images": "Изображения",
+  "Placeholder Format": "Формат заполнителя",
+  "Document ID": "ID документа",
+  "Document Name": "Название документа",
+  "Folder": "Папка",
+  "Create a new document if not found?": "Создать новый документ, если не найден?",
+  "New Document Properties": "Новые свойства документа",
+  "Method": "Метод",
+  "Headers": "Заголовки",
+  "Query Parameters": "Параметры запроса",
+  "Body": "Тело",
+  "No Error on Failure": "Нет ошибок при ошибке",
+  "Timeout (in seconds)": "Таймаут (в секундах)",
+  "Text to append": "Текст в добавление",
+  "The ID of the file to replace the values": "ID файла для замены значений",
+  "Dont include the placeholder format \"[[]]\" or \"{{}}\", only the key name and its value": "Не используйте формат плейсхолдера \"[[]]\" или \"{{}}\", только имя ключа и его значение",
+  "Key: Image ID (get it manually from the Read File Action), Value: Image URL": "Ключ: ID изображения (получить вручную из действия чтения файла), значение: URL изображения",
+  "Choose the format of placeholders in your template": "Выберите формат заполнителей в вашем шаблоне",
+  "The ID of the document to read": "ID документа для чтения",
+  "Authorization headers are injected automatically from your connection.": "Заголовки авторизации включаются автоматически из вашего соединения.",
+  "The text to append to the document": "Текст для добавления в документ",
+  "The ID of the document to append text to": "ID документа для добавления текста в",
+  "Curly Braces {{}}": "Изогнутые Наручи {{}}",
+  "Square Brackets [[]]": "Квадратные скобки [[]]",
+  "GET": "ПОЛУЧИТЬ",
+  "POST": "ПОСТ",
+  "PATCH": "ПАТЧ",
+  "PUT": "ПОКУПИТЬ",
+  "DELETE": "УДАЛИТЬ",
+  "HEAD": "HEAD",
+  "New Document": "Новый документ",
+  "Triggers when a new document is added to a specific folder(optional).": "Включает при добавлении нового документа в определенную папку(необязательно)."
+}

package/src/i18n/translation.json

@@ -0,0 +1,61 @@
+{
+  "Create and edit documents online": "Create and edit documents online",
+  "Create Document": "Create Document",
+  "Edit template file": "Edit template file",
+  "Read Document": "Read Document",
+  "Find Document": "Find Document",
+  "Custom API Call": "Custom API Call",
+  "Append text to google docs": "Append text to google docs",
+  "Create a document on Google Docs": "Create a document on Google Docs",
+  "Edit a template file and replace the values with the ones provided": "Edit a template file and replace the values with the ones provided",
+  "Read a document from Google Docs": "Read a document from Google Docs",
+  "Search for document by name.": "Search for document by name.",
+  "Make a custom API call to a specific endpoint": "Make a custom API call to a specific endpoint",
+  "Appends text to google docs": "Appends text to google docs",
+  "Document Title": "Document Title",
+  "Document Content": "Document Content",
+  "Destination File": "Destination File",
+  "Variables": "Variables",
+  "Images": "Images",
+  "Placeholder Format": "Placeholder Format",
+  "Document ID": "Document ID",
+  "Document Name": "Document Name",
+  "Folder": "Folder",
+  "Create a new document if not found?": "Create a new document if not found?",
+  "New Document Properties": "New Document Properties",
+  "Method": "Method",
+  "Headers": "Headers",
+  "Query Parameters": "Query Parameters",
+  "Body Type": "Body Type",
+  "Body": "Body",
+  "Response is Binary ?": "Response is Binary ?",
+  "No Error on Failure": "No Error on Failure",
+  "Timeout (in seconds)": "Timeout (in seconds)",
+  "Follow redirects": "Follow redirects",
+  "Text to append": "Text to append",
+  "The ID of the file to replace the values": "The ID of the file to replace the values",
+  "Dont include the placeholder format \"[[]]\" or \"{{}}\", only the key name and its value": "Dont include the placeholder format \"[[]]\" or \"{{}}\", only the key name and its value",
+  "Key: Image ID (get it manually from the Read File Action), Value: Image URL": "Key: Image ID (get it manually from the Read File Action), Value: Image URL",
+  "Choose the format of placeholders in your template": "Choose the format of placeholders in your template",
+  "The ID of the document to read": "The ID of the document to read",
+  "Authorization headers are injected automatically from your connection.": "Authorization headers are injected automatically from your connection.",
+  "Enable for files like PDFs, images, etc.": "Enable for files like PDFs, images, etc.",
+  "The text to append to the document": "The text to append to the document",
+  "The ID of the document to append text to": "The ID of the document to append text to",
+  "Curly Braces {{}}": "Curly Braces {{}}",
+  "Square Brackets [[]]": "Square Brackets [[]]",
+  "Single Curly Braces {}": "Single Curly Braces {}",
+  "Single Square Brackets []": "Single Square Brackets []",
+  "GET": "GET",
+  "POST": "POST",
+  "PATCH": "PATCH",
+  "PUT": "PUT",
+  "DELETE": "DELETE",
+  "HEAD": "HEAD",
+  "None": "None",
+  "JSON": "JSON",
+  "Form Data": "Form Data",
+  "Raw": "Raw",
+  "New Document": "New Document",
+  "Triggers when a new document is added to a specific folder(optional).": "Triggers when a new document is added to a specific folder(optional)."
+}

package/src/i18n/vi.json

@@ -0,0 +1,52 @@
+{
+  "Google Docs": "Google Docs",
+  "Create and edit documents online": "Create and edit documents online",
+  "Create Document": "Create Document",
+  "Edit template file": "Edit template file",
+  "Read Document": "Read Document",
+  "Find Document": "Find Document",
+  "Custom API Call": "Custom API Call",
+  "Append text to google docs": "Append text to google docs",
+  "Create a document on Google Docs": "Create a document on Google Docs",
+  "Edit a template file and replace the values with the ones provided": "Edit a template file and replace the values with the ones provided",
+  "Read a document from Google Docs": "Read a document from Google Docs",
+  "Search for document by name.": "Search for document by name.",
+  "Make a custom API call to a specific endpoint": "Make a custom API call to a specific endpoint",
+  "Appends text to google docs": "Appends text to google docs",
+  "Document Title": "Document Title",
+  "Document Content": "Document Content",
+  "Destination File": "Destination File",
+  "Variables": "Variables",
+  "Images": "Images",
+  "Placeholder Format": "Placeholder Format",
+  "Document ID": "Document ID",
+  "Document Name": "Document Name",
+  "Folder": "Folder",
+  "Create a new document if not found?": "Create a new document if not found?",
+  "New Document Properties": "New Document Properties",
+  "Method": "Method",
+  "Headers": "Headers",
+  "Query Parameters": "Query Parameters",
+  "Body": "Body",
+  "No Error on Failure": "No Error on Failure",
+  "Timeout (in seconds)": "Timeout (in seconds)",
+  "Text to append": "Text to append",
+  "The ID of the file to replace the values": "The ID of the file to replace the values",
+  "Dont include the placeholder format \"[[]]\" or \"{{}}\", only the key name and its value": "Dont include the placeholder format \"[[]]\" or \"{{}}\", only the key name and its value",
+  "Key: Image ID (get it manually from the Read File Action), Value: Image URL": "Key: Image ID (get it manually from the Read File Action), Value: Image URL",
+  "Choose the format of placeholders in your template": "Choose the format of placeholders in your template",
+  "The ID of the document to read": "The ID of the document to read",
+  "Authorization headers are injected automatically from your connection.": "Authorization headers are injected automatically from your connection.",
+  "The text to append to the document": "The text to append to the document",
+  "The ID of the document to append text to": "The ID of the document to append text to",
+  "Curly Braces {{}}": "Curly Braces {{}}",
+  "Square Brackets [[]]": "Square Brackets [[]]",
+  "GET": "GET",
+  "POST": "POST",
+  "PATCH": "PATCH",
+  "PUT": "PUT",
+  "DELETE": "DELETE",
+  "HEAD": "HEAD",
+  "New Document": "New Document",
+  "Triggers when a new document is added to a specific folder(optional).": "Triggers when a new document is added to a specific folder(optional)."
+}

package/src/i18n/zh.json

@@ -0,0 +1,61 @@
+{
+  "Create and edit documents online": "Create and edit documents online",
+  "Create Document": "Create Document",
+  "Edit template file": "Edit template file",
+  "Read Document": "Read Document",
+  "Find Document": "Find Document",
+  "Custom API Call": "自定义 API 呼叫",
+  "Append text to google docs": "Append text to google docs",
+  "Create a document on Google Docs": "Create a document on Google Docs",
+  "Edit a template file and replace the values with the ones provided": "Edit a template file and replace the values with the ones provided",
+  "Read a document from Google Docs": "Read a document from Google Docs",
+  "Search for document by name.": "Search for document by name.",
+  "Make a custom API call to a specific endpoint": "将一个自定义 API 调用到一个特定的终点",
+  "Appends text to google docs": "Appends text to google docs",
+  "Document Title": "Document Title",
+  "Document Content": "Document Content",
+  "Destination File": "Destination File",
+  "Variables": "Variables",
+  "Images": "Images",
+  "Placeholder Format": "Placeholder Format",
+  "Document ID": "Document ID",
+  "Document Name": "Document Name",
+  "Folder": "Folder",
+  "Create a new document if not found?": "Create a new document if not found?",
+  "New Document Properties": "New Document Properties",
+  "Method": "方法",
+  "Headers": "信头",
+  "Query Parameters": "查询参数",
+  "Body Type": "Body Type",
+  "Body": "正文内容",
+  "Response is Binary ?": "Response is Binary ?",
+  "No Error on Failure": "失败时没有错误",
+  "Timeout (in seconds)": "超时(秒)",
+  "Follow redirects": "Follow redirects",
+  "Text to append": "Text to append",
+  "The ID of the file to replace the values": "The ID of the file to replace the values",
+  "Dont include the placeholder format \"[[]]\" or \"{{}}\", only the key name and its value": "Dont include the placeholder format \"[[]]\" or \"{{}}\", only the key name and its value",
+  "Key: Image ID (get it manually from the Read File Action), Value: Image URL": "Key: Image ID (get it manually from the Read File Action), Value: Image URL",
+  "Choose the format of placeholders in your template": "Choose the format of placeholders in your template",
+  "The ID of the document to read": "The ID of the document to read",
+  "Authorization headers are injected automatically from your connection.": "授权头自动从您的连接中注入。",
+  "Enable for files like PDFs, images, etc.": "Enable for files like PDFs, images, etc.",
+  "The text to append to the document": "The text to append to the document",
+  "The ID of the document to append text to": "The ID of the document to append text to",
+  "Curly Braces {{}}": "Curly Braces {{}}",
+  "Square Brackets [[]]": "Square Brackets [[]]",
+  "Single Curly Braces {}": "Single Curly Braces {}",
+  "Single Square Brackets []": "Single Square Brackets []",
+  "GET": "获取",
+  "POST": "帖子",
+  "PATCH": "PATCH",
+  "PUT": "弹出",
+  "DELETE": "删除",
+  "HEAD": "黑色",
+  "None": "无",
+  "JSON": "JSON",
+  "Form Data": "表单数据",
+  "Raw": "原始文件",
+  "New Document": "New Document",
+  "Triggers when a new document is added to a specific folder(optional).": "Triggers when a new document is added to a specific folder(optional)."
+}

package/src/index.ts

@@ -0,0 +1,46 @@
+import { createPiece } from '@guayaba/workflows-framework';
+
+import { createCustomApiCallAction } from '@guayaba/workflows-common';
+import { PieceCategory } from '@guayaba/workflows-shared';
+import { createDocument } from './lib/actions/create-document';
+import { createDocumentBasedOnTemplate } from './lib/actions/create-document-based-on-template.action';
+import { readDocument } from './lib/actions/read-document.action';
+import { appendText } from './lib/actions/append-text';
+import { findDocumentAction } from './lib/actions/find-document';
+import { newDocumentTrigger } from './lib/triggers/new-document';
+import { googleDocsAuth, getAccessToken, GoogleDocsAuthValue } from './lib/auth';
+
+export { googleDocsAuth, getAccessToken, GoogleDocsAuthValue } from './lib/auth';
+
+export const googleDocs = createPiece({
+	displayName: 'Google Docs',
+	description: 'Create and edit documents online',
+	minimumSupportedRelease: '0.30.0',
+	logoUrl: 'https://cdn.activepieces.com/pieces/google-docs.png',
+	categories: [PieceCategory.CONTENT_AND_FILES],
+	authors: [
+		'pfernandez98',
+		'kishanprmr',
+		'MoShizzle',
+		'khaledmashaly',
+		'abuaboud',
+		'AbdullahBitar',
+		'Kevinyu-alan'
+	],
+	auth: googleDocsAuth,
+	actions: [
+		createDocument,
+		createDocumentBasedOnTemplate,
+		readDocument,
+		findDocumentAction,
+		createCustomApiCallAction({
+			baseUrl: () => 'https://docs.googleapis.com/v1',
+			auth: googleDocsAuth,
+			authMapping: async (auth) => ({
+				Authorization: `Bearer ${await getAccessToken(auth as GoogleDocsAuthValue)}`,
+			}),
+		}),
+		appendText,
+	],
+	triggers: [newDocumentTrigger],
+});

package/src/lib/actions/append-text.ts

@@ -0,0 +1,29 @@
+import { docsCommon } from '../common';
+import { googleDocsAuth, getAccessToken } from '../auth';
+import { Property, createAction } from "@guayaba/workflows-framework";
+
+export const appendText = createAction({
+    auth: googleDocsAuth,
+    name: 'append_text',
+    description: 'Appends text to google docs',
+    displayName: 'Append text to google docs',
+    props: {
+      text: Property.LongText({
+        displayName: 'Text to append',
+        description: 'The text to append to the document',
+        required: true,
+      }),
+      documentId: Property.ShortText({
+        displayName: 'Document ID',
+        description: 'The ID of the document to append text to',
+        required: true,
+      })
+    },
+    async run(context) {
+      return await docsCommon.writeToDocument(
+        context.propsValue.documentId,
+        context.propsValue.text,
+        await getAccessToken(context.auth)
+      );
+    },
+  });

package/src/lib/actions/create-document-based-on-template.action.ts

@@ -0,0 +1,102 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { googleDocsAuth, createGoogleClient } from '../auth';
+import { Property, createAction } from '@guayaba/workflows-framework';
+import { google } from 'googleapis';
+
+const PLACEHOLDER_FORMATS: Record<string, string> = {
+  'curly_braces': '{{KEY}}',
+  'square_brackets': '[[KEY]]',
+  'single_curly': '{KEY}',
+  'single_square': '[KEY]',
+  '{{KEY}}': '{{KEY}}',
+  '[[KEY]]': '[[KEY]]',
+  '{KEY}': '{KEY}',
+  '[KEY]': '[KEY]',
+};
+
+export const createDocumentBasedOnTemplate = createAction({
+  auth: googleDocsAuth,
+  name: 'create_document_based_on_template',
+  description:
+    'Edit a template file and replace the values with the ones provided',
+  displayName: 'Edit template file',
+  props: {
+    template: Property.ShortText({
+      displayName: 'Destination File',
+      description: 'The ID of the file to replace the values',
+      required: true,
+    }),
+    values: Property.Object({
+      displayName: 'Variables',
+      description: 'Dont include the placeholder format "[[]]" or "{{}}", only the key name and its value',
+      required: true,
+    }),
+    images: Property.Object({
+      displayName: 'Images',
+      description:
+        'Key: Image ID (get it manually from the Read File Action), Value: Image URL',
+      required: true,
+    }),
+    placeholder_format: Property.StaticDropdown({
+      displayName: 'Placeholder Format',
+      description: 'Choose the format of placeholders in your template',
+      required: true,
+      defaultValue: 'square_brackets',
+      options: {
+          disabled: false,
+          options: [
+              { label: 'Curly Braces {{}}', value: 'curly_braces' },
+              { label: 'Square Brackets [[]]', value: 'square_brackets' },
+              { label: 'Single Curly Braces {}', value: 'single_curly' },
+              { label: 'Single Square Brackets []', value: 'single_square' }
+          ],
+        },
+  }),
+  },
+  async run(context) {
+    const documentId: string = context.propsValue.template;
+    const values = context.propsValue.values;
+    const placeholderType = context.propsValue.placeholder_format;
+    const placeholder_format = PLACEHOLDER_FORMATS[placeholderType] || '[[KEY]]';
+
+    const authClient = await createGoogleClient(context.auth);
+    const docs = google.docs('v1');
+
+    const requests = [];
+
+    for (const key in values) {
+      const value = values[key];
+      const new_key = placeholder_format.replace('KEY', key);
+
+      requests.push({
+        replaceAllText: {
+          containsText: {
+            text: new_key,
+            matchCase: true,
+          },
+          replaceText: String(value),
+        },
+      });
+    }
+
+    for (const key in context.propsValue.images) {
+      const value = context.propsValue.images[key];
+      requests.push({
+        replaceImage: {
+          imageObjectId: key,
+          uri: String(value),
+        },
+      });
+    }
+
+    const res = await docs.documents.batchUpdate({
+      auth: authClient,
+      documentId,
+      requestBody: {
+        requests: requests,
+      },
+    });
+
+    return res;
+  },
+});

package/src/lib/actions/create-document.ts

@@ -0,0 +1,28 @@
+import { createAction } from '@guayaba/workflows-framework';
+import { docsCommon } from '../common';
+import { googleDocsAuth, getAccessToken } from '../auth';
+
+export const createDocument = createAction({
+  auth: googleDocsAuth,
+  name: 'create_document',
+  description: 'Create a document on Google Docs',
+  displayName: 'Create Document',
+  props: {
+    title: docsCommon.title,
+    body: docsCommon.body,
+  },
+  async run(context) {
+    const accessToken = await getAccessToken(context.auth);
+    const document = await docsCommon.createDocument(
+      context.propsValue.title,
+      accessToken
+    );
+    const response = await docsCommon.writeToDocument(
+      document.documentId,
+      context.propsValue.body,
+      accessToken
+    );
+
+    return response;
+  },
+});

package/src/lib/actions/find-document.ts

@@ -0,0 +1,126 @@
+import { googleDocsAuth, createGoogleClient } from '../auth';
+import {
+	createAction,
+	DynamicPropsValue,
+	Property,
+} from '@guayaba/workflows-framework';
+import { google } from 'googleapis';
+import { folderIdProp } from '../common/props';
+
+export const findDocumentAction = createAction({
+	auth: googleDocsAuth,
+	name: 'google-docs-find-document',
+	displayName: 'Find Document',
+	description: 'Search for document by name.',
+	props: {
+		name: Property.ShortText({
+			displayName: 'Document Name',
+			required: true,
+		}),
+		folderId: folderIdProp,
+		createIfNotFound: Property.Checkbox({
+			displayName: 'Create a new document if not found?',
+			defaultValue: false,
+			required: false,
+		}),
+		newDocumentProps: Property.DynamicProperties({
+			auth: googleDocsAuth,
+			displayName: 'New Document Properties',
+			required: false,
+			refreshers: ['createIfNotFound'],
+			props: async ({ auth, createIfNotFound }) => {
+				if (!auth) return {};
+				if (!createIfNotFound) return {};
+
+				const props: DynamicPropsValue = {};
+
+				if (createIfNotFound) {
+					props['content'] = Property.LongText({
+						displayName: 'Document Content',
+						required: true,
+					});
+				}
+
+				return props;
+			},
+		}),
+	},
+	async run(context) {
+		const { name: documentName, folderId, createIfNotFound, newDocumentProps } = context.propsValue;
+		const newDocumentContent = newDocumentProps?.['content'] as string;
+
+		const authClient = await createGoogleClient(context.auth);
+
+		const drive = google.drive({ version: 'v3', auth: authClient });
+		const docs = google.docs({ version: 'v1', auth: authClient });
+
+		// Search for the document in Google Drive
+		const query: string[] = [
+			`name contains '${documentName}'`,
+			`mimeType='application/vnd.google-apps.document'`,
+			'trashed=false',
+		];
+
+		if (folderId) query.push(`'${folderId}' in parents`);
+
+		const response = await drive.files.list({
+			q: query.join(' and '),
+			supportsAllDrives: true,
+			fields: '*',
+			pageSize: 1,
+			includeItemsFromAllDrives: true,
+		});
+
+		const existingFile = response.data.files?.[0];
+
+		if (existingFile) {
+			return { found: true, file: existingFile };
+		}
+
+		// Create a new document if not found
+		if (!createIfNotFound) return { found: false, file: {} };
+
+		//creating new Document
+		const createdDoc = await docs.documents.create({ requestBody: { title: documentName } });
+		const documentId = createdDoc.data.documentId;
+
+		if (!documentId) throw new Error('Failed to create document');
+
+		// Insert content into the new document
+		if (newDocumentContent) {
+			// appending text
+			await docs.documents.batchUpdate({
+				documentId,
+				requestBody: {
+					requests: [{ insertText: { text: newDocumentContent, endOfSegmentLocation: {} } }],
+				},
+			});
+		}
+
+		// Move the document to the specified folder
+		if (folderId) {
+			const fileData = await drive.files.get({
+				fileId: documentId,
+				supportsAllDrives: true,
+				fields: 'id, parents',
+			});
+
+			await drive.files.update({
+				fileId: documentId,
+				fields: 'id, name, parents',
+				removeParents: fileData.data.parents?.join(','),
+				addParents: folderId,
+				supportsAllDrives: true,
+			});
+		}
+
+		// Fetch document details
+		const finalFile = await drive.files.get({
+			fileId: documentId,
+			supportsAllDrives: true,
+			fields: '*',
+		});
+
+		return { found: false, file: finalFile.data };
+	},
+});

package/src/lib/actions/read-document.action.ts

@@ -0,0 +1,32 @@
+import { googleDocsAuth, createGoogleClient } from '../auth';
+import { Property, createAction } from '@guayaba/workflows-framework';
+import { google } from 'googleapis';
+
+export const readDocument = createAction({
+  displayName: 'Read Document',
+  auth: googleDocsAuth,
+  name: 'read_document',
+  description: 'Read a document from Google Docs',
+  props: {
+    documentId: Property.ShortText({
+      displayName: 'Document ID',
+      description: 'The ID of the document to read',
+      required: true,
+    }),
+  },
+  async run(context) {
+    const authClient = await createGoogleClient(context.auth);
+
+    const docs = google.docs({ version: 'v1', auth: authClient });
+    const response = await docs.documents.get({
+      documentId: context.propsValue.documentId,
+    });
+
+    if (response.status !== 200) {
+      console.error(response);
+      throw new Error('Error reading document');
+    }
+
+    return response.data;
+  },
+});