Skip to content

Commit f5628af

Browse files
author
Samuel Bodin
authored
Merge branch 'master' into feat/timeout-max
2 parents 142d5e2 + a5df2fb commit f5628af

File tree

84 files changed

+1912
-305
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+1912
-305
lines changed

‎.eslintrc.js‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,12 @@ module.exports = {
6161
['@algolia/client-account', './packages/client-account/src'],
6262
['@algolia/client-analytics', './packages/client-analytics/src'],
6363
['@algolia/client-common', './packages/client-common/src'],
64-
['@algolia/client-search', './packages/client-search/src'],
64+
['@algolia/client-personalization', './packages/client-personalization/src'],
6565
['@algolia/client-recommendation', './packages/client-recommendation/src'],
66+
['@algolia/client-search', './packages/client-search/src'],
6667
['@algolia/logger-common', './packages/logger-common/src'],
6768
['@algolia/logger-console', './packages/logger-console/src'],
69+
['@algolia/recommend', './packages/recommend/src'],
6870
['@algolia/requester-browser-xhr', './packages/requester-browser-xhr/src'],
6971
['@algolia/requester-common', './packages/requester-common/src'],
7072
['@algolia/requester-node-http', './packages/requester-node-http/src'],

‎CHANGELOG.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,60 @@
1+
## [v4.10.5](https://github.com/algolia/algoliasearch-client-javascript/compare/4.10.4...4.10.5)
2+
3+
* fix(recommend): prevent `undefined` threshold (#1300) ([7d21d3c](https://github.com/algolia/algoliasearch-client-javascript/commit/7d21d3c)), closes [#1300](https://github.com/algolia/algoliasearch-client-javascript/issues/1300)
4+
5+
6+
7+
## [v4.10.4](https://github.com/algolia/algoliasearch-client-javascript/compare/4.10.3...4.10.4)
8+
9+
* fix(recommend): expose correct key on window in umd (#1298) ([169b12a](https://github.com/algolia/algoliasearch-client-javascript/commit/169b12a)), closes [#1298](https://github.com/algolia/algoliasearch-client-javascript/issues/1298)
10+
11+
12+
13+
## [v4.10.3](https://github.com/algolia/algoliasearch-client-javascript/compare/4.10.2...4.10.3)
14+
15+
* fix(answers): omit original hits in response (#1293) ([fb62b15](https://github.com/algolia/algoliasearch-client-javascript/commit/fb62b15)), closes [#1293](https://github.com/algolia/algoliasearch-client-javascript/issues/1293)
16+
* fix(facetOrdering): facetOrdering.facets, not .facet ([d931976](https://github.com/algolia/algoliasearch-client-javascript/commit/d931976))
17+
18+
19+
20+
## [v4.10.2](https://github.com/algolia/algoliasearch-client-javascript/compare/4.10.0...4.10.2)
21+
22+
* fix(recommend): export method types (#1287) ([95281fe](https://github.com/algolia/algoliasearch-client-javascript/commit/95281fe)), closes [#1287](https://github.com/algolia/algoliasearch-client-javascript/issues/1287)
23+
* chore(release): force public access on npm release (#1288) ([2fefd78](https://github.com/algolia/algoliasearch-client-javascript/commit/2fefd78)), closes [#1288](https://github.com/algolia/algoliasearch-client-javascript/issues/1288)
24+
25+
26+
27+
## [v4.10.0](https://github.com/algolia/algoliasearch-client-javascript/compare/4.9.3...4.10.0)
28+
29+
The `@algolia/client-recommendation` is now deprecated, please use `@algolia/client-personalization` instead. If you were using `initRecommendation` from the `algoliasearch` package, please use `initPersonalization` instead.
30+
31+
32+
33+
* feat(recommend): introduce Recommend API client (#1280) ([97ebde6](https://github.com/algolia/algoliasearch-client-javascript/commit/97ebde6)), closes [#1280](https://github.com/algolia/algoliasearch-client-javascript/issues/1280) [#1278](https://github.com/algolia/algoliasearch-client-javascript/issues/1278)
34+
* feat(personalization): deprecate client-recommendation (#1278)
35+
* fix(rules): automaticOptionalFacetFilters type takes the same input as automaticFacetFilters (#1279) ([831a3de](https://github.com/algolia/algoliasearch-client-javascript/commit/831a3de)), closes [#1279](https://github.com/algolia/algoliasearch-client-javascript/issues/1279)
36+
37+
38+
39+
## [v4.9.3](https://github.com/algolia/algoliasearch-client-javascript/compare/4.9.2...4.9.3)
40+
41+
* fix(ts): make all keys in facetOrdering optional ([d772f98](https://github.com/algolia/algoliasearch-client-javascript/commit/d772f98))
42+
43+
44+
45+
## [v4.9.2](https://github.com/algolia/algoliasearch-client-javascript/compare/4.9.1...4.9.2)
46+
47+
* feat(ts): document renderingContent (#1273) ([04f2a20](https://github.com/algolia/algoliasearch-client-javascript/commit/04f2a20)), closes [#1273](https://github.com/algolia/algoliasearch-client-javascript/issues/1273)
48+
* fix(api-keys): fix typing issues (#1270) ([fec87a9](https://github.com/algolia/algoliasearch-client-javascript/commit/fec87a9)), closes [#1270](https://github.com/algolia/algoliasearch-client-javascript/issues/1270)
49+
50+
51+
52+
## [v4.9.1](https://github.com/algolia/algoliasearch-client-javascript/compare/4.9.0...4.9.1)
53+
54+
* fix(types): support `facetQuery` in `MultipleQueriesQuery` (#1267) ([84355a9](https://github.com/algolia/algoliasearch-client-javascript/commit/84355a9)), closes [#1267](https://github.com/algolia/algoliasearch-client-javascript/issues/1267)
55+
56+
57+
158
## [v4.9.0](https://github.com/algolia/algoliasearch-client-javascript/compare/4.8.6...4.9.0)
259

360
* feat(dictionaries): adds methods and tests (#1253) ([aed6554](https://github.com/algolia/algoliasearch-client-javascript/commit/aed6554)), closes [#1253](https://github.com/algolia/algoliasearch-client-javascript/issues/1253)

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<a href="https://npmjs.org/package/algoliasearch"><img src="https://img.shields.io/npm/v/algoliasearch.svg?style=flat-square" alt="NPM version"></img></a>
1010
<a href="http://npm-stat.com/charts.html?package=algoliasearch"><img src="https://img.shields.io/npm/dm/algoliasearch.svg?style=flat-square" alt="NPM downloads"></a>
1111
<a href="https://www.jsdelivr.com/package/npm/algoliasearch"><img src="https://data.jsdelivr.com/v1/package/npm/algoliasearch/badge" alt="jsDelivr Downloads"></img></a>
12-
<a href="LICENSE.txt"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="License"></a>
12+
<a href="LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="License"></a>
1313
</p>
1414
</p>
1515

@@ -88,4 +88,4 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
8888

8989
## 📄 License
9090

91-
Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE.txt).
91+
Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).

‎lerna.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"npmClient": "yarn",
33
"useWorkspaces": true,
4-
"version": "4.9.0"
4+
"version": "4.10.5"
55
}

‎package.json‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2+
"version": "4.10.5",
23
"private": true,
34
"license": "MIT",
4-
"version": "4.9.0",
55
"workspaces": [
66
"packages/*"
77
],
@@ -82,7 +82,7 @@
8282
"rollup-plugin-terser": "5.2.0",
8383
"rollup-plugin-typescript2": "0.26.0",
8484
"serve": "11.3.0",
85-
"shipjs": "0.22.0",
85+
"shipjs": "0.23.3",
8686
"sort-package-json": "1.40.0",
8787
"ts-jest": "25.2.1",
8888
"ts-mockito": "2.5.0",
@@ -98,11 +98,15 @@
9898
"bundlesize": [
9999
{
100100
"path": "packages/algoliasearch/dist/algoliasearch.umd.js",
101-
"maxSize": "7.85KB"
101+
"maxSize": "7.95KB"
102102
},
103103
{
104104
"path": "packages/algoliasearch/dist/algoliasearch-lite.umd.js",
105105
"maxSize": "4.35KB"
106+
},
107+
{
108+
"path": "packages/recommend/dist/recommend.umd.js",
109+
"maxSize": "4.1KB"
106110
}
107111
]
108112
}

‎packages/algoliasearch/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<a href="https://npmjs.org/package/algoliasearch"><img src="https://img.shields.io/npm/v/algoliasearch.svg?style=flat-square" alt="NPM version"></img></a>
1010
<a href="http://npm-stat.com/charts.html?package=algoliasearch"><img src="https://img.shields.io/npm/dm/algoliasearch.svg?style=flat-square" alt="NPM downloads"></a>
1111
<a href="https://www.jsdelivr.com/package/npm/algoliasearch"><img src="https://data.jsdelivr.com/v1/package/npm/algoliasearch/badge" alt="jsDelivr Downloads"></img></a>
12-
<a href="LICENSE.txt"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="License"></a>
12+
<a href="LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="License"></a>
1313
</p>
1414
</p>
1515

@@ -79,4 +79,4 @@ For full documentation, visit the **[online documentation](https://www.algolia.c
7979

8080
## 📄 License
8181

82-
Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE.txt).
82+
Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).

‎packages/algoliasearch/package.json‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "algoliasearch",
3-
"version": "4.9.0",
3+
"version": "4.10.5",
44
"private": false,
55
"description": "A fully-featured and blazing-fast JavaScript API client to interact with Algolia API.",
66
"repository": {
@@ -25,19 +25,19 @@
2525
"lite.d.ts"
2626
],
2727
"dependencies": {
28-
"@algolia/cache-browser-local-storage": "4.9.0",
29-
"@algolia/cache-common": "4.9.0",
30-
"@algolia/cache-in-memory": "4.9.0",
31-
"@algolia/client-account": "4.9.0",
32-
"@algolia/client-analytics": "4.9.0",
33-
"@algolia/client-common": "4.9.0",
34-
"@algolia/client-recommendation": "4.9.0",
35-
"@algolia/client-search": "4.9.0",
36-
"@algolia/logger-common": "4.9.0",
37-
"@algolia/logger-console": "4.9.0",
38-
"@algolia/requester-browser-xhr": "4.9.0",
39-
"@algolia/requester-common": "4.9.0",
40-
"@algolia/requester-node-http": "4.9.0",
41-
"@algolia/transporter": "4.9.0"
28+
"@algolia/cache-browser-local-storage": "4.10.5",
29+
"@algolia/cache-common": "4.10.5",
30+
"@algolia/cache-in-memory": "4.10.5",
31+
"@algolia/client-account": "4.10.5",
32+
"@algolia/client-analytics": "4.10.5",
33+
"@algolia/client-common": "4.10.5",
34+
"@algolia/client-personalization": "4.10.5",
35+
"@algolia/client-search": "4.10.5",
36+
"@algolia/logger-common": "4.10.5",
37+
"@algolia/logger-console": "4.10.5",
38+
"@algolia/requester-browser-xhr": "4.10.5",
39+
"@algolia/requester-common": "4.10.5",
40+
"@algolia/requester-node-http": "4.10.5",
41+
"@algolia/transporter": "4.10.5"
4242
}
4343
}

‎packages/algoliasearch/src/__tests__/default.test.ts‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ describe('default preset', () => {
8383

8484
expect(client.transporter.requestsCache).not.toBe(cache);
8585
expect(customClient.transporter.requestsCache).toBe(cache);
86-
expect(customClient.initRecommendation().transporter.requestsCache).not.toBe(cache);
86+
expect(customClient.initPersonalization().transporter.requestsCache).not.toBe(cache);
8787
expect(customClient.initAnalytics({ requestsCache: cache }).transporter.requestsCache).toBe(
8888
cache
8989
);
@@ -92,7 +92,7 @@ describe('default preset', () => {
9292
read: 46,
9393
write: 47,
9494
});
95-
expect(customClient.initRecommendation().transporter.timeouts).toEqual({
95+
expect(customClient.initPersonalization().transporter.timeouts).toEqual({
9696
connect: testing.isBrowser() ? 1 : 2,
9797
read: testing.isBrowser() ? 2 : 5,
9898
write: 30,
@@ -110,7 +110,7 @@ describe('default preset', () => {
110110
expect(customClient.transporter.hosts).toEqual([createStatelessHost({ url: 'foo.com' })]);
111111

112112
expect(customClient.initAnalytics().transporter.queryParameters).toEqual({});
113-
expect(customClient.initRecommendation().transporter.headers).toEqual({
113+
expect(customClient.initPersonalization().transporter.headers).toEqual({
114114
'content-type': 'application/json',
115115
'x-algolia-application-id': 'appId',
116116
'x-algolia-api-key': 'apiKey',
@@ -119,31 +119,31 @@ describe('default preset', () => {
119119
createStatelessHost({ url: 'foo.com' }),
120120
]);
121121

122-
expect(customClient.initRecommendation().transporter.queryParameters).not.toEqual({
122+
expect(customClient.initPersonalization().transporter.queryParameters).not.toEqual({
123123
queryParameter: 'bar',
124124
});
125125

126-
expect(customClient.initRecommendation().transporter.headers).toEqual({
126+
expect(customClient.initPersonalization().transporter.headers).toEqual({
127127
'content-type': 'application/json',
128128
'x-algolia-application-id': 'appId',
129129
'x-algolia-api-key': 'apiKey',
130130
});
131-
expect(customClient.initRecommendation().transporter.hosts).not.toEqual([
131+
expect(customClient.initPersonalization().transporter.hosts).not.toEqual([
132132
createStatelessHost({ url: 'foo.com' }),
133133
]);
134134
});
135135

136136
test('shared implementations between clients', () => {
137137
const analytics = client.initAnalytics();
138-
const recommendation = client.initRecommendation();
138+
const personalization = client.initPersonalization();
139139

140140
expect(analytics.transporter).not.toBe(client.transporter);
141141
expect(analytics.transporter.hostsCache).toBe(client.transporter.hostsCache);
142142
expect(analytics.transporter.userAgent).toBe(client.transporter.userAgent);
143143

144-
expect(recommendation.transporter).not.toBe(client.transporter);
145-
expect(recommendation.transporter.hostsCache).toBe(client.transporter.hostsCache);
146-
expect(recommendation.transporter.userAgent).toBe(client.transporter.userAgent);
144+
expect(personalization.transporter).not.toBe(client.transporter);
145+
expect(personalization.transporter.hostsCache).toBe(client.transporter.hostsCache);
146+
expect(personalization.transporter.userAgent).toBe(client.transporter.userAgent);
147147
});
148148

149149
test('allows clients to override credentials', () => {
@@ -154,12 +154,12 @@ describe('default preset', () => {
154154
const analytics = clientWithOptions.initAnalytics({
155155
apiKey: 'analytics',
156156
});
157-
const recommendation = clientWithOptions.initRecommendation({
158-
apiKey: 'recommendation',
157+
const personalization = clientWithOptions.initPersonalization({
158+
apiKey: 'personalization',
159159
});
160160

161161
expect(analytics.transporter.headers['x-algolia-api-key']).toBe('analytics');
162-
expect(recommendation.transporter.headers['x-algolia-api-key']).toBe('recommendation');
162+
expect(personalization.transporter.headers['x-algolia-api-key']).toBe('personalization');
163163
});
164164

165165
test('allows clients to keep default credentials', () => {
@@ -168,10 +168,10 @@ describe('default preset', () => {
168168
expect(clientWithOptions.transporter.headers['x-algolia-api-key']).toBe('apiKey');
169169

170170
const analytics = clientWithOptions.initAnalytics();
171-
const recommendation = clientWithOptions.initRecommendation();
171+
const personalization = clientWithOptions.initPersonalization();
172172

173173
expect(analytics.transporter.headers['x-algolia-api-key']).toBe('apiKey');
174-
expect(recommendation.transporter.headers['x-algolia-api-key']).toBe('apiKey');
174+
expect(personalization.transporter.headers['x-algolia-api-key']).toBe('apiKey');
175175
});
176176

177177
it('can be destroyed', () => {

‎packages/algoliasearch/src/builds/browser.ts‎

Lines changed: 37 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ import {
1919
} from '@algolia/client-analytics';
2020
import { version, WaitablePromise } from '@algolia/client-common';
2121
import {
22-
createRecommendationClient,
22+
createPersonalizationClient,
2323
getPersonalizationStrategy,
2424
GetPersonalizationStrategyResponse,
25+
PersonalizationClient as BasePersonalizationClient,
2526
PersonalizationStrategy,
26-
RecommendationClient as BaseRecommendationClient,
2727
setPersonalizationStrategy,
2828
SetPersonalizationStrategyResponse,
29-
} from '@algolia/client-recommendation';
29+
} from '@algolia/client-personalization';
3030
import {
3131
addApiKey,
3232
AddApiKeyOptions,
@@ -192,7 +192,7 @@ import { createConsoleLogger } from '@algolia/logger-console';
192192
import { createBrowserXhrRequester } from '@algolia/requester-browser-xhr';
193193
import { createUserAgent, RequestOptions } from '@algolia/transporter';
194194

195-
import { AlgoliaSearchOptions, InitAnalyticsOptions, InitRecommendationOptions } from '../types';
195+
import { AlgoliaSearchOptions, InitAnalyticsOptions, InitPersonalizationOptions } from '../types';
196196

197197
export default function algoliasearch(
198198
appId: string,
@@ -219,10 +219,22 @@ export default function algoliasearch(
219219
}),
220220
userAgent: createUserAgent(version).add({ segment: 'Browser' }),
221221
};
222+
const searchClientOptions = { ...commonOptions, ...options };
223+
const initPersonalization = () => (
224+
clientOptions?: InitPersonalizationOptions
225+
): PersonalizationClient => {
226+
return createPersonalizationClient({
227+
...commonOptions,
228+
...clientOptions,
229+
methods: {
230+
getPersonalizationStrategy,
231+
setPersonalizationStrategy,
232+
},
233+
});
234+
};
222235

223236
return createSearchClient({
224-
...commonOptions,
225-
...options,
237+
...searchClientOptions,
226238
methods: {
227239
search: multipleQueries,
228240
searchForFacetValues: multipleSearchForFacetValues,
@@ -319,17 +331,15 @@ export default function algoliasearch(
319331
},
320332
});
321333
},
334+
initPersonalization,
322335
initRecommendation: () => (
323-
clientOptions?: InitRecommendationOptions
324-
): RecommendationClient => {
325-
return createRecommendationClient({
326-
...commonOptions,
327-
...clientOptions,
328-
methods: {
329-
getPersonalizationStrategy,
330-
setPersonalizationStrategy,
331-
},
332-
});
336+
clientOptions?: InitPersonalizationOptions
337+
): PersonalizationClient => {
338+
searchClientOptions.logger.info(
339+
'The `initRecommendation` method is deprecated. Use `initPersonalization` instead.'
340+
);
341+
342+
return initPersonalization()(clientOptions);
333343
},
334344
},
335345
});
@@ -338,7 +348,7 @@ export default function algoliasearch(
338348
// eslint-disable-next-line functional/immutable-data
339349
algoliasearch.version = version;
340350

341-
export type RecommendationClient = BaseRecommendationClient & {
351+
export type PersonalizationClient = BasePersonalizationClient & {
342352
readonly getPersonalizationStrategy: (
343353
requestOptions?: RequestOptions
344354
) => Readonly<Promise<GetPersonalizationStrategyResponse>>;
@@ -348,6 +358,11 @@ export type RecommendationClient = BaseRecommendationClient & {
348358
) => Readonly<Promise<SetPersonalizationStrategyResponse>>;
349359
};
350360

361+
/**
362+
* @deprecated Use `PersonalizationClient` instead.
363+
*/
364+
export type RecommendationClient = PersonalizationClient;
365+
351366
export type AnalyticsClient = BaseAnalyticsClient & {
352367
readonly addABTest: (
353368
abTest: ABTest,
@@ -663,7 +678,11 @@ export type SearchClient = BaseSearchClient & {
663678
requestOptions?: RequestOptions
664679
) => Readonly<Promise<TaskStatusResponse>>;
665680
readonly initAnalytics: (options?: InitAnalyticsOptions) => AnalyticsClient;
666-
readonly initRecommendation: (options?: InitRecommendationOptions) => RecommendationClient;
681+
readonly initPersonalization: (options?: InitPersonalizationOptions) => PersonalizationClient;
682+
/**
683+
* @deprecated Use `initPersonalization` instead.
684+
*/
685+
readonly initRecommendation: (options?: InitPersonalizationOptions) => PersonalizationClient;
667686
};
668687

669688
export * from '../types';

0 commit comments

Comments
 (0)