astro 4.0.0-beta.3 → 4.0.0-beta.5

package/LICENSE

@@ -20,7 +20,6 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
-
 """
 This license applies to parts of the `packages/create-astro` and `packages/astro` subdirectories originating from the https://github.com/sveltejs/kit repository:
 
@@ -33,7 +32,6 @@ The above copyright notice and this permission notice shall be included in all c
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 """
 
-
 """
 This license applies to parts of the `packages/create-astro` and `packages/astro` subdirectories originating from the https://github.com/vitejs/vite repository:
 

package/dist/@types/astro.d.ts

@@ -1057,6 +1057,7 @@ export interface AstroUserConfig {
      * @docs
      * @kind heading
      * @name Dev Overlay Options
+     * @deprecated Use `devToolbar` instead.
      */
     devOverlay?: {
         /**
@@ -1080,6 +1081,33 @@ export interface AstroUserConfig {
          */
         defaultState: 'minimized' | 'expanded';
     };
+    /**
+     * @docs
+     * @kind heading
+     * @name Dev Toolbar Options
+     */
+    devToolbar?: {
+        /**
+         * @docs
+         * @name devToolbar.enabled
+         * @type {boolean}
+         * @default `true`
+         * @description
+         * Whether to enable the Astro Dev Toolbar. This toolbar allows you to inspect your page islands, see helpful audits on performance and accessibility, and more.
+         *
+         * This option is scoped to the entire project, to only disable the toolbar for yourself, run `npm run astro preferences disable devToolbar`. To disable the toolbar for all your Astro projects, run `npm run astro preferences disable devToolbar --global`.
+         */
+        enabled: boolean;
+        /**
+         * @docs
+         * @name devToolbar.defaultState
+         * @type {'minimized' | 'expanded'}
+         * @default `minimized`
+         * @description
+         * Whether the Dev Toolbar should be expanded or minimized by default.
+         */
+        defaultState: 'minimized' | 'expanded';
+    };
     /**
      * @docs
      * @kind heading
@@ -1274,141 +1302,141 @@ export interface AstroUserConfig {
      * Astro offers experimental flags to give users early access to new features.
      * These flags are not guaranteed to be stable.
      */
-    experimental?: {
+    /**
+     * @docs
+     * @name i18n
+     * @type {object}
+     * @version 3.5.0
+     * @type {object}
+     * @description
+     *
+     * Configures experimental i18n routing and allows you to specify some customization options.
+     *
+     * See our guide for more information on [internationalization in Astro](/en/guides/internationalization/)
+     */
+    i18n?: {
         /**
          * @docs
-         * @name experimental.optimizeHoistedScript
-         * @type {boolean}
-         * @default `false`
-         * @version 2.10.4
+         * @kind h4
+         * @name i18n.defaultLocale
+         * @type {string}
+         * @version 3.5.0
          * @description
-         * Prevents unused components' scripts from being included in a page unexpectedly.
-         * The optimization is best-effort and may inversely miss including the used scripts. Make sure to double-check your built pages
-         * before publishing.
-         * Enable hoisted script analysis optimization by adding the experimental flag:
+         *
+         * The default locale of your website/application. This is a required field.
+         *
+         * No particular language format or syntax is enforced, but we suggest using lower-case and hyphens as needed (e.g. "es", "pt-br") for greatest compatibility.
+         */
+        defaultLocale: string;
+        /**
+         * @docs
+         * @kind h4
+         * @name i18n.locales
+         * @type {Locales}
+         * @version 3.5.0
+         * @description
+         *
+         * A list of all locales supported by the website, including the `defaultLocale`. This is a required field.
+         *
+         * Languages can be listed either as individual codes (e.g. `['en', 'es', 'pt-br']`) or mapped to a shared `path` of codes (e.g.  `{ path: "english", codes: ["en", "en-US"]}`). These codes will be used to determine the URL structure of your deployed site.
+         *
+         * No particular language code format or syntax is enforced, but your project folders containing your content files must match exactly the `locales` items in the list. In the case of multiple `codes` pointing to a custom URL path prefix, store your content files in a folder with the same name as the `path` configured.
+         */
+        locales: Locales;
+        /**
+         * @docs
+         * @kind h4
+         * @name i18n.fallback
+         * @type {Record<string, string>}
+         * @version 3.5.0
+         * @description
+         *
+         * The fallback strategy when navigating to pages that do not exist (e.g. a translated page has not been created).
+         *
+         * Use this object to declare a fallback `locale` route for each language you support. If no fallback is specified, then unavailable pages will return a 404.
+         *
+         * ##### Example
+         *
+         * The following example configures your content fallback strategy to redirect unavailable pages in `/pt-br/` to their `es` version, and unavailable pages in `/fr/` to their `en` version. Unavailable `/es/` pages will return a 404.
          *
          * ```js
-         * {
+         * export default defineConfig({
          * 	experimental: {
-         *		optimizeHoistedScript: true,
-         * 	},
-         * }
+         * 		i18n: {
+         * 			defaultLocale: "en",
+         * 			locales: ["en", "fr", "pt-br", "es"],
+         * 			fallback: {
+         * 				pt: "es",
+         * 			  fr: "en"
+         * 			}
+         * 		}
+         * 	}
+         * })
          * ```
          */
-        optimizeHoistedScript?: boolean;
+        fallback?: Record<string, string>;
         /**
          * @docs
-         * @name experimental.i18n
-         * @type {object}
-         * @version 3.5.0
-         * @type {object}
+         * @kind h4
+         * @name i18n.routing
+         * @type {Routing}
+         * @version 3.7.0
          * @description
          *
-         * Configures experimental i18n routing and allows you to specify some customization options.
-         *
-         * See our guide for more information on [internationalization in Astro](/en/guides/internationalization/)
+         * Controls the routing strategy to determine your site URLs. Set this based on your folder/URL path configuration for your default language.
          */
-        i18n?: {
+        routing?: {
             /**
              * @docs
-             * @kind h4
-             * @name experimental.i18n.defaultLocale
-             * @type {string}
-             * @version 3.5.0
-             * @description
-             *
-             * The default locale of your website/application. This is a required field.
-             *
-             * No particular language format or syntax is enforced, but we suggest using lower-case and hyphens as needed (e.g. "es", "pt-br") for greatest compatibility.
-             */
-            defaultLocale: string;
-            /**
-             * @docs
-             * @kind h4
-             * @name experimental.i18n.locales
-             * @type {Locales}
-             * @version 3.5.0
-             * @description
-             *
-             * A list of all locales supported by the website, including the `defaultLocale`. This is a required field.
-             *
-             * Languages can be listed either as individual codes (e.g. `['en', 'es', 'pt-br']`) or mapped to a shared `path` of codes (e.g.  `{ path: "english", codes: ["en", "en-US"]}`). These codes will be used to determine the URL structure of your deployed site.
-             *
-             * No particular language code format or syntax is enforced, but your project folders containing your content files must match exactly the `locales` items in the list. In the case of multiple `codes` pointing to a custom URL path prefix, store your content files in a folder with the same name as the `path` configured.
-             */
-            locales: Locales;
-            /**
-             * @docs
-             * @kind h4
-             * @name experimental.i18n.fallback
-             * @type {Record<string, string>}
-             * @version 3.5.0
+             * @name i18n.routing.prefixDefaultLocale
+             * @type {boolean}
+             * @default `false`
+             * @version 3.7.0
              * @description
              *
-             * The fallback strategy when navigating to pages that do not exist (e.g. a translated page has not been created).
-             *
-             * Use this object to declare a fallback `locale` route for each language you support. If no fallback is specified, then unavailable pages will return a 404.
-             *
-             * ##### Example
-             *
-             * The following example configures your content fallback strategy to redirect unavailable pages in `/pt-br/` to their `es` version, and unavailable pages in `/fr/` to their `en` version. Unavailable `/es/` pages will return a 404.
+             * When `false`, only non-default languages will display a language prefix.
+             * The `defaultLocale` will not show a language prefix and content files do not exist in a localized folder.
+             *  URLs will be of the form `example.com/[locale]/content/` for all non-default languages, but `example.com/content/` for the default locale.
              *
-             * ```js
-             * export default defineConfig({
-             * 	experimental: {
-             * 		i18n: {
-             * 			defaultLocale: "en",
-             * 			locales: ["en", "fr", "pt-br", "es"],
-             * 			fallback: {
-             * 				pt: "es",
-             * 			  fr: "en"
-             * 			}
-             * 		}
-             * 	}
-             * })
-             * ```
+             * When `true`, all URLs will display a language prefix.
+             * URLs will be of the form `example.com/[locale]/content/` for every route, including the default language.
+             * Localized folders are used for every language, including the default.
              */
-            fallback?: Record<string, string>;
+            prefixDefaultLocale: boolean;
             /**
-             * @docs
-             * @kind h4
-             * @name experimental.i18n.routing
-             * @type {Routing}
+             * @name i18n.routing.strategy
+             * @type {"pathname"}
+             * @default `"pathname"`
              * @version 3.7.0
              * @description
              *
-             * Controls the routing strategy to determine your site URLs. Set this based on your folder/URL path configuration for your default language.
+             * - `"pathanme": The strategy is applied to the pathname of the URLs
              */
-            routing?: {
-                /**
-                 * @docs
-                 * @name experimental.i18n.routing.prefixDefaultLocale
-                 * @type {boolean}
-                 * @default `false`
-                 * @version 3.7.0
-                 * @description
-                 *
-                 * When `false`, only non-default languages will display a language prefix.
-                 * The `defaultLocale` will not show a language prefix and content files do not exist in a localized folder.
-                 *  URLs will be of the form `example.com/[locale]/content/` for all non-default languages, but `example.com/content/` for the default locale.
-                 *
-                 * When `true`, all URLs will display a language prefix.
-                 * URLs will be of the form `example.com/[locale]/content/` for every route, including the default language.
-                 * Localized folders are used for every language, including the default.
-                 */
-                prefixDefaultLocale: boolean;
-                /**
-                 * @name experimental.i18n.routing.strategy
-                 * @type {"pathname"}
-                 * @default `"pathname"`
-                 * @version 3.7.0
-                 * @description
-                 *
-                 * - `"pathanme": The strategy is applied to the pathname of the URLs
-                 */
-                strategy: 'pathname';
-            };
+            strategy: 'pathname';
         };
+    };
+    experimental?: {
+        /**
+         * @docs
+         * @name experimental.optimizeHoistedScript
+         * @type {boolean}
+         * @default `false`
+         * @version 2.10.4
+         * @description
+         * Prevents unused components' scripts from being included in a page unexpectedly.
+         * The optimization is best-effort and may inversely miss including the used scripts. Make sure to double-check your built pages
+         * before publishing.
+         * Enable hoisted script analysis optimization by adding the experimental flag:
+         *
+         * ```js
+         * {
+         * 	experimental: {
+         *		optimizeHoistedScript: true,
+         * 	},
+         * }
+         * ```
+         */
+        optimizeHoistedScript?: boolean;
         /**
          * @docs
          * @name experimental.contentCollectionCache
@@ -1574,7 +1602,7 @@ export interface AstroSettings {
      * Map of directive name (e.g. `load`) to the directive script code
      */
     clientDirectives: Map<string, string>;
-    devOverlayPlugins: string[];
+    devToolbarApps: string[];
     middlewares: {
         pre: string[];
         post: string[];
@@ -2051,7 +2079,11 @@ export interface AstroIntegration {
             injectScript: (stage: InjectedScriptStage, content: string) => void;
             injectRoute: (injectRoute: InjectedRoute) => void;
             addClientDirective: (directive: ClientDirectiveConfig) => void;
+            /**
+             * @deprecated Use `addDevToolbarApp` instead.
+             */
             addDevOverlayPlugin: (entrypoint: string) => void;
+            addDevToolbarApp: (entrypoint: string) => void;
             addMiddleware: (mid: AstroIntegrationMiddleware) => void;
             logger: AstroIntegrationLogger;
         }) => void | Promise<void>;
@@ -2255,13 +2287,14 @@ export interface ClientDirectiveConfig {
     name: string;
     entrypoint: string;
 }
-export interface DevOverlayPlugin {
+export interface DevToolbarApp {
     id: string;
     name: string;
     icon: Icon;
     init?(canvas: ShadowRoot, eventTarget: EventTarget): void | Promise<void>;
     beforeTogglingOff?(canvas: ShadowRoot): boolean | Promise<boolean>;
 }
+export type DevOverlayPlugin = DevToolbarApp;
 export type DevOverlayMetadata = Window & typeof globalThis & {
     __astro_dev_overlay__: {
         defaultState: AstroConfig['devOverlay']['defaultState'];
@@ -2272,6 +2305,16 @@ export type DevOverlayMetadata = Window & typeof globalThis & {
 };
 declare global {
     interface HTMLElementTagNameMap {
+        'astro-dev-toolbar': AstroDevOverlay;
+        'astro-dev-toolbar-window': DevOverlayWindow;
+        'astro-dev-toolbar-plugin-canvas': DevOverlayCanvas;
+        'astro-dev-toolbar-tooltip': DevOverlayTooltip;
+        'astro-dev-toolbar-highlight': DevOverlayHighlight;
+        'astro-dev-toolbar-toggle': DevOverlayToggle;
+        'astro-dev-toolbar-badge': DevOverlayBadge;
+        'astro-dev-toolbar-button': DevOverlayButton;
+        'astro-dev-toolbar-icon': DevOverlayIcon;
+        'astro-dev-toolbar-card': DevOverlayCard;
         'astro-dev-overlay': AstroDevOverlay;
         'astro-dev-overlay-window': DevOverlayWindow;
         'astro-dev-overlay-plugin-canvas': DevOverlayCanvas;

package/dist/assets/build/generate.d.ts

@@ -1,4 +1,4 @@
-import PQueue from 'p-queue';
+import type PQueue from 'p-queue';
 import type { AstroConfig } from '../../@types/astro.js';
 import type { BuildPipeline } from '../../core/build/buildPipeline.js';
 import type { Logger } from '../../core/logger/core.js';

package/dist/assets/build/generate.js

@@ -1,7 +1,6 @@
 import { dim, green } from "kleur/colors";
 import fs, { readFileSync } from "node:fs";
 import { basename, join } from "node:path/posix";
-import PQueue from "p-queue";
 import { getOutDirWithinCwd } from "../../core/build/common.js";
 import { getTimeStat } from "../../core/build/util.js";
 import { isRemotePath, prependForwardSlash } from "../../core/path.js";

package/dist/core/build/buildPipeline.d.ts

@@ -1,6 +1,6 @@
 import type { AstroConfig, AstroSettings } from '../../@types/astro.js';
 import type { SSRManifest } from '../app/types.js';
-import { Logger } from '../logger/core.js';
+import type { Logger } from '../logger/core.js';
 import { Pipeline } from '../pipeline.js';
 import type { BuildInternals } from './internal.js';
 import type { PageBuildData, StaticBuildOptions } from './types.js';

package/dist/core/build/buildPipeline.js

@@ -1,6 +1,5 @@
 import { getOutputDirectory, isServerLikeOutput } from "../../prerender/utils.js";
 import { BEFORE_HYDRATION_SCRIPT_ID } from "../../vite-plugin-scripts/index.js";
-import { Logger } from "../logger/core.js";
 import { Pipeline } from "../pipeline.js";
 import { routeIsFallback, routeIsRedirect } from "../redirects/helpers.js";
 import { createEnvironment } from "../render/index.js";

package/dist/core/build/generate.js

@@ -200,7 +200,7 @@ async function generatePage(pageData, ssrEntry, builtPaths, pipeline) {
     pipeline.getManifest().base,
     pipeline.getManifest().trailingSlash
   );
-  if (config.experimental.i18n && i18nMiddleware) {
+  if (config.i18n && i18nMiddleware) {
     if (onRequest) {
       pipeline.setMiddlewareFunction(sequence(i18nMiddleware, onRequest));
     } else {
@@ -396,7 +396,7 @@ async function generatePath(pathname, pipeline, gopts, route) {
     logger: pipeline.getLogger(),
     ssr
   });
-  const i18n = pipeline.getConfig().experimental.i18n;
+  const i18n = pipeline.getConfig().i18n;
   const renderContext = await createRenderContext({
     pathname,
     request,
@@ -457,12 +457,12 @@ async function generatePath(pathname, pipeline, gopts, route) {
 }
 function createBuildManifest(settings, internals, renderers) {
   let i18nManifest = void 0;
-  if (settings.config.experimental.i18n) {
+  if (settings.config.i18n) {
     i18nManifest = {
-      fallback: settings.config.experimental.i18n.fallback,
-      routing: settings.config.experimental.i18n.routing,
-      defaultLocale: settings.config.experimental.i18n.defaultLocale,
-      locales: settings.config.experimental.i18n.locales
+      fallback: settings.config.i18n.fallback,
+      routing: settings.config.i18n.routing,
+      defaultLocale: settings.config.i18n.defaultLocale,
+      locales: settings.config.i18n.locales
     };
   }
   return {

package/dist/core/build/index.js

@@ -16,7 +16,7 @@ import { resolveConfig } from "../config/config.js";
 import { createNodeLogger } from "../config/logging.js";
 import { createSettings } from "../config/settings.js";
 import { createVite } from "../create-vite.js";
-import { Logger, levels, timerMessage } from "../logger/core.js";
+import { levels, timerMessage } from "../logger/core.js";
 import { apply as applyPolyfill } from "../polyfill.js";
 import { RouteCache } from "../render/route-cache.js";
 import { createRouteManifest } from "../routing/index.js";

package/dist/core/build/plugins/plugin-manifest.js

@@ -180,12 +180,12 @@ function buildManifest(opts, internals, staticFiles) {
     entryModules[BEFORE_HYDRATION_SCRIPT_ID] = "";
   }
   let i18nManifest = void 0;
-  if (settings.config.experimental.i18n) {
+  if (settings.config.i18n) {
     i18nManifest = {
-      fallback: settings.config.experimental.i18n.fallback,
-      routing: settings.config.experimental.i18n.routing,
-      locales: settings.config.experimental.i18n.locales,
-      defaultLocale: settings.config.experimental.i18n.defaultLocale
+      fallback: settings.config.i18n.fallback,
+      routing: settings.config.i18n.routing,
+      locales: settings.config.i18n.locales,
+      defaultLocale: settings.config.i18n.defaultLocale
     };
   }
   return {

package/dist/core/build/util.js

@@ -19,8 +19,8 @@ function shouldAppendForwardSlash(trailingSlash, buildFormat) {
   }
 }
 function i18nHasFallback(config) {
-  if (config.experimental.i18n && config.experimental.i18n.fallback) {
-    return Object.keys(config.experimental.i18n.fallback).length > 0;
+  if (config.i18n && config.i18n.fallback) {
+    return Object.keys(config.i18n.fallback).length > 0;
   }
   return false;
 }

package/dist/core/compile/compile.js

@@ -1,7 +1,7 @@
 import { transform } from "@astrojs/compiler";
 import { fileURLToPath } from "node:url";
 import { normalizePath } from "vite";
-import { AggregateError, AstroError, CompilerError } from "../errors/errors.js";
+import { AggregateError, CompilerError } from "../errors/errors.js";
 import { AstroErrorData } from "../errors/index.js";
 import { resolvePath } from "../util.js";
 import { createStylePreprocessor } from "./style.js";