@readme/markdown 8.2.0 → 8.3.0

package/dist/processor/compile/callout.d.ts

@@ -1,3 +1,3 @@
-import { Callout } from '../../types';
+import type { Callout } from '../../types';
 declare const callout: (node: Callout, _: any, state: any, info: any) => any;
 export default callout;

package/dist/processor/compile/code-tabs.d.ts

@@ -1,3 +1,3 @@
-import { CodeTabs } from '../../types';
+import type { CodeTabs } from '../../types';
 declare const codeTabs: (node: CodeTabs, _: any, state: any, info: any) => any;
 export default codeTabs;

package/dist/processor/compile/compatibility.d.ts

@@ -1,53 +1,42 @@
-import { Html, Image } from 'mdast';
+import type { Html } from 'mdast';
+import type { Figure } from 'types';
 import { NodeTypes } from '../../enums';
-type CompatNodes = {
-    type: NodeTypes.glossary;
+interface EditorGlossary {
+    children: [{
+        type: 'text';
+        value: string;
+    }];
     data: {
+        hName: 'Glossary';
         hProperties: {
             term: string;
         };
     };
-} | {
     type: NodeTypes.glossary;
+}
+interface CompatEmbed {
     data: {
-        hName: 'Glossary';
+        hProperties: Record<string, string>;
     };
-    children: [{
-        type: 'text';
-        value: string;
-    }];
-} | {
-    type: NodeTypes.reusableContent;
-    tag: string;
-} | {
+    html: string;
     type: 'embed';
+}
+type CompatNodes = CompatEmbed | EditorGlossary | Figure | Html | {
     data: {
         hProperties: {
-            [key: string]: string;
+            className: string[];
         };
     };
+    type: 'i';
+} | {
+    tag: string;
+    type: NodeTypes.reusableContent;
 } | {
     type: 'escape';
     value: string;
-} | {
-    type: 'figure';
-    children: [Image, {
-        type: 'figcaption';
-        children: [{
-            type: 'text';
-            value: string;
-        }];
-    }];
-} | {
-    type: 'i';
-    data: {
-        hProperties: {
-            className: string[];
-        };
-    };
 } | {
     type: 'yaml';
     value: string;
-} | Html;
+};
 declare const compatibility: (node: CompatNodes) => string;
 export default compatibility;

package/dist/processor/compile/embed.d.ts

@@ -1,3 +1,3 @@
-import type { EmbedBlock } from "types";
+import type { EmbedBlock } from 'types';
 declare const embed: (node: EmbedBlock) => string;
 export default embed;

package/dist/processor/compile/gemoji.d.ts

@@ -1,3 +1,3 @@
-import { Gemoji } from '../../types';
+import type { Gemoji } from '../../types';
 declare const gemoji: (node: Gemoji) => string;
 export default gemoji;

package/dist/processor/compile/html-block.d.ts

@@ -1,3 +1,3 @@
-import { HTMLBlock } from '../../types';
+import type { HTMLBlock } from '../../types';
 declare const htmlBlock: (node: HTMLBlock) => string;
 export default htmlBlock;

package/dist/processor/compile/variable.d.ts

@@ -1,3 +1,3 @@
-import { Variable } from '../../types';
+import type { Variable } from '../../types';
 declare const variable: (node: Variable) => string;
 export default variable;

package/dist/processor/plugin/toc.d.ts

@@ -1,8 +1,8 @@
-import { Transformer } from 'unified';
-import { Root } from 'hast';
-import { CustomComponents, IndexableElements } from '../../types';
+import type { CustomComponents, IndexableElements } from '../../types';
+import type { Root } from 'hast';
+import type { Transformer } from 'unified';
 interface Options {
-    components?: Record<string, any>;
+    components?: CustomComponents;
 }
 export declare const rehypeToc: ({ components }: Options) => Transformer<Root, Root>;
 export declare const tocToMdx: (toc: IndexableElements[], components: CustomComponents) => string;

package/dist/processor/transform/callouts.d.ts

@@ -1,2 +1,3 @@
-declare const calloutTransformer: () => (tree: any) => void;
+import type { Root } from 'mdast';
+declare const calloutTransformer: () => (tree: Root) => void;
 export default calloutTransformer;

package/dist/processor/transform/code-tabs.d.ts

@@ -1,4 +1,4 @@
-import { Node } from 'mdast';
+import type { Node } from 'mdast';
 declare const codeTabsTransformer: ({ copyButtons }?: {
     copyButtons?: boolean;
 }) => (tree: Node) => Node;

package/dist/processor/transform/compatability.d.ts

@@ -1,3 +1,3 @@
-import { Transform } from 'mdast-util-from-markdown';
+import type { Transform } from 'mdast-util-from-markdown';
 declare const compatibilityTransfomer: () => Transform;
 export default compatibilityTransfomer;

package/dist/processor/transform/div.d.ts

@@ -1,3 +1,3 @@
-import { Transform } from 'mdast-util-from-markdown';
+import type { Transform } from 'mdast-util-from-markdown';
 declare const divTransformer: () => Transform;
 export default divTransformer;

package/dist/processor/transform/embeds.d.ts

@@ -1,3 +1,3 @@
-import { Node } from 'mdast';
+import type { Node } from 'mdast';
 declare const embedTransformer: () => (tree: Node) => void;
 export default embedTransformer;

package/dist/processor/transform/gemoji+.d.ts

@@ -1,3 +1,3 @@
-import { Root } from 'mdast';
+import type { Root } from 'mdast';
 declare const gemojiTransformer: () => (tree: Root) => Root;
 export default gemojiTransformer;

package/dist/processor/transform/images.d.ts

@@ -1,3 +1,3 @@
-import { Node } from 'mdast';
+import type { Node } from 'mdast';
 declare const imageTransformer: () => (tree: Node) => Node;
 export default imageTransformer;

package/dist/processor/transform/index.d.ts

@@ -6,11 +6,11 @@ import mermaidTransformer from './mermaid';
 import readmeComponentsTransformer from './readme-components';
 import readmeToMdx from './readme-to-mdx';
 import tablesToJsx from './tables-to-jsx';
-import variablesTransformer from './variables';
 import tailwindTransformer from './tailwind';
+import variablesTransformer from './variables';
 export { compatabilityTransfomer, divTransformer, injectComponents, mdxToHast, mermaidTransformer, readmeComponentsTransformer, readmeToMdx, tablesToJsx, tailwindTransformer, variablesTransformer, };
 export declare const defaultTransforms: {
-    calloutTransformer: () => (tree: any) => void;
+    calloutTransformer: () => (tree: import("mdast").Root) => void;
     codeTabsTransformer: ({ copyButtons }?: {
         copyButtons?: boolean;
     }) => (tree: import("mdast").Node) => import("mdast").Node;
@@ -18,7 +18,7 @@ export declare const defaultTransforms: {
     imageTransformer: () => (tree: import("mdast").Node) => import("mdast").Node;
     gemojiTransformer: () => (tree: import("mdast").Root) => import("mdast").Root;
 };
-declare const _default: ((() => (tree: any) => void) | (({ copyButtons }?: {
+declare const _default: ((() => (tree: import("mdast").Root) => void) | (({ copyButtons }?: {
     copyButtons?: boolean;
-}) => (tree: import("mdast").Node) => import("mdast").Node) | (() => (tree: import("mdast").Node) => void) | (() => (tree: import("mdast").Node) => import("mdast").Node) | (() => (tree: import("mdast").Root) => import("mdast").Root))[];
+}) => (tree: import("mdast").Node) => import("mdast").Node) | (() => (tree: import("mdast").Node) => void) | (() => (tree: import("mdast").Root) => import("mdast").Root) | (() => (tree: import("mdast").Node) => import("mdast").Node))[];
 export default _default;

package/dist/processor/transform/inject-components.d.ts

@@ -1,5 +1,5 @@
-import { MdastComponents } from '../../types';
-import { Transform } from 'mdast-util-from-markdown';
+import type { MdastComponents } from '../../types';
+import type { Transform } from 'mdast-util-from-markdown';
 interface Options {
     components?: MdastComponents;
 }

package/dist/processor/transform/mdx-to-hast.d.ts

@@ -1,3 +1,3 @@
-import { Transform } from 'mdast-util-from-markdown';
+import type { Transform } from 'mdast-util-from-markdown';
 declare const mdxToHast: () => Transform;
 export default mdxToHast;

package/dist/processor/transform/mermaid.d.ts

@@ -1,3 +1,3 @@
-import { Node } from 'unist';
+import type { Node } from 'unist';
 declare const mermaidTransformer: () => (tree: Node) => Node;
 export default mermaidTransformer;

package/dist/processor/transform/readme-components.d.ts

@@ -1,4 +1,4 @@
-import { Transform } from 'mdast-util-from-markdown';
+import type { Transform } from 'mdast-util-from-markdown';
 interface Options {
     components: Record<string, string>;
     html?: boolean;

package/dist/processor/transform/readme-to-mdx.d.ts

@@ -1,3 +1,3 @@
-import { Transform } from 'mdast-util-from-markdown';
+import type { Transform } from 'mdast-util-from-markdown';
 declare const readmeToMdx: () => Transform;
 export default readmeToMdx;

package/dist/processor/transform/tables-to-jsx.d.ts

@@ -1,3 +1,3 @@
-import { Transform } from 'mdast-util-from-markdown';
+import type { Transform } from 'mdast-util-from-markdown';
 declare const tablesToJsx: () => Transform;
 export default tablesToJsx;

package/dist/processor/transform/tailwind.d.ts

@@ -1,4 +1,4 @@
-import { Plugin } from 'unified';
+import type { Plugin } from 'unified';
 interface TailwindRootOptions {
     components: Record<string, string>;
 }

package/dist/processor/transform/variables.d.ts

@@ -1,4 +1,4 @@
-import { Transform } from 'mdast-util-from-markdown';
+import type { Transform } from 'mdast-util-from-markdown';
 declare const variables: ({ asMdx }?: {
     asMdx: boolean;
 }) => Transform;

package/dist/processor/utils.d.ts

@@ -1,5 +1,5 @@
-import type { Node, Root as MdastRoot, Root } from 'mdast';
 import type { Root as HastRoot } from 'hast';
+import type { Node, Root as MdastRoot, Root } from 'mdast';
 import type { MdxJsxFlowElement, MdxJsxTextElement, MdxjsEsm } from 'mdast-util-mdx';
 import type { MdxJsxAttribute } from 'mdast-util-mdx-jsx';
 /**
@@ -18,7 +18,7 @@ export declare const formatHProps: <T>(node: Node) => string;
  * @param {Object} props
  * @returns {string}
  */
-export declare const formatProps: (props: Object) => string;
+export declare const formatProps: <T>(props: T) => string;
 /**
  * Returns the hProperties of a node.
  *
@@ -34,7 +34,7 @@ export declare const getHProps: <T>(node: Node) => T;
  * @param {Node} node
  * @returns {Array} array of hProperty keys
  */
-export declare const getHPropKeys: <T>(node: Node) => any;
+export declare const getHPropKeys: <T>(node: Node) => string[];
 /**
  * Gets the attributes of an MDX element and returns them as an object of hProperties.
  *
@@ -42,7 +42,7 @@ export declare const getHPropKeys: <T>(node: Node) => any;
  * @param {(MdxJsxFlowElement | MdxJsxTextElement)} jsx
  * @returns {T} object of hProperties
  */
-export declare const getAttrs: <T>(jsx: MdxJsxFlowElement | MdxJsxTextElement) => any;
+export declare const getAttrs: <T>(jsx: MdxJsxFlowElement | MdxJsxTextElement) => T;
 /**
  * Gets the children of an MDX element and returns them as an array of Text nodes.
  * Currently only being used by the HTML Block component, which only expects a single text node.
@@ -51,7 +51,7 @@ export declare const getAttrs: <T>(jsx: MdxJsxFlowElement | MdxJsxTextElement) =
  * @param {(MdxJsxFlowElement | MdxJsxTextElement)} jsx
  * @returns {Array} array of child text nodes
  */
-export declare const getChildren: <T>(jsx: MdxJsxFlowElement | MdxJsxTextElement) => any;
+export declare const getChildren: <T>(jsx: MdxJsxFlowElement | MdxJsxTextElement) => T;
 /**
  * Tests if a node is an MDX element.
  * TODO: Make this more extensible to all types of nodes. isElement(node, 'type' or ['type1', 'type2']), say
@@ -83,8 +83,8 @@ export declare const formatHTML: (html: string) => string;
  * @param {number} [indent=2]
  * @returns {string} re-formatted HTML
  */
-export declare const reformatHTML: (html: string, indent?: number) => string;
-export declare const toAttributes: (object: Record<string, any>, keys?: string[]) => MdxJsxAttribute[];
+export declare const reformatHTML: (html: string) => string;
+export declare const toAttributes: (object: Record<string, unknown>, keys?: string[]) => MdxJsxAttribute[];
 /**
  * Checks if a named export exists in the MDX tree. Accepts either an mdast or
  * a hast tree.
@@ -97,5 +97,5 @@ export declare const toAttributes: (object: Record<string, any>, keys?: string[]
  * ```
  *
  */
-export declare const hasNamedExport: (tree: MdastRoot | HastRoot, name: string) => boolean;
+export declare const hasNamedExport: (tree: HastRoot | MdastRoot, name: string) => boolean;
 export declare const getExports: (tree: Root) => string[];

package/dist/utils/user.d.ts

@@ -1,10 +1,10 @@
 interface Default {
-    name: string;
     default: string;
+    name: string;
 }
 export interface Variables {
-    user: Record<string, string>;
     defaults: Default[];
+    user: Record<string, string>;
 }
 declare const User: (variables?: Variables) => Record<string, string>;
 export default User;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@readme/markdown",
   "description": "ReadMe's React-based Markdown parser",
   "author": "Rafe Goldberg <rafe@readme.io>",
-  "version": "8.2.0",
+  "version": "8.3.0",
   "main": "dist/main.node.js",
   "types": "dist/index.d.ts",
   "browser": "dist/main.js",
@@ -41,6 +41,7 @@
     "lodash.kebabcase": "^4.1.1",
     "mdast-util-find-and-replace": "^3.0.1",
     "mdast-util-phrasing": "^4.1.0",
+    "mdast-util-to-markdown": "^2.1.2",
     "path-browserify": "^1.0.1",
     "postcss": "^8.5.1",
     "postcss-prefix-selector": "^2.1.0",
@@ -53,6 +54,8 @@
     "remark-gfm": "^4.0.0",
     "remark-mdx": "^3.0.0",
     "remark-parse": "^11.0.0",
+    "remark-rehype": "^11.1.1",
+    "remark-stringify": "^11.0.0",
     "tailwindcss": "^4.0.3",
     "unified": "^11.0.4",
     "unist-util-flatmap": "^1.0.0",