algoliasearch 5.0.0-beta.1 → 5.0.0-beta.10

package/dist/recommend/model/lookingSimilar.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lookingSimilar.d.ts","sourceRoot":"","sources":["../../../../recommend/model/lookingSimilar.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,mBAAmB,CAAC;IAE3B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,kBAAkB,CAAC,EAAE,cAAc,CAAC;CACrC,CAAC"}

package/dist/recommend/model/lookingSimilarModel.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Looking similar model.  This model recommends items that look similar to the item with the ID `objectID` based on image attributes in your index.
+ */
+export type LookingSimilarModel = 'looking-similar';
+//# sourceMappingURL=lookingSimilarModel.d.ts.map

package/dist/recommend/model/lookingSimilarModel.d.ts.map

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

package/dist/recommend/model/lookingSimilarQuery.d.ts

@@ -0,0 +1,4 @@
+import type { BaseRecommendRequest } from './baseRecommendRequest';
+import type { LookingSimilar } from './lookingSimilar';
+export type LookingSimilarQuery = BaseRecommendRequest & LookingSimilar;
+//# sourceMappingURL=lookingSimilarQuery.d.ts.map

package/dist/recommend/model/lookingSimilarQuery.d.ts.map

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

package/dist/recommend/model/matchLevel.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Whether the whole query string matches or only a part.
+ */
+export type MatchLevel = 'full' | 'none' | 'partial';
+//# sourceMappingURL=matchLevel.d.ts.map

package/dist/recommend/model/matchLevel.d.ts.map

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

package/dist/recommend/model/matchedGeoLocation.d.ts

@@ -0,0 +1,15 @@
+export type MatchedGeoLocation = {
+    /**
+     * Latitude of the matched location.
+     */
+    lat?: number;
+    /**
+     * Longitude of the matched location.
+     */
+    lng?: number;
+    /**
+     * Distance between the matched location and the search location (in meters).
+     */
+    distance?: number;
+};
+//# sourceMappingURL=matchedGeoLocation.d.ts.map

package/dist/recommend/model/matchedGeoLocation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchedGeoLocation.d.ts","sourceRoot":"","sources":["../../../../recommend/model/matchedGeoLocation.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/recommend/model/mode.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Search mode the index will use to query for results.  This setting only applies to indices, for which Algolia enabled NeuralSearch for you.
+ */
+export type Mode = 'keywordSearch' | 'neuralSearch';
+//# sourceMappingURL=mode.d.ts.map

package/dist/recommend/model/mode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mode.d.ts","sourceRoot":"","sources":["../../../../recommend/model/mode.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,eAAe,GAAG,cAAc,CAAC"}

package/dist/recommend/model/numericFilters.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Filter by numeric facets.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparsions are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`.
+ */
+export type NumericFilters = NumericFilters[] | string;
+//# sourceMappingURL=numericFilters.d.ts.map

package/dist/recommend/model/numericFilters.d.ts.map

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

package/dist/recommend/model/optionalFilters.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Filters to promote or demote records in the search results.  Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match.  - Optional filters don\'t work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don\'t work with numeric attributes.
+ */
+export type OptionalFilters = OptionalFilters[] | string;
+//# sourceMappingURL=optionalFilters.d.ts.map

package/dist/recommend/model/optionalFilters.d.ts.map

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

package/dist/recommend/model/paramsConsequence.d.ts

@@ -0,0 +1,19 @@
+import type { AutoFacetFilter } from './autoFacetFilter';
+/**
+ * Filter or boost recommendations matching a facet filter.
+ */
+export type ParamsConsequence = {
+    /**
+     * Filter recommendations that match or don\'t match the same `facet:facet_value` combination as the viewed item.
+     */
+    automaticFacetFilters?: AutoFacetFilter[];
+    /**
+     * Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
+     */
+    filters?: string;
+    /**
+     * Filters to promote or demote records in the search results.  Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. Matches with higher weights (`<score=N>`) rank before matches with lower weights. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match.
+     */
+    optionalFilters?: string[];
+};
+//# sourceMappingURL=paramsConsequence.d.ts.map

package/dist/recommend/model/paramsConsequence.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paramsConsequence.d.ts","sourceRoot":"","sources":["../../../../recommend/model/paramsConsequence.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,eAAe,EAAE,CAAC;IAE1C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;CAC5B,CAAC"}

package/dist/recommend/model/personalization.d.ts

@@ -0,0 +1,15 @@
+export type Personalization = {
+    /**
+     * The score of the filters.
+     */
+    filtersScore?: number;
+    /**
+     * The score of the ranking.
+     */
+    rankingScore?: number;
+    /**
+     * The score of the event.
+     */
+    score?: number;
+};
+//# sourceMappingURL=personalization.d.ts.map

package/dist/recommend/model/personalization.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"personalization.d.ts","sourceRoot":"","sources":["../../../../recommend/model/personalization.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/recommend/model/promoteConsequenceObject.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Object ID and position of the recommendation you want to pin.
+ */
+export type PromoteConsequenceObject = {
+    /**
+     * Unique record identifier.
+     */
+    objectID?: string;
+    /**
+     * Index in the list of recommendations where to place this item.
+     */
+    position?: number;
+};
+//# sourceMappingURL=promoteConsequenceObject.d.ts.map

package/dist/recommend/model/promoteConsequenceObject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promoteConsequenceObject.d.ts","sourceRoot":"","sources":["../../../../recommend/model/promoteConsequenceObject.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/recommend/model/queryType.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Determines if and how query words are interpreted as prefixes.  By default, only the last query word is treated as prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower.  For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
+ */
+export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
+//# sourceMappingURL=queryType.d.ts.map

package/dist/recommend/model/queryType.d.ts.map

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

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

@@ -0,0 +1,54 @@
+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/recommend/model/rankingInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rankingInfo.d.ts","sourceRoot":"","sources":["../../../../recommend/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,CAAC,EAAE,MAAM,CAAC;IAEjB;;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,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC"}

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

@@ -0,0 +1,5 @@
+/**
+ * Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
+ */
+export type ReRankingApplyFilter = ReRankingApplyFilter[] | string;
+//# sourceMappingURL=reRankingApplyFilter.d.ts.map

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

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

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

@@ -0,0 +1,27 @@
+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/recommend/model/recommendHit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recommendHit.d.ts","sourceRoot":"","sources":["../../../../recommend/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/recommend/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/recommend/model/recommendModels.d.ts.map

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

package/dist/recommend/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/recommend/model/recommendRule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recommendRule.d.ts","sourceRoot":"","sources":["../../../../recommend/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/recommend/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/recommend/model/recommendRuleMetadata.d.ts.map

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

package/dist/recommend/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/recommend/model/recommendationsHit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recommendationsHit.d.ts","sourceRoot":"","sources":["../../../../recommend/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/recommend/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/recommend/model/recommendationsHits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recommendationsHits.d.ts","sourceRoot":"","sources":["../../../../recommend/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/recommend/model/recommendationsRequest.d.ts

@@ -0,0 +1,8 @@
+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/recommend/model/recommendationsRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recommendationsRequest.d.ts","sourceRoot":"","sources":["../../../../recommend/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/recommend/model/recommendationsResults.d.ts

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

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

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

package/dist/recommend/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/recommend/model/recommendedForYou.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recommendedForYou.d.ts","sourceRoot":"","sources":["../../../../recommend/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/recommend/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/recommend/model/recommendedForYouModel.d.ts.map

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

package/dist/recommend/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/recommend/model/recommendedForYouQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recommendedForYouQuery.d.ts","sourceRoot":"","sources":["../../../../recommend/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/recommend/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/), this this parameter is for internal use only.
+ */
+export type Redirect = {
+    index?: RedirectRuleIndexMetadata[];
+};
+//# sourceMappingURL=redirect.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"redirect.d.ts","sourceRoot":"","sources":["../../../../recommend/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/recommend/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/recommend/model/redirectRuleIndexMetadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"redirectRuleIndexMetadata.d.ts","sourceRoot":"","sources":["../../../../recommend/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/recommend/model/redirectRuleIndexMetadataData.d.ts

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

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

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

package/dist/recommend/model/redirectURL.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The redirect rule container.
+ */
+export type RedirectURL = {
+    url?: string;
+};
+//# sourceMappingURL=redirectURL.d.ts.map

package/dist/recommend/model/redirectURL.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"redirectURL.d.ts","sourceRoot":"","sources":["../../../../recommend/model/redirectURL.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/recommend/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/recommend/model/relatedModel.d.ts.map

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

package/dist/recommend/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/recommend/model/relatedProducts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relatedProducts.d.ts","sourceRoot":"","sources":["../../../../recommend/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/recommend/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/recommend/model/relatedQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relatedQuery.d.ts","sourceRoot":"","sources":["../../../../recommend/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/recommend/model/removeStopWords.d.ts

@@ -0,0 +1,6 @@
+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/recommend/model/removeStopWords.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"removeStopWords.d.ts","sourceRoot":"","sources":["../../../../recommend/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/recommend/model/removeWordsIfNoResults.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 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/recommend/model/removeWordsIfNoResults.d.ts.map

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

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

@@ -0,0 +1,10 @@
+import type { FacetOrdering } from './facetOrdering';
+import type { RedirectURL } from './redirectURL';
+/**
+ * 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;
+    redirect?: RedirectURL;
+};
+//# sourceMappingURL=renderingContent.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"renderingContent.d.ts","sourceRoot":"","sources":["../../../../recommend/model/renderingContent.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B,QAAQ,CAAC,EAAE,WAAW,CAAC;CACxB,CAAC"}

package/dist/recommend/model/searchPagination.d.ts

@@ -0,0 +1,19 @@
+export type SearchPagination = {
+    /**
+     * Page of search results to retrieve.
+     */
+    page: number;
+    /**
+     * Number of results (hits).
+     */
+    nbHits: number;
+    /**
+     * Number of pages of results.
+     */
+    nbPages: number;
+    /**
+     * Number of hits per page.
+     */
+    hitsPerPage: number;
+};
+//# sourceMappingURL=searchPagination.d.ts.map

package/dist/recommend/model/searchPagination.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchPagination.d.ts","sourceRoot":"","sources":["../../../../recommend/model/searchPagination.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC"}

package/dist/recommend/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/recommend/model/searchParams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchParams.d.ts","sourceRoot":"","sources":["../../../../recommend/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/recommend/model/searchParamsObject.d.ts

@@ -0,0 +1,7 @@
+import type { BaseSearchParams } from './baseSearchParams';
+import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+/**
+ * Each parameter value, including the `query` must not be larger than 512 bytes.
+ */
+export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
+//# sourceMappingURL=searchParamsObject.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"searchParamsObject.d.ts","sourceRoot":"","sources":["../../../../recommend/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;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG,2BAA2B,CAAC"}

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

@@ -0,0 +1,7 @@
+export type SearchParamsQuery = {
+    /**
+     * Search query.
+     */
+    query?: string;
+};
+//# sourceMappingURL=searchParamsQuery.d.ts.map

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

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