@foxtware/mineral 0.1.15 → 0.1.17

package/api/shopify/shopifyInventoryItemsGet.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 shopifyInventoryItemsGet = 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, 'inventoryItem', { ...getterOptions });
+  const getterArgs = [
+    credsPayload, 
+    'inventoryItem', 
+    {
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? shopifyGetter(...getterArgs)
+    : shopifyGet(...getterArgs);
 };
 
 const funcApiConfig = {
@@ -30,7 +42,8 @@ const funcApiConfig = {
 };
 
 module.exports = {
-  shopifyInventoryItemsGet,
+  shopifyInventoryItemsGet: (...args) => shopifyInventoryItemsGet(false, ...args),
+  shopifyInventoryItemsGetter: (...args) => shopifyInventoryItemsGet(true, ...args),
   funcApiConfig,
 };
 

package/api/shopify/shopifyLocationsGet.js

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

package/api/shopify/shopifyMarketingEventsGet.js

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

package/api/shopify/shopifyMarketsGet.js

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

package/api/shopify/shopifyMenusGet.js

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

package/api/shopify/shopifyMetafieldDefinitionCreate.js

@@ -0,0 +1,111 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/metafieldDefinitionCreate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['ownerType'],
+  ['namespace'],
+  ['key'],
+  ['name'],
+  ['type'],
+]);
+
+const defaultReturnSchema = `
+  createdDefinition {
+    id
+    name
+    namespace
+    key
+    type {
+      name
+    }
+  }
+`.trim();
+
+const shopifyMetafieldDefinitionCreate = async (
+  credsPayload,
+  ownerType,
+  namespace,
+  key,
+  name,
+  type,
+  {
+    apiVersion,
+    access,
+    description,
+    pin,
+    useAsCollectionCondition,
+    validations,
+    returnSchema = defaultReturnSchema,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    ownerType,
+    namespace,
+    key,
+    name,
+    type,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'metafieldDefinitionCreate',
+    {
+      mutationVariables: {
+        definition: {
+          type: 'MetafieldDefinitionInput!',
+          value: {
+            ownerType,
+            namespace,
+            key,
+            name,
+            type,
+            ...(access && { access }),
+            ...(description && { description }),
+            ...(pin && { pin }),
+            ...(useAsCollectionCondition && { useAsCollectionCondition }),
+            ...(validations && { validations }),
+          },
+        },
+      },
+      returnSchema,
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyMetafieldDefinitionCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyMetafieldDefinitionCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "ownerType": "CUSTOMER",
+    "namespace": "migrations",
+    "key": "last_migration_data",
+    "name": "Last Migration Data",
+    "type": "json",
+    "options": {
+      "description": "Latest customer store migration details for on-site messaging",
+      "access": {
+        "storefront": "PUBLIC_READ"
+      }
+    }
+  }'
+*/

package/api/shopify/shopifyMetafieldDefinitionPropagate.js

@@ -0,0 +1,211 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/metafieldDefinitionCreate
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/metafieldDefinition
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden, credsFromPayload, objHasAny } = require('../utils');
+const { shopifyClient } = require('./shopify.utils');
+const { shopifyMutationDo } = require('./shopifyMutationDo');
+
+const sourceMetafieldDefinitionAttrs = `
+  name
+  namespace
+  key
+  description
+  ownerType
+  pinnedPosition
+  type {
+    name
+  }
+  validations {
+    name
+    value
+  }
+  capabilities {
+    adminFilterable {
+      enabled
+    }
+    smartCollectionCondition {
+      enabled
+    }
+    uniqueValues {
+      enabled
+    }
+  }
+`.trim();
+
+const defaultReturnCreatedDefinitionAttrs = 'id name namespace key ownerType type { name }';
+
+const metafieldDefinitionIdentifierValidator = (metafieldDefinitionIdentifier) => {
+  return objHasAny(metafieldDefinitionIdentifier, [
+    'ownerType',
+    'namespace',
+    'key',
+  ]);
+};
+
+const argsWarden = new ArgsWarden([
+  ['fromStoreCredsPayload', credsValidator],
+  ['toStoreCredsPayload', credsValidator],
+  ['metafieldDefinitionIdentifier', metafieldDefinitionIdentifierValidator],
+]);
+
+const metafieldDefinitionInputFromDefinition = (sourceDefinition) => {
+  const {
+    name,
+    namespace,
+    key,
+    description,
+    ownerType,
+    type,
+    validations,
+    capabilities,
+    pinnedPosition,
+  } = sourceDefinition;
+
+  const definitionInput = {
+    name,
+    namespace,
+    key,
+    ownerType,
+    type: type?.name,
+    ...(description && { description }),
+    ...(pinnedPosition != null && { pin: true }),
+  };
+
+  if (Array.isArray(validations) && validations.length) {
+    definitionInput.validations = validations.map(({ name: validationName, value }) => ({
+      name: validationName,
+      value,
+    }));
+  }
+
+  if (capabilities) {
+    definitionInput.capabilities = {
+      ...(capabilities.adminFilterable && {
+        adminFilterable: { enabled: capabilities.adminFilterable.enabled },
+      }),
+      ...(capabilities.smartCollectionCondition && {
+        smartCollectionCondition: { enabled: capabilities.smartCollectionCondition.enabled },
+      }),
+      ...(capabilities.uniqueValues && {
+        uniqueValues: { enabled: capabilities.uniqueValues.enabled },
+      }),
+    };
+  }
+
+  return definitionInput;
+};
+
+const fetchSourceMetafieldDefinition = async (
+  fromStoreCredsPayload,
+  metafieldDefinitionIdentifier,
+  {
+    apiVersion,
+  } = {},
+) => {
+  const creds = await credsFromPayload(fromStoreCredsPayload);
+
+  return shopifyClient.fetch({
+    method: 'post',
+    body: {
+      query: `
+        query GetMetafieldDefinition($identifier: MetafieldDefinitionIdentifierInput!) {
+          metafieldDefinition(identifier: $identifier) {
+            ${ sourceMetafieldDefinitionAttrs }
+          }
+        }
+      `,
+      variables: {
+        identifier: metafieldDefinitionIdentifier,
+      },
+    },
+    context: {
+      creds,
+      apiVersion,
+      resultPath: 'data.metafieldDefinition',
+    },
+  });
+};
+
+const shopifyMetafieldDefinitionPropagate = async (
+  fromStoreCredsPayload,
+  toStoreCredsPayload,
+  metafieldDefinitionIdentifier,
+  {
+    apiVersion,
+    returnCreatedDefinitionAttrs = defaultReturnCreatedDefinitionAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    fromStoreCredsPayload,
+    toStoreCredsPayload,
+    metafieldDefinitionIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const sourceResponse = await fetchSourceMetafieldDefinition(
+    fromStoreCredsPayload,
+    metafieldDefinitionIdentifier,
+    { apiVersion },
+  );
+
+  if (!sourceResponse.ok) {
+    return sourceResponse;
+  }
+
+  if (!sourceResponse.data) {
+    return {
+      ok: false,
+      error: {
+        code: 'NOT_FOUND',
+        message: 'Metafield definition not found on source store.',
+        details: metafieldDefinitionIdentifier,
+      },
+    };
+  }
+
+  const definitionInput = metafieldDefinitionInputFromDefinition(sourceResponse.data);
+
+  return shopifyMutationDo(
+    toStoreCredsPayload,
+    'metafieldDefinitionCreate',
+    {
+      mutationVariables: {
+        definition: {
+          type: 'MetafieldDefinitionInput!',
+          value: definitionInput,
+        },
+      },
+      returnSchema: `
+        createdDefinition { ${ returnCreatedDefinitionAttrs } }
+      `.trim(),
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyMetafieldDefinitionPropagate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyMetafieldDefinitionPropagate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "fromStoreCredsPayload": { "credsPath": "shopify.au" },
+    "toStoreCredsPayload": { "credsPath": "shopify.us" },
+    "metafieldDefinitionIdentifier": {
+      "ownerType": "PRODUCT",
+      "namespace": "custom",
+      "key": "outfit_builder_image"
+    }
+  }'
+*/

package/api/shopify/shopifyMetafieldDefinitionsGet.js

@@ -2,7 +2,7 @@
 
 const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
-const { shopifyGet } = require('./shopifyGet');
+const { shopifyGet, shopifyGetter } = require('./shopifyGet');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
@@ -10,6 +10,8 @@ const argsWarden = new ArgsWarden([
 ]);
 
 const shopifyMetafieldDefinitionsGet = async (
+  returnGetter, // Always bound
+
   credsPayload,
   ownerType,
   {
@@ -17,7 +19,7 @@ const shopifyMetafieldDefinitionsGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
     ownerType,
   });
@@ -25,7 +27,18 @@ const shopifyMetafieldDefinitionsGet = async (
     return rejectResponse;
   }
 
-  return await shopifyGet(credsPayload, 'metafieldDefinition', { ownerType, ...getterOptions });
+  const getterArgs = [
+    credsPayload, 
+    'metafieldDefinition', 
+    {
+      ownerType,
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? shopifyGetter(...getterArgs)
+    : shopifyGet(...getterArgs);
 };
 
 const funcApiConfig = {
@@ -33,7 +46,8 @@ const funcApiConfig = {
 };
 
 module.exports = {
-  shopifyMetafieldDefinitionsGet,
+  shopifyMetafieldDefinitionsGet: (...args) => shopifyMetafieldDefinitionsGet(false, ...args),
+  shopifyMetafieldDefinitionsGetter: (...args) => shopifyMetafieldDefinitionsGet(true, ...args),
   funcApiConfig,
 };
 

package/api/shopify/shopifyMetafieldsDelete.js

@@ -0,0 +1,78 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/metafieldsDelete
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const metafieldsValidator = (metafields) => {
+  return Array.isArray(metafields)
+    && metafields.length > 0
+    && metafields.every((metafield) => {
+      return metafield?.ownerId && metafield?.namespace && metafield?.key;
+    });
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['metafields', metafieldsValidator],
+]);
+
+const shopifyMetafieldsDelete = async (
+  credsPayload,
+  metafields,
+  {
+    apiVersion,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    metafields,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'metafieldsDelete',
+    {
+      mutationVariables: {
+        metafields: {
+          type: '[MetafieldIdentifierInput!]!',
+          value: metafields,
+        },
+      },
+      returnSchema: `
+        deletedMetafields {
+          key
+          namespace
+          ownerId
+        }
+      `.trim(),
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyMetafieldsDelete,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyMetafieldsDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "metafields": [{
+      "ownerId": "gid://shopify/Customer/2111702204488",
+      "namespace": "aug26_migration",
+      "key": "loyalty_points"
+    }]
+  }'
+*/

package/api/shopify/shopifyMetaobjectDefinitionsGet.js

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

package/api/shopify/shopifyMetaobjectsGet.js

@@ -17,7 +17,7 @@ const shopifyMetaobjectsGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
     type,
   });

package/api/shopify/shopifyMutationDo.js

@@ -18,7 +18,10 @@ const shopifyMutationDo = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, mutationName });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    mutationName,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/shopify/shopifyOrderGet.js

@@ -57,7 +57,10 @@ const shopifyOrderGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, orderIdentifier });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    orderIdentifier,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/shopify/shopifyOrdersGet.js

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

package/api/shopify/shopifyPageDelete.js

@@ -17,7 +17,10 @@ const shopifyPageDelete = async (
   } = {},
 ) => {
 
-  const argsRejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, pageId });
+  const argsRejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    pageId,
+  });
   if (argsRejectResponse) {
     return argsRejectResponse;
   }

package/api/shopify/shopifyPageGet.js

@@ -20,7 +20,10 @@ const shopifyPageGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, pageId });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    pageId,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/shopify/shopifyPageUpdate.js

@@ -30,7 +30,11 @@ const shopifyPageUpdate = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, pageId, updatePayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    pageId,
+    updatePayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/shopify/shopifyPagesGet.js

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

package/api/shopify/shopifyPaymentCustomizationsGet.js

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

package/api/shopify/shopifyProductFeedsGet.js

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