@consentera/consent-sdk 2.0.0

package/dist/types/react/index.d.mts

@@ -0,0 +1,4 @@
+// GENERATED by scripts/emit-esm-types.mjs — do not edit.
+// The ESM-flavoured door into the shared declaration tree; that script says
+// why a .d.mts entry is needed at all.
+export * from './index.js';

package/dist/types/react/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * ConsentEra Consent SDK — React Integration
+ * Provider, hooks, and components for React applications
+ */
+export { ConsentEraProvider, useConsentEraClient, useConsentEraContext, type ConsentEraContextValue, type ConsentEraProviderProps, } from './ConsentEraProvider';
+export { useConsentEra } from './useConsentEra';
+export { useConsentValidation, type UseConsentValidationReturn, type UseConsentValidationOptions, } from './useConsentValidation';
+export { ConsentGate } from './ConsentGate';
+export type { UseConsentEraReturn } from './useConsentEra';
+export type { ConsentGateProps } from './ConsentGate';

package/dist/types/react/useConsentEra.d.ts

@@ -0,0 +1,65 @@
+import { ConsentEraClient } from '../core/ConsentEraClient';
+import { ConsentSession } from '../consent/ConsentSession';
+import { ConsentValidator } from '../consent/ConsentValidator';
+import { ConsentManager } from '../consent/ConsentManager';
+import { CallbackHandler } from '../consent/CallbackHandler';
+import { DFConfigClient } from '../df/DFConfigClient';
+import { PrincipalClient } from '../principal/PrincipalClient';
+/**
+ * Every namespace is `null` when there is no client: the provider's
+ * configuration was refused, or there is no provider. `error` then says which.
+ * The hook never throws during render (WEB-038), so check `ready` (or the
+ * namespace) before you call it.
+ */
+export interface UseConsentEraReturn {
+    /** true when a client exists and the namespaces below are non-null. */
+    ready: boolean;
+    /** Unified consent namespace — sessions, validation, management, callbacks */
+    consent: ConsentEraClient['consent'] | null;
+    /** Consent session creation and artifact retrieval */
+    session: ConsentSession | null;
+    /** Consent validation (single + bulk) */
+    validate: ConsentValidator | null;
+    /** Consent update, withdrawal, and renewal */
+    manage: ConsentManager | null;
+    /** Callback handler for redirect flows */
+    callback: CallbackHandler | null;
+    /** DF configuration and notice purposes */
+    df: DFConfigClient | null;
+    /** Data principal rights and portal SSO */
+    principal: PrincipalClient | null;
+    /** Whether the SDK is still initializing */
+    loading: boolean;
+    /** Why there is no client, or the client's last error. */
+    error: Error | null;
+}
+/**
+ * Main hook for accessing all Consentera consent operations.
+ *
+ * @example
+ * ```tsx
+ * function LoanPage() {
+ *   const { consent, error } = useConsentEra();
+ *   if (!consent) return <p>Consent is unavailable: {error?.message}</p>;
+ *
+ *   const handleApply = async () => {
+ *     const check = await consent.validate(
+ *       { data_principal_identifiers: { email: 'user@example.com' } },
+ *       'credit_assessment'
+ *     );
+ *     if (check.decision === 'DENY') {
+ *       const s = await consent.createSession({
+ *         // keyed by THIS organisation's locked integration key — the SAME
+ *         // open map the validate call above passes, one vocabulary on both
+ *         // roads (F015). Only the wire KEY differs: `data_principal` here
+ *         // may mint a person, `data_principal_identifiers` only resolves.
+ *         data_principal: { email: 'user@example.com' },
+ *         notice_internal_name: 'loan_notice',
+ *       });
+ *       consent.redirectToConsent(s);
+ *     }
+ *   };
+ * }
+ * ```
+ */
+export declare function useConsentEra(): UseConsentEraReturn;

package/dist/types/react/useConsentValidation.d.ts

@@ -0,0 +1,23 @@
+import { ValidateResponse } from '../types/consent-lifecycle';
+import type { PrincipalRef } from '../utils/context';
+export interface UseConsentValidationReturn {
+    /** true = ALLOW. false = DENY. null = not yet known, or the check failed. */
+    allowed: boolean | null;
+    /** Full validation response from the API */
+    result: ValidateResponse | null;
+    /** Whether a validation is in progress */
+    loading: boolean;
+    /** Error if validation failed */
+    error: Error | null;
+    /** Re-run the validation check */
+    recheck: () => Promise<void>;
+}
+export interface UseConsentValidationOptions {
+    autoCheck?: boolean;
+    /**
+     * Re-check when the SDK reports a consent change for this person. Default
+     * true — this is what closes a gate on withdrawal without a remount.
+     */
+    watchChanges?: boolean;
+}
+export declare function useConsentValidation(who: PrincipalRef | undefined, purposeCode: string | undefined, options?: UseConsentValidationOptions): UseConsentValidationReturn;

package/dist/types/storage/ConsentStorage.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Consent Storage Module
+ * Handles persistence of consent data
+ */
+import { StorageConfig, ConsentData } from '../types';
+export declare class ConsentStorage {
+    private config;
+    private key;
+    constructor(config?: StorageConfig);
+    /**
+     * Save consent data
+     */
+    save(consent: ConsentData): boolean;
+    /**
+     * Get consent data
+     */
+    get(): ConsentData | null;
+    /**
+     * Check if consent exists
+     */
+    exists(): boolean;
+    /**
+     * Clear consent data
+     */
+    clear(): void;
+    /**
+     * Set cookie
+     */
+    /** @returns false when the value could not be stored (and says why). */
+    private setCookie;
+    /**
+     * Get cookie value
+     */
+    private getCookie;
+    /**
+     * Delete cookie
+     */
+    private deleteCookie;
+}

package/dist/types/tcf/TCFManager.d.ts

@@ -0,0 +1,46 @@
+/**
+ * TCF 2.2 Manager
+ * IAB Transparency & Consent Framework implementation
+ */
+import { TCFConfig, TCFData, ConsentPreferences } from '../types';
+export declare class TCFManager {
+    private config;
+    private tcfData;
+    constructor(config: TCFConfig);
+    /**
+     * Initialize TCF API
+     */
+    init(): Promise<void>;
+    /**
+     * Create __tcfapi stub
+     */
+    private createTCFApiStub;
+    /**
+     * Get default TCF data
+     */
+    private getDefaultTCFData;
+    /**
+     * Update consent in TCF format
+     */
+    updateConsent(preferences: ConsentPreferences): Promise<void>;
+    /**
+     * Generate TC String (simplified version)
+     */
+    private generateTCString;
+    /**
+     * Dispatch TCF event
+     */
+    private dispatchTCFEvent;
+    /**
+     * Get current TCF data
+     */
+    getTCFData(): TCFData | null;
+    /**
+     * Get TC String
+     */
+    getTCString(): string;
+    /**
+     * Destroy TCF manager
+     */
+    destroy(): void;
+}