@docusaurus/plugin-content-docs 0.0.0-4550 → 0.0.0-4554

package/lib/client/index.d.ts

@@ -4,4 +4,16 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-export * from './globalDataHooks';
+import type { GlobalPluginData, GlobalVersion, ActivePlugin, ActiveDocContext, DocVersionSuggestions, GetActivePluginOptions } from '@docusaurus/plugin-content-docs/client';
+export declare const useAllDocsData: () => Record<string, GlobalPluginData>;
+export declare const useDocsData: (pluginId: string | undefined) => GlobalPluginData;
+export declare const useActivePlugin: (options?: GetActivePluginOptions) => ActivePlugin | undefined;
+export declare const useActivePluginAndVersion: (options?: GetActivePluginOptions) => {
+    activePlugin: ActivePlugin;
+    activeVersion: GlobalVersion | undefined;
+} | undefined;
+export declare const useVersions: (pluginId: string | undefined) => GlobalVersion[];
+export declare const useLatestVersion: (pluginId: string | undefined) => GlobalVersion;
+export declare const useActiveVersion: (pluginId: string | undefined) => GlobalVersion | undefined;
+export declare const useActiveDocContext: (pluginId: string | undefined) => ActiveDocContext;
+export declare const useDocVersionSuggestions: (pluginId: string | undefined) => DocVersionSuggestions;

package/lib/client/index.js

@@ -6,5 +6,70 @@
  * 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 tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./globalDataHooks"), exports);
+const router_1 = require("@docusaurus/router");
+const useGlobalData_1 = (0, tslib_1.__importStar)(require("@docusaurus/useGlobalData"));
+const docsClientUtils_1 = require("./docsClientUtils");
+// Important to use a constant object to avoid React useEffect executions etc.
+// see https://github.com/facebook/docusaurus/issues/5089
+const StableEmptyObject = {};
+// Not using useAllPluginInstancesData() because 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 = () => { var _a; return (_a = (0, useGlobalData_1.default)()['docusaurus-plugin-content-docs']) !== null && _a !== void 0 ? _a : StableEmptyObject; };
+exports.useAllDocsData = useAllDocsData;
+const useDocsData = (pluginId) => (0, useGlobalData_1.usePluginData)('docusaurus-plugin-content-docs', pluginId);
+exports.useDocsData = useDocsData;
+// TODO this feature should be provided by docusaurus core
+const useActivePlugin = (options = {}) => {
+    const data = (0, exports.useAllDocsData)();
+    const { pathname } = (0, router_1.useLocation)();
+    return (0, docsClientUtils_1.getActivePlugin)(data, pathname, options);
+};
+exports.useActivePlugin = useActivePlugin;
+const useActivePluginAndVersion = (options = {}) => {
+    const activePlugin = (0, exports.useActivePlugin)(options);
+    const { pathname } = (0, router_1.useLocation)();
+    if (activePlugin) {
+        const activeVersion = (0, docsClientUtils_1.getActiveVersion)(activePlugin.pluginData, pathname);
+        return {
+            activePlugin,
+            activeVersion,
+        };
+    }
+    return undefined;
+};
+exports.useActivePluginAndVersion = useActivePluginAndVersion;
+// versions are returned ordered (most recent first)
+const useVersions = (pluginId) => {
+    const data = (0, exports.useDocsData)(pluginId);
+    return data.versions;
+};
+exports.useVersions = useVersions;
+const useLatestVersion = (pluginId) => {
+    const data = (0, exports.useDocsData)(pluginId);
+    return (0, docsClientUtils_1.getLatestVersion)(data);
+};
+exports.useLatestVersion = useLatestVersion;
+// Note: return undefined on doc-unrelated pages,
+// because there's no version currently considered as active
+const useActiveVersion = (pluginId) => {
+    const data = (0, exports.useDocsData)(pluginId);
+    const { pathname } = (0, router_1.useLocation)();
+    return (0, docsClientUtils_1.getActiveVersion)(data, pathname);
+};
+exports.useActiveVersion = useActiveVersion;
+const useActiveDocContext = (pluginId) => {
+    const data = (0, exports.useDocsData)(pluginId);
+    const { pathname } = (0, router_1.useLocation)();
+    return (0, docsClientUtils_1.getActiveDocContext)(data, pathname);
+};
+exports.useActiveDocContext = useActiveDocContext;
+// Useful to say "hey, you are not on the latest docs version, please switch"
+const useDocVersionSuggestions = (pluginId) => {
+    const data = (0, exports.useDocsData)(pluginId);
+    const { pathname } = (0, router_1.useLocation)();
+    return (0, docsClientUtils_1.getDocVersionSuggestions)(data, pathname);
+};
+exports.useDocVersionSuggestions = useDocVersionSuggestions;

package/lib/{server/index.d.ts → server-export.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.
  */
-export * from '../constants';
-export { filterVersions, getDefaultVersionBanner, getVersionBadge, getVersionBanner, getVersionsFilePath, readVersionsFile, readVersionNames, } from '../versions';
+export { CURRENT_VERSION_NAME, VERSIONED_DOCS_DIR, VERSIONED_SIDEBARS_DIR, VERSIONS_JSON_FILE, } from './constants';
+export { filterVersions, getDefaultVersionBanner, getVersionBadge, getVersionBanner, getVersionsFilePath, readVersionsFile, readVersionNames, } from './versions';

package/lib/{server/index.js → server-export.js}

@@ -6,11 +6,14 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readVersionNames = exports.readVersionsFile = exports.getVersionsFilePath = exports.getVersionBanner = exports.getVersionBadge = exports.getDefaultVersionBanner = exports.filterVersions = void 0;
-const tslib_1 = require("tslib");
+exports.readVersionNames = exports.readVersionsFile = exports.getVersionsFilePath = exports.getVersionBanner = exports.getVersionBadge = exports.getDefaultVersionBanner = exports.filterVersions = exports.VERSIONS_JSON_FILE = exports.VERSIONED_SIDEBARS_DIR = exports.VERSIONED_DOCS_DIR = exports.CURRENT_VERSION_NAME = void 0;
 // APIs available to Node.js
-(0, tslib_1.__exportStar)(require("../constants"), exports);
-var versions_1 = require("../versions");
+var constants_1 = require("./constants");
+Object.defineProperty(exports, "CURRENT_VERSION_NAME", { enumerable: true, get: function () { return constants_1.CURRENT_VERSION_NAME; } });
+Object.defineProperty(exports, "VERSIONED_DOCS_DIR", { enumerable: true, get: function () { return constants_1.VERSIONED_DOCS_DIR; } });
+Object.defineProperty(exports, "VERSIONED_SIDEBARS_DIR", { enumerable: true, get: function () { return constants_1.VERSIONED_SIDEBARS_DIR; } });
+Object.defineProperty(exports, "VERSIONS_JSON_FILE", { enumerable: true, get: function () { return constants_1.VERSIONS_JSON_FILE; } });
+var versions_1 = require("./versions");
 Object.defineProperty(exports, "filterVersions", { enumerable: true, get: function () { return versions_1.filterVersions; } });
 Object.defineProperty(exports, "getDefaultVersionBanner", { enumerable: true, get: function () { return versions_1.getDefaultVersionBanner; } });
 Object.defineProperty(exports, "getVersionBadge", { enumerable: true, get: function () { return versions_1.getVersionBadge; } });

package/lib/sidebars/utils.js

@@ -184,7 +184,6 @@ Available document ids are:
     }
     function getFirstLink(sidebar) {
         var _a, _b, _c;
-        // eslint-disable-next-line no-restricted-syntax
         for (const item of sidebar) {
             if (item.type === 'doc') {
                 return {

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-4550",
+  "version": "0.0.0-4554",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "exports": {
     "./client": "./lib/client/index.js",
-    "./server": "./lib/server/index.js",
+    "./server": "./lib/server-export.js",
     ".": "./lib/index.js"
   },
   "types": "src/plugin-content-docs.d.ts",
@@ -23,11 +23,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4550",
-    "@docusaurus/logger": "0.0.0-4550",
-    "@docusaurus/mdx-loader": "0.0.0-4550",
-    "@docusaurus/utils": "0.0.0-4550",
-    "@docusaurus/utils-validation": "0.0.0-4550",
+    "@docusaurus/core": "0.0.0-4554",
+    "@docusaurus/logger": "0.0.0-4554",
+    "@docusaurus/mdx-loader": "0.0.0-4554",
+    "@docusaurus/utils": "0.0.0-4554",
+    "@docusaurus/utils-validation": "0.0.0-4554",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.0.0",
     "import-fresh": "^3.2.2",
@@ -40,8 +40,8 @@
     "webpack": "^5.68.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4550",
-    "@docusaurus/types": "0.0.0-4550",
+    "@docusaurus/module-type-aliases": "0.0.0-4554",
+    "@docusaurus/types": "0.0.0-4554",
     "@types/js-yaml": "^4.0.0",
     "@types/picomatch": "^2.2.1",
     "commander": "^5.1.0",
@@ -57,5 +57,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "9eccadbbf68a877760b1ee7a42484df09cd9d862"
+  "gitHead": "d599cd10202242196737527108e8a15beef1443d"
 }

package/src/client/index.ts

@@ -5,4 +5,100 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-export * from './globalDataHooks';
+import {useLocation} from '@docusaurus/router';
+import useGlobalData, {usePluginData} from '@docusaurus/useGlobalData';
+
+import {
+  getActivePlugin,
+  getLatestVersion,
+  getActiveVersion,
+  getActiveDocContext,
+  getDocVersionSuggestions,
+} from './docsClientUtils';
+import type {
+  GlobalPluginData,
+  GlobalVersion,
+  ActivePlugin,
+  ActiveDocContext,
+  DocVersionSuggestions,
+  GetActivePluginOptions,
+} from '@docusaurus/plugin-content-docs/client';
+
+// Important to use a constant object to avoid React useEffect executions etc.
+// see https://github.com/facebook/docusaurus/issues/5089
+const StableEmptyObject = {};
+
+// Not using useAllPluginInstancesData() because 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
+export const useAllDocsData = (): Record<string, GlobalPluginData> =>
+  useGlobalData()['docusaurus-plugin-content-docs'] ?? StableEmptyObject;
+
+export const useDocsData = (pluginId: string | undefined): GlobalPluginData =>
+  usePluginData('docusaurus-plugin-content-docs', pluginId) as GlobalPluginData;
+
+// TODO this feature should be provided by docusaurus core
+export const useActivePlugin = (
+  options: GetActivePluginOptions = {},
+): ActivePlugin | undefined => {
+  const data = useAllDocsData();
+  const {pathname} = useLocation();
+  return getActivePlugin(data, pathname, options);
+};
+
+export const useActivePluginAndVersion = (
+  options: GetActivePluginOptions = {},
+):
+  | undefined
+  | {activePlugin: ActivePlugin; activeVersion: GlobalVersion | undefined} => {
+  const activePlugin = useActivePlugin(options);
+  const {pathname} = useLocation();
+  if (activePlugin) {
+    const activeVersion = getActiveVersion(activePlugin.pluginData, pathname);
+    return {
+      activePlugin,
+      activeVersion,
+    };
+  }
+  return undefined;
+};
+
+// versions are returned ordered (most recent first)
+export const useVersions = (pluginId: string | undefined): GlobalVersion[] => {
+  const data = useDocsData(pluginId);
+  return data.versions;
+};
+
+export const useLatestVersion = (
+  pluginId: string | undefined,
+): GlobalVersion => {
+  const data = useDocsData(pluginId);
+  return getLatestVersion(data);
+};
+
+// Note: return undefined on doc-unrelated pages,
+// because there's no version currently considered as active
+export const useActiveVersion = (
+  pluginId: string | undefined,
+): GlobalVersion | undefined => {
+  const data = useDocsData(pluginId);
+  const {pathname} = useLocation();
+  return getActiveVersion(data, pathname);
+};
+
+export const useActiveDocContext = (
+  pluginId: string | undefined,
+): ActiveDocContext => {
+  const data = useDocsData(pluginId);
+  const {pathname} = useLocation();
+  return getActiveDocContext(data, pathname);
+};
+
+// Useful to say "hey, you are not on the latest docs version, please switch"
+export const useDocVersionSuggestions = (
+  pluginId: string | undefined,
+): DocVersionSuggestions => {
+  const data = useDocsData(pluginId);
+  const {pathname} = useLocation();
+  return getDocVersionSuggestions(data, pathname);
+};

package/src/{server/index.ts → server-export.ts}

@@ -6,7 +6,12 @@
  */
 
 // APIs available to Node.js
-export * from '../constants';
+export {
+  CURRENT_VERSION_NAME,
+  VERSIONED_DOCS_DIR,
+  VERSIONED_SIDEBARS_DIR,
+  VERSIONS_JSON_FILE,
+} from './constants';
 
 export {
   filterVersions,
@@ -16,4 +21,4 @@ export {
   getVersionsFilePath,
   readVersionsFile,
   readVersionNames,
-} from '../versions';
+} from './versions';

package/src/sidebars/utils.ts

@@ -303,7 +303,6 @@ Available document ids are:
         label: string;
       }
     | undefined {
-    // eslint-disable-next-line no-restricted-syntax
     for (const item of sidebar) {
       if (item.type === 'doc') {
         return {

package/lib/client/globalDataHooks.d.ts

@@ -1,19 +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 type { GlobalPluginData, GlobalVersion, ActivePlugin, ActiveDocContext, DocVersionSuggestions, GetActivePluginOptions } from '@docusaurus/plugin-content-docs/client';
-export declare const useAllDocsData: () => Record<string, GlobalPluginData>;
-export declare const useDocsData: (pluginId: string | undefined) => GlobalPluginData;
-export declare const useActivePlugin: (options?: GetActivePluginOptions) => ActivePlugin | undefined;
-export declare const useActivePluginAndVersion: (options?: GetActivePluginOptions) => {
-    activePlugin: ActivePlugin;
-    activeVersion: GlobalVersion | undefined;
-} | undefined;
-export declare const useVersions: (pluginId: string | undefined) => GlobalVersion[];
-export declare const useLatestVersion: (pluginId: string | undefined) => GlobalVersion;
-export declare const useActiveVersion: (pluginId: string | undefined) => GlobalVersion | undefined;
-export declare const useActiveDocContext: (pluginId: string | undefined) => ActiveDocContext;
-export declare const useDocVersionSuggestions: (pluginId: string | undefined) => DocVersionSuggestions;

package/lib/client/globalDataHooks.js

@@ -1,77 +0,0 @@
-"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 tslib_1 = require("tslib");
-const router_1 = require("@docusaurus/router");
-const useGlobalData_1 = (0, tslib_1.__importStar)(require("@docusaurus/useGlobalData"));
-const docsClientUtils_1 = require("./docsClientUtils");
-// Important to use a constant object to avoid React useEffect executions etc.
-// see https://github.com/facebook/docusaurus/issues/5089
-const StableEmptyObject = {};
-// Not using useAllPluginInstancesData() because 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 = () => { var _a; 
-// useAllPluginInstancesData('docusaurus-plugin-content-docs');
-return (_a = (0, useGlobalData_1.default)()['docusaurus-plugin-content-docs']) !== null && _a !== void 0 ? _a : StableEmptyObject; };
-exports.useAllDocsData = useAllDocsData;
-const useDocsData = (pluginId) => (0, useGlobalData_1.usePluginData)('docusaurus-plugin-content-docs', pluginId);
-exports.useDocsData = useDocsData;
-// TODO this feature should be provided by docusaurus core
-const useActivePlugin = (options = {}) => {
-    const data = (0, exports.useAllDocsData)();
-    const { pathname } = (0, router_1.useLocation)();
-    return (0, docsClientUtils_1.getActivePlugin)(data, pathname, options);
-};
-exports.useActivePlugin = useActivePlugin;
-const useActivePluginAndVersion = (options = {}) => {
-    const activePlugin = (0, exports.useActivePlugin)(options);
-    const { pathname } = (0, router_1.useLocation)();
-    if (activePlugin) {
-        const activeVersion = (0, docsClientUtils_1.getActiveVersion)(activePlugin.pluginData, pathname);
-        return {
-            activePlugin,
-            activeVersion,
-        };
-    }
-    return undefined;
-};
-exports.useActivePluginAndVersion = useActivePluginAndVersion;
-// versions are returned ordered (most recent first)
-const useVersions = (pluginId) => {
-    const data = (0, exports.useDocsData)(pluginId);
-    return data.versions;
-};
-exports.useVersions = useVersions;
-const useLatestVersion = (pluginId) => {
-    const data = (0, exports.useDocsData)(pluginId);
-    return (0, docsClientUtils_1.getLatestVersion)(data);
-};
-exports.useLatestVersion = useLatestVersion;
-// Note: return undefined on doc-unrelated pages,
-// because there's no version currently considered as active
-const useActiveVersion = (pluginId) => {
-    const data = (0, exports.useDocsData)(pluginId);
-    const { pathname } = (0, router_1.useLocation)();
-    return (0, docsClientUtils_1.getActiveVersion)(data, pathname);
-};
-exports.useActiveVersion = useActiveVersion;
-const useActiveDocContext = (pluginId) => {
-    const data = (0, exports.useDocsData)(pluginId);
-    const { pathname } = (0, router_1.useLocation)();
-    return (0, docsClientUtils_1.getActiveDocContext)(data, pathname);
-};
-exports.useActiveDocContext = useActiveDocContext;
-// Useful to say "hey, you are not on the latest docs version, please switch"
-const useDocVersionSuggestions = (pluginId) => {
-    const data = (0, exports.useDocsData)(pluginId);
-    const { pathname } = (0, router_1.useLocation)();
-    return (0, docsClientUtils_1.getDocVersionSuggestions)(data, pathname);
-};
-exports.useDocVersionSuggestions = useDocVersionSuggestions;

package/src/client/globalDataHooks.ts

@@ -1,108 +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 {useLocation} from '@docusaurus/router';
-import useGlobalData, {
-  // useAllPluginInstancesData,
-  usePluginData,
-} from '@docusaurus/useGlobalData';
-
-import {
-  getActivePlugin,
-  getLatestVersion,
-  getActiveVersion,
-  getActiveDocContext,
-  getDocVersionSuggestions,
-} from './docsClientUtils';
-import type {
-  GlobalPluginData,
-  GlobalVersion,
-  ActivePlugin,
-  ActiveDocContext,
-  DocVersionSuggestions,
-  GetActivePluginOptions,
-} from '@docusaurus/plugin-content-docs/client';
-
-// Important to use a constant object to avoid React useEffect executions etc.
-// see https://github.com/facebook/docusaurus/issues/5089
-const StableEmptyObject = {};
-
-// Not using useAllPluginInstancesData() because 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
-export const useAllDocsData = (): Record<string, GlobalPluginData> =>
-  // useAllPluginInstancesData('docusaurus-plugin-content-docs');
-  useGlobalData()['docusaurus-plugin-content-docs'] ?? StableEmptyObject;
-
-export const useDocsData = (pluginId: string | undefined): GlobalPluginData =>
-  usePluginData('docusaurus-plugin-content-docs', pluginId) as GlobalPluginData;
-
-// TODO this feature should be provided by docusaurus core
-export const useActivePlugin = (
-  options: GetActivePluginOptions = {},
-): ActivePlugin | undefined => {
-  const data = useAllDocsData();
-  const {pathname} = useLocation();
-  return getActivePlugin(data, pathname, options);
-};
-
-export const useActivePluginAndVersion = (
-  options: GetActivePluginOptions = {},
-):
-  | undefined
-  | {activePlugin: ActivePlugin; activeVersion: GlobalVersion | undefined} => {
-  const activePlugin = useActivePlugin(options);
-  const {pathname} = useLocation();
-  if (activePlugin) {
-    const activeVersion = getActiveVersion(activePlugin.pluginData, pathname);
-    return {
-      activePlugin,
-      activeVersion,
-    };
-  }
-  return undefined;
-};
-
-// versions are returned ordered (most recent first)
-export const useVersions = (pluginId: string | undefined): GlobalVersion[] => {
-  const data = useDocsData(pluginId);
-  return data.versions;
-};
-
-export const useLatestVersion = (
-  pluginId: string | undefined,
-): GlobalVersion => {
-  const data = useDocsData(pluginId);
-  return getLatestVersion(data);
-};
-
-// Note: return undefined on doc-unrelated pages,
-// because there's no version currently considered as active
-export const useActiveVersion = (
-  pluginId: string | undefined,
-): GlobalVersion | undefined => {
-  const data = useDocsData(pluginId);
-  const {pathname} = useLocation();
-  return getActiveVersion(data, pathname);
-};
-
-export const useActiveDocContext = (
-  pluginId: string | undefined,
-): ActiveDocContext => {
-  const data = useDocsData(pluginId);
-  const {pathname} = useLocation();
-  return getActiveDocContext(data, pathname);
-};
-
-// Useful to say "hey, you are not on the latest docs version, please switch"
-export const useDocVersionSuggestions = (
-  pluginId: string | undefined,
-): DocVersionSuggestions => {
-  const data = useDocsData(pluginId);
-  const {pathname} = useLocation();
-  return getDocVersionSuggestions(data, pathname);
-};