Skip to content
qubeequbee
API/DrfRequestStrategy

DrfRequestStrategy

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

Request strategy for the Django REST Framework (DRF) driver

Generates URIs in DRF’s flat query-parameter format, augmented by django-filter’s double-underscore lookup convention:

  • Simple filters: field=value (multi-value collapses to field__in=v1,v2)
  • Operator filters: field__lookup=value (translated from FilterOperatorEnum — GTE→__gte, ILIKE→__icontains, BTW→__range, NULL→__isnull, etc.)
  • Ordering: ordering=-field1,field2 (- prefix = DESC)
  • Search: search=term (DRF’s SearchFilter)
  • Pagination: page=N&page_size=M (PageNumberPagination)

ordering and page_size are DRF-idiomatic param names and are intentionally not configurable via QueryBuilderOptions — same precedent as PostgREST’s order and offset. PostgREST’s full-text search operators (FTS, PHFTS, PLFTS, WFTS) and the generic NOT have no django-filter equivalent and throw UnsupportedFilterOperatorError.

Constructor

Section titled “Constructor”
new DrfRequestStrategy()

Properties

Section titled “Properties”
Property Type Description
capabilities StrategyCapabilities Simple filters, operator filters (django-filter lookups), sorts, and global search — no per-model fields, no relation includes, no flat select (django-restql adds it but is not core DRF)

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)

Exactly one slash joins the two: trailing slashes on the base URL and leading slashes on the resource are dropped, so /projects/42/tasks never becomes the protocol-relative //projects/42/tasks. A trailing slash on the resource is kept, for backends whose routes end in one. Nothing is encoded.

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.

parts(...) receives the state with filter values, operator-filter values and the search term already percent-encoded (see encodeValues), so no concrete strategy encodes on its own and none can forget to.

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 DRF-format query-string segments in canonical order: filters → operator filters → ordering → search → pagination

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

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