rehype-og-card 0.3.0 → 0.3.1

package/dist/index.js

@@ -9,6 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 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";
@@ -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;

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

@@ -29,6 +29,12 @@ declare const isValidURL: (url: string) => boolean;
  * @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.
@@ -38,14 +44,6 @@ interface DownloadImageOptions {
      * 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.
      */
@@ -57,4 +55,4 @@ interface DownloadImageOptions {
  * @returns Path to the downloaded image.
  */
 declare const downloadImage: (options: DownloadImageOptions) => Promise<string | null>;
-export { AnchorElement, isTextNode, isAnchorElement, isValidURL, convertTextToAnchorElement, downloadImage };
+export { AnchorElement, isTextNode, isAnchorElement, isValidURL, convertTextToAnchorElement, checkFileExists, downloadImage };

package/dist/util.js

@@ -81,18 +81,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 +95,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 +103,4 @@ const downloadImage = (options) => __awaiter(void 0, void 0, void 0, function* (
         return null;
     }
 });
-export { isTextNode, isAnchorElement, isValidURL, convertTextToAnchorElement, downloadImage };
+export { isTextNode, isAnchorElement, isValidURL, convertTextToAnchorElement, checkFileExists, downloadImage };

package/package.json

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