Skip to content
qubeequbee
API/DirectusRequestStrategy

DirectusRequestStrategy

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

Request strategy for the Directus driver

Generates URIs in Directus’ query format:

  • Filters: filter[field][_eq]=value (multi-value collapses to _in)
  • Operator filters: filter[field][_op]=value (translated from FilterOperatorEnum — BTW→_between, SW→_starts_with, ILIKE→_icontains, NOT→_neq/_nin, NULL→_null/_nnull)
  • Sorts: sort=-created_at,name (CSV, - prefix = DESC)
  • Field selection / relations: a single fields= CSV — flat columns from addSelect, whole relations from addIncludes (rel.*), and column-projected relations from addEmbedded (rel.col1,rel.col2)
  • Search: search=term (global full-text search)
  • Metadata: a constant meta=total_count,filter_count so responses carry the totals the response strategy needs
  • Pagination (page-based): limit=N&page=N

The filter / sort / fields / search / limit / page keys honour the existing QueryBuilderOptions names (their defaults match the Directus wire format); meta is fixed by the server and lives as a private static. Directus’ deep[...] relational query options and nested relation filtering are out of scope.

PostgREST-native full-text search operators (FTS, PHFTS, PLFTS, WFTS) throw UnsupportedFilterOperatorError — use search or the CONTAINS / ILIKE operator filters instead.

Constructor

Section titled “Constructor”
new DirectusRequestStrategy()

Properties

Section titled “Properties”
Property Type Description
capabilities StrategyCapabilities Filters, operator filters, sorts, flat select, includes and embedded (both folding into fields=), global search — no per-model fields (Directus scopes relational projections with dot paths, not a fields[model] map)

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 Directus-format query-string segments in canonical order: filter (merged) → sort → fields → search → meta → limit → page

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

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