@algolia/client-search 5.0.0-alpha.2 → 5.0.0-alpha.5

package/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/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/model/saveObjectResponse.ts

@@ -1,11 +1,13 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
 export type SaveObjectResponse = {
-  createdAt?: string;
+  createdAt: string;
+
   /**
    * TaskID of the task to wait for.
    */
-  taskID?: number;
+  taskID: number;
+
   /**
    * Unique identifier of the object.
    */

package/model/saveSynonymResponse.ts

@@ -5,10 +5,12 @@ export type SaveSynonymResponse = {
    * TaskID of the task to wait for.
    */
   taskID: number;
+
   /**
    * Date of last update (ISO-8601 format).
    */
   updatedAt: string;
+
   /**
    * ObjectID of the inserted object.
    */

package/model/searchDictionaryEntriesParams.ts

@@ -8,14 +8,17 @@ export type SearchDictionaryEntriesParams = {
    * The text to search in the index.
    */
   query: string;
+
   /**
    * Specify the page to retrieve.
    */
   page?: number;
+
   /**
    * Set the number of hits per page.
    */
   hitsPerPage?: number;
+
   /**
    * Language ISO code supported by the dictionary (e.g., \"en\" for English).
    */

package/model/searchForFacetValuesRequest.ts

@@ -5,10 +5,12 @@ export type SearchForFacetValuesRequest = {
    * Search parameters as URL-encoded query string.
    */
   params?: 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.
    */

package/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/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/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/model/searchMethodParams.ts

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

package/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/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/model/searchRulesParams.ts

@@ -10,23 +10,29 @@ export type SearchRulesParams = {
    * Full text query.
    */
   query?: string;
+
   anchoring?: Anchoring;
+
   /**
    * Restricts matches to contextual rules with a specific context (exact match).
    */
   context?: string;
+
   /**
    * Requested page (zero-based).
    */
   page?: number;
+
   /**
    * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
    */
   hitsPerPage?: number;
+
   /**
    * When specified, restricts matches to rules with a specific enabled status. When absent (default), all rules are retrieved, regardless of their enabled status.
    */
   enabled?: boolean;
+
   /**
    * A mapping of requestOptions to send along with the request.
    */

package/model/searchRulesResponse.ts

@@ -7,14 +7,17 @@ export type SearchRulesResponse = {
    * Fetched rules.
    */
   hits: Rule[];
+
   /**
    * Number of fetched rules.
    */
   nbHits: number;
+
   /**
    * Current page.
    */
   page: number;
+
   /**
    * Number of pages.
    */

package/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/model/searchUserIdsParams.ts

@@ -8,14 +8,17 @@ export type SearchUserIdsParams = {
    * Query to search. The search is a prefix search with typoTolerance. Use empty query to retrieve all users.
    */
   query: string;
+
   /**
    * Name of the cluster.
    */
   clusterName?: string;
+
   /**
    * Specify the page to retrieve.
    */
   page?: number;
+
   /**
    * Set the number of hits per page.
    */

package/model/searchUserIdsResponse.ts

@@ -10,18 +10,22 @@ export type SearchUserIdsResponse = {
    * List of user object matching the query.
    */
   hits: UserHit[];
+
   /**
    * Number of hits that the search query matched.
    */
   nbHits: number;
+
   /**
    * Specify the page to retrieve.
    */
   page: number;
+
   /**
    * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
    */
   hitsPerPage: number;
+
   /**
    * Date of last update (ISO-8601 format).
    */

package/model/snippetResultOption.ts

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

package/model/source.ts

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

package/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/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/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/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/model/updateApiKeyResponse.ts

@@ -2,9 +2,10 @@
 
 export type UpdateApiKeyResponse = {
   /**
-   * Key string.
+   * The API key.
    */
   key: string;
+
   /**
    * Date of last update (ISO-8601 format).
    */

package/model/updatedAtResponse.ts

@@ -8,6 +8,7 @@ export type UpdatedAtResponse = {
    * TaskID of the task to wait for.
    */
   taskID: number;
+
   /**
    * Date of last update (ISO-8601 format).
    */

package/model/updatedAtWithObjectIdResponse.ts

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

package/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/model/userHighlightResult.ts

@@ -7,6 +7,7 @@ export type UserHighlightResult = {
    * Show highlighted section and words matched on a query.
    */
   userID: Record<string, HighlightResult>;
+
   /**
    * Show highlighted section and words matched on a query.
    */

package/model/userHit.ts

@@ -7,21 +7,26 @@ export type UserHit = {
    * UserID of the user.
    */
   userID: string;
+
   /**
    * Name of the cluster.
    */
   clusterName: string;
+
   /**
    * Number of records in the cluster.
    */
   nbRecords: number;
+
   /**
    * Data size taken by all the users assigned to the cluster.
    */
   dataSize: number;
+
   /**
    * UserID of the requested user. Same as userID.
    */
   objectID: string;
+
   _highlightResult: UserHighlightResult;
 };

package/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/model/value.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-search",
-  "version": "5.0.0-alpha.2",
+  "version": "5.0.0-alpha.5",
   "description": "JavaScript client for client-search",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
@@ -21,12 +21,12 @@
     "clean": "rm -rf ./dist"
   },
   "dependencies": {
-    "@algolia/client-common": "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-common": "5.0.0-alpha.5",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.5",
+    "@algolia/requester-node-http": "5.0.0-alpha.5"
   },
   "devDependencies": {
-    "@types/node": "16.11.45",
+    "@types/node": "16.11.47",
     "typescript": "4.7.4"
   },
   "engines": {

package/dist/model/attributeOrBuiltInOperation.d.ts

@@ -1,3 +0,0 @@
-import type { BuiltInOperation } from './builtInOperation';
-export declare type AttributeOrBuiltInOperation = BuiltInOperation | string;
-//# sourceMappingURL=attributeOrBuiltInOperation.d.ts.map

package/dist/model/attributeOrBuiltInOperation.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"attributeOrBuiltInOperation.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/attributeOrBuiltInOperation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,oBAAY,2BAA2B,GAAG,gBAAgB,GAAG,MAAM,CAAC"}

package/dist/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/model/createdAtObject.d.ts

@@ -1,7 +0,0 @@
-export declare type CreatedAtObject = {
-    /**
-     * Date of creation (ISO-8601 format).
-     */
-    createdAt: string;
-};
-//# sourceMappingURL=createdAtObject.d.ts.map

package/dist/model/createdAtObject.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"createdAtObject.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/createdAtObject.ts"],"names":[],"mappings":"AAEA,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/key.d.ts

@@ -1,4 +0,0 @@
-import type { ApiKey } from './apiKey';
-import type { CreatedAtObject } from './createdAtObject';
-export declare type Key = ApiKey & CreatedAtObject;
-//# sourceMappingURL=key.d.ts.map

package/dist/model/key.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"key.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/key.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,GAAG,GAAG,MAAM,GAAG,eAAe,CAAC"}

package/dist/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/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"}