algoliasearch-helper 3.6.2 → 3.7.2

package/CHANGELOG

@@ -1,3 +1,14 @@
+3.7.2 - 2022-03-18
+ * chore(docs): fix capitalization of Github and npm https://github.com/algolia/algoliasearch-helper-js/commit/5babbcad0b3d406a0b56f7a55682ff169e2b853f
+ * fix(results): implement search result options via an argument https://github.com/algolia/algoliasearch-helper-js/commit/4e6ac6926bd284c7eafe060480fc4258844d121a
+
+3.7.1 - 2022-03-17
+ * docs(readme): fixed angular.js example link (#885) https://github.com/algolia/algoliasearch-helper-js/commit/c16287e6685040a3786b8d0bac0922cdc583134e, closes https://github.com/algolia/algoliasearch-helper-js/issues/885
+ * fix(types): allow "__isArtificial" (#890) https://github.com/algolia/algoliasearch-helper-js/commit/1e2aef0fb8aa88c80b985ef009bff5a3dd71ca80
+
+3.7.0 - 2021-12-13
+ * feat(events): move to @algolia/events (#883) https://github.com/algolia/algoliasearch-helper-js/commit/0c33fdc0063d7486db71ba0c6952339dc8b93ae5
+
 3.6.2 - 2021-10-19
  * fix(SearchParameters): ignore invalid parameters (#880) https://github.com/algolia/algoliasearch-helper-js/commit/4ff542b70b92a6b81cce8b9255700b0bc0817edd
 

package/README.md

@@ -36,7 +36,7 @@ track of the search parameters and provides a higher level API.
   - [Helper cheatsheet](#helper-cheatsheet)
     - [Add the helper in your project](#add-the-helper-in-your-project)
     - [Regular `<script>` tag](#regular-script-tag)
-    - [With NPM](#with-npm)
+    - [With npm](#with-npm)
     - [Init the helper](#init-the-helper)
     - [Helper lifecycle](#helper-lifecycle)
     - [Objects](#objects)
@@ -124,7 +124,7 @@ angular.module('searchApp', ['ngSanitize', 'algoliasearch'])
 }]);
 </script>
 ```
-You can see the full [Angular example here](examples/instantsearch%2Bhelper%2Bangular.html)
+You can see the full [Angular example here](https://codepen.io/Algolia/pen/PzZobK)
 
 ## Helper cheatsheet
 
@@ -138,7 +138,7 @@ Use our [jsDelivr](http://www.jsdelivr.com/) build:
 
 `<script src="https://cdn.jsdelivr.net/algoliasearch.helper/2/algoliasearch.helper.min.js"></script>`
 
-### With NPM
+### With npm
 
 `npm install algoliasearch-helper`
 

package/dist/algoliasearch.helper.js

@@ -100,7 +100,7 @@ function EventEmitter() {
 module.exports = EventEmitter;
 
 // Backwards-compat with node 0.10.x
-EventEmitter.EventEmitter = EventEmitter;
+// EventEmitter.EventEmitter = EventEmitter;
 
 EventEmitter.prototype._events = undefined;
 EventEmitter.prototype._maxListeners = undefined;
@@ -378,7 +378,7 @@ function isUndefined(arg) {
 },{}],3:[function(require,module,exports){
 'use strict';
 
-var events = require('events');
+var EventEmitter = require('@algolia/events');
 var inherits = require('../functions/inherits');
 
 /**
@@ -397,7 +397,7 @@ function DerivedHelper(mainHelper, fn) {
   this.lastResults = null;
 }
 
-inherits(DerivedHelper, events.EventEmitter);
+inherits(DerivedHelper, EventEmitter);
 
 /**
  * Detach this helper from the main helper
@@ -415,7 +415,7 @@ DerivedHelper.prototype.getModifiedState = function(parameters) {
 
 module.exports = DerivedHelper;
 
-},{"../functions/inherits":14,"events":2}],4:[function(require,module,exports){
+},{"../functions/inherits":14,"@algolia/events":2}],4:[function(require,module,exports){
 'use strict';
 
 /**
@@ -2504,7 +2504,7 @@ function findMatchingHierarchicalFacetFromAttributeName(
 }
  **/
 /*eslint-enable */
-function SearchResults(state, results) {
+function SearchResults(state, results, options) {
   var mainSubResponse = results[0];
 
   this._rawResults = results;
@@ -2516,6 +2516,11 @@ function SearchResults(state, results) {
     self[key] = mainSubResponse[key];
   });
 
+  // Make every key of the result options reachable from the instance
+  Object.keys(options || {}).forEach(function(key) {
+    self[key] = options[key];
+  });
+
   /**
    * query used to generate the results
    * @name query
@@ -3303,7 +3308,7 @@ var SearchResults = require('./SearchResults');
 var DerivedHelper = require('./DerivedHelper');
 var requestBuilder = require('./requestBuilder');
 
-var events = require('events');
+var EventEmitter = require('@algolia/events');
 var inherits = require('./functions/inherits');
 var objectHasKeys = require('./functions/objectHasKeys');
 var omit = require('./functions/omit');
@@ -3430,7 +3435,7 @@ function AlgoliaSearchHelper(client, index, options) {
   this._currentNbQueries = 0;
 }
 
-inherits(AlgoliaSearchHelper, events.EventEmitter);
+inherits(AlgoliaSearchHelper, EventEmitter);
 
 /**
  * Start the search with the parameters set in the state. When the
@@ -4764,7 +4769,7 @@ AlgoliaSearchHelper.prototype.hasPendingRequests = function() {
 
 module.exports = AlgoliaSearchHelper;
 
-},{"./DerivedHelper":3,"./SearchParameters":5,"./SearchResults":7,"./functions/inherits":14,"./functions/merge":16,"./functions/objectHasKeys":17,"./functions/omit":18,"./requestBuilder":21,"./version":23,"events":2}],9:[function(require,module,exports){
+},{"./DerivedHelper":3,"./SearchParameters":5,"./SearchResults":7,"./functions/inherits":14,"./functions/merge":16,"./functions/objectHasKeys":17,"./functions/omit":18,"./requestBuilder":21,"./version":23,"@algolia/events":2}],9:[function(require,module,exports){
 'use strict';
 
 module.exports = function compact(array) {
@@ -5447,7 +5452,7 @@ module.exports = function isValidUserToken(userToken) {
 },{}],23:[function(require,module,exports){
 'use strict';
 
-module.exports = '3.6.2';
+module.exports = '3.7.2';
 
 },{}]},{},[1])(1)
 });