@foxtware/mineral 0.1.0

package/api/shopify/shopifyGetSingle.js

@@ -0,0 +1,106 @@
+const { credsFromPayload, capitaliseString, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyClient } = require('./shopify.utils');
+
+const resourcesNotRequiringId = ['shop'];
+
+const defaultAttrs = 'id';
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['resource'],
+  ['id', (id, context) => resourcesNotRequiringId.includes(context.resource) || Boolean(id)],
+]);
+
+const shopifyGetSingle = async (
+  credsPayload,
+  resource,
+  id,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+    gidType,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs(
+    { 
+      credsPayload, 
+      resource, 
+      id, 
+    },
+    { resource },
+  );
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+
+  const Resource = capitaliseString(resource);
+  const usesId = !resourcesNotRequiringId.includes(resource);
+
+  const query = `
+    query Get${ Resource }${ usesId ? '($id: ID!)' : '' } {
+      ${ resource }${ usesId ? '(id: $id)' : '' } {
+        ${ attrs }
+      }
+    }
+  `;
+
+  const response = await shopifyClient.fetch({
+    method: 'post',
+    body: {
+      query,
+      variables: {
+        ...(usesId ? { id: `gid://shopify/${ gidType || Resource }/${ id }` } : {}),
+      },
+    },
+    context: {
+      creds,
+      apiVersion,
+      resultPath: `data.${ resource }`,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyGetSingle,
+  funcApiConfig,
+};
+/*
+
+curl -X POST "http://localhost:8000/shopifyGetSingle" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsObject": {
+        "STORE_HANDLE": "arisawa-heavy-industries",
+        "API_KEY": "shpat_xxx"
+      }
+    },
+    "resource": "order",
+    "id": "1234567890",
+    "options": {
+      "attrs": "id name"
+    }
+  }'
+
+curl -X POST "http://localhost:8000/shopifyGetSingle" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "shopify.au"
+    },
+    "resource": "shop",
+    "options": {
+      "attrs": "id name primaryDomain { url } myshopifyDomain"
+    }
+  }'
+  */

package/api/shopify/shopifyGiftCardCreate.js

@@ -0,0 +1,95 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/giftCardCreate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const giftCardInputValidator = (giftCardInput) => {
+  if (!giftCardInput || typeof giftCardInput !== 'object') {
+    return false;
+  }
+
+  const initialValue = parseFloat(giftCardInput.initialValue);
+  return !isNaN(initialValue) && initialValue > 0;
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['giftCardInput', giftCardInputValidator],
+]);
+
+const defaultReturnGiftCardAttrs = 'id initialValue { amount } customer { id }';
+
+const shopifyGiftCardCreate = async (
+  credsPayload,
+  giftCardInput,
+  {
+    apiVersion,
+    returnGiftCardAttrs = defaultReturnGiftCardAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, giftCardInput });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'giftCardCreate',
+    {
+      mutationVariables: {
+        input: {
+          type: 'GiftCardCreateInput!',
+          value: giftCardInput,
+        },
+      },
+      returnSchema: `
+        giftCardCode
+        giftCard { ${ returnGiftCardAttrs } }
+      `.trim(),
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyGiftCardCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyGiftCardCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "giftCardInput": {
+      "initialValue": "5",
+      "customerId": "gid://shopify/Customer/1234567890",
+      "note": "Pocket money"
+    }
+  }'
+
+curl -X POST "http://localhost:8000/shopifyGiftCardCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "giftCardInput": {
+      "initialValue": "101.0",
+      "customerId": "gid://shopify/Customer/1234567890",
+      "recipientAttributes": {
+        "id": "gid://shopify/Customer/0987654321",
+        "message": "One dalmatian = one dollar",
+        "preferredName": "Cruella",
+        "sendNotificationAt": "2026-07-01T12:00:00Z"
+      }
+    },
+    "options": {
+      "returnGiftCardAttrs": "id initialValue { amount } customer { id } recipientAttributes { message preferredName sendNotificationAt recipient { id } }"
+    }
+  }'
+*/

package/api/shopify/shopifyGiftCardDeactivate.js

@@ -0,0 +1,58 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/giftCardDeactivate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['giftCardId'],
+]);
+
+const shopifyGiftCardDeactivate = async (
+  credsPayload,
+  giftCardId,
+  {
+    apiVersion,
+    giftCardReturnAttrs = 'id deactivatedAt',
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, giftCardId });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'giftCardDeactivate',
+    {
+      mutationVariables: {
+        id: {
+          type: 'ID!',
+          value: `gid://shopify/GiftCard/${ giftCardId }`,
+        },
+      },
+      returnSchema: `giftCard { ${ giftCardReturnAttrs } }`,
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyGiftCardDeactivate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyGiftCardDeactivate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "giftCardId": "651526996040"
+  }'
+*/

package/api/shopify/shopifyMetafieldsSet.js

@@ -0,0 +1,100 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/metafieldsset
+
+const { credsValidator } = require('../validators');
+const { actionSingleOrMultiple, arrayToChunks, ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+const { MAX_METAFIELDS_PER_SET } = require('../shopify/shopify.constants');
+
+const metafieldsValidator = (metafields) => {
+  return Array.isArray(metafields) && metafields.length > 0;
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['metafields', metafieldsValidator],
+]);
+
+const defaultAttrs = 'id namespace key type value';
+
+const shopifyMetafieldsSetChunk = async (
+  credsPayload,
+  metafields,
+  {
+    apiVersion,
+    returnMetafieldAttrs = defaultAttrs,
+  } = {},
+) => {
+
+  return shopifyMutationDo(
+    credsPayload,
+    'metafieldsSet',
+    {
+      mutationVariables: {
+        metafields: {
+          type: '[MetafieldsSetInput!]!',
+          value: metafields,
+        },
+      },
+      returnSchema: `
+        metafields { ${ returnMetafieldAttrs } }
+      `.trim(),
+      apiVersion,
+    },
+  );
+};
+
+const shopifyMetafieldsSet = async (
+  credsPayload,
+  metafields,
+  {
+    queueRunOptions,
+    apiVersion,
+    returnMetafieldAttrs = defaultAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    metafields,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const chunks = arrayToChunks(metafields, MAX_METAFIELDS_PER_SET);
+
+  return actionSingleOrMultiple(
+    chunks,
+    shopifyMetafieldsSetChunk,
+    (chunk) => ({
+      args: [credsPayload, chunk, { apiVersion, returnMetafieldAttrs }],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyMetafieldsSet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyMetafieldsSet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "metafields": [{
+      "ownerId": "gid://shopify/Customer/2111702204488",
+      "namespace": "facts",
+      "key": "birth_date",
+      "type": "date",
+      "value": "1990-01-01"
+    }]
+  }'
+*/

package/api/shopify/shopifyMutationDo.js

@@ -0,0 +1,95 @@
+const { credsFromPayload, logDeep, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyClient } = require('./shopify.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['mutationName'],
+]);
+
+const shopifyMutationDo = async (
+  credsPayload,
+  mutationName,
+  {
+    mutationVariables = {},
+    returnSchema = '',
+    apiVersion,
+    ...clientOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, mutationName });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  if (!returnSchema?.includes('userErrors')) {
+    returnSchema += ' userErrors { field message }';
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+
+  const mutation = `
+    mutation ${ mutationName }(${ Object.entries(mutationVariables).map(([name, { type }]) => `$${ name }: ${ type }`).join(', ') }) {
+      ${ mutationName }(${ Object.keys(mutationVariables).map(name => `${ name }: $${ name }`).join(', ') }) {
+        ${ returnSchema }
+        userErrors {
+          field
+          message
+        }
+      }
+    }
+  `;
+
+  const variables = {};
+  for (const [name, { value }] of Object.entries(mutationVariables)) {
+    variables[name] = value;
+  }
+
+  const response = await shopifyClient.fetch({
+    method: 'post',
+    body: { query: mutation, variables },
+    context: {
+      creds,
+      apiVersion,
+      resultPath: `data.${ mutationName }`,
+    },
+    ...clientOptions,
+  });
+
+  logDeep(response);
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyMutationDo,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyMutationDo" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "shopify.au"
+    },
+    "mutationName": "tagsAdd",
+    "options": {
+      "mutationVariables": {
+        "id": {
+          "value": "gid://shopify/Order/7693468893256",
+          "type": "ID!"
+        },
+        "tags": {
+          "value": ["test-tag"],
+          "type": "[String!]!"
+        }
+      },
+      "returnSchema": "order { id name }"
+    }
+  }'
+*/

package/api/shopify/shopifyOrderGet.js

@@ -0,0 +1,123 @@
+const { credsValidator } = require('../validators');
+const { actionSingleOrMultiple, everyIfArray, ArgsWarden } = require('../utils');
+const { shopifyGetSingle } = require('../shopify/shopifyGetSingle');
+
+const defaultAttrs = 'id name createdAt displayFinancialStatus displayFulfillmentStatus';
+
+const orderIdentifierValidator = ({ orderId, orderName } = {}) => Boolean(orderId) || Boolean(orderName);
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['orderIdentifier', (i) => everyIfArray(orderIdentifierValidator, i)],
+]);
+
+const shopifyOrderGetSingle = async (
+  credsPayload,
+  orderIdentifier,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+  } = {},
+) => {
+
+  const { orderId, orderName } = orderIdentifier;
+
+  if (orderId) {
+    return shopifyGetSingle(
+      credsPayload,
+      'order',
+      orderId,
+      {
+        apiVersion,
+        attrs,
+      },
+    );
+  }
+
+  /* orderName */
+  // const response = await shopifyOrdersGet(credsPath, {
+  //   apiVersion,
+  //   attrs,
+  //   queries: [`name:${ orderName }`],
+  // });
+
+  // const singleResponse = standardInterpreters.expectOne(response);
+
+  // return singleResponse;
+  /* /orderName */
+};
+
+const shopifyOrderGet = async (
+  credsPayload,
+  orderIdentifier,
+  {
+    queueRunOptions,
+    apiVersion,
+    attrs = defaultAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, orderIdentifier });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    orderIdentifier,
+    shopifyOrderGetSingle,
+    (identifier) => ({
+      args: [credsPayload, identifier, { apiVersion, attrs }],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyOrderGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyOrderGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsObject": {
+        "STORE_HANDLE": "arisawa-heavy-industries",
+        "API_KEY": "shpat_xxx"
+      }
+    },
+    "orderIdentifier": {
+      "orderId": "1234567890"
+    }
+  }'
+
+curl -X POST "http://localhost:8000/shopifyOrderGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "shopify.au"
+    },
+    "orderIdentifier": {
+      "orderId": "7015155466312"
+    }
+  }'
+
+curl -X POST "http://localhost:8000/shopifyOrderGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "shopify.au"
+    },
+    "orderIdentifier": [
+      { "orderId": "7015155466312" },
+      { "orderId": "7697048109128" }
+    ]
+  }'
+*/

package/api/shopify/shopifyOrdersGet.js

@@ -0,0 +1,80 @@
+const { credsFromPayload, logDeep, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyClient } = require('./shopify.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyOrdersGet = async (
+  credsPayload,
+  {
+    first = 50,
+    after,
+    query,
+    apiVersion,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+
+  const response = await shopifyClient.fetch({
+    method: 'post',
+    body: {
+      query: `
+        query OrdersGet(
+          $first: Int!,
+          $after: String,
+          $query: String
+        ) {
+          orders(
+            first: $first,
+            after: $after,
+            query: $query
+          ) {
+            edges {
+              node {
+                id
+                name
+                createdAt
+                displayFinancialStatus
+                displayFulfillmentStatus
+              }
+            }
+          }
+        }
+      `,
+      variables: {
+        first,
+        after,
+        query,
+      },
+    },
+    context: {
+      creds,
+      apiVersion,
+      resultPath: 'data.orders',
+    },
+  });
+
+  if (!response.ok) {
+    return response;
+  }
+
+  logDeep('response', response);
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyOrdersGet,
+  funcApiConfig,
+};

package/api/shopify/shopifyPageDelete.js

@@ -0,0 +1,59 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/pageDelete
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['pageId'],
+]);
+
+const shopifyPageDelete = async (
+  credsPayload,
+  pageId,
+  {
+    apiVersion,
+  } = {},
+) => {
+
+  const argsRejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, pageId });
+  if (argsRejectResponse) {
+    return argsRejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'pageDelete',
+    {
+      mutationVariables: {
+        id: {
+          type: 'ID!',
+          value: `gid://shopify/Page/${ pageId }`,
+        },
+      },
+      returnSchema: 'deletedPageId',
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyPageDelete,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyPageDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "shopify.au"
+    },
+    "pageId": "104188477512"
+  }'
+*/