catalog-client: make getPaginatedEntities non optional

Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>

packages/catalog-client/api-report.md

@@ -58,7 +58,7 @@ export interface CatalogApi {
     locationRef: string,
     options?: CatalogRequestOptions,
   ): Promise<Location_2 | undefined>;
-  getPaginatedEntities?(
+  getPaginatedEntities(
     request?: GetPaginatedEntitiesRequest,
     options?: CatalogRequestOptions,
   ): Promise<GetPaginatedEntitiesResponse>;
@@ -128,7 +128,7 @@ export class CatalogClient implements CatalogApi {
     locationRef: string,
     options?: CatalogRequestOptions,
   ): Promise<Location_2 | undefined>;
-  getPaginatedEntities?(
+  getPaginatedEntities(
     request?: GetPaginatedEntitiesRequest,
     options?: CatalogRequestOptions,
   ): Promise<GetPaginatedEntitiesResponse>;

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',
       );

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<GetPaginatedEntitiesResponse> {

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<GetPaginatedEntitiesResponse>;