@docsearch/react - npm Package Compare versions

Comparing version 3.9.0 to 4.0.0-beta.0

dist/esm/index.d.ts

 import { BaseItem, AutocompleteState, AutocompleteContext, AutocompleteInsightsApi, AutocompleteOptions } from '@algolia/autocomplete-core';
 import { LiteClient, SearchParamsObject } from 'algoliasearch/lite';
 import React, { JSX } from 'react';
+import { Message } from '@ai-sdk/react';
 
-type ContentType = 'content' | 'lvl0' | 'lvl1' | 'lvl2' | 'lvl3' | 'lvl4' | 'lvl5' | 'lvl6';
+type ContentType = 'askAI' | 'content' | 'lvl0' | 'lvl1' | 'lvl2' | 'lvl3' | 'lvl4' | 'lvl5' | 'lvl6';
 interface DocSearchHitAttributeHighlightResult {
@@ -38,2 +39,3 @@ value: string;
     content: string | null;
+    query?: string;
     url: string;
@@ -90,2 +92,4 @@ url_without_anchor: string;
 
+type DocSearchTheme = 'dark' | 'light';
+
 type InternalDocSearchHit = DocSearchHit & {
@@ -96,2 +100,9 @@ __docsearch_parent: InternalDocSearchHit | null;
 type StoredDocSearchHit = Omit<DocSearchHit, '_highlightResult' | '_snippetResult'>;
+type StoredAskAiMessage = Message & {
+    /** Optional user feedback on this assistant message. */
+    feedback?: 'dislike' | 'like';
+};
+type StoredAskAiState = Omit<DocSearchHit, '_highlightResult' | '_snippetResult'> & {
+    messages?: StoredAskAiMessage[];
+};
 
@@ -107,2 +118,23 @@ type DocSearchTranslations = Partial<{
 };
+type DocSearchAskAi = {
+    /**
+     * The index name to use for the ask AI feature. Your assistant will search this index for relevant documents.
+     * If not provided, the index name will be used.
+     */
+    indexName?: string;
+    /**
+     * The API key to use for the ask AI feature. Your assistant will use this API key to search the index.
+     * If not provided, the API key will be used.
+     */
+    apiKey?: string;
+    /**
+     * The app ID to use for the ask AI feature. Your assistant will use this app ID to search the index.
+     * If not provided, the app ID will be used.
+     */
+    appId?: string;
+    /**
+     * The assistant ID to use for the ask AI feature.
+     */
+    assistantId: string | null;
+};
 interface DocSearchProps {
@@ -112,2 +144,4 @@ appId: string;
     indexName: string;
+    askAi?: DocSearchAskAi | string;
+    theme?: DocSearchTheme;
     placeholder?: string;
@@ -134,3 +168,3 @@ searchParameters?: SearchParamsObject;
 }
-declare function DocSearch(props: DocSearchProps): JSX.Element;
+declare function DocSearch({ ...props }: DocSearchProps): JSX.Element;
 
@@ -142,2 +176,3 @@ type ButtonTranslations = Partial<{
 type DocSearchButtonProps = React.ComponentProps<'button'> & {
+    theme?: DocSearchTheme;
     translations?: ButtonTranslations;
@@ -149,2 +184,3 @@ };
     selectText: string;
+    submitQuestionText: string;
     selectKeyAriaLabel: string;
@@ -155,6 +191,38 @@ navigateText: string;
     closeText: string;
+    backToSearchText: string;
     closeKeyAriaLabel: string;
-    searchByText: string;
+    poweredByText: string;
 }>;
 
+type AskAiScreenTranslations = Partial<{
+    disclaimerText: string;
+    relatedSourcesText: string;
+    thinkingText: string;
+    copyButtonText: string;
+    copyButtonCopiedText: string;
+    copyButtonTitle: string;
+    likeButtonTitle: string;
+    dislikeButtonTitle: string;
+    thanksForFeedbackText: string;
+    preToolCallText: string;
+    duringToolCallText: string;
+    afterToolCallText: string;
+    /**
+     * Build the full jsx element for the aggregated search block.
+     * If provided, completely overrides the default english renderer.
+     */
+    aggregatedToolCallNode?: (queries: string[], onSearchQueryClick: (query: string) => void) => React.ReactNode;
+    /**
+     * Generate the list connective parts only (backwards compatibility).
+     * Receives full list of queries and should return translation parts for before/after/separators.
+     * Example: (qs) => ({ before: 'searched for ', separator: ', ', lastSeparator: ' and ', after: '' }).
+     */
+    aggregatedToolCallText?: (queries: string[]) => {
+        before?: string;
+        separator?: string;
+        lastSeparator?: string;
+        after?: string;
+    };
+}>;
+
 type ErrorScreenTranslations = Partial<{
@@ -172,2 +240,6 @@ titleText: string;
 
+type ResultsScreenTranslations = Partial<{
+    askAiPlaceholder: string;
+}>;
+
 type StartScreenTranslations = Partial<{
@@ -180,2 +252,4 @@ recentSearchesTitle: string;
     removeFavoriteSearchButtonTitle: string;
+    recentConversationsTitle: string;
+    removeRecentConversationButtonTitle: string;
 }>;
@@ -187,10 +261,19 @@
     noResultsScreen: NoResultsScreenTranslations;
+    resultsScreen: ResultsScreenTranslations;
+    askAiScreen: AskAiScreenTranslations;
 }>;
 
 type SearchBoxTranslations = Partial<{
-    resetButtonTitle: string;
-    resetButtonAriaLabel: string;
-    cancelButtonText: string;
-    cancelButtonAriaLabel: string;
+    clearButtonTitle: string;
+    clearButtonAriaLabel: string;
+    closeButtonText: string;
+    closeButtonAriaLabel: string;
+    placeholderText: string;
+    placeholderTextAskAi: string;
+    placeholderTextAskAiStreaming: string;
+    enterKeyHint: string;
+    enterKeyHintAskAi: string;
     searchInputLabel: string;
+    backToKeywordSearchButtonText: string;
+    backToKeywordSearchButtonAriaLabel: string;
 }>;
@@ -204,6 +287,9 @@
     initialScrollY: number;
+    onAskAiToggle: (toggle: boolean) => void;
     onClose?: () => void;
+    isAskAiActive?: boolean;
+    canHandleAskAi?: boolean;
     translations?: ModalTranslations;
 };
-declare function DocSearchModal({ appId, apiKey, indexName, placeholder, searchParameters, maxResultsPerGroup, onClose, transformItems, hitComponent, resultsFooterComponent, navigator, initialScrollY, transformSearchClient, disableUserPersonalization, initialQuery: initialQueryFromProp, translations, getMissingResultsUrl, insights, }: DocSearchModalProps): JSX.Element;
+declare function DocSearchModal({ appId, apiKey, indexName, placeholder, askAi, searchParameters, maxResultsPerGroup, theme, onClose, transformItems, hitComponent, resultsFooterComponent, navigator, initialScrollY, transformSearchClient, disableUserPersonalization, initialQuery: initialQueryFromProp, translations, getMissingResultsUrl, insights, onAskAiToggle, isAskAiActive, canHandleAskAi, }: DocSearchModalProps): JSX.Element;
 
@@ -216,7 +302,9 @@ interface UseDocSearchKeyboardEventsProps {
     searchButtonRef: React.RefObject<HTMLButtonElement | null>;
+    isAskAiActive: boolean;
+    onAskAiToggle: (toggle: boolean) => void;
 }
-declare function useDocSearchKeyboardEvents({ isOpen, onOpen, onClose, onInput, searchButtonRef, }: UseDocSearchKeyboardEventsProps): void;
+declare function useDocSearchKeyboardEvents({ isOpen, onOpen, onClose, onInput, isAskAiActive, onAskAiToggle, searchButtonRef, }: UseDocSearchKeyboardEventsProps): void;
 
-declare const version = "3.9.0";
+declare const version = "4.0.0-beta.0";
 
-export { type ButtonTranslations, DocSearch, DocSearchButton, type DocSearchButtonProps, type DocSearchHit, DocSearchModal, type DocSearchModalProps, type DocSearchProps, type DocSearchState, type DocSearchTransformClient, type DocSearchTranslations, type InternalDocSearchHit, type ModalTranslations, type StoredDocSearchHit, type UseDocSearchKeyboardEventsProps, useDocSearchKeyboardEvents, version };
+export { type ButtonTranslations, DocSearch, type DocSearchAskAi, DocSearchButton, type DocSearchButtonProps, type DocSearchHit, DocSearchModal, type DocSearchModalProps, type DocSearchProps, type DocSearchState, type DocSearchTheme, type DocSearchTransformClient, type DocSearchTranslations, type InternalDocSearchHit, type ModalTranslations, type StoredAskAiMessage, type StoredAskAiState, type StoredDocSearchHit, type UseDocSearchKeyboardEventsProps, useDocSearchKeyboardEvents, version };

package.json

 {
   "name": "@docsearch/react",
   "description": "React package for DocSearch, the best search experience for docs.",
-  "version": "3.9.0",
+  "version": "4.0.0-beta.0",
   "license": "MIT",
@@ -36,9 +36,11 @@ "homepage": "https://docsearch.algolia.com",
     "on:change": "yarn build",
-    "watch": "watch \"yarn on:change\" --ignoreDirectoryPattern \"/dist/\""
+    "watch": "nodemon --watch src --ext ts,tsx,js,jsx,json --ignore dist/ --ignore node_modules/ --verbose --delay 250ms --exec \"yarn on:change\""
   },
   "dependencies": {
-    "@algolia/autocomplete-core": "1.17.9",
-    "@algolia/autocomplete-preset-algolia": "1.17.9",
-    "@docsearch/css": "3.9.0",
-    "algoliasearch": "^5.14.2"
+    "@ai-sdk/react": "^1.2.12",
+    "@algolia/autocomplete-core": "1.19.2",
+    "@algolia/autocomplete-preset-algolia": "1.19.2",
+    "@docsearch/css": "4.0.0-beta.0",
+    "algoliasearch": "^5.28.0",
+    "marked": "^15.0.12"
   },
@@ -49,3 +51,5 @@ "devDependencies": {
     "@testing-library/react": "16.2.0",
-    "vitest": "3.0.2"
+    "nodemon": "^3.1.0",
+    "vitest": "3.0.2",
+    "zod": "^3.25.67"
   },
@@ -52,0 +56,0 @@ "peerDependencies": {

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1293454

132.29%

Lines of code

2273

119.61%

Worsened metrics

Dependency count

10

25%

Dev dependency count

6

50%

Number of low quality alerts

3

50%

Number of low supply chain risk alerts

15

1400%

Number of medium supply chain risk alerts

20

900%

Dependency changes

• + Added

  @ai-sdk/react@^1.2.12

• + Added

  marked@^15.0.12

• + Added

  @ai-sdk/provider@1.1.3
  (transitive)

• + Added

  @ai-sdk/provider-utils@2.2.8
  (transitive)

• + Added

  @ai-sdk/react@1.2.12
  (transitive)

• + Added

  @ai-sdk/ui-utils@1.2.11
  (transitive)

• + Added

  @algolia/autocomplete-core@1.19.2
  (transitive)

• + Added

  @algolia/autocomplete-plugin-algolia-insights@1.19.2
  (transitive)

• + Added

  @algolia/autocomplete-preset-algolia@1.19.2
  (transitive)

• + Added

  @algolia/autocomplete-shared@1.19.2
  (transitive)

• + Added

  @docsearch/css@4.0.0-beta.0
  (transitive)

• + Added

  dequal@2.0.3
  (transitive)

• + Added

  json-schema@0.4.0
  (transitive)

• + Added

  marked@15.0.12
  (transitive)

• + Added

  nanoid@3.3.11
  (transitive)

• + Added

  secure-json-parse@2.7.0
  (transitive)

• + Added

  swr@2.4.1
  (transitive)

• + Added

  throttleit@2.1.0
  (transitive)

• + Added

  use-sync-external-store@1.6.0
  (transitive)

• + Added

  zod@3.25.76
  (transitive)

• + Added

  zod-to-json-schema@3.25.1
  (transitive)

• - Removed

  @algolia/autocomplete-core@1.17.9
  (transitive)

• - Removed

  @algolia/autocomplete-plugin-algolia-insights@1.17.9
  (transitive)

• - Removed

  @algolia/autocomplete-preset-algolia@1.17.9
  (transitive)

• - Removed

  @algolia/autocomplete-shared@1.17.9
  (transitive)

• - Removed

  @docsearch/css@3.9.0
  (transitive)

• Updated

  @algolia/autocomplete-core@1.19.2

• Updated

  @algolia/autocomplete-preset-algolia@1.19.2

• Updated

  @docsearch/css@4.0.0-beta.0

• Updated

  algoliasearch@^5.28.0