feat(v2): global data + useGlobalData + docs versions dropdown (#2971)

* doc components initial simplification

* doc components initial simplification

* add docContext test

* Add poc of global data system + use it in the theme

* Revert "doc components initial simplification"

This reverts commit f657b4c4

* revert useless changes

* avoid loosing context on docs switch

* fix docs tests

* fix @generated/globalData ts declaration / es import

* typo

* revert bad commit

* refactor navbar in multiple parts + add navbar item types validation + try to fix remaining merge bugs

* add missing watch mode for plugin debug

* fix docs global data integration, move related hooks to docs plugin + convert to TS

* change versions link label

* fix activeClassName react warning

* improve docs global data system + contextual navbar dropdown

* fix bug preventing the deployment

* refactor the global data system to namespace automatically by plugin name + plugin id

* proper NavbarItem comp

* fix tests

* fix snapshot

* extract theme config schema in separate file + rename navbar links to navbar items

* minor typos

* polish docs components/api

* polish useDocs api surface

* fix the docs version suggestions comp + data

* refactors + add docsClientUtils unit tests

* Add documentation

* typo

* Add check for duplicate plugin ids detection

* multi-instance: createData plugin data should be namespaced by plugin instance id

* remove attempt for multi-instance support

packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts

@@ -25,6 +25,7 @@ const createFakeActions = (
   routeConfigs: RouteConfig[],
   contentDir,
   dataContainer?,
+  globalDataContainer?,
 ) => {
   return {
     addRoute: (config: RouteConfig) => {
@@ -36,6 +37,9 @@ const createFakeActions = (
       }
       return path.join(contentDir, name);
     },
+    setGlobalData: (data) => {
+      globalDataContainer.pluginName = {pluginId: data};
+    },
   };
 };
 
@@ -166,6 +170,7 @@ describe('simple website', () => {
     expect(versionToSidebars).toEqual({});
     expect(docsMetadata.hello).toEqual({
       id: 'hello',
+      unversionedId: 'hello',
       isDocsHomePage: true,
       permalink: '/docs/',
       previous: {
@@ -176,11 +181,11 @@ describe('simple website', () => {
       source: path.join('@site', pluginPath, 'hello.md'),
       title: 'Hello, World !',
       description: 'Hi, Endilie here :)',
-      latestVersionMainDocPermalink: undefined,
     });
 
     expect(docsMetadata['foo/bar']).toEqual({
       id: 'foo/bar',
+      unversionedId: 'foo/bar',
       isDocsHomePage: false,
       next: {
         title: 'baz',
@@ -191,17 +196,18 @@ describe('simple website', () => {
       source: path.join('@site', pluginPath, 'foo', 'bar.md'),
       title: 'Bar',
       description: 'This is custom description',
-      latestVersionMainDocPermalink: undefined,
     });
 
     expect(docsSidebars).toMatchSnapshot();
 
     const routeConfigs = [];
     const dataContainer = {};
+    const globalDataContainer = {};
     const actions = createFakeActions(
       routeConfigs,
       pluginContentDir,
       dataContainer,
+      globalDataContainer,
     );
 
     await plugin.contentLoaded({
@@ -219,6 +225,7 @@ describe('simple website', () => {
 
     expect(routeConfigs).not.toEqual([]);
     expect(routeConfigs).toMatchSnapshot();
+    expect(globalDataContainer).toMatchSnapshot();
   });
 });
 
@@ -313,6 +320,7 @@ describe('versioned website', () => {
     expect(docsMetadata['version-1.0.1/foo/baz']).toBeUndefined();
     expect(docsMetadata['foo/bar']).toEqual({
       id: 'foo/bar',
+      unversionedId: 'foo/bar',
       isDocsHomePage: false,
       permalink: '/docs/next/foo/barSlug',
       source: path.join('@site', routeBasePath, 'foo', 'bar.md'),
@@ -327,6 +335,7 @@ describe('versioned website', () => {
     });
     expect(docsMetadata.hello).toEqual({
       id: 'hello',
+      unversionedId: 'hello',
       isDocsHomePage: true,
       permalink: '/docs/next/',
       source: path.join('@site', routeBasePath, 'hello.md'),
@@ -341,6 +350,7 @@ describe('versioned website', () => {
     });
     expect(docsMetadata['version-1.0.1/hello']).toEqual({
       id: 'version-1.0.1/hello',
+      unversionedId: 'hello',
       isDocsHomePage: true,
       permalink: '/docs/',
       source: path.join(
@@ -357,10 +367,10 @@ describe('versioned website', () => {
         title: 'bar',
         permalink: '/docs/foo/bar',
       },
-      latestVersionMainDocPermalink: undefined,
     });
     expect(docsMetadata['version-1.0.0/foo/baz']).toEqual({
       id: 'version-1.0.0/foo/baz',
+      unversionedId: 'foo/baz',
       isDocsHomePage: false,
       permalink: '/docs/1.0.0/foo/baz',
       source: path.join(
@@ -391,10 +401,12 @@ describe('versioned website', () => {
     );
     const routeConfigs = [];
     const dataContainer = {};
+    const globalDataContainer = {};
     const actions = createFakeActions(
       routeConfigs,
       pluginContentDir,
       dataContainer,
+      globalDataContainer,
     );
     await plugin.contentLoaded({
       content,
@@ -438,5 +450,6 @@ describe('versioned website', () => {
 
     expect(routeConfigs).not.toEqual([]);
     expect(routeConfigs).toMatchSnapshot();
+    expect(globalDataContainer).toMatchSnapshot();
   });
 });