Skip to content
qubeequbee
API/StrapiRequestStrategy

StrapiRequestStrategy

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

Request strategy for the Strapi driver

Generates URIs in Strapi’s filter API format:

  • Filters: filters[field][$eq]=value (multi-value collapses to $in)
  • Operator filters: filters[field][$op]=value (translated from FilterOperatorEnum — BTW→$between, SW→$startsWith, ILIKE→$containsi, NOT→$ne/$notIn, NULL→$null/$notNull)
  • Sorts: sort[0]=field:asc&sort[1]=field:desc
  • Field selection (flat): fields[0]=col1&fields[1]=col2
  • Population: populate[0]=relation
  • Pagination (page-based): pagination[page]=N&pagination[pageSize]=N

Strapi-native full-text search (FTS, PHFTS, PLFTS, WFTS) is PostgREST-only and throws UnsupportedFilterOperatorError here.

Constructor

Section titled “Constructor”
new StrapiRequestStrategy()

Properties

Section titled “Properties”
Property Type Description
capabilities StrategyCapabilities Filters, operator filters, sorts, populate (includes), flat field selection (select) — no per-model fields, no global search (use $contains / $containsi operator filters instead)

Methods

Section titled “Methods”

assertResource()

Section titled “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()

Section titled “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()

Section titled “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()

Section titled “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()

Section titled “parts()”
parts(state: QueryBuilderState, _options: QueryBuilderOptions): string[]

Emit Strapi-format query-string segments in canonical order: populate → fields → filters (merged) → sort → pagination

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

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

Returns — Ordered query-string fragments

validateLimit()

Section titled “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