@foxtware/mineral 0.1.26 → 0.1.28

package/api/salesforce/salesforceLimitsGet.js

@@ -0,0 +1,55 @@
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_limits.htm
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { salesforceClient } = require('../salesforce/salesforce.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const salesforceLimitsGet = async (
+  credsPayload,
+  {
+    apiVersion,
+    inspect = false,
+    fetchClient = salesforceClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: '/limits',
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceLimitsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceLimitsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" }
+  }'
+*/

package/api/salesforce/salesforceQuery.js

@@ -0,0 +1,69 @@
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_query.htm
+
+const { ArgsWarden, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { salesforceClient } = require('../salesforce/salesforce.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['soql'],
+]);
+
+const salesforceQuery = async (
+  credsPayload,
+  soql,
+  {
+    apiVersion,
+    inspect = false,
+    fetchClient = salesforceClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    soql,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: '/query',
+      params: {
+        q: soql,
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceQuery,
+  funcApiConfig,
+};
+
+/*
+  curl -X POST "http://localhost:8000/salesforceQuery" \
+    -H "Content-Type: application/json" \
+    -d '{
+      "credsPayload": { "credsPath": "salesforce" },
+      "soql": "SELECT Id, Name FROM Account LIMIT 5"
+    }'
+
+  curl -X POST "http://localhost:8000/salesforceQuery" \
+    -H "Content-Type: application/json" \
+    -d '{
+      "credsPayload": {"credsPath": "salesforce"},
+      "soql": "SELECT Id, Name, Email, Phone, Account.Name FROM Contact ORDER BY LastModifiedDate DESC LIMIT 10"
+    }'
+*/

package/api/salesforce/salesforceQueryAll.js

@@ -0,0 +1,62 @@
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_queryall.htm
+
+const { ArgsWarden, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { salesforceClient } = require('../salesforce/salesforce.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['soql'],
+]);
+
+const salesforceQueryAll = async (
+  credsPayload,
+  soql,
+  {
+    apiVersion,
+    inspect = false,
+    fetchClient = salesforceClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    soql,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: '/queryAll',
+      params: {
+        q: soql,
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceQueryAll,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceQueryAll" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" },
+    "soql": "SELECT Id, Name, IsDeleted FROM Account WHERE IsDeleted = true"
+  }'
+*/

package/api/salesforce/salesforceQueryMore.js

@@ -0,0 +1,75 @@
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_query_more.htm
+
+const { ArgsWarden, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { salesforceClient } = require('../salesforce/salesforce.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['nextRecordsUrl'],
+]);
+
+/**
+ * nextRecordsUrl from a prior query response is typically
+ * /services/data/vXX.X/query/{locator}. The client prefixes
+ * {instance}/services/data/v{version}, so strip down to /query/...
+ */
+const pathFromNextRecordsUrl = (nextRecordsUrl) => {
+  const match = String(nextRecordsUrl).match(/\/services\/data\/v[\d.]+(\/.*)$/i);
+  if (match) {
+    return match[1];
+  }
+  if (String(nextRecordsUrl).startsWith('/query')) {
+    return nextRecordsUrl;
+  }
+  return `/query/${ nextRecordsUrl }`;
+};
+
+const salesforceQueryMore = async (
+  credsPayload,
+  nextRecordsUrl,
+  {
+    apiVersion,
+    inspect = false,
+    fetchClient = salesforceClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    nextRecordsUrl,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: pathFromNextRecordsUrl(nextRecordsUrl),
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceQueryMore,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceQueryMore" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" },
+    "nextRecordsUrl": "/services/data/v62.0/query/01gxx000000xxxx-2000"
+  }'
+*/

package/api/salesforce/salesforceRecentItemsGet.js

@@ -0,0 +1,63 @@
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_recent_items.htm
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { salesforceClient } = require('../salesforce/salesforce.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const salesforceRecentItemsGet = async (
+  credsPayload,
+  {
+    limit,
+    apiVersion,
+    inspect = false,
+    fetchClient = salesforceClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const params = {};
+  if (limit !== undefined) {
+    params.limit = limit;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: '/recent',
+      params,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceRecentItemsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceRecentItemsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" },
+    "options": { "limit": 10 }
+  }'
+*/

package/api/salesforce/salesforceResourcesGet.js

@@ -0,0 +1,55 @@
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_discoveryresource.htm
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { salesforceClient } = require('../salesforce/salesforce.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const salesforceResourcesGet = async (
+  credsPayload,
+  {
+    apiVersion,
+    inspect = false,
+    fetchClient = salesforceClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: '/',
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceResourcesGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceResourcesGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" }
+  }'
+*/

package/api/salesforce/salesforceSearch.js

@@ -0,0 +1,62 @@
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search.htm
+
+const { ArgsWarden, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { salesforceClient } = require('../salesforce/salesforce.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['sosl'],
+]);
+
+const salesforceSearch = async (
+  credsPayload,
+  sosl,
+  {
+    apiVersion,
+    inspect = false,
+    fetchClient = salesforceClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    sosl,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: '/search',
+      params: {
+        q: sosl,
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceSearch,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceSearch" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" },
+    "sosl": "FIND {Acme} IN ALL FIELDS RETURNING Account(Id, Name), Contact(Id, Name)"
+  }'
+*/

package/api/salesforce/salesforceSobjectBasicInfoGet.js

@@ -0,0 +1,81 @@
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_sobject_basic_info.htm
+
+const { ArgsWarden, actionSingleOrMultiple, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { salesforceClient } = require('../salesforce/salesforce.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['sobjectType'],
+]);
+
+const salesforceSobjectBasicInfoGetSingle = async (
+  credsPayload,
+  sobjectType,
+  {
+    apiVersion,
+    inspect = false,
+    fetchClient = salesforceClient,
+  } = {},
+) => {
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/sobjects/${ sobjectType }`,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const salesforceSobjectBasicInfoGet = async (
+  credsPayload,
+  sobjectType,
+  {
+    queueRunOptions,
+    ...options
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    sobjectType,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    sobjectType,
+    salesforceSobjectBasicInfoGetSingle,
+    (sobjectTypeItem) => ({
+      args: [credsPayload, sobjectTypeItem, options],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceSobjectBasicInfoGet,
+  salesforceSobjectBasicInfoGetSingle,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceSobjectBasicInfoGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" },
+    "sobjectType": "Account"
+  }'
+*/

package/api/salesforce/salesforceSobjectBlobGet.js

@@ -0,0 +1,67 @@
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_sobject_blob_retrieve.htm
+
+const { ArgsWarden, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { salesforceClient } = require('../salesforce/salesforce.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['sobjectType'],
+  ['id'],
+  ['blobField'],
+]);
+
+const salesforceSobjectBlobGet = async (
+  credsPayload,
+  sobjectType,
+  id,
+  blobField,
+  {
+    apiVersion,
+    inspect = false,
+    fetchClient = salesforceClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    sobjectType,
+    id,
+    blobField,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/sobjects/${ sobjectType }/${ id }/${ blobField }`,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceSobjectBlobGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceSobjectBlobGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" },
+    "sobjectType": "Document",
+    "id": "015xx0000000001",
+    "blobField": "Body"
+  }'
+*/

package/api/salesforce/salesforceSobjectCollectionCreate.js

@@ -0,0 +1,78 @@
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections_create.htm
+
+const { ArgsWarden, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { salesforceClient } = require('../salesforce/salesforce.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['records'],
+]);
+
+const salesforceSobjectCollectionCreate = async (
+  credsPayload,
+  records,
+  {
+    allOrNone,
+    apiVersion,
+    inspect = false,
+    fetchClient = salesforceClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    records,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const body = {
+    records,
+  };
+  if (allOrNone !== undefined) {
+    body.allOrNone = allOrNone;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url: '/composite/sobjects',
+      body,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceSobjectCollectionCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceSobjectCollectionCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" },
+    "records": [
+      {
+        "attributes": { "type": "Account" },
+        "Name": "Collection Account 1"
+      },
+      {
+        "attributes": { "type": "Account" },
+        "Name": "Collection Account 2"
+      }
+    ],
+    "options": { "allOrNone": false }
+  }'
+*/