No way to modify totalResults and itemsPerPage in the ListResponse result

[anthwal]

I am using the ListResponse class to return a paginated response for User resources, which are retrieved from my application's database.
Is there a way to modify the itemsPerPage and totalResults properties of the ListResponse?
I am passing the itemsPerPage value from the params to the ListResponse to my SQL query which should correctly return the specified number of records from the database but the totalResults is meant to be a number showing count of the total records which satisfy the given conditions.

In my case the ListResponse returns the records which my database query returns.

new ListResponse(
  resultRows,
  {
    sortBy: sortBy,
    sortOrder: sortOrder,
    startIndex: pgStart,
    itemsPerPage: limit,
  }
)

// response
{
  schemas: [ 'urn:ietf:params:scim:api:messages:2.0:ListResponse' ],
  totalResults: 1,
  Resources: [
    {
      id: 1,
      email: '[email protected]',
    }
  ],
  startIndex: 1,
  itemsPerPage: 20
}
    

here the totalResults is showing the length of the Resources property of the ListResponse, but I am not able to find a way to change it to the calculated value of 8.
And the itemsPerPage value in the result is always 20, I provided the itemsPerPage param value as 1.

[sleelin]

Hi @anthwal, thanks for reaching out!
Apologies for the confusion, I've realised it's not explicitly documented anywhere that the totalResults property is set using the length property of the array passed in to the ListResponse constructor, and can be modified by manipulating the length property of said array (by taking advantage of JavaScript's sparse array functionality, this does not cause the results to be filled with empty values). Using your example, this would look something like the following:

const totalResults = someDatabaseCountMethod({sortBy, sortOrder});
const resultsRow = someDatabaseSelectMethod({sortBy, sortOrder, pgStart, limit});

new ListResponse(
    Object.assign(resultRows, {length: totalResults}),
    {
        sortBy, sortOrder,
        startIndex: pgStart,
        itemsPerPage: limit
    }
);

Regarding the itemsPerPage property, it will fall back to the default value of 20 when both the itemsPerPage and count parameters are undefined - could you please confirm that the limit variable you assign to itemsPerPage is your expected value of 1?

I'm also curious as to what your use case is for using the ListResponse class directly, as opposed to the SCIMMY.Resources.User class, which automates the parameter parsing and instantiation of list responses on read?

Thanks,
Sam