@iqworksai/consentiq-react 0.1.5 → 0.1.6

package/dist/index.d.mts

@@ -1,3 +1,4 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
 import React$1 from 'react';
 
 /**
@@ -198,7 +199,7 @@ interface ConsentIQContextValue {
 interface ConsentIQProviderProps extends ConsentIQConfig {
     children: React$1.ReactNode;
 }
-declare function ConsentIQProvider({ children, propertyKey, apiUrl, subjectId: providedSubjectId, autoGenerateSubjectId, onConsentChange, onOpen, onClose, autoShow, language: preferredLanguage, locale, debug, }: ConsentIQProviderProps): React$1.JSX.Element;
+declare function ConsentIQProvider({ children, propertyKey, apiUrl, subjectId: providedSubjectId, autoGenerateSubjectId, onConsentChange, onOpen, onClose, autoShow, language: preferredLanguage, locale, debug, }: ConsentIQProviderProps): react_jsx_runtime.JSX.Element;
 /**
  * Hook to access ConsentIQ context
  */
@@ -225,7 +226,7 @@ interface CookieBannerProps {
     /** Custom styles */
     style?: React$1.CSSProperties;
 }
-declare function CookieBanner({ className, position, theme, style }: CookieBannerProps): React$1.JSX.Element | null;
+declare function CookieBanner({ className, position, theme, style }: CookieBannerProps): react_jsx_runtime.JSX.Element | null;
 
 interface ConsentTriggerProps {
     /** Custom class name for the trigger button */
@@ -247,7 +248,51 @@ interface ConsentTriggerProps {
  * by GDPR/DPDPA). Hidden while the banner or Preference Center is open, so it
  * only appears once a consent decision has been recorded.
  */
-declare function ConsentTrigger({ className, position, theme, style, label, }: ConsentTriggerProps): React$1.JSX.Element | null;
+declare function ConsentTrigger({ className, position, theme, style, label, }: ConsentTriggerProps): react_jsx_runtime.JSX.Element | null;
+
+interface ConsentPageTriggerProps {
+    /** ConsentIQ origin, e.g. https://consent.iqworks.ai */
+    apiUrl: string;
+    /** The consent page's public token */
+    token: string;
+    /** popup = open in a modal iframe (default); redirect = navigate to the hosted page */
+    mode?: 'popup' | 'redirect';
+    /** redirect mode only: an allowlisted return URL */
+    redirect?: string;
+    onComplete?: (result: {
+        consentId?: string;
+        proofHash?: string;
+        email?: string;
+    }) => void;
+    onClose?: () => void;
+    className?: string;
+    style?: React$1.CSSProperties;
+    children?: React$1.ReactNode;
+}
+/**
+ * Opens a property's hosted consent page as a modal iframe popup (or a redirect),
+ * and reports completion. Standalone — does not require the cookie ConsentIQProvider.
+ */
+declare function ConsentPageTrigger({ apiUrl, token, mode, redirect, onComplete, onClose, className, style, children, }: ConsentPageTriggerProps): react_jsx_runtime.JSX.Element;
+
+interface ConsentFormProps {
+    /** ConsentIQ origin, e.g. https://consent.iqworks.ai */
+    apiUrl: string;
+    /** The consent page's public token (binding must have embed enabled) */
+    token: string;
+    /** If the host already knows the person's email, pass it to skip the email field */
+    email?: string;
+    onRecorded?: (result: {
+        consentId: string;
+        proofHash: string;
+    }) => void;
+    className?: string;
+}
+/**
+ * Renders a consent page's purposes as inline checkboxes on the host's own form and records
+ * consent via the embed API. Drop in on the specific forms that need inline consent — Stage 2.
+ */
+declare function ConsentForm({ apiUrl, token, email: initialEmail, onRecorded, className }: ConsentFormProps): react_jsx_runtime.JSX.Element;
 
 interface LanguageSelectorProps {
     /** Custom class name */
@@ -259,7 +304,7 @@ interface LanguageSelectorProps {
  * Language switcher for the consent UI. Renders nothing when the property
  * supports a single language, so callers can drop it in unconditionally.
  */
-declare function LanguageSelector({ className, style }: LanguageSelectorProps): React$1.JSX.Element | null;
+declare function LanguageSelector({ className, style }: LanguageSelectorProps): react_jsx_runtime.JSX.Element | null;
 
 interface PreferenceCenterProps {
     /** Custom class name */
@@ -269,7 +314,7 @@ interface PreferenceCenterProps {
     /** Custom styles */
     style?: React$1.CSSProperties;
 }
-declare function PreferenceCenter({ className, theme, style }: PreferenceCenterProps): React$1.JSX.Element | null;
+declare function PreferenceCenter({ className, theme, style }: PreferenceCenterProps): react_jsx_runtime.JSX.Element | null;
 
 interface ConsentGateProps {
     /** The consent category required to show children */
@@ -298,7 +343,7 @@ interface ConsentGateProps {
  * </ConsentGate>
  * ```
  */
-declare function ConsentGate({ category, children, fallback, loading, }: ConsentGateProps): React$1.JSX.Element;
+declare function ConsentGate({ category, children, fallback, loading, }: ConsentGateProps): react_jsx_runtime.JSX.Element;
 /**
  * Higher-order component version of ConsentGate
  *
@@ -307,7 +352,7 @@ declare function ConsentGate({ category, children, fallback, loading, }: Consent
  * const ProtectedAnalytics = withConsentGate(GoogleAnalytics, 'analytics');
  * ```
  */
-declare function withConsentGate<P extends object>(Component: React$1.ComponentType<P>, category: ConsentCategory | string, FallbackComponent?: React$1.ComponentType<P>): (props: P) => React$1.JSX.Element | null;
+declare function withConsentGate<P extends object>(Component: React$1.ComponentType<P>, category: ConsentCategory | string, FallbackComponent?: React$1.ComponentType<P>): (props: P) => react_jsx_runtime.JSX.Element | null;
 
 declare const MarketingConsentForm: React$1.ForwardRefExoticComponent<FormConsentProps & React$1.RefAttributes<FormConsentRef>>;
 
@@ -338,6 +383,29 @@ interface UseFormConsentReturn {
 }
 declare function useFormConsent(options: UseFormConsentOptions): UseFormConsentReturn;
 
+interface ConsentPurpose {
+    purpose_id: string;
+    label: string | null;
+    description: string | null;
+    data_items: string[] | null;
+    is_required: boolean;
+}
+interface RecordedConsent {
+    success: boolean;
+    consentId: string;
+    proofHash: string;
+}
+/**
+ * Fetches a consent page's purposes (for the host to render its own checkboxes) and records
+ * consent inline via the embed API — Stage 2 of the integration journey.
+ */
+declare function useConsentPurposes(apiUrl: string, token: string): {
+    purposes: ConsentPurpose[];
+    loading: boolean;
+    error: string | null;
+    record: (email: string, purposeConsents: Record<string, boolean>) => Promise<RecordedConsent>;
+};
+
 /**
  * ConsentIQ API Client
  * Handles all communication with the ConsentIQ backend
@@ -405,4 +473,4 @@ declare function detectCountry(): string | undefined;
  */
 declare function detectLanguage(supportedLanguages: string[]): string;
 
-export { type BannerLayout, type BannerPosition, type BannerTheme, type CategoryInfo, type ConsentCategory, ConsentGate, type ConsentGateProps, ConsentIQApiClient, type ConsentIQConfig, type ConsentIQContextValue, ConsentIQProvider, type ConsentMethod, type ConsentState, ConsentTrigger, type ConsentTriggerProps, CookieBanner, type CookieBannerProps, type FormConsentProps, type FormConsentRef, type FormConsentSource, type GeoRule, LanguageSelector, type LanguageSelectorProps, type MarketingChannelInfo, MarketingConsentForm, type MarketingConsentState, PreferenceCenter, type PreferenceCenterProps, type PropertyConfig, type SavedConsent, type TranslationSet, detectCountry, detectLanguage, generateSubjectId, getOrCreateSubjectId, useConsent, useConsentGate, useConsentIQ, useFormConsent, withConsentGate };
+export { type BannerLayout, type BannerPosition, type BannerTheme, type CategoryInfo, type ConsentCategory, ConsentForm, type ConsentFormProps, ConsentGate, type ConsentGateProps, ConsentIQApiClient, type ConsentIQConfig, type ConsentIQContextValue, ConsentIQProvider, type ConsentMethod, ConsentPageTrigger, type ConsentPageTriggerProps, type ConsentPurpose, type ConsentState, ConsentTrigger, type ConsentTriggerProps, CookieBanner, type CookieBannerProps, type FormConsentProps, type FormConsentRef, type FormConsentSource, type GeoRule, LanguageSelector, type LanguageSelectorProps, type MarketingChannelInfo, MarketingConsentForm, type MarketingConsentState, PreferenceCenter, type PreferenceCenterProps, type PropertyConfig, type RecordedConsent, type SavedConsent, type TranslationSet, detectCountry, detectLanguage, generateSubjectId, getOrCreateSubjectId, useConsent, useConsentGate, useConsentIQ, useConsentPurposes, useFormConsent, withConsentGate };

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
 import React$1 from 'react';
 
 /**
@@ -198,7 +199,7 @@ interface ConsentIQContextValue {
 interface ConsentIQProviderProps extends ConsentIQConfig {
     children: React$1.ReactNode;
 }
-declare function ConsentIQProvider({ children, propertyKey, apiUrl, subjectId: providedSubjectId, autoGenerateSubjectId, onConsentChange, onOpen, onClose, autoShow, language: preferredLanguage, locale, debug, }: ConsentIQProviderProps): React$1.JSX.Element;
+declare function ConsentIQProvider({ children, propertyKey, apiUrl, subjectId: providedSubjectId, autoGenerateSubjectId, onConsentChange, onOpen, onClose, autoShow, language: preferredLanguage, locale, debug, }: ConsentIQProviderProps): react_jsx_runtime.JSX.Element;
 /**
  * Hook to access ConsentIQ context
  */
@@ -225,7 +226,7 @@ interface CookieBannerProps {
     /** Custom styles */
     style?: React$1.CSSProperties;
 }
-declare function CookieBanner({ className, position, theme, style }: CookieBannerProps): React$1.JSX.Element | null;
+declare function CookieBanner({ className, position, theme, style }: CookieBannerProps): react_jsx_runtime.JSX.Element | null;
 
 interface ConsentTriggerProps {
     /** Custom class name for the trigger button */
@@ -247,7 +248,51 @@ interface ConsentTriggerProps {
  * by GDPR/DPDPA). Hidden while the banner or Preference Center is open, so it
  * only appears once a consent decision has been recorded.
  */
-declare function ConsentTrigger({ className, position, theme, style, label, }: ConsentTriggerProps): React$1.JSX.Element | null;
+declare function ConsentTrigger({ className, position, theme, style, label, }: ConsentTriggerProps): react_jsx_runtime.JSX.Element | null;
+
+interface ConsentPageTriggerProps {
+    /** ConsentIQ origin, e.g. https://consent.iqworks.ai */
+    apiUrl: string;
+    /** The consent page's public token */
+    token: string;
+    /** popup = open in a modal iframe (default); redirect = navigate to the hosted page */
+    mode?: 'popup' | 'redirect';
+    /** redirect mode only: an allowlisted return URL */
+    redirect?: string;
+    onComplete?: (result: {
+        consentId?: string;
+        proofHash?: string;
+        email?: string;
+    }) => void;
+    onClose?: () => void;
+    className?: string;
+    style?: React$1.CSSProperties;
+    children?: React$1.ReactNode;
+}
+/**
+ * Opens a property's hosted consent page as a modal iframe popup (or a redirect),
+ * and reports completion. Standalone — does not require the cookie ConsentIQProvider.
+ */
+declare function ConsentPageTrigger({ apiUrl, token, mode, redirect, onComplete, onClose, className, style, children, }: ConsentPageTriggerProps): react_jsx_runtime.JSX.Element;
+
+interface ConsentFormProps {
+    /** ConsentIQ origin, e.g. https://consent.iqworks.ai */
+    apiUrl: string;
+    /** The consent page's public token (binding must have embed enabled) */
+    token: string;
+    /** If the host already knows the person's email, pass it to skip the email field */
+    email?: string;
+    onRecorded?: (result: {
+        consentId: string;
+        proofHash: string;
+    }) => void;
+    className?: string;
+}
+/**
+ * Renders a consent page's purposes as inline checkboxes on the host's own form and records
+ * consent via the embed API. Drop in on the specific forms that need inline consent — Stage 2.
+ */
+declare function ConsentForm({ apiUrl, token, email: initialEmail, onRecorded, className }: ConsentFormProps): react_jsx_runtime.JSX.Element;
 
 interface LanguageSelectorProps {
     /** Custom class name */
@@ -259,7 +304,7 @@ interface LanguageSelectorProps {
  * Language switcher for the consent UI. Renders nothing when the property
  * supports a single language, so callers can drop it in unconditionally.
  */
-declare function LanguageSelector({ className, style }: LanguageSelectorProps): React$1.JSX.Element | null;
+declare function LanguageSelector({ className, style }: LanguageSelectorProps): react_jsx_runtime.JSX.Element | null;
 
 interface PreferenceCenterProps {
     /** Custom class name */
@@ -269,7 +314,7 @@ interface PreferenceCenterProps {
     /** Custom styles */
     style?: React$1.CSSProperties;
 }
-declare function PreferenceCenter({ className, theme, style }: PreferenceCenterProps): React$1.JSX.Element | null;
+declare function PreferenceCenter({ className, theme, style }: PreferenceCenterProps): react_jsx_runtime.JSX.Element | null;
 
 interface ConsentGateProps {
     /** The consent category required to show children */
@@ -298,7 +343,7 @@ interface ConsentGateProps {
  * </ConsentGate>
  * ```
  */
-declare function ConsentGate({ category, children, fallback, loading, }: ConsentGateProps): React$1.JSX.Element;
+declare function ConsentGate({ category, children, fallback, loading, }: ConsentGateProps): react_jsx_runtime.JSX.Element;
 /**
  * Higher-order component version of ConsentGate
  *
@@ -307,7 +352,7 @@ declare function ConsentGate({ category, children, fallback, loading, }: Consent
  * const ProtectedAnalytics = withConsentGate(GoogleAnalytics, 'analytics');
  * ```
  */
-declare function withConsentGate<P extends object>(Component: React$1.ComponentType<P>, category: ConsentCategory | string, FallbackComponent?: React$1.ComponentType<P>): (props: P) => React$1.JSX.Element | null;
+declare function withConsentGate<P extends object>(Component: React$1.ComponentType<P>, category: ConsentCategory | string, FallbackComponent?: React$1.ComponentType<P>): (props: P) => react_jsx_runtime.JSX.Element | null;
 
 declare const MarketingConsentForm: React$1.ForwardRefExoticComponent<FormConsentProps & React$1.RefAttributes<FormConsentRef>>;
 
@@ -338,6 +383,29 @@ interface UseFormConsentReturn {
 }
 declare function useFormConsent(options: UseFormConsentOptions): UseFormConsentReturn;
 
+interface ConsentPurpose {
+    purpose_id: string;
+    label: string | null;
+    description: string | null;
+    data_items: string[] | null;
+    is_required: boolean;
+}
+interface RecordedConsent {
+    success: boolean;
+    consentId: string;
+    proofHash: string;
+}
+/**
+ * Fetches a consent page's purposes (for the host to render its own checkboxes) and records
+ * consent inline via the embed API — Stage 2 of the integration journey.
+ */
+declare function useConsentPurposes(apiUrl: string, token: string): {
+    purposes: ConsentPurpose[];
+    loading: boolean;
+    error: string | null;
+    record: (email: string, purposeConsents: Record<string, boolean>) => Promise<RecordedConsent>;
+};
+
 /**
  * ConsentIQ API Client
  * Handles all communication with the ConsentIQ backend
@@ -405,4 +473,4 @@ declare function detectCountry(): string | undefined;
  */
 declare function detectLanguage(supportedLanguages: string[]): string;
 
-export { type BannerLayout, type BannerPosition, type BannerTheme, type CategoryInfo, type ConsentCategory, ConsentGate, type ConsentGateProps, ConsentIQApiClient, type ConsentIQConfig, type ConsentIQContextValue, ConsentIQProvider, type ConsentMethod, type ConsentState, ConsentTrigger, type ConsentTriggerProps, CookieBanner, type CookieBannerProps, type FormConsentProps, type FormConsentRef, type FormConsentSource, type GeoRule, LanguageSelector, type LanguageSelectorProps, type MarketingChannelInfo, MarketingConsentForm, type MarketingConsentState, PreferenceCenter, type PreferenceCenterProps, type PropertyConfig, type SavedConsent, type TranslationSet, detectCountry, detectLanguage, generateSubjectId, getOrCreateSubjectId, useConsent, useConsentGate, useConsentIQ, useFormConsent, withConsentGate };
+export { type BannerLayout, type BannerPosition, type BannerTheme, type CategoryInfo, type ConsentCategory, ConsentForm, type ConsentFormProps, ConsentGate, type ConsentGateProps, ConsentIQApiClient, type ConsentIQConfig, type ConsentIQContextValue, ConsentIQProvider, type ConsentMethod, ConsentPageTrigger, type ConsentPageTriggerProps, type ConsentPurpose, type ConsentState, ConsentTrigger, type ConsentTriggerProps, CookieBanner, type CookieBannerProps, type FormConsentProps, type FormConsentRef, type FormConsentSource, type GeoRule, LanguageSelector, type LanguageSelectorProps, type MarketingChannelInfo, MarketingConsentForm, type MarketingConsentState, PreferenceCenter, type PreferenceCenterProps, type PropertyConfig, type RecordedConsent, type SavedConsent, type TranslationSet, detectCountry, detectLanguage, generateSubjectId, getOrCreateSubjectId, useConsent, useConsentGate, useConsentIQ, useConsentPurposes, useFormConsent, withConsentGate };