@foxtware/mineral 0.1.15 → 0.1.17

package/api/shopify/shopifyProductGet.js

@@ -0,0 +1,110 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/product
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/productByIdentifier
+
+const { credsValidator } = require('../validators');
+const { objHasAny, ArgsWarden } = require('../utils');
+const { shopifyGetSingle } = require('../shopify/shopifyGetSingle');
+const { shopifyClient } = require('../shopify/shopify.utils');
+
+const defaultAttrs = 'id handle';
+
+const productIdentifierValidator = (productIdentifier) => {
+  return objHasAny(productIdentifier, [
+    'productId',
+    'handle',
+  ]);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['productIdentifier', productIdentifierValidator],
+]);
+
+const shopifyProductGet = async (
+  credsPayload,
+  productIdentifier,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    productIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const {
+    productId,
+    handle,
+  } = productIdentifier;
+
+  if (!productId) {
+    const query = `
+      query GetProductByIdentifier ($identifier: ProductIdentifierInput!) {
+        product: productByIdentifier(identifier: $identifier) {
+          ${ attrs }
+        }
+      }
+    `;
+
+    const response = await shopifyClient.fetch({
+      requestPayload: {
+        method: 'post',
+        body: {
+          query,
+          variables: {
+            identifier: {
+              ...(handle && { handle }),
+            },
+          },
+        },
+      },
+      context: {
+        credsPayload,
+        apiVersion,
+        resultPath: 'data.product',
+      },
+    });
+
+    return response;
+  }
+
+  return shopifyGetSingle(
+    credsPayload,
+    'product',
+    productId,
+    {
+      apiVersion,
+      attrs,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyProductGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyProductGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "productIdentifier": { "productId": "1234567890" }
+  }'
+
+curl -X POST "http://localhost:8000/shopifyProductGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "productIdentifier": { "handle": "master-ball" }
+  }'
+*/

package/api/shopify/shopifyProductVariantsGet.js

@@ -15,7 +15,7 @@ const shopifyProductVariantsGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
   });
   if (rejectResponse) {

package/api/shopify/shopifyProductsGet.js

@@ -2,27 +2,39 @@
 
 const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
-const { shopifyGet } = require('./shopifyGet');
+const { shopifyGet, shopifyGetter } = require('./shopifyGet');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
 ]);
 
 const shopifyProductsGet = async (
+  returnGetter, // Always bound
+
   credsPayload,
   {
     ...getterOptions // e.g. limit
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
   });
   if (rejectResponse) {
     return rejectResponse;
   }
 
-  return await shopifyGet(credsPayload, 'product', { ...getterOptions });
+  const getterArgs = [
+    credsPayload, 
+    'product', 
+    {
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? shopifyGetter(...getterArgs)
+    : shopifyGet(...getterArgs);
 };
 
 const funcApiConfig = {
@@ -30,7 +42,8 @@ const funcApiConfig = {
 };
 
 module.exports = {
-  shopifyProductsGet,
+  shopifyProductsGet: (...args) => shopifyProductsGet(false, ...args),
+  shopifyProductsGetter: (...args) => shopifyProductsGet(true, ...args),
   funcApiConfig,
 };
 

package/api/shopify/shopifyPublicationsGet.js

@@ -2,27 +2,39 @@
 
 const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
-const { shopifyGet } = require('./shopifyGet');
+const { shopifyGet, shopifyGetter } = require('./shopifyGet');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
 ]);
 
 const shopifyPublicationsGet = async (
+  returnGetter, // Always bound
+
   credsPayload,
   {
     ...getterOptions // e.g. limit
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
   });
   if (rejectResponse) {
     return rejectResponse;
   }
 
-  return await shopifyGet(credsPayload, 'publication', { ...getterOptions });
+  const getterArgs = [
+    credsPayload, 
+    'publication', 
+    {
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? shopifyGetter(...getterArgs)
+    : shopifyGet(...getterArgs);
 };
 
 const funcApiConfig = {
@@ -30,7 +42,8 @@ const funcApiConfig = {
 };
 
 module.exports = {
-  shopifyPublicationsGet,
+  shopifyPublicationsGet: (...args) => shopifyPublicationsGet(false, ...args),
+  shopifyPublicationsGetter: (...args) => shopifyPublicationsGet(true, ...args),
   funcApiConfig,
 };
 

package/api/shopify/shopifySegmentsGet.js

@@ -15,7 +15,7 @@ const shopifySegmentsGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
   });
   if (rejectResponse) {

package/api/shopify/shopifyStoreCreditAccountCredit.js

@@ -0,0 +1,144 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/storeCreditAccountCredit
+
+const { credsValidator } = require('../validators');
+const { actionSingleOrMultiple, everyIfArray, ArgsWarden, valueProvided } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const creditPayloadValidator = (creditPayload) => {
+  return valueProvided(creditPayload?.amount)
+    && creditPayload?.currencyCode;
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['ownerOrAccountGid'],
+  ['creditPayload', (i) => everyIfArray(creditPayloadValidator, i)],
+]);
+
+const defaultReturnSchema = `
+  storeCreditAccountTransaction {
+    amount {
+      amount
+      currencyCode
+    }
+    account {
+      id
+      balance {
+        amount
+        currencyCode
+      }
+    }
+  }
+`.trim();
+
+const shopifyStoreCreditAccountCreditSingle = async (
+  credsPayload,
+  ownerOrAccountGid,
+  creditPayload,
+  {
+    apiVersion,
+    returnSchema = defaultReturnSchema,
+  } = {},
+) => {
+
+  const {
+    amount,
+    currencyCode,
+    expiresAt,
+  } = creditPayload;
+
+  return shopifyMutationDo(
+    credsPayload,
+    'storeCreditAccountCredit',
+    {
+      mutationVariables: {
+        id: {
+          type: 'ID!',
+          value: ownerOrAccountGid,
+        },
+        creditInput: {
+          type: 'StoreCreditAccountCreditInput!',
+          value: {
+            creditAmount: {
+              amount: String(amount),
+              currencyCode,
+            },
+            ...(expiresAt && { expiresAt }),
+          },
+        },
+      },
+      returnSchema,
+      apiVersion,
+    },
+  );
+};
+
+const shopifyStoreCreditAccountCredit = async (
+  credsPayload,
+  ownerOrAccountGid,
+  creditPayload,
+  {
+    queueRunOptions,
+    apiVersion,
+    returnSchema = defaultReturnSchema,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    ownerOrAccountGid,
+    creditPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    creditPayload,
+    shopifyStoreCreditAccountCreditSingle,
+    (creditPayloadItem) => ({
+      args: [
+        credsPayload,
+        ownerOrAccountGid,
+        creditPayloadItem,
+        { apiVersion, returnSchema },
+      ],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStoreCreditAccountCredit,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStoreCreditAccountCredit" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "ownerOrAccountGid": "gid://shopify/Customer/5736896757832",
+    "creditPayload": {
+      "amount": "10.00",
+      "currencyCode": "AUD"
+    }
+  }'
+
+curl -X POST "http://localhost:8000/shopifyStoreCreditAccountCredit" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "ownerOrAccountGid": "gid://shopify/Customer/5736896757832",
+    "creditPayload": [
+      { "amount": "10.00", "currencyCode": "AUD", "expiresAt": "2027-07-16T13:59:59Z" },
+      { "amount": "5.00", "currencyCode": "USD" }
+    ]
+  }'
+*/

package/api/shopify/shopifyStoreCreditAccountDebit.js

@@ -0,0 +1,132 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/storeCreditAccountDebit
+
+const { credsValidator } = require('../validators');
+const { actionSingleOrMultiple, everyIfArray, ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const debitAmountValidator = (debitAmount) => {
+  return debitAmount?.amount !== undefined
+    && debitAmount?.amount !== null
+    && debitAmount?.currencyCode;
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['ownerOrAccountGid'],
+  ['debitAmount', (i) => everyIfArray(debitAmountValidator, i)],
+]);
+
+const defaultReturnSchema = `
+  storeCreditAccountTransaction {
+    amount {
+      amount
+      currencyCode
+    }
+    account {
+      id
+      balance {
+        amount
+        currencyCode
+      }
+    }
+  }
+`.trim();
+
+const shopifyStoreCreditAccountDebitSingle = async (
+  credsPayload,
+  ownerOrAccountGid,
+  debitAmount,
+  {
+    apiVersion,
+    returnSchema = defaultReturnSchema,
+  } = {},
+) => {
+
+  const {
+    amount,
+    currencyCode,
+  } = debitAmount;
+
+  return shopifyMutationDo(
+    credsPayload,
+    'storeCreditAccountDebit',
+    {
+      mutationVariables: {
+        id: {
+          type: 'ID!',
+          value: ownerOrAccountGid,
+        },
+        debitInput: {
+          type: 'StoreCreditAccountDebitInput!',
+          value: {
+            debitAmount: {
+              amount: String(amount),
+              currencyCode,
+            },
+          },
+        },
+      },
+      returnSchema,
+      apiVersion,
+    },
+  );
+};
+
+const shopifyStoreCreditAccountDebit = async (
+  credsPayload,
+  ownerOrAccountGid,
+  debitAmount,
+  {
+    queueRunOptions,
+    apiVersion,
+    returnSchema = defaultReturnSchema,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    ownerOrAccountGid,
+    debitAmount,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    debitAmount,
+    shopifyStoreCreditAccountDebitSingle,
+    (debitAmountItem) => ({
+      args: [
+        credsPayload,
+        ownerOrAccountGid,
+        debitAmountItem,
+        { apiVersion, returnSchema },
+      ],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStoreCreditAccountDebit,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStoreCreditAccountDebit" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "ownerOrAccountGid": "gid://shopify/StoreCreditAccount/11862088",
+    "debitAmount": {
+      "amount": "10.00",
+      "currencyCode": "AUD"
+    }
+  }'
+*/

package/api/shopify/shopifyThemeDelete.js

@@ -44,7 +44,10 @@ const shopifyThemeDelete = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, themeId });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    themeId,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/shopify/shopifyThemeDuplicate.js

@@ -19,7 +19,10 @@ const shopifyThemeDuplicate = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, themeId });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    themeId,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/shopify/shopifyThemeGet.js

@@ -20,8 +20,8 @@ const shopifyThemeGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
-    credsPayload, 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
     themeId,
   });
   if (rejectResponse) {

package/api/shopify/shopifyThemesGet.js

@@ -19,7 +19,9 @@ const shopifyThemesGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/shopify/shopifyUrlRedirectsGet.js

@@ -15,7 +15,7 @@ const shopifyUrlRedirectsGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
   });
   if (rejectResponse) {

package/api/shopify/shopifyWebhookSubscriptionsGet.js

@@ -2,27 +2,39 @@
 
 const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
-const { shopifyGet } = require('./shopifyGet');
+const { shopifyGet, shopifyGetter } = require('./shopifyGet');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
 ]);
 
 const shopifyWebhookSubscriptionsGet = async (
+  returnGetter, // Always bound
+
   credsPayload,
   {
     ...getterOptions // e.g. limit
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
   });
   if (rejectResponse) {
     return rejectResponse;
   }
 
-  return await shopifyGet(credsPayload, 'webhookSubscription', { ...getterOptions });
+  const getterArgs = [
+    credsPayload, 
+    'webhookSubscription', 
+    {
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? shopifyGetter(...getterArgs)
+    : shopifyGet(...getterArgs);
 };
 
 const funcApiConfig = {
@@ -30,7 +42,8 @@ const funcApiConfig = {
 };
 
 module.exports = {
-  shopifyWebhookSubscriptionsGet,
+  shopifyWebhookSubscriptionsGet: (...args) => shopifyWebhookSubscriptionsGet(false, ...args),
+  shopifyWebhookSubscriptionsGetter: (...args) => shopifyWebhookSubscriptionsGet(true, ...args),
   funcApiConfig,
 };
 

package/api/snowflake/docs.md

@@ -0,0 +1,8 @@
+# Snowflake
+
+- [Developer documentation](https://docs.snowflake.com/en/developer-guide)
+- [SQL API](https://docs.snowflake.com/en/developer-guide/sql-api/index)
+- [SQL API reference](https://docs.snowflake.com/en/developer-guide/sql-api/reference)
+- [Authenticating to the SQL API](https://docs.snowflake.com/en/developer-guide/sql-api/authenticating)
+
+Account-scoped HTTPS JSON API at `https://{account_identifier}.snowflakecomputing.com/api/v2/statements` for submitting SQL, polling handles, and canceling runs, authenticated with OAuth or key-pair JWT rather than a single static API key.

package/api/starshipit/starshipitAddressesGet.js

@@ -17,7 +17,9 @@ const starshipitAddressesGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/starshipit/starshipitOrdersListShipped.js

@@ -17,7 +17,9 @@ const starshipitOrdersListShipped = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/starshipit/starshipitProductsGet.js

@@ -16,7 +16,9 @@ const starshipitProductsGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/stripe/_example.js

@@ -12,7 +12,10 @@ const FUNC = async (
   arg,
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, arg });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    arg,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/stripe/stripeChargesGet.js

@@ -15,7 +15,9 @@ const stripeChargesGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }