@pipedream/google_drive 0.3.3 → 0.4.0

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

@@ -0,0 +1,52 @@
+import googleDrive from "../../google_drive.app.mjs";
+
+export default {
+  key: "google_drive-move-file",
+  name: "Move File",
+  description: "Move a file from one folder to another. [See the docs](https://developers.google.com/drive/api/v3/reference/files/update) for more information",
+  version: "0.0.4",
+  type: "action",
+  props: {
+    googleDrive,
+    drive: {
+      propDefinition: [
+        googleDrive,
+        "watchedDrive",
+      ],
+      optional: true,
+    },
+    fileId: {
+      propDefinition: [
+        googleDrive,
+        "fileId",
+        (c) => ({
+          drive: c.drive,
+        }),
+      ],
+      description: "The file to move",
+    },
+    folderId: {
+      propDefinition: [
+        googleDrive,
+        "folderId",
+        (c) => ({
+          drive: c.drive,
+        }),
+      ],
+      description: "The folder you want to move the file to",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    // Get file to get parents to remove
+    const file = await this.googleDrive.getFile(this.fileId);
+    // Update file, removing old parents, adding new parent folder
+    const resp = await this.googleDrive.updateFile(this.fileId, {
+      fields: "*",
+      removeParents: file.parents.join(","),
+      addParents: this.folderId,
+    });
+    $.export("$summary", `Successfully moved the file, "${file.name}"`);
+    return resp;
+  },
+};

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

@@ -0,0 +1,41 @@
+import googleDrive from "../../google_drive.app.mjs";
+import { GOOGLE_DRIVE_FOLDER_MIME_TYPE } from "../../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.0.4",
+  type: "action",
+  props: {
+    googleDrive,
+    drive: {
+      propDefinition: [
+        googleDrive,
+        "watchedDrive",
+      ],
+      optional: true,
+    },
+    fileId: {
+      propDefinition: [
+        googleDrive,
+        "fileOrFolderId",
+        (c) => ({
+          drive: c.drive,
+        }),
+      ],
+      description: "The file or folder to move to trash",
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.googleDrive.updateFile(this.fileId, {
+      requestBody: {
+        trashed: true,
+      },
+    });
+    $.export("$summary", `Successfully moved the ${resp.mimeType === GOOGLE_DRIVE_FOLDER_MIME_TYPE
+      ? "folder"
+      : "file"} "${resp.name}" to trash`);
+    return resp;
+  },
+};

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

@@ -0,0 +1,90 @@
+import path from "path";
+import googleDrive from "../../google_drive.app.mjs";
+import { omitEmptyStringValues } from "../../utils.mjs";
+
+import { getFileStream } from "../../utils.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.0.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`)",
+    },
+  },
+  async run({ $ }) {
+    const {
+      fileId,
+      fileUrl,
+      filePath,
+      name,
+      mimeType,
+    } = this;
+    if (!fileUrl && !filePath) {
+      throw new Error("One of File URL and File Path is required.");
+    }
+    const fileStream = await getFileStream({
+      $,
+      fileUrl,
+      filePath,
+    });
+    // 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,
+    }));
+    const resp = await this.googleDrive.updateFile(fileId, omitEmptyStringValues({
+      name: name || path.basename(fileUrl || filePath),
+      mimeType,
+    }));
+    $.export("$summary", "Successfully replaced the file");
+    return resp;
+  },
+};

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

@@ -0,0 +1,34 @@
+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.0.3",
+  type: "action",
+  props: {
+    googleDrive,
+    q: {
+      type: "string",
+      label: "Search Query",
+      description:
+        "The [shared drives](https://support.google.com/a/users/answer/9310351) search query. See [query terms](https://developers.google.com/drive/api/v3/ref-search-terms#drive_properties) for a list of shard drive-specific query terms.",
+    },
+    useDomainAdminAccess: {
+      propDefinition: [
+        googleDrive,
+        "useDomainAdminAccess",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const drives = (
+      await this.googleDrive.searchDrives({
+        q: this.q,
+        useDomainAdminAccess: this.useDomainAdminAccess,
+      })
+    ).drives;
+    $.export("$summary", `Successfully found ${drives.length} shared drives using the search query "${this.q}"`);
+    return drives;
+  },
+};

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

@@ -0,0 +1,164 @@
+import googleDrive from "../../google_drive.app.mjs";
+import { toSingleLineString } from "../../utils.mjs";
+import { getFileStream } from "../../utils.mjs";
+
+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.0.4",
+  type: "action",
+  props: {
+    googleDrive,
+    drive: {
+      propDefinition: [
+        googleDrive,
+        "watchedDrive",
+      ],
+
+      optional: true,
+    },
+    fileId: {
+      propDefinition: [
+        googleDrive,
+        "fileId",
+        (c) => ({
+          drive: c.drive,
+        }),
+      ],
+      description: "The file to update",
+    },
+    fileUrl: {
+      propDefinition: [
+        googleDrive,
+        "fileUrl",
+      ],
+      description: "The URL of the file to use to update content",
+    },
+    filePath: {
+      propDefinition: [
+        googleDrive,
+        "filePath",
+      ],
+      description: toSingleLineString(`
+        The path to the file saved to the [\`/tmp\`
+        directory](https://pipedream.com/docs/workflows/steps/code/nodejs/working-with-files/#the-tmp-directory)
+        (e.g., \`/tmp/myFile.csv\`) with which to update content
+      `),
+    },
+    name: {
+      propDefinition: [
+        googleDrive,
+        "fileName",
+      ],
+      description: "The new name of the file",
+    },
+    mimeType: {
+      propDefinition: [
+        googleDrive,
+        "mimeType",
+      ],
+      description:
+        "The file's MIME type (e.g., `image/jpeg`). The value cannot be changed unless a new revision is uploaded.",
+    },
+    addParents: {
+      propDefinition: [
+        googleDrive,
+        "folderId",
+      ],
+      type: "string[]",
+      label: "Add Parents",
+      description: "A list of parent folder IDs to add",
+      optional: true,
+    },
+    removeParents: {
+      propDefinition: [
+        googleDrive,
+        "fileParents",
+        ({ fileId }) => ({
+          fileId,
+        }),
+      ],
+      label: "Remove Parents",
+      description: "A list of parent folder IDs to remove",
+    },
+    keepRevisionForever: {
+      propDefinition: [
+        googleDrive,
+        "keepRevisionForever",
+      ],
+    },
+    ocrLanguage: {
+      propDefinition: [
+        googleDrive,
+        "ocrLanguage",
+      ],
+    },
+    useContentAsIndexableText: {
+      propDefinition: [
+        googleDrive,
+        "useContentAsIndexableText",
+      ],
+    },
+    advanced: {
+      type: "object",
+      label: "Advanced Options",
+      optional: true,
+      description: toSingleLineString(`
+        Specify less-common properties that you want to use. See [Files: update]
+        (https://developers.google.com/drive/api/v3/reference/files/update#request-body) for a list
+        of supported properties.
+      `),
+    },
+  },
+  async run({ $ }) {
+    const {
+      fileId,
+      fileUrl,
+      filePath,
+      name,
+      mimeType,
+      addParents,
+      removeParents,
+      keepRevisionForever,
+      ocrLanguage,
+      useContentAsIndexableText,
+      advanced,
+    } = this;
+
+    const fileStream =
+      fileUrl || filePath
+        ? await getFileStream({
+          $,
+          fileUrl,
+          filePath,
+        })
+        : undefined;
+
+    // Update file content, if set, separately from metadata to prevent
+    // multipart upload, which `google-apis-nodejs-client` doesn't seem to
+    // support for [files.update](https://bit.ly/3lP5sWn)
+    if (fileStream) {
+      await this.googleDrive.updateFileMedia(fileId, fileStream, {
+        mimeType,
+      });
+    }
+
+    const resp = await this.googleDrive.updateFile(fileId, {
+      name,
+      mimeType,
+      addParents: addParents?.join(","),
+      removeParents: removeParents?.join(","),
+      keepRevisionForever,
+      ocrLanguage,
+      useContentAsIndexableText,
+      requestBody: {
+        ...advanced,
+      },
+      fields: "*",
+    });
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `Successfully updated the file, "${name ? resp.id : resp.name}"`);
+    return resp;
+  },
+};

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

@@ -0,0 +1,77 @@
+import googleDrive from "../../google_drive.app.mjs";
+
+export default {
+  key: "google_drive-update-shared-drive",
+  name: "Update Shared Drive",
+  description: "Update an existing shared drive. [See the docs](https://developers.google.com/drive/api/v3/reference/drives/update) for more information",
+  version: "0.0.3",
+  type: "action",
+  props: {
+    googleDrive,
+    drive: {
+      propDefinition: [
+        googleDrive,
+        "watchedDrive",
+      ],
+      description:
+        "Select a [shared drive](https://support.google.com/a/users/answer/9310351) to update",
+      default: "",
+    },
+    useDomainAdminAccess: {
+      propDefinition: [
+        googleDrive,
+        "useDomainAdminAccess",
+      ],
+    },
+    backgroundImageLink: {
+      type: "string",
+      label: "Background Image Link",
+      description:
+        "A link to the new backround image for the shared drive. Cannot be set if `Theme ID` is set in the same request.",
+      optional: true,
+    },
+    colorRgb: {
+      type: "string",
+      label: "Color",
+      description:
+        "The new color of this shared drive as an RGB hex string. Cannot be set if `Theme ID` is set in the same request.",
+      optional: true,
+    },
+    themeId: {
+      type: "string",
+      label: "Theme ID",
+      description:
+        "The ID of the theme from which the background image and color will be set. Cannot be set if `Color` or `Background Image Link` is set in the same request.",
+      optional: true,
+    },
+    restrictions: {
+      type: "object",
+      label: "Restrictions",
+      description:
+        "A set of restrictions that apply to this shared drive or items inside this shared drive. See `restrictions` in the [Drive resource representation](https://developers.google.com/drive/api/v3/reference/drives#resource-representations).",
+      optional: true,
+      default: {},
+    },
+  },
+  async run({ $ }) {
+    const {
+      useDomainAdminAccess,
+      backgroundImageLink,
+      colorRgb,
+      themeId,
+      restrictions,
+    } = this;
+    const driveId = this.googleDrive.getDriveId(this.drive);
+    const resp = await this.googleDrive.updateSharedDrive(driveId, {
+      useDomainAdminAccess,
+      requestBody: {
+        backgroundImageLink,
+        colorRgb,
+        themeId,
+        restrictions,
+      },
+    });
+    $.export("$summary", `Successfully updated the shared drive, "${resp.name}"`);
+    return resp;
+  },
+};

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

@@ -0,0 +1,89 @@
+import googleDrive from "../../google_drive.app.mjs";
+import path from "path";
+import { getFileStream } from "../../utils.mjs";
+import { omitEmptyStringValues } from "../../utils.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.0.4",
+  type: "action",
+  props: {
+    googleDrive,
+    drive: {
+      propDefinition: [
+        googleDrive,
+        "watchedDrive",
+      ],
+      optional: true,
+    },
+    parentId: {
+      propDefinition: [
+        googleDrive,
+        "folderId",
+        (c) => ({
+          drive: c.drive,
+        }),
+      ],
+      description:
+        "The folder you want to upload the file to. If not specified, the file will be placed directly in the drive's top-level folder.",
+      optional: true,
+    },
+    fileUrl: {
+      propDefinition: [
+        googleDrive,
+        "fileUrl",
+      ],
+    },
+    filePath: {
+      propDefinition: [
+        googleDrive,
+        "filePath",
+      ],
+    },
+    name: {
+      propDefinition: [
+        googleDrive,
+        "fileName",
+      ],
+      description:
+        "The name of the new file (e.g. `/myFile.csv`). By default, the name is the same as the source file's.",
+    },
+    mimeType: {
+      propDefinition: [
+        googleDrive,
+        "mimeType",
+      ],
+      description:
+        "The file's MIME type (e.g., `image/jpeg`). Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided.",
+    },
+  },
+  async run({ $ }) {
+    const {
+      parentId,
+      fileUrl,
+      filePath,
+      name,
+      mimeType,
+    } = this;
+    if (!fileUrl && !filePath) {
+      throw new Error("One of File URL and File Path is required.");
+    }
+    const driveId = this.googleDrive.getDriveId(this.drive);
+    const file = await getFileStream({
+      $,
+      fileUrl,
+      filePath,
+    });
+    const resp = await this.googleDrive.createFile(omitEmptyStringValues({
+      file,
+      mimeType,
+      name: name || path.basename(fileUrl || filePath),
+      parentId,
+      driveId,
+    }));
+    $.export("$summary", `Successfully uploaded a new file, "${resp.name}"`);
+    return resp;
+  },
+};