Files
HiveGrid-Wireframes/03 Quellen und Referenzen/hivegrid-cloud/packages/search/src/index.ts
T

67 lines
2.5 KiB
TypeScript

/**
* Public entry point for `@hivegrid/search`.
*
* The package exposes a typed wrapper around Meilisearch with two
* non-negotiable invariants:
*
* 1. Every search call accepts (and routes through) an explicit
* `tenantId`. The wrapper injects `tenantId = "<id>"` as a filter so
* domain code cannot accidentally read across tenants.
* 2. The raw Meilisearch SDK is never re-exported. Callers receive a
* narrow `SearchClient` / `IndexHandle` instead. This is enforced by
* keeping the SDK module-private and by the code-review checklist
* documented in docs/improvement-plan/04-search-rag/meilisearch.md.
*/
export { createSearchClient } from "./client.js";
export type {
CreateSearchClientOptions,
IndexHandle,
IndexSearchOptions,
IndexSettingsInput,
MeiliFactory,
SearchClient,
SearchDocument,
SearchHit,
SearchHits,
} from "./client.js";
export { SEARCH_INDEX_UID_PREFIX, toPhysicalSearchIndexUid } from "./index-name.js";
export { createSearchIndex, IndexSchemaValidationError, provisionSearchIndexes, validateIndexSchema } from "./index-helper.js";
export type { CreateSearchIndexInput, ProvisionSearchIndexesInput } from "./index-helper.js";
export { bulkIndex, deleteFromIndex, deleteTenantFromIndex, health, searchInIndex, searchWithFallback, TenantScopeError } from "./query.js";
export type { BulkIndexInput, DeleteFromIndexInput, DeleteTenantFromIndexInput, SearchFallback, SearchInIndexInput, SearchWithFallbackInput } from "./query.js";
export {
ALL_SEARCH_INDEXES,
BULK_REINDEX_SUPPORTED_INDEXES,
BULK_REINDEX_SUPPORTED_INDEX_NAMES,
chatMessagesIndex,
crmContactsIndex,
filesIndex,
getSearchIndexSchema,
hrDirectoryIndex,
hrLocationsIndex,
kbArticlesIndex,
projectsIndex,
tasksIndex,
usersIndex,
} from "./schemas/index.js";
export type { SearchIndexSchema } from "./schemas/index.js";
export { getIndexedEntitiesForPermissions, getIndexedEntity, indexedEntities, listIndexedEntities, validateIndexedEntities } from "./indexed-entities.js";
export type { IndexedEntity, IndexedEntityConfig, IndexedEntityKey, IndexedEntityRegistry } from "./indexed-entities.js";
export { sanitizeDocument } from "./sanitize.js";
export { publishSearchBulkReindexEvent, publishSearchDeleteEvent, publishSearchUpsertEvent, searchEventType } from "./outbox-publisher.js";
export type {
PublishSearchBulkReindexEventInput,
PublishSearchDeleteEventInput,
PublishSearchUpsertEventInput,
SearchOutboxPublisher,
SearchOutboxVerb,
} from "./outbox-publisher.js";