Home / Docs / gn-vquery

Supported Host API

Commercial / SemVer contract for @gerald-neumann/gn-vquery.

Tier Import Promise
Core @gerald-neumann/gn-vquery Stable host path — prefer for new integrations
Advanced same root (documented below) Supported but richer; shapes frozen with care
Internal @gerald-neumann/gn-vquery/advanced May change in minors; not the happy path

Core (happy path)

Surface Notes
VQueryChip, VQueryFieldConfig, VQueryFieldOption, operators / kinds Chip + catalog model
chipsToAdvancedQuery, chipsToReqlWhere, compileVQuery Dialect compilers
GnVQueryChipBarElement, registerGnVQueryChipBar, GN_VQUERY_CHIP_BAR_TAG Custom Element
Events: chips-change, preset-chip-remove, notice Host wiring
commitPendingDraft(), focusDraft() Host toolbar / focus
serializeVQueryChips, deserializeVQueryChips, createVQueryChipId, vqueryChipsEqual Persistence
applyCompiledQueryToVTable, applyCompiledQueryToVGantt + reload host types Table / Gantt glue
styles/vquery-chip-bar.css, styles/vquery-chip-bubbles.css Required chrome
--vquery-* tokens and vquery-chip* / vquery-chip-bar* class names Versioned style contract (light DOM)

Field catalog knobs (Core)

Advanced (package root)

Surface Notes
parseReql, tokenizeReql, validateReqlWhere Structure / validation only — not SQL
mergeReqlWhere, stripReqlWhere, normalizeReqlWhereFragment, normalizeAdvancedQuery, mergeAdvancedQueryParts Fragment merge
createCommittedChipElement, fieldChipParts, bubble shape helpers Custom chip chrome
parseNegationPrefix, parseComparatorPrefix, vqueryOperatorDisplay, operator defaults Draft / authoring helpers
rankLabeledSuggestions, participatesInFreeTextSearch, isYearMonthFreeTextField Helpers

Internal (@gerald-neumann/gn-vquery/advanced)

Surface Notes
escapeAdvancedQueryValue, escapeReqlLiteral Escaping
splitAdvancedQueryCsvTerms, splitReqlCsvTerms, stripSubstringOperator Tokenization
isYearMonthKey, REQL format helpers (quoteReqlIdentifier, toReqlLikePattern, …) Low-level
chipsToFilterQuery, mergeOverviewFilterParts Deprecated aliases
import { escapeAdvancedQueryValue } from '@gerald-neumann/gn-vquery/advanced';

Compile semantics

Full table: COMPILE-MATRIX.md.

Chip Advanced Query REQL
Free-text OR across text fields with includeInFreeText !== false Same participation
Text ~ CSV OR of field~term LIKE / terms
Equality = CSV (text / enum / number) OR of field=term; negated → AND of != (enum negated → not (… OR …)) IN / OR of comparisons
Quarter facet OR of month equalities via quarterMonthField Same

See also package README and CHANGELOG.