@snapkyc-ooru/consent-handoff-react 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,225 @@
+import { CSSProperties } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+declare class SnapSdkHttpError extends Error {
+    readonly url: string;
+    readonly status: number;
+    readonly bodyText?: string | undefined;
+    readonly name = "SnapSdkHttpError";
+    constructor(url: string, status: number, message: string, bodyText?: string | undefined);
+}
+
+type IntentOs = "android" | "ios";
+
+type DemographicData = {
+    resident_name?: string;
+    resident_name_local_language?: string;
+    date_of_birth?: string;
+    gender?: string;
+    care_of?: string;
+    full_address?: string;
+    regional_address?: string;
+    mobile_number?: string;
+    masked_mobile_number?: string;
+    email_address?: string;
+    masked_email_address?: string;
+    state?: string;
+    district?: string;
+    sub_district?: string;
+    village_town_city?: string;
+    postal_code?: string;
+    resident_image?: string;
+    [key: string]: unknown;
+};
+type TxnStatusEvidence = {
+    aadhaar_uuid?: string;
+    sd_jwt?: string;
+    disclosures?: unknown[];
+    demographic_data?: DemographicData;
+    [key: string]: unknown;
+};
+type TxnStatusData = {
+    txn_id: string;
+    status: string;
+    created_at?: string;
+    purposes?: {
+        id: string;
+        name: string;
+    }[];
+    evidence?: TxnStatusEvidence;
+};
+type TxnStatusResponse = TxnStatusData & {
+    /** passthrough unknown fields returned with SUCCESS payloads */
+    [key: string]: unknown;
+};
+/** Optional overrides for `POST /api/integrations/generate-qr` (txn_id is set by the SDK). */
+type QrRequestOverrides = {
+    size?: number;
+};
+
+/**
+ * Resolved visual tokens for the consent handoff UI.
+ * Pass a partial object via `theme` on `SnapConsentHandoffFlow` to override defaults.
+ */
+type SnapConsentHandoffTheme = {
+    fontFamily: string;
+    /** Primary brand color (buttons, selected states, accents). */
+    primary: string;
+    /** Text/icon color on top of primary (typically white). */
+    onPrimary: string;
+    /** Sheet / panel background (e.g. warm light gray). */
+    canvas: string;
+    /** Default “card” surface (e.g. unselected purpose rows). */
+    surface: string;
+    /** Muted surface (agreement notice, selected purpose row). */
+    surfaceMuted: string;
+    text: string;
+    textMuted: string;
+    border: string;
+    /** Strong border for selected / emphasized controls. */
+    borderActive: string;
+    modalOverlay: string;
+    danger: string;
+    /** Corner radius for cards, rows, and buttons (e.g. `12px`). */
+    radius: string;
+    gap: string;
+    maxWidth: string;
+    modalZ: string;
+    /** Success state (shield, status checkmarks). */
+    success: string;
+    /** Success screen status summary card background. */
+    successStatusSurface: string;
+    /** Success screen confirmed-purposes panel background. */
+    successPurposesSurface: string;
+    /** Accordion borders on the success demographic panel. */
+    successAccordionBorder: string;
+};
+declare const DEFAULT_SNAP_CONSENT_THEME: SnapConsentHandoffTheme;
+declare function resolveSnapConsentTheme(partial?: Partial<SnapConsentHandoffTheme>): SnapConsentHandoffTheme;
+/**
+ * Maps resolved theme tokens to CSS custom properties on `.snap-consent-handoff`.
+ */
+declare function themeToCssProperties(theme: SnapConsentHandoffTheme): CSSProperties;
+
+type HandoffMode = "qr" | "intent";
+type IntentDetectionMeta = {
+    kind: "resolved";
+    platform: IntentOs;
+} | {
+    kind: "ambiguous-choice";
+    chosen?: IntentOs;
+} | {
+    kind: "forced";
+    platform: IntentOs;
+};
+type FlowPhase = "agreement-loading" | "agreement-ready" | "txn-initiating" | "txn-created" | "handoff-loading" | "handoff-ready" | "polling" | "completed" | "failed" | "cancelled";
+type FlowEvent = {
+    phase: Exclude<FlowPhase, "failed">;
+    txnId?: string;
+    meta?: IntentDetectionMeta;
+    error?: never;
+} | {
+    phase: "failed";
+    txnId?: string;
+    meta?: IntentDetectionMeta;
+    error: unknown;
+};
+type CompletionResult = {
+    txn_id?: string;
+    status: unknown;
+    raw: TxnStatusResponse;
+};
+type RpContext = {
+    reference_id: string;
+    session_id?: string;
+};
+type SnapConsentHandoffPublicProps = {
+    integrationToken: string;
+    rpContext: RpContext;
+    agreementId?: string;
+    acceptLanguage?: string;
+    handoffMode: HandoffMode;
+    qrRequestBody?: QrRequestOverrides;
+    pollIntervalMs?: number;
+    pollDeadlineMs?: number;
+    intentPlatformOverride?: IntentOs | undefined;
+    /** @deprecated prefer `_dangerouslyForceIntentPlatform` */
+    dangerousForceIntentPlatform?: IntentOs;
+    /** QA escape hatch ONLY — not suggested for production RP integrations */
+    _dangerouslyForceIntentPlatform?: IntentOs;
+    /** Optional UA override for SSR/tests */
+    userAgent?: string;
+    onFlowEvent?: (evt: FlowEvent) => void;
+    onSuccess?: (result: CompletionResult) => void;
+    onError?: (err: unknown) => void;
+    onRequestClose?: () => void;
+    displayMode?: "modal" | "inline";
+    title?: string;
+    /** Optional palette and layout tokens; merged with built-in defaults. */
+    theme?: Partial<SnapConsentHandoffTheme>;
+};
+
+type DemographicField = {
+    /** Original API field name (snake_case). */
+    key: string;
+    label: string;
+    value: string;
+};
+type DemographicAccordionSection = {
+    id: string;
+    title: string;
+    fields: DemographicField[];
+    /** When true, render resident photo in this section (Personal Details only). */
+    includePhoto: boolean;
+};
+declare function extractDemographicData(status: TxnStatusResponse | null | undefined): DemographicData | null;
+declare function hasDisplayableDemographics(status: TxnStatusResponse | null | undefined): boolean;
+declare function formatDisplayValue(value: unknown): string;
+/** All demographic_data fields; empty / object values render as `null`. */
+declare function demographicFieldsForDisplay(data: DemographicData): DemographicField[];
+/**
+ * Groups demographic fields into accordion sections (Personal, Contact, Address, Additional).
+ * Personal Details may include a photo slot when `includePhoto` is true.
+ */
+declare function demographicAccordionSections(data: DemographicData, options: {
+    includePhoto: boolean;
+}): DemographicAccordionSection[];
+declare function formatPurposeLabel(name: unknown): string;
+
+declare function parseDemographicPayload(raw: unknown): DemographicData | null;
+/**
+ * Normalizes status payloads from GET …/transactions/{id}/status into a stable shape
+ * for UI + onSuccess, even if the host accidentally passes the full API envelope.
+ */
+declare function normalizeTxnStatusPayload(input: unknown): TxnStatusResponse;
+
+declare function SnapConsentHandoffFlow(props: SnapConsentHandoffPublicProps): react_jsx_runtime.JSX.Element | null;
+
+type OpenSnapConsentHandoffOptions = Omit<SnapConsentHandoffPublicProps, "displayMode" | "onRequestClose"> & Partial<Pick<SnapConsentHandoffPublicProps, "displayMode">> & {
+    /**
+     * Render in StrictMode — mostly useful during development.
+     * Default false to avoid duplicated effects/timeouts surprises in overlays.
+     */
+    strict?: boolean;
+};
+/**
+ * Opens a modal consent + handoff flow mounted on `document.body`.
+ *
+ * Important: callers should keep the returned `{ dispose }` and invoke it when navigating away so
+ * polling aborts cleanly and blob/object URLs revoke via component unmount.
+ */
+declare function openSnapConsentHandoffFlow(options: OpenSnapConsentHandoffOptions): {
+    dispose(): void;
+};
+/**
+ * Deprecated alias kept for docs that referenced a QR-specific opener name.
+ */
+declare const openSnapConsentQrFlow: typeof openSnapConsentHandoffFlow;
+
+/**
+ * API origin bundled with the SDK. Replace at publish-time (staging/prod) via your build pipeline
+ * or bump this constant per release artefact — hosts cannot override `baseUrl` at runtime.
+ */
+declare const API_ORIGIN = "https://staging-api.snapkyc.com/";
+
+export { API_ORIGIN, type CompletionResult, DEFAULT_SNAP_CONSENT_THEME, type DemographicAccordionSection, type DemographicData, type DemographicField, type FlowEvent, type FlowPhase, type HandoffMode, type OpenSnapConsentHandoffOptions, type RpContext, SnapConsentHandoffFlow, type SnapConsentHandoffPublicProps, type SnapConsentHandoffTheme, SnapSdkHttpError, type TxnStatusEvidence, type TxnStatusResponse, demographicAccordionSections, demographicFieldsForDisplay, extractDemographicData, formatDisplayValue, formatPurposeLabel, hasDisplayableDemographics, normalizeTxnStatusPayload, openSnapConsentHandoffFlow, openSnapConsentQrFlow, parseDemographicPayload, resolveSnapConsentTheme, themeToCssProperties };