@sveltejs/adapter-vercel 2.2.1 → 2.3.1

package/README.md

@@ -2,8 +2,6 @@
 
 A SvelteKit adapter that creates a Vercel app.
 
-If you're using [adapter-auto](https://kit.svelte.dev/docs/adapter-auto), you don't need to install this unless you need to specify Vercel-specific options, since it's already included.
-
 ## Docs
 
 [Docs](https://kit.svelte.dev/docs/adapter-vercel)

package/files/edge.js

@@ -8,12 +8,16 @@ const initialized = server.init({
 
 /**
  * @param {Request} request
+ * @param {import('../index.js').RequestContext} context
  */
-export default async (request) => {
+export default async (request, context) => {
 	await initialized;
 	return server.respond(request, {
 		getClientAddress() {
 			return /** @type {string} */ (request.headers.get('x-forwarded-for'));
+		},
+		platform: {
+			context
 		}
 	});
 };

package/index.d.ts

@@ -1,4 +1,5 @@
 import { Adapter } from '@sveltejs/kit';
+import './ambient.js';
 
 export default function plugin(config?: Config): Adapter;
 
@@ -77,3 +78,59 @@ export interface EdgeConfig {
 }
 
 export type Config = EdgeConfig | ServerlessConfig;
+
+// we copy the RequestContext interface from `@vercel/edge` because that package can't co-exist with `@types/node`.
+// see https://github.com/sveltejs/kit/pull/9280#issuecomment-1452110035
+
+/**
+ * An extension to the standard `Request` object that is passed to every Edge Function.
+ *
+ * @example
+ * ```ts
+ * import type { RequestContext } from '@vercel/edge';
+ *
+ * export default async function handler(request: Request, ctx: RequestContext): Promise<Response> {
+ *   // ctx is the RequestContext
+ * }
+ * ```
+ */
+export interface RequestContext {
+	/**
+	 * A method that can be used to keep the function running after a response has been sent.
+	 * This is useful when you have an async task that you want to keep running even after the
+	 * response has been sent and the request has ended.
+	 *
+	 * @example
+	 *
+	 * <caption>Sending an internal error to an error tracking service</caption>
+	 *
+	 * ```ts
+	 * import type { RequestContext } from '@vercel/edge';
+	 *
+	 * export async function handleRequest(request: Request, ctx: RequestContext): Promise<Response> {
+	 *  try {
+	 *    return await myFunctionThatReturnsResponse();
+	 *  } catch (e) {
+	 *    ctx.waitUntil((async () => {
+	 *      // report this error to your error tracking service
+	 *      await fetch('https://my-error-tracking-service.com', {
+	 *        method: 'POST',
+	 *        body: JSON.stringify({
+	 *          stack: e.stack,
+	 *          message: e.message,
+	 *          name: e.name,
+	 *          url: request.url,
+	 *        }),
+	 *      });
+	 *    })());
+	 *    return new Response('Internal Server Error', { status: 500 });
+	 *  }
+	 * }
+	 * ```
+	 */
+	waitUntil(
+		/**
+		 * A promise that will be kept alive until it resolves or rejects.
+		 */ promise: Promise<unknown>
+	): void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sveltejs/adapter-vercel",
-  "version": "2.2.1",
+  "version": "2.3.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/sveltejs/kit",
@@ -29,7 +29,7 @@
   "devDependencies": {
     "@types/node": "^16.18.6",
     "typescript": "^4.9.4",
-    "@sveltejs/kit": "^1.9.2"
+    "@sveltejs/kit": "^1.11.0"
   },
   "peerDependencies": {
     "@sveltejs/kit": "^1.5.0"