c15t
Version:
Headless JavaScript consent management platform for cookie banners, privacy preferences, consent storage, and script gating.
77 lines (76 loc) • 2.52 kB
TypeScript
/**
* @packageDocumentation
* Central export point for all consent management types and interfaces.
* This module aggregates and re-exports all type definitions needed for implementing
* GDPR-compliant consent management.
*/
export type { Callback, Callbacks, OnBannerFetchedPayload, OnConsentChangedPayload, OnConsentSetPayload, OnErrorPayload, } from './callbacks';
export type { ConsentBannerResponse, ConsentState, LocationInfo, NamespaceProps, } from './compliance';
/**
* @module
* GDPR Consent Types
*
* @remarks
* Exports types and constants for GDPR-specific consent management:
* - Consent category definitions
* - Consent type configurations
* - Predefined consent settings
*
* @example
* Import and use GDPR-related types:
* ```typescript
* import {
* type AllConsentNames,
* type ConsentType,
* consentTypes
* } from 'c15t/types';
*
* function isOptionalConsent(type: AllConsentNames): boolean {
* const config = consentTypes.find(c => c.name === type);
* return config ? !config.disabled && !config.defaultValue : false;
* }
* ```
*/
export { type AllConsentNames, allConsentNames, type ConsentInfo, type ConsentType, consentTypes, } from './consent-types';
export type { User } from './user';
/**
* @module
* Translation Types
*
* @remarks
* Exports types for translation configuration and translations:
* - Translation configuration
* - Translation types
* - Cookie banner translations
* - Consent manager dialog translations
* - Consent manager widget translations
*/
export type { CommonTranslations, ConsentManagerDialogTranslations, ConsentTypesTranslations, ConsentTypeTranslations, CookieBannerTranslations, I18nConfig, TranslationConfig, Translations, } from '@c15t/translations';
export * from './compliance';
export * from './iab-tcf';
export * from './legal-links';
export * from './non-iab-vendor';
export type Overrides = {
/**
* Country code to forcefully set
* @example 'DE'
*/
country?: string;
/**
* Region code to forcefully set
* @example 'BE'
*/
region?: string;
/**
* Language code to forcefully set
* @example 'de-DE'
*/
language?: string;
/**
* Override the Global Privacy Control (GPC) signal.
* When `true`, simulates GPC being active (opt-out of marketing/measurement).
* When `false`, suppresses the real browser GPC signal.
* When `undefined`, falls back to the browser's `navigator.globalPrivacyControl`.
*/
gpc?: boolean;
};