@astrojs/markdown-remark 2.1.1 → 2.1.3

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
-@astrojs/markdown-remark:build: cache hit, replaying output 16e4e4cd9a08743c
+@astrojs/markdown-remark:build: cache hit, replaying output d62fcf6af591535d
 @astrojs/markdown-remark:build: 
-@astrojs/markdown-remark:build: > @astrojs/markdown-remark@2.1.1 build /home/runner/work/astro/astro/packages/markdown/remark
+@astrojs/markdown-remark:build: > @astrojs/markdown-remark@2.1.3 build /home/runner/work/astro/astro/packages/markdown/remark
 @astrojs/markdown-remark:build: > astro-scripts build "src/**/*.ts" && tsc -p tsconfig.json
 @astrojs/markdown-remark:build: 

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @astrojs/markdown-remark
 
+## 2.1.3
+
+### Patch Changes
+
+- [#6744](https://github.com/withastro/astro/pull/6744) [`a1a4f45b5`](https://github.com/withastro/astro/commit/a1a4f45b51a80215fa7598da83bd0d9c5acd20d2) Thanks [@Princesseuh](https://github.com/Princesseuh)! - Fix remote images in Markdown throwing errors when using `experimental.assets`
+
+- Updated dependencies [[`489dd8d69`](https://github.com/withastro/astro/commit/489dd8d69cdd9d7c243cf8bec96051a914984b9c), [`a1a4f45b5`](https://github.com/withastro/astro/commit/a1a4f45b51a80215fa7598da83bd0d9c5acd20d2), [`a1108e037`](https://github.com/withastro/astro/commit/a1108e037115cdb67d03505286c7d3a4fc2a1ff5), [`8b88e4cf1`](https://github.com/withastro/astro/commit/8b88e4cf15c8bea7942b3985380164e0edf7250b), [`d54cbe413`](https://github.com/withastro/astro/commit/d54cbe41349e55f8544212ad9320705f07325920), [`4c347ab51`](https://github.com/withastro/astro/commit/4c347ab51e46f2319d614f8577fe502e3dc816e2), [`ff0430786`](https://github.com/withastro/astro/commit/ff043078630e678348ae4f4757b3015b3b862c16), [`2f2e572e9`](https://github.com/withastro/astro/commit/2f2e572e937fd25451bbc78a05d55b7caa1ca3ec), [`7116c021a`](https://github.com/withastro/astro/commit/7116c021a39eac15a6e1264dfbd11bef0f5d618a)]:
+  - astro@2.2.0
+
+## 2.1.2
+
+### Patch Changes
+
+- [#6604](https://github.com/withastro/astro/pull/6604) [`7f7a8504b`](https://github.com/withastro/astro/commit/7f7a8504b5c2df4c99d3025931860c0d50992510) Thanks [@Princesseuh](https://github.com/Princesseuh)! - Fix using optimized images in Markdown not working
+
+- Updated dependencies [[`7f7a8504b`](https://github.com/withastro/astro/commit/7f7a8504b5c2df4c99d3025931860c0d50992510), [`38e6ec21e`](https://github.com/withastro/astro/commit/38e6ec21e266ad8765d8ca2293034123b34e839a), [`f42f47dc6`](https://github.com/withastro/astro/commit/f42f47dc6a91cdb6534dab0ecbf9e8e85f00ba40)]:
+  - astro@2.1.5
+
 ## 2.1.1
 
 ### Patch Changes

package/dist/index.js

@@ -69,7 +69,7 @@ async function renderMarkdown(content, opts) {
       parser.use([remarkPrism(scopedClassName)]);
     }
     if (opts.experimentalAssets) {
-      parser.use([toRemarkCollectImages(opts.resolveImage)]);
+      parser.use([toRemarkCollectImages()]);
     }
   }
   parser.use([
@@ -86,7 +86,7 @@ async function renderMarkdown(content, opts) {
     parser.use([[plugin, pluginOpts]]);
   });
   if (opts.experimentalAssets) {
-    parser.use(rehypeImages(await opts.imageService, opts.assetsDir, opts.getImageMetadata));
+    parser.use(rehypeImages());
   }
   if (!isPerformanceBenchmark) {
     parser.use([rehypeHeadingIds]);

package/dist/rehype-images.d.ts

@@ -1,2 +1,2 @@
 import type { MarkdownVFile } from './types.js';
-export declare function rehypeImages(imageService: any, assetsDir: URL | undefined, getImageMetadata: any): () => (tree: any, file: MarkdownVFile) => void;
+export declare function rehypeImages(): () => (tree: any, file: MarkdownVFile) => void;

package/dist/rehype-images.js

@@ -1,71 +1,21 @@
-import { join as pathJoin } from "node:path";
-import { fileURLToPath } from "node:url";
 import { visit } from "unist-util-visit";
-import { pathToFileURL } from "url";
-function rehypeImages(imageService, assetsDir, getImageMetadata) {
+function rehypeImages() {
   return () => function(tree, file) {
     visit(tree, (node) => {
-      var _a;
-      if (!assetsDir)
-        return;
+      var _a, _b;
       if (node.type !== "element")
         return;
       if (node.tagName !== "img")
         return;
       if ((_a = node.properties) == null ? void 0 : _a.src) {
-        if (file.dirname) {
-          if (!isRelativePath(node.properties.src) && !isAliasedPath(node.properties.src))
-            return;
-          let fileURL;
-          if (isAliasedPath(node.properties.src)) {
-            fileURL = new URL(stripAliasPath(node.properties.src), assetsDir);
-          } else {
-            fileURL = pathToFileURL(pathJoin(file.dirname, node.properties.src));
-          }
-          const fileData = getImageMetadata(fileURLToPath(fileURL));
-          fileURL.searchParams.append("origWidth", fileData.width.toString());
-          fileURL.searchParams.append("origHeight", fileData.height.toString());
-          fileURL.searchParams.append("origFormat", fileData.type.toString());
-          let options = {
-            src: {
-              src: fileURL,
-              width: fileData.width,
-              height: fileData.height,
-              format: fileData.type
-            },
-            alt: node.properties.alt
-          };
-          const validatedOptions = imageService.validateOptions ? imageService.validateOptions(options) : options;
-          const imageURL = imageService.getURL(validatedOptions);
-          node.properties = Object.assign(node.properties, {
-            src: imageURL,
-            ...imageService.getHTMLAttributes !== void 0 ? imageService.getHTMLAttributes(validatedOptions) : {}
-          });
+        if ((_b = file.data.imagePaths) == null ? void 0 : _b.has(node.properties.src)) {
+          node.properties["__ASTRO_IMAGE_"] = node.properties.src;
+          delete node.properties.src;
         }
       }
     });
   };
 }
-function isAliasedPath(path) {
-  return path.startsWith("~/assets");
-}
-function stripAliasPath(path) {
-  return path.replace("~/assets/", "");
-}
-function isRelativePath(path) {
-  return startsWithDotDotSlash(path) || startsWithDotSlash(path);
-}
-function startsWithDotDotSlash(path) {
-  const c1 = path[0];
-  const c2 = path[1];
-  const c3 = path[2];
-  return c1 === "." && c2 === "." && c3 === "/";
-}
-function startsWithDotSlash(path) {
-  const c1 = path[0];
-  const c2 = path[1];
-  return c1 === "." && c2 === "/";
-}
 export {
   rehypeImages
 };

package/dist/remark-collect-images.d.ts

@@ -1,4 +1,2 @@
-import type { VFile } from 'vfile';
-type OptionalResolveImage = ((path: string) => Promise<string>) | undefined;
-export default function toRemarkCollectImages(resolveImage: OptionalResolveImage): () => (tree: any, vfile: VFile) => Promise<void>;
-export {};
+import type { MarkdownVFile } from './types';
+export default function toRemarkCollectImages(): () => (tree: any, vfile: MarkdownVFile) => Promise<void>;

package/dist/remark-collect-images.js

@@ -1,28 +1,27 @@
 import { visit } from "unist-util-visit";
-function toRemarkCollectImages(resolveImage) {
+function toRemarkCollectImages() {
   return () => async function(tree, vfile) {
     if (typeof (vfile == null ? void 0 : vfile.path) !== "string")
       return;
     const imagePaths = /* @__PURE__ */ new Set();
-    visit(tree, "image", function raiseError(node) {
-      imagePaths.add(node.url);
+    visit(tree, "image", (node) => {
+      if (shouldOptimizeImage(node.url))
+        imagePaths.add(node.url);
     });
-    if (imagePaths.size === 0) {
-      vfile.data.imagePaths = [];
-      return;
-    } else if (resolveImage) {
-      const mapping = /* @__PURE__ */ new Map();
-      for (const path of Array.from(imagePaths)) {
-        const id = await resolveImage(path);
-        mapping.set(path, id);
-      }
-      visit(tree, "image", function raiseError(node) {
-        node.url = mapping.get(node.url);
-      });
-    }
-    vfile.data.imagePaths = Array.from(imagePaths);
+    vfile.data.imagePaths = imagePaths;
   };
 }
+function shouldOptimizeImage(src) {
+  return !isValidUrl(src) && !src.startsWith("/");
+}
+function isValidUrl(str) {
+  try {
+    new URL(str);
+    return true;
+  } catch {
+    return false;
+  }
+}
 export {
   toRemarkCollectImages as default
 };

package/dist/types.d.ts

@@ -47,10 +47,6 @@ export interface MarkdownRenderingOptions extends AstroMarkdownOptions {
     /** Used for frontmatter injection plugins */
     frontmatter?: Record<string, any>;
     experimentalAssets?: boolean;
-    imageService?: any;
-    assetsDir?: URL;
-    resolveImage?: (path: string) => Promise<string>;
-    getImageMetadata?: any;
 }
 export interface MarkdownHeading {
     depth: number;
@@ -65,10 +61,11 @@ export interface MarkdownMetadata {
 export interface MarkdownVFile extends VFile {
     data: {
         __astroHeadings?: MarkdownHeading[];
+        imagePaths?: Set<string>;
     };
 }
 export interface MarkdownRenderingResult {
     metadata: MarkdownMetadata;
-    vfile: VFile;
+    vfile: MarkdownVFile;
     code: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/markdown-remark",
-  "version": "2.1.1",
+  "version": "2.1.3",
   "type": "module",
   "author": "withastro",
   "license": "MIT",
@@ -17,7 +17,7 @@
     "./dist/internal.js": "./dist/internal.js"
   },
   "peerDependencies": {
-    "astro": "^2.1.4"
+    "astro": "^2.2.0"
   },
   "dependencies": {
     "@astrojs/prism": "^2.1.0",

package/src/index.ts

@@ -96,7 +96,7 @@ export async function renderMarkdown(
 
 		if (opts.experimentalAssets) {
 			// Apply later in case user plugins resolve relative image paths
-			parser.use([toRemarkCollectImages(opts.resolveImage)]);
+			parser.use([toRemarkCollectImages()]);
 		}
 	}
 
@@ -116,7 +116,7 @@ export async function renderMarkdown(
 	});
 
 	if (opts.experimentalAssets) {
-		parser.use(rehypeImages(await opts.imageService, opts.assetsDir, opts.getImageMetadata));
+		parser.use(rehypeImages());
 	}
 	if (!isPerformanceBenchmark) {
 		parser.use([rehypeHeadingIds]);

package/src/rehype-images.ts

@@ -1,81 +1,19 @@
-import { join as pathJoin } from 'node:path';
-import { fileURLToPath } from 'node:url';
 import { visit } from 'unist-util-visit';
-import { pathToFileURL } from 'url';
-import type { ImageMetadata, MarkdownVFile } from './types.js';
+import type { MarkdownVFile } from './types.js';
 
-export function rehypeImages(imageService: any, assetsDir: URL | undefined, getImageMetadata: any) {
+export function rehypeImages() {
 	return () =>
 		function (tree: any, file: MarkdownVFile) {
 			visit(tree, (node) => {
-				if (!assetsDir) return;
 				if (node.type !== 'element') return;
 				if (node.tagName !== 'img') return;
 
 				if (node.properties?.src) {
-					if (file.dirname) {
-						if (!isRelativePath(node.properties.src) && !isAliasedPath(node.properties.src)) return;
-
-						let fileURL: URL;
-						if (isAliasedPath(node.properties.src)) {
-							fileURL = new URL(stripAliasPath(node.properties.src), assetsDir);
-						} else {
-							fileURL = pathToFileURL(pathJoin(file.dirname, node.properties.src));
-						}
-
-						const fileData = getImageMetadata!(fileURLToPath(fileURL)) as ImageMetadata;
-						fileURL.searchParams.append('origWidth', fileData.width.toString());
-						fileURL.searchParams.append('origHeight', fileData.height.toString());
-						fileURL.searchParams.append('origFormat', fileData.type.toString());
-
-						let options = {
-							src: {
-								src: fileURL,
-								width: fileData.width,
-								height: fileData.height,
-								format: fileData.type,
-							},
-							alt: node.properties.alt,
-						};
-
-						const validatedOptions = imageService.validateOptions
-							? imageService.validateOptions(options)
-							: options;
-
-						const imageURL = imageService.getURL(validatedOptions);
-						node.properties = Object.assign(node.properties, {
-							src: imageURL,
-							...(imageService.getHTMLAttributes !== undefined
-								? imageService.getHTMLAttributes(validatedOptions)
-								: {}),
-						});
+					if (file.data.imagePaths?.has(node.properties.src)) {
+						node.properties['__ASTRO_IMAGE_'] = node.properties.src;
+						delete node.properties.src;
 					}
 				}
 			});
 		};
 }
-
-function isAliasedPath(path: string) {
-	return path.startsWith('~/assets');
-}
-
-function stripAliasPath(path: string) {
-	return path.replace('~/assets/', '');
-}
-
-function isRelativePath(path: string) {
-	return startsWithDotDotSlash(path) || startsWithDotSlash(path);
-}
-
-function startsWithDotDotSlash(path: string) {
-	const c1 = path[0];
-	const c2 = path[1];
-	const c3 = path[2];
-	return c1 === '.' && c2 === '.' && c3 === '/';
-}
-
-function startsWithDotSlash(path: string) {
-	const c1 = path[0];
-	const c2 = path[1];
-	return c1 === '.' && c2 === '/';
-}

package/src/remark-collect-images.ts

@@ -1,32 +1,31 @@
 import type { Image } from 'mdast';
 import { visit } from 'unist-util-visit';
-import type { VFile } from 'vfile';
+import type { MarkdownVFile } from './types';
 
-type OptionalResolveImage = ((path: string) => Promise<string>) | undefined;
-
-export default function toRemarkCollectImages(resolveImage: OptionalResolveImage) {
+export default function toRemarkCollectImages() {
 	return () =>
-		async function (tree: any, vfile: VFile) {
+		async function (tree: any, vfile: MarkdownVFile) {
 			if (typeof vfile?.path !== 'string') return;
 
 			const imagePaths = new Set<string>();
-			visit(tree, 'image', function raiseError(node: Image) {
-				imagePaths.add(node.url);
+			visit(tree, 'image', (node: Image) => {
+				if (shouldOptimizeImage(node.url)) imagePaths.add(node.url);
 			});
-			if (imagePaths.size === 0) {
-				vfile.data.imagePaths = [];
-				return;
-			} else if (resolveImage) {
-				const mapping = new Map<string, string>();
-				for (const path of Array.from(imagePaths)) {
-					const id = await resolveImage(path);
-					mapping.set(path, id);
-				}
-				visit(tree, 'image', function raiseError(node: Image) {
-					node.url = mapping.get(node.url)!;
-				});
-			}
 
-			vfile.data.imagePaths = Array.from(imagePaths);
+			vfile.data.imagePaths = imagePaths;
 		};
 }
+
+function shouldOptimizeImage(src: string) {
+	// Optimize anything that is NOT external or an absolute path to `public/`
+	return !isValidUrl(src) && !src.startsWith('/');
+}
+
+function isValidUrl(str: string): boolean {
+	try {
+		new URL(str);
+		return true;
+	} catch {
+		return false;
+	}
+}

package/src/types.ts

@@ -68,10 +68,6 @@ export interface MarkdownRenderingOptions extends AstroMarkdownOptions {
 	/** Used for frontmatter injection plugins */
 	frontmatter?: Record<string, any>;
 	experimentalAssets?: boolean;
-	imageService?: any;
-	assetsDir?: URL;
-	resolveImage?: (path: string) => Promise<string>;
-	getImageMetadata?: any;
 }
 
 export interface MarkdownHeading {
@@ -89,11 +85,12 @@ export interface MarkdownMetadata {
 export interface MarkdownVFile extends VFile {
 	data: {
 		__astroHeadings?: MarkdownHeading[];
+		imagePaths?: Set<string>;
 	};
 }
 
 export interface MarkdownRenderingResult {
 	metadata: MarkdownMetadata;
-	vfile: VFile;
+	vfile: MarkdownVFile;
 	code: string;
 }