@astrojs/node
✨ Major Changes
-
#5056
e55af8a23Thanks @matthewp! - # Standalone mode for the Node.js adapterNew in
@astrojs/nodeis support for standalone mode. With standalone mode you can start your production server without needing to write any server JavaScript yourself. The server starts simply by running the script like so:Terminal window node ./dist/server/entry.mjsTo enable standalone mode, set the new
modeto'standalone'option in your Astro config:import { defineConfig } from 'astro/config';import nodejs from '@astrojs/node';export default defineConfig({output: 'server',adapter: nodejs({mode: 'standalone',}),});See the @astrojs/node documentation to learn all of the options available in standalone mode.
This is a semver major change because the new
modeoption is required. Existing @astrojs/node users who are using their own HTTP server framework such as Express can upgrade by setting themodeoption to'middleware'in order to build to a middleware mode, which is the same behavior and API as before.import { defineConfig } from 'astro/config';import nodejs from '@astrojs/node';export default defineConfig({output: 'server',adapter: nodejs({mode: 'middleware',}),});
🍿 Minor Changes
-
#5056
e55af8a23Thanks @matthewp! - # Adapter support forastro previewAdapters are now about to support the
astro previewcommand via a new integration option. The Node.js adapter@astrojs/nodeis the first of the built-in adapters to gain support for this. What this means is that if you are using@astrojs/nodeyou can new preview your SSR app by running:Terminal window npm run previewWe will be updating the other first party Astro adapters to support preview over time. Adapters can opt in to this feature by providing the
previewEntrypointvia thesetAdapterfunction inastro:config:donehook. The Node.js adapter’s code looks like this:export default function() {return {name: '@astrojs/node',hooks: {'astro:config:done': ({ setAdapter, config }) => {setAdapter({name: '@astrojs/node',serverEntrypoint: '@astrojs/node/server.js',previewEntrypoint: '@astrojs/node/preview.js',exports: ['handler'],});// more here}}};}The
previewEntrypointis a module in the adapter’s package that is a Node.js script. This script is run whenastro previewis run and is charged with starting up the built server. See the Node.js implementation in@astrojs/nodeto see how that is implemented. -
#5056
e55af8a23Thanks @matthewp! - # New build configurationThe ability to customize SSR build configuration more granularly is now available in Astro. You can now customize the output folder for
server(the server code for SSR),client(your client-side JavaScript and assets), andserverEntry(the name of the entrypoint server module). Here are the defaults:import { defineConfig } from 'astro/config';export default defineConfig({output: 'server',build: {server: './dist/server/',client: './dist/client/',serverEntry: 'entry.mjs',},});These new configuration options are only supported in SSR mode and are ignored when building to SSG (a static site).
The integration hook
astro:build:startincludes a parambuildConfigwhich includes all of these same options. You can continue to use this param in Astro 1.x, but it is deprecated in favor of the newbuild.configoptions. All of the built-in adapters have been updated to the new format. If you have an integration that depends on this param we suggest upgrading to do this instead:export default function myIntegration() {return {name: 'my-integration',hooks: {'astro:config:setup': ({ updateConfig }) => {updateConfig({build: {server: '...',},});},},};}
-
🍿 Minor Changes
-
#4876
d3091f89eThanks @matthewp! - Adds the Astro.cookies APIAstro.cookiesis a new API for manipulating cookies in Astro components and API routes.In Astro components, the new
Astro.cookiesobject is a map-like object that allows you to get, set, delete, and check for a cookie’s existence (has):---type Prefs = {darkMode: boolean;};Astro.cookies.set<Prefs>('prefs',{ darkMode: true },{expires: '1 month',});const prefs = Astro.cookies.get<Prefs>('prefs').json();---<body data-theme={prefs.darkMode ? 'dark' : 'light'}></body>Once you’ve set a cookie with Astro.cookies it will automatically be included in the outgoing response.
This API is also available with the same functionality in API routes:
export function post({ cookies }) {cookies.set('loggedIn', false);return new Response(null, {status: 302,headers: {Location: '/login',},});}See the RFC to learn more.
-
🐞 Patch Changes
- #4558
742966456Thanks @tony-sull! - Adding thewithastrokeyword to include the adapters on the Integrations Catalog
- #4558
✨ Major Changes
-
04ad44563- > Astro v1.0 is out! Read the official announcement post.No breaking changes. This package is now officially stable and compatible with
astro@1.0.0!
🐞 Patch Changes
- Updated dependencies [
04ad44563]:- @astrojs/webapi@1.0.0
-
🍿 Minor Changes
-
#4015
6fd161d76Thanks @matthewp! - Newoutputconfiguration optionThis change introduces a new “output target” configuration option (
output). Setting the output target lets you decide the format of your final build, either:"static"(default): A static site. Your final build will be a collection of static assets (HTML, CSS, JS) that you can deploy to any static site host."server": A dynamic server application. Your final build will be an application that will run in a hosted server environment, generating HTML dynamically for different requests.
If
outputis omitted from your config, the default value"static"will be used.When using the
"server"output target, you must also include a runtime adapter via theadapterconfiguration. An adapter will adapt your final build to run on the deployed platform of your choice (Netlify, Vercel, Node.js, Deno, etc).To migrate: No action is required for most users. If you currently define an
adapter, you will need to also addoutput: 'server'to your config file to make it explicit that you are building a server. Here is an example of what that change would look like for someone deploying to Netlify:import { defineConfig } from 'astro/config';import netlify from '@astrojs/netlify/functions';export default defineConfig({adapter: netlify(),output: 'server',}); -
#3973
5a23483efThanks @matthewp! - Adds support for Astro.clientAddressThe new
Astro.clientAddressproperty allows you to get the IP address of the requested user.<div>Your address { Astro.clientAddress }</div>This property is only available when building for SSR, and only if the adapter you are using supports providing the IP address. If you attempt to access the property in a SSG app it will throw an error.
🐞 Patch Changes
-
🐞 Patch Changes
- Updated dependencies [
4de53ecc]:- @astrojs/webapi@0.12.0
- Updated dependencies [
🐞 Patch Changes
815d62f1Thanks @FredKSchott! - no changes.
🐞 Patch Changes
-
#2879
80034c6cThanks @matthewp! - Netlify AdapterThis change adds a Netlify adapter that uses Netlify Functions. You can use it like so:
import { defineConfig } from 'astro/config';import netlify from '@astrojs/netlify/functions';export default defineConfig({adapter: netlify(),}); -
#2873
e4025d1fThanks @matthewp! - Improves the build by building to a single file for rendering
-