Get the total_count and the data in one request

[dboeck]

Apparently, the SAP CLOUD SDK does not offer a direct way to return the count (total_count) of an entity requested from sap and the actual data in a single request, even though the SAP API actually allows this with the parameter $count=true. There seems to be only the option to fetch the count in a separate request (https://sap.github.io/cloud-sdk/docs/js/v3/features/odata/common/operations/count), which would mean we would have to send each request for a table twice... which, of course, would be very slow.

For this reason, when we need the total_count of the entity in the requests, we have to "work around" the SAP CLOUD SDK and send the query as a raw request, including a custom query parameter. If there is a different way to get the total_count and the data in one request with the typescript SAP CLOUD SDK i'm happy to here from you :-)

Here’s the code example:

const { records, count } = await dealer_StockSetApi
        .requestBuilder()
        .getAll()
        .select(
          dealer_StockSetApi.schema.KUNNR,
          dealer_StockSetApi.schema.MATNR,
          dealer_StockSetApi.schema.MENGE,
          dealer_StockSetApi.schema.DATUM
        )
        .filter(...filters)
        .skip(skip)
        .top(top)
        .orderBy(sorting)
        .addCustomQueryParameters({
          $count: 'true',
        })
        .executeRaw(destinationFetchOptions)
        .then((response) => {
          return deserializeRawResponse(response, dealer_StockSetApi)
        })

import { defaultDeSerializers, entityDeserializer, EntityApi, EntityBase } from '@sap-cloud-sdk/odata-v4'
import { DeserializeRawResponseReturn, HttpRawResponse, HttpRawResponseRecord } from './types'

const deserializeRawResponse = <RecordData = HttpRawResponseRecord>(
  response: HttpRawResponse,
  entity: EntityApi<EntityBase, any>
): DeserializeRawResponseReturn<RecordData> => {
  const deserializer = entityDeserializer(defaultDeSerializers)
  return {
    records: response.data.value.map((json: any) => deserializer.deserializeEntity(json, entity) as RecordData),
    count: response.data['@odata.count'],
  }
}

export { deserializeRawResponse }