feat(api): Create a paginate method

[muntaxir4]

Description

Added common/paginate.ts and common/paginate.spec.ts under api. The paginate method takes totalCount, realtiveUrl, query and defaultQuery.

• The totalCount is usually calculated by the calling method using prisma.[table].count() without any filters like page and limit.
• relativeUrl is the the endpoint for a service function. Eg: /workspace-role/${workspaceId}/all
• query belongs to QueryOptions necessary to do pagination and defaultQuery are extra queries that could be provided.

Fixes #345

Dependencies

Mention any dependencies/packages used

Future Improvements

Mention any improvements to be done in future related to any file/feature

Mentions

Mention and tag the people

Screenshots of relevant screens

1 Test Suite and 4 Test Cases are added. Passes paginate unit tests.

Developer's checklist

• [x] My PR follows the style guidelines of this project
• [x] I have performed a self-check on my work

If changes are made in the code:

• [x] I have followed the coding guidelines
• [x] My changes in code generate no new warnings
• [ ] My changes are breaking another fix/feature of the project
• [x] I have added test cases to show that my feature works
• [x] I have added relevant screenshots in my PR
• [x] There are no UI/UX issues

Documentation Update

• [ ] This PR requires an update to the documentation at docs.keyshade.xyz
• [x] I have made the necessary updates to the documentation, or no documentation changes are required.

[codiumai-pr-agent-free[bot]]

Failed to generate code suggestions for PR

[rajdip-b]

Hey bro! Looks like you've already added this in #382. I'm closing this PR and this issue to the other PR.

[muntaxir4]

Actually #382 is branched from this. Every other pagination is dependent on this @rajdip-b

[rajdip-b]

Yeah, I understand that. Okay so lets do this. I'm merging this since it is not dependent on foss hack. And, you can use this in your other PRs.

[codiumai-pr-agent-free[bot]]

Failed to generate code suggestions for PR

[muntaxir4]

Yeah, I understand that. Okay so lets do this. I'm merging this since it is not dependent on foss hack. And, you can use this in your other PRs.

Yeah sure. Thanks

[muntaxir4]

Yeah, I understand that. Okay so lets do this. I'm merging this since it is not dependent on foss hack. And, you can use this in your other PRs.

By the way, why this isn't in the foss hack? The parent issue has the label. :')

[rajdip-b]

Yeah, I understand that. Okay so lets do this. I'm merging this since it is not dependent on foss hack. And, you can use this in your other PRs.

By the way, why this isn't in the foss hack? The parent issue has the label. :')

Actually, since the feature implemented in this issue would be used by all the other issues, I marked it as non FOSS so that once the implementation is done I can quickly merge it. That way, others would be able to use this feature.