diff --git a/CHANGELOG.md b/CHANGELOG.md index d5ead3494..666d25b76 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,19 @@ +# [3.8.0](https://github.com/algolia/docsearch/compare/v3.7.0...v3.8.0) (2024-11-12) + +This version introduces a new type [DocSearchTransformClient](https://github.com/algolia/docsearch/blob/main/packages/docsearch-react/src/DocSearch.tsx#L19) to allow the `transformSearchClient` to use either the lite client, or the full algoliasearch client. +Users are encouraged to use the [lite client](https://www.algolia.com/doc/libraries/javascript/v5/methods/search/) (`import { liteClient } from 'algoliasearch/lite`) to reduce bundle size. + +### Bug Fixes + +* **types:** use a minimal type for transformSearchClient ([#2348](https://github.com/algolia/docsearch/issues/2348)) ([08d9a37](https://github.com/algolia/docsearch/commit/08d9a37807a136da99ca2dd39f4cbc86ade9c5bf)) + + +### Features + +* **a11y:** add hotkeys to search input aria-label ([#2337](https://github.com/algolia/docsearch/issues/2337)) ([44aa7dc](https://github.com/algolia/docsearch/commit/44aa7dcf3831b533d9546c95a916d6acdee9d6d8)) + + + # [3.7.0](https://github.com/algolia/docsearch/compare/v3.6.3...v3.7.0) (2024-11-04) diff --git a/examples/demo/package.json b/examples/demo/package.json index 1d7ce25d3..af96ec85d 100644 --- a/examples/demo/package.json +++ b/examples/demo/package.json @@ -1,7 +1,7 @@ { "name": "@docsearch/react-example", "description": "DocSearch v3 React example", - "version": "3.7.0", + "version": "3.8.0", "private": true, "license": "MIT", "type": "module", @@ -11,8 +11,8 @@ "preview": "vite preview" }, "dependencies": { - "@docsearch/css": "3.7.0", - "@docsearch/react": "3.7.0", + "@docsearch/css": "3.8.0", + "@docsearch/react": "3.8.0", "react": "^18.0.0", "react-dom": "^18.0.0" }, diff --git a/examples/js-demo/package.json b/examples/js-demo/package.json index 19ae77dc6..003f0a46f 100644 --- a/examples/js-demo/package.json +++ b/examples/js-demo/package.json @@ -1,7 +1,7 @@ { "name": "@docsearch/js-example", "description": "DocSearch v3 Vanilla JavaScript example", - "version": "3.7.0", + "version": "3.8.0", "private": true, "license": "MIT", "scripts": { @@ -10,8 +10,8 @@ "preview": "vite preview" }, "dependencies": { - "@docsearch/css": "3.7.0", - "@docsearch/js": "3.7.0" + "@docsearch/css": "3.8.0", + "@docsearch/js": "3.8.0" }, "devDependencies": { "vite": "^5.4.10" diff --git a/lerna.json b/lerna.json index 3ecd24b35..f58d04aa3 100644 --- a/lerna.json +++ b/lerna.json @@ -3,6 +3,6 @@ "packages/*", "examples/*" ], - "version": "3.7.0", + "version": "3.8.0", "npmClient": "yarn" -} +} \ No newline at end of file diff --git a/packages/docsearch-css/package.json b/packages/docsearch-css/package.json index d516afec3..a2b6df40b 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": "3.7.0", + "version": "3.8.0", "license": "MIT", "homepage": "https://docsearch.algolia.com", "repository": { diff --git a/packages/docsearch-js/package.json b/packages/docsearch-js/package.json index a38e38700..4f2e0515a 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": "3.7.0", + "version": "3.8.0", "license": "MIT", "homepage": "https://docsearch.algolia.com", "repository": { @@ -32,7 +32,7 @@ "watch": "watch \"yarn on:change\" --ignoreDirectoryPattern \"/dist/\"" }, "dependencies": { - "@docsearch/react": "3.7.0", + "@docsearch/react": "3.8.0", "preact": "^10.0.0" }, "devDependencies": { diff --git a/packages/docsearch-react/package.json b/packages/docsearch-react/package.json index 5f434e175..b6e9fc4dc 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": "3.7.0", + "version": "3.8.0", "license": "MIT", "homepage": "https://docsearch.algolia.com", "repository": { @@ -37,7 +37,7 @@ "dependencies": { "@algolia/autocomplete-core": "1.17.7", "@algolia/autocomplete-preset-algolia": "1.17.7", - "@docsearch/css": "3.7.0", + "@docsearch/css": "3.8.0", "algoliasearch": "^5.12.0" }, "devDependencies": { diff --git a/packages/docsearch-react/src/version.ts b/packages/docsearch-react/src/version.ts index 0d774fa01..ab297a7f0 100644 --- a/packages/docsearch-react/src/version.ts +++ b/packages/docsearch-react/src/version.ts @@ -1 +1 @@ -export const version = '3.7.0'; +export const version = '3.8.0'; diff --git a/packages/website/package.json b/packages/website/package.json index 51326cae8..07c2290b8 100644 --- a/packages/website/package.json +++ b/packages/website/package.json @@ -1,6 +1,6 @@ { "name": "@docsearch/website", - "version": "3.7.0", + "version": "3.8.0", "private": true, "homepage": "https://docsearch.algolia.com/", "scripts": { @@ -17,7 +17,7 @@ }, "dependencies": { "@algolia/ui-library": "5.86.0", - "@docsearch/react": "3.7.0", + "@docsearch/react": "3.8.0", "@docusaurus/core": "3.6.1", "@docusaurus/preset-classic": "3.6.1", "@mdx-js/react": "^3.1.0", diff --git a/yarn.lock b/yarn.lock index 3cd48b7a1..3ebf4ce4d 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2232,7 +2232,7 @@ __metadata: languageName: node linkType: hard -"@docsearch/css@npm:3.7.0, @docsearch/css@workspace:packages/docsearch-css": +"@docsearch/css@npm:3.8.0, @docsearch/css@workspace:packages/docsearch-css": version: 0.0.0-use.local resolution: "@docsearch/css@workspace:packages/docsearch-css" languageName: unknown @@ -2242,17 +2242,17 @@ __metadata: version: 0.0.0-use.local resolution: "@docsearch/js-example@workspace:examples/js-demo" dependencies: - "@docsearch/css": "npm:3.7.0" - "@docsearch/js": "npm:3.7.0" + "@docsearch/css": "npm:3.8.0" + "@docsearch/js": "npm:3.8.0" vite: "npm:^5.4.10" languageName: unknown linkType: soft -"@docsearch/js@npm:3.7.0, @docsearch/js@workspace:packages/docsearch-js": +"@docsearch/js@npm:3.8.0, @docsearch/js@workspace:packages/docsearch-js": version: 0.0.0-use.local resolution: "@docsearch/js@workspace:packages/docsearch-js" dependencies: - "@docsearch/react": "npm:3.7.0" + "@docsearch/react": "npm:3.8.0" "@rollup/plugin-replace": "npm:6.0.1" preact: "npm:^10.0.0" languageName: unknown @@ -2320,8 +2320,8 @@ __metadata: version: 0.0.0-use.local resolution: "@docsearch/react-example@workspace:examples/demo" dependencies: - "@docsearch/css": "npm:3.7.0" - "@docsearch/react": "npm:3.7.0" + "@docsearch/css": "npm:3.8.0" + "@docsearch/react": "npm:3.8.0" "@vitejs/plugin-react": "npm:^4.3.3" react: "npm:^18.0.0" react-dom: "npm:^18.0.0" @@ -2329,13 +2329,13 @@ __metadata: languageName: unknown linkType: soft -"@docsearch/react@npm:3.7.0, @docsearch/react@npm:^3.5.2, @docsearch/react@workspace:packages/docsearch-react": +"@docsearch/react@npm:3.8.0, @docsearch/react@npm:^3.5.2, @docsearch/react@workspace:packages/docsearch-react": version: 0.0.0-use.local resolution: "@docsearch/react@workspace:packages/docsearch-react" dependencies: "@algolia/autocomplete-core": "npm:1.17.7" "@algolia/autocomplete-preset-algolia": "npm:1.17.7" - "@docsearch/css": "npm:3.7.0" + "@docsearch/css": "npm:3.8.0" "@rollup/plugin-replace": "npm:6.0.1" "@testing-library/jest-dom": "npm:6.6.3" "@testing-library/react": "npm:16.0.1" @@ -2363,7 +2363,7 @@ __metadata: resolution: "@docsearch/website@workspace:packages/website" dependencies: "@algolia/ui-library": "npm:5.86.0" - "@docsearch/react": "npm:3.7.0" + "@docsearch/react": "npm:3.8.0" "@docusaurus/core": "npm:3.6.1" "@docusaurus/preset-classic": "npm:3.6.1" "@mdx-js/react": "npm:^3.1.0"