@docusaurus/theme-search-algolia 2.0.0-beta.1 → 2.0.0-beta.10

package/src/theme-search-algolia.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+declare module '@docusaurus/theme-search-algolia' {
+  export type Options = never;
+}
+
+declare module '@theme/hooks/useSearchQuery' {
+  export interface SearchQuery {
+    searchQuery: string;
+    setSearchQuery: (newSearchQuery: string) => void;
+    generateSearchPageLink: (targetSearchQuery: string) => string;
+  }
+
+  export default function useSearchQuery(): SearchQuery;
+}
+
+declare module '@theme/hooks/useAlgoliaContextualFacetFilters' {
+  export type useAlgoliaContextualFacetFiltersReturns = [string, string[]];
+
+  export default function useAlgoliaContextualFacetFilters(): useAlgoliaContextualFacetFiltersReturns;
+}
+
+declare module '@theme/SearchPage' {
+  const SearchPage: () => JSX.Element;
+  export default SearchPage;
+}
+
+declare module '@theme/SearchMetadata' {
+  export type SearchMetadataProps = {
+    readonly locale?: string;
+    readonly version?: string;
+    readonly tag?: string;
+  };
+
+  const SearchMetadata: (props: SearchMetadataProps) => JSX.Element;
+  export default SearchMetadata;
+}
+
+declare module '@theme/SearchBar' {
+  const SearchBar: () => JSX.Element;
+  export default SearchBar;
+}

package/src/types.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/// <reference types="@docusaurus/module-type-aliases" />
+/// <reference types="@docusaurus/theme-common" />
+/// <reference types="@docusaurus/theme-classic" />

package/src/{validateThemeConfig.js → validateThemeConfig.ts}

@@ -5,7 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const {Joi} = require('@docusaurus/utils-validation');
+import {Joi} from '@docusaurus/utils-validation';
+import type {ThemeConfig, Validate, ValidationResult} from '@docusaurus/types';
 
 const DEFAULT_CONFIG = {
   contextualSearch: false, // future: maybe we want to enable this by default
@@ -18,11 +19,11 @@ const DEFAULT_CONFIG = {
 };
 exports.DEFAULT_CONFIG = DEFAULT_CONFIG;
 
-const Schema = Joi.object({
+export const Schema = Joi.object({
   algolia: Joi.object({
     // Docusaurus attributes
     contextualSearch: Joi.boolean().default(DEFAULT_CONFIG.contextualSearch),
-
+    externalUrlRegex: Joi.string().optional(),
     // Algolia attributes
     appId: Joi.string().default(DEFAULT_CONFIG.appId),
     apiKey: Joi.string().required(),
@@ -35,11 +36,13 @@ const Schema = Joi.object({
     .required()
     .unknown(), // DocSearch 3 is still alpha: don't validate the rest for now
 });
-exports.Schema = Schema;
 
-exports.validateThemeConfig = function validateThemeConfig({
+export function validateThemeConfig({
   validate,
   themeConfig,
-}) {
+}: {
+  validate: Validate<ThemeConfig>;
+  themeConfig: ThemeConfig;
+}): ValidationResult<ThemeConfig> {
   return validate(Schema, themeConfig);
-};
+}

package/tsconfig.browser.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "esnext",
+    "jsx": "react-native"
+  },
+  "include": ["src/theme/", "src/*.d.ts"]
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "lib": ["DOM", "ES2019"],
+    "rootDir": "src",
+    "baseUrl": "src",
+    "outDir": "lib"
+  }
+}

package/tsconfig.server.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src/*.ts", "src/templates/*.ts"]
+}

package/src/theme/hooks/useSearchQuery.js

@@ -1,44 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import {useHistory, useLocation} from '@docusaurus/router';
-import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-
-const SEARCH_PARAM_QUERY = 'q';
-
-function useSearchQuery() {
-  const history = useHistory();
-  const location = useLocation();
-  const {siteConfig: {baseUrl} = {}} = useDocusaurusContext();
-
-  return {
-    searchValue:
-      (ExecutionEnvironment.canUseDOM &&
-        new URLSearchParams(location.search).get(SEARCH_PARAM_QUERY)) ||
-      '',
-    updateSearchPath: (searchValue) => {
-      const searchParams = new URLSearchParams(location.search);
-
-      if (searchValue) {
-        searchParams.set(SEARCH_PARAM_QUERY, searchValue);
-      } else {
-        searchParams.delete(SEARCH_PARAM_QUERY);
-      }
-
-      history.replace({
-        search: searchParams.toString(),
-      });
-    },
-    generateSearchPageLink: (searchValue) => {
-      // Refer to https://github.com/facebook/docusaurus/pull/2838
-      return `${baseUrl}search?q=${encodeURIComponent(searchValue)}`;
-    },
-  };
-}
-
-export default useSearchQuery;