refactor: update ComponentsOptions and related functions for consistent parameter order and required fields

Author: felixicaza

src/types/components-options.type.ts

@@ -2,10 +2,10 @@ import type { LqipType } from './lqip.type'
 
 export type ComponentsOptions = {
   src: string | object
-  lqip?: LqipType
-  lqipSize?: number
-  styleProps?: Record<string, any>
-  forbiddenVars?: string[]
-  isDevelopment?: boolean
-  isPrerendered?: boolean | undefined
+  lqip: LqipType
+  lqipSize: number
+  styleProps: Record<string, any>
+  forbiddenVars: string[]
+  isDevelopment: boolean | undefined
+  isPrerendered: boolean | undefined
 }

src/utils/generateLqip.ts

@@ -6,7 +6,12 @@ import { PREFIX } from '../constants'
 
 import { getPlaiceholder } from 'plaiceholder'
 
-export async function generateLqip(imagePath: string, isDevelopment: boolean, lqipType: LqipType, lqipSize: number) {
+export async function generateLqip(
+  imagePath: string,
+  lqipType: LqipType,
+  lqipSize: number,
+  isDevelopment: boolean | undefined
+) {
   try {
     const buffer = await readFile(imagePath)
     const plaiceholderResult = await getPlaiceholder(buffer, { size: lqipSize })

src/utils/getLqip.ts

@@ -18,7 +18,13 @@ async function ensureCacheDir() {
   }
 }
 
-export async function getLqip(imagePath: { src: string }, isDevelopment: boolean, isPrerendered: boolean | undefined, lqipType: LqipType, lqipSize: number) {
+export async function getLqip(
+  imagePath: { src: string },
+  lqipType: LqipType,
+  lqipSize: number,
+  isDevelopment: boolean | undefined,
+  isPrerendered: boolean | undefined
+) {
   if (!imagePath?.src) return undefined
 
   if (isRemoteUrl(imagePath.src)) {
@@ -33,7 +39,7 @@ export async function getLqip(imagePath: { src: string }, isDevelopment: boolean
     await writeFile(tempPath, buffer)
 
     try {
-      const lqip = await generateLqip(tempPath, isDevelopment, lqipType, lqipSize)
+      const lqip = await generateLqip(tempPath, lqipType, lqipSize, isDevelopment)
       return lqip
     } finally {
       await unlink(tempPath)
@@ -42,17 +48,17 @@ export async function getLqip(imagePath: { src: string }, isDevelopment: boolean
 
   if (isDevelopment && imagePath.src.startsWith('/@fs/')) {
     const filePath = imagePath.src.replace(/^\/@fs/, '').split('?')[0]
-    return await generateLqip(filePath, isDevelopment, lqipType, lqipSize)
+    return await generateLqip(filePath, lqipType, lqipSize, isDevelopment)
   }
 
   if (!isPrerendered && !isDevelopment) {
     const filePath = join(process.cwd(), 'dist', 'client', imagePath.src)
-    return await generateLqip(filePath, isDevelopment, lqipType, lqipSize)
+    return await generateLqip(filePath, lqipType, lqipSize, isDevelopment)
   }
 
   if (!isDevelopment && imagePath.src.startsWith('/_astro/')) {
     const buildPath = join(process.cwd(), 'dist', imagePath.src)
-    return await generateLqip(buildPath, isDevelopment, lqipType, lqipSize)
+    return await generateLqip(buildPath, lqipType, lqipSize, isDevelopment)
   }
 
   return undefined

src/utils/useLqipImage.ts

@@ -13,7 +13,7 @@ export async function useLqipImage({
   lqipSize = 4,
   styleProps = {},
   forbiddenVars = ['--lqip-background', '--z-index', '--opacity'],
-  isDevelopment = false,
+  isDevelopment,
   isPrerendered
 }: ComponentsOptions) {
   let getImagePath: string | { src: string } | null
@@ -29,7 +29,7 @@ export async function useLqipImage({
   let lqipImage
   if (getImagePath) {
     const lqipInput = typeof getImagePath === 'string' ? { src: getImagePath } : getImagePath
-    lqipImage = await getLqip(lqipInput, isDevelopment, isPrerendered, lqip, lqipSize)
+    lqipImage = await getLqip(lqipInput, lqip, lqipSize, isDevelopment, isPrerendered)
   }
 
   let svgHTML = ''