rehype-og-card 0.3.0 → 0.3.2

package/dist/index.js

@@ -7,8 +7,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { convertTextToAnchorElement, downloadImage, isAnchorElement, isTextNode, isValidURL } from "./util.js";
-import { createOGCard, getOGData } from "./openGraphUtil.js";
+import { convertTextToAnchorElement, createOGCard, isAnchorElement, isTextNode } from "./util/hast.js";
+import { downloadImage, getOGData, isValidURL } from "./util/network.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";
@@ -45,6 +46,9 @@ const rehypeOGCard = (options) => {
      */
     // 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) => {
@@ -88,10 +92,8 @@ const rehypeOGCard = (options) => {
                     return;
                 if (OGData.OGImageURL && mergedOptions.serverCache) {
                     const filename = yield downloadImage({
-                        buildCacheDirectory: mergedOptions.buildCachePath,
                         directly: mergedOptions.serverCachePath,
                         url: OGData.OGImageURL,
-                        useBuildCache: mergedOptions.buildCache,
                         userAgent: mergedOptions.crawlerUserAgent
                     });
                     if (filename && mergedOptions.serverCache) {
@@ -100,10 +102,8 @@ const rehypeOGCard = (options) => {
                 }
                 if (OGData.faviconURL && mergedOptions.serverCache) {
                     const filename = yield downloadImage({
-                        buildCacheDirectory: mergedOptions.buildCachePath,
                         directly: mergedOptions.serverCachePath,
                         url: OGData.faviconURL,
-                        useBuildCache: mergedOptions.buildCache,
                         userAgent: mergedOptions.crawlerUserAgent
                     });
                     if (filename && mergedOptions.serverCache) {
@@ -126,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/types.d.ts

@@ -31,16 +31,20 @@ interface RehypeOGCardOptions {
     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;
@@ -50,4 +54,15 @@ interface RehypeOGCardOptions {
      */
     crawlerUserAgent?: string;
 }
-export { RehypeOGCardOptions };
+interface OGCardData {
+    url: string;
+    title: string;
+    description?: string;
+    displayURL: string;
+    faviconURL?: string;
+    OGImageURL?: string;
+    OGImageAlt?: string;
+    OGImageWidth?: number;
+    OGImageHeight?: number;
+}
+export { RehypeOGCardOptions, OGCardData };

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 "./file.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/file.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 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>;
+export { checkFileExists };

package/dist/util/file.js

@@ -0,0 +1,25 @@
+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 fs from "fs/promises";
+/**
+ * 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;
+    }
+});
+export { checkFileExists };

package/dist/util/hast.d.ts

@@ -0,0 +1,37 @@
+import type { Element, ElementContent, Text } from "hast";
+import { OGCardData, RehypeOGCardOptions } from "../types.js";
+interface AnchorElement extends Element {
+    tagName: "a";
+    properties: {
+        href: string;
+    };
+}
+/**
+ * Check if the node is a text node.
+ * @param node Node to check.
+ * @returns `true` if the node is a text node, `false` otherwise.
+ */
+declare const isTextNode: (node: ElementContent) => node is Text;
+/**
+ * Check if the node is an anchor element.
+ * @param node Node to check.
+ * @returns `true` if the node is an anchor element, `false` otherwise.
+ */
+declare const isAnchorElement: (node: unknown) => node is AnchorElement;
+/**
+ * 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;
+/**
+ * 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 { AnchorElement, isTextNode, isAnchorElement, convertTextToAnchorElement, createOGCard };

package/dist/util/hast.js

@@ -0,0 +1,68 @@
+import { h } from "hastscript";
+import { isElement } from "hast-util-is-element";
+/**
+ * Check if the node is a text node.
+ * @param node Node to check.
+ * @returns `true` if the node is a text node, `false` otherwise.
+ */
+const isTextNode = (node) => Boolean(node) && typeof node === "object" && "type" in node && node.type === "text";
+/**
+ * Check if the node is an anchor element.
+ * @param node Node to check.
+ * @returns `true` if the node is an anchor element, `false` otherwise.
+ */
+const isAnchorElement = (node) => Boolean(node) && isElement(node, "a") && "href" in node.properties && typeof node.properties.href === "string";
+/**
+ * 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.
+ */
+const convertTextToAnchorElement = (text) => ({
+    children: [text],
+    properties: {
+        href: text.value.trim()
+    },
+    tagName: "a",
+    type: "element"
+});
+/**
+ * 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 { isTextNode, isAnchorElement, convertTextToAnchorElement, createOGCard };

package/dist/util/network.d.ts

@@ -0,0 +1,35 @@
+import type { OGCardData } from "../types.js";
+/**
+ * Check if the URL is valid.
+ * @param url URL to check.
+ * @returns `true` if the URL is valid, `false` otherwise.
+ */
+declare const isValidURL: (url: string) => boolean;
+/**
+ * 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>;
+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 options Options to download image.
+ * @returns Path to the downloaded image.
+ */
+declare const downloadImage: (options: DownloadImageOptions) => Promise<string | null>;
+export { isValidURL, getOGData, downloadImage };

package/dist/{util.js → util/network.js}

@@ -7,22 +7,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+import { checkFileExists } from "./file.js";
 import { createHash } from "crypto";
 import fs from "fs/promises";
-import { isElement } from "hast-util-is-element";
 import path from "path";
-/**
- * Check if the node is a text node.
- * @param node Node to check.
- * @returns `true` if the node is a text node, `false` otherwise.
- */
-const isTextNode = (node) => Boolean(node) && typeof node === "object" && "type" in node && node.type === "text";
-/**
- * Check if the node is an anchor element.
- * @param node Node to check.
- * @returns `true` if the node is an anchor element, `false` otherwise.
- */
-const isAnchorElement = (node) => Boolean(node) && isElement(node, "a") && "href" in node.properties && typeof node.properties.href === "string";
+import scraper from "open-graph-scraper";
 /**
  * Check if the URL is valid.
  * @param url URL to check.
@@ -39,30 +28,42 @@ const isValidURL = (url) => {
     }
 };
 /**
- * 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.
+ * 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 convertTextToAnchorElement = (text) => ({
-    children: [text],
-    properties: {
-        href: text.value.trim()
-    },
-    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* () {
+const getOGData = (url, userAgent) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        yield fs.access(filePath);
-        return true;
+        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 (_a) {
-        return false;
+    catch (error) {
+        // eslint-disable-next-line no-console
+        console.error("[rehype-og-card] Error fetching OG data:", error);
+        return null;
     }
 });
 /**
@@ -81,18 +82,11 @@ const downloadImage = (options) => __awaiter(void 0, void 0, void 0, function* (
         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);
-        const buildCachePath = path.posix.join(options.buildCacheDirectory, filename);
         // If the file already exists, return the filename.
         const fileExists = yield checkFileExists(savePath);
         if (fileExists) {
             return filename;
         }
-        const buildCacheExists = yield checkFileExists(buildCachePath);
-        if (options.useBuildCache && buildCacheExists) {
-            yield fs.mkdir(options.directly, { recursive: true });
-            yield fs.copyFile(buildCachePath, savePath);
-            return filename;
-        }
         const response = yield fetch(options.url, {
             headers: {
                 "user-agent": options.userAgent
@@ -102,10 +96,6 @@ const downloadImage = (options) => __awaiter(void 0, void 0, void 0, function* (
         const buffer = Buffer.from(arrayBuffer);
         yield fs.mkdir(options.directly, { recursive: true });
         yield fs.writeFile(savePath, buffer);
-        if (options.useBuildCache) {
-            yield fs.mkdir(options.buildCacheDirectory, { recursive: true });
-            yield fs.writeFile(buildCachePath, buffer);
-        }
         return filename;
     }
     catch (error) {
@@ -114,4 +104,4 @@ const downloadImage = (options) => __awaiter(void 0, void 0, void 0, function* (
         return null;
     }
 });
-export { isTextNode, isAnchorElement, isValidURL, convertTextToAnchorElement, downloadImage };
+export { isValidURL, getOGData, downloadImage };

package/package.json

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

package/dist/openGraphUtil.d.ts

@@ -1,31 +0,0 @@
-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

@@ -1,91 +0,0 @@
-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/util.d.ts

@@ -1,60 +0,0 @@
-import type { Element, ElementContent, Text } from "hast";
-interface AnchorElement extends Element {
-    tagName: "a";
-    properties: {
-        href: string;
-    };
-}
-/**
- * Check if the node is a text node.
- * @param node Node to check.
- * @returns `true` if the node is a text node, `false` otherwise.
- */
-declare const isTextNode: (node: ElementContent) => node is Text;
-/**
- * Check if the node is an anchor element.
- * @param node Node to check.
- * @returns `true` if the node is an anchor element, `false` otherwise.
- */
-declare const isAnchorElement: (node: unknown) => node is AnchorElement;
-/**
- * Check if the URL is valid.
- * @param url URL to check.
- * @returns `true` if the URL is valid, `false` otherwise.
- */
-declare const isValidURL: (url: string) => boolean;
-/**
- * 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;
-interface DownloadImageOptions {
-    /**
-     * URL to download image.
-     */
-    url: string;
-    /**
-     * Directory to save the downloaded image.
-     */
-    directly: string;
-    /**
-     * Whether to save and restore the image cache.
-     */
-    useBuildCache: boolean;
-    /**
-     * Directory to save the image cache.
-     */
-    buildCacheDirectory: string;
-    /**
-     * User agent to use for fetching the image.
-     */
-    userAgent: string;
-}
-/**
- * Download image from given URL.
- * @param options Options to download image.
- * @returns Path to the downloaded image.
- */
-declare const downloadImage: (options: DownloadImageOptions) => Promise<string | null>;
-export { AnchorElement, isTextNode, isAnchorElement, isValidURL, convertTextToAnchorElement, downloadImage };