@foxtware/mineral 0.1.0

package/api/peoplevox/peoplevoxReportGet.js

@@ -0,0 +1,76 @@
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { peoplevoxClient } = require('../peoplevox/peoplevox.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['reportName'],
+]);
+
+const peoplevoxReportGet = async (
+  credsPayload,
+  reportName,
+  {
+    searchClause,
+    perPage,
+    filter,
+    orderBy,
+    columns,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, reportName });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const reportGetResponse = await peoplevoxClient.fetch({
+    method: 'post',
+    body: {
+      getReportRequest: {
+        TemplateName: reportName,
+        ...(searchClause ? { SearchClause: searchClause } : {}),
+        ...(perPage ? { ItemsPerPage: perPage } : {}),
+        ...(filter ? { FilterClause: filter } : {}),
+        ...(orderBy ? { OrderBy: orderBy } : {}),
+        ...(columns ? { Columns: columns.join(',') } : {}),
+      },
+    },
+    context: {
+      credsPayload,
+      action: 'GetReportData',
+    },
+  });
+
+  return reportGetResponse;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  peoplevoxReportGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/peoplevoxReportGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "peoplevox" },
+    "reportName": "Item inventory summary"
+  }'
+
+curl -X POST "http://localhost:8000/peoplevoxReportGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "peoplevox" },
+    "reportName": "Despatch summary",
+    "options": {
+      "searchClause": "([Salesorder number].Equals(\"11221660500337\"))",
+      "perPage": 50,
+      "columns": ["Salesorder number", "Despatch number", "Tracking number"]
+    }
+  }'
+*/

package/api/shopify/_example.create.js

@@ -0,0 +1,69 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/customerCreate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const thingInputValidator = (thingInput) => thingInput?.email;
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['thingInput', thingInputValidator],
+]);
+
+const defaultReturnThingAttrs = 'id';
+
+const shopifyThingCreate = async (
+  credsPayload,
+  thingInput,
+  {
+    apiVersion,
+    returnThingAttrs = defaultReturnThingAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload, 
+    thingInput,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'thingCreate',
+    {
+      mutationVariables: {
+        input: {
+          type: 'ThingInput!',
+          value: thingInput,
+        },
+      },
+      returnSchema: `
+        thing { ${ returnThingAttrs } }
+      `.trim(),
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyThingCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyThingCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "thingInput": {
+      ...
+    }
+  }'
+*/

package/api/shopify/_example.getsingle.js

@@ -0,0 +1,55 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/page
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyGetSingle } = require('../shopify/shopifyGetSingle');
+
+const defaultAttrs = 'id title handle';
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['thingId'],
+]);
+
+const FUNC = async (
+  credsPayload,
+  thingId,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, thingId });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyGetSingle(
+    credsPayload,
+    'thing',
+    thingId,
+    {
+      apiVersion,
+      attrs,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  FUNC,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/FUNC" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "thingId": "104188477512"
+  }'
+*/

package/api/shopify/_example.js

@@ -0,0 +1,45 @@
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['arg', Boolean],
+]);
+
+const FUNC = async (
+  credsPayload,
+  arg,
+  options = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, arg });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return {
+    ok: true,
+    data: {
+      arg,
+      options,
+    },
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  FUNC,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/FUNC" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "arg": "1234"
+  }'
+*/

package/api/shopify/_example.mutation.js

@@ -0,0 +1,58 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/pageDelete
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['thingId'],
+]);
+
+const FUNC = async (
+  credsPayload,
+  thingId,
+  {
+    apiVersion,
+    returnSchema = 'deletedThingId',
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, thingId });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'thingDelete',
+    {
+      mutationVariables: {
+        id: {
+          type: 'ID!',
+          value: `gid://shopify/Thing/${ thingId }`,
+        },
+      },
+      returnSchema,
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  FUNC,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/FUNC" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "thingId": "104188477512"
+  }'
+*/

package/api/shopify/shopify.constants.js

@@ -0,0 +1,7 @@
+const DEFAULT_API_VERSION = '2026-04';
+
+module.exports = {
+  DEFAULT_API_VERSION,
+  MAX_PER_PAGE: 250,
+  MAX_METAFIELDS_PER_SET: 25,
+};

package/api/shopify/shopify.utils.js

@@ -0,0 +1,123 @@
+const { DEFAULT_API_VERSION } = require('../shopify/shopify.constants');
+const {
+  FetchClient,
+  Chain,
+  appendUrlToBase,
+  fetchClientCommonSteps,
+  pathAsArray,
+  objectDigNodeAtPath,
+} = require('../utils');
+
+const handleMutationUserErrors = async (state) => {
+  const { response } = state;
+  const mutationPayload = response?.data;
+
+  if (!response?.ok || !mutationPayload || typeof mutationPayload !== 'object') {
+    return {};
+  }
+
+  const { userErrors, ...mutationResult } = mutationPayload;
+
+  if (!Array.isArray(userErrors)) {
+    return {};
+  }
+
+  if (userErrors.length) {
+    const message = userErrors
+      .map((userError) => userError?.message)
+      .filter(Boolean)
+      .join('; ');
+
+    return {
+      response: {
+        ok: false,
+        error: {
+          code: 'USER_ERROR',
+          message: message || 'Mutation failed',
+          details: userErrors,
+        },
+        ...(Object.keys(mutationResult).length ? { data: mutationResult } : {}),
+      },
+      breakChain: true,
+    };
+  }
+
+  return {
+    response: {
+      data: mutationResult,
+    },
+  };
+};
+
+const addUrlAndAuthHeaders = async (state) => {
+  const { requestPayload, context } = state;
+  const {
+    creds,
+    apiVersion = DEFAULT_API_VERSION,
+  } = context;
+  const {
+    STORE_HANDLE,
+    API_KEY,
+  } = creds;
+
+  const baseUrl = `https://${ STORE_HANDLE }.myshopify.com/admin/api/${ apiVersion }/graphql.json`;
+  const baseHeaders = {
+    'X-Shopify-Access-Token': API_KEY,
+  };
+
+  return {
+    requestPayload: {
+      url: appendUrlToBase(baseUrl, requestPayload.url),
+      headers: {
+        ...baseHeaders,
+        ...requestPayload.headers,
+      },
+    },
+  };
+};
+
+const movePageInfoToMeta = async (state) => {
+  const { response, context } = state;
+  const { resultPath } = context ?? {};
+
+  if (!response?.ok || !response?.data || !resultPath) {
+    return {};
+  }
+
+  const connection = objectDigNodeAtPath(response.data, pathAsArray(resultPath));
+
+  if (!connection?.pageInfo) {
+    return {};
+  }
+
+  return {
+    response: {
+      meta: {
+        pageInfo: connection.pageInfo,
+      },
+    },
+  };
+};
+
+const shopifyClientRequestPreparer = new Chain([
+  addUrlAndAuthHeaders,
+]);
+
+const shopifyClientResponseInterpreter = new Chain([
+  movePageInfoToMeta,
+  fetchClientCommonSteps.stripEdgesAndNodes,
+  fetchClientCommonSteps.collapseDataWithOneValue,
+  fetchClientCommonSteps.exitEarlyOnNotOk,
+  fetchClientCommonSteps.exitEarlyOnGraphqlErrors,
+  fetchClientCommonSteps.digToPath,
+  handleMutationUserErrors,
+]);
+
+const shopifyClient = new FetchClient({
+  requestPreparer: shopifyClientRequestPreparer,
+  responseInterpreter: shopifyClientResponseInterpreter,
+});
+
+module.exports = {
+  shopifyClient,
+};

package/api/shopify/shopifyCollectionGet.js

@@ -0,0 +1,109 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/collection
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden, objHasAny, credsFromPayload } = require('../utils');
+const { shopifyGetSingle } = require('../shopify/shopifyGetSingle');
+const { shopifyClient } = require('../shopify/shopify.utils');
+
+const defaultAttrs = 'id title handle';
+
+const collectionIdentifierValidator = (collectionIdentifier) => {
+  return objHasAny(collectionIdentifier, [
+    'customId',
+    'id',
+    'handle',
+  ]);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['collectionIdentifier', collectionIdentifierValidator],
+]);
+
+const shopifyCollectionGet = async (
+  credsPayload,
+  collectionIdentifier,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, collectionIdentifier });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const { 
+    customId, 
+    id, 
+    handle,
+  } = collectionIdentifier;
+
+  if (!id) {
+
+    const creds = await credsFromPayload(credsPayload);
+
+    const query = `
+      query GetCollectionByIdentifier ($identifier: CollectionIdentifierInput!) {
+        collection: collectionByIdentifier(identifier: $identifier) {
+          ${ attrs }
+        }
+      }
+    `;
+
+    const variables = {
+      identifier: {
+        ...customId && { customId },
+        ...handle && { handle },
+      },
+    };
+
+    const response = await shopifyClient.fetch({
+      method: 'post',
+      body: { query, variables },
+      context: {
+        creds,
+        apiVersion,
+        resultPath: 'data.collection',
+      },
+    });
+
+    return response;
+  }
+
+  return shopifyGetSingle(
+    credsPayload,
+    'collection',
+    collectionIdentifier,
+    {
+      apiVersion,
+      attrs,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyCollectionGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyCollectionGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "collectionIdentifier": { "id": "279980277832" }
+  }'
+
+curl -X POST "http://localhost:8000/shopifyCollectionGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "collectionIdentifier": { "handle": "new-arrivals" }
+  }'
+*/

package/api/shopify/shopifyCustomerCreate.js

@@ -0,0 +1,71 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/customerCreate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const customerInputValidator = (customerInput) => customerInput?.email;
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerInput', customerInputValidator],
+]);
+
+const defaultReturnCustomerAttrs = 'id email';
+
+const shopifyCustomerCreate = async (
+  credsPayload,
+  customerInput,
+  {
+    apiVersion,
+    returnCustomerAttrs = defaultReturnCustomerAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload, 
+    customerInput,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'customerCreate',
+    {
+      mutationVariables: {
+        input: {
+          type: 'CustomerInput!',
+          value: customerInput,
+        },
+      },
+      returnSchema: `
+        customer { ${ returnCustomerAttrs } }
+      `.trim(),
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyCustomerCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyCustomerCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "customerInput": {
+      "email": "john+shopifyCustomerCreate@whitefoxboutique.com",
+      "firstName": "Doctor",
+      "lastName": "Manhattan"
+    }
+  }'
+*/