From 1a68b3efe4c19da8ad286c400b33e7eee8ed4a5d Mon Sep 17 00:00:00 2001 From: meteorlxy Date: Thu, 14 Jul 2022 10:32:12 +0800 Subject: [PATCH] refactor: upgrade docsearch to fix broken typing --- package.json | 4 +- pnpm-lock.yaml | 53 ++++++++++++------- src/client/shim.d.ts | 6 --- .../components/VPAlgoliaSearchBox.vue | 4 +- 4 files changed, 39 insertions(+), 28 deletions(-) diff --git a/package.json b/package.json index 3c499689..4c682920 100644 --- a/package.json +++ b/package.json @@ -71,8 +71,8 @@ "ci-docs": "run-s docs-build" }, "dependencies": { - "@docsearch/css": "^3.0.0", - "@docsearch/js": "^3.0.0", + "@docsearch/css": "^3.1.1", + "@docsearch/js": "^3.1.1", "@vitejs/plugin-vue": "^2.3.2", "@vue/devtools-api": "^6.1.4", "@vueuse/core": "^8.5.0", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 0a2e3702..a5cd497e 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -4,8 +4,8 @@ importers: .: specifiers: - '@docsearch/css': ^3.0.0 - '@docsearch/js': ^3.0.0 + '@docsearch/css': ^3.1.1 + '@docsearch/js': ^3.1.1 '@rollup/plugin-alias': ^3.1.5 '@rollup/plugin-commonjs': ^20.0.0 '@rollup/plugin-json': ^4.1.0 @@ -72,8 +72,8 @@ importers: vitest: ^0.14.2 vue: ^3.2.33 dependencies: - '@docsearch/css': 3.1.0 - '@docsearch/js': 3.1.0 + '@docsearch/css': 3.1.1 + '@docsearch/js': 3.1.1 '@vitejs/plugin-vue': 2.3.3_vite@2.9.9+vue@3.2.33 '@vue/devtools-api': 6.1.4 '@vueuse/core': 8.5.0_vue@3.2.33 @@ -152,14 +152,27 @@ importers: packages: - /@algolia/autocomplete-core/1.6.3: - resolution: {integrity: sha512-dqQqRt01fX3YuVFrkceHsoCnzX0bLhrrg8itJI1NM68KjrPYQPYsE+kY8EZTCM4y8VDnhqJErR73xe/ZsV+qAA==} + /@algolia/autocomplete-core/1.7.1: + resolution: {integrity: sha512-eiZw+fxMzNQn01S8dA/hcCpoWCOCwcIIEUtHHdzN5TGB3IpzLbuhqFeTfh2OUhhgkE8Uo17+wH+QJ/wYyQmmzg==} dependencies: - '@algolia/autocomplete-shared': 1.6.3 + '@algolia/autocomplete-shared': 1.7.1 dev: false - /@algolia/autocomplete-shared/1.6.3: - resolution: {integrity: sha512-UV46bnkTztyADFaETfzFC5ryIdGVb2zpAoYgu0tfcuYWjhg1KbLXveFffZIrGVoboqmAk1b+jMrl6iCja1i3lg==} + /@algolia/autocomplete-preset-algolia/1.7.1_algoliasearch@4.11.0: + resolution: {integrity: sha512-pJwmIxeJCymU1M6cGujnaIYcY3QPOVYZOXhFkWVM7IxKzy272BwCvMFMyc5NpG/QmiObBxjo7myd060OeTNJXg==} + peerDependencies: + '@algolia/client-search': ^4.9.1 + algoliasearch: ^4.9.1 + peerDependenciesMeta: + '@algolia/client-search': + optional: true + dependencies: + '@algolia/autocomplete-shared': 1.7.1 + algoliasearch: 4.11.0 + dev: false + + /@algolia/autocomplete-shared/1.7.1: + resolution: {integrity: sha512-eTmGVqY3GeyBTT8IWiB2K5EuURAqhnumfktAEoHxfDY2o7vg2rSnO16ZtIG0fMgt3py28Vwgq42/bVEuaQV7pg==} dev: false /@algolia/cache-browser-local-storage/4.11.0: @@ -294,23 +307,24 @@ packages: to-fast-properties: 2.0.0 dev: false - /@docsearch/css/3.1.0: - resolution: {integrity: sha512-bh5IskwkkodbvC0FzSg1AxMykfDl95hebEKwxNoq4e5QaGzOXSBgW8+jnMFZ7JU4sTBiB04vZWoUSzNrPboLZA==} + /@docsearch/css/3.1.1: + resolution: {integrity: sha512-utLgg7E1agqQeqCJn05DWC7XXMk4tMUUnL7MZupcknRu2OzGN13qwey2qA/0NAKkVBGugiWtON0+rlU0QIPojg==} dev: false - /@docsearch/js/3.1.0: - resolution: {integrity: sha512-5XSK+xbP0hcTIp54MECqxkWLs6kf7Ug4nWdxWNtx8cUpLiFNFnKXDxCb35wnyNpjukmrx7Q9DkO5tFFsmNVxng==} + /@docsearch/js/3.1.1: + resolution: {integrity: sha512-bt7l2aKRoSnLUuX+s4LVQ1a7AF2c9myiZNv5uvQCePG5tpvVGpwrnMwqVXOUJn9q6FwVVhOrQMO/t+QmnnAEUw==} dependencies: - '@docsearch/react': 3.1.0 + '@docsearch/react': 3.1.1 preact: 10.5.15 transitivePeerDependencies: + - '@algolia/client-search' - '@types/react' - react - react-dom dev: false - /@docsearch/react/3.1.0: - resolution: {integrity: sha512-bjB6ExnZzf++5B7Tfoi6UXgNwoUnNOfZ1NyvnvPhWgCMy5V/biAtLL4o7owmZSYdAKeFSvZ5Lxm0is4su/dBWg==} + /@docsearch/react/3.1.1: + resolution: {integrity: sha512-cfoql4qvtsVRqBMYxhlGNpvyy/KlCoPqjIsJSZYqYf9AplZncKjLBTcwBu6RXFMVCe30cIFljniI4OjqAU67pQ==} peerDependencies: '@types/react': '>= 16.8.0 < 19.0.0' react: '>= 16.8.0 < 19.0.0' @@ -323,9 +337,12 @@ packages: react-dom: optional: true dependencies: - '@algolia/autocomplete-core': 1.6.3 - '@docsearch/css': 3.1.0 + '@algolia/autocomplete-core': 1.7.1 + '@algolia/autocomplete-preset-algolia': 1.7.1_algoliasearch@4.11.0 + '@docsearch/css': 3.1.1 algoliasearch: 4.11.0 + transitivePeerDependencies: + - '@algolia/client-search' dev: false /@hutson/parse-repository-url/3.0.2: diff --git a/src/client/shim.d.ts b/src/client/shim.d.ts index f627e102..2c394ffa 100644 --- a/src/client/shim.d.ts +++ b/src/client/shim.d.ts @@ -14,9 +14,3 @@ declare module '@siteData' { const data: SiteData export default data } - -// this module's typing is broken. -declare module '@docsearch/js' { - function docsearch(props: T): void - export default docsearch -} diff --git a/src/client/theme-default/components/VPAlgoliaSearchBox.vue b/src/client/theme-default/components/VPAlgoliaSearchBox.vue index 7e3ca208..0380cf0f 100644 --- a/src/client/theme-default/components/VPAlgoliaSearchBox.vue +++ b/src/client/theme-default/components/VPAlgoliaSearchBox.vue @@ -97,9 +97,9 @@ function initialize(userOptions: DefaultTheme.AlgoliaSearchOptions) { children } - } + } as unknown } - }) + }) as Parameters[0] docsearch(options) }