Use an object as the argument for ImageFunction to allow for more o…

…ptions later (#128)

.changeset/forty-spiders-glow.md

@@ -0,0 +1,5 @@
+---
+'markdownlayer': minor
+---
+
+Use an object as the argument for `ImageFunction` to allow for more options later

packages/markdownlayer/src/core/generation/image.ts

@@ -3,9 +3,13 @@ import type { StaticImageData } from 'next/dist/shared/lib/image-external'; // t
 import path from 'path';
 import { z } from 'zod';
 
-import type { GenerationMode, StaticImageDataSchema } from '../types';
+import type { GenerationMode, ImageSchemaFunctionOptions, StaticImageDataSchema } from '../types';
 
-type CreateImageOptions = { optional?: boolean; mode: GenerationMode; shouldEmitFile: boolean; sourceFilePath: string };
+type CreateImageOptions = ImageSchemaFunctionOptions & {
+  mode: GenerationMode;
+  shouldEmitFile: boolean;
+  sourceFilePath: string;
+};
 
 export function createImage({ optional, shouldEmitFile, sourceFilePath }: CreateImageOptions): StaticImageDataSchema {
   const schema = optional ? z.string().optional() : z.string();

packages/markdownlayer/src/core/generation/index.ts

@@ -241,12 +241,12 @@ async function generateDocuments(options: GenerateDocsOptions): Promise<Generati
   if (typeof schema === 'function') {
     schema = schema({
       // TODO: figure out how to handle images in the schema without needing to pass the file path (module augmentation may help)
-      image: (optional) =>
+      image: (options) =>
         // @ts-expect-error - The type is correct but the error is due to the transform function
-        (optional ? z.string().optional() : z.string()).transform(
+        (options?.optional ? z.string().optional() : z.string()).transform(
           (): StaticImageData => ({ src: '', height: 0, width: 0 }),
         ),
-      // image: (optional) => createImage({ optional, shouldEmitFile: false, mode, sourceFilePath }),
+      // image: (options) => createImage({ ...options, shouldEmitFile: false, mode, sourceFilePath }),
     });
   }
 

packages/markdownlayer/src/core/types.ts

@@ -43,12 +43,19 @@ export type StaticImageDataSchema = ZodObject<{
   >;
 }>;
 
+export type ImageSchemaFunctionOptions = {
+  /** Whether the image is optional. */
+  optional?: boolean;
+
+  // other options like optimization with sharp would go here
+};
+
 /**
  * Schema for an image.
- * @param optional Whether the image is optional.
+ * @param options - Options for the image schema.
  * @returns A Zod object representing an image.
  */
-export type ImageSchemaFunction = (optional?: boolean) => StaticImageDataSchema;
+export type ImageSchemaFunction = (options?: ImageSchemaFunctionOptions) => StaticImageDataSchema;
 
 type DocumentDefinitionSchemaWithoutEffects =
   | AnyZodObject