algoliasearch 5.0.0-alpha.2 → 5.0.0-alpha.3

package/lite/model/rankingInfo.ts

@@ -8,44 +8,56 @@ export type RankingInfo = {
    * This field is reserved for advanced usage.
    */
   filters: number;
+
   /**
    * Position of the most important matched attribute in the attributes to index list.
    */
   firstMatchedWord: number;
+
   /**
    * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
    */
   geoDistance: number;
+
   /**
    * Precision used when computing the geo distance, in meters.
    */
   geoPrecision?: number;
+
   matchedGeoLocation?: MatchedGeoLocation;
+
   personalization?: Personalization;
+
   /**
    * Number of exactly matched words.
    */
   nbExactWords: number;
+
   /**
    * Number of typos encountered when matching the record.
    */
   nbTypos: number;
+
   /**
    * Present and set to true if a Rule promoted the hit.
    */
   promoted: boolean;
+
   /**
    * When the query contains more than one word, the sum of the distances between matched words (in meters).
    */
   proximityDistance?: number;
+
   /**
    * Custom ranking for the object, expressed as a single integer value.
    */
   userScore: number;
+
   /**
    * Number of matched words, including prefixes and typos.
    */
   words: number;
+
   /**
    * Wether the record are promoted by the re-ranking strategy.
    */

package/lite/model/rule.ts

@@ -12,19 +12,24 @@ export type Rule = {
    * Unique identifier of the object.
    */
   objectID: string;
+
   /**
    * A list of conditions that should apply to activate a Rule. You can use up to 25 conditions per Rule.
    */
   conditions?: Condition[];
+
   consequence?: Consequence;
+
   /**
    * This field is intended for Rule management purposes, in particular to ease searching for Rules and presenting them to human readers. It\'s not interpreted by the API.
    */
   description?: string;
+
   /**
    * Whether the Rule is enabled. Disabled Rules remain in the index, but aren\'t applied at query time.
    */
   enabled?: boolean;
+
   /**
    * By default, Rules are permanently valid. When validity periods are specified, the Rule applies only during those periods; it\'s ignored the rest of the time. The list must not be empty.
    */

package/lite/model/searchForFacetsOptions.ts

@@ -7,17 +7,21 @@ export type SearchForFacetsOptions = {
    * The `facet` name.
    */
   facet: string;
+
   /**
    * The Algolia index name.
    */
   indexName: string;
+
   /**
    * Text to search inside the facet\'s values.
    */
   facetQuery?: string;
+
   /**
    * Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.
    */
   maxFacetHits?: number;
+
   type: SearchTypeFacet;
 };

package/lite/model/searchForHitsOptions.ts

@@ -7,5 +7,6 @@ export type SearchForHitsOptions = {
    * The Algolia index name.
    */
   indexName: string;
+
   type?: SearchTypeDefault;
 } & { facet?: never; maxFacetHits?: never; facetQuery?: never };

package/lite/model/searchHits.ts

@@ -2,6 +2,6 @@
 
 import type { Hit } from './hit';
 
-export type SearchHits<T> = {
+export type SearchHits<T = Record<string, any>> = {
   hits: Array<Hit<T>>;
 };

package/lite/model/searchMethodParams.ts

@@ -5,5 +5,6 @@ import type { SearchStrategy } from './searchStrategy';
 
 export type SearchMethodParams = {
   requests: SearchQuery[];
+
   strategy?: SearchStrategy;
 };

package/lite/model/searchResponse.ts

@@ -3,4 +3,5 @@
 import type { BaseSearchResponse } from './baseSearchResponse';
 import type { SearchHits } from './searchHits';
 
-export type SearchResponse<T> = BaseSearchResponse & SearchHits<T>;
+export type SearchResponse<T = Record<string, any>> = BaseSearchResponse &
+  SearchHits<T>;

package/lite/model/searchResponses.ts

@@ -2,6 +2,6 @@
 
 import type { SearchResponse } from './searchResponse';
 
-export type SearchResponses<T> = {
+export type SearchResponses<T = Record<string, any>> = {
   results: Array<SearchResponse<T>>;
 };

package/lite/model/searchSynonymsResponse.ts

@@ -7,6 +7,7 @@ export type SearchSynonymsResponse = Record<string, any> & {
    * Array of synonym objects.
    */
   hits: SynonymHit[];
+
   /**
    * Number of hits that the search query matched.
    */

package/lite/model/snippetResultOption.ts

@@ -10,5 +10,6 @@ export type SnippetResultOption = {
    * Markup text with occurrences highlighted.
    */
   value: string;
+
   matchLevel: MatchLevel;
 };

package/lite/model/source.ts

@@ -8,6 +8,7 @@ export type Source = {
    * The IP range of the source.
    */
   source: string;
+
   /**
    * The description of the source.
    */

package/lite/model/standardEntries.ts

@@ -8,10 +8,12 @@ export type StandardEntries = {
    * Language ISO code.
    */
   plurals?: Record<string, boolean> | null;
+
   /**
    * Language ISO code.
    */
   stopwords?: Record<string, boolean> | null;
+
   /**
    * Language ISO code.
    */

package/lite/model/synonymHit.ts

@@ -11,30 +11,38 @@ export type SynonymHit = {
    * Unique identifier of the synonym object to be created or updated.
    */
   objectID: string;
+
   type: SynonymType;
+
   /**
    * Words or phrases to be considered equivalent.
    */
   synonyms?: string[];
+
   /**
    * Word or phrase to appear in query strings (for onewaysynonym).
    */
   input?: string;
+
   /**
    * Word or phrase to appear in query strings (for altcorrection1 and altcorrection2).
    */
   word?: string;
+
   /**
    * Words to be matched in records.
    */
   corrections?: string[];
+
   /**
    * Token to be put inside records.
    */
   placeholder?: string;
+
   /**
    * List of query words that will match the token.
    */
   replacements?: string[];
+
   _highlightResult?: SynonymHitHighlightResult;
 };

package/lite/model/synonymHitHighlightResult.ts

@@ -10,5 +10,6 @@ export type SynonymHitHighlightResult = {
    * Show highlighted section and words matched on a query.
    */
   type?: Record<string, HighlightResult>;
+
   synonyms?: Array<Record<string, HighlightResult>>;
 };

package/lite/model/timeRange.ts

@@ -5,6 +5,7 @@ export type TimeRange = {
    * Lower bound of the time range (Unix timestamp).
    */
   from: number;
+
   /**
    * Upper bound of the time range (Unix timestamp).
    */

package/lite/model/updatedRuleResponse.ts

@@ -5,10 +5,12 @@ export type UpdatedRuleResponse = {
    * Unique identifier of the object.
    */
   objectID: string;
+
   /**
    * Date of last update (ISO-8601 format).
    */
   updatedAt: string;
+
   /**
    * TaskID of the task to wait for.
    */

package/lite/model/userId.ts

@@ -8,14 +8,17 @@ export type UserId = {
    * UserID of the user.
    */
   userID: string;
+
   /**
    * Cluster on which the user is assigned.
    */
   clusterName: string;
+
   /**
    * Number of records belonging to the user.
    */
   nbRecords: number;
+
   /**
    * Data size used by the user.
    */

package/lite/model/value.ts

@@ -7,5 +7,6 @@ export type Value = {
    * Pinned order of facet lists.
    */
   order?: string[];
+
   sortRemainingBy?: SortRemainingBy;
 };

package/lite/src/liteClient.ts

@@ -22,7 +22,7 @@ import type {
 import type { SearchMethodParams } from '../model/searchMethodParams';
 import type { SearchResponses } from '../model/searchResponses';
 
-export const apiClientVersion = '5.0.0-alpha.2';
+export const apiClientVersion = '5.0.0-alpha.3';
 
 function getDefaultHosts(appId: string): Host[] {
   return (

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "algoliasearch",
-  "version": "5.0.0-alpha.2",
+  "version": "5.0.0-alpha.3",
   "description": "A fully-featured and blazing-fast JavaScript API client to interact with Algolia API.",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
@@ -58,13 +58,13 @@
     "test": "jest"
   },
   "dependencies": {
-    "@algolia/client-abtesting": "5.0.0-alpha.2",
-    "@algolia/client-analytics": "5.0.0-alpha.2",
-    "@algolia/client-common": "5.0.0-alpha.2",
-    "@algolia/client-personalization": "5.0.0-alpha.2",
-    "@algolia/client-search": "5.0.0-alpha.2",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.2",
-    "@algolia/requester-node-http": "5.0.0-alpha.2"
+    "@algolia/client-abtesting": "5.0.0-alpha.3",
+    "@algolia/client-analytics": "5.0.0-alpha.3",
+    "@algolia/client-common": "5.0.0-alpha.3",
+    "@algolia/client-personalization": "5.0.0-alpha.3",
+    "@algolia/client-search": "5.0.0-alpha.3",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.3",
+    "@algolia/requester-node-http": "5.0.0-alpha.3"
   },
   "devDependencies": {
     "@types/jest": "28.1.6",

package/dist/client-search/model/batchOperation.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"batchOperation.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/batchOperation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,oBAAY,cAAc,GAAG;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC"}

package/dist/client-search/model/multipleBatchOperation.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"multipleBatchOperation.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/multipleBatchOperation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,oBAAY,sBAAsB,GAAG;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}

package/dist/client-search/model/multipleGetObjectsParams.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"multipleGetObjectsParams.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/multipleGetObjectsParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,wBAAwB,GAAG;IACrC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}