@pipedream/google_drive 0.3.3 → 0.4.0

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

@@ -0,0 +1,83 @@
+import googleDrive from "../../google_drive.app.mjs";
+
+/**
+ * Uses Google Drive API to create a permission for a file. The role granted by
+ * the permission is one of `owner`,`organizer`,`fileOrganizer`,
+ * `writer`,`commenter`, `reader`. See the [Google Drive API Reference for
+ * Permissions](https://bit.ly/2XKKG1X) for more information.
+ */
+export default {
+  key: "google_drive-add-file-sharing-preference",
+  name: "Add File Sharing Preference",
+  description:
+    "Add a [sharing](https://support.google.com/drive/answer/7166529) permission to the sharing preferences of a file and provide a sharing URL. [See the docs](https://developers.google.com/drive/api/v3/reference/permissions/create) 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 share",
+    },
+    role: {
+      propDefinition: [
+        googleDrive,
+        "role",
+      ],
+    },
+    type: {
+      propDefinition: [
+        googleDrive,
+        "type",
+      ],
+    },
+    domain: {
+      propDefinition: [
+        googleDrive,
+        "domain",
+      ],
+    },
+    emailAddress: {
+      propDefinition: [
+        googleDrive,
+        "emailAddress",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      fileId,
+      role,
+      type,
+      domain,
+      emailAddress,
+    } = this;
+    // Create the permission for the file
+    await this.googleDrive.createPermission(fileId, {
+      role,
+      type,
+      domain,
+      emailAddress,
+    });
+
+    // Get the file to get the `webViewLink` sharing URL
+    const resp = await this.googleDrive.getFile(this.fileId);
+    const webViewLink = resp.webViewLink;
+    $.export("$summary", `Successfully added a sharing permission to the file, "${resp.name}"`);
+    return webViewLink;
+  },
+};

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

@@ -0,0 +1,34 @@
+import googleDrive from "../../google_drive.app.mjs";
+
+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.0.3",
+  type: "action",
+  props: {
+    googleDrive,
+    drive: {
+      propDefinition: [
+        googleDrive,
+        "watchedDrive",
+      ],
+      optional: true,
+    },
+    fileId: {
+      propDefinition: [
+        googleDrive,
+        "fileId",
+        (c) => ({
+          drive: c.drive,
+        }),
+      ],
+      description: "The file to copy",
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.googleDrive.copyFile(this.fileId);
+    $.export("$summary", `Successfully created a copy of the file, "${resp.name}"`);
+    return resp;
+  },
+};

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

@@ -0,0 +1,242 @@
+import googleDrive from "../../google_drive.app.mjs";
+import fs from "fs";
+import got from "got";
+import { toSingleLineString } from "../../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.0.7",
+  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 commenters
+      `),
+      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/create-file-from-template/create-file-from-template.mjs

@@ -0,0 +1,98 @@
+import googleDrive from "../../google_drive.app.mjs";
+import Mustaches from "google-docs-mustaches";
+
+const MODE_GOOGLE_DOC = "Google Doc";
+const MODE_PDF = "Pdf";
+
+export default {
+  key: "google_drive-create-file-from-template",
+  name: "Create New File From Template",
+  description: "Create a new google doc file from template. [See documentation](https://www.npmjs.com/package/google-docs-mustaches)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    googleDrive,
+    templateId: {
+      propDefinition: [
+        googleDrive,
+        "fileId",
+      ],
+      description:
+        "Id of the file you want to use as a template.",
+    },
+    folderId: {
+      propDefinition: [
+        googleDrive,
+        "folderId",
+      ],
+      description:
+        "Folder id of the newly created google doc and pdf.",
+    },
+    name: {
+      propDefinition: [
+        googleDrive,
+        "fileName",
+      ],
+      description:
+        "Name of the file you want to create (eg. `myFile` will create a google doc called `myFile` and a pdf called `myFile.pdf`)",
+      optional: false,
+    },
+    mode: {
+      type: "string[]",
+      label: "Mode",
+      description: "Select if you want to create the google doc, the pdf or both files.",
+      options: [
+        MODE_GOOGLE_DOC,
+        MODE_PDF,
+      ],
+    },
+    replaceValues: {
+      type: "object",
+      label: "Replace values",
+      description: "Substrings to replace in the document. (eg. `{{ key }}` in the document will be replace by the value.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const result = {
+      folderId: this.folderId,
+      name: this.name,
+      mode: this.mode,
+    };
+
+    const client = new Mustaches.default({
+      token: () => this.googleDrive.$auth.oauth_access_token,
+    });
+
+    /* CREATE THE GOOGLE DOC */
+
+    const googleDocId = await client.interpolate({
+      source: this.templateId,
+      destination: this.folderId,
+      name: this.name,
+      data: this.replaceValues,
+    });
+    result["googleDocId"] = googleDocId;
+
+    /* CREATE THE PDF */
+
+    if (this.mode.includes(MODE_PDF)) {
+      const pdfId = await client.export({
+        file: googleDocId,
+        mimeType: "application/pdf",
+        name: this.name,
+        destination: this.folderId,
+      });
+      result["pdfId"] = pdfId;
+    }
+
+    /* REMOVE THE GOOGLE DOC */
+
+    if (!this.mode.includes(MODE_GOOGLE_DOC)) {
+      await this.googleDrive.deleteFile(googleDocId);
+    }
+
+    $.export("$summary", "New file successfully created");
+    return result;
+  },
+};

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

@@ -0,0 +1,67 @@
+import googleDrive from "../../google_drive.app.mjs";
+import { Readable } from "stream";
+
+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.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 add the file to. If not specified, the file will be placed directly in the drive's top-level folder.",
+      optional: true,
+    },
+    name: {
+      propDefinition: [
+        googleDrive,
+        "fileName",
+      ],
+      description:
+        "The name of the file you want to create (e.g., `myFile.txt`)",
+    },
+    content: {
+      type: "string",
+      label: "Content",
+      description: "Enter text to create the file with.",
+      optional: true,
+      default: "",
+    },
+  },
+  async run({ $ }) {
+    const {
+      parentId,
+      name,
+      content,
+    } = this;
+    const file = Readable.from([
+      content,
+    ]);
+    const driveId = this.googleDrive.getDriveId(this.drive);
+    const resp = await this.googleDrive.createFile({
+      mimeType: "text/plain",
+      file,
+      name,
+      parentId,
+      driveId,
+    });
+    $.export("$summary", `Successfully created a new file, "${resp.name}"`);
+    return resp;
+  },
+};

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

@@ -0,0 +1,54 @@
+import googleDrive from "../../google_drive.app.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.0.4",
+  type: "action",
+  props: {
+    googleDrive,
+    drive: {
+      propDefinition: [
+        googleDrive,
+        "watchedDrive",
+      ],
+      optional: true,
+    },
+    parentId: {
+      propDefinition: [
+        googleDrive,
+        "folderId",
+        (c) => ({
+          drive: c.drive,
+        }),
+      ],
+      description:
+        "Select a folder in which to place the new folder. If not specified, the folder will be placed directly in the drive's top-level folder.",
+      optional: true,
+    },
+    name: {
+      propDefinition: [
+        googleDrive,
+        "fileName",
+      ],
+      label: "Name",
+      description: "The name of the new folder",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      parentId,
+      name,
+    } = this;
+    const driveId = this.googleDrive.getDriveId(this.drive);
+    const resp = await this.googleDrive.createFolder({
+      name,
+      parentId,
+      driveId,
+    });
+    $.export("$summary", `Successfully created a new folder, "${resp.name}"`);
+    return resp;
+  },
+};

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

@@ -0,0 +1,25 @@
+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.0.3",
+  type: "action",
+  props: {
+    googleDrive,
+    name: {
+      type: "string",
+      label: "Name",
+      description: "The name of the new shared drive",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.googleDrive.createDrive({
+      name: this.name,
+    });
+    $.export("$summary", `Successfully created a new shared drive, "${resp.name}"`);
+    return resp;
+  },
+};

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

@@ -0,0 +1,37 @@
+import googleDrive from "../../google_drive.app.mjs";
+
+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.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 delete",
+    },
+  },
+  async run({ $ }) {
+    await this.googleDrive.deleteFile(this.fileId);
+    $.export("$summary", "Successfully deleted the file");
+    return {
+      success: true,
+    };
+  },
+};

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

@@ -0,0 +1,30 @@
+import googleDrive from "../../google_drive.app.mjs";
+
+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.0.3",
+  type: "action",
+  props: {
+    googleDrive,
+    drive: {
+      propDefinition: [
+        googleDrive,
+        "watchedDrive",
+      ],
+      description:
+        "Select a [shared drive](https://support.google.com/a/users/answer/9310351) to delete.",
+      default: "",
+    },
+  },
+  async run({ $ }) {
+    await this.googleDrive.deleteSharedDrive(
+      this.googleDrive.getDriveId(this.drive),
+    );
+    $.export("$summary", "Successfully deleted the shared drive");
+    return {
+      success: true,
+    };
+  },
+};