@aws-amplify/adapter-nextjs 0.0.2-console-preview.e8aa063.0

package/src/types/NextServer.ts

@@ -0,0 +1,72 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { GetServerSidePropsContext as NextGetServerSidePropsContext } from 'next';
+import { NextRequest, NextResponse } from 'next/server';
+import { cookies } from 'next/headers';
+import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
+
+export namespace NextServer {
+	/**
+	 * This context is normally available in the following:
+	 *   - Next App Router [middleware](https://nextjs.org/docs/app/building-your-application/routing/middleware)
+	 *   - Next App Router [route handler](https://nextjs.org/docs/app/building-your-application/routing/route-handlers)
+	 *     when using `NextResponse` to create the response of the route handler
+	 */
+	export type NextRequestAndNextResponseContext = {
+		request: NextRequest;
+		response: NextResponse;
+	};
+
+	/**
+	 * This context is normally available in the following:
+	 *   - Next App Router [route handler](https://nextjs.org/docs/app/building-your-application/routing/route-handlers)
+	 *     when using the Web API [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
+	 *     to create the response of the route handler
+	 */
+	export type NextRequestAndResponseContext = {
+		request: NextRequest;
+		response: Response;
+	};
+
+	/**
+	 * This context is normally available in the following:
+	 *   - Next [Server Component](https://nextjs.org/docs/getting-started/react-essentials#server-components)
+	 *     where the [`cookies`](https://nextjs.org/docs/app/api-reference/functions/cookies)
+	 *     function can be imported and called
+	 */
+	export type ServerComponentContext = {
+		cookies: typeof cookies;
+	};
+
+	export type ServerActionContext = ServerComponentContext;
+
+	/**
+	 * This context is normally available in the
+	 * [`getServerSideProps`](https://nextjs.org/docs/pages/building-your-application/data-fetching/get-server-side-props)
+	 * function of the Next Pages Router.
+	 */
+	export type GetServerSidePropsContext = {
+		request: NextGetServerSidePropsContext['req'];
+		response: NextGetServerSidePropsContext['res'];
+	};
+
+	export type Context =
+		| NextRequestAndNextResponseContext
+		| NextRequestAndResponseContext
+		| ServerComponentContext
+		| GetServerSidePropsContext;
+
+	export interface RunWithContextInput<OperationResult> {
+		nextServerContext: Context | null;
+		operation: (
+			contextSpec: AmplifyServer.ContextSpec
+		) => OperationResult | Promise<OperationResult>;
+	}
+
+	export interface RunOperationWithContext {
+		<OperationResult>(
+			input: RunWithContextInput<OperationResult>
+		): Promise<OperationResult>;
+	}
+}

package/src/types/index.ts

@@ -0,0 +1,4 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { NextServer } from './NextServer';

package/src/utils/createCookieStorageAdapterFromNextServerContext.ts

@@ -0,0 +1,202 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { NextRequest, NextResponse } from 'next/server';
+import { NextServer } from '../types';
+import {
+	AmplifyServerContextError,
+	CookieStorage,
+} from '@aws-amplify/core/internals/adapter-core';
+import { IncomingMessage, ServerResponse } from 'http';
+
+export const DATE_IN_THE_PAST = new Date(0);
+
+export const createCookieStorageAdapterFromNextServerContext = (
+	context: NextServer.Context
+): CookieStorage.Adapter => {
+	const { request, response } = context as
+		| NextServer.NextRequestAndNextResponseContext
+		| NextServer.NextRequestAndResponseContext;
+
+	if (request instanceof NextRequest && response) {
+		if (response instanceof NextResponse) {
+			return createCookieStorageAdapterFromNextRequestAndNextResponse(
+				request,
+				response
+			);
+		} else {
+			return createCookieStorageAdapterFromNextRequestAndHttpResponse(
+				request,
+				response
+			);
+		}
+	}
+
+	const { cookies } = context as
+		| NextServer.ServerComponentContext
+		| NextServer.ServerActionContext;
+
+	if (typeof cookies === 'function') {
+		return createCookieStorageAdapterFromNextCookies(cookies);
+	}
+
+	const { request: req, response: res } =
+		context as NextServer.GetServerSidePropsContext;
+
+	if (req instanceof IncomingMessage && res instanceof ServerResponse) {
+		return createCookieStorageAdapterFromGetServerSidePropsContext(req, res);
+	}
+
+	// This should not happen normally.
+	throw new AmplifyServerContextError({
+		message:
+			'Attempted to create cookie storage adapter from an unsupported Next.js server context.',
+	});
+};
+
+const createCookieStorageAdapterFromNextRequestAndNextResponse = (
+	request: NextRequest,
+	response: NextResponse
+): CookieStorage.Adapter => {
+	const readonlyCookieStore = request.cookies;
+	const mutableCookieStore = response.cookies;
+
+	return {
+		get: readonlyCookieStore.get.bind(readonlyCookieStore),
+		getAll: readonlyCookieStore.getAll.bind(readonlyCookieStore),
+		set: mutableCookieStore.set.bind(mutableCookieStore),
+		delete: mutableCookieStore.delete.bind(mutableCookieStore),
+	};
+};
+
+const createCookieStorageAdapterFromNextRequestAndHttpResponse = (
+	request: NextRequest,
+	response: Response
+): CookieStorage.Adapter => {
+	const readonlyCookieStore = request.cookies;
+	const mutableCookieStore = createMutableCookieStoreFromHeaders(
+		response.headers
+	);
+
+	return {
+		get: readonlyCookieStore.get.bind(readonlyCookieStore),
+		getAll: readonlyCookieStore.getAll.bind(readonlyCookieStore),
+		...mutableCookieStore,
+	};
+};
+
+const createCookieStorageAdapterFromNextCookies = (
+	cookies: NextServer.ServerComponentContext['cookies']
+): CookieStorage.Adapter => {
+	const cookieStore = cookies();
+
+	// When Next cookies() is called in a server component, it returns a readonly
+	// cookie store. Hence calling set and delete throws an error. However,
+	// cookies() returns a mutable cookie store when called in a server action.
+	// We have no way to detect which one is returned, so we try to call set and delete
+	// and safely ignore the error if it is thrown.
+	const setFunc: CookieStorage.Adapter['set'] = (name, value, options) => {
+		try {
+			cookieStore.set(name, value, options);
+		} catch {
+			// no-op
+		}
+	};
+
+	const deleteFunc: CookieStorage.Adapter['delete'] = name => {
+		try {
+			cookieStore.delete(name);
+		} catch {
+			// no-op
+		}
+	};
+
+	return {
+		get: cookieStore.get.bind(cookieStore),
+		getAll: cookieStore.getAll.bind(cookieStore),
+		set: setFunc,
+		delete: deleteFunc,
+	};
+};
+
+const createCookieStorageAdapterFromGetServerSidePropsContext = (
+	request: NextServer.GetServerSidePropsContext['request'],
+	response: NextServer.GetServerSidePropsContext['response']
+): CookieStorage.Adapter => {
+	const cookiesMap = { ...request.cookies };
+	const allCookies = Object.entries(cookiesMap).map(([name, value]) => ({
+		name,
+		value,
+	}));
+
+	return {
+		get(name) {
+			const value = cookiesMap[name];
+			return value
+				? {
+						name,
+						value,
+				  }
+				: undefined;
+		},
+		getAll() {
+			return allCookies;
+		},
+		set(name, value, options) {
+			response.setHeader(
+				'Set-Cookie',
+				`${name}=${value};${options ? serializeSetCookieOptions(options) : ''}`
+			);
+		},
+		delete(name) {
+			response.setHeader(
+				'Set-Cookie',
+				`${name}=;Expires=${DATE_IN_THE_PAST.toUTCString()}`
+			);
+		},
+	};
+};
+
+const createMutableCookieStoreFromHeaders = (
+	headers: Headers
+): Pick<CookieStorage.Adapter, 'set' | 'delete'> => {
+	const setFunc: CookieStorage.Adapter['set'] = (name, value, options) => {
+		headers.append(
+			'Set-Cookie',
+			`${name}=${value};${options ? serializeSetCookieOptions(options) : ''}`
+		);
+	};
+	const deleteFunc: CookieStorage.Adapter['delete'] = name => {
+		headers.append(
+			'Set-Cookie',
+			`${name}=;Expires=${DATE_IN_THE_PAST.toUTCString()}`
+		);
+	};
+	return {
+		set: setFunc,
+		delete: deleteFunc,
+	};
+};
+
+const serializeSetCookieOptions = (
+	options: CookieStorage.SetCookieOptions
+): string => {
+	const { expires, maxAge, domain, httpOnly, sameSite, secure } = options;
+	const serializedOptions: string[] = [];
+	if (domain) {
+		serializedOptions.push(`Domain=${domain}`);
+	}
+	if (expires) {
+		serializedOptions.push(`Expires=${expires.toUTCString()}`);
+	}
+	if (httpOnly) {
+		serializedOptions.push(`HttpOnly`);
+	}
+	if (sameSite) {
+		serializedOptions.push(`SameSite=${sameSite}`);
+	}
+	if (secure) {
+		serializedOptions.push(`Secure`);
+	}
+	return serializedOptions.join(';');
+};

package/src/utils/getAmplifyConfig.ts

@@ -0,0 +1,22 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { ResourcesConfig } from '@aws-amplify/core';
+import { AmplifyServerContextError } from '@aws-amplify/core/internals/adapter-core';
+
+export const getAmplifyConfig = (): ResourcesConfig => {
+	const configStr = process.env.amplifyConfig;
+
+	if (!configStr) {
+		throw new AmplifyServerContextError({
+			message: 'Amplify configuration is missing from `process.env`.',
+			recoverySuggestion:
+				'Ensure to use `withAmplify` function in your `next.config.js`.',
+		});
+	}
+
+	const configObject = JSON.parse(configStr);
+
+	// TODO(HuiSF): adds ResourcesConfig validation when it has one.
+	return configObject;
+};

package/src/utils/index.ts

@@ -0,0 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { getAmplifyConfig } from './getAmplifyConfig';
+export { createCookieStorageAdapterFromNextServerContext } from './createCookieStorageAdapterFromNextServerContext';

package/src/withAmplify.ts

@@ -0,0 +1,28 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { ResourcesConfig } from '@aws-amplify/core';
+import { NextConfig } from 'next';
+
+// NOTE: this function is exported from the subpath `/with-amplify`.
+// The reason is that this function is called in the `next.config.js` which
+// is not being transpiled by Next.js.
+
+/**
+ * Merges the `amplifyConfig` into the `nextConfig.env`.
+ * @param nextConfig The next config for a Next.js app.
+ * @param amplifyConfig
+ * @returns The updated `nextConfig`.
+ */
+export const withAmplify = (
+	nextConfig: NextConfig,
+	amplifyConfig: ResourcesConfig
+) => {
+	nextConfig.env = {
+		...nextConfig.env,
+		// TODO(Hui): follow up the validation of the amplifyConfig.
+		amplifyConfig: JSON.stringify(amplifyConfig),
+	};
+
+	return nextConfig;
+};