michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fix(assets): Fix misc types issues (#8568)

Browse source 
* fix(assets): Fix misc types issues

* fix: remove unnecessary change

* chore: changeset
This commit is contained in:
Erika 2023-09-18 11:39:21 +02:00 committed by GitHub
parent 8d361169b8
commit 95b5f6280d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 13 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/fair-teachers-protect.md Normal file
View file

@ -0,0 +1,5 @@
---
'astro': patch
---
Fix small types issues related to `astro:assets`'s AVIF support and `getImage`

4
packages/astro/client.d.ts vendored
View file

@ -48,9 +48,7 @@ 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
| import('./dist/assets/types.js').UnresolvedImageTransform
options: import('./dist/assets/types.js').UnresolvedImageTransform
) => Promise<import('./dist/assets/types.js').GetImageResult>;
imageConfig: import('./dist/@types/astro.js').AstroConfig['image'];
getConfiguredImageService: typeof import('./dist/assets/index.js').getConfiguredImageService;

1
packages/astro/content-types.template.d.ts vendored
View file

@ -33,6 +33,7 @@ declare module 'astro:content' {
import('astro/zod').ZodLiteral<'webp'>,
import('astro/zod').ZodLiteral<'gif'>,
import('astro/zod').ZodLiteral<'svg'>,
import('astro/zod').ZodLiteral<'avif'>,
]
>;
}>;

1
packages/astro/src/@types/astro.ts
View file

@ -48,6 +48,7 @@ export type {
ImageQuality,
ImageQualityPreset,
ImageTransform,
UnresolvedImageTransform,
} from '../assets/types.js';
export type { RemotePattern } from '../assets/utils/remotePattern.js';
export type { SSRManifest } from '../core/app/types.js';

2
packages/astro/src/assets/internal.ts
View file

@ -67,7 +67,7 @@ export async function getConfiguredImageService(): Promise<ImageService> {
}
export async function getImage(
options: ImageTransform | UnresolvedImageTransform,
options: UnresolvedImageTransform,
imageConfig: AstroConfig['image']
): Promise<GetImageResult> {
if (!options || typeof options !== 'object') {

5
packages/astro/src/assets/types.ts
View file

@ -28,8 +28,11 @@ export interface ImageMetadata {
orientation?: number;
}
/**
* A yet to be resolved image transform. Used by `getImage`
*/
export type UnresolvedImageTransform = Omit<ImageTransform, 'src'> & {
src: Promise<{ default: ImageMetadata }>;
src: ImageMetadata | string | Promise<{ default: ImageMetadata }>;
};
/**