@foxtware/mineral 0.1.17 → 0.1.18

package/api/linear/linearWebhookCreate.js

@@ -0,0 +1,77 @@
+// https://linear.app/developers/graphql
+
+const { ArgsWarden, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { linearClient } = require('../linear/linear.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['input', valueProvided],
+]);
+
+const linearWebhookCreate = async (
+  credsPayload,
+  input,
+  {
+    inspect = false,
+    fetchClient = linearClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    input,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      body: {
+        query: `
+          mutation WebhookCreate($input: WebhookCreateInput!) {
+            webhookCreate(input: $input) {
+              success
+              webhook {
+                id
+                url
+                enabled
+              }
+            }
+          }
+        `,
+        variables: {
+          input,
+        },
+      },
+    },
+    context: {
+      credsPayload,
+      resultPath: 'data.webhookCreate',
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  linearWebhookCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/linearWebhookCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "linear" },
+    "input": {
+      "url": "https://example.com/hooks/linear",
+      "teamId": "f2387dcd-61ac-49aa-8d7a-7f62a0b5cca0",
+      "resourceTypes": ["Issue"]
+    }
+  }'
+*/

package/api/linear/linearWebhookDelete.js

@@ -0,0 +1,68 @@
+// https://linear.app/developers/graphql
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { linearClient } = require('../linear/linear.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['id'],
+]);
+
+const linearWebhookDelete = async (
+  credsPayload,
+  id,
+  {
+    inspect = false,
+    fetchClient = linearClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    id,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      body: {
+        query: `
+          mutation WebhookDelete($id: String!) {
+            webhookDelete(id: $id) {
+              success
+            }
+          }
+        `,
+        variables: {
+          id,
+        },
+      },
+    },
+    context: {
+      credsPayload,
+      resultPath: 'data.webhookDelete',
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  linearWebhookDelete,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/linearWebhookDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "linear" },
+    "id": "WEBHOOK_ID"
+  }'
+*/

package/api/linear/linearWebhooksGet.js

@@ -0,0 +1,67 @@
+// https://linear.app/developers/graphql
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { linearGet, linearGetter } = require('./linearGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const linearWebhooksGet = async (
+  returnGetter,
+
+  credsPayload,
+  {
+    attrs = `
+      id
+      url
+      enabled
+    `,
+    filterType = null,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getterArgs = [
+    credsPayload,
+    'webhook',
+    {
+      attrs,
+      filterType,
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? linearGetter(...getterArgs)
+    : linearGet(...getterArgs);
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  linearWebhooksGet: linearWebhooksGet.bind(null, false),
+  linearWebhooksGetter: linearWebhooksGet.bind(null, true),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/linearWebhooksGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "linear" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/linear/linearWorkflowStatesGet.js

@@ -0,0 +1,73 @@
+// https://linear.app/developers/graphql
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { linearGet, linearGetter } = require('./linearGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const linearWorkflowStatesGet = async (
+  returnGetter,
+
+  credsPayload,
+  {
+    attrs = `
+      id
+      name
+      type
+      position
+      team {
+        id
+        name
+      }
+    `,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getterArgs = [
+    credsPayload,
+    'workflowState',
+    {
+      attrs,
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? linearGetter(...getterArgs)
+    : linearGet(...getterArgs);
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  linearWorkflowStatesGet: linearWorkflowStatesGet.bind(null, false),
+  linearWorkflowStatesGetter: linearWorkflowStatesGet.bind(null, true),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/linearWorkflowStatesGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "linear" },
+    "options": {
+      "limit": 20,
+      "filter": {
+        "team": { "id": { "eq": "f2387dcd-61ac-49aa-8d7a-7f62a0b5cca0" } }
+      }
+    }
+  }'
+*/

package/api/pipe17/pipe17.utils.js

@@ -75,6 +75,7 @@ const pipe17Client = new FetchClient({
     'fetch',
     fetchClientCommonSteps.exitEarlyOnNotOk,
     interpretPipe17Response,
+    fetchClientCommonSteps.digToPath,
   ],
 });
 
@@ -83,37 +84,23 @@ const pipe17GetSingle = async (
   collectionPath,
   id,
   {
-    resultKey,
+    resultPath,
     inspect = false,
     fetchClient = pipe17Client,
   } = {},
 ) => {
 
-  const response = await fetchClient.fetch({
+  return fetchClient.fetch({
     requestPayload: {
       method: 'get',
       url: `${ collectionPath }/${ id }`,
     },
-    context: { credsPayload },
+    context: {
+      credsPayload,
+      resultPath,
+    },
     inspect,
   });
-
-  if (!response.ok) {
-    return response;
-  }
-
-  const resolvedResultKey = resultKey ?? collectionPath.replace(/^\//, '').replace(/s$/, '');
-  const entity = response.data?.result?.[resolvedResultKey]
-    ?? response.data?.[resolvedResultKey];
-
-  if (entity !== undefined) {
-    return {
-      ...response,
-      data: entity,
-    };
-  }
-
-  return response;
 };
 
 module.exports = {

package/api/pipe17/pipe17ArrivalGet.js

@@ -52,7 +52,7 @@ const pipe17ArrivalGet = async (
     '/arrivals',
     resolveArrivalId(arrivalIdentifier),
     {
-      resultKey: 'arrival',
+      resultPath: 'result.arrival',
       inspect,
       fetchClient,
     },

package/api/pipe17/pipe17FulfillmentGet.js

@@ -43,7 +43,7 @@ const pipe17FulfillmentGet = async (
     '/fulfillments',
     resolveFulfillmentId(fulfillmentIdentifier),
     {
-      resultKey: 'fulfillment',
+      resultPath: 'result.fulfillment',
       inspect,
       fetchClient,
     },

package/api/pipe17/pipe17InventoryItemGet.js

@@ -31,7 +31,7 @@ const pipe17InventoryItemGet = async (
     '/inventory',
     inventoryItemId,
     {
-      resultKey: 'inventory',
+      resultPath: 'result.inventory',
       inspect,
       fetchClient,
     },

package/api/pipe17/pipe17JobGet.js

@@ -2,7 +2,7 @@
 
 const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
-const { pipe17Client } = require('../pipe17/pipe17.utils');
+const { pipe17GetSingle } = require('../pipe17/pipe17.utils');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
@@ -14,7 +14,7 @@ const pipe17JobGet = async (
   jobId,
   {
     inspect = false,
-    fetchClient = pipe17Client,
+    fetchClient,
   } = {},
 ) => {
 
@@ -26,29 +26,16 @@ const pipe17JobGet = async (
     return rejectResponse;
   }
 
-  const response = await fetchClient.fetch({
-    requestPayload: {
-      method: 'get',
-      url: `/jobs/${ jobId }`,
+  return pipe17GetSingle(
+    credsPayload,
+    '/jobs',
+    jobId,
+    {
+      resultPath: 'result.job',
+      inspect,
+      fetchClient,
     },
-    context: { credsPayload },
-    inspect,
-  });
-
-  if (!response.ok) {
-    return response;
-  }
-
-  const job = response.data?.result?.job
-    ?? response.data?.job;
-  if (job !== undefined) {
-    return {
-      ...response,
-      data: job,
-    };
-  }
-
-  return response;
+  );
 };
 
 const funcApiConfig = {

package/api/pipe17/pipe17LocationGet.js

@@ -31,7 +31,7 @@ const pipe17LocationGet = async (
     '/locations',
     locationId,
     {
-      resultKey: 'location',
+      resultPath: 'result.location',
       inspect,
       fetchClient,
     },

package/api/pipe17/pipe17OrderGet.js

@@ -45,7 +45,7 @@ const pipe17OrderGet = async (
     '/orders',
     resolveOrderId(orderIdentifier),
     {
-      resultKey: 'order',
+      resultPath: 'result.order',
       inspect,
       fetchClient,
     },

package/api/pipe17/pipe17ProductGet.js

@@ -31,7 +31,7 @@ const pipe17ProductGet = async (
     '/products',
     productId,
     {
-      resultKey: 'product',
+      resultPath: 'result.product',
       inspect,
       fetchClient,
     },

package/api/pipe17/pipe17PurchaseGet.js

@@ -31,7 +31,7 @@ const pipe17PurchaseGet = async (
     '/purchases',
     purchaseId,
     {
-      resultKey: 'purchase',
+      resultPath: 'result.purchase',
       inspect,
       fetchClient,
     },

package/api/pipe17/pipe17ReceiptGet.js

@@ -31,7 +31,7 @@ const pipe17ReceiptGet = async (
     '/receipts',
     receiptId,
     {
-      resultKey: 'receipt',
+      resultPath: 'result.receipt',
       inspect,
       fetchClient,
     },

package/api/pipe17/pipe17ReturnGet.js

@@ -31,7 +31,7 @@ const pipe17ReturnGet = async (
     '/returns',
     returnId,
     {
-      resultKey: 'return',
+      resultPath: 'result.return',
       inspect,
       fetchClient,
     },

package/api/shopify/shopifyFileCreate.js

@@ -0,0 +1,107 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/fileCreate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden, ensureArray, everyIfArray } = require('../utils');
+const { shopifyMutationDo } = require('./shopifyMutationDo');
+
+const fileInputValidator = ({ originalSource } = {}) => Boolean(originalSource);
+
+const defaultReturnFileAttrs = `
+  id
+  fileStatus
+  alt
+  fileErrors {
+    code
+    details
+    message
+  }
+  preview {
+    image {
+      url
+    }
+  }
+  ... on MediaImage {
+    image {
+      url
+    }
+  }
+  ... on GenericFile {
+    url
+  }
+  ... on Video {
+    originalSource {
+      url
+    }
+  }
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['fileInput', (fileInput) => everyIfArray(fileInputValidator, fileInput)],
+]);
+
+const shopifyFileCreate = async (
+  credsPayload,
+  fileInput,
+  {
+    apiVersion,
+    returnFileAttrs = defaultReturnFileAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    fileInput,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyMutationDo(
+    credsPayload,
+    'fileCreate',
+    {
+      mutationVariables: {
+        files: {
+          type: '[FileCreateInput!]!',
+          value: ensureArray(fileInput).map(({
+            filename,
+            originalSource,
+            contentType,
+            alt,
+            duplicateResolutionMode,
+          }) => ({
+            originalSource,
+            ...(filename && { filename }),
+            ...(contentType && { contentType }),
+            ...(alt && { alt }),
+            ...(duplicateResolutionMode && { duplicateResolutionMode }),
+          })),
+        },
+      },
+      returnSchema: `files { ${ returnFileAttrs } }`,
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyFileCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyFileCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "fileInput": {
+      "originalSource": "https://upload.wikimedia.org/wikipedia/en/5/5f/Original_Doge_meme.jpg",
+      "filename": "doge.jpg"
+    }
+  }'
+*/

package/api/shopify/shopifyMetafieldDefinitionCreate.js

@@ -39,6 +39,7 @@ const shopifyMetafieldDefinitionCreate = async (
     pin,
     useAsCollectionCondition,
     validations,
+    capabilities,
     returnSchema = defaultReturnSchema,
   } = {},
 ) => {
@@ -73,6 +74,7 @@ const shopifyMetafieldDefinitionCreate = async (
             ...(pin && { pin }),
             ...(useAsCollectionCondition && { useAsCollectionCondition }),
             ...(validations && { validations }),
+            ...(capabilities && { capabilities }),
           },
         },
       },