@pipedream/google_drive 1.11.0 → 1.12.0

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

@@ -0,0 +1,102 @@
+import { Readable } from "stream";
+import googleDrive from "../../google_drive.app.mjs";
+
+export default {
+  key: "google_drive-create-text-file",
+  name: "Create Text File",
+  description:
+    "Create a new Google Doc from text content in Google Drive."
+    + " The file is created as a Google Docs document, which can be viewed and edited in the browser."
+    + " Use this when the user asks to create a document, write a file, or save text to Drive."
+    + " To place the file in a specific folder, pass the `parentId` — use **Search Files** with"
+    + " `mimeType = 'application/vnd.google-apps.folder'` to find the folder ID first."
+    + " Supported content formats: plain text, Markdown, HTML, Rich Text, CSV."
+    + " [See the documentation](https://developers.google.com/drive/api/v3/reference/files/create)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    googleDrive,
+    name: {
+      type: "string",
+      label: "File Name",
+      description: "The name of the new file (e.g., 'Meeting Notes', 'Project Plan').",
+    },
+    content: {
+      type: "string",
+      label: "Content",
+      description: "The text content of the file.",
+      optional: true,
+      default: "",
+    },
+    mimeType: {
+      type: "string",
+      label: "Content Format",
+      description:
+        "The format of the content being provided. Defaults to plain text.",
+      optional: true,
+      default: "text/plain",
+      options: [
+        {
+          value: "text/plain",
+          label: "Plain Text",
+        },
+        {
+          value: "text/markdown",
+          label: "Markdown",
+        },
+        {
+          value: "text/html",
+          label: "HTML",
+        },
+        {
+          value: "application/rtf",
+          label: "Rich Text",
+        },
+        {
+          value: "text/csv",
+          label: "CSV",
+        },
+      ],
+    },
+    parentId: {
+      type: "string",
+      label: "Parent Folder ID",
+      description:
+        "The ID of the folder to create the file in."
+        + " Use **Search Files** with `mimeType = 'application/vnd.google-apps.folder'` to find folder IDs."
+        + " Omit to create in the root of My Drive.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const file = Readable.from([
+      this.content,
+    ]);
+    const drive = this.googleDrive.drive();
+
+    const { data: resp } = await drive.files.create({
+      supportsAllDrives: true,
+      media: {
+        mimeType: this.mimeType,
+        body: file,
+      },
+      requestBody: {
+        name: this.name,
+        mimeType: "application/vnd.google-apps.document",
+        parents: this.parentId
+          ? [
+            this.parentId,
+          ]
+          : undefined,
+      },
+    });
+
+    $.export("$summary", `Created file: ${resp.name} (${resp.id})`);
+    return resp;
+  },
+};

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

@@ -0,0 +1,48 @@
+import googleDrive from "../../google_drive.app.mjs";
+
+export default {
+  key: "google_drive-get-file",
+  name: "Get File",
+  description:
+    "Get full metadata for a file or folder by its ID."
+    + " Returns name, MIME type, size, parent folders, sharing permissions, web links, creation/modification dates, and more."
+    + " Use **Search Files** first to find the file ID if you only have the file name."
+    + " By default returns all fields. Pass specific field names to `fields` to reduce the response size."
+    + "\n\nCommon fields: `id`, `name`, `mimeType`, `size`, `parents`, `webViewLink`, `webContentLink`,"
+    + " `createdTime`, `modifiedTime`, `owners`, `permissions`, `description`, `trashed`."
+    + " [See the documentation](https://developers.google.com/drive/api/v3/reference/files/get)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    googleDrive,
+    fileId: {
+      type: "string",
+      label: "File ID",
+      description:
+        "The ID of the file or folder to retrieve."
+        + " Use **Search Files** to find the file ID by name.",
+    },
+    fields: {
+      type: "string",
+      label: "Fields",
+      description:
+        "Comma-separated list of fields to include in the response."
+        + " Example: `id,name,mimeType,webViewLink,parents,permissions`."
+        + " Omit to return all fields.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.googleDrive.getFile(this.fileId, {
+      fields: this.fields || "*",
+    });
+
+    $.export("$summary", `Retrieved file: ${response.name}`);
+    return response;
+  },
+};

package/actions/get-user-details/get-user-details.mjs

@@ -0,0 +1,34 @@
+import googleDrive from "../../google_drive.app.mjs";
+
+export default {
+  key: "google_drive-get-user-details",
+  name: "Get User Details",
+  description:
+    "Retrieve the authenticated user's Google Drive identity and storage quota."
+    + " Returns display name, email address, permission ID, and storage usage/limits."
+    + " Use this tool when the user asks 'who am I?' or needs their identity for owner-based queries."
+    + " When the user says 'my files' or 'my documents', call this first to get the owner email,"
+    + " then pass it to **Search Files** with a query like `'user@example.com' in owners`."
+    + " [See the documentation](https://developers.google.com/drive/api/v3/reference/about/get)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    googleDrive,
+  },
+  async run({ $ }) {
+    const about = await this.googleDrive.getAbout("user,storageQuota");
+
+    const name =
+      about?.user?.displayName
+      || about?.user?.emailAddress
+      || about?.user?.permissionId;
+    $.export("$summary", `Retrieved Google Drive user: ${name}`);
+
+    return about;
+  },
+};

package/actions/list-permissions/list-permissions.mjs

@@ -0,0 +1,46 @@
+import googleDrive from "../../google_drive.app.mjs";
+
+export default {
+  key: "google_drive-list-permissions",
+  name: "List Permissions",
+  description:
+    "List sharing permissions on a file or folder in Google Drive."
+    + " Returns each permission's ID, type (user/group/domain/anyone), role (owner/writer/commenter/reader), and email address."
+    + " Use **Search Files** first to find the file ID by name."
+    + " Use this tool when the user asks 'who has access to this file?' or needs to audit sharing."
+    + " Pass permission IDs from this response to **Remove Sharing** to revoke access."
+    + " [See the documentation](https://developers.google.com/drive/api/v3/reference/permissions/list)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    googleDrive,
+    fileId: {
+      type: "string",
+      label: "File ID",
+      description:
+        "The ID of the file or folder to list permissions for."
+        + " Use **Search Files** to find the file ID by name.",
+    },
+  },
+  async run({ $ }) {
+    const allPermissions = [];
+    let pageToken;
+    do {
+      const {
+        permissions = [], nextPageToken,
+      } = await this.googleDrive.listPermissions(pageToken, this.fileId);
+      allPermissions.push(...permissions);
+      pageToken = nextPageToken;
+    } while (pageToken);
+
+    $.export("$summary", `Found ${allPermissions.length} permission${allPermissions.length === 1
+      ? ""
+      : "s"}`);
+    return allPermissions;
+  },
+};

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

@@ -0,0 +1,52 @@
+import googleDrive from "../../google_drive.app.mjs";
+
+export default {
+  key: "google_drive-list-shared-drives",
+  name: "List Shared Drives",
+  description:
+    "List shared drives accessible to the authenticated user."
+    + " Returns drive IDs, names, and metadata for each shared drive."
+    + " Use this when the user asks about their shared drives or needs to scope a search to a specific drive."
+    + " Pass a drive ID to **Search Files** `driveId` parameter to search within a specific shared drive."
+    + " Optionally filter by name using the `query` parameter (e.g., `name contains 'Engineering'`)."
+    + " [See the documentation](https://developers.google.com/drive/api/v3/reference/drives/list)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    googleDrive,
+    query: {
+      type: "string",
+      label: "Query",
+      description:
+        "Optional. Filter shared drives by name."
+        + " Example: `name contains 'Marketing'`."
+        + " Omit to list all shared drives.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const allDrives = [];
+    let pageToken;
+    do {
+      const {
+        drives = [], nextPageToken,
+      } = await this.googleDrive.searchDrives({
+        q: this.query,
+        pageToken,
+        pageSize: 100,
+      });
+      allDrives.push(...drives);
+      pageToken = nextPageToken;
+    } while (pageToken);
+
+    $.export("$summary", `Found ${allDrives.length} shared drive${allDrives.length === 1
+      ? ""
+      : "s"}`);
+    return allDrives;
+  },
+};

package/actions/remove-sharing/remove-sharing.mjs

@@ -0,0 +1,50 @@
+import googleDrive from "../../google_drive.app.mjs";
+
+export default {
+  key: "google_drive-remove-sharing",
+  name: "Remove Sharing",
+  description:
+    "Remove a sharing permission from a file or folder in Google Drive."
+    + " This revokes access for the specified permission."
+    + " Use **List Permissions** first to find the permission ID to remove."
+    + " The owner permission cannot be removed."
+    + " Use **Search Files** to find the file ID by name if needed."
+    + " [See the documentation](https://developers.google.com/drive/api/v3/reference/permissions/delete)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    googleDrive,
+    fileId: {
+      type: "string",
+      label: "File ID",
+      description:
+        "The ID of the file or folder to remove the sharing permission from."
+        + " Use **Search Files** to find the file ID by name.",
+    },
+    permissionId: {
+      type: "string",
+      label: "Permission ID",
+      description:
+        "The ID of the permission to remove."
+        + " Use **List Permissions** to find the permission ID.",
+    },
+  },
+  async run({ $ }) {
+    await this.googleDrive.deletePermission({
+      fileId: this.fileId,
+      permissionId: this.permissionId,
+    });
+
+    $.export("$summary", `Removed permission ${this.permissionId} from file ${this.fileId}`);
+    return {
+      success: true,
+      fileId: this.fileId,
+      permissionId: this.permissionId,
+    };
+  },
+};

package/actions/search-files/search-files.mjs

@@ -0,0 +1,82 @@
+import { getListFilesOpts } from "../../common/utils.mjs";
+import googleDrive from "../../google_drive.app.mjs";
+
+export default {
+  key: "google_drive-search-files",
+  name: "Search Files",
+  description:
+    "Search for files and folders in Google Drive using the Drive query language."
+    + " This is the primary tool for finding files, folders, spreadsheets, forms, and any other Drive item."
+    + " Returns matching files with their IDs, names, MIME types, and parent folder IDs."
+    + "\n\n**Query syntax** — pass a Drive search query string. Examples:"
+    + "\n- Find by name: `name contains 'Budget'`"
+    + "\n- Exact name match: `name = 'Q4 Report'`"
+    + "\n- Folders only: `mimeType = 'application/vnd.google-apps.folder'`"
+    + "\n- Google Docs: `mimeType = 'application/vnd.google-apps.document'`"
+    + "\n- Spreadsheets: `mimeType = 'application/vnd.google-apps.spreadsheet'`"
+    + "\n- Files in a folder: `'FOLDER_ID' in parents`"
+    + "\n- Not trashed: `trashed = false`"
+    + "\n- Modified after date: `modifiedTime > '2024-01-01T00:00:00'`"
+    + "\n- Combine with AND: `name contains 'Report' and mimeType = 'application/vnd.google-apps.document'`"
+    + "\n- Owner filter: `'user@example.com' in owners`"
+    + "\n\nWhen the user says 'my files', use **Get User Details** first to get the owner email."
+    + " To scope to a shared drive, pass the `driveId` from **List Shared Drives**."
+    + " [See the documentation](https://developers.google.com/drive/api/v3/search-files)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    googleDrive,
+    query: {
+      type: "string",
+      label: "Query",
+      description:
+        "A Drive search query string. See the tool description for syntax examples."
+        + " Common queries: `name contains 'keyword'`, `mimeType = 'application/vnd.google-apps.folder'`,"
+        + " `'FOLDER_ID' in parents`, `trashed = false`.",
+    },
+    driveId: {
+      type: "string",
+      label: "Drive ID",
+      description:
+        "Optional. Scope the search to a specific shared drive."
+        + " Use **List Shared Drives** to find available drive IDs."
+        + " Omit to search My Drive.",
+      optional: true,
+    },
+    includeItemsFromAllDrives: {
+      type: "boolean",
+      label: "Include Items From All Drives",
+      description:
+        "If true, include results from all drives (My Drive and shared drives)."
+        + " Defaults to false.",
+      optional: true,
+      default: false,
+    },
+  },
+  async run({ $ }) {
+    const opts = getListFilesOpts(this.driveId, {
+      q: this.query,
+      includeItemsFromAllDrives: this.includeItemsFromAllDrives,
+    });
+
+    const allFiles = [];
+    let pageToken;
+    do {
+      const {
+        files, nextPageToken,
+      } = await this.googleDrive.listFilesInPage(pageToken, opts);
+      allFiles.push(...files);
+      pageToken = nextPageToken;
+    } while (pageToken);
+
+    $.export("$summary", `Found ${allFiles.length} file${allFiles.length === 1
+      ? ""
+      : "s"} matching query "${this.query}"`);
+    return allFiles;
+  },
+};

package/actions/share-file/share-file.mjs

@@ -0,0 +1,86 @@
+import googleDrive from "../../google_drive.app.mjs";
+
+export default {
+  key: "google_drive-share-file",
+  name: "Share File",
+  description:
+    "Share a file or folder in Google Drive by creating a sharing permission."
+    + " Supports sharing with a specific user, a group, an entire domain, or anyone with the link."
+    + " Use **Search Files** first to find the file ID by name."
+    + "\n\n**Sharing types:**"
+    + "\n- `user` — share with a specific person (requires `emailAddress`)"
+    + "\n- `group` — share with a Google Group (requires `emailAddress`)"
+    + "\n- `domain` — share with everyone in a Google Workspace domain (requires `domain`)"
+    + "\n- `anyone` — share with anyone who has the link (no email/domain needed)"
+    + "\n\n**Roles:** `reader` (view only), `commenter` (can comment), `writer` (can edit)."
+    + " Use **List Permissions** to see existing sharing on a file."
+    + " [See the documentation](https://developers.google.com/drive/api/v3/reference/permissions/create)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    googleDrive,
+    fileId: {
+      type: "string",
+      label: "File ID",
+      description:
+        "The ID of the file or folder to share."
+        + " Use **Search Files** to find the file ID by name.",
+    },
+    type: {
+      type: "string",
+      label: "Type",
+      description:
+        "The type of grantee: `user`, `group`, `domain`, or `anyone`.",
+      options: [
+        "user",
+        "group",
+        "domain",
+        "anyone",
+      ],
+    },
+    role: {
+      type: "string",
+      label: "Role",
+      description:
+        "The access level to grant: `reader` (view), `commenter` (comment), or `writer` (edit).",
+      options: [
+        "reader",
+        "commenter",
+        "writer",
+      ],
+    },
+    emailAddress: {
+      type: "string",
+      label: "Email Address",
+      description:
+        "The email address of the user or group to share with."
+        + " Required when type is `user` or `group`. Ignored for `domain` and `anyone`.",
+      optional: true,
+    },
+    domain: {
+      type: "string",
+      label: "Domain",
+      description:
+        "The Google Workspace domain to share with (e.g., `example.com`)."
+        + " Required when type is `domain`. Ignored for other types.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.googleDrive.createPermission(this.fileId, {
+      role: this.role,
+      type: this.type,
+      emailAddress: this.emailAddress,
+      domain: this.domain,
+    });
+
+    const target = this.emailAddress || this.domain || this.type;
+    $.export("$summary", `Shared file with ${target} as ${this.role}`);
+    return resp;
+  },
+};

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

@@ -0,0 +1,41 @@
+import googleDrive from "../../google_drive.app.mjs";
+
+export default {
+  key: "google_drive-trash-file",
+  name: "Trash File",
+  description:
+    "Move a file or folder to the trash in Google Drive."
+    + " This is a reversible operation — the file can be restored from trash within 30 days."
+    + " Use **Search Files** first to find the file ID by name."
+    + " Use this instead of permanent deletion as the safer default."
+    + " To find trashed files, use **Search Files** with `trashed = true`."
+    + " [See the documentation](https://developers.google.com/drive/api/v3/reference/files/update)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    googleDrive,
+    fileId: {
+      type: "string",
+      label: "File ID",
+      description:
+        "The ID of the file or folder to move to trash."
+        + " Use **Search Files** to find the file ID by name.",
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.googleDrive.updateFile(this.fileId, {
+      requestBody: {
+        trashed: true,
+      },
+      fields: "*",
+    });
+
+    $.export("$summary", `Moved to trash: ${resp.name} (${resp.id})`);
+    return resp;
+  },
+};

package/package.json

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