@foxtware/mineral 0.1.0 → 0.1.2

package/api/shopify/shopifyMarketsGet.js

@@ -0,0 +1,46 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/markets
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyGet } = require('./shopifyGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyMarketsGet = async (
+  credsPayload,
+  {
+    ...getterOptions // e.g. limit
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return await shopifyGet(credsPayload, 'market', { ...getterOptions });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyMarketsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyMarketsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/shopify/shopifyMenusGet.js

@@ -0,0 +1,46 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/menus
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyGet } = require('./shopifyGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyMenusGet = async (
+  credsPayload,
+  {
+    ...getterOptions // e.g. limit
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return await shopifyGet(credsPayload, 'menu', { ...getterOptions });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyMenusGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyMenusGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/shopify/shopifyMetafieldDefinitionsGet.js

@@ -0,0 +1,50 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/metafieldDefinitions
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyGet } = require('./shopifyGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['ownerType'],
+]);
+
+const shopifyMetafieldDefinitionsGet = async (
+  credsPayload,
+  ownerType,
+  {
+    ...getterOptions // e.g. limit
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload,
+    ownerType,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return await shopifyGet(credsPayload, 'metafieldDefinition', { ownerType, ...getterOptions });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyMetafieldDefinitionsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyMetafieldDefinitionsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "ownerType": "PRODUCT",
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/shopify/shopifyMetaobjectDefinitionsGet.js

@@ -0,0 +1,46 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/metaobjectDefinitions
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyGet } = require('./shopifyGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyMetaobjectDefinitionsGet = async (
+  credsPayload,
+  {
+    ...getterOptions // e.g. limit
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return await shopifyGet(credsPayload, 'metaobjectDefinition', { ...getterOptions });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyMetaobjectDefinitionsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyMetaobjectDefinitionsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/shopify/shopifyMetaobjectsGet.js

@@ -0,0 +1,50 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/metaobjects
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyGet } = require('./shopifyGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['type'],
+]);
+
+const shopifyMetaobjectsGet = async (
+  credsPayload,
+  type,
+  {
+    ...getterOptions // e.g. limit
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload,
+    type,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return await shopifyGet(credsPayload, 'metaobject', { type, ...getterOptions });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyMetaobjectsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyMetaobjectsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "type": "image_hotspot",
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/shopify/shopifyPagesGet.js

@@ -0,0 +1,46 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/pages
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyGet } = require('./shopifyGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyPagesGet = async (
+  credsPayload,
+  {
+    ...getterOptions // e.g. limit
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return await shopifyGet(credsPayload, 'page', { ...getterOptions });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyPagesGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyPagesGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/shopify/shopifyPaymentCustomizationsGet.js

@@ -0,0 +1,46 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/paymentCustomizations
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyGet } = require('./shopifyGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyPaymentCustomizationsGet = async (
+  credsPayload,
+  {
+    ...getterOptions // e.g. limit
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return await shopifyGet(credsPayload, 'paymentCustomization', { ...getterOptions });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyPaymentCustomizationsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyPaymentCustomizationsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/shopify/shopifyProductFeedsGet.js

@@ -0,0 +1,46 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/productFeeds
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyGet } = require('./shopifyGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyProductFeedsGet = async (
+  credsPayload,
+  {
+    ...getterOptions // e.g. limit
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return await shopifyGet(credsPayload, 'productFeed', { ...getterOptions });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyProductFeedsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyProductFeedsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/shopify/shopifyProductVariantsGet.js

@@ -0,0 +1,46 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/productVariants
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyGet } = require('./shopifyGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyProductVariantsGet = async (
+  credsPayload,
+  {
+    ...getterOptions // e.g. limit
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return await shopifyGet(credsPayload, 'productVariant', { ...getterOptions });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyProductVariantsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyProductVariantsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/shopify/shopifyProductsGet.js

@@ -0,0 +1,46 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/products
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyGet } = require('./shopifyGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyProductsGet = async (
+  credsPayload,
+  {
+    ...getterOptions // e.g. limit
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return await shopifyGet(credsPayload, 'product', { ...getterOptions });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyProductsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyProductsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/shopify/shopifyPublicationsGet.js

@@ -0,0 +1,46 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/publications
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyGet } = require('./shopifyGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyPublicationsGet = async (
+  credsPayload,
+  {
+    ...getterOptions // e.g. limit
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return await shopifyGet(credsPayload, 'publication', { ...getterOptions });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyPublicationsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyPublicationsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/shopify/shopifySegmentsGet.js

@@ -0,0 +1,46 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/segments
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyGet } = require('./shopifyGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifySegmentsGet = async (
+  credsPayload,
+  {
+    ...getterOptions // e.g. limit
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return await shopifyGet(credsPayload, 'segment', { ...getterOptions });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifySegmentsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifySegmentsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/shopify/shopifyUrlRedirectsGet.js

@@ -0,0 +1,46 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/urlRedirects
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyGet } = require('./shopifyGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyUrlRedirectsGet = async (
+  credsPayload,
+  {
+    ...getterOptions // e.g. limit
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return await shopifyGet(credsPayload, 'urlRedirect', { ...getterOptions });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyUrlRedirectsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyUrlRedirectsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/shopify/shopifyWebhookSubscriptionsGet.js

@@ -0,0 +1,46 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/webhookSubscriptions
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyGet } = require('./shopifyGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyWebhookSubscriptionsGet = async (
+  credsPayload,
+  {
+    ...getterOptions // e.g. limit
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return await shopifyGet(credsPayload, 'webhookSubscription', { ...getterOptions });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyWebhookSubscriptionsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyWebhookSubscriptionsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/utils.js

@@ -1,5 +1,3 @@
-require('dotenv').config();
-
 const xml2js = require('xml2js');
 const readline = require('readline');
 const fs = require('fs').promises;
@@ -7,6 +5,7 @@ const yaml = require('yaml');
 const { EventEmitter } = require('events');
 
 const { HOSTED } = require('./constants');
+const { getWorkspace } = require('./workspace');
 
 const wait = (ms) => new Promise((resolve, reject) => setTimeout(resolve, ms));
 
@@ -73,7 +72,7 @@ const credsFromPayload = async (credsPayload) => {
         throw new Error(`Malformed CREDS environment variable: ${ err }`);
       }
     } else {
-      const credsText = await fs.readFile('.creds.yml', 'utf8');
+      const credsText = await fs.readFile(`${ getWorkspace() }/.creds.yml`, 'utf8');
       credsYmlAsObject = yaml.parse(credsText);
     }
 
@@ -414,6 +413,8 @@ class Chain {
   }
 }
 
+// TODO: client wrapper enabling auth and retrying with different auth
+
 class FetchClient {
   constructor({
     context, // necessary data for preparer and interpreters to refer to