@docusaurus/plugin-content-docs 0.0.0-5012 → 0.0.0-5024

package/lib/client/docsClientUtils.js

@@ -1,22 +1,19 @@
-"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.getDocVersionSuggestions = exports.getActiveDocContext = exports.getActiveVersion = exports.getLatestVersion = exports.getActivePlugin = void 0;
-const router_1 = require("@docusaurus/router");
+import { matchPath } from '@docusaurus/router';
 // This code is not part of the api surface, not in ./theme on purpose
 // get the data of the plugin that is currently "active"
 // ie the docs of that plugin are currently browsed
 // it is useful to support multiple docs plugin instances
-function getActivePlugin(allPluginData, pathname, options = {}) {
+export function getActivePlugin(allPluginData, pathname, options = {}) {
     const activeEntry = Object.entries(allPluginData)
         // Route sorting: '/android/foo' should match '/android' instead of '/'
         .sort((a, b) => b[1].path.localeCompare(a[1].path))
-        .find(([, pluginData]) => !!(0, router_1.matchPath)(pathname, {
+        .find(([, pluginData]) => !!matchPath(pathname, {
         path: pluginData.path,
         exact: false,
         strict: false,
@@ -31,27 +28,24 @@ function getActivePlugin(allPluginData, pathname, options = {}) {
     }
     return activePlugin;
 }
-exports.getActivePlugin = getActivePlugin;
-const getLatestVersion = (data) => data.versions.find((version) => version.isLast);
-exports.getLatestVersion = getLatestVersion;
-function getActiveVersion(data, pathname) {
-    const lastVersion = (0, exports.getLatestVersion)(data);
+export const getLatestVersion = (data) => data.versions.find((version) => version.isLast);
+export function getActiveVersion(data, pathname) {
+    const lastVersion = getLatestVersion(data);
     // Last version is a route like /docs/*,
     // we need to match it last or it would match /docs/version-1.0/* as well
     const orderedVersionsMetadata = [
         ...data.versions.filter((version) => version !== lastVersion),
         lastVersion,
     ];
-    return orderedVersionsMetadata.find((version) => !!(0, router_1.matchPath)(pathname, {
+    return orderedVersionsMetadata.find((version) => !!matchPath(pathname, {
         path: version.path,
         exact: false,
         strict: false,
     }));
 }
-exports.getActiveVersion = getActiveVersion;
-function getActiveDocContext(data, pathname) {
+export function getActiveDocContext(data, pathname) {
     const activeVersion = getActiveVersion(data, pathname);
-    const activeDoc = activeVersion?.docs.find((doc) => !!(0, router_1.matchPath)(pathname, {
+    const activeDoc = activeVersion?.docs.find((doc) => !!matchPath(pathname, {
         path: doc.path,
         exact: true,
         strict: false,
@@ -76,11 +70,9 @@ function getActiveDocContext(data, pathname) {
         alternateDocVersions: alternateVersionDocs,
     };
 }
-exports.getActiveDocContext = getActiveDocContext;
-function getDocVersionSuggestions(data, pathname) {
-    const latestVersion = (0, exports.getLatestVersion)(data);
+export function getDocVersionSuggestions(data, pathname) {
+    const latestVersion = getLatestVersion(data);
     const activeDocContext = getActiveDocContext(data, pathname);
     const latestDocSuggestion = activeDocContext?.alternateDocVersions[latestVersion.name];
     return { latestDocSuggestion, latestVersionSuggestion: latestVersion };
 }
-exports.getDocVersionSuggestions = getDocVersionSuggestions;

package/lib/client/index.js

@@ -1,72 +1,60 @@
-"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.useDocVersionSuggestions = exports.useActiveDocContext = exports.useActiveVersion = exports.useLatestVersion = exports.useVersions = exports.useActivePluginAndVersion = exports.useActivePlugin = exports.useDocsData = exports.useAllDocsData = void 0;
-const router_1 = require("@docusaurus/router");
-const useGlobalData_1 = require("@docusaurus/useGlobalData");
-const docsClientUtils_1 = require("./docsClientUtils");
+import { useLocation } from '@docusaurus/router';
+import { useAllPluginInstancesData, usePluginData, } from '@docusaurus/useGlobalData';
+import { getActivePlugin, getLatestVersion, getActiveVersion, getActiveDocContext, getDocVersionSuggestions, } from './docsClientUtils';
 // Important to use a constant object to avoid React useEffect executions etc.
 // see https://github.com/facebook/docusaurus/issues/5089
 const StableEmptyObject = {};
 // In blog-only mode, docs hooks are still used by the theme. We need a fail-
 // safe fallback when the docs plugin is not in use
-const useAllDocsData = () => (0, useGlobalData_1.useAllPluginInstancesData)('docusaurus-plugin-content-docs') ??
+export const useAllDocsData = () => useAllPluginInstancesData('docusaurus-plugin-content-docs') ??
     StableEmptyObject;
-exports.useAllDocsData = useAllDocsData;
-const useDocsData = (pluginId) => (0, useGlobalData_1.usePluginData)('docusaurus-plugin-content-docs', pluginId, {
+export const useDocsData = (pluginId) => usePluginData('docusaurus-plugin-content-docs', pluginId, {
     failfast: true,
 });
-exports.useDocsData = useDocsData;
 // TODO this feature should be provided by docusaurus core
-function useActivePlugin(options = {}) {
-    const data = (0, exports.useAllDocsData)();
-    const { pathname } = (0, router_1.useLocation)();
-    return (0, docsClientUtils_1.getActivePlugin)(data, pathname, options);
+export function useActivePlugin(options = {}) {
+    const data = useAllDocsData();
+    const { pathname } = useLocation();
+    return getActivePlugin(data, pathname, options);
 }
-exports.useActivePlugin = useActivePlugin;
-function useActivePluginAndVersion(options = {}) {
+export function useActivePluginAndVersion(options = {}) {
     const activePlugin = useActivePlugin(options);
-    const { pathname } = (0, router_1.useLocation)();
+    const { pathname } = useLocation();
     if (!activePlugin) {
         return undefined;
     }
-    const activeVersion = (0, docsClientUtils_1.getActiveVersion)(activePlugin.pluginData, pathname);
+    const activeVersion = getActiveVersion(activePlugin.pluginData, pathname);
     return {
         activePlugin,
         activeVersion,
     };
 }
-exports.useActivePluginAndVersion = useActivePluginAndVersion;
-function useVersions(pluginId) {
-    const data = (0, exports.useDocsData)(pluginId);
+export function useVersions(pluginId) {
+    const data = useDocsData(pluginId);
     return data.versions;
 }
-exports.useVersions = useVersions;
-function useLatestVersion(pluginId) {
-    const data = (0, exports.useDocsData)(pluginId);
-    return (0, docsClientUtils_1.getLatestVersion)(data);
+export function useLatestVersion(pluginId) {
+    const data = useDocsData(pluginId);
+    return getLatestVersion(data);
 }
-exports.useLatestVersion = useLatestVersion;
-function useActiveVersion(pluginId) {
-    const data = (0, exports.useDocsData)(pluginId);
-    const { pathname } = (0, router_1.useLocation)();
-    return (0, docsClientUtils_1.getActiveVersion)(data, pathname);
+export function useActiveVersion(pluginId) {
+    const data = useDocsData(pluginId);
+    const { pathname } = useLocation();
+    return getActiveVersion(data, pathname);
 }
-exports.useActiveVersion = useActiveVersion;
-function useActiveDocContext(pluginId) {
-    const data = (0, exports.useDocsData)(pluginId);
-    const { pathname } = (0, router_1.useLocation)();
-    return (0, docsClientUtils_1.getActiveDocContext)(data, pathname);
+export function useActiveDocContext(pluginId) {
+    const data = useDocsData(pluginId);
+    const { pathname } = useLocation();
+    return getActiveDocContext(data, pathname);
 }
-exports.useActiveDocContext = useActiveDocContext;
-function useDocVersionSuggestions(pluginId) {
-    const data = (0, exports.useDocsData)(pluginId);
-    const { pathname } = (0, router_1.useLocation)();
-    return (0, docsClientUtils_1.getDocVersionSuggestions)(data, pathname);
+export function useDocVersionSuggestions(pluginId) {
+    const data = useDocsData(pluginId);
+    const { pathname } = useLocation();
+    return getDocVersionSuggestions(data, pathname);
 }
-exports.useDocVersionSuggestions = useDocVersionSuggestions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-5012",
+  "version": "0.0.0-5024",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -12,7 +12,7 @@
   },
   "types": "src/plugin-content-docs.d.ts",
   "scripts": {
-    "build": "tsc",
+    "build": "tsc --build",
     "watch": "tsc --watch"
   },
   "publishConfig": {
@@ -25,11 +25,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5012",
-    "@docusaurus/logger": "0.0.0-5012",
-    "@docusaurus/mdx-loader": "0.0.0-5012",
-    "@docusaurus/utils": "0.0.0-5012",
-    "@docusaurus/utils-validation": "0.0.0-5012",
+    "@docusaurus/core": "0.0.0-5024",
+    "@docusaurus/logger": "0.0.0-5024",
+    "@docusaurus/mdx-loader": "0.0.0-5024",
+    "@docusaurus/utils": "0.0.0-5024",
+    "@docusaurus/utils-validation": "0.0.0-5024",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.1.0",
     "import-fresh": "^3.3.0",
@@ -41,8 +41,8 @@
     "webpack": "^5.72.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-5012",
-    "@docusaurus/types": "0.0.0-5012",
+    "@docusaurus/module-type-aliases": "0.0.0-5024",
+    "@docusaurus/types": "0.0.0-5024",
     "@types/js-yaml": "^4.0.5",
     "@types/picomatch": "^2.3.0",
     "commander": "^5.1.0",
@@ -58,5 +58,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "23b7a134145506adf6db87c8e81640e3633c13ec"
+  "gitHead": "9d61f0a1f0c1121d25211afbb0fc45a92ca3b2ec"
 }

package/src/plugin-content-docs.d.ts

@@ -5,6 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+/// <reference types="@docusaurus/module-type-aliases" />
+
 declare module '@docusaurus/plugin-content-docs' {
   import type {MDXOptions} from '@docusaurus/mdx-loader';
   import type {

package/src/types.ts

@@ -5,8 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-/// <reference types="@docusaurus/module-type-aliases" />
-
 import type {BrokenMarkdownLink, Tag} from '@docusaurus/utils';
 import type {
   VersionMetadata,