Skip to content

Commit 2ac2f2f

Browse files
algolia-bote-krebsshortcutsmillotp
committed
feat(specs): rename composition to composition-full (private) and add composition (public) (generated)
algolia/api-clients-automation#4357 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Emmanuel Krebs <[email protected]> Co-authored-by: shortcuts <[email protected]> Co-authored-by: Pierre Millot <[email protected]>
1 parent c14cef0 commit 2ac2f2f

File tree

87 files changed

+1872
-18
lines changed

Some content is hidden

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

87 files changed

+1872
-18
lines changed

‎packages/algoliasearch/builds/browser.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ import type { QuerySuggestionsClient } from '@algolia/client-query-suggestions';
1414
import { querySuggestionsClient } from '@algolia/client-query-suggestions';
1515
import type { SearchClient } from '@algolia/client-search';
1616
import { searchClient } from '@algolia/client-search';
17+
import type { CompositionClient } from '@algolia/composition';
18+
import { compositionClient } from '@algolia/composition';
1719
import type { IngestionClient } from '@algolia/ingestion';
1820
import { ingestionClient } from '@algolia/ingestion';
1921
import type { MonitoringClient } from '@algolia/monitoring';
@@ -36,6 +38,7 @@ export * from './models';
3638
export type Algoliasearch = SearchClient & {
3739
initAbtesting: (initOptions: InitClientOptions & AbtestingRegionOptions) => AbtestingClient;
3840
initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions) => AnalyticsClient;
41+
initComposition: (initOptions?: InitClientOptions) => CompositionClient;
3942
initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions) => IngestionClient;
4043
initInsights: (initOptions: InitClientOptions & InsightsRegionOptions) => InsightsClient;
4144
initMonitoring: (initOptions?: InitClientOptions) => MonitoringClient;
@@ -83,6 +86,10 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
8386
);
8487
},
8588

89+
initComposition: (initOptions: InitClientOptions = {}): CompositionClient => {
90+
return compositionClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
91+
},
92+
8693
initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions): IngestionClient => {
8794
return ingestionClient(
8895
initOptions.appId || appId,

‎packages/algoliasearch/builds/fetch.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ import type { QuerySuggestionsClient } from '@algolia/client-query-suggestions';
1414
import { querySuggestionsClient } from '@algolia/client-query-suggestions';
1515
import type { SearchClient } from '@algolia/client-search';
1616
import { searchClient } from '@algolia/client-search';
17+
import type { CompositionClient } from '@algolia/composition';
18+
import { compositionClient } from '@algolia/composition';
1719
import type { IngestionClient } from '@algolia/ingestion';
1820
import { ingestionClient } from '@algolia/ingestion';
1921
import type { MonitoringClient } from '@algolia/monitoring';
@@ -36,6 +38,7 @@ export * from './models';
3638
export type Algoliasearch = SearchClient & {
3739
initAbtesting: (initOptions: InitClientOptions & AbtestingRegionOptions) => AbtestingClient;
3840
initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions) => AnalyticsClient;
41+
initComposition: (initOptions?: InitClientOptions) => CompositionClient;
3942
initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions) => IngestionClient;
4043
initInsights: (initOptions: InitClientOptions & InsightsRegionOptions) => InsightsClient;
4144
initMonitoring: (initOptions?: InitClientOptions) => MonitoringClient;
@@ -83,6 +86,10 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
8386
);
8487
},
8588

89+
initComposition: (initOptions: InitClientOptions = {}): CompositionClient => {
90+
return compositionClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
91+
},
92+
8693
initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions): IngestionClient => {
8794
return ingestionClient(
8895
initOptions.appId || appId,

‎packages/algoliasearch/builds/models.ts

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
import type { Region as AbtestingRegion, RegionOptions as AbtestingRegionOptions } from '@algolia/client-abtesting';
44
import type { Region as AnalyticsRegion, RegionOptions as AnalyticsRegionOptions } from '@algolia/client-analytics';
5+
56
import type { Region as InsightsRegion, RegionOptions as InsightsRegionOptions } from '@algolia/client-insights';
67
import type { Region as IngestionRegion, RegionOptions as IngestionRegionOptions } from '@algolia/ingestion';
78

@@ -46,27 +47,29 @@ import type {
4647
CustomGetProps,
4748
CustomPostProps,
4849
CustomPutProps,
49-
DeletedAtResponse,
5050
DeleteSourceProps,
51+
DeletedAtResponse,
5152
Distinct,
5253
Edit,
5354
EditType,
5455
ErrorBase,
5556
ExactOnSingleWordQuery,
5657
Exhaustive,
5758
FacetFilters,
59+
FacetHits,
5860
FacetOrdering,
59-
Facets,
6061
FacetStats,
62+
Facets,
6163
GetTaskProps,
6264
HighlightResult,
6365
HighlightResultOption,
66+
Hit,
6467
IgnorePlurals,
6568
IndexSettingsAsSearchParams,
6669
InsideBoundingBox,
6770
Languages,
68-
MatchedGeoLocation,
6971
MatchLevel,
72+
MatchedGeoLocation,
7073
Mode,
7174
NumericFilters,
7275
OptionalFilters,
@@ -79,18 +82,23 @@ import type {
7982
QueryType,
8083
Range,
8184
RankingInfo,
85+
ReRankingApplyFilter,
8286
Redirect,
8387
RedirectRuleIndexData,
8488
RedirectRuleIndexMetadata,
8589
RedirectURL,
8690
RemoveStopWords,
8791
RemoveWordsIfNoResults,
8892
RenderingContent,
89-
ReRankingApplyFilter,
93+
SearchForFacetValuesProps,
94+
SearchForFacetValuesRequest,
95+
SearchForFacetValuesResponse,
96+
SearchHits,
9097
SearchPagination,
9198
SearchParams,
9299
SearchParamsObject,
93100
SearchParamsQuery,
101+
SearchResponse,
94102
SemanticSearch,
95103
SnippetResult,
96104
SnippetResultOption,
@@ -113,6 +121,7 @@ export * from '@algolia/client-insights';
113121
export * from '@algolia/client-personalization';
114122
export * from '@algolia/client-query-suggestions';
115123
export * from '@algolia/client-search';
124+
export * from '@algolia/composition';
116125
export * from '@algolia/ingestion';
117126
export * from '@algolia/monitoring';
118127
export * from '@algolia/recommend';
@@ -178,27 +187,29 @@ export type {
178187
CustomGetProps,
179188
CustomPostProps,
180189
CustomPutProps,
181-
DeletedAtResponse,
182190
DeleteSourceProps,
191+
DeletedAtResponse,
183192
Distinct,
184193
Edit,
185194
EditType,
186195
ErrorBase,
187196
ExactOnSingleWordQuery,
188197
Exhaustive,
189198
FacetFilters,
199+
FacetHits,
190200
FacetOrdering,
191-
Facets,
192201
FacetStats,
202+
Facets,
193203
GetTaskProps,
194204
HighlightResult,
195205
HighlightResultOption,
206+
Hit,
196207
IgnorePlurals,
197208
IndexSettingsAsSearchParams,
198209
InsideBoundingBox,
199210
Languages,
200-
MatchedGeoLocation,
201211
MatchLevel,
212+
MatchedGeoLocation,
202213
Mode,
203214
NumericFilters,
204215
OptionalFilters,
@@ -211,18 +222,23 @@ export type {
211222
QueryType,
212223
Range,
213224
RankingInfo,
225+
ReRankingApplyFilter,
214226
Redirect,
215227
RedirectRuleIndexData,
216228
RedirectRuleIndexMetadata,
217229
RedirectURL,
218230
RemoveStopWords,
219231
RemoveWordsIfNoResults,
220232
RenderingContent,
221-
ReRankingApplyFilter,
233+
SearchForFacetValuesProps,
234+
SearchForFacetValuesRequest,
235+
SearchForFacetValuesResponse,
236+
SearchHits,
222237
SearchPagination,
223238
SearchParams,
224239
SearchParamsObject,
225240
SearchParamsQuery,
241+
SearchResponse,
226242
SemanticSearch,
227243
SnippetResult,
228244
SnippetResultOption,

‎packages/algoliasearch/builds/node.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ import type { QuerySuggestionsClient } from '@algolia/client-query-suggestions';
1414
import { querySuggestionsClient } from '@algolia/client-query-suggestions';
1515
import type { SearchClient } from '@algolia/client-search';
1616
import { searchClient } from '@algolia/client-search';
17+
import type { CompositionClient } from '@algolia/composition';
18+
import { compositionClient } from '@algolia/composition';
1719
import type { IngestionClient } from '@algolia/ingestion';
1820
import { ingestionClient } from '@algolia/ingestion';
1921
import type { MonitoringClient } from '@algolia/monitoring';
@@ -36,6 +38,7 @@ export * from './models';
3638
export type Algoliasearch = SearchClient & {
3739
initAbtesting: (initOptions: InitClientOptions & AbtestingRegionOptions) => AbtestingClient;
3840
initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions) => AnalyticsClient;
41+
initComposition: (initOptions?: InitClientOptions) => CompositionClient;
3942
initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions) => IngestionClient;
4043
initInsights: (initOptions: InitClientOptions & InsightsRegionOptions) => InsightsClient;
4144
initMonitoring: (initOptions?: InitClientOptions) => MonitoringClient;
@@ -83,6 +86,10 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
8386
);
8487
},
8588

89+
initComposition: (initOptions: InitClientOptions = {}): CompositionClient => {
90+
return compositionClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
91+
},
92+
8693
initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions): IngestionClient => {
8794
return ingestionClient(
8895
initOptions.appId || appId,

‎packages/algoliasearch/builds/worker.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ import type { QuerySuggestionsClient } from '@algolia/client-query-suggestions';
1414
import { querySuggestionsClient } from '@algolia/client-query-suggestions';
1515
import type { SearchClient } from '@algolia/client-search';
1616
import { searchClient } from '@algolia/client-search';
17+
import type { CompositionClient } from '@algolia/composition';
18+
import { compositionClient } from '@algolia/composition';
1719
import type { IngestionClient } from '@algolia/ingestion';
1820
import { ingestionClient } from '@algolia/ingestion';
1921
import type { MonitoringClient } from '@algolia/monitoring';
@@ -36,6 +38,7 @@ export * from './models';
3638
export type Algoliasearch = SearchClient & {
3739
initAbtesting: (initOptions: InitClientOptions & AbtestingRegionOptions) => AbtestingClient;
3840
initAnalytics: (initOptions: InitClientOptions & AnalyticsRegionOptions) => AnalyticsClient;
41+
initComposition: (initOptions?: InitClientOptions) => CompositionClient;
3942
initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions) => IngestionClient;
4043
initInsights: (initOptions: InitClientOptions & InsightsRegionOptions) => InsightsClient;
4144
initMonitoring: (initOptions?: InitClientOptions) => MonitoringClient;
@@ -83,6 +86,10 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
8386
);
8487
},
8588

89+
initComposition: (initOptions: InitClientOptions = {}): CompositionClient => {
90+
return compositionClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
91+
},
92+
8693
initIngestion: (initOptions: InitClientOptions & IngestionRegionOptions): IngestionClient => {
8794
return ingestionClient(
8895
initOptions.appId || appId,

‎packages/algoliasearch/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@
8181
"@algolia/client-personalization": "5.19.0",
8282
"@algolia/client-query-suggestions": "5.19.0",
8383
"@algolia/client-search": "5.19.0",
84+
"@algolia/composition": "0.0.1",
8485
"@algolia/ingestion": "1.19.0",
8586
"@algolia/monitoring": "1.19.0",
8687
"@algolia/recommend": "5.19.0",

‎packages/client-composition/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ import { compositionClient } from '@algolia/client-composition';
6666
const client = compositionClient('YOUR_APP_ID', 'YOUR_API_KEY');
6767
```
6868

69-
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/composition/)**.
69+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/composition-full/)**.
7070

7171
## ❓ Troubleshooting
7272

‎packages/client-composition/builds/browser.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ import {
1111

1212
import type { ClientOptions } from '@algolia/client-common';
1313

14-
import { apiClientVersion, createCompositionClient } from '../src/compositionClient';
14+
import { apiClientVersion, createCompositionClient } from '../src/compositionFullClient';
1515

16-
export { apiClientVersion } from '../src/compositionClient';
16+
export { apiClientVersion } from '../src/compositionFullClient';
1717

1818
export * from '../model';
1919

‎packages/client-composition/builds/fetch.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ import { createFetchRequester } from '@algolia/requester-fetch';
77

88
import type { ClientOptions } from '@algolia/client-common';
99

10-
import { createCompositionClient } from '../src/compositionClient';
10+
import { createCompositionClient } from '../src/compositionFullClient';
1111

12-
export { apiClientVersion } from '../src/compositionClient';
12+
export { apiClientVersion } from '../src/compositionFullClient';
1313

1414
export * from '../model';
1515

‎packages/client-composition/builds/node.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ import { createMemoryCache, createNullCache, createNullLogger } from '@algolia/c
88

99
import type { ClientOptions } from '@algolia/client-common';
1010

11-
import { createCompositionClient } from '../src/compositionClient';
11+
import { createCompositionClient } from '../src/compositionFullClient';
1212

13-
export { apiClientVersion } from '../src/compositionClient';
13+
export { apiClientVersion } from '../src/compositionFullClient';
1414

1515
export * from '../model';
1616

‎packages/client-composition/builds/worker.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ import { createFetchRequester } from '@algolia/requester-fetch';
77

88
import type { ClientOptions } from '@algolia/client-common';
99

10-
import { createCompositionClient } from '../src/compositionClient';
10+
import { createCompositionClient } from '../src/compositionFullClient';
1111

12-
export { apiClientVersion } from '../src/compositionClient';
12+
export { apiClientVersion } from '../src/compositionFullClient';
1313

1414
export * from '../model';
1515

‎packages/client-composition/src/compositionClient.ts renamed to ‎packages/client-composition/src/compositionFullClient.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ export function createCompositionClient({
9191
...options,
9292
algoliaAgent: getAlgoliaAgent({
9393
algoliaAgents,
94-
client: 'Composition',
94+
client: 'CompositionFull',
9595
version: apiClientVersion,
9696
}),
9797
baseHeaders: {

‎packages/composition/LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2013-Present Algolia
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)