@foxtware/mineral 0.1.27 → 0.1.28

package/api/salesforce/salesforceSobjectCollectionDelete.js

@@ -0,0 +1,70 @@
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections_delete.htm
+
+const { ArgsWarden, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { salesforceClient } = require('../salesforce/salesforce.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['ids'],
+]);
+
+const salesforceSobjectCollectionDelete = async (
+  credsPayload,
+  ids,
+  {
+    allOrNone,
+    apiVersion,
+    inspect = false,
+    fetchClient = salesforceClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    ids,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const idList = Array.isArray(ids) ? ids.join(',') : ids;
+
+  const params = {
+    ids: idList,
+  };
+  if (allOrNone !== undefined) {
+    params.allOrNone = allOrNone;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'delete',
+      url: '/composite/sobjects',
+      params,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceSobjectCollectionDelete,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceSobjectCollectionDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" },
+    "ids": ["001xx000003DGb2AAG", "001xx000003DGb3AAG"]
+  }'
+*/

package/api/salesforce/salesforceSobjectCollectionGet.js

@@ -0,0 +1,75 @@
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections_retrieve.htm
+
+const { ArgsWarden, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { salesforceClient } = require('../salesforce/salesforce.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['sobjectType'],
+  ['ids'],
+]);
+
+const salesforceSobjectCollectionGet = async (
+  credsPayload,
+  sobjectType,
+  ids,
+  {
+    fields,
+    apiVersion,
+    inspect = false,
+    fetchClient = salesforceClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    sobjectType,
+    ids,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const idList = Array.isArray(ids) ? ids.join(',') : ids;
+
+  const params = {
+    ids: idList,
+  };
+  if (fields) {
+    params.fields = Array.isArray(fields) ? fields.join(',') : fields;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/composite/sobjects/${ sobjectType }`,
+      params,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceSobjectCollectionGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceSobjectCollectionGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" },
+    "sobjectType": "Account",
+    "ids": ["001xx000003DGb2AAG"],
+    "options": { "fields": ["Id", "Name"] }
+  }'
+*/

package/api/salesforce/salesforceSobjectCollectionUpdate.js

@@ -0,0 +1,74 @@
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections_update.htm
+
+const { ArgsWarden, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { salesforceClient } = require('../salesforce/salesforce.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['records'],
+]);
+
+const salesforceSobjectCollectionUpdate = 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: 'patch',
+      url: '/composite/sobjects',
+      body,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceSobjectCollectionUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceSobjectCollectionUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" },
+    "records": [
+      {
+        "attributes": { "type": "Account" },
+        "Id": "001xx000003DGb2AAG",
+        "Name": "Updated via collection"
+      }
+    ]
+  }'
+*/

package/api/salesforce/salesforceSobjectCreate.js

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

package/api/salesforce/salesforceSobjectDelete.js

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

package/api/salesforce/salesforceSobjectDeleteByExternalId.js

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

package/api/salesforce/salesforceSobjectDeletedGet.js

@@ -0,0 +1,71 @@
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_getdeleted.htm
+
+const { ArgsWarden, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { salesforceClient } = require('../salesforce/salesforce.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['sobjectType'],
+  ['start'],
+  ['end'],
+]);
+
+const salesforceSobjectDeletedGet = async (
+  credsPayload,
+  sobjectType,
+  start,
+  end,
+  {
+    apiVersion,
+    inspect = false,
+    fetchClient = salesforceClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    sobjectType,
+    start,
+    end,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/sobjects/${ sobjectType }/deleted`,
+      params: {
+        start,
+        end,
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceSobjectDeletedGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceSobjectDeletedGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" },
+    "sobjectType": "Account",
+    "start": "2026-01-01T00:00:00+00:00",
+    "end": "2026-01-02T00:00:00+00:00"
+  }'
+*/

package/api/salesforce/salesforceSobjectDescribe.js

@@ -0,0 +1,81 @@
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_sobject_describe.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 salesforceSobjectDescribeSingle = async (
+  credsPayload,
+  sobjectType,
+  {
+    apiVersion,
+    inspect = false,
+    fetchClient = salesforceClient,
+  } = {},
+) => {
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/sobjects/${ sobjectType }/describe`,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const salesforceSobjectDescribe = async (
+  credsPayload,
+  sobjectType,
+  {
+    queueRunOptions,
+    ...options
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    sobjectType,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    sobjectType,
+    salesforceSobjectDescribeSingle,
+    (sobjectTypeItem) => ({
+      args: [credsPayload, sobjectTypeItem, options],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceSobjectDescribe,
+  salesforceSobjectDescribeSingle,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceSobjectDescribe" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" },
+    "sobjectType": "Account"
+  }'
+*/

package/api/salesforce/salesforceSobjectDescribeLayouts.js

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