@foxtware/mineral 0.1.8 → 0.1.10

package/api/shopify/shopifyBulkMutationDo.js

@@ -0,0 +1,211 @@
+const { randomUUID } = require('crypto');
+const { createReadStream } = require('fs');
+const fs = require('fs').promises;
+
+const { HOSTED, TEMP_DIR } = require('../constants');
+const { credsValidator } = require('../validators');
+const {
+  ArgsWarden,
+  customFetch,
+  gidToId,
+  objectToFormData,
+  objHasAny,
+  objectArrayToJsonl,
+  jsonlToObjectArray,
+  wait,
+  valueProvided,
+} = require('../utils');
+const { shopifyStagedUploadCreate } = require('./shopifyStagedUploadCreate');
+const { shopifyBulkOperationRunMutation } = require('./shopifyBulkOperationRunMutation');
+const { shopifyBulkOperationGet } = require('./shopifyBulkOperationGet');
+
+const bulkOpAttrs = `
+  id
+  status
+  type
+  objectCount
+  url
+  errorCode
+`;
+
+const createOrResumeBulkOpPayloadValidator = (payload) => {
+  const { mutation, input, bulkOperationId } = payload;
+
+  if (valueProvided(bulkOperationId)) {
+    return true;
+  }
+
+  return valueProvided(mutation) && objHasAny(input, ['data', 'filepath']);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['createOrResumeBulkOpPayload', createOrResumeBulkOpPayloadValidator],
+]);
+
+const shopifyBulkMutationDo = async (
+  credsPayload,
+  createOrResumeBulkOpPayload,
+  {
+    apiVersion,
+    clientIdentifier,
+    waitForResult = true,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload, 
+    createOrResumeBulkOpPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const {
+    mutation,
+    input,
+    bulkOperationId,
+  } = createOrResumeBulkOpPayload;
+  
+  let bulkOperation;
+
+  if (!bulkOperationId) {
+
+    if (HOSTED) {
+      return {
+        ok: false,
+        error: 'This function is only available locally',
+      };
+    }
+
+    let {
+      data,
+      filepath,
+    } = input;
+
+    if (!filepath) {
+      await fs.mkdir(TEMP_DIR, { recursive: true });
+      filepath = `${ TEMP_DIR }/shopifyBulkMutationDo_${ randomUUID() }.jsonl`;
+      await fs.writeFile(filepath, objectArrayToJsonl(data));
+    }
+
+    const stagedUploadResponse = await shopifyStagedUploadCreate(
+      credsPayload,
+      {
+        resource: 'BULK_MUTATION_VARIABLES',
+        filename: filepath.split('/').pop(),
+        mimeType: 'text/jsonl',
+        httpMethod: 'POST',
+      },
+      { apiVersion },
+    );
+    if (!stagedUploadResponse.ok) {
+      return stagedUploadResponse;
+    }
+
+    const { url, parameters } = stagedUploadResponse.data.stagedTargets[0];
+
+    const formData = objectToFormData(
+      Object.fromEntries(parameters.map(({ name, value }) => [name, value])),
+    );
+    formData.append('file', createReadStream(filepath));
+
+    const uploadResponse = await customFetch(url, {
+      method: 'post',
+      body: formData,
+    });
+    if (!uploadResponse.ok) {
+      return uploadResponse;
+    }
+
+    const stagedUploadPath = uploadResponse.data?.PostResponse?.Key;
+    
+    const mutationRunResponse = await shopifyBulkOperationRunMutation(
+      credsPayload,
+      mutation,
+      stagedUploadPath,
+      {
+        apiVersion,
+        clientIdentifier,
+        returnAttrs: bulkOpAttrs,
+      },
+    );
+
+    if (!waitForResult) {
+      return mutationRunResponse;
+    }
+
+    const { ok: mutationRunOk, data: mutationRunData } = mutationRunResponse;
+    if (!mutationRunOk) {
+      return mutationRunResponse;
+    }
+    
+    bulkOperation = mutationRunData.bulkOperation;
+    bulkOperationId = gidToId(bulkOperation.id);
+  }
+  
+  while (['CREATED', 'RUNNING'].includes(bulkOperation?.status)) {
+
+    if (bulkOperation) {
+      await wait(5000);
+    }
+
+    const operationResponse = await shopifyBulkOperationGet(
+      credsPayload,
+      bulkOperationId,
+      {
+        apiVersion,
+        attrs: bulkOpAttrs,
+      },
+    );
+    if (!operationResponse.ok) {
+      return operationResponse;
+    }
+
+    bulkOperation = operationResponse.data;
+  }
+
+  if (bulkOperation.status !== 'COMPLETED') {
+    return {
+      ok: false,
+      error: {
+        code: 'BULK_OPERATION_FAILED',
+        message: `Bulk operation failed with status ${ bulkOperation.status }`,
+        details: bulkOperation,
+      },
+    };
+  }
+
+  const resultsResponse = await customFetch(bulkOperation.url);
+  if (!resultsResponse.ok) {
+    return resultsResponse;
+  }
+
+  const results = jsonlToObjectArray(resultsResponse.data);
+
+  return {
+    ok: true,
+    data: results,
+    meta: {
+      bulkOperation,
+    },
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyBulkMutationDo,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyBulkMutationDo" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "arg": "1234"
+  }'
+*/

package/api/shopify/shopifyBulkOperationGet.js

@@ -0,0 +1,86 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/bulkOperation
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden, actionSingleOrMultiple } = require('../utils');
+const { shopifyGetSingle } = require('./shopifyGetSingle');
+
+const defaultAttrs = `
+  id
+  status
+  type
+  objectCount
+  url
+  errorCode
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['bulkOperationId'],
+]);
+
+const shopifyBulkOperationGetSingle = async (
+  credsPayload,
+  bulkOperationId,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+  } = {},
+) => {
+  return shopifyGetSingle(
+    credsPayload,
+    'bulkOperation',
+    bulkOperationId,
+    {
+      apiVersion,
+      attrs,
+    },
+  );
+};
+
+const shopifyBulkOperationGet = async (
+  credsPayload,
+  bulkOperationId,
+  {
+    queueRunOptions,
+    apiVersion,
+    attrs = defaultAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    bulkOperationId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    bulkOperationId,
+    shopifyBulkOperationGetSingle,
+    (bulkOperationIdItem) => ({
+      args: [credsPayload, bulkOperationIdItem, { apiVersion, attrs }],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyBulkOperationGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyBulkOperationGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "bulkOperationId": "3525975375944"
+  }'
+*/

package/api/shopify/shopifyBulkOperationRunMutation.js

@@ -0,0 +1,83 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/bulkOperationRunMutation
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('./shopifyMutationDo');
+
+const defaultReturnAttrs = `
+  id
+  type
+  status
+  objectCount
+  url
+`;
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['mutation'],
+  ['stagedUploadPath'],
+]);
+
+const shopifyBulkOperationRunMutation = async (
+  credsPayload,
+  mutation,
+  stagedUploadPath,
+  {
+    apiVersion,
+    returnAttrs = defaultReturnAttrs,
+    clientIdentifier,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    mutation,
+    stagedUploadPath,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'bulkOperationRunMutation',
+    {
+      mutationVariables: {
+        mutation: {
+          type: 'String!',
+          value: mutation,
+        },
+        stagedUploadPath: {
+          type: 'String!',
+          value: stagedUploadPath,
+        },
+        ...clientIdentifier && {
+          clientIdentifier: {
+            type: 'String',
+            value: clientIdentifier,
+          },
+        },
+      },
+      returnSchema: `bulkOperation { ${ returnAttrs } }`,
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyBulkOperationRunMutation,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyBulkOperationRunMutation" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "arg": "1234"
+  }'
+*/

package/api/shopify/shopifyCheckoutAndAccountsConfigurationUpdate.js

@@ -0,0 +1,79 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/checkoutAndAccountsConfigurationUpdate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['configurationId'],
+  ['updatePayload'],
+]);
+
+const defaultReturnConfigurationAttrs = 'id name isPublished updatedAt';
+
+const shopifyCheckoutAndAccountsConfigurationUpdate = async (
+  credsPayload,
+  configurationId,
+  updatePayload,
+  {
+    apiVersion,
+    returnConfigurationAttrs = defaultReturnConfigurationAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    configurationId,
+    updatePayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'checkoutAndAccountsConfigurationUpdate',
+    {
+      mutationVariables: {
+        id: {
+          type: 'ID!',
+          value: `gid://shopify/CheckoutAndAccountsConfiguration/${ configurationId }`,
+        },
+        configuration: {
+          type: 'CheckoutAndAccountsConfigurationInput!',
+          value: updatePayload,
+        },
+      },
+      returnSchema: `configuration { ${ returnConfigurationAttrs } }`,
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyCheckoutAndAccountsConfigurationUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyCheckoutAndAccountsConfigurationUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "configurationId": "123456789",
+    "updatePayload": {
+      "branding": {
+        "designTokens": {
+          "cornerRadius": {
+            "large": "LARGE"
+          }
+        }
+      }
+    }
+  }'
+*/

package/api/shopify/shopifyCollectionGet.js

@@ -1,7 +1,7 @@
 // https://shopify.dev/docs/api/admin-graphql/latest/queries/collection
 
 const { credsValidator } = require('../validators');
-const { ArgsWarden, objHasAny, credsFromPayload } = require('../utils');
+const { ArgsWarden, objHasAny } = require('../utils');
 const { shopifyGetSingle } = require('../shopify/shopifyGetSingle');
 const { shopifyClient } = require('../shopify/shopify.utils');
 
@@ -42,8 +42,6 @@ const shopifyCollectionGet = async (
 
   if (!id) {
 
-    const creds = await credsFromPayload(credsPayload);
-
     const query = `
       query GetCollectionByIdentifier ($identifier: CollectionIdentifierInput!) {
         collection: collectionByIdentifier(identifier: $identifier) {
@@ -60,10 +58,12 @@ const shopifyCollectionGet = async (
     };
 
     const response = await shopifyClient.fetch({
-      method: 'post',
-      body: { query, variables },
+      requestPayload: {
+        method: 'post',
+        body: { query, variables },
+      },
       context: {
-        creds,
+        credsPayload,
         apiVersion,
         resultPath: 'data.collection',
       },
@@ -75,7 +75,7 @@ const shopifyCollectionGet = async (
   return shopifyGetSingle(
     credsPayload,
     'collection',
-    collectionIdentifier,
+    id,
     {
       apiVersion,
       attrs,

package/api/shopify/shopifyCustomerGet.js

@@ -1,7 +1,7 @@
 // https://shopify.dev/docs/api/admin-graphql/latest/queries/customer
 
 const { credsValidator } = require('../validators');
-const { objHasAny, credsFromPayload, ArgsWarden } = require('../utils');
+const { objHasAny, ArgsWarden } = require('../utils');
 const { shopifyGetSingle } = require('../shopify/shopifyGetSingle');
 const { shopifyClient } = require('../shopify/shopify.utils');
 
@@ -44,8 +44,6 @@ const shopifyCustomerGet = async (
 
   if (!customerId) {
 
-    const creds = await credsFromPayload(credsPayload);
-
     const query = `
       query GetCustomerByIdentifier ($identifier: CustomerIdentifierInput!) {
         customer: customerByIdentifier(identifier: $identifier) {
@@ -63,10 +61,12 @@ const shopifyCustomerGet = async (
     };
 
     const response = await shopifyClient.fetch({
-      method: 'post',
-      body: { query, variables },
+      requestPayload: {
+        method: 'post',
+        body: { query, variables },
+      },
       context: {
-        creds,
+        credsPayload,
         apiVersion,
         resultPath: 'data.customer',
       },

package/api/shopify/shopifyGet.js

@@ -1,4 +1,4 @@
-const { credsFromPayload, Getter, capitaliseString, ArgsWarden } = require('../utils');
+const { Getter, capitaliseString, ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { shopifyClient } = require('./shopify.utils');
 const { MAX_PER_PAGE } = require('./shopify.constants');
@@ -11,7 +11,7 @@ const argsWarden = new ArgsWarden([
 const shopifyGetPacket = async (
   // options on the main function can become args on the packet get if they have defaults
   // TODO: Consider where defaults should lie
-  creds,
+  credsPayload,
   resource,
   resources,
   attrs,
@@ -108,9 +108,10 @@ const shopifyGetPacket = async (
   };
 
   return await shopifyClient.fetch({
-    method: 'post',
-    body: {
-      query: `
+    requestPayload: {
+      method: 'post',
+      body: {
+        query: `
         query Get${ Resources } (
           ${ queryTypeDeclaration }
         ) {
@@ -129,10 +130,11 @@ const shopifyGetPacket = async (
           }
         }
       `,
-      variables,
+        variables,
+      },
     },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
       resultPath: `data.${ resources }`,
     },
@@ -231,14 +233,12 @@ const shopifyGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const getter = new Getter(
     {
       args: [
-        creds, 
-        resource, 
-        resources, 
+        credsPayload,
+        resource,
+        resources,
         attrs,
       ],
       options: {
@@ -276,7 +276,12 @@ const shopifyGet = async (
     return getter;
   }
 
-  return await getter.run({ returnAll: true });
+  const data = await getter.run({ returnAll: true });
+
+  return {
+    ok: true,
+    data,
+  };
 };
 
 const funcApiConfig = {

package/api/shopify/shopifyGetSingle.js

@@ -1,4 +1,4 @@
-const { credsFromPayload, capitaliseString, ArgsWarden } = require('../utils');
+const { capitaliseString, ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { shopifyClient } = require('./shopify.utils');
 
@@ -35,8 +35,6 @@ const shopifyGetSingle = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const Resource = capitaliseString(resource);
   const usesId = !resourcesNotRequiringId.includes(resource);
 
@@ -49,15 +47,17 @@ const shopifyGetSingle = async (
   `;
 
   const response = await shopifyClient.fetch({
-    method: 'post',
-    body: {
-      query,
-      variables: {
-        ...(usesId ? { id: `gid://shopify/${ gidType || Resource }/${ id }` } : {}),
+    requestPayload: {
+      method: 'post',
+      body: {
+        query,
+        variables: {
+          ...(usesId ? { id: `gid://shopify/${ gidType || Resource }/${ id }` } : {}),
+        },
       },
     },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
       resultPath: `data.${ resource }`,
     },

package/api/shopify/shopifyMutationDo.js

@@ -1,4 +1,4 @@
-const { credsFromPayload, logDeep, ArgsWarden } = require('../utils');
+const { logDeep, ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { shopifyClient } = require('./shopify.utils');
 
@@ -27,8 +27,6 @@ const shopifyMutationDo = async (
     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(', ') }) {
@@ -47,10 +45,12 @@ const shopifyMutationDo = async (
   }
 
   const response = await shopifyClient.fetch({
-    method: 'post',
-    body: { query: mutation, variables },
+    requestPayload: {
+      method: 'post',
+      body: { query: mutation, variables },
+    },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
       resultPath: `data.${ mutationName }`,
     },