@pipedream/dropbox 0.3.3 → 0.3.4

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

@@ -0,0 +1,117 @@
+import dropbox from "../../dropbox.app.mjs";
+import isNil from "lodash/isNil.js";
+import get from "lodash/get.js";
+import consts from "../../consts.mjs";
+
+export default {
+  name: "Search files and folders",
+  description: "Searches for files and folders by name. [See the docs here](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#filesSearchV2__anchor)",
+  key: "dropbox-search-files-folders",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    dropbox,
+    query: {
+      propDefinition: [
+        dropbox,
+        "query",
+      ],
+    },
+    path: {
+      propDefinition: [
+        dropbox,
+        "pathFolder",
+      ],
+      optional: true,
+      description: "Scopes the search to a path in the user's Dropbox. Searches the entire Dropbox if not specified.",
+    },
+    orderBy: {
+      type: "string",
+      label: "Order by",
+      description: "By default, results are sorted by relevance.",
+      optional: true,
+      options: consts.SEARCH_FILE_FOLDER_ORDER_BY_OPTIONS,
+    },
+    fileStatus: {
+      type: "string",
+      label: "File status",
+      description: "Restricts search to the given file status.",
+      optional: true,
+      options: consts.SEARCH_FILE_FOLDER_STATUS_OPTIONS,
+    },
+    filenameOnly: {
+      type: "boolean",
+      label: "Filename only",
+      description: "Restricts search to only match on filenames.",
+      optional: true,
+    },
+    fileCategories: {
+      type: "string[]",
+      label: "File categories",
+      description: "Restricts search to only the file categories specified. Only supported for active file search.",
+      optional: true,
+      options: consts.FILES_CATEGORIES_OPTIONS,
+    },
+    fileExtensions: {
+      type: "string[]",
+      label: "File extensions",
+      description: "Restricts search to only the extensions specified. Only supported for active file search.",
+      optional: true,
+    },
+    includeHighlights: {
+      type: "boolean",
+      label: "Include highlights",
+      description: "Whether to include highlight span from file title.",
+      optional: true,
+    },
+    limit: {
+      propDefinition: [
+        dropbox,
+        "limit",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      query,
+      includeHighlights,
+      limit,
+      path,
+      orderBy,
+      fileStatus,
+      filenameOnly,
+      fileExtensions,
+      fileCategories,
+    } = this;
+    const res = await this.dropbox.searchFilesFolders({
+      query,
+      match_field_options: !isNil(includeHighlights)
+        ? undefined
+        : {
+          include_highlights: includeHighlights,
+        },
+      options: {
+        path: get(path, "value", path) || "",
+        order_by: orderBy
+          ? {
+            ".tag": orderBy,
+          }
+          : undefined,
+        file_status: fileStatus
+          ? {
+            ".tag": fileStatus,
+          }
+          : undefined,
+        filename_only: filenameOnly,
+        file_extensions: fileExtensions,
+        file_categories: fileCategories
+          ? fileCategories.map((category) => ({
+            ".tag": category,
+          }))
+          : undefined,
+      },
+    }, limit);
+    $.export("$summary", "Files and folders successfully fetched");
+    return res;
+  },
+};

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

@@ -0,0 +1,101 @@
+import dropbox from "../../dropbox.app.mjs";
+import consts from "../../consts.mjs";
+import fs from "fs";
+import got from "got";
+import common from "../common.mjs";
+
+export default {
+  ...common,
+  name: "Upload a File",
+  description: "Uploads a file to a selected folder. [See docs here](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#filesUpload__anchor)",
+  key: "dropbox-upload-a-file",
+  version: "0.0.3",
+  type: "action",
+  props: {
+    dropbox,
+    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.",
+    },
+    name: {
+      type: "string",
+      label: "File name",
+      description: "The name of your new file.",
+    },
+    fileUrl: {
+      type: "string",
+      label: "File URL",
+      description: "The URL of the file you want to upload to Dropbox. Must specify either File URL or File Path.",
+      optional: true,
+    },
+    filePath: {
+      type: "string",
+      label: "File Path",
+      description: "The path to the file, e.g. /tmp/myFile.csv . Must specify either File URL or File Path.",
+      optional: true,
+    },
+    autorename: {
+      type: "boolean",
+      label: "Autorename",
+      description: "If there's a conflict, have Dropbox try to autorename the folder to avoid the conflict.",
+      optional: true,
+    },
+    mute: {
+      type: "boolean",
+      label: "Mute",
+      description: "Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If `true`, this will not result in a user notification.",
+      optional: true,
+    },
+    strictConflict: {
+      type: "boolean",
+      label: "Strict Conflict",
+      description: "Be more strict about how each WriteMode detects conflict. For example, always return a conflict error when mode = WriteMode.update and the given \"rev\" doesn't match the existing file's \"rev\", even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents.",
+      optional: true,
+    },
+    mode: {
+      type: "string",
+      label: "Mode",
+      description: "Selects what to do if the file already exists.",
+      options: consts.UPLOAD_FILE_MODE_OPTIONS,
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      fileUrl,
+      filePath,
+      path,
+      name,
+      autorename,
+      mute,
+      strictConflict,
+      mode,
+      clientModified,
+    } = this;
+
+    const contents = fileUrl
+      ? await got.stream(fileUrl)
+      : fs.createReadStream(filePath);
+
+    let normalizedPath = this.getNormalizedPath(path, true);
+
+    const res = await this.dropbox.uploadFile({
+      contents,
+      autorename,
+      path: normalizedPath + name,
+      mode: mode
+        ? {
+          ".tag": mode,
+        }
+        : undefined,
+      client_modified: clientModified,
+      mute,
+      strict_conflict: strictConflict,
+    });
+    $.export("$summary", `File successfully uploaded to "${path?.label || path}"`);
+    return res;
+  },
+};

package/config.mjs

@@ -0,0 +1,11 @@
+export default {
+  SEARCH_FILE_FOLDERS: {
+    DEFAULT_MAX_RESULTS: 100,
+  },
+  LIST_FILES_IN_FOLDER: {
+    DEFAULT_MAX_RESULTS: 100,
+  },
+  GET_PATH_OPTIONS: {
+    DEFAULT_MAX_RESULTS: 1000,
+  },
+};

package/consts.mjs

@@ -0,0 +1,52 @@
+export default {
+  SEARCH_FILE_FOLDER_ORDER_BY_OPTIONS: [
+    "relevance",
+    "last_modified_time",
+  ],
+  SEARCH_FILE_FOLDER_STATUS_OPTIONS: [
+    "active",
+    "deleted",
+  ],
+  FILES_CATEGORIES_OPTIONS: [
+    "image",
+    "document",
+    "pdf",
+    "spreadsheet",
+    "presentation",
+    "audio",
+    "video",
+    "folder",
+    "paper",
+    "others",
+    "other",
+  ],
+  LIST_FILE_REVISIONS_OPTIONS: [
+    "path",
+    "id",
+    "other",
+  ],
+  CREATE_SHARED_LINK_AUDIENCE_OPTIONS: [
+    "public",
+    "team",
+    "no_one",
+    "password",
+    "members",
+    "other",
+  ],
+  CREATE_SHARED_LINK_ACCESS_OPTIONS: [
+    "viewer",
+    "editor",
+    "max",
+    "other",
+  ],
+  CREATE_SHARED_LINK_REQUESTED_VISIBILITY_OPTIONS: [
+    "public",
+    "team_only",
+    "password",
+  ],
+  UPLOAD_FILE_MODE_OPTIONS: [
+    "add",
+    "overwrite",
+    "update",
+  ],
+};