From 56e79326291eeb75b7f8c0a9ca8478fd5af15abb Mon Sep 17 00:00:00 2001 From: Oliver Sand Date: Mon, 16 Aug 2021 11:29:50 +0200 Subject: [PATCH] Update API reports Signed-off-by: Oliver Sand --- packages/search-common/api-report.md | 6 +++++- .../search-backend-module-elasticsearch/api-report.md | 2 ++ plugins/search-backend-module-pg/api-report.md | 10 +++++++++- plugins/search/api-report.md | 4 +++- 4 files changed, 19 insertions(+), 3 deletions(-) diff --git a/packages/search-common/api-report.md b/packages/search-common/api-report.md index 055f2d152f..b4fcac22ca 100644 --- a/packages/search-common/api-report.md +++ b/packages/search-common/api-report.md @@ -53,7 +53,9 @@ export interface SearchQuery { // (undocumented) filters?: JsonObject; // (undocumented) - pageCursor: string; + limit?: number; + // (undocumented) + offset?: number; // (undocumented) term: string; // (undocumented) @@ -76,6 +78,8 @@ export interface SearchResult { export interface SearchResultSet { // (undocumented) results: SearchResult[]; + // (undocumented) + totalCount: number; } // (No @packageDocumentation comment for this package) diff --git a/plugins/search-backend-module-elasticsearch/api-report.md b/plugins/search-backend-module-elasticsearch/api-report.md index eac76a30b9..e538201bc0 100644 --- a/plugins/search-backend-module-elasticsearch/api-report.md +++ b/plugins/search-backend-module-elasticsearch/api-report.md @@ -45,6 +45,8 @@ export class ElasticSearchSearchEngine implements SearchEngine { term, filters, types, + offset, + limit, }: SearchQuery): ConcreteElasticSearchQuery; } diff --git a/plugins/search-backend-module-pg/api-report.md b/plugins/search-backend-module-pg/api-report.md index 23a1f3ecbb..4879e64d06 100644 --- a/plugins/search-backend-module-pg/api-report.md +++ b/plugins/search-backend-module-pg/api-report.md @@ -18,6 +18,8 @@ export class DatabaseDocumentStore implements DatabaseStore { // (undocumented) completeInsert(tx: Knex.Transaction, type: string): Promise; // (undocumented) + count(tx: Knex.Transaction, searchQuery: PgSearchQuery): Promise; + // (undocumented) static create(knex: Knex): Promise; // (undocumented) insertDocuments( @@ -32,7 +34,7 @@ export class DatabaseDocumentStore implements DatabaseStore { // (undocumented) query( tx: Knex.Transaction, - { types, pgTerm, fields }: PgSearchQuery, + searchQuery: PgSearchQuery, ): Promise; // (undocumented) static supported(knex: Knex): Promise; @@ -47,6 +49,8 @@ export interface DatabaseStore { // (undocumented) completeInsert(tx: Knex.Transaction, type: string): Promise; // (undocumented) + count(tx: Knex.Transaction, pgQuery: PgSearchQuery): Promise; + // (undocumented) insertDocuments( tx: Knex.Transaction, type: string, @@ -93,6 +97,10 @@ export interface PgSearchQuery { // (undocumented) fields?: Record; // (undocumented) + limit: number; + // (undocumented) + offset: number; + // (undocumented) pgTerm?: string; // (undocumented) types?: string[]; diff --git a/plugins/search/api-report.md b/plugins/search/api-report.md index e3075a448d..616c6f2cae 100644 --- a/plugins/search/api-report.md +++ b/plugins/search/api-report.md @@ -139,8 +139,10 @@ export { searchPlugin }; // @public (undocumented) export const SearchResult: ({ children, + initialPageSize, }: { children: (results: { results: SearchResult_2[] }) => JSX.Element; + initialPageSize?: number | undefined; }) => JSX.Element; // Warning: (ae-forgotten-export) The symbol "SearchTypeProps" needs to be exported by the entry point index.d.ts @@ -167,7 +169,7 @@ export const useSearch: () => SearchContextValue; // Warnings were encountered during analysis: // -// src/components/SearchContext/SearchContext.d.ts:19:5 - (ae-forgotten-export) The symbol "SettableSearchContext" needs to be exported by the entry point index.d.ts +// src/components/SearchContext/SearchContext.d.ts:23:5 - (ae-forgotten-export) The symbol "SettableSearchContext" needs to be exported by the entry point index.d.ts // src/components/SearchFilter/SearchFilter.d.ts:13:5 - (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts // src/components/SearchFilter/SearchFilter.d.ts:14:5 - (ae-forgotten-export) The symbol "Component" needs to be exported by the entry point index.d.ts