@guayaba/workflow-piece-google-drive 0.7.5

package/src/i18n/zh.json

@@ -0,0 +1,136 @@
+{
+  "Cloud storage and file backup": "Cloud storage and file backup",
+  "Create new folder": "Create new folder",
+  "Create new file": "Create new file",
+  "Upload file": "Upload file",
+  "Read File Content": "Read File Content",
+  "Get File Information": "Get File Information",
+  "List files": "List files",
+  "Search": "Search",
+  "Duplicate File": "Duplicate File",
+  "Save Document as PDF": "Save Document as PDF",
+  "Update permissions": "Update permissions",
+  "Delete permissions": "Delete permissions",
+  "Set public access": "Set public access",
+  "Move File": "Move File",
+  "Delete file": "Delete file",
+  "Trash file": "Trash file",
+  "Custom API Call": "自定义 API 呼叫",
+  "Create a new empty folder in your Google Drive": "Create a new empty folder in your Google Drive",
+  "Create a new text file in your Google Drive from text": "Create a new text file in your Google Drive from text",
+  "Upload a file in your Google Drive": "Upload a file in your Google Drive",
+  "Read a selected file from google drive file": "Read a selected file from google drive file",
+  "Get a file folder for files/sub-folders": "Get a file folder for files/sub-folders",
+  "List files from a Google Drive folder": "List files from a Google Drive folder",
+  "Search a Google Drive folder for files/sub-folders": "Search a Google Drive folder for files/sub-folders",
+  "Duplicate a file from Google Drive. Returns the new file ID.": "Duplicate a file from Google Drive. Returns the new file ID.",
+  "Save a document as PDF in a Google Drive folder": "Save a document as PDF in a Google Drive folder",
+  "Update permissions for a file or folder": "Update permissions for a file or folder",
+  "Removes a role from an user for a file or folder": "Removes a role from an user for a file or folder",
+  "Set public access for a file or folder": "Set public access for a file or folder",
+  "Moves a file from one folder to another.": "Moves a file from one folder to another.",
+  "Delete permanently a file from your Google Drive": "Delete permanently a file from your Google Drive",
+  "Move a file to the trash in your Google Drive": "Move a file to the trash in your Google Drive",
+  "Make a custom API call to a specific endpoint": "将一个自定义 API 调用到一个特定的终点",
+  "Folder name": "Folder name",
+  "Parent Folder": "父文件夹",
+  "Include Team Drives": "Include Team Drives",
+  "File name": "File name",
+  "Text": "文本",
+  "Content type": "Content type",
+  "File": "文件",
+  "File ID": "File ID",
+  "Destination File name": "Destination File name",
+  "File / Folder Id": "File / Folder Id",
+  "Folder ID": "Folder ID",
+  "Include Trashed": "Include Trashed",
+  "Depth Level": "Depth Level",
+  "Download Files": "Download Files",
+  "Query Term": "Query Term",
+  "Operator": "运算符",
+  "Value": "值",
+  "File Type": "File Type",
+  "Name": "名称",
+  "Duplicate as": "Duplicate as",
+  "Document ID": "Document ID",
+  "File or Folder ID": "File or Folder ID",
+  "User email": "User email",
+  "Role": "作用",
+  "Send invitation email": "Send invitation email",
+  "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",
+  "The name of the new folder": "The name of the new folder",
+  "Determines if folders from Team Drives should be included in the results.": "Determines if folders from Team Drives should be included in the results.",
+  "The name of the new text file": "The name of the new text file",
+  "The text content to add to file": "The text content to add to file",
+  "Select file type": "Select file type",
+  "The name of the file": "The name of the file",
+  "The file URL or base64 to upload": "The file URL or base64 to upload",
+  "File ID coming from | New File -> id |": "File ID coming from | New File -> id |",
+  "The Id of the file/folder to search for.": "The Id of the file/folder to search for.",
+  "Folder ID coming from | New Folder -> id | (or any other source)": "Folder ID coming from | New Folder -> id | (or any other source)",
+  "Include new files that have been trashed.": "Include new files that have been trashed.",
+  "How many levels deep to search for files. 1 = current folder only, 2 = current + next level, etc.": "How many levels deep to search for files. 1 = current folder only, 2 = current + next level, etc.",
+  "Download all file contents in a list": "Download all file contents in a list",
+  "The Query term or field of file/folder to search upon.": "The Query term or field of file/folder to search upon.",
+  "The operator to create criteria.": "The operator to create criteria.",
+  "Value of the field of file/folder to search for.": "Value of the field of file/folder to search for.",
+  "(Optional) Choose between files and folders.": "(Optional) Choose between files and folders.",
+  "The ID of the file to duplicate": "The ID of the file to duplicate",
+  "The name of the new file": "The name of the new file",
+  "The ID of the folder where the file will be duplicated": "The ID of the folder where the file will be duplicated",
+  "If left unselected the file will be duplicated as it is": "If left unselected the file will be duplicated as it is",
+  "The ID of the document to export": "The ID of the document to export",
+  "The ID of the folder where the file will be exported": "The ID of the folder where the file will be exported",
+  "The name of the new file (do not include the extension)": "The name of the new file (do not include the extension)",
+  "The ID of the file or folder to update permissions for": "The ID of the file or folder to update permissions for",
+  "The email address of the user to update permissions for": "The email address of the user to update permissions for",
+  "The role to grant to user. See more at: https://developers.google.com/drive/api/guides/ref-roles": "The role to grant to user. See more at: https://developers.google.com/drive/api/guides/ref-roles",
+  "Send an email to the user to notify them of the new permissions": "Send an email to the user to notify them of the new permissions",
+  "The role to remove from user.": "The role to remove from user.",
+  "The role to assign for public access": "The role to assign for public access",
+  "You can use **Search Folder/File** action to retrieve ID.": "You can use **Search Folder/File** action to retrieve ID.",
+  "The ID of the file to delete": "The ID of the file to delete",
+  "The ID of the file to trash": "The ID of the file to trash",
+  "Authorization headers are injected automatically from your connection.": "授权头自动从您的连接中注入。",
+  "Enable for files like PDFs, images, etc.": "Enable for files like PDFs, images, etc.",
+  "CSV": "CSV",
+  "XML": "XML",
+  "Full text search": "Full text search",
+  "Contains": "Contains",
+  "Equals": "Equals",
+  "All": "所有的",
+  "Files": "Files",
+  "Folders": "文件夹",
+  "Google Sheets": "谷歌工作表",
+  "Google Docs": "Google Docs",
+  "Organizer": "Organizer",
+  "File Organizer": "File Organizer",
+  "Writer": "Writer",
+  "Commenter": "Commenter",
+  "Reader": "Reader",
+  "Editor": "编辑器",
+  "GET": "获取",
+  "POST": "帖子",
+  "PATCH": "PATCH",
+  "PUT": "弹出",
+  "DELETE": "删除",
+  "HEAD": "黑色",
+  "None": "无",
+  "JSON": "JSON",
+  "Form Data": "表单数据",
+  "Raw": "原始文件",
+  "New File": "New File",
+  "New Folder": "新建文件夹",
+  "Trigger when a new file is uploaded.": "Trigger when a new file is uploaded.",
+  "Trigger when a new folder is created or uploaded.": "Trigger when a new folder is created or uploaded.",
+  "Include File Content": "Include File Content",
+  "Include the file content in the output. This will increase the time taken to fetch the files and might cause issues with large files.": "Include the file content in the output. This will increase the time taken to fetch the files and might cause issues with large files."
+}

package/src/index.ts

@@ -0,0 +1,74 @@
+import {
+  createPiece,
+} from '@guayaba/workflows-framework';
+
+import { createCustomApiCallAction } from '@guayaba/workflows-common';
+import { PieceCategory } from '@guayaba/workflows-shared';
+import { addPermission } from './lib/action/add-permission.action';
+import { googleDriveCreateNewFolder } from './lib/action/create-new-folder';
+import { googleDriveCreateNewTextFile } from './lib/action/create-new-text-file';
+import { deletePermission } from './lib/action/delete-permission.action';
+import { duplicateFileAction } from './lib/action/duplicate-file.action';
+import { googleDriveGetResourceById } from './lib/action/get-file-by-id';
+import { googleDriveListFiles } from './lib/action/list-files.action';
+import { readFile } from './lib/action/read-file';
+import { saveFileAsPdf } from './lib/action/save-file-as-pdf.action';
+import { googleDriveSearchFolder } from './lib/action/search-folder-or-file.action';
+import { googleDriveUploadFile } from './lib/action/upload-file';
+import { newFile } from './lib/triggers/new-file';
+import { newFolder } from './lib/triggers/new-folder';
+import { setPublicAccess } from './lib/action/set-public-access';
+import { moveFileAction } from './lib/action/move-file';
+import { googleDriveDeleteFile } from './lib/action/delete-file';
+import { googleDriveTrashFile } from './lib/action/send-to-trash';
+import { googleDriveAuth, getAccessToken, GoogleDriveAuthValue } from './lib/auth';
+
+export { googleDriveAuth, getAccessToken, GoogleDriveAuthValue, createGoogleClient } from './lib/auth';
+
+export const googleDrive = createPiece({
+  minimumSupportedRelease: '0.5.6',
+  logoUrl: 'https://cdn.activepieces.com/pieces/google-drive.png',
+  categories: [PieceCategory.CONTENT_AND_FILES],
+  displayName: 'Google Drive',
+  description: 'Cloud storage and file backup',
+  authors: [
+    'BastienMe',
+    'ArmanGiau3',
+    'Vitalini',
+    'pfernandez98',
+    'kanarelo',
+    'Salem-Alaa',
+    'kishanprmr',
+    'MoShizzle',
+    'AbdulTheActivePiecer',
+    'khaledmashaly',
+    'abuaboud',
+    'geekyme'
+  ],
+  triggers: [newFile, newFolder],
+  actions: [
+    googleDriveCreateNewFolder,
+    googleDriveCreateNewTextFile,
+    googleDriveUploadFile,
+    readFile,
+    googleDriveGetResourceById,
+    googleDriveListFiles,
+    googleDriveSearchFolder,
+    duplicateFileAction,
+    saveFileAsPdf,
+    addPermission,
+    deletePermission,
+    setPublicAccess,
+    moveFileAction,
+    googleDriveDeleteFile,
+    googleDriveTrashFile,
+    createCustomApiCallAction({
+      baseUrl: () => 'https://www.googleapis.com/drive/v3',
+      auth: googleDriveAuth,
+      authMapping: async (auth) => ({
+        Authorization: `Bearer ${await getAccessToken(auth as GoogleDriveAuthValue)}`,
+      }),
+    }),
+  ],
+  auth: googleDriveAuth,
+});

package/src/lib/action/add-permission.action.ts

@@ -0,0 +1,78 @@
+import { Property, createAction } from "@guayaba/workflows-framework";
+import { googleDriveAuth, createGoogleClient } from '../auth';
+import { google } from 'googleapis';
+import { common } from "../common";
+
+export const addPermission = createAction({
+    auth: googleDriveAuth,
+    name: 'update_permissions',
+    description: 'Update permissions for a file or folder',
+    displayName: 'Update permissions',
+    props: {
+        fileId: Property.ShortText({
+            displayName: 'File or Folder ID',
+            description: 'The ID of the file or folder to update permissions for',
+            required: true,
+        }),
+        user_email: Property.ShortText({
+            displayName: 'User email',
+            description: 'The email address of the user to update permissions for',
+            required: true,
+        }),
+        permission_name : Property.StaticDropdown({
+            displayName: 'Role',
+            description: 'The role to grant to user. See more at: https://developers.google.com/drive/api/guides/ref-roles',
+            required: true,
+            options: {
+            options: [
+                {
+                    label: 'Organizer',
+                    value: 'organizer',
+                },
+                {
+                    label: 'File Organizer',
+                    value: 'fileOrganizer',
+                },
+                {
+                    label: 'Writer',
+                    value: 'writer',
+                },
+                {
+                    label: 'Commenter',
+                    value: 'commenter',
+                },
+                {
+                    label: 'Reader',
+                    value: 'reader',
+                },
+
+            ]
+            }
+        }),
+        include_team_drives: common.properties.include_team_drives,
+        send_invitation_email: Property.Checkbox({
+            displayName: 'Send invitation email',
+            description: 'Send an email to the user to notify them of the new permissions',
+            required: true,
+        }),
+       },
+
+    async run(context) {
+        const {fileId, user_email, permission_name, send_invitation_email,include_team_drives} = context.propsValue;
+
+        const authClient = await createGoogleClient(context.auth);
+
+        const drive = google.drive({ version: 'v3', auth: authClient });
+
+        const permission = { 'type': 'user', 'role': permission_name, 'emailAddress': user_email };
+
+        const result = await drive.permissions.create({
+            requestBody: permission,
+            fileId: fileId,
+            sendNotificationEmail: send_invitation_email,
+            supportsAllDrives: include_team_drives,
+        });
+
+        return result.data;
+    }
+});

package/src/lib/action/create-new-folder.ts

@@ -0,0 +1,38 @@
+import { createAction, Property } from '@guayaba/workflows-framework';
+import { googleDriveAuth, createGoogleClient } from '../auth';
+import { common } from '../common';
+import { google } from 'googleapis';
+
+export const googleDriveCreateNewFolder = createAction({
+  auth: googleDriveAuth,
+  name: 'create_new_gdrive_folder',
+  description: 'Create a new empty folder in your Google Drive',
+  displayName: 'Create new folder',
+  props: {
+    folderName: Property.ShortText({
+      displayName: 'Folder name',
+      description: 'The name of the new folder',
+      required: true,
+    }),
+    parentFolder: common.properties.parentFolder,
+    include_team_drives: common.properties.include_team_drives,
+  },
+  async run(context) {
+    const authClient = await createGoogleClient(context.auth);
+
+    const drive = google.drive({ version: 'v3', auth: authClient });
+
+    const response = await drive.files.create({
+      requestBody: {
+        mimeType: 'application/vnd.google-apps.folder',
+        name: context.propsValue.folderName,
+        ...(context.propsValue.parentFolder
+          ? { parents: [context.propsValue.parentFolder] }
+          : {}),
+      },
+      supportsAllDrives: context.propsValue.include_team_drives,
+    });
+
+    return response.data;
+  },
+});

package/src/lib/action/create-new-text-file.ts

@@ -0,0 +1,89 @@
+import { createAction, Property } from '@guayaba/workflows-framework';
+import {
+  httpClient,
+  HttpMethod,
+  AuthenticationType,
+} from '@guayaba/workflows-common';
+import FormData from 'form-data';
+import { googleDriveAuth, getAccessToken } from '../auth';
+import { common } from '../common';
+
+export const googleDriveCreateNewTextFile = createAction({
+  auth: googleDriveAuth,
+  name: 'create_new_gdrive_file',
+  description: 'Create a new text file in your Google Drive from text',
+  displayName: 'Create new file',
+  props: {
+    fileName: Property.ShortText({
+      displayName: 'File name',
+      description: 'The name of the new text file',
+      required: true,
+    }),
+    text: Property.LongText({
+      displayName: 'Text',
+      description: 'The text content to add to file',
+      required: true,
+    }),
+    fileType: Property.StaticDropdown({
+      displayName: 'Content type',
+      description: 'Select file type',
+      required: true,
+      defaultValue: 'plain/text',
+      options: {
+        options: [
+          {
+            label: 'Text',
+            value: 'plain/text',
+          },
+          {
+            label: 'CSV',
+            value: 'text/csv',
+          },
+          {
+            label: 'XML',
+            value: 'text/xml',
+          },
+        ],
+      },
+    }),
+    parentFolder: common.properties.parentFolder,
+    include_team_drives: common.properties.include_team_drives,
+  },
+  async run(context) {
+    const meta = {
+      mimeType: context.propsValue.fileType,
+      name: context.propsValue.fileName,
+      ...(context.propsValue.parentFolder
+        ? { parents: [context.propsValue.parentFolder] }
+        : {}),
+    };
+
+    const metaBuffer = Buffer.from(JSON.stringify(meta), 'utf-8');
+    const textBuffer = Buffer.from(context.propsValue.text!, 'utf-8');
+
+    const form = new FormData();
+    form.append('Metadata', metaBuffer, { contentType: 'application/json' });
+    form.append('Media', textBuffer, {
+      contentType: context.propsValue.fileType,
+    });
+
+    const result = await httpClient.sendRequest({
+      method: HttpMethod.POST,
+      url: `https://www.googleapis.com/upload/drive/v3/files?uploadType=multipart`,
+      body: form,
+      headers: {
+        ...form.getHeaders(),
+      },
+      queryParams: {
+        supportsAllDrives: String(context.propsValue.include_team_drives || false),
+      },
+      authentication: {
+        type: AuthenticationType.BEARER_TOKEN,
+        token: await getAccessToken(context.auth),
+      },
+    });
+
+    console.debug('File creation response', result);
+    return result.body;
+  },
+});

package/src/lib/action/delete-file.ts

@@ -0,0 +1,31 @@
+import { createAction, Property } from '@guayaba/workflows-framework';
+import { googleDriveAuth, createGoogleClient } from '../auth';
+import { common } from '../common';
+import { google } from 'googleapis';
+
+export const googleDriveDeleteFile = createAction({
+  auth: googleDriveAuth,
+  name: 'delete_gdrive_file',
+  description: 'Delete permanently a file from your Google Drive',
+  displayName: 'Delete file',
+  props: {
+    fileId: Property.ShortText({
+      displayName: 'File ID',
+      description: 'The ID of the file to delete',
+      required: true,
+    }),
+    include_team_drives: common.properties.include_team_drives,
+  },
+  async run(context) {
+    const authClient = await createGoogleClient(context.auth);
+
+    const drive = google.drive({ version: 'v3', auth: authClient });
+
+    const response = await drive.files.delete({
+      fileId: context.propsValue.fileId,
+      supportsAllDrives: context.propsValue.include_team_drives,
+    });
+
+    return response.data;
+  },
+});

package/src/lib/action/delete-permission.action.ts

@@ -0,0 +1,80 @@
+import { Property, createAction } from "@guayaba/workflows-framework";
+import { googleDriveAuth, createGoogleClient } from '../auth';
+import { google } from 'googleapis';
+
+export const deletePermission = createAction({
+    auth: googleDriveAuth,
+    name: 'delete_permissions',
+    description: 'Removes a role from an user for a file or folder',
+    displayName: 'Delete permissions',
+    props: {
+        fileId: Property.ShortText({
+            displayName: 'File or Folder ID',
+            description: 'The ID of the file or folder to update permissions for',
+            required: true,
+        }),
+        user_email: Property.ShortText({
+            displayName: 'User email',
+            description: 'The email address of the user to update permissions for',
+            required: true,
+        }),  
+        permission_name : Property.StaticDropdown({
+            displayName: 'Role',
+            description: 'The role to remove from user.',
+            required: true,
+            options: {
+            options: [
+                {
+                    label: 'Organizer',
+                    value: 'organizer',
+                },
+                {
+                    label: 'File Organizer',
+                    value: 'fileOrganizer',
+                },
+                {
+                    label: 'Writer',
+                    value: 'writer',
+                },
+                {
+                    label: 'Commenter',
+                    value: 'commenter',
+                },
+                {
+                    label: 'Reader',
+                    value: 'reader',
+                },
+                
+            ]
+            }
+        }),
+    },
+    async run (context) {
+        const [fileId, user_email] = [context.propsValue.fileId, context.propsValue.user_email];
+        const authClient = await createGoogleClient(context.auth);
+
+        const drive = google.drive({ version: 'v3', auth: authClient });
+        
+        const response_permissions_list = await drive.permissions.list({
+            fileId: fileId,
+            fields: 'permissions(id, emailAddress, role)',
+            
+        });
+
+        if (response_permissions_list.data.permissions) {
+
+            for (const permission of response_permissions_list.data.permissions) {
+                if (permission.emailAddress === user_email && permission.role === context.propsValue.permission_name) {
+                    await drive.permissions.delete({
+                        fileId: fileId,
+                        permissionId: permission.id ? permission.id : '',
+                    });
+                    return {removed: true, message: 'Permission removed'};
+                }
+            }
+        }
+
+        return {removed: false, message: 'Permission not found'};        
+
+    }
+});

package/src/lib/action/duplicate-file.action.ts

@@ -0,0 +1,78 @@
+import { Property, createAction } from '@guayaba/workflows-framework';
+import { google } from 'googleapis';
+import { googleDriveAuth, createGoogleClient } from '../auth';
+import { common } from '../common';
+
+export const duplicateFileAction = createAction({
+  displayName: 'Duplicate File',
+  auth: googleDriveAuth,
+  name: 'duplicate_file',
+  description: 'Duplicate a file from Google Drive. Returns the new file ID.',
+  props: {
+    fileId: Property.ShortText({
+      displayName: 'File ID',
+      description: 'The ID of the file to duplicate',
+      required: true,
+    }),
+    name: Property.ShortText({
+      displayName: 'Name',
+      description: 'The name of the new file',
+      required: true,
+    }),
+    folderId: Property.ShortText({
+      displayName: 'Folder ID',
+      description: 'The ID of the folder where the file will be duplicated',
+      required: true,
+    }),
+    mimeType: Property.StaticDropdown({
+      displayName: 'Duplicate as',
+      description: 'If left unselected the file will be duplicated as it is',
+      required: false,
+      options: {
+        options: [
+          {
+            label: 'Google Sheets',
+            value: 'application/vnd.google-apps.spreadsheet',
+          },
+          {
+            label: 'Google Docs',
+            value: 'application/vnd.google-apps.document',
+          }
+        ],
+      },
+    }),
+    include_team_drives: common.properties.include_team_drives,
+  },
+  async run(context) {
+    const authClient = await createGoogleClient(context.auth);
+
+    const fileId = context.propsValue.fileId;
+    const nameForNewFile = context.propsValue.name;
+    const parentFolderId = context.propsValue.folderId;
+    const mimeType = context.propsValue.mimeType;
+
+    const drive = google.drive({ version: 'v3', auth: authClient });
+
+    const requestBody: any = {
+      name: nameForNewFile,
+      parents: [parentFolderId],
+    };
+
+    if (mimeType) {
+      requestBody.mimeType = mimeType;
+    }
+
+    const response = await drive.files.copy({
+      fileId,
+      auth: authClient,
+      requestBody,
+      supportsAllDrives: context.propsValue.include_team_drives,
+    });
+
+    if (response.status !== 200) {
+      throw new Error('Error duplicating file');
+    }
+
+    return response.data;
+  },
+});

package/src/lib/action/get-file-by-id.ts

@@ -0,0 +1,34 @@
+import { googleDriveAuth, createGoogleClient } from '../auth';
+import { Property, createAction } from '@guayaba/workflows-framework';
+import { google } from 'googleapis';
+import { common } from '../common';
+
+export const googleDriveGetResourceById = createAction({
+  auth: googleDriveAuth,
+  name: 'get-file-or-folder-by-id',
+  displayName: 'Get File Information',
+  description: 'Get a file folder for files/sub-folders',
+  props: {
+    id: Property.ShortText({
+      displayName: 'File / Folder Id',
+      description: 'The Id of the file/folder to search for.',
+      required: true,
+    }),
+    include_team_drives: common.properties.include_team_drives,
+  },
+  async run(context) {
+    const authClient = await createGoogleClient(context.auth);
+    const drive = google.drive({ version: 'v3', auth: authClient });
+    const response = await drive.files.get({
+      fileId: context.propsValue.id,
+      supportsAllDrives: context.propsValue.include_team_drives,
+    });
+
+    if (response.data) {
+      return response.data;
+    } else {
+      console.log('The specified ID corresponds to a folder. Returning null.');
+      return null;
+    }
+  },
+});