@pipedream/google_drive 0.6.19 → 0.7.1

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

@@ -1,3 +1,9 @@
+import {
+  GOOGLE_DRIVE_GRANTEE_DOMAIN,
+  GOOGLE_DRIVE_GRANTEE_GROUP,
+  GOOGLE_DRIVE_GRANTEE_USER,
+  GOOGLE_DRIVE_ROLE_OPTIONS,
+} from "../../common/constants.mjs";
 import googleDrive from "../../google_drive.app.mjs";
 
 /**
@@ -8,10 +14,10 @@ import googleDrive from "../../google_drive.app.mjs";
  */
 export default {
   key: "google_drive-add-file-sharing-preference",
-  name: "Add File Sharing Preference",
+  name: "Share File",
   description:
-    "Add a [sharing](https://support.google.com/drive/answer/7166529) permission to the sharing preferences of a file or folder and provide a sharing URL. [See the docs](https://developers.google.com/drive/api/v3/reference/permissions/create) for more information",
-  version: "0.1.4",
+    "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",
   type: "action",
   props: {
     googleDrive,
@@ -33,38 +39,60 @@ export default {
       optional: false,
       description: "The file or folder to share",
     },
-    role: {
-      propDefinition: [
-        googleDrive,
-        "role",
-      ],
-    },
     type: {
       propDefinition: [
         googleDrive,
         "type",
       ],
+      reloadProps: true,
     },
-    domain: {
-      propDefinition: [
-        googleDrive,
-        "domain",
-      ],
-    },
-    emailAddress: {
-      propDefinition: [
-        googleDrive,
-        "emailAddress",
-      ],
-    },
+  },
+  additionalProps() {
+    const obj = {};
+    const emailAddress = {
+      type: "string",
+      label: "Email Address",
+      description:
+        "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) {
+    case GOOGLE_DRIVE_GRANTEE_DOMAIN:
+      obj.domain = {
+        type: "string",
+        label: "Domain",
+        description:
+            "Enter the domain of the G Suite organization that you'd like to share the file or folder with (e.g. `altostrat.com`). All G Suite organization users under this domain will have access to the file you share.",
+      };
+      break;
+    case GOOGLE_DRIVE_GRANTEE_GROUP:
+      obj.emailAddress = {
+        ...emailAddress,
+        description:
+            "Enter the email address of the group that you'd like to share the file or folder with (e.g. `hiking-club@altostrat.com`)",
+      };
+      break;
+    case GOOGLE_DRIVE_GRANTEE_USER:
+      obj.emailAddress = emailAddress;
+      break;
+
+    default:
+      break;
+    }
+
+    return {
+      ...obj,
+      role: {
+        type: "string",
+        label: "Role",
+        description: "The role granted by this permission",
+        options: GOOGLE_DRIVE_ROLE_OPTIONS,
+      },
+    };
   },
   async run({ $ }) {
     const {
-      fileOrFolderId,
-      role,
-      type,
-      domain,
-      emailAddress,
+      fileOrFolderId, role, type, domain, emailAddress,
     } = this;
     // Create the permission for the file
     await this.googleDrive.createPermission(fileOrFolderId, {
@@ -77,7 +105,12 @@ export default {
     // Get the file to get the `webViewLink` sharing URL
     const resp = await this.googleDrive.getFile(this.fileOrFolderId);
     const webViewLink = resp.webViewLink;
-    $.export("$summary", `Successfully added a sharing permission to the file, "${resp.name}"`);
+    $.export(
+      "$summary",
+      `Successfully shared file "${resp.name}" with ${this.type} "${
+        this.emailAddress ?? this.domain ?? ""
+      }"`,
+    );
     return webViewLink;
   },
 };

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

@@ -4,7 +4,7 @@ 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.3",
+  version: "0.1.4",
   type: "action",
   props: {
     googleDrive,

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

@@ -7,7 +7,7 @@ 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.5",
+  version: "0.1.6",
   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.3",
+  version: "0.1.4",
   type: "action",
   props: {
     googleDrive,

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

@@ -5,7 +5,7 @@ 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.3",
+  version: "0.1.4",
   type: "action",
   props: {
     googleDrive,

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

@@ -7,13 +7,13 @@ import {
 import {
   MY_DRIVE_VALUE,
   GOOGLE_DRIVE_FOLDER_MIME_TYPE,
-} from "../../constants.mjs";
+} from "../../common/constants.mjs";
 
 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.3",
+  version: "0.1.4",
   type: "action",
   props: {
     googleDrive,

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

@@ -3,8 +3,8 @@ import googleDrive from "../../google_drive.app.mjs";
 export default {
   key: "google_drive-create-shared-drive",
   name: "Create Shared Drive",
-  description: "Create a new shared drive. [See the docs](https://developers.google.com/drive/api/v3/reference/drives/create) for more information",
-  version: "0.1.3",
+  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",
   type: "action",
   props: {
     googleDrive,

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

@@ -4,8 +4,8 @@ export default {
   key: "google_drive-delete-file",
   name: "Delete File",
   description:
-    "Permanently delete a file or folder without moving it to the trash. [See the docs](https://developers.google.com/drive/api/v3/reference/files/delete) for more information",
-  version: "0.1.3",
+    "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",
   type: "action",
   props: {
     googleDrive,

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

@@ -4,7 +4,7 @@ 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.3",
+  version: "0.1.4",
   type: "action",
   props: {
     googleDrive,

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

@@ -2,7 +2,7 @@ import googleDrive from "../../google_drive.app.mjs";
 import fs from "fs";
 import stream from "stream";
 import { promisify } from "util";
-import { GOOGLE_DRIVE_MIME_TYPE_PREFIX } from "../../constants.mjs";
+import { GOOGLE_DRIVE_MIME_TYPE_PREFIX } from "../../common/constants.mjs";
 import googleWorkspaceExportFormats from "../google-workspace-export-formats.mjs";
 import { toSingleLineString } from "../../common/utils.mjs";
 
@@ -18,7 +18,7 @@ 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.3",
+  version: "0.1.4",
   type: "action",
   props: {
     googleDrive,

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

@@ -5,7 +5,7 @@ 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.3",
+  version: "0.1.4",
   type: "action",
   props: {
     googleDrive,

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

@@ -1,13 +1,13 @@
 import googleDrive from "../../google_drive.app.mjs";
 import { getListFilesOpts } from "../../common/utils.mjs";
 
-import { GOOGLE_DRIVE_FOLDER_MIME_TYPE } from "../../constants.mjs";
+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.3",
+  version: "0.1.4",
   type: "action",
   props: {
     googleDrive,

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

@@ -5,7 +5,7 @@ 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.4",
+  version: "0.0.5",
   type: "action",
   props: {
     googleDrive,

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

@@ -5,7 +5,7 @@ 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.3",
+  version: "0.1.4",
   type: "action",
   props: {
     googleDrive,

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

@@ -11,8 +11,8 @@ import googleDrive from "../../google_drive.app.mjs";
 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 docs](https://developers.google.com/drive/api/v3/search-files) for more information",
-  version: "0.1.3",
+  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.5",
   type: "action",
   props: {
     googleDrive,

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

@@ -4,7 +4,7 @@ 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.3",
+  version: "0.1.4",
   type: "action",
   props: {
     googleDrive,

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.7",
+  version: "0.1.8",
   type: "action",
   props: {
     googleDrive,

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

@@ -4,7 +4,7 @@ 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.3",
+  version: "0.1.4",
   type: "action",
   props: {
     googleDrive,

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

@@ -1,11 +1,11 @@
 import googleDrive from "../../google_drive.app.mjs";
-import { GOOGLE_DRIVE_FOLDER_MIME_TYPE } from "../../constants.mjs";
+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.3",
+  version: "0.1.4",
   type: "action",
   props: {
     googleDrive,

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

@@ -9,13 +9,13 @@ import {
 import {
   GOOGLE_DRIVE_UPLOAD_TYPE_MEDIA,
   GOOGLE_DRIVE_UPLOAD_TYPE_RESUMABLE,
-} from "../../constants.mjs";
+} 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.3",
+  version: "0.1.4",
   type: "action",
   props: {
     googleDrive,

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

@@ -3,8 +3,8 @@ import googleDrive from "../../google_drive.app.mjs";
 export default {
   key: "google_drive-search-shared-drives",
   name: "Search for Shared Drives",
-  description: "Search for shared drives with query options. [See the docs](https://developers.google.com/drive/api/v3/search-shareddrives) for more information",
-  version: "0.1.3",
+  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",
   type: "action",
   props: {
     googleDrive,

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

@@ -8,7 +8,7 @@ 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.3",
+  version: "0.1.4",
   type: "action",
   props: {
     googleDrive,

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

@@ -4,7 +4,7 @@ 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.3",
+  version: "0.1.4",
   type: "action",
   props: {
     googleDrive,

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

@@ -4,13 +4,13 @@ import {
   getFileStream,
   omitEmptyStringValues,
 } from "../../common/utils.mjs";
-import { GOOGLE_DRIVE_UPLOAD_TYPE_MULTIPART } from "../../constants.mjs";
+import { GOOGLE_DRIVE_UPLOAD_TYPE_MULTIPART } from "../../common/constants.mjs";
 
 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.5",
+  version: "0.1.6",
   type: "action",
   props: {
     googleDrive,

package/{constants.mjs → common/constants.mjs}

@@ -66,6 +66,36 @@ const GOOGLE_DRIVE_UPDATE_TYPES = [
   GOOGLE_DRIVE_NOTIFICATION_UNTRASH,
   GOOGLE_DRIVE_NOTIFICATION_CHANGE,
 ];
+const GOOGLE_DRIVE_UPDATE_TYPE_OPTIONS = [
+  {
+    label: `'${GOOGLE_DRIVE_NOTIFICATION_SYNC}' - A channel was successfully created. You can expect to start receiving notifications for it.`,
+    value: GOOGLE_DRIVE_NOTIFICATION_SYNC,
+  },
+  {
+    label: `'${GOOGLE_DRIVE_NOTIFICATION_ADD}' - A resource was created or shared.`,
+    value: GOOGLE_DRIVE_NOTIFICATION_ADD,
+  },
+  {
+    label: `'${GOOGLE_DRIVE_NOTIFICATION_REMOVE}' - An existing resource was deleted or unshared.`,
+    value: GOOGLE_DRIVE_NOTIFICATION_REMOVE,
+  },
+  {
+    label: `'${GOOGLE_DRIVE_NOTIFICATION_UPDATE}' - One or more properties (metadata) of a resource have been updated.`,
+    value: GOOGLE_DRIVE_NOTIFICATION_UPDATE,
+  },
+  {
+    label: `'${GOOGLE_DRIVE_NOTIFICATION_TRASH}' - A resource has been moved to the trash.`,
+    value: GOOGLE_DRIVE_NOTIFICATION_TRASH,
+  },
+  {
+    label: `'${GOOGLE_DRIVE_NOTIFICATION_UNTRASH}' - A resource has been removed from the trash.`,
+    value: GOOGLE_DRIVE_NOTIFICATION_UNTRASH,
+  },
+  {
+    label: `'${GOOGLE_DRIVE_NOTIFICATION_CHANGE}' - One or more changelog items have been added.`,
+    value: GOOGLE_DRIVE_NOTIFICATION_CHANGE,
+  },
+];
 
 /**
  * This is a custom string value to represent the 'My Drive' Google Drive, which
@@ -142,6 +172,33 @@ const GOOGLE_DRIVE_ROLES = [
   GOOGLE_DRIVE_ROLE_READER,
 ];
 
+const GOOGLE_DRIVE_ROLE_OPTIONS = [
+  {
+    label: "Writer - Can make changes, accept or reject suggestions, and share the file with others.",
+    value: GOOGLE_DRIVE_ROLE_WRITER,
+  },
+  {
+    label: "Commenter - Can make comments and suggestions, but can't change or share the file with others.",
+    value: GOOGLE_DRIVE_ROLE_COMMENTER,
+  },
+  {
+    label: "Reader - 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_GRANTEE_USER = "user";
 const GOOGLE_DRIVE_GRANTEE_GROUP = "group";
 const GOOGLE_DRIVE_GRANTEE_DOMAIN = "domain";
@@ -175,6 +232,7 @@ export {
   GOOGLE_DRIVE_NOTIFICATION_UNTRASH,
   GOOGLE_DRIVE_NOTIFICATION_CHANGE,
   GOOGLE_DRIVE_UPDATE_TYPES,
+  GOOGLE_DRIVE_UPDATE_TYPE_OPTIONS,
   MY_DRIVE_VALUE,
   LEGACY_MY_DRIVE_VALUE,
   WEBHOOK_SUBSCRIPTION_EXPIRATION_TIME_MILLISECONDS,
@@ -191,6 +249,7 @@ export {
   GOOGLE_DRIVE_ROLE_COMMENTER,
   GOOGLE_DRIVE_ROLE_READER,
   GOOGLE_DRIVE_ROLES,
+  GOOGLE_DRIVE_ROLE_OPTIONS,
   // Google Drive Grantee Types
   GOOGLE_DRIVE_GRANTEE_USER,
   GOOGLE_DRIVE_GRANTEE_GROUP,

package/common/utils.mjs

@@ -4,7 +4,7 @@ import {
   MY_DRIVE_VALUE,
   LEGACY_MY_DRIVE_VALUE,
   MAX_FILE_OPTION_PATH_SEGMENTS,
-} from "../constants.mjs";
+} from "../common/constants.mjs";
 
 /**
  * Returns whether the specified drive ID corresponds to the authenticated

package/google_drive.app.mjs

@@ -10,12 +10,10 @@ import {
   MY_DRIVE_VALUE,
   WEBHOOK_SUBSCRIPTION_EXPIRATION_TIME_MILLISECONDS,
   GOOGLE_DRIVE_FOLDER_MIME_TYPE,
-  GOOGLE_DRIVE_ROLES,
   GOOGLE_DRIVE_GRANTEE_TYPES,
-  GOOGLE_DRIVE_GRANTEE_ANYONE,
-  GOOGLE_DRIVE_ROLE_READER,
   GOOGLE_DRIVE_UPLOAD_TYPES,
-} from "./constants.mjs";
+  GOOGLE_DRIVE_UPDATE_TYPE_OPTIONS,
+} from "./common/constants.mjs";
 import googleMimeTypes from "./actions/google-mime-types.mjs";
 
 import {
@@ -117,16 +115,15 @@ export default {
       type: "string[]",
       label: "Types of updates",
       description: `The types of updates you want to watch for on these files.
-        [See Google's docs]
-        (https://developers.google.com/drive/api/v3/push#understanding-drive-api-notification-events).`,
+        [See Google's docs](https://developers.google.com/drive/api/v3/push#understanding-drive-api-notification-events).`,
       default: GOOGLE_DRIVE_UPDATE_TYPES,
-      options: GOOGLE_DRIVE_UPDATE_TYPES,
+      options: GOOGLE_DRIVE_UPDATE_TYPE_OPTIONS,
     },
     watchForPropertiesChanges: {
       type: "boolean",
       label: "Watch for changes to file properties",
-      description: `Watch for changes to [file properties](https://developers.google.com/drive/api/v3/properties)
-        in addition to changes to content. **Defaults to \`false\`, watching for only changes to content**.`,
+      description: `Watch for changes to [custom file properties](https://developers.google.com/drive/api/v3/properties)
+        in addition to changes to content. **Defaults to \`false\`, watching only for changes to content**.`,
       optional: true,
       default: false,
     },
@@ -198,37 +195,13 @@ export default {
       optional: true,
       default: false,
     },
-    role: {
-      type: "string",
-      label: "Role",
-      description: "The role granted by this permission",
-      optional: true,
-      default: GOOGLE_DRIVE_ROLE_READER,
-      options: GOOGLE_DRIVE_ROLES,
-    },
     type: {
       type: "string",
       label: "Type",
       description:
-        "The type of the grantee. If **Type** is `user` or `group`, you must provide an **Email Address** for the user or group. When **Type** is `domain`, you must provide a `Domain`. Sharing with a domain is only valid for G Suite users.",
-      optional: true,
-      default: GOOGLE_DRIVE_GRANTEE_ANYONE,
+        "The type of the grantee. Sharing with a domain is only valid for G Suite users.",
       options: GOOGLE_DRIVE_GRANTEE_TYPES,
     },
-    domain: {
-      type: "string",
-      label: "Domain",
-      description:
-        "The domain of the G Suite organization to which this permission refers if **Type** is `domain` (e.g., `yourcomapany.com`)",
-      optional: true,
-    },
-    emailAddress: {
-      type: "string",
-      label: "Email Address",
-      description:
-        "The email address of the user or group to which this permission refers if **Type** is `user` or `group`",
-      optional: true,
-    },
     ocrLanguage: {
       type: "string",
       label: "OCR Language",

package/package.json

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

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

@@ -3,9 +3,8 @@ import sampleEmit from "./test-event.mjs";
 import includes from "lodash/includes.js";
 import { v4 as uuid } from "uuid";
 
-import { MY_DRIVE_VALUE } from "../../constants.mjs";
-
 import changesToSpecificFiles from "../changes-to-specific-files-shared-drive/changes-to-specific-files-shared-drive.mjs";
+import { MY_DRIVE_VALUE } from "../../common/constants.mjs";
 
 /**
  * This source uses the Google Drive API's
@@ -16,8 +15,8 @@ export default {
   ...changesToSpecificFiles,
   key: "google_drive-changes-to-specific-files",
   name: "Changes to Specific Files",
-  description: "Watches for changes to specific files, emitting an event any time 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.1.5",
+  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",
   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
@@ -222,7 +221,14 @@ export default {
       return;
     }
 
-    this.processChange(file, headers);
+    const [
+      checkedFile,
+    ] = this.checkMinimumInterval([
+      file,
+    ]);
+    if (checkedFile) {
+      this.processChange(file, headers);
+    }
   },
   sampleEmit,
 };

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

@@ -14,7 +14,8 @@ import {
   GOOGLE_DRIVE_NOTIFICATION_CHANGE,
   GOOGLE_DRIVE_NOTIFICATION_ADD,
   GOOGLE_DRIVE_NOTIFICATION_UPDATE,
-} from "../../constants.mjs";
+} from "../../common/constants.mjs";
+import commonDedupeChanges from "../common-dedupe-changes.mjs";
 
 /**
  * This source uses the Google Drive API's
@@ -25,8 +26,8 @@ export default {
   ...common,
   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 any time a change is made to one of those files",
-  version: "0.1.5",
+  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",
   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
@@ -37,13 +38,12 @@ export default {
       type: "string[]",
       label: "Files",
       description: "The files you want to watch for changes.",
-      optional: true,
-      default: [],
       options({ prevContext }) {
         const { nextPageToken } = prevContext;
         return this.googleDrive.listFilesOptions(nextPageToken, this.getListFilesOpts());
       },
     },
+    ...commonDedupeChanges.props,
   },
   hooks: {
     async deploy() {
@@ -54,6 +54,7 @@ export default {
       const args = this.getListFilesOpts({
         q: `mimeType != "application/vnd.google-apps.folder" and modifiedTime > "${timeString}" and trashed = false`,
         fields: "files",
+        pageSize: 5,
       });
 
       const { files } = await this.googleDrive.listFilesInPage(null, args);
@@ -96,7 +97,9 @@ export default {
     },
     getChanges(headers) {
       if (!headers) {
-        return;
+        return {
+          change: { },
+        };
       }
       return {
         change: {
@@ -119,7 +122,9 @@ export default {
       console.log(`Processing ${changedFiles.length} changed files`);
       console.log(`Changed files: ${JSON.stringify(changedFiles, null, 2)}!!!`);
       console.log(`Files: ${this.files}!!!`);
-      for (const file of changedFiles) {
+
+      const filteredFiles = this.checkMinimumInterval(changedFiles);
+      for (const file of filteredFiles) {
         if (!this.isFileRelevant(file)) {
           console.log(`Skipping event for irrelevant file ${file.id}`);
           continue;

package/sources/common-dedupe-changes.mjs

@@ -0,0 +1,53 @@
+export default {
+  props: {
+    intervalAlert: {
+      type: "alert",
+      alertType: "info",
+      content: `This source can emit many events in quick succession while a file is being edited. By default, it will not emit another event for the same file for at least 1 minute.
+\\
+You can change or disable this minimum interval using the prop \`Minimum Interval Per File\`.`,
+    },
+    perFileInterval: {
+      type: "integer",
+      label: "Minimum Interval Per File",
+      description: "How many minutes to wait until the same file can emit another event.\n\nIf set to `0`, this interval is disabled and all events will be emitted.",
+      min: 0,
+      max: 60,
+      default: 1,
+      optional: true,
+    },
+  },
+  methods: {
+    _getFileIntervals() {
+      return this.db.get("fileIntervals") ?? {};
+    },
+    _setFileIntervals(value) {
+      this.db.set("fileIntervals", value);
+    },
+    checkMinimumInterval(files) {
+      const interval = this.perFileInterval;
+      if (!interval) return files;
+
+      const now = Date.now();
+      const minTimestamp = now - (interval * 1000 * 60);
+
+      const savedData = this._getFileIntervals();
+      Object.entries(savedData).forEach(([
+        key,
+        value,
+      ]) => {
+        if (value < minTimestamp) delete savedData[key];
+      });
+
+      const filteredFiles = files.filter(({ id }) => {
+        const exists = !!savedData[id];
+        if (!exists) {
+          savedData[id] = now;
+        }
+        return !exists;
+      });
+      this._setFileIntervals(savedData);
+      return filteredFiles;
+    },
+  },
+};

package/sources/common-webhook.mjs

@@ -2,8 +2,9 @@ import includes from "lodash/includes.js";
 import { v4 as uuid } from "uuid";
 
 import googleDrive from "../google_drive.app.mjs";
-import { WEBHOOK_SUBSCRIPTION_RENEWAL_SECONDS } from "../constants.mjs";
+import { WEBHOOK_SUBSCRIPTION_RENEWAL_SECONDS } from "../common/constants.mjs";
 import { getListFilesOpts } from "../common/utils.mjs";
+import commonDedupeChanges from "./common-dedupe-changes.mjs";
 
 export default {
   props: {
@@ -18,12 +19,6 @@ export default {
       description: "Defaults to My Drive. To select a [Shared Drive](https://support.google.com/a/users/answer/9310351) instead, select it from this list.",
       optional: false,
     },
-    watchForPropertiesChanges: {
-      propDefinition: [
-        googleDrive,
-        "watchForPropertiesChanges",
-      ],
-    },
     timer: {
       label: "Push notification renewal schedule",
       description:
@@ -73,6 +68,7 @@ export default {
     },
   },
   methods: {
+    ...commonDedupeChanges.methods,
     _getSubscription() {
       return this.db.get("subscription");
     },

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

@@ -3,14 +3,14 @@ import sampleEmit from "./test-event.mjs";
 import {
   GOOGLE_DRIVE_NOTIFICATION_ADD,
   GOOGLE_DRIVE_NOTIFICATION_CHANGE,
-} from "../../constants.mjs";
+} from "../../common/constants.mjs";
 
 export default {
   ...common,
   key: "google_drive-new-files-instant",
   name: "New Files (Instant)",
-  description: "Emit new event any time a new file is added in your linked Google Drive",
-  version: "0.1.6",
+  description: "Emit new event when a new file is added in your linked Google Drive",
+  version: "0.1.7",
   type: "source",
   dedupe: "unique",
   props: {
@@ -19,7 +19,7 @@ export default {
       type: "string[]",
       label: "Folders",
       description:
-        "(Optional) The folders you want to watch for changes. Leave blank to watch for any new file in the Drive.",
+        "(Optional) The folders you want to watch. Leave blank to watch for any new file in the Drive.",
       optional: true,
       default: [],
       options({ prevContext }) {
@@ -50,7 +50,7 @@ export default {
         q: `mimeType != "application/vnd.google-apps.folder" and createdTime > "${timeString}" and trashed = false`,
         orderBy: "createdTime desc",
         fields: "*",
-        pageSize: 25,
+        pageSize: 5,
       });
 
       const { files } = await this.googleDrive.listFilesInPage(null, args);

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

@@ -9,15 +9,15 @@
 // 2) A timer that runs on regular intervals, renewing the notification channel as needed
 
 import common from "../common-webhook.mjs";
-import { GOOGLE_DRIVE_NOTIFICATION_CHANGE } from "../../constants.mjs";
+import { GOOGLE_DRIVE_NOTIFICATION_CHANGE } from "../../common/constants.mjs";
 
 export default {
   ...common,
   key: "google_drive-new-or-modified-comments",
-  name: "New or Modified Comments",
+  name: "New or Modified Comments (Instant)",
   description:
-    "Emits a new event any time a file comment is added, modified, or deleted in your linked Google Drive",
-  version: "0.1.6",
+    "Emit new event when a file comment is created or modified in the selected Drive",
+  version: "0.1.7",
   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
@@ -31,6 +31,7 @@ export default {
       const args = this.getListFilesOpts({
         q: `mimeType != "application/vnd.google-apps.folder" and modifiedTime > "${timeString}" and trashed = false`,
         fields: "files",
+        pageSize: 5,
       });
 
       const { files } = await this.googleDrive.listFilesInPage(null, args);
@@ -82,7 +83,9 @@ export default {
     },
     getChanges(headers) {
       if (!headers) {
-        return;
+        return {
+          change: { },
+        };
       }
       return {
         change: {

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

@@ -14,14 +14,17 @@ import {
   GOOGLE_DRIVE_NOTIFICATION_ADD,
   GOOGLE_DRIVE_NOTIFICATION_CHANGE,
   GOOGLE_DRIVE_NOTIFICATION_UPDATE,
-} from "../../constants.mjs";
+} from "../../common/constants.mjs";
+import commonDedupeChanges from "../common-dedupe-changes.mjs";
+
+const { googleDrive } = common.props;
 
 export default {
   ...common,
   key: "google_drive-new-or-modified-files",
-  name: "New or Modified Files",
-  description: "Emit new event any time any file in your linked Google Drive is added, modified, or deleted",
-  version: "0.2.2",
+  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",
   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
@@ -30,9 +33,9 @@ export default {
     ...common.props,
     folders: {
       type: "string[]",
-      label: "Folders",
+      label: "Folder(s)",
       description:
-        "(Optional) The folders you want to watch for changes. Leave blank to watch for any new file in the Drive.",
+        "The folder(s) to watch for changes. Leave blank to watch for any new or modified file in the Drive.",
       optional: true,
       default: [],
       options({ prevContext }) {
@@ -52,6 +55,13 @@ export default {
         return this.googleDrive.listFilesOptions(nextPageToken, opts);
       },
     },
+    watchForPropertiesChanges: {
+      propDefinition: [
+        googleDrive,
+        "watchForPropertiesChanges",
+      ],
+    },
+    ...commonDedupeChanges.props,
   },
   hooks: {
     async deploy() {
@@ -62,6 +72,7 @@ export default {
       const args = this.getListFilesOpts({
         q: `mimeType != "application/vnd.google-apps.folder" and modifiedTime > "${timeString}" and trashed = false`,
         fields: "files",
+        pageSize: 5,
       });
 
       const { files } = await this.googleDrive.listFilesInPage(null, args);
@@ -105,7 +116,9 @@ export default {
     },
     async getChanges(headers) {
       if (!headers) {
-        return;
+        return {
+          change: { },
+        };
       }
       const resourceUri = headers["x-goog-resource-uri"];
       const metadata = await this.googleDrive.getFileMetadata(`${resourceUri}&fields=*`);
@@ -121,7 +134,9 @@ export default {
     async processChanges(changedFiles, headers) {
       const changes = await this.getChanges(headers);
 
-      for (const file of changedFiles) {
+      const filteredFiles = this.checkMinimumInterval(changedFiles);
+
+      for (const file of filteredFiles) {
         file.parents = (await this.googleDrive.getFile(file.id, {
           fields: "parents",
         })).parents;

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

@@ -13,14 +13,14 @@ import {
   GOOGLE_DRIVE_NOTIFICATION_ADD,
   GOOGLE_DRIVE_NOTIFICATION_CHANGE,
   GOOGLE_DRIVE_NOTIFICATION_UPDATE,
-} from "../../constants.mjs";
+} from "../../common/constants.mjs";
 
 export default {
   ...common,
   key: "google_drive-new-or-modified-folders",
-  name: "New or Modified Folders",
-  description: "Emit new event any time any folder in your linked Google Drive is added, modified, or deleted",
-  version: "0.1.4",
+  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",
   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
@@ -34,6 +34,7 @@ export default {
       const args = this.getListFilesOpts({
         q: `mimeType = "application/vnd.google-apps.folder" and modifiedTime > "${timeString}" and trashed = false`,
         fields: "files(id, mimeType)",
+        pageSize: 5,
       });
 
       const { files } = await this.googleDrive.listFilesInPage(null, args);
@@ -70,7 +71,9 @@ export default {
     },
     async getChanges(headers) {
       if (!headers) {
-        return;
+        return {
+          change: { },
+        };
       }
       const resourceUri = headers["x-goog-resource-uri"];
       const metadata = await this.googleDrive.getFileMetadata(`${resourceUri}&fields=*`);

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.3",
+  version: "0.1.4",
   type: "source",
   dedupe: "unique",
   props: {

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

@@ -5,21 +5,25 @@ export default {
   key: "google_drive-new-spreadsheet",
   type: "source",
   name: "New Spreadsheet (Instant)",
-  description: "Emit new event each time a new spreadsheet is created in a drive.",
-  version: "0.1.4",
+  description: "Emit new event when a new spreadsheet is created in a drive.",
+  version: "0.1.5",
   props: {
     googleDrive: newFilesInstant.props.googleDrive,
     db: newFilesInstant.props.db,
     http: newFilesInstant.props.http,
     drive: newFilesInstant.props.drive,
     timer: newFilesInstant.props.timer,
-    folders: newFilesInstant.props.folders,
+    folders: {
+      ...newFilesInstant.props.folders,
+      description:
+        "(Optional) The folders you want to watch. Leave blank to watch for any new spreadsheet in the Drive.",
+    },
   },
   hooks: {
     ...newFilesInstant.hooks,
     async deploy() {
       // Emit sample records on the first run
-      const spreadsheets = await this.getSpreadsheets(10);
+      const spreadsheets = await this.getSpreadsheets(5);
       for (const fileInfo of spreadsheets) {
         const createdTime = Date.parse(fileInfo.createdTime);
         this.$emit(fileInfo, {