0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-16 21:46:22 -05:00
astro/packages/integrations/vercel/CHANGELOG.md
Houston (Bot) e24db1d8a6
[ci] release (#10092)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2024-02-13 14:25:59 -07:00

99 KiB
Raw Blame History

@astrojs/vercel

7.3.1

Patch Changes

7.3.0

Minor Changes

  • #9987 0699f34d5c4481c027c4d29d73944f79f97008df Thanks @lilnasy! - Implements verification for edge middleware. This is a security measure to ensure that your serverless functions are only ever called by your edge middleware and not a third party.

    When edgeMiddleware is enabled, the serverless function will now respond with 403 Forbidden for requests that are not verified to have come from the generated edge middleware. No user action is necessary.

7.2.0

Minor Changes

  • #9714 e2fe51c828dc7ea8204788e59e3953fe36c97836 Thanks @lilnasy! - Introduces a new config option, isr, that allows you to deploy your project as an ISR function. ISR (Incremental Static Regeneration) caches your on-demand rendered pages in the same way as prerendered pages after first request.

    To enable this feature, set isr to true in your Vercel adapter configuration in astro.config.mjs:

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

    Cache invalidation options

    By default, ISR responses are cached for the duration of your deployment. You can further control caching by setting an expiration time or prevent caching entirely for certain routes.

    Time-based invalidation

    You can change the length of time to cache routes this by configuring an expiration value in seconds:

    export default defineConfig({
      output: 'server',
      adapter: vercel({
        isr: {
          // caches all pages on first request and saves for 1 day
          expiration: 60 * 60 * 24,
        },
      }),
    });
    

    Manual invalidation

    To implement Vercel's Draft mode, or On-Demand Incremental Static Regeneration (ISR), you can create a bypass token and provide it to the isr config along with the paths to exclude from caching:

    export default defineConfig({
      output: 'server',
      adapter: vercel({
        isr: {
          // A secret random string that you create.
          bypassToken: '005556d774a8',
          // Paths that will always be served fresh.
          exclude: ['/api/invalidate'],
        },
      }),
    });
    

7.1.1

Patch Changes

7.1.0

Minor Changes

Patch Changes

  • #9885 49e0c24d7f90d00e986533fcf546665967540ce7 Thanks @matthewp! - Better ignores for Vercel file-tracer

    The Vercel adapter has a file-tracer it uses to detect which files should be moved over to the dist/ folder. When it's done, it prints warnings for things that it detected that maybe should be moved.

    This change expands how we do ignores so that:

    • Ignores happen within dot folders like .pnpm.
    • @libsql/client is ignored, a package we know is not bundled.

7.0.2

Patch Changes

7.0.1

Patch Changes

7.0.0

Major Changes

6.1.4

Patch Changes

6.1.3

Patch Changes

6.1.2

Patch Changes

6.1.1

Patch Changes

6.1.0

Minor Changes

Patch Changes

6.0.2

Patch Changes

6.0.1

Patch Changes

6.0.0

Major Changes

  • #9199 49aa215a0 Thanks @lilnasy! - The internals of the integration have been updated to support Astro 4.0. Make sure to upgrade your Astro version as Astro 3.0 is no longer supported.

  • #9184 a145ac07e Thanks @bluwy! - Removes deprecated analytics option. Use the webAnalytics option instead.

  • #9263 3cbd8ea75 Thanks @bluwy! - Removes the deprecated @astrojs/vercel/edge export. You should use @astrojs/vercel/serverless instead with the edgeMiddleware option.

6.0.0-beta.2

Major Changes

  • #9263 3cbd8ea75 Thanks @bluwy! - Removes the deprecated @astrojs/vercel/edge export. You should use @astrojs/vercel/serverless instead with the edgeMiddleware option.

6.0.0-beta.1

Major Changes

  • #9199 49aa215a0 Thanks @lilnasy! - The internals of the integration have been updated to support Astro 4.0. Make sure to upgrade your Astro version as Astro 3.0 is no longer supported.

6.0.0-beta.0

Major Changes

  • #9184 a145ac07e Thanks @bluwy! - Removes deprecated analytics option. Use the webAnalytics option instead.

Patch Changes

5.2.0

Minor Changes

  • #8879 754e4fd31 Thanks @lilnasy! - The Vercel adapter now streams responses!

    This brings better performance to your visitors by showing them content as it is rendered. The browser can also start loading the required stylesheets and scripts much sooner, which ultimately results in faster full page loads.

5.1.0

Minor Changes

  • #8867 b209e5335 Thanks @lilnasy! - You can now configure how long your functions can run before timing out.

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

Patch Changes

  • #8896 5dd1ed50b Thanks @bluwy! - Prevents the Vercel serverless adapter from generating static redirect pages in hybrid mode

  • Updated dependencies [26b77b8fe]:

    • astro@3.3.4

5.0.2

Patch Changes

5.0.1

Patch Changes

5.0.0

Major Changes

  • #8445 91380378c Thanks @Princesseuh! - Adds a configuration option devImageService to choose which of the built-in image services to use in development. Defaults to sharp.

  • #8546 b79e11f3c Thanks @matthewp! - Turn off functionPerRoute by default

    In the previous version of @astrojs/vercel, the default for functionPerRoute was changed to true. While this option has several advantages, if you're a free tier user you are likely to run into the limit of 12 functions per deployment. This will result in an error when you attempt to deploy.

    For this reason, the functionPerRoute option is now back to defaulting to false. It's still a useful option if you have a paid plan and have previously run into issues with your single function exceeding the size limits.

Minor Changes

  • #8021 2e8726fee Thanks @chriswdmr! - Enable Vercel Speed Insights and Vercel Web Analytics individually. Deprecates the analytics property in astro.config.mjs in favor of speedInsights and webAnalytics.

    If you're using the analytics property, you'll need to update your config to use the new properties:

    // astro.config.mjs
    export default defineConfig({
    	adapter: vercel({
    -		analytics: true,
    +		webAnalytics: {
    +			enabled: true
    +		},
    +		speedInsights: {
    +			enabled: true
    +		}
    	})
    });
    

    Allow configuration of Web Analytics with all available configuration options. Bumps @vercel/analytics package to the latest version.

Patch Changes

4.0.5

Patch Changes

4.0.4

Patch Changes

4.0.3

Patch Changes

  • #8348 5f2c55bb5 Thanks @ematipico! - - Cache result during bundling, to speed up the process of multiple functions;

    • Avoid creating multiple symbolic links of the dependencies when building the project with functionPerRoute enabled;
  • #8354 0eb09dbab Thanks @Princesseuh! - Fix unnecessary warning about Sharp showing while building

  • Updated dependencies [d3a6f9f83, f21599671]:

    • astro@3.0.6

4.0.2

Patch Changes

4.0.1

Patch Changes

4.0.0

Major Changes

  • #8188 d0679a666 Thanks @ematipico! - Remove support for Node 16. The lowest supported version by Astro and all integrations is now v18.14.1. As a reminder, Node 16 will be deprecated on the 11th September 2023.

  • #8179 6011d52d3 Thanks @matthewp! - Astro 3.0 Release Candidate

  • #8188 7511a4980 Thanks @ematipico! - When using an adapter that supports neither Squoosh or Sharp, Astro will now automatically use an image service that does not support processing, but still provides the other benefits of astro:assets such as enforcing alt, no CLS etc to users

  • #8015 9cc4e48e6 Thanks @matthewp! - Remove the Vercel Edge adapter

    @astrojs/vercel/serverless now supports Edge middleware, so a separate adapter for Edge itself (deploying your entire app to the edge) is no longer necessary. Please update your Astro config to reflect this change:

    // astro.config.mjs
    import { defineConfig } from 'astro/config';
    - import vercel from '@astrojs/vercel/edge';
    + import vercel from '@astrojs/vercel/serverless';
    
    export default defineConfig({
     output: 'server',
     adapter: vercel({
    +    edgeMiddleware: true
     }),
    });
    

    This adapter had several known limitations and compatibility issues that prevented many people from using it in production. To reduce maintenance costs and because we have a better story with Serveless + Edge Middleware, we are removing the Edge adapter.

  • #8239 52f0837bd Thanks @matthewp! - Vercel adapter now defaults to functionPerRoute.

    With this change, @astrojs/vercel/serverless now splits each route into its own function. By doing this, the size of each function is reduced and startup time is faster.

    You can disable this option, which will cause the code to be bundled into a single function, by setting functionPerRoute to false.

  • #8188 148e61d24 Thanks @ematipico! - Reduced the amount of polyfills provided by Astro. Astro will no longer provide (no-op) polyfills for several web apis such as HTMLElement, Image or Document. If you need access to those APIs on the server, we recommend using more proper polyfills available on npm.

Minor Changes

  • #8188 cd2d7e769 Thanks @ematipico! - Introduced the concept of feature map. A feature map is a list of features that are built-in in Astro, and an Adapter can tell Astro if it can support it.

    import { AstroIntegration } from './astro';
    
    function myIntegration(): AstroIntegration {
      return {
        name: 'astro-awesome-list',
        // new feature map
        supportedAstroFeatures: {
          hybridOutput: 'experimental',
          staticOutput: 'stable',
          serverOutput: 'stable',
          assets: {
            supportKind: 'stable',
            isSharpCompatible: false,
            isSquooshCompatible: false,
          },
        },
      };
    }
    
  • #8188 80f1494cd Thanks @ematipico! - The build.split and build.excludeMiddleware configuration options are deprecated and have been replaced by options in the adapter config.

    If your config includes the build.excludeMiddleware option, replace it with edgeMiddleware in your adapter options:

    import { defineConfig } from "astro/config";
    import vercel from "@astrojs/vercel/serverless";
    
    export default defineConfig({
         build: {
    -        excludeMiddleware: true
         },
         adapter: vercel({
    +        edgeMiddleware: true
         }),
    });
    

    If your config includes the build.split option, replace it with functionPerRoute in your adapter options:

    import { defineConfig } from "astro/config";
    import vercel from "@astrojs/vercel/serverless";
    
    export default defineConfig({
         build: {
    -        split: true
         },
         adapter: vercel({
    +        functionPerRoute: true
         }),
    });
    

Patch Changes

4.0.0-rc.5

Major Changes

  • #8239 52f0837bd Thanks @matthewp! - Vercel adapter now defaults to functionPerRoute.

    With this change, @astrojs/vercel/serverless now splits each route into its own function. By doing this, the size of each function is reduced and startup time is faster.

    You can disable this option, which will cause the code to be bundled into a single function, by setting functionPerRoute to false.

Patch Changes

4.0.0-rc.4

Major Changes

Patch Changes

4.0.0-beta.3

Patch Changes

4.0.0-beta.2

Patch Changes

  • Updated dependencies [2aa6d8ace]:
    • @astrojs/internal-helpers@0.2.0-beta.1
    • astro@3.0.0-beta.2

4.0.0-beta.1

Major Changes

  • #8015 9cc4e48e6 Thanks @matthewp! - Remove the Vercel Edge adapter

    @astrojs/vercel/serverless now supports Edge middleware, so a separate adapter for Edge itself (deploying your entire app to the edge) is no longer necessary. Please update your Astro config to reflect this change:

    // astro.config.mjs
    import { defineConfig } from 'astro/config';
    - import vercel from '@astrojs/vercel/edge';
    + import vercel from '@astrojs/vercel/serverless';
    
    export default defineConfig({
     output: 'server',
     adapter: vercel({
    +    edgeMiddleware: true
     }),
    });
    

    This adapter had several known limitations and compatibility issues that prevented many people from using it in production. To reduce maintenance costs and because we have a better story with Serveless + Edge Middleware, we are removing the Edge adapter.

Patch Changes

4.0.0-beta.0

Major Changes

  • 1eae2e3f7 Thanks @Princesseuh! - Remove support for Node 16. The lowest supported version by Astro and all integrations is now v18.14.1. As a reminder, Node 16 will be deprecated on the 11th September 2023.

  • c022a4217 Thanks @Princesseuh! - When using an adapter that supports neither Squoosh or Sharp, Astro will now automatically use an image service that does not support processing, but still provides the other benefits of astro:assets such as enforcing alt, no CLS etc to users

  • 3dc1ca2fa Thanks @Princesseuh! - Reduced the amount of polyfills provided by Astro. Astro will no longer provide (no-op) polyfills for several web apis such as HTMLElement, Image or Document. If you need access to those APIs on the server, we recommend using more proper polyfills available on npm.

Minor Changes

  • 9b4f70a62 Thanks @ematipico! - Introduced the concept of feature map. A feature map is a list of features that are built-in in Astro, and an Adapter can tell Astro if it can support it.

    import { AstroIntegration } from './astro';
    
    function myIntegration(): AstroIntegration {
      return {
        name: 'astro-awesome-list',
        // new feature map
        supportedAstroFeatures: {
          hybridOutput: 'experimental',
          staticOutput: 'stable',
          serverOutput: 'stable',
          assets: {
            supportKind: 'stable',
            isSharpCompatible: false,
            isSquooshCompatible: false,
          },
        },
      };
    }
    
  • 3fdf509b2 Thanks @ematipico! - The build.split and build.excludeMiddleware configuration options are deprecated and have been replaced by options in the adapter config.

    If your config includes the build.excludeMiddleware option, replace it with edgeMiddleware in your adapter options:

    import { defineConfig } from "astro/config";
    import vercel from "@astrojs/vercel/serverless";
    
    export default defineConfig({
         build: {
    -        excludeMiddleware: true
         },
         adapter: vercel({
    +        edgeMiddleware: true
         }),
    });
    

    If your config includes the build.split option, replace it with functionPerRoute in your adapter options:

    import { defineConfig } from "astro/config";
    import vercel from "@astrojs/vercel/serverless";
    
    export default defineConfig({
         build: {
    -        split: true
         },
         adapter: vercel({
    +        functionPerRoute: true
         }),
    });
    

Patch Changes

3.8.2

Patch Changes

3.8.1

Patch Changes

3.8.0

Minor Changes

Patch Changes

3.7.5

Patch Changes

3.7.4

Patch Changes

3.7.3

Patch Changes

3.7.2

Patch Changes

  • #7659 57a5eff5c Thanks @natemoo-re! - Fix critical build regression. @vercel/nft is excluded from the bundle automatically.

3.7.1

Patch Changes

3.7.0

Minor Changes

  • #7532 9e5fafa2b Thanks @ematipico! - Support for Vercel Edge Middleware via Astro middleware.

    When a project uses the new option Astro build.excludeMiddleware, the @astrojs/vercel/serverless adapter will automatically create a Vercel Edge Middleware that will automatically communicate with the Astro Middleware.

    Check the documentation for more details.

Patch Changes

3.6.0

Minor Changes

  • #7514 154af8f5e Thanks @matthewp! - Split support in Vercel Serverless

    The Vercel adapter builds to a single function by default. Astro 2.7 added support for splitting your build into separate entry points per page. If you use this configuration the Vercel adapter will generate a separate function for each page. This can help reduce the size of each function so they are only bundling code used on that page.

    // astro.config.mjs
    import { defineConfig } from 'astro/config';
    import vercel from '@astrojs/vercel/serverless';
    
    export default defineConfig({
      output: 'server',
      adapter: vercel(),
      build: {
        split: true,
      },
    });
    

Patch Changes

3.5.1

Patch Changes

3.5.0

Minor Changes

  • #7067 57f8d14c0 Thanks @matthewp! - Support for experimental redirects

    This adds support for the redirects RFC in the Vercel adapter. No changes are necessary, simply use configured redirects and the adapter will output the vercel.json file with the configuration values.

Patch Changes

3.4.1

Patch Changes

3.4.0

Minor Changes

Patch Changes

3.3.0

Minor Changes

Patch Changes

3.2.5

Patch Changes

3.2.4

Patch Changes

3.2.3

Patch Changes

3.2.2

Patch Changes

3.2.1

Patch Changes

3.2.0

Minor Changes

Patch Changes

3.1.4

Patch Changes

3.1.3

Patch Changes

3.1.2

Patch Changes

3.1.1

Patch Changes

3.1.0

Minor Changes

Patch Changes

3.0.1

Patch Changes

  • #6085 b236b5cc8 Thanks @AirBorne04! - Added second build step through esbuild, to allow framework defined build (vite build) and target defined bundling (esbuilt step)

  • Updated dependencies [9bec6bc41]:

    • astro@2.0.6

3.0.0

Major Changes

  • #5782 1f92d64ea Thanks @Princesseuh! - Remove support for Node 14. Minimum supported Node version is now >=16.12.0

  • #5707 5eba34fcc Thanks @bluwy! - Remove astro:build:start backwards compatibility code

  • #5806 7572f7402 Thanks @matthewp! - Make astro a peerDependency of integrations

    This marks astro as a peerDependency of several packages that are already getting major version bumps. This is so we can more properly track the dependency between them and what version of Astro they are being used with.

Patch Changes

3.0.0-beta.1

See changes in 3.0.0-beta.1

Major Changes

  • #5782 1f92d64ea Thanks @Princesseuh! - Remove support for Node 14. Minimum supported Node version is now >=16.12.0

  • #5806 7572f7402 Thanks @matthewp! - Make astro a peerDependency of integrations

    This marks astro as a peerDependency of several packages that are already getting major version bumps. This is so we can more properly track the dependency between them and what version of Astro they are being used with.

Patch Changes

3.0.0-beta.0

See changes in 3.0.0-beta.0

Major Changes

2.4.0

Minor Changes

2.3.6

Patch Changes

2.3.5

Patch Changes

2.3.4

Patch Changes

2.3.3

Patch Changes

2.3.2

Patch Changes

  • #5175 abf41da77 Thanks @JuanM04! - Edge adapter includes all the generated files (all files inside dist/) instead of only entry.mjs

2.3.1

Patch Changes

2.3.0

Minor Changes

2.2.0

Minor Changes

  • #5056 e55af8a23 Thanks @matthewp! - # New build configuration

    The 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), and serverEntry (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).

    Integration hook change

    The integration hook astro:build:start includes a param buildConfig which 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 new build.config options. 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: '...',
              },
            });
          },
        },
      };
    }
    

2.1.1

Patch Changes

2.1.0

Minor Changes

  • #4876 d3091f89e Thanks @matthewp! - Adds the Astro.cookies API

    Astro.cookies is a new API for manipulating cookies in Astro components and API routes.

    In Astro components, the new Astro.cookies object 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.

2.0.1

Patch Changes

2.0.0

Major Changes

1.0.2

Patch Changes

1.0.1

Patch Changes

1.0.0

Major Changes

Patch Changes

  • Updated dependencies [04ad44563]:
    • @astrojs/webapi@1.0.0

0.4.0

Minor Changes

0.3.0

Minor Changes

  • #4015 6fd161d76 Thanks @matthewp! - New output configuration option

    This 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 output is 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 the adapter configuration. 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 add output: '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 5a23483ef Thanks @matthewp! - Adds support for Astro.clientAddress

    The new Astro.clientAddress property allows you to get the IP address of the requested user.

    
    

    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.

0.2.6

Patch Changes

0.2.5

Patch Changes

0.2.4

Patch Changes

0.2.3

Patch Changes

  • Updated dependencies [4de53ecc]:
    • @astrojs/webapi@0.12.0

0.2.2

Patch Changes

  • #3368 9d01f93b Thanks @JuanM04! - Remove nodeVersion option for serverless target. Now it is inferred from Vercel

0.2.1

Patch Changes

0.2.0

Minor Changes

  • #3216 114bf63e Thanks @JuanM04! - [BREAKING] Now with Build Output API (v3)! See the README to get started.

    • trailingSlash redirects works without a vercel.json file: just configure them inside your astro.config.mjs
    • Multiple deploy targets: edge, serverless and static!
    • When building to serverless, your code isn't transpiled to CJS anymore.

    Migrate from v0.1

    1. Change the import inside astro.config.mjs:
      - import vercel from '@astrojs/vercel';
      + import vercel from '@astrojs/vercel/serverless';
      
    2. Rename the ENABLE_FILE_SYSTEM_API environment variable to ENABLE_VC_BUILD, as Vercel changed it.
    3. The output folder changed from .output to .vercel/output — you may need to update your .gitignore.

0.1.4

Patch Changes

0.1.3

Patch Changes

0.1.2

Patch Changes

0.1.1

Patch Changes

0.1.0

Patch Changes

  • #3008 8bd49c95 Thanks @JuanM04! - Updated integrations' astro:build:done hook: now it matches the client dist when using SSR

0.0.3-beta.1

Patch Changes

0.0.3-beta.0

Patch Changes

  • #3008 8bd49c95 Thanks @JuanM04! - Updated integrations' astro:build:done hook: now it matches the client dist when using SSR

0.0.2

Patch Changes