From 0c5978a1fe224da86ddea34c9ea3ccda30286d5b Mon Sep 17 00:00:00 2001 From: Paul Jankowski <8bittitan@gmail.com> Date: Thu, 6 Aug 2026 15:46:22 -0400 Subject: [PATCH] chore: release v5.0.0 (#2969) --- .changeset/better-cars-smell.md | 30 ---- .changeset/brave-things-join.md | 15 -- .changeset/bright-errors-block.md | 6 - .changeset/calm-buttons-listen.md | 6 - .changeset/deep-conversations-start.md | 5 - .changeset/dynamic-indices-strings.md | 6 - .changeset/kind-foxes-give.md | 5 - .changeset/long-snippets-wrap.md | 6 - .changeset/pre.json | 35 ---- .changeset/ready-clubs-serve.md | 20 --- .changeset/safe-answers-smile.md | 5 - .changeset/sharp-donkeys-search.md | 20 --- .changeset/sixty-lights-try.md | 14 -- .changeset/tidy-moons-argue.md | 20 --- .changeset/typed-panels-wave.md | 5 - .changeset/vast-numbers-read.md | 46 ------ .circleci/config.yml | 1 - .../CHANGELOG.md | 109 +++++++++++++ .../package.json | 2 +- bun.lock | 22 +-- package.json | 2 +- packages/docsearch-core/CHANGELOG.md | 51 ++++++ packages/docsearch-core/package.json | 2 +- packages/docsearch-css/CHANGELOG.md | 111 +++++++++++++ packages/docsearch-css/package.json | 2 +- packages/docsearch-js/CHANGELOG.md | 66 ++++++++ packages/docsearch-js/package.json | 6 +- packages/docsearch-modal/CHANGELOG.md | 65 ++++++++ packages/docsearch-modal/package.json | 6 +- packages/docsearch-react/CHANGELOG.md | 152 ++++++++++++++++++ packages/docsearch-react/package.json | 8 +- packages/docsearch-react/src/version.ts | 2 +- packages/docsearch-sidepanel-js/CHANGELOG.md | 58 +++++++ packages/docsearch-sidepanel-js/package.json | 6 +- packages/docsearch-sidepanel/CHANGELOG.md | 66 ++++++++ packages/docsearch-sidepanel/package.json | 8 +- 36 files changed, 711 insertions(+), 278 deletions(-) delete mode 100644 .changeset/better-cars-smell.md delete mode 100644 .changeset/brave-things-join.md delete mode 100644 .changeset/bright-errors-block.md delete mode 100644 .changeset/calm-buttons-listen.md delete mode 100644 .changeset/deep-conversations-start.md delete mode 100644 .changeset/dynamic-indices-strings.md delete mode 100644 .changeset/kind-foxes-give.md delete mode 100644 .changeset/long-snippets-wrap.md delete mode 100644 .changeset/pre.json delete mode 100644 .changeset/ready-clubs-serve.md delete mode 100644 .changeset/safe-answers-smile.md delete mode 100644 .changeset/sharp-donkeys-search.md delete mode 100644 .changeset/sixty-lights-try.md delete mode 100644 .changeset/tidy-moons-argue.md delete mode 100644 .changeset/typed-panels-wave.md delete mode 100644 .changeset/vast-numbers-read.md diff --git a/.changeset/better-cars-smell.md b/.changeset/better-cars-smell.md deleted file mode 100644 index 90c6c501..00000000 --- a/.changeset/better-cars-smell.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -"@docsearch/docusaurus-adapter": patch -"@docsearch/react": patch -"@docsearch/css": patch ---- - -feat(v5): General UI styling updates and fixes - -- New `--docsearch-font-family` variable, used by the search button, keyboard - keys, modal, and sidepanel. It replaces the system font stacks that were - duplicated across `sidepanel.css` and `button.css`, so overriding one - variable now themes every DocSearch surface -- The search input and modal heading are `1rem` at every breakpoint - (previously `0.875rem` with a mobile-only override) -- `.DocSearch-Title` uses `line-height: 1.5em` instead of `0.5em` and adds - `overflow-wrap: anywhere`, so long titles wrap instead of overlapping (#2908) -- Hit icon `svg` sizing moved into `.DocSearch-Hit-icon`. The - `.DocSearch-Hit-icon--small` modifier is replaced by - `.DocSearch-Hit-icon--start`, which top-aligns the icon; recent - conversations use it -- The Ask AI button icon centers with `display: inline-flex` instead of - `margin-block-start`/`align-self` overrides -- Removed the 2px offset on the Ask AI sources action text -- `SourcesPanel` accepts `pluralTitleText`. `titleText` is now the singular - label, and the trigger renders `{count} {label}` -- `AskAiScreenTranslations` and `ConversationScreenTranslations` expose - `relatedSourcesTextPlural` -- Docusaurus adapter: `theme.SearchModal.askAiScreen.relatedSourcesText` is - now the singular "Source", and the new - `theme.SearchModal.askAiScreen.relatedSourcesTextPlural` provides "Sources" diff --git a/.changeset/brave-things-join.md b/.changeset/brave-things-join.md deleted file mode 100644 index f671ce93..00000000 --- a/.changeset/brave-things-join.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -"@docsearch/docusaurus-adapter": patch -"@docsearch/sidepanel": patch -"@docsearch/modal": patch -"@docsearch/react": patch -"@docsearch/core": patch ---- - -feat(v5): UI and DX updates - -- Rename the Ask AI assistantId option to agentId (adapter theme.SearchModal.askAi.assistantId → agentId) -- appId and apiKey moved up into @docsearch/core, so they're configured once and shared -- Removed the indexName prop from the Sidepanel -- Facet defaults can now be read from the index searchParameters -- Restored nested grouping of search results diff --git a/.changeset/bright-errors-block.md b/.changeset/bright-errors-block.md deleted file mode 100644 index 3299281f..00000000 --- a/.changeset/bright-errors-block.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'@docsearch/css': patch -'@docsearch/react': patch ---- - -Surface Agent Studio cost-control errors and block prompts until the user can recover. [#2878](https://github.com/algolia/docsearch/pull/2878) diff --git a/.changeset/calm-buttons-listen.md b/.changeset/calm-buttons-listen.md deleted file mode 100644 index e3d44486..00000000 --- a/.changeset/calm-buttons-listen.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -"@docsearch/core": patch -"@docsearch/react": patch ---- - -Prevent the slash search shortcut from intercepting key events on focused buttons. diff --git a/.changeset/deep-conversations-start.md b/.changeset/deep-conversations-start.md deleted file mode 100644 index 2b603d3c..00000000 --- a/.changeset/deep-conversations-start.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@docsearch/react": patch ---- - -Recognize current Agent Studio conversation-depth error messages. diff --git a/.changeset/dynamic-indices-strings.md b/.changeset/dynamic-indices-strings.md deleted file mode 100644 index 6fac1119..00000000 --- a/.changeset/dynamic-indices-strings.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -"@docsearch/react": patch -"@docsearch/docusaurus-adapter": patch ---- - -Align Ask AI dynamic indices with Agent Studio completions: `askAi.indices` is now `string[]` (index names only). Use `askAi.searchParameters` for per-index runtime overrides. diff --git a/.changeset/kind-foxes-give.md b/.changeset/kind-foxes-give.md deleted file mode 100644 index 13367588..00000000 --- a/.changeset/kind-foxes-give.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@docsearch/docusaurus-adapter": patch ---- - -fix(docusaurus-adapter): Docusaurus styling cleanup diff --git a/.changeset/long-snippets-wrap.md b/.changeset/long-snippets-wrap.md deleted file mode 100644 index 28ece56d..00000000 --- a/.changeset/long-snippets-wrap.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -"@docsearch/react": patch -"@docsearch/css": patch ---- - -Stop over-truncating mobile snippets and allow long search hits to wrap. diff --git a/.changeset/pre.json b/.changeset/pre.json deleted file mode 100644 index 3fac99d2..00000000 --- a/.changeset/pre.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "mode": "pre", - "tag": "beta", - "initialVersions": { - "@docsearch/docusaurus-adapter": "4.6.0", - "@docsearch/js-example": "4.6.0", - "@docsearch/react-example": "4.6.0", - "@docsearch/cli": "0.0.2", - "@docsearch/core": "4.6.0", - "@docsearch/css": "4.6.0", - "@docsearch/js": "4.6.0", - "@docsearch/modal": "4.6.0", - "@docsearch/react": "4.6.0", - "@docsearch/sidepanel": "4.6.0", - "@docsearch/sidepanel-js": "4.6.0", - "@docsearch/website": "4.6.0" - }, - "changesets": [ - "better-cars-smell", - "brave-things-join", - "bright-errors-block", - "calm-buttons-listen", - "deep-conversations-start", - "dynamic-indices-strings", - "kind-foxes-give", - "long-snippets-wrap", - "ready-clubs-serve", - "safe-answers-smile", - "sharp-donkeys-search", - "sixty-lights-try", - "tidy-moons-argue", - "typed-panels-wave", - "vast-numbers-read" - ] -} diff --git a/.changeset/ready-clubs-serve.md b/.changeset/ready-clubs-serve.md deleted file mode 100644 index 34c8173e..00000000 --- a/.changeset/ready-clubs-serve.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -"@docsearch/react": patch -"@docsearch/css": patch ---- - -fix(askai): Ask AI fixes for v5 - -- `getMessageContent` now joins every assistant text part instead of stopping - at the first one, so copying an answer that interleaves text with tool calls - returns the complete response (#2782) -- Key Ask AI conversation storage by `appId` instead of `indexName`, fixes - triggering a new conversation in hybrid mode -- Negative feedback panel is labelled with `aria-labelledby` and reason chips - expose selection via `aria-pressed` (styling moved off the - `--selected` modifier) -- `Popover.Trigger` forwards refs, fixes sources panel not showing in some cases -- Add `--docsearch-error-soft-color`, `--docsearch-error-text-color`, and - `--docsearch-code-block-background` variables; restyle the Ask AI error panel - and markdown code blocks to use them -``` diff --git a/.changeset/safe-answers-smile.md b/.changeset/safe-answers-smile.md deleted file mode 100644 index cfe147fc..00000000 --- a/.changeset/safe-answers-smile.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@docsearch/react": patch ---- - -Sanitize Ask AI Markdown HTML and URLs before rendering to prevent XSS. diff --git a/.changeset/sharp-donkeys-search.md b/.changeset/sharp-donkeys-search.md deleted file mode 100644 index 3284a142..00000000 --- a/.changeset/sharp-donkeys-search.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -"@docsearch/react": patch ---- - -fix(askai): support Agent Studio's batched MCP search tool - -The Algolia MCP search tool can now issue multiple queries in a single tool -call (`queries[]`), which previously rendered as an empty query and broke -consecutive tool-call aggregation. - -- `AlgoliaMCPSearchTool["input"]` accepts both the legacy single-query shape - and the new batched `queries[]` shape, and tolerates a missing `output` -- New `getSearchToolQueries()` helper normalizes query extraction across - `searchIndex`, batched MCP, and legacy MCP tool parts -- `ToolCall` renders one tool state per query for both `input-available` and - `output-available` states -- `groupConsecutiveToolResults` reuses the shared helper so batched calls - aggregate correctly -- Fix `AggregatedSearchBlock` keyboard handler comparing `e.key === 'enter'`, - which never matched and made query chips unusable via keyboard diff --git a/.changeset/sixty-lights-try.md b/.changeset/sixty-lights-try.md deleted file mode 100644 index 36511e25..00000000 --- a/.changeset/sixty-lights-try.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -"@docsearch/react": patch -"@docsearch/css": patch -"@docsearch/js": patch ---- - -feat(v5): add customizable footer action - -- New `footerAction` prop renders a custom action in the modal footer, - before the Algolia logo, inside `.DocSearch-Footer-Action` -- `@docsearch/js` supports `footerAction` via template patterns (html helper, - JSX, or function-based) -- Fixes typing differences between `@docsearch/react` and `@docsearch/js` -- Restyle the footer with a `.DocSearch-Footer-Actions` wrapper diff --git a/.changeset/tidy-moons-argue.md b/.changeset/tidy-moons-argue.md deleted file mode 100644 index 0fca4cf0..00000000 --- a/.changeset/tidy-moons-argue.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -"@docsearch/docusaurus-adapter": patch -"@docsearch/css": patch -"@docsearch/react": patch ---- - -Align CSS class and animation names with the `DocSearch-` naming convention. - -- The `shimmer` utility class is now `DocSearch-shimmer` -- Fixed a typo in `DocSearck-AskAiScreen-MessageContent-Stopped`, now - `DocSearch-AskAiScreen-MessageContent-Stopped` -- Keyframes renamed to kebab-case: `shimmerText` → `shimmer-text`, - `slideDown` → `slide-down`, `fadeIn` → `fade-in` -- Dark theme selectors use `:root[data-theme='dark']` instead of - `html[data-theme='dark']` -- Dropped redundant type qualifiers from `.DocSearch-Hits-padded` and - `.DocSearch-Hit-Select-Icon` selectors, slightly lowering their specificity - -If you override these classes or keyframes in custom styles, update your -selectors accordingly. diff --git a/.changeset/typed-panels-wave.md b/.changeset/typed-panels-wave.md deleted file mode 100644 index 990a59d5..00000000 --- a/.changeset/typed-panels-wave.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@docsearch/sidepanel-js": patch ---- - -Expose Agent Studio search parameters in the public Sidepanel JavaScript props. diff --git a/.changeset/vast-numbers-read.md b/.changeset/vast-numbers-read.md deleted file mode 100644 index 8bc6d4b4..00000000 --- a/.changeset/vast-numbers-read.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -"@docsearch/docusaurus-adapter": major -"@docsearch/core": major -"@docsearch/css": major -"@docsearch/js": major -"@docsearch/modal": major -"@docsearch/react": major -"@docsearch/sidepanel": major -"@docsearch/sidepanel-js": major ---- - -# DocSearch v5-beta - -DocSearch v5 is a major release that introduces AI-powered answers via Agent -Studio, a refreshed search UI, and a modernized package architecture. - -## Ask AI & Agent Studio - -- Agent Studio integration with core tools and dynamic tool calls -- Conversation memory support -- Compatibility with the Algolia MCP search tool, with aggregated MCP search - tool calls -- Dynamic index selection for Agent Studio -- Feedback integration, including feedback notes and tags -- Prompt suggestions in keyword search and follow-up prompt suggestions -- Ask AI modal split into its own component and Ask AI transport layer removed - -## Search UI - -- Refreshed v5 UI with improved dark theme, sources panel, and accessibility -- Faceted search with filter chips -- Hit breadcrumbs and result badges - -## Packaging & architecture - -- New `@docsearch/cli` package for MCP setup and search -- MCP plugin support -- Split JS bundles for search-only usage and JS-based hybrid mode -- Migrated the build system to tsdown -- Migrated CSS building to LightningCSS - -## Breaking changes - -- Ask AI related props are now nested under a single root `askai` option -- The Ask AI transport layer has been removed - diff --git a/.circleci/config.yml b/.circleci/config.yml index 144377e5..81457360 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -185,7 +185,6 @@ jobs: command: | export NPM_ID_TOKEN="$(circleci run oidc get --claims '{"aud": "npm:registry.npmjs.org"}')" bun run release - git push --follow-tags origin "HEAD:${CIRCLE_BRANCH}" test_playwright: <<: *playwright steps: diff --git a/adapters/docusaurus-theme-search-algolia/CHANGELOG.md b/adapters/docusaurus-theme-search-algolia/CHANGELOG.md index 0feaed48..03577fd0 100644 --- a/adapters/docusaurus-theme-search-algolia/CHANGELOG.md +++ b/adapters/docusaurus-theme-search-algolia/CHANGELOG.md @@ -1,5 +1,114 @@ # @docsearch/docusaurus-adapter +## 5.0.0 + +### Major Changes + +- ecd905d: # DocSearch v5-beta + + DocSearch v5 is a major release that introduces AI-powered answers via Agent + Studio, a refreshed search UI, and a modernized package architecture. + + ## Ask AI & Agent Studio + + - Agent Studio integration with core tools and dynamic tool calls + - Conversation memory support + - Compatibility with the Algolia MCP search tool, with aggregated MCP search + tool calls + - Dynamic index selection for Agent Studio + - Feedback integration, including feedback notes and tags + - Prompt suggestions in keyword search and follow-up prompt suggestions + - Ask AI modal split into its own component and Ask AI transport layer removed + + ## Search UI + + - Refreshed v5 UI with improved dark theme, sources panel, and accessibility + - Faceted search with filter chips + - Hit breadcrumbs and result badges + + ## Packaging & architecture + + - New `@docsearch/cli` package for MCP setup and search + - MCP plugin support + - Split JS bundles for search-only usage and JS-based hybrid mode + - Migrated the build system to tsdown + - Migrated CSS building to LightningCSS + + ## Breaking changes + + - Ask AI related props are now nested under a single root `askai` option + - The Ask AI transport layer has been removed + +### Patch Changes + +- ecd905d: feat(v5): General UI styling updates and fixes + + - New `--docsearch-font-family` variable, used by the search button, keyboard + keys, modal, and sidepanel. It replaces the system font stacks that were + duplicated across `sidepanel.css` and `button.css`, so overriding one + variable now themes every DocSearch surface + - The search input and modal heading are `1rem` at every breakpoint + (previously `0.875rem` with a mobile-only override) + - `.DocSearch-Title` uses `line-height: 1.5em` instead of `0.5em` and adds + `overflow-wrap: anywhere`, so long titles wrap instead of overlapping (#2908) + - Hit icon `svg` sizing moved into `.DocSearch-Hit-icon`. The + `.DocSearch-Hit-icon--small` modifier is replaced by + `.DocSearch-Hit-icon--start`, which top-aligns the icon; recent + conversations use it + - The Ask AI button icon centers with `display: inline-flex` instead of + `margin-block-start`/`align-self` overrides + - Removed the 2px offset on the Ask AI sources action text + - `SourcesPanel` accepts `pluralTitleText`. `titleText` is now the singular + label, and the trigger renders `{count} {label}` + - `AskAiScreenTranslations` and `ConversationScreenTranslations` expose + `relatedSourcesTextPlural` + - Docusaurus adapter: `theme.SearchModal.askAiScreen.relatedSourcesText` is + now the singular "Source", and the new + `theme.SearchModal.askAiScreen.relatedSourcesTextPlural` provides "Sources" + +- ecd905d: feat(v5): UI and DX updates + + - Rename the Ask AI assistantId option to agentId (adapter theme.SearchModal.askAi.assistantId → agentId) + - appId and apiKey moved up into @docsearch/core, so they're configured once and shared + - Removed the indexName prop from the Sidepanel + - Facet defaults can now be read from the index searchParameters + - Restored nested grouping of search results + +- ecd905d: Align Ask AI dynamic indices with Agent Studio completions: `askAi.indices` is now `string[]` (index names only). Use `askAi.searchParameters` for per-index runtime overrides. +- ecd905d: fix(docusaurus-adapter): Docusaurus styling cleanup +- ecd905d: Align CSS class and animation names with the `DocSearch-` naming convention. + + - The `shimmer` utility class is now `DocSearch-shimmer` + - Fixed a typo in `DocSearck-AskAiScreen-MessageContent-Stopped`, now + `DocSearch-AskAiScreen-MessageContent-Stopped` + - Keyframes renamed to kebab-case: `shimmerText` → `shimmer-text`, + `slideDown` → `slide-down`, `fadeIn` → `fade-in` + - Dark theme selectors use `:root[data-theme='dark']` instead of + `html[data-theme='dark']` + - Dropped redundant type qualifiers from `.DocSearch-Hits-padded` and + `.DocSearch-Hit-Select-Icon` selectors, slightly lowering their specificity + + If you override these classes or keyframes in custom styles, update your + selectors accordingly. + +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] + - @docsearch/react@5.0.0 + - @docsearch/sidepanel@5.0.0 + - @docsearch/modal@5.0.0 + - @docsearch/core@5.0.0 + ## 5.0.0-beta.4 ### Patch Changes diff --git a/adapters/docusaurus-theme-search-algolia/package.json b/adapters/docusaurus-theme-search-algolia/package.json index 5223d1fb..0fd8c01c 100644 --- a/adapters/docusaurus-theme-search-algolia/package.json +++ b/adapters/docusaurus-theme-search-algolia/package.json @@ -1,6 +1,6 @@ { "name": "@docsearch/docusaurus-adapter", - "version": "5.0.0-beta.4", + "version": "5.0.0", "description": "Algolia search component for Docusaurus.", "main": "lib/index.js", "sideEffects": [ diff --git a/bun.lock b/bun.lock index 0a5c1d0e..2f2e5f59 100644 --- a/bun.lock +++ b/bun.lock @@ -31,7 +31,7 @@ }, "adapters/docusaurus-theme-search-algolia": { "name": "@docsearch/docusaurus-adapter", - "version": "5.0.0-beta.3", + "version": "5.0.0", "dependencies": { "@algolia/autocomplete-core": "1.19.2", "@docsearch/core": "workspace:*", @@ -115,7 +115,7 @@ }, "packages/docsearch-core": { "name": "@docsearch/core", - "version": "5.0.0-beta.3", + "version": "5.0.0", "devDependencies": { "@testing-library/jest-dom": "6.6.3", "@testing-library/react": "16.2.0", @@ -137,7 +137,7 @@ }, "packages/docsearch-css": { "name": "@docsearch/css", - "version": "5.0.0-beta.3", + "version": "5.0.0", "devDependencies": { "browserslist": "4.28.2", "lightningcss": "1.32.0", @@ -146,7 +146,7 @@ }, "packages/docsearch-js": { "name": "@docsearch/js", - "version": "5.0.0-beta.3", + "version": "5.0.0", "dependencies": { "@docsearch/core": "4.6.0", "@docsearch/react": "4.6.0", @@ -160,7 +160,7 @@ }, "packages/docsearch-modal": { "name": "@docsearch/modal", - "version": "5.0.0-beta.3", + "version": "5.0.0", "dependencies": { "@docsearch/core": "5.0.0-beta.3", "@docsearch/react": "5.0.0-beta.3", @@ -185,13 +185,13 @@ }, "packages/docsearch-react": { "name": "@docsearch/react", - "version": "5.0.0-beta.3", + "version": "5.0.0", "dependencies": { "@ai-sdk/react": "^2.0.30", "@algolia/autocomplete-core": "1.19.2", "@base-ui/react": "^1.5.0", - "@docsearch/core": "5.0.0-beta.3", - "@docsearch/css": "5.0.0-beta.3", + "@docsearch/core": "5.0.0", + "@docsearch/css": "5.0.0", "ai": "^5.0.30", "algoliasearch": "^5.28.0", "marked": "^16.3.0", @@ -199,7 +199,7 @@ }, "devDependencies": { "@algolia/autocomplete-core": "1.19.2", - "@docsearch/core": "5.0.0-beta.3", + "@docsearch/core": "5.0.0", "@testing-library/jest-dom": "6.6.3", "@testing-library/react": "16.2.0", "preact": "11.0.0-beta.0", @@ -222,7 +222,7 @@ }, "packages/docsearch-sidepanel": { "name": "@docsearch/sidepanel", - "version": "5.0.0-beta.3", + "version": "5.0.0", "dependencies": { "@docsearch/core": "5.0.0-beta.3", "@docsearch/css": "5.0.0-beta.3", @@ -248,7 +248,7 @@ }, "packages/docsearch-sidepanel-js": { "name": "@docsearch/sidepanel-js", - "version": "5.0.0-beta.3", + "version": "5.0.0", "dependencies": { "@docsearch/core": "4.6.0", "@docsearch/react": "4.6.0", diff --git a/package.json b/package.json index 9eaf202e..ef7b2edd 100644 --- a/package.json +++ b/package.json @@ -55,7 +55,7 @@ "website:serve": "bun --filter @docsearch/website serve -- --host 0.0.0.0", "website:test": "bun --filter @docsearch/website start -- --no-open", "changeset": "changeset", - "version": "changeset version && bun run sync:docsearch-version", + "version": "changeset version && bun run sync:docsearch-version && bun install", "release": "changeset publish", "sync:docsearch-version": "bun scripts/updateDocsearchVersion.ts" }, diff --git a/packages/docsearch-core/CHANGELOG.md b/packages/docsearch-core/CHANGELOG.md index 22eca5da..2bcae654 100644 --- a/packages/docsearch-core/CHANGELOG.md +++ b/packages/docsearch-core/CHANGELOG.md @@ -1,5 +1,56 @@ # @docsearch/core +## 5.0.0 + +### Major Changes + +- ecd905d: # DocSearch v5-beta + + DocSearch v5 is a major release that introduces AI-powered answers via Agent + Studio, a refreshed search UI, and a modernized package architecture. + + ## Ask AI & Agent Studio + + - Agent Studio integration with core tools and dynamic tool calls + - Conversation memory support + - Compatibility with the Algolia MCP search tool, with aggregated MCP search + tool calls + - Dynamic index selection for Agent Studio + - Feedback integration, including feedback notes and tags + - Prompt suggestions in keyword search and follow-up prompt suggestions + - Ask AI modal split into its own component and Ask AI transport layer removed + + ## Search UI + + - Refreshed v5 UI with improved dark theme, sources panel, and accessibility + - Faceted search with filter chips + - Hit breadcrumbs and result badges + + ## Packaging & architecture + + - New `@docsearch/cli` package for MCP setup and search + - MCP plugin support + - Split JS bundles for search-only usage and JS-based hybrid mode + - Migrated the build system to tsdown + - Migrated CSS building to LightningCSS + + ## Breaking changes + + - Ask AI related props are now nested under a single root `askai` option + - The Ask AI transport layer has been removed + +### Patch Changes + +- ecd905d: feat(v5): UI and DX updates + + - Rename the Ask AI assistantId option to agentId (adapter theme.SearchModal.askAi.assistantId → agentId) + - appId and apiKey moved up into @docsearch/core, so they're configured once and shared + - Removed the indexName prop from the Sidepanel + - Facet defaults can now be read from the index searchParameters + - Restored nested grouping of search results + +- ecd905d: Prevent the slash search shortcut from intercepting key events on focused buttons. + ## 5.0.0-beta.4 ## 5.0.0-beta.3 diff --git a/packages/docsearch-core/package.json b/packages/docsearch-core/package.json index eac2170a..83a38c5f 100644 --- a/packages/docsearch-core/package.json +++ b/packages/docsearch-core/package.json @@ -1,7 +1,7 @@ { "name": "@docsearch/core", "description": "Core package logic for DocSearch", - "version": "5.0.0-beta.4", + "version": "5.0.0", "license": "MIT", "type": "module", "homepage": "https://docsearch.algolia.com", diff --git a/packages/docsearch-css/CHANGELOG.md b/packages/docsearch-css/CHANGELOG.md index f6781ac7..61e80572 100644 --- a/packages/docsearch-css/CHANGELOG.md +++ b/packages/docsearch-css/CHANGELOG.md @@ -1,5 +1,116 @@ # @docsearch/css +## 5.0.0 + +### Major Changes + +- ecd905d: # DocSearch v5-beta + + DocSearch v5 is a major release that introduces AI-powered answers via Agent + Studio, a refreshed search UI, and a modernized package architecture. + + ## Ask AI & Agent Studio + + - Agent Studio integration with core tools and dynamic tool calls + - Conversation memory support + - Compatibility with the Algolia MCP search tool, with aggregated MCP search + tool calls + - Dynamic index selection for Agent Studio + - Feedback integration, including feedback notes and tags + - Prompt suggestions in keyword search and follow-up prompt suggestions + - Ask AI modal split into its own component and Ask AI transport layer removed + + ## Search UI + + - Refreshed v5 UI with improved dark theme, sources panel, and accessibility + - Faceted search with filter chips + - Hit breadcrumbs and result badges + + ## Packaging & architecture + + - New `@docsearch/cli` package for MCP setup and search + - MCP plugin support + - Split JS bundles for search-only usage and JS-based hybrid mode + - Migrated the build system to tsdown + - Migrated CSS building to LightningCSS + + ## Breaking changes + + - Ask AI related props are now nested under a single root `askai` option + - The Ask AI transport layer has been removed + +### Patch Changes + +- ecd905d: feat(v5): General UI styling updates and fixes + + - New `--docsearch-font-family` variable, used by the search button, keyboard + keys, modal, and sidepanel. It replaces the system font stacks that were + duplicated across `sidepanel.css` and `button.css`, so overriding one + variable now themes every DocSearch surface + - The search input and modal heading are `1rem` at every breakpoint + (previously `0.875rem` with a mobile-only override) + - `.DocSearch-Title` uses `line-height: 1.5em` instead of `0.5em` and adds + `overflow-wrap: anywhere`, so long titles wrap instead of overlapping (#2908) + - Hit icon `svg` sizing moved into `.DocSearch-Hit-icon`. The + `.DocSearch-Hit-icon--small` modifier is replaced by + `.DocSearch-Hit-icon--start`, which top-aligns the icon; recent + conversations use it + - The Ask AI button icon centers with `display: inline-flex` instead of + `margin-block-start`/`align-self` overrides + - Removed the 2px offset on the Ask AI sources action text + - `SourcesPanel` accepts `pluralTitleText`. `titleText` is now the singular + label, and the trigger renders `{count} {label}` + - `AskAiScreenTranslations` and `ConversationScreenTranslations` expose + `relatedSourcesTextPlural` + - Docusaurus adapter: `theme.SearchModal.askAiScreen.relatedSourcesText` is + now the singular "Source", and the new + `theme.SearchModal.askAiScreen.relatedSourcesTextPlural` provides "Sources" + +- ecd905d: Surface Agent Studio cost-control errors and block prompts until the user can recover. [#2878](https://github.com/algolia/docsearch/pull/2878) +- ecd905d: Stop over-truncating mobile snippets and allow long search hits to wrap. +- ecd905d: fix(askai): Ask AI fixes for v5 + + - `getMessageContent` now joins every assistant text part instead of stopping + at the first one, so copying an answer that interleaves text with tool calls + returns the complete response (#2782) + - Key Ask AI conversation storage by `appId` instead of `indexName`, fixes + triggering a new conversation in hybrid mode + - Negative feedback panel is labelled with `aria-labelledby` and reason chips + expose selection via `aria-pressed` (styling moved off the + `--selected` modifier) + - `Popover.Trigger` forwards refs, fixes sources panel not showing in some cases + - Add `--docsearch-error-soft-color`, `--docsearch-error-text-color`, and + `--docsearch-code-block-background` variables; restyle the Ask AI error panel + and markdown code blocks to use them + + ``` + + ``` + +- ecd905d: feat(v5): add customizable footer action + + - New `footerAction` prop renders a custom action in the modal footer, + before the Algolia logo, inside `.DocSearch-Footer-Action` + - `@docsearch/js` supports `footerAction` via template patterns (html helper, + JSX, or function-based) + - Fixes typing differences between `@docsearch/react` and `@docsearch/js` + - Restyle the footer with a `.DocSearch-Footer-Actions` wrapper + +- ecd905d: Align CSS class and animation names with the `DocSearch-` naming convention. + + - The `shimmer` utility class is now `DocSearch-shimmer` + - Fixed a typo in `DocSearck-AskAiScreen-MessageContent-Stopped`, now + `DocSearch-AskAiScreen-MessageContent-Stopped` + - Keyframes renamed to kebab-case: `shimmerText` → `shimmer-text`, + `slideDown` → `slide-down`, `fadeIn` → `fade-in` + - Dark theme selectors use `:root[data-theme='dark']` instead of + `html[data-theme='dark']` + - Dropped redundant type qualifiers from `.DocSearch-Hits-padded` and + `.DocSearch-Hit-Select-Icon` selectors, slightly lowering their specificity + + If you override these classes or keyframes in custom styles, update your + selectors accordingly. + ## 5.0.0-beta.4 ### Patch Changes diff --git a/packages/docsearch-css/package.json b/packages/docsearch-css/package.json index 2c0f3091..09dc56c6 100644 --- a/packages/docsearch-css/package.json +++ b/packages/docsearch-css/package.json @@ -1,7 +1,7 @@ { "name": "@docsearch/css", "description": "Styles for DocSearch.", - "version": "5.0.0-beta.4", + "version": "5.0.0", "license": "MIT", "homepage": "https://docsearch.algolia.com", "repository": { diff --git a/packages/docsearch-js/CHANGELOG.md b/packages/docsearch-js/CHANGELOG.md index 9a276a40..eac57801 100644 --- a/packages/docsearch-js/CHANGELOG.md +++ b/packages/docsearch-js/CHANGELOG.md @@ -1,5 +1,71 @@ # @docsearch/js +## 5.0.0 + +### Major Changes + +- ecd905d: # DocSearch v5-beta + + DocSearch v5 is a major release that introduces AI-powered answers via Agent + Studio, a refreshed search UI, and a modernized package architecture. + + ## Ask AI & Agent Studio + + - Agent Studio integration with core tools and dynamic tool calls + - Conversation memory support + - Compatibility with the Algolia MCP search tool, with aggregated MCP search + tool calls + - Dynamic index selection for Agent Studio + - Feedback integration, including feedback notes and tags + - Prompt suggestions in keyword search and follow-up prompt suggestions + - Ask AI modal split into its own component and Ask AI transport layer removed + + ## Search UI + + - Refreshed v5 UI with improved dark theme, sources panel, and accessibility + - Faceted search with filter chips + - Hit breadcrumbs and result badges + + ## Packaging & architecture + + - New `@docsearch/cli` package for MCP setup and search + - MCP plugin support + - Split JS bundles for search-only usage and JS-based hybrid mode + - Migrated the build system to tsdown + - Migrated CSS building to LightningCSS + + ## Breaking changes + + - Ask AI related props are now nested under a single root `askai` option + - The Ask AI transport layer has been removed + +### Patch Changes + +- ecd905d: feat(v5): add customizable footer action + + - New `footerAction` prop renders a custom action in the modal footer, + before the Algolia logo, inside `.DocSearch-Footer-Action` + - `@docsearch/js` supports `footerAction` via template patterns (html helper, + JSX, or function-based) + - Fixes typing differences between `@docsearch/react` and `@docsearch/js` + - Restyle the footer with a `.DocSearch-Footer-Actions` wrapper + +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] + - @docsearch/react@5.0.0 + - @docsearch/core@5.0.0 + ## 5.0.0-beta.4 ### Patch Changes diff --git a/packages/docsearch-js/package.json b/packages/docsearch-js/package.json index 75227354..8d2f0404 100644 --- a/packages/docsearch-js/package.json +++ b/packages/docsearch-js/package.json @@ -1,7 +1,7 @@ { "name": "@docsearch/js", "description": "JavaScript package for DocSearch, the best search experience for docs.", - "version": "5.0.0-beta.4", + "version": "5.0.0", "license": "MIT", "homepage": "https://docsearch.algolia.com", "repository": { @@ -33,8 +33,8 @@ "watch": "tsdown --watch" }, "dependencies": { - "@docsearch/core": "5.0.0-beta.4", - "@docsearch/react": "5.0.0-beta.4" + "@docsearch/core": "5.0.0", + "@docsearch/react": "5.0.0" }, "devDependencies": { "htm": "3.1.1", diff --git a/packages/docsearch-modal/CHANGELOG.md b/packages/docsearch-modal/CHANGELOG.md index 9a130856..15662f8a 100644 --- a/packages/docsearch-modal/CHANGELOG.md +++ b/packages/docsearch-modal/CHANGELOG.md @@ -1,5 +1,70 @@ # @docsearch/modal +## 5.0.0 + +### Major Changes + +- ecd905d: # DocSearch v5-beta + + DocSearch v5 is a major release that introduces AI-powered answers via Agent + Studio, a refreshed search UI, and a modernized package architecture. + + ## Ask AI & Agent Studio + + - Agent Studio integration with core tools and dynamic tool calls + - Conversation memory support + - Compatibility with the Algolia MCP search tool, with aggregated MCP search + tool calls + - Dynamic index selection for Agent Studio + - Feedback integration, including feedback notes and tags + - Prompt suggestions in keyword search and follow-up prompt suggestions + - Ask AI modal split into its own component and Ask AI transport layer removed + + ## Search UI + + - Refreshed v5 UI with improved dark theme, sources panel, and accessibility + - Faceted search with filter chips + - Hit breadcrumbs and result badges + + ## Packaging & architecture + + - New `@docsearch/cli` package for MCP setup and search + - MCP plugin support + - Split JS bundles for search-only usage and JS-based hybrid mode + - Migrated the build system to tsdown + - Migrated CSS building to LightningCSS + + ## Breaking changes + + - Ask AI related props are now nested under a single root `askai` option + - The Ask AI transport layer has been removed + +### Patch Changes + +- ecd905d: feat(v5): UI and DX updates + + - Rename the Ask AI assistantId option to agentId (adapter theme.SearchModal.askAi.assistantId → agentId) + - appId and apiKey moved up into @docsearch/core, so they're configured once and shared + - Removed the indexName prop from the Sidepanel + - Facet defaults can now be read from the index searchParameters + - Restored nested grouping of search results + +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] + - @docsearch/react@5.0.0 + - @docsearch/core@5.0.0 + ## 5.0.0-beta.4 ### Patch Changes diff --git a/packages/docsearch-modal/package.json b/packages/docsearch-modal/package.json index bf825153..2fef72ba 100644 --- a/packages/docsearch-modal/package.json +++ b/packages/docsearch-modal/package.json @@ -1,7 +1,7 @@ { "name": "@docsearch/modal", "description": "DocSearch modal package for keyword search and Ask AI.", - "version": "5.0.0-beta.4", + "version": "5.0.0", "license": "MIT", "homepage": "https://docsearch.algolia.com", "repository": { @@ -35,8 +35,8 @@ "watch": "tsdown --watch" }, "dependencies": { - "@docsearch/core": "5.0.0-beta.4", - "@docsearch/react": "5.0.0-beta.4" + "@docsearch/core": "5.0.0", + "@docsearch/react": "5.0.0" }, "devDependencies": { "@testing-library/jest-dom": "6.6.3", diff --git a/packages/docsearch-react/CHANGELOG.md b/packages/docsearch-react/CHANGELOG.md index 8464d825..2182b08c 100644 --- a/packages/docsearch-react/CHANGELOG.md +++ b/packages/docsearch-react/CHANGELOG.md @@ -1,5 +1,157 @@ # @docsearch/react +## 5.0.0 + +### Major Changes + +- ecd905d: # DocSearch v5-beta + + DocSearch v5 is a major release that introduces AI-powered answers via Agent + Studio, a refreshed search UI, and a modernized package architecture. + + ## Ask AI & Agent Studio + + - Agent Studio integration with core tools and dynamic tool calls + - Conversation memory support + - Compatibility with the Algolia MCP search tool, with aggregated MCP search + tool calls + - Dynamic index selection for Agent Studio + - Feedback integration, including feedback notes and tags + - Prompt suggestions in keyword search and follow-up prompt suggestions + - Ask AI modal split into its own component and Ask AI transport layer removed + + ## Search UI + + - Refreshed v5 UI with improved dark theme, sources panel, and accessibility + - Faceted search with filter chips + - Hit breadcrumbs and result badges + + ## Packaging & architecture + + - New `@docsearch/cli` package for MCP setup and search + - MCP plugin support + - Split JS bundles for search-only usage and JS-based hybrid mode + - Migrated the build system to tsdown + - Migrated CSS building to LightningCSS + + ## Breaking changes + + - Ask AI related props are now nested under a single root `askai` option + - The Ask AI transport layer has been removed + +### Patch Changes + +- ecd905d: feat(v5): General UI styling updates and fixes + + - New `--docsearch-font-family` variable, used by the search button, keyboard + keys, modal, and sidepanel. It replaces the system font stacks that were + duplicated across `sidepanel.css` and `button.css`, so overriding one + variable now themes every DocSearch surface + - The search input and modal heading are `1rem` at every breakpoint + (previously `0.875rem` with a mobile-only override) + - `.DocSearch-Title` uses `line-height: 1.5em` instead of `0.5em` and adds + `overflow-wrap: anywhere`, so long titles wrap instead of overlapping (#2908) + - Hit icon `svg` sizing moved into `.DocSearch-Hit-icon`. The + `.DocSearch-Hit-icon--small` modifier is replaced by + `.DocSearch-Hit-icon--start`, which top-aligns the icon; recent + conversations use it + - The Ask AI button icon centers with `display: inline-flex` instead of + `margin-block-start`/`align-self` overrides + - Removed the 2px offset on the Ask AI sources action text + - `SourcesPanel` accepts `pluralTitleText`. `titleText` is now the singular + label, and the trigger renders `{count} {label}` + - `AskAiScreenTranslations` and `ConversationScreenTranslations` expose + `relatedSourcesTextPlural` + - Docusaurus adapter: `theme.SearchModal.askAiScreen.relatedSourcesText` is + now the singular "Source", and the new + `theme.SearchModal.askAiScreen.relatedSourcesTextPlural` provides "Sources" + +- ecd905d: feat(v5): UI and DX updates + + - Rename the Ask AI assistantId option to agentId (adapter theme.SearchModal.askAi.assistantId → agentId) + - appId and apiKey moved up into @docsearch/core, so they're configured once and shared + - Removed the indexName prop from the Sidepanel + - Facet defaults can now be read from the index searchParameters + - Restored nested grouping of search results + +- ecd905d: Surface Agent Studio cost-control errors and block prompts until the user can recover. [#2878](https://github.com/algolia/docsearch/pull/2878) +- ecd905d: Prevent the slash search shortcut from intercepting key events on focused buttons. +- ecd905d: Recognize current Agent Studio conversation-depth error messages. +- ecd905d: Align Ask AI dynamic indices with Agent Studio completions: `askAi.indices` is now `string[]` (index names only). Use `askAi.searchParameters` for per-index runtime overrides. +- ecd905d: Stop over-truncating mobile snippets and allow long search hits to wrap. +- ecd905d: fix(askai): Ask AI fixes for v5 + + - `getMessageContent` now joins every assistant text part instead of stopping + at the first one, so copying an answer that interleaves text with tool calls + returns the complete response (#2782) + - Key Ask AI conversation storage by `appId` instead of `indexName`, fixes + triggering a new conversation in hybrid mode + - Negative feedback panel is labelled with `aria-labelledby` and reason chips + expose selection via `aria-pressed` (styling moved off the + `--selected` modifier) + - `Popover.Trigger` forwards refs, fixes sources panel not showing in some cases + - Add `--docsearch-error-soft-color`, `--docsearch-error-text-color`, and + `--docsearch-code-block-background` variables; restyle the Ask AI error panel + and markdown code blocks to use them + + ``` + + ``` + +- ecd905d: Sanitize Ask AI Markdown HTML and URLs before rendering to prevent XSS. +- ecd905d: fix(askai): support Agent Studio's batched MCP search tool + + The Algolia MCP search tool can now issue multiple queries in a single tool + call (`queries[]`), which previously rendered as an empty query and broke + consecutive tool-call aggregation. + + - `AlgoliaMCPSearchTool["input"]` accepts both the legacy single-query shape + and the new batched `queries[]` shape, and tolerates a missing `output` + - New `getSearchToolQueries()` helper normalizes query extraction across + `searchIndex`, batched MCP, and legacy MCP tool parts + - `ToolCall` renders one tool state per query for both `input-available` and + `output-available` states + - `groupConsecutiveToolResults` reuses the shared helper so batched calls + aggregate correctly + - Fix `AggregatedSearchBlock` keyboard handler comparing `e.key === 'enter'`, + which never matched and made query chips unusable via keyboard + +- ecd905d: feat(v5): add customizable footer action + + - New `footerAction` prop renders a custom action in the modal footer, + before the Algolia logo, inside `.DocSearch-Footer-Action` + - `@docsearch/js` supports `footerAction` via template patterns (html helper, + JSX, or function-based) + - Fixes typing differences between `@docsearch/react` and `@docsearch/js` + - Restyle the footer with a `.DocSearch-Footer-Actions` wrapper + +- ecd905d: Align CSS class and animation names with the `DocSearch-` naming convention. + + - The `shimmer` utility class is now `DocSearch-shimmer` + - Fixed a typo in `DocSearck-AskAiScreen-MessageContent-Stopped`, now + `DocSearch-AskAiScreen-MessageContent-Stopped` + - Keyframes renamed to kebab-case: `shimmerText` → `shimmer-text`, + `slideDown` → `slide-down`, `fadeIn` → `fade-in` + - Dark theme selectors use `:root[data-theme='dark']` instead of + `html[data-theme='dark']` + - Dropped redundant type qualifiers from `.DocSearch-Hits-padded` and + `.DocSearch-Hit-Select-Icon` selectors, slightly lowering their specificity + + If you override these classes or keyframes in custom styles, update your + selectors accordingly. + +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] + - @docsearch/css@5.0.0 + - @docsearch/core@5.0.0 + ## 5.0.0-beta.4 ### Patch Changes diff --git a/packages/docsearch-react/package.json b/packages/docsearch-react/package.json index d4d76089..b812c702 100644 --- a/packages/docsearch-react/package.json +++ b/packages/docsearch-react/package.json @@ -1,7 +1,7 @@ { "name": "@docsearch/react", "description": "React package for DocSearch, the best search experience for docs.", - "version": "5.0.0-beta.4", + "version": "5.0.0", "license": "MIT", "homepage": "https://docsearch.algolia.com", "repository": { @@ -50,8 +50,8 @@ "@ai-sdk/react": "^2.0.30", "@algolia/autocomplete-core": "1.19.2", "@base-ui/react": "^1.5.0", - "@docsearch/core": "5.0.0-beta.4", - "@docsearch/css": "5.0.0-beta.4", + "@docsearch/core": "5.0.0", + "@docsearch/css": "5.0.0", "ai": "^5.0.30", "algoliasearch": "^5.28.0", "marked": "^16.3.0", @@ -59,7 +59,7 @@ }, "devDependencies": { "@algolia/autocomplete-core": "1.19.2", - "@docsearch/core": "5.0.0-beta.4", + "@docsearch/core": "5.0.0", "@testing-library/jest-dom": "6.6.3", "@testing-library/react": "16.2.0", "preact": "11.0.0-beta.0", diff --git a/packages/docsearch-react/src/version.ts b/packages/docsearch-react/src/version.ts index 2c487c8f..56b7f454 100644 --- a/packages/docsearch-react/src/version.ts +++ b/packages/docsearch-react/src/version.ts @@ -1 +1 @@ -export const version = '5.0.0-beta.4'; +export const version = '5.0.0'; diff --git a/packages/docsearch-sidepanel-js/CHANGELOG.md b/packages/docsearch-sidepanel-js/CHANGELOG.md index 6daa8819..05919ec7 100644 --- a/packages/docsearch-sidepanel-js/CHANGELOG.md +++ b/packages/docsearch-sidepanel-js/CHANGELOG.md @@ -1,5 +1,63 @@ # @docsearch/sidepanel-js +## 5.0.0 + +### Major Changes + +- ecd905d: # DocSearch v5-beta + + DocSearch v5 is a major release that introduces AI-powered answers via Agent + Studio, a refreshed search UI, and a modernized package architecture. + + ## Ask AI & Agent Studio + + - Agent Studio integration with core tools and dynamic tool calls + - Conversation memory support + - Compatibility with the Algolia MCP search tool, with aggregated MCP search + tool calls + - Dynamic index selection for Agent Studio + - Feedback integration, including feedback notes and tags + - Prompt suggestions in keyword search and follow-up prompt suggestions + - Ask AI modal split into its own component and Ask AI transport layer removed + + ## Search UI + + - Refreshed v5 UI with improved dark theme, sources panel, and accessibility + - Faceted search with filter chips + - Hit breadcrumbs and result badges + + ## Packaging & architecture + + - New `@docsearch/cli` package for MCP setup and search + - MCP plugin support + - Split JS bundles for search-only usage and JS-based hybrid mode + - Migrated the build system to tsdown + - Migrated CSS building to LightningCSS + + ## Breaking changes + + - Ask AI related props are now nested under a single root `askai` option + - The Ask AI transport layer has been removed + +### Patch Changes + +- ecd905d: Expose Agent Studio search parameters in the public Sidepanel JavaScript props. +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] + - @docsearch/react@5.0.0 + - @docsearch/core@5.0.0 + ## 5.0.0-beta.4 ### Patch Changes diff --git a/packages/docsearch-sidepanel-js/package.json b/packages/docsearch-sidepanel-js/package.json index 49e6ac91..77d82a57 100644 --- a/packages/docsearch-sidepanel-js/package.json +++ b/packages/docsearch-sidepanel-js/package.json @@ -1,7 +1,7 @@ { "name": "@docsearch/sidepanel-js", "description": "JavaScript package for DocSearch Sidepanel for interfacing with Ask AI.", - "version": "5.0.0-beta.4", + "version": "5.0.0", "license": "MIT", "homepage": "https://docsearch.algolia.com", "repository": { @@ -32,8 +32,8 @@ "watch": "tsdown --watch" }, "dependencies": { - "@docsearch/core": "5.0.0-beta.4", - "@docsearch/react": "5.0.0-beta.4" + "@docsearch/core": "5.0.0", + "@docsearch/react": "5.0.0" }, "devDependencies": { "preact": "11.0.0-beta.0", diff --git a/packages/docsearch-sidepanel/CHANGELOG.md b/packages/docsearch-sidepanel/CHANGELOG.md index b592b958..c805dcf6 100644 --- a/packages/docsearch-sidepanel/CHANGELOG.md +++ b/packages/docsearch-sidepanel/CHANGELOG.md @@ -1,5 +1,71 @@ # @docsearch/sidepanel +## 5.0.0 + +### Major Changes + +- ecd905d: # DocSearch v5-beta + + DocSearch v5 is a major release that introduces AI-powered answers via Agent + Studio, a refreshed search UI, and a modernized package architecture. + + ## Ask AI & Agent Studio + + - Agent Studio integration with core tools and dynamic tool calls + - Conversation memory support + - Compatibility with the Algolia MCP search tool, with aggregated MCP search + tool calls + - Dynamic index selection for Agent Studio + - Feedback integration, including feedback notes and tags + - Prompt suggestions in keyword search and follow-up prompt suggestions + - Ask AI modal split into its own component and Ask AI transport layer removed + + ## Search UI + + - Refreshed v5 UI with improved dark theme, sources panel, and accessibility + - Faceted search with filter chips + - Hit breadcrumbs and result badges + + ## Packaging & architecture + + - New `@docsearch/cli` package for MCP setup and search + - MCP plugin support + - Split JS bundles for search-only usage and JS-based hybrid mode + - Migrated the build system to tsdown + - Migrated CSS building to LightningCSS + + ## Breaking changes + + - Ask AI related props are now nested under a single root `askai` option + - The Ask AI transport layer has been removed + +### Patch Changes + +- ecd905d: feat(v5): UI and DX updates + + - Rename the Ask AI assistantId option to agentId (adapter theme.SearchModal.askAi.assistantId → agentId) + - appId and apiKey moved up into @docsearch/core, so they're configured once and shared + - Removed the indexName prop from the Sidepanel + - Facet defaults can now be read from the index searchParameters + - Restored nested grouping of search results + +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] +- Updated dependencies [ecd905d] + - @docsearch/react@5.0.0 + - @docsearch/css@5.0.0 + - @docsearch/core@5.0.0 + ## 5.0.0-beta.4 ### Patch Changes diff --git a/packages/docsearch-sidepanel/package.json b/packages/docsearch-sidepanel/package.json index a623ad7f..f8c51723 100644 --- a/packages/docsearch-sidepanel/package.json +++ b/packages/docsearch-sidepanel/package.json @@ -1,7 +1,7 @@ { "name": "@docsearch/sidepanel", "description": "DocSearch Sidepanel package for Ask AI.", - "version": "5.0.0-beta.4", + "version": "5.0.0", "license": "MIT", "homepage": "https://docsearch.algolia.com", "repository": { @@ -38,9 +38,9 @@ "watch": "tsdown --watch" }, "dependencies": { - "@docsearch/core": "5.0.0-beta.4", - "@docsearch/css": "5.0.0-beta.4", - "@docsearch/react": "5.0.0-beta.4" + "@docsearch/core": "5.0.0", + "@docsearch/css": "5.0.0", + "@docsearch/react": "5.0.0" }, "devDependencies": { "@testing-library/jest-dom": "6.6.3",