From e8a4ac87c40a19385f181a22baec5fb1887238b1 Mon Sep 17 00:00:00 2001 From: Shireesha Bongarala Date: Sun, 17 Feb 2019 18:55:48 +0530 Subject: [PATCH 1/5] Add missing definition for "sortFacetValuesBy" in QueryParameters. Fixes https://github.com/DefinitelyTyped/DefinitelyTyped/issues/32761 --- types/algoliasearch/algoliasearch-tests.ts | 1 + types/algoliasearch/index.d.ts | 5 +++++ types/algoliasearch/lite/index.d.ts | 5 +++++ 3 files changed, 11 insertions(+) diff --git a/types/algoliasearch/algoliasearch-tests.ts b/types/algoliasearch/algoliasearch-tests.ts index 92c090d179..e650013a06 100644 --- a/types/algoliasearch/algoliasearch-tests.ts +++ b/types/algoliasearch/algoliasearch-tests.ts @@ -150,6 +150,7 @@ let _algoliaQueryParameters: QueryParameters = { synonyms: true, replaceSynonymsInHighlight: false, minProximity: 0, + sortFacetValuesBy: 'alpha' }; let client: Client = algoliasearch('', ''); diff --git a/types/algoliasearch/index.d.ts b/types/algoliasearch/index.d.ts index 5478fedbac..b56ca9872f 100644 --- a/types/algoliasearch/index.d.ts +++ b/types/algoliasearch/index.d.ts @@ -1451,6 +1451,11 @@ declare namespace algoliasearch { nbShards?: number; userData?: string | object; + + /** + * https://www.algolia.com/doc/api-reference/api-parameters/sortFacetValuesBy/ + */ + sortFacetValuesBy: 'count' | 'alpha' } namespace SearchForFacetValues { diff --git a/types/algoliasearch/lite/index.d.ts b/types/algoliasearch/lite/index.d.ts index ce58d6a428..29c22ad0e3 100644 --- a/types/algoliasearch/lite/index.d.ts +++ b/types/algoliasearch/lite/index.d.ts @@ -531,6 +531,11 @@ declare namespace algoliasearch { nbShards?: number; userData?: string | object; + + /** + * https://www.algolia.com/doc/api-reference/api-parameters/sortFacetValuesBy/ + */ + sortFacetValuesBy: 'count' | 'alpha' } namespace SearchForFacetValues { From 99e6d86abb0fb705a0016300ebe0a689c0f861a7 Mon Sep 17 00:00:00 2001 From: Shireesha Bongarala Date: Sun, 17 Feb 2019 20:43:29 +0530 Subject: [PATCH 2/5] Add missing semi-colons --- types/algoliasearch/index.d.ts | 2 +- types/algoliasearch/lite/index.d.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/types/algoliasearch/index.d.ts b/types/algoliasearch/index.d.ts index b56ca9872f..2baf12c0e8 100644 --- a/types/algoliasearch/index.d.ts +++ b/types/algoliasearch/index.d.ts @@ -1455,7 +1455,7 @@ declare namespace algoliasearch { /** * https://www.algolia.com/doc/api-reference/api-parameters/sortFacetValuesBy/ */ - sortFacetValuesBy: 'count' | 'alpha' + sortFacetValuesBy: 'count' | 'alpha'; } namespace SearchForFacetValues { diff --git a/types/algoliasearch/lite/index.d.ts b/types/algoliasearch/lite/index.d.ts index 29c22ad0e3..3617ae91a0 100644 --- a/types/algoliasearch/lite/index.d.ts +++ b/types/algoliasearch/lite/index.d.ts @@ -535,7 +535,7 @@ declare namespace algoliasearch { /** * https://www.algolia.com/doc/api-reference/api-parameters/sortFacetValuesBy/ */ - sortFacetValuesBy: 'count' | 'alpha' + sortFacetValuesBy: 'count' | 'alpha'; } namespace SearchForFacetValues { From b0aeee8dbd380eedca7462082928b0f0ca70d068 Mon Sep 17 00:00:00 2001 From: Shireesha Bongarala Date: Sun, 17 Feb 2019 20:53:10 +0530 Subject: [PATCH 3/5] Make query param non-mandatory --- types/algoliasearch/index.d.ts | 2 +- types/algoliasearch/lite/index.d.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/types/algoliasearch/index.d.ts b/types/algoliasearch/index.d.ts index 2baf12c0e8..e799ee1832 100644 --- a/types/algoliasearch/index.d.ts +++ b/types/algoliasearch/index.d.ts @@ -1455,7 +1455,7 @@ declare namespace algoliasearch { /** * https://www.algolia.com/doc/api-reference/api-parameters/sortFacetValuesBy/ */ - sortFacetValuesBy: 'count' | 'alpha'; + sortFacetValuesBy?: "count"|"alpha"; } namespace SearchForFacetValues { diff --git a/types/algoliasearch/lite/index.d.ts b/types/algoliasearch/lite/index.d.ts index 3617ae91a0..a3babc339b 100644 --- a/types/algoliasearch/lite/index.d.ts +++ b/types/algoliasearch/lite/index.d.ts @@ -535,7 +535,7 @@ declare namespace algoliasearch { /** * https://www.algolia.com/doc/api-reference/api-parameters/sortFacetValuesBy/ */ - sortFacetValuesBy: 'count' | 'alpha'; + sortFacetValuesBy?: "count"|"alpha"; } namespace SearchForFacetValues { From afeecd2abd9d89b3aae0b46de5f34c704cffbd64 Mon Sep 17 00:00:00 2001 From: Shireesha Bongarala Date: Mon, 18 Feb 2019 19:27:58 +0530 Subject: [PATCH 4/5] Add trailing comma --- types/algoliasearch/algoliasearch-tests.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/algoliasearch/algoliasearch-tests.ts b/types/algoliasearch/algoliasearch-tests.ts index e650013a06..8123c69891 100644 --- a/types/algoliasearch/algoliasearch-tests.ts +++ b/types/algoliasearch/algoliasearch-tests.ts @@ -150,7 +150,7 @@ let _algoliaQueryParameters: QueryParameters = { synonyms: true, replaceSynonymsInHighlight: false, minProximity: 0, - sortFacetValuesBy: 'alpha' + sortFacetValuesBy: 'alpha', }; let client: Client = algoliasearch('', ''); From 44dca6f2db376ee168c862a55ac17335917d0afd Mon Sep 17 00:00:00 2001 From: Shireesha Bongarala Date: Mon, 18 Feb 2019 19:34:08 +0530 Subject: [PATCH 5/5] Add to IndexSettings, change the format to single quotes and spaces --- types/algoliasearch/algoliasearch-tests.ts | 1 + types/algoliasearch/index.d.ts | 4 +++- types/algoliasearch/lite/index.d.ts | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/types/algoliasearch/algoliasearch-tests.ts b/types/algoliasearch/algoliasearch-tests.ts index 8123c69891..fdd0f395fe 100644 --- a/types/algoliasearch/algoliasearch-tests.ts +++ b/types/algoliasearch/algoliasearch-tests.ts @@ -97,6 +97,7 @@ let _algoliaIndexSettings: IndexSettings = { minProximity: 0, placeholders: { '': [''] }, camelCaseAttributes: [''], + sortFacetValuesBy: 'count', }; let _algoliaQueryParameters: QueryParameters = { diff --git a/types/algoliasearch/index.d.ts b/types/algoliasearch/index.d.ts index e799ee1832..f25d901f73 100644 --- a/types/algoliasearch/index.d.ts +++ b/types/algoliasearch/index.d.ts @@ -1455,7 +1455,7 @@ declare namespace algoliasearch { /** * https://www.algolia.com/doc/api-reference/api-parameters/sortFacetValuesBy/ */ - sortFacetValuesBy?: "count"|"alpha"; + sortFacetValuesBy?: 'count' | 'alpha'; } namespace SearchForFacetValues { @@ -1781,6 +1781,8 @@ declare namespace algoliasearch { https://www.algolia.com/doc/api-reference/api-parameters/camelCaseAttributes/ */ camelCaseAttributes?: string[]; + + sortFacetValuesBy?: 'count' | 'alpha'; } interface Response { diff --git a/types/algoliasearch/lite/index.d.ts b/types/algoliasearch/lite/index.d.ts index a3babc339b..5c9457df22 100644 --- a/types/algoliasearch/lite/index.d.ts +++ b/types/algoliasearch/lite/index.d.ts @@ -535,7 +535,7 @@ declare namespace algoliasearch { /** * https://www.algolia.com/doc/api-reference/api-parameters/sortFacetValuesBy/ */ - sortFacetValuesBy?: "count"|"alpha"; + sortFacetValuesBy?: 'count' | 'alpha'; } namespace SearchForFacetValues {