API/PayloadRequestStrategy

PayloadRequestStrategy

src/strategies/payload-request.strategy.ts6 public methodsclass

Request strategy for the Payload CMS driver

Generates URIs in Payload’s REST query format:

Filters: where[field][equals]=value (multi-value collapses to where[field][in]=v1,v2 CSV)
Operator filters: where[field][op]=value (translated from FilterOperatorEnum — BTW→greater_than_equal+less_than_equal pair, NOT→not_equals/not_in, NULL→exists with inverted boolean)
Sorts: sort=-createdAt,title (CSV, - prefix = DESC)
Field selection (flat): select[col1]=true&select[col2]=true
Pagination (page-based): page=N&limit=M

The where / sort / select / page / limit keys are fixed by Payload’s REST endpoints and intentionally not configurable through QueryBuilderOptions; they live as private statics so they are visible in one place.

Relationship population is controlled by Payload’s numeric depth param, not a named-relation list — addIncludes therefore throws UnsupportedIncludesError (pass depth through your HTTP layer if needed). There is no per-model field selection and no global search param. SW (no starts-with operator) and the PostgREST-native full-text operators (FTS, PHFTS, PLFTS, WFTS) throw UnsupportedFilterOperatorError.

Constructor

new PayloadRequestStrategy()

Properties

Property	Type	Description
`capabilities`	`StrategyCapabilities`	Filters, operator filters, sorts, flat field selection (`select`) — no per-model fields, no includes (numeric `depth` instead), no global search, no embedded resources

Methods

assertResource()

assertResource(state: QueryBuilderState): void

Throw if the resource is not set on the state

Centralises the message that was previously copy-pasted across four of the five concrete strategies.

Parameter	Type	Description
`state`	`QueryBuilderState`	The current query builder state

baseUri()

baseUri(state: QueryBuilderState): string

Compute the base path (no query string)

Parameter	Type	Description
`state`	`QueryBuilderState`	The current query builder state

Returns — The base URI without the query separator (e.g. /users or https://api.example.com/users)

buildUri()

buildUri(state: QueryBuilderState, options: QueryBuilderOptions): string

Compose the full request URI from the given state

Template method: validates the resource, computes the base path, delegates the per-driver query-string segments to parts(...), and joins them with the conventional ?/& separators.

Parameter	Type	Description
`state`	`QueryBuilderState`	The current query builder state
`options`	`QueryBuilderOptions`	The query parameter key name configuration

Returns — The composed URI string

join()

join(base: string, segments: string[]): string

Glue the base URI and the per-driver query-string segments

Returns the bare base when no segments were emitted (e.g. PostgREST in RANGE mode with no filters), otherwise joins with ? + &.

Parameter	Type	Description
`base`	`string`	The base URI from `_baseUri`
`segments`	`string[]`	The query-string fragments from `parts(...)`

Returns — The full URI

parts()

parts(state: QueryBuilderState, _options: QueryBuilderOptions): string[]

Emit Payload-format query-string segments in canonical order: where (merged) → sort → select → page → limit

Simple filters and operator filters share a single where wrapper so stringify() emits one ordered bracket structure rather than two duplicate top-level where[...] blocks.

Parameter	Type	Description
`state`	`QueryBuilderState`	The current query builder state
`_options`	`QueryBuilderOptions`	The query parameter key name configuration (unused; Payload’s wire keys are fixed by the server)

Returns — Ordered query-string fragments

validateLimit()

validateLimit(limit: number): void

Validate that a limit value is acceptable for this driver

Default policy: positive integer. Drivers that recognise a sentinel (NestJS treats -1 as “fetch all”) override this method.

Parameter	Type	Description
`limit`	`number`	The limit value to validate