@foxtware/mineral 0.1.22 → 0.1.24

package/api/peoplevox/peoplevox.utils.js

@@ -1,5 +1,6 @@
 const csvtojson = require('csvtojson');
 const xml2js = require('xml2js');
+const { HOSTED } = require('../constants');
 const { resolveCreds } = require('../pipelineSteps');
 const {
   FetchClient,
@@ -69,7 +70,7 @@ const useSoapEnvelope = async (state) => {
     sessionId,
   });
 
-  logDeep({ envelopeXml });
+  !HOSTED && logDeep({ envelopeXml });
 
   return {
     requestPayload: {

package/api/shopify/shopifyMetafieldDefinitionDelete.js

@@ -0,0 +1,127 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/metafieldDefinitionDelete
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden, valueProvided, actionSingleOrMultiple, everyIfArray } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const metafieldDefinitionIdentifierValidator = (metafieldDefinitionIdentifier) => {
+  const { 
+    id,
+    key,
+    namespace,
+    ownerType,
+  } = metafieldDefinitionIdentifier;
+  return (key && namespace && ownerType)
+    || valueProvided(id);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', (i) => everyIfArray(credsValidator, i)],
+  ['metafieldDefinitionIdentifier', (i) => everyIfArray(metafieldDefinitionIdentifierValidator, i)],
+]);
+
+const shopifyMetafieldDefinitionDeleteSingle = async (
+  credsPayload,
+  metafieldDefinitionIdentifier,
+  {
+    apiVersion,
+    returnSchema = 'deletedDefinitionId',
+    deleteAllAssociatedMetafields = false,
+  } = {},
+) => {
+
+  const {
+    id,
+    key,
+    namespace,
+    ownerType,
+  } = metafieldDefinitionIdentifier;
+
+  return shopifyMutationDo(
+    credsPayload,
+    'metafieldDefinitionDelete',
+    {
+      mutationVariables: {
+        ...(id && { id: {
+          type: 'ID!',
+          value: `gid://shopify/MetafieldDefinition/${ id }`,
+        } }),
+        ...((key && namespace && ownerType) && { 
+          identifier: {
+            type: 'MetafieldDefinitionIdentifierInput!',
+            value: {
+              key,
+              namespace,
+              ownerType,
+            },
+          },
+        }),
+        deleteAllAssociatedMetafields: {
+          type: 'Boolean!',
+          value: deleteAllAssociatedMetafields,
+        },
+      },
+      returnSchema,
+      apiVersion,
+    },
+  );
+};
+
+const shopifyMetafieldDefinitionDelete = async (
+  credsPayload,
+  metafieldDefinitionIdentifier,
+  {
+    queueRunOptions,
+    ...options
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    metafieldDefinitionIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    [credsPayload, metafieldDefinitionIdentifier],
+    shopifyMetafieldDefinitionDeleteSingle,
+    (credsPayloadItem, metafieldDefinitionIdentifierItem) => ({
+      args: [
+        credsPayloadItem, 
+        metafieldDefinitionIdentifierItem, 
+        options,
+      ],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyMetafieldDefinitionDelete,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyMetafieldDefinitionDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": [
+      { "credsPath": "shopify.au" },
+      { "credsPath": "shopify.us" },
+      { "credsPath": "shopify.uk" }
+    ],
+    "metafieldDefinitionIdentifier": {
+      "key": "associations",
+      "namespace": "merch",
+      "ownerType": "PRODUCT"
+    }
+  }'
+*/

package/api/shopify/shopifyOrdersGet.js

@@ -1,18 +1,17 @@
-const { logDeep, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
-const { shopifyClient } = require('./shopify.utils');
+const { shopifyGet, shopifyGetter } = require('./shopifyGet');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
 ]);
 
 const shopifyOrdersGet = async (
+  returnGetter, // Always bound
+
   credsPayload,
   {
-    first = 50,
-    after,
-    query,
-    apiVersion,
+    ...getterOptions // e.g. limit
   } = {},
 ) => {
 
@@ -23,53 +22,17 @@ const shopifyOrdersGet = async (
     return rejectResponse;
   }
 
-  const response = await shopifyClient.fetch({
-    requestPayload: {
-      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: {
-      credsPayload,
-      apiVersion,
-      resultPath: 'data.orders',
+  const getterArgs = [
+    credsPayload, 
+    'order', 
+    {
+      ...getterOptions,
     },
-  });
-
-  if (!response.ok) {
-    return response;
-  }
+  ];
 
-  logDeep('response', response);
-  return response;
+  return returnGetter
+    ? shopifyGetter(...getterArgs)
+    : shopifyGet(...getterArgs);
 };
 
 const funcApiConfig = {
@@ -77,6 +40,7 @@ const funcApiConfig = {
 };
 
 module.exports = {
-  shopifyOrdersGet,
+  shopifyOrdersGet: (...args) => shopifyOrdersGet(false, ...args),
+  shopifyOrdersGetter: (...args) => shopifyOrdersGet(true, ...args),
   funcApiConfig,
 };

package/api/shopify/shopifyShopifyqlQuery.js

@@ -0,0 +1,109 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/shopifyqlQuery
+// Requires API version 2025-10+ and the read_reports access scope.
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyClient } = require('./shopify.utils');
+
+const defaultAttrs = `
+  tableData {
+    columns {
+      name
+      dataType
+      displayName
+    }
+    rows
+  }
+  parseErrors
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['query'],
+]);
+
+const shopifyShopifyqlQuery = async (
+  credsPayload,
+  query,
+  {
+    apiVersion,
+    attrs = defaultAttrs,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    query,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await shopifyClient.fetch({
+    requestPayload: {
+      method: 'post',
+      body: {
+        query: `
+          query Shopifyql($query: String!) {
+            shopifyqlQuery(query: $query) {
+              ${ attrs }
+            }
+          }
+        `,
+        variables: {
+          query,
+        },
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+      resultPath: 'data.shopifyqlQuery',
+    },
+  });
+
+  if (!response?.ok) {
+    return response;
+  }
+
+  const parseErrors = response?.data?.parseErrors;
+  if (Array.isArray(parseErrors) && parseErrors.length) {
+    return {
+      ok: false,
+      error: {
+        code: 'PARSE_ERROR',
+        message: parseErrors.join('; '),
+        details: parseErrors,
+      },
+      data: response.data,
+    };
+  }
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyShopifyqlQuery,
+  funcApiConfig,
+};
+
+/*
+  curl -X POST "http://localhost:8000/shopifyShopifyqlQuery" \
+    -H "Content-Type: application/json" \
+    -d '{
+      "credsPayload": { "credsPath": "shopify.au" },
+      "query": "FROM sales SHOW total_sales, orders TIMESERIES day SINCE -7d ORDER BY day ASC"
+    }'
+
+  Example command to get at last restock date
+  curl -X POST "http://localhost:8000/shopifyShopifyqlQuery" \
+    -H "Content-Type: application/json" \
+    -d '{
+      "credsPayload": { "credsPath": "shopify.au" },
+      "query": "FROM inventory_adjustment_history SHOW inventory_adjustment_change, product_variant_title, product_variant_sku, day GROUP BY product_variant_title, product_variant_sku, day HAVING inventory_adjustment_change > 10 ORDER BY day DESC LIMIT 10"
+    }'
+*/

package/api/tagalys/docs.md

@@ -1,7 +1,7 @@
 # Tagalys
 
-- [Custom integration API (V1)](https://static.tagalys.com/docs/api/custom-integration/)
-- [Support: custom platform integration](https://support.tagalys.com/how-can-i-install-tagalys-to-my-custom-built-ecommerce-platform)
-- [Integration overview](https://support.tagalys.com/integration)
+- [Storefront API (v2)](https://tagalys.notion.site/Storefront-API-v2-20eacdd38c2080d58d3fd0cf6f24e435)
 
-Region-specific HTTPS origins with POST JSON (and FormData for feeds); every call includes an `identification` object (`client_code`, `api_key`, `store_id`) using the private key for sync/config and the public key for storefront search and analytics.
+Region-specific HTTPS origins (`https://api-r{n}.tagalys.com`) with REST-style JSON under `/v2`. Storefront reads use GET; analytics ingest uses `POST /v2/analytics/events` with a JSON body. Browser requests authenticate with the `shop_id` query param (the shop’s `*.myshopify.com` domain). Server-side integrations should also pass `storefront_api_key`.
+
+Endpoints: `GET /v2/collections/:collection_id`, `GET /v2/search`, `GET /v2/search_suggestions`, `GET /v2/popular_searches`, `GET /v2/recommendations/:recommendation_id`, `POST /v2/analytics/events`. Collections and search support pagination (`page`, `per_page`, capped at 10,000 products), sorting (`sort`, `include[]=sort_options`), filtering (`filter[...]`, `include[]=filters`), and scope (`scope[...]`). Use `include[]=products` or `include[]=product_ids` to control product payloads. Optional request context on collections, search, and recommendations: `country`, `language`, `segment_tag`. Errors return JSON with `error.type`, `error.code`, and `error.message`.

package/api/utils.js

@@ -1180,6 +1180,10 @@ class Getter extends EventEmitter {
         items = ensureArray(response);
       }
 
+      if (!items) {
+        logDeep({ response });
+      }
+
       if (this.limit) {
         const itemsLeft = this.limit - resultsCount;
         items = items.slice(0, itemsLeft);

package/hosting/hostingPreview.js

@@ -1,6 +1,6 @@
 const http = require('http');
 const { createRequire } = require('module');
-const { respondJson, errorToReadable } = require('../server.utils');
+const { respondJson, errorToReadable, listenOrOfferKillPort } = require('../server.utils');
 const { getWorkspace, setWorkspace, loadWorkspaceEnv, toAbsolutePath } = require('../api/workspace');
 const { getApiDirs, readCliFlag } = require('../cli');
 const { loadHandlers } = require('../server');
@@ -137,7 +137,7 @@ const startHostingPreview = (options = {}) => {
   const handlers = loadHostedRoutes(config);
   const server = createHostedPreviewServer(handlers);
 
-  server.listen(config.port, () => {
+  listenOrOfferKillPort(server, config.port, () => {
     console.log(`Hosting preview running on port ${ config.port }`);
     console.log(`Workspace: ${ config.workspace }`);
     console.log('Hosted routes:');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foxtware/mineral",
-  "version": "0.1.22",
+  "version": "0.1.24",
   "bin": {
     "mineral": "bin/mineral.js"
   },

package/server.js

@@ -1,6 +1,14 @@
 const fs = require('fs');
 const http = require('http');
-const { respondJson, errorToReadable, getRequestBody, argsFromBody, funcApi, statusCodeFromResult } = require('./server.utils');
+const {
+  respondJson,
+  errorToReadable,
+  getRequestBody,
+  argsFromBody,
+  funcApi,
+  statusCodeFromResult,
+  listenOrOfferKillPort,
+} = require('./server.utils');
 const { getWorkspace, setWorkspace, loadWorkspaceEnv, toAbsolutePath } = require('./api/workspace');
 const { getApiDirs, readCliFlag } = require('./cli');
 const { getFuncApiConfig } = require('./hosting/hosting.utils');
@@ -208,7 +216,7 @@ const startServer = (options = {}) => {
   handlers = loadHandlers(config);
   server = createServer(handlers);
 
-  server.listen(config.port, () => logStartup({
+  listenOrOfferKillPort(server, config.port, () => logStartup({
     ...config,
     handlers,
   }));

package/server.utils.js

@@ -1,4 +1,5 @@
-const { logDeep } = require('./api/utils');
+const { execFileSync } = require('child_process');
+const { logDeep, askQuestion } = require('./api/utils');
 const { HOSTED } = require('./api/constants');
 const { StringDecoder } = require('string_decoder');
 
@@ -277,6 +278,171 @@ const funcApi = (func, config = {}) => {
   };
 };
 
+const wait = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+
+const isWatchMode = () => process.execArgv.some((arg) => arg.startsWith('--watch'));
+
+const exitServer = (code = 0) => {
+  if (isWatchMode() && process.ppid && process.ppid !== 1) {
+    try {
+      process.kill(process.ppid, 'SIGTERM');
+    } catch (error) {
+      // Parent may already be gone.
+    }
+  }
+
+  process.exit(code);
+};
+
+const findPortListeners = (port) => {
+  try {
+    const stdout = execFileSync('lsof', [
+      '-nP',
+      `-iTCP:${ port }`,
+      '-sTCP:LISTEN',
+      '-Fpc',
+    ], {
+      encoding: 'utf8',
+    });
+
+    const listeners = [];
+    let pid = null;
+
+    for (const line of stdout.split('\n')) {
+      if (line.startsWith('p')) {
+        pid = Number(line.slice(1));
+        continue;
+      }
+
+      if (line.startsWith('c') && pid) {
+        listeners.push({
+          pid,
+          command: line.slice(1),
+        });
+        pid = null;
+      }
+    }
+
+    return listeners.filter((listener) => listener.pid && listener.pid !== process.pid);
+  } catch (error) {
+    return [];
+  }
+};
+
+const formatPortListeners = (listeners) => listeners
+  .map(({ pid, command }) => `${ command } (PID ${ pid })`)
+  .join(', ');
+
+const killPortListeners = async (listeners) => {
+  for (const { pid } of listeners) {
+    try {
+      process.kill(pid, 'SIGTERM');
+    } catch (error) {
+      if (error.code !== 'ESRCH') {
+        throw error;
+      }
+    }
+  }
+
+  await wait(300);
+
+  for (const { pid } of listeners) {
+    try {
+      process.kill(pid, 0);
+      process.kill(pid, 'SIGKILL');
+    } catch (error) {
+      if (error.code !== 'ESRCH') {
+        throw error;
+      }
+    }
+  }
+
+  await wait(200);
+};
+
+const listenOrOfferKillPort = (server, port, onListening) => {
+  let recovering = false;
+
+  const tryListen = () => {
+    server.listen(port);
+  };
+
+  const askRecoveryQuestions = async () => {
+    const shouldFind = await askQuestion('Look up the process using it? ');
+
+    if (shouldFind === 'n') {
+      return false;
+    }
+
+    if (shouldFind !== '') {
+      console.error('not a valid input');
+      exitServer(1);
+    }
+
+    const listeners = findPortListeners(port);
+
+    if (!listeners.length) {
+      console.error(`Could not find a process listening on port ${ port }.`);
+      return false;
+    }
+
+    console.log('Port in use by:', formatPortListeners(listeners));
+
+    const shouldKill = await askQuestion('Kill it and retry? ');
+
+    if (shouldKill === 'n') {
+      return false;
+    }
+
+    if (shouldKill !== '') {
+      console.error('not a valid input');
+      exitServer(1);
+    }
+
+    await killPortListeners(listeners);
+    return true;
+  };
+
+  server.once('listening', onListening);
+
+  server.on('error', async (error) => {
+    if (error.code !== 'EADDRINUSE') {
+      console.error(error);
+      exitServer(1);
+    }
+
+    if (recovering) {
+      console.error(error);
+      exitServer(1);
+    }
+
+    console.error(error);
+
+    if (HOSTED) {
+      exitServer(1);
+    }
+
+    recovering = true;
+
+    try {
+      const shouldRetry = await askRecoveryQuestions();
+
+      if (!shouldRetry) {
+        exitServer(0);
+      }
+
+      tryListen();
+    } catch (recoveryError) {
+      console.error(recoveryError);
+      exitServer(1);
+    }
+  });
+
+  tryListen();
+
+  return server;
+};
+
 module.exports = {
   respondJson,
   errorToReadable,
@@ -285,4 +451,6 @@ module.exports = {
   wrapFunction,
   statusCodeFromResult,
   funcApi,
+  findPortListeners,
+  listenOrOfferKillPort,
 };