@radzor/search-index

Full-text search with facets, filters, and typo-tolerance. Supports Meilisearch and Typesense. Handles indexing, real-time updates, relevance tuning, and instant search queries.

Data & Databasev0.1.0typescriptServersearchfull-textmeilisearchtypesensefacetsfiltersinstant-searchby Radzor

Install

View source on GitHub →

$npx radzor@latest add search-index

⚠ Constraints: Requires a running Meilisearch or Typesense instance — not a managed SaaS. Indexing is async in Meilisearch (tasks complete in background). Always set searchableFields and filterableFields before indexing data to avoid full re-indexing.

Inputs

Name	Type	Default	Description
provider*	'meilisearch' \| 'typesense'	—	Search provider.
host*	string	—	Search server host URL (e.g. http://localhost:7700).
apiKey*	string	—	Admin or search-only API key.MEILISEARCH_KEY
indexName*	string	—	Index / collection name to operate on.
searchableFields	string[]	—	Fields to index for full-text search.
filterableFields	string[]	—

{ "llm": { "constraints": "Requires a running Meilisearch or Typesense instance — not a managed SaaS. Indexing is async in Meilisearch (tasks complete in background). Always set searchableFields and filterableFields before indexing data to avoid full re-indexing.", "usageExamples": "llm/examples.md", "integrationPrompt": "llm/integration.md" }, "name": "@radzor/search-index", "tags": [ "search", "full-text", "meilisearch", "typesense", "facets", "filters", "instant-search" ], "events": [ { "name": "onIndexed", "payload": { "indexName": "string", "durationMs": "number", "documentCount": "number" }, "description": "Fired when documents are successfully indexed." }, { "name": "onSearchComplete", "payload": { "hits": "number", "query": "string", "processingMs": "number" }, "description": "Fired when a search query returns." }, { "name": "onError", "payload": { "code": "string", "message": "string", "operation": "string" }, "description": "Fired when an indexing or search operation fails." } ], "inputs": [ { "name": "provider", "type": "'meilisearch' | 'typesense'", "required": true, "description": "Search provider." }, { "name": "host", "type": "string", "required": true, "description": "Search server host URL (e.g. http://localhost:7700)." }, { "name": "apiKey", "type": "string", "envVar": "MEILISEARCH_KEY", "required": true, "description": "Admin or search-only API key." }, { "name": "indexName", "type": "string", "required": true, "description": "Index / collection name to operate on." }, { "name": "searchableFields", "type": "string[]", "required": false, "description": "Fields to index for full-text search." }, { "name": "filterableFields", "type": "string[]", "required": false, "description": "Fields available for filtering and faceting." }, { "name": "primaryKey", "type": "string", "default": "id", "required": false, "description": "Field used as the document unique identifier." } ], "radzor": "1.0.0", "actions": [ { "name": "index", "params": [ { "name": "documents", "type": "Record<string, unknown>[]", "description": "Array of documents to index." } ], "returns": "Promise<void>", "description": "Add or replace documents in the index." }, { "name": "search", "params": [ { "name": "query", "type": "string", "description": "Search query string." }, { "name": "options", "type": "SearchOptions", "required": false, "description": "filter, facets, limit, offset, sort." } ], "returns": "Promise<SearchResults>", "description": "Perform a full-text search with optional filtering and faceting." }, { "name": "update", "params": [ { "name": "documents", "type": "Record<string, unknown>[]", "description": "Partial documents to merge into existing ones." } ], "returns": "Promise<void>", "description": "Partially update existing documents (merge, not replace)." }, { "name": "delete", "params": [ { "name": "ids", "type": "string[]", "description": "IDs of documents to remove." } ], "returns": "Promise<void>", "description": "Delete documents by ID." }, { "name": "clearIndex", "params": [], "returns": "Promise<void>", "description": "Delete all documents in the index without deleting the index settings." }, { "name": "configure", "params": [ { "name": "settings", "type": "IndexSettings", "description": "searchableAttributes, filterableAttributes, rankingRules, etc." } ], "returns": "Promise<void>", "description": "Update index settings (searchable fields, ranking, etc.)." } ], "outputs": [ { "name": "searchResults", "type": "SearchResults", "fields": [ { "name": "hits", "type": "unknown[]" }, { "name": "total", "type": "number" }, { "name": "processingTimeMs", "type": "number" }, { "name": "facets", "type": "Record<string, unknown>", "required": false } ], "description": "Search response with hits, total, processing time, and facet counts." } ], "runtime": "server", "version": "0.1.0", "category": "data", "languages": [ "typescript" ], "description": "Full-text search with facets, filters, and typo-tolerance. Supports Meilisearch and Typesense. Handles indexing, real-time updates, relevance tuning, and instant search queries.", "dependencies": { "packages": { "meilisearch": "^0.44.0" } }, "composability": { "connectsTo": [ { "output": "searchResults", "description": "Feed search results to LLM or export them.", "compatibleWith": [ "@radzor/llm-completion.action.complete.prompt", "@radzor/csv-export.action.generate.data" ] } ] } }

@radzor/search-index

Install

Inputs

Outputs

Actions

Events

Composability

radzor.manifest.json

Version History