Skip to content
qubeequbee
API/SieveRequestStrategy

SieveRequestStrategy

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

Request strategy for the Sieve (.NET) driver

Generates URIs in Sieve’s compact expression format:

  • Filters: a single filters= parameter holding comma-joined (AND) Field{op}Value terms; multi-value terms use the pipe (OR) on the value side (status==active|pending)
  • Operator filters: translated from FilterOperatorEnum — see the mapping on _formatOperatorTerms
  • Sorts: sorts=field,-other (CSV, - prefix = DESC)
  • Pagination: page=N&pageSize=N

Sieve has no per-model field selection, no relation includes, no flat column selection, and no global search parameter — the corresponding fluent methods throw the matching Unsupported*Error. PostgREST-native full-text search operators (FTS, PHFTS, PLFTS, WFTS) throw UnsupportedFilterOperatorError.

Constructor

Section titled “Constructor”
new SieveRequestStrategy()

Properties

Section titled “Properties”
Property Type Description
capabilities StrategyCapabilities Filters, operator filters, sorts — no per-model fields, no includes, no flat select, no global search (use CONTAINS / ILIKE operator filters for partial matches)

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 Sieve-format query-string segments in canonical order: filters → sorts → page → pageSize

Parameter Type Description
state QueryBuilderState The current query builder state
options QueryBuilderOptions The query parameter key name configuration (used for page, whose default matches the wire format; the filters / sorts / pageSize 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