@foxtware/mineral 1.0.4 → 1.0.7

package/api/shopify/shopifyStorefrontShopGet.js

@@ -0,0 +1,81 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/shop
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const {
+  shopifyStorefrontClient,
+  buildInContextDirective,
+} = require('./shopify.utils');
+
+const defaultAttrs = `
+  id
+  name
+  description
+  primaryDomain { url host }
+  moneyFormat
+  paymentSettings {
+    currencyCode
+    acceptedCardBrands
+  }
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyStorefrontShopGet = async (
+  credsPayload,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+    inContext,
+    fetchClient = shopifyStorefrontClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const inContextDirective = buildInContextDirective(inContext);
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      body: {
+        query: `
+          query StorefrontShop${ inContextDirective } {
+            shop {
+              ${ attrs }
+            }
+          }
+        `,
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+      resultPath: 'data.shop',
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontShopGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontShopGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" }
+  }'
+*/

package/api/shopify/shopifyStorefrontShopPayPaymentRequestSessionCreate.js

@@ -0,0 +1,91 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/shopPayPaymentRequestSessionCreate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const defaultReturnSessionAttrs = `
+  id
+  sourceIdentifier
+  checkoutUrl
+  paymentRequest {
+    total {
+      amount
+      currencyCode
+    }
+  }
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['sourceIdentifier'],
+  ['paymentRequest'],
+]);
+
+const shopifyStorefrontShopPayPaymentRequestSessionCreate = async (
+  credsPayload,
+  sourceIdentifier,
+  paymentRequest,
+  {
+    apiVersion,
+    returnSessionAttrs = defaultReturnSessionAttrs,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    sourceIdentifier,
+    paymentRequest,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'shopPayPaymentRequestSessionCreate',
+    {
+      mutationVariables: {
+        sourceIdentifier: {
+          type: 'String!',
+          value: sourceIdentifier,
+        },
+        paymentRequest: {
+          type: 'ShopPayPaymentRequestInput!',
+          value: paymentRequest,
+        },
+      },
+      returnSchema: `
+        shopPayPaymentRequestSession { ${ returnSessionAttrs } }
+        userErrors { field message code }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontShopPayPaymentRequestSessionCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontShopPayPaymentRequestSessionCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "sourceIdentifier": "order-123",
+    "paymentRequest": {
+      "total": { "amount": "10.00", "currencyCode": "AUD" },
+      "lineItems": [{ "label": "Item", "amount": { "amount": "10.00", "currencyCode": "AUD" }, "quantity": 1 }]
+    }
+  }'
+*/

package/api/shopify/shopifyStorefrontShopPayPaymentRequestSessionSubmit.js

@@ -0,0 +1,95 @@
+// https://shopify.dev/docs/api/storefront/latest/mutations/shopPayPaymentRequestSessionSubmit
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyStorefrontMutationDo } = require('./shopifyStorefrontMutationDo');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['token'],
+  ['paymentRequest'],
+  ['idempotencyKey'],
+]);
+
+const shopifyStorefrontShopPayPaymentRequestSessionSubmit = async (
+  credsPayload,
+  token,
+  paymentRequest,
+  idempotencyKey,
+  {
+    apiVersion,
+    orderName,
+    inContext,
+    fetchClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    token,
+    paymentRequest,
+    idempotencyKey,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyStorefrontMutationDo(
+    credsPayload,
+    'shopPayPaymentRequestSessionSubmit',
+    {
+      mutationVariables: {
+        token: {
+          type: 'String!',
+          value: token,
+        },
+        paymentRequest: {
+          type: 'ShopPayPaymentRequestInput!',
+          value: paymentRequest,
+        },
+        idempotencyKey: {
+          type: 'String!',
+          value: idempotencyKey,
+        },
+        ...orderName !== undefined && {
+          orderName: {
+            type: 'String',
+            value: orderName,
+          },
+        },
+      },
+      returnSchema: `
+        paymentRequestReceipt {
+          token
+          processingStatusType
+        }
+        userErrors { field message code }
+      `.trim(),
+      apiVersion,
+      inContext,
+      ...fetchClient ? { fetchClient } : {},
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontShopPayPaymentRequestSessionSubmit,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontShopPayPaymentRequestSessionSubmit" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "token": "session-token",
+    "paymentRequest": {
+      "total": { "amount": "10.00", "currencyCode": "AUD" }
+    },
+    "idempotencyKey": "unique-key-123"
+  }'
+*/

package/api/shopify/shopifyStorefrontSitemapGet.js

@@ -0,0 +1,98 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/sitemap
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const {
+  shopifyStorefrontClient,
+  buildInContextDirective,
+} = require('./shopify.utils');
+
+const defaultAttrs = `
+  pagesCount {
+    count
+    precision
+  }
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['type'],
+]);
+
+const shopifyStorefrontSitemapGet = async (
+  credsPayload,
+  type,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+    page,
+    inContext,
+    fetchClient = shopifyStorefrontClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    type,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const inContextDirective = buildInContextDirective(inContext);
+
+  const resourcesBlock = page !== undefined ? `
+              resources(page: ${ page }) {
+                items {
+                  ... on SitemapResource {
+                    handle
+                    updatedAt
+                  }
+                }
+                pageInfo {
+                  hasNextPage
+                }
+              }
+` : '';
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      body: {
+        query: `
+          query StorefrontSitemap ($type: SitemapType!)${ inContextDirective } {
+            sitemap(type: $type) {
+              ${ attrs }
+              ${ resourcesBlock }
+            }
+          }
+        `,
+        variables: { type },
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+      resultPath: 'data.sitemap',
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontSitemapGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontSitemapGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "type": "PRODUCT",
+    "options": { "page": 1 }
+  }'
+*/

package/api/shopify/shopifyStorefrontUrlRedirectsGet.js

@@ -0,0 +1,67 @@
+// https://shopify.dev/docs/api/storefront/latest/queries/urlRedirects
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyStorefrontGet, shopifyStorefrontGetter } = require('./shopifyStorefrontGet');
+
+const defaultAttrs = `
+id
+  path
+  target
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyStorefrontUrlRedirectsGetInner = async (
+  returnGetter,
+  credsPayload,
+  {
+    attrs = defaultAttrs,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getterArgs = [
+    credsPayload,
+    'urlRedirect',
+    {
+      attrs,
+      resources: 'urlRedirects',
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? shopifyStorefrontGetter(...getterArgs)
+    : shopifyStorefrontGet(...getterArgs);
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStorefrontUrlRedirectsGet: (...args) => shopifyStorefrontUrlRedirectsGetInner(false, ...args),
+  shopifyStorefrontUrlRedirectsGetter: (...args) => shopifyStorefrontUrlRedirectsGetInner(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStorefrontUrlRedirectsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/slack/docs.md

@@ -0,0 +1,4 @@
+# Slack Web API
+
+- Docs: https://docs.slack.dev/apis
+- Auth: Bearer token (`xoxb-` bot or `xoxp-` user). Some methods (e.g. `search.messages`) require a user token.

package/api/slack/slack.utils.js

@@ -5,17 +5,50 @@ const {
   fetchClientCommonSteps,
 } = require('../utils');
 
+const TOKEN_KEYS_BY_TYPE = {
+  bot: 'BOT_TOKEN',
+  user: 'USER_TOKEN',
+};
+
 const useAuthHeaders = async (state) => {
   const { requestPayload, context } = state;
   const { creds } = context;
-  const { BOT_TOKEN } = creds;
+  const useTokenType = context.useTokenType || 'bot';
+  const tokenKey = TOKEN_KEYS_BY_TYPE[useTokenType];
+
+  if (!tokenKey) {
+    return {
+      breakChain: true,
+      response: {
+        ok: false,
+        error: {
+          code: 'INVALID_USE_TOKEN_TYPE',
+          message: `useTokenType must be 'bot' or 'user', got '${ useTokenType }'`,
+        },
+      },
+    };
+  }
+
+  const token = creds?.[tokenKey];
+  if (!token) {
+    return {
+      breakChain: true,
+      response: {
+        ok: false,
+        error: {
+          code: 'NO_SLACK_TOKEN',
+          message: `slack creds missing ${ tokenKey }`,
+        },
+      },
+    };
+  }
 
   return {
     requestPayload: {
       ...requestPayload,
       method: requestPayload.method || 'post',
       headers: {
-        Authorization: `Bearer ${ BOT_TOKEN }`,
+        Authorization: `Bearer ${ token }`,
         ...requestPayload.headers,
       },
     },
@@ -34,4 +67,5 @@ const slackClient = new FetchClient({
 
 module.exports = {
   slackClient,
+  TOKEN_KEYS_BY_TYPE,
 };

package/api/slack/slackMessagePost.js

@@ -23,7 +23,9 @@ const slackMessagePost = async (
   channelIdentifier,
   messagePayload,
   {
+    useTokenType = 'bot',
     inspect = false,
+    fetchClient = slackClient,
   } = {},
 ) => {
 
@@ -47,7 +49,7 @@ const slackMessagePost = async (
     markdownText,
   } = messagePayload;
 
-  const response = await slackClient.fetch({
+  const response = await fetchClient.fetch({
     requestPayload: {
       url: '/chat.postMessage',
       method: 'post',
@@ -58,7 +60,10 @@ const slackMessagePost = async (
         ...markdownText && { markdown_text: markdownText },
       },
     },
-    context: { credsPayload },
+    context: {
+      credsPayload,
+      useTokenType,
+    },
     inspect,
   });
 
@@ -80,6 +85,9 @@ curl -X POST "http://localhost:8000/slackMessagePost" \
   -d '{
     "credsPayload": { "credsPath": "slack" },
     "channelIdentifier": { "channelName": "#hidden_testing" },
-    "messagePayload": { "text": "new number, who dis?" }
+    "messagePayload": { "text": "new number, who dis?" },
+    "options": {
+      "useTokenType": "bot"
+    }
   }'
 */

package/api/slack/slackMessagesSearch.js

@@ -0,0 +1,81 @@
+// https://docs.slack.dev/reference/methods/search.messages
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { slackClient } = require('../slack/slack.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['query'],
+]);
+
+const slackMessagesSearch = async (
+  credsPayload,
+  query,
+  {
+    count,
+    page,
+    sort,
+    sortDir,
+    highlight,
+    useTokenType = 'user',
+    inspect = false,
+    fetchClient = slackClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    query,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const searchParams = new URLSearchParams({
+    query,
+    ...count != null && { count: String(count) },
+    ...page != null && { page: String(page) },
+    ...sort && { sort },
+    ...sortDir && { sort_dir: sortDir },
+    ...highlight != null && { highlight: String(highlight) },
+  });
+
+  const response = await fetchClient.fetch({
+    requestPayload: {
+      url: `/search.messages?${ searchParams }`,
+      method: 'get',
+    },
+    context: {
+      credsPayload,
+      useTokenType,
+    },
+    inspect,
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  slackMessagesSearch,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/slackMessagesSearch" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "slack" },
+    "query": "in:#project_canada_migration",
+    "options": {
+      "count": 5,
+      "sort": "timestamp",
+      "sortDir": "desc",
+      "useTokenType": "user"
+    }
+  }'
+*/