@pipedream/google_drive 0.3.1 → 0.4.0

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

@@ -0,0 +1,120 @@
+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 googleWorkspaceExportFormats from "../google-workspace-export-formats.mjs";
+import { toSingleLineString } from "../../utils.mjs";
+
+/**
+ * Uses Google Drive API to download files to a `filePath` in the /tmp
+ * directory.
+ *
+ * Use `files.export` for Google Workspace files types (e.g.,
+ * `application/vnd.google-apps.document`) and `files.get` for other file types,
+ * as per the [Download files API guide](https://bit.ly/2ZbJvcn).
+ */
+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.0.3",
+  type: "action",
+  props: {
+    googleDrive,
+    drive: {
+      propDefinition: [
+        googleDrive,
+        "watchedDrive",
+      ],
+
+      optional: true,
+    },
+    fileId: {
+      propDefinition: [
+        googleDrive,
+        "fileId",
+        (c) => ({
+          drive: c.drive,
+        }),
+      ],
+      description: "The file to download",
+    },
+    filePath: {
+      type: "string",
+      label: "Destination File Path",
+      description: toSingleLineString(`
+        The destination path for the file in the [\`/tmp\`
+        directory](https://pipedream.com/docs/workflows/steps/code/nodejs/working-with-files/#the-tmp-directory)
+        (e.g., \`/tmp/myFile.csv\`)
+      `),
+    },
+    mimeType: {
+      type: "string",
+      label: "Conversion Format",
+      description: toSingleLineString(`
+        The format to which to convert the downloaded file if it is a [Google Workspace
+        document](https://developers.google.com/drive/api/v3/ref-export-formats)
+      `),
+      optional: true,
+      async options() {
+        const fileId = this.fileId;
+        if (!fileId) {
+          return googleWorkspaceExportFormats;
+        }
+        let file, exportFormats;
+        try {
+          ([
+            file,
+            exportFormats,
+          ] = await Promise.all([
+            this.googleDrive.getFile(fileId, {
+              fields: "mimeType",
+            }),
+            this.googleDrive.getExportFormats(),
+          ]));
+        } catch (err) {
+          return googleWorkspaceExportFormats;
+        }
+        const mimeTypes = exportFormats[file.mimeType];
+        if (!mimeTypes) {
+          return [];
+        }
+        return exportFormats[file.mimeType].map((f) =>
+          googleWorkspaceExportFormats.find(
+            (format) => format.value === f,
+          ) ?? f);
+      },
+    },
+  },
+  async run({ $ }) {
+    // Get file metadata to get file's MIME type
+    const fileMetadata = await this.googleDrive.getFile(this.fileId, {
+      fields: "name,mimeType",
+    });
+    const mimeType = fileMetadata.mimeType;
+
+    const isWorkspaceDocument = mimeType.includes(GOOGLE_DRIVE_MIME_TYPE_PREFIX);
+    if (isWorkspaceDocument && !this.mimeType) {
+      throw new Error("Conversion Format is required when File is a Google Workspace Document");
+    }
+    // Download file
+    // If `mimeType` is a Google MIME type, use `downloadWorkspaceFile`. Otherwise, use `getFile`.
+    // See https://developers.google.com/drive/api/v3/mime-types for a list of Google MIME types.
+    // Google Workspace format to MIME type map:
+    // https://developers.google.com/drive/api/v3/ref-export-formats
+    const file = isWorkspaceDocument
+      ? await this.googleDrive.downloadWorkspaceFile(this.fileId, {
+        mimeType: this.mimeType,
+      })
+      : await this.googleDrive.getFile(this.fileId, {
+        alt: "media",
+      });
+
+    // Stream file to `filePath`
+    const pipeline = promisify(stream.pipeline);
+    await pipeline(file, fs.createWriteStream(this.filePath));
+    $.export("$summary", `Successfully downloaded the file, "${fileMetadata.name}"`);
+    return fileMetadata;
+  },
+};

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

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

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

@@ -0,0 +1,38 @@
+import googleDrive from "../../google_drive.app.mjs";
+import { getListFilesOpts } from "../../utils.mjs";
+
+import { GOOGLE_DRIVE_FOLDER_MIME_TYPE } from "../../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.0.3",
+  type: "action",
+  props: {
+    googleDrive,
+    drive: {
+      propDefinition: [
+        googleDrive,
+        "watchedDrive",
+      ],
+      optional: true,
+    },
+    nameSearchTerm: {
+      propDefinition: [
+        googleDrive,
+        "fileNameSearchTerm",
+      ],
+      description: "The name of the folder to search for",
+    },
+  },
+  async run({ $ }) {
+    const opts = getListFilesOpts(this.drive, {
+      q: `mimeType = '${GOOGLE_DRIVE_FOLDER_MIME_TYPE}' and name contains '${this.nameSearchTerm}'`,
+    });
+    const folders = (await this.googleDrive.listFilesInPage(null, opts)).files;
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `Successfully found ${folders.length} folder${folders.length === 1 ? "" : "s"} containing the term, "${this.nameSearchTerm}"`);
+    return folders;
+  },
+};

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

@@ -0,0 +1,62 @@
+import googleDrive from "../../google_drive.app.mjs";
+
+/**
+ * Uses Google Drive API to get the folder ID for a Google Drive folder from
+ * the `path` to the folder (e.g., `folder1/subFolderA/subFolderB`).
+ *
+ * For each part of the path, uses the Google Drive API to find a folder with
+ * `name` of the part and with `id` of the found folder of the previous part in
+ * its `parents`.
+ */
+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.0.3",
+  type: "action",
+  props: {
+    googleDrive,
+    drive: {
+      propDefinition: [
+        googleDrive,
+        "watchedDrive",
+      ],
+      optional: true,
+    },
+    path: {
+      type: "string",
+      label: "Path",
+      description:
+        "The path to the folder (e.g., `myFolder/mySubFolder1/mySubFolder2`)",
+      optional: false,
+    },
+  },
+  async run({ $ }) {
+    // Convert path to array (e.g., `"folder1/subFolderA/subFolderB" ->
+    // ["folder1","subFolderA","subFolderB"]`)
+    const parts = this.path.split("/");
+
+    let part;
+    let parentId;
+    // Iterate over parts
+    // `parentId` of initial folder is `undefined` or root ("My Drive")
+    while ((part = parts.shift())) {
+      const folders = await this.googleDrive.findFolder({
+        drive: this.drive,
+        name: part,
+        parentId,
+      });
+      if (!folders[0]) {
+        // Folder at path is not found
+        $.export("$summary", `Couldn't find a folderId for the path, "${this.path}"`);
+        return undefined;
+      }
+      // Set parentId of next folder in path to find
+      parentId = folders[0] && folders[0].id;
+    }
+
+    $.export("$summary", `Successfully retrieved the folderId for the path, "${this.path}"`);
+    // Return id of last folder that is found
+    return parentId;
+  },
+};

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

@@ -0,0 +1,37 @@
+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.0.3",
+  type: "action",
+  props: {
+    googleDrive,
+    drive: {
+      propDefinition: [
+        googleDrive,
+        "watchedDrive",
+      ],
+      description:
+        "Select a [shared drive](https://support.google.com/a/users/answer/9310351).",
+      default: "",
+    },
+    useDomainAdminAccess: {
+      propDefinition: [
+        googleDrive,
+        "useDomainAdminAccess",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.googleDrive.getSharedDrive(
+      this.googleDrive.getDriveId(this.drive),
+      {
+        useDomainAdminAccess: this.useDomainAdminAccess,
+      },
+    );
+    $.export("$summary", `Successfully fetched the shared drive, "${resp.name}"`);
+    return resp;
+  },
+};

package/actions/google-mime-types.mjs

@@ -0,0 +1,19 @@
+export default [
+  "application/vnd.google-apps.audio",
+  "application/vnd.google-apps.document",
+  "application/vnd.google-apps.drive-sdk",
+  "application/vnd.google-apps.drawing",
+  "application/vnd.google-apps.file",
+  "application/vnd.google-apps.folder",
+  "application/vnd.google-apps.form",
+  "application/vnd.google-apps.fusiontable",
+  "application/vnd.google-apps.map",
+  "application/vnd.google-apps.photo",
+  "application/vnd.google-apps.presentation",
+  "application/vnd.google-apps.script",
+  "application/vnd.google-apps.shortcut",
+  "application/vnd.google-apps.site",
+  "application/vnd.google-apps.spreadsheet",
+  "application/vnd.google-apps.unknown",
+  "application/vnd.google-apps.video",
+];

package/actions/google-workspace-export-formats.mjs

@@ -0,0 +1,74 @@
+export default [
+  {
+    value: "application/epub+zip",
+    label: "EPUB",
+  },
+  {
+    value: "application/pdf",
+    label: "PDF",
+  },
+  {
+    value: "application/rtf",
+    label: "Rich Text",
+  },
+  {
+    value: "application/vnd.google-apps.script+json",
+    label: "JSON",
+  },
+  {
+    value: "application/vnd.oasis.opendocument.presentation",
+    label: "Open Office presentation",
+  },
+  {
+    value: "application/x-vnd.oasis.opendocument.spreadsheet",
+    label: "Open Office sheet",
+  },
+  {
+    value: "application/vnd.oasis.opendocument.text",
+    label: "Open Office doc",
+  },
+  {
+    value: "application/vnd.openxmlformats-officedocument.presentationml.presentation",
+    label: "MS PowerPoint",
+  },
+  {
+    value: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+    label: "MS Excel",
+  },
+  {
+    value: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+    label: "MS Word document",
+  },
+  {
+    value: "application/zip",
+    label: "HTML (zipped)",
+  },
+  {
+    value: "image/jpeg",
+    label: "JPEG",
+  },
+  {
+    value: "image/png",
+    label: "PNG",
+  },
+  {
+    value: "image/svg+xml",
+    label: "SVG",
+  },
+  {
+    value: "text/csv",
+    label: "CSV (first sheet only)",
+  },
+  {
+    value: "text/html",
+    label: "HTML",
+  },
+  {
+    value: "text/plain",
+    label: "Plain text",
+  },
+  {
+    value: "text/tab-separated-values",
+    label: "TSV (sheet only)",
+  },
+];