@foxtware/mineral 0.1.36 → 0.1.37

package/api/peoplevox/peoplevoxOrderEdit.js

@@ -1,6 +1,13 @@
 const { json2csv } = require('json-2-csv');
 const { credsValidator } = require('../validators');
-const { ensureArray, everyIfArray, ArgsWarden } = require('../utils');
+const {
+  ensureArray,
+  everyIfArray,
+  ArgsWarden,
+  arrayToChunks,
+  groupObjectsByFields,
+  actionSingleOrMultiple,
+} = require('../utils');
 const { peoplevoxClient } = require('../peoplevox/peoplevox.utils');
 const { MAX_REQUEST_ITEMS } = require('../peoplevox/peoplevox.constants');
 
@@ -11,36 +18,15 @@ const argsWarden = new ArgsWarden([
   ['orderPayload', (i) => everyIfArray(orderPayloadValidator, i)],
 ]);
 
-const peoplevoxOrderEdit = async (
+const peoplevoxOrderEditChunk = async (
   credsPayload,
-  orderPayload,
+  orderPayloads,
   {
     fetchClient = peoplevoxClient,
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({
-    credsPayload,
-    orderPayload,
-  });
-  if (rejectResponse) {
-    return rejectResponse;
-  }
-
-  // TODO: Consider making CSV transformation a request preparer step
-  const csvData = await json2csv(ensureArray(orderPayload));
-  
-  // TODO: Handle by chunking
-  // TODO: Chunk objects by common fields so that each call has a consistent schema - bedrock groupObjectsByFields
-  if (csvData.length > MAX_REQUEST_ITEMS) {
-    return {
-      ok: false,
-      error: {
-        code: 'MAX_REQUEST_ITEMS_EXCEEDED',
-        message: `Max request items exceeded. Max is ${ MAX_REQUEST_ITEMS }.`,
-      },
-    };
-  }
+  const csvData = await json2csv(orderPayloads);
 
   return fetchClient.fetch({
     requestPayload: {
@@ -59,6 +45,44 @@ const peoplevoxOrderEdit = async (
   });
 };
 
+const peoplevoxOrderEdit = async (
+  credsPayload,
+  orderPayload,
+  {
+    fetchClient = peoplevoxClient,
+    queueRunOptions,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    orderPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  // TODO: Consider making CSV transformation a request preparer step
+  const orderPayloads = ensureArray(orderPayload);
+
+  // Sort into buckets of matching field sets so json2csv does not pad missing keys,
+  // then chunk each bucket by max size
+  const buckets = groupObjectsByFields(orderPayloads);
+  const chunksByBucket = buckets.map((bucket) => arrayToChunks(bucket, MAX_REQUEST_ITEMS));
+  const chunks = chunksByBucket.flat();
+
+  return actionSingleOrMultiple(
+    chunks,
+    peoplevoxOrderEditChunk,
+    (chunk) => ({
+      args: [credsPayload, chunk, { fetchClient }],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
 const funcApiConfig = {
   argsWarden,
 };

package/api/shopify/shopifyInventoryItemUpdate.js

@@ -9,30 +9,39 @@ const {
 } = require('../utils');
 const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
 
-const inventoryItemUpdatePayloadValidator = (updatePayload) => {
-  return valueProvided(updatePayload)
+const inventoryItemUpdateValidator = (inventoryItemUpdate) => {
+  const {
+    inventoryItemId,
+    ...updatePayload
+  } = inventoryItemUpdate;
+
+  return valueProvided(inventoryItemId)
+    && valueProvided(updatePayload)
     && typeof updatePayload === 'object'
     && !Array.isArray(updatePayload);
 };
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
-  ['inventoryItemId', (id) => everyIfArray(valueProvided, id)],
-  ['updatePayload', (payload) => everyIfArray(inventoryItemUpdatePayloadValidator, payload)],
+  ['inventoryItemUpdate', (p) => everyIfArray(inventoryItemUpdateValidator, p)],
 ]);
 
 const defaultReturnInventoryItemAttrs = 'id countryCodeOfOrigin harmonizedSystemCode';
 
 const shopifyInventoryItemUpdateSingle = async (
   credsPayload,
-  inventoryItemId,
-  updatePayload,
+  inventoryItemUpdate,
   {
     apiVersion,
     returnInventoryItemAttrs = defaultReturnInventoryItemAttrs,
   } = {},
 ) => {
 
+  const {
+    inventoryItemId,
+    ...updatePayload
+  } = inventoryItemUpdate;
+
   return shopifyMutationDo(
     credsPayload,
     'inventoryItemUpdate',
@@ -55,8 +64,7 @@ const shopifyInventoryItemUpdateSingle = async (
 
 const shopifyInventoryItemUpdate = async (
   credsPayload,
-  inventoryItemId,
-  updatePayload,
+  inventoryItemUpdate, // update payload with inventoryItemId included
   {
     queueRunOptions,
     apiVersion,
@@ -66,21 +74,19 @@ const shopifyInventoryItemUpdate = async (
 
   const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
-    inventoryItemId,
-    updatePayload,
+    inventoryItemUpdate,
   });
   if (rejectResponse) {
     return rejectResponse;
   }
 
   return actionSingleOrMultiple(
-    [inventoryItemId, updatePayload],
+    [inventoryItemUpdate],
     shopifyInventoryItemUpdateSingle,
-    (inventoryItemIdItem, updatePayloadItem) => ({
+    (inventoryItemUpdateItem) => ({
       args: [
         credsPayload,
-        inventoryItemIdItem,
-        updatePayloadItem,
+        inventoryItemUpdateItem,
         {
           apiVersion,
           returnInventoryItemAttrs,
@@ -107,8 +113,8 @@ curl -X POST "http://localhost:8000/shopifyInventoryItemUpdate" \
   -H "Content-Type: application/json" \
   -d '{
     "credsPayload": { "credsPath": "shopify.au" },
-    "inventoryItemId": "43729076",
-    "updatePayload": {
+    "inventoryItemUpdate": {
+      "inventoryItemId": "43729076",
       "countryCodeOfOrigin": "US",
       "harmonizedSystemCode": "621710"
     }

package/api/shopify/shopifyInventoryItemsUpdateBulk.js

@@ -0,0 +1,79 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/inventoryitemupdate
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyBulkMutationDo } = require('./shopifyBulkMutationDo');
+
+const inventoryItemsUpdateBulkMutation = `
+  mutation call($id: ID!, $input: InventoryItemInput!) {
+    inventoryItemUpdate(id: $id, input: $input) {
+      inventoryItem {
+        id
+      }
+      userErrors {
+        field
+        message
+      }
+    }
+  }
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['inventoryItemUpdates', Array.isArray], // TODO: Real validator mandating inventoryItemId
+]);
+
+const shopifyInventoryItemsUpdateBulk = async (
+  credsPayload,
+  inventoryItemUpdates,
+  {
+    ...bulkMutationOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    inventoryItemUpdates,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyBulkMutationDo(
+    credsPayload,
+    {
+      mutation: inventoryItemsUpdateBulkMutation,
+      input: {
+        data: inventoryItemUpdates.map(({ inventoryItemId, ...input }) => ({
+          id: `gid://shopify/InventoryItem/${ inventoryItemId }`,
+          input,
+        })),
+      },
+    },
+    bulkMutationOptions,
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyInventoryItemsUpdateBulk,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyInventoryItemsUpdateBulk" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "inventoryItemUpdates": [
+      {
+        "inventoryItemId": "43729076",
+        "countryCodeOfOrigin": "US",
+        "harmonizedSystemCode": "621710"
+      }
+    ]
+  }'
+*/

package/api/shopify/shopifyMetafieldsSetBulk.js

@@ -0,0 +1,87 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/metafieldsset
+// https://shopify.dev/docs/api/usage/bulk-operations/imports
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyBulkMutationDo } = require('./shopifyBulkMutationDo');
+
+const metafieldsSetBulkMutation = `
+  mutation call($metafields: [MetafieldsSetInput!]!) {
+    metafieldsSet(metafields: $metafields) {
+      metafields {
+        id
+        namespace
+        key
+        type
+        value
+      }
+      userErrors {
+        field
+        message
+      }
+    }
+  }
+`.trim();
+
+const metafieldsValidator = (metafields) => {
+  return Array.isArray(metafields) && metafields.length > 0;
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['metafields', metafieldsValidator],
+]);
+
+const shopifyMetafieldsSetBulk = async (
+  credsPayload,
+  metafields,
+  {
+    ...bulkMutationOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    metafields,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyBulkMutationDo(
+    credsPayload,
+    {
+      mutation: metafieldsSetBulkMutation,
+      input: {
+        data: metafields.map((metafield) => ({
+          metafields: [metafield],
+        })),
+      },
+    },
+    bulkMutationOptions,
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyMetafieldsSetBulk,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyMetafieldsSetBulk" \
+  -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/shopifyProductGet.js

@@ -91,6 +91,7 @@ const funcApiConfig = {
 module.exports = {
   shopifyProductGet,
   funcApiConfig,
+  productIdentifierValidator, // TODO: Consider moving to validators
 };
 
 /*

package/api/shopify/shopifyProductUpdate.js

@@ -0,0 +1,136 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/productUpdate
+
+const { credsValidator } = require('../validators');
+const {
+  actionSingleOrMultiple,
+  everyIfArray,
+  ArgsWarden,
+  valueProvided,
+} = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const productUpdateValidator = (productUpdate) => {
+  const {
+    productIdentifier,
+    media,
+    product,
+  } = productUpdate || {};
+
+  return valueProvided(productIdentifier) && (media || product);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['productUpdate', (p) => everyIfArray(productUpdateValidator, p)],
+]);
+
+const defaultReturnProductAttrs = 'id handle';
+
+const shopifyProductUpdateSingle = async (
+  credsPayload,
+  productUpdate,
+  {
+    apiVersion,
+    returnProductAttrs = defaultReturnProductAttrs,
+  } = {},
+) => {
+
+  const {
+    productIdentifier,
+    media,
+    product,
+  } = productUpdate;
+
+  const {
+    productId,
+    handle,
+    customId,
+  } = productIdentifier;
+
+  return shopifyMutationDo(
+    credsPayload,
+    'productUpdate',
+    {
+      mutationVariables: {
+        identifier: {
+          type: 'ProductUpdateIdentifiers',
+          value: {
+            ...((productId) && { id: `gid://shopify/Product/${ productId }` }),
+            ...(handle && { handle }),
+            ...(customId && { customId }),
+          },
+        },
+        ...(product && { product: {
+          type: 'ProductUpdateInput!',
+          value: product,
+        }}),
+        ...(media && { media: {
+          type: '[CreateMediaInput!]',
+          value: media,
+        }}),
+      },
+      returnSchema: `product { ${ returnProductAttrs } }`,
+      apiVersion,
+    },
+  );
+};
+
+const shopifyProductUpdate = async (
+  credsPayload,
+  productUpdate,
+  {
+    queueRunOptions,
+    apiVersion,
+    returnProductAttrs = defaultReturnProductAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    productUpdate,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    [productUpdate],
+    shopifyProductUpdateSingle,
+    (productUpdateItem) => ({
+      args: [
+        credsPayload,
+        productUpdateItem,
+        {
+          apiVersion,
+          returnProductAttrs,
+        },
+      ],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyProductUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyProductUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "productUpdate": {
+      "productIdentifier": "104188477512",
+      "product": {
+        "title": "Example"
+      }
+    }
+  }'
+*/

package/api/shopify/shopifyProductUpdateTrigger.js

@@ -0,0 +1,96 @@
+// "Artificially" fires a product update webhook by appending a space to the product title, which Shopify strips.
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+
+const { shopifyProductGet, productIdentifierValidator } = require('../shopify/shopifyProductGet');
+const { shopifyProductUpdate } = require('../shopify/shopifyProductUpdate');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['productIdentifier', productIdentifierValidator],
+]);
+
+const shopifyProductUpdateTrigger = async (
+  credsPayload,
+  productIdentifier,
+  {
+    apiVersion,
+    productTitle,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    productIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  if (!productTitle) {
+    const productResponse = await shopifyProductGet(
+      credsPayload,
+      productIdentifier,
+      {
+        attrs: 'title',
+      },
+    );
+    
+    const {
+      ok: productOk,
+      data: productData,
+    } = productResponse;
+    if (!productOk) {
+      return productResponse;
+    }
+
+    ({ title: productTitle } = productData);
+  }
+
+  if (!productTitle) {
+    return {
+      ok: false,
+      error: 'Product title not found',
+    };
+  }
+
+  return shopifyProductUpdate(
+    credsPayload,
+    {
+      productIdentifier,
+      product: {
+        title: `${ productTitle } `,
+      },
+    },
+    {
+      apiVersion,
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyProductUpdateTrigger,
+  funcApiConfig,
+};
+
+/*
+  curl -X POST "http://localhost:8000/shopifyProductUpdateTrigger" \
+    -H "Content-Type: application/json" \
+    -d '{
+      "credsPayload": { "credsPath": "shopify.au" },
+      "productIdentifier": { "productId": "1234567890" }
+    }'
+
+  curl -X POST "http://localhost:8000/shopifyProductUpdateTrigger" \
+    -H "Content-Type: application/json" \
+    -d '{
+      "credsPayload": { "credsPath": "shopify.au" },
+      "productIdentifier": { "productId": "1234567890" },
+      "options": { "productTitle": "Ultra Strength Freeze Ray" }
+    }'
+*/

package/api/snowflake/docs.md

@@ -3,6 +3,12 @@
 - [Developer documentation](https://docs.snowflake.com/en/developer-guide)
 - [SQL API](https://docs.snowflake.com/en/developer-guide/sql-api/index)
 - [SQL API reference](https://docs.snowflake.com/en/developer-guide/sql-api/reference)
-- [Authenticating to the SQL API](https://docs.snowflake.com/en/developer-guide/sql-api/authenticating)
+- [Snowflake REST APIs](https://docs.snowflake.com/en/developer-guide/snowflake-rest-api)
+- [Authenticating](https://docs.snowflake.com/en/developer-guide/sql-api/authenticating)
 
-Account-scoped HTTPS JSON API at `https://{account_identifier}.snowflakecomputing.com/api/v2/statements` for submitting SQL, polling handles, and canceling runs, authenticated with OAuth or key-pair JWT rather than a single static API key.
+Account-scoped HTTPS JSON APIs at `https://{account_identifier}.snowflakecomputing.com`:
+
+- **SQL API** (`/api/v2/statements`) — submit SQL, poll handles, cancel runs, partitioned result sets
+- **REST APIs** (`/api/v2/databases`, schemas, tables, users, …) — manage and list account objects with `showLimit` / `fromName` pagination
+
+Auth: OAuth access token, programmatic access token, or key-pair JWT. Optional OAuth client + refresh token can mint access tokens without Upstash.

package/api/snowflake/snowflake.constants.js

@@ -0,0 +1,19 @@
+const SQL_API_PATH = '/api/v2/statements';
+const REST_API_VERSION = 'v2';
+const DEFAULT_STATEMENT_TIMEOUT_SECONDS = 60;
+const DEFAULT_POLL_INTERVAL_MS = 1000;
+const DEFAULT_POLL_MAX_ATTEMPTS = 120;
+const JWT_LIFETIME_SECONDS = 59 * 60; // max 1 hour; stay under
+const DEFAULT_SHOW_LIMIT = 100;
+const MAX_SHOW_LIMIT = 10000;
+
+module.exports = {
+  SQL_API_PATH,
+  REST_API_VERSION,
+  DEFAULT_STATEMENT_TIMEOUT_SECONDS,
+  DEFAULT_POLL_INTERVAL_MS,
+  DEFAULT_POLL_MAX_ATTEMPTS,
+  JWT_LIFETIME_SECONDS,
+  DEFAULT_SHOW_LIMIT,
+  MAX_SHOW_LIMIT,
+};