@lastshotlabs/slingshot-search

npm install @lastshotlabs/slingshot-search

Functions

createAlgoliaProvider

Algolia search provider.

HTTP-based provider that communicates with the Algolia REST API. Uses native fetch (available in Bun) with retry logic and exponential backoff.

Implements the full SearchProvider interface including lifecycle, index management, document operations, search, suggest, and task monitoring.

Algolia operations return task IDs for indexing mutations; search is synchronous.

function createAlgoliaProvider(config: AlgoliaProviderConfig): SearchProvider

Source: packages/slingshot-search/src/providers/algolia.ts

createElasticsearchProvider

Elasticsearch search provider.

HTTP-based provider that communicates with an Elasticsearch cluster via its REST API. Uses native fetch (available in Bun) with retry logic and exponential backoff.

Implements the full SearchProvider interface including lifecycle, index management, document operations, search, suggest, and task monitoring.

Elasticsearch operations are synchronous for most document/search APIs, so waitForTask is a no-op.

function createElasticsearchProvider(config: ElasticsearchProviderConfig): SearchProvider

Source: packages/slingshot-search/src/providers/elasticsearch.ts

createEventSyncManager

Event-bus sync manager.

Manages event-bus subscriptions for entities with syncMode: 'event-bus'. Supports config-driven entities discovered via the entity registry.

Batches indexing operations with a configurable flush interval and queue size threshold. Deletions are flushed immediately to avoid stale data.

All state is closure-owned — no module-level mutable state.

function createEventSyncManager(config: EventSyncManagerConfig): EventSyncManager

Source: packages/slingshot-search/src/eventSync.ts

createFileDlqStore

Event-bus sync manager.

Manages event-bus subscriptions for entities with syncMode: 'event-bus'. Supports config-driven entities discovered via the entity registry.

Batches indexing operations with a configurable flush interval and queue size threshold. Deletions are flushed immediately to avoid stale data.

All state is closure-owned — no module-level mutable state.

function createFileDlqStore(config: FileDlqStoreConfig): FileDlqStore

Source: packages/slingshot-search/src/eventSync.ts

createInMemoryRateLimitStore

In-memory token-bucket rate limiter for search and suggest routes.

The store is injectable so deployments can swap the in-memory implementation for a Redis or Memcached backend without touching the route handlers.

Default policy: 60 requests / 60 s per (tenant, ip) tuple.

function createInMemoryRateLimitStore(): RateLimitStore

Source: packages/slingshot-search/src/routes/rateLimiter.ts

createRateLimitMiddleware

In-memory token-bucket rate limiter for search and suggest routes.

The store is injectable so deployments can swap the in-memory implementation for a Redis or Memcached backend without touching the route handlers.

Default policy: 60 requests / 60 s per (tenant, ip) tuple.

function createRateLimitMiddleware(options: RateLimitOptions = {}): void

Source: packages/slingshot-search/src/routes/rateLimiter.ts

createSearchCircuitBreaker

Circuit breaker for search provider calls at the search-manager level.

Provides manager-level fail-fast behavior when a search provider is unreachable, independent of any provider-level breakers. Mirrors the pattern from slingshot-mail and slingshot-assets so operational behaviour stays uniform across production-track packages.

State machine: closed — normal operation; failures increment a counter. open — fail fast; reject every request until cooldown elapses. half-open — let exactly one probe through; success resets, failure re-opens.

function createSearchCircuitBreaker(opts: SearchCircuitBreakerOptions,): SearchCircuitBreaker

Source: packages/slingshot-search/src/searchCircuitBreaker.ts

createSearchPackage

Search package factory.

Produces a SlingshotPackageDefinition consumed via createApp({ packages: [...] }).

Lifecycle:

1. setupMiddleware — registers internal search events on the framework bus.
2. setupRoutes — mounts per-entity search, suggest, federated, and admin routers.
3. setupPost — discovers searchable entities, initializes indexes, subscribes to entity CRUD events for eventual sync, publishes the runtime through pluginState (legacy) and the SearchRuntimeCap capability.
4. teardown — flushes pending syncs and disconnects providers.

function createSearchPackage(rawConfig: SearchPluginConfig, options?: { logger?: Logger },): SlingshotPackageDefinition

Source: packages/slingshot-search/src/plugin.ts

createTypesenseProvider

Typesense search provider.

HTTP-based provider that communicates with a Typesense instance via its REST API. Uses native fetch (available in Bun) with retry logic and exponential backoff.

Implements the full SearchProvider interface including lifecycle, index management, document operations, search, suggest, and task monitoring.

Typesense operations are synchronous (no task queue), so waitForTask is a no-op.

function createTypesenseProvider(config: TypesenseProviderConfig): SearchProvider

Source: packages/slingshot-search/src/providers/typesense.ts

isTransientError

Retry with exponential backoff for search provider operations.

Transient failures (timeouts, connection resets, 5xx, 429) are retried automatically. Circuit-open errors and non-transient errors propagate immediately so the circuit breaker can maintain accurate state.

function isTransientError(err: unknown): boolean

Source: packages/slingshot-search/src/retry.ts

withRetry

Retry with exponential backoff for search provider operations.

Transient failures (timeouts, connection resets, 5xx, 429) are retried automatically. Circuit-open errors and non-transient errors propagate immediately so the circuit breaker can maintain accurate state.

async function withRetry<T>(fn: () => Promise<T>, options?: Partial<RetryOptions>,): Promise<T>

Source: packages/slingshot-search/src/retry.ts

Constants

Search

Public contract for slingshot-search.

Cross-package consumers resolve SearchRuntimeCap through ctx.capabilities.require(...) to ensure config entities are indexed and to retrieve typed search clients.

Source: packages/slingshot-search/src/public.ts

SEARCH_ROUTES

Named route group identifiers for the search plugin.

Pass values to SearchPluginConfig.disableRoutes to suppress specific route groups at startup.

Source: packages/slingshot-search/src/routes/index.ts

SearchRuntimeCap

Public contract for slingshot-search.

Cross-package consumers resolve SearchRuntimeCap through ctx.capabilities.require(...) to ensure config entities are indexed and to retrieve typed search clients.

Source: packages/slingshot-search/src/public.ts

Classes

ProviderUnavailableError

Typesense search provider.

HTTP-based provider that communicates with a Typesense instance via its REST API. Uses native fetch (available in Bun) with retry logic and exponential backoff.

Implements the full SearchProvider interface including lifecycle, index management, document operations, search, suggest, and task monitoring.

Typesense operations are synchronous (no task queue), so waitForTask is a no-op.

Source: packages/slingshot-search/src/providers/typesense.ts

SearchCircuitOpenError

Circuit breaker for search provider calls at the search-manager level.

Provides manager-level fail-fast behavior when a search provider is unreachable, independent of any provider-level breakers. Mirrors the pattern from slingshot-mail and slingshot-assets so operational behaviour stays uniform across production-track packages.

State machine: closed — normal operation; failures increment a counter. open — fail fast; reject every request until cooldown elapses. half-open — let exactly one probe through; success resets, failure re-opens.

Source: packages/slingshot-search/src/searchCircuitBreaker.ts

SearchConfigError

Thrown when search plugin configuration is invalid.

Source: packages/slingshot-search/src/errors/searchErrors.ts

SearchFilterError

Thrown when search plugin configuration is invalid.

Source: packages/slingshot-search/src/errors/searchErrors.ts

SearchIndexNotFoundError

Thrown when search plugin configuration is invalid.

Source: packages/slingshot-search/src/errors/searchErrors.ts

SearchPaginationError

Thrown when search plugin configuration is invalid.

Source: packages/slingshot-search/src/errors/searchErrors.ts

SearchProviderError

Thrown when search plugin configuration is invalid.

Source: packages/slingshot-search/src/errors/searchErrors.ts

SearchTransformError

Thrown when search plugin configuration is invalid.

Source: packages/slingshot-search/src/errors/searchErrors.ts

SearchValidationError

Thrown when search plugin configuration is invalid.

Source: packages/slingshot-search/src/errors/searchErrors.ts

Interfaces

AlgoliaProviderConfig

Full search provider interface and provider-specific configurations.

SearchProvider extends the minimal SearchProviderContract from core with lifecycle, index management, search, suggest, and task monitoring.

Source: packages/slingshot-search/src/types/provider.ts

CircuitBreakerHealth

Typesense search provider.

HTTP-based provider that communicates with a Typesense instance via its REST API. Uses native fetch (available in Bun) with retry logic and exponential backoff.

Implements the full SearchProvider interface including lifecycle, index management, document operations, search, suggest, and task monitoring.

Typesense operations are synchronous (no task queue), so waitForTask is a no-op.

Source: packages/slingshot-search/src/providers/typesense.ts

DbNativeProviderConfig

Full search provider interface and provider-specific configurations.

SearchProvider extends the minimal SearchProviderContract from core with lifecycle, index management, search, suggest, and task monitoring.

Source: packages/slingshot-search/src/types/provider.ts

DlqStore

Event-bus sync manager.

Manages event-bus subscriptions for entities with syncMode: 'event-bus'. Supports config-driven entities discovered via the entity registry.

Batches indexing operations with a configurable flush interval and queue size threshold. Deletions are flushed immediately to avoid stale data.

All state is closure-owned — no module-level mutable state.

Source: packages/slingshot-search/src/eventSync.ts

ElasticsearchProviderConfig

Full search provider interface and provider-specific configurations.

SearchProvider extends the minimal SearchProviderContract from core with lifecycle, index management, search, suggest, and task monitoring.

Source: packages/slingshot-search/src/types/provider.ts

EventSyncHealth

Event-bus sync manager.

Manages event-bus subscriptions for entities with syncMode: 'event-bus'. Supports config-driven entities discovered via the entity registry.

Batches indexing operations with a configurable flush interval and queue size threshold. Deletions are flushed immediately to avoid stale data.

All state is closure-owned — no module-level mutable state.

Source: packages/slingshot-search/src/eventSync.ts

EventSyncManager

Event-bus sync manager.

Manages event-bus subscriptions for entities with syncMode: 'event-bus'. Supports config-driven entities discovered via the entity registry.

Batches indexing operations with a configurable flush interval and queue size threshold. Deletions are flushed immediately to avoid stale data.

All state is closure-owned — no module-level mutable state.

Source: packages/slingshot-search/src/eventSync.ts

EventSyncManagerConfig

Event-bus sync manager.

Manages event-bus subscriptions for entities with syncMode: 'event-bus'. Supports config-driven entities discovered via the entity registry.

Batches indexing operations with a configurable flush interval and queue size threshold. Deletions are flushed immediately to avoid stale data.

All state is closure-owned — no module-level mutable state.

Source: packages/slingshot-search/src/eventSync.ts

FacetOptions

Search query types — the full query API for enterprise search.

Supports full-text search, faceted filtering, geo queries, highlighting, snippets, federated (multi-index) search, and autocomplete suggestions.

Source: packages/slingshot-search/src/types/query.ts

FacetStats

Search response types — structured results from search, suggest, and federated search operations.

Source: packages/slingshot-search/src/types/response.ts

FederatedSearchEntry

Search query types — the full query API for enterprise search.

Supports full-text search, faceted filtering, geo queries, highlighting, snippets, federated (multi-index) search, and autocomplete suggestions.

Source: packages/slingshot-search/src/types/query.ts

FederatedSearchHit

Search response types — structured results from search, suggest, and federated search operations.

Source: packages/slingshot-search/src/types/response.ts

FederatedSearchQuery

Search query types — the full query API for enterprise search.

Supports full-text search, faceted filtering, geo queries, highlighting, snippets, federated (multi-index) search, and autocomplete suggestions.

Source: packages/slingshot-search/src/types/query.ts

FederatedSearchResponse

Search response types — structured results from search, suggest, and federated search operations.

Source: packages/slingshot-search/src/types/response.ts

FileDlqStore

Event-bus sync manager.

Manages event-bus subscriptions for entities with syncMode: 'event-bus'. Supports config-driven entities discovered via the entity registry.

Batches indexing operations with a configurable flush interval and queue size threshold. Deletions are flushed immediately to avoid stale data.

All state is closure-owned — no module-level mutable state.

Source: packages/slingshot-search/src/eventSync.ts

FileDlqStoreConfig

Event-bus sync manager.

Manages event-bus subscriptions for entities with syncMode: 'event-bus'. Supports config-driven entities discovered via the entity registry.

Batches indexing operations with a configurable flush interval and queue size threshold. Deletions are flushed immediately to avoid stale data.

All state is closure-owned — no module-level mutable state.

Source: packages/slingshot-search/src/eventSync.ts

FlushDeadLetterEntry

Event-bus sync manager.

Manages event-bus subscriptions for entities with syncMode: 'event-bus'. Supports config-driven entities discovered via the entity registry.

Batches indexing operations with a configurable flush interval and queue size threshold. Deletions are flushed immediately to avoid stale data.

All state is closure-owned — no module-level mutable state.

Source: packages/slingshot-search/src/eventSync.ts

HighlightConfig

Search query types — the full query API for enterprise search.

Supports full-text search, faceted filtering, geo queries, highlighting, snippets, federated (multi-index) search, and autocomplete suggestions.

Source: packages/slingshot-search/src/types/query.ts

LanguageConfig

Full search provider interface and provider-specific configurations.

SearchProvider extends the minimal SearchProviderContract from core with lifecycle, index management, search, suggest, and task monitoring.

Source: packages/slingshot-search/src/types/provider.ts

MeilisearchProviderConfig

Full search provider interface and provider-specific configurations.

SearchProvider extends the minimal SearchProviderContract from core with lifecycle, index management, search, suggest, and task monitoring.

Source: packages/slingshot-search/src/types/provider.ts

RateLimitOptions

In-memory token-bucket rate limiter for search and suggest routes.

The store is injectable so deployments can swap the in-memory implementation for a Redis or Memcached backend without touching the route handlers.

Default policy: 60 requests / 60 s per (tenant, ip) tuple.

Source: packages/slingshot-search/src/routes/rateLimiter.ts

RateLimitStore

In-memory token-bucket rate limiter for search and suggest routes.

The store is injectable so deployments can swap the in-memory implementation for a Redis or Memcached backend without touching the route handlers.

Default policy: 60 requests / 60 s per (tenant, ip) tuple.

Source: packages/slingshot-search/src/routes/rateLimiter.ts

RetryOptions

Retry with exponential backoff for search provider operations.

Transient failures (timeouts, connection resets, 5xx, 429) are retried automatically. Circuit-open errors and non-transient errors propagate immediately so the circuit breaker can maintain accurate state.

Source: packages/slingshot-search/src/retry.ts

SearchAdminGate

Search plugin configuration types.

SearchPluginConfig is passed to createSearchPackage() and controls provider setup, default sync mode, and plugin-level settings.

Source: packages/slingshot-search/src/types/config.ts

SearchCircuitBreaker

Circuit breaker for search provider calls at the search-manager level.

Provides manager-level fail-fast behavior when a search provider is unreachable, independent of any provider-level breakers. Mirrors the pattern from slingshot-mail and slingshot-assets so operational behaviour stays uniform across production-track packages.

State machine: closed — normal operation; failures increment a counter. open — fail fast; reject every request until cooldown elapses. half-open — let exactly one probe through; success resets, failure re-opens.

Source: packages/slingshot-search/src/searchCircuitBreaker.ts

SearchCircuitBreakerHealth

Circuit breaker for search provider calls at the search-manager level.

Provides manager-level fail-fast behavior when a search provider is unreachable, independent of any provider-level breakers. Mirrors the pattern from slingshot-mail and slingshot-assets so operational behaviour stays uniform across production-track packages.

State machine: closed — normal operation; failures increment a counter. open — fail fast; reject every request until cooldown elapses. half-open — let exactly one probe through; success resets, failure re-opens.

Source: packages/slingshot-search/src/searchCircuitBreaker.ts

SearchCircuitBreakerOptions

Circuit breaker for search provider calls at the search-manager level.

Provides manager-level fail-fast behavior when a search provider is unreachable, independent of any provider-level breakers. Mirrors the pattern from slingshot-mail and slingshot-assets so operational behaviour stays uniform across production-track packages.

State machine: closed — normal operation; failures increment a counter. open — fail fast; reject every request until cooldown elapses. half-open — let exactly one probe through; success resets, failure re-opens.

Source: packages/slingshot-search/src/searchCircuitBreaker.ts

SearchFilterAnd

Search query types — the full query API for enterprise search.

Supports full-text search, faceted filtering, geo queries, highlighting, snippets, federated (multi-index) search, and autocomplete suggestions.

Source: packages/slingshot-search/src/types/query.ts

SearchFilterCondition

Search query types — the full query API for enterprise search.

Supports full-text search, faceted filtering, geo queries, highlighting, snippets, federated (multi-index) search, and autocomplete suggestions.

Source: packages/slingshot-search/src/types/query.ts

SearchFilterGeoBoundingBox

Search query types — the full query API for enterprise search.

Supports full-text search, faceted filtering, geo queries, highlighting, snippets, federated (multi-index) search, and autocomplete suggestions.

Source: packages/slingshot-search/src/types/query.ts

SearchFilterGeoRadius

Search query types — the full query API for enterprise search.

Supports full-text search, faceted filtering, geo queries, highlighting, snippets, federated (multi-index) search, and autocomplete suggestions.

Source: packages/slingshot-search/src/types/query.ts

SearchFilterNot

Search query types — the full query API for enterprise search.

Supports full-text search, faceted filtering, geo queries, highlighting, snippets, federated (multi-index) search, and autocomplete suggestions.

Source: packages/slingshot-search/src/types/query.ts

SearchFilterOr

Search query types — the full query API for enterprise search.

Supports full-text search, faceted filtering, geo queries, highlighting, snippets, federated (multi-index) search, and autocomplete suggestions.

Source: packages/slingshot-search/src/types/query.ts

SearchHealthResult

Full search provider interface and provider-specific configurations.

SearchProvider extends the minimal SearchProviderContract from core with lifecycle, index management, search, suggest, and task monitoring.

Source: packages/slingshot-search/src/types/provider.ts

SearchHit

Search response types — structured results from search, suggest, and federated search operations.

Source: packages/slingshot-search/src/types/response.ts

SearchIndexSettings

Full search provider interface and provider-specific configurations.

SearchProvider extends the minimal SearchProviderContract from core with lifecycle, index management, search, suggest, and task monitoring.

Source: packages/slingshot-search/src/types/provider.ts

SearchIndexTask

Full search provider interface and provider-specific configurations.

SearchProvider extends the minimal SearchProviderContract from core with lifecycle, index management, search, suggest, and task monitoring.

Source: packages/slingshot-search/src/types/provider.ts

SearchPluginConfig

Search plugin configuration types.

SearchPluginConfig is passed to createSearchPackage() and controls provider setup, default sync mode, and plugin-level settings.

Source: packages/slingshot-search/src/types/config.ts

SearchProvider

Full search provider interface and provider-specific configurations.

SearchProvider extends the minimal SearchProviderContract from core with lifecycle, index management, search, suggest, and task monitoring.

Source: packages/slingshot-search/src/types/provider.ts

SearchProviderBaseConfig

Full search provider interface and provider-specific configurations.

SearchProvider extends the minimal SearchProviderContract from core with lifecycle, index management, search, suggest, and task monitoring.

Source: packages/slingshot-search/src/types/provider.ts

SearchQuery

Search query types — the full query API for enterprise search.

Supports full-text search, faceted filtering, geo queries, highlighting, snippets, federated (multi-index) search, and autocomplete suggestions.

Source: packages/slingshot-search/src/types/query.ts

SearchRankingConfig

Full search provider interface and provider-specific configurations.

SearchProvider extends the minimal SearchProviderContract from core with lifecycle, index management, search, suggest, and task monitoring.

Source: packages/slingshot-search/src/types/provider.ts

SearchResponse

Search response types — structured results from search, suggest, and federated search operations.

Source: packages/slingshot-search/src/types/response.ts

SnippetConfig

Search query types — the full query API for enterprise search.

Supports full-text search, faceted filtering, geo queries, highlighting, snippets, federated (multi-index) search, and autocomplete suggestions.

Source: packages/slingshot-search/src/types/query.ts

SuggestQuery

Search query types — the full query API for enterprise search.

Supports full-text search, faceted filtering, geo queries, highlighting, snippets, federated (multi-index) search, and autocomplete suggestions.

Source: packages/slingshot-search/src/types/query.ts

SuggestResponse

Search response types — structured results from search, suggest, and federated search operations.

Source: packages/slingshot-search/src/types/response.ts

SynonymDefinition

Full search provider interface and provider-specific configurations.

SearchProvider extends the minimal SearchProviderContract from core with lifecycle, index management, search, suggest, and task monitoring.

Source: packages/slingshot-search/src/types/provider.ts

TypesenseProviderConfig

Full search provider interface and provider-specific configurations.

SearchProvider extends the minimal SearchProviderContract from core with lifecycle, index management, search, suggest, and task monitoring.

Source: packages/slingshot-search/src/types/provider.ts

TypoToleranceConfig

Full search provider interface and provider-specific configurations.

SearchProvider extends the minimal SearchProviderContract from core with lifecycle, index management, search, suggest, and task monitoring.

Source: packages/slingshot-search/src/types/provider.ts

Types

AnySearchProviderConfig

Full search provider interface and provider-specific configurations.

SearchProvider extends the minimal SearchProviderContract from core with lifecycle, index management, search, suggest, and task monitoring.

Source: packages/slingshot-search/src/types/provider.ts

SearchFilter

Search query types — the full query API for enterprise search.

Supports full-text search, faceted filtering, geo queries, highlighting, snippets, federated (multi-index) search, and autocomplete suggestions.

Source: packages/slingshot-search/src/types/query.ts

SearchFilterOp

Search query types — the full query API for enterprise search.

Supports full-text search, faceted filtering, geo queries, highlighting, snippets, federated (multi-index) search, and autocomplete suggestions.

Source: packages/slingshot-search/src/types/query.ts

SearchFilterValue

Search query types — the full query API for enterprise search.

Supports full-text search, faceted filtering, geo queries, highlighting, snippets, federated (multi-index) search, and autocomplete suggestions.

Source: packages/slingshot-search/src/types/query.ts

SearchRankingRule

Full search provider interface and provider-specific configurations.

SearchProvider extends the minimal SearchProviderContract from core with lifecycle, index management, search, suggest, and task monitoring.

Source: packages/slingshot-search/src/types/provider.ts

SearchRoute

Named route group identifiers for the search plugin.

Pass values to SearchPluginConfig.disableRoutes to suppress specific route groups at startup.

Source: packages/slingshot-search/src/routes/index.ts

SearchSort

Search query types — the full query API for enterprise search.

Supports full-text search, faceted filtering, geo queries, highlighting, snippets, federated (multi-index) search, and autocomplete suggestions.

Source: packages/slingshot-search/src/types/query.ts