@foxtware/mineral 0.1.27 → 0.1.29

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/shopify.utils.js

@@ -76,6 +76,31 @@ const useUrlAndAuthHeaders = async (state) => {
   };
 };
 
+const useStorefrontUrlAndAuthHeaders = async (state) => {
+  const { requestPayload, context } = state;
+  const {
+    apiVersion = DEFAULT_API_VERSION,
+    creds,
+  } = context;
+  const {
+    STORE_HANDLE,
+    STOREFRONT_API_KEY,
+  } = creds;
+
+  const baseUrl = `https://${ STORE_HANDLE }.myshopify.com/api/${ apiVersion }/graphql.json`;
+
+  return {
+    requestPayload: {
+      ...requestPayload,
+      url: appendUrlToBase(baseUrl, requestPayload.url),
+      headers: {
+        'X-Shopify-Storefront-Access-Token': STOREFRONT_API_KEY,
+        ...requestPayload.headers,
+      },
+    },
+  };
+};
+
 const movePageInfoToMeta = async (state) => {
   const { response, context } = state;
   const { resultPath } = context ?? {};
@@ -86,15 +111,23 @@ const movePageInfoToMeta = async (state) => {
 
   const connection = objectDigNodeAtPath(response.data, pathAsArray(resultPath));
 
-  if (!connection?.pageInfo) {
+  if (!connection || typeof connection !== 'object') {
+    return {};
+  }
+
+  const meta = {
+    ...connection.pageInfo ? { pageInfo: connection.pageInfo } : {},
+    ...connection.totalCount !== undefined ? { totalCount: connection.totalCount } : {},
+    ...connection.productFilters !== undefined ? { productFilters: connection.productFilters } : {},
+  };
+
+  if (!Object.keys(meta).length) {
     return {};
   }
 
   return {
     response: {
-      meta: {
-        pageInfo: connection.pageInfo,
-      },
+      meta,
     },
   };
 };
@@ -188,7 +221,23 @@ const shopifyClient = new FetchClient({
   ],
 });
 
+const shopifyStorefrontClient = new FetchClient({
+  pipeline: [
+    resolveCreds,
+    useStorefrontUrlAndAuthHeaders,
+    'fetch',
+    movePageInfoToMeta,
+    fetchClientCommonSteps.stripEdgesAndNodes,
+    fetchClientCommonSteps.collapseDataWithOneValue,
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+    fetchClientCommonSteps.exitEarlyOnGraphqlErrors,
+    fetchClientCommonSteps.digToPath,
+    handleMutationUserErrors,
+  ],
+});
+
 module.exports = {
   parseShopifyJsonl,
   shopifyClient,
+  shopifyStorefrontClient,
 };

package/api/shopify/shopifyMetaobjectCreate.js

@@ -0,0 +1,79 @@
+// 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 capabilities { publishable { status } }';
+
+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.au" },
+    "metaobjectInput": {
+      "type": "catalog_filter_blacklist",
+      "handle": "collection-blacklist-example",
+      "capabilities": {
+        "publishable": {
+          "status": "ACTIVE"
+        }
+      },
+      "fields": [
+        { "key": "internal_name", "value": "Blacklist Category > \"Example\"" },
+        { "key": "source_filter", "value": "Category" },
+        { "key": "values", "value": "[\"Example\"]" },
+        { "key": "enabled", "value": "true" }
+      ]
+    }
+  }'
+*/

package/api/shopify/shopifyMetaobjectDelete.js

@@ -0,0 +1,90 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/metaobjectDelete
+
+const { credsValidator } = require('../validators');
+const { actionSingleOrMultiple, ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['metaobjectId'],
+]);
+
+const shopifyMetaobjectDeleteSingle = async (
+  credsPayload,
+  metaobjectId,
+  {
+    apiVersion,
+    returnSchema = 'deletedId',
+  } = {},
+) => {
+
+  return shopifyMutationDo(
+    credsPayload,
+    'metaobjectDelete',
+    {
+      mutationVariables: {
+        id: {
+          type: 'ID!',
+          value: `gid://shopify/Metaobject/${ metaobjectId }`,
+        },
+      },
+      returnSchema,
+      apiVersion,
+    },
+  );
+};
+
+const shopifyMetaobjectDelete = async (
+  credsPayload,
+  metaobjectId,
+  {
+    queueRunOptions,
+    apiVersion,
+    returnSchema = 'deletedId',
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    metaobjectId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    metaobjectId,
+    shopifyMetaobjectDeleteSingle,
+    (metaobjectIdItem) => ({
+      args: [credsPayload, metaobjectIdItem, { apiVersion, returnSchema }],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyMetaobjectDelete,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyMetaobjectDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "metaobjectId": "215094820924"
+  }'
+
+curl -X POST "http://localhost:8000/shopifyMetaobjectDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "metaobjectId": ["215094820924", "215094820925"]
+  }'
+*/

package/api/shopify/shopifyMetaobjectGet.js

@@ -0,0 +1,80 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/metaobject
+
+const { credsValidator } = require('../validators');
+const { actionSingleOrMultiple, ArgsWarden } = require('../utils');
+const { shopifyGetSingle } = require('../shopify/shopifyGetSingle');
+
+const defaultAttrs = 'id handle type updatedAt capabilities { publishable { status } } fields { key value type }';
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['metaobjectId'],
+]);
+
+const shopifyMetaobjectGetSingle = async (
+  credsPayload,
+  metaobjectId,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+  } = {},
+) => {
+
+  return shopifyGetSingle(
+    credsPayload,
+    'metaobject',
+    metaobjectId,
+    {
+      apiVersion,
+      attrs,
+    },
+  );
+};
+
+const shopifyMetaobjectGet = async (
+  credsPayload,
+  metaobjectId,
+  {
+    queueRunOptions,
+    apiVersion,
+    attrs = defaultAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    metaobjectId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    metaobjectId,
+    shopifyMetaobjectGetSingle,
+    (metaobjectIdItem) => ({
+      args: [credsPayload, metaobjectIdItem, { apiVersion, attrs }],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyMetaobjectGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyMetaobjectGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "metaobjectId": "207864102984"
+  }'
+*/