@algolia/recommend 5.0.0-alpha.11 → 5.0.0-alpha.111

package/dist/model/rankingInfo.d.ts

@@ -1,51 +1,54 @@
-import type { MatchedGeoLocation } from './matchedGeoLocation';
-import type { Personalization } from './personalization';
-export declare 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.
-     */
-    promotedByReRanking?: boolean;
-};
+import type { MatchedGeoLocation } from './matchedGeoLocation';
+import type { Personalization } from './personalization';
+/**
+ * Object with detailed information about the record\'s ranking.
+ */
+export type RankingInfo = {
+    /**
+     * Whether a filter matched the query.
+     */
+    filters: number;
+    /**
+     * Position of the first matched word in the best matching attribute of the record.
+     */
+    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;
+    /**
+     * Whether the record was promoted by a rule.
+     */
+    promoted: boolean;
+    /**
+     * Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0.
+     */
+    proximityDistance?: number;
+    /**
+     * Overall ranking of the record, expressed as a single integer. This attribute is internal.
+     */
+    userScore: number;
+    /**
+     * Number of matched words.
+     */
+    words: number;
+    /**
+     * Whether the record is re-ranked.
+     */
+    promotedByReRanking?: boolean;
+};
 //# sourceMappingURL=rankingInfo.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"rankingInfo.d.ts","sourceRoot":"","sources":["../../model/rankingInfo.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAExC,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC"}
+{"version":3,"file":"rankingInfo.d.ts","sourceRoot":"","sources":["../../model/rankingInfo.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAExC,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC"}

package/dist/model/reRankingApplyFilter.d.ts

@@ -1,6 +1,6 @@
-import type { MixedSearchFilters } from './mixedSearchFilters';
-/**
- * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
- */
-export declare type ReRankingApplyFilter = MixedSearchFilters[] | string;
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * Restrict [Dynamic Re-ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
+ */
+export type ReRankingApplyFilter = MixedSearchFilters[] | string;
 //# sourceMappingURL=reRankingApplyFilter.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"reRankingApplyFilter.d.ts","sourceRoot":"","sources":["../../model/reRankingApplyFilter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,oBAAY,oBAAoB,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}
+{"version":3,"file":"reRankingApplyFilter.d.ts","sourceRoot":"","sources":["../../model/reRankingApplyFilter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}

package/dist/model/recommendHit.d.ts

@@ -1,27 +1,27 @@
-import type { HighlightResult } from './highlightResult';
-import type { RankingInfo } from './rankingInfo';
-import type { SnippetResult } from './snippetResult';
-/**
- * A Recommend hit.
- */
-export declare type RecommendHit = Record<string, any> & {
-    /**
-     * Unique identifier of the object.
-     */
-    objectID: string;
-    /**
-     * Show highlighted section and words matched on a query.
-     */
-    _highlightResult?: Record<string, HighlightResult>;
-    /**
-     * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
-     */
-    _snippetResult?: Record<string, SnippetResult>;
-    _rankingInfo?: RankingInfo;
-    _distinctSeqID?: number;
-    /**
-     * The recommendation score.
-     */
-    _score: number;
-};
+import type { HighlightResult } from './highlightResult';
+import type { RankingInfo } from './rankingInfo';
+import type { SnippetResult } from './snippetResult';
+/**
+ * Recommend hit.
+ */
+export type RecommendHit = Record<string, any> & {
+    /**
+     * Unique record identifier.
+     */
+    objectID: string;
+    /**
+     * Surround words that match the query with HTML tags for highlighting.
+     */
+    _highlightResult?: Record<string, HighlightResult>;
+    /**
+     * Snippets that show the context around a matching search query.
+     */
+    _snippetResult?: Record<string, SnippetResult>;
+    _rankingInfo?: RankingInfo;
+    _distinctSeqID?: number;
+    /**
+     * Recommendation score.
+     */
+    _score: number;
+};
 //# sourceMappingURL=recommendHit.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"recommendHit.d.ts","sourceRoot":"","sources":["../../model/recommendHit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;GAEG;AACH,oBAAY,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAC/C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAEnD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAE/C,YAAY,CAAC,EAAE,WAAW,CAAC;IAE3B,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"recommendHit.d.ts","sourceRoot":"","sources":["../../model/recommendHit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAC/C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAEnD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAE/C,YAAY,CAAC,EAAE,WAAW,CAAC;IAE3B,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/model/recommendModels.d.ts

@@ -0,0 +1,2 @@
+export type RecommendModels = 'bought-together' | 'related-products' | 'trending-facets' | 'trending-items';
+//# sourceMappingURL=recommendModels.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recommendModels.d.ts","sourceRoot":"","sources":["../../model/recommendModels.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,eAAe,GACvB,iBAAiB,GACjB,kBAAkB,GAClB,iBAAiB,GACjB,gBAAgB,CAAC"}

package/dist/model/recommendRule.d.ts

@@ -0,0 +1,24 @@
+import type { Condition } from './condition';
+import type { Consequence } from './consequence';
+import type { RecommendRuleMetadata } from './recommendRuleMetadata';
+/**
+ * Recommend rule.
+ */
+export type RecommendRule = {
+    _metadata?: RecommendRuleMetadata;
+    /**
+     * Unique identifier of a rule object.
+     */
+    objectID?: string;
+    condition?: Condition;
+    consequence?: Consequence;
+    /**
+     * Description of the rule\'s purpose. This can be helpful for display in the Algolia dashboard.
+     */
+    description?: string;
+    /**
+     * Indicates whether to enable the rule. If it isn\'t enabled, it isn\'t applied at query time.
+     */
+    enabled?: boolean;
+};
+//# sourceMappingURL=recommendRule.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recommendRule.d.ts","sourceRoot":"","sources":["../../model/recommendRule.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}

package/dist/model/recommendRuleMetadata.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Rule metadata.
+ */
+export type RecommendRuleMetadata = {
+    /**
+     * Date and time when the object was updated, in RFC 3339 format.
+     */
+    lastUpdate?: string;
+};
+//# sourceMappingURL=recommendRuleMetadata.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recommendRuleMetadata.d.ts","sourceRoot":"","sources":["../../model/recommendRuleMetadata.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC"}

package/dist/model/recommendationsHit.d.ts

@@ -0,0 +1,4 @@
+import type { RecommendHit } from './recommendHit';
+import type { TrendingFacetHit } from './trendingFacetHit';
+export type RecommendationsHit = RecommendHit | TrendingFacetHit;
+//# sourceMappingURL=recommendationsHit.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recommendationsHit.d.ts","sourceRoot":"","sources":["../../model/recommendationsHit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG,gBAAgB,CAAC"}

package/dist/model/recommendationsHits.d.ts

@@ -0,0 +1,5 @@
+import type { RecommendationsHit } from './recommendationsHit';
+export type RecommendationsHits = {
+    hits: RecommendationsHit[];
+};
+//# sourceMappingURL=recommendationsHits.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recommendationsHits.d.ts","sourceRoot":"","sources":["../../model/recommendationsHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,kBAAkB,EAAE,CAAC;CAC5B,CAAC"}

package/dist/model/recommendationsRequest.d.ts

@@ -1,4 +1,8 @@
-import type { RecommendationRequest } from './recommendationRequest';
-import type { TrendingRequest } from './trendingRequest';
-export declare type RecommendationsRequest = RecommendationRequest | TrendingRequest;
+import type { BoughtTogetherQuery } from './boughtTogetherQuery';
+import type { LookingSimilarQuery } from './lookingSimilarQuery';
+import type { RecommendedForYouQuery } from './recommendedForYouQuery';
+import type { RelatedQuery } from './relatedQuery';
+import type { TrendingFacetsQuery } from './trendingFacetsQuery';
+import type { TrendingItemsQuery } from './trendingItemsQuery';
+export type RecommendationsRequest = BoughtTogetherQuery | LookingSimilarQuery | RecommendedForYouQuery | RelatedQuery | TrendingFacetsQuery | TrendingItemsQuery;
 //# sourceMappingURL=recommendationsRequest.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"recommendationsRequest.d.ts","sourceRoot":"","sources":["../../model/recommendationsRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,sBAAsB,GAAG,qBAAqB,GAAG,eAAe,CAAC"}
+{"version":3,"file":"recommendationsRequest.d.ts","sourceRoot":"","sources":["../../model/recommendationsRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,sBAAsB,GAC9B,mBAAmB,GACnB,mBAAmB,GACnB,sBAAsB,GACtB,YAAY,GACZ,mBAAmB,GACnB,kBAAkB,CAAC"}

package/dist/model/recommendationsResults.d.ts

@@ -0,0 +1,4 @@
+import type { BaseSearchResponse } from './baseSearchResponse';
+import type { RecommendationsHits } from './recommendationsHits';
+export type RecommendationsResults = BaseSearchResponse & RecommendationsHits;
+//# sourceMappingURL=recommendationsResults.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recommendationsResults.d.ts","sourceRoot":"","sources":["../../model/recommendationsResults.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,sBAAsB,GAAG,kBAAkB,GAAG,mBAAmB,CAAC"}

package/dist/model/recommendedForYou.d.ts

@@ -0,0 +1,7 @@
+import type { FallbackParams } from './fallbackParams';
+import type { RecommendedForYouModel } from './recommendedForYouModel';
+export type RecommendedForYou = {
+    model: RecommendedForYouModel;
+    fallbackParameters?: FallbackParams;
+};
+//# sourceMappingURL=recommendedForYou.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recommendedForYou.d.ts","sourceRoot":"","sources":["../../model/recommendedForYou.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,sBAAsB,CAAC;IAE9B,kBAAkB,CAAC,EAAE,cAAc,CAAC;CACrC,CAAC"}

package/dist/model/recommendedForYouModel.d.ts

@@ -0,0 +1,5 @@
+/**
+ * \"Recommened for you\" model.
+ */
+export type RecommendedForYouModel = 'recommended-for-you';
+//# sourceMappingURL=recommendedForYouModel.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recommendedForYouModel.d.ts","sourceRoot":"","sources":["../../model/recommendedForYouModel.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,qBAAqB,CAAC"}

package/dist/model/recommendedForYouQuery.d.ts

@@ -0,0 +1,4 @@
+import type { BaseRecommendRequest } from './baseRecommendRequest';
+import type { RecommendedForYou } from './recommendedForYou';
+export type RecommendedForYouQuery = BaseRecommendRequest & RecommendedForYou;
+//# sourceMappingURL=recommendedForYouQuery.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recommendedForYouQuery.d.ts","sourceRoot":"","sources":["../../model/recommendedForYouQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,MAAM,MAAM,sBAAsB,GAAG,oBAAoB,GAAG,iBAAiB,CAAC"}

package/dist/model/redirect.d.ts

@@ -0,0 +1,8 @@
+import type { RedirectRuleIndexMetadata } from './redirectRuleIndexMetadata';
+/**
+ * [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/).
+ */
+export type Redirect = {
+    index?: RedirectRuleIndexMetadata[];
+};
+//# sourceMappingURL=redirect.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"redirect.d.ts","sourceRoot":"","sources":["../../model/redirect.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAE7E;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,KAAK,CAAC,EAAE,yBAAyB,EAAE,CAAC;CACrC,CAAC"}

package/dist/model/redirectRuleIndexMetadata.d.ts

@@ -0,0 +1,21 @@
+import type { RedirectRuleIndexMetadataData } from './redirectRuleIndexMetadataData';
+export type RedirectRuleIndexMetadata = {
+    /**
+     * Source index for the redirect rule.
+     */
+    source: string;
+    /**
+     * Destination index for the redirect rule.
+     */
+    dest: string;
+    /**
+     * Reason for the redirect rule.
+     */
+    reason: string;
+    /**
+     * Redirect rule status.
+     */
+    succeed: boolean;
+    data: RedirectRuleIndexMetadataData;
+};
+//# sourceMappingURL=redirectRuleIndexMetadata.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"redirectRuleIndexMetadata.d.ts","sourceRoot":"","sources":["../../model/redirectRuleIndexMetadata.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAErF,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB,IAAI,EAAE,6BAA6B,CAAC;CACrC,CAAC"}

package/dist/model/redirectRuleIndexMetadataData.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Redirect rule data.
+ */
+export type RedirectRuleIndexMetadataData = {
+    ruleObjectID: string;
+};
+//# sourceMappingURL=redirectRuleIndexMetadataData.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"redirectRuleIndexMetadataData.d.ts","sourceRoot":"","sources":["../../model/redirectRuleIndexMetadataData.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC"}

package/dist/model/relatedModel.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Related products or similar content model.  This model recommends items that are similar to the item with the ID `objectID`. Similarity is determined from the user interactions and attributes.
+ */
+export type RelatedModel = 'related-products';
+//# sourceMappingURL=relatedModel.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"relatedModel.d.ts","sourceRoot":"","sources":["../../model/relatedModel.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,kBAAkB,CAAC"}

package/dist/model/relatedProducts.d.ts

@@ -0,0 +1,11 @@
+import type { FallbackParams } from './fallbackParams';
+import type { RelatedModel } from './relatedModel';
+export type RelatedProducts = {
+    model: RelatedModel;
+    /**
+     * Unique record identifier.
+     */
+    objectID: string;
+    fallbackParameters?: FallbackParams;
+};
+//# sourceMappingURL=relatedProducts.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"relatedProducts.d.ts","sourceRoot":"","sources":["../../model/relatedProducts.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,EAAE,YAAY,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,kBAAkB,CAAC,EAAE,cAAc,CAAC;CACrC,CAAC"}

package/dist/model/relatedQuery.d.ts

@@ -0,0 +1,4 @@
+import type { BaseRecommendRequest } from './baseRecommendRequest';
+import type { RelatedProducts } from './relatedProducts';
+export type RelatedQuery = BaseRecommendRequest & RelatedProducts;
+//# sourceMappingURL=relatedQuery.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"relatedQuery.d.ts","sourceRoot":"","sources":["../../model/relatedQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,YAAY,GAAG,oBAAoB,GAAG,eAAe,CAAC"}

package/dist/model/removeStopWords.d.ts

@@ -1,5 +1,6 @@
-/**
- * Removes stop (common) words from the query before executing it. RemoveStopWords is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
- */
-export declare type RemoveStopWords = string[] | boolean;
+import type { SupportedLanguage } from './supportedLanguage';
+/**
+ * Removes stop words from the search query.  Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words.  You should only use this feature for the languages used in your index.
+ */
+export type RemoveStopWords = SupportedLanguage[] | boolean;
 //# sourceMappingURL=removeStopWords.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"removeStopWords.d.ts","sourceRoot":"","sources":["../../model/removeStopWords.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,eAAe,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC"}
+{"version":3,"file":"removeStopWords.d.ts","sourceRoot":"","sources":["../../model/removeStopWords.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,iBAAiB,EAAE,GAAG,OAAO,CAAC"}

package/dist/model/removeWordsIfNoResults.d.ts

@@ -1,5 +1,5 @@
-/**
- * Selects a strategy to remove words from the query when it doesn\'t match any hits.
- */
-export declare type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
+/**
+ * Strategy for removing words from the query when it doesn\'t return any results. This helps to avoid returning empty search results.  - `none`.   No words are removed when a query doesn\'t return results.  - `lastWords`.   Treat the last (then second to last, then third to last) word as optional,   until there are results or at most 5 words have been removed.  - `firstWords`.   Treat the first (then second, then third) word as optional,   until there are results or at most 5 words have been removed.  - `allOptional`.   Treat all words as optional.  For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/).
+ */
+export type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
 //# sourceMappingURL=removeWordsIfNoResults.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"removeWordsIfNoResults.d.ts","sourceRoot":"","sources":["../../model/removeWordsIfNoResults.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,sBAAsB,GAC9B,aAAa,GACb,YAAY,GACZ,WAAW,GACX,MAAM,CAAC"}
+{"version":3,"file":"removeWordsIfNoResults.d.ts","sourceRoot":"","sources":["../../model/removeWordsIfNoResults.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,aAAa,GACb,YAAY,GACZ,WAAW,GACX,MAAM,CAAC"}

package/dist/model/renderingContent.d.ts

@@ -1,8 +1,8 @@
-import type { FacetOrdering } from './facetOrdering';
-/**
- * Content defining how the search interface should be rendered. Can be set via the settings for a default value and can be overridden via rules.
- */
-export declare type RenderingContent = {
-    facetOrdering?: FacetOrdering;
-};
+import type { FacetOrdering } from './facetOrdering';
+/**
+ * Extra data that can be used in the search UI.  You can use this to control aspects of your search UI, such as, the order of facet names and values without changing your frontend code.
+ */
+export type RenderingContent = {
+    facetOrdering?: FacetOrdering;
+};
 //# sourceMappingURL=renderingContent.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"renderingContent.d.ts","sourceRoot":"","sources":["../../model/renderingContent.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC"}
+{"version":3,"file":"renderingContent.d.ts","sourceRoot":"","sources":["../../model/renderingContent.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC"}

package/dist/model/searchParams.d.ts

@@ -0,0 +1,3 @@
+import type { SearchParamsObject } from './searchParamsObject';
+export type SearchParams = Record<string, any> & SearchParamsObject;
+//# sourceMappingURL=searchParams.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"searchParams.d.ts","sourceRoot":"","sources":["../../model/searchParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,kBAAkB,CAAC"}

package/dist/model/searchParamsObject.d.ts

@@ -1,4 +1,4 @@
-import type { BaseSearchParams } from './baseSearchParams';
-import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
-export declare type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
+import type { BaseSearchParams } from './baseSearchParams';
+import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
 //# sourceMappingURL=searchParamsObject.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchParamsObject.d.ts","sourceRoot":"","sources":["../../model/searchParamsObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEjF,oBAAY,kBAAkB,GAAG,gBAAgB,GAAG,2BAA2B,CAAC"}
+{"version":3,"file":"searchParamsObject.d.ts","sourceRoot":"","sources":["../../model/searchParamsObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEjF,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG,2BAA2B,CAAC"}

package/dist/model/searchParamsQuery.d.ts

@@ -1,7 +1,7 @@
-export declare type SearchParamsQuery = {
-    /**
-     * The text to search in the index.
-     */
-    query?: string;
-};
+export type SearchParamsQuery = {
+    /**
+     * Search query.
+     */
+    query?: string;
+};
 //# sourceMappingURL=searchParamsQuery.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchParamsQuery.d.ts","sourceRoot":"","sources":["../../model/searchParamsQuery.ts"],"names":[],"mappings":"AAEA,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"searchParamsQuery.d.ts","sourceRoot":"","sources":["../../model/searchParamsQuery.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/model/searchRecommendRulesParams.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Recommend rules parameters.
+ */
+export type SearchRecommendRulesParams = {
+    /**
+     * Search query.
+     */
+    query?: string;
+    /**
+     * Only search for rules with matching context.
+     */
+    context?: string;
+    /**
+     * Requested page of the API response.
+     */
+    page?: number;
+    /**
+     * Maximum number of hits per page.
+     */
+    hitsPerPage?: number;
+    /**
+     * Whether to only show rules where the value of their `enabled` property matches this parameter. If absent, show all rules, regardless of their `enabled` property.
+     */
+    enabled?: boolean;
+    /**
+     * Filter expression. This only searches for rules matching the filter expression.
+     */
+    filters?: string;
+    /**
+     * Include facets and facet values in the response. Use `[\'*\']` to include all facets.
+     */
+    facets?: string[];
+    /**
+     * Maximum number of values to return for each facet.
+     */
+    maxValuesPerFacet?: number;
+};
+//# sourceMappingURL=searchRecommendRulesParams.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"searchRecommendRulesParams.d.ts","sourceRoot":"","sources":["../../model/searchRecommendRulesParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC"}

package/dist/model/searchRecommendRulesResponse.d.ts

@@ -0,0 +1,20 @@
+import type { RecommendRule } from './recommendRule';
+export type SearchRecommendRulesResponse = {
+    /**
+     * Recommend rules that match the search criteria.
+     */
+    hits: RecommendRule[];
+    /**
+     * Number of results (hits).
+     */
+    nbHits: number;
+    /**
+     * Page of search results to retrieve.
+     */
+    page: number;
+    /**
+     * Number of pages of results.
+     */
+    nbPages: number;
+};
+//# sourceMappingURL=searchRecommendRulesResponse.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"searchRecommendRulesResponse.d.ts","sourceRoot":"","sources":["../../model/searchRecommendRulesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,IAAI,EAAE,aAAa,EAAE,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/model/semanticSearch.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`.
+ */
+export type SemanticSearch = {
+    /**
+     * Indices from which to collect click and conversion events.  If null, the current index and all its replicas are used.
+     */
+    eventSources?: string[] | null;
+};
+//# sourceMappingURL=semanticSearch.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"semanticSearch.d.ts","sourceRoot":"","sources":["../../model/semanticSearch.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAChC,CAAC"}

package/dist/model/snippetResult.d.ts

@@ -1,3 +1,3 @@
-import type { SnippetResultOption } from './snippetResultOption';
-export declare type SnippetResult = SnippetResultOption | SnippetResultOption[];
+import type { SnippetResultOption } from './snippetResultOption';
+export type SnippetResult = Record<string, SnippetResultOption> | SnippetResultOption | SnippetResultOption[];
 //# sourceMappingURL=snippetResult.d.ts.map