fix: enforcing no skip param for query options, removing uneccessary console statements, adding cbp to toc in readme [CAPI-2357]

Author: ebefarooqui

README.md

@@ -60,6 +60,7 @@
   - [Configuration](#configuration)
   - [Reference Documentation](#reference-documentation)
   - [Contentful Javascript resources](#contentful-javascript-resources)
+  - [Cursor Based Pagination](#cursor-based-pagination)
   - [REST API reference](#rest-api-reference)
 - [Versioning](#versioning)
 - [Reach out to us](#reach-out-to-us)

lib/common-types.ts

@@ -359,6 +359,7 @@ export interface BasicQueryOptions {
 }
 
 export interface BasicCursorPaginationOptions extends Omit<BasicQueryOptions, 'skip'> {
+  skip?: never
   pageNext?: string
   pagePrev?: string
 }

lib/common-utils.ts

@@ -93,6 +93,6 @@ export function normalizeCursorPaginationResponse<T>(
 
   return {
     ...data,
-    ...(Object.keys(pages).length && { pages }),
+    pages,
   }
 }

test/integration/asset-integration.test.ts

@@ -59,7 +59,7 @@ describe('Asset API - Read', () => {
     })
 
     test('returns [limit] number of items', async () => {
-      const response = await environment.getAssetsWithCursor({ limit: 3 })
+      const response = await environment.getAssetsWithCursor({ limit: 3})
 
       expect(response.items).toHaveLength(3)
       expect(response.pages).toBeDefined()

test/unit/test-creators/static-entity-methods.ts

@@ -7,7 +7,6 @@ export async function makeGetEntityTest(
   { entityType, mockToReturn, methodToTest, wrapperSuffix = '' },
 ) {
   const { api, entitiesMock } = setup(Promise.resolve(mockToReturn))
-  console.debug('HERE', entitiesMock[entityType])
   entitiesMock[entityType][`wrap${upperFirst(entityType)}${wrapperSuffix}`].mockReturnValue(
     mockToReturn,
   )