astro 5.9.3 → 5.10.0

package/dist/types/public/config.d.ts

@@ -123,7 +123,7 @@ interface BuiltinSessionConfig<TDriver extends keyof BuiltinDriverOptions> exten
 }
 interface CustomSessionConfig extends CommonSessionConfig {
     /** Entrypoint for a custom session driver */
-    driver: string;
+    driver?: string;
     options?: Record<string, unknown>;
 }
 interface TestSessionConfig extends CommonSessionConfig {
@@ -1242,58 +1242,70 @@ export interface ViteUserConfig extends OriginalViteUserConfig {
         remotePatterns?: Partial<RemotePattern>[];
         /**
          * @docs
-         * @name image.experimentalLayout
+         * @name image.layout
          * @type {ImageLayout}
          * @default `undefined`
+         * @version 5.10.0
          * @description
          * The default layout type for responsive images. Can be overridden by the `layout` prop on the image component.
-         * Requires the `experimental.responsiveImages` flag to be enabled.
          * - `constrained` - The image will scale to fit the container, maintaining its aspect ratio, but will not exceed the specified dimensions.
          * - `fixed` - The image will maintain its original dimensions.
          * - `full-width` - The image will scale to fit the container, maintaining its aspect ratio.
+         *
+         * See [the `layout` component property](https://docs.astro.build/en/reference/modules/astro-assets/#layout) for more details.
          */
-        experimentalLayout?: ImageLayout | undefined;
+        layout?: ImageLayout | undefined;
         /**
          * @docs
-         * @name image.experimentalObjectFit
+         * @name image.objectFit
          * @type {ImageFit}
          * @default `"cover"`
+         * @version 5.10.0
          * @description
          * The default object-fit value for responsive images. Can be overridden by the `fit` prop on the image component.
-         * Requires the `experimental.responsiveImages` flag to be enabled.
+         * Requires a value for `layout` to be set.
+         *
+         * See [the `fit` component property](https://docs.astro.build/en/reference/modules/astro-assets/#fit) for more details.
          */
-        experimentalObjectFit?: ImageFit;
+        objectFit?: ImageFit;
         /**
          * @docs
-         * @name image.experimentalObjectPosition
+         * @name image.objectPosition
          * @type {string}
          * @default `"center"`
+         * @version 5.10.0
          * @description
          * The default object-position value for responsive images. Can be overridden by the `position` prop on the image component.
-         * Requires the `experimental.responsiveImages` flag to be enabled.
+         * Requires a value for `layout` to be set.
+         *
+         * See [the `position` component property](https://docs.astro.build/en/reference/modules/astro-assets/#position) for more details.
          */
-        experimentalObjectPosition?: string;
+        objectPosition?: string;
         /**
          * @docs
-         * @name image.experimentalBreakpoints
+         * @name image.breakpoints
          * @type {number[]}
          * @default `[640, 750, 828, 1080, 1280, 1668, 2048, 2560] | [640, 750, 828, 960, 1080, 1280, 1668, 1920, 2048, 2560, 3200, 3840, 4480, 5120, 6016]`
+         * @version 5.10.0
          * @description
-         * The breakpoints used to generate responsive images. Requires the `experimental.responsiveImages` flag to be enabled. The full list is not normally used,
+         * The breakpoints used to generate responsive images. Requires a value for `layout` to be set. The full list is not normally used,
          * but is filtered according to the source and output size. The defaults used depend on whether a local or remote image service is used. For remote services
          * the more comprehensive list is used, because only the required sizes are generated. For local services, the list is shorter to reduce the number of images generated.
          */
-        experimentalBreakpoints?: number[];
+        breakpoints?: number[];
         /**
          * @docs
-         * @name image.experimentalDefaultStyles
+         * @name image.responsiveStyles
          * @type {boolean}
-         * @default `true`
+         * @default `false`
+         * @version 5.10.0
          * @description
-         * Whether to automatically add global styles to ensure that experimental images resize correctly. This is enabled by default, but can be disabled if you want to manage the styles yourself.
-         * This option is only used when the `experimental.responsiveImages` flag is enabled.
+         * Whether to automatically add global styles for responsive images. You should enable this option unless you are styling the images yourself.
+         * This option is only used when `layout` is set to `constrained`, `full-width`, or `fixed` using the configuration or the `layout` prop on the image component.
+         *
+         * See [the images docs](https://docs.astro.build/en/guides/images/#responsive-image-styles) for more information.
          */
-        experimentalDefaultStyles?: boolean;
+        responsiveStyles?: boolean;
     };
     /**
      * @docs
@@ -1974,119 +1986,6 @@ export interface ViteUserConfig extends OriginalViteUserConfig {
          * To use this feature with the Astro VS Code extension, you must also enable the `astro.content-intellisense` option in your VS Code settings. For editors using the Astro language server directly, pass the `contentIntellisense: true` initialization parameter to enable this feature.
          */
         contentIntellisense?: boolean;
-        /**
-         *
-         * @name experimental.responsiveImages
-         * @type {boolean}
-         * @default `undefined`
-         * @version 5.0.0
-         * @description
-         *
-         * Enables automatic responsive images in your project.
-         *
-         * ```js title=astro.config.mjs
-         * {
-         *    experimental: {
-         * 			responsiveImages: true,
-         * 		},
-         * }
-         * ```
-         *
-         * When enabled, you can pass a `layout` props to any `<Image />` or `<Picture />` component to create a responsive image. When a layout is set, images have automatically generated `srcset` and `sizes` attributes based on the image's dimensions and the layout type. Images with `constrained` and `full-width` layouts will have styles applied to ensure they resize according to their container.
-         *
-         * ```astro title=MyComponent.astro
-         * ---
-         * import { Image, Picture } from 'astro:assets';
-         * import myImage from '../assets/my_image.png';
-         * ---
-         * <Image src={myImage} alt="A description of my image." layout='constrained' width={800} height={600} />
-         * <Picture src={myImage} alt="A description of my image." layout='full-width' formats={['avif', 'webp', 'jpeg']} />
-         * ```
-         * This `<Image />` component will generate the following HTML output:
-         * ```html title=Output
-         *
-         * 	<img
-         *		src="/_astro/my_image.hash3.webp"
-         *		srcset="/_astro/my_image.hash1.webp 640w,
-         *						/_astro/my_image.hash2.webp 750w,
-         *						/_astro/my_image.hash3.webp 800w,
-         *						/_astro/my_image.hash4.webp 828w,
-         *						/_astro/my_image.hash5.webp 1080w,
-         *						/_astro/my_image.hash6.webp 1280w,
-         *						/_astro/my_image.hash7.webp 1600w"
-         *		alt="A description of my image"
-         *		sizes="(min-width: 800px) 800px, 100vw"
-         *		loading="lazy"
-         *		decoding="async"
-         *		fetchpriority="auto"
-         *		width="800"
-         *		height="600"
-         *		style="--fit: cover; --pos: center;"
-         *		data-astro-image="constrained"
-         *  >
-         * ```
-         *
-         * The following styles are applied to ensure the images resize correctly:
-         *
-         * ```css title="Responsive Image Styles"
-         *
-         * :where([data-astro-image]) {
-         *   object-fit: var(--fit);
-         *   object-position: var(--pos);
-         * }
-         *
-         * :where([data-astro-image='full-width']) {
-         *   width: 100%;
-         * }
-         *
-         * :where([data-astro-image='constrained']) {
-         *   max-width: 100%;
-         * }
-         *
-         * ```
-         * You can enable responsive images for all `<Image />` and `<Picture />` components by setting `image.experimentalLayout` with a default value. This can be overridden by the `layout` prop on each component.
-         *
-         * **Example:**
-         * ```js title=astro.config.mjs
-         * {
-         * 		image: {
-         * 			// Used for all `<Image />` and `<Picture />` components unless overridden
-         * 			experimentalLayout: 'constrained',
-         * 		},
-         * 		experimental: {
-         * 			responsiveImages: true,
-         * 		},
-         * }
-         * ```
-         *
-         * ```astro title=MyComponent.astro
-         * ---
-         * import { Image } from 'astro:assets';
-         * import myImage from '../assets/my_image.png';
-         * ---
-         *
-         * <Image src={myImage} alt="This will use responsive layout" width={800} height={600} />
-         *
-         * <Image src={myImage} alt="This will use full-width layout" layout="full-width" />
-         *
-         * <Image src={myImage} alt="This will disable responsive images" layout="none" />
-         * ```
-         *
-         * #### Responsive image properties
-         *
-         * These are additional properties available to the `<Image />` and `<Picture />` components when responsive images are enabled:
-         *
-         * - `layout`: The layout type for the image. Can be `constrained`, `fixed`, `full-width` or `none`. Defaults to value of `image.experimentalLayout`.
-         * - `fit`: Defines how the image should be cropped if the aspect ratio is changed. Values match those of CSS `object-fit`. Defaults to `cover`, or the value of `image.experimentalObjectFit` if set.
-         * - `position`: Defines the position of the image crop if the aspect ratio is changed. Values match those of CSS `object-position`. Defaults to `center`, or the value of `image.experimentalObjectPosition` if set.
-         * - `priority`: If set, eagerly loads the image. Otherwise images will be lazy-loaded. Use this for your largest above-the-fold image. Defaults to `false`.
-         *
-         * The `widths` and `sizes` attributes are automatically generated based on the image's dimensions and the layout type, and in most cases should not be set manually. The generated `sizes` attribute for `constrained` and `full-width` images
-         * is based on the assumption that the image is displayed at close to the full width of the screen when the viewport is smaller than the image's width. If it is significantly different (e.g. if it's in a multi-column layout on small screens) you may need to adjust the `sizes` attribute manually for best results.
-         *
-         * The `densities` attribute is not compatible with responsive images and will be ignored if set.
-         */
-        responsiveImages?: boolean;
         /**
          *
          * @name experimental.fonts
@@ -2397,6 +2296,16 @@ export interface ViteUserConfig extends OriginalViteUserConfig {
          *
          */
         preserveScriptOrder?: boolean;
+        /**
+         * @name experimental.liveContentCollections
+         * @type {boolean}
+         * @default `false`
+         * @version 5.x
+         * @description
+         * Enables the use of live content collections.
+         *
+         */
+        liveContentCollections?: boolean;
     };
 }
 /**

package/dist/types/public/content.d.ts

@@ -1,6 +1,7 @@
 import type { MarkdownHeading } from '@astrojs/markdown-remark';
 import type * as rollup from 'rollup';
 import type { DataEntry, RenderedContent } from '../../content/data-store.js';
+import type { LiveCollectionError } from '../../content/loaders/errors.js';
 import type { AstroComponentFactory } from '../../runtime/server/index.js';
 import type { AstroConfig } from './config.js';
 export interface AstroInstance {
@@ -108,4 +109,33 @@ export type GetDataEntryInfoReturnType = {
     data: Record<string, unknown>;
     rawData?: string;
 };
+export interface CacheHint {
+    /** Cache tags */
+    tags?: Array<string>;
+    /** Maximum age of the response in seconds */
+    maxAge?: number;
+}
+export interface LiveDataEntry<TData extends Record<string, any> = Record<string, unknown>> {
+    /** The ID of the entry. Unique per collection. */
+    id: string;
+    /** The parsed entry data */
+    data: TData;
+    /** A hint for how to cache this entry */
+    cacheHint?: CacheHint;
+}
+export interface LiveDataCollection<TData extends Record<string, any> = Record<string, unknown>> {
+    entries: Array<LiveDataEntry<TData>>;
+    /** A hint for how to cache this collection. Individual entries can also have cache hints */
+    cacheHint?: CacheHint;
+}
+export interface LiveDataCollectionResult<TData extends Record<string, any> = Record<string, unknown>, TError extends Error = Error> {
+    entries?: Array<LiveDataEntry<TData>>;
+    error?: TError | LiveCollectionError;
+    cacheHint?: CacheHint;
+}
+export interface LiveDataEntryResult<TData extends Record<string, any> = Record<string, unknown>, TError extends Error = Error> {
+    entry?: LiveDataEntry<TData>;
+    error?: TError | LiveCollectionError;
+    cacheHint?: CacheHint;
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro",
-  "version": "5.9.3",
+  "version": "5.10.0",
   "description": "Astro is a modern site builder with web best practices, performance, and DX front-of-mind.",
   "type": "module",
   "author": "withastro",
@@ -64,6 +64,7 @@
     "./assets/services/noop": "./dist/assets/services/noop.js",
     "./assets/fonts/providers/*": "./dist/assets/fonts/providers/entrypoints/*.js",
     "./loaders": "./dist/content/loaders/index.js",
+    "./content/config": "./dist/content/config.js",
     "./content/runtime": "./dist/content/runtime.js",
     "./content/runtime-assets": "./dist/content/runtime-assets.js",
     "./debug": "./components/Debug.astro",
@@ -157,8 +158,8 @@
     "zod-to-json-schema": "^3.24.5",
     "zod-to-ts": "^1.2.0",
     "@astrojs/internal-helpers": "0.6.1",
-    "@astrojs/telemetry": "3.3.0",
-    "@astrojs/markdown-remark": "6.3.2"
+    "@astrojs/markdown-remark": "6.3.2",
+    "@astrojs/telemetry": "3.3.0"
   },
   "optionalDependencies": {
     "sharp": "^0.33.3"

package/templates/content/module.mjs

@@ -6,12 +6,16 @@ import {
 	createGetEntries,
 	createGetEntry,
 	createGetEntryBySlug,
+	createGetLiveCollection,
+	createGetLiveEntry,
 	createReference,
 } from 'astro/content/runtime';
 
 export { defineCollection, renderEntry as render } from 'astro/content/runtime';
 export { z } from 'astro/zod';
 
+/* @@LIVE_CONTENT_CONFIG@@ */
+
 const contentDir = '@@CONTENT_DIR@@';
 
 const contentEntryGlob = '@@CONTENT_ENTRY_GLOB_PATH@@';
@@ -56,12 +60,14 @@ export const getCollection = createGetCollection({
 	dataCollectionToEntryMap,
 	getRenderEntryImport: createGlobLookup(collectionToRenderEntryMap),
 	cacheEntriesByCollection,
+	liveCollections,
 });
 
 export const getEntry = createGetEntry({
 	getEntryImport: createGlobLookup(collectionToEntryMap),
 	getRenderEntryImport: createGlobLookup(collectionToRenderEntryMap),
 	collectionNames,
+	liveCollections,
 });
 
 export const getEntryBySlug = createGetEntryBySlug({
@@ -80,3 +86,11 @@ export const getDataEntryById = createGetDataEntryById({
 export const getEntries = createGetEntries(getEntry);
 
 export const reference = createReference({ lookupMap });
+
+export const getLiveCollection = createGetLiveCollection({
+	liveCollections,
+});
+
+export const getLiveEntry = createGetLiveEntry({
+	liveCollections,
+});

package/templates/content/types.d.ts

@@ -45,6 +45,10 @@ declare module 'astro:content' {
 		collection: C;
 		slug: E;
 	};
+	export type ReferenceLiveEntry<C extends keyof LiveContentConfig['collections']> = {
+		collection: C;
+		id: string;
+	};
 
 	/** @deprecated Use `getEntry` instead. */
 	export function getEntryBySlug<
@@ -73,6 +77,13 @@ declare module 'astro:content' {
 		filter?: (entry: CollectionEntry<C>) => unknown,
 	): Promise<CollectionEntry<C>[]>;
 
+	export function getLiveCollection<C extends keyof LiveContentConfig['collections']>(
+		collection: C,
+		filter?: LiveLoaderCollectionFilterType<C>,
+	): Promise<
+		import('astro').LiveDataCollectionResult<LiveLoaderDataType<C>, LiveLoaderErrorType<C>>
+	>;
+
 	export function getEntry<
 		C extends keyof ContentEntryMap,
 		E extends ValidContentEntrySlug<C> | (string & {}),
@@ -109,6 +120,10 @@ declare module 'astro:content' {
 			? Promise<DataEntryMap[C][E]> | undefined
 			: Promise<DataEntryMap[C][E]>
 		: Promise<CollectionEntry<C> | undefined>;
+	export function getLiveEntry<C extends keyof LiveContentConfig['collections']>(
+		collection: C,
+		filter: string | LiveLoaderEntryFilterType<C>,
+	): Promise<import('astro').LiveDataEntryResult<LiveLoaderDataType<C>, LiveLoaderErrorType<C>>>;
 
 	/** Resolve an array of entry references from the same collection */
 	export function getEntries<C extends keyof ContentEntryMap>(
@@ -152,5 +167,33 @@ declare module 'astro:content' {
 
 	type AnyEntryMap = ContentEntryMap & DataEntryMap;
 
+	type ExtractLoaderTypes<T> = T extends import('astro/loaders').LiveLoader<
+		infer TData,
+		infer TEntryFilter,
+		infer TCollectionFilter,
+		infer TError
+	>
+		? { data: TData; entryFilter: TEntryFilter; collectionFilter: TCollectionFilter; error: TError }
+		: { data: never; entryFilter: never; collectionFilter: never; error: never };
+	type ExtractDataType<T> = ExtractLoaderTypes<T>['data'];
+	type ExtractEntryFilterType<T> = ExtractLoaderTypes<T>['entryFilter'];
+	type ExtractCollectionFilterType<T> = ExtractLoaderTypes<T>['collectionFilter'];
+	type ExtractErrorType<T> = ExtractLoaderTypes<T>['error'];
+
+	type LiveLoaderDataType<C extends keyof LiveContentConfig['collections']> =
+		LiveContentConfig['collections'][C]['schema'] extends undefined
+			? ExtractDataType<LiveContentConfig['collections'][C]['loader']>
+			: import('astro/zod').infer<
+					Exclude<LiveContentConfig['collections'][C]['schema'], undefined>
+				>;
+	type LiveLoaderEntryFilterType<C extends keyof LiveContentConfig['collections']> =
+		ExtractEntryFilterType<LiveContentConfig['collections'][C]['loader']>;
+	type LiveLoaderCollectionFilterType<C extends keyof LiveContentConfig['collections']> =
+		ExtractCollectionFilterType<LiveContentConfig['collections'][C]['loader']>;
+	type LiveLoaderErrorType<C extends keyof LiveContentConfig['collections']> = ExtractErrorType<
+		LiveContentConfig['collections'][C]['loader']
+	>;
+
 	export type ContentConfig = '@@CONTENT_CONFIG_TYPE@@';
+	export type LiveContentConfig = '@@LIVE_CONTENT_CONFIG_TYPE@@';
 }

package/types/content.d.ts

@@ -1,85 +1,24 @@
 declare module 'astro:content' {
 	export { z } from 'astro/zod';
-
-	// This needs to be in sync with ImageMetadata
-	export type ImageFunction = () => import('astro/zod').ZodObject<{
-		src: import('astro/zod').ZodString;
-		width: import('astro/zod').ZodNumber;
-		height: import('astro/zod').ZodNumber;
-		format: import('astro/zod').ZodUnion<
-			[
-				import('astro/zod').ZodLiteral<'png'>,
-				import('astro/zod').ZodLiteral<'jpg'>,
-				import('astro/zod').ZodLiteral<'jpeg'>,
-				import('astro/zod').ZodLiteral<'tiff'>,
-				import('astro/zod').ZodLiteral<'webp'>,
-				import('astro/zod').ZodLiteral<'gif'>,
-				import('astro/zod').ZodLiteral<'svg'>,
-				import('astro/zod').ZodLiteral<'avif'>,
-			]
-		>;
-	}>;
-
-	export interface DataEntry {
-		id: string;
-		data: Record<string, unknown>;
-		filePath?: string;
-		body?: string;
-	}
-
-	export interface DataStore {
-		get: (key: string) => DataEntry;
-		entries: () => Array<[id: string, DataEntry]>;
-		set: (key: string, data: Record<string, unknown>, body?: string, filePath?: string) => void;
-		values: () => Array<DataEntry>;
-		keys: () => Array<string>;
-		delete: (key: string) => void;
-		clear: () => void;
-		has: (key: string) => boolean;
-	}
-
-	export interface MetaStore {
-		get: (key: string) => string | undefined;
-		set: (key: string, value: string) => void;
-		delete: (key: string) => void;
-		has: (key: string) => boolean;
-	}
-
-	export type BaseSchema = import('astro/zod').ZodType;
-
-	export type SchemaContext = { image: ImageFunction };
-
-	type ContentLayerConfig<S extends BaseSchema, TData extends { id: string } = { id: string }> = {
-		type?: 'content_layer';
-		schema?: S | ((context: SchemaContext) => S);
-		loader:
-			| import('astro/loaders').Loader
-			| (() =>
-					| Array<TData>
-					| Promise<Array<TData>>
-					| Record<string, Omit<TData, 'id'> & { id?: string }>
-					| Promise<Record<string, Omit<TData, 'id'> & { id?: string }>>);
-	};
-
-	type DataCollectionConfig<S extends BaseSchema> = {
-		type: 'data';
-		schema?: S | ((context: SchemaContext) => S);
-	};
-
-	type ContentCollectionConfig<S extends BaseSchema> = {
-		type?: 'content';
-		schema?: S | ((context: SchemaContext) => S);
-		loader?: never;
-	};
-
-	export type CollectionConfig<S extends BaseSchema> =
-		| ContentCollectionConfig<S>
-		| DataCollectionConfig<S>
-		| ContentLayerConfig<S>;
-
-	export function defineCollection<S extends BaseSchema>(
-		input: CollectionConfig<S>,
-	): CollectionConfig<S>;
+	export type {
+		ImageFunction,
+		DataEntry,
+		DataStore,
+		MetaStore,
+		BaseSchema,
+		SchemaContext,
+	} from 'astro/content/config';
+
+	export function defineLiveCollection<
+		L extends import('astro/loader').LiveLoader,
+		S extends import('astro/content/config').BaseSchema | undefined = undefined,
+	>(
+		config: import('astro/content/config').LiveCollectionConfig<L, S>,
+	): import('astro/content/config').LiveCollectionConfig<L, S>;
+
+	export function defineCollection<S extends import('astro/content/config').BaseSchema>(
+		config: import('astro/content/config').CollectionConfig<S>,
+	): import('astro/content/config').CollectionConfig<S>;
 
 	/** Run `astro dev` or `astro sync` to generate high fidelity types */
 	export const getEntryBySlug: (...args: any[]) => any;
@@ -106,4 +45,8 @@ declare module 'astro:content' {
 	export type ContentConfig = any;
 	/** Run `astro dev` or `astro sync` to generate high fidelity types */
 	export const render: (entry: any) => any;
+	/** Run `astro dev` or `astro sync` to generate high fidelity types */
+	export const getLiveCollection: (...args: any[]) => any;
+	/** Run `astro dev` or `astro sync` to generate high fidelity types */
+	export const getLiveEntry: (...args: any[]) => any;
 }