@pipedream/google_drive 0.7.3 → 0.8.1

package/actions/add-file-sharing-preference/add-file-sharing-preference.mjs

@@ -1,8 +1,11 @@
 import {
+  GOOGLE_DRIVE_FOLDER_MIME_TYPE,
   GOOGLE_DRIVE_GRANTEE_DOMAIN,
   GOOGLE_DRIVE_GRANTEE_GROUP,
   GOOGLE_DRIVE_GRANTEE_USER,
   GOOGLE_DRIVE_ROLE_OPTIONS,
+  GOOGLE_DRIVE_ROLE_OPTION_FILEORGANIZER,
+  GOOGLE_DRIVE_ROLE_WRITER,
 } from "../../common/constants.mjs";
 import googleDrive from "../../google_drive.app.mjs";
 
@@ -14,10 +17,10 @@ import googleDrive from "../../google_drive.app.mjs";
  */
 export default {
   key: "google_drive-add-file-sharing-preference",
-  name: "Share File",
+  name: "Share File or Folder",
   description:
     "Add a [sharing permission](https://support.google.com/drive/answer/7166529) to the sharing preferences of a file or folder and provide a sharing URL. [See the documentation](https://developers.google.com/drive/api/v3/reference/permissions/create)",
-  version: "0.1.5",
+  version: "0.1.6",
   type: "action",
   props: {
     googleDrive,
@@ -38,6 +41,7 @@ export default {
       ],
       optional: false,
       description: "The file or folder to share",
+      reloadProps: true,
     },
     type: {
       propDefinition: [
@@ -47,8 +51,17 @@ export default {
       reloadProps: true,
     },
   },
-  additionalProps() {
+  async additionalProps() {
     const obj = {};
+    const {
+      fileOrFolderId, type,
+    } = this;
+    if (!fileOrFolderId || !type) return obj;
+
+    const { mimeType } = await this.googleDrive.getFile(this.fileOrFolderId, {
+      fields: "mimeType",
+    });
+
     const emailAddress = {
       type: "string",
       label: "Email Address",
@@ -56,7 +69,7 @@ export default {
         "Enter the email address of the user that you'd like to share the file or folder with (e.g. `alex@altostrat.com`).",
     };
 
-    switch (this.type) {
+    switch (type) {
     case GOOGLE_DRIVE_GRANTEE_DOMAIN:
       obj.domain = {
         type: "string",
@@ -80,13 +93,22 @@ export default {
       break;
     }
 
+    const isFolder = mimeType === GOOGLE_DRIVE_FOLDER_MIME_TYPE;
+    const options = GOOGLE_DRIVE_ROLE_OPTIONS;
+
+    if (isFolder) {
+      const writerOpt = options.find(({ value }) => value === GOOGLE_DRIVE_ROLE_WRITER);
+      writerOpt.label = writerOpt.label.replace(/Writer/, "Contributor");
+      options.push(GOOGLE_DRIVE_ROLE_OPTION_FILEORGANIZER);
+    }
+
     return {
       ...obj,
       role: {
         type: "string",
         label: "Role",
         description: "The role granted by this permission",
-        options: GOOGLE_DRIVE_ROLE_OPTIONS,
+        options,
       },
     };
   },
@@ -107,9 +129,9 @@ export default {
     const webViewLink = resp.webViewLink;
     $.export(
       "$summary",
-      `Successfully shared file "${resp.name}" with ${this.type} "${
-        this.emailAddress ?? this.domain ?? ""
-      }"`,
+      `Successfully shared file "${resp.name}" with ${type} "${
+        emailAddress ?? domain ?? ""
+      }" with role '${role}'`,
     );
     return webViewLink;
   },

package/actions/copy-file/copy-file.mjs

@@ -3,8 +3,8 @@ import googleDrive from "../../google_drive.app.mjs";
 export default {
   key: "google_drive-copy-file",
   name: "Copy File",
-  description: "Create a copy of the specified file. [See the docs](https://developers.google.com/drive/api/v3/reference/files/copy) for more information",
-  version: "0.1.4",
+  description: "Create a copy of the specified file. [See the documentation](https://developers.google.com/drive/api/v3/reference/files/copy) for more information",
+  version: "0.1.5",
   type: "action",
   props: {
     googleDrive,

package/actions/create-file-from-template/create-file-from-template.mjs

@@ -8,7 +8,7 @@ export default {
   key: "google_drive-create-file-from-template",
   name: "Create New File From Template",
   description: "Create a new Google Docs file from a template. Optionally include placeholders in the template document that will get replaced from this action. [See documentation](https://www.npmjs.com/package/google-docs-mustaches)",
-  version: "0.1.4",
+  version: "0.1.5",
   type: "action",
   props: {
     googleDrive,
@@ -18,7 +18,7 @@ export default {
         "fileId",
       ],
       description:
-        "Select the template document you'd like to use as the template, or use a custom expression to reference a document ID from a previous step. Template documents should contain placeholders in the format {{xyz}}.",
+        "Select the template document you'd like to use as the template, or use a custom expression to reference a document ID from a previous step. Template documents should contain placeholders in the format `{{xyz}}`.",
     },
     folderId: {
       propDefinition: [
@@ -49,7 +49,7 @@ export default {
     replaceValues: {
       type: "object",
       label: "Replace text placeholders",
-      description: "Replace text placeholders in the document. Use the format {{xyz}} in the document but exclude the curly braces in the key. (eg. `{{myPlaceholder}}` in the document will be replaced by the value of the key `myPlaceholder` in the action.",
+      description: "Replace text placeholders in the document. Use the format `{{xyz}}` in the document but exclude the curly braces in the key. (eg. `{{myPlaceholder}}` in the document will be replaced by the value of the key `myPlaceholder` in the action.",
     },
   },
   async run({ $ }) {

package/actions/create-file-from-text/create-file-from-text.mjs

@@ -4,8 +4,8 @@ import { Readable } from "stream";
 export default {
   key: "google_drive-create-file-from-text",
   name: "Create New File From Text",
-  description: "Create a new file from plain text. [See the docs](https://developers.google.com/drive/api/v3/reference/files/create) for more information",
-  version: "0.1.4",
+  description: "Create a new file from plain text. [See the documentation](https://developers.google.com/drive/api/v3/reference/files/create) for more information",
+  version: "0.1.5",
   type: "action",
   props: {
     googleDrive,
@@ -33,6 +33,7 @@ export default {
         googleDrive,
         "fileName",
       ],
+      label: "File Name",
       description:
         "The name of the file you want to create (e.g., `myFile.txt`)",
     },

package/actions/create-folder/create-folder.mjs

@@ -12,8 +12,8 @@ import {
 export default {
   key: "google_drive-create-folder",
   name: "Create Folder",
-  description: "Create a new empty folder. [See the docs](https://developers.google.com/drive/api/v3/reference/files/create) for more information",
-  version: "0.1.4",
+  description: "Create a new empty folder. [See the documentation](https://developers.google.com/drive/api/v3/reference/files/create) for more information",
+  version: "0.1.5",
   type: "action",
   props: {
     googleDrive,
@@ -32,6 +32,7 @@ export default {
           drive: c.drive,
         }),
       ],
+      label: "Parent Folder",
       description: toSingleLineString(`
         Select a folder in which to place the new folder.
         If not specified, the folder will be placed directly in the drive's top-level folder.

package/actions/create-shared-drive/create-shared-drive.mjs

@@ -4,7 +4,7 @@ export default {
   key: "google_drive-create-shared-drive",
   name: "Create Shared Drive",
   description: "Create a new shared drive. [See the documentation](https://developers.google.com/drive/api/v3/reference/drives/create) for more information",
-  version: "0.1.5",
+  version: "0.1.6",
   type: "action",
   props: {
     googleDrive,
@@ -12,7 +12,6 @@ export default {
       type: "string",
       label: "Name",
       description: "The name of the new shared drive",
-      optional: true,
     },
   },
   async run({ $ }) {

package/actions/delete-file/delete-file.mjs

@@ -5,10 +5,15 @@ export default {
   name: "Delete File",
   description:
     "Permanently delete a file or folder without moving it to the trash. [See the documentation](https://developers.google.com/drive/api/v3/reference/files/delete) for more information",
-  version: "0.1.5",
+  version: "0.1.6",
   type: "action",
   props: {
     googleDrive,
+    infoAlert: {
+      type: "alert",
+      alertType: "warning",
+      content: "This action will **permanently** delete a file. If you want to move it to the trash instead, use the **[Move File to Trash](https://pipedream.com/apps/google-drive/actions/move-file-to-trash)** action.",
+    },
     drive: {
       propDefinition: [
         googleDrive,
@@ -28,10 +33,12 @@ export default {
     },
   },
   async run({ $ }) {
-    await this.googleDrive.deleteFile(this.fileId);
-    $.export("$summary", "Successfully deleted the file");
+    const { fileId } = this;
+    await this.googleDrive.deleteFile(fileId);
+    $.export("$summary", `Successfully deleted file (ID: ${fileId}`);
     return {
       success: true,
+      fileId,
     };
   },
 };

package/actions/delete-shared-drive/delete-shared-drive.mjs

@@ -3,28 +3,30 @@ import googleDrive from "../../google_drive.app.mjs";
 export default {
   key: "google_drive-delete-shared-drive",
   name: "Delete Shared Drive",
-  description: "Delete a shared drive without any content. [See the docs](https://developers.google.com/drive/api/v3/reference/drives/delete) for more information",
-  version: "0.1.4",
+  description: "Delete a shared drive without any content. [See the documentation](https://developers.google.com/drive/api/v3/reference/drives/delete) for more information",
+  version: "0.1.5",
   type: "action",
   props: {
     googleDrive,
     drive: {
       propDefinition: [
         googleDrive,
-        "watchedDrive",
+        "sharedDrive",
       ],
       description:
         "Select a [shared drive](https://support.google.com/a/users/answer/9310351) to delete.",
-      default: "",
+      optional: false,
     },
   },
   async run({ $ }) {
+    const { drive } = this;
     await this.googleDrive.deleteSharedDrive(
-      this.googleDrive.getDriveId(this.drive),
+      this.googleDrive.getDriveId(drive),
     );
     $.export("$summary", "Successfully deleted the shared drive");
     return {
       success: true,
+      drive,
     };
   },
 };

package/actions/download-file/download-file.mjs

@@ -17,8 +17,8 @@ import { toSingleLineString } from "../../common/utils.mjs";
 export default {
   key: "google_drive-download-file",
   name: "Download File",
-  description: "Download a file. [See the docs](https://developers.google.com/drive/api/v3/manage-downloads) for more information",
-  version: "0.1.4",
+  description: "Download a file. [See the documentation](https://developers.google.com/drive/api/v3/manage-downloads) for more information",
+  version: "0.1.5",
   type: "action",
   props: {
     googleDrive,
@@ -27,7 +27,6 @@ export default {
         googleDrive,
         "watchedDrive",
       ],
-
       optional: true,
     },
     fileId: {
@@ -44,7 +43,7 @@ export default {
       type: "string",
       label: "Destination File Path",
       description: toSingleLineString(`
-        The destination path for the file in the [\`/tmp\`
+        The destination file name or path [in the \`/tmp\`
         directory](https://pipedream.com/docs/workflows/steps/code/nodejs/working-with-files/#the-tmp-directory)
         (e.g., \`/tmp/myFile.csv\`)
       `),
@@ -113,8 +112,14 @@ export default {
 
     // Stream file to `filePath`
     const pipeline = promisify(stream.pipeline);
-    await pipeline(file, fs.createWriteStream(this.filePath));
+    const filePath = this.filePath.includes("tmp/")
+      ? this.filePath
+      : `/tmp/${this.filePath}`;
+    await pipeline(file, fs.createWriteStream(filePath));
     $.export("$summary", `Successfully downloaded the file, "${fileMetadata.name}"`);
-    return fileMetadata;
+    return  {
+      fileMetadata,
+      filePath,
+    };
   },
 };

package/actions/find-file/find-file.mjs

@@ -1,11 +1,12 @@
 import googleDrive from "../../google_drive.app.mjs";
 import { getListFilesOpts } from "../../common/utils.mjs";
+import commonSearchQuery from "../../common/commonSearchQuery.mjs";
 
 export default {
   key: "google_drive-find-file",
   name: "Find File",
-  description: "Search for a specific file by name. [See the docs](https://developers.google.com/drive/api/v3/search-files) for more information",
-  version: "0.1.4",
+  description: "Search for a specific file by name. [See the documentation](https://developers.google.com/drive/api/v3/search-files) for more information",
+  version: "0.1.5",
   type: "action",
   props: {
     googleDrive,
@@ -16,20 +17,17 @@ export default {
       ],
       optional: true,
     },
-    nameSearchTerm: {
-      propDefinition: [
-        googleDrive,
-        "fileNameSearchTerm",
-      ],
-    },
+    ...commonSearchQuery.props,
   },
+  methods: commonSearchQuery.methods,
   async run({ $ }) {
+    const q = this.getQuery();
     const opts = getListFilesOpts(this.drive, {
-      q: `name contains '${this.nameSearchTerm}'`,
+      q,
     });
     const files = (await this.googleDrive.listFilesInPage(null, opts)).files;
     // eslint-disable-next-line multiline-ternary
-    $.export("$summary", `Successfully found ${files.length} file${files.length === 1 ? "" : "s"} containing the term, "${this.nameSearchTerm}"`);
+    $.export("$summary", `Successfully found ${files.length} file${files.length === 1 ? "" : "s"} with the query "${q}"`);
     return files;
   },
 };

package/actions/find-folder/find-folder.mjs

@@ -6,8 +6,8 @@ import { GOOGLE_DRIVE_FOLDER_MIME_TYPE } from "../../common/constants.mjs";
 export default {
   key: "google_drive-find-folder",
   name: "Find Folder",
-  description: "Search for a specific folder by name. [See the docs](https://developers.google.com/drive/api/v3/search-files) for more information",
-  version: "0.1.4",
+  description: "Search for a specific folder by name. [See the documentation](https://developers.google.com/drive/api/v3/search-files) for more information",
+  version: "0.1.5",
   type: "action",
   props: {
     googleDrive,

package/actions/find-forms/find-forms.mjs

@@ -1,11 +1,12 @@
 import googleDrive from "../../google_drive.app.mjs";
 import { getListFilesOpts } from "../../common/utils.mjs";
+import commonSearchQuery from "../../common/commonSearchQuery.mjs";
 
 export default {
   key: "google_drive-find-forms",
   name: "Find Forms",
-  description: "List Google Form documents or search for a Form by name. [See the docs](https://developers.google.com/drive/api/v3/search-files) for more information",
-  version: "0.0.5",
+  description: "List Google Form documents or search for a Form by name. [See the documentation](https://developers.google.com/drive/api/v3/search-files) for more information",
+  version: "0.0.6",
   type: "action",
   props: {
     googleDrive,
@@ -28,27 +29,30 @@ export default {
       description: "The ID of the parent folder which contains the file. If not specified, it will list files from the drive's top-level folder.",
       optional: true,
     },
-    nameSearchTerm: {
-      propDefinition: [
-        googleDrive,
-        "fileNameSearchTerm",
-      ],
-      optional: true,
+    queryAlert: {
+      type: "alert",
+      alertType: "info",
+      content: "If no query or search name is specified, all forms in the selected drive/folder will be returned.",
+    },
+    ...commonSearchQuery.props,
+    searchQuery: {
+      ...commonSearchQuery.props.searchQuery,
+      description:
+        "Search for a file with a query. [See the documentation](https://developers.google.com/drive/api/guides/ref-search-terms) for more information. If specified, `Search Name` and `Parent Folder` will be ignored.",
     },
   },
+  methods: commonSearchQuery.methods,
   async run({ $ }) {
-    let q = "mimeType = 'application/vnd.google-apps.form'";
-    if (this.nameSearchTerm) {
-      q = `${q} and name contains '${this.nameSearchTerm}'`;
-    }
-    if (this.folderId) {
-      q = `${q} and "${this.folderId}" in parents`;
-    }
+    const q = this.getQuery("form", this.folderId);
     const opts = getListFilesOpts(this.drive, {
-      q: q.trim(),
+      q,
     });
     const files = (await this.googleDrive.listFilesInPage(null, opts)).files;
-    $.export("$summary", `Successfully found ${files.length} form(s)`);
-    return files;
+    $.export("$summary", `Successfully found ${files.length} form(s) with the query "${q}"`);
+    return files.map((file) => ({
+      ...file,
+      url: `https://docs.google.com/forms/d/${file.id}`,
+    }))
+    ;
   },
 };

package/actions/find-spreadsheets/find-spreadsheets.mjs

@@ -1,11 +1,12 @@
 import googleDrive from "../../google_drive.app.mjs";
 import { getListFilesOpts } from "../../common/utils.mjs";
+import commonSearchQuery from "../../common/commonSearchQuery.mjs";
 
 export default {
   key: "google_drive-find-spreadsheets",
   name: "Find Spreadsheets",
-  description: "Search for a specific spreadsheet by name. [See the docs](https://developers.google.com/drive/api/v3/search-files) for more information",
-  version: "0.1.4",
+  description: "Search for a specific spreadsheet by name. [See the documentation](https://developers.google.com/drive/api/v3/search-files) for more information",
+  version: "0.1.5",
   type: "action",
   props: {
     googleDrive,
@@ -28,27 +29,29 @@ export default {
       description: "The ID of the parent folder which contains the file. If not specified, it will list files from the drive's top-level folder.",
       optional: true,
     },
-    nameSearchTerm: {
-      propDefinition: [
-        googleDrive,
-        "fileNameSearchTerm",
-      ],
-      optional: true,
+    queryAlert: {
+      type: "alert",
+      alertType: "info",
+      content: "If no query or search name is specified, all spreadsheets in the selected drive/folder will be returned.",
+    },
+    ...commonSearchQuery.props,
+    searchQuery: {
+      ...commonSearchQuery.props.searchQuery,
+      description:
+        "Search for a file with a query. [See the documentation](https://developers.google.com/drive/api/guides/ref-search-terms) for more information. If specified, `Search Name` and `Parent Folder` will be ignored.",
     },
   },
+  methods: commonSearchQuery.methods,
   async run({ $ }) {
-    let q = "mimeType = 'application/vnd.google-apps.spreadsheet'";
-    if (this.nameSearchTerm) {
-      q = `${q} and name contains '${this.nameSearchTerm}'`;
-    }
-    if (this.folderId) {
-      q = `${q} and "${this.folderId}" in parents`;
-    }
+    const q = this.getQuery("spreadsheet", this.folderId);
     const opts = getListFilesOpts(this.drive, {
-      q: q.trim(),
+      q,
     });
     const files = (await this.googleDrive.listFilesInPage(null, opts)).files;
-    $.export("$summary", `Successfully found ${files.length} spreadsheet(s)`);
-    return files;
+    $.export("$summary", `Successfully found ${files.length} spreadsheet(s) with the query "${q}"`);
+    return files.map((file) => ({
+      ...file,
+      url: `https://docs.google.com/spreadsheets/d/${file.id}`,
+    }));
   },
 };

package/actions/get-file-by-id/get-file-by-id.mjs

@@ -5,7 +5,7 @@ export default {
   key: "google_drive-get-file-by-id",
   name: "Get File By ID",
   description: "Get info on a specific file. [See the documentation](https://developers.google.com/drive/api/reference/rest/v3/files/get) for more information",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
     googleDrive,

package/actions/get-folder-id-for-path/get-folder-id-for-path.mjs

@@ -12,7 +12,7 @@ export default {
   key: "google_drive-get-folder-id-for-path",
   name: "Get Folder ID for a Path",
   description: "Retrieve a folderId for a path. [See the documentation](https://developers.google.com/drive/api/v3/search-files) for more information",
-  version: "0.1.6",
+  version: "0.1.7",
   type: "action",
   props: {
     googleDrive,

package/actions/get-shared-drive/get-shared-drive.mjs

@@ -3,19 +3,16 @@ import googleDrive from "../../google_drive.app.mjs";
 export default {
   key: "google_drive-get-shared-drive",
   name: "Get Shared Drive",
-  description: "Get a shared drive's metadata by ID. [See the docs](https://developers.google.com/drive/api/v3/reference/drives/get) for more information",
-  version: "0.1.4",
+  description: "Get metadata for one or all shared drives. [See the documentation](https://developers.google.com/drive/api/v3/reference/drives/get) for more information",
+  version: "0.1.5",
   type: "action",
   props: {
     googleDrive,
     drive: {
       propDefinition: [
         googleDrive,
-        "watchedDrive",
+        "sharedDrive",
       ],
-      description:
-        "Select a [shared drive](https://support.google.com/a/users/answer/9310351).",
-      default: "",
     },
     useDomainAdminAccess: {
       propDefinition: [
@@ -26,12 +23,15 @@ export default {
   },
   async run({ $ }) {
     const resp = await this.googleDrive.getSharedDrive(
-      this.googleDrive.getDriveId(this.drive),
+      this.drive ?? null,
       {
         useDomainAdminAccess: this.useDomainAdminAccess,
       },
     );
-    $.export("$summary", `Successfully fetched the shared drive, "${resp.name}"`);
+    const summary = resp.drives
+      ? `${resp.drives.length} shared drives`
+      : `the shared drive "${resp.name}"`;
+    $.export("$summary", `Successfully fetched ${summary}`);
     return resp;
   },
 };

package/actions/list-files/list-files.mjs

@@ -5,7 +5,7 @@ export default {
   key: "google_drive-list-files",
   name: "List Files",
   description: "List files from a specific folder. [See the documentation](https://developers.google.com/drive/api/v3/reference/files/list) for more information",
-  version: "0.1.8",
+  version: "0.1.9",
   type: "action",
   props: {
     googleDrive,
@@ -31,7 +31,7 @@ export default {
     fields: {
       type: "string",
       label: "Fields",
-      description: "The paths of the fields you want included in the response. If not specified, the response includes a default set of fields specific to this method. For development you can use the special value `*` to return all fields, but you'll achieve greater performance by only selecting the fields you need.\n\n**eg:** `files(id,mimeType,name,webContentLink,webViewLink)`",
+      description: "The fields you want included in the response [(see the documentation for available fields)](https://developers.google.com/drive/api/reference/rest/v3/files). If not specified, the response includes a default set of fields specific to this method. For development you can use the special value `*` to return all fields, but you'll achieve greater performance by only selecting the fields you need.\n\n**eg:** `files(id,mimeType,name,webContentLink,webViewLink)`",
       optional: true,
     },
     filterText: {
@@ -44,7 +44,7 @@ export default {
     trashed: {
       label: "Trashed",
       type: "boolean",
-      description: "List trashed files or non-trashed files. Keep it empty to include both.",
+      description: "If `true`, list **only** trashed files. If `false`, list **only** non-trashed files. Keep it empty to include both.",
       optional: true,
     },
   },

package/actions/move-file/move-file.mjs

@@ -3,8 +3,8 @@ import googleDrive from "../../google_drive.app.mjs";
 export default {
   key: "google_drive-move-file",
   name: "Move File",
-  description: "Move a file from one folder to another. [See the docs](https://developers.google.com/drive/api/v3/reference/files/update) for more information",
-  version: "0.1.4",
+  description: "Move a file from one folder to another. [See the documentation](https://developers.google.com/drive/api/v3/reference/files/update) for more information",
+  version: "0.1.5",
   type: "action",
   props: {
     googleDrive,

package/actions/move-file-to-trash/move-file-to-trash.mjs

@@ -4,11 +4,16 @@ import { GOOGLE_DRIVE_FOLDER_MIME_TYPE } from "../../common/constants.mjs";
 export default {
   key: "google_drive-move-file-to-trash",
   name: "Move File to Trash",
-  description: "Move a file or folder to trash. [See the docs](https://developers.google.com/drive/api/v3/reference/files/update) for more information",
-  version: "0.1.4",
+  description: "Move a file or folder to trash. [See the documentation](https://developers.google.com/drive/api/v3/reference/files/update) for more information",
+  version: "0.1.5",
   type: "action",
   props: {
     googleDrive,
+    infoAlert: {
+      type: "alert",
+      alertType: "info",
+      content: "If you want to **permanently** delete a file instead, use the **[Move File to Trash](https://pipedream.com/apps/google-drive/actions/delete-file)** action.",
+    },
     drive: {
       propDefinition: [
         googleDrive,

package/actions/search-shared-drives/search-shared-drives.mjs

@@ -4,7 +4,7 @@ export default {
   key: "google_drive-search-shared-drives",
   name: "Search for Shared Drives",
   description: "Search for shared drives with query options. [See the documentation](https://developers.google.com/drive/api/v3/search-shareddrives) for more information",
-  version: "0.1.5",
+  version: "0.1.6",
   type: "action",
   props: {
     googleDrive,