@foxtware/mineral 0.1.28 → 0.1.29

package/api/dropbox/dropboxFileMove.js

@@ -0,0 +1,67 @@
+// https://www.dropbox.com/developers/documentation/http/documentation#files-move_v2
+
+const { ArgsWarden, logDeep } = require('../utils');
+const { credsValidator } = require('../validators');
+const { dropboxClient } = require('../dropbox/dropbox.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['fromPath'],
+  ['toPath'],
+]);
+
+const dropboxFileMove = async (
+  credsPayload,
+  fromPath,
+  toPath,
+  {
+    allowSharedFolder = false,
+    autorename = false,
+    allowOwnershipTransfer = false,
+    fetchClient = dropboxClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    fromPath,
+    toPath,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await fetchClient.fetch({
+    context: { credsPayload },
+    requestPayload: {
+      method: 'post',
+      url: '/files/move_v2',
+      body: {
+        from_path: fromPath,
+        to_path: toPath,
+        allow_shared_folder: allowSharedFolder,
+        autorename,
+        allow_ownership_transfer: allowOwnershipTransfer,
+      },
+    },
+  });
+
+  const { ok, data, error } = response;
+  if (!ok) {
+    logDeep({ error });
+    return { ok: false, error };
+  }
+
+  return {
+    ok: true,
+    data: data.metadata ?? data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  dropboxFileMove,
+  funcApiConfig,
+};

package/api/dropbox/dropboxFileUpload.js

@@ -0,0 +1,129 @@
+// https://www.dropbox.com/developers/documentation/http/documentation#files-upload
+// Max 150 MB for a single /files/upload call. Larger files need upload sessions.
+
+const fs = require('fs').promises;
+const pathModule = require('path');
+
+const { ArgsWarden, valueProvided, logDeep } = require('../utils');
+const { credsValidator } = require('../validators');
+const { dropboxContentClient } = require('../dropbox/dropbox.utils');
+
+const fileDataValidator = (fileData) => {
+  if (!fileData || typeof fileData !== 'object') {
+    return false;
+  }
+  const { filePath, fileSource, contents } = fileData;
+  return valueProvided(filePath)
+    || valueProvided(fileSource)
+    || valueProvided(contents);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['path'],
+  ['fileData', fileDataValidator],
+]);
+
+const dropboxFileUpload = async (
+  credsPayload,
+  path,
+  fileData,
+  {
+    mode = 'add', // 'add' | 'overwrite' | { '.tag': 'update', update: rev }
+    autorename = false,
+    mute = false,
+    strictConflict = false,
+    clientModified,
+    fetchClient = dropboxContentClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    path,
+    fileData,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  let body;
+  if (valueProvided(fileData.filePath)) {
+    body = await fs.readFile(fileData.filePath);
+  } else if (valueProvided(fileData.fileSource)) {
+    body = Buffer.isBuffer(fileData.fileSource)
+      ? fileData.fileSource
+      : Buffer.from(fileData.fileSource, fileData.encoding || 'utf8');
+  } else if (valueProvided(fileData.contents)) {
+    body = Buffer.isBuffer(fileData.contents)
+      ? fileData.contents
+      : Buffer.from(fileData.contents, fileData.encoding || 'utf8');
+  }
+
+  if (!body) {
+    return {
+      ok: false,
+      error: {
+        code: 'INVALID_FILE_DATA',
+        message: 'Provide filePath, fileSource, or contents',
+      },
+    };
+  }
+
+  // If path ends with / or is empty folder style, append basename from filePath.
+  let uploadPath = path;
+  if (fileData.filePath && (path.endsWith('/') || path === '')) {
+    uploadPath = `${ path.replace(/\/$/, '') }/${ pathModule.basename(fileData.filePath) }`;
+  }
+
+  const arg = {
+    path: uploadPath,
+    mode,
+    autorename,
+    mute,
+    strict_conflict: strictConflict,
+    ...(clientModified !== undefined && { client_modified: clientModified }),
+  };
+
+  const response = await fetchClient.fetch({
+    context: { credsPayload },
+    requestPayload: {
+      method: 'post',
+      url: '/files/upload',
+      headers: {
+        'Dropbox-API-Arg': JSON.stringify(arg),
+        'Content-Type': 'application/octet-stream',
+      },
+      body,
+    },
+  });
+
+  const { ok, data, error } = response;
+  if (!ok) {
+    logDeep({ error });
+    return { ok: false, error };
+  }
+
+  return {
+    ok: true,
+    data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  dropboxFileUpload,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/dropboxFileUpload" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "dropbox" },
+    "path": "/Homework/math/hello.txt",
+    "fileData": { "contents": "hello world" }
+  }'
+*/

package/api/dropbox/dropboxFolderCreate.js

@@ -0,0 +1,68 @@
+// https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder_v2
+
+const { ArgsWarden, logDeep } = require('../utils');
+const { credsValidator } = require('../validators');
+const { dropboxClient } = require('../dropbox/dropbox.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['path'],
+]);
+
+const dropboxFolderCreate = async (
+  credsPayload,
+  path,
+  {
+    autorename = false,
+    fetchClient = dropboxClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    path,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await fetchClient.fetch({
+    context: { credsPayload },
+    requestPayload: {
+      method: 'post',
+      url: '/files/create_folder_v2',
+      body: {
+        path,
+        autorename,
+      },
+    },
+  });
+
+  const { ok, data, error } = response;
+  if (!ok) {
+    logDeep({ error });
+    return { ok: false, error };
+  }
+
+  return {
+    ok: true,
+    data: data.metadata ?? data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  dropboxFolderCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/dropboxFolderCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "dropbox" },
+    "path": "/Homework/math"
+  }'
+*/

package/api/dropbox/dropboxFolderList.js

@@ -0,0 +1,66 @@
+// https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { dropboxGet } = require('../dropbox/dropboxGet');
+const { MAX_PER_PAGE } = require('../dropbox/dropbox.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+// path: "" for root. recursive walks the whole subtree.
+const dropboxFolderList = async (
+  credsPayload,
+  {
+    path = '',
+    recursive = false,
+    includeDeleted = false,
+    includeMediaInfo = false,
+    includeMountedFolders = true,
+    includeNonDownloadableFiles = true,
+    perPage = MAX_PER_PAGE,
+    fetchClient,
+    ...getterOptions
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return dropboxGet(credsPayload, '/files/list_folder', {
+    body: {
+      path,
+      recursive,
+      include_deleted: includeDeleted,
+      include_media_info: includeMediaInfo,
+      include_mounted_folders: includeMountedFolders,
+      include_non_downloadable_files: includeNonDownloadableFiles,
+    },
+    perPage,
+    resultsKey: 'entries',
+    fetchClient,
+    ...getterOptions,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  dropboxFolderList,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/dropboxFolderList" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "dropbox" },
+    "options": { "path": "/Homework" }
+  }'
+*/

package/api/dropbox/dropboxGet.js

@@ -0,0 +1,158 @@
+// https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder
+
+const { ArgsWarden, Getter } = require('../utils');
+const { credsValidator } = require('../validators');
+const { dropboxClient } = require('../dropbox/dropbox.utils');
+const { MAX_PER_PAGE } = require('../dropbox/dropbox.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['url'],
+]);
+
+const dropboxGetPacket = async (
+  credsPayload,
+  url,
+  {
+    body = {},
+    perPage = MAX_PER_PAGE,
+    fetchClient = dropboxClient,
+  } = {},
+) => {
+  // When continuing, Dropbox wants only { cursor } on list_folder/continue.
+  const isContinue = url.includes('/continue') || body.cursor;
+
+  const requestBody = isContinue
+    ? { cursor: body.cursor }
+    : {
+        ...body,
+        ...(body.limit === undefined && {
+          limit: Math.min(perPage, MAX_PER_PAGE),
+        }),
+      };
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url,
+      body: requestBody,
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const dropboxGetPaginator = async (currentParams, response) => {
+  if (!response?.ok) {
+    return [true];
+  }
+
+  const { has_more: hasMore, cursor } = response.data ?? {};
+  if (!hasMore || !cursor) {
+    return [true];
+  }
+
+  const { args, options } = currentParams;
+  const [, initialUrl] = args;
+
+  // Switch to the matching continue endpoint when still on the initial path.
+  let continueUrl = initialUrl;
+  if (!continueUrl.includes('/continue')) {
+    continueUrl = `${ initialUrl.replace(/\/$/, '') }/continue`;
+  }
+
+  return [false, {
+    args: [args[0], continueUrl],
+    options: {
+      ...options,
+      body: {
+        cursor,
+      },
+    },
+  }];
+};
+
+const dropboxGet = async (
+  returnGetter,
+
+  credsPayload,
+  url,
+  {
+    body,
+    perPage = MAX_PER_PAGE,
+    resultsKey = 'entries',
+    fetchClient,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    url,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getter = new Getter(
+    {
+      args: [credsPayload, url],
+      options: {
+        body,
+        perPage,
+        fetchClient,
+      },
+    },
+    {
+      func: dropboxGetPacket,
+      digester: (response) => {
+        if (!response?.ok) {
+          return [];
+        }
+
+        if (resultsKey) {
+          return response.data?.[resultsKey] ?? [];
+        }
+
+        return response.data ?? [];
+      },
+      paginator: dropboxGetPaginator,
+      ...getterOptions,
+    },
+  );
+
+  if (returnGetter) {
+    return getter;
+  }
+
+  const data = await getter.run({ returnAll: true });
+
+  return {
+    ok: true,
+    data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  dropboxGet: (...args) => dropboxGet(false, ...args),
+  dropboxGetter: (...args) => dropboxGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/dropboxGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "dropbox" },
+    "url": "/files/list_folder",
+    "options": {
+      "body": { "path": "" },
+      "perPage": 100
+    }
+  }'
+*/

package/api/dropbox/dropboxSearch.js

@@ -0,0 +1,161 @@
+// https://www.dropbox.com/developers/documentation/http/documentation#files-search_v2
+
+const { ArgsWarden, Getter, logDeep } = require('../utils');
+const { credsValidator } = require('../validators');
+const { dropboxClient } = require('../dropbox/dropbox.utils');
+const { MAX_PER_PAGE } = require('../dropbox/dropbox.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['query'],
+]);
+
+const dropboxSearchPacket = async (
+  credsPayload,
+  query,
+  {
+    body = {},
+    perPage = 100,
+    fetchClient = dropboxClient,
+  } = {},
+) => {
+  if (body.cursor) {
+    return fetchClient.fetch({
+      context: { credsPayload },
+      requestPayload: {
+        method: 'post',
+        url: '/files/search/continue_v2',
+        body: { cursor: body.cursor },
+      },
+    });
+  }
+
+  return fetchClient.fetch({
+    context: { credsPayload },
+    requestPayload: {
+      method: 'post',
+      url: '/files/search_v2',
+      body: {
+        query,
+        options: {
+          max_results: Math.min(perPage, MAX_PER_PAGE),
+          ...(body.options || {}),
+        },
+        ...(body.match_field_options && {
+          match_field_options: body.match_field_options,
+        }),
+      },
+    },
+  });
+};
+
+const dropboxSearchPaginator = async (currentParams, response) => {
+  if (!response?.ok) {
+    return [true];
+  }
+
+  const { has_more: hasMore, cursor } = response.data ?? {};
+  if (!hasMore || !cursor) {
+    return [true];
+  }
+
+  const { args, options } = currentParams;
+
+  return [false, {
+    args,
+    options: {
+      ...options,
+      body: {
+        cursor,
+      },
+    },
+  }];
+};
+
+const dropboxSearch = async (
+  returnGetter,
+
+  credsPayload,
+  query,
+  {
+    path,
+    fileStatus,
+    filenameOnly,
+    maxResults,
+    fileCategories,
+    accountId,
+    perPage = 100,
+    fetchClient,
+    ...getterOptions
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    query,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const options = {
+    ...(path !== undefined && { path }),
+    ...(fileStatus !== undefined && { file_status: fileStatus }),
+    ...(filenameOnly !== undefined && { filename_only: filenameOnly }),
+    ...(maxResults !== undefined && { max_results: maxResults }),
+    ...(fileCategories !== undefined && { file_categories: fileCategories }),
+    ...(accountId !== undefined && { account_id: accountId }),
+  };
+
+  const getter = new Getter(
+    {
+      args: [credsPayload, query],
+      options: {
+        body: { options },
+        perPage: maxResults ?? perPage,
+        fetchClient,
+      },
+    },
+    {
+      func: dropboxSearchPacket,
+      digester: (response) => {
+        if (!response?.ok) {
+          return [];
+        }
+        return response.data?.matches ?? [];
+      },
+      paginator: dropboxSearchPaginator,
+      ...getterOptions,
+    },
+  );
+
+  if (returnGetter) {
+    return getter;
+  }
+
+  const data = await getter.run({ returnAll: true });
+
+  return {
+    ok: true,
+    data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  dropboxSearch: (...args) => dropboxSearch(false, ...args),
+  dropboxSearchGetter: (...args) => dropboxSearch(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/dropboxSearch" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "dropbox" },
+    "query": "prime",
+    "options": { "path": "/Homework" }
+  }'
+*/

package/api/dropbox/dropboxSharedLinkCreate.js

@@ -0,0 +1,68 @@
+// https://www.dropbox.com/developers/documentation/http/documentation#sharing-create_shared_link_with_settings
+
+const { ArgsWarden, logDeep } = require('../utils');
+const { credsValidator } = require('../validators');
+const { dropboxClient } = require('../dropbox/dropbox.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['path'],
+]);
+
+const dropboxSharedLinkCreate = async (
+  credsPayload,
+  path,
+  {
+    settings,
+    fetchClient = dropboxClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    path,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await fetchClient.fetch({
+    context: { credsPayload },
+    requestPayload: {
+      method: 'post',
+      url: '/sharing/create_shared_link_with_settings',
+      body: {
+        path,
+        ...(settings !== undefined && { settings }),
+      },
+    },
+  });
+
+  const { ok, data, error } = response;
+  if (!ok) {
+    logDeep({ error });
+    return { ok: false, error };
+  }
+
+  return {
+    ok: true,
+    data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  dropboxSharedLinkCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/dropboxSharedLinkCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "dropbox" },
+    "path": "/Homework/math/Prime_Numbers.txt"
+  }'
+*/