rehype-og-card 2.0.1 → 3.0.0

package/README.md

@@ -63,7 +63,7 @@ Output (formatted for readability):
 ```html
 <p>this is a link: https://blog.google/products/android/world-emoji-day-2024/</p>
 <p><code>https://blog.google/products/android/world-emoji-day-2024/</code></p>
-<p><div class="og-card-container">
+<div class="og-card-container">
     <a href="https://blog.google/products/android/world-emoji-day-2024/">
         <div class="og-card-info">
             <div class="og-card-title">10 fun facts about emoji for World Emoji Day</div>
@@ -77,7 +77,7 @@ Output (formatted for readability):
             <img class="og-card-image" alt="https://storage.googleapis.com/gweb-uniblog-publish-prod/images/world_emoji_day_v2_1.width-1300.png" decoding="async" loading="lazy" src="https://storage.googleapis.com/gweb-uniblog-publish-prod/images/world_emoji_day_v2_1.width-1300.png">
         </div>
     </a>
-</div></p>
+</div>
 <p><a href="https://blog.google/products/android/world-emoji-day-2024/">https://blog.google/products/android/world-emoji-day-2024/</a></p>
 <p><a href="https://blog.google/products/android/world-emoji-day-2024/">Google blog</a></p>
 ```
@@ -128,7 +128,7 @@ Expiration is calculated using the cached timestamp stored in the cache itself.
 User agent to use for fetching the OG metadata and images.
 
 - Type: `string`
-- Default: `"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36"`
+- Default: `"Mozilla/5.0 (compatible; rehype-og-card/2.0; +https://github.com/Robot-Inventor/rehype-og-card/; purpose=link-preview; twitterbot-compatible)"`
 
 ### `decoding`
 
@@ -165,6 +165,13 @@ Whether to open the link in a new tab.
 - Type: `boolean`
 - Default: `false`
 
+### `removeParentPTag`
+
+Whether to remove the parent `<p>` tag that contains only the bare link.
+
+- Type: `boolean`
+- Default: `true`
+
 ### `serverCache`
 
 Whether to cache the OG data on the server.

package/dist/index.js

@@ -13,12 +13,13 @@ const DEFAULT_OPTIONS = {
     buildCache: false,
     buildCacheMaxAge: DEFAULT_CACHE_MAX_AGE_MS,
     buildCachePath: "./node_modules/.cache",
-    crawlerUserAgent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36",
+    crawlerUserAgent: "Mozilla/5.0 (compatible; rehype-og-card/2.0; +https://github.com/Robot-Inventor/rehype-og-card/; purpose=link-preview; twitterbot-compatible)",
     decoding: "async",
     enableSameTextURLConversion: false,
     excludeDomains: [],
     loading: "lazy",
     openInNewTab: false,
+    removeParentPTag: true,
     serverCache: true,
     serverCacheMaxAge: DEFAULT_CACHE_MAX_AGE_MS,
     serverCachePath: "./public",
@@ -94,7 +95,7 @@ const rehypeOGCard = (options) => {
             const targetURL = new URL(anchorNode.properties.href);
             if (mergedOptions.excludeDomains.includes(targetURL.hostname))
                 return;
-            // eslint-disable-next-line jsdoc/require-jsdoc, max-statements, max-lines-per-function
+            // eslint-disable-next-line jsdoc/require-jsdoc, max-statements, max-lines-per-function, complexity
             const linkCardPromise = async () => {
                 let OGData = mergedOptions.buildCache
                     ? await restoreOGDataBuildCache(anchorNode.properties.href, mergedOptions.buildCachePath, mergedOptions.buildCacheMaxAge)
@@ -144,12 +145,18 @@ const rehypeOGCard = (options) => {
                     OGData.displayURL = shortenedURL.hostname;
                 }
                 const OGCard = createOGCard(OGData, mergedOptions);
-                const index = parent.children.indexOf(node);
+                const { removeParentPTag: shouldRemoveParentPTag } = mergedOptions;
+                // eslint-disable-next-line no-magic-numbers
+                const replacementContainer = shouldRemoveParentPTag ? ancestors[ancestors.length - 2] : parent;
+                const replacementTarget = shouldRemoveParentPTag ? parent : node;
+                if (!replacementContainer || !("children" in replacementContainer))
+                    return;
+                const index = replacementContainer.children.indexOf(replacementTarget);
                 // eslint-disable-next-line no-magic-numbers
                 if (index === -1)
                     return;
                 // eslint-disable-next-line no-magic-numbers
-                parent.children.splice(index, 1, OGCard);
+                replacementContainer.children.splice(index, 1, OGCard);
             };
             linkCardPromises.push(linkCardPromise());
         });

package/dist/types.d.ts

@@ -23,6 +23,11 @@ interface RehypeOGCardOptions {
      * @default false
      */
     openInNewTab?: boolean;
+    /**
+     * Whether to remove the parent `<p>` tag that contains only the bare link.
+     * @default true
+     */
+    removeParentPTag?: boolean;
     /**
      * Whether to enable converting the links
      * that have the same URL and text (e.g., `[https://example.com](https://example.com)`).
@@ -69,7 +74,7 @@ interface RehypeOGCardOptions {
     buildCacheMaxAge?: number | false;
     /**
      * User agent to use for fetching the OG metadata and images.
-     * @default "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36"
+     * @default "Mozilla/5.0 (compatible; rehype-og-card/2.0; +https://github.com/Robot-Inventor/rehype-og-card/; purpose=link-preview; twitterbot-compatible)"
      */
     crawlerUserAgent?: string;
 }

package/dist/util/network.js

@@ -46,10 +46,8 @@ const getOGData = async (url, userAgent) => {
         });
         const OGImage = result.ogImage ? result.ogImage[0] : null;
         const OGImageURL = resolveAbsoluteURL(OGImage?.url, url);
-        const faviconURL = result.favicon
-            ? `https://www.google.com/s2/favicons?domain=${new URL(url).hostname}`
-            : // eslint-disable-next-line no-undefined
-                undefined;
+        const resolvedFaviconURL = result.favicon ? resolveAbsoluteURL(result.favicon, url) : null;
+        const faviconURL = resolvedFaviconURL ?? `https://www.google.com/s2/favicons?domain=${new URL(url).hostname}`;
         return {
             OGImageAlt: OGImage?.alt,
             OGImageHeight: OGImage?.height,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rehype-og-card",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "description": "Rehype plugin to convert text links to link cards",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",