@docusaurus/theme-common 2.0.0-beta.fc64c12e4 → 2.0.0

package/lib/utils/usePrevious.js

@@ -1,14 +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 { useRef, useEffect } from 'react';
-export function usePrevious(value) {
-    const ref = useRef();
-    useEffect(() => {
-        ref.current = value;
-    });
-    return ref.current;
-}

package/src/utils/__tests__/codeBlockUtils.test.ts

@@ -1,54 +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 {parseCodeBlockTitle} from '../codeBlockUtils';
-
-describe('parseCodeBlockTitle', () => {
-  test('should parse double quote delimited title', () => {
-    expect(parseCodeBlockTitle(`title="index.js"`)).toEqual(`index.js`);
-  });
-
-  test('should parse single quote delimited title', () => {
-    expect(parseCodeBlockTitle(`title='index.js'`)).toEqual(`index.js`);
-  });
-
-  test('should not parse mismatched quote delimiters', () => {
-    expect(parseCodeBlockTitle(`title="index.js'`)).toEqual(``);
-  });
-
-  test('should parse undefined metastring', () => {
-    expect(parseCodeBlockTitle(undefined)).toEqual(``);
-  });
-
-  test('should parse metastring with no title specified', () => {
-    expect(parseCodeBlockTitle(`{1,2-3}`)).toEqual(``);
-  });
-
-  test('should parse with multiple metadatas title first', () => {
-    expect(parseCodeBlockTitle(`title="index.js" label="JavaScript"`)).toEqual(
-      `index.js`,
-    );
-  });
-
-  test('should parse with multiple metadatas title last', () => {
-    expect(parseCodeBlockTitle(`label="JavaScript" title="index.js"`)).toEqual(
-      `index.js`,
-    );
-  });
-
-  test('should parse double quotes when delimited by single quotes', () => {
-    expect(parseCodeBlockTitle(`title='console.log("Hello, World!")'`)).toEqual(
-      `console.log("Hello, World!")`,
-    );
-  });
-
-  test('should parse single quotes when delimited by double quotes', () => {
-    expect(parseCodeBlockTitle(`title="console.log('Hello, World!')"`)).toEqual(
-      `console.log('Hello, World!')`,
-    );
-  });
-});

package/src/utils/__tests__/pathUtils.test.ts

@@ -1,32 +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 {isSamePath} from '../pathUtils';
-
-describe('isSamePath', () => {
-  test('should be true for compared path without trailing slash', () => {
-    expect(isSamePath('/docs', '/docs')).toBeTruthy();
-  });
-
-  test('should be true for compared path with trailing slash', () => {
-    expect(isSamePath('/docs', '/docs/')).toBeTruthy();
-  });
-
-  test('should be false for compared path with double trailing slash', () => {
-    expect(isSamePath('/docs', '/docs//')).toBeFalsy();
-  });
-
-  test('should be true for twice undefined/null', () => {
-    expect(isSamePath(undefined, undefined)).toBeTruthy();
-    expect(isSamePath(undefined, undefined)).toBeTruthy();
-  });
-
-  test('should be false when one undefined', () => {
-    expect(isSamePath('/docs', undefined)).toBeFalsy();
-    expect(isSamePath(undefined, '/docs')).toBeFalsy();
-  });
-});

package/src/utils/docsPreferredVersion/DocsPreferredVersionProvider.tsx

@@ -1,165 +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 React, {
-  createContext,
-  ReactNode,
-  useContext,
-  useEffect,
-  useMemo,
-  useState,
-} from 'react';
-import {useThemeConfig, DocsVersionPersistence} from '../useThemeConfig';
-import {isDocsPluginEnabled} from '../docsUtils';
-
-import {useAllDocsData} from '@theme/hooks/useDocs';
-
-import DocsPreferredVersionStorage from './DocsPreferredVersionStorage';
-
-type DocsPreferredVersionName = string | null;
-
-// State for a single docs plugin instance
-type DocsPreferredVersionPluginState = {
-  preferredVersionName: DocsPreferredVersionName;
-};
-
-// We need to store in state/storage globally
-// one preferred version per docs plugin instance
-// pluginId => pluginState
-type DocsPreferredVersionState = Record<
-  string,
-  DocsPreferredVersionPluginState
->;
-
-// Initial state is always null as we can't read localstorage from node SSR
-function getInitialState(pluginIds: string[]): DocsPreferredVersionState {
-  const initialState: DocsPreferredVersionState = {};
-  pluginIds.forEach((pluginId) => {
-    initialState[pluginId] = {
-      preferredVersionName: null,
-    };
-  });
-  return initialState;
-}
-
-// Read storage for all docs plugins
-// Assign to each doc plugin a preferred version (if found)
-function readStorageState({
-  pluginIds,
-  versionPersistence,
-  allDocsData,
-}: {
-  pluginIds: string[];
-  versionPersistence: DocsVersionPersistence;
-  allDocsData: any; // TODO find a way to type it :(
-}): DocsPreferredVersionState {
-  // The storage value we read might be stale,
-  // and belong to a version that does not exist in the site anymore
-  // In such case, we remove the storage value to avoid downstream errors
-  function restorePluginState(
-    pluginId: string,
-  ): DocsPreferredVersionPluginState {
-    const preferredVersionNameUnsafe = DocsPreferredVersionStorage.read(
-      pluginId,
-      versionPersistence,
-    );
-    const pluginData = allDocsData[pluginId];
-    const versionExists = pluginData.versions.some(
-      (version: any) => version.name === preferredVersionNameUnsafe,
-    );
-    if (versionExists) {
-      return {preferredVersionName: preferredVersionNameUnsafe};
-    } else {
-      DocsPreferredVersionStorage.clear(pluginId, versionPersistence);
-      return {preferredVersionName: null};
-    }
-  }
-
-  const initialState: DocsPreferredVersionState = {};
-  pluginIds.forEach((pluginId) => {
-    initialState[pluginId] = restorePluginState(pluginId);
-  });
-  return initialState;
-}
-
-function useVersionPersistence(): DocsVersionPersistence {
-  return useThemeConfig().docs.versionPersistence;
-}
-
-// Value that  will be accessible through context: [state,api]
-function useContextValue() {
-  const allDocsData = useAllDocsData();
-  const versionPersistence = useVersionPersistence();
-  const pluginIds = useMemo(() => Object.keys(allDocsData), [allDocsData]);
-
-  // Initial state is empty, as  we can't read browser storage in node/SSR
-  const [state, setState] = useState(() => getInitialState(pluginIds));
-
-  // On mount, we set the state read from browser storage
-  useEffect(() => {
-    setState(readStorageState({allDocsData, versionPersistence, pluginIds}));
-  }, [allDocsData, versionPersistence, pluginIds]);
-
-  // The API that we expose to consumer hooks (memo for constant object)
-  const api = useMemo(() => {
-    function savePreferredVersion(pluginId: string, versionName: string) {
-      DocsPreferredVersionStorage.save(
-        pluginId,
-        versionPersistence,
-        versionName,
-      );
-      setState((s) => ({
-        ...s,
-        [pluginId]: {preferredVersionName: versionName},
-      }));
-    }
-
-    return {
-      savePreferredVersion,
-    };
-  }, [setState]);
-
-  return [state, api] as const;
-}
-
-type DocsPreferredVersionContextValue = ReturnType<typeof useContextValue>;
-
-const Context = createContext<DocsPreferredVersionContextValue | null>(null);
-
-export function DocsPreferredVersionContextProvider({
-  children,
-}: {
-  children: ReactNode;
-}): JSX.Element {
-  if (isDocsPluginEnabled) {
-    return (
-      <DocsPreferredVersionContextProviderUnsafe>
-        {children}
-      </DocsPreferredVersionContextProviderUnsafe>
-    );
-  } else {
-    return <>{children}</>;
-  }
-}
-
-function DocsPreferredVersionContextProviderUnsafe({
-  children,
-}: {
-  children: ReactNode;
-}): JSX.Element {
-  const contextValue = useContextValue();
-  return <Context.Provider value={contextValue}>{children}</Context.Provider>;
-}
-
-export function useDocsPreferredVersionContext(): DocsPreferredVersionContextValue {
-  const value = useContext(Context);
-  if (!value) {
-    throw new Error(
-      'Can\'t find docs preferred context, maybe you forgot to use the "DocsPreferredVersionContextProvider"?',
-    );
-  }
-  return value;
-}

package/src/utils/docsPreferredVersion/DocsPreferredVersionStorage.ts

@@ -1,34 +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 {createStorageSlot} from '../storageUtils';
-import {DocsVersionPersistence} from '../useThemeConfig';
-
-const storageKey = (pluginId: string) => `docs-preferred-version-${pluginId}`;
-
-const DocsPreferredVersionStorage = {
-  save: (
-    pluginId: string,
-    persistence: DocsVersionPersistence,
-    versionName: string,
-  ): void => {
-    createStorageSlot(storageKey(pluginId), {persistence}).set(versionName);
-  },
-
-  read: (
-    pluginId: string,
-    persistence: DocsVersionPersistence,
-  ): string | null => {
-    return createStorageSlot(storageKey(pluginId), {persistence}).get();
-  },
-
-  clear: (pluginId: string, persistence: DocsVersionPersistence): void => {
-    createStorageSlot(storageKey(pluginId), {persistence}).del();
-  },
-};
-
-export default DocsPreferredVersionStorage;

package/src/utils/docsPreferredVersion/useDocsPreferredVersion.ts

@@ -1,66 +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 {useCallback} from 'react';
-import {useDocsPreferredVersionContext} from './DocsPreferredVersionProvider';
-import {useAllDocsData, useDocsData} from '@theme/hooks/useDocs';
-
-import {DEFAULT_PLUGIN_ID} from '@docusaurus/constants';
-
-// TODO improve typing
-
-// Note, the preferredVersion attribute will always be null before mount
-export function useDocsPreferredVersion(
-  pluginId: string | undefined = DEFAULT_PLUGIN_ID,
-) {
-  const docsData = useDocsData(pluginId);
-  const [state, api] = useDocsPreferredVersionContext();
-
-  const {preferredVersionName} = state[pluginId];
-
-  const preferredVersion = preferredVersionName
-    ? docsData.versions.find(
-        (version: any) => version.name === preferredVersionName,
-      )
-    : null;
-
-  const savePreferredVersionName = useCallback(
-    (versionName: string) => {
-      api.savePreferredVersion(pluginId, versionName);
-    },
-    [api],
-  );
-
-  return {preferredVersion, savePreferredVersionName} as const;
-}
-
-export function useDocsPreferredVersionByPluginId(): Record<string, any> {
-  const allDocsData = useAllDocsData();
-  const [state] = useDocsPreferredVersionContext();
-
-  function getPluginIdPreferredVersion(pluginId: string) {
-    const docsData = allDocsData[pluginId];
-    const {preferredVersionName} = state[pluginId];
-
-    return preferredVersionName
-      ? docsData.versions.find(
-          (version: any) => version.name === preferredVersionName,
-        )
-      : null;
-  }
-
-  const pluginIds = Object.keys(allDocsData);
-
-  const result: Record<
-    string,
-    any // TODO find a way to type this properly!
-  > = {};
-  pluginIds.forEach((pluginId) => {
-    result[pluginId] = getPluginIdPreferredVersion(pluginId);
-  });
-
-  return result;
-}

package/src/utils/docsUtils.ts

@@ -1,11 +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 {useAllDocsData} from '@theme/hooks/useDocs';
-
-// TODO not ideal, see also "useDocs"
-export const isDocsPluginEnabled: boolean = !!useAllDocsData;

package/src/utils/mobileSecondaryMenu.tsx

@@ -1,115 +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 React, {
-  useState,
-  ReactNode,
-  useContext,
-  createContext,
-  useEffect,
-  ComponentType,
-  useMemo,
-} from 'react';
-
-/*
-The idea behind all this is that a specific component must be able to fill a placeholder in the generic layout
-The doc page should be able to fill the secondary menu of the main mobile navbar.
-This permits to reduce coupling between the main layout and the specific page.
-
-This kind of feature is often called portal/teleport/gateway... various unmaintained React libs exist
-Most up-to-date one: https://github.com/gregberge/react-teleporter
-Not sure any of those is safe regarding concurrent mode.
- */
-
-type ExtraProps = {
-  toggleSidebar: () => void;
-};
-
-export type MobileSecondaryMenuComponent<Props extends unknown> = ComponentType<
-  Props & ExtraProps
->;
-
-type State = {
-  component: MobileSecondaryMenuComponent<unknown>;
-  props: unknown;
-} | null;
-
-function useContextValue() {
-  return useState<State>(null);
-}
-
-type ContextValue = ReturnType<typeof useContextValue>;
-
-const Context = createContext<ContextValue | null>(null);
-
-export function MobileSecondaryMenuProvider({
-  children,
-}: {
-  children: ReactNode;
-}): JSX.Element {
-  return (
-    <Context.Provider value={useContextValue()}>{children}</Context.Provider>
-  );
-}
-
-function useMobileSecondaryMenuContext(): ContextValue {
-  const value = useContext(Context);
-  if (value === null) {
-    throw new Error(
-      'MobileSecondaryMenuProvider was not used correctly, context value is null',
-    );
-  }
-  return value;
-}
-
-export function useMobileSecondaryMenuRenderer(): (
-  extraProps: ExtraProps,
-) => ReactNode | undefined {
-  const [state] = useMobileSecondaryMenuContext();
-  if (state) {
-    const Comp = state.component;
-    return function render(extraProps) {
-      return <Comp {...state.props} {...extraProps} />;
-    };
-  }
-  return () => undefined;
-}
-
-function useShallowMemoizedObject<O extends Record<string, unknown>>(obj: O) {
-  return useMemo(
-    () => obj,
-    // Is this safe?
-    [...Object.keys(obj), ...Object.values(obj)],
-  );
-}
-
-// Fill the secondary menu placeholder with some real content
-export function MobileSecondaryMenuFiller<
-  Props extends Record<string, unknown>
->({
-  component,
-  props,
-}: {
-  component: MobileSecondaryMenuComponent<Props & ExtraProps>;
-  props: Props;
-}): JSX.Element | null {
-  const [, setState] = useMobileSecondaryMenuContext();
-
-  // To avoid useless context re-renders, props are memoized shallowly
-  const memoizedProps = useShallowMemoizedObject(props);
-
-  useEffect(() => {
-    // @ts-expect-error: context is not 100% typesafe but it's ok
-    setState({component, props: memoizedProps});
-  }, [setState, component, memoizedProps]);
-
-  useEffect(() => {
-    return () => setState(null);
-  }, [setState]);
-
-  return null;
-}

package/src/utils/pathUtils.ts

@@ -1,17 +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.
- */
-
-// Compare the 2 paths, ignoring trailing /
-export const isSamePath = (
-  path1: string | undefined,
-  path2: string | undefined,
-): boolean => {
-  const normalize = (pathname: string | undefined) => {
-    return !pathname || pathname?.endsWith('/') ? pathname : `${pathname}/`;
-  };
-  return normalize(path1) === normalize(path2);
-};

package/src/utils/usePrevious.ts

@@ -1,18 +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 {useRef, useEffect} from 'react';
-
-export function usePrevious<T>(value: T): T | undefined {
-  const ref = useRef<T>();
-
-  useEffect(() => {
-    ref.current = value;
-  });
-
-  return ref.current;
-}

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "incremental": true,
-    "tsBuildInfoFile": "./lib/.tsbuildinfo",
-    "module": "esnext",
-    "rootDir": "src",
-    "outDir": "lib"
-  }
-}