@segment/consent-manager/types/types.d.ts

Drop-in consent management plugin for analytics.js

/// <reference types="react" />
/// <reference types="segment-analytics" />
import { CloseBehaviorFunction } from './consent-manager/container';
import { PreferencesManager } from './consent-manager-builder/preferences';
import { CookieAttributes } from 'js-cookie';
declare type AJS = SegmentAnalytics.AnalyticsJS & {
    initialized: boolean;
    track: (event: string, properties: {
        [key: string]: any;
    }) => void;
    addSourceMiddleware: (middleware: Middleware) => void;
};
export declare type Middleware = (input: MiddlewareInput) => void;
interface MiddlewareInput {
    payload: {
        obj: Record<string, any>;
        [key: string]: any;
    };
    integrations?: Record<string, boolean>;
    next: (payload: MiddlewareInput['payload']) => void;
}
export declare type WindowWithAJS = Window & typeof globalThis & {
    analytics?: AJS;
};
export declare type WindowWithConsentManagerConfig = Window & typeof globalThis & {
    consentManagerConfig?: (args: StandaloneConsentManagerParams) => ConsentManagerInput | ConsentManagerInput;
};
export declare type ConsentManagerInput = ConsentManagerProps & {
    container: string;
};
export declare type DefaultDestinationBehavior = 'enable' | 'disable' | 'imply' | 'ask';
export declare type CloseBehavior = 'accept' | 'deny' | 'dismiss';
interface StandaloneConsentManagerParams {
    React: unknown;
    version?: string;
    openConsentManager: () => void;
    doNotTrack: () => boolean | null;
    inEU: () => boolean;
    preferences: PreferencesManager;
    inRegions: (regions: string[]) => () => boolean;
}
export interface Preferences {
    destinationPreferences?: CategoryPreferences;
    customPreferences?: CategoryPreferences;
}
export interface Destination {
    id: string;
    name: string;
    creationName: string;
    description: string;
    website: string;
    category: string;
}
export interface CategoryPreferences {
    functional?: boolean | null | undefined;
    marketingAndAnalytics?: boolean | null | undefined;
    advertising?: boolean | null | undefined;
    [category: string]: boolean | null | undefined | string;
}
export interface CustomCategories {
    [key: string]: CustomCategory;
}
interface CustomCategory {
    integrations: string[];
    purpose: string;
}
export interface PreferencesCategories {
    key: string;
    name?: string;
    description?: string;
    example?: string;
}
export interface PreferenceDialogTemplate {
    headings?: {
        allowValue?: string;
        categoryValue?: string;
        purposeValue?: string;
        toolsValue?: string;
    };
    checkboxes?: {
        noValue?: string;
        yesValue?: string;
    };
    actionButtons?: {
        saveValue?: string;
        cancelValue?: string;
    };
    cancelDialogButtons?: {
        cancelValue?: string;
        backValue?: string;
    };
    categories?: PreferencesCategories[];
}
export interface ConsentManagerProps {
    writeKey: string;
    otherWriteKeys?: string[];
    shouldRequireConsent?: () => Promise<boolean> | boolean;
    implyConsentOnInteraction?: boolean;
    cookieDomain?: string;
    cookieName?: string;
    cookieAttributes?: CookieAttributes;
    cookieExpires?: number;
    bannerContent: React.ReactNode;
    bannerSubContent?: string;
    bannerActionsBlock?: ((props: ActionsBlockProps) => React.ReactElement) | true;
    bannerTextColor?: string;
    bannerBackgroundColor?: string;
    bannerHideCloseButton: boolean;
    bannerAsModal?: boolean;
    preferencesDialogTitle?: React.ReactNode;
    preferencesDialogContent: React.ReactNode;
    onError?: (error: Error | undefined) => void;
    cancelDialogTitle?: React.ReactNode;
    cancelDialogContent: React.ReactNode;
    closeBehavior?: CloseBehavior | CloseBehaviorFunction;
    initialPreferences?: CategoryPreferences;
    customCategories?: CustomCategories;
    defaultDestinationBehavior?: DefaultDestinationBehavior;
    cdnHost?: string;
    preferencesDialogTemplate?: PreferenceDialogTemplate;
}
export interface ActionsBlockProps {
    acceptAll: () => void;
    denyAll: () => void;
    changePreferences: () => void;
}
export {};