Function serveWithQueryAPIToken

packages/gitbook/src/middleware.ts:454–488

* Server a response with an API token obtained from the query params.

(
    scopePath: string,
    request: NextRequest,
    serve: (apiToken: string) => Promise<NextResponse>
)

 * Server a response with an API token obtained from the query params.
 */
async function serveWithQueryAPIToken(
    scopePath: string,
    request: NextRequest,
    serve: (apiToken: string) => Promise<NextResponse>
) {
    // We store the API token in a cookie that is scoped to the specific route
    // to avoid errors when multiple previews are opened in different tabs.
    const cookieName = getPathScopedCookieName('gitbook-api-token', scopePath);

    // Extract a potential GitBook API token passed in the request
    // If found, we redirect to the same URL but with the token in the cookie
    const queryAPIToken = request.nextUrl.searchParams.get('token');
    if (queryAPIToken) {
        request.nextUrl.searchParams.delete('token');
        return writeResponseCookies(NextResponse.redirect(request.nextUrl.toString()), [
            {
                name: cookieName,
                value: queryAPIToken,
                options: {
                    httpOnly: true,
                    sameSite: process.env.NODE_ENV === 'production' ? 'none' : undefined,
                    secure: process.env.NODE_ENV === 'production',
                    maxAge: 60 * 60, // 1 hour
                },
            },
        ]);
    }

    const apiToken = request.cookies.get(cookieName)?.value;
    if (!apiToken) {
        throw new DataFetcherError('Missing API token', 400);
    }

    return serve(apiToken);
}

/**
 * The URL of the GitBook content can be passed in 3 different ways (in order of priority):