SFRA Server-side Javascript - Source: app_storefront_base/cartridge/controllers/SearchServices.js menu

SFRA / Server-side JS / Source: app_storefront_base/cartridge/controllers/SearchServices.js 

  1. 'use strict';
  3. /**
  4.  * @namespace SearchServices
  5.  */
  7. var server = require('server');
  9. var cache = require('*/cartridge/scripts/middleware/cache');
  11. var Resource = require('dw/web/Resource');
  13. var preferences = require('*/cartridge/config/preferences.js');
  15. /**
  16.  * SearchServices-GetSuggestions : The SearchServices-GetSuggestions endpoint is responsible for searching as you type and displaying the suggestions from that search
  17.  * @name Base/SearchServices-GetSuggestions
  18.  * @function
  19.  * @memberof SearchServices
  20.  * @param {middleware} - cache.applyDefaultCache
  21.  * @param {querystringparameter} - q - the query string a shopper is searching for
  22.  * @param {category} - non-sensitive
  23.  * @param {returns} - json
  24.  * @param {serverfunction} - get
  25.  */
  26. server.get('GetSuggestions', cache.applyDefaultCache, function (req, res, next) {
  27.     var SuggestModel = require('dw/suggest/SuggestModel');
  28.     var CategorySuggestions = require('*/cartridge/models/search/suggestions/category');
  29.     var ContentSuggestions = require('*/cartridge/models/search/suggestions/content');
  30.     var ProductSuggestions = require('*/cartridge/models/search/suggestions/product');
  31.     var SearchPhraseSuggestions = require('*/cartridge/models/search/suggestions/searchPhrase');
  32.     var categorySuggestions;
  33.     var contentSuggestions;
  34.     var productSuggestions;
  35.     var recentSuggestions;
  36.     var popularSuggestions;
  37.     var brandSuggestions;
  38.     var searchTerms = req.querystring.q;
  39.     var suggestions;
  40.     // TODO: Move minChars and maxSuggestions to Site Preferences when ready for refactoring
  41.     var minChars = preferences.minTermLength;
  42.     // Unfortunately, by default, max suggestions is set to 10 and is not configurable in Business
  43.     // Manager.
  44.     var maxSuggestions = 3;
  46.     if (searchTerms && searchTerms.length >= minChars) {
  47.         suggestions = new SuggestModel();
  48.         suggestions.setFilteredByFolder(false);
  49.         suggestions.setSearchPhrase(searchTerms);
  50.         suggestions.setMaxSuggestions(maxSuggestions);
  51.         categorySuggestions = new CategorySuggestions(suggestions, maxSuggestions);
  52.         contentSuggestions = new ContentSuggestions(suggestions, maxSuggestions);
  53.         productSuggestions = new ProductSuggestions(suggestions, maxSuggestions);
  54.         recentSuggestions = new SearchPhraseSuggestions(suggestions.recentSearchPhrases, maxSuggestions);
  55.         popularSuggestions = new SearchPhraseSuggestions(suggestions.popularSearchPhrases, maxSuggestions);
  56.         brandSuggestions = new SearchPhraseSuggestions(suggestions.brandSuggestions, maxSuggestions);
  58.         if (productSuggestions.available || contentSuggestions.available
  59.             || categorySuggestions.available
  60.             || recentSuggestions.available
  61.             || popularSuggestions.available
  62.             || brandSuggestions.available) {
  63.             var total = productSuggestions.products.length + contentSuggestions.contents.length
  64.                 + categorySuggestions.categories.length
  65.                 + recentSuggestions.phrases.length
  66.                 + popularSuggestions.phrases.length
  67.                 + brandSuggestions.phrases.length;
  68.             res.render('search/suggestions', {
  69.                 suggestions: {
  70.                     product: productSuggestions,
  71.                     category: categorySuggestions,
  72.                     content: contentSuggestions,
  73.                     recent: recentSuggestions,
  74.                     popular: popularSuggestions,
  75.                     brand: brandSuggestions,
  76.                     message: Resource.msgf('label.header.search.result.count.msg', 'common', null, ['' + total])
  77.                 }
  78.             });
  79.         } else {
  80.             res.json({});
  81.         }
  82.     } else {
  83.         // Return an empty object that can be checked on the client.  By default, rendered
  84.         // templates automatically get a diagnostic string injected into it, making it difficult
  85.         // to check for a null or empty response on the client.
  86.         res.json({});
  87.     }
  89.     next();
  90. });
  92. module.exports = server.exports();