@foxtware/mineral 0.1.26 → 0.1.28

package/api/salesforce/salesforceSobjectGet.js

@@ -0,0 +1,93 @@
+// 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 salesforceSobjectGetSingle = async (
+  credsPayload,
+  sobjectType,
+  id,
+  {
+    fields,
+    apiVersion,
+    inspect = false,
+    fetchClient = salesforceClient,
+  } = {},
+) => {
+
+  const params = {};
+  if (fields) {
+    params.fields = Array.isArray(fields) ? fields.join(',') : fields;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/sobjects/${ sobjectType }/${ id }`,
+      params,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const salesforceSobjectGet = async (
+  credsPayload,
+  sobjectType,
+  id,
+  {
+    queueRunOptions,
+    ...options
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    sobjectType,
+    id,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    id,
+    salesforceSobjectGetSingle,
+    (idItem) => ({
+      args: [credsPayload, sobjectType, idItem, options],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceSobjectGet,
+  salesforceSobjectGetSingle,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceSobjectGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" },
+    "sobjectType": "Account",
+    "id": "001xx000003DGb2AAG"
+  }'
+*/

package/api/salesforce/salesforceSobjectGetByExternalId.js

@@ -0,0 +1,98 @@
+// 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 salesforceSobjectGetByExternalIdSingle = async (
+  credsPayload,
+  sobjectType,
+  externalIdField,
+  externalId,
+  {
+    fields,
+    apiVersion,
+    inspect = false,
+    fetchClient = salesforceClient,
+  } = {},
+) => {
+
+  const params = {};
+  if (fields) {
+    params.fields = Array.isArray(fields) ? fields.join(',') : fields;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/sobjects/${ sobjectType }/${ externalIdField }/${ encodeURIComponent(externalId) }`,
+      params,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const salesforceSobjectGetByExternalId = async (
+  credsPayload,
+  sobjectType,
+  externalIdField,
+  externalId,
+  {
+    queueRunOptions,
+    ...options
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    sobjectType,
+    externalIdField,
+    externalId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    externalId,
+    salesforceSobjectGetByExternalIdSingle,
+    (externalIdItem) => ({
+      args: [credsPayload, sobjectType, externalIdField, externalIdItem, options],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceSobjectGetByExternalId,
+  salesforceSobjectGetByExternalIdSingle,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceSobjectGetByExternalId" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" },
+    "sobjectType": "Account",
+    "externalIdField": "External_Id__c",
+    "externalId": "ext-123"
+  }'
+*/

package/api/salesforce/salesforceSobjectTreeCreate.js

@@ -0,0 +1,79 @@
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobject_tree.htm
+
+const { ArgsWarden, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { salesforceClient } = require('../salesforce/salesforce.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['sobjectType'],
+  ['records'],
+]);
+
+const salesforceSobjectTreeCreate = async (
+  credsPayload,
+  sobjectType,
+  records,
+  {
+    apiVersion,
+    inspect = false,
+    fetchClient = salesforceClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    sobjectType,
+    records,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url: `/composite/tree/${ sobjectType }`,
+      body: {
+        records,
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceSobjectTreeCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceSobjectTreeCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" },
+    "sobjectType": "Account",
+    "records": [
+      {
+        "attributes": { "type": "Account", "referenceId": "ref1" },
+        "Name": "Tree Account",
+        "Contacts": {
+          "records": [
+            {
+              "attributes": { "type": "Contact", "referenceId": "ref2" },
+              "LastName": "Tree Contact"
+            }
+          ]
+        }
+      }
+    ]
+  }'
+*/

package/api/salesforce/salesforceSobjectUpdate.js

@@ -0,0 +1,94 @@
+// 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'],
+  ['record'],
+]);
+
+const salesforceSobjectUpdateSingle = async (
+  credsPayload,
+  sobjectType,
+  id,
+  record,
+  {
+    apiVersion,
+    inspect = false,
+    fetchClient = salesforceClient,
+  } = {},
+) => {
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'patch',
+      url: `/sobjects/${ sobjectType }/${ id }`,
+      body: record,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const salesforceSobjectUpdate = async (
+  credsPayload,
+  sobjectType,
+  id,
+  record,
+  {
+    queueRunOptions,
+    ...options
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    sobjectType,
+    id,
+    record,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    id,
+    salesforceSobjectUpdateSingle,
+    (idItem) => ({
+      args: [credsPayload, sobjectType, idItem, record, options],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceSobjectUpdate,
+  salesforceSobjectUpdateSingle,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceSobjectUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" },
+    "sobjectType": "Account",
+    "id": "001xx000003DGb2AAG",
+    "record": {
+      "Name": "Updated Account"
+    }
+  }'
+*/

package/api/salesforce/salesforceSobjectUpdatedGet.js

@@ -0,0 +1,71 @@
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_getupdated.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 salesforceSobjectUpdatedGet = 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 }/updated`,
+      params: {
+        start,
+        end,
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceSobjectUpdatedGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceSobjectUpdatedGet" \
+  -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/salesforceSobjectUpsert.js

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

package/api/salesforce/salesforceSobjectsDescribeGlobal.js

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

package/api/salesforce/salesforceVersionsGet.js

@@ -0,0 +1,62 @@
+// https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_versions.htm
+
+const {
+  ArgsWarden,
+  appendUrlToBase,
+  customFetch,
+} = require('../utils');
+const { credsValidator } = require('../validators');
+const { salesforceAuthGet } = require('../salesforce/salesforceAuthGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+// Versions live at {instance}/services/data/ (no vXX.X segment).
+const salesforceVersionsGet = async (
+  credsPayload,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const authResponse = await salesforceAuthGet(credsPayload);
+  if (!authResponse.ok) {
+    return authResponse;
+  }
+
+  const {
+    access_token,
+    instance_url,
+  } = authResponse.data;
+
+  const url = appendUrlToBase(instance_url, '/services/data');
+
+  return customFetch(url, {
+    method: 'get',
+    headers: {
+      Authorization: `Bearer ${ access_token }`,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  salesforceVersionsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/salesforceVersionsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "salesforce" }
+  }'
+*/

package/api/shopify/shopifyMetaobjectCreate.js

@@ -0,0 +1,72 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/metaobjectCreate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const metaobjectInputValidator = (metaobjectInput) => Boolean(metaobjectInput?.type);
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['metaobjectInput', metaobjectInputValidator],
+]);
+
+const defaultReturnMetaobjectAttrs = 'id handle type updatedAt';
+
+const shopifyMetaobjectCreate = async (
+  credsPayload,
+  metaobjectInput,
+  {
+    apiVersion,
+    returnMetaobjectAttrs = defaultReturnMetaobjectAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    metaobjectInput,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'metaobjectCreate',
+    {
+      mutationVariables: {
+        metaobject: {
+          type: 'MetaobjectCreateInput!',
+          value: metaobjectInput,
+        },
+      },
+      returnSchema: `metaobject { ${ returnMetaobjectAttrs } }`,
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyMetaobjectCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyMetaobjectCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.white-fox-us-dev-radial" },
+    "metaobjectInput": {
+      "type": "your_metaobject_type",
+      "handle": "optional-unique-handle",
+      "fields": [
+        { "key": "title", "value": "Example" },
+        { "key": "body", "value": "Some content" }
+      ]
+    }
+  }'
+*/

package/api/tableau/tableau.constants.js

@@ -0,0 +1,8 @@
+const DEFAULT_API_VERSION = '3.22';
+// Tableau's max page size for list endpoints
+const MAX_PER_PAGE = 1000;
+
+module.exports = {
+  DEFAULT_API_VERSION,
+  MAX_PER_PAGE,
+};