algolia / algoliasearch-client-javascript

⚡️ A fully-featured and blazing-fast JavaScript API client to interact with Algolia.
https://www.algolia.com/doc/api-client/javascript/getting-started/
MIT License
1.33k stars 221 forks source link

fix(recommend): only export default function #1514

Closed dhayab closed 5 months ago

dhayab commented 5 months ago

In #1512 I exported Recommend methods in addition to the existing default function export, to allow algoliasearch to import them in CJS.

This causes an issue as now there are multiple exports, which means recommend() cannot be accessed directly and is instead available from require('@algolia/recommend').default.

To prevent this, the Recommend methods are now augmenting the default function export.

[!NOTE] The existing version of api-extractor does not correctly resolve type imports, resulting in import('../xyz').Type statements with relative paths that are incorrect. I updated to the fixed version and went through all 22 type declaration files. There are no meaningful changes (in some cases type imports are aliased with a suffix to prevent conflicts, ie: import { Type as Type_2 } from '...', but all exports have the appropriate name, and now imports are properly resolved.

declare namespace recommend {
     var version: string;
-    var getFrequentlyBoughtTogether: (base: BaseRecommendClient) => <TObject>(queries: readonly Pick<import("../types").RecommendationsQuery, "queryParameters" | "objectID" | "indexName" | "threshold" | "maxRecommendations">[], requestOptions?: (import("../../../transporter/src").RequestOptions & import("../../../client-search/src").SearchOptions) | undefined) => Readonly<Promise<import("../types").RecommendQueriesResponse<TObject>>>;
+    var getFrequentlyBoughtTogether: (base: BaseRecommendClient) => <TObject>(queries: readonly Pick<RecommendationsQuery, "queryParameters" | "objectID" | "indexName" | "threshold" | "maxRecommendations">[], requestOptions?: (RequestOptions_2 & SearchOptions_2) | undefined) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;

-    var getRecommendations: (base: BaseRecommendClient) => <TObject>(queries: readonly (import("../types").RecommendationsQuery | (import("../types").TrendingItemsQuery & {
-        readonly model: import("../types").TrendingModel;
-    }) | (import("../types").TrendingFacetsQuery & {
-        readonly model: import("../types").TrendingModel;
-    }) | import("../types").RecommendedForYouQuery)[], requestOptions?: (import("../../../transporter/src").RequestOptions & import("../../../client-search/src").SearchOptions) | undefined) => Readonly<Promise<import("../types").RecommendQueriesResponse<TObject>>>;
+    var getRecommendations: (base: BaseRecommendClient) => <TObject>(queries: readonly (RecommendationsQuery | (TrendingItemsQuery & {
+        readonly model: TrendingModel;
+    }) | (TrendingFacetsQuery & {
+        readonly model: TrendingModel;
+    }) | RecommendedForYouQuery)[], requestOptions?: (RequestOptions_2 & SearchOptions_2) | undefined) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;

-    var getRelatedProducts: (base: BaseRecommendClient) => <TObject>(queries: readonly Pick<import("../types").RecommendationsQuery, "queryParameters" | "objectID" | "indexName" | "threshold" | "maxRecommendations" | "fallbackParameters">[], requestOptions?: (import("../../../transporter/src").RequestOptions & import("../../../client-search/src").SearchOptions) | undefined) => Readonly<Promise<import("../types").RecommendQueriesResponse<TObject>>>;
+    var getRelatedProducts: (base: BaseRecommendClient) => <TObject>(queries: readonly Pick<RecommendationsQuery, "queryParameters" | "objectID" | "indexName" | "threshold" | "maxRecommendations" | "fallbackParameters">[], requestOptions?: (RequestOptions_2 & SearchOptions_2) | undefined) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;

-    var getTrendingFacets: (base: BaseRecommendClient) => <TObject>(queries: readonly import("../types").TrendingFacetsQuery[], requestOptions?: (import("../../../transporter/src").RequestOptions & import("../../../client-search/src").SearchOptions) | undefined) => Readonly<Promise<import("../types").RecommendTrendingFacetsQueriesResponse>>;
+    var getTrendingFacets: (base: BaseRecommendClient) => <TObject>(queries: readonly TrendingFacetsQuery[], requestOptions?: (RequestOptions_2 & SearchOptions_2) | undefined) => Readonly<Promise<RecommendTrendingFacetsQueriesResponse>>;

-    var getTrendingItems: (base: BaseRecommendClient) => <TObject>(queries: readonly import("../types").TrendingItemsQuery[], requestOptions?: (import("../../../transporter/src").RequestOptions & import("../../../client-search/src").SearchOptions) | undefined) => Readonly<Promise<import("../types").RecommendQueriesResponse<TObject>>>;
+    var getTrendingItems: (base: BaseRecommendClient) => <TObject>(queries: readonly TrendingItemsQuery[], requestOptions?: (RequestOptions_2 & SearchOptions_2) | undefined) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;

-    var getLookingSimilar: (base: BaseRecommendClient) => <TObject>(queries: readonly Pick<import("../types").RecommendationsQuery, "queryParameters" | "objectID" | "indexName" | "threshold" | "maxRecommendations" | "fallbackParameters">[], requestOptions?: (import("../../../transporter/src").RequestOptions & import("../../../client-search/src").SearchOptions) | undefined) => Readonly<Promise<import("../types").RecommendQueriesResponse<TObject>>>;
+    var getLookingSimilar: (base: BaseRecommendClient) => <TObject>(queries: readonly Pick<RecommendationsQuery, "queryParameters" | "objectID" | "indexName" | "threshold" | "maxRecommendations" | "fallbackParameters">[], requestOptions?: (RequestOptions_2 & SearchOptions_2) | undefined) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;

-    var getRecommendedForYou: (base: BaseRecommendClient) => <TObject>(queries: readonly Pick<import("../types").RecommendedForYouQuery, "queryParameters" | "indexName" | "threshold" | "maxRecommendations" | "fallbackParameters">[], requestOptions?: (import("../../../transporter/src").RequestOptions & import("../../../client-search/src").SearchOptions) | undefined) => Readonly<Promise<import("../types").RecommendQueriesResponse<TObject>>>;
+    var getRecommendedForYou: (base: BaseRecommendClient) => <TObject>(queries: readonly Pick<RecommendedForYouQuery, "queryParameters" | "indexName" | "threshold" | "maxRecommendations" | "fallbackParameters">[], requestOptions?: (RequestOptions_2 & SearchOptions_2) | undefined) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
}

Tests on the built bundles are also added to catch this in CI.

Fixes #1515

Haroenv commented 5 months ago

This fixes https://github.com/algolia/algoliasearch-client-javascript/issues/1515 right?