@pipedream/dropbox 0.3.1 → 0.3.4

package/actions/common.mjs

@@ -0,0 +1,21 @@
+import isEmpty from "lodash/isEmpty.js";
+import isNil from "lodash/isNil.js";
+
+export default {
+  methods: {
+    getNormalizedPath: (path, appendFinalBar) => {
+      let normalizedPath = path?.value || path;
+
+      // Check for empties path
+      if (isNil(normalizedPath) || isEmpty(normalizedPath)) {
+        normalizedPath = "/";
+      }
+
+      if (appendFinalBar && normalizedPath[normalizedPath.length - 1] !== "/") {
+        normalizedPath += "/";
+      }
+
+      return normalizedPath;
+    },
+  },
+};

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

@@ -0,0 +1,47 @@
+import dropbox from "../../dropbox.app.mjs";
+import common from "../common.mjs";
+
+export default {
+  ...common,
+  name: "Create a Text File",
+  description: "Creates a brand new text file from plain text content you specify. [See docs here](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#filesUpload__anchor)",
+  key: "dropbox-create-a-text-file",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    dropbox,
+    name: {
+      type: "string",
+      label: "File name",
+      description: "Your new file name.",
+    },
+    path: {
+      propDefinition: [
+        dropbox,
+        "pathFolder",
+      ],
+      description: "The file path in the user's Dropbox to create the file. If not filled, it will be created in the root folder.",
+    },
+    content: {
+      type: "string",
+      label: "Content",
+      description: "The content of your new file",
+    },
+  },
+  async run({ $ }) {
+    const {
+      name,
+      content,
+      path,
+    } = this;
+
+    const res = await this.dropbox.uploadFile({
+      contents: Buffer.from(content),
+      path: this.getNormalizedPath(path, true) + name,
+      autorename: true,
+    });
+
+    $.export("$summary", `${name} successfully created in the folder ${path?.label || path}`);
+    return res;
+  },
+};

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

@@ -0,0 +1,47 @@
+import dropbox from "../../dropbox.app.mjs";
+import common from "../common.mjs";
+
+export default {
+  ...common,
+  name: "Create folder",
+  description: "Create a folder. [See docs here](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#filesCreateFolderV2__anchor)",
+  key: "dropbox-create-folder",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    dropbox,
+    name: {
+      type: "string",
+      label: "Folder name",
+      description: "Your new folder name.",
+    },
+    path: {
+      propDefinition: [
+        dropbox,
+        "pathFolder",
+      ],
+      optional: true,
+      description: "The file path in the user's Dropbox to create the folder. If not filled, it will be created in the root folder.",
+    },
+    autorename: {
+      type: "boolean",
+      label: "Autorename",
+      description: "If there's a conflict, have Dropbox try to autorename the folder to avoid the conflict.",
+      default: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      autorename,
+      name,
+      path,
+    } = this;
+
+    const res = await this.dropbox.createFolder({
+      autorename,
+      path: this.getNormalizedPath(path, true) + name,
+    });
+    $.export("$summary", `Folder successfully created: \`${res.result.metadata.name}\``);
+    return res;
+  },
+};

package/actions/create-or-append-to-a-text-file/create-or-append-to-a-text-file.mjs

@@ -0,0 +1,87 @@
+import dropbox from "../../dropbox.app.mjs";
+import common from "../common.mjs";
+
+export default {
+  name: "Create or Append to a Text File",
+  description: "Adds a new line to an existing text file, or creates a file if it doesn't exist. [See docs here](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#filesUpload__anchor)",
+  key: "dropbox-create-or-append-to-a-text-file",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    dropbox,
+    name: {
+      type: "string",
+      label: "File name",
+      description: "Your new file name",
+    },
+    path: {
+      propDefinition: [
+        dropbox,
+        "pathFolder",
+      ],
+      optional: true,
+      description: "The file path in the user's Dropbox to create the file. If not filled, it will be created in the root folder.",
+    },
+    content: {
+      type: "string",
+      label: "Content",
+      description: "The content to be written",
+    },
+  },
+  methods: {
+    ...common.methods,
+    async getFileInfo(path, content) {
+      let file;
+      try {
+        file = await this.dropbox.downloadFile({
+          path,
+        });
+      } catch {
+        file = null;
+      }
+
+      return {
+        fileExists: !!(file?.result?.fileBinary),
+        content: file?.result?.fileBinary
+          ? `${file.result.fileBinary.toString()}\n${content}`
+          : content,
+      };
+    },
+    getArgs(fileExists, content, normalizedPath) {
+      return {
+        contents: Buffer.from(content),
+        path: normalizedPath,
+        autorename: !fileExists,
+        mode: fileExists
+          ? {
+            ".tag": "overwrite",
+          }
+          : undefined,
+      };
+    },
+  },
+  async run({ $ }) {
+    const {
+      name,
+      content,
+      path,
+    } = this;
+
+    const normalizedPath = this.getNormalizedPath(path, true) + name;
+    const {
+      fileExists,
+      content: normalizedContent,
+    } = await this.getFileInfo(normalizedPath, content);
+
+    const res = await this.dropbox.uploadFile(this.getArgs(
+      fileExists,
+      normalizedContent,
+      normalizedPath,
+    ));
+
+    $.export("$summary", fileExists
+      ? `Text successfully appended to the file "${name}"`
+      : `Text file successfully created in the path "${path?.label || path}"`);
+    return res;
+  },
+};

package/actions/create-update-share-link/create-update-share-link.mjs

@@ -0,0 +1,91 @@
+import dropbox from "../../dropbox.app.mjs";
+import consts from "../../consts.mjs";
+
+export default {
+  name: "Create/Update a Share Link",
+  description: "Creates or updates a public share link to the file or folder (It allows to share the file or folder with anyone). [See docs here](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#sharingCreateSharedLinkWithSettings__anchor)",
+  key: "dropbox-create-update-update-a-share-link",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    dropbox,
+    path: {
+      propDefinition: [
+        dropbox,
+        "pathFileFolder",
+      ],
+      description: "The path to be shared by the shared link.",
+    },
+    requirePassword: {
+      type: "boolean",
+      label: "Require password",
+      description: "Boolean flag to enable or disable password protection.",
+      default: false,
+    },
+    linkPassword: {
+      type: "string",
+      label: "Link password",
+      description: "If `require_password` is `true`, this is needed to specify the password to access the link.",
+      optional: true,
+    },
+    expires: {
+      type: "string",
+      label: "Expires",
+      description: "Expiration time of the shared link. By default the link never expires. Make sure to use a valid [timestamp](https://dropbox.github.io/dropbox-sdk-js/global.html#Timestamp) value.",
+      optional: true,
+    },
+    audience: {
+      type: "string",
+      label: "Audience",
+      description: "The new audience who can benefit from the access level specified by the link's access level specified in the `link_access_level` field of `LinkPermissions`. This is used in conjunction with team policies and shared folder policies to determine the final effective audience type in the `effective_audience` field of `LinkPermissions.",
+      optional: true,
+      options: consts.CREATE_SHARED_LINK_AUDIENCE_OPTIONS,
+    },
+    access: {
+      type: "string",
+      label: "Access",
+      description: "Requested access level you want the audience to gain from this link. Note, modifying access level for an existing link is not supported.",
+      optional: true,
+      options: consts.CREATE_SHARED_LINK_ACCESS_OPTIONS,
+    },
+    allowDownload: {
+      type: "boolean",
+      label: "Allow downloads",
+      description: "Boolean flag to allow or not allow capabilities for shared links.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      path,
+      requirePassword,
+      linkPassword,
+      expires,
+      audience,
+      access,
+      requestedVisibility,
+      allowDownload,
+      removeExpiration,
+    } = this;
+
+    if (requirePassword && !linkPassword) {
+      throw new Error("Since the password is required, please add a linkPassword");
+    }
+
+    const res = await this.dropbox.createSharedLink({
+      path: path?.value || path,
+      settings: {
+        require_password: requirePassword,
+        link_password: linkPassword,
+        expires,
+        audience,
+        access,
+        requested_visibility: requestedVisibility,
+        allow_download: allowDownload,
+      },
+      remove_expiration: removeExpiration,
+    });
+    $.export("$summary", `Shared link for "${path?.label || path}" successfully created`);
+    return res;
+  },
+};

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

@@ -0,0 +1,27 @@
+import dropbox from "../../dropbox.app.mjs";
+
+export default {
+  name: "Delete a File/Folder",
+  description: "Permanently removes a file/folder from the server. [See docs here](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#filesDeleteV2__anchor)",
+  key: "dropbox-delete-a-file-folder",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    dropbox,
+    path: {
+      propDefinition: [
+        dropbox,
+        "pathFileFolder",
+      ],
+      description: "Path in the user's Dropbox to delete.",
+    },
+  },
+  async run({ $ }) {
+    const { path } = this;
+    const res = await this.dropbox.deleteFileFolder({
+      path: path?.value || path,
+    });
+    $.export("$summary", `"${path?.label || path}" successfully deleted`);
+    return res;
+  },
+};

package/actions/list-file-folders-in-a-folder/list-file-folders-in-a-folder.mjs

@@ -0,0 +1,76 @@
+import dropbox from "../../dropbox.app.mjs";
+
+export default {
+  name: "List All Files/Subfolders in a Folder",
+  description: "Retrieves a list of files or subfolders in a specified folder [See the docs here](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#filesListFolder__anchor)",
+  key: "dropbox-list-file-folders-in-a-folder",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    dropbox,
+    path: {
+      propDefinition: [
+        dropbox,
+        "pathFolder",
+      ],
+      description: "Scopes the search to a path in the user's Dropbox.",
+    },
+    recursive: {
+      type: "boolean",
+      label: "Recursive",
+      description: "If `true`, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders.",
+      default: true,
+    },
+    includeDeleted: {
+      type: "boolean",
+      label: "Include deleted",
+      description: "If `true`, the results will include files and folders that used to exist but were deleted.",
+      default: false,
+    },
+    includeHasExplicitSharedMembers: {
+      type: "boolean",
+      label: "Include has explicit shared members",
+      description: "If `true`, the results will include a flag for each file indicating whether or not that file has any explicit members.",
+      default: false,
+    },
+    includeMountedFolders: {
+      type: "boolean",
+      label: "Include mounted folders",
+      description: "If `true`, the results will include entries under mounted folders which includes app folder, shared folder and team folder.",
+      default: false,
+    },
+    includeNonDownloadableFiles: {
+      type: "boolean",
+      label: "Include non downloadable files",
+      description: "If `true`, include files that are not downloadable, i.e. Google Docs.",
+      default: true,
+    },
+    limit: {
+      propDefinition: [
+        dropbox,
+        "limit",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      limit,
+      path,
+      recursive,
+      includeDeleted,
+      includeHasExplicitSharedMembers,
+      includeMountedFolders,
+      includeNonDownloadableFiles,
+    } = this;
+    const res = await this.dropbox.listFilesFolders({
+      path: path?.value || path,
+      recursive,
+      include_deleted: includeDeleted,
+      include_has_explicit_shared_members: includeHasExplicitSharedMembers,
+      include_mounted_folders: includeMountedFolders,
+      include_non_downloadable_files: includeNonDownloadableFiles,
+    }, limit);
+    $.export("$summary", `Files and folders in the path ${path?.label || path} successfully fetched`);
+    return res;
+  },
+};

package/actions/list-file-revisions/list-file-revisions.mjs

@@ -0,0 +1,53 @@
+import consts from "../../consts.mjs";
+import dropbox from "../../dropbox.app.mjs";
+
+export default {
+  name: "List File Revisions",
+  description: "Retrieves a list of file revisions needed to recover previous content. [See docs here](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#filesListRevisions__anchor)",
+  key: "dropbox-list-file-revisions",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    dropbox,
+    path: {
+      propDefinition: [
+        dropbox,
+        "pathFile",
+      ],
+      description: "The file path for the file whose revisions you'd like to list.",
+    },
+    mode: {
+      type: "string",
+      label: "Mode",
+      description: "Determines the behavior of the API in listing the revisions for a given file path or id.",
+      optional: true,
+      options: consts.LIST_FILE_REVISIONS_OPTIONS,
+    },
+    limit: {
+      propDefinition: [
+        dropbox,
+        "limit",
+      ],
+      description: "The maximum number of revision entries returned.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      path,
+      mode,
+      limit,
+    } = this;
+    const res = await this.dropbox.listFileRevisions({
+      path: path?.value || path,
+      mode: mode
+        ? {
+          ".tag": mode,
+        }
+        : undefined,
+      limit,
+    });
+    $.export("$summary", `File revisions for file "${path?.label || path}" successfully fetched`);
+    return res;
+  },
+};

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

@@ -0,0 +1,67 @@
+import dropbox from "../../dropbox.app.mjs";
+
+export default {
+  name: "Move a File/Folder",
+  description: "Moves a file or folder to a different location in the user's Dropbox [See the docs here](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#filesMoveV2__anchor)",
+  key: "dropbox-move-file-folder",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    dropbox,
+    pathFrom: {
+      propDefinition: [
+        dropbox,
+        "pathFileFolder",
+      ],
+      label: "Path from",
+      description: "The file/folder that you want to move.",
+    },
+    pathTo: {
+      propDefinition: [
+        dropbox,
+        "pathFolder",
+      ],
+      label: "Path to",
+      description: "The new path of your file/folder",
+    },
+    autorename: {
+      type: "boolean",
+      label: "Autorename",
+      description: "If there's a conflict, have Dropbox try to autorename the folder to avoid the conflict.",
+      optional: true,
+    },
+    allowOwnershipTransfer: {
+      type: "boolean",
+      label: "Allow ownership transfer",
+      description: "Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      pathFrom,
+      autorename,
+      allowOwnershipTransfer,
+      pathTo,
+    } = this;
+
+    let normalizedPathTo = pathTo?.value || pathTo;
+    const normalizedPathFrom = pathFrom?.value || pathFrom;
+
+    // If path is a file, we need to move it as a file
+    if (pathFrom?.type == "file" && pathFrom.value) {
+      const splited = normalizedPathFrom.split("/");
+      const fileName = splited[splited.length - 1];
+      normalizedPathTo = `${pathTo?.value || pathTo}/${fileName}`;
+    }
+
+    const res = await this.dropbox.filesMove({
+      from_path: pathFrom.value,
+      to_path: normalizedPathTo,
+      autorename,
+      allow_ownership_transfer: allowOwnershipTransfer,
+    });
+    $.export("$summary", `"${normalizedPathFrom}" successfully moved to "${normalizedPathTo}"`);
+    return res;
+  },
+};

package/actions/rename-file-folder/rename-file-folder.mjs

@@ -0,0 +1,57 @@
+import dropbox from "../../dropbox.app.mjs";
+
+export default {
+  name: "Rename a File/Folder",
+  description: "Renames a file or folder in the user's Dropbox [See the docs here](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#filesMoveV2__anchor)",
+  key: "dropbox-rename-file-folder",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    dropbox,
+    pathFrom: {
+      propDefinition: [
+        dropbox,
+        "pathFileFolder",
+      ],
+      label: "Path From",
+      description: "The file that you want to rename.",
+    },
+    newName: {
+      type: "string",
+      label: "New Name",
+      description: "The file's new name (make sure to include the file extension).",
+    },
+    autorename: {
+      type: "boolean",
+      label: "Autorename",
+      description: "If there's a conflict, have Dropbox try to autorename the folder to avoid the conflict.",
+      optional: true,
+    },
+    allowOwnershipTransfer: {
+      type: "boolean",
+      label: "Allow ownership transfer",
+      description: "Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      pathFrom,
+      newName,
+      autorename,
+      allowOwnershipTransfer,
+    } = this;
+
+    const normalizedPathFrom = pathFrom?.value || pathFrom;
+    const splitedPath = normalizedPathFrom.split("/");
+    splitedPath[splitedPath.length - 1] = newName;
+    const res = await this.dropbox.filesMove({
+      from_path: normalizedPathFrom,
+      to_path: splitedPath.join("/"),
+      autorename,
+      allow_ownership_transfer: allowOwnershipTransfer,
+    });
+    $.export("$summary", `"${normalizedPathFrom}" successfully renamed to "${newName}"`);
+    return res;
+  },
+};

package/actions/restore-a-file/restore-a-file.mjs

@@ -0,0 +1,42 @@
+import dropbox from "../../dropbox.app.mjs";
+
+export default {
+  name: "Restore a File",
+  description: "Restores a previous file version. [See docs here](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#filesRestore__anchor)",
+  key: "dropbox-restore-a-file",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    dropbox,
+    path: {
+      propDefinition: [
+        dropbox,
+        "pathFile",
+      ],
+      description: "The path to save the restored file.",
+    },
+    rev: {
+      propDefinition: [
+        dropbox,
+        "fileRevision",
+        ({ path }) => ({
+          path,
+        }),
+      ],
+      description: "The revision to restore.",
+    },
+  },
+  async run({ $ }) {
+    const {
+      path,
+      rev,
+    } = this;
+
+    const res = await this.dropbox.restoreFile({
+      path: path?.value || path,
+      rev: rev?.value || rev,
+    });
+    $.export("$summary", `"${path?.label || path}" successfully restored to "${rev?.label || rev}" revision`);
+    return res;
+  },
+};