gitbook/src/lib/seo.ts

import { Collection, ContentVisibility, Space } from '@gitbook/api';
import { headers } from 'next/headers';

/**
 * Return true if a space should be indexed by search engines.
 */
export function shouldIndexSpace({
    space,
    collection,
}: {
    space: Space;
    collection: Collection | null;
}) {
    const headerSet = headers();

    if (
        process.env.GITBOOK_BLOCK_SEARCH_INDEXATION &&
        !headerSet.has('x-gitbook-search-indexation')
    ) {
        return false;
    }

    // Prevent indexation of preview of revisions / change-requests
    if (
        headerSet.get('x-gitbook-content-revision') ||
        headerSet.get('x-gitbook-content-changerequest')
    ) {
        return false;
    }

    if (space.visibility === ContentVisibility.InCollection) {
        return collection ? shouldIndexVisibility(collection.visibility) : false;
    }
    return shouldIndexVisibility(space.visibility);
}

function shouldIndexVisibility(visibility: ContentVisibility) {
    return visibility === ContentVisibility.Public;
}