@docusaurus/plugin-content-docs 0.0.0-5122 → 0.0.0-5125

package/lib/client/index.d.ts

@@ -4,8 +4,59 @@
  * 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 } from '@docusaurus/plugin-content-docs/client';
 import type { UseDataOptions } from '@docusaurus/types';
+export declare type ActivePlugin = {
+    pluginId: string;
+    pluginData: GlobalPluginData;
+};
+export declare type ActiveDocContext = {
+    activeVersion?: GlobalVersion;
+    activeDoc?: GlobalDoc;
+    alternateDocVersions: {
+        [versionName: string]: GlobalDoc;
+    };
+};
+export declare type GlobalDoc = {
+    /**
+     * For generated index pages, this is the `slug`, **not** `permalink`
+     * (without base URL). Because slugs have leading slashes but IDs don't,
+     * there won't be clashes.
+     */
+    id: string;
+    path: string;
+    sidebar: string | undefined;
+};
+export declare type GlobalVersion = {
+    name: string;
+    label: string;
+    isLast: boolean;
+    path: string;
+    /** The doc with `slug: /`, or first doc in first sidebar */
+    mainDocId: string;
+    docs: GlobalDoc[];
+    /** Unversioned IDs. In development, this list is empty. */
+    draftIds: string[];
+    sidebars?: {
+        [sidebarId: string]: GlobalSidebar;
+    };
+};
+export declare type GlobalSidebar = {
+    link?: {
+        label: string;
+        path: string;
+    };
+};
+export declare type GlobalPluginData = {
+    path: string;
+    versions: GlobalVersion[];
+    breadcrumbs: boolean;
+};
+export declare type DocVersionSuggestions = {
+    /** Suggest the latest version */
+    latestVersionSuggestion: GlobalVersion;
+    /** Suggest the same doc, in latest version (if one exists) */
+    latestDocSuggestion?: GlobalDoc;
+};
 export declare const useAllDocsData: () => {
     [pluginId: string]: GlobalPluginData;
 };
@@ -15,8 +66,16 @@ export declare function useActivePluginAndVersion(options?: UseDataOptions): {
     activePlugin: ActivePlugin;
     activeVersion: GlobalVersion | undefined;
 } | undefined;
+/** Versions are returned ordered (most recent first). */
 export declare function useVersions(pluginId: string | undefined): GlobalVersion[];
 export declare function useLatestVersion(pluginId: string | undefined): GlobalVersion;
+/**
+ * Returns `undefined` on doc-unrelated pages, because there's no version
+ * currently considered as active.
+ */
 export declare function useActiveVersion(pluginId: string | undefined): GlobalVersion | undefined;
 export declare function useActiveDocContext(pluginId: string | undefined): ActiveDocContext;
+/**
+ * Useful to say "hey, you are not on the latest docs version, please switch"
+ */
 export declare function useDocVersionSuggestions(pluginId: string | undefined): DocVersionSuggestions;

package/lib/client/index.js

@@ -34,6 +34,7 @@ export function useActivePluginAndVersion(options = {}) {
         activeVersion,
     };
 }
+/** Versions are returned ordered (most recent first). */
 export function useVersions(pluginId) {
     const data = useDocsData(pluginId);
     return data.versions;
@@ -42,6 +43,10 @@ export function useLatestVersion(pluginId) {
     const data = useDocsData(pluginId);
     return getLatestVersion(data);
 }
+/**
+ * Returns `undefined` on doc-unrelated pages, because there's no version
+ * currently considered as active.
+ */
 export function useActiveVersion(pluginId) {
     const data = useDocsData(pluginId);
     const { pathname } = useLocation();
@@ -52,6 +57,9 @@ export function useActiveDocContext(pluginId) {
     const { pathname } = useLocation();
     return getActiveDocContext(data, pathname);
 }
+/**
+ * Useful to say "hey, you are not on the latest docs version, please switch"
+ */
 export function useDocVersionSuggestions(pluginId) {
     const data = useDocsData(pluginId);
     const { pathname } = useLocation();

package/package.json

@@ -1,14 +1,23 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-5122",
+  "version": "0.0.0-5125",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
   "exports": {
     "./src/*": "./src/*",
-    "./client": "./lib/client/index.js",
-    "./server": "./lib/server-export.js",
-    ".": "./lib/index.js"
+    "./client": {
+      "type": "./lib/client/index.d.ts",
+      "default": "./lib/client/index.js"
+    },
+    "./server": {
+      "type": "./lib/server-export.d.ts",
+      "default": "./lib/server-export.js"
+    },
+    ".": {
+      "types": "./src/plugin-content-docs.d.ts",
+      "default": "./lib/index.js"
+    }
   },
   "types": "src/plugin-content-docs.d.ts",
   "scripts": {
@@ -25,13 +34,13 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5122",
-    "@docusaurus/logger": "0.0.0-5122",
-    "@docusaurus/mdx-loader": "0.0.0-5122",
-    "@docusaurus/module-type-aliases": "0.0.0-5122",
-    "@docusaurus/types": "0.0.0-5122",
-    "@docusaurus/utils": "0.0.0-5122",
-    "@docusaurus/utils-validation": "0.0.0-5122",
+    "@docusaurus/core": "0.0.0-5125",
+    "@docusaurus/logger": "0.0.0-5125",
+    "@docusaurus/mdx-loader": "0.0.0-5125",
+    "@docusaurus/module-type-aliases": "0.0.0-5125",
+    "@docusaurus/types": "0.0.0-5125",
+    "@docusaurus/utils": "0.0.0-5125",
+    "@docusaurus/utils-validation": "0.0.0-5125",
     "@types/react-router-config": "^5.0.6",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.1.0",
@@ -58,5 +67,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "4e3147e669a62176c9e1b3127b34378c00ad9a74"
+  "gitHead": "95b18955d3045fa305bb4790e12bd7c5cfc292d6"
 }

package/src/client/index.ts

@@ -18,15 +18,60 @@ import {
   getActiveDocContext,
   getDocVersionSuggestions,
 } from './docsClientUtils';
-import type {
-  GlobalPluginData,
-  GlobalVersion,
-  ActivePlugin,
-  ActiveDocContext,
-  DocVersionSuggestions,
-} from '@docusaurus/plugin-content-docs/client';
 import type {UseDataOptions} from '@docusaurus/types';
 
+export type ActivePlugin = {
+  pluginId: string;
+  pluginData: GlobalPluginData;
+};
+export type ActiveDocContext = {
+  activeVersion?: GlobalVersion;
+  activeDoc?: GlobalDoc;
+  alternateDocVersions: {[versionName: string]: GlobalDoc};
+};
+export type GlobalDoc = {
+  /**
+   * For generated index pages, this is the `slug`, **not** `permalink`
+   * (without base URL). Because slugs have leading slashes but IDs don't,
+   * there won't be clashes.
+   */
+  id: string;
+  path: string;
+  sidebar: string | undefined;
+};
+
+export type GlobalVersion = {
+  name: string;
+  label: string;
+  isLast: boolean;
+  path: string;
+  /** The doc with `slug: /`, or first doc in first sidebar */
+  mainDocId: string;
+  docs: GlobalDoc[];
+  /** Unversioned IDs. In development, this list is empty. */
+  draftIds: string[];
+  sidebars?: {[sidebarId: string]: GlobalSidebar};
+};
+
+export type GlobalSidebar = {
+  link?: {
+    label: string;
+    path: string;
+  };
+  // ... we may add other things here later
+};
+export type GlobalPluginData = {
+  path: string;
+  versions: GlobalVersion[];
+  breadcrumbs: boolean;
+};
+export type DocVersionSuggestions = {
+  /** Suggest the latest version */
+  latestVersionSuggestion: GlobalVersion;
+  /** Suggest the same doc, in latest version (if one exists) */
+  latestDocSuggestion?: GlobalDoc;
+};
+
 // Important to use a constant object to avoid React useEffect executions etc.
 // see https://github.com/facebook/docusaurus/issues/5089
 const StableEmptyObject = {};
@@ -71,6 +116,7 @@ export function useActivePluginAndVersion(
   };
 }
 
+/** Versions are returned ordered (most recent first). */
 export function useVersions(pluginId: string | undefined): GlobalVersion[] {
   const data = useDocsData(pluginId);
   return data.versions;
@@ -81,6 +127,10 @@ export function useLatestVersion(pluginId: string | undefined): GlobalVersion {
   return getLatestVersion(data);
 }
 
+/**
+ * Returns `undefined` on doc-unrelated pages, because there's no version
+ * currently considered as active.
+ */
 export function useActiveVersion(
   pluginId: string | undefined,
 ): GlobalVersion | undefined {
@@ -96,7 +146,9 @@ export function useActiveDocContext(
   const {pathname} = useLocation();
   return getActiveDocContext(data, pathname);
 }
-
+/**
+ * Useful to say "hey, you are not on the latest docs version, please switch"
+ */
 export function useDocVersionSuggestions(
   pluginId: string | undefined,
 ): DocVersionSuggestions {

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

@@ -616,89 +616,3 @@ declare module '@theme/DocPage' {
 
   export default function DocPage(props: Props): JSX.Element;
 }
-
-// TODO TS only supports reading `exports` in 4.7. We will need to merge the
-// type defs (and JSDoc) here with the implementation after that
-declare module '@docusaurus/plugin-content-docs/client' {
-  import type {UseDataOptions} from '@docusaurus/types';
-
-  export type ActivePlugin = {
-    pluginId: string;
-    pluginData: GlobalPluginData;
-  };
-  export type ActiveDocContext = {
-    activeVersion?: GlobalVersion;
-    activeDoc?: GlobalDoc;
-    alternateDocVersions: {[versionName: string]: GlobalDoc};
-  };
-  export type GlobalDoc = {
-    /**
-     * For generated index pages, this is the `slug`, **not** `permalink`
-     * (without base URL). Because slugs have leading slashes but IDs don't,
-     * there won't be clashes.
-     */
-    id: string;
-    path: string;
-    sidebar: string | undefined;
-  };
-
-  export type GlobalVersion = {
-    name: string;
-    label: string;
-    isLast: boolean;
-    path: string;
-    /** The doc with `slug: /`, or first doc in first sidebar */
-    mainDocId: string;
-    docs: GlobalDoc[];
-    /** Unversioned IDs. In development, this list is empty. */
-    draftIds: string[];
-    sidebars?: {[sidebarId: string]: GlobalSidebar};
-  };
-
-  export type GlobalSidebar = {
-    link?: {
-      label: string;
-      path: string;
-    };
-    // ... we may add other things here later
-  };
-  export type GlobalPluginData = {
-    path: string;
-    versions: GlobalVersion[];
-    breadcrumbs: boolean;
-  };
-  export type DocVersionSuggestions = {
-    /** Suggest the latest version */
-    latestVersionSuggestion: GlobalVersion;
-    /** Suggest the same doc, in latest version (if one exists) */
-    latestDocSuggestion?: GlobalDoc;
-  };
-
-  export const useAllDocsData: () => {[pluginId: string]: GlobalPluginData};
-  export const useDocsData: (pluginId?: string) => GlobalPluginData;
-  export const useActivePlugin: (
-    options?: UseDataOptions,
-  ) => ActivePlugin | undefined;
-  export const useActivePluginAndVersion: (
-    options?: UseDataOptions,
-  ) =>
-    | {activePlugin: ActivePlugin; activeVersion: GlobalVersion | undefined}
-    | undefined;
-  /** Versions are returned ordered (most recent first). */
-  export const useVersions: (pluginId?: string) => GlobalVersion[];
-  export const useLatestVersion: (pluginId?: string) => GlobalVersion;
-  /**
-   * Returns `undefined` on doc-unrelated pages, because there's no version
-   * currently considered as active.
-   */
-  export const useActiveVersion: (
-    pluginId?: string,
-  ) => GlobalVersion | undefined;
-  export const useActiveDocContext: (pluginId?: string) => ActiveDocContext;
-  /**
-   * Useful to say "hey, you are not on the latest docs version, please switch"
-   */
-  export const useDocVersionSuggestions: (
-    pluginId?: string,
-  ) => DocVersionSuggestions;
-}