rehype-og-card 0.2.1 → 0.3.1

package/README.md

@@ -2,20 +2,20 @@
 
 Rehype plugin to convert text links to link cards inspired by [remark-link-card](https://github.com/gladevise/remark-link-card). Bare links are converted to link cards, but not links in lists or non-bare links.
 
-| Features                                       |                                     remark-link-card                                      |      rehype-og-card       |
-| :--------------------------------------------- | :---------------------------------------------------------------------------------------: | :-----------------------: |
-| Plugin type                                    |                                          Remark                                           |          Rehype           |
-| TypeScript support                             |                                             ❌                                             |             ✅             |
-| Convert bare links to link cards               |                                             ✅                                             |             ✅             |
-| Shorten URLs displayed on link cards           |                                             ✅                                             |             ✅             |
-| Server-side cache for images                   |                                             ✅                                             |             ✅             |
-| Cache images with long URLs                    | ❌ ([implemented](https://github.com/gladevise/remark-link-card/pull/16) but not released) |             ✅             |
-| Build cache for Open Graph metadata and images |                                             ❌                                             | Planned to be implemented |
-| Exclude links in lists from conversion         |                                             ❌                                             |             ✅             |
-| Exclude specific domains from conversion       |                                             ❌                                             |             ✅             |
-| Lazy loading images                            |                                             ❌                                             |             ✅             |
-| Async decoding images                          |                                             ❌                                             |             ✅             |
-| Customize the crawler's user agent string      |                                             ❌                                             |             ✅             |
+| Features                                       |                                     remark-link-card                                      | rehype-og-card |
+| :--------------------------------------------- | :---------------------------------------------------------------------------------------: | :------------: |
+| Plugin type                                    |                                          Remark                                           |     Rehype     |
+| TypeScript support                             |                                             ❌                                             |       ✅        |
+| Convert bare links to link cards               |                                             ✅                                             |       ✅        |
+| Shorten URLs displayed on link cards           |                                             ✅                                             |       ✅        |
+| Server-side cache for images                   |                                             ✅                                             |       ✅        |
+| Cache images with long URLs                    | ❌ ([implemented](https://github.com/gladevise/remark-link-card/pull/16) but not released) |       ✅        |
+| Build cache for Open Graph metadata and images |                                             ❌                                             | ✅ (image only) |
+| Exclude links in lists from conversion         |                                             ❌                                             |       ✅        |
+| Exclude specific domains from conversion       |                                             ❌                                             |       ✅        |
+| Lazy loading images                            |                                             ❌                                             |       ✅        |
+| Async decoding images                          |                                             ❌                                             |       ✅        |
+| Customize the crawler's user agent string      |                                             ❌                                             |       ✅        |
 
 ## Installation
 
@@ -101,6 +101,20 @@ The following links will NOT be converted to link cards:
 
 All options are optional.
 
+### `buildCache`
+
+Whether to cache the OG metadata and images for the next build. `buildCache` option requires `serverCache` option to be enabled.
+
+- Type: `boolean`
+- Default: `false`
+
+### `buildCachePath`
+
+Path to save the build cache. For Astro projects, specify the `./node_modules/.astro` directory.
+
+- Type: `string`
+- Default: `"./.cache/og-card"`
+
 ### `crawlerUserAgent`
 
 User agent to use for fetching the OG metadata and images.
@@ -145,7 +159,7 @@ Whether to cache the OG data on the server.
 
 ### `serverCachePath`
 
-Path to save the server cache.
+Path to save the server cache. Specify the directory whose contents will be copied to the root. For example, for an Astro project, specify the `public` directory.
 
 - Type: `string`
 - Default: `"./public"`

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { RehypeOGCardOptions } from "./util.js";
 import type { Plugin } from "unified";
+import { RehypeOGCardOptions } from "./types.js";
 import type { Root } from "hast";
 /**
  * Rehype plugin to create OG card from bare links.

package/dist/index.js

@@ -7,11 +7,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { convertTextToAnchorElement, createOGCard, downloadImage, getOGData, isAnchorElement, isTextNode, isValidURL } from "./util.js";
+import { convertTextToAnchorElement, downloadImage, isAnchorElement, isTextNode, isValidURL } from "./util.js";
+import { createOGCard, getOGData } from "./openGraphUtil.js";
+import { restoreBuildCache, saveBuildCache } from "./util/cache.js";
 import { isElement } from "hast-util-is-element";
 import path from "path";
 import { visitParents } from "unist-util-visit-parents";
 const DEFAULT_OPTIONS = {
+    buildCache: false,
+    buildCachePath: "./node_modules/.cache",
     crawlerUserAgent: 
     // eslint-disable-next-line max-len
     "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36",
@@ -31,13 +35,20 @@ const DEFAULT_OPTIONS = {
 // eslint-disable-next-line max-lines-per-function
 const rehypeOGCard = (options) => {
     const mergedOptions = Object.assign(Object.assign({}, DEFAULT_OPTIONS), options);
+    if (mergedOptions.buildCache && !mergedOptions.serverCache) {
+        throw new Error("[rehype-og-card] `buildCache` option requires `serverCache` option to be enabled.");
+    }
     mergedOptions.serverCachePath = path.posix.join(mergedOptions.serverCachePath, "./rehype-og-card/");
+    mergedOptions.buildCachePath = path.posix.join(mergedOptions.buildCachePath, "./rehype-og-card/");
     /**
      * Transform function to create OG card from bare links.
      * @param tree Root node of the HAST tree.
      */
     // eslint-disable-next-line max-lines-per-function
     const transform = (tree) => __awaiter(void 0, void 0, void 0, function* () {
+        if (mergedOptions.buildCache) {
+            yield restoreBuildCache(mergedOptions.buildCachePath, mergedOptions.serverCachePath);
+        }
         const linkCardPromises = [];
         // eslint-disable-next-line max-statements, max-lines-per-function
         visitParents(tree, ["element", "text"], (node, ancestors) => {
@@ -80,14 +91,22 @@ const rehypeOGCard = (options) => {
                 if (!OGData)
                     return;
                 if (OGData.OGImageURL && mergedOptions.serverCache) {
-                    const filename = yield downloadImage(OGData.OGImageURL, mergedOptions.serverCachePath, mergedOptions.crawlerUserAgent);
-                    if (filename) {
+                    const filename = yield downloadImage({
+                        directly: mergedOptions.serverCachePath,
+                        url: OGData.OGImageURL,
+                        userAgent: mergedOptions.crawlerUserAgent
+                    });
+                    if (filename && mergedOptions.serverCache) {
                         OGData.OGImageURL = path.posix.join("/rehype-og-card", filename);
                     }
                 }
                 if (OGData.faviconURL && mergedOptions.serverCache) {
-                    const filename = yield downloadImage(OGData.faviconURL, mergedOptions.serverCachePath, mergedOptions.crawlerUserAgent);
-                    if (filename) {
+                    const filename = yield downloadImage({
+                        directly: mergedOptions.serverCachePath,
+                        url: OGData.faviconURL,
+                        userAgent: mergedOptions.crawlerUserAgent
+                    });
+                    if (filename && mergedOptions.serverCache) {
                         OGData.faviconURL = path.posix.join("/rehype-og-card", filename);
                     }
                 }
@@ -107,6 +126,9 @@ const rehypeOGCard = (options) => {
             linkCardPromises.push(linkCardPromise());
         });
         yield Promise.all(linkCardPromises);
+        if (mergedOptions.buildCache) {
+            yield saveBuildCache(mergedOptions.serverCachePath, mergedOptions.buildCachePath);
+        }
     });
     return transform;
 };

package/dist/openGraphUtil.d.ts

@@ -0,0 +1,31 @@
+import type { Element } from "hast";
+import { RehypeOGCardOptions } from "./types.js";
+interface OGCardData {
+    url: string;
+    title: string;
+    description?: string;
+    displayURL: string;
+    faviconURL?: string;
+    OGImageURL?: string;
+    OGImageAlt?: string;
+    OGImageWidth?: number;
+    OGImageHeight?: number;
+}
+/**
+ * Get OG card data from given URL.
+ * @param url URL to get OG card data.
+ * @param userAgent User agent to use for fetching.
+ * @returns OG card data.
+ */
+declare const getOGData: (url: string, userAgent: string) => Promise<OGCardData | null>;
+/**
+ * Create OG card element from given data.
+ * @param data Data to create OG card.
+ * @param options Options to create OG card.
+ * @returns OG card element.
+ */
+declare const createOGCard: (data: OGCardData, options: Required<{
+    loading: RehypeOGCardOptions["loading"];
+    decoding: RehypeOGCardOptions["decoding"];
+}>) => Element;
+export { OGCardData, createOGCard, getOGData };

package/dist/openGraphUtil.js

@@ -0,0 +1,91 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { h } from "hastscript";
+import scraper from "open-graph-scraper";
+/**
+ * Get OG card data from given URL.
+ * @param url URL to get OG card data.
+ * @param userAgent User agent to use for fetching.
+ * @returns OG card data.
+ */
+const getOGData = (url, userAgent) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const { result } = yield scraper({
+            fetchOptions: {
+                headers: {
+                    "user-agent": userAgent
+                }
+            },
+            url
+        });
+        const OGImage = result.ogImage ? result.ogImage[0] : null;
+        const faviconURL = result.favicon
+            ? `https://www.google.com/s2/favicons?domain=${new URL(url).hostname}`
+            : // eslint-disable-next-line no-undefined
+                undefined;
+        return {
+            OGImageAlt: OGImage === null || OGImage === void 0 ? void 0 : OGImage.alt,
+            OGImageHeight: OGImage === null || OGImage === void 0 ? void 0 : OGImage.height,
+            OGImageURL: OGImage === null || OGImage === void 0 ? void 0 : OGImage.url,
+            OGImageWidth: OGImage === null || OGImage === void 0 ? void 0 : OGImage.width,
+            description: result.ogDescription,
+            displayURL: url,
+            faviconURL,
+            title: result.ogTitle || url,
+            url
+        };
+    }
+    catch (error) {
+        // eslint-disable-next-line no-console
+        console.error("[rehype-og-card] Error fetching OG data:", error);
+        return null;
+    }
+});
+/**
+ * Create OG card element from given data.
+ * @param data Data to create OG card.
+ * @param options Options to create OG card.
+ * @returns OG card element.
+ */
+const createOGCard = (data, options) => {
+    const card = h("div.og-card-container", [
+        h("a", { href: data.url }, [
+            h("div.og-card-info", [
+                h("div.og-card-title", data.title),
+                data.description ? h("div.og-card-description", data.description) : null,
+                h("div.og-card-url-container", [
+                    h("img.og-card-favicon", {
+                        alt: "favicon",
+                        decoding: options.decoding,
+                        height: 16,
+                        loading: options.loading,
+                        src: data.faviconURL,
+                        width: 16
+                    }),
+                    h("span.og-card-url", data.displayURL)
+                ])
+            ]),
+            data.OGImageURL
+                ? h("div.og-card-image-container", [
+                    h("img.og-card-image", {
+                        alt: data.OGImageAlt || data.OGImageURL,
+                        decoding: options.decoding,
+                        height: data.OGImageHeight,
+                        loading: options.loading,
+                        src: data.OGImageURL,
+                        width: data.OGImageWidth
+                    })
+                ])
+                : null
+        ])
+    ]);
+    return card;
+};
+export { createOGCard, getOGData };

package/dist/types.d.ts

@@ -0,0 +1,57 @@
+interface RehypeOGCardOptions {
+    /**
+     * Domains to exclude from conversion.
+     */
+    excludeDomains?: string[];
+    /**
+     * `decoding` attribute of the image element.
+     * @default "async"
+     */
+    decoding?: HTMLImageElement["decoding"];
+    /**
+     * `loading` attribute of the image element.
+     * @default "lazy"
+     */
+    loading?: HTMLImageElement["loading"];
+    /**
+     * Whether to shorten the displayed URL.
+     * @default true
+     */
+    shortenURL?: boolean;
+    /**
+     * Whether to enable converting the links
+     * that have the same URL and text (e.g., `[https://example.com](https://example.com)`).
+     * @default false
+     */
+    enableSameTextURLConversion?: boolean;
+    /**
+     * Whether to cache the OG data on the server.
+     * @default true
+     */
+    serverCache?: boolean;
+    /**
+     * Path to save the server cache.
+     * Specify the directory whose contents will be copied to the root.
+     * For example, for an Astro project, specify the `public` directory.
+     * @default "./public"
+     */
+    serverCachePath?: string;
+    /**
+     * Whether to cache the OG metadata and images for the next build.
+     * `buildCache` option requires `serverCache` option to be enabled.
+     * @default false
+     */
+    buildCache?: boolean;
+    /**
+     * Path to save the build cache.
+     * For Astro projects, specify the `./node_modules/.astro` directory.
+     * @default "./node_modules/.cache"
+     */
+    buildCachePath?: string;
+    /**
+     * 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"
+     */
+    crawlerUserAgent?: string;
+}
+export { RehypeOGCardOptions };

package/dist/types.js

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

package/dist/util/cache.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Save build cache if server cache exists.
+ * @param serverCachePath Server cache path.
+ * @param buildCachePath Build cache path.
+ */
+declare const saveBuildCache: (serverCachePath: string, buildCachePath: string) => Promise<void>;
+/**
+ * Restore build cache if it exists.
+ * @param buildCachePath Build cache path.
+ * @param serverCachePath Server cache path.
+ */
+declare const restoreBuildCache: (buildCachePath: string, serverCachePath: string) => Promise<void>;
+export { saveBuildCache, restoreBuildCache };

package/dist/util/cache.js

@@ -0,0 +1,52 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { checkFileExists } from "../util.js";
+import fs from "fs/promises";
+import path from "path";
+/**
+ * Copy directory from source to destination.
+ * @param source Source directory.
+ * @param destination Destination directory.
+ */
+// eslint-disable-next-line max-statements
+const copyDirectory = (source, destination) => __awaiter(void 0, void 0, void 0, function* () {
+    const sourceExists = yield checkFileExists(source);
+    if (!sourceExists)
+        return;
+    const destinationExists = yield checkFileExists(destination);
+    if (!destinationExists) {
+        yield fs.mkdir(destination, { recursive: true });
+    }
+    const files = yield fs.readdir(source);
+    const promises = [];
+    for (const file of files) {
+        const sourceFile = path.join(source, file);
+        const destFile = path.join(destination, file);
+        promises.push(fs.copyFile(sourceFile, destFile));
+    }
+    yield Promise.all(promises);
+});
+/**
+ * Save build cache if server cache exists.
+ * @param serverCachePath Server cache path.
+ * @param buildCachePath Build cache path.
+ */
+const saveBuildCache = (serverCachePath, buildCachePath) => __awaiter(void 0, void 0, void 0, function* () {
+    yield copyDirectory(serverCachePath, buildCachePath);
+});
+/**
+ * Restore build cache if it exists.
+ * @param buildCachePath Build cache path.
+ * @param serverCachePath Server cache path.
+ */
+const restoreBuildCache = (buildCachePath, serverCachePath) => __awaiter(void 0, void 0, void 0, function* () {
+    yield copyDirectory(buildCachePath, serverCachePath);
+});
+export { saveBuildCache, restoreBuildCache };

package/dist/util.d.ts

@@ -1,46 +1,4 @@
 import type { Element, ElementContent, Text } from "hast";
-interface RehypeOGCardOptions {
-    /**
-     * Domains to exclude from conversion.
-     */
-    excludeDomains?: string[];
-    /**
-     * `decoding` attribute of the image element.
-     * @default "async"
-     */
-    decoding?: HTMLImageElement["decoding"];
-    /**
-     * `loading` attribute of the image element.
-     * @default "lazy"
-     */
-    loading?: HTMLImageElement["loading"];
-    /**
-     * Whether to shorten the displayed URL.
-     * @default true
-     */
-    shortenURL?: boolean;
-    /**
-     * Whether to enable converting the links
-     * that have the same URL and text (e.g., `[https://example.com](https://example.com)`).
-     * @default false
-     */
-    enableSameTextURLConversion?: boolean;
-    /**
-     * Whether to cache the OG data on the server.
-     * @default true
-     */
-    serverCache?: boolean;
-    /**
-     * Path to save the server cache.
-     * @default "./public"
-     */
-    serverCachePath?: string;
-    /**
-     * 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"
-     */
-    crawlerUserAgent?: string;
-}
 interface AnchorElement extends Element {
     tagName: "a";
     properties: {
@@ -65,46 +23,36 @@ declare const isAnchorElement: (node: unknown) => node is AnchorElement;
  * @returns `true` if the URL is valid, `false` otherwise.
  */
 declare const isValidURL: (url: string) => boolean;
-interface OGCardData {
-    url: string;
-    title: string;
-    description?: string;
-    displayURL: string;
-    faviconURL?: string;
-    OGImageURL?: string;
-    OGImageAlt?: string;
-    OGImageWidth?: number;
-    OGImageHeight?: number;
-}
-/**
- * Get OG card data from given URL.
- * @param url URL to get OG card data.
- * @param userAgent User agent to use for fetching.
- * @returns OG card data.
- */
-declare const getOGData: (url: string, userAgent: string) => Promise<OGCardData | null>;
-/**
- * Create OG card element from given data.
- * @param data Data to create OG card.
- * @param options Options to create OG card.
- * @returns OG card element.
- */
-declare const createOGCard: (data: OGCardData, options: Required<{
-    loading: RehypeOGCardOptions["loading"];
-    decoding: RehypeOGCardOptions["decoding"];
-}>) => Element;
 /**
  * Convert text node to anchor element. **This function does not check if the text is a valid URL.**
  * @param text Text node to convert.
  * @returns Anchor element.
  */
 declare const convertTextToAnchorElement: (text: Text) => AnchorElement;
+/**
+ * Check if the file exists.
+ * @param filePath Path to check.
+ * @returns `true` if the file exists, `false` otherwise.
+ */
+declare const checkFileExists: (filePath: string) => Promise<boolean>;
+interface DownloadImageOptions {
+    /**
+     * URL to download image.
+     */
+    url: string;
+    /**
+     * Directory to save the downloaded image.
+     */
+    directly: string;
+    /**
+     * User agent to use for fetching the image.
+     */
+    userAgent: string;
+}
 /**
  * Download image from given URL.
- * @param url URL to download image.
- * @param directly Path to save the image.
- * @param userAgent User agent to use for fetching.
+ * @param options Options to download image.
  * @returns Path to the downloaded image.
  */
-declare const downloadImage: (url: string, directly: string, userAgent: string) => Promise<string | null>;
-export { AnchorElement, RehypeOGCardOptions, OGCardData, isTextNode, isAnchorElement, isValidURL, getOGData, createOGCard, convertTextToAnchorElement, downloadImage };
+declare const downloadImage: (options: DownloadImageOptions) => Promise<string | null>;
+export { AnchorElement, isTextNode, isAnchorElement, isValidURL, convertTextToAnchorElement, checkFileExists, downloadImage };

package/dist/util.js

@@ -9,10 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { createHash } from "crypto";
 import fs from "fs/promises";
-import { h } from "hastscript";
 import { isElement } from "hast-util-is-element";
 import path from "path";
-import scraper from "open-graph-scraper";
 /**
  * Check if the node is a text node.
  * @param node Node to check.
@@ -40,85 +38,6 @@ const isValidURL = (url) => {
         return false;
     }
 };
-/**
- * Get OG card data from given URL.
- * @param url URL to get OG card data.
- * @param userAgent User agent to use for fetching.
- * @returns OG card data.
- */
-const getOGData = (url, userAgent) => __awaiter(void 0, void 0, void 0, function* () {
-    try {
-        const { result } = yield scraper({
-            fetchOptions: {
-                headers: {
-                    "user-agent": userAgent
-                }
-            },
-            url
-        });
-        const OGImage = result.ogImage ? result.ogImage[0] : null;
-        const faviconURL = result.favicon
-            ? `https://www.google.com/s2/favicons?domain=${new URL(url).hostname}`
-            : // eslint-disable-next-line no-undefined
-                undefined;
-        return {
-            OGImageAlt: OGImage === null || OGImage === void 0 ? void 0 : OGImage.alt,
-            OGImageHeight: OGImage === null || OGImage === void 0 ? void 0 : OGImage.height,
-            OGImageURL: OGImage === null || OGImage === void 0 ? void 0 : OGImage.url,
-            OGImageWidth: OGImage === null || OGImage === void 0 ? void 0 : OGImage.width,
-            description: result.ogDescription,
-            displayURL: url,
-            faviconURL,
-            title: result.ogTitle || url,
-            url
-        };
-    }
-    catch (error) {
-        // eslint-disable-next-line no-console
-        console.error("[rehype-og-card] Error fetching OG data:", error);
-        return null;
-    }
-});
-/**
- * Create OG card element from given data.
- * @param data Data to create OG card.
- * @param options Options to create OG card.
- * @returns OG card element.
- */
-const createOGCard = (data, options) => {
-    const card = h("div.og-card-container", [
-        h("a", { href: data.url }, [
-            h("div.og-card-info", [
-                h("div.og-card-title", data.title),
-                data.description ? h("div.og-card-description", data.description) : null,
-                h("div.og-card-url-container", [
-                    h("img.og-card-favicon", {
-                        alt: "favicon",
-                        decoding: options.decoding,
-                        height: 16,
-                        loading: options.loading,
-                        src: data.faviconURL,
-                        width: 16
-                    }),
-                    h("span.og-card-url", data.displayURL)
-                ])
-            ]),
-            data.OGImageURL
-                ? h("div.og-card-image-container", [
-                    h("img.og-card-image", {
-                        alt: data.OGImageAlt || data.OGImageURL,
-                        decoding: options.decoding,
-                        height: data.OGImageHeight,
-                        loading: options.loading,
-                        src: data.OGImageURL,
-                        width: data.OGImageWidth
-                    })
-                ])
-                : null
-        ])
-    ]);
-    return card;
-};
 /**
  * Convert text node to anchor element. **This function does not check if the text is a valid URL.**
  * @param text Text node to convert.
@@ -132,32 +51,49 @@ const convertTextToAnchorElement = (text) => ({
     tagName: "a",
     type: "element"
 });
+/**
+ * Check if the file exists.
+ * @param filePath Path to check.
+ * @returns `true` if the file exists, `false` otherwise.
+ */
+const checkFileExists = (filePath) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        yield fs.access(filePath);
+        return true;
+    }
+    catch (_a) {
+        return false;
+    }
+});
 /**
  * Download image from given URL.
- * @param url URL to download image.
- * @param directly Path to save the image.
- * @param userAgent User agent to use for fetching.
+ * @param options Options to download image.
  * @returns Path to the downloaded image.
  */
 // eslint-disable-next-line max-statements
-const downloadImage = (url, directly, userAgent) => __awaiter(void 0, void 0, void 0, function* () {
-    if (!isValidURL(url)) {
+const downloadImage = (options) => __awaiter(void 0, void 0, void 0, function* () {
+    if (!isValidURL(options.url)) {
         // eslint-disable-next-line no-console
-        console.error("[rehype-og-card] Invalid thumbnail URL:", url);
+        console.error("[rehype-og-card] Invalid thumbnail URL:", options.url);
         return null;
     }
     try {
-        const response = yield fetch(url, {
+        const hash = createHash("sha256").update(options.url).digest("hex");
+        const filename = hash + path.extname(new URL(options.url).pathname);
+        const savePath = path.posix.join(options.directly, filename);
+        // If the file already exists, return the filename.
+        const fileExists = yield checkFileExists(savePath);
+        if (fileExists) {
+            return filename;
+        }
+        const response = yield fetch(options.url, {
             headers: {
-                "user-agent": userAgent
+                "user-agent": options.userAgent
             }
         });
         const arrayBuffer = yield response.arrayBuffer();
         const buffer = Buffer.from(arrayBuffer);
-        const hash = createHash("sha256").update(url).digest("hex");
-        const filename = hash + path.extname(new URL(url).pathname);
-        const savePath = path.posix.join(directly, filename);
-        yield fs.mkdir(directly, { recursive: true });
+        yield fs.mkdir(options.directly, { recursive: true });
         yield fs.writeFile(savePath, buffer);
         return filename;
     }
@@ -167,4 +103,4 @@ const downloadImage = (url, directly, userAgent) => __awaiter(void 0, void 0, vo
         return null;
     }
 });
-export { isTextNode, isAnchorElement, isValidURL, getOGData, createOGCard, convertTextToAnchorElement, downloadImage };
+export { isTextNode, isAnchorElement, isValidURL, convertTextToAnchorElement, checkFileExists, downloadImage };

package/package.json

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