From 9bb980d23f854d00ee65dc3fb69ecdaf3913c989 Mon Sep 17 00:00:00 2001 From: Vincenzo Scamporlino Date: Wed, 1 Feb 2023 20:58:51 +0100 Subject: [PATCH] catalog-client: make getPaginatedEntities non optional Signed-off-by: Vincenzo Scamporlino --- packages/catalog-client/api-report.md | 4 ++-- packages/catalog-client/src/CatalogClient.test.ts | 14 +++++++------- packages/catalog-client/src/CatalogClient.ts | 2 +- packages/catalog-client/src/types/api.ts | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/packages/catalog-client/api-report.md b/packages/catalog-client/api-report.md index e39fa7eb8d..1abc90d24c 100644 --- a/packages/catalog-client/api-report.md +++ b/packages/catalog-client/api-report.md @@ -58,7 +58,7 @@ export interface CatalogApi { locationRef: string, options?: CatalogRequestOptions, ): Promise; - getPaginatedEntities?( + getPaginatedEntities( request?: GetPaginatedEntitiesRequest, options?: CatalogRequestOptions, ): Promise; @@ -128,7 +128,7 @@ export class CatalogClient implements CatalogApi { locationRef: string, options?: CatalogRequestOptions, ): Promise; - getPaginatedEntities?( + getPaginatedEntities( request?: GetPaginatedEntitiesRequest, options?: CatalogRequestOptions, ): Promise; diff --git a/packages/catalog-client/src/CatalogClient.test.ts b/packages/catalog-client/src/CatalogClient.test.ts index 9dc60da193..fde54adeb6 100644 --- a/packages/catalog-client/src/CatalogClient.test.ts +++ b/packages/catalog-client/src/CatalogClient.test.ts @@ -307,7 +307,7 @@ describe('CatalogClient', () => { }); it('should fetch entities from correct endpoint', async () => { - const response = await client.getPaginatedEntities?.({}, { token }); + const response = await client.getPaginatedEntities({}, { token }); expect(response?.entities).toEqual(defaultClientResponse.entities); expect(response?.totalItems).toEqual(defaultClientResponse.totalItems); expect(response?.nextCursor).toBeDefined(); @@ -323,7 +323,7 @@ describe('CatalogClient', () => { server.use(rest.get(`${mockBaseUrl}/v2/entities`, mockedEndpoint)); - const response = await client.getPaginatedEntities?.( + const response = await client.getPaginatedEntities( { filter: [ { @@ -358,7 +358,7 @@ describe('CatalogClient', () => { server.use(rest.get(`${mockBaseUrl}/v2/entities`, mockedEndpoint)); - await client.getPaginatedEntities?.({ + await client.getPaginatedEntities({ fields: ['a', 'b'], limit: 100, query: 'query', @@ -381,7 +381,7 @@ describe('CatalogClient', () => { server.use(rest.get(`${mockBaseUrl}/v2/entities`, mockedEndpoint)); - await client.getPaginatedEntities?.({ + await client.getPaginatedEntities({ fields: ['a', 'b'], limit: 100, query: 'query', @@ -424,7 +424,7 @@ describe('CatalogClient', () => { server.use(rest.get(`${mockBaseUrl}/v2/entities`, mockedEndpoint)); - const response = await client.getPaginatedEntities?.({ + const response = await client.getPaginatedEntities({ limit: 2, }); expect(mockedEndpoint.mock.calls[0][0].url.search).toBe('?limit=2'); @@ -432,12 +432,12 @@ describe('CatalogClient', () => { expect(response?.nextCursor).toBeDefined(); expect(response?.prevCursor).toBeDefined(); - await client.getPaginatedEntities?.({ cursor: response!.nextCursor! }); + await client.getPaginatedEntities({ cursor: response!.nextCursor! }); expect(mockedEndpoint.mock.calls[1][0].url.search).toBe( '?cursor=nextcursor', ); - await client.getPaginatedEntities?.({ cursor: response!.prevCursor! }); + await client.getPaginatedEntities({ cursor: response!.prevCursor! }); expect(mockedEndpoint.mock.calls[2][0].url.search).toBe( '?cursor=prevcursor', ); diff --git a/packages/catalog-client/src/CatalogClient.ts b/packages/catalog-client/src/CatalogClient.ts index 8af2a40ccd..6d7188edbb 100644 --- a/packages/catalog-client/src/CatalogClient.ts +++ b/packages/catalog-client/src/CatalogClient.ts @@ -207,7 +207,7 @@ export class CatalogClient implements CatalogApi { /** * {@inheritdoc CatalogApi.getPaginatedEntities} */ - async getPaginatedEntities?( + async getPaginatedEntities( request: GetPaginatedEntitiesRequest = {}, options?: CatalogRequestOptions, ): Promise { diff --git a/packages/catalog-client/src/types/api.ts b/packages/catalog-client/src/types/api.ts index 168dbbcaff..667bc3d8f0 100644 --- a/packages/catalog-client/src/types/api.ts +++ b/packages/catalog-client/src/types/api.ts @@ -503,7 +503,7 @@ export interface CatalogApi { * @param request - Request parameters * @param options - Additional options */ - getPaginatedEntities?( + getPaginatedEntities( request?: GetPaginatedEntitiesRequest, options?: CatalogRequestOptions, ): Promise;