@solvenza/cookies-compliance 1.2.1 → 1.5.3

package/dist/presets.d.ts

@@ -0,0 +1,51 @@
+import { m as ServicePreset, j as ServiceConfig, C as ConsentConfig } from './types--kyI7OOR.js';
+
+/**
+ * Built-in service presets for common analytics, marketing, media, payments, and security tools.
+ * Compliant with AEPD / GDPR / LSSI standards with pre-configured cookie names, storage keys,
+ * providers, and default categories.
+ */
+declare const SERVICE_PRESETS: Record<string, ServicePreset>;
+type KnownPresetId = keyof typeof SERVICE_PRESETS | string;
+
+/**
+ * Check if a preset exists in the catalog.
+ */
+declare function hasPreset(presetId: string): boolean;
+/**
+ * Retrieve a service preset by identifier, optionally applying custom overrides.
+ *
+ * @param presetId - Identifier of the preset (e.g. 'ga4', 'meta_pixel', 'hotjar')
+ * @param overrides - Optional overrides to customize category, label, cookies, etc.
+ * @returns Complete ServiceConfig ready for ConsentConfig.services
+ *
+ * @example
+ * ```ts
+ * const ga4Service = getPreset('ga4');
+ * const customPosthog = getPreset('posthog', { label: 'Internal Product Metrics' });
+ * ```
+ */
+declare function getPreset(presetId: KnownPresetId, overrides?: Partial<ServiceConfig>): ServiceConfig;
+/**
+ * Define multiple services using preset shorthand, preset IDs, or full custom configurations.
+ *
+ * @example
+ * ```ts
+ * const services = defineServices({
+ *   ga4: 'ga4',
+ *   facebook: 'meta_pixel',
+ *   hotjar: { preset: 'hotjar', category: 'analytics' },
+ *   customApi: { category: 'necessary', label: 'Custom Auth API' }
+ * });
+ * ```
+ */
+declare function defineServices(definitions: Record<string, KnownPresetId | (Partial<ServiceConfig> & {
+    preset?: string;
+})>): Record<string, ServiceConfig>;
+/**
+ * Resolve any preset references in a ConsentConfig object in-place or return a new hydrated config.
+ * Hydrates services configured with `"preset": "ga4"` or matching known preset keys.
+ */
+declare function resolveConfigPresets(config: ConsentConfig): ConsentConfig;
+
+export { type KnownPresetId, SERVICE_PRESETS, ServicePreset, defineServices, getPreset, hasPreset, resolveConfigPresets };

package/dist/presets.js

@@ -0,0 +1,16 @@
+import {
+  SERVICE_PRESETS,
+  defineServices,
+  getPreset,
+  hasPreset,
+  resolveConfigPresets
+} from "./chunk-OHOHIAK6.js";
+import "./chunk-Q3FZFXQE.js";
+export {
+  SERVICE_PRESETS,
+  defineServices,
+  getPreset,
+  hasPreset,
+  resolveConfigPresets
+};
+//# sourceMappingURL=presets.js.map

package/dist/presets.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types--kyI7OOR.d.cts

@@ -0,0 +1,314 @@
+interface ConsentChoices {
+    [categoryOrService: string]: boolean;
+}
+interface ServiceConfig {
+    preset?: string;
+    category?: string;
+    label?: string;
+    provider?: string;
+    policyUrl?: string;
+    description?: string;
+    cookies?: Array<{
+        name: string;
+        domain?: string;
+        duration?: string;
+        purpose?: string;
+    }>;
+    storageKeys?: string[];
+    localStorage?: string[];
+    sessionStorage?: string[];
+}
+interface ServicePreset {
+    id: string;
+    category: string;
+    label: string;
+    provider: string;
+    description?: string;
+    policyUrl?: string;
+    cookies?: Array<{
+        name: string;
+        domain?: string;
+        duration?: string;
+        purpose?: string;
+    }>;
+    storageKeys?: string[];
+    localStorage?: string[];
+    sessionStorage?: string[];
+}
+interface CategoryConfig {
+    required?: boolean;
+    default?: boolean;
+    label: string;
+    description: string;
+    storageKeys?: string[];
+    localStorage?: string[];
+    sessionStorage?: string[];
+}
+interface StoragePurgeReport {
+    category: string;
+    purgedCookies: string[];
+    purgedLocalStorage: string[];
+    purgedSessionStorage: string[];
+}
+interface FloatingBadgeConfig {
+    enabled?: boolean;
+    position?: "bottom-left" | "bottom-right" | "top-left" | "top-right";
+    label?: string;
+    ariaLabel?: string;
+    tooltip?: string;
+    showLabel?: boolean;
+    icon?: "cookie" | "shield" | "settings";
+    visibility?: "always" | "after-consent";
+}
+interface BannerUIConfig {
+    title?: string;
+    description?: string;
+    accept?: string;
+    reject?: string;
+    configure?: string;
+    cookiesPolicy?: string;
+    privacyPolicy?: string;
+    ariaLabel?: string;
+}
+interface PreferencesUIConfig {
+    title?: string;
+    subtitle?: string;
+    save?: string;
+    acceptAll?: string;
+    rejectAll?: string;
+    closeLabel?: string;
+    requiredBadge?: string;
+    optionalBadge?: string;
+    servicesLabel?: string;
+    viewServices?: string;
+    hideServices?: string;
+    thirdParty?: string;
+}
+interface TranslationConfig {
+    policy?: {
+        privacyUrl?: string;
+        cookiesUrl?: string;
+    };
+    ui?: {
+        banner?: BannerUIConfig;
+        preferences?: PreferencesUIConfig;
+        floatingBadge?: {
+            label?: string;
+            ariaLabel?: string;
+            tooltip?: string;
+        };
+    };
+    categories?: Record<string, {
+        label?: string;
+        description?: string;
+    }>;
+    services?: Record<string, {
+        label?: string;
+        provider?: string;
+    }>;
+}
+interface LocaleConfig {
+    default?: string;
+    autoDetect?: boolean;
+    syncHtmlLang?: boolean;
+    syncUrl?: boolean;
+    supported?: string[];
+}
+interface GpcConfig {
+    enabled?: boolean;
+    respectSignal?: boolean;
+    mode?: "auto-reject" | "notice-only";
+    categories?: string[];
+    noticeText?: string;
+}
+interface LegalEntityConfig {
+    name: string;
+    tradeName?: string;
+    taxId?: string;
+    address?: string;
+    email?: string;
+    phone?: string;
+    registryData?: string;
+    dpoEmail?: string;
+    activity?: string;
+    websiteUrl?: string;
+}
+interface LegalNoticeConfig {
+    entity?: LegalEntityConfig;
+    applicableLaw?: string;
+    jurisdiction?: string;
+    lastUpdated?: string;
+}
+interface LegalPolicyOptions {
+    view?: "full" | "table-only" | "summary";
+    locale?: string;
+    showRevocationButtons?: boolean;
+    showBrowserGuide?: boolean;
+    showInternationalTransfers?: boolean;
+    showGpcNotice?: boolean;
+    theme?: "light" | "dark" | "auto";
+    className?: string;
+}
+interface ConsentConfig {
+    schemaVersion: number;
+    policyVersion: string;
+    legalEntity?: LegalEntityConfig;
+    legalNotice?: LegalNoticeConfig;
+    locale?: LocaleConfig;
+    translations?: Record<string, TranslationConfig>;
+    security?: {
+        secretKey?: string;
+    };
+    csp?: {
+        nonce?: string;
+    };
+    gpc?: GpcConfig;
+    storage?: {
+        name?: string;
+        type?: "cookie" | "memory";
+        sameSite?: "Strict" | "Lax" | "None";
+        secure?: boolean;
+        path?: string;
+        domain?: string;
+    };
+    consent?: {
+        maxAgeDays?: number;
+    };
+    policy?: {
+        privacyUrl?: string;
+        cookiesUrl?: string;
+    };
+    categories: Record<string, CategoryConfig>;
+    services?: Record<string, ServiceConfig>;
+    logging?: {
+        enabled?: boolean;
+        endpoint?: string;
+    };
+    ui?: {
+        theme?: "auto" | "light" | "dark";
+        position?: "bottom" | "top" | "modal";
+        banner?: BannerUIConfig;
+        preferences?: PreferencesUIConfig;
+        floatingBadge?: boolean | FloatingBadgeConfig;
+    };
+}
+interface ConsentReceipt {
+    schema?: number;
+    receiptId: string;
+    policyVersion: string;
+    decidedAt: string;
+    updatedAt: string;
+    source: "banner" | "preferences" | "withdraw" | "programmatic" | "gpc";
+    choices: ConsentChoices;
+    signature?: string;
+    gpc?: boolean;
+}
+interface ConsentState {
+    initialized: boolean;
+    policyVersion: string;
+    locale: string;
+    receipt: ConsentReceipt | null;
+    choices: ConsentChoices;
+    gpc?: boolean;
+}
+type ConsentEvent = "ready" | "banner:shown" | "preferences:opened" | "preferences:closed" | "floating-badge:shown" | "floating-badge:hidden" | "locale:changed" | "gpc:detected" | "consent:changed" | "consent:accepted" | "consent:rejected" | "consent:withdrawn" | "service:blocked" | "service:loaded" | "service:revoked" | "storage:purged" | "diagnostic:warning" | "error";
+interface ConsentEventDetailMap {
+    ready: {
+        state: ConsentState;
+    };
+    "banner:shown": void;
+    "preferences:opened": void;
+    "preferences:closed": void;
+    "floating-badge:shown": void;
+    "floating-badge:hidden": void;
+    "locale:changed": {
+        locale: string;
+        previousLocale: string;
+    };
+    "gpc:detected": {
+        signal: boolean;
+        autoApplied: boolean;
+        choices: ConsentChoices;
+    };
+    "consent:changed": {
+        choices: ConsentChoices;
+        receipt: ConsentReceipt;
+    };
+    "consent:accepted": {
+        choices: ConsentChoices;
+        receipt: ConsentReceipt;
+    };
+    "consent:rejected": {
+        choices: ConsentChoices;
+        receipt: ConsentReceipt;
+    };
+    "consent:withdrawn": {
+        previousChoices: ConsentChoices;
+    };
+    "service:blocked": {
+        serviceId: string;
+        category: string;
+        element?: HTMLElement;
+    };
+    "service:loaded": {
+        serviceId: string;
+        category: string;
+    };
+    "service:revoked": {
+        serviceId: string;
+        category: string;
+    };
+    "storage:purged": {
+        category: string;
+        report: StoragePurgeReport;
+    };
+    "diagnostic:warning": {
+        code: string;
+        message: string;
+        details?: unknown;
+    };
+    error: {
+        code: string;
+        message: string;
+        error?: unknown;
+    };
+}
+type ConsentEventHandler<E extends ConsentEvent> = (detail: ConsentEventDetailMap[E]) => void;
+interface DiagnosticReport {
+    timestamp: string;
+    unblockedThirdPartyScripts: string[];
+    compliant: boolean;
+}
+interface ConsentSDKInterface {
+    init(config: ConsentConfig | string): Promise<void>;
+    ready(): Promise<void>;
+    getConsent(): ConsentState;
+    getLocale(): string;
+    setLocale(locale: string): void;
+    syncLocale(locale: string): void;
+    isGpcActive(): boolean;
+    has(category: string): boolean;
+    hasService(service: string): boolean;
+    acceptAll(): void;
+    rejectAll(): void;
+    setPreferences(choices: Record<string, boolean>): void;
+    openPreferences(): void;
+    closePreferences(): void;
+    withdraw(): void;
+    purgeCategory(category: string): StoragePurgeReport;
+    purgeStorage(categoryOrService?: string): StoragePurgeReport[];
+    showFloatingBadge(): void;
+    hideFloatingBadge(): void;
+    when(categoryOrService: string, callback: () => void): () => void;
+    on<E extends ConsentEvent>(event: E, handler: ConsentEventHandler<E>): () => void;
+    getReceipt(): ConsentReceipt | null;
+    rescan(): DiagnosticReport;
+    mountPolicy(targetContainer: HTMLElement | string, options?: LegalPolicyOptions): void;
+    renderPolicyHtml(options?: LegalPolicyOptions): string;
+    mountLegalNotice(targetContainer: HTMLElement | string, options?: LegalPolicyOptions): void;
+    renderLegalNoticeHtml(options?: LegalPolicyOptions): string;
+    mountPrivacyPolicy(targetContainer: HTMLElement | string, options?: LegalPolicyOptions): void;
+    renderPrivacyPolicyHtml(options?: LegalPolicyOptions): string;
+}
+
+export type { BannerUIConfig as B, ConsentConfig as C, DiagnosticReport as D, FloatingBadgeConfig as F, GpcConfig as G, LegalPolicyOptions as L, PreferencesUIConfig as P, StoragePurgeReport as S, TranslationConfig as T, ConsentSDKInterface as a, ConsentState as b, ConsentChoices as c, ConsentEvent as d, ConsentEventHandler as e, ConsentReceipt as f, LegalEntityConfig as g, LegalNoticeConfig as h, CategoryConfig as i, ServiceConfig as j, ConsentEventDetailMap as k, LocaleConfig as l, ServicePreset as m };

package/dist/types--kyI7OOR.d.ts

@@ -0,0 +1,314 @@
+interface ConsentChoices {
+    [categoryOrService: string]: boolean;
+}
+interface ServiceConfig {
+    preset?: string;
+    category?: string;
+    label?: string;
+    provider?: string;
+    policyUrl?: string;
+    description?: string;
+    cookies?: Array<{
+        name: string;
+        domain?: string;
+        duration?: string;
+        purpose?: string;
+    }>;
+    storageKeys?: string[];
+    localStorage?: string[];
+    sessionStorage?: string[];
+}
+interface ServicePreset {
+    id: string;
+    category: string;
+    label: string;
+    provider: string;
+    description?: string;
+    policyUrl?: string;
+    cookies?: Array<{
+        name: string;
+        domain?: string;
+        duration?: string;
+        purpose?: string;
+    }>;
+    storageKeys?: string[];
+    localStorage?: string[];
+    sessionStorage?: string[];
+}
+interface CategoryConfig {
+    required?: boolean;
+    default?: boolean;
+    label: string;
+    description: string;
+    storageKeys?: string[];
+    localStorage?: string[];
+    sessionStorage?: string[];
+}
+interface StoragePurgeReport {
+    category: string;
+    purgedCookies: string[];
+    purgedLocalStorage: string[];
+    purgedSessionStorage: string[];
+}
+interface FloatingBadgeConfig {
+    enabled?: boolean;
+    position?: "bottom-left" | "bottom-right" | "top-left" | "top-right";
+    label?: string;
+    ariaLabel?: string;
+    tooltip?: string;
+    showLabel?: boolean;
+    icon?: "cookie" | "shield" | "settings";
+    visibility?: "always" | "after-consent";
+}
+interface BannerUIConfig {
+    title?: string;
+    description?: string;
+    accept?: string;
+    reject?: string;
+    configure?: string;
+    cookiesPolicy?: string;
+    privacyPolicy?: string;
+    ariaLabel?: string;
+}
+interface PreferencesUIConfig {
+    title?: string;
+    subtitle?: string;
+    save?: string;
+    acceptAll?: string;
+    rejectAll?: string;
+    closeLabel?: string;
+    requiredBadge?: string;
+    optionalBadge?: string;
+    servicesLabel?: string;
+    viewServices?: string;
+    hideServices?: string;
+    thirdParty?: string;
+}
+interface TranslationConfig {
+    policy?: {
+        privacyUrl?: string;
+        cookiesUrl?: string;
+    };
+    ui?: {
+        banner?: BannerUIConfig;
+        preferences?: PreferencesUIConfig;
+        floatingBadge?: {
+            label?: string;
+            ariaLabel?: string;
+            tooltip?: string;
+        };
+    };
+    categories?: Record<string, {
+        label?: string;
+        description?: string;
+    }>;
+    services?: Record<string, {
+        label?: string;
+        provider?: string;
+    }>;
+}
+interface LocaleConfig {
+    default?: string;
+    autoDetect?: boolean;
+    syncHtmlLang?: boolean;
+    syncUrl?: boolean;
+    supported?: string[];
+}
+interface GpcConfig {
+    enabled?: boolean;
+    respectSignal?: boolean;
+    mode?: "auto-reject" | "notice-only";
+    categories?: string[];
+    noticeText?: string;
+}
+interface LegalEntityConfig {
+    name: string;
+    tradeName?: string;
+    taxId?: string;
+    address?: string;
+    email?: string;
+    phone?: string;
+    registryData?: string;
+    dpoEmail?: string;
+    activity?: string;
+    websiteUrl?: string;
+}
+interface LegalNoticeConfig {
+    entity?: LegalEntityConfig;
+    applicableLaw?: string;
+    jurisdiction?: string;
+    lastUpdated?: string;
+}
+interface LegalPolicyOptions {
+    view?: "full" | "table-only" | "summary";
+    locale?: string;
+    showRevocationButtons?: boolean;
+    showBrowserGuide?: boolean;
+    showInternationalTransfers?: boolean;
+    showGpcNotice?: boolean;
+    theme?: "light" | "dark" | "auto";
+    className?: string;
+}
+interface ConsentConfig {
+    schemaVersion: number;
+    policyVersion: string;
+    legalEntity?: LegalEntityConfig;
+    legalNotice?: LegalNoticeConfig;
+    locale?: LocaleConfig;
+    translations?: Record<string, TranslationConfig>;
+    security?: {
+        secretKey?: string;
+    };
+    csp?: {
+        nonce?: string;
+    };
+    gpc?: GpcConfig;
+    storage?: {
+        name?: string;
+        type?: "cookie" | "memory";
+        sameSite?: "Strict" | "Lax" | "None";
+        secure?: boolean;
+        path?: string;
+        domain?: string;
+    };
+    consent?: {
+        maxAgeDays?: number;
+    };
+    policy?: {
+        privacyUrl?: string;
+        cookiesUrl?: string;
+    };
+    categories: Record<string, CategoryConfig>;
+    services?: Record<string, ServiceConfig>;
+    logging?: {
+        enabled?: boolean;
+        endpoint?: string;
+    };
+    ui?: {
+        theme?: "auto" | "light" | "dark";
+        position?: "bottom" | "top" | "modal";
+        banner?: BannerUIConfig;
+        preferences?: PreferencesUIConfig;
+        floatingBadge?: boolean | FloatingBadgeConfig;
+    };
+}
+interface ConsentReceipt {
+    schema?: number;
+    receiptId: string;
+    policyVersion: string;
+    decidedAt: string;
+    updatedAt: string;
+    source: "banner" | "preferences" | "withdraw" | "programmatic" | "gpc";
+    choices: ConsentChoices;
+    signature?: string;
+    gpc?: boolean;
+}
+interface ConsentState {
+    initialized: boolean;
+    policyVersion: string;
+    locale: string;
+    receipt: ConsentReceipt | null;
+    choices: ConsentChoices;
+    gpc?: boolean;
+}
+type ConsentEvent = "ready" | "banner:shown" | "preferences:opened" | "preferences:closed" | "floating-badge:shown" | "floating-badge:hidden" | "locale:changed" | "gpc:detected" | "consent:changed" | "consent:accepted" | "consent:rejected" | "consent:withdrawn" | "service:blocked" | "service:loaded" | "service:revoked" | "storage:purged" | "diagnostic:warning" | "error";
+interface ConsentEventDetailMap {
+    ready: {
+        state: ConsentState;
+    };
+    "banner:shown": void;
+    "preferences:opened": void;
+    "preferences:closed": void;
+    "floating-badge:shown": void;
+    "floating-badge:hidden": void;
+    "locale:changed": {
+        locale: string;
+        previousLocale: string;
+    };
+    "gpc:detected": {
+        signal: boolean;
+        autoApplied: boolean;
+        choices: ConsentChoices;
+    };
+    "consent:changed": {
+        choices: ConsentChoices;
+        receipt: ConsentReceipt;
+    };
+    "consent:accepted": {
+        choices: ConsentChoices;
+        receipt: ConsentReceipt;
+    };
+    "consent:rejected": {
+        choices: ConsentChoices;
+        receipt: ConsentReceipt;
+    };
+    "consent:withdrawn": {
+        previousChoices: ConsentChoices;
+    };
+    "service:blocked": {
+        serviceId: string;
+        category: string;
+        element?: HTMLElement;
+    };
+    "service:loaded": {
+        serviceId: string;
+        category: string;
+    };
+    "service:revoked": {
+        serviceId: string;
+        category: string;
+    };
+    "storage:purged": {
+        category: string;
+        report: StoragePurgeReport;
+    };
+    "diagnostic:warning": {
+        code: string;
+        message: string;
+        details?: unknown;
+    };
+    error: {
+        code: string;
+        message: string;
+        error?: unknown;
+    };
+}
+type ConsentEventHandler<E extends ConsentEvent> = (detail: ConsentEventDetailMap[E]) => void;
+interface DiagnosticReport {
+    timestamp: string;
+    unblockedThirdPartyScripts: string[];
+    compliant: boolean;
+}
+interface ConsentSDKInterface {
+    init(config: ConsentConfig | string): Promise<void>;
+    ready(): Promise<void>;
+    getConsent(): ConsentState;
+    getLocale(): string;
+    setLocale(locale: string): void;
+    syncLocale(locale: string): void;
+    isGpcActive(): boolean;
+    has(category: string): boolean;
+    hasService(service: string): boolean;
+    acceptAll(): void;
+    rejectAll(): void;
+    setPreferences(choices: Record<string, boolean>): void;
+    openPreferences(): void;
+    closePreferences(): void;
+    withdraw(): void;
+    purgeCategory(category: string): StoragePurgeReport;
+    purgeStorage(categoryOrService?: string): StoragePurgeReport[];
+    showFloatingBadge(): void;
+    hideFloatingBadge(): void;
+    when(categoryOrService: string, callback: () => void): () => void;
+    on<E extends ConsentEvent>(event: E, handler: ConsentEventHandler<E>): () => void;
+    getReceipt(): ConsentReceipt | null;
+    rescan(): DiagnosticReport;
+    mountPolicy(targetContainer: HTMLElement | string, options?: LegalPolicyOptions): void;
+    renderPolicyHtml(options?: LegalPolicyOptions): string;
+    mountLegalNotice(targetContainer: HTMLElement | string, options?: LegalPolicyOptions): void;
+    renderLegalNoticeHtml(options?: LegalPolicyOptions): string;
+    mountPrivacyPolicy(targetContainer: HTMLElement | string, options?: LegalPolicyOptions): void;
+    renderPrivacyPolicyHtml(options?: LegalPolicyOptions): string;
+}
+
+export type { BannerUIConfig as B, ConsentConfig as C, DiagnosticReport as D, FloatingBadgeConfig as F, GpcConfig as G, LegalPolicyOptions as L, PreferencesUIConfig as P, StoragePurgeReport as S, TranslationConfig as T, ConsentSDKInterface as a, ConsentState as b, ConsentChoices as c, ConsentEvent as d, ConsentEventHandler as e, ConsentReceipt as f, LegalEntityConfig as g, LegalNoticeConfig as h, CategoryConfig as i, ServiceConfig as j, ConsentEventDetailMap as k, LocaleConfig as l, ServicePreset as m };