@foxtware/mineral 0.1.27 → 0.1.29

package/api/linear/linearIssueUpdate.js

@@ -7,7 +7,7 @@ const { linearClient } = require('../linear/linear.utils');
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
   ['id'],
-  ['input', valueProvided],
+  ['input'],
 ]);
 
 const linearIssueUpdate = async (

package/api/linear/linearProjectCreate.js

@@ -6,7 +6,7 @@ const { linearClient } = require('../linear/linear.utils');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
-  ['input', valueProvided],
+  ['input'],
 ]);
 
 const linearProjectCreate = async (

package/api/linear/linearProjectUpdate.js

@@ -7,7 +7,7 @@ const { linearClient } = require('../linear/linear.utils');
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
   ['id'],
-  ['input', valueProvided],
+  ['input'],
 ]);
 
 const linearProjectUpdate = async (

package/api/linear/linearWebhookCreate.js

@@ -6,7 +6,7 @@ const { linearClient } = require('../linear/linear.utils');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
-  ['input', valueProvided],
+  ['input'],
 ]);
 
 const linearWebhookCreate = async (

package/api/salesforce/salesforce.constants.js

@@ -0,0 +1,13 @@
+const DEFAULT_API_VERSION = '62.0';
+const DEFAULT_LOGIN_URL = 'https://login.salesforce.com';
+
+// Query result page size is controlled by SOQL; next page uses nextRecordsUrl.
+// SObject list endpoints typically allow up to 2000 in some contexts; REST query
+// uses the default batch size (often 2000 max via headers / tooling).
+const MAX_PER_PAGE = 2000;
+
+module.exports = {
+  DEFAULT_API_VERSION,
+  DEFAULT_LOGIN_URL,
+  MAX_PER_PAGE,
+};

package/api/salesforce/salesforce.utils.js

@@ -0,0 +1,61 @@
+const { DEFAULT_API_VERSION } = require('../salesforce/salesforce.constants');
+const { salesforceAuthGet } = require('../salesforce/salesforceAuthGet');
+const { resolveCreds } = require('../pipelineSteps');
+const {
+  FetchClient,
+  appendUrlToBase,
+  fetchClientCommonSteps,
+} = require('../utils');
+
+const useUrlAndAuthHeaders = async (state) => {
+  const { requestPayload, context } = state;
+  const {
+    apiVersion = DEFAULT_API_VERSION,
+    creds,
+  } = context;
+
+  const authResponse = await salesforceAuthGet({
+    credsObject: creds,
+  });
+
+  if (!authResponse?.ok) {
+    return {
+      breakChain: true,
+      response: authResponse,
+    };
+  }
+
+  const {
+    access_token,
+    instance_url,
+  } = authResponse.data;
+
+  const dataBase = appendUrlToBase(
+    instance_url,
+    `/services/data/v${ apiVersion }`,
+  );
+
+  return {
+    requestPayload: {
+      ...requestPayload,
+      url: appendUrlToBase(dataBase, requestPayload.url),
+      headers: {
+        Authorization: `Bearer ${ access_token }`,
+        ...requestPayload.headers,
+      },
+    },
+  };
+};
+
+const salesforceClient = new FetchClient({
+  pipeline: [
+    resolveCreds,
+    useUrlAndAuthHeaders,
+    'fetch',
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+  ],
+});
+
+module.exports = {
+  salesforceClient,
+};

package/api/salesforce/salesforceAuthGet.js

@@ -0,0 +1,115 @@
+// https://help.salesforce.com/s/articleView?id=xcloud.remoteaccess_oauth_client_credentials_flow_ca.htm
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_understanding_authentication.htm
+
+const {
+  ArgsWarden,
+  appendUrlToBase,
+  credsFromPayload,
+  customFetch,
+} = require('../utils');
+const { credsValidator } = require('../validators');
+const { DEFAULT_LOGIN_URL } = require('../salesforce/salesforce.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const salesforceAuthGet = async (
+  credsPayload,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+  const {
+    ACCESS_TOKEN,
+    INSTANCE_URL,
+    CLIENT_ID,
+    CLIENT_SECRET,
+    LOGIN_URL = DEFAULT_LOGIN_URL,
+  } = creds ?? {};
+
+  if (ACCESS_TOKEN && INSTANCE_URL) {
+    return {
+      ok: true,
+      data: {
+        access_token: ACCESS_TOKEN,
+        instance_url: INSTANCE_URL,
+      },
+    };
+  }
+
+  if (!CLIENT_ID || !CLIENT_SECRET) {
+    return {
+      ok: false,
+      error: {
+        code: 'INVALID_CREDS',
+        message: 'Provide ACCESS_TOKEN and INSTANCE_URL, or CLIENT_ID and CLIENT_SECRET for client credentials.',
+      },
+    };
+  }
+
+  const tokenUrl = appendUrlToBase(LOGIN_URL, '/services/oauth2/token');
+
+  const tokenResponse = await customFetch(tokenUrl, {
+    method: 'post',
+    headers: {
+      'Content-Type': 'application/x-www-form-urlencoded',
+    },
+    body: new URLSearchParams({
+      grant_type: 'client_credentials',
+      client_id: CLIENT_ID,
+      client_secret: CLIENT_SECRET,
+    }),
+  });
+
+  if (!tokenResponse.ok) {
+    return tokenResponse;
+  }
+
+  const {
+    access_token,
+    instance_url,
+  } = tokenResponse.data ?? {};
+
+  if (!access_token || !instance_url) {
+    return {
+      ok: false,
+      error: {
+        code: 'AUTH_FAILED',
+        message: 'Salesforce did not return access_token and instance_url.',
+        details: tokenResponse.data,
+      },
+    };
+  }
+
+  return {
+    ok: true,
+    data: {
+      access_token,
+      instance_url,
+    },
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceAuthGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceAuthGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" }
+  }'
+*/

package/api/salesforce/salesforceComposite.js

@@ -0,0 +1,79 @@
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_composite.htm
+
+const { ArgsWarden, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { salesforceClient } = require('../salesforce/salesforce.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['compositeRequest'],
+]);
+
+const salesforceComposite = async (
+  credsPayload,
+  compositeRequest,
+  {
+    allOrNone,
+    collateSubrequests,
+    apiVersion,
+    inspect = false,
+    fetchClient = salesforceClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    compositeRequest,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const body = {
+    compositeRequest,
+  };
+  if (allOrNone !== undefined) {
+    body.allOrNone = allOrNone;
+  }
+  if (collateSubrequests !== undefined) {
+    body.collateSubrequests = collateSubrequests;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url: '/composite',
+      body,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceComposite,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceComposite" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" },
+    "compositeRequest": [
+      {
+        "method": "GET",
+        "url": "/services/data/v62.0/sobjects/Account/001xx000003DGb2AAG",
+        "referenceId": "refAccount"
+      }
+    ],
+    "options": { "allOrNone": true }
+  }'
+*/

package/api/salesforce/salesforceCompositeBatch.js

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

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 }
+  }'
+*/