instantsearch.js 4.68.1 → 4.70.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/cjs/connectors/frequently-bought-together/connectFrequentlyBoughtTogether.js +93 -0
  2. package/cjs/connectors/index.js +28 -0
  3. package/cjs/connectors/looking-similar/connectLookingSimilar.js +94 -0
  4. package/cjs/connectors/related-products/connectRelatedProducts.js +94 -0
  5. package/cjs/connectors/trending-items/connectTrendingItems.js +90 -0
  6. package/cjs/lib/InstantSearch.js +10 -1
  7. package/cjs/lib/server.js +28 -9
  8. package/cjs/lib/utils/addWidgetId.js +17 -0
  9. package/cjs/lib/utils/hydrateRecommendCache.js +23 -0
  10. package/cjs/lib/utils/hydrateSearchClient.js +7 -3
  11. package/cjs/lib/utils/index.js +22 -0
  12. package/cjs/lib/utils/render-args.js +3 -3
  13. package/cjs/lib/version.js +1 -1
  14. package/cjs/widgets/frequently-bought-together/frequently-bought-together.js +120 -0
  15. package/cjs/widgets/index/index.js +89 -20
  16. package/cjs/widgets/index.js +28 -0
  17. package/cjs/widgets/looking-similar/looking-similar.js +122 -0
  18. package/cjs/widgets/related-products/related-products.js +122 -0
  19. package/cjs/widgets/trending-items/trending-items.js +126 -0
  20. package/dist/instantsearch.development.d.ts +411 -12
  21. package/dist/instantsearch.development.js +1702 -265
  22. package/dist/instantsearch.development.js.map +1 -1
  23. package/dist/instantsearch.production.d.ts +411 -12
  24. package/dist/instantsearch.production.min.d.ts +411 -12
  25. package/dist/instantsearch.production.min.js +2 -2
  26. package/dist/instantsearch.production.min.js.map +1 -1
  27. package/es/connectors/frequently-bought-together/connectFrequentlyBoughtTogether.d.ts +45 -0
  28. package/es/connectors/frequently-bought-together/connectFrequentlyBoughtTogether.js +86 -0
  29. package/es/connectors/index.d.ts +4 -0
  30. package/es/connectors/index.js +5 -1
  31. package/es/connectors/looking-similar/connectLookingSimilar.d.ts +49 -0
  32. package/es/connectors/looking-similar/connectLookingSimilar.js +87 -0
  33. package/es/connectors/related-products/connectRelatedProducts.d.ts +49 -0
  34. package/es/connectors/related-products/connectRelatedProducts.js +87 -0
  35. package/es/connectors/trending-items/connectTrendingItems.d.ts +57 -0
  36. package/es/connectors/trending-items/connectTrendingItems.js +83 -0
  37. package/es/lib/InstantSearch.d.ts +2 -0
  38. package/es/lib/InstantSearch.js +11 -2
  39. package/es/lib/server.d.ts +1 -1
  40. package/es/lib/server.js +28 -9
  41. package/es/lib/templating/renderTemplate.d.ts +1 -1
  42. package/es/lib/utils/addWidgetId.d.ts +3 -0
  43. package/es/lib/utils/addWidgetId.js +10 -0
  44. package/es/lib/utils/hydrateRecommendCache.d.ts +3 -0
  45. package/es/lib/utils/hydrateRecommendCache.js +17 -0
  46. package/es/lib/utils/hydrateSearchClient.js +7 -3
  47. package/es/lib/utils/index.d.ts +2 -0
  48. package/es/lib/utils/index.js +2 -0
  49. package/es/lib/utils/render-args.d.ts +3 -3
  50. package/es/lib/utils/render-args.js +3 -3
  51. package/es/lib/version.d.ts +1 -1
  52. package/es/lib/version.js +1 -1
  53. package/es/types/results.d.ts +7 -3
  54. package/es/types/templates.d.ts +1 -1
  55. package/es/types/widget.d.ts +16 -9
  56. package/es/widgets/frequently-bought-together/frequently-bought-together.d.ts +41 -0
  57. package/es/widgets/frequently-bought-together/frequently-bought-together.js +112 -0
  58. package/es/widgets/index/index.d.ts +2 -1
  59. package/es/widgets/index/index.js +89 -20
  60. package/es/widgets/index.d.ts +4 -0
  61. package/es/widgets/index.js +5 -1
  62. package/es/widgets/looking-similar/looking-similar.d.ts +41 -0
  63. package/es/widgets/looking-similar/looking-similar.js +114 -0
  64. package/es/widgets/related-products/related-products.d.ts +41 -0
  65. package/es/widgets/related-products/related-products.js +114 -0
  66. package/es/widgets/trending-items/trending-items.d.ts +41 -0
  67. package/es/widgets/trending-items/trending-items.js +118 -0
  68. package/package.json +7 -7
@@ -0,0 +1,122 @@
1
+ "use strict";
2
+
3
+ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ exports.default = void 0;
8
+ var _instantsearchUiComponents = require("instantsearch-ui-components");
9
+ var _preact = require("preact");
10
+ var _Template = _interopRequireDefault(require("../../components/Template/Template"));
11
+ var _connectRelatedProducts = _interopRequireDefault(require("../../connectors/related-products/connectRelatedProducts"));
12
+ var _templating = require("../../lib/templating");
13
+ var _utils = require("../../lib/utils");
14
+ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
15
+ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
16
+ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
17
+ function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
18
+ function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
19
+ function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
20
+ function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
21
+ var withUsage = (0, _utils.createDocumentationMessageGenerator)({
22
+ name: 'related-products'
23
+ });
24
+ var RelatedProducts = (0, _instantsearchUiComponents.createRelatedProductsComponent)({
25
+ createElement: _preact.h,
26
+ Fragment: _preact.Fragment
27
+ });
28
+ function createRenderer(_ref) {
29
+ var renderState = _ref.renderState,
30
+ cssClasses = _ref.cssClasses,
31
+ containerNode = _ref.containerNode,
32
+ templates = _ref.templates;
33
+ return function renderer(_ref2, isFirstRendering) {
34
+ var items = _ref2.items,
35
+ results = _ref2.results,
36
+ instantSearchInstance = _ref2.instantSearchInstance;
37
+ if (isFirstRendering) {
38
+ renderState.templateProps = (0, _templating.prepareTemplateProps)({
39
+ // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
40
+ defaultTemplates: {},
41
+ templatesConfig: instantSearchInstance.templatesConfig,
42
+ templates: templates
43
+ });
44
+ return;
45
+ }
46
+ var headerComponent = templates.header ? function (data) {
47
+ return (0, _preact.h)(_Template.default, _extends({}, renderState.templateProps, {
48
+ templateKey: "header",
49
+ rootTagName: "fragment",
50
+ data: {
51
+ cssClasses: data.classNames,
52
+ items: data.items
53
+ }
54
+ }));
55
+ } : undefined;
56
+ var itemComponent = templates.item ? function (_ref3) {
57
+ var item = _ref3.item;
58
+ return (0, _preact.h)(_Template.default, _extends({}, renderState.templateProps, {
59
+ templateKey: "item",
60
+ rootTagName: "fragment",
61
+ data: item
62
+ }));
63
+ } : undefined;
64
+ var emptyComponent = templates.empty ? function () {
65
+ return (0, _preact.h)(_Template.default, _extends({}, renderState.templateProps, {
66
+ templateKey: "empty",
67
+ rootTagName: "fragment",
68
+ data: results
69
+ }));
70
+ } : undefined;
71
+ (0, _preact.render)((0, _preact.h)(RelatedProducts, {
72
+ items: items,
73
+ sendEvent: function sendEvent() {},
74
+ classNames: cssClasses,
75
+ headerComponent: headerComponent,
76
+ itemComponent: itemComponent,
77
+ emptyComponent: emptyComponent,
78
+ status: instantSearchInstance.status
79
+ }), containerNode);
80
+ };
81
+ }
82
+ var relatedProducts = function relatedProducts(widgetParams) {
83
+ var _ref4 = widgetParams || {},
84
+ container = _ref4.container,
85
+ objectIDs = _ref4.objectIDs,
86
+ limit = _ref4.limit,
87
+ queryParameters = _ref4.queryParameters,
88
+ fallbackParameters = _ref4.fallbackParameters,
89
+ threshold = _ref4.threshold,
90
+ escapeHTML = _ref4.escapeHTML,
91
+ transformItems = _ref4.transformItems,
92
+ _ref4$templates = _ref4.templates,
93
+ templates = _ref4$templates === void 0 ? {} : _ref4$templates,
94
+ _ref4$cssClasses = _ref4.cssClasses,
95
+ cssClasses = _ref4$cssClasses === void 0 ? {} : _ref4$cssClasses;
96
+ if (!container) {
97
+ throw new Error(withUsage('The `container` option is required.'));
98
+ }
99
+ var containerNode = (0, _utils.getContainerNode)(container);
100
+ var specializedRenderer = createRenderer({
101
+ containerNode: containerNode,
102
+ cssClasses: cssClasses,
103
+ renderState: {},
104
+ templates: templates
105
+ });
106
+ var makeWidget = (0, _connectRelatedProducts.default)(specializedRenderer, function () {
107
+ return (0, _preact.render)(null, containerNode);
108
+ });
109
+ return _objectSpread(_objectSpread({}, makeWidget({
110
+ objectIDs: objectIDs,
111
+ limit: limit,
112
+ queryParameters: queryParameters,
113
+ fallbackParameters: fallbackParameters,
114
+ threshold: threshold,
115
+ escapeHTML: escapeHTML,
116
+ transformItems: transformItems
117
+ })), {}, {
118
+ $$widgetType: 'ais.relatedProducts'
119
+ });
120
+ };
121
+ var _default = relatedProducts;
122
+ exports.default = _default;
@@ -0,0 +1,126 @@
1
+ "use strict";
2
+
3
+ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ exports.default = void 0;
8
+ var _instantsearchUiComponents = require("instantsearch-ui-components");
9
+ var _preact = require("preact");
10
+ var _Template = _interopRequireDefault(require("../../components/Template/Template"));
11
+ var _connectTrendingItems = _interopRequireDefault(require("../../connectors/trending-items/connectTrendingItems"));
12
+ var _templating = require("../../lib/templating");
13
+ var _utils = require("../../lib/utils");
14
+ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
15
+ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
16
+ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
17
+ function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
18
+ function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
19
+ function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
20
+ function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
21
+ var withUsage = (0, _utils.createDocumentationMessageGenerator)({
22
+ name: 'trending-items'
23
+ });
24
+ var TrendingItems = (0, _instantsearchUiComponents.createTrendingItemsComponent)({
25
+ createElement: _preact.h,
26
+ Fragment: _preact.Fragment
27
+ });
28
+ function createRenderer(_ref) {
29
+ var renderState = _ref.renderState,
30
+ cssClasses = _ref.cssClasses,
31
+ containerNode = _ref.containerNode,
32
+ templates = _ref.templates;
33
+ return function renderer(_ref2, isFirstRendering) {
34
+ var items = _ref2.items,
35
+ results = _ref2.results,
36
+ instantSearchInstance = _ref2.instantSearchInstance;
37
+ if (isFirstRendering) {
38
+ renderState.templateProps = (0, _templating.prepareTemplateProps)({
39
+ // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
40
+ defaultTemplates: {},
41
+ templatesConfig: instantSearchInstance.templatesConfig,
42
+ templates: templates
43
+ });
44
+ return;
45
+ }
46
+ var headerComponent = templates.header ? function (data) {
47
+ return (0, _preact.h)(_Template.default, _extends({}, renderState.templateProps, {
48
+ templateKey: "header",
49
+ rootTagName: "fragment",
50
+ data: {
51
+ cssClasses: data.classNames,
52
+ items: data.items
53
+ }
54
+ }));
55
+ } : undefined;
56
+ var itemComponent = templates.item ? function (_ref3) {
57
+ var item = _ref3.item;
58
+ return (0, _preact.h)(_Template.default, _extends({}, renderState.templateProps, {
59
+ templateKey: "item",
60
+ rootTagName: "fragment",
61
+ data: item
62
+ }));
63
+ } : undefined;
64
+ var emptyComponent = templates.empty ? function () {
65
+ return (0, _preact.h)(_Template.default, _extends({}, renderState.templateProps, {
66
+ templateKey: "empty",
67
+ rootTagName: "fragment",
68
+ data: results
69
+ }));
70
+ } : undefined;
71
+ (0, _preact.render)((0, _preact.h)(TrendingItems, {
72
+ items: items,
73
+ sendEvent: function sendEvent() {},
74
+ classNames: cssClasses,
75
+ headerComponent: headerComponent,
76
+ itemComponent: itemComponent,
77
+ emptyComponent: emptyComponent,
78
+ status: instantSearchInstance.status
79
+ }), containerNode);
80
+ };
81
+ }
82
+ var trendingItems = function trendingItems(widgetParams) {
83
+ var _ref4 = widgetParams || {},
84
+ container = _ref4.container,
85
+ facetName = _ref4.facetName,
86
+ facetValue = _ref4.facetValue,
87
+ limit = _ref4.limit,
88
+ queryParameters = _ref4.queryParameters,
89
+ fallbackParameters = _ref4.fallbackParameters,
90
+ threshold = _ref4.threshold,
91
+ escapeHTML = _ref4.escapeHTML,
92
+ transformItems = _ref4.transformItems,
93
+ _ref4$templates = _ref4.templates,
94
+ templates = _ref4$templates === void 0 ? {} : _ref4$templates,
95
+ _ref4$cssClasses = _ref4.cssClasses,
96
+ cssClasses = _ref4$cssClasses === void 0 ? {} : _ref4$cssClasses;
97
+ if (!container) {
98
+ throw new Error(withUsage('The `container` option is required.'));
99
+ }
100
+ var containerNode = (0, _utils.getContainerNode)(container);
101
+ var specializedRenderer = createRenderer({
102
+ containerNode: containerNode,
103
+ cssClasses: cssClasses,
104
+ renderState: {},
105
+ templates: templates
106
+ });
107
+ var makeWidget = (0, _connectTrendingItems.default)(specializedRenderer, function () {
108
+ return (0, _preact.render)(null, containerNode);
109
+ });
110
+ var facetParameters = facetName && facetValue ? {
111
+ facetName: facetName,
112
+ facetValue: facetValue
113
+ } : {};
114
+ return _objectSpread(_objectSpread({}, makeWidget(_objectSpread(_objectSpread({}, facetParameters), {}, {
115
+ limit: limit,
116
+ queryParameters: queryParameters,
117
+ fallbackParameters: fallbackParameters,
118
+ threshold: threshold,
119
+ escapeHTML: escapeHTML,
120
+ transformItems: transformItems
121
+ }))), {}, {
122
+ $$widgetType: 'ais.trendingItems'
123
+ });
124
+ };
125
+ var _default = trendingItems;
126
+ exports.default = _default;