@foxtware/mineral 0.1.27 → 0.1.29

package/api/tagalys/tagalysRecommendationGet.js

@@ -0,0 +1,109 @@
+// https://tagalys.notion.site/Storefront-API-v2-20eacdd38c2080d58d3fd0cf6f24e435
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden, actionSingleOrMultiple, ensureArray, logDeep } = require('../utils');
+const { MAX_RECOMMENDATION_PRODUCT_IDS } = require('../tagalys/tagalys.constants');
+const { tagalysClient } = require('../tagalys/tagalys.utils');
+
+// System-defined ids: bought_also_bought, viewed_also_viewed, atc_also_atc,
+// recently_viewed, personalized. Custom recommendations use a dashboard slug
+// (e.g. 8d72jc02jd719ddc6hw0).
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['recommendationId'],
+]);
+
+const tagalysRecommendationGetSingle = async (
+  credsPayload,
+  recommendationId,
+  {
+    productIds, // up to 3, for product-contextual recommendations
+    count,
+
+    // personalized / recently_viewed: either deviceId or userId is required
+    deviceId,
+    userId,
+
+    fallbackRecommendationId, // personalized only
+    visitId, // recently_viewed only
+
+    country,
+    language,
+    segmentTag,
+  } = {},
+) => {
+  const response = await tagalysClient.fetch({
+    context: {
+      credsPayload,
+      country,
+      language,
+      segmentTag,
+    },
+    requestPayload: {
+      url: `/v2/recommendations/${ recommendationId }`,
+      method: 'get',
+      query: {
+        ...(productIds ? { product_ids: ensureArray(productIds).slice(0, MAX_RECOMMENDATION_PRODUCT_IDS) } : {}),
+        ...(count ? { count } : {}),
+        ...(deviceId ? { device_id: deviceId } : {}),
+        ...(userId ? { user_id: userId } : {}),
+        ...(fallbackRecommendationId ? { fallback_recommendation_id: fallbackRecommendationId } : {}),
+        ...(visitId ? { visit_id: visitId } : {}),
+      },
+    },
+  });
+
+  const { ok, error } = response;
+  if (!ok) {
+    logDeep({ error });
+  }
+
+  return response;
+};
+
+const tagalysRecommendationGet = async (
+  credsPayload,
+  recommendationId,
+  {
+    queueRunOptions,
+    ...options
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    recommendationId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    recommendationId,
+    tagalysRecommendationGetSingle,
+    (recommendationIdItem) => ({
+      args: [credsPayload, recommendationIdItem, options],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  tagalysRecommendationGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/tagalysRecommendationGet" \
+-d '{
+  "credsPayload": { "credsPath": "tagalys.au" },
+  "recommendationId": "bought_also_bought",
+  "options": { "productIds": ["1234567890"], "count": 10 }
+}'
+*/

package/api/tagalys/tagalysSearch.js

@@ -2,84 +2,8 @@
 
 const { credsValidator } = require('../validators');
 const { ArgsWarden, logDeep } = require('../utils');
-const { resolveCreds } = require('../pipelineSteps');
-const {
-  FetchClient,
-  fetchClientCommonSteps,
-} = require('../utils');
-
-// NOTE: the Storefront API v2 docs authenticate with `shop_id` (the
-// Shopify myshopify.com domain) + an optional `storefront_api_key`, and
-// don't mention a client_code param on this endpoint at all -- that's a
-// holdover from Tagalys' older v1 API. Mapped below as best guess:
-//   BASE_URL   -> used directly (docs say it's region-specific,
-//                 e.g. https://api-r1.tagalys.com -- assumed already
-//                 resolved to the right region in the creds store)
-//   STORE_HANDLE -> expanded to the `shop_id` myshopify domain
-//   STOREFRONT_API_KEY -> sent as `api_key`
-//   CLIENT_CODE -> not used by /v2/search per the docs; left unused below.
-//                  Flag if your account actually needs it sent somewhere.
-const DEFAULT_INCLUDE = ['products', 'total_count'];
-
-// Recursively flattens nested params into Rails/PHP-style bracket query
-// params, e.g. { filter: { color: ['red'] } } -> filter[color][]=red
-// and { filter: { price: { selected_min: 100 } } } -> filter[price][selected_min]=100
-const appendParams = (searchParams, key, value) => {
-  if (value === undefined || value === null) {
-    return;
-  }
-  if (Array.isArray(value)) {
-    value.forEach((item) => appendParams(searchParams, `${ key }[]`, item));
-  } else if (typeof value === 'object') {
-    Object.entries(value).forEach(([subKey, subValue]) => {
-      appendParams(searchParams, `${ key }[${ subKey }]`, subValue);
-    });
-  } else {
-    searchParams.append(key, value);
-  }
-};
-
-const useUrlAndQuery = async (state) => {
-  const { requestPayload, context } = state;
-  const { creds } = context;
-
-  const {
-    BASE_URL,
-    STORE_HANDLE,
-    STOREFRONT_API_KEY,
-  } = creds;
-  const shopId = `${ STORE_HANDLE }.myshopify.com`;
-  const storefrontApiKey = STOREFRONT_API_KEY;
-
-  const searchParams = new URLSearchParams();
-  searchParams.append('shop_id', shopId);
-  if (storefrontApiKey) {
-    searchParams.append('api_key', storefrontApiKey);
-  }
-  Object.entries(requestPayload.query || {}).forEach(([key, value]) => {
-    appendParams(searchParams, key, value);
-  });
-
-  return {
-    requestPayload: {
-      ...requestPayload,
-      url: `${ BASE_URL }${ requestPayload.url }?${ searchParams.toString() }`,
-      headers: {
-        Accept: 'application/json',
-        ...requestPayload.headers,
-      },
-    },
-  };
-};
-
-const tagalysClient = new FetchClient({
-  pipeline: [
-    resolveCreds,
-    useUrlAndQuery,
-    'fetch',
-    fetchClientCommonSteps.exitEarlyOnNotOk,
-  ],
-});
+const { DEFAULT_INCLUDE } = require('../tagalys/tagalys.constants');
+const { tagalysClient } = require('../tagalys/tagalys.utils');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
@@ -96,6 +20,9 @@ const tagalysSearch = async (
     sort, // e.g. 'price-asc'
     page,
     perPage,
+    country,
+    language,
+    segmentTag,
   } = {},
 ) => {
   const rejectResponse = await argsWarden.responseIfRejectingArgs({
@@ -106,9 +33,16 @@ const tagalysSearch = async (
     return rejectResponse;
   }
 
+  // A search can be both redirected and spelling-corrected in the same
+  // response -- redirected/redirectUrl and data (query_handling,
+  // original_query, etc.) both land on the response, see
+  // tagalys.utils.js#useRedirectResponse.
   const response = await tagalysClient.fetch({
     context: {
       credsPayload,
+      country,
+      language,
+      segmentTag,
     },
     requestPayload: {
       url: '/v2/search',
@@ -125,19 +59,12 @@ const tagalysSearch = async (
     },
   });
 
-  const { ok, data, error } = response;
+  const { ok, error } = response;
   if (!ok) {
     logDeep({ error });
-    return { ok: false, error };
-  }
-
-  // A configured redirect takes precedence over the rest of the response --
-  // surface it plainly rather than making callers dig for it.
-  if (data.redirect_url) {
-    return { ok: true, redirected: true, redirectUrl: data.redirect_url, data };
   }
 
-  return { ok: true, data };
+  return response;
 };
 
 const funcApiConfig = {
@@ -146,11 +73,10 @@ const funcApiConfig = {
 
 module.exports = {
   tagalysSearch,
-  tagalysClient,
   funcApiConfig,
 };
 
 /*
 curl -X POST "http://localhost:8000/tagalysSearch" \
--d '{ "credsPayload": { "credsPath": "tagalys.au" }, "query": "gold" }'
+-d '{ "credsPayload": { "credsPath": "tagalys.store" }, "query": "gold" }'
 */

package/api/tagalys/tagalysSearchSuggestionsGet.js

@@ -0,0 +1,76 @@
+// https://tagalys.notion.site/Storefront-API-v2-20eacdd38c2080d58d3fd0cf6f24e435
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden, logDeep, valueProvided } = require('../utils');
+const { tagalysClient } = require('../tagalys/tagalys.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['query'],
+  ['sections', (sections) => valueProvided(sections) && Object.keys(sections).length > 0],
+]);
+
+// `sections` is an object keyed by section_id, e.g.:
+// {
+//   products: { count: 6, include: ['items', 'total_count'], scope: { gender: ['female'] } },
+//   collections: { count: 4 },
+//   searches: { count: 4 },
+// }
+// section_ids and their available options are configured per account by Tagalys.
+const tagalysSearchSuggestionsGet = async (
+  credsPayload,
+  query,
+  sections,
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    query,
+    sections,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  // redirected/redirectUrl land on the response via tagalys.utils.js#useRedirectResponse
+  const response = await tagalysClient.fetch({
+    context: {
+      credsPayload,
+    },
+    requestPayload: {
+      url: '/v2/search_suggestions',
+      method: 'get',
+      query: {
+        query,
+        sections,
+      },
+    },
+  });
+
+  const { ok, error } = response;
+  if (!ok) {
+    logDeep({ error });
+  }
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  tagalysSearchSuggestionsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/tagalysSearchSuggestionsGet" \
+-d '{
+  "credsPayload": { "credsPath": "tagalys.au" },
+  "query": "shi",
+  "sections": {
+    "products": { "count": 6 },
+    "collections": { "count": 4 }
+  }
+}'
+*/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foxtware/mineral",
-  "version": "0.1.27",
+  "version": "0.1.29",
   "bin": {
     "mineral": "bin/mineral.js"
   },
@@ -17,6 +17,7 @@
     "spin_off": "node _build_scripts/spinOff.js",
     "serve": "PORT=8100 node server.js",
     "start": "node server.js",
+    "zip": "sh ../shell_scripts/zip.sh",
     "npm:publish": "node _build_scripts/publish.js"
   },
   "dependencies": {

package/server.js

@@ -200,11 +200,13 @@ const logStartup = ({
   if (api_dirs.length) {
     console.log('Extra API dirs:', api_dirs.join(', '));
   }
-
+  
+  /*
   console.log('Registered routes:');
   for (const route of [...routeHandlers.keys()].sort()) {
     console.log(route);
   }
+  */
 };
 
 const startServer = (options = {}) => {