import type { Relay } from '@coveo/relay';
/**
 * The `NavigatorContext` interface represents the context of the browser client.
 */
export interface NavigatorContext {
    /**
     * The`X-Forwarded-For` header.
     * This header is used to identify the originating IP address of a client.
     * See [X-Forwarded-For](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For)
     *
     * **Note:** This property is only relevant for Server-Side Rendering (SSR) use cases.
     */
    forwardedFor?: string;
    /**
     * The URL of the page that referred the user to the current page.
     * See [Referer](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer)
     */
    referrer: string | null;
    /**
     * The user agent string of the browser that made the request.
     * See [User-Agent](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent)
     */
    userAgent: string | null;
    /**
     * The URL of the current page.
     */
    location: string | null;
    /** The unique identifier of the browser client in a Coveo-powered page.
     * See [clientId](https://docs.coveo.com/en/masb0234).
     */
    clientId: string;
    /**
     * Whether to capture analytics events.
     *
     * Must be left undefined or set to `false` if the `clientId` is an empty string, otherwise requests will fail.
     */
    capture?: boolean;
}
/**
 * The navigator context provider.
 * This provider is essential for retrieving navigation-related data such as referrer, userAgent, location, and clientId, which are crucial for handling both server-side and client-side API requests effectively.
 *
 * Note: The implementation specifics of the navigator context provider depend on the Node.js framework being used. It is the developer's responsibility to define and implement the navigator context provider to ensure accurate navigation context is available in the application. If the user fails to provide a navigator context provider, a warning will be logged either in the server or the browser console.
 */
export type NavigatorContextProvider = () => NavigatorContext;
export type BrowserNavigatorContextProvider = (clientId: string) => NavigatorContext;
export declare const defaultNodeJSNavigatorContextProvider: NavigatorContextProvider;
export declare const getNavigatorContext: (relay: Relay, customProvider?: NavigatorContextProvider) => NavigatorContext;