@astrojs/markdown-remark 2.1.0 → 2.1.2

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
-@astrojs/markdown-remark:build: cache hit, replaying output a9a85fd17740b5e6
+@astrojs/markdown-remark:build: cache hit, replaying output 56144f20e07435ef
 @astrojs/markdown-remark:build: 
-@astrojs/markdown-remark:build: > @astrojs/markdown-remark@2.1.0 build /home/runner/work/astro/astro/packages/markdown/remark
+@astrojs/markdown-remark:build: > @astrojs/markdown-remark@2.1.2 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,25 @@
 # @astrojs/markdown-remark
 
+## 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
+
+- [#6559](https://github.com/withastro/astro/pull/6559) [`90e5f87d0`](https://github.com/withastro/astro/commit/90e5f87d03215a833bb6ac91f9548670a25ce659) Thanks [@Princesseuh](https://github.com/Princesseuh)! - Vendor `image-size` to fix CJS-related issues
+
+- [#6555](https://github.com/withastro/astro/pull/6555) [`f5fddafc2`](https://github.com/withastro/astro/commit/f5fddafc248bb1ef57b7349bfecc25539ae2b5ea) Thanks [@Princesseuh](https://github.com/Princesseuh)! - Add a `validateOptions` hook to the Image Service API in order to set default options and validate the passed options
+
+- Updated dependencies [[`04dddd783`](https://github.com/withastro/astro/commit/04dddd783da3235aa9ed523d2856adf86b792b5f), [`ea9b3dd72`](https://github.com/withastro/astro/commit/ea9b3dd72b98b3f5a542ca24a275f673faa6c7c5), [`bf024cb34`](https://github.com/withastro/astro/commit/bf024cb3429c5929d98378108230bc946a376b17), [`22955b895`](https://github.com/withastro/astro/commit/22955b895ce4343e282355db64b3a5c1415f3944), [`f413446a8`](https://github.com/withastro/astro/commit/f413446a859e497395b3612e44d1540cc6b9dad7), [`90e5f87d0`](https://github.com/withastro/astro/commit/90e5f87d03215a833bb6ac91f9548670a25ce659), [`388190102`](https://github.com/withastro/astro/commit/3881901028cbb586f5a4de1b4953e2d6730458ab), [`035c0c4df`](https://github.com/withastro/astro/commit/035c0c4df2a623bcc2f2a1cb9e490df35fa29adc), [`f112c12b1`](https://github.com/withastro/astro/commit/f112c12b15dfbb278d66699f54809674dd1bded0), [`689884251`](https://github.com/withastro/astro/commit/68988425119255382f94c983796574050006f003), [`fa132e35c`](https://github.com/withastro/astro/commit/fa132e35c23f2cfe368fd0a7239584a2bc5c4f12), [`f5fddafc2`](https://github.com/withastro/astro/commit/f5fddafc248bb1ef57b7349bfecc25539ae2b5ea), [`283734525`](https://github.com/withastro/astro/commit/28373452503bc6ca88221ffd39a5590e015e4d71), [`66858f1f2`](https://github.com/withastro/astro/commit/66858f1f238a0edf6ded2b0f693bc738785d5aa3), [`6c465e958`](https://github.com/withastro/astro/commit/6c465e958e088ff55e5b895e67c64c0dfd4277a6)]:
+  - astro@2.1.4
+
 ## 2.1.0
 
 ### Minor 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));
+    parser.use(rehypeImages());
   }
   if (!isPerformanceBenchmark) {
     parser.use([rehypeHeadingIds]);

package/dist/load-plugins.d.ts

@@ -1,2 +1,2 @@
-import * as unified from 'unified';
+import type * as unified from 'unified';
 export declare function loadPlugins(items: (string | [string, any] | unified.Plugin<any[], any> | [unified.Plugin<any[], any>, any])[]): Promise<[unified.Plugin, any?]>[];

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): () => (tree: any, file: MarkdownVFile) => void;
+export declare function rehypeImages(): () => (tree: any, file: MarkdownVFile) => void;

package/dist/rehype-images.js

@@ -1,14 +1,8 @@
-import sizeOf from "image-size";
-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) {
+function rehypeImages() {
   return () => function(tree, file) {
     visit(tree, (node) => {
       var _a;
-      if (!assetsDir)
-        return;
       if (node.type !== "element")
         return;
       if (node.tagName !== "img")
@@ -17,30 +11,8 @@ function rehypeImages(imageService, assetsDir) {
         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 = sizeOf(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 imageURL = imageService.getURL(options);
-          node.properties = Object.assign(node.properties, {
-            src: imageURL,
-            ...imageService.getHTMLAttributes !== void 0 ? imageService.getHTMLAttributes(options) : {}
-          });
+          node.properties["__ASTRO_IMAGE_"] = node.properties.src;
+          delete node.properties.src;
         }
       }
     });
@@ -49,9 +21,6 @@ function rehypeImages(imageService, assetsDir) {
 function isAliasedPath(path) {
   return path.startsWith("~/assets");
 }
-function stripAliasPath(path) {
-  return path.replace("~/assets/", "");
-}
 function isRelativePath(path) {
   return startsWithDotDotSlash(path) || startsWithDotSlash(path);
 }

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

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

package/dist/remark-collect-images.js

@@ -1,5 +1,5 @@
 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;
@@ -7,19 +7,6 @@ function toRemarkCollectImages(resolveImage) {
     visit(tree, "image", function raiseError(node) {
       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);
   };
 }

package/dist/remark-prism.d.ts

@@ -1,3 +1,3 @@
-declare type MaybeString = string | null | undefined;
+type MaybeString = string | null | undefined;
 declare function plugin(className: MaybeString): () => (tree: any) => void;
 export default plugin;

package/dist/types.d.ts

@@ -5,14 +5,14 @@ import type { ILanguageRegistration, IThemeRegistration, Theme } from 'shiki';
 import type * as unified from 'unified';
 import type { VFile } from 'vfile';
 export type { Node } from 'unist';
-export declare type MarkdownAstroData = {
+export type MarkdownAstroData = {
     frontmatter: Record<string, any>;
 };
-export declare type RemarkPlugin<PluginParameters extends any[] = any[]> = unified.Plugin<PluginParameters, mdast.Root>;
-export declare type RemarkPlugins = (string | [string, any] | RemarkPlugin | [RemarkPlugin, any])[];
-export declare type RehypePlugin<PluginParameters extends any[] = any[]> = unified.Plugin<PluginParameters, hast.Root>;
-export declare type RehypePlugins = (string | [string, any] | RehypePlugin | [RehypePlugin, any])[];
-export declare type RemarkRehype = Omit<RemarkRehypeOptions, 'handlers' | 'unknownHandler'> & {
+export type RemarkPlugin<PluginParameters extends any[] = any[]> = unified.Plugin<PluginParameters, mdast.Root>;
+export type RemarkPlugins = (string | [string, any] | RemarkPlugin | [RemarkPlugin, any])[];
+export type RehypePlugin<PluginParameters extends any[] = any[]> = unified.Plugin<PluginParameters, hast.Root>;
+export type RehypePlugins = (string | [string, any] | RehypePlugin | [RehypePlugin, any])[];
+export type RemarkRehype = Omit<RemarkRehypeOptions, 'handlers' | 'unknownHandler'> & {
     handlers?: typeof Handlers;
     handler?: typeof Handler;
 };
@@ -31,6 +31,12 @@ export interface AstroMarkdownOptions {
     gfm?: boolean;
     smartypants?: boolean;
 }
+export interface ImageMetadata {
+    src: string;
+    width: number;
+    height: number;
+    type: string;
+}
 export interface MarkdownRenderingOptions extends AstroMarkdownOptions {
     /** @internal */
     fileURL?: URL;
@@ -41,9 +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>;
 }
 export interface MarkdownHeading {
     depth: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/markdown-remark",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "type": "module",
   "author": "withastro",
   "license": "MIT",
@@ -17,12 +17,11 @@
     "./dist/internal.js": "./dist/internal.js"
   },
   "peerDependencies": {
-    "astro": "^2.1.0"
+    "astro": "^2.1.5"
   },
   "dependencies": {
     "@astrojs/prism": "^2.1.0",
     "github-slugger": "^1.4.0",
-    "image-size": "^1.0.2",
     "import-meta-resolve": "^2.1.0",
     "rehype-raw": "^6.1.1",
     "rehype-stringify": "^9.0.3",

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));
+		parser.use(rehypeImages());
 	}
 	if (!isPerformanceBenchmark) {
 		parser.use([rehypeHeadingIds]);

package/src/load-plugins.ts

@@ -1,6 +1,6 @@
 import { resolve as importMetaResolve } from 'import-meta-resolve';
 import path from 'path';
-import * as unified from 'unified';
+import type * as unified from 'unified';
 import { pathToFileURL } from 'url';
 
 const cwdUrlStr = pathToFileURL(path.join(process.cwd(), 'package.json')).toString();

package/src/rehype-collect-headings.ts

@@ -1,7 +1,7 @@
-import { type Expression, type Super } from 'estree';
+import type { Expression, Super } from 'estree';
 import Slugger from 'github-slugger';
-import { type MdxTextExpression } from 'mdast-util-mdx-expression';
-import { type Node } from 'unist';
+import type { MdxTextExpression } from 'mdast-util-mdx-expression';
+import type { Node } from 'unist';
 import { visit } from 'unist-util-visit';
 
 import { InvalidAstroDataError, safelyGetAstroData } from './frontmatter-injection.js';

package/src/rehype-images.ts

@@ -1,15 +1,10 @@
-import sizeOf from 'image-size';
-import { join as pathJoin } from 'node:path';
-import { fileURLToPath } from 'node:url';
 import { visit } from 'unist-util-visit';
-import { pathToFileURL } from 'url';
 import type { MarkdownVFile } from './types.js';
 
-export function rehypeImages(imageService: any, assetsDir: URL | undefined) {
+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;
 
@@ -17,35 +12,8 @@ export function rehypeImages(imageService: any, assetsDir: URL | undefined) {
 					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 = sizeOf(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 imageURL = imageService.getURL(options);
-						node.properties = Object.assign(node.properties, {
-							src: imageURL,
-							...(imageService.getHTMLAttributes !== undefined
-								? imageService.getHTMLAttributes(options)
-								: {}),
-						});
+						node.properties['__ASTRO_IMAGE_'] = node.properties.src;
+						delete node.properties.src;
 					}
 				}
 			});
@@ -56,10 +24,6 @@ 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);
 }

package/src/remark-collect-images.ts

@@ -2,9 +2,7 @@ import type { Image } from 'mdast';
 import { visit } from 'unist-util-visit';
 import type { VFile } from 'vfile';
 
-type OptionalResolveImage = ((path: string) => Promise<string>) | undefined;
-
-export default function toRemarkCollectImages(resolveImage: OptionalResolveImage) {
+export default function toRemarkCollectImages() {
 	return () =>
 		async function (tree: any, vfile: VFile) {
 			if (typeof vfile?.path !== 'string') return;
@@ -13,19 +11,6 @@ export default function toRemarkCollectImages(resolveImage: OptionalResolveImage
 			visit(tree, 'image', function raiseError(node: Image) {
 				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);
 		};

package/src/types.ts

@@ -51,6 +51,13 @@ export interface AstroMarkdownOptions {
 	smartypants?: boolean;
 }
 
+export interface ImageMetadata {
+	src: string;
+	width: number;
+	height: number;
+	type: string;
+}
+
 export interface MarkdownRenderingOptions extends AstroMarkdownOptions {
 	/** @internal */
 	fileURL?: URL;
@@ -61,9 +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>;
 }
 
 export interface MarkdownHeading {