@pipedream/google_drive 0.7.2 → 0.8.0

package/common/constants.mjs

@@ -163,14 +163,6 @@ const GOOGLE_DRIVE_ROLE_READER = "reader";
  * All of the available Google Drive roles granted by a permission as defined by the [Google
  * Drive API docs](https://developers.google.com/drive/api/v3/reference/permissions)
  */
-const GOOGLE_DRIVE_ROLES = [
-  GOOGLE_DRIVE_ROLE_OWNER,
-  GOOGLE_DRIVE_ROLE_ORGANIZER,
-  GOOGLE_DRIVE_ROLE_FILEORGANIZER,
-  GOOGLE_DRIVE_ROLE_WRITER,
-  GOOGLE_DRIVE_ROLE_COMMENTER,
-  GOOGLE_DRIVE_ROLE_READER,
-];
 
 const GOOGLE_DRIVE_ROLE_OPTIONS = [
   {
@@ -182,23 +174,20 @@ const GOOGLE_DRIVE_ROLE_OPTIONS = [
     value: GOOGLE_DRIVE_ROLE_COMMENTER,
   },
   {
-    label: "Reader - Can access, but can't change or share the file with others.",
+    label: "Viewer - Can access, but can't change or share the file with others.",
     value: GOOGLE_DRIVE_ROLE_READER,
   },
-  {
-    label: "(Advanced) File Owner - this will transfer ownership of the file.",
-    value: GOOGLE_DRIVE_ROLE_OWNER,
-  },
-  {
-    label: "(Advanced) File Organizar",
-    value: GOOGLE_DRIVE_ROLE_FILEORGANIZER,
-  },
-  {
-    label: "(Advanced) Organizar",
-    value: GOOGLE_DRIVE_ROLE_ORGANIZER,
-  },
 ];
 
+const GOOGLE_DRIVE_ROLE_OPTION_FILEORGANIZER = {
+  label: "(Advanced) Content Manager - add, edit, move, delete and share content",
+  value: GOOGLE_DRIVE_ROLE_FILEORGANIZER,
+};
+const GOOGLE_DRIVE_ROLE_OPTION_OWNER = {
+  label: "(Advanced) File Owner - this will transfer ownership of the file.",
+  value: GOOGLE_DRIVE_ROLE_OWNER,
+};
+
 const GOOGLE_DRIVE_GRANTEE_USER = "user";
 const GOOGLE_DRIVE_GRANTEE_GROUP = "group";
 const GOOGLE_DRIVE_GRANTEE_DOMAIN = "domain";
@@ -222,6 +211,20 @@ const GOOGLE_DRIVE_UPLOAD_TYPES = [
   GOOGLE_DRIVE_UPLOAD_TYPE_RESUMABLE,
   GOOGLE_DRIVE_UPLOAD_TYPE_MULTIPART,
 ];
+const GOOGLE_DRIVE_UPLOAD_TYPE_OPTIONS = [
+  {
+    label: "Simple upload. Upload the media only, without any metadata.",
+    value: GOOGLE_DRIVE_UPLOAD_TYPE_MEDIA,
+  },
+  {
+    label: "Resumable upload. Upload the file in a resumable fashion, using a series of at least two requests where the first request includes the metadata.",
+    value: GOOGLE_DRIVE_UPLOAD_TYPE_RESUMABLE,
+  },
+  {
+    label: "Multipart upload. Upload both the media and its metadata, in a single request.",
+    value: GOOGLE_DRIVE_UPLOAD_TYPE_MULTIPART,
+  },
+];
 
 export {
   GOOGLE_DRIVE_NOTIFICATION_SYNC,
@@ -241,6 +244,7 @@ export {
   GOOGLE_DRIVE_MIME_TYPE_PREFIX,
   GOOGLE_DRIVE_FOLDER_MIME_TYPE,
   GOOGLE_DRIVE_UPLOAD_TYPES,
+  GOOGLE_DRIVE_UPLOAD_TYPE_OPTIONS,
   // Google Drive Roles
   GOOGLE_DRIVE_ROLE_OWNER,
   GOOGLE_DRIVE_ROLE_ORGANIZER,
@@ -248,8 +252,9 @@ export {
   GOOGLE_DRIVE_ROLE_WRITER,
   GOOGLE_DRIVE_ROLE_COMMENTER,
   GOOGLE_DRIVE_ROLE_READER,
-  GOOGLE_DRIVE_ROLES,
   GOOGLE_DRIVE_ROLE_OPTIONS,
+  GOOGLE_DRIVE_ROLE_OPTION_FILEORGANIZER,
+  GOOGLE_DRIVE_ROLE_OPTION_OWNER,
   // Google Drive Grantee Types
   GOOGLE_DRIVE_GRANTEE_USER,
   GOOGLE_DRIVE_GRANTEE_GROUP,

package/google_drive.app.mjs

@@ -11,7 +11,7 @@ import {
   WEBHOOK_SUBSCRIPTION_EXPIRATION_TIME_MILLISECONDS,
   GOOGLE_DRIVE_FOLDER_MIME_TYPE,
   GOOGLE_DRIVE_GRANTEE_TYPES,
-  GOOGLE_DRIVE_UPLOAD_TYPES,
+  GOOGLE_DRIVE_UPLOAD_TYPE_OPTIONS,
   GOOGLE_DRIVE_UPDATE_TYPE_OPTIONS,
 } from "./common/constants.mjs";
 import googleMimeTypes from "./actions/google-mime-types.mjs";
@@ -40,6 +40,31 @@ export default {
         return this._listDriveOptions(nextPageToken);
       },
     },
+    sharedDrive: {
+      type: "string",
+      label: "Shared Drive",
+      description: "Select a [Shared Drive](https://support.google.com/a/users/answer/9310351) or leave blank to retrieve all available shared drives.",
+      optional: true,
+      async options({ prevContext }) {
+        const { nextPageToken } = prevContext;
+        return this._listDriveOptions(nextPageToken, false);
+      },
+    },
+    themeId: {
+      type: "string",
+      label: "Theme ID",
+      description: "The theme from which the background image and color will be set. Cannot be set if `Color` or `Background Image Link` are used.",
+      optional: true,
+      async options() {
+        const { driveThemes } = await this.getAbout("driveThemes");
+        return driveThemes?.map(({
+          id, colorRgb,
+        }) => ({
+          label: `${id} (${colorRgb})`,
+          value: id,
+        }));
+      },
+    },
     folderId: {
       type: "string",
       label: "Folder",
@@ -155,7 +180,13 @@ export default {
     fileNameSearchTerm: {
       type: "string",
       label: "Search Name",
-      description: "Enter the name of a file to search for.",
+      description: "Search for a file by name (equivalent to the query `name contains [value]`).",
+      optional: true,
+    },
+    searchQuery: {
+      type: "string",
+      label: "Search Query",
+      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` will be ignored.",
       optional: true,
     },
     mimeType: {
@@ -179,14 +210,8 @@ export default {
     uploadType: {
       type: "string",
       label: "Upload Type",
-      description: `The type of upload request to the /upload URI. If you are uploading data
-        (using an /upload URI), this field is required. If you are creating a metadata-only file,
-        this field is not required.
-        media - Simple upload. Upload the media only, without any metadata.
-        multipart - Multipart upload. Upload both the media and its metadata, in a single request.
-        resumable - Resumable upload. Upload the file in a resumable fashion, using a series of
-        at least two requests where the first request includes the metadata.`,
-      options: GOOGLE_DRIVE_UPLOAD_TYPES,
+      description: "The type of upload request to the /upload URI. Required if you are uploading data, but not if are creating a metadata-only file. [See the documentation](https://developers.google.com/drive/api/reference/rest/v2/files/update#path-parameters) for more information.",
+      options: GOOGLE_DRIVE_UPLOAD_TYPE_OPTIONS,
     },
     useDomainAdminAccess: {
       type: "boolean",
@@ -429,7 +454,7 @@ export default {
         pageToken = nextPageToken;
       }
     },
-    async _listDriveOptions(pageToken) {
+    async _listDriveOptions(pageToken, myDrive = true) {
       const {
         drives,
         nextPageToken,
@@ -440,14 +465,14 @@ export default {
       // only do this during the first page of options (i.e. when `pageToken` is
       // undefined).
       const options =
-        pageToken !== undefined
-          ? []
-          : [
+        myDrive && pageToken === undefined
+          ? [
             {
               label: "My Drive",
               value: MY_DRIVE_VALUE,
             },
-          ];
+          ]
+          : [];
       for (const d of drives) {
         options.push({
           label: d.name,
@@ -1239,7 +1264,7 @@ export default {
      */
     async createPermission(fileId, opts = {}) {
       const {
-        role = "reader",
+        role,
         type,
         domain,
         emailAddress,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/google_drive",
-  "version": "0.7.2",
+  "version": "0.8.0",
   "description": "Pipedream Google_drive Components",
   "main": "google_drive.app.mjs",
   "keywords": [

package/sources/changes-to-specific-files/changes-to-specific-files.mjs

@@ -2,9 +2,8 @@ import cronParser from "cron-parser";
 import sampleEmit from "./test-event.mjs";
 import includes from "lodash/includes.js";
 import { v4 as uuid } from "uuid";
-
-import changesToSpecificFiles from "../changes-to-specific-files-shared-drive/changes-to-specific-files-shared-drive.mjs";
 import { MY_DRIVE_VALUE } from "../../common/constants.mjs";
+import changesToSpecificFiles from "../changes-to-specific-files-shared-drive/changes-to-specific-files-shared-drive.mjs";
 
 /**
  * This source uses the Google Drive API's
@@ -16,7 +15,7 @@ export default {
   key: "google_drive-changes-to-specific-files",
   name: "Changes to Specific Files",
   description: "Watches for changes to specific files, emitting an event when a change is made to one of those files. To watch for changes to [shared drive](https://support.google.com/a/users/answer/9310351) files, use the **Changes to Specific Files (Shared Drive)** source instead.",
-  version: "0.2.0",
+  version: "0.2.1",
   type: "source",
   // Dedupe events based on the "x-goog-message-number" header for the target channel:
   // https://developers.google.com/drive/api/v3/push#making-watch-requests

package/sources/changes-to-specific-files-shared-drive/changes-to-specific-files-shared-drive.mjs

@@ -27,7 +27,7 @@ export default {
   key: "google_drive-changes-to-specific-files-shared-drive",
   name: "Changes to Specific Files (Shared Drive)",
   description: "Watches for changes to specific files in a shared drive, emitting an event when a change is made to one of those files",
-  version: "0.2.0",
+  version: "0.2.1",
   type: "source",
   // Dedupe events based on the "x-goog-message-number" header for the target channel:
   // https://developers.google.com/drive/api/v3/push#making-watch-requests

package/sources/new-files-instant/new-files-instant.mjs

@@ -10,7 +10,7 @@ export default {
   key: "google_drive-new-files-instant",
   name: "New Files (Instant)",
   description: "Emit new event when a new file is added in your linked Google Drive",
-  version: "0.1.7",
+  version: "0.1.8",
   type: "source",
   dedupe: "unique",
   props: {

package/sources/new-or-modified-comments/new-or-modified-comments.mjs

@@ -17,7 +17,7 @@ export default {
   name: "New or Modified Comments (Instant)",
   description:
     "Emit new event when a file comment is created or modified in the selected Drive",
-  version: "0.1.7",
+  version: "0.1.8",
   type: "source",
   // Dedupe events based on the "x-goog-message-number" header for the target channel:
   // https://developers.google.com/drive/api/v3/push#making-watch-requests

package/sources/new-or-modified-files/new-or-modified-files.mjs

@@ -24,7 +24,7 @@ export default {
   key: "google_drive-new-or-modified-files",
   name: "New or Modified Files (Instant)",
   description: "Emit new event when a file in the selected Drive is created, modified or trashed.",
-  version: "0.3.0",
+  version: "0.3.1",
   type: "source",
   // Dedupe events based on the "x-goog-message-number" header for the target channel:
   // https://developers.google.com/drive/api/v3/push#making-watch-requests

package/sources/new-or-modified-folders/new-or-modified-folders.mjs

@@ -20,7 +20,7 @@ export default {
   key: "google_drive-new-or-modified-folders",
   name: "New or Modified Folders (Instant)",
   description: "Emit new event when a folder is created or modified in the selected Drive",
-  version: "0.1.5",
+  version: "0.1.6",
   type: "source",
   // Dedupe events based on the "x-goog-message-number" header for the target channel:
   // https://developers.google.com/drive/api/v3/push#making-watch-requests

package/sources/new-shared-drive/new-shared-drive.mjs

@@ -5,7 +5,7 @@ export default {
   key: "google_drive-new-shared-drive",
   name: "New Shared Drive",
   description: "Emits a new event any time a shared drive is created.",
-  version: "0.1.4",
+  version: "0.1.5",
   type: "source",
   dedupe: "unique",
   props: {

package/sources/new-spreadsheet/new-spreadsheet.mjs

@@ -6,7 +6,7 @@ export default {
   type: "source",
   name: "New Spreadsheet (Instant)",
   description: "Emit new event when a new spreadsheet is created in a drive.",
-  version: "0.1.5",
+  version: "0.1.6",
   props: {
     googleDrive: newFilesInstant.props.googleDrive,
     db: newFilesInstant.props.db,

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

@@ -1,242 +0,0 @@
-import googleDrive from "../../google_drive.app.mjs";
-import fs from "fs";
-import got from "got@13.0.0";
-import { toSingleLineString } from "../../common/utils.mjs";
-
-export default {
-  key: "google_drive-create-file",
-  name: "Create a New File",
-  description: "Create a new file from a URL or /tmp/filepath. [See the docs](https://developers.google.com/drive/api/v3/reference/files/create) for more information",
-  version: "0.1.6",
-  type: "action",
-  props: {
-    googleDrive,
-    drive: {
-      propDefinition: [
-        googleDrive,
-        "watchedDrive",
-      ],
-    },
-    parent: {
-      propDefinition: [
-        googleDrive,
-        "folderId",
-        (c) => ({
-          drive: c.drive,
-        }),
-      ],
-      label: "Parent Folder",
-      description: toSingleLineString(`
-        The ID of the parent folder which contains the file. If not specified, the file will be
-        placed directly in the drive's top-level folder.
-    `),
-      optional: true,
-    },
-    uploadType: {
-      propDefinition: [
-        googleDrive,
-        "uploadType",
-      ],
-    },
-    fileUrl: {
-      propDefinition: [
-        googleDrive,
-        "fileUrl",
-      ],
-    },
-    filePath: {
-      propDefinition: [
-        googleDrive,
-        "filePath",
-      ],
-    },
-    ignoreDefaultVisibility: {
-      type: "boolean",
-      label: "Ignore Default Visibility",
-      description: toSingleLineString(`
-        Whether to ignore the domain's default visibility settings for the created
-        file. Domain administrators can choose to make all uploaded files visible to the domain
-        by default; this parameter bypasses that behavior for the request. Permissions are still
-        inherited from parent folders.
-      `),
-      default: false,
-    },
-    includePermissionsForView: {
-      type: "string",
-      label: "Include Permissions For View",
-      description: toSingleLineString(`
-        Specifies which additional view's permissions to include in the response. Only
-        'published' is supported.
-      `),
-      optional: true,
-      options: [
-        "published",
-      ],
-    },
-    keepRevisionForever: {
-      propDefinition: [
-        googleDrive,
-        "keepRevisionForever",
-      ],
-      default: false,
-    },
-    ocrLanguage: {
-      propDefinition: [
-        googleDrive,
-        "ocrLanguage",
-      ],
-    },
-    useContentAsIndexableText: {
-      propDefinition: [
-        googleDrive,
-        "useContentAsIndexableText",
-      ],
-      default: false,
-    },
-    supportsAllDrives: {
-      type: "boolean",
-      label: "Supports All Drives",
-      description: toSingleLineString(`
-        Whether to include shared drives. Set to 'true' if saving to a shared drive.
-        Defaults to 'false' if left blank.
-      `),
-      optional: true,
-    },
-    contentHintsIndexableText: {
-      type: "string",
-      label: "Content Hints Indexable Text",
-      description: toSingleLineString(`
-        Text to be indexed for the file to improve fullText queries. This is limited to 128KB in
-        length and may contain HTML elements.
-      `),
-      optional: true,
-    },
-    contentRestrictionsReadOnly: {
-      type: "boolean",
-      label: "Content Restrictions Read Only",
-      description: toSingleLineString(`
-        Whether the content of the file is read-only. If a file is read-only, a new revision of
-        the file may not be added, comments may not be added or modified, and the title of the file
-        may not be modified.
-      `),
-      optional: true,
-    },
-    contentRestrictionsReason: {
-      type: "string",
-      label: "Content Restrictions Reason",
-      description: toSingleLineString(`
-        Reason for why the content of the file is restricted. This is only mutable on requests
-        that also set readOnly=true.
-      `),
-      optional: true,
-    },
-    copyRequiresWriterPermission: {
-      type: "boolean",
-      label: "Copy Requires Writer Permission",
-      description: toSingleLineString(`
-        Whether the options to copy, print, or download this file, should be disabled for
-        readers and commentators
-      `),
-      optional: true,
-    },
-    description: {
-      type: "string",
-      label: "Description",
-      description: "A short description of the file",
-      optional: true,
-    },
-    folderColorRgb: {
-      type: "string",
-      label: "Folder Color RGB",
-      description: toSingleLineString(`
-        The color for a folder as an RGB hex string. If an unsupported color is specified,
-        the closest color in the palette will be used instead.
-      `),
-      optional: true,
-    },
-    mimeType: {
-      propDefinition: [
-        googleDrive,
-        "mimeType",
-      ],
-    },
-    name: {
-      propDefinition: [
-        googleDrive,
-        "fileName",
-      ],
-      description: "Name of the file",
-    },
-    originalFilename: {
-      type: "string",
-      label: "Original Filename",
-      description:
-        "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.",
-      optional: true,
-    },
-    shortcutDetailsTargetId: {
-      type: "string",
-      label: "Shortcut Details Target ID",
-      description: "The ID of the file that this shortcut points to",
-      optional: true,
-    },
-    starred: {
-      type: "boolean",
-      label: "Starred",
-      description: "Whether the user has starred the file",
-      optional: true,
-    },
-    writersCanShare: {
-      type: "boolean",
-      label: "Writers Can Share",
-      description:
-        "Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.",
-      optional: true,
-    },
-  },
-  async run({ $ }) {
-    const body = this.fileUrl
-      ? await got.stream(this.fileUrl)
-      : fs.createReadStream(this.filePath);
-    const driveId = this.googleDrive.getDriveId(this.drive);
-    const resp = await this.googleDrive.createFile({
-      ignoreDefaultVisibility: this.ignoreDefaultVisibility,
-      includePermissionsForView: this.includePermissionsForView,
-      keepRevisionForever: this.keepRevisionForever,
-      ocrLanguage: this.ocrLanguage,
-      useContentAsIndexableText: this.useContentAsIndexableText,
-      supportsAllDrives: this.supportsAllDrives,
-      resource: {
-        name: this.name,
-        originalFilename: this.originalFilename,
-        parents: [
-          this.parent ?? driveId,
-        ],
-        mimeType: this.mimeType,
-        description: this.description,
-        folderColorRgb: this.folderColorRgb,
-        shortcutDetails: {
-          targetId: this.shortcutDetailsTargetId,
-        },
-        starred: this.starred,
-        writersCanShare: this.writersCanShare,
-        contentHints: {
-          indexableText: this.contentHintsIndexableText,
-        },
-        contentRestrictions: {
-          readOnly: this.contentRestrictionsReadOnly,
-          reason: this.contentRestrictionsReason,
-        },
-        copyRequiresWriterPermission: this.copyRequiresWriterPermission,
-      },
-      media: {
-        mimeType: this.mimeType,
-        uploadType: this.uploadType,
-        body,
-      },
-      fields: "*",
-    });
-    $.export("$summary", `Successfully created a new file, "${resp.name}"`);
-    return resp;
-  },
-};

package/actions/replace-file/replace-file.mjs

@@ -1,134 +0,0 @@
-import path from "path";
-import googleDrive from "../../google_drive.app.mjs";
-import {
-  omitEmptyStringValues,
-  getFileStream,
-  streamToBuffer,
-  byteToMB,
-} from "../../common/utils.mjs";
-import {
-  GOOGLE_DRIVE_UPLOAD_TYPE_MEDIA,
-  GOOGLE_DRIVE_UPLOAD_TYPE_RESUMABLE,
-} from "../../common/constants.mjs";
-
-export default {
-  key: "google_drive-replace-file",
-  name: "Replace File",
-  description: "Upload a file that replaces an existing file. [See the docs](https://developers.google.com/drive/api/v3/reference/files/update) for more information",
-  version: "0.1.4",
-  type: "action",
-  props: {
-    googleDrive,
-    drive: {
-      propDefinition: [
-        googleDrive,
-        "watchedDrive",
-      ],
-      optional: true,
-    },
-    fileId: {
-      propDefinition: [
-        googleDrive,
-        "fileId",
-        (c) => ({
-          drive: c.drive,
-        }),
-      ],
-      optional: false,
-      description: "The file to update",
-    },
-    fileUrl: {
-      propDefinition: [
-        googleDrive,
-        "fileUrl",
-      ],
-    },
-    filePath: {
-      propDefinition: [
-        googleDrive,
-        "filePath",
-      ],
-    },
-    name: {
-      propDefinition: [
-        googleDrive,
-        "fileName",
-      ],
-      label: "Name",
-      description: "The name of the new file (e.g., `myFile.csv`)",
-    },
-    mimeType: {
-      propDefinition: [
-        googleDrive,
-        "mimeType",
-      ],
-      description: "The MIME type of the new file (e.g., `image/jpeg`)",
-    },
-    uploadType: {
-      propDefinition: [
-        googleDrive,
-        "uploadType",
-      ],
-      optional: true,
-    },
-  },
-  async run({ $ }) {
-    const {
-      fileId,
-      fileUrl,
-      filePath,
-      name,
-      mimeType,
-    } = this;
-    let { uploadType } = this;
-    if (!fileUrl && !filePath) {
-      throw new Error("One of File URL and File Path is required.");
-    }
-    const fileStream = await getFileStream({
-      $,
-      fileUrl,
-      filePath,
-    });
-
-    if (!uploadType || uploadType === "") {
-      try {
-        // Its necessary to get the file stream again, after user streamToBuffer function and pass
-        // the same object to updateFileMedia function, the function will throw an error about
-        // circular json structure.
-        // Deep clone is very slow in this case, so its better get the stream again
-        const fileBuffer = await streamToBuffer(await getFileStream({
-          $,
-          fileUrl,
-          filePath,
-        }));
-        const bufferSize = byteToMB(Buffer.byteLength(fileBuffer));
-        uploadType = bufferSize > 5
-          ? GOOGLE_DRIVE_UPLOAD_TYPE_RESUMABLE
-          : undefined;
-      } catch (err) {
-        console.log(err);
-        uploadType = undefined;
-      }
-    }
-
-    if (uploadType === GOOGLE_DRIVE_UPLOAD_TYPE_MEDIA) {
-      uploadType = undefined;
-    }
-    console.log(`Upload type: ${uploadType}`);
-    // Update file media separately from metadata to prevent multipart upload,
-    // which `google-apis-nodejs-client` doesn't seem to support for
-    // [files.update](https://bit.ly/3lP5sWn)
-    await this.googleDrive.updateFileMedia(fileId, fileStream, omitEmptyStringValues({
-      mimeType,
-      uploadType,
-    }));
-
-    const resp = await this.googleDrive.updateFile(fileId, omitEmptyStringValues({
-      name: name || path.basename(fileUrl || filePath),
-      mimeType,
-      uploadType,
-    }));
-    $.export("$summary", "Successfully replaced the file");
-    return resp;
-  },
-};