astro 1.4.7 → 1.5.0

package/components/Code.astro

@@ -24,7 +24,7 @@ export interface Props {
 	/**
 	 * Enable word wrapping.
 	 *  - true: enabled.
-	 *  - false: enabled.
+	 *  - false: disabled.
 	 *  - null: All overflow styling removed. Code will overflow the element by default.
 	 *
 	 * @default false

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

@@ -60,8 +60,17 @@ export interface CLIFlags {
     drafts?: boolean;
 }
 export interface BuildConfig {
+    /**
+     * @deprecated Use config.build.client instead.
+     */
     client: URL;
+    /**
+     * @deprecated Use config.build.server instead.
+     */
     server: URL;
+    /**
+     * @deprecated Use config.build.serverEntry instead.
+     */
     serverEntry: string;
 }
 /**
@@ -69,7 +78,7 @@ export interface BuildConfig {
  *
  * [Astro reference](https://docs.astro.build/reference/api-reference/#astro-global)
  */
-export interface AstroGlobal<Props extends Record<string, any> = Record<string, any>> extends AstroGlobalPartial {
+export interface AstroGlobal<Props extends Record<string, any> = Record<string, any>> extends AstroGlobalPartial, AstroSharedContext<Props> {
     /**
      * Canonical URL of the current page.
      * @deprecated Use `Astro.url` instead.
@@ -82,21 +91,13 @@ export interface AstroGlobal<Props extends Record<string, any> = Record<string,
      * ```
      */
     canonicalURL: URL;
-    /** The address (usually IP address) of the user. Used with SSR only.
-     *
-     */
-    clientAddress: string;
     /**
      * A full URL object of the request URL.
      * Equivalent to: `new URL(Astro.request.url)`
      *
      * [Astro reference](https://docs.astro.build/en/reference/api-reference/#url)
      */
-    /**
-     * Utility for getting and setting cookies values.
-     */
-    cookies: AstroCookies;
-    url: URL;
+    url: AstroSharedContext['url'];
     /** Parameters passed to a dynamic page generated using [getStaticPaths](https://docs.astro.build/en/reference/api-reference/#getstaticpaths)
      *
      * Example usage:
@@ -113,9 +114,9 @@ export interface AstroGlobal<Props extends Record<string, any> = Record<string,
      * <h1>{id}</h1>
      * ```
      *
-     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#params)
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#astroparams)
      */
-    params: Params;
+    params: AstroSharedContext['params'];
     /** List of props passed to this component
      *
      * A common way to get specific props is through [destructuring](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment), ex:
@@ -125,7 +126,7 @@ export interface AstroGlobal<Props extends Record<string, any> = Record<string,
      *
      * [Astro reference](https://docs.astro.build/en/core-concepts/astro-components/#component-props)
      */
-    props: Props;
+    props: AstroSharedContext<Props>['props'];
     /** Information about the current request. This is a standard [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object
      *
      * For example, to get a URL object of the current URL, you can use:
@@ -159,11 +160,11 @@ export interface AstroGlobal<Props extends Record<string, any> = Record<string,
      *
      * [Astro reference](https://docs.astro.build/en/guides/server-side-rendering/#astroredirect)
      */
-    redirect(path: string): Response;
+    redirect: AstroSharedContext['redirect'];
     /**
      * The <Astro.self /> element allows a component to reference itself recursively.
      *
-     * [Astro reference](https://docs.astro.build/en/guides/server-side-rendering/#astroself)
+     * [Astro reference](https://docs.astro.build/en/guides/api-reference/#astroself)
      */
     self: AstroComponentFactory;
     /** Utility functions for modifying an Astro component’s slotted children
@@ -354,6 +355,7 @@ export interface AstroUserConfig {
      * @name outDir
      * @type {string}
      * @default `"./dist"`
+     * @see build.server
      * @description Set the directory that `astro build` writes your final build to.
      *
      * The value can be either an absolute file system path or a path relative to the project root.
@@ -493,6 +495,68 @@ export interface AstroUserConfig {
          * This means that when you create relative URLs using `new URL('./relative', Astro.url)`, you will get consistent behavior between dev and build.
          */
         format?: 'file' | 'directory';
+        /**
+         * @docs
+         * @name build.client
+         * @type {string}
+         * @default `'./dist/client'`
+         * @description
+         * Controls the output directory of your client-side CSS and JavaScript when `output: 'server'` only.
+         * `outDir` controls where the code is built to.
+         *
+         * This value is relative to the `outDir`.
+         *
+         * ```js
+         * {
+         *   output: 'server',
+         *   build: {
+         *     client: './client'
+         *   }
+         * }
+         * ```
+         */
+        client?: string;
+        /**
+         * @docs
+         * @name build.server
+         * @type {string}
+         * @default `'./dist/server'`
+         * @description
+         * Controls the output directory of server JavaScript when building to SSR.
+         *
+         * This value is relative to the `outDir`.
+         *
+         * ```js
+         * {
+         *   build: {
+         *     server: './server'
+         *   }
+         * }
+         * ```
+         */
+        server?: string;
+        /**
+         * @docs
+         * @name build.serverEntry
+         * @type {string}
+         * @default `'entry.mjs'`
+         * @description
+         * Specifies the file name of the server entrypoint when building to SSR.
+         * This entrypoint is usually dependent on which host you are deploying to and
+         * will be set by your adapter for you.
+         *
+         * Note that it is recommended that this file ends with `.mjs` so that the runtime
+         * detects that the file is a JavaScript module.
+         *
+         * ```js
+         * {
+         *   build: {
+         *     serverEntry: 'main.mjs'
+         *   }
+         * }
+         * ```
+         */
+        serverEntry?: string;
     };
     /**
      * @docs
@@ -820,6 +884,7 @@ export interface AstroSettings {
     }[];
     tsConfig: TsConfigJson | undefined;
     tsConfigPath: string | undefined;
+    watchFiles: string[];
 }
 export declare type AsyncRendererComponentFn<U> = (Component: any, props: any, slots: Record<string, string>, metadata?: AstroComponentMetadata) => Promise<U>;
 /** Generic interface for a component (Astro, Svelte, React, etc.) */
@@ -969,19 +1034,116 @@ export interface Page<T = any> {
 }
 export declare type PaginateFunction = (data: any[], args?: PaginateOptions) => GetStaticPathsResult;
 export declare type Params = Record<string, string | number | undefined>;
-export declare type Props = Record<string, unknown>;
 export interface AstroAdapter {
     name: string;
     serverEntrypoint?: string;
+    previewEntrypoint?: string;
     exports?: string[];
     args?: any;
 }
 declare type Body = string;
-export interface APIContext {
+interface AstroSharedContext<Props extends Record<string, any> = Record<string, any>> {
+    /**
+     * The address (usually IP address) of the user. Used with SSR only.
+     */
+    clientAddress: string;
+    /**
+     * Utility for getting and setting the values of cookies.
+     */
     cookies: AstroCookies;
-    params: Params;
+    /**
+     * Information about the current request. This is a standard [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object
+     */
     request: Request;
+    /**
+     * A full URL object of the request URL.
+     */
+    url: URL;
+    /**
+     * Route parameters for this request if this is a dynamic route.
+     */
+    params: Params;
+    /**
+     * List of props returned for this path by `getStaticPaths` (**Static Only**).
+     */
+    props: Props;
+    /**
+     * Redirect to another page (**SSR Only**).
+     */
+    redirect(path: string, status?: 301 | 302 | 308): Response;
 }
+export interface APIContext<Props extends Record<string, any> = Record<string, any>> extends AstroSharedContext<Props> {
+    site: URL | undefined;
+    generator: string;
+    /**
+     * A full URL object of the request URL.
+     * Equivalent to: `new URL(request.url)`
+     */
+    url: AstroSharedContext['url'];
+    /**
+     * Parameters matching the page’s dynamic route pattern.
+     * In static builds, this will be the `params` generated by `getStaticPaths`.
+     * In SSR builds, this can be any path segments matching the dynamic route pattern.
+     *
+     * Example usage:
+     * ```ts
+     * export function getStaticPaths() {
+     *   return [
+     *     { params: { id: '0' }, props: { name: 'Sarah' } },
+     *     { params: { id: '1' }, props: { name: 'Chris' } },
+     *     { params: { id: '2' }, props: { name: 'Fuzzy' } },
+     *   ];
+     * }
+     *
+     * export async function get({ params }) {
+     *  return {
+     * 	  body: `Hello user ${params.id}!`,
+     *  }
+     * }
+     * ```
+     *
+     * [context reference](https://docs.astro.build/en/guides/api-reference/#contextparams)
+     */
+    params: AstroSharedContext['params'];
+    /**
+     * List of props passed from `getStaticPaths`. Only available to static builds.
+     *
+     * Example usage:
+     * ```ts
+     * export function getStaticPaths() {
+     *   return [
+     *     { params: { id: '0' }, props: { name: 'Sarah' } },
+     *     { params: { id: '1' }, props: { name: 'Chris' } },
+     *     { params: { id: '2' }, props: { name: 'Fuzzy' } },
+     *   ];
+     * }
+     *
+     * export function get({ props }) {
+     *   return {
+     *     body: `Hello ${props.name}!`,
+     *   }
+     * }
+     * ```
+     *
+     * [context reference](https://docs.astro.build/en/guides/api-reference/#contextprops)
+     */
+    props: AstroSharedContext<Props>['props'];
+    /**
+     * Redirect to another page. Only available in SSR builds.
+     *
+     * Example usage:
+     * ```ts
+     * // src/pages/secret.ts
+     * export function get({ redirect }) {
+     *   return redirect('/login');
+     * }
+     * ```
+     *
+     * [context reference](https://docs.astro.build/en/guides/api-reference/#contextredirect)
+     */
+    redirect: AstroSharedContext['redirect'];
+}
+export declare type Props = Record<string, unknown>;
 export interface EndpointOutput {
     body: Body;
     encoding?: BufferEncoding;
@@ -1019,9 +1181,11 @@ export interface AstroIntegration {
     hooks: {
         'astro:config:setup'?: (options: {
             config: AstroConfig;
-            command: 'dev' | 'build';
+            command: 'dev' | 'build' | 'preview';
+            isRestart: boolean;
             updateConfig: (newConfig: Record<string, any>) => void;
             addRenderer: (renderer: AstroRenderer) => void;
+            addWatchFile: (path: URL | string) => void;
             injectScript: (stage: InjectedScriptStage, content: string) => void;
             injectRoute: (injectRoute: InjectedRoute) => void;
         }) => void | Promise<void>;
@@ -1110,3 +1274,20 @@ export interface SSRResult {
 export declare type MarkdownAstroData = {
     frontmatter: object;
 };
+export interface PreviewServer {
+    host?: string;
+    port: number;
+    closed(): Promise<void>;
+    stop(): Promise<void>;
+}
+export interface PreviewServerParams {
+    outDir: URL;
+    client: URL;
+    serverEntrypoint: URL;
+    host: string | undefined;
+    port: number;
+}
+export declare type CreatePreviewServer = (params: PreviewServerParams) => PreviewServer | Promise<PreviewServer>;
+export interface PreviewModule {
+    default: CreatePreviewServer;
+}

package/dist/cli/index.js

@@ -7,12 +7,12 @@ import add from "../core/add/index.js";
 import build from "../core/build/index.js";
 import {
   createSettings,
-  loadTSConfig,
   openConfig,
   resolveConfigPath,
   resolveFlags,
   resolveRoot
 } from "../core/config/index.js";
+import { ASTRO_VERSION } from "../core/constants.js";
 import devServer from "../core/dev/index.js";
 import { collectErrorMetadata } from "../core/errors.js";
 import { debug, error, info } from "../core/logger/core.js";
@@ -20,7 +20,7 @@ import { enableVerboseLogging, nodeLogDestination } from "../core/logger/node.js
 import { formatConfigErrorMessage, formatErrorMessage, printHelp } from "../core/messages.js";
 import { appendForwardSlash } from "../core/path.js";
 import preview from "../core/preview/index.js";
-import { ASTRO_VERSION, createSafeError } from "../core/util.js";
+import { createSafeError } from "../core/util.js";
 import * as event from "../events/index.js";
 import { eventConfigError, eventError, telemetry } from "../events/index.js";
 import { check } from "./check/index.js";
@@ -132,12 +132,7 @@ async function runCommand(cmd, flags) {
   if (!initialAstroConfig)
     return;
   telemetry.record(event.eventCliSession(cmd, initialUserConfig, flags));
-  let initialTsConfig = loadTSConfig(root);
-  let settings = createSettings({
-    config: initialAstroConfig,
-    tsConfig: initialTsConfig == null ? void 0 : initialTsConfig.config,
-    tsConfigPath: initialTsConfig == null ? void 0 : initialTsConfig.path
-  });
+  let settings = createSettings(initialAstroConfig, root);
   switch (cmd) {
     case "dev": {
       async function startDevServer({ isRestart = false } = {}) {
@@ -147,35 +142,39 @@ async function runCommand(cmd, flags) {
         const configFlagPath = configFlag ? await resolveConfigPath({ cwd: root, flags }) : void 0;
         const resolvedRoot = appendForwardSlash(resolveRoot(root));
         const handleServerRestart = (logMsg) => async function(changedFile) {
-          if (!restartInFlight && (configFlag ? configFlagPath && normalizePath(configFlagPath) === normalizePath(changedFile) : new RegExp(
+          if (restartInFlight)
+            return;
+          let shouldRestart = false;
+          shouldRestart = configFlag ? !!configFlagPath && normalizePath(configFlagPath) === normalizePath(changedFile) : new RegExp(
             `${normalizePath(resolvedRoot)}.*astro.config.((mjs)|(cjs)|(js)|(ts))$`
-          ).test(normalizePath(changedFile)))) {
-            restartInFlight = true;
-            console.clear();
-            try {
-              const newConfig = await openConfig({
-                cwd: root,
-                flags,
-                cmd,
-                logging,
-                isConfigReload: true
-              });
-              info(logging, "astro", logMsg + "\n");
-              let astroConfig = newConfig.astroConfig;
-              let tsconfig = loadTSConfig(root);
-              settings = createSettings({
-                config: astroConfig,
-                tsConfig: tsconfig == null ? void 0 : tsconfig.config,
-                tsConfigPath: tsconfig == null ? void 0 : tsconfig.path
-              });
-              await stop();
-              await startDevServer({ isRestart: true });
-            } catch (e) {
-              await handleConfigError(e, { cwd: root, flags, logging });
-              await stop();
-              info(logging, "astro", "Continuing with previous valid configuration\n");
-              await startDevServer({ isRestart: true });
-            }
+          ).test(normalizePath(changedFile));
+          if (!shouldRestart && settings.watchFiles.length > 0) {
+            shouldRestart = settings.watchFiles.some(
+              (path) => normalizePath(path) === normalizePath(changedFile)
+            );
+          }
+          if (!shouldRestart)
+            return;
+          restartInFlight = true;
+          console.clear();
+          try {
+            const newConfig = await openConfig({
+              cwd: root,
+              flags,
+              cmd,
+              logging,
+              isRestart: true
+            });
+            info(logging, "astro", logMsg + "\n");
+            let astroConfig = newConfig.astroConfig;
+            settings = createSettings(astroConfig, root);
+            await stop();
+            await startDevServer({ isRestart: true });
+          } catch (e) {
+            await handleConfigError(e, { cwd: root, flags, logging });
+            await stop();
+            info(logging, "astro", "Continuing with previous valid configuration\n");
+            await startDevServer({ isRestart: true });
           }
         };
         watcher.on("change", handleServerRestart("Configuration updated. Restarting..."));

package/dist/config/index.js

@@ -7,7 +7,7 @@ function getViteConfig(inlineConfig) {
     const [
       { mergeConfig },
       { nodeLogDestination },
-      { openConfig, createSettings, loadTSConfig },
+      { openConfig, createSettings },
       { createVite },
       { runHookConfigSetup, runHookConfigDone }
     ] = await Promise.all([
@@ -25,12 +25,7 @@ function getViteConfig(inlineConfig) {
       cmd,
       logging
     });
-    const initialTsConfig = loadTSConfig(inlineConfig.root);
-    const settings = createSettings({
-      config,
-      tsConfig: initialTsConfig == null ? void 0 : initialTsConfig.config,
-      tsConfigPath: initialTsConfig == null ? void 0 : initialTsConfig.path
-    });
+    const settings = createSettings(config, inlineConfig.root);
     await runHookConfigSetup({ settings, command: cmd, logging });
     const viteConfig = await createVite(
       {

package/dist/core/add/index.js

@@ -2,13 +2,18 @@ import boxen from "boxen";
 import { diffWords } from "diff";
 import { execa } from "execa";
 import { existsSync, promises as fs } from "fs";
-import { bold, cyan, dim, green, magenta, yellow } from "kleur/colors";
+import { bold, cyan, dim, green, magenta, red, yellow } from "kleur/colors";
 import ora from "ora";
 import path from "path";
 import preferredPM from "preferred-pm";
 import prompts from "prompts";
 import { fileURLToPath, pathToFileURL } from "url";
-import { resolveConfigPath } from "../config/index.js";
+import { loadTSConfig, resolveConfigPath } from "../config/index.js";
+import {
+  defaultTSConfig,
+  presets,
+  updateTSConfigForFramework
+} from "../config/tsconfig.js";
 import { debug, info } from "../logger/core.js";
 import * as msg from "../messages.js";
 import { printHelp } from "../messages.js";
@@ -212,7 +217,7 @@ async function add(names, { cwd, flags, logging, telemetry }) {
   switch (configResult) {
     case UpdateResult.cancelled: {
       info(logging, null, msg.cancelled(`Your configuration has ${bold("NOT")} been updated.`));
-      return;
+      break;
     }
     case UpdateResult.none: {
       const pkgURL = new URL("./package.json", configURL);
@@ -224,11 +229,11 @@ async function add(names, { cwd, flags, logging, telemetry }) {
         );
         if (missingDeps.length === 0) {
           info(logging, null, msg.success(`Configuration up-to-date.`));
-          return;
+          break;
         }
       }
       info(logging, null, msg.success(`Configuration up-to-date.`));
-      return;
+      break;
     }
     default: {
       const list = integrations.map((integration) => `  - ${integration.packageName}`).join("\n");
@@ -242,6 +247,27 @@ ${list}`
       );
     }
   }
+  const updateTSConfigResult = await updateTSConfig(cwd, logging, integrations, flags);
+  switch (updateTSConfigResult) {
+    case UpdateResult.none: {
+      break;
+    }
+    case UpdateResult.cancelled: {
+      info(
+        logging,
+        null,
+        msg.cancelled(`Your TypeScript configuration has ${bold("NOT")} been updated.`)
+      );
+      break;
+    }
+    case UpdateResult.failure: {
+      throw new Error(
+        `Unknown error parsing tsconfig.json or jsconfig.json. Could not update TypeScript settings.`
+      );
+    }
+    default:
+      info(logging, null, msg.success(`Successfully updated TypeScript settings`));
+  }
 }
 function isAdapter(integration) {
   return integration.type === "adapter";
@@ -392,27 +418,12 @@ ${defaultExport}`);
   if (input === output) {
     return 0 /* none */;
   }
-  let changes = [];
-  for (const change of diffWords(input, output)) {
-    let lines = change.value.trim().split("\n").slice(0, change.count);
-    if (lines.length === 0)
-      continue;
-    if (change.added) {
-      if (!change.value.trim())
-        continue;
-      changes.push(change.value);
-    }
-  }
-  if (changes.length === 0) {
+  const diff = getDiffContent(input, output);
+  if (!diff) {
     return 0 /* none */;
   }
-  let diffed = output;
-  for (let newContent of changes) {
-    const coloredOutput = newContent.split("\n").map((ln) => ln ? green(ln) : "").join("\n");
-    diffed = diffed.replace(newContent, coloredOutput);
-  }
   const message = `
-${boxen(diffed, {
+${boxen(diff, {
     margin: 0.5,
     padding: 0.5,
     borderStyle: "round",
@@ -616,6 +627,90 @@ async function validateIntegrations(integrations) {
     }
   }
 }
+async function updateTSConfig(cwd = process.cwd(), logging, integrationsInfo, flags) {
+  var _a, _b;
+  const integrations = integrationsInfo.map(
+    (integration) => integration.id
+  );
+  const firstIntegrationWithTSSettings = integrations.find(
+    (integration) => presets.has(integration)
+  );
+  if (!firstIntegrationWithTSSettings) {
+    return 0 /* none */;
+  }
+  const inputConfig = loadTSConfig(cwd, false);
+  const configFileName = inputConfig.exists ? inputConfig.path.split("/").pop() : "tsconfig.json";
+  if (inputConfig.reason === "invalid-config") {
+    return 3 /* failure */;
+  }
+  if (inputConfig.reason === "not-found") {
+    debug("add", "Couldn't find tsconfig.json or jsconfig.json, generating one");
+  }
+  const outputConfig = updateTSConfigForFramework(
+    inputConfig.exists ? inputConfig.config : defaultTSConfig,
+    firstIntegrationWithTSSettings
+  );
+  const input = inputConfig.exists ? JSON.stringify(inputConfig.config, null, 2) : "";
+  const output = JSON.stringify(outputConfig, null, 2);
+  const diff = getDiffContent(input, output);
+  if (!diff) {
+    return 0 /* none */;
+  }
+  const message = `
+${boxen(diff, {
+    margin: 0.5,
+    padding: 0.5,
+    borderStyle: "round",
+    title: configFileName
+  })}
+`;
+  info(
+    logging,
+    null,
+    `
+  ${magenta(`Astro will make the following changes to your ${configFileName}:`)}
+${message}`
+  );
+  const conflictingIntegrations = [...Object.keys(presets).filter((config) => config !== "vue")];
+  const hasConflictingIntegrations = integrations.filter((integration) => presets.has(integration)).length > 1 && integrations.filter((integration) => conflictingIntegrations.includes(integration)).length > 0;
+  if (hasConflictingIntegrations) {
+    info(
+      logging,
+      null,
+      red(
+        `  ${bold(
+          "Caution:"
+        )} Selected UI frameworks require conflicting tsconfig.json settings, as such only settings for ${bold(
+          firstIntegrationWithTSSettings
+        )} were used.
+  More information: https://docs.astro.build/en/guides/typescript/#errors-typing-multiple-jsx-frameworks-at-the-same-time
+`
+      )
+    );
+  }
+  if (integrations.includes("vue") && hasConflictingIntegrations && (((_a = outputConfig.compilerOptions) == null ? void 0 : _a.jsx) !== "preserve" && ((_b = outputConfig.compilerOptions) == null ? void 0 : _b.jsxImportSource) !== void 0 || integrations.includes("react"))) {
+    info(
+      logging,
+      null,
+      red(
+        `  ${bold(
+          "Caution:"
+        )} Using Vue together with a JSX framework can lead to type checking issues inside Vue files.
+  More information: https://docs.astro.build/en/guides/typescript/#vue-components-are-mistakenly-typed-by-the-typesreact-package-when-installed
+`
+      )
+    );
+  }
+  if (await askToContinue({ flags })) {
+    await fs.writeFile((inputConfig == null ? void 0 : inputConfig.path) ?? path.join(cwd, "tsconfig.json"), output, {
+      encoding: "utf-8"
+    });
+    debug("add", `Updated ${configFileName} file`);
+    return 1 /* updated */;
+  } else {
+    return 2 /* cancelled */;
+  }
+}
 function parseIntegrationName(spec) {
   const result = parseNpmName(spec);
   if (!result)
@@ -643,6 +738,28 @@ async function askToContinue({ flags }) {
   });
   return Boolean(response.askToContinue);
 }
+function getDiffContent(input, output) {
+  let changes = [];
+  for (const change of diffWords(input, output)) {
+    let lines = change.value.trim().split("\n").slice(0, change.count);
+    if (lines.length === 0)
+      continue;
+    if (change.added) {
+      if (!change.value.trim())
+        continue;
+      changes.push(change.value);
+    }
+  }
+  if (changes.length === 0) {
+    return null;
+  }
+  let diffed = output;
+  for (let newContent of changes) {
+    const coloredOutput = newContent.split("\n").map((ln) => ln ? green(ln) : "").join("\n");
+    diffed = diffed.replace(newContent, coloredOutput);
+  }
+  return diffed;
+}
 export {
   add as default,
   validateIntegrations