@astrojs/ vercel

Este adaptador permite a Astro desplegar tu sitio renderizado en modo hybrid o server a Vercel.

Si utilizas Astro como un generador de sitios estáticos, no necesitas un adaptador.

Aprende a desplegar tu sitio de Astro consultando nuestra guía de despliegue en Vercel.

¿Por qué Astro Vercel?

Vercel es una plataforma de despliegue que te permite alojar tu proyecto conectándote directamente a tu repositorio de GitHub. Este adaptador ajusta el proceso de compilación de Astro para preparar tu proyecto para el despliegue a través de Vercel.

Instalación

Astro incluye el comando astro add para automatizar la instalación de integraciones oficiales. Si lo prefieres, puedes instalar las integraciones manualmente.

Agrega el adaptador Vercel para habilitar SSR en tu proyecto de Astro con el siguiente comando astro add. Esto instalará @astrojs/vercel y hará los cambios apropiados en tu archivo astro.config.mjs en un solo paso.

npx astro add vercel

pnpm astro add vercel

yarn astro add vercel

Instalación manual

En primer lugar, añade el adaptador @astrojs/vercel a las dependencias de tu proyecto utilizando tu gestor de paquetes preferido:

npm install @astrojs/vercel

pnpm add @astrojs/vercel

yarn add @astrojs/vercel

A continuación, añade el adaptador y el modo de renderizado bajo demanda que deseas a tu archivo astro.config.*:

import { defineConfig } from 'astro/config';
import vercel from '@astrojs/vercel/serverless';

export default defineConfig({
  // ...
  output: 'server',
  adapter: vercel(),
});

Objetivos

Puedes desplegar en diferentes objetivos:

serverless: SSR dentro de una función Node.js.
static: genera un sitio estático siguiendo los formatos de salida, redirecciones, etc. de Vercel.

Puedes cambiar el destino modificando la importación:

import vercel from '@astrojs/vercel/serverless';
import vercel from '@astrojs/vercel/static';

Uso

Lee la guía completa para despliegue aquí.

Puedes desplegar por CLI (vercel deploy) o conectando tu nuevo repositorio en el Panel de Vercel. Alternativamente, puedes crear un build de producción localmente:

astro build
vercel deploy --prebuilt

Configuración

Para configurar este adaptador, pasa un objeto a la invocación de función vercel() en astro.config.mjs:

`webAnalytics`

Tipo: VercelWebAnalyticsConfig
Disponible para: Serverless, Static

Agregado en: @astrojs/vercel@3.8.0

Puedes habilitar Vercel Analytics (incluyendo Web Vitals y Audiences) configurando webAnalytics: { enabled: true }. Esto inyectará los scripts de seguimiento de Vercel en todas tus páginas.

import { defineConfig } from 'astro/config';
import vercel from '@astrojs/vercel/serverless';

export default defineConfig({
  // ...
  output: 'server',
  adapter: vercel({
    webAnalytics: {
      enabled: true,
    },
  }),
});

`imagesConfig`

Tipo: VercelImageConfig
Disponible para: Serverless, Static

Agregado en: @astrojs/vercel@3.3.0

Opciones de configuración para la API de Optimización de Imágenes de Vercel. Consulta la documentación de configuración de imágenes de Vercel para obtener una lista completa de los parámetros admitidos.

Las propiedades domains y remotePatterns se llenarán automáticamente utilizando la configuración correspondiente de image en Astro.

import { defineConfig } from 'astro/config';
import vercel from '@astrojs/vercel/static';

export default defineConfig({
  // ...
  output: 'static',
  adapter: vercel({
    imagesConfig: {
      sizes: [320, 640, 1280],
    },
  }),
});

`imageService`

Tipo: boolean
Disponible para: Serverless y Static

Agregado en: @astrojs/vercel@3.3.0

Cuando está habilitado, se configurará y utilizará automáticamente un Servicio de Imágenes impulsado por la API de Optimización de Imágenes de Vercel en producción. En desarrollo, el servicio de imágenes especificado por devImageService se utilizará en su lugar.

import { defineConfig } from 'astro/config';
import vercel from '@astrojs/vercel/static';

export default defineConfig({
  // ...
  output: 'static',
  adapter: vercel({
    imageService: true,
  }),
});

---
import { Image } from 'astro:assets';
import astroLogo from ''../assets/logo.png';
---
<!-- Este componente -->
<Image src={astroLogo} alt="My super logo!" />
<!-- se convertirá en el siguiente elemento de HTML -->
<img
  src="/_vercel/image?url=_astro/logo.hash.png&w=...&q=..."
  alt="Mi super logo!"
  loading="lazy"
  decoding="async"
  width="..."
  height="..."
/>

`devImageService`

Tipo: 'sharp' | 'squoosh' | string
Disponible para: Serverless, Static

Agregado en: @astrojs/vercel@3.8.0

Por defecto: sharp

Te permite configurar qué servicio de imágenes usar en desarrollo cuando imageService está habilitado. Esto puede ser útil si no puedes instalar las dependencias de Sharp en tu máquina de desarrollo, pero usar otro servicio de imágenes como Squoosh te permitiría previsualizar imágenes en tu entorno de desarrollo. La compilación no se ve afectada y siempre usará la Optimización de Imágenes de Vercel.

También puede establecerse en cualquier valor arbitrario para usar un servicio de imágenes personalizado en lugar de los integrados en Astro.

import { defineConfig } from 'astro/config';
import vercel from '@astrojs/vercel/serverless';

export default defineConfig({
  // ...
  output: 'server',
  adapter: vercel({
    imageService: true,
    devImageService: 'squoosh',
  }),
});

`isr`

Tipo: boolean | VercelISRConfig
Disponible para: Serverless

Agregado en: @astrojs/vercel@7.2.0

Por defecto: false

Permite desplegar tu proyecto como una función de ISR (Regeneración Estática Incremental), que almacena en caché tus páginas renderizadas bajo demanda de la misma manera que las páginas prerenderizadas después de la primera solicitud.

Para habilitar esta característica, establece isr en true en la configuración del adaptador de Vercel en astro.config.mjs:

import { defineConfig } from 'astro/config';
import vercel from '@astrojs/vercel/serverless';

export default defineConfig({
  // ...
  output: 'server',
  adapter: vercel({
    isr: true,
  }),
});

Toma en cuenta que las solicitudes de funciones ISR no incluyen parámetros de búsqueda, similar a las solicitudes en modo estático.

Invalidación de caché de ISR

Por defecto, una función ISR se almacena en caché durante la duración de tu despliegue. Puedes controlar aún más el almacenamiento en caché configurando un tiempo de expiración, o excluyendo rutas particulares del almacenamiento en caché por completo.

Invalidación basada en el tiempo

Puedes cambiar la duración del tiempo para almacenar en caché rutas configurando un valor de expiration en segundos:

import { defineConfig } from 'astro/config';
import vercel from '@astrojs/vercel/serverless';

export default defineConfig({
  // ...
  output: 'server',
  adapter: vercel({
    isr: {
      // almacena todas las páginas en la primera solicitud y las guarda por 1 día
      expiration: 60 * 60 * 24,
    },
  }),
});

Excluir rutas del almacenamiento en caché

Para implementar el modo borrador de Vercel, o Regeneración Estática Incremental bajo demanda (ISR), puedes crear un token de bypass y proporcionarlo a la configuración isr junto con cualquier ruta para excluir del almacenamiento en caché:

import { defineConfig } from 'astro/config';
import vercel from '@astrojs/vercel/serverless';

export default defineConfig({
    output: "server",
    adapter: vercel({
        isr: {
            // Un string aleatoria secreta que creas.
            bypassToken: "005556d774a8",
            // Rutas que siempre se servirán frescas.
            exclude: [ "/api/invalidate" ]
        }
    })
})

`includeFiles`

Tipo: string[]
Disponible para: Serverless

Usa esta propiedad para forzar a que los archivos se incluyan en el empaquetado de tu función. Esto es útil cuando notas que faltan archivos.

import { defineConfig } from 'astro/config';
import vercel from '@astrojs/vercel/serverless';

export default defineConfig({
  // ...
  output: 'server',
  adapter: vercel({
    includeFiles: ['./my-data.json'],
  }),
});

`excludeFiles`

Tipo: string[]
Disponible para: Serverless

Utiliza esta propiedad para excluir cualquier archivo del proceso de empaquetado que de otra manera se incluiría.

import { defineConfig } from 'astro/config';
import vercel from '@astrojs/vercel/serverless';

export default defineConfig({
  // ...
  output: 'server',
  adapter: vercel({
    excludeFiles: ['./src/some_big_file.jpg'],
  }),
});

`maxDuration`

Tipo: number
Disponible para: Serverless

Usa esta propiedad para extender o limitar la duración máxima (en segundos) que pueden ejecutarse las funciones sin servidor antes de agotar el tiempo de espera. Consulta la documentación de Vercel para conocer el límite predeterminado y máximo para el plan de tu cuenta.

import { defineConfig } from 'astro/config';
import vercel from '@astrojs/vercel/serverless';

export default defineConfig({
// ...
  output: "server",
  adapter: vercel({
    maxDuration: 60
  }),
});

Configuración de agrupación de funciones

El adaptador de Vercel combina todas tus rutas en una única función por defecto.

También tienes la opción de dividir las compilaciones en una función separada para cada ruta usando la opción functionPerRoute. Esto reduce el tamaño de cada función, lo que significa que es menos probable que excedas el límite de tamaño para una función individual. Además, el código se inicia más rápido.

Verifica que tu plan de Vercel incluya un número adecuado de funciones antes de habilitar functionPerRoute. Por ejemplo, el nivel gratuito de Vercel limita cada despliegue a no más de 12 funciones. Si tu plan de Vercel es insuficiente para el número de rutas en tu proyecto, recibirás un mensaje de error durante el despliegue.

import { defineConfig } from 'astro/config';
import vercel from '@astrojs/vercel/serverless';

export default defineConfig({
  // ...
  output: 'server',
  adapter: vercel({
    functionPerRoute: true,
  }),
});

Middleware de Vercel Edge

Puedes usar el middleware de Vercel Edge para interceptar una solicitud y redirigirla antes de enviar una respuesta. El middleware de Vercel puede ejecutarse para despliegues de Edge, SSR y estáticos.

Es posible que no necesites instalar este paquete para tu middleware. @vercel/edge solo es necesario para usar algunas características del middleware, como la geolocalización. Para obtener más información, consulta la documentación del middleware de Vercel.

Agrega un archivo middleware.js en la raíz de tu proyecto:

export const config = {
 // Solo ejecuta el middleware en la ruta admin
 matcher: '/admin',
};

export default function middleware(request) {
 const url = new URL(request.url);
 // Puedes recuperar la ubicación IP o las cookies aquí.
 if (url.pathname === '/admin') {
   url.pathname = '/'
 }
 return Response.redirect(url);
}

Mientras desarrollas localmente, puedes ejecutar vercel dev para ejecutar el middleware. En producción, Vercel lo manejará por ti.

Ejecutar el middleware de Astro en funciones de Vercel Edge

El adaptador @astrojs/vercel/serverless puede crear una función edge a partir de un middleware de Astro en tu base de código. Cuando edgeMiddleware está habilitado, una función edge ejecutará tu código de middleware para todas las solicitudes, incluyendo activos estáticos, páginas prerrenderizadas y páginas renderizadas bajo demanda.

Para páginas renderizadas bajo demanda, el objeto context.locals se serializa usando JSON y se envía en un encabezado para la función serverless, que realiza la renderización. Como medida de seguridad, la función serverless se negará a servir solicitudes con una respuesta 403 Forbidden a menos que provengan de la función edge generada.

Esta es una característica opcional. Para habilitarla, establece edgeMiddleware en true:

import { defineConfig } from 'astro/config';
import vercel from '@astrojs/vercel/serverless';

export default defineConfig({
  // ...
  output: 'server',
  adapter: vercel({
    edgeMiddleware: true,
  }),
});

Opcionalmente, puedes crear un archivo reconocido por el adaptador llamado vercel-edge-middleware.(js|ts) en la carpeta srcDir para crear Astro.locals.

Escribir requiere el paquete @vercel/edge

/**
 *
 * @param options.request {Request}
 * @param options.context {import("@vercel/edge").RequestContext}
 * @returns {object}
 */
export default function ({ request, context }) {
  // haz algo con la solicitud y el contexto
  return {
    title: "Blog de Spider-Man",
  };
}

Si usas TypeScript, puedes escribir la función de la siguiente manera:

import type { RequestContext } from '@vercel/edge';

export default function ({ request, context }: { request: Request; context: RequestContext }) {
  // haz algo con la solicitud y el contexto
  return {
    title: "Blog de Spider-Man",
  };
}

La información devuelta por esta función se pasará al middleware de Astro.

La función:

debe exportar una función predeterminada;
debe regresar un object;
acepta un objeto con una request y context como propiedades;
request es tipada como Request;
context es tipado como RequestContext;

Limitaciones y restricciones

Cuando optes por esta característica, hay algunas restricciones a tener en cuenta:

El middleware de Vercel Edge será siempre la primera función en recibir la Request y la última función en recibir la Response. Esta es una restricción arquitectónica que sigue los límites establecidos por Vercel.
Solo request y context se pueden usar para producir un objeto Astro.locals. Las operaciones como redireccionamientos, etc. deben delegarse al middleware de Astro.
Astro.locals debe ser serializable. Si no lo haces, se producirá un error de runtime. Esto significa que no puedes almacenar tipos complejos como Map, function, Set, etc.

Soporte de versiones de Node.js

El adaptador @astrojs/vercel admite versiones específicas de Node.js para desplegar tu proyecto de Astro en Vercel. Para ver las versiones de Node.js admitidas en Vercel, haz clic en la pestaña de configuración de un proyecto y desplázate hacia abajo hasta la sección “Versión de Node.js”.