@docusaurus/theme-search-algolia 0.0.0-5945 → 0.0.0-5953

package/lib/index.js

@@ -7,23 +7,11 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateThemeConfig = void 0;
-const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const lodash_1 = tslib_1.__importDefault(require("lodash"));
-const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
-const eta_1 = require("eta");
 const utils_1 = require("@docusaurus/utils");
 const theme_translations_1 = require("@docusaurus/theme-translations");
-const opensearch_1 = tslib_1.__importDefault(require("./templates/opensearch"));
-const getCompiledOpenSearchTemplate = lodash_1.default.memoize(() => (0, eta_1.compile)(opensearch_1.default.trim()));
-function renderOpenSearchTemplate(data) {
-    const compiled = getCompiledOpenSearchTemplate();
-    return compiled(data, eta_1.defaultConfig);
-}
-const OPEN_SEARCH_FILENAME = 'opensearch.xml';
+const opensearch_1 = require("./opensearch");
 function themeSearchAlgolia(context) {
-    const { baseUrl, siteConfig: { title, url, favicon, themeConfig }, i18n: { currentLocale }, } = context;
+    const { baseUrl, siteConfig: { themeConfig }, i18n: { currentLocale }, } = context;
     const { algolia: { searchPagePath }, } = themeConfig;
     return {
         name: 'docusaurus-theme-search-algolia',
@@ -48,40 +36,16 @@ function themeSearchAlgolia(context) {
                 });
             }
         },
-        async postBuild({ outDir }) {
-            if (searchPagePath) {
-                const siteUrl = (0, utils_1.normalizeUrl)([url, baseUrl]);
-                try {
-                    await fs_extra_1.default.writeFile(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 (err) {
-                    logger_1.default.error('Generating OpenSearch file failed.');
-                    throw err;
-                }
+        async postBuild() {
+            if ((0, opensearch_1.shouldCreateOpenSearchFile)({ context })) {
+                await (0, opensearch_1.createOpenSearchFile)({ context });
             }
         },
         injectHtmlTags() {
-            if (!searchPagePath) {
-                return {};
+            if ((0, opensearch_1.shouldCreateOpenSearchFile)({ context })) {
+                return { headTags: (0, opensearch_1.createOpenSearchHeadTags)({ context }) };
             }
-            return {
-                headTags: [
-                    {
-                        tagName: 'link',
-                        attributes: {
-                            rel: 'search',
-                            type: 'application/opensearchdescription+xml',
-                            title,
-                            href: (0, utils_1.normalizeUrl)([baseUrl, OPEN_SEARCH_FILENAME]),
-                        },
-                    },
-                ],
-            };
+            return {};
         },
     };
 }

package/lib/opensearch.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 type { HtmlTags, LoadContext } from '@docusaurus/types';
+export declare function shouldCreateOpenSearchFile({ context, }: {
+    context: LoadContext;
+}): boolean;
+export declare function createOpenSearchFile({ context, }: {
+    context: LoadContext;
+}): Promise<void>;
+export declare function createOpenSearchHeadTags({ context, }: {
+    context: LoadContext;
+}): HtmlTags;

package/lib/opensearch.js

@@ -0,0 +1,66 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createOpenSearchHeadTags = exports.createOpenSearchFile = exports.shouldCreateOpenSearchFile = void 0;
+const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const eta_1 = require("eta");
+const utils_1 = require("@docusaurus/utils");
+const opensearch_1 = tslib_1.__importDefault(require("./templates/opensearch"));
+const getCompiledOpenSearchTemplate = lodash_1.default.memoize(() => (0, eta_1.compile)(opensearch_1.default.trim()));
+function renderOpenSearchTemplate(data) {
+    const compiled = getCompiledOpenSearchTemplate();
+    return compiled(data, eta_1.defaultConfig);
+}
+const OPEN_SEARCH_FILENAME = 'opensearch.xml';
+function shouldCreateOpenSearchFile({ context, }) {
+    const { siteConfig: { themeConfig, future: { experimental_router: router }, }, } = context;
+    const { algolia: { searchPagePath }, } = themeConfig;
+    return !!searchPagePath && router !== 'hash';
+}
+exports.shouldCreateOpenSearchFile = shouldCreateOpenSearchFile;
+function createOpenSearchFileContent({ context, searchPagePath, }) {
+    const { baseUrl, siteConfig: { title, url, favicon }, } = context;
+    const siteUrl = (0, utils_1.normalizeUrl)([url, baseUrl]);
+    return renderOpenSearchTemplate({
+        title,
+        siteUrl,
+        searchUrl: (0, utils_1.normalizeUrl)([siteUrl, searchPagePath]),
+        faviconUrl: favicon ? (0, utils_1.normalizeUrl)([siteUrl, favicon]) : null,
+    });
+}
+async function createOpenSearchFile({ context, }) {
+    const { outDir, siteConfig: { themeConfig }, } = context;
+    const { algolia: { searchPagePath }, } = themeConfig;
+    if (!searchPagePath) {
+        throw new Error('no searchPagePath provided in themeConfig.algolia');
+    }
+    const fileContent = createOpenSearchFileContent({ context, searchPagePath });
+    try {
+        await fs_extra_1.default.writeFile(path_1.default.join(outDir, OPEN_SEARCH_FILENAME), fileContent);
+    }
+    catch (err) {
+        throw new Error('Generating OpenSearch file failed.', { cause: err });
+    }
+}
+exports.createOpenSearchFile = createOpenSearchFile;
+function createOpenSearchHeadTags({ context, }) {
+    const { baseUrl, siteConfig: { title }, } = context;
+    return {
+        tagName: 'link',
+        attributes: {
+            rel: 'search',
+            type: 'application/opensearchdescription+xml',
+            title,
+            href: (0, utils_1.normalizeUrl)([baseUrl, OPEN_SEARCH_FILENAME]),
+        },
+    };
+}
+exports.createOpenSearchHeadTags = createOpenSearchHeadTags;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-search-algolia",
-  "version": "0.0.0-5945",
+  "version": "0.0.0-5953",
   "description": "Algolia search component for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": [
@@ -34,13 +34,13 @@
   },
   "dependencies": {
     "@docsearch/react": "^3.5.2",
-    "@docusaurus/core": "0.0.0-5945",
-    "@docusaurus/logger": "0.0.0-5945",
-    "@docusaurus/plugin-content-docs": "0.0.0-5945",
-    "@docusaurus/theme-common": "0.0.0-5945",
-    "@docusaurus/theme-translations": "0.0.0-5945",
-    "@docusaurus/utils": "0.0.0-5945",
-    "@docusaurus/utils-validation": "0.0.0-5945",
+    "@docusaurus/core": "0.0.0-5953",
+    "@docusaurus/logger": "0.0.0-5953",
+    "@docusaurus/plugin-content-docs": "0.0.0-5953",
+    "@docusaurus/theme-common": "0.0.0-5953",
+    "@docusaurus/theme-translations": "0.0.0-5953",
+    "@docusaurus/utils": "0.0.0-5953",
+    "@docusaurus/utils-validation": "0.0.0-5953",
     "algoliasearch": "^4.18.0",
     "algoliasearch-helper": "^3.13.3",
     "clsx": "^2.0.0",
@@ -51,7 +51,7 @@
     "utility-types": "^3.10.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-5945"
+    "@docusaurus/module-type-aliases": "0.0.0-5953"
   },
   "peerDependencies": {
     "react": "^18.0.0",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "93d26c046a449a18fd39d96f34d08518f833cdf3"
+  "gitHead": "dcfda109529e5e3bd7e1360fcc421e243d7e569b"
 }

package/src/index.ts

@@ -5,38 +5,21 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import path from 'path';
-import fs from 'fs-extra';
-import _ from 'lodash';
-import logger from '@docusaurus/logger';
-import {defaultConfig, compile} from 'eta';
 import {normalizeUrl} from '@docusaurus/utils';
 import {readDefaultCodeTranslationMessages} from '@docusaurus/theme-translations';
-import openSearchTemplate from './templates/opensearch';
+import {
+  createOpenSearchFile,
+  createOpenSearchHeadTags,
+  shouldCreateOpenSearchFile,
+} from './opensearch';
 
 import type {LoadContext, Plugin} from '@docusaurus/types';
 import type {ThemeConfig} from '@docusaurus/theme-search-algolia';
 
-const getCompiledOpenSearchTemplate = _.memoize(() =>
-  compile(openSearchTemplate.trim()),
-);
-
-function renderOpenSearchTemplate(data: {
-  title: string;
-  siteUrl: string;
-  searchUrl: string;
-  faviconUrl: string | null;
-}) {
-  const compiled = getCompiledOpenSearchTemplate();
-  return compiled(data, defaultConfig);
-}
-
-const OPEN_SEARCH_FILENAME = 'opensearch.xml';
-
 export default function themeSearchAlgolia(context: LoadContext): Plugin<void> {
   const {
     baseUrl,
-    siteConfig: {title, url, favicon, themeConfig},
+    siteConfig: {themeConfig},
     i18n: {currentLocale},
   } = context;
   const {
@@ -70,45 +53,17 @@ export default function themeSearchAlgolia(context: LoadContext): Plugin<void> {
       }
     },
 
-    async postBuild({outDir}) {
-      if (searchPagePath) {
-        const siteUrl = normalizeUrl([url, baseUrl]);
-
-        try {
-          await fs.writeFile(
-            path.join(outDir, OPEN_SEARCH_FILENAME),
-            renderOpenSearchTemplate({
-              title,
-              siteUrl,
-              searchUrl: normalizeUrl([siteUrl, searchPagePath]),
-              faviconUrl: favicon ? normalizeUrl([siteUrl, favicon]) : null,
-            }),
-          );
-        } catch (err) {
-          logger.error('Generating OpenSearch file failed.');
-          throw err;
-        }
+    async postBuild() {
+      if (shouldCreateOpenSearchFile({context})) {
+        await createOpenSearchFile({context});
       }
     },
 
     injectHtmlTags() {
-      if (!searchPagePath) {
-        return {};
+      if (shouldCreateOpenSearchFile({context})) {
+        return {headTags: createOpenSearchHeadTags({context})};
       }
-
-      return {
-        headTags: [
-          {
-            tagName: 'link',
-            attributes: {
-              rel: 'search',
-              type: 'application/opensearchdescription+xml',
-              title,
-              href: normalizeUrl([baseUrl, OPEN_SEARCH_FILENAME]),
-            },
-          },
-        ],
-      };
+      return {};
     },
   };
 }

package/src/opensearch.ts

@@ -0,0 +1,115 @@
+/**
+ * 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 path from 'path';
+import fs from 'fs-extra';
+import _ from 'lodash';
+import {defaultConfig, compile} from 'eta';
+import {normalizeUrl} from '@docusaurus/utils';
+import openSearchTemplate from './templates/opensearch';
+
+import type {HtmlTags, LoadContext} from '@docusaurus/types';
+import type {ThemeConfig} from '@docusaurus/theme-search-algolia';
+
+const getCompiledOpenSearchTemplate = _.memoize(() =>
+  compile(openSearchTemplate.trim()),
+);
+
+function renderOpenSearchTemplate(data: {
+  title: string;
+  siteUrl: string;
+  searchUrl: string;
+  faviconUrl: string | null;
+}) {
+  const compiled = getCompiledOpenSearchTemplate();
+  return compiled(data, defaultConfig);
+}
+
+const OPEN_SEARCH_FILENAME = 'opensearch.xml';
+
+export function shouldCreateOpenSearchFile({
+  context,
+}: {
+  context: LoadContext;
+}): boolean {
+  const {
+    siteConfig: {
+      themeConfig,
+      future: {experimental_router: router},
+    },
+  } = context;
+  const {
+    algolia: {searchPagePath},
+  } = themeConfig as ThemeConfig;
+
+  return !!searchPagePath && router !== 'hash';
+}
+
+function createOpenSearchFileContent({
+  context,
+  searchPagePath,
+}: {
+  context: LoadContext;
+  searchPagePath: string;
+}): string {
+  const {
+    baseUrl,
+    siteConfig: {title, url, favicon},
+  } = context;
+
+  const siteUrl = normalizeUrl([url, baseUrl]);
+
+  return renderOpenSearchTemplate({
+    title,
+    siteUrl,
+    searchUrl: normalizeUrl([siteUrl, searchPagePath]),
+    faviconUrl: favicon ? normalizeUrl([siteUrl, favicon]) : null,
+  });
+}
+
+export async function createOpenSearchFile({
+  context,
+}: {
+  context: LoadContext;
+}): Promise<void> {
+  const {
+    outDir,
+    siteConfig: {themeConfig},
+  } = context;
+  const {
+    algolia: {searchPagePath},
+  } = themeConfig as ThemeConfig;
+  if (!searchPagePath) {
+    throw new Error('no searchPagePath provided in themeConfig.algolia');
+  }
+  const fileContent = createOpenSearchFileContent({context, searchPagePath});
+  try {
+    await fs.writeFile(path.join(outDir, OPEN_SEARCH_FILENAME), fileContent);
+  } catch (err) {
+    throw new Error('Generating OpenSearch file failed.', {cause: err});
+  }
+}
+
+export function createOpenSearchHeadTags({
+  context,
+}: {
+  context: LoadContext;
+}): HtmlTags {
+  const {
+    baseUrl,
+    siteConfig: {title},
+  } = context;
+  return {
+    tagName: 'link',
+    attributes: {
+      rel: 'search',
+      type: 'application/opensearchdescription+xml',
+      title,
+      href: normalizeUrl([baseUrl, OPEN_SEARCH_FILENAME]),
+    },
+  };
+}