rehype-og-card 1.0.1 → 1.0.3

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import type { Plugin } from "unified";
-import { RehypeOGCardOptions } from "./types.js";
+import type { RehypeOGCardOptions } from "./types.js";
 import type { Root } from "hast";
 /**
  * Rehype plugin to create OG card from bare links.
@@ -8,4 +8,4 @@ import type { Root } from "hast";
  */
 declare const rehypeOGCard: Plugin<[RehypeOGCardOptions | undefined], Root>;
 export default rehypeOGCard;
-export { RehypeOGCardOptions };
+export type { RehypeOGCardOptions };

package/dist/index.js

@@ -1,12 +1,3 @@
-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 { convertTextToAnchorElement, createOGCard, isAnchorElement, isTextNode } from "./util/hast.js";
 import { checkFileExistsSync, createDirectorySync } from "./util/file.js";
 import { downloadImage, getOGData, isValidURL } from "./util/network.js";
@@ -36,7 +27,10 @@ const DEFAULT_OPTIONS = {
  */
 // eslint-disable-next-line max-lines-per-function, max-statements
 const rehypeOGCard = (options) => {
-    const mergedOptions = Object.assign(Object.assign({}, DEFAULT_OPTIONS), options);
+    const mergedOptions = {
+        ...DEFAULT_OPTIONS,
+        ...options
+    };
     if (mergedOptions.buildCache && !mergedOptions.serverCache) {
         throw new Error("[rehype-og-card] `buildCache` option requires `serverCache` option to be enabled.");
     }
@@ -56,11 +50,10 @@ const rehypeOGCard = (options) => {
      * @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* () {
+    const transform = async (tree) => {
         const linkCardPromises = [];
         // eslint-disable-next-line max-statements, max-lines-per-function
         visitParents(tree, ["element", "text"], (node, ancestors) => {
-            var _a;
             let anchorNode = null;
             const isBareLink = node.type === "text" && isValidURL(node.value.trim());
             const isValidAnchor = isAnchorElement(node) && isValidURL(node.properties.href);
@@ -91,15 +84,15 @@ const rehypeOGCard = (options) => {
             if (!isTheOnlyChild)
                 return;
             const targetURL = new URL(anchorNode.properties.href);
-            if ((_a = mergedOptions.excludeDomains) === null || _a === void 0 ? void 0 : _a.includes(targetURL.hostname))
+            if (mergedOptions.excludeDomains.includes(targetURL.hostname))
                 return;
             // eslint-disable-next-line jsdoc/require-jsdoc, max-statements, max-lines-per-function
-            const linkCardPromise = () => __awaiter(void 0, void 0, void 0, function* () {
+            const linkCardPromise = async () => {
                 let OGData = mergedOptions.buildCache
-                    ? yield restoreOGDataBuildCache(anchorNode.properties.href, mergedOptions.buildCachePath)
+                    ? await restoreOGDataBuildCache(anchorNode.properties.href, mergedOptions.buildCachePath)
                     : null;
                 if (!OGData) {
-                    OGData = yield getOGData(anchorNode.properties.href, mergedOptions.crawlerUserAgent);
+                    OGData = await getOGData(anchorNode.properties.href, mergedOptions.crawlerUserAgent);
                     if (!OGData)
                         return;
                     if (mergedOptions.buildCache) {
@@ -107,12 +100,12 @@ const rehypeOGCard = (options) => {
                     }
                 }
                 if (OGData.OGImageURL && mergedOptions.serverCache) {
-                    const filename = yield downloadImage({
+                    const filename = await downloadImage({
                         directory: mergedOptions.serverCachePath,
                         url: OGData.OGImageURL,
                         userAgent: mergedOptions.crawlerUserAgent
                     });
-                    if (filename && mergedOptions.serverCache) {
+                    if (filename) {
                         OGData.OGImageURL = path.posix.join("/rehype-og-card", filename);
                     }
                     if (filename && mergedOptions.buildCache) {
@@ -122,12 +115,12 @@ const rehypeOGCard = (options) => {
                     }
                 }
                 if (OGData.faviconURL && mergedOptions.serverCache) {
-                    const filename = yield downloadImage({
+                    const filename = await downloadImage({
                         directory: mergedOptions.serverCachePath,
                         url: OGData.faviconURL,
                         userAgent: mergedOptions.crawlerUserAgent
                     });
-                    if (filename && mergedOptions.serverCache) {
+                    if (filename) {
                         OGData.faviconURL = path.posix.join("/rehype-og-card", filename);
                     }
                     if (filename && mergedOptions.buildCache) {
@@ -148,11 +141,11 @@ const rehypeOGCard = (options) => {
                     return;
                 // eslint-disable-next-line no-magic-numbers
                 ancestors[ancestors.length - 1].children.splice(index, 1, OGCard);
-            });
+            };
             linkCardPromises.push(linkCardPromise());
         });
-        yield Promise.all(linkCardPromises);
-    });
+        await Promise.all(linkCardPromises);
+    };
     return transform;
 };
 export default rehypeOGCard;

package/dist/types.d.ts

@@ -70,4 +70,4 @@ interface OGCardData {
     OGImageWidth?: number;
     OGImageHeight?: number;
 }
-export { RehypeOGCardOptions, OGCardData };
+export type { RehypeOGCardOptions, OGCardData };

package/dist/util/cache.d.ts

@@ -1,4 +1,4 @@
-import { OGCardData } from "../types.js";
+import type { OGCardData } from "../types.js";
 /**
  * Save build cache if server cache exists.
  * @param serverCachePath Server cache path.

package/dist/util/cache.js

@@ -1,12 +1,3 @@
-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, copyDirectory, generateFilename } from "./file.js";
 import fs from "fs/promises";
 import path from "path";
@@ -15,13 +6,13 @@ import path from "path";
  * @param serverCachePath Server cache path.
  * @param buildCachePath Build cache path.
  */
-const saveBuildCacheFile = (serverCachePath, buildCachePath) => __awaiter(void 0, void 0, void 0, function* () {
-    const serverCacheExists = yield checkFileExists(serverCachePath);
-    const buildCacheExists = yield checkFileExists(buildCachePath);
+const saveBuildCacheFile = async (serverCachePath, buildCachePath) => {
+    const serverCacheExists = await checkFileExists(serverCachePath);
+    const buildCacheExists = await checkFileExists(buildCachePath);
     if (serverCacheExists && !buildCacheExists) {
-        yield fs.copyFile(serverCachePath, buildCachePath);
+        await fs.copyFile(serverCachePath, buildCachePath);
     }
-});
+};
 /**
  * Restore build cache if it exists.
  * @param buildCachePath Build cache path.
@@ -36,30 +27,30 @@ const restoreBuildCache = (buildCachePath, serverCachePath) => {
  * @param OGData OG data to save.
  * @param buildCachePath Build cache path.
  */
-const saveOGDataBuildCache = (url, OGData, buildCachePath) => __awaiter(void 0, void 0, void 0, function* () {
+const saveOGDataBuildCache = async (url, OGData, buildCachePath) => {
     const filename = generateFilename(url, false);
     const savePath = `${path.join(buildCachePath, filename)}.json`;
-    const cacheDirectoryExists = yield checkFileExists(buildCachePath);
+    const cacheDirectoryExists = await checkFileExists(buildCachePath);
     if (!cacheDirectoryExists) {
-        yield fs.mkdir(buildCachePath, { recursive: true });
+        await fs.mkdir(buildCachePath, { recursive: true });
     }
-    yield fs.writeFile(savePath, JSON.stringify(OGData));
-});
+    await fs.writeFile(savePath, JSON.stringify(OGData));
+};
 /**
  * Restore OG data from build cache.
  * @param url URL of the OG data.
  * @param buildCachePath Build cache path.
  * @returns Restored OG data. If not found, returns `null`.
  */
-const restoreOGDataBuildCache = (url, buildCachePath) => __awaiter(void 0, void 0, void 0, function* () {
+const restoreOGDataBuildCache = async (url, buildCachePath) => {
     const filename = generateFilename(url, false);
     const savePath = `${path.join(buildCachePath, filename)}.json`;
     try {
-        const data = yield fs.readFile(savePath, "utf-8");
+        const data = await fs.readFile(savePath, "utf-8");
         return JSON.parse(data);
     }
-    catch (_a) {
+    catch {
         return null;
     }
-});
+};
 export { saveBuildCacheFile, restoreBuildCache, saveOGDataBuildCache, restoreOGDataBuildCache };

package/dist/util/file.js

@@ -1,12 +1,3 @@
-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 { createHash } from "crypto";
 import fs from "fs";
 import path from "path";
@@ -15,15 +6,15 @@ import path from "path";
  * @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 checkFileExists = async (filePath) => {
     try {
-        yield fs.promises.access(filePath);
+        await fs.promises.access(filePath);
         return true;
     }
-    catch (_a) {
+    catch {
         return false;
     }
-});
+};
 /**
  * Check if the file exists.
  * @param filePath Path to check.

package/dist/util/hast.d.ts

@@ -1,5 +1,5 @@
 import type { Element, ElementContent, Text } from "hast";
-import { OGCardData, RehypeOGCardOptions } from "../types.js";
+import type { OGCardData, RehypeOGCardOptions } from "../types.js";
 interface AnchorElement extends Element {
     tagName: "a";
     properties: {
@@ -35,4 +35,4 @@ declare const createOGCard: (data: OGCardData, options: Required<{
     decoding: RehypeOGCardOptions["decoding"];
     openInNewTab: RehypeOGCardOptions["openInNewTab"];
 }>) => Element;
-export { AnchorElement, isTextNode, isAnchorElement, convertTextToAnchorElement, createOGCard };
+export { type AnchorElement, isTextNode, isAnchorElement, convertTextToAnchorElement, createOGCard };

package/dist/util/hast.js

@@ -38,7 +38,7 @@ const createOGCard = (data, options) => {
     };
     const card = h("div.og-card-container", [
         // eslint-disable-next-line no-extra-parens
-        h("a", Object.assign({ href: data.url }, (options.openInNewTab ? openInNewTab : {})), [
+        h("a", { href: data.url, ...(options.openInNewTab ? openInNewTab : {}) }, [
             h("div.og-card-info", [
                 h("div.og-card-title", data.title),
                 data.description ? h("div.og-card-description", data.description) : null,
@@ -57,6 +57,7 @@ const createOGCard = (data, options) => {
             data.OGImageURL
                 ? h("div.og-card-image-container", [
                     h("img.og-card-image", {
+                        // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
                         alt: data.OGImageAlt || data.OGImageURL,
                         decoding: options.decoding,
                         height: data.OGImageHeight,

package/dist/util/network.js

@@ -1,12 +1,3 @@
-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, generateFilename } from "./file.js";
 import fetch from "node-fetch";
 import fs from "fs/promises";
@@ -27,7 +18,7 @@ const isValidURL = (url) => {
         new URL(url);
         return true;
     }
-    catch (_a) {
+    catch {
         return false;
     }
 };
@@ -37,9 +28,9 @@ const isValidURL = (url) => {
  * @param userAgent User agent to use for fetching.
  * @returns OG card data.
  */
-const getOGData = (url, userAgent) => __awaiter(void 0, void 0, void 0, function* () {
+const getOGData = async (url, userAgent) => {
     try {
-        const { result } = yield scraper({
+        const { result } = await scraper({
             fetchOptions: {
                 headers: {
                     "user-agent": userAgent
@@ -53,13 +44,14 @@ const getOGData = (url, userAgent) => __awaiter(void 0, void 0, void 0, function
             : // 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,
+            OGImageAlt: OGImage?.alt,
+            OGImageHeight: OGImage?.height,
+            OGImageURL: OGImage?.url,
+            OGImageWidth: OGImage?.width,
             description: result.ogDescription,
             displayURL: url,
             faviconURL,
+            // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
             title: result.ogTitle || url,
             url
         };
@@ -69,14 +61,14 @@ const getOGData = (url, userAgent) => __awaiter(void 0, void 0, void 0, function
         console.error("[rehype-og-card] Error fetching OG data:", error);
         return null;
     }
-});
+};
 /**
  * Download image from given URL. If the image already exists, return the filename.
  * @param options Options to download image.
  * @returns Filename of the downloaded image.
  */
 // eslint-disable-next-line max-statements
-const downloadImage = (options) => __awaiter(void 0, void 0, void 0, function* () {
+const downloadImage = async (options) => {
     if (!isValidURL(options.url)) {
         // eslint-disable-next-line no-console
         console.error("[rehype-og-card] Invalid thumbnail URL:", options.url);
@@ -86,23 +78,23 @@ const downloadImage = (options) => __awaiter(void 0, void 0, void 0, function* (
         const filename = generateFilename(options.url);
         const savePath = path.posix.join(options.directory, filename);
         // If the file already exists, return the filename.
-        const fileExists = yield checkFileExists(savePath);
+        const fileExists = await checkFileExists(savePath);
         if (fileExists)
             return filename;
-        const response = yield fetch(options.url, {
+        const response = await fetch(options.url, {
             headers: {
                 "user-agent": options.userAgent
             },
             // eslint-disable-next-line no-magic-numbers
             signal: AbortSignal.timeout(10 * 1000)
         });
-        const arrayBuffer = yield response.arrayBuffer();
+        const arrayBuffer = await response.arrayBuffer();
         const buffer = Buffer.from(arrayBuffer);
-        const saveDirectoryExists = yield checkFileExists(options.directory);
+        const saveDirectoryExists = await checkFileExists(options.directory);
         if (!saveDirectoryExists) {
-            yield fs.mkdir(options.directory, { recursive: true });
+            await fs.mkdir(options.directory, { recursive: true });
         }
-        yield fs.writeFile(savePath, buffer);
+        await fs.writeFile(savePath, buffer);
         return filename;
     }
     catch (error) {
@@ -110,5 +102,5 @@ const downloadImage = (options) => __awaiter(void 0, void 0, void 0, function* (
         console.error("[rehype-og-card] Error downloading image:", error);
         return null;
     }
-});
+};
 export { isValidURL, getOGData, downloadImage };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rehype-og-card",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Rehype plugin to convert text links to link cards",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -42,7 +42,8 @@
   "devDependencies": {
     "@changesets/changelog-github": "^0.5.0",
     "@changesets/cli": "^2.27.7",
-    "@robot-inventor/eslint-config": "^0.2.21",
+    "@robot-inventor/eslint-config": "^4.0.0",
+    "@robot-inventor/tsconfig-base": "^1.1.0",
     "@types/node": "^20.14.11",
     "@types/sanitize-html": "^2.11.0",
     "eslint": "^9.7.0",