typesense-instantsearch-adapter/index.d.ts at master · typesense/typesense-instantsearch-adapter · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
import type { SearchClient as AlgoliaSearchClient, CompositionClient } from "instantsearch.js";

type SearchClient = CompositionClient | AlgoliaSearchClient;

import type { ConfigurationOptions } from "typesense/lib/Typesense/Configuration";
import type { DocumentSchema, SearchParamsWithPreset } from "typesense/lib/Typesense/Documents";
import { default as TypesenseSearchClient } from "typesense/lib/Typesense/SearchClient";

interface BaseSearchParameters<T extends DocumentSchema, Infix extends string = string>
  extends Partial<Omit<SearchParamsWithPreset<T, Infix>, "q" | "filter_by">> {
  /**
   * @deprecated Please use the snake_cased version of this parameter
   */
  queryByWeights?: string;
  /**
   * @deprecated Please use the snake_cased version of this parameter
   */
  sortBy?: string;
  /**
   * @deprecated Please use the snake_cased version of this parameter
   */
  maxFacetValues?: number;
  /**
   * @deprecated Please use the snake_cased version of this parameter
   */
  perPage?: number;
  /**
   * @deprecated Please use the snake_cased version of this parameter
   */
  includeFields?: string;
  /**
   * @deprecated Please use the snake_cased version of this parameter
   */
  excludeFields?: string;
  /**
   * @deprecated Please use the snake_cased version of this parameter
   */
  highlightFields?: string;
  /**
   * @deprecated Please use the snake_cased version of this parameter
   */
  highlightFullFields?: string;
  /**
   * @deprecated Please use the snake_cased version of this parameter
   */
  numTypos?: string;
  /**
   * @deprecated Please use the snake_cased version of this parameter
   */
  typoTokensThreshold?: number;
  /**
   * @deprecated Please use the snake_cased version of this parameter
   */
  dropTokensThreshold?: number;
  /**
   * @deprecated Please use the snake_cased version of this parameter
   */
  pinnedHits?: string;
  /**
   * @deprecated Please use the snake_cased version of this parameter
   */
  hiddenHits?: string;
  /**
   * @deprecated Please use the snake_cased version of this parameter
   */
  enableOverrides?: boolean;
  /**
   * @deprecated Please use the snake_cased version of this parameter
   */
  preSegmentedQuery?: boolean;
  /**
   * @deprecated Please use the snake_cased version of this parameter
   */
  limitHits?: number;
  /**
   * @deprecated Please use the snake_cased version of this parameter
   */
  groupBy?: string;
  /**
   * @deprecated Please use the snake_cased version of this parameter
   */
  groupLimit?: number;
  /**
   * @deprecated Please use the snake_cased version of this parameter
   */
  exhaustiveSearch?: boolean;
}

interface BaseAdapterOptions {
  server: ConfigurationOptions;
  geoLocationField?: string;
  facetableFieldsWithSpecialCharacters?: string[];
  renderingContent?: object;
  flattenGroupedHits?: boolean;
  facetByOptions?: object;
  collectionSpecificFacetByOptions?: object;
  filterByOptions?: object;
  collectionSpecificFilterByOptions?: object;
  sortByOptions?: object;
  collectionSpecificSortByOptions?: object;
  /**
   * For Typesense versions before v30, set to true to use override_tags.
   * For v30+, leave as false (default) to use curation_tags.
   */
  useOverrideTags?: boolean;
  /**
   * Flips negative refinement encoding.
   * AND groups become `field:![a,b]`, OR groups become `field:!a || field:!b`.
   */
  flipNegativeRefinementOperator?: boolean;
}

type CollectionSearchParameters<Infix extends string = string> = Record<
  string,
  BaseSearchParameters<DocumentSchema, Infix>
>;

interface AdditionalSearchParametersWithQueryBy<T extends DocumentSchema, Infix extends string = string>
  extends BaseAdapterOptions {
  additionalSearchParameters: BaseSearchParameters<T, Infix>;
}

interface AdditionalSearchParametersOptionalQueryBy<T extends DocumentSchema, Infix extends string = string>
  extends BaseAdapterOptions {
  additionalSearchParameters?: BaseSearchParameters<T, Infix>;
}

interface CollectionSpecificSearchParametersWithQueryBy<Infix extends string = string> extends BaseAdapterOptions {
  collectionSpecificSearchParameters: CollectionSearchParameters<Infix>;
}

interface CollectionSpecificSearchParametersOptionalQueryBy<Infix extends string = string> extends BaseAdapterOptions {
  collectionSpecificSearchParameters?: CollectionSearchParameters<Infix>;
}

type AdapterOptionsWithQueryByInAdditionalSearchParameters<
  T extends DocumentSchema,
  Infix extends string = string,
> = AdditionalSearchParametersWithQueryBy<T, Infix> & CollectionSpecificSearchParametersOptionalQueryBy<Infix>;
type AdapterOptionWithQueryByInCollectionSpecificSearchParameters<
  T extends DocumentSchema,
  Infix extends string = string,
> = AdditionalSearchParametersOptionalQueryBy<T, Infix> & CollectionSpecificSearchParametersWithQueryBy<Infix>;

type TypesenseInstantsearchAdapterOptions<T extends DocumentSchema = DocumentSchema, Infix extends string = string> =
  | AdapterOptionWithQueryByInCollectionSpecificSearchParameters<T, Infix>
  | AdapterOptionsWithQueryByInAdditionalSearchParameters<T, Infix>;

export default class TypesenseInstantsearchAdapter<
  T extends DocumentSchema = DocumentSchema,
  Infix extends string = string,
> {
  readonly searchClient: SearchClient;
  readonly typesenseClient: TypesenseSearchClient;
  constructor(options: TypesenseInstantsearchAdapterOptions<T, Infix>);
  clearCache(): SearchClient;
  updateConfiguration(options: TypesenseInstantsearchAdapterOptions<T, Infix>): boolean;
}