ObjectStackSearch Engine
Search Engine protocol schemas
Source: packages/spec/src/system/search-engine.zod.ts
TypeScript Usage
import { AnalyzerConfigSchema, FacetConfigSchema, SearchConfigSchema, SearchIndexConfigSchema, SearchProviderSchema } from '@objectstack/spec/system';
import type { AnalyzerConfig, FacetConfig, SearchConfig, SearchIndexConfig, SearchProvider } from '@objectstack/spec/system';
// Validate data
const result = AnalyzerConfigSchema.parse(data);AnalyzerConfig
Text analyzer configuration for index tokenization and normalization
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| type | Enum<'standard' | 'simple' | 'whitespace' | 'keyword' | 'pattern' | 'language'> | ✅ | Text analyzer type |
| language | string | optional | Language for language-specific analysis |
| stopwords | string[] | optional | Custom stopwords to filter during analysis |
| customFilters | string[] | optional | Additional token filter names to apply |
FacetConfig
Faceted search configuration for a single field
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| field | string | ✅ | Field name to generate facets from |
| maxValues | number | optional (default: 10) | Maximum number of facet values to return |
| sort | Enum<'count' | 'alpha'> | optional (default: "count") | Facet value sort order |
SearchConfig
Top-level full-text search engine configuration
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| provider | Enum<'elasticsearch' | 'algolia' | 'meilisearch' | 'typesense' | 'opensearch'> | ✅ | Search engine backend provider |
| indexes | { indexName: string; objectName: string; fields: object[]; replicas: number; … }[] | ✅ | Search index definitions |
| analyzers | Record<string, { type: Enum<'standard' | 'simple' | 'whitespace' | 'keyword' | 'pattern' | 'language'>; language?: string; stopwords?: string[]; customFilters?: string[] }> | optional | Named text analyzer configurations |
| facets | { field: string; maxValues: number; sort: Enum<'count' | 'alpha'> }[] | optional | Faceted search configurations |
| typoTolerance | boolean | optional (default: true) | Enable typo-tolerant search |
| synonyms | Record<string, string[]> | optional | Synonym mappings for search expansion |
| ranking | Enum<'typo' | 'geo' | 'words' | 'filters' | 'proximity' | 'attribute' | 'exact' | 'custom'>[] | optional | Custom ranking rule order |
Nested Shape: SearchConfig.indexes[number]
Search index definition mapping an ObjectQL object to a search engine index
| Property | Type | Required | Description |
|---|---|---|---|
| indexName | string | ✅ | Name of the search index |
| objectName | string | ✅ | Source ObjectQL object |
| fields | { name: string; type: Enum<'text' | 'keyword' | 'number' | 'date' | 'boolean' | 'geo'>; analyzer?: string; searchable: boolean; … }[] | ✅ | Fields to include in the search index |
| replicas | number | optional (default: 1) | Number of index replicas for availability |
| shards | number | optional (default: 1) | Number of index shards for distribution |
Nested Shape: SearchConfig.analyzers[string]
Text analyzer configuration for index tokenization and normalization
| Property | Type | Required | Description |
|---|---|---|---|
| type | Enum<'standard' | 'simple' | 'whitespace' | 'keyword' | 'pattern' | 'language'> | ✅ | Text analyzer type |
| language | string | optional | Language for language-specific analysis |
| stopwords | string[] | optional | Custom stopwords to filter during analysis |
| customFilters | string[] | optional | Additional token filter names to apply |
Nested Shape: SearchConfig.facets[number]
Faceted search configuration for a single field
| Property | Type | Required | Description |
|---|---|---|---|
| field | string | ✅ | Field name to generate facets from |
| maxValues | number | optional (default: 10) | Maximum number of facet values to return |
| sort | Enum<'count' | 'alpha'> | optional (default: "count") | Facet value sort order |
SearchIndexConfig
Search index definition mapping an ObjectQL object to a search engine index
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| indexName | string | ✅ | Name of the search index |
| objectName | string | ✅ | Source ObjectQL object |
| fields | { name: string; type: Enum<'text' | 'keyword' | 'number' | 'date' | 'boolean' | 'geo'>; analyzer?: string; searchable: boolean; … }[] | ✅ | Fields to include in the search index |
| replicas | number | optional (default: 1) | Number of index replicas for availability |
| shards | number | optional (default: 1) | Number of index shards for distribution |
Nested Shape: SearchIndexConfig.fields[number]
| Property | Type | Required | Description |
|---|---|---|---|
| name | string | ✅ | Field name to index |
| type | Enum<'text' | 'keyword' | 'number' | 'date' | 'boolean' | 'geo'> | ✅ | Index field data type |
| analyzer | string | optional | Named analyzer to use for this field |
| searchable | boolean | optional (default: true) | Include field in full-text search |
| filterable | boolean | optional (default: false) | Allow filtering on this field |
| sortable | boolean | optional (default: false) | Allow sorting by this field |
| boost | number | optional (default: 1) | Relevance boost factor for this field |
SearchProvider
Supported full-text search engine provider
Allowed Values
elasticsearchalgoliameilisearchtypesenseopensearch