@docusaurus/plugin-content-docs 0.0.0-4841 → 0.0.0-4842

package/lib/client/docsClientUtils.d.ts

@@ -4,10 +4,11 @@
  * 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, GetActivePluginOptions, ActivePlugin, ActiveDocContext, DocVersionSuggestions } from '@docusaurus/plugin-content-docs/client';
+import type { GlobalPluginData, GlobalVersion, ActivePlugin, ActiveDocContext, DocVersionSuggestions } from '@docusaurus/plugin-content-docs/client';
+import type { UseDataOptions } from '@docusaurus/types';
 export declare function getActivePlugin(allPluginData: {
     [pluginId: string]: GlobalPluginData;
-}, pathname: string, options?: GetActivePluginOptions): ActivePlugin | undefined;
+}, pathname: string, options?: UseDataOptions): ActivePlugin | undefined;
 export declare const getLatestVersion: (data: GlobalPluginData) => GlobalVersion;
 export declare const getActiveVersion: (data: GlobalPluginData, pathname: string) => GlobalVersion | undefined;
 export declare const getActiveDocContext: (data: GlobalPluginData, pathname: string) => ActiveDocContext;

package/lib/client/index.d.ts

@@ -4,13 +4,14 @@
  * 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';
+import type { GlobalPluginData, GlobalVersion, ActivePlugin, ActiveDocContext, DocVersionSuggestions } from '@docusaurus/plugin-content-docs/client';
+import type { UseDataOptions } from '@docusaurus/types';
 export declare const useAllDocsData: () => {
     [pluginId: string]: GlobalPluginData;
 };
 export declare const useDocsData: (pluginId: string | undefined) => GlobalPluginData;
-export declare const useActivePlugin: (options?: GetActivePluginOptions) => ActivePlugin | undefined;
-export declare const useActivePluginAndVersion: (options?: GetActivePluginOptions) => {
+export declare const useActivePlugin: (options?: UseDataOptions) => ActivePlugin | undefined;
+export declare const useActivePluginAndVersion: (options?: UseDataOptions) => {
     activePlugin: ActivePlugin;
     activeVersion: GlobalVersion | undefined;
 } | undefined;

package/lib/client/index.js

@@ -7,19 +7,20 @@
  */
 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 = tslib_1.__importStar(require("@docusaurus/useGlobalData"));
+const useGlobalData_1 = 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 = () => (0, useGlobalData_1.default)()['docusaurus-plugin-content-docs'] ?? 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') ??
+    StableEmptyObject;
 exports.useAllDocsData = useAllDocsData;
-const useDocsData = (pluginId) => (0, useGlobalData_1.usePluginData)('docusaurus-plugin-content-docs', pluginId);
+const useDocsData = (pluginId) => (0, useGlobalData_1.usePluginData)('docusaurus-plugin-content-docs', pluginId, {
+    failfast: true,
+});
 exports.useDocsData = useDocsData;
 // TODO this feature should be provided by docusaurus core
 const useActivePlugin = (options = {}) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-4841",
+  "version": "0.0.0-4842",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "exports": {
@@ -23,11 +23,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4841",
-    "@docusaurus/logger": "0.0.0-4841",
-    "@docusaurus/mdx-loader": "0.0.0-4841",
-    "@docusaurus/utils": "0.0.0-4841",
-    "@docusaurus/utils-validation": "0.0.0-4841",
+    "@docusaurus/core": "0.0.0-4842",
+    "@docusaurus/logger": "0.0.0-4842",
+    "@docusaurus/mdx-loader": "0.0.0-4842",
+    "@docusaurus/utils": "0.0.0-4842",
+    "@docusaurus/utils-validation": "0.0.0-4842",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.0.1",
     "import-fresh": "^3.3.0",
@@ -39,8 +39,8 @@
     "webpack": "^5.70.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4841",
-    "@docusaurus/types": "0.0.0-4841",
+    "@docusaurus/module-type-aliases": "0.0.0-4842",
+    "@docusaurus/types": "0.0.0-4842",
     "@types/js-yaml": "^4.0.5",
     "@types/picomatch": "^2.3.0",
     "commander": "^5.1.0",
@@ -56,5 +56,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "d8b0b5fbaeeb5c2f8c380816f817bd2c7b88ff85"
+  "gitHead": "6bf15cea226810a6d8263f83eb2b6a56a5d0499b"
 }

package/src/client/docsClientUtils.ts

@@ -11,11 +11,11 @@ import type {
   GlobalPluginData,
   GlobalVersion,
   GlobalDoc,
-  GetActivePluginOptions,
   ActivePlugin,
   ActiveDocContext,
   DocVersionSuggestions,
 } from '@docusaurus/plugin-content-docs/client';
+import type {UseDataOptions} from '@docusaurus/types';
 
 // This code is not part of the api surface, not in ./theme on purpose
 
@@ -25,7 +25,7 @@ import type {
 export function getActivePlugin(
   allPluginData: {[pluginId: string]: GlobalPluginData},
   pathname: string,
-  options: GetActivePluginOptions = {},
+  options: UseDataOptions = {},
 ): ActivePlugin | undefined {
   const activeEntry = Object.entries(allPluginData)
     // Route sorting: '/android/foo' should match '/android' instead of '/'

package/src/client/index.ts

@@ -6,7 +6,10 @@
  */
 
 import {useLocation} from '@docusaurus/router';
-import useGlobalData, {usePluginData} from '@docusaurus/useGlobalData';
+import {
+  useAllPluginInstancesData,
+  usePluginData,
+} from '@docusaurus/useGlobalData';
 
 import {
   getActivePlugin,
@@ -21,25 +24,27 @@ import type {
   ActivePlugin,
   ActiveDocContext,
   DocVersionSuggestions,
-  GetActivePluginOptions,
 } from '@docusaurus/plugin-content-docs/client';
+import type {UseDataOptions} from '@docusaurus/types';
 
 // 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
+// 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 = (): {[pluginId: string]: GlobalPluginData} =>
-  useGlobalData()['docusaurus-plugin-content-docs'] ?? StableEmptyObject;
+  useAllPluginInstancesData('docusaurus-plugin-content-docs') ??
+  StableEmptyObject;
 
 export const useDocsData = (pluginId: string | undefined): GlobalPluginData =>
-  usePluginData('docusaurus-plugin-content-docs', pluginId) as GlobalPluginData;
+  usePluginData('docusaurus-plugin-content-docs', pluginId, {
+    failfast: true,
+  }) as GlobalPluginData;
 
 // TODO this feature should be provided by docusaurus core
 export const useActivePlugin = (
-  options: GetActivePluginOptions = {},
+  options: UseDataOptions = {},
 ): ActivePlugin | undefined => {
   const data = useAllDocsData();
   const {pathname} = useLocation();
@@ -47,7 +52,7 @@ export const useActivePlugin = (
 };
 
 export const useActivePluginAndVersion = (
-  options: GetActivePluginOptions = {},
+  options: UseDataOptions = {},
 ):
   | undefined
   | {activePlugin: ActivePlugin; activeVersion: GlobalVersion | undefined} => {

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

@@ -612,6 +612,8 @@ declare module '@theme/DocPage/Layout/Main' {
 
 // TODO until TS supports exports field... hope it's in 4.6
 declare module '@docusaurus/plugin-content-docs/client' {
+  import type {UseDataOptions} from '@docusaurus/types';
+
   export type ActivePlugin = {
     pluginId: string;
     pluginData: GlobalPluginData;
@@ -655,15 +657,14 @@ declare module '@docusaurus/plugin-content-docs/client' {
     // suggest the same doc, in latest version (if exist)
     latestDocSuggestion?: GlobalDoc;
   };
-  export type GetActivePluginOptions = {failfast?: boolean}; // use fail-fast option if you know for sure one plugin instance is active
 
   export const useAllDocsData: () => {[pluginId: string]: GlobalPluginData};
   export const useDocsData: (pluginId?: string) => GlobalPluginData;
   export const useActivePlugin: (
-    options?: GetActivePluginOptions,
+    options?: UseDataOptions,
   ) => ActivePlugin | undefined;
   export const useActivePluginAndVersion: (
-    options?: GetActivePluginOptions,
+    options?: UseDataOptions,
   ) =>
     | {activePlugin: ActivePlugin; activeVersion: GlobalVersion | undefined}
     | undefined;