@pipedream/google_drive 0.7.2 → 0.8.0

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

@@ -0,0 +1,293 @@
+/* eslint-disable max-len */
+export const FILE_FIELD_OPTIONS = [
+  {
+    label:
+      "\"kind\" - Identifies what kind of resource this is. Value: the fixed string \"drive#file\".",
+    value: "kind",
+  },
+  {
+    label:
+      "\"driveId\" - ID of the shared drive the file resides in. Only populated for items in shared drives.",
+    value: "driveId",
+  },
+  {
+    label:
+      "\"fileExtension\" - The final component of fullFileExtension. This is only available for files with binary content in Google Drive.",
+    value: "fileExtension",
+  },
+  {
+    label:
+      "\"copyRequiresWriterPermission\" - Whether the options to copy, print, or download this file, should be disabled for readers and commenters.",
+    value: "copyRequiresWriterPermission",
+  },
+  {
+    label:
+      "\"md5Checksum\" - The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.",
+    value: "md5Checksum",
+  },
+  {
+    label:
+      "\"contentHints\" - Additional information about the content of the file. These fields are never populated in responses.",
+    value: "contentHints",
+  },
+  {
+    label:
+      "\"writersCanShare\" - Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.",
+    value: "writersCanShare",
+  },
+  {
+    label: "\"viewedByMe\" - Whether the file has been viewed by this user.",
+    value: "viewedByMe",
+  },
+  {
+    label:
+      "\"mimeType\" - The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided.",
+    value: "mimeType",
+  },
+  {
+    label:
+      "\"exportLinks\" - Links for exporting Docs Editors files to specific formats.",
+    value: "exportLinks",
+  },
+  {
+    label:
+      "\"parents\" - The IDs of the parent folders which contain the file.",
+    value: "parents",
+  },
+  {
+    label:
+      "\"thumbnailLink\" - A short-lived link to the file's thumbnail, if available.",
+    value: "thumbnailLink",
+  },
+  {
+    label: "\"iconLink\" - A static, unauthenticated link to the file's icon.",
+    value: "iconLink",
+  },
+  {
+    label:
+      "\"shared\" - Whether the file has been shared. Not populated for items in shared drives.",
+    value: "shared",
+  },
+  {
+    label: "\"lastModifyingUser\" - The last user to modify the file.",
+    value: "lastModifyingUser",
+  },
+  {
+    label:
+      "\"owners\" - The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.",
+    value: "owners",
+  },
+  {
+    label:
+      "\"headRevisionId\" - The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.",
+    value: "headRevisionId",
+  },
+  {
+    label:
+      "\"sharingUser\" - The user who shared the file with the requesting user, if applicable.",
+    value: "sharingUser",
+  },
+  {
+    label:
+      "\"webViewLink\" - A link for opening the file in a relevant Google editor or viewer in a browser.",
+    value: "webViewLink",
+  },
+  {
+    label:
+      "\"webContentLink\" - A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.",
+    value: "webContentLink",
+  },
+  {
+    label:
+      "\"size\" - Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders.",
+    value: "size",
+  },
+  {
+    label:
+      "\"permissions\" - The full list of permissions for the file. This is only available if the requesting user can share the file.",
+    value: "permissions",
+  },
+  {
+    label:
+      "\"hasThumbnail\" - Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail.",
+    value: "hasThumbnail",
+  },
+  {
+    label: "\"spaces\" - The list of spaces which contain the file.",
+    value: "spaces",
+  },
+  {
+    label:
+      "\"folderColorRgb\" - The color for a folder or a shortcut to a folder as an RGB hex string.",
+    value: "folderColorRgb",
+  },
+  {
+    label: "\"id\" - The ID of the file.",
+    value: "id",
+  },
+  {
+    label:
+      "\"name\" - The name of the file. This is not necessarily unique within a folder.",
+    value: "name",
+  },
+  {
+    label: "\"description\" - A short description of the file.",
+    value: "description",
+  },
+  {
+    label: "\"starred\" - Whether the user has starred the file.",
+    value: "starred",
+  },
+  {
+    label:
+      "\"trashed\" - Whether the file has been trashed, either explicitly or from a trashed parent folder.",
+    value: "trashed",
+  },
+  {
+    label:
+      "\"explicitlyTrashed\" - Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.",
+    value: "explicitlyTrashed",
+  },
+  {
+    label:
+      "\"createdTime\" - The time at which the file was created (RFC 3339 date-time).",
+    value: "createdTime",
+  },
+  {
+    label:
+      "\"modifiedTime\" - The last time the file was modified by anyone (RFC 3339 date-time).",
+    value: "modifiedTime",
+  },
+  {
+    label:
+      "\"modifiedByMeTime\" - The last time the file was modified by the user (RFC 3339 date-time).",
+    value: "modifiedByMeTime",
+  },
+  {
+    label:
+      "\"viewedByMeTime\" - The last time the file was viewed by the user (RFC 3339 date-time).",
+    value: "viewedByMeTime",
+  },
+  {
+    label:
+      "\"sharedWithMeTime\" - The time at which the file was shared with the user, if applicable (RFC 3339 date-time).",
+    value: "sharedWithMeTime",
+  },
+  {
+    label:
+      "\"quotaBytesUsed\" - The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.",
+    value: "quotaBytesUsed",
+  },
+  {
+    label:
+      "\"version\" - A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.",
+    value: "version",
+  },
+  {
+    label:
+      "\"originalFilename\" - The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.",
+    value: "originalFilename",
+  },
+  {
+    label:
+      "\"ownedByMe\" - Whether the user owns the file. Not populated for items in shared drives.",
+    value: "ownedByMe",
+  },
+  {
+    label:
+      "\"fullFileExtension\" - The full file extension extracted from the name field. May contain multiple concatenated extensions, such as \"tar.gz\". This is only available for files with binary content in Google Drive.",
+    value: "fullFileExtension",
+  },
+  {
+    label:
+      "\"properties\" - A collection of arbitrary key-value pairs which are visible to all apps.Entries with null values are cleared in update and copy requests.",
+    value: "properties",
+  },
+  {
+    label:
+      "\"appProperties\" - A collection of arbitrary key-value pairs which are private to the requesting app.",
+    value: "appProperties",
+  },
+  {
+    label:
+      "\"isAppAuthorized\" - Whether the file was created or opened by the requesting app.",
+    value: "isAppAuthorized",
+  },
+  {
+    label:
+      "\"capabilities\" - Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.",
+    value: "capabilities",
+  },
+  {
+    label:
+      "\"hasAugmentedPermissions\" - Whether there are permissions directly on this file. This field is only populated for items in shared drives.",
+    value: "hasAugmentedPermissions",
+  },
+  {
+    label:
+      "\"trashingUser\" - If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.",
+    value: "trashingUser",
+  },
+  {
+    label:
+      "\"thumbnailVersion\" - The thumbnail version for use in thumbnail cache invalidation.",
+    value: "thumbnailVersion",
+  },
+  {
+    label:
+      "\"trashedTime\" - The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.",
+    value: "trashedTime",
+  },
+  {
+    label: "\"modifiedByMe\" - Whether the file has been modified by this user.",
+    value: "modifiedByMe",
+  },
+  {
+    label:
+      "\"permissionIds\" - files.list of permission IDs for users with access to this file.",
+    value: "permissionIds",
+  },
+  {
+    label:
+      "\"imageMediaMetadata\" - Additional metadata about image media, if available.",
+    value: "imageMediaMetadata",
+  },
+  {
+    label:
+      "\"videoMediaMetadata\" - Additional metadata about video media. This may not be available immediately upon upload.",
+    value: "videoMediaMetadata",
+  },
+  {
+    label:
+      "\"shortcutDetails\" - Shortcut file details. Only populated for shortcut files.",
+    value: "shortcutDetails",
+  },
+  {
+    label:
+      "\"contentRestrictions\" - Restrictions for accessing the content of the file. Only populated if such a restriction exists.",
+    value: "contentRestrictions",
+  },
+  {
+    label: "\"resourceKey\" - A key needed to access the item via a shared link.",
+    value: "resourceKey",
+  },
+  {
+    label:
+      "\"linkShareMetadata\" - LinkShare related details. Contains details about the link URLs that clients are using to refer to this item.",
+    value: "linkShareMetadata",
+  },
+  {
+    label: "\"labelInfo\" - An overview of the labels on the file.",
+    value: "labelInfo",
+  },
+  {
+    label:
+      "\"sha1Checksum\" - The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive.",
+    value: "sha1Checksum",
+  },
+  {
+    label:
+      "\"sha256Checksum\" - The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive.",
+    value: "sha256Checksum",
+  },
+];

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

@@ -0,0 +1,56 @@
+import googleDrive from "../../google_drive.app.mjs";
+import { FILE_FIELD_OPTIONS } from "./common-file-fields.mjs";
+
+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.2",
+  type: "action",
+  props: {
+    googleDrive,
+    drive: {
+      propDefinition: [
+        googleDrive,
+        "watchedDrive",
+      ],
+      optional: true,
+    },
+    fileIdTip: {
+      type: "alert",
+      alertType: "info",
+      content: "You can use actions such as **Find File** or **List Files** to obtain a file ID, and use its value here.",
+    },
+    fileId: {
+      propDefinition: [
+        googleDrive,
+        "fileId",
+        (c) => ({
+          drive: c.drive,
+        }),
+      ],
+      description: "The file to obtain info for. You can select a file or use a file ID from a previous step.",
+    },
+    fields: {
+      type: "string[]",
+      label: "Fields",
+      description: "Customize the fields to obtain for the file. [See the documentation](https://developers.google.com/drive/api/reference/rest/v3/files) for more information.",
+      optional: true,
+      options: FILE_FIELD_OPTIONS,
+    },
+  },
+  async run({ $ }) {
+    const {
+      googleDrive, fileId, fields,
+    } = this;
+    const strFields = typeof fields === "string"
+      ? fields
+      : fields?.join();
+    const response = await googleDrive.getFile(fileId, {
+      fields: strFields,
+    });
+
+    $.export("$summary", "Successfully fetched file info");
+    return response;
+  },
+};

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,

package/actions/update-file/update-file.mjs

@@ -7,17 +7,21 @@ import {
 export default {
   key: "google_drive-update-file",
   name: "Update File",
-  description: "Update a file's metadata and/or content. [See the docs](https://developers.google.com/drive/api/v3/reference/files/update) for more information",
-  version: "0.1.4",
+  description: "Update a file's metadata and/or content. [See the documentation](https://developers.google.com/drive/api/v3/reference/files/update) for more information",
+  version: "0.1.5",
   type: "action",
   props: {
     googleDrive,
+    requiredPropsAlert: {
+      type: "alert",
+      alertType: "info",
+      content: "Either `File URL` and `File Path` should be specified.",
+    },
     drive: {
       propDefinition: [
         googleDrive,
         "watchedDrive",
       ],
-
       optional: true,
     },
     fileId: {
@@ -104,12 +108,10 @@ export default {
     },
     advanced: {
       type: "object",
-      label: "Advanced Options",
+      label: "Additional Options",
       optional: true,
       description: toSingleLineString(`
-        Specify less-common properties that you want to use. See [Files: update]
-        (https://developers.google.com/drive/api/v3/reference/files/update#request-body) for a list
-        of supported properties.
+        Any additional parameters to pass in the request. [See the documentation](https://developers.google.com/drive/api/v3/reference/files/update#request-body) for all available parameters.
       `),
     },
   },

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

@@ -3,8 +3,8 @@ import googleDrive from "../../google_drive.app.mjs";
 export default {
   key: "google_drive-update-shared-drive",
   name: "Update Shared Drive",
-  description: "Update an existing shared drive. [See the docs](https://developers.google.com/drive/api/v3/reference/drives/update) for more information",
-  version: "0.1.4",
+  description: "Update an existing shared drive. [See the documentation](https://developers.google.com/drive/api/v3/reference/drives/update) for more information",
+  version: "0.1.5",
   type: "action",
   props: {
     googleDrive,
@@ -16,6 +16,7 @@ export default {
       description:
         "Select a [shared drive](https://support.google.com/a/users/answer/9310351) to update",
       default: "",
+      optional: false,
     },
     useDomainAdminAccess: {
       propDefinition: [
@@ -23,25 +24,24 @@ export default {
         "useDomainAdminAccess",
       ],
     },
+    themeId: {
+      propDefinition: [
+        googleDrive,
+        "themeId",
+      ],
+    },
     backgroundImageLink: {
       type: "string",
       label: "Background Image Link",
       description:
-        "A link to the new background image for the shared drive. Cannot be set if `Theme ID` is set in the same request.",
+        "A link to the new background image for the shared drive. Cannot be set if `Theme ID` is used (it already sets the background image).",
       optional: true,
     },
     colorRgb: {
       type: "string",
       label: "Color",
       description:
-        "The new color of this shared drive as an RGB hex string. Cannot be set if `Theme ID` is set in the same request.",
-      optional: true,
-    },
-    themeId: {
-      type: "string",
-      label: "Theme ID",
-      description:
-        "The ID of the theme from which the background image and color will be set. Cannot be set if `Color` or `Background Image Link` is set in the same request.",
+        "The new color of this shared drive as an RGB hex string. Cannot be set if `Theme ID` is used (it already sets the color).",
       optional: true,
     },
     restrictions: {

package/actions/upload-file/upload-file.mjs

@@ -5,15 +5,21 @@ import {
   omitEmptyStringValues,
 } from "../../common/utils.mjs";
 import { GOOGLE_DRIVE_UPLOAD_TYPE_MULTIPART } from "../../common/constants.mjs";
+import { ConfigurationError } from "@pipedream/platform";
 
 export default {
   key: "google_drive-upload-file",
   name: "Upload File",
-  description: "Copy an existing file to Google Drive. [See the docs](https://developers.google.com/drive/api/v3/manage-uploads) for more information",
-  version: "0.1.6",
+  description: "Upload a file to Google Drive. [See the documentation](https://developers.google.com/drive/api/v3/manage-uploads) for more information",
+  version: "0.1.7",
   type: "action",
   props: {
     googleDrive,
+    infoAlert: {
+      type: "alert",
+      alertType: "info",
+      content: "Either `File URL` and `File Path` should be specified.",
+    },
     drive: {
       propDefinition: [
         googleDrive,
@@ -89,7 +95,7 @@ export default {
     } = this;
     let { uploadType } = this;
     if (!fileUrl && !filePath) {
-      throw new Error("One of File URL and File Path is required.");
+      throw new ConfigurationError("Either `File URL` and `File Path` should be specified.");
     }
     const driveId = this.googleDrive.getDriveId(this.drive);
 
@@ -98,7 +104,9 @@ export default {
     const file = await getFileStream({
       $,
       fileUrl,
-      filePath,
+      filePath: filePath.includes("tmp/")
+        ? filePath
+        : `/tmp/${filePath}`,
     });
     console.log(`Upload type: ${uploadType}.`);
 

package/common/commonSearchQuery.mjs

@@ -0,0 +1,48 @@
+import { ConfigurationError } from "@pipedream/platform";
+import googleDrive from "../google_drive.app.mjs";
+
+export default {
+  methods: {
+    getQuery(type, folderId) {
+      const {
+        searchQuery, nameSearchTerm,
+      } = this;
+      if (!searchQuery && !nameSearchTerm && !type) {
+        throw new ConfigurationError("You must specify a search query or name.");
+      }
+      let q = type
+        ? `mimeType = 'application/vnd.google-apps.${type}'`
+        : "";
+      if (searchQuery) {
+        q = (!q || searchQuery.includes(q))
+          ? searchQuery
+          : `${q} and ${searchQuery}`;
+      } else {
+        if (nameSearchTerm) {
+          const nameQuery = `name contains '${nameSearchTerm}'`;
+          q = q
+            ? `${q} and ${nameQuery}`
+            : nameQuery;
+        }
+        if (folderId) {
+          q = `${q} and "${folderId}" in parents`;
+        }
+      }
+      return q.trim();
+    },
+  },
+  props: {
+    nameSearchTerm: {
+      propDefinition: [
+        googleDrive,
+        "fileNameSearchTerm",
+      ],
+    },
+    searchQuery: {
+      propDefinition: [
+        googleDrive,
+        "searchQuery",
+      ],
+    },
+  },
+};