@foxtware/mineral 0.1.0

package/api/shopify/shopifyPageGet.js

@@ -0,0 +1,57 @@
+// 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 templateSuffix';
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['pageId', Boolean],
+]);
+
+const shopifyPageGet = async (
+  credsPayload,
+  pageId,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, pageId });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyGetSingle(
+    credsPayload,
+    'page',
+    pageId,
+    {
+      apiVersion,
+      attrs,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyPageGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyPageGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "shopify.au"
+    },
+    "pageId": "104188477512"
+  }'
+*/

package/api/shopify/shopifyPageUpdate.js

@@ -0,0 +1,79 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/pageUpdate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['pageId'],
+  ['updatePayload'],
+]);
+
+const shopifyPageUpdate = async (
+  credsPayload,
+  pageId,
+  updatePayload,
+  /*
+    body,
+    title,
+    handle,
+    redirectNewHandle,
+    isPublished,
+    publishDate,
+    metafields,
+    templateSuffix,
+  */
+  {
+    apiVersion,
+    returnPageAttrs = 'title handle templateSuffix',
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, pageId, updatePayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'pageUpdate',
+    {
+      mutationVariables: {
+        id: {
+          type: 'ID!',
+          value: `gid://shopify/Page/${ pageId }`,
+        },
+        page: {
+          type: 'PageUpdateInput!',
+          value: updatePayload,
+        },
+      },
+      returnSchema: `page { ${ returnPageAttrs } }`,
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyPageUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyPageUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "shopify.au"
+    },
+    "pageId": "104188477512",
+    "updatePayload": {
+      "templateSuffix": "styleguide"
+    }
+  }'
+*/

package/api/shopify/shopifyTagsAdd.js

@@ -0,0 +1,94 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/tagsAdd
+
+const { credsValidator } = require('../validators');
+const { actionSingleOrMultiple, ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['gid'],
+  ['tags', Array],
+]);
+
+const defaultAttrs = 'id';
+
+const shopifyTagsAddSingle = async (
+  credsPayload,
+  gid,
+  tags,
+  {
+    apiVersion,
+    returnAttrs = defaultAttrs,
+  } = {},
+) => {
+
+  return shopifyMutationDo(
+    credsPayload,
+    'tagsAdd',
+    {
+      mutationVariables: {
+        id: {
+          type: 'ID!',
+          value: gid,
+        },
+        tags: {
+          type: '[String!]!',
+          value: tags,
+        },
+      },
+      returnSchema: `node { ${ returnAttrs } }`,
+      apiVersion,
+    },
+  );
+};
+
+const shopifyTagsAdd = async (
+  credsPayload,
+  gid,
+  tags,
+  {
+    queueRunOptions,
+    apiVersion,
+    returnAttrs = defaultAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    gid,
+    tags,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    gid,
+    shopifyTagsAddSingle,
+    (gidItem) => ({
+      args: [credsPayload, gidItem, tags, { apiVersion, returnAttrs }],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyTagsAdd,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyTagsAdd" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "gid": "gid://shopify/Product/6981195825224",
+    "tags": ["watermelon", "banana"]
+  }'
+*/

package/api/shopify/shopifyTagsRemove.js

@@ -0,0 +1,94 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/tagsRemove
+
+const { credsValidator } = require('../validators');
+const { actionSingleOrMultiple, ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['gid'],
+  ['tags', Array],
+]);
+
+const defaultAttrs = 'id';
+
+const shopifyTagsRemoveSingle = async (
+  credsPayload,
+  gid,
+  tags,
+  {
+    apiVersion,
+    returnAttrs = defaultAttrs,
+  } = {},
+) => {
+
+  return shopifyMutationDo(
+    credsPayload,
+    'tagsRemove',
+    {
+      mutationVariables: {
+        id: {
+          type: 'ID!',
+          value: gid,
+        },
+        tags: {
+          type: '[String!]!',
+          value: tags,
+        },
+      },
+      returnSchema: `node { ${ returnAttrs } }`,
+      apiVersion,
+    },
+  );
+};
+
+const shopifyTagsRemove = async (
+  credsPayload,
+  gid,
+  tags,
+  {
+    queueRunOptions,
+    apiVersion,
+    returnAttrs = defaultAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    gid,
+    tags,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    gid,
+    shopifyTagsRemoveSingle,
+    (gidItem) => ({
+      args: [credsPayload, gidItem, tags, { apiVersion, returnAttrs }],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyTagsRemove,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyTagsRemove" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "gid": "gid://shopify/Product/6981195825224",
+    "tags": ["watermelon", "banana"]
+  }'
+*/

package/api/shopify/shopifyThemeDelete.js

@@ -0,0 +1,87 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/themeDelete
+
+const { credsValidator } = require('../validators');
+const { actionSingleOrMultiple, ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['themeId'],
+]);
+
+const shopifyThemeDeleteSingle = async (
+  credsPayload,
+  themeId,
+  {
+    apiVersion,
+    returnSchema = 'deletedThemeId',
+  } = {},
+) => {
+
+  return shopifyMutationDo(
+    credsPayload,
+    'themeDelete',
+    {
+      mutationVariables: {
+        id: {
+          type: 'ID!',
+          value: `gid://shopify/OnlineStoreTheme/${ themeId }`,
+        },
+      },
+      returnSchema,
+      apiVersion,
+    },
+  );
+};
+
+const shopifyThemeDelete = async (
+  credsPayload,
+  themeId,
+  {
+    queueRunOptions,
+    apiVersion,
+    returnSchema = 'deletedThemeId',
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, themeId });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    themeId,
+    shopifyThemeDeleteSingle,
+    (themeIdItem) => ({
+      args: [credsPayload, themeIdItem, { apiVersion, returnSchema }],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyThemeDelete,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyThemeDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "themeId": "1234567890"
+  }'
+
+curl -X POST "http://localhost:8000/shopifyThemeDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "themeId": ["1234567890", "0987654321"]
+  }'
+*/

package/api/shopify/shopifyThemeDuplicate.js

@@ -0,0 +1,70 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/themeDuplicate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['themeId'],
+]);
+
+const shopifyThemeDuplicate = async (
+  credsPayload,
+  themeId,
+  {
+    apiVersion,
+    name,
+    returnThemeAttrs = 'id name role createdAt',
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, themeId });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const mutationVariables = {
+    id: {
+      type: 'ID!',
+      value: `gid://shopify/OnlineStoreTheme/${ themeId }`,
+    },
+    ...name && {
+      name: {
+        type: 'String',
+        value: name,
+      },
+    },
+  };
+
+  return shopifyMutationDo(
+    credsPayload,
+    'themeDuplicate',
+    {
+      mutationVariables,
+      returnSchema: `newTheme { ${ returnThemeAttrs } }`,
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyThemeDuplicate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyThemeDuplicate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "themeId": "129840808008",
+    "options": {
+      "name": "There'\''s no I in theme"
+    }
+  }'
+*/

package/api/shopify/shopifyThemeGet.js

@@ -0,0 +1,59 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/theme
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden, objHasAny } = require('../utils');
+const { shopifyGetSingle } = require('../shopify/shopifyGetSingle');
+
+const defaultAttrs = 'id name role createdAt updatedAt';
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['themeId'],
+]);
+
+const shopifyThemeGet = async (
+  credsPayload,
+  themeId,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload, 
+    themeId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyGetSingle(
+    credsPayload,
+    'theme',
+    themeId,
+    {
+      apiVersion,
+      attrs,
+      gidType: 'OnlineStoreTheme',
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyThemeGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyThemeGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "themeId": "129840808008"
+  }'
+*/

package/api/shopify/shopifyThemeUpdate.js

@@ -0,0 +1,71 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/themeUpdate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['themeId'],
+  ['updatePayload'],
+]);
+
+const shopifyThemeUpdate = async (
+  credsPayload,
+  themeId,
+  updatePayload,
+  {
+    apiVersion,
+    returnThemeAttrs = 'id name role createdAt updatedAt',
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    themeId,
+    updatePayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'themeUpdate',
+    {
+      mutationVariables: {
+        id: {
+          type: 'ID!',
+          value: `gid://shopify/OnlineStoreTheme/${ themeId }`,
+        },
+        input: {
+          type: 'OnlineStoreThemeInput!',
+          value: updatePayload,
+        },
+      },
+      returnSchema: `theme { ${ returnThemeAttrs } }`,
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyThemeUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyThemeUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "themeId": "129840808008",
+    "updatePayload": {
+      "name": "The me theme"
+    }
+  }'
+*/

package/api/shopify/shopifyThemesGet.js

@@ -0,0 +1,63 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/themes
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyGet } = require('../shopify/shopifyGet');
+
+const defaultAttrs = 'id name role createdAt updatedAt';
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyThemesGet = async (
+  credsPayload,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyGet(
+    credsPayload,
+    'theme',
+    {
+      apiVersion,
+      attrs,
+      ...getterOptions,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyThemesGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyThemesGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" }
+  }'
+
+curl -X POST "http://localhost:8000/shopifyThemesGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "roles": ["MAIN"],
+      "attrs": "id name role"
+    }
+  }'
+*/