algoliasearch-helper 3.6.2 → 3.7.2

package/index.d.ts

@@ -13,13 +13,13 @@ import algoliasearch, {
   // @ts-ignore
   Response as SearchResponseV3,
 } from 'algoliasearch';
-import {
+import { 
   SearchOptions as SearchOptionsV4,
   SearchResponse as SearchResponseV4,
   FindAnswersResponse
   // @ts-ignore
 } from '@algolia/client-search';
-import { EventEmitter } from 'events';
+import EventEmitter from '@algolia/events';
 
 type DummySearchClientV4 = {
   transporter: any;
@@ -1144,8 +1144,16 @@ declare namespace algoliasearchHelper {
     type Operator = '=' | '>' | '>=' | '<' | '<=' | '!=';
   }
 
+  export interface SearchResultsOptions {
+    /**
+     * Marker which can be added to search results to identify them as created without a search response.
+     * This is for internal use, e.g., avoiding caching in infinite hits, or delaying the display of these results.
+     */
+    __isArtificial: boolean | undefined
+  }
+
   export class SearchResults<T = any>
-    implements Omit<SearchResponse<T>, 'facets' | 'params'> {
+    implements Omit<SearchResponse<T>, 'facets' | 'params'>, implements SearchResultsOptions {
     /**
      * query used to generate the results
      */
@@ -1298,7 +1306,17 @@ declare namespace algoliasearchHelper {
     _rawResults: SearchResponse<T>[];
     _state: SearchParameters;
 
-    constructor(state: SearchParameters, results: SearchResponse<T>[]);
+    /**
+     * Marker which can be added to search results to identify them as created without a search response.
+     * This is for internal use, e.g., avoiding caching in infinite hits, or delaying the display of these results.
+     */
+    // __isArtificial?: boolean;
+
+    constructor(
+      state: SearchParameters,
+      results: SearchResponse<T>[],
+      options?: SearchResultsOptions
+    );
 
     /**
      * Get a facet object with its name

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "algoliasearch-helper",
-  "version": "3.6.2",
+  "version": "3.7.2",
   "description": "Helper for implementing advanced search features with algolia",
   "main": "index.js",
   "types": "index.d.ts",
@@ -97,7 +97,7 @@
     "yargs": "13.2.4"
   },
   "dependencies": {
-    "events": "^1.1.1"
+    "@algolia/events": "^4.0.1"
   },
   "peerDependencies": {
     "algoliasearch": ">= 3.1 < 5"

package/src/DerivedHelper/index.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var events = require('events');
+var EventEmitter = require('@algolia/events');
 var inherits = require('../functions/inherits');
 
 /**
@@ -19,7 +19,7 @@ function DerivedHelper(mainHelper, fn) {
   this.lastResults = null;
 }
 
-inherits(DerivedHelper, events.EventEmitter);
+inherits(DerivedHelper, EventEmitter);
 
 /**
  * Detach this helper from the main helper

package/src/SearchResults/index.js

@@ -224,7 +224,7 @@ function findMatchingHierarchicalFacetFromAttributeName(
 }
  **/
 /*eslint-enable */
-function SearchResults(state, results) {
+function SearchResults(state, results, options) {
   var mainSubResponse = results[0];
 
   this._rawResults = results;
@@ -236,6 +236,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

package/src/algoliasearch.helper.js

@@ -5,7 +5,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');
@@ -132,7 +132,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

package/src/version.js

@@ -1,3 +1,3 @@
 'use strict';
 
-module.exports = '3.6.2';
+module.exports = '3.7.2';