@docusaurus/theme-search-algolia 0.0.0-4594 → 0.0.0-4602

package/lib/index.js

@@ -29,9 +29,12 @@ const OPEN_SEARCH_FILENAME = 'opensearch.xml';
 function themeSearchAlgolia(context) {
   const {
     baseUrl,
-    siteConfig: {title, url, favicon},
+    siteConfig: {title, url, favicon, themeConfig},
     i18n: {currentLocale},
   } = context;
+  const {
+    algolia: {searchPagePath},
+  } = themeConfig;
   return {
     name: 'docusaurus-theme-search-algolia',
     getThemePath() {
@@ -47,30 +50,39 @@ function themeSearchAlgolia(context) {
       });
     },
     async contentLoaded({actions: {addRoute}}) {
-      addRoute({
-        path: (0, utils_1.normalizeUrl)([baseUrl, 'search']),
-        component: '@theme/SearchPage',
-        exact: true,
-      });
+      if (searchPagePath) {
+        addRoute({
+          path: (0, utils_1.normalizeUrl)([baseUrl, searchPagePath]),
+          component: '@theme/SearchPage',
+          exact: true,
+        });
+      }
     },
     async postBuild({outDir}) {
-      try {
-        fs_1.default.writeFileSync(
-          path_1.default.join(outDir, OPEN_SEARCH_FILENAME),
-          renderOpenSearchTemplate({
-            title,
-            url: url + baseUrl,
-            favicon: favicon
-              ? (0, utils_1.normalizeUrl)([url, baseUrl, favicon])
-              : null,
-          }),
-        );
-      } catch (e) {
-        logger_1.default.error('Generating OpenSearch file failed.');
-        throw e;
+      if (searchPagePath) {
+        const siteUrl = (0, utils_1.normalizeUrl)([url, baseUrl]);
+        try {
+          fs_1.default.writeFileSync(
+            path_1.default.join(outDir, OPEN_SEARCH_FILENAME),
+            renderOpenSearchTemplate({
+              title,
+              siteUrl,
+              searchUrl: (0, utils_1.normalizeUrl)([siteUrl, searchPagePath]),
+              faviconUrl: favicon
+                ? (0, utils_1.normalizeUrl)([siteUrl, favicon])
+                : null,
+            }),
+          );
+        } catch (e) {
+          logger_1.default.error('Generating OpenSearch file failed.');
+          throw e;
+        }
       }
     },
     injectHtmlTags() {
+      if (!searchPagePath) {
+        return {};
+      }
       return {
         headTags: [
           {

package/lib/templates/opensearch.d.ts

@@ -4,5 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-declare const _default: "\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OpenSearchDescription xmlns=\"http://a9.com/-/spec/opensearch/1.1/\"\n                       xmlns:moz=\"http://www.mozilla.org/2006/browser/search/\">\n  <ShortName><%= it.title %></ShortName>\n  <Description>Search <%= it.title %></Description>\n  <InputEncoding>UTF-8</InputEncoding>\n  <% if (it.favicon) { _%>\n    <Image width=\"16\" height=\"16\" type=\"image/x-icon\"><%= it.favicon %></Image>\n  <% } _%>\n  <Url type=\"text/html\" method=\"get\" template=\"<%= it.url %>search?q={searchTerms}\"/>\n  <Url type=\"application/opensearchdescription+xml\" rel=\"self\" template=\"<%= it.url %>opensearch.xml\" />\n  <moz:SearchForm><%= it.url %></moz:SearchForm>\n</OpenSearchDescription>\n";
+declare const _default: "\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OpenSearchDescription xmlns=\"http://a9.com/-/spec/opensearch/1.1/\"\n                       xmlns:moz=\"http://www.mozilla.org/2006/browser/search/\">\n  <ShortName><%= it.title %></ShortName>\n  <Description>Search <%= it.title %></Description>\n  <InputEncoding>UTF-8</InputEncoding>\n  <% if (it.faviconUrl) { _%>\n    <Image width=\"16\" height=\"16\" type=\"image/x-icon\"><%= it.faviconUrl %></Image>\n  <% } _%>\n  <Url type=\"text/html\" method=\"get\" template=\"<%= it.searchUrl %>?q={searchTerms}\"/>\n  <Url type=\"application/opensearchdescription+xml\" rel=\"self\" template=\"<%= it.siteUrl %>opensearch.xml\" />\n  <moz:SearchForm><%= it.siteUrl %></moz:SearchForm>\n</OpenSearchDescription>\n";
 export default _default;

package/lib/templates/opensearch.js

@@ -13,11 +13,11 @@ exports.default = `
   <ShortName><%= it.title %></ShortName>
   <Description>Search <%= it.title %></Description>
   <InputEncoding>UTF-8</InputEncoding>
-  <% if (it.favicon) { _%>
-    <Image width="16" height="16" type="image/x-icon"><%= it.favicon %></Image>
+  <% if (it.faviconUrl) { _%>
+    <Image width="16" height="16" type="image/x-icon"><%= it.faviconUrl %></Image>
   <% } _%>
-  <Url type="text/html" method="get" template="<%= it.url %>search?q={searchTerms}"/>
-  <Url type="application/opensearchdescription+xml" rel="self" template="<%= it.url %>opensearch.xml" />
-  <moz:SearchForm><%= it.url %></moz:SearchForm>
+  <Url type="text/html" method="get" template="<%= it.searchUrl %>?q={searchTerms}"/>
+  <Url type="application/opensearchdescription+xml" rel="self" template="<%= it.siteUrl %>opensearch.xml" />
+  <moz:SearchForm><%= it.siteUrl %></moz:SearchForm>
 </OpenSearchDescription>
 `;

package/lib/theme/SearchBar/index.js

@@ -194,8 +194,10 @@ function DocSearch({contextualSearch, externalUrlRegex, ...props}) {
             navigator={navigator}
             transformItems={transformItems}
             hitComponent={Hit}
-            resultsFooterComponent={resultsFooterComponent}
             transformSearchClient={transformSearchClient}
+            {...(props.searchPagePath && {
+              resultsFooterComponent,
+            })}
             {...props}
             searchParameters={searchParameters}
           />,

package/lib/validateThemeConfig.d.ts

@@ -10,6 +10,7 @@ export declare const DEFAULT_CONFIG: {
     contextualSearch: boolean;
     appId: string;
     searchParameters: {};
+    searchPagePath: string;
 };
 export declare const Schema: Joi.ObjectSchema<any>;
 export declare function validateThemeConfig({ validate, themeConfig, }: {

package/lib/validateThemeConfig.js

@@ -16,6 +16,7 @@ exports.DEFAULT_CONFIG = {
   // This has been designed on purpose with Algolia.
   appId: 'BH4D9OD16A',
   searchParameters: {},
+  searchPagePath: 'search',
 };
 exports.Schema = utils_validation_1.Joi.object({
   algolia: utils_validation_1.Joi.object({
@@ -33,6 +34,13 @@ exports.Schema = utils_validation_1.Joi.object({
     searchParameters: utils_validation_1.Joi.object()
       .default(exports.DEFAULT_CONFIG.searchParameters)
       .unknown(),
+    searchPagePath: utils_validation_1.Joi.alternatives()
+      .try(
+        utils_validation_1.Joi.boolean().invalid(true),
+        utils_validation_1.Joi.string(),
+      )
+      .allow(null)
+      .default(exports.DEFAULT_CONFIG.searchPagePath),
   })
     .label('themeConfig.algolia')
     .required()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-search-algolia",
-  "version": "0.0.0-4594",
+  "version": "0.0.0-4602",
   "description": "Algolia search component for Docusaurus.",
   "main": "lib/index.js",
   "exports": {
@@ -26,12 +26,12 @@
   },
   "dependencies": {
     "@docsearch/react": "^3.0.0-alpha.50",
-    "@docusaurus/core": "0.0.0-4594",
-    "@docusaurus/logger": "0.0.0-4594",
-    "@docusaurus/theme-common": "0.0.0-4594",
-    "@docusaurus/theme-translations": "0.0.0-4594",
-    "@docusaurus/utils": "0.0.0-4594",
-    "@docusaurus/utils-validation": "0.0.0-4594",
+    "@docusaurus/core": "0.0.0-4602",
+    "@docusaurus/logger": "0.0.0-4602",
+    "@docusaurus/theme-common": "0.0.0-4602",
+    "@docusaurus/theme-translations": "0.0.0-4602",
+    "@docusaurus/utils": "0.0.0-4602",
+    "@docusaurus/utils-validation": "0.0.0-4602",
     "algoliasearch": "^4.12.1",
     "algoliasearch-helper": "^3.7.0",
     "clsx": "^1.1.1",
@@ -41,7 +41,7 @@
     "utility-types": "^3.10.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4594",
+    "@docusaurus/module-type-aliases": "0.0.0-4602",
     "fs-extra": "^10.0.0"
   },
   "peerDependencies": {
@@ -51,5 +51,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "877ac1ede73b4b1da7e536afb8fc3718f50f7c5a"
+  "gitHead": "5f89abf1d9b54116c27d696334ceb3e898531268"
 }

package/src/index.ts

@@ -15,6 +15,7 @@ import openSearchTemplate from './templates/opensearch';
 import {memoize} from 'lodash';
 
 import type {LoadContext, Plugin} from '@docusaurus/types';
+import type {ThemeConfig} from '@docusaurus/theme-search-algolia';
 
 const getCompiledOpenSearchTemplate = memoize(() =>
   compile(openSearchTemplate.trim()),
@@ -22,8 +23,9 @@ const getCompiledOpenSearchTemplate = memoize(() =>
 
 function renderOpenSearchTemplate(data: {
   title: string;
-  url: string;
-  favicon: string | null;
+  siteUrl: string;
+  searchUrl: string;
+  faviconUrl: string | null;
 }) {
   const compiled = getCompiledOpenSearchTemplate();
   return compiled(data, defaultConfig);
@@ -34,9 +36,12 @@ const OPEN_SEARCH_FILENAME = 'opensearch.xml';
 export default function themeSearchAlgolia(context: LoadContext): Plugin<void> {
   const {
     baseUrl,
-    siteConfig: {title, url, favicon},
+    siteConfig: {title, url, favicon, themeConfig},
     i18n: {currentLocale},
   } = context;
+  const {
+    algolia: {searchPagePath},
+  } = themeConfig as ThemeConfig;
 
   return {
     name: 'docusaurus-theme-search-algolia',
@@ -57,30 +62,41 @@ export default function themeSearchAlgolia(context: LoadContext): Plugin<void> {
     },
 
     async contentLoaded({actions: {addRoute}}) {
-      addRoute({
-        path: normalizeUrl([baseUrl, 'search']),
-        component: '@theme/SearchPage',
-        exact: true,
-      });
+      if (searchPagePath) {
+        addRoute({
+          path: normalizeUrl([baseUrl, searchPagePath]),
+          component: '@theme/SearchPage',
+          exact: true,
+        });
+      }
     },
 
     async postBuild({outDir}) {
-      try {
-        fs.writeFileSync(
-          path.join(outDir, OPEN_SEARCH_FILENAME),
-          renderOpenSearchTemplate({
-            title,
-            url: url + baseUrl,
-            favicon: favicon ? normalizeUrl([url, baseUrl, favicon]) : null,
-          }),
-        );
-      } catch (e) {
-        logger.error('Generating OpenSearch file failed.');
-        throw e;
+      if (searchPagePath) {
+        const siteUrl = normalizeUrl([url, baseUrl]);
+
+        try {
+          fs.writeFileSync(
+            path.join(outDir, OPEN_SEARCH_FILENAME),
+            renderOpenSearchTemplate({
+              title,
+              siteUrl,
+              searchUrl: normalizeUrl([siteUrl, searchPagePath]),
+              faviconUrl: favicon ? normalizeUrl([siteUrl, favicon]) : null,
+            }),
+          );
+        } catch (e) {
+          logger.error('Generating OpenSearch file failed.');
+          throw e;
+        }
       }
     },
 
     injectHtmlTags() {
+      if (!searchPagePath) {
+        return {};
+      }
+
       return {
         headTags: [
           {

package/src/templates/opensearch.ts

@@ -12,11 +12,11 @@ export default `
   <ShortName><%= it.title %></ShortName>
   <Description>Search <%= it.title %></Description>
   <InputEncoding>UTF-8</InputEncoding>
-  <% if (it.favicon) { _%>
-    <Image width="16" height="16" type="image/x-icon"><%= it.favicon %></Image>
+  <% if (it.faviconUrl) { _%>
+    <Image width="16" height="16" type="image/x-icon"><%= it.faviconUrl %></Image>
   <% } _%>
-  <Url type="text/html" method="get" template="<%= it.url %>search?q={searchTerms}"/>
-  <Url type="application/opensearchdescription+xml" rel="self" template="<%= it.url %>opensearch.xml" />
-  <moz:SearchForm><%= it.url %></moz:SearchForm>
+  <Url type="text/html" method="get" template="<%= it.searchUrl %>?q={searchTerms}"/>
+  <Url type="application/opensearchdescription+xml" rel="self" template="<%= it.siteUrl %>opensearch.xml" />
+  <moz:SearchForm><%= it.siteUrl %></moz:SearchForm>
 </OpenSearchDescription>
 `;

package/src/theme/SearchBar/index.tsx

@@ -34,6 +34,7 @@ type DocSearchProps = Omit<
 > & {
   contextualSearch?: string;
   externalUrlRegex?: string;
+  searchPagePath: boolean | string;
 };
 
 let DocSearchModal: typeof DocSearchModalType | null = null;
@@ -256,8 +257,10 @@ function DocSearch({
             navigator={navigator}
             transformItems={transformItems}
             hitComponent={Hit}
-            resultsFooterComponent={resultsFooterComponent}
             transformSearchClient={transformSearchClient}
+            {...(props.searchPagePath && {
+              resultsFooterComponent,
+            })}
             {...props}
             searchParameters={searchParameters}
           />,

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

@@ -16,6 +16,7 @@ declare module '@docusaurus/theme-search-algolia' {
       apiKey: string;
       indexName: string;
       searchParameters: Record<string, unknown>;
+      searchPagePath: string | false | null;
     };
   };
   export type UserThemeConfig = DeepPartial<ThemeConfig>;

package/src/validateThemeConfig.ts

@@ -18,6 +18,7 @@ export const DEFAULT_CONFIG = {
   appId: 'BH4D9OD16A',
 
   searchParameters: {},
+  searchPagePath: 'search',
 };
 
 export const Schema = Joi.object({
@@ -32,6 +33,10 @@ export const Schema = Joi.object({
     searchParameters: Joi.object()
       .default(DEFAULT_CONFIG.searchParameters)
       .unknown(),
+    searchPagePath: Joi.alternatives()
+      .try(Joi.boolean().invalid(true), Joi.string())
+      .allow(null)
+      .default(DEFAULT_CONFIG.searchPagePath),
   })
     .label('themeConfig.algolia')
     .required()

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

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

package/lib/theme/SearchMetadata/index.js

@@ -1,22 +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 React from 'react';
-import Head from '@docusaurus/Head';
-// Override default/agnostic SearchMetadata to use Algolia-specific metadata
-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;
-  return (
-    <Head>
-      {language && <meta name="docsearch:language" content={language} />}
-      {version && <meta name="docsearch:version" content={version} />}
-      {tag && <meta name="docsearch:docusaurus_tag" content={tag} />}
-    </Head>
-  );
-}
-export default SearchMetadata;

package/src/theme/SearchMetadata/index.tsx

@@ -1,28 +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 React from 'react';
-
-import Head from '@docusaurus/Head';
-import type {Props} from '@theme/SearchMetadata';
-
-// Override default/agnostic SearchMetadata to use Algolia-specific metadata
-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;
-
-  return (
-    <Head>
-      {language && <meta name="docsearch:language" content={language} />}
-      {version && <meta name="docsearch:version" content={version} />}
-      {tag && <meta name="docsearch:docusaurus_tag" content={tag} />}
-    </Head>
-  );
-}
-
-export default SearchMetadata;