@readme/markdown 10.2.7 → 10.2.9

package/components/Callout/index.tsx

@@ -5,7 +5,7 @@ interface Props extends React.PropsWithChildren<React.HTMLAttributes<HTMLQuoteEl
   attributes?: Record<string, unknown>;
   empty?: boolean;
   icon?: string;
-  theme: string;
+  theme?: string;
 }
 
 export const themes: Record<string, string> = {
@@ -36,12 +36,13 @@ export const defaultIcons = {
 };
 
 const Callout = (props: Props) => {
-  const { attributes, theme = 'default', empty } = props;
+  const { attributes, empty } = props;
   const children = React.Children.toArray(props.children);
 
   const icon = props.icon;
   const isEmoji = icon && emojiRegex().test(icon);
   const heading = empty ? <p className={'callout-heading empty'}></p> : children[0];
+  const theme = props.theme || (icon && themes[icon]) || 'default';
 
   return (
     // @ts-expect-error -- theme is not a valid attribute

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

@@ -3,7 +3,7 @@ interface Props extends React.PropsWithChildren<React.HTMLAttributes<HTMLQuoteEl
     attributes?: Record<string, unknown>;
     empty?: boolean;
     icon?: string;
-    theme: string;
+    theme?: string;
 }
 export declare const themes: Record<string, string>;
 export declare const defaultIcons: {

package/dist/enums.d.ts

@@ -10,8 +10,10 @@ export declare enum NodeTypes {
     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/dist/main.js

@@ -10640,11 +10640,12 @@ const defaultIcons = {
     error: '\u2757\uFE0F',
 };
 const Callout = (props) => {
-    const { attributes, theme = 'default', empty } = props;
+    const { attributes, empty } = props;
     const children = external_amd_react_commonjs_react_commonjs2_react_root_React_umd_react_.Children.toArray(props.children);
     const icon = props.icon;
     const isEmoji = icon && emoji_regex().test(icon);
     const heading = empty ? external_amd_react_commonjs_react_commonjs2_react_root_React_umd_react_.createElement("p", { className: 'callout-heading empty' }) : children[0];
+    const theme = props.theme || (icon && themes[icon]) || 'default';
     return (
     // @ts-expect-error -- theme is not a valid attribute
     // eslint-disable-next-line react/jsx-props-no-spreading, react/no-unknown-property
@@ -39644,8 +39645,10 @@ var NodeTypes;
     NodeTypes["i"] = "i";
     NodeTypes["imageBlock"] = "image-block";
     NodeTypes["plain"] = "plain";
+    NodeTypes["recipe"] = "recipe";
     NodeTypes["reusableContent"] = "reusable-content";
     NodeTypes["tableau"] = "tableau";
+    /** @deprecated Deprecated in favor of `recipe`. */
     NodeTypes["tutorialTile"] = "tutorial-tile";
     NodeTypes["variable"] = "readme-variable";
 })(NodeTypes || (NodeTypes = {}));
@@ -51525,13 +51528,6 @@ const findFirst = (node) => {
         return node;
     return null;
 };
-const findLast = (node) => {
-    if ('children' in node && Array.isArray(node.children))
-        return findFirst(node.children[node.children.length - 1]);
-    if (node.type === 'text')
-        return node;
-    return null;
-};
 const wrapHeading = (node) => {
     const firstChild = node.children[0];
     return {
@@ -51539,8 +51535,8 @@ const wrapHeading = (node) => {
         depth: 3,
         children: ('children' in firstChild ? firstChild.children : []),
         position: {
-            start: findFirst(firstChild)?.position.start,
-            end: findLast(firstChild)?.position.end,
+            start: firstChild.position.start,
+            end: firstChild.position.end,
         },
     };
 };
@@ -51562,6 +51558,11 @@ const calloutTransformer = () => {
                 }
                 if (heading) {
                     node.children[0] = wrapHeading(node);
+                    // @note: We add to the offset/column the length of the unicode
+                    // character that was stripped off, so that the start position of the
+                    // heading/text matches where it actually starts.
+                    node.children[0].position.start.offset += match.length;
+                    node.children[0].position.start.column += match.length;
                 }
                 Object.assign(node, {
                     type: NodeTypes.callout,
@@ -51658,7 +51659,7 @@ const compatibilityTransfomer = () => tree => {
 ;// ./processor/transform/div.ts
 
 
-// This transformer has been necessary for migrating legacy markdown files 
+// This transformer has been necessary for migrating legacy markdown files
 // where tutorial tiles were wrapped in a div. It also provides a fallback for legacy magic blocks that were never fully supported:
 //     [block:custom-block]
 //     { ... }
@@ -51676,7 +51677,7 @@ const divTransformer = () => tree => {
                     const { hName, hProperties, ...rest } = node.data;
                     const tile = {
                         ...rest,
-                        type: NodeTypes.tutorialTile,
+                        type: NodeTypes.recipe,
                     };
                     parent.children.splice(index, 1, tile);
                 }
@@ -69173,7 +69174,8 @@ const types = {
     HTMLBlock: NodeTypes.htmlBlock,
     Table: 'table',
     Variable: NodeTypes.variable,
-    TutorialTile: NodeTypes.tutorialTile,
+    Recipe: NodeTypes.recipe,
+    TutorialTile: NodeTypes.recipe, // coerce to recipe for backwards compatibility
 };
 var TableNames;
 (function (TableNames) {
@@ -69557,7 +69559,7 @@ const visitor = (table, index, parent) => {
         visit(cell, 'break', (_, breakIndex, breakParent) => {
             breakParent.children.splice(breakIndex, 1, { type: 'text', value: '\n' });
         });
-        if (!phrasing(content) && content.type !== 'escape') {
+        if (!(phrasing(content) || content.type === 'plain') && content.type !== 'escape') {
             hasFlowContent = true;
             return EXIT;
         }
@@ -89598,8 +89600,8 @@ const makeUseMDXComponents = (more = {}) => {
         'html-block': components_HTMLBlock,
         'image-block': components_Image,
         'table-of-contents': components_TableOfContents,
-        // Ensures backwards compatibility with historical TutoirialTile component
-        'TutorialTile': components_Recipe,
+        // Ensures backwards compatibility with historical TutorialTile component
+        TutorialTile: components_Recipe,
         ...headings,
         ...more,
     };

package/dist/main.node.js

@@ -16196,11 +16196,12 @@ const defaultIcons = {
     error: '\u2757\uFE0F',
 };
 const Callout = (props) => {
-    const { attributes, theme = 'default', empty } = props;
+    const { attributes, empty } = props;
     const children = external_amd_react_commonjs_react_commonjs2_react_root_React_umd_react_.Children.toArray(props.children);
     const icon = props.icon;
     const isEmoji = icon && emoji_regex().test(icon);
     const heading = empty ? external_amd_react_commonjs_react_commonjs2_react_root_React_umd_react_.createElement("p", { className: 'callout-heading empty' }) : children[0];
+    const theme = props.theme || (icon && themes[icon]) || 'default';
     return (
     // @ts-expect-error -- theme is not a valid attribute
     // eslint-disable-next-line react/jsx-props-no-spreading, react/no-unknown-property
@@ -57727,8 +57728,10 @@ var NodeTypes;
     NodeTypes["i"] = "i";
     NodeTypes["imageBlock"] = "image-block";
     NodeTypes["plain"] = "plain";
+    NodeTypes["recipe"] = "recipe";
     NodeTypes["reusableContent"] = "reusable-content";
     NodeTypes["tableau"] = "tableau";
+    /** @deprecated Deprecated in favor of `recipe`. */
     NodeTypes["tutorialTile"] = "tutorial-tile";
     NodeTypes["variable"] = "readme-variable";
 })(NodeTypes || (NodeTypes = {}));
@@ -69608,13 +69611,6 @@ const findFirst = (node) => {
         return node;
     return null;
 };
-const findLast = (node) => {
-    if ('children' in node && Array.isArray(node.children))
-        return findFirst(node.children[node.children.length - 1]);
-    if (node.type === 'text')
-        return node;
-    return null;
-};
 const wrapHeading = (node) => {
     const firstChild = node.children[0];
     return {
@@ -69622,8 +69618,8 @@ const wrapHeading = (node) => {
         depth: 3,
         children: ('children' in firstChild ? firstChild.children : []),
         position: {
-            start: findFirst(firstChild)?.position.start,
-            end: findLast(firstChild)?.position.end,
+            start: firstChild.position.start,
+            end: firstChild.position.end,
         },
     };
 };
@@ -69645,6 +69641,11 @@ const calloutTransformer = () => {
                 }
                 if (heading) {
                     node.children[0] = wrapHeading(node);
+                    // @note: We add to the offset/column the length of the unicode
+                    // character that was stripped off, so that the start position of the
+                    // heading/text matches where it actually starts.
+                    node.children[0].position.start.offset += match.length;
+                    node.children[0].position.start.column += match.length;
                 }
                 Object.assign(node, {
                     type: NodeTypes.callout,
@@ -69741,7 +69742,7 @@ const compatibilityTransfomer = () => tree => {
 ;// ./processor/transform/div.ts
 
 
-// This transformer has been necessary for migrating legacy markdown files 
+// This transformer has been necessary for migrating legacy markdown files
 // where tutorial tiles were wrapped in a div. It also provides a fallback for legacy magic blocks that were never fully supported:
 //     [block:custom-block]
 //     { ... }
@@ -69759,7 +69760,7 @@ const divTransformer = () => tree => {
                     const { hName, hProperties, ...rest } = node.data;
                     const tile = {
                         ...rest,
-                        type: NodeTypes.tutorialTile,
+                        type: NodeTypes.recipe,
                     };
                     parent.children.splice(index, 1, tile);
                 }
@@ -87256,7 +87257,8 @@ const readme_components_types = {
     HTMLBlock: NodeTypes.htmlBlock,
     Table: 'table',
     Variable: NodeTypes.variable,
-    TutorialTile: NodeTypes.tutorialTile,
+    Recipe: NodeTypes.recipe,
+    TutorialTile: NodeTypes.recipe, // coerce to recipe for backwards compatibility
 };
 var TableNames;
 (function (TableNames) {
@@ -87640,7 +87642,7 @@ const visitor = (table, index, parent) => {
         visit(cell, 'break', (_, breakIndex, breakParent) => {
             breakParent.children.splice(breakIndex, 1, { type: 'text', value: '\n' });
         });
-        if (!phrasing(content) && content.type !== 'escape') {
+        if (!(phrasing(content) || content.type === 'plain') && content.type !== 'escape') {
             hasFlowContent = true;
             return EXIT;
         }
@@ -107681,8 +107683,8 @@ const makeUseMDXComponents = (more = {}) => {
         'html-block': components_HTMLBlock,
         'image-block': components_Image,
         'table-of-contents': components_TableOfContents,
-        // Ensures backwards compatibility with historical TutoirialTile component
-        'TutorialTile': components_Recipe,
+        // Ensures backwards compatibility with historical TutorialTile component
+        TutorialTile: components_Recipe,
         ...headings,
         ...more,
     };