@devcycle/nextjs-sdk/src/common/types.d.ts

The Next.js SDK for DevCycle!

import { DevCycleOptions, DevCycleUser } from '@devcycle/js-client-sdk';
import { BucketedUserConfig, ConfigSource } from '@devcycle/types';
export type DevCycleNextOptions = Pick<DevCycleOptions, 'maxEventQueueSize' | 'flushEventQueueSize' | 'eventFlushIntervalMS' | 'logger' | 'logLevel' | 'apiProxyURL' | 'disableRealtimeUpdates' | 'disableAutomaticEventLogging' | 'disableCustomEventLogging' | 'enableObfuscation'> & {
    /**
     * Make the SDK's initialization non-blocking. This unblocks serverside rendering up to the point of a variable
     * evaluation, and allows the use of a Suspense boundary to stream flagged components to the client when the
     * configuration is ready.
     *
     * When this is enabled, client components will initially render using default variable values,
     * and will re-render when the configuration is ready.
     */
    enableStreaming?: boolean;
    /**
     * Used to disable any SDK features that require dynamic request context. This allows the SDK to be used in pages
     * that are intended to be statically generated, as long as nothing else on that page consumes request details
     * like headers or cookies.
     * This option will disable the following features:
     * - automatic user agent parsing to populate targeting rule data for Platform Version and Device Model
     *
     */
    staticMode?: boolean;
    /**
     * Replace the default source for DevCycle configuration with an alternative
     */
    configSource?: ConfigSource;
};
export type BucketedConfigWithAdditionalFields = BucketedUserConfig & {
    lastModified?: string;
    clientSDKKey: string;
};
export type DevCycleServerData = {
    user: DevCycleUser;
    config: BucketedConfigWithAdditionalFields | null;
    userAgent: string | undefined;
};