pagination

func GetNextCursorFromPageSize ¶

func GetNextCursorFromPageSize(objectsInPage int, pageSize int64, currentCursor int64) (nextCursor *int64)

GetNextCursorFromPageSize computes the next cursor based on the number of objects in the current page, the current cursor, and the page size.

func MarshalCursor ¶

func MarshalCursor[T int64 | string](cursor *CompositeCursor[T]) (string, *framework.Error)

MarshalCursor marshals the cursor into a base64 encoded JSON string. If marshalling fails, an error is returned.

func PaginateObjects ¶

func PaginateObjects[T int64 | string](
	objects []map[string]any,
	pageSize int64,
	cursor *CompositeCursor[T],
) (
	[]map[string]any,
	*T,
	*framework.Error,
)

PaginateObjects implements pagination for APIs that do not support pagination on the server side. It returns a requested page from available records along with a cursor for the next page.

func UpdateNextCursorFromCollectionAPI ¶

func UpdateNextCursorFromCollectionAPI[T int64 | string, Request any](
	ctx context.Context,
	cursor *CompositeCursor[T],
	getPageFunc func(
		ctx context.Context, request *Request,
	) (
		int, string, []map[string]any, *CompositeCursor[T], *framework.Error,
	),
	collectionRequest *Request,
	uniqueIDAttribute string,
) (bool, *framework.Error)

UpdateNextCursorFromCollectionAPI populates the provided cursor in place based on the following rules:

1. If `cursor.Cursor` is set, we're in the middle of syncing a page of member entity objects for a collection so we should exit early without modifying the cursor.
2. If `cursor.Cursor` is not set, we need to determine the current collection ID to use. In this case, we'll use the provided `getPageFunc` and `collectionRequest` to request the next collection object. If `cursor.CollectionCursor` is not set we're at the start of a sync so we'll request the first collection object. Otherwise, we'll use the `cursor.CollectionCursor` to request the correct collection object.
3. If there is a collection object returned, set the `cursor.CollectionID`.
4. If there is a cursor to the next collection object, we'll save that as `cursor.CollectionCursor`, which will be used to request the next collection object after we process all pages of member objects for the current collection.
5. If the current collection page does not return any objects, we're done with the current sync and should set `cursor.CollectionID` and `cursor.CollectionCursor` to nil and return.

The provided `getPageFunc` should make a request to the collection API based on the provided `collectionRequest` and parse / return the expected fields. The `collectionRequest` MUST have a page size set to 1, as well as setting any additional params required by the function called in `getPageFunc` to request data from the API.

func ValidateCompositeCursor ¶

func ValidateCompositeCursor[T int64 | string](
	cursor *CompositeCursor[T], entityExternalID string, isMemberEntity bool,
) *framework.Error

ValidateCompositeCursor validates that the composite cursor is correctly set. The following rules are enforced: 1) If the entity is a member entity, then CollectionID must be set. 2) If the entity is not a member entity, then CollectionID and CollectionCursor must be nil.

If no cursor is provided, this returns nil.