mirror of
https://github.com/FlipsideCrypto/DefinitelyTyped.git
synced 2026-02-06 10:56:53 +00:00
[algoliasearch(-helper)] remove packages
Both of these packages are now shipping their own definitions and aren't used anywhere else, except algoliasearch-helper in react-instantsearch-core
This commit is contained in:
Haroen Viaene
parent
8c9eba5079
commit
337ebccca8
@ -48,6 +48,18 @@
|
||||
"sourceRepoURL": "https://github.com/epoberezkin/ajv",
|
||||
"asOfVersion": "1.0.0"
|
||||
},
|
||||
{
|
||||
"libraryName": "algoliasearch",
|
||||
"typingsPackageName": "algoliasearch",
|
||||
"sourceRepoURL": "https://github.com/algolia/algoliasearch-client-javascript",
|
||||
"asOfVersion": "4.0.0"
|
||||
},
|
||||
{
|
||||
"libraryName": "algoliasearch-helper",
|
||||
"typingsPackageName": "algoliasearch-helper",
|
||||
"sourceRepoURL": "https://github.com/algolia/algoliasearch-helper-js/",
|
||||
"asOfVersion": "3.0.0"
|
||||
},
|
||||
{
|
||||
"libraryName": "all-keys",
|
||||
"typingsPackageName": "all-keys",
|
||||
|
||||
@ -1,332 +0,0 @@
|
||||
import * as algoliasearch from 'algoliasearch';
|
||||
import * as algoliasearchHelper from 'algoliasearch-helper';
|
||||
// tslint:disable-next-line:no-duplicate-imports
|
||||
import { SearchResults, SearchParameters } from 'algoliasearch-helper';
|
||||
|
||||
// https://community.algolia.com/algoliasearch-helper-js/reference.html#module:algoliasearchHelper
|
||||
|
||||
const client = algoliasearch('latency', '6be0576ff61c053d5f9a3225e2a90f76');
|
||||
const helper = algoliasearchHelper(client, 'bestbuy', {
|
||||
facets: ['shipping'],
|
||||
disjunctiveFacets: ['category']
|
||||
});
|
||||
helper.on('result', (result) => {
|
||||
console.log(result);
|
||||
});
|
||||
helper.toggleRefine('Movies & TV Shows')
|
||||
.toggleRefine('Free shipping')
|
||||
.search();
|
||||
|
||||
const updateTheResult = (results: SearchResults, state: SearchParameters) => {
|
||||
console.log(results, state);
|
||||
};
|
||||
helper.on('result', updateTheResult);
|
||||
helper.once('result', updateTheResult);
|
||||
helper.removeListener('result', updateTheResult);
|
||||
helper.removeAllListeners('result');
|
||||
|
||||
() => {
|
||||
// Changing the number of records returned per page to 1
|
||||
// This example uses the callback API
|
||||
const state = helper.searchOnce({hitsPerPage: 1},
|
||||
(error, content: SearchResults, state: SearchParameters) => {});
|
||||
|
||||
// Changing the number of records returned per page to 1
|
||||
// This example uses the promise API
|
||||
const state1 = helper.searchOnce({hitsPerPage: 1})
|
||||
.then(promiseHandler);
|
||||
|
||||
function promiseHandler(res: {content: SearchResults, state: SearchParameters}) {
|
||||
// res contains
|
||||
// {
|
||||
// content : SearchResults
|
||||
// state : SearchParameters (the one used for this specific search)
|
||||
// }
|
||||
}
|
||||
};
|
||||
|
||||
helper.setIndex('highestPrice_products').getIndex();
|
||||
helper.setPage(0).nextPage().getPage();
|
||||
helper.setPage(1).previousPage().getPage();
|
||||
helper.setQueryParameter('hitsPerPage', 20).search();
|
||||
const hitsPerPage = helper.getQueryParameter('hitsPerPage');
|
||||
helper.addFacetRefinement('film-genre', 'comedy');
|
||||
helper.addFacetRefinement('film-genre', 'science-fiction');
|
||||
|
||||
() => {
|
||||
const indexName = 'test';
|
||||
const helper2 = algoliasearchHelper(client, indexName, {
|
||||
facets: ['nameOfTheAttribute']
|
||||
});
|
||||
};
|
||||
|
||||
// Removing all the refinements
|
||||
helper.clearRefinements().search();
|
||||
|
||||
// Removing all the filters on a the category attribute.
|
||||
helper.clearRefinements('category').search();
|
||||
|
||||
// Removing only the exclude filters on the category facet.
|
||||
helper.clearRefinements((value, attribute, type) => {
|
||||
return type === 'exclude' && attribute === 'category';
|
||||
}).search();
|
||||
|
||||
// https://community.algolia.com/algoliasearch-helper-js/reference.html#AlgoliaSearchHelper#hasRefinements
|
||||
|
||||
helper.hasRefinements('price'); // false
|
||||
helper.addNumericRefinement('price', '>', 100);
|
||||
helper.hasRefinements('price'); // true
|
||||
|
||||
helper.hasRefinements('color'); // false
|
||||
helper.addFacetRefinement('color', 'blue');
|
||||
helper.hasRefinements('color'); // true
|
||||
|
||||
helper.hasRefinements('material'); // false
|
||||
helper.addDisjunctiveFacetRefinement('material', 'plastic');
|
||||
helper.hasRefinements('material'); // true
|
||||
|
||||
helper.hasRefinements('categories'); // false
|
||||
helper.toggleFacetRefinement('categories', 'kitchen > knife');
|
||||
helper.hasRefinements('categories'); // true
|
||||
|
||||
// https://community.algolia.com/algoliasearch-helper-js/reference.html#AlgoliaSearchHelper#getRefinements
|
||||
|
||||
helper.addNumericRefinement('price', '>', 100);
|
||||
helper.getRefinements('price');
|
||||
|
||||
helper.addFacetRefinement('color', 'blue');
|
||||
helper.addFacetExclusion('color', 'red');
|
||||
helper.getRefinements('color');
|
||||
|
||||
helper.addDisjunctiveFacetRefinement('material', 'plastic');
|
||||
|
||||
helper.addDisjunctiveFacetRefinement('tech', 'crt');
|
||||
helper.addDisjunctiveFacetRefinement('tech', 'led');
|
||||
helper.addDisjunctiveFacetRefinement('tech', 'plasma');
|
||||
|
||||
() => {
|
||||
const helper2 = algoliasearchHelper(client, 'test', {
|
||||
disjunctiveFacets: ['nameOfTheAttribute']
|
||||
});
|
||||
};
|
||||
|
||||
// https://community.algolia.com/algoliasearch-helper-js/reference.html#AlgoliaSearchHelper#hasRefinements
|
||||
|
||||
// hasRefinements works with numeric, conjunctive, disjunctive and hierarchical filters
|
||||
helper.hasRefinements('price'); // false
|
||||
helper.addNumericRefinement('price', '>', 100);
|
||||
helper.hasRefinements('price'); // true
|
||||
|
||||
helper.hasRefinements('color'); // false
|
||||
helper.addFacetRefinement('color', 'blue');
|
||||
helper.hasRefinements('color'); // true
|
||||
|
||||
helper.hasRefinements('material'); // false
|
||||
helper.addDisjunctiveFacetRefinement('material', 'plastic');
|
||||
helper.hasRefinements('material'); // true
|
||||
|
||||
helper.hasRefinements('categories'); // false
|
||||
helper.toggleFacetRefinement('categories', 'kitchen > knife');
|
||||
helper.hasRefinements('categories'); // true
|
||||
|
||||
const params = helper.getState().getQueryParams();
|
||||
client.search([{
|
||||
indexName: 'test',
|
||||
query: '',
|
||||
params
|
||||
}]);
|
||||
|
||||
// https://community.algolia.com/algoliasearch-helper-js/reference.html#SearchResults#getFacetValues
|
||||
helper.on('result', (content) => {
|
||||
// get values ordered only by name ascending using the string predicate
|
||||
content.getFacetValues('city', {sortBy: ['name:asc']});
|
||||
// get values ordered only by count ascending using a function
|
||||
content.getFacetValues('city', {
|
||||
// this is equivalent to ['count:asc']
|
||||
sortBy(a: { count: number }, b: { count: number }) {
|
||||
if (a.count === b.count) return 0;
|
||||
if (a.count > b.count) return 1;
|
||||
if (b.count > a.count) return -1;
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// https://community.algolia.com/algoliasearch-helper-js/reference.html#SearchParameters#addTagRefinement
|
||||
|
||||
const searchparameter = new SearchParameters();
|
||||
|
||||
// for price = 50 or 40
|
||||
searchparameter.addNumericRefinement('price', '=', [50, 40]);
|
||||
|
||||
// for size = 38 and 40
|
||||
searchparameter.addNumericRefinement('size', '=', 38);
|
||||
searchparameter.addNumericRefinement('size', '=', 40);
|
||||
|
||||
let queryParameters = new SearchParameters({}); // everything is optional
|
||||
queryParameters = new SearchParameters({
|
||||
advancedSyntax: true,
|
||||
allowTyposOnNumericTokens: true,
|
||||
analytics: true,
|
||||
analyticsTags: ['test'],
|
||||
aroundLatLng: 'latitude',
|
||||
aroundLatLngViaIP: true,
|
||||
aroundPrecision: 1,
|
||||
aroundRadius: 1,
|
||||
attributesToHighlight: ['test'],
|
||||
attributesToRetrieve: ['test'],
|
||||
attributesToSnippet: ['test'],
|
||||
disableExactOnAttributes: ['test'],
|
||||
disjunctiveFacets: ['test'],
|
||||
disjunctiveFacetsRefinements: { test: ['test'] },
|
||||
distinct: 2,
|
||||
enableExactOnSingleWordQuery: true,
|
||||
facets: ['test'],
|
||||
facetsExcludes: { test: ['test'] },
|
||||
facetsRefinements: { test: ['test'] },
|
||||
getRankingInfo: true,
|
||||
hierarchicalFacets: ['test'],
|
||||
hierarchicalFacetsRefinements: { test: ['test'] },
|
||||
highlightPostTag: 'test',
|
||||
highlightPreTag: 'test',
|
||||
hitsPerPage: 1,
|
||||
ignorePlurals: true,
|
||||
index: 'test',
|
||||
insideBoundingBox: [[1, 2, 3, 4]],
|
||||
insidePolygon: [[1, 2, 3, 4]],
|
||||
length: 2,
|
||||
maxValuesPerFacet: 1,
|
||||
minimumAroundRadius: 1,
|
||||
minProximity: 1,
|
||||
minWordSizefor1Typo: 1,
|
||||
minWordSizefor2Typos: 1,
|
||||
numericFilters: ['test'],
|
||||
numericRefinements: { test: { '=': [1], '>': [[2, 3]] } },
|
||||
offset: 1,
|
||||
optionalFacetFilters: 'test',
|
||||
optionalTagFilters: 'test',
|
||||
optionalWords: ['test'],
|
||||
page: 1,
|
||||
query: 'test',
|
||||
queryType: 'prefixAll',
|
||||
removeWordsIfNoResults: 'none',
|
||||
replaceSynonymsInHighlight: true,
|
||||
restrictSearchableAttributes: ['test'],
|
||||
snippetEllipsisText: '...',
|
||||
synonyms: true,
|
||||
tagFilters: ['test'],
|
||||
tagRefinements: ['test'],
|
||||
typoTolerance: true,
|
||||
});
|
||||
|
||||
queryParameters.advancedSyntax;
|
||||
queryParameters.allowTyposOnNumericTokens;
|
||||
queryParameters.analytics;
|
||||
queryParameters.analyticsTags;
|
||||
queryParameters.aroundLatLng;
|
||||
queryParameters.aroundLatLngViaIP;
|
||||
queryParameters.aroundPrecision;
|
||||
queryParameters.aroundRadius;
|
||||
queryParameters.attributesToHighlight;
|
||||
queryParameters.attributesToRetrieve;
|
||||
queryParameters.attributesToSnippet;
|
||||
queryParameters.disableExactOnAttributes;
|
||||
queryParameters.disjunctiveFacets;
|
||||
queryParameters.disjunctiveFacetsRefinements;
|
||||
queryParameters.distinct;
|
||||
queryParameters.enableExactOnSingleWordQuery;
|
||||
queryParameters.facets;
|
||||
queryParameters.facetsExcludes;
|
||||
queryParameters.facetsRefinements;
|
||||
queryParameters.getRankingInfo;
|
||||
queryParameters.hierarchicalFacets;
|
||||
queryParameters.hierarchicalFacetsRefinements;
|
||||
queryParameters.highlightPostTag;
|
||||
queryParameters.highlightPreTag;
|
||||
queryParameters.hitsPerPage;
|
||||
queryParameters.ignorePlurals;
|
||||
queryParameters.index;
|
||||
queryParameters.insideBoundingBox;
|
||||
queryParameters.insidePolygon;
|
||||
queryParameters.length;
|
||||
queryParameters.maxValuesPerFacet;
|
||||
queryParameters.minimumAroundRadius;
|
||||
queryParameters.minProximity;
|
||||
queryParameters.minWordSizefor1Typo;
|
||||
queryParameters.minWordSizefor2Typos;
|
||||
queryParameters.numericFilters;
|
||||
queryParameters.numericRefinements;
|
||||
queryParameters.offset;
|
||||
queryParameters.optionalFacetFilters;
|
||||
queryParameters.optionalTagFilters;
|
||||
queryParameters.optionalWords;
|
||||
queryParameters.page;
|
||||
queryParameters.query;
|
||||
queryParameters.queryType;
|
||||
queryParameters.removeWordsIfNoResults;
|
||||
queryParameters.replaceSynonymsInHighlight;
|
||||
queryParameters.restrictSearchableAttributes;
|
||||
queryParameters.snippetEllipsisText;
|
||||
queryParameters.synonyms;
|
||||
queryParameters.tagFilters;
|
||||
queryParameters.tagRefinements;
|
||||
queryParameters.typoTolerance;
|
||||
|
||||
queryParameters.addDisjunctiveFacet('test');
|
||||
queryParameters.addDisjunctiveFacetRefinement('test', 'test');
|
||||
queryParameters.addExcludeRefinement('test', 'test');
|
||||
queryParameters.addFacet('test');
|
||||
queryParameters.addFacetRefinement('test', 'test');
|
||||
queryParameters.addHierarchicalFacet({});
|
||||
queryParameters.addHierarchicalFacetRefinement('test', 'test');
|
||||
queryParameters.addNumericRefinement('test', '>', [7]);
|
||||
queryParameters.addTagRefinement('test');
|
||||
queryParameters.clearRefinements('test');
|
||||
queryParameters.clearTags();
|
||||
queryParameters.filter(['test']);
|
||||
queryParameters.getConjunctiveRefinements('test');
|
||||
queryParameters.getDisjunctiveRefinements('test');
|
||||
queryParameters.getExcludeRefinements('test');
|
||||
queryParameters.getHierarchicalFacetBreadcrumb('test');
|
||||
queryParameters.getHierarchicalFacetByName('test');
|
||||
queryParameters.getHierarchicalRefinement('test');
|
||||
queryParameters.getNumericRefinement('test', '=');
|
||||
queryParameters.getNumericRefinements('test');
|
||||
queryParameters.getQueryParameter('test');
|
||||
queryParameters.getRefinedDisjunctiveFacets('test', {});
|
||||
queryParameters.getRefinedHierarchicalFacets('test', {});
|
||||
queryParameters.getUnrefinedDisjunctiveFacets();
|
||||
queryParameters.isConjunctiveFacet('test');
|
||||
queryParameters.isDisjunctiveFacet('test');
|
||||
queryParameters.isDisjunctiveFacetRefined('test', 'test');
|
||||
queryParameters.isExcludeRefined('test', 'test');
|
||||
queryParameters.isFacetRefined('test', 'test');
|
||||
queryParameters.isHierarchicalFacet('test');
|
||||
queryParameters.isHierarchicalFacetRefined('test', 'test');
|
||||
queryParameters.isNumericRefined('test', '>', 'test');
|
||||
queryParameters.isTagRefined('test');
|
||||
queryParameters.removeDisjunctiveFacet('test');
|
||||
queryParameters.removeDisjunctiveFacetRefinement('test', 'test');
|
||||
queryParameters.removeExcludeRefinement('test', 'test');
|
||||
queryParameters.removeFacet('test');
|
||||
queryParameters.removeFacetRefinement('test', 'test');
|
||||
queryParameters.removeHierarchicalFacet('test');
|
||||
queryParameters.removeHierarchicalFacetRefinement('test');
|
||||
queryParameters.removeTagRefinement('test');
|
||||
queryParameters.setDisjunctiveFacets(['test']);
|
||||
queryParameters.setFacets(['test']);
|
||||
queryParameters.setHitsPerPage(1);
|
||||
queryParameters.setPage(1);
|
||||
queryParameters.setQuery('test');
|
||||
queryParameters.setQueryParameter('test', {});
|
||||
queryParameters.setQueryParameters({ test: {} });
|
||||
queryParameters.setTypoTolerance('test');
|
||||
queryParameters.toggleConjunctiveFacetRefinement('test', {});
|
||||
queryParameters.toggleDisjunctiveFacetRefinement('test', {});
|
||||
queryParameters.toggleExcludeFacetRefinement('test', {});
|
||||
queryParameters.toggleFacetRefinement('test', {});
|
||||
queryParameters.toggleHierarchicalFacetRefinement('test', {});
|
||||
queryParameters.toggleTagRefinement('test');
|
||||
|
||||
// static methods
|
||||
SearchParameters.make(queryParameters);
|
||||
SearchParameters.validate(queryParameters, { queryType: 'prefixAll' });
|
||||
760
types/algoliasearch-helper/index.d.ts
vendored
760
types/algoliasearch-helper/index.d.ts
vendored
@ -1,760 +0,0 @@
|
||||
// Type definitions for algoliasearch-helper 2.26
|
||||
// Project: https://community.algolia.com/algoliasearch-helper-js/
|
||||
// Definitions by: Gordon Burgett <https://github.com/gburgett>
|
||||
// Haroen Viaene <https://github.com/haroenv>
|
||||
// Samuel Vaillant <https://github.com/samouss>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
// TypeScript Version: 2.8
|
||||
|
||||
import { Client } from 'algoliasearch';
|
||||
import { EventEmitter } from 'events';
|
||||
import algoliasearch = require('algoliasearch');
|
||||
|
||||
/**
|
||||
* The algoliasearchHelper module is the function that will let its
|
||||
* contains everything needed to use the Algoliasearch
|
||||
* Helper. It is a also a function that instanciate the helper.
|
||||
* To use the helper, you also need the Algolia JS client v3.
|
||||
* @param client an AlgoliaSearch client
|
||||
* @param index the name of the index to query
|
||||
* @param opts
|
||||
*/
|
||||
declare function algoliasearchHelper(client: Client, index: string, opts: algoliasearchHelper.QueryParameters): algoliasearchHelper.AlgoliaSearchHelper;
|
||||
|
||||
declare namespace algoliasearchHelper {
|
||||
export const version: string;
|
||||
|
||||
export class AlgoliaSearchHelper extends EventEmitter {
|
||||
state: SearchParameters;
|
||||
lastResults: SearchResults;
|
||||
derivedHelpers: AlgoliaSearchHelper[];
|
||||
|
||||
on(event: 'change' | 'search', cb: (state: SearchParameters, lastResults: SearchResults | null) => any): this;
|
||||
on(event: 'searchForFacetValues', cb: (state: SearchParameters, facet: string, query: string) => any): this;
|
||||
on(event: 'searchOnce', cb: (state: SearchParameters) => any): this;
|
||||
on(event: 'result', cb: (results: SearchResults, state: SearchParameters) => any): this;
|
||||
on(event: 'error', cb: (error: any) => any): this;
|
||||
on(event: 'searchQueueEmpty', cb: () => any): this;
|
||||
|
||||
/**
|
||||
* Start the search with the parameters set in the state. When the
|
||||
* method is called, it triggers a `search` event. The results will
|
||||
* be available through the `result` event. If an error occurs, an
|
||||
* `error` will be fired instead.
|
||||
* @return
|
||||
* @fires search
|
||||
* @fires result
|
||||
* @fires error
|
||||
* @chainable
|
||||
*/
|
||||
search(): this;
|
||||
|
||||
/**
|
||||
* Gets the search query parameters that would be sent to the Algolia Client
|
||||
* for the hits
|
||||
* @return Query Parameters
|
||||
*/
|
||||
getQuery(): QueryParameters;
|
||||
|
||||
/**
|
||||
* Start a search using a modified version of the current state. This method does
|
||||
* not trigger the helper lifecycle and does not modify the state kept internally
|
||||
* by the helper. This second aspect means that the next search call will be the
|
||||
* same as a search call before calling searchOnce.
|
||||
* @param options can contain all the parameters that can be set to SearchParameters
|
||||
* plus the index
|
||||
* @param [callback] optional callback executed when the response from the
|
||||
* server is back.
|
||||
* @return if a callback is passed the method returns undefined
|
||||
* otherwise it returns a promise containing an object with two keys :
|
||||
* - content with a SearchResults
|
||||
* - state with the state used for the query as a SearchParameters
|
||||
* @example
|
||||
* // Changing the number of records returned per page to 1
|
||||
* // This example uses the callback API
|
||||
* var state = helper.searchOnce({hitsPerPage: 1},
|
||||
* function(error, content, state) {
|
||||
* // if an error occurred it will be passed in error, otherwise its value is null
|
||||
* // content contains the results formatted as a SearchResults
|
||||
* // state is the instance of SearchParameters used for this search
|
||||
* });
|
||||
* @example
|
||||
* // Changing the number of records returned per page to 1
|
||||
* // This example uses the promise API
|
||||
* var state1 = helper.searchOnce({hitsPerPage: 1})
|
||||
* .then(promiseHandler);
|
||||
*
|
||||
* function promiseHandler(res) {
|
||||
* // res contains
|
||||
* // {
|
||||
* // content : SearchResults
|
||||
* // state : SearchParameters (the one used for this specific search)
|
||||
* // }
|
||||
* }
|
||||
*/
|
||||
searchOnce(options: QueryParameters): Promise<{ content: SearchResults, state: SearchParameters }>;
|
||||
searchOnce(options: QueryParameters, cb: (error: any, content: SearchResults, state: SearchParameters) => any): undefined;
|
||||
|
||||
/**
|
||||
* Search for facet values based on an query and the name of a faceted attribute. This
|
||||
* triggers a search and will return a promise. On top of using the query, it also sends
|
||||
* the parameters from the state so that the search is narrowed down to only the possible values.
|
||||
*
|
||||
* See the description of [FacetSearchResult](reference.html#FacetSearchResult)
|
||||
* @param facet the name of the faceted attribute
|
||||
* @param query the string query for the search
|
||||
* @param [maxFacetHits] the maximum number values returned. Should be > 0 and <= 100
|
||||
* @param [userState] the set of custom parameters to use on top of the current state. Setting a property to `undefined` removes
|
||||
* it in the generated query.
|
||||
* @return the results of the search
|
||||
*/
|
||||
searchForFacetValues(facet: string, query: string, maxFacetHits: number, userState: any): Promise<AlgoliaSearchHelper.FacetSearchResult>;
|
||||
|
||||
/**
|
||||
* Sets the text query used for the search.
|
||||
*
|
||||
* This method resets the current page to 0.
|
||||
* @param q the user query
|
||||
* @return
|
||||
* @fires change
|
||||
* @chainable
|
||||
*/
|
||||
setQuery(q: string): this;
|
||||
|
||||
/**
|
||||
* Remove all the types of refinements except tags. A string can be provided to remove
|
||||
* only the refinements of a specific attribute. For more advanced use case, you can
|
||||
* provide a function instead. This function should follow the
|
||||
* [clearCallback definition](#SearchParameters.clearCallback).
|
||||
*
|
||||
* This method resets the current page to 0.
|
||||
* @param [name] optional name of the facet / attribute on which we want to remove all refinements
|
||||
* @return
|
||||
* @fires change
|
||||
* @chainable
|
||||
* @example
|
||||
* // Removing all the refinements
|
||||
* helper.clearRefinements().search();
|
||||
* @example
|
||||
* // Removing all the filters on a the category attribute.
|
||||
* helper.clearRefinements('category').search();
|
||||
* @example
|
||||
* // Removing only the exclude filters on the category facet.
|
||||
* helper.clearRefinements(function(value, attribute, type) {
|
||||
* return type === 'exclude' && attribute === 'category';
|
||||
* }).search();
|
||||
*/
|
||||
clearRefinements(name?: string): this;
|
||||
clearRefinements(func: (value: any, attribute: string, type: string) => boolean): this;
|
||||
|
||||
/**
|
||||
* Remove all the tag filters.
|
||||
*
|
||||
* This method resets the current page to 0.
|
||||
* @return
|
||||
* @fires change
|
||||
* @chainable
|
||||
*/
|
||||
clearTags(): this;
|
||||
|
||||
/**
|
||||
* Updates the name of the index that will be targeted by the query.
|
||||
*
|
||||
* This method resets the current page to 0.
|
||||
* @param name the index name
|
||||
* @return
|
||||
* @fires change
|
||||
* @chainable
|
||||
*/
|
||||
setIndex(name: string): this;
|
||||
|
||||
addDisjunctiveFacetRefinement(...args: any[]): any;
|
||||
addDisjunctiveRefine(...args: any[]): any;
|
||||
addHierarchicalFacetRefinement(...args: any[]): any;
|
||||
addNumericRefinement(...args: any[]): any;
|
||||
addFacetRefinement(...args: any[]): any;
|
||||
addRefine(...args: any[]): any;
|
||||
addFacetExclusion(...args: any[]): any;
|
||||
addExclude(...args: any[]): any;
|
||||
addTag(...args: any[]): any;
|
||||
removeNumericRefinement(...args: any[]): any;
|
||||
removeDisjunctiveFacetRefinement(...args: any[]): any;
|
||||
removeDisjunctiveRefine(...args: any[]): any;
|
||||
removeHierarchicalFacetRefinement(...args: any[]): any;
|
||||
removeFacetRefinement(...args: any[]): any;
|
||||
removeRefine(...args: any[]): any;
|
||||
removeFacetExclusion(...args: any[]): any;
|
||||
removeExclude(...args: any[]): any;
|
||||
removeTag(...args: any[]): any;
|
||||
toggleFacetExclusion(...args: any[]): any;
|
||||
toggleExclude(...args: any[]): any;
|
||||
toggleRefinement(...args: any[]): any;
|
||||
toggleFacetRefinement(...args: any[]): any;
|
||||
toggleRefine(...args: any[]): any;
|
||||
toggleTag(...args: any[]): any;
|
||||
nextPage(...args: any[]): any;
|
||||
previousPage(...args: any[]): any;
|
||||
setCurrentPage(...args: any[]): any;
|
||||
setPage(...args: any[]): any;
|
||||
setQueryParameter(...args: any[]): any;
|
||||
|
||||
/**
|
||||
* Set the whole state (warning: will erase previous state)
|
||||
* @param newState the whole new state
|
||||
* @return
|
||||
* @fires change
|
||||
* @chainable
|
||||
*/
|
||||
setState(newState: QueryParameters): this;
|
||||
|
||||
/**
|
||||
* Get the current search state stored in the helper. This object is immutable.
|
||||
* @param [filters] optional filters to retrieve only a subset of the state
|
||||
* @return if filters is specified a plain object is
|
||||
* returned containing only the requested fields, otherwise return the unfiltered
|
||||
* state
|
||||
* @example
|
||||
* // Get the complete state as stored in the helper
|
||||
* helper.getState();
|
||||
* @example
|
||||
* // Get a part of the state with all the refinements on attributes and the query
|
||||
* helper.getState(['query', 'attribute:category']);
|
||||
*/
|
||||
getState(): SearchParameters;
|
||||
getState(filters: string[]): QueryParameters;
|
||||
|
||||
getStateAsQueryString(...args: any[]): any;
|
||||
setStateFromQueryString(...args: any[]): any;
|
||||
overrideStateWithoutTriggeringChangeEvent(...args: any[]): any;
|
||||
isRefined(...args: any[]): any;
|
||||
hasRefinements(...args: any[]): any;
|
||||
isExcluded(...args: any[]): any;
|
||||
isDisjunctiveRefined(...args: any[]): any;
|
||||
hasTag(...args: any[]): any;
|
||||
isTagRefined(...args: any[]): any;
|
||||
getIndex(...args: any[]): any;
|
||||
getCurrentPage(...args: any[]): any;
|
||||
getPage(...args: any[]): any;
|
||||
getTags(...args: any[]): any;
|
||||
getQueryParameter(...args: any[]): any;
|
||||
getRefinements(...args: any[]): any;
|
||||
getNumericRefinement(...args: any[]): any;
|
||||
getHierarchicalFacetBreadcrumb(...args: any[]): any;
|
||||
containsRefinement(...args: any[]): any;
|
||||
clearCache(...args: any[]): any;
|
||||
setClient(...args: any[]): any;
|
||||
getClient(...args: any[]): any;
|
||||
derive(...args: any[]): any;
|
||||
detachDerivedHelper(...args: any[]): any;
|
||||
hasPendingRequests(...args: any[]): any;
|
||||
}
|
||||
|
||||
namespace AlgoliaSearchHelper {
|
||||
/**
|
||||
* Structure of each result when using
|
||||
* [`searchForFacetValues()`](reference.html#AlgoliaSearchHelper#searchForFacetValues)
|
||||
*/
|
||||
interface FacetSearchHit {
|
||||
value: string;
|
||||
highlighted: string;
|
||||
count: number;
|
||||
isRefined: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Structure of the data resolved by the
|
||||
* [`searchForFacetValues()`](reference.html#AlgoliaSearchHelper#searchForFacetValues)
|
||||
* promise.
|
||||
*/
|
||||
interface FacetSearchResult {
|
||||
facetHits: FacetSearchHit;
|
||||
processingTimeMS: number;
|
||||
}
|
||||
}
|
||||
|
||||
export interface QueryParameters extends algoliasearch.QueryParameters {
|
||||
/**
|
||||
* Targeted index. This parameter is mandatory.
|
||||
*/
|
||||
index?: string;
|
||||
/**
|
||||
* This attribute contains the list of all the disjunctive facets
|
||||
* used. This list will be added to requested facets in the
|
||||
* [facets attribute](https://www.algolia.com/doc/rest-api/search#param-facets) sent to algolia.
|
||||
*/
|
||||
disjunctiveFacets?: string[];
|
||||
/**
|
||||
* This attribute contains the list of all the hierarchical facets
|
||||
* used. This list will be added to requested facets in the
|
||||
* [facets attribute](https://www.algolia.com/doc/rest-api/search#param-facets) sent to algolia.
|
||||
* Hierarchical facets are a sub type of disjunctive facets that
|
||||
* let you filter faceted attributes hierarchically.
|
||||
*/
|
||||
hierarchicalFacets?: string[] | object[];
|
||||
|
||||
// Refinements
|
||||
/**
|
||||
* This attribute contains all the filters that need to be
|
||||
* applied on the conjunctive facets. Each facet must be properly
|
||||
* defined in the `facets` attribute.
|
||||
*
|
||||
* The key is the name of the facet, and the `FacetList` contains all
|
||||
* filters selected for the associated facet name.
|
||||
*
|
||||
* When querying algolia, the values stored in this attribute will
|
||||
* be translated into the `facetFilters` attribute.
|
||||
*/
|
||||
facetsRefinements?: { [facet: string]: SearchParameters.FacetList };
|
||||
/**
|
||||
* This attribute contains all the filters that need to be
|
||||
* excluded from the conjunctive facets. Each facet must be properly
|
||||
* defined in the `facets` attribute.
|
||||
*
|
||||
* The key is the name of the facet, and the `FacetList` contains all
|
||||
* filters excluded for the associated facet name.
|
||||
*
|
||||
* When querying algolia, the values stored in this attribute will
|
||||
* be translated into the `facetFilters` attribute.
|
||||
*/
|
||||
facetsExcludes?: { [facet: string]: SearchParameters.FacetList };
|
||||
/**
|
||||
* This attribute contains all the filters that need to be
|
||||
* applied on the disjunctive facets. Each facet must be properly
|
||||
* defined in the `disjunctiveFacets` attribute.
|
||||
*
|
||||
* The key is the name of the facet, and the `FacetList` contains all
|
||||
* filters selected for the associated facet name.
|
||||
*
|
||||
* When querying algolia, the values stored in this attribute will
|
||||
* be translated into the `facetFilters` attribute.
|
||||
*/
|
||||
disjunctiveFacetsRefinements?: { [facet: string]: SearchParameters.FacetList };
|
||||
/**
|
||||
* This attribute contains all the filters that need to be
|
||||
* applied on the numeric attributes.
|
||||
*
|
||||
* The key is the name of the attribute, and the value is the
|
||||
* filters to apply to this attribute.
|
||||
*
|
||||
* When querying algolia, the values stored in this attribute will
|
||||
* be translated into the `numericFilters` attribute.
|
||||
*/
|
||||
numericRefinements?: { [facet: string]: SearchParameters.OperatorList };
|
||||
/**
|
||||
* This attribute contains all the tags used to refine the query.
|
||||
*
|
||||
* When querying algolia, the values stored in this attribute will
|
||||
* be translated into the `tagFilters` attribute.
|
||||
*/
|
||||
tagRefinements?: string[];
|
||||
/**
|
||||
* This attribute contains all the filters that need to be
|
||||
* applied on the hierarchical facets. Each facet must be properly
|
||||
* defined in the `hierarchicalFacets` attribute.
|
||||
*
|
||||
* The key is the name of the facet, and the `FacetList` contains all
|
||||
* filters selected for the associated facet name. The FacetList values
|
||||
* are structured as a string that contain the values for each level
|
||||
* separated by the configured separator.
|
||||
*
|
||||
* When querying algolia, the values stored in this attribute will
|
||||
* be translated into the `facetFilters` attribute.
|
||||
*/
|
||||
hierarchicalFacetsRefinements?: { [facet: string]: SearchParameters.FacetList };
|
||||
|
||||
/**
|
||||
* Contains the optional tag filters in the raw format of the Algolia API.
|
||||
* @see https://www.algolia.com/doc/rest#param-tagFilters
|
||||
*/
|
||||
optionalTagFilters?: string;
|
||||
|
||||
/**
|
||||
* Contains the optional facet filters in the raw format of the Algolia API.
|
||||
* @see https://www.algolia.com/doc/rest#param-tagFilters
|
||||
*/
|
||||
optionalFacetFilters?: string;
|
||||
|
||||
// Misc. parameters
|
||||
/**
|
||||
* Applies 'exact' on single word queries if the word contains at least 3 characters
|
||||
* and is not a stop word.
|
||||
* Can take two values?: true or false.
|
||||
* By default, its set to false.
|
||||
* @see https://www.algolia.com/doc/rest#param-enableExactOnSingleWordQuery
|
||||
*/
|
||||
enableExactOnSingleWordQuery?: boolean;
|
||||
}
|
||||
|
||||
type ValueTypes<T> = T extends Array<infer U> ? U : never;
|
||||
type ManagedParameters = {
|
||||
[K in ValueTypes<SearchParameters["managedParameters"]>]: SearchParameters[K]
|
||||
};
|
||||
|
||||
export class SearchParameters implements QueryParameters {
|
||||
index?: string ;
|
||||
disjunctiveFacets?: string[] ;
|
||||
hierarchicalFacets?: string[] | object[] ;
|
||||
facetsRefinements?: { [facet: string]: string[]; } ;
|
||||
facetsExcludes?: { [facet: string]: string[]; } ;
|
||||
disjunctiveFacetsRefinements?: { [facet: string]: string[]; } ;
|
||||
numericRefinements?: { [facet: string]: SearchParameters.OperatorList };
|
||||
tagRefinements?: string[] ;
|
||||
hierarchicalFacetsRefinements?: { [facet: string]: string[]; } ;
|
||||
optionalTagFilters?: string ;
|
||||
optionalFacetFilters?: string ;
|
||||
hitsPerPage?: number ;
|
||||
maxValuesPerFacet?: number ;
|
||||
minWordSizefor1Typo?: number ;
|
||||
minWordSizefor2Typos?: number ;
|
||||
minProximity?: any;
|
||||
allowTyposOnNumericTokens?: boolean ;
|
||||
ignorePlurals?: boolean ;
|
||||
advancedSyntax?: boolean ;
|
||||
analytics?: boolean ;
|
||||
synonyms?: boolean ;
|
||||
replaceSynonymsInHighlight?: boolean ;
|
||||
highlightPreTag?: string ;
|
||||
highlightPostTag?: string ;
|
||||
distinct?: number | boolean ;
|
||||
aroundLatLng?: string ;
|
||||
aroundRadius?: number ;
|
||||
minimumAroundRadius?: number ;
|
||||
aroundPrecision?: number ;
|
||||
snippetEllipsisText?: string;
|
||||
enableExactOnSingleWordQuery?: boolean ;
|
||||
query?: string ;
|
||||
filters?: string ;
|
||||
attributesToRetrieve?: string[] ;
|
||||
restrictSearchableAttributes?: string[] ;
|
||||
facets?: string[] ;
|
||||
facetingAfterDistinct?: boolean ;
|
||||
attributesToHighlight?: string[] ;
|
||||
attributesToSnippet?: string[] ;
|
||||
restrictHighlightAndSnippetArrays?: boolean ;
|
||||
page?: number ;
|
||||
offset?: number ;
|
||||
length?: number ;
|
||||
typoTolerance?: boolean ;
|
||||
disableTypoToleranceOnAttributes?: string[] ;
|
||||
aroundLatLngViaIP?: boolean ;
|
||||
insideBoundingBox?: number[][] ;
|
||||
queryType?: "prefixAll" | "prefixLast" | "prefixNone" ;
|
||||
insidePolygon?: number[][] ;
|
||||
removeWordsIfNoResults?: "none" | "lastWords" | "firstWords" | "allOptional" ;
|
||||
optionalWords?: string[] ;
|
||||
removeStopWords?: boolean | string[] ;
|
||||
disableExactOnAttributes?: string[] ;
|
||||
exactOnSingleWordQuery?: "none" | "attribute" | "word" ;
|
||||
alternativesAsExact?: Array<"ignorePlurals" | "singleWordSynonym" | "multiWordsSynonym"> ;
|
||||
getRankingInfo?: boolean ;
|
||||
numericAttributesToIndex?: string[] ;
|
||||
numericAttributesForFiltering?: string[] ;
|
||||
numericFilters?: string[] ;
|
||||
tagFilters?: string[] ;
|
||||
facetFilters?: string[] | string[][] ;
|
||||
analyticsTags?: string[] ;
|
||||
nbShards?: number ;
|
||||
userData?: string | object ;
|
||||
|
||||
managedParameters: [
|
||||
'index',
|
||||
'facets', 'disjunctiveFacets', 'facetsRefinements',
|
||||
'facetsExcludes', 'disjunctiveFacetsRefinements',
|
||||
'numericRefinements', 'tagRefinements', 'hierarchicalFacets', 'hierarchicalFacetsRefinements'
|
||||
];
|
||||
|
||||
constructor(newParameters?: QueryParameters)
|
||||
|
||||
/* Add a disjunctive facet to the disjunctiveFacets attribute of the helper configuration, if it isn't already present. */
|
||||
addDisjunctiveFacet(facet: string): SearchParameters;
|
||||
/* Adds a refinement on a disjunctive facet. */
|
||||
addDisjunctiveFacetRefinement(facet: string, value: string): SearchParameters;
|
||||
/* Exclude a value from a "normal" facet */
|
||||
addExcludeRefinement(facet: string, value: string): SearchParameters;
|
||||
/* Add a facet to the facets attribute of the helper configuration, if it isn't already present. */
|
||||
addFacet(facet: string): SearchParameters;
|
||||
/* Add a refinement on a "normal" facet */
|
||||
addFacetRefinement(facet: string, value: string): SearchParameters;
|
||||
addHierarchicalFacet(facet: any): SearchParameters;
|
||||
addHierarchicalFacetRefinement(facet: string, path: string): SearchParameters;
|
||||
addNumericRefinement(attribute: string, operator: SearchParameters.Operator, value: number | number[]): SearchParameters;
|
||||
addTagRefinement(tag: string): SearchParameters;
|
||||
clearRefinements(attribute?: string | ((value: any, attribute: string, type: string) => any)): SearchParameters;
|
||||
clearTags(): SearchParameters;
|
||||
filter(filters: string[]): any;
|
||||
getConjunctiveRefinements(facetName: string): string[];
|
||||
getDisjunctiveRefinements(facetName: string): string[];
|
||||
getExcludeRefinements(facetName: string): string[];
|
||||
getHierarchicalFacetBreadcrumb(facetName: string): string[];
|
||||
getHierarchicalFacetByName(hierarchicalFacetName: string): any;
|
||||
getHierarchicalRefinement(facetName: string): string[];
|
||||
getNumericRefinements(facetName: string): SearchParameters.OperatorList[];
|
||||
getNumericRefinement(attribute: string, operator: SearchParameters.Operator): Array<number | number[]>;
|
||||
getQueryParams(): Partial<ManagedParameters>;
|
||||
getQueryParameter(paramName: string): any;
|
||||
getRefinedDisjunctiveFacets(facet: string, value: any): string[];
|
||||
getRefinedHierarchicalFacets(facet: string, value: any): string[];
|
||||
getUnrefinedDisjunctiveFacets(): string[];
|
||||
isConjunctiveFacet(facet: string): boolean;
|
||||
isDisjunctiveFacetRefined(facet: string, value?: string): boolean;
|
||||
isDisjunctiveFacet(facet: string): boolean;
|
||||
isExcludeRefined(facet: string, value?: string): boolean;
|
||||
isFacetRefined(facet: string, value?: string): boolean;
|
||||
isHierarchicalFacetRefined(facet: string, value?: string): boolean;
|
||||
isHierarchicalFacet(facet: string): boolean;
|
||||
isNumericRefined(attribute: string, operator: SearchParameters.Operator, value?: string): boolean;
|
||||
isTagRefined(tag: string): boolean;
|
||||
static make(newParameters: QueryParameters): SearchParameters;
|
||||
removeExcludeRefinement(facet: string, value: string): SearchParameters;
|
||||
removeFacet(facet: string): SearchParameters;
|
||||
removeFacetRefinement(facet: string, value?: string): SearchParameters;
|
||||
removeDisjunctiveFacet(facet: string): SearchParameters;
|
||||
removeDisjunctiveFacetRefinement(facet: string, value?: string): SearchParameters;
|
||||
removeHierarchicalFacet(facet: string): SearchParameters;
|
||||
removeHierarchicalFacetRefinement(facet: string): SearchParameters;
|
||||
removeTagRefinement(tag: string): SearchParameters;
|
||||
setDisjunctiveFacets(facets: string[]): SearchParameters;
|
||||
setFacets(facets: string[]): SearchParameters;
|
||||
setHitsPerPage(n: number): SearchParameters;
|
||||
setPage(newPage: number): SearchParameters;
|
||||
setQueryParameters(params: { [key: string]: any }): SearchParameters;
|
||||
setQueryParameter(parameter: string, value: any): SearchParameters;
|
||||
setQuery(newQuery: string): SearchParameters;
|
||||
setTypoTolerance(typoTolerance: string): SearchParameters;
|
||||
toggleDisjunctiveFacetRefinement(facet: string, value: any): SearchParameters;
|
||||
toggleExcludeFacetRefinement(facet: string, value: any): SearchParameters;
|
||||
toggleConjunctiveFacetRefinement(facet: string, value: any): SearchParameters;
|
||||
toggleHierarchicalFacetRefinement(facet: string, value: any): SearchParameters;
|
||||
toggleFacetRefinement(facet: string, value: any): SearchParameters;
|
||||
toggleTagRefinement(tag: string): SearchParameters;
|
||||
static validate(currentState: SearchParameters, parameters: QueryParameters): null | Error;
|
||||
}
|
||||
|
||||
namespace SearchParameters {
|
||||
type FacetList = string[];
|
||||
|
||||
type OperatorList = {
|
||||
[k in Operator]?: Array<number | number[]>
|
||||
};
|
||||
type Operator = '=' | '>' | '>=' | '<' | '<=' | '!=';
|
||||
}
|
||||
|
||||
export class SearchResults {
|
||||
/**
|
||||
* query used to generate the results
|
||||
*/
|
||||
query: string;
|
||||
/**
|
||||
* The query as parsed by the engine given all the rules.
|
||||
*/
|
||||
parsedQuery: string;
|
||||
/**
|
||||
* all the records that match the search parameters. Each record is
|
||||
* augmented with a new attribute `_highlightResult`
|
||||
* which is an object keyed by attribute and with the following properties:
|
||||
* - `value` : the value of the facet highlighted (html)
|
||||
* - `matchLevel`: full, partial or none depending on how the query terms match
|
||||
*/
|
||||
hits: any[];
|
||||
/**
|
||||
* index where the results come from
|
||||
*/
|
||||
index: string;
|
||||
/**
|
||||
* number of hits per page requested
|
||||
*/
|
||||
hitsPerPage: number;
|
||||
/**
|
||||
* total number of hits of this query on the index
|
||||
*/
|
||||
nbHits: number;
|
||||
/**
|
||||
* total number of pages with respect to the number of hits per page and the total number of hits
|
||||
*/
|
||||
nbPages: number;
|
||||
/**
|
||||
* current page
|
||||
*/
|
||||
page: number;
|
||||
/**
|
||||
* sum of the processing time of all the queries
|
||||
*/
|
||||
processingTimeMS: number;
|
||||
/**
|
||||
* The position if the position was guessed by IP.
|
||||
* @example "48.8637,2.3615",
|
||||
*/
|
||||
aroundLatLng: string;
|
||||
/**
|
||||
* The radius computed by Algolia.
|
||||
* @example "126792922",
|
||||
*/
|
||||
automaticRadius: string;
|
||||
/**
|
||||
* String identifying the server used to serve this request.
|
||||
* @example "c7-use-2.algolia.net",
|
||||
*/
|
||||
serverUsed: string;
|
||||
/**
|
||||
* Boolean that indicates if the computation of the counts did time out.
|
||||
* @deprecated
|
||||
*/
|
||||
timeoutCounts: boolean;
|
||||
/**
|
||||
* Boolean that indicates if the computation of the hits did time out.
|
||||
* @deprecated
|
||||
*/
|
||||
timeoutHits: boolean;
|
||||
|
||||
/**
|
||||
* True if the counts of the facets is exhaustive
|
||||
*/
|
||||
exhaustiveFacetsCount: boolean;
|
||||
|
||||
/**
|
||||
* True if the number of hits is exhaustive
|
||||
*/
|
||||
exhaustiveNbHits: boolean;
|
||||
|
||||
/**
|
||||
* Contains the userData if they are set by a [query rule](https://www.algolia.com/doc/guides/query-rules/query-rules-overview/).
|
||||
*/
|
||||
userData: any[];
|
||||
|
||||
/**
|
||||
* queryID is the unique identifier of the query used to generate the current search results.
|
||||
* This value is only available if the `clickAnalytics` search parameter is set to `true`.
|
||||
*/
|
||||
queryID: string;
|
||||
|
||||
/**
|
||||
* disjunctive facets results
|
||||
*/
|
||||
disjunctiveFacets: SearchResults.Facet[];
|
||||
/**
|
||||
* disjunctive facets results
|
||||
*/
|
||||
hierarchicalFacets: SearchResults.HierarchicalFacet[];
|
||||
|
||||
/**
|
||||
* other facets results
|
||||
*/
|
||||
facets: SearchResults.Facet[];
|
||||
|
||||
_rawResults: any;
|
||||
_state: SearchParameters;
|
||||
|
||||
constructor(state: SearchParameters, results: any[])
|
||||
|
||||
/**
|
||||
* Get a facet object with its name
|
||||
* @deprecated
|
||||
* @param name name of the faceted attribute
|
||||
* @return the facet object
|
||||
*/
|
||||
getFacetByName(name: string): SearchResults.Facet;
|
||||
|
||||
/**
|
||||
* Get a the list of values for a given facet attribute. Those values are sorted
|
||||
* refinement first, descending count (bigger value on top), and name ascending
|
||||
* (alphabetical order). The sort formula can overridden using either string based
|
||||
* predicates or a function.
|
||||
*
|
||||
* This method will return all the values returned by the Algolia engine plus all
|
||||
* the values already refined. This means that it can happen that the
|
||||
* `maxValuesPerFacet` [configuration](https://www.algolia.com/doc/rest-api/search#param-maxValuesPerFacet)
|
||||
* might not be respected if you have facet values that are already refined.
|
||||
* @param attribute attribute name
|
||||
* @param opts configuration options.
|
||||
* @param opts.sortBy
|
||||
* When using strings, it consists of
|
||||
* the name of the [FacetValue](#SearchResults.FacetValue) or the
|
||||
* [HierarchicalFacet](#SearchResults.HierarchicalFacet) attributes with the
|
||||
* order (`asc` or `desc`). For example to order the value by count, the
|
||||
* argument would be `['count:asc']`.
|
||||
*
|
||||
* If only the attribute name is specified, the ordering defaults to the one
|
||||
* specified in the default value for this attribute.
|
||||
*
|
||||
* When not specified, the order is
|
||||
* ascending. This parameter can also be a function which takes two facet
|
||||
* values and should return a number, 0 if equal, 1 if the first argument is
|
||||
* bigger or -1 otherwise.
|
||||
*
|
||||
* The default value for this attribute `['isRefined:desc', 'count:desc', 'name:asc']`
|
||||
* @return depending on the type of facet of
|
||||
* the attribute requested (hierarchical, disjunctive or conjunctive)
|
||||
* @example
|
||||
* helper.on('results', function(content){
|
||||
* //get values ordered only by name ascending using the string predicate
|
||||
* content.getFacetValues('city', {sortBy: ['name:asc']});
|
||||
* //get values ordered only by count ascending using a function
|
||||
* content.getFacetValues('city', {
|
||||
* // this is equivalent to ['count:asc']
|
||||
* sortBy: function(a, b) {
|
||||
* if (a.count === b.count) return 0;
|
||||
* if (a.count > b.count) return 1;
|
||||
* if (b.count > a.count) return -1;
|
||||
* }
|
||||
* });
|
||||
* });
|
||||
*/
|
||||
getFacetValues(attribute: string, opts: any): SearchResults.FacetValue[] | SearchResults.HierarchicalFacet;
|
||||
|
||||
/**
|
||||
* Returns the facet stats if attribute is defined and the facet contains some.
|
||||
* Otherwise returns undefined.
|
||||
* @param attribute name of the faceted attribute
|
||||
* @return The stats of the facet
|
||||
*/
|
||||
getFacetStats(attribute: string): any;
|
||||
|
||||
/**
|
||||
* Returns all refinements for all filters + tags. It also provides
|
||||
* additional information: count and exhausistivity for each filter.
|
||||
*
|
||||
* See the [refinement type](#Refinement) for an exhaustive view of the available
|
||||
* data.
|
||||
*
|
||||
* @return all the refinements
|
||||
*/
|
||||
getRefinements(): SearchResults.Refinement[];
|
||||
}
|
||||
|
||||
namespace SearchResults {
|
||||
interface Facet {
|
||||
name: string;
|
||||
data: object;
|
||||
stats: object;
|
||||
}
|
||||
|
||||
interface HierarchicalFacet {
|
||||
name: string;
|
||||
count: number;
|
||||
path: string;
|
||||
isRefined: boolean;
|
||||
data: HierarchicalFacet[];
|
||||
}
|
||||
|
||||
interface FacetValue {
|
||||
name: string;
|
||||
count: number;
|
||||
isRefined: boolean;
|
||||
isExcluded: boolean;
|
||||
}
|
||||
|
||||
interface Refinement {
|
||||
type: `numeric` | `facet` | `exclude` | `disjunctive` | `hierarchical`;
|
||||
attributeName: string;
|
||||
name: string;
|
||||
numericValue: number;
|
||||
operator: string;
|
||||
count: number;
|
||||
exhaustive: boolean;
|
||||
}
|
||||
}
|
||||
|
||||
export {};
|
||||
}
|
||||
|
||||
export = algoliasearchHelper;
|
||||
@ -1,24 +0,0 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"module": "commonjs",
|
||||
"lib": [
|
||||
"es6",
|
||||
"dom"
|
||||
],
|
||||
"noImplicitAny": true,
|
||||
"noImplicitThis": true,
|
||||
"strictNullChecks": true,
|
||||
"strictFunctionTypes": true,
|
||||
"baseUrl": "../",
|
||||
"typeRoots": [
|
||||
"../"
|
||||
],
|
||||
"types": [],
|
||||
"noEmit": true,
|
||||
"forceConsistentCasingInFileNames": true
|
||||
},
|
||||
"files": [
|
||||
"index.d.ts",
|
||||
"algoliasearch-helper-tests.ts"
|
||||
]
|
||||
}
|
||||
@ -1 +0,0 @@
|
||||
{ "extends": "dtslint/dt.json" }
|
||||
@ -1,249 +0,0 @@
|
||||
import * as algoliasearch from 'algoliasearch';
|
||||
import {
|
||||
ClientOptions,
|
||||
SynonymOption,
|
||||
ApiKeyOptions,
|
||||
SearchSynonymOptions,
|
||||
SecuredApiOptions,
|
||||
Index,
|
||||
Response,
|
||||
IndexSettings,
|
||||
QueryParameters,
|
||||
ApiKey,
|
||||
MultiResponse,
|
||||
Client,
|
||||
} from 'algoliasearch';
|
||||
import * as algoliasearchLite from 'algoliasearch/lite';
|
||||
|
||||
let _algoliaResponse: Response = {
|
||||
hits: [{}, {}],
|
||||
page: 0,
|
||||
nbHits: 12,
|
||||
nbPages: 6,
|
||||
hitsPerPage: 2,
|
||||
processingTimeMS: 32,
|
||||
query: '',
|
||||
params: '',
|
||||
index: '',
|
||||
exhaustiveFacetsCount: true,
|
||||
exhaustiveNbHits: false,
|
||||
};
|
||||
|
||||
let _clientOptions: ClientOptions = {
|
||||
timeout: 12,
|
||||
protocol: '',
|
||||
httpAgent: '',
|
||||
};
|
||||
|
||||
let _synonymOption: SynonymOption = {
|
||||
forwardToReplicas: false,
|
||||
replaceExistingSynonyms: false,
|
||||
};
|
||||
|
||||
let _algoliaApiKeyOptions: ApiKeyOptions = {
|
||||
validity: 0,
|
||||
maxQueriesPerIPPerHour: 0,
|
||||
indexes: [''],
|
||||
queryParameters: { attributesToRetrieve: ['algolia'] },
|
||||
description: '',
|
||||
};
|
||||
|
||||
let _searchSynonymOptions: SearchSynonymOptions = {
|
||||
query: '',
|
||||
page: 0,
|
||||
type: '',
|
||||
hitsPerPage: 0,
|
||||
};
|
||||
|
||||
let _algoliaSecuredApiOptions: SecuredApiOptions = {
|
||||
filters: '',
|
||||
validUntil: 0,
|
||||
restrictIndices: '',
|
||||
userToken: '',
|
||||
};
|
||||
|
||||
let _algoliaSecuredApiOptionsAdvanced: SecuredApiOptions = {
|
||||
filters: '',
|
||||
validUntil: 0,
|
||||
restrictIndices: ['', ''],
|
||||
userToken: '',
|
||||
attributesToRetrieve: ['foo', 'bar'],
|
||||
restrictSearchableAttributes: [''],
|
||||
};
|
||||
|
||||
let _algoliaIndexSettings: IndexSettings = {
|
||||
attributesToIndex: [''],
|
||||
attributesForFaceting: [''],
|
||||
unretrievableAttributes: [''],
|
||||
attributesToRetrieve: [''],
|
||||
ranking: [''],
|
||||
customRanking: [''],
|
||||
replicas: [''],
|
||||
maxValuesPerFacet: 100,
|
||||
attributesToHighlight: [''],
|
||||
attributesToSnippet: [''],
|
||||
highlightPreTag: '',
|
||||
highlightPostTag: '',
|
||||
snippetEllipsisText: '',
|
||||
restrictHighlightAndSnippetArrays: false,
|
||||
hitsPerPage: 0,
|
||||
minWordSizefor1Typo: 0,
|
||||
minWordSizefor2Typos: 0,
|
||||
typoTolerance: false,
|
||||
allowTyposOnNumericTokens: false,
|
||||
ignorePlurals: false,
|
||||
disableTypoToleranceOnAttributes: '',
|
||||
separatorsToIndex: '',
|
||||
queryType: 'prefixAll',
|
||||
removeWordsIfNoResults: '',
|
||||
advancedSyntax: false,
|
||||
optionalWords: [''],
|
||||
removeStopWords: [''],
|
||||
disablePrefixOnAttributes: [''],
|
||||
disableExactOnAttributes: [''],
|
||||
exactOnSingleWordQuery: '',
|
||||
alternativesAsExact: ['ignorePlurals'],
|
||||
attributeForDistinct: '',
|
||||
distinct: false,
|
||||
numericAttributesToIndex: [''],
|
||||
allowCompressionOfIntegerArray: false,
|
||||
altCorrections: [{}],
|
||||
minProximity: 0,
|
||||
placeholders: { '': [''] },
|
||||
camelCaseAttributes: [''],
|
||||
sortFacetValuesBy: 'count',
|
||||
queryLanguages: ['fr', 'es'],
|
||||
paginationLimitedTo: 500,
|
||||
};
|
||||
|
||||
let _algoliaQueryParameters: QueryParameters = {
|
||||
query: '',
|
||||
filters: '',
|
||||
attributesToRetrieve: [''],
|
||||
restrictSearchableAttributes: [''],
|
||||
facets: [''],
|
||||
facetingAfterDistinct: true,
|
||||
maxValuesPerFacet: 2,
|
||||
attributesToHighlight: [''],
|
||||
attributesToSnippet: [''],
|
||||
highlightPreTag: '',
|
||||
highlightPostTag: '',
|
||||
snippetEllipsisText: '',
|
||||
restrictHighlightAndSnippetArrays: false,
|
||||
hitsPerPage: 0,
|
||||
page: 0,
|
||||
offset: 0,
|
||||
length: 0,
|
||||
minWordSizefor1Typo: 0,
|
||||
minWordSizefor2Typos: 0,
|
||||
typoTolerance: false,
|
||||
allowTyposOnNumericTokens: false,
|
||||
ignorePlurals: false,
|
||||
disableTypoToleranceOnAttributes: [''],
|
||||
aroundLatLng: '',
|
||||
aroundLatLngViaIP: true,
|
||||
aroundRadius: 0,
|
||||
aroundPrecision: 0,
|
||||
minimumAroundRadius: 0,
|
||||
insideBoundingBox: [[0]],
|
||||
queryType: 'prefixAll',
|
||||
insidePolygon: [[0]],
|
||||
removeWordsIfNoResults: 'firstWords',
|
||||
advancedSyntax: false,
|
||||
optionalWords: [''],
|
||||
removeStopWords: [''],
|
||||
disableExactOnAttributes: [''],
|
||||
exactOnSingleWordQuery: 'attribute',
|
||||
alternativesAsExact: ['ignorePlurals'],
|
||||
distinct: 0,
|
||||
getRankingInfo: false,
|
||||
numericAttributesToIndex: [''],
|
||||
numericAttributesForFiltering: [''],
|
||||
numericFilters: [''],
|
||||
tagFilters: [''],
|
||||
facetFilters: ['', ['']],
|
||||
analytics: false,
|
||||
clickAnalytics: true,
|
||||
analyticsTags: [''],
|
||||
synonyms: true,
|
||||
replaceSynonymsInHighlight: false,
|
||||
minProximity: 0,
|
||||
sortFacetValuesBy: 'alpha',
|
||||
};
|
||||
|
||||
let _apiKey: ApiKey = {
|
||||
value: '0eb3e6308abccdf9b67d70ddacb418b4',
|
||||
createdAt: 1513462891,
|
||||
acl: ['search'],
|
||||
validity: 0,
|
||||
};
|
||||
|
||||
let client: Client = algoliasearch('', '');
|
||||
let index: Index = client.initIndex('');
|
||||
|
||||
let search = index.search({ query: '' });
|
||||
|
||||
index.search({ query: '' }, (err, res) => {});
|
||||
|
||||
// partialUpdateObject
|
||||
index.partialUpdateObject({}, () => {});
|
||||
index.partialUpdateObject({}, false, () => {});
|
||||
index.partialUpdateObject({}).then(() => {});
|
||||
index.partialUpdateObject({}, false).then(() => {});
|
||||
|
||||
// partialUpdateObjects
|
||||
index.partialUpdateObjects([{}], () => {});
|
||||
index.partialUpdateObjects([{}], false, () => {});
|
||||
index.partialUpdateObjects([{}]).then(() => {});
|
||||
index.partialUpdateObjects([{}], false).then(() => {});
|
||||
|
||||
let indexName: string = index.indexName;
|
||||
|
||||
// complete copy
|
||||
client.copyIndex('from', 'to').then(() => {});
|
||||
client.copyIndex('from', 'to', () => {});
|
||||
// with scope
|
||||
client.copyIndex('from', 'to', ['settings']).then(() => {});
|
||||
client.copyIndex('from', 'to', ['synonyms', 'rules'], () => {});
|
||||
|
||||
// Browsing
|
||||
const browser = index.browseAll();
|
||||
index.browseAll('query');
|
||||
index.browseAll('', {
|
||||
filters: 'dog',
|
||||
});
|
||||
|
||||
let hits: Object[] = [];
|
||||
|
||||
browser.on('result', function onResult(content) {
|
||||
hits = hits.concat(content.hits);
|
||||
});
|
||||
|
||||
browser.on('end', function onEnd() {
|
||||
const _message = `We got ${hits.length} hits`;
|
||||
});
|
||||
|
||||
browser.on('error', function onError(err) {
|
||||
throw err;
|
||||
});
|
||||
|
||||
browser.stop();
|
||||
|
||||
index.setSettings({ hitsPerPage: 10 }, () => {});
|
||||
index.setSettings({ hitsPerPage: 10 }, { forwardToReplicas: true }, () => {});
|
||||
index.setSettings({ hitsPerPage: 10 }).then(() => {});
|
||||
index.setSettings({ hitsPerPage: 10 }, { forwardToReplicas: true }).then(() => {});
|
||||
|
||||
index.browse('', {
|
||||
advancedSyntax: false,
|
||||
attributesToRetrieve: ['dogs'],
|
||||
});
|
||||
client.copyIndex('from', 'to', ['settings']).then(() => {});
|
||||
client.copyIndex('from', 'to', ['synonyms', 'rules'], () => {});
|
||||
|
||||
const liteClient: algoliasearchLite.Client = algoliasearchLite('', '');
|
||||
|
||||
liteClient.search([], (err: Error, res: MultiResponse) => {});
|
||||
liteClient.search([]).then((res: MultiResponse) => {});
|
||||
type Res = { zipzop: true };
|
||||
liteClient.search<Res>([]).then((res: MultiResponse<Res>) => {});
|
||||
2180
types/algoliasearch/index.d.ts
vendored
2180
types/algoliasearch/index.d.ts
vendored
File diff suppressed because it is too large
Load Diff
191
types/algoliasearch/lite/index.d.ts
vendored
191
types/algoliasearch/lite/index.d.ts
vendored
@ -1,191 +0,0 @@
|
||||
// Type definitions for algoliasearch-client-js 3.35
|
||||
// Project: https://github.com/algolia/algoliasearch-client-js
|
||||
// Definitions by: Baptiste Coquelle <https://github.com/cbaptiste>
|
||||
// Haroen Viaene <https://github.com/haroenv>
|
||||
// Samuel Vaillant <https://github.com/samouss>
|
||||
// Claas Brüggemann <https://github.com/ClaasBrueggemann>
|
||||
// Kai Eichinger <https://github.com/keichinger>
|
||||
// Nery Ortez <https://github.com/neryortez>
|
||||
// Antoine Rousseau <https://github.com/antoinerousseau>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
// TypeScript Version: 2.8
|
||||
|
||||
import {
|
||||
QueryParameters,
|
||||
ClientOptions,
|
||||
MultiResponse,
|
||||
SearchForFacetValues,
|
||||
Response,
|
||||
BrowseParameters,
|
||||
BrowseResponse
|
||||
} from 'algoliasearch';
|
||||
|
||||
declare namespace algoliasearch {
|
||||
/**
|
||||
* Interface for the algolia client object
|
||||
*/
|
||||
interface Client {
|
||||
/**
|
||||
* Initialization of the index
|
||||
* https://github.com/algolia/algoliasearch-client-js#init-index---initindex
|
||||
*/
|
||||
initIndex(indexName: string): Index;
|
||||
/**
|
||||
* Query on multiple index
|
||||
* https://github.com/algolia/algoliasearch-client-js#multiple-queries---multiplequeries
|
||||
*/
|
||||
search<T=any>(
|
||||
queries: {
|
||||
indexName: string;
|
||||
query: string;
|
||||
params: QueryParameters;
|
||||
}[],
|
||||
cb: (err: Error, res: MultiResponse<T>) => void
|
||||
): void;
|
||||
/**
|
||||
* Query on multiple index
|
||||
* https://github.com/algolia/algoliasearch-client-js#multiple-queries---multiplequeries
|
||||
*/
|
||||
search<T=any>(
|
||||
queries: {
|
||||
indexName: string;
|
||||
query: string;
|
||||
params: QueryParameters;
|
||||
}[]
|
||||
): Promise<MultiResponse<T>>;
|
||||
/**
|
||||
* Query for facet values of a specific facet
|
||||
*/
|
||||
searchForFacetValues(
|
||||
queries: [{ indexName: string; params: SearchForFacetValues.Parameters }]
|
||||
): Promise<SearchForFacetValues.Response[]>;
|
||||
/**
|
||||
* clear browser cache
|
||||
* https://github.com/algolia/algoliasearch-client-js#cache
|
||||
*/
|
||||
clearCache(): void;
|
||||
/**
|
||||
* Add a header to be sent with all upcoming requests
|
||||
*/
|
||||
setExtraHeader(name: string, value: string): void;
|
||||
/**
|
||||
* Get the value of an extra header
|
||||
*/
|
||||
getExtraHeader(name: string): string;
|
||||
/**
|
||||
* remove an extra header for all upcoming requests
|
||||
*/
|
||||
unsetExtraHeader(name: string): void;
|
||||
/**
|
||||
* add a header, used for flagging InstantSearch implementations
|
||||
*/
|
||||
addAlgoliaAgent(agent: string): void;
|
||||
}
|
||||
|
||||
/**
|
||||
* Interface for the index algolia object
|
||||
*/
|
||||
interface Index {
|
||||
indexName: string;
|
||||
/**
|
||||
* Gets a specific object
|
||||
* https://algolia.com/doc/api-reference/api-methods/get-objects/#retrieve-only-one-object
|
||||
*/
|
||||
getObject(objectID: string, cb: (err: Error, res: {}) => void): void;
|
||||
/**
|
||||
* Gets specific attributes from an object
|
||||
* https://algolia.com/doc/api-reference/api-methods/get-objects/#retrieve-only-one-object
|
||||
*/
|
||||
getObject(
|
||||
objectID: string,
|
||||
attributes: string[],
|
||||
cb: (err: Error, res: {}) => void
|
||||
): void;
|
||||
/**
|
||||
* Gets specific attributes from an object
|
||||
* https://algolia.com/doc/api-reference/api-methods/get-objects/#retrieve-only-one-object
|
||||
*/
|
||||
getObject<T>(objectID: string, attributes?: string[]): Promise<T>;
|
||||
/**
|
||||
* Gets a list of objects
|
||||
* https://github.com/algolia/algoliasearch-client-js#find-by-ids---getobjects
|
||||
*/
|
||||
getObjects(
|
||||
objectIDs: string[],
|
||||
cb: (err: Error, res: { results: {}[] }) => void
|
||||
): void;
|
||||
/**
|
||||
* Gets a list of objects
|
||||
* https://github.com/algolia/algoliasearch-client-js#find-by-ids---getobjects
|
||||
*/
|
||||
getObjects(objectIDs: string[]): Promise<{ results: {}[] }>;
|
||||
/**
|
||||
* Clear cache of an index
|
||||
* https://github.com/algolia/algoliasearch-client-js#cache
|
||||
*/
|
||||
clearCache(): void;
|
||||
/**
|
||||
* Search in an index
|
||||
* https://github.com/algolia/algoliasearch-client-js#search-in-an-index---search
|
||||
*/
|
||||
search<T=any>(
|
||||
params: QueryParameters,
|
||||
cb: (err: Error, res: Response<T>) => void
|
||||
): void;
|
||||
/**
|
||||
* Search in an index
|
||||
* https://github.com/algolia/algoliasearch-client-js#search-in-an-index---search
|
||||
*/
|
||||
search<T=any>(params: QueryParameters): Promise<Response<T>>;
|
||||
/**
|
||||
* Search in an index
|
||||
* https://www.algolia.com/doc/api-reference/api-methods/search-for-facet-values/
|
||||
*/
|
||||
searchForFacetValues(
|
||||
options: SearchForFacetValues.Parameters
|
||||
): Promise<SearchForFacetValues.Response>;
|
||||
/**
|
||||
* Search in an index
|
||||
* https://www.algolia.com/doc/api-reference/api-methods/search-for-facet-values/
|
||||
*/
|
||||
searchForFacetValues(
|
||||
options: SearchForFacetValues.Parameters,
|
||||
cb: (err: Error, res: SearchForFacetValues.Response) => void
|
||||
): void;
|
||||
/**
|
||||
* Browse an index
|
||||
* https://github.com/algolia/algoliasearch-client-js#backup--export-an-index---browse
|
||||
*/
|
||||
browse(query: string, parameters: BrowseParameters, cb: (err: Error, res: BrowseResponse) => void): void;
|
||||
/**
|
||||
* Browse an index
|
||||
* https://github.com/algolia/algoliasearch-client-js#backup--export-an-index---browse
|
||||
*/
|
||||
browse(query: string, cb: (err: Error, res: BrowseResponse) => void): void;
|
||||
/**
|
||||
* Browse an index
|
||||
* https://github.com/algolia/algoliasearch-client-js#backup--export-an-index---browse
|
||||
*/
|
||||
browse(query: string, parameters?: BrowseParameters): Promise<BrowseResponse>;
|
||||
/**
|
||||
* Browse an index from a cursor
|
||||
* https://github.com/algolia/algoliasearch-client-js#backup--export-an-index---browse
|
||||
*/
|
||||
browseFrom(
|
||||
cursor: string,
|
||||
cb: (err: Error, res: BrowseResponse) => void
|
||||
): void;
|
||||
/**
|
||||
* Browse an index from a cursor
|
||||
* https://github.com/algolia/algoliasearch-client-js#backup--export-an-index---browse
|
||||
*/
|
||||
browseFrom(cursor: string): Promise<BrowseResponse>;
|
||||
}
|
||||
}
|
||||
|
||||
declare function algoliasearch(
|
||||
applicationId: string,
|
||||
apiKey: string,
|
||||
options?: ClientOptions
|
||||
): algoliasearch.Client;
|
||||
export = algoliasearch;
|
||||
@ -1,23 +0,0 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"module": "commonjs",
|
||||
"lib": [
|
||||
"es6"
|
||||
],
|
||||
"noImplicitAny": true,
|
||||
"noImplicitThis": true,
|
||||
"strictNullChecks": true,
|
||||
"strictFunctionTypes": true,
|
||||
"baseUrl": "../",
|
||||
"typeRoots": [
|
||||
"../"
|
||||
],
|
||||
"types": [],
|
||||
"noEmit": true,
|
||||
"forceConsistentCasingInFileNames": true
|
||||
},
|
||||
"files": [
|
||||
"index.d.ts",
|
||||
"algoliasearch-tests.ts"
|
||||
]
|
||||
}
|
||||
@ -1,25 +0,0 @@
|
||||
{
|
||||
"extends": "dtslint/dt.json",
|
||||
"rules": {
|
||||
"adjacent-overload-signatures": false,
|
||||
"array-type": false,
|
||||
"ban-types": false,
|
||||
"callable-types": false,
|
||||
"dt-header": false,
|
||||
"interface-over-type-literal": false,
|
||||
"jsdoc-format": false,
|
||||
"max-line-length": false,
|
||||
"no-consecutive-blank-lines": false,
|
||||
"no-duplicate-imports": false,
|
||||
"no-padding": false,
|
||||
"no-redundant-jsdoc": false,
|
||||
"no-redundant-jsdoc-2": false,
|
||||
"no-self-import": false,
|
||||
"no-unnecessary-generics": false,
|
||||
"prefer-const": false,
|
||||
"prefer-method-signature": false,
|
||||
"semicolon": false,
|
||||
"unified-signatures": false,
|
||||
"whitespace": false
|
||||
}
|
||||
}
|
||||
6
types/react-instantsearch-core/package.json
Normal file
6
types/react-instantsearch-core/package.json
Normal file
@ -0,0 +1,6 @@
|
||||
{
|
||||
"private": true,
|
||||
"dependencies": {
|
||||
"algoliasearch-helper": "^3.1.1"
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user