@readme/markdown 6.75.0-beta.3 → 6.75.0-beta.31

package/components/Callout/index.tsx

@@ -0,0 +1,27 @@
+import * as React from 'react';
+
+interface Props extends React.PropsWithChildren<React.HTMLAttributes<HTMLQuoteElement>> {
+  attributes: {};
+  icon: string;
+  theme: string;
+  heading?: React.ReactElement;
+}
+
+const Callout = (props: Props) => {
+  const { attributes, children, theme, icon, heading } = props;
+
+  return (
+    // @ts-ignore
+    <blockquote {...attributes} className={`callout callout_${theme}`} theme={icon}>
+      {heading && (
+        <h3 className={`callout-heading${heading ? '' : ' empty'}`}>
+          <span className="callout-icon">{icon}</span>
+          {heading}
+        </h3>
+      )}
+      {children}
+    </blockquote>
+  );
+};
+
+export default Callout;

package/components/Code/index.tsx

@@ -0,0 +1,73 @@
+import copy from 'copy-to-clipboard';
+import React, { createRef } from 'react';
+
+// Only load CodeMirror in the browser, for SSR
+// apps. Necessary because of people like this:
+// https://github.com/codemirror/CodeMirror/issues/3701#issuecomment-164904534
+let syntaxHighlighter;
+let canonicalLanguage = _ => '';
+if (typeof window !== 'undefined') {
+  // eslint-disable-next-line global-require
+  syntaxHighlighter = require('@readme/syntax-highlighter').default;
+  // eslint-disable-next-line global-require
+  ({ canonical: canonicalLanguage } = require('@readme/syntax-highlighter'));
+}
+
+function CopyCode({ codeRef, rootClass = 'rdmd-code-copy', className = '' }) {
+  const copyClass = `${rootClass}_copied`;
+  const button = createRef<HTMLButtonElement>();
+
+  const copier = () => {
+    const code = codeRef.current.textContent;
+
+    if (copy(code)) {
+      const el = button.current;
+      el.classList.add(copyClass);
+
+      setTimeout(() => el.classList.remove(copyClass), 1500);
+    }
+  };
+
+  return <button ref={button} aria-label="Copy Code" className={`${rootClass} ${className}`} onClick={copier} />;
+}
+
+interface Props extends Omit<HTMLElement, 'lang'> {
+  copyButtons?: boolean;
+  lang?: string;
+  meta?: string;
+  theme?: string;
+  value?: string;
+}
+
+const Code = (props: Props) => {
+  const { children, copyButtons, lang, theme, value } = props;
+
+  const language = canonicalLanguage(lang);
+
+  const codeRef = createRef<HTMLElement>();
+
+  const codeOpts = {
+    inline: !lang,
+    tokenizeVariables: true,
+    dark: theme === 'dark',
+  };
+
+  const code = value ?? children?.[0] ?? children ?? '';
+  const highlightedCode = syntaxHighlighter && code ? syntaxHighlighter(code, language, codeOpts) : code;
+
+  return (
+    <>
+      {copyButtons && <CopyCode className="fa" codeRef={codeRef} />}
+      <code
+        ref={codeRef}
+        className={['rdmd-code', `lang-${language}`, `theme-${theme}`].join(' ')}
+        data-lang={language}
+        suppressHydrationWarning={true}
+      >
+        {highlightedCode}
+      </code>
+    </>
+  );
+};
+
+export default Code;

package/components/CodeTabs/{index.jsx → index.tsx}

@@ -1,14 +1,13 @@
-const { uppercase } = require('@readme/syntax-highlighter');
-const PropTypes = require('prop-types');
-const React = require('react');
+import { uppercase } from '@readme/syntax-highlighter';
+import React from 'react';
 
 const CodeTabs = props => {
   const { children, theme } = props;
 
-  function handleClick({ target }, index) {
+  function handleClick({ target }, index: number) {
     const $wrap = target.parentElement.parentElement;
     const $open = [].slice.call($wrap.querySelectorAll('.CodeTabs_active'));
-    $open.forEach(el => el.classList.remove('CodeTabs_active'));
+    $open.forEach((el: Element) => el.classList.remove('CodeTabs_active'));
     $wrap.classList.remove('CodeTabs_initial');
 
     const codeblocks = $wrap.querySelectorAll('pre');
@@ -20,8 +19,9 @@ const CodeTabs = props => {
   return (
     <div className={`CodeTabs CodeTabs_initial theme-${theme}`}>
       <div className="CodeTabs-toolbar">
-        {children.map(({ props: pre }, i) => {
-          const { meta, lang } = pre.children[0].props;
+        {(Array.isArray(children) ? children : [children]).map((pre, i) => {
+          const { meta, lang } = pre.props.children.props;
+
           /* istanbul ignore next */
           return (
             <button key={i} onClick={e => handleClick(e, i)} type="button">
@@ -35,15 +35,4 @@ const CodeTabs = props => {
   );
 };
 
-CodeTabs.propTypes = {
-  children: PropTypes.arrayOf(PropTypes.any).isRequired,
-  theme: PropTypes.string,
-};
-
-function CreateCodeTabs({ theme }) {
-  // eslint-disable-next-line react/display-name
-  return props => <CodeTabs {...props} theme={theme} />;
-}
-
-module.exports = CreateCodeTabs;
-module.exports.CodeTabs = CodeTabs;
+export default CodeTabs;

package/components/GlossaryItem/index.tsx

@@ -0,0 +1,31 @@
+import React, { useContext } from 'react';
+import Tooltip from '@tippyjs/react';
+import GlossaryContext from '../../contexts/GlossaryTerms';
+import type { GlossaryItem, GlossaryTerm } from '../../contexts/GlossaryTerms';
+
+const GlossaryItem = ({ term, terms }: { term: string; terms: GlossaryTerm[] }) => {
+  const foundTerm = terms.find(i => term.toLowerCase() === i.term.toLowerCase());
+
+  if (!foundTerm) return <span>{term}</span>;
+
+  return (
+    <Tooltip
+      content={
+        <div className="GlossaryItem-tooltip-content">
+          <strong className="GlossaryItem-term">{foundTerm.term}</strong> - {foundTerm.definition}
+        </div>
+      }
+      offset={[-5, 5]}
+      placement="bottom-start"
+    >
+      <span className="GlossaryItem-trigger">{term}</span>
+    </Tooltip>
+  );
+};
+
+const GlossaryItemWithContext = props => {
+  const terms = useContext(GlossaryContext);
+  return terms ? <GlossaryItem {...props} terms={terms} /> : null;
+};
+
+export { GlossaryItem, GlossaryItemWithContext as default, GlossaryContext };

package/components/HTMLBlock/index.tsx

@@ -0,0 +1,36 @@
+import React, { useEffect } from 'react';
+import { renderToStaticMarkup } from 'react-dom/server';
+
+const MATCH_SCRIPT_TAGS = /<script\b[^>]*>([\s\S]*?)<\/script *>\n?/gim;
+
+const extractScripts = (html: string = ''): [string, () => void] => {
+  const scripts: string[] = [];
+  let match: RegExpExecArray | null;
+  while ((match = MATCH_SCRIPT_TAGS.exec(html)) !== null) {
+    scripts.push(match[1]);
+  }
+  const cleaned = html.replace(MATCH_SCRIPT_TAGS, '');
+  return [cleaned, () => scripts.map(js => window.eval(js))];
+};
+
+const HTMLBlock = ({ children = '', runScripts = false, safeMode = false }) => {
+  let html = children;
+  if (typeof html !== 'string') html = renderToStaticMarkup(html);
+  const [cleanedHtml, exec] = extractScripts(html);
+
+  useEffect(() => {
+    if (typeof window !== 'undefined' && typeof runScripts === 'boolean' && runScripts) exec();
+  }, [runScripts, exec]);
+
+  if (safeMode) {
+    return (
+      <pre className="html-unsafe">
+        <code>{html}</code>
+      </pre>
+    );
+  }
+
+  return <div className="rdmd-html" dangerouslySetInnerHTML={{ __html: cleanedHtml }} />;
+};
+
+export default HTMLBlock;

package/components/Image/index.tsx

@@ -0,0 +1,96 @@
+import * as React from 'react';
+
+const Image = ({
+  align = '',
+  alt = '',
+  border = false,
+  caption,
+  className = '',
+  height = 'auto',
+  src = '',
+  title = '',
+  width = 'auto',
+  lazy = false,
+}) => {
+  const [lightbox, setLightbox] = React.useState(false);
+
+  if (className === 'emoji') {
+    return <img src={src} width={width} height={height} title={title} alt={alt} loading={lazy ? 'lazy' : 'eager'} />;
+  }
+
+  const handleKeyDown = ({ key, metaKey: cmd }: React.KeyboardEvent<HTMLImageElement>) => {
+    const cmdKey = cmd ? 'cmd+' : '';
+    key = `${cmdKey}${key.toLowerCase()}`;
+
+    switch (key) {
+      case 'cmd+.':
+      case 'escape':
+        // CLOSE
+        setLightbox(false);
+        break;
+      case ' ':
+      case 'enter':
+        // OPEN
+        if (!lightbox) setLightbox(true);
+      default:
+    }
+  };
+
+  const toggle = () => {
+    if (className === 'emoji') return;
+    setLightbox(!lightbox);
+  };
+
+  if (caption) {
+    return (
+      <figure>
+        <span
+          aria-label={alt}
+          className={`img lightbox ${lightbox ? 'open' : 'closed'}`}
+          onClick={toggle}
+          onKeyDown={handleKeyDown}
+          role={'button'}
+          tabIndex={0}
+        >
+          <span className="lightbox-inner">
+            <img
+              src={src}
+              width={width}
+              height={height}
+              title={title}
+              className={`img img-align-center ${border ? 'border' : ''}`}
+              alt={alt}
+              loading={lazy ? 'lazy' : 'eager'}
+            />
+          </span>
+        </span>
+        <figcaption>{caption}</figcaption>
+      </figure>
+    );
+  }
+
+  return (
+    <span
+      aria-label={alt}
+      className={`img lightbox ${lightbox ? 'open' : 'closed'}`}
+      onClick={toggle}
+      onKeyDown={handleKeyDown}
+      role={'button'}
+      tabIndex={0}
+    >
+      <span className="lightbox-inner">
+        <img
+          src={src}
+          width={width}
+          height={height}
+          title={title}
+          className={`img img-align-${align} ${border ? 'border' : ''}`}
+          alt={alt}
+          loading={lazy ? 'lazy' : 'eager'}
+        />
+      </span>
+    </span>
+  );
+};
+
+export default Image;

package/components/Table/index.tsx

@@ -0,0 +1,19 @@
+import React from 'react';
+
+interface Props extends JSX.IntrinsicAttributes {
+  children: [React.ReactElement<HTMLTableCaptionElement | HTMLTableSectionElement | HTMLTableRowElement>];
+}
+
+const Table = (props: Props) => {
+  const { children } = props;
+
+  return (
+    <div className="rdmd-table">
+      <div className="rdmd-table-inner">
+        <table>{children}</table>
+      </div>
+    </div>
+  );
+};
+
+export default Table;

package/components/TableOfContents/index.jsx

@@ -1,5 +1,5 @@
-const PropTypes = require('prop-types');
-const React = require('react');
+import { element } from 'prop-types';
+import React from 'react';
 
 function TableOfContents({ children }) {
   return (
@@ -19,7 +19,7 @@ function TableOfContents({ children }) {
 }
 
 TableOfContents.propTypes = {
-  children: PropTypes.element,
+  children: element,
 };
 
-module.exports = TableOfContents;
+export default TableOfContents;

package/dist/components/Callout/index.d.ts

@@ -0,0 +1,9 @@
+import * as React from 'react';
+interface Props extends React.PropsWithChildren<React.HTMLAttributes<HTMLQuoteElement>> {
+    attributes: {};
+    icon: string;
+    theme: string;
+    heading?: React.ReactElement;
+}
+declare const Callout: (props: Props) => React.JSX.Element;
+export default Callout;

package/dist/components/Code/index.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+interface Props extends Omit<HTMLElement, 'lang'> {
+    copyButtons?: boolean;
+    lang?: string;
+    meta?: string;
+    theme?: string;
+    value?: string;
+}
+declare const Code: (props: Props) => React.JSX.Element;
+export default Code;

package/dist/components/CodeTabs/index.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const CodeTabs: (props: any) => React.JSX.Element;
+export default CodeTabs;

package/dist/components/GlossaryItem/index.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import GlossaryContext from '../../contexts/GlossaryTerms';
+import type { GlossaryItem, GlossaryTerm } from '../../contexts/GlossaryTerms';
+declare const GlossaryItem: ({ term, terms }: {
+    term: string;
+    terms: GlossaryTerm[];
+}) => React.JSX.Element;
+declare const GlossaryItemWithContext: (props: any) => React.JSX.Element;
+export { GlossaryItem, GlossaryItemWithContext as default, GlossaryContext };

package/dist/components/HTMLBlock/index.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+declare const HTMLBlock: ({ children, runScripts, safeMode }: {
+    children?: string;
+    runScripts?: boolean;
+    safeMode?: boolean;
+}) => React.JSX.Element;
+export default HTMLBlock;

package/dist/components/Image/index.d.ts

@@ -0,0 +1,14 @@
+import * as React from 'react';
+declare const Image: ({ align, alt, border, caption, className, height, src, title, width, lazy, }: {
+    align?: string;
+    alt?: string;
+    border?: boolean;
+    caption: any;
+    className?: string;
+    height?: string;
+    src?: string;
+    title?: string;
+    width?: string;
+    lazy?: boolean;
+}) => React.JSX.Element;
+export default Image;

package/dist/components/Table/index.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+interface Props extends JSX.IntrinsicAttributes {
+    children: [React.ReactElement<HTMLTableCaptionElement | HTMLTableSectionElement | HTMLTableRowElement>];
+}
+declare const Table: (props: Props) => React.JSX.Element;
+export default Table;

package/dist/components/index.d.ts

@@ -0,0 +1,12 @@
+export { default as Anchor } from './Anchor';
+export { default as Callout } from './Callout';
+export { default as Code } from './Code';
+export { default as CodeTabs } from './CodeTabs';
+export { default as Embed } from './Embed';
+export { default as GlossaryItem } from './GlossaryItem';
+export { default as HTMLBlock } from './HTMLBlock';
+export { default as Heading } from './Heading';
+export { default as Image } from './Image';
+export { default as Style } from './Style';
+export { default as Table } from './Table';
+export { default as TableOfContents } from './TableOfContents';

package/dist/contexts/GlossaryTerms.d.ts

@@ -0,0 +1,15 @@
+import { ReactNode } from "react";
+export type GlossaryTerm = {
+    term: string;
+    definition: string;
+    _id?: string;
+};
+export type GlossaryItem = {
+    term?: string;
+    terms: GlossaryTerm[];
+};
+declare const GlossaryContext: import("react").Context<GlossaryTerm[]>;
+export default GlossaryContext;
+export declare function Provider(Provider: any, arg1: {
+    value: GlossaryTerm[];
+}): ReactNode;

package/dist/enums.d.ts

@@ -0,0 +1,7 @@
+export declare enum NodeTypes {
+    codeTabs = "code-tabs",
+    emoji = "emoji",
+    i = "i",
+    image = "image",
+    htmlBlock = "html-block"
+}

package/dist/errors/mdx-syntax-error.d.ts

@@ -0,0 +1,5 @@
+import { VFileMessage } from 'vfile-message';
+export default class MdxSyntaxError extends SyntaxError {
+    original: VFileMessage;
+    constructor(error: VFileMessage, doc: string);
+}

package/dist/example/App.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const App: () => React.JSX.Element;
+export default App;

package/dist/example/Doc.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const Doc: () => React.JSX.Element;
+export default Doc;

package/dist/example/Form.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const Form: () => React.JSX.Element;
+export default Form;

package/dist/example/Header.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare function Header(): React.JSX.Element;
+export default Header;

package/dist/example/RenderError.d.ts

@@ -0,0 +1,23 @@
+import React, { PropsWithChildren } from 'react';
+interface Props {
+    error?: string;
+}
+interface State {
+    hasError: boolean;
+    message?: string;
+}
+declare class RenderError extends React.Component<PropsWithChildren<Props>, State> {
+    state: {
+        hasError: boolean;
+        message: any;
+    };
+    static getDerivedStateFromError(error: Error): {
+        hasError: boolean;
+        message: string;
+    };
+    componentDidCatch(error: any, info: {
+        componentStack: any;
+    }): void;
+    render(): string | number | boolean | Iterable<React.ReactNode> | React.JSX.Element;
+}
+export default RenderError;

package/dist/example/Root.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const Root: () => React.JSX.Element;
+export default Root;

package/dist/example/docs.d.ts

@@ -0,0 +1,2 @@
+declare const fixtures: {};
+export default fixtures;

package/dist/example/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+import React from 'react';
+import { RunOptions } from '@mdx-js/mdx';
+import * as Components from './components';
+type RunOpts = Omit<RunOptions, 'Fragment'> & {
+    components?: Record<string, () => React.ReactNode>;
+    imports?: Record<string, unknown>;
+};
+export { Components };
+export declare const utils: {
+    readonly options: any;
+    BaseUrlContext: any;
+    getHref: any;
+    GlossaryContext: React.Context<import("./contexts/GlossaryTerms").GlossaryTerm[]>;
+    VariablesContext: any;
+    calloutIcons: {};
+};
+export declare const reactProcessor: (opts?: {}) => import("unified").Processor<import("mdast").Root, import("estree").Program, import("estree").Program, import("estree").Program, string>;
+export declare const compile: (text: string, opts?: {}) => string;
+export declare const run: (code: string, _opts?: RunOpts) => Promise<import("mdx/types").MDXContent | (() => any)>;
+export declare const reactTOC: (text: string, opts?: {}) => void;
+export declare const mdx: (tree: any, opts?: {}) => string;
+export declare const html: (text: string, opts?: {}) => void;
+export declare const mdast: any;
+export declare const hast: (text: string, opts?: {}) => import("hast").Root;
+export declare const esast: (text: string, opts?: {}) => void;
+export declare const plain: (text: string, opts?: {}) => void;

package/dist/lib/owlmoji.d.ts

@@ -0,0 +1,4 @@
+export default class Owlmoji {
+    static kind: (name: string) => "gemoji" | "fontawesome" | "owlmoji";
+    static nameToEmoji: Record<string, string>;
+}