+
@@ -88,4 +88,4 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
## 📄 License
-Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE.txt).
+Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).
diff --git a/package.json b/package.json
index c3297dd33..fbd9d2796 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
{
+ "version": "4.9.3",
"private": true,
"license": "MIT",
- "version": "4.9.3",
"workspaces": [
"packages/*"
],
@@ -98,11 +98,15 @@
"bundlesize": [
{
"path": "packages/algoliasearch/dist/algoliasearch.umd.js",
- "maxSize": "7.85KB"
+ "maxSize": "7.95KB"
},
{
"path": "packages/algoliasearch/dist/algoliasearch-lite.umd.js",
"maxSize": "4.35KB"
+ },
+ {
+ "path": "packages/recommend/dist/recommend.umd.js",
+ "maxSize": "4.1KB"
}
]
}
diff --git a/packages/algoliasearch/README.md b/packages/algoliasearch/README.md
index 3a9d10485..9e227e857 100644
--- a/packages/algoliasearch/README.md
+++ b/packages/algoliasearch/README.md
@@ -9,7 +9,7 @@
+
@@ -79,4 +79,4 @@ For full documentation, visit the **[online documentation](https://www.algolia.c
## 📄 License
-Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE.txt).
+Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).
diff --git a/packages/algoliasearch/package.json b/packages/algoliasearch/package.json
index d63721690..e9d6c354a 100644
--- a/packages/algoliasearch/package.json
+++ b/packages/algoliasearch/package.json
@@ -31,7 +31,7 @@
"@algolia/client-account": "4.9.3",
"@algolia/client-analytics": "4.9.3",
"@algolia/client-common": "4.9.3",
- "@algolia/client-recommendation": "4.9.3",
+ "@algolia/client-personalization": "4.9.3",
"@algolia/client-search": "4.9.3",
"@algolia/logger-common": "4.9.3",
"@algolia/logger-console": "4.9.3",
diff --git a/packages/algoliasearch/src/__tests__/default.test.ts b/packages/algoliasearch/src/__tests__/default.test.ts
index 3e37ab4b4..b86c866a0 100644
--- a/packages/algoliasearch/src/__tests__/default.test.ts
+++ b/packages/algoliasearch/src/__tests__/default.test.ts
@@ -83,7 +83,7 @@ describe('default preset', () => {
expect(client.transporter.requestsCache).not.toBe(cache);
expect(customClient.transporter.requestsCache).toBe(cache);
- expect(customClient.initRecommendation().transporter.requestsCache).not.toBe(cache);
+ expect(customClient.initPersonalization().transporter.requestsCache).not.toBe(cache);
expect(customClient.initAnalytics({ requestsCache: cache }).transporter.requestsCache).toBe(
cache
);
@@ -92,7 +92,7 @@ describe('default preset', () => {
read: 46,
write: 47,
});
- expect(customClient.initRecommendation().transporter.timeouts).toEqual({
+ expect(customClient.initPersonalization().transporter.timeouts).toEqual({
connect: testing.isBrowser() ? 1 : 2,
read: testing.isBrowser() ? 2 : 5,
write: 30,
@@ -110,7 +110,7 @@ describe('default preset', () => {
expect(customClient.transporter.hosts).toEqual([createStatelessHost({ url: 'foo.com' })]);
expect(customClient.initAnalytics().transporter.queryParameters).toEqual({});
- expect(customClient.initRecommendation().transporter.headers).toEqual({
+ expect(customClient.initPersonalization().transporter.headers).toEqual({
'content-type': 'application/json',
'x-algolia-application-id': 'appId',
'x-algolia-api-key': 'apiKey',
@@ -119,31 +119,31 @@ describe('default preset', () => {
createStatelessHost({ url: 'foo.com' }),
]);
- expect(customClient.initRecommendation().transporter.queryParameters).not.toEqual({
+ expect(customClient.initPersonalization().transporter.queryParameters).not.toEqual({
queryParameter: 'bar',
});
- expect(customClient.initRecommendation().transporter.headers).toEqual({
+ expect(customClient.initPersonalization().transporter.headers).toEqual({
'content-type': 'application/json',
'x-algolia-application-id': 'appId',
'x-algolia-api-key': 'apiKey',
});
- expect(customClient.initRecommendation().transporter.hosts).not.toEqual([
+ expect(customClient.initPersonalization().transporter.hosts).not.toEqual([
createStatelessHost({ url: 'foo.com' }),
]);
});
test('shared implementations between clients', () => {
const analytics = client.initAnalytics();
- const recommendation = client.initRecommendation();
+ const personalization = client.initPersonalization();
expect(analytics.transporter).not.toBe(client.transporter);
expect(analytics.transporter.hostsCache).toBe(client.transporter.hostsCache);
expect(analytics.transporter.userAgent).toBe(client.transporter.userAgent);
- expect(recommendation.transporter).not.toBe(client.transporter);
- expect(recommendation.transporter.hostsCache).toBe(client.transporter.hostsCache);
- expect(recommendation.transporter.userAgent).toBe(client.transporter.userAgent);
+ expect(personalization.transporter).not.toBe(client.transporter);
+ expect(personalization.transporter.hostsCache).toBe(client.transporter.hostsCache);
+ expect(personalization.transporter.userAgent).toBe(client.transporter.userAgent);
});
test('allows clients to override credentials', () => {
@@ -154,12 +154,12 @@ describe('default preset', () => {
const analytics = clientWithOptions.initAnalytics({
apiKey: 'analytics',
});
- const recommendation = clientWithOptions.initRecommendation({
- apiKey: 'recommendation',
+ const personalization = clientWithOptions.initPersonalization({
+ apiKey: 'personalization',
});
expect(analytics.transporter.headers['x-algolia-api-key']).toBe('analytics');
- expect(recommendation.transporter.headers['x-algolia-api-key']).toBe('recommendation');
+ expect(personalization.transporter.headers['x-algolia-api-key']).toBe('personalization');
});
test('allows clients to keep default credentials', () => {
@@ -168,10 +168,10 @@ describe('default preset', () => {
expect(clientWithOptions.transporter.headers['x-algolia-api-key']).toBe('apiKey');
const analytics = clientWithOptions.initAnalytics();
- const recommendation = clientWithOptions.initRecommendation();
+ const personalization = clientWithOptions.initPersonalization();
expect(analytics.transporter.headers['x-algolia-api-key']).toBe('apiKey');
- expect(recommendation.transporter.headers['x-algolia-api-key']).toBe('apiKey');
+ expect(personalization.transporter.headers['x-algolia-api-key']).toBe('apiKey');
});
it('can be destroyed', () => {
diff --git a/packages/algoliasearch/src/builds/browser.ts b/packages/algoliasearch/src/builds/browser.ts
index cb7bb484b..232fce240 100644
--- a/packages/algoliasearch/src/builds/browser.ts
+++ b/packages/algoliasearch/src/builds/browser.ts
@@ -19,14 +19,14 @@ import {
} from '@algolia/client-analytics';
import { version, WaitablePromise } from '@algolia/client-common';
import {
- createRecommendationClient,
+ createPersonalizationClient,
getPersonalizationStrategy,
GetPersonalizationStrategyResponse,
+ PersonalizationClient as BasePersonalizationClient,
PersonalizationStrategy,
- RecommendationClient as BaseRecommendationClient,
setPersonalizationStrategy,
SetPersonalizationStrategyResponse,
-} from '@algolia/client-recommendation';
+} from '@algolia/client-personalization';
import {
addApiKey,
AddApiKeyOptions,
@@ -192,7 +192,7 @@ import { createConsoleLogger } from '@algolia/logger-console';
import { createBrowserXhrRequester } from '@algolia/requester-browser-xhr';
import { createUserAgent, RequestOptions } from '@algolia/transporter';
-import { AlgoliaSearchOptions, InitAnalyticsOptions, InitRecommendationOptions } from '../types';
+import { AlgoliaSearchOptions, InitAnalyticsOptions, InitPersonalizationOptions } from '../types';
export default function algoliasearch(
appId: string,
@@ -219,10 +219,22 @@ export default function algoliasearch(
}),
userAgent: createUserAgent(version).add({ segment: 'Browser' }),
};
+ const searchClientOptions = { ...commonOptions, ...options };
+ const initPersonalization = () => (
+ clientOptions?: InitPersonalizationOptions
+ ): PersonalizationClient => {
+ return createPersonalizationClient({
+ ...commonOptions,
+ ...clientOptions,
+ methods: {
+ getPersonalizationStrategy,
+ setPersonalizationStrategy,
+ },
+ });
+ };
return createSearchClient({
- ...commonOptions,
- ...options,
+ ...searchClientOptions,
methods: {
search: multipleQueries,
searchForFacetValues: multipleSearchForFacetValues,
@@ -319,17 +331,15 @@ export default function algoliasearch(
},
});
},
+ initPersonalization,
initRecommendation: () => (
- clientOptions?: InitRecommendationOptions
- ): RecommendationClient => {
- return createRecommendationClient({
- ...commonOptions,
- ...clientOptions,
- methods: {
- getPersonalizationStrategy,
- setPersonalizationStrategy,
- },
- });
+ clientOptions?: InitPersonalizationOptions
+ ): PersonalizationClient => {
+ searchClientOptions.logger.info(
+ 'The `initRecommendation` method is deprecated. Use `initPersonalization` instead.'
+ );
+
+ return initPersonalization()(clientOptions);
},
},
});
@@ -338,7 +348,7 @@ export default function algoliasearch(
// eslint-disable-next-line functional/immutable-data
algoliasearch.version = version;
-export type RecommendationClient = BaseRecommendationClient & {
+export type PersonalizationClient = BasePersonalizationClient & {
readonly getPersonalizationStrategy: (
requestOptions?: RequestOptions
) => Readonly+
+ 
+
+
+ Documentation • + UI library • + Community Forum • + Stack Overflow • + Report a bug • + Support +
+ +## ✨ Features + +- Thin & **minimal low-level HTTP client** to interact with Algolia's Recommend API +- Works both on the **browser** and **node.js** +- **UMD compatible**, you can use it with any module loader +- Built with TypeScript + +## 💡 Getting Started + +First, install Algolia Recommend API Client via the [npm](https://www.npmjs.com/get-npm) package manager: + +```bash +npm install @algolia/recommend +``` + +Then, let's retrieve recommendations: + +```js +const algoliarecommend = require('@algolia/recommend'); + +const client = algoliarecommend('YourApplicationID', 'YourAdminAPIKey'); + +client + .getFrequentlyBoughtTogether({ + indexName: 'your_index_name', + objectID: 'your_object_id', + }) + .then(({ results }) => { + console.log(results); + }) + .catch(err => { + console.log(err); + }); + +client + .getRelatedProducts({ + indexName: 'your_index_name', + objectID: 'your_object_id', + }) + .then(({ results }) => { + console.log(results); + }) + .catch(err => { + console.log(err); + }); +``` + +For full documentation, visit the **[online documentation](https://www.algolia.com/doc/api-client/methods/recommend/)**. + +## 📄 License + +Algolia Recommend API Client is an open-sourced software licensed under the [MIT license](LICENSE.md). diff --git a/packages/recommend/api-extractor.json b/packages/recommend/api-extractor.json new file mode 100644 index 000000000..a522871c3 --- /dev/null +++ b/packages/recommend/api-extractor.json @@ -0,0 +1,7 @@ +{ + "extends": "../../api-extractor.json", + "mainEntryPointFilePath": "./dist/packages/recommend/src/builds/node.d.ts", + "dtsRollup": { + "untrimmedFilePath": "./dist/recommend.d.ts" + } +} diff --git a/packages/recommend/index.d.ts b/packages/recommend/index.d.ts new file mode 100644 index 000000000..70d1e5942 --- /dev/null +++ b/packages/recommend/index.d.ts @@ -0,0 +1,3 @@ +/* eslint-disable import/no-unresolved*/ +export * from './dist/recommend'; +export { default } from './dist/recommend'; diff --git a/packages/recommend/index.js b/packages/recommend/index.js new file mode 100644 index 000000000..8122c2480 --- /dev/null +++ b/packages/recommend/index.js @@ -0,0 +1,15 @@ +/* eslint-disable functional/immutable-data, import/no-commonjs */ +const recommend = require('./dist/recommend.cjs.js'); + +/** + * The Common JS build is the default entry point for the Node environment. Keep in + * in mind, that for the browser environment, we hint the bundler to use the UMD + * build instead as specified on the key `browser` of our `package.json` file. + */ +module.exports = recommend; + +/** + * In addition, we also set explicitly the default export below making + * this Common JS module in compliance with es6 modules specification. + */ +module.exports.default = recommend; diff --git a/packages/recommend/package.json b/packages/recommend/package.json new file mode 100644 index 000000000..5b4463a90 --- /dev/null +++ b/packages/recommend/package.json @@ -0,0 +1,37 @@ +{ + "name": "@algolia/recommend", + "version": "4.9.3", + "private": false, + "description": "The perfect starting point to integrate Algolia Recommend within your JavaScript project.", + "repository": { + "type": "git", + "url": "git://github.com/algolia/algoliasearch-client-javascript.git" + }, + "license": "MIT", + "sideEffects": false, + "main": "index.js", + "jsdelivr": "./dist/recommend.umd.js", + "unpkg": "./dist/recommend.umd.js", + "browser": { + "./index.js": "./dist/recommend.umd.js" + }, + "types": "index.d.ts", + "files": [ + "dist", + "index.js", + "index.d.ts" + ], + "dependencies": { + "@algolia/cache-browser-local-storage": "4.9.3", + "@algolia/cache-common": "4.9.3", + "@algolia/cache-in-memory": "4.9.3", + "@algolia/client-common": "4.9.3", + "@algolia/client-search": "4.9.3", + "@algolia/logger-common": "4.9.3", + "@algolia/logger-console": "4.9.3", + "@algolia/requester-browser-xhr": "4.9.3", + "@algolia/requester-common": "4.9.3", + "@algolia/requester-node-http": "4.9.3", + "@algolia/transporter": "4.9.3" + } +} diff --git a/packages/recommend/src/__tests__/getFrequentlyBoughtTogether.test.ts b/packages/recommend/src/__tests__/getFrequentlyBoughtTogether.test.ts new file mode 100644 index 000000000..2a6908a64 --- /dev/null +++ b/packages/recommend/src/__tests__/getFrequentlyBoughtTogether.test.ts @@ -0,0 +1,77 @@ +import { TestSuite } from '../../../client-common/src/__tests__/TestSuite'; + +const recommend = new TestSuite('recommend').recommend; + +function createMockedClient() { + const client = recommend('appId', 'apiKey'); + jest.spyOn(client.transporter, 'read').mockImplementation(() => Promise.resolve()); + + return client; +} + +describe('getFrequentlyBoughtTogether', () => { + test('builds the request', async () => { + const client = createMockedClient(); + + await client.getFrequentlyBoughtTogether( + { + indexName: 'products', + objectID: 'B018APC4LE', + }, + {} + ); + + expect(client.transporter.read).toHaveBeenCalledTimes(1); + expect(client.transporter.read).toHaveBeenCalledWith( + { + cacheable: true, + data: { + requests: [ + { + fallbackParameters: {}, + indexName: 'products', + model: 'bought-together', + objectID: 'B018APC4LE', + threshold: 0, + }, + ], + }, + method: 'POST', + path: '1/indexes/*/recommendations', + }, + {} + ); + }); + + test('ignores `fallbackParameters`', async () => { + const client = createMockedClient(); + + await client.getFrequentlyBoughtTogether({ + // @ts-ignore `fallbackParameters` are not supposed to be passed + // according to the types + fallbackParameters: { + facetFilters: [], + }, + indexName: 'products', + objectID: 'B018APC4LE', + }); + + expect(client.transporter.read).toHaveBeenCalledTimes(1); + expect(client.transporter.read).toHaveBeenCalledWith( + expect.objectContaining({ + data: { + requests: [ + { + fallbackParameters: {}, + indexName: 'products', + model: 'bought-together', + objectID: 'B018APC4LE', + threshold: 0, + }, + ], + }, + }), + undefined + ); + }); +}); diff --git a/packages/recommend/src/__tests__/getRecommendations.test.ts b/packages/recommend/src/__tests__/getRecommendations.test.ts new file mode 100644 index 000000000..2852033a8 --- /dev/null +++ b/packages/recommend/src/__tests__/getRecommendations.test.ts @@ -0,0 +1,78 @@ +import { TestSuite } from '../../../client-common/src/__tests__/TestSuite'; + +const recommend = new TestSuite('recommend').recommend; + +function createMockedClient() { + const client = recommend('appId', 'apiKey'); + jest.spyOn(client.transporter, 'read').mockImplementation(() => Promise.resolve()); + + return client; +} + +describe('getRecommendations', () => { + test('builds the request for "bought-together" model', async () => { + const client = createMockedClient(); + + await client.getRecommendations( + { + model: 'bought-together', + indexName: 'products', + objectID: 'B018APC4LE', + }, + {} + ); + + expect(client.transporter.read).toHaveBeenCalledTimes(1); + expect(client.transporter.read).toHaveBeenCalledWith( + { + cacheable: true, + data: { + requests: [ + { + indexName: 'products', + model: 'bought-together', + objectID: 'B018APC4LE', + threshold: 0, + }, + ], + }, + method: 'POST', + path: '1/indexes/*/recommendations', + }, + {} + ); + }); + + test('builds the request for "related-products" model', async () => { + const client = createMockedClient(); + + await client.getRecommendations( + { + model: 'related-products', + indexName: 'products', + objectID: 'B018APC4LE', + }, + {} + ); + + expect(client.transporter.read).toHaveBeenCalledTimes(1); + expect(client.transporter.read).toHaveBeenCalledWith( + { + cacheable: true, + data: { + requests: [ + { + indexName: 'products', + model: 'related-products', + objectID: 'B018APC4LE', + threshold: 0, + }, + ], + }, + method: 'POST', + path: '1/indexes/*/recommendations', + }, + {} + ); + }); +}); diff --git a/packages/recommend/src/__tests__/getRelatedProducts.test.ts b/packages/recommend/src/__tests__/getRelatedProducts.test.ts new file mode 100644 index 000000000..6e91cc950 --- /dev/null +++ b/packages/recommend/src/__tests__/getRelatedProducts.test.ts @@ -0,0 +1,44 @@ +import { TestSuite } from '../../../client-common/src/__tests__/TestSuite'; + +const recommend = new TestSuite('recommend').recommend; + +function createMockedClient() { + const client = recommend('appId', 'apiKey'); + jest.spyOn(client.transporter, 'read').mockImplementation(() => Promise.resolve()); + + return client; +} + +describe('getRelatedProducts', () => { + test('builds the request', async () => { + const client = createMockedClient(); + + await client.getRelatedProducts( + { + indexName: 'products', + objectID: 'B018APC4LE', + }, + {} + ); + + expect(client.transporter.read).toHaveBeenCalledTimes(1); + expect(client.transporter.read).toHaveBeenCalledWith( + { + cacheable: true, + data: { + requests: [ + { + indexName: 'products', + model: 'related-products', + objectID: 'B018APC4LE', + threshold: 0, + }, + ], + }, + method: 'POST', + path: '1/indexes/*/recommendations', + }, + {} + ); + }); +}); diff --git a/packages/recommend/src/__tests__/recommend-client.test.ts b/packages/recommend/src/__tests__/recommend-client.test.ts new file mode 100644 index 000000000..d3798a54d --- /dev/null +++ b/packages/recommend/src/__tests__/recommend-client.test.ts @@ -0,0 +1,179 @@ +import { createInMemoryCache } from '@algolia/cache-in-memory'; +import { version } from '@algolia/client-common'; +import { createStatelessHost, createUserAgent } from '@algolia/transporter'; + +import { TestSuite } from '../../../client-common/src/__tests__/TestSuite'; + +const recommend = new TestSuite('recommend').recommend; + +describe('recommend', () => { + test('has a version property', () => { + expect(recommend.version).toBe(version); + expect(recommend.version.startsWith('4.')).toBe(true); + }); + + test('gives access to appId', () => { + expect(recommend('appId', 'apiKey').appId).toEqual('appId'); + }); + + test('clearCache', async () => { + const client = recommend('appId', 'apiKey'); + + client.transporter.requestsCache.set('bla', 'blo'); + client.transporter.responsesCache.set('bla', 'blo'); + + if (testing.isBrowser()) { + await expect( + client.transporter.requestsCache.get('bla', () => Promise.resolve('wrong')) + ).resolves.toBe('blo'); + await expect( + client.transporter.responsesCache.get('bla', () => Promise.resolve('wrong')) + ).resolves.toBe('blo'); + } else { + // node uses a null cache, so these assertions don't make sense there + await expect( + client.transporter.requestsCache.get('bla', () => Promise.resolve('wrong')) + ).resolves.toBe('wrong'); + await expect( + client.transporter.responsesCache.get('bla', () => Promise.resolve('wrong')) + ).resolves.toBe('wrong'); + } + + await client.clearCache(); + + await expect( + client.transporter.requestsCache.get('bla', () => Promise.resolve('wrong')) + ).resolves.toBe('wrong'); + await expect( + client.transporter.responsesCache.get('bla', () => Promise.resolve('wrong')) + ).resolves.toBe('wrong'); + }); + + test('clearCache without promise', async () => { + const client = recommend('appId', 'apiKey'); + + client.transporter.requestsCache.set('bla', 'blo'); + client.transporter.responsesCache.set('bla', 'blo'); + + if (testing.isBrowser()) { + await expect( + client.transporter.requestsCache.get('bla', () => Promise.resolve('wrong')) + ).resolves.toBe('blo'); + await expect( + client.transporter.responsesCache.get('bla', () => Promise.resolve('wrong')) + ).resolves.toBe('blo'); + } else { + // node uses a null cache, so these assertions don't make sense there + await expect( + client.transporter.requestsCache.get('bla', () => Promise.resolve('wrong')) + ).resolves.toBe('wrong'); + await expect( + client.transporter.responsesCache.get('bla', () => Promise.resolve('wrong')) + ).resolves.toBe('wrong'); + } + + // no await, since default memory caches _actually_ are instant + client.clearCache(); + + await expect( + client.transporter.requestsCache.get('bla', () => Promise.resolve('wrong')) + ).resolves.toBe('wrong'); + await expect( + client.transporter.responsesCache.get('bla', () => Promise.resolve('wrong')) + ).resolves.toBe('wrong'); + }); + + it('sets default headers and queryParameters', () => { + const client = recommend('appId', 'apiKey'); + + if (testing.isBrowser()) { + expect(client.transporter.headers).toEqual({ + 'content-type': 'application/x-www-form-urlencoded', + }); + expect(client.transporter.queryParameters).toEqual({ + 'x-algolia-application-id': 'appId', + 'x-algolia-api-key': 'apiKey', + }); + } else { + expect(client.transporter.headers).toEqual({ + 'content-type': 'application/x-www-form-urlencoded', + 'x-algolia-application-id': 'appId', + 'x-algolia-api-key': 'apiKey', + }); + expect(client.transporter.queryParameters).toEqual({}); + } + }); + + test('sets default user agent', () => { + const client = recommend('appId', 'apiKey'); + + if (testing.isBrowser()) { + expect(client.transporter.userAgent.value).toEqual( + `Algolia for JavaScript (${version}); Recommend (${version}); Browser` + ); + } else { + const nodeVersion = process.versions.node; + + expect(client.transporter.userAgent.value).toEqual( + `Algolia for JavaScript (${version}); Recommend (${version}); Node.js (${nodeVersion})` + ); + } + }); + + test('allows to customize options', () => { + const client = recommend('appId', 'apiKey'); + const cache = createInMemoryCache(); + const userAgent = createUserAgent('0.2.0'); + + const customClient = recommend('appId', 'apiKey', { + hostsCache: cache, + requestsCache: cache, + userAgent, + timeouts: { + connect: 45, + read: 46, + write: 47, + }, + queryParameters: { + queryParameter: 'bar', + }, + headers: { + header: 'foo', + }, + hosts: [{ url: 'foo.com' }], + }); + + // Then, on custom options, only the client is impacted + expect(client.transporter.hostsCache).not.toBe(cache); + expect(customClient.transporter.hostsCache).toBe(cache); + + expect(client.transporter.requestsCache).not.toBe(cache); + expect(customClient.transporter.requestsCache).toBe(cache); + expect(customClient.transporter.timeouts).toEqual({ + connect: 45, + read: 46, + write: 47, + }); + + expect(customClient.transporter.queryParameters).toEqual( + expect.objectContaining({ + queryParameter: 'bar', + }) + ); + expect(customClient.transporter.headers).toEqual( + expect.objectContaining({ + 'content-type': 'application/x-www-form-urlencoded', + header: 'foo', + }) + ); + expect(customClient.transporter.hosts).toEqual([createStatelessHost({ url: 'foo.com' })]); + }); + + test('can be destroyed', () => { + const client = recommend('appId', 'apiKey'); + + if (!testing.isBrowser()) { + expect(client).toHaveProperty('destroy'); + } + }); +}); diff --git a/packages/recommend/src/builds/browser.ts b/packages/recommend/src/builds/browser.ts new file mode 100644 index 000000000..4e791606f --- /dev/null +++ b/packages/recommend/src/builds/browser.ts @@ -0,0 +1,57 @@ +import { createBrowserLocalStorageCache } from '@algolia/cache-browser-local-storage'; +import { createFallbackableCache } from '@algolia/cache-common'; +import { createInMemoryCache } from '@algolia/cache-in-memory'; +import { AuthMode, version } from '@algolia/client-common'; +import { LogLevelEnum } from '@algolia/logger-common'; +import { createConsoleLogger } from '@algolia/logger-console'; +import { createBrowserXhrRequester } from '@algolia/requester-browser-xhr'; +import { createUserAgent } from '@algolia/transporter'; + +import { createRecommendClient } from '../createRecommendClient'; +import { getFrequentlyBoughtTogether, getRecommendations, getRelatedProducts } from '../methods'; +import { RecommendClient, RecommendOptions, WithRecommendMethods } from '../types'; + +export default function recommend( + appId: string, + apiKey: string, + options?: RecommendOptions +): WithRecommendMethods