@astrojs/markdown-remark 2.1.0 → 2.1.1

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 16e4e4cd9a08743c
 @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.1 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,16 @@
 # @astrojs/markdown-remark
 
+## 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

@@ -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(await opts.imageService, opts.assetsDir, opts.getImageMetadata));
   }
   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(imageService: any, assetsDir: URL | undefined, getImageMetadata: any): () => (tree: any, file: MarkdownVFile) => void;

package/dist/rehype-images.js

@@ -1,9 +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(imageService, assetsDir, getImageMetadata) {
   return () => function(tree, file) {
     visit(tree, (node) => {
       var _a;
@@ -23,7 +22,7 @@ function rehypeImages(imageService, assetsDir) {
           } else {
             fileURL = pathToFileURL(pathJoin(file.dirname, node.properties.src));
           }
-          const fileData = sizeOf(fileURLToPath(fileURL));
+          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());
@@ -36,10 +35,11 @@ function rehypeImages(imageService, assetsDir) {
             },
             alt: node.properties.alt
           };
-          const imageURL = imageService.getURL(options);
+          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(options) : {}
+            ...imageService.getHTMLAttributes !== void 0 ? imageService.getHTMLAttributes(validatedOptions) : {}
           });
         }
       }

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

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

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;
@@ -44,6 +50,7 @@ export interface MarkdownRenderingOptions extends AstroMarkdownOptions {
     imageService?: any;
     assetsDir?: URL;
     resolveImage?: (path: string) => Promise<string>;
+    getImageMetadata?: any;
 }
 export interface MarkdownHeading {
     depth: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/markdown-remark",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "type": "module",
   "author": "withastro",
   "license": "MIT",
@@ -17,12 +17,11 @@
     "./dist/internal.js": "./dist/internal.js"
   },
   "peerDependencies": {
-    "astro": "^2.1.0"
+    "astro": "^2.1.4"
   },
   "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

@@ -116,7 +116,7 @@ export async function renderMarkdown(
 	});
 
 	if (opts.experimentalAssets) {
-		parser.use(rehypeImages(await opts.imageService, opts.assetsDir));
+		parser.use(rehypeImages(await opts.imageService, opts.assetsDir, opts.getImageMetadata));
 	}
 	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,11 +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';
+import type { ImageMetadata, MarkdownVFile } from './types.js';
 
-export function rehypeImages(imageService: any, assetsDir: URL | undefined) {
+export function rehypeImages(imageService: any, assetsDir: URL | undefined, getImageMetadata: any) {
 	return () =>
 		function (tree: any, file: MarkdownVFile) {
 			visit(tree, (node) => {
@@ -24,10 +23,10 @@ export function rehypeImages(imageService: any, assetsDir: URL | undefined) {
 							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());
+						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: {
@@ -39,11 +38,15 @@ export function rehypeImages(imageService: any, assetsDir: URL | undefined) {
 							alt: node.properties.alt,
 						};
 
-						const imageURL = imageService.getURL(options);
+						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(options)
+								? imageService.getHTMLAttributes(validatedOptions)
 								: {}),
 						});
 					}

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;
@@ -64,6 +71,7 @@ export interface MarkdownRenderingOptions extends AstroMarkdownOptions {
 	imageService?: any;
 	assetsDir?: URL;
 	resolveImage?: (path: string) => Promise<string>;
+	getImageMetadata?: any;
 }
 
 export interface MarkdownHeading {