Skip to content

Commit

Permalink
feat(assets): Add support for passing non-awaited imports to the Imag…
Browse files Browse the repository at this point in the history
…e component and `getImage`
  • Loading branch information
Princesseuh committed Aug 14, 2023
1 parent 41cfde9 commit de047ad
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 6 deletions.
5 changes: 5 additions & 0 deletions .changeset/odd-plants-tie.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'astro': patch
---

Add support for non-awaited imports to the Image component and `getImage`
4 changes: 3 additions & 1 deletion packages/astro/client-base.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,9 @@ declare module 'astro:assets' {
* This is functionally equivalent to using the `<Image />` component, as the component calls this function internally.
*/
getImage: (
options: import('./dist/assets/types.js').ImageTransform
options:
| import('./dist/assets/types.js').ImageTransform
| import('./dist/assets/types.js').UnresolvedImageTransform
) => Promise<import('./dist/assets/types.js').GetImageResult>;
getConfiguredImageService: typeof import('./dist/assets/index.js').getConfiguredImageService;
Image: typeof import('./components/Image.astro').default;
Expand Down
25 changes: 20 additions & 5 deletions packages/astro/src/assets/internal.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
import type { AstroSettings } from '../@types/astro.js';
import { AstroError, AstroErrorData } from '../core/errors/index.js';
import { isLocalService, type ImageService } from './services/service.js';
import type { GetImageResult, ImageMetadata, ImageTransform } from './types.js';
import type {
GetImageResult,
ImageMetadata,
ImageTransform,
UnresolvedImageTransform,
} from './types.js';

export function injectImageEndpoint(settings: AstroSettings) {
settings.injectedRoutes.push({
Expand Down Expand Up @@ -37,7 +42,7 @@ export async function getConfiguredImageService(): Promise<ImageService> {
}

export async function getImage(
options: ImageTransform,
options: ImageTransform | UnresolvedImageTransform,
serviceConfig: Record<string, any>
): Promise<GetImageResult> {
if (!options || typeof options !== 'object') {
Expand All @@ -48,9 +53,19 @@ export async function getImage(
}

const service = await getConfiguredImageService();

// If the user inlined an import, something fairly common especially in MDX, await it for them
const resolvedOptions: ImageTransform = {
...options,
src:
typeof options.src === 'object' && 'then' in options.src
? (await options.src).default
: options.src,
};

const validatedOptions = service.validateOptions
? await service.validateOptions(options, serviceConfig)
: options;
? await service.validateOptions(resolvedOptions, serviceConfig)
: resolvedOptions;

let imageURL = await service.getURL(validatedOptions, serviceConfig);

Expand All @@ -60,7 +75,7 @@ export async function getImage(
}

return {
rawOptions: options,
rawOptions: resolvedOptions,
options: validatedOptions,
src: imageURL,
attributes:
Expand Down
4 changes: 4 additions & 0 deletions packages/astro/src/assets/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ export interface ImageMetadata {
orientation?: number;
}

export type UnresolvedImageTransform = Omit<ImageTransform, 'src'> & {
src: Promise<{ default: ImageMetadata }>;
};

/**
* Options accepted by the image transformation service.
*/
Expand Down

0 comments on commit de047ad

Please sign in to comment.