@readme/markdown 13.7.0 → 13.7.1

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

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

package/dist/processor/transform/mdxish/magic-blocks/types.d.ts

@@ -93,14 +93,18 @@ export interface MagicBlockEmbed {
         hName?: string;
         hProperties?: {
             favicon?: string;
+            height?: string;
             href?: string;
             html?: string;
+            iframe?: boolean;
             image?: string;
             provider?: string;
             providerName?: string;
             providerUrl?: string;
             title?: string;
+            typeOfEmbed?: string;
             url?: string;
+            width?: string;
         };
     };
     position?: Position;

package/dist/processor/transform/mdxish/mdxish-self-closing-blocks.d.ts

@@ -0,0 +1,21 @@
+import type { Parent } from 'mdast';
+import type { Plugin } from 'unified';
+/**
+ * Transform paragraph-wrapped self-closing JSX components into mdxJsxFlowElement nodes.
+ *
+ * CommonMark wraps multi-line JSX in paragraphs when the opening tag isn't complete
+ * on one line. This plugin detects these structures and unwraps them for components
+ * in the SELF_CLOSING_BLOCK_TAGS allowlist.
+ *
+ * Input structure:
+ * ```
+ * paragraph > html: "<Embed\n  typeOfEmbed=\"youtube\"\n/>"
+ * ```
+ *
+ * Output structure:
+ * ```
+ * mdxJsxFlowElement: { name: "Embed", attributes: [...], children: [] }
+ * ```
+ */
+declare const mdxishSelfClosingBlocks: Plugin<[], Parent>;
+export default mdxishSelfClosingBlocks;

package/enums.ts

@@ -0,0 +1,20 @@
+export enum NodeTypes {
+  anchor = 'readme-anchor',
+  callout = 'rdme-callout',
+  codeTabs = 'code-tabs',
+  embedBlock = 'embed-block',
+  emoji = 'gemoji',
+  figcaption = 'figcaption',
+  figure = 'figure',
+  glossary = 'readme-glossary-item',
+  htmlBlock = 'html-block',
+  i = 'i',
+  imageBlock = 'image-block',
+  plain = 'plain',
+  recipe = 'recipe',
+  reusableContent = 'reusable-content',
+  tableau = 'tableau',
+  /** @deprecated Deprecated in favor of `recipe`. */
+  tutorialTile = 'tutorial-tile',
+  variable = 'readme-variable',
+}

package/package.json

@@ -2,14 +2,16 @@
   "name": "@readme/markdown",
   "description": "ReadMe's React-based Markdown parser",
   "author": "Rafe Goldberg <rafe@readme.io>",
-  "version": "13.7.0",
+  "version": "13.7.1",
   "main": "dist/main.node.js",
   "types": "dist/index.d.ts",
   "browser": "dist/main.js",
   "files": [
     "styles",
     "components",
-    "dist"
+    "dist",
+    "types.d.ts",
+    "enums.ts"
   ],
   "scripts": {
     "build": "webpack --mode production && npm run build-types",
@@ -108,18 +110,18 @@
     "@readme/markdown-legacy": "npm:@readme/markdown@^6.87.1",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@testing-library/jest-dom": "^6.4.2",
+    "@testing-library/jest-dom": "^6.9.1",
     "@testing-library/react": "^14",
     "@testing-library/user-event": "^14.5.2",
     "@types/hast": "^3.0.4",
-    "@types/jest": "^29.5.12",
+    "@types/jest": "^30.0.0",
     "@types/mdast": "^4.0.3",
     "@types/mdx": "^2.0.12",
     "@types/unist": "^3.0.2",
     "@vitejs/plugin-react": "^4.2.1",
     "@vitest/coverage-v8": "^4.0.8",
     "@vitest/ui": "^4.0.8",
-    "babel-jest": "^29.5.0",
+    "babel-jest": "^30.3.0",
     "babel-loader": "^9.1.2",
     "browserify-fs": "^1.0.0",
     "codemirror": "^5.54.0",
@@ -128,11 +130,11 @@
     "eslint": "^8.37.0",
     "hast-util-to-text": "^4.0.2",
     "identity-obj-proxy": "^3.0.0",
-    "jest": "^29.5.0",
-    "jest-environment-jsdom": "^29.5.0",
-    "jest-environment-puppeteer": "^8.0.6",
-    "jest-image-snapshot": "^6.4.0",
-    "jest-puppeteer": "^10.1.4",
+    "jest": "^30.3.0",
+    "jest-environment-jsdom": "^30.3.0",
+    "jest-environment-puppeteer": "^11.0.0",
+    "jest-image-snapshot": "^6.5.2",
+    "jest-puppeteer": "^11.0.0",
     "mermaid": "^11.12.0",
     "mini-css-extract-plugin": "^2.7.5",
     "prettier": "^3.2.5",
@@ -167,7 +169,7 @@
       },
       {
         "path": "dist/main.node.js",
-        "maxSize": "835KB"
+        "maxSize": "853KB"
       }
     ]
   },

package/types.d.ts

@@ -0,0 +1,281 @@
+import type { NodeTypes } from './enums';
+import type { Element } from 'hast';
+import type {
+  Code,
+  Data,
+  Literal,
+  Parent,
+  Blockquote,
+  Node,
+  PhrasingContent,
+  Root,
+  Text,
+  Table,
+  BlockContent,
+  Link,
+  RootContent,
+} from 'mdast';
+import type { MdxJsxFlowElementHast } from 'mdast-util-mdx-jsx';
+import type { MDXModule } from 'mdx/types';
+import type { Position } from 'unist';
+
+export type Callout = Omit<Blockquote, 'children' | 'type'> & {
+  children: BlockContent[];
+  data: Data & {
+    hName: 'Callout' | 'rdme-callout';
+    hProperties: {
+      empty?: boolean;
+      icon: string;
+      theme: string;
+    };
+  };
+  type: NodeTypes.callout;
+};
+
+export interface CodeTabs extends Parent {
+  children: Code[];
+  data?: Data & {
+    hName: 'CodeTabs';
+  };
+  type: NodeTypes.codeTabs;
+}
+
+export interface Embed extends Link {
+  title: '@embed';
+}
+
+export interface EmbedBlock extends Node {
+  data: Data & {
+    hName: 'Embed' | 'embed';
+    hProperties: Record<string, unknown> & {
+      favicon?: string;
+      height?:string;
+      href?: string;
+      html?: string;
+      iframe?: boolean;
+      image?: string;
+      provider?:string;
+      providerName?: string;
+      providerUrl?: string;
+      title: string;
+      typeOfEmbed?: string;
+      url: string;
+      width?: string;
+    };
+  };
+  label?: string;
+  title?: string;
+  type: NodeTypes.embedBlock;
+  url?: string;
+}
+
+export interface Figure extends Node {
+  children: [ImageBlock & { url: string }, FigCaption];
+  data: {
+    hName: 'figure';
+  };
+  type: NodeTypes.figure;
+}
+
+export interface FigCaption extends Node {
+  children: BlockContent[];
+  data: {
+    hName: 'figcaption';
+  };
+  type: NodeTypes.figcaption;
+}
+
+export interface HTMLBlock extends Node {
+  children: Text[];
+  data: Data & {
+    hName: 'html-block';
+    hProperties: {
+      html: string;
+      runScripts?: boolean | string;
+      safeMode?: string;
+    };
+  };
+  type: NodeTypes.htmlBlock;
+}
+
+export interface Plain extends Literal {
+  type: NodeTypes.plain;
+}
+
+export type ImageAlign = 'center' | 'left' | 'right';
+
+export interface ImageBlockAttrs {
+  align?: ImageAlign;
+  alt: string;
+  border?: boolean;
+  caption?: string;
+  children?: RootContent[];
+  className?: string;
+  height?: string;
+  lazy?: boolean;
+  sizing?: string;
+  src: string;
+  title: string;
+  width?: string;
+}
+
+export interface ImageBlock extends ImageBlockAttrs, Omit<Parent, 'children'> {
+  data: Data & {
+    hName: 'img';
+    hProperties: ImageBlockAttrs;
+  };
+  type: NodeTypes.imageBlock;
+}
+
+export interface Gemoji extends Node {
+  name: string;
+  type: NodeTypes.emoji;
+  value?: string;
+}
+
+export interface FaEmoji extends Literal {
+  type: NodeTypes.i;
+}
+
+export interface Tableau extends Omit<Table, 'type'> {
+  type: NodeTypes.tableau;
+}
+
+export interface Recipe extends Node {
+  backgroundColor: string;
+  emoji: string;
+  id: string;
+  link: string;
+  slug: string;
+  title: string;
+  // Keeping both types for backwards compatibility
+  type: NodeTypes.recipe | NodeTypes.tutorialTile;
+}
+
+export interface ReusableContent extends Parent {
+  children: RootContent[];
+  tag: string;
+  type: NodeTypes.reusableContent;
+}
+
+export interface Variable extends Node {
+  data: Data & {
+    hName: 'readme-variable' | 'Variable';
+    hProperties: {
+      name: string;
+    };
+  };
+  value: string;
+}
+
+export interface Glossary extends Node {
+  children: [{ type: 'text'; value: string }];
+  data: Data & {
+    hName: 'Glossary';
+    hProperties: { term: string };
+  };
+  position?: Position;
+  type: NodeTypes.glossary;
+}
+
+export interface Anchor extends Node {
+  children: PhrasingContent[];
+  data: Data & {
+    hName: 'Anchor';
+    hProperties: {
+      href: string;
+      label?: string;
+      target?: string;
+      title?: string;
+    };
+  };
+  position?: Position;
+  type: NodeTypes.anchor;
+}
+
+declare module 'mdast' {
+  interface BlockContentMap {
+    [NodeTypes.callout]: Callout;
+    [NodeTypes.codeTabs]: CodeTabs;
+    [NodeTypes.embedBlock]: EmbedBlock;
+    [NodeTypes.figure]: Figure;
+    [NodeTypes.htmlBlock]: HTMLBlock;
+    [NodeTypes.imageBlock]: ImageBlock;
+    [NodeTypes.plain]: Plain;
+    [NodeTypes.recipe]: Recipe;
+    [NodeTypes.reusableContent]: ReusableContent;
+    [NodeTypes.tableau]: Tableau;
+    [NodeTypes.tutorialTile]: Recipe;
+    link: Embed | Link;
+  }
+
+  interface PhrasingContentMap {
+    [NodeTypes.anchor]: Anchor;
+    [NodeTypes.emoji]: Gemoji;
+    [NodeTypes.i]: FaEmoji;
+    [NodeTypes.glossary]: Glossary;
+    [NodeTypes.variable]: Variable;
+    [NodeTypes.plain]: Plain;
+  }
+
+  interface RootContentMap {
+    Link: Embed | Link;
+    [NodeTypes.anchor]: Anchor;
+    [NodeTypes.callout]: Callout;
+    [NodeTypes.codeTabs]: CodeTabs;
+    [NodeTypes.embedBlock]: EmbedBlock;
+    [NodeTypes.emoji]: Gemoji;
+    [NodeTypes.figure]: Figure;
+    [NodeTypes.glossary]: Glossary;
+    [NodeTypes.htmlBlock]: HTMLBlock;
+    [NodeTypes.i]: FaEmoji;
+    [NodeTypes.imageBlock]: ImageBlock;
+    [NodeTypes.plain]: Plain;
+    [NodeTypes.recipe]: Recipe;
+    [NodeTypes.reusableContent]: ReusableContent;
+    [NodeTypes.tableau]: Tableau;
+    [NodeTypes.tutorialTile]: Recipe;
+    [NodeTypes.variable]: Variable;
+  }
+}
+
+interface HastHeading extends Element {
+  depth: number;
+  tagName: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
+}
+
+interface TocList extends Element {
+  children: TocListItem[];
+  tagName: 'ul';
+}
+
+interface Variables {
+  defaults: { default: string; name: string }[];
+  user: Record<string, string>;
+}
+
+interface TocListItem extends Element {
+  children: (TocEntry | TocList)[];
+  tagName: 'li';
+}
+
+interface TocEntry extends Element {
+  children: (Element | Literal)[];
+  tagName: 'a';
+}
+
+type IndexableElements = HastHeading | MdxJsxFlowElementHast;
+
+interface RMDXModule extends MDXModule {
+  Toc: React.FC<Record<string, unknown>> | null;
+  toc: IndexableElements[];
+}
+
+interface CustomComponents extends Record<string, RMDXModule> {}
+
+interface MdastComponents extends Record<string, Root> {}
+
+declare module '*.md' {
+  const content: string;
+  export default content;
+}