@docusaurus/theme-search-algolia 0.0.0-4379 → 0.0.0-4391

package/lib/index.d.ts

@@ -4,8 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { DocusaurusContext, Plugin } from '@docusaurus/types';
-export default function theme(context: DocusaurusContext & {
-    baseUrl: string;
-}): Plugin<void>;
+import type { LoadContext, Plugin } from '@docusaurus/types';
+export default function themeSearchAlgolia(context: LoadContext): Plugin<void>;
 export { validateThemeConfig } from './validateThemeConfig';

package/lib/index.js

@@ -22,16 +22,10 @@ function renderOpenSearchTemplate(data) {
     return compiled(data, eta_1.defaultConfig);
 }
 const OPEN_SEARCH_FILENAME = 'opensearch.xml';
-function theme(context) {
+function themeSearchAlgolia(context) {
     const { baseUrl, siteConfig: { title, url, favicon }, i18n: { currentLocale }, } = context;
-    const pageComponent = './theme/SearchPage/index.js';
-    const pagePath = (0, utils_1.getSwizzledComponent)(pageComponent) ||
-        path_1.default.resolve(__dirname, pageComponent);
     return {
         name: 'docusaurus-theme-search-algolia',
-        getPathsToWatch() {
-            return [pagePath];
-        },
         getThemePath() {
             return path_1.default.resolve(__dirname, './theme');
         },
@@ -47,7 +41,7 @@ function theme(context) {
         async contentLoaded({ actions: { addRoute } }) {
             addRoute({
                 path: (0, utils_1.normalizeUrl)([baseUrl, 'search']),
-                component: pagePath,
+                component: '@theme/SearchPage',
                 exact: true,
             });
         },
@@ -81,6 +75,6 @@ function theme(context) {
         },
     };
 }
-exports.default = theme;
+exports.default = themeSearchAlgolia;
 var validateThemeConfig_1 = require("./validateThemeConfig");
 Object.defineProperty(exports, "validateThemeConfig", { enumerable: true, get: function () { return validateThemeConfig_1.validateThemeConfig; } });

package/lib/theme/SearchMetadata/index.d.ts

@@ -4,7 +4,8 @@
  * 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/theme-classic" />
 /// <reference types="react" />
-import type { SearchMetadataProps } from '@theme/SearchMetadata';
-declare function SearchMetadata({ locale, version, tag, }: SearchMetadataProps): JSX.Element;
+import type { Props } from '@theme/SearchMetadata';
+declare function SearchMetadata({ locale, version, tag }: Props): JSX.Element;
 export default SearchMetadata;

package/lib/theme/SearchMetadata/index.js

@@ -7,7 +7,7 @@
 import React from 'react';
 import Head from '@docusaurus/Head';
 // Override default/agnostic SearchMetas to use Algolia-specific metadata
-function SearchMetadata({ locale, version, tag, }) {
+function SearchMetadata({ locale, version, tag }) {
     // Seems safe to consider here the locale is the language,
     // as the existing docsearch:language filter is afaik a regular string-based filter
     const language = locale;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-search-algolia",
-  "version": "0.0.0-4379",
+  "version": "0.0.0-4391",
   "description": "Algolia search component for Docusaurus.",
   "main": "lib/index.js",
   "exports": {
@@ -25,21 +25,22 @@
   },
   "dependencies": {
     "@docsearch/react": "^3.0.0-alpha.39",
-    "@docusaurus/core": "0.0.0-4379",
-    "@docusaurus/logger": "0.0.0-4379",
-    "@docusaurus/theme-common": "0.0.0-4379",
-    "@docusaurus/theme-translations": "0.0.0-4379",
-    "@docusaurus/utils": "0.0.0-4379",
-    "@docusaurus/utils-validation": "0.0.0-4379",
+    "@docusaurus/core": "0.0.0-4391",
+    "@docusaurus/logger": "0.0.0-4391",
+    "@docusaurus/theme-common": "0.0.0-4391",
+    "@docusaurus/theme-translations": "0.0.0-4391",
+    "@docusaurus/utils": "0.0.0-4391",
+    "@docusaurus/utils-validation": "0.0.0-4391",
     "algoliasearch": "^4.10.5",
     "algoliasearch-helper": "^3.5.5",
     "clsx": "^1.1.1",
     "eta": "^1.12.3",
     "lodash": "^4.17.20",
-    "tslib": "^2.3.1"
+    "tslib": "^2.3.1",
+    "utility-types": "^3.10.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4379",
+    "@docusaurus/module-type-aliases": "0.0.0-4391",
     "fs-extra": "^10.0.0"
   },
   "peerDependencies": {
@@ -49,5 +50,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "92aba1ab0bda5fe2b1f6cc8cdd50677051187dcb"
+  "gitHead": "16a313077f39acf0b712f20b277d92a94d7393ac"
 }

package/src/index.ts

@@ -8,13 +8,13 @@
 import path from 'path';
 import fs from 'fs';
 import {defaultConfig, compile} from 'eta';
-import {normalizeUrl, getSwizzledComponent} from '@docusaurus/utils';
+import {normalizeUrl} from '@docusaurus/utils';
 import {readDefaultCodeTranslationMessages} from '@docusaurus/theme-translations';
 import logger from '@docusaurus/logger';
 import openSearchTemplate from './templates/opensearch';
 import {memoize} from 'lodash';
 
-import type {DocusaurusContext, Plugin} from '@docusaurus/types';
+import type {LoadContext, Plugin} from '@docusaurus/types';
 
 const getCompiledOpenSearchTemplate = memoize(() =>
   compile(openSearchTemplate.trim()),
@@ -31,26 +31,16 @@ function renderOpenSearchTemplate(data: {
 
 const OPEN_SEARCH_FILENAME = 'opensearch.xml';
 
-export default function theme(
-  context: DocusaurusContext & {baseUrl: string},
-): Plugin<void> {
+export default function themeSearchAlgolia(context: LoadContext): Plugin<void> {
   const {
     baseUrl,
     siteConfig: {title, url, favicon},
     i18n: {currentLocale},
   } = context;
-  const pageComponent = './theme/SearchPage/index.js';
-  const pagePath =
-    getSwizzledComponent(pageComponent) ||
-    path.resolve(__dirname, pageComponent);
 
   return {
     name: 'docusaurus-theme-search-algolia',
 
-    getPathsToWatch() {
-      return [pagePath];
-    },
-
     getThemePath() {
       return path.resolve(__dirname, './theme');
     },
@@ -69,7 +59,7 @@ export default function theme(
     async contentLoaded({actions: {addRoute}}) {
       addRoute({
         path: normalizeUrl([baseUrl, 'search']),
-        component: pagePath,
+        component: '@theme/SearchPage',
         exact: true,
       });
     },

package/src/theme/SearchMetadata/index.tsx

@@ -8,14 +8,10 @@
 import React from 'react';
 
 import Head from '@docusaurus/Head';
-import type {SearchMetadataProps} from '@theme/SearchMetadata';
+import type {Props} from '@theme/SearchMetadata';
 
 // Override default/agnostic SearchMetas to use Algolia-specific metadata
-function SearchMetadata({
-  locale,
-  version,
-  tag,
-}: SearchMetadataProps): JSX.Element {
+function SearchMetadata({locale, version, tag}: Props): JSX.Element {
   // Seems safe to consider here the locale is the language,
   // as the existing docsearch:language filter is afaik a regular string-based filter
   const language = locale;

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

@@ -5,6 +5,22 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+declare module '@docusaurus/theme-search-algolia' {
+  import type {DeepPartial} from 'utility-types';
+
+  export type ThemeConfig = {
+    algolia: {
+      contextualSearch: boolean;
+      externalUrlRegex?: string;
+      appId: string;
+      apiKey: string;
+      indexName: string;
+      searchParameters: Record<string, unknown>;
+    };
+  };
+  export type UserThemeConfig = DeepPartial<ThemeConfig>;
+}
+
 declare module '@docusaurus/theme-search-algolia/client' {
   export function useAlgoliaContextualFacetFilters(): [string, string[]];
 }
@@ -14,17 +30,6 @@ declare module '@theme/SearchPage' {
   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;