Skip to content
qubeequbee
API/JsonServerRequestStrategy

JsonServerRequestStrategy

src/strategies/json-server-request.strategy.ts6 public methodsclass

Request strategy for the json-server driver

Generates URIs in json-server’s query format — the de-facto standard mock REST API for prototyping:

  • Filters: field=value (exact, no operator); multi-value folds to the in list (field:in=v1,v2)
  • Operator filters: colon syntax field:op=value — see the mapping on _formatOperatorSegments
  • Sorts: _sort=-views,title (CSV, - prefix = DESC)
  • Search: q=term (full-text search)
  • Pagination: _page=N&_per_page=M

The underscore-prefixed system params (_page, _per_page, _sort) and the q search key are fixed by the server and intentionally not configurable through QueryBuilderOptions; they live as private statics so they are visible in one place.

json-server has no per-model field selection, no relation includes, no column projection — the corresponding fluent methods throw the matching Unsupported*Error. ILIKE (no case-insensitive variant), NULL (no null check), and the PostgREST-native full-text operators (FTS, PHFTS, PLFTS, WFTS) throw UnsupportedFilterOperatorError.

Constructor

Section titled “Constructor”
new JsonServerRequestStrategy()

Properties

Section titled “Properties”
Property Type Description
capabilities StrategyCapabilities Filters, operator filters, sorts, global search — no per-model fields, no includes, no flat select, no embedded resources

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 json-server-format query-string segments in canonical order: filters → operator filters → _sort → q → _page → _per_page

Parameter Type Description
state QueryBuilderState The current query builder state
_options QueryBuilderOptions The query parameter key name configuration (unused; json-server’s system 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