cookie-consent-gdpr 1.0.0

package/dist/gdpr-cookie-consent.d.ts

@@ -0,0 +1,182 @@
+/**
+ * GDPR Cookie Consent — TypeScript Declarations
+ */
+
+export interface CookieDetail {
+  /** Cookie name or pattern. */
+  name: string;
+  /** Domain/company that sets this cookie. */
+  provider?: string;
+  /** Human-readable purpose. */
+  purpose?: string;
+  /** Duration string (e.g. '1 year', 'Session'). */
+  expiry?: string;
+  /** Type: 'HTTP Cookie' | 'localStorage' | 'sessionStorage' | 'Pixel'. */
+  type?: string;
+}
+
+export interface CategoryConfig {
+  /** Whether this category is enabled by default (must be false for non-necessary per GDPR). */
+  enabled: boolean;
+  /** Whether the user can toggle this off (true for strictly necessary cookies). */
+  readOnly: boolean;
+  /** Display title for this category. */
+  title: string;
+  /** Description of what this category does. */
+  description: string;
+  /** List of cookies in this category. */
+  cookies: CookieDetail[];
+}
+
+export interface CookieConfig {
+  /** Name of the consent cookie. Default: 'cc_consent'. */
+  name?: string;
+  /** Cookie domain. Set to '.example.com' for cross-subdomain sharing. */
+  domain?: string;
+  /** Cookie path. Default: '/'. */
+  path?: string;
+  /** Consent expiry in days. Default: 365. */
+  expiryDays?: number;
+  /** SameSite attribute. Default: 'Lax'. */
+  sameSite?: 'Lax' | 'Strict' | 'None';
+  /** Secure flag. Default: auto-detected from protocol. */
+  secure?: boolean;
+}
+
+export interface WebhookConfig {
+  /** URL to POST consent records to. */
+  url: string | null;
+  /** Additional headers for the webhook request. */
+  headers?: Record<string, string>;
+}
+
+export interface ThemeConfig {
+  primary?: string;
+  primaryHover?: string;
+  primaryText?: string;
+  background?: string;
+  text?: string;
+  textSecondary?: string;
+  border?: string;
+  overlay?: string;
+  toggleOn?: string;
+  toggleOff?: string;
+  toggleKnob?: string;
+  fontFamily?: string;
+  fontSize?: string;
+  borderRadius?: string;
+  zIndex?: number;
+  maxWidth?: string;
+  popupWidth?: string;
+}
+
+export interface TextsConfig {
+  bannerTitle?: string;
+  bannerDescription?: string;
+  acceptAll?: string;
+  rejectAll?: string;
+  settings?: string;
+  preferencesTitle?: string;
+  preferencesDescription?: string;
+  save?: string;
+  acceptAllPreferences?: string;
+  rejectAllPreferences?: string;
+  alwaysActive?: string;
+  cookieNameLabel?: string;
+  cookieProviderLabel?: string;
+  cookiePurposeLabel?: string;
+  cookieExpiryLabel?: string;
+  cookieTypeLabel?: string;
+  noCookies?: string;
+  privacyPolicyLabel?: string;
+  poweredBy?: string;
+}
+
+export interface ConsentRecord {
+  /** Unique consent ID (UUID). */
+  id: string;
+  /** ISO 8601 timestamp of when consent was given. */
+  timestamp: string;
+  /** Map of category keys to boolean consent values. */
+  categories: Record<string, boolean>;
+  /** Hash of the config used when consent was given. */
+  configHash: string;
+  /** ISO 8601 timestamp of when this consent expires. */
+  expires: string;
+  /** URL where consent was given. */
+  url: string;
+  /** User agent string. */
+  userAgent: string;
+}
+
+export type ConsentEvent =
+  | 'consent:given'
+  | 'consent:updated'
+  | 'consent:revoked'
+  | 'category:accepted'
+  | 'category:rejected'
+  | 'banner:shown'
+  | 'banner:hidden'
+  | 'preferences:shown'
+  | 'preferences:hidden';
+
+export interface CookieConsentConfig {
+  /** CSS selector or DOM element to mount the banner in. */
+  container?: string | HTMLElement | null;
+  /** CSS selector or DOM element for the preferences button. */
+  preferencesButton?: string | HTMLElement | null;
+  /** Banner layout: 'bar' | 'modal' | 'popup'. Default: 'bar'. */
+  layout?: 'bar' | 'modal' | 'popup';
+  /** Banner position. Default: 'bottom'. */
+  position?: 'bottom' | 'top' | 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left';
+  /** Whether clicking the overlay closes the banner. Default: false. */
+  closeOnBackdrop?: boolean;
+  /** Auto-show banner if no consent exists. Default: true. */
+  autoShow?: boolean;
+  /** Re-show banner when config changes. Default: true. */
+  reconsentOnChange?: boolean;
+  /** Force an overlay that blocks page interaction. Default: false. */
+  forceOverlay?: boolean;
+  /** Cookie storage settings. */
+  cookie?: CookieConfig;
+  /** Webhook for consent records. */
+  webhook?: WebhookConfig;
+  /** Cookie category definitions. */
+  categories?: Record<string, CategoryConfig>;
+  /** UI text strings (for i18n). */
+  texts?: TextsConfig;
+  /** URL to the site's privacy policy. */
+  privacyPolicyUrl?: string;
+  /** Theme/appearance settings. */
+  theme?: ThemeConfig;
+  /** Callback when consent is given or updated. */
+  onConsent?: (consent: ConsentRecord) => void;
+  /** Callback when consent is revoked. */
+  onRevoke?: (consent: ConsentRecord | null) => void;
+  /** Callback when a category is accepted. */
+  onAccept?: (category: string) => void;
+  /** Callback when a category is rejected. */
+  onReject?: (category: string) => void;
+}
+
+export interface CookieConsentAPI {
+  init(config?: CookieConsentConfig): CookieConsentAPI;
+  show(): CookieConsentAPI;
+  hide(): CookieConsentAPI;
+  showPreferences(): CookieConsentAPI;
+  hidePreferences(): CookieConsentAPI;
+  acceptAll(): CookieConsentAPI;
+  rejectAll(): CookieConsentAPI;
+  acceptCategory(category: string): CookieConsentAPI;
+  getConsent(): ConsentRecord | null;
+  hasConsented(): boolean;
+  hasCategory(category: string): boolean;
+  revokeConsent(): CookieConsentAPI;
+  on(event: ConsentEvent, fn: (data?: any) => void): CookieConsentAPI;
+  off(event: ConsentEvent, fn?: (data?: any) => void): CookieConsentAPI;
+  destroy(): CookieConsentAPI;
+  getConfig(): CookieConsentConfig | null;
+}
+
+declare const CookieConsent: CookieConsentAPI;
+export default CookieConsent;