Skip to content
qubeequbee
API/PocketbaseRequestStrategy

PocketbaseRequestStrategy

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

Request strategy for the PocketBase driver

Generates URIs in PocketBase’s records-list format:

  • Filters: a single filter=(...) expression-language parameter — simple single-value filters fold to field='value', multi-value filters fold to an OR group ((field='v1' || field='v2')), and all clauses join with && — sent as %26%26, since a raw & would end the parameter
  • Operator filters: expression terms (field>=10, field~'val') — see the mapping on _formatOperatorClause
  • Sorts: sort=-created,title (CSV, - prefix = DESC)
  • Field selection (flat): fields=id,title (CSV)
  • Relation expansion: expand=author,comments (CSV)
  • Pagination (page-based): page=N&perPage=M

The page / perPage / sort / filter / expand / fields keys are fixed by the PocketBase records API and intentionally not configurable through QueryBuilderOptions; they live as private statics so they are visible in one place.

String literals are single-quoted with embedded quotes backslash-escaped (name='O\'Brien'); numbers and booleans emit bare. PocketBase has no global search param (use ~ terms instead) and no per-model field selection — the corresponding fluent methods throw the matching Unsupported*Error. The PostgREST-native full-text operators (FTS, PHFTS, PLFTS, WFTS) throw UnsupportedFilterOperatorError.

Constructor

Section titled “Constructor”
new PocketbaseRequestStrategy()

Properties

Section titled “Properties”
Property Type Description
capabilities StrategyCapabilities Filters, operator filters, sorts, expand (includes), flat field selection (select) — no per-model fields, no global search, 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)

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 PocketBase-format query-string segments in canonical order: expand → fields → filter (merged) → sort → page → perPage

Simple filters and operator filters share the single filter=(...) parameter so the server receives one combined expression rather than two conflicting filter params.

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