|
|
|
|
@ -1,3 +1,20 @@
|
|
|
|
|
import { type DocSearchProps as DocSearchPropsJS } from '@docsearch/js'
|
|
|
|
|
import { type SidepanelProps as SidepanelPropsBase } from '@docsearch/sidepanel-js'
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Sidepanel translation configuration (for locale configs).
|
|
|
|
|
*/
|
|
|
|
|
export type SidepanelTranslations = NonNullable<
|
|
|
|
|
NonNullable<SidepanelPropsBase['button']>['translations']
|
|
|
|
|
> & {
|
|
|
|
|
panel?: NonNullable<NonNullable<SidepanelPropsBase['panel']>['translations']>
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Partial sidepanel props for locale configs where auth fields are inherited from the main config.
|
|
|
|
|
*/
|
|
|
|
|
export type SidepanelProps = Partial<Omit<SidepanelPropsBase, 'container'>>
|
|
|
|
|
|
|
|
|
|
export interface DocSearchProps {
|
|
|
|
|
/**
|
|
|
|
|
* Keyword search (optional when using Ask AI side panel only).
|
|
|
|
|
@ -6,11 +23,11 @@ export interface DocSearchProps {
|
|
|
|
|
apiKey?: string
|
|
|
|
|
indexName?: string
|
|
|
|
|
placeholder?: string
|
|
|
|
|
searchParameters?: SearchOptions
|
|
|
|
|
searchParameters?: DocSearchPropsJS['searchParameters']
|
|
|
|
|
disableUserPersonalization?: boolean
|
|
|
|
|
initialQuery?: string
|
|
|
|
|
insights?: boolean
|
|
|
|
|
translations?: DocSearchTranslations
|
|
|
|
|
translations?: DocSearchPropsJS['translations']
|
|
|
|
|
askAi?: DocSearchAskAi | string
|
|
|
|
|
/**
|
|
|
|
|
* Ask AI side panel integration mode.
|
|
|
|
|
@ -19,173 +36,9 @@ export interface DocSearchProps {
|
|
|
|
|
* - 'auto': infer hybrid vs sidePanel-only from provided config
|
|
|
|
|
* - 'sidePanel': force sidePanel-only even if keyword search is configured
|
|
|
|
|
* - 'hybrid': force hybrid (error if keyword search is not configured)
|
|
|
|
|
* - 'modal': force modal even if sidePanel is configured (ask ai in modal stays in modal)
|
|
|
|
|
*/
|
|
|
|
|
mode?: 'auto' | 'sidePanel' | 'hybrid'
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export interface SearchOptions {
|
|
|
|
|
query?: string
|
|
|
|
|
similarQuery?: string
|
|
|
|
|
facetFilters?: string | string[]
|
|
|
|
|
optionalFilters?: string | string[]
|
|
|
|
|
numericFilters?: string | string[]
|
|
|
|
|
tagFilters?: string | string[]
|
|
|
|
|
sumOrFiltersScores?: boolean
|
|
|
|
|
filters?: string
|
|
|
|
|
page?: number
|
|
|
|
|
hitsPerPage?: number
|
|
|
|
|
offset?: number
|
|
|
|
|
length?: number
|
|
|
|
|
attributesToHighlight?: string[]
|
|
|
|
|
attributesToSnippet?: string[]
|
|
|
|
|
attributesToRetrieve?: string[]
|
|
|
|
|
highlightPreTag?: string
|
|
|
|
|
highlightPostTag?: string
|
|
|
|
|
snippetEllipsisText?: string
|
|
|
|
|
restrictHighlightAndSnippetArrays?: boolean
|
|
|
|
|
facets?: string[]
|
|
|
|
|
maxValuesPerFacet?: number
|
|
|
|
|
facetingAfterDistinct?: boolean
|
|
|
|
|
minWordSizefor1Typo?: number
|
|
|
|
|
minWordSizefor2Typos?: number
|
|
|
|
|
allowTyposOnNumericTokens?: boolean
|
|
|
|
|
disableTypoToleranceOnAttributes?: string[]
|
|
|
|
|
queryType?: 'prefixLast' | 'prefixAll' | 'prefixNone'
|
|
|
|
|
removeWordsIfNoResults?: 'none' | 'lastWords' | 'firstWords' | 'allOptional'
|
|
|
|
|
advancedSyntax?: boolean
|
|
|
|
|
advancedSyntaxFeatures?: ('exactPhrase' | 'excludeWords')[]
|
|
|
|
|
optionalWords?: string | string[]
|
|
|
|
|
disableExactOnAttributes?: string[]
|
|
|
|
|
exactOnSingleWordQuery?: 'attribute' | 'none' | 'word'
|
|
|
|
|
alternativesAsExact?: (
|
|
|
|
|
| 'ignorePlurals'
|
|
|
|
|
| 'singleWordSynonym'
|
|
|
|
|
| 'multiWordsSynonym'
|
|
|
|
|
)[]
|
|
|
|
|
enableRules?: boolean
|
|
|
|
|
ruleContexts?: string[]
|
|
|
|
|
distinct?: boolean | number
|
|
|
|
|
analytics?: boolean
|
|
|
|
|
analyticsTags?: string[]
|
|
|
|
|
synonyms?: boolean
|
|
|
|
|
replaceSynonymsInHighlight?: boolean
|
|
|
|
|
minProximity?: number
|
|
|
|
|
responseFields?: string[]
|
|
|
|
|
maxFacetHits?: number
|
|
|
|
|
percentileComputation?: boolean
|
|
|
|
|
clickAnalytics?: boolean
|
|
|
|
|
personalizationImpact?: number
|
|
|
|
|
enablePersonalization?: boolean
|
|
|
|
|
restrictSearchableAttributes?: string[]
|
|
|
|
|
sortFacetValuesBy?: 'count' | 'alpha'
|
|
|
|
|
typoTolerance?: boolean | 'min' | 'strict'
|
|
|
|
|
aroundLatLng?: string
|
|
|
|
|
aroundLatLngViaIP?: boolean
|
|
|
|
|
aroundRadius?: number | 'all'
|
|
|
|
|
aroundPrecision?: number | { from: number; value: number }[]
|
|
|
|
|
minimumAroundRadius?: number
|
|
|
|
|
insideBoundingBox?: number[][]
|
|
|
|
|
insidePolygon?: number[][]
|
|
|
|
|
ignorePlurals?: boolean | string[]
|
|
|
|
|
removeStopWords?: boolean | string[]
|
|
|
|
|
naturalLanguages?: string[]
|
|
|
|
|
getRankingInfo?: boolean
|
|
|
|
|
userToken?: string
|
|
|
|
|
enableABTest?: boolean
|
|
|
|
|
decompoundQuery?: boolean
|
|
|
|
|
relevancyStrictness?: number
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export interface DocSearchTranslations {
|
|
|
|
|
button?: ButtonTranslations
|
|
|
|
|
modal?: ModalTranslations
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export interface ButtonTranslations {
|
|
|
|
|
buttonText?: string
|
|
|
|
|
buttonAriaLabel?: string
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export interface ModalTranslations extends ScreenStateTranslations {
|
|
|
|
|
searchBox?: SearchBoxTranslations
|
|
|
|
|
footer?: FooterTranslations
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export interface ScreenStateTranslations {
|
|
|
|
|
errorScreen?: ErrorScreenTranslations
|
|
|
|
|
startScreen?: StartScreenTranslations
|
|
|
|
|
resultsScreen?: ResultsScreenTranslations
|
|
|
|
|
noResultsScreen?: NoResultsScreenTranslations
|
|
|
|
|
askAiScreen?: AskAiScreenTranslations
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export interface SearchBoxTranslations {
|
|
|
|
|
clearButtonTitle?: string
|
|
|
|
|
clearButtonAriaLabel?: string
|
|
|
|
|
closeButtonText?: string
|
|
|
|
|
closeButtonAriaLabel?: string
|
|
|
|
|
placeholderText?: string
|
|
|
|
|
placeholderTextAskAi?: string
|
|
|
|
|
searchInputLabel?: string
|
|
|
|
|
placeholderTextAskAiStreaming?: string
|
|
|
|
|
backToKeywordSearchButtonText?: string
|
|
|
|
|
backToKeywordSearchButtonAriaLabel?: string
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export interface FooterTranslations {
|
|
|
|
|
selectText?: string
|
|
|
|
|
submitQuestionText?: string
|
|
|
|
|
selectKeyAriaLabel?: string
|
|
|
|
|
navigateText?: string
|
|
|
|
|
navigateUpKeyAriaLabel?: string
|
|
|
|
|
backToSearchText?: string
|
|
|
|
|
navigateDownKeyAriaLabel?: string
|
|
|
|
|
closeText?: string
|
|
|
|
|
closeKeyAriaLabel?: string
|
|
|
|
|
poweredByText?: string
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export interface ErrorScreenTranslations {
|
|
|
|
|
titleText?: string
|
|
|
|
|
helpText?: string
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export interface StartScreenTranslations {
|
|
|
|
|
recentSearchesTitle?: string
|
|
|
|
|
noRecentSearchesText?: string
|
|
|
|
|
saveRecentSearchButtonTitle?: string
|
|
|
|
|
removeRecentSearchButtonTitle?: string
|
|
|
|
|
favoriteSearchesTitle?: string
|
|
|
|
|
removeFavoriteSearchButtonTitle?: string
|
|
|
|
|
recentConversationsTitle?: string
|
|
|
|
|
removeRecentConversationButtonTitle?: string
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export interface ResultsScreenTranslations {
|
|
|
|
|
askAiPlaceholder?: string
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export interface NoResultsScreenTranslations {
|
|
|
|
|
noResultsText?: string
|
|
|
|
|
suggestedQueryText?: string
|
|
|
|
|
reportMissingResultsText?: string
|
|
|
|
|
reportMissingResultsLinkText?: string
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export interface AskAiScreenTranslations {
|
|
|
|
|
disclaimerText?: string
|
|
|
|
|
relatedSourcesText?: string
|
|
|
|
|
thinkingText?: string
|
|
|
|
|
copyButtonText?: string
|
|
|
|
|
copyButtonCopiedText?: string
|
|
|
|
|
copyButtonTitle?: string
|
|
|
|
|
likeButtonTitle?: string
|
|
|
|
|
dislikeButtonTitle?: string
|
|
|
|
|
thanksForFeedbackText?: string
|
|
|
|
|
preToolCallText?: string
|
|
|
|
|
duringToolCallText?: string
|
|
|
|
|
afterToolCallText?: string
|
|
|
|
|
aggregatedToolCallText?: string
|
|
|
|
|
mode?: 'auto' | 'sidePanel' | 'hybrid' | 'modal'
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export interface DocSearchAskAi {
|
|
|
|
|
@ -206,13 +59,14 @@ export interface DocSearchAskAi {
|
|
|
|
|
appId?: string
|
|
|
|
|
/**
|
|
|
|
|
* The assistant ID to use for the ask AI feature.
|
|
|
|
|
* Optional in locale configs where it's inherited from the main config.
|
|
|
|
|
*/
|
|
|
|
|
assistantId: string | null
|
|
|
|
|
assistantId?: string | null
|
|
|
|
|
/**
|
|
|
|
|
* The search parameters to use for the ask AI feature.
|
|
|
|
|
*/
|
|
|
|
|
searchParameters?: Pick<
|
|
|
|
|
SearchOptions,
|
|
|
|
|
DocSearchPropsJS['searchParameters'],
|
|
|
|
|
| 'facetFilters'
|
|
|
|
|
| 'filters'
|
|
|
|
|
| 'attributesToRetrieve'
|
|
|
|
|
@ -226,42 +80,5 @@ export interface DocSearchAskAi {
|
|
|
|
|
/**
|
|
|
|
|
* Ask AI side panel configuration.
|
|
|
|
|
*/
|
|
|
|
|
sidePanel?: boolean | SidePanelConfig
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Sidepanel configuration (flat, mirrors @docsearch/sidepanel-js API).
|
|
|
|
|
* @see https://docsearch.algolia.com/docs/sidepanel/api-reference
|
|
|
|
|
*/
|
|
|
|
|
export interface SidePanelConfig {
|
|
|
|
|
/**
|
|
|
|
|
* Default: 'floating'
|
|
|
|
|
*/
|
|
|
|
|
variant?: 'floating' | 'inline'
|
|
|
|
|
/**
|
|
|
|
|
* Default: 'right'
|
|
|
|
|
*/
|
|
|
|
|
side?: 'right' | 'left'
|
|
|
|
|
/**
|
|
|
|
|
* Default: '360px'
|
|
|
|
|
*/
|
|
|
|
|
width?: number | string
|
|
|
|
|
/**
|
|
|
|
|
* Default: '580px'
|
|
|
|
|
*/
|
|
|
|
|
expandedWidth?: number | string
|
|
|
|
|
/**
|
|
|
|
|
* Enables displaying suggested questions on new conversation screen.
|
|
|
|
|
*/
|
|
|
|
|
suggestedQuestions?: boolean
|
|
|
|
|
/**
|
|
|
|
|
* Default: {'Ctrl/Cmd+I': true}
|
|
|
|
|
*/
|
|
|
|
|
keyboardShortcuts?: {
|
|
|
|
|
'Ctrl/Cmd+I'?: boolean
|
|
|
|
|
}
|
|
|
|
|
/**
|
|
|
|
|
* Default: 'light'
|
|
|
|
|
*/
|
|
|
|
|
theme?: 'light' | 'dark'
|
|
|
|
|
sidePanel?: boolean | SidepanelProps
|
|
|
|
|
}
|
|
|
|
|
|
Dylan Tientcheu
4 months ago