@methodfi/opal-react 0.0.1 → 0.0.2

package/dist/types/index.d.ts

@@ -1,145 +0,0 @@
-export type OpalEnvironment = 'local' | 'dev' | 'sandbox' | 'production';
-export type OpalMode = 'opal' | 'card_connect' | 'account_verification' | string;
-export type OpalEventObject = 'session' | 'card' | 'account' | 'bank' | string;
-export type OpalEventAction = 'started' | 'errored' | 'exited' | 'verified' | 'completed' | string;
-export type OpalEventType = 'opal.session.started' | 'opal.session.errored' | 'opal.session.exited' | 'card_connect.session.started' | 'card_connect.session.errored' | 'card_connect.card.verified' | 'account_verification.session.started' | 'account_verification.session.errored' | 'account_verification.account.verified' | string;
-/**
- * Structured event object matching Method's Opal event format
- * Events follow the pattern: <mode>.<object>.<action>
- */
-export interface OpalEvent {
-    /** The type of event, formatted as <mode>.<object>.<action> */
-    type: OpalEventType;
-    /** The operational mode associated with the event (e.g., 'card_connect') */
-    mode: OpalMode;
-    /** The object the event is related to (e.g., 'card', 'session') */
-    object: OpalEventObject;
-    /** The action that occurred (e.g., 'started', 'verified', 'errored') */
-    action: OpalEventAction;
-    /** The ISO 8601 timestamp of when the event occurred */
-    timestamp: string;
-    /** Additional context or details related to the event (varies by event type) */
-    data?: OpalEventData | null;
-}
-/**
- * Error data structure for Opal session errors
- */
-export interface OpalErrorData {
-    /** Error type identifier */
-    type: string;
-    /** Error sub-type for more specific categorization */
-    sub_type?: string;
-    /** Human-readable error message */
-    message: string;
-}
-/**
- * Card verification event data
- */
-export interface CardVerifiedEventData {
-    /** The account ID of the verified card */
-    account: string;
-    /** Additional metadata about the card verification */
-    metadata?: Record<string, any>;
-}
-/**
- * Account verification event data
- */
-export interface AccountVerifiedEventData {
-    /** The account ID of the verified account */
-    account: string;
-    /** Account verification details */
-    account_verification?: {
-        account_id: string;
-        type: string;
-        [key: string]: any;
-    };
-    /** Additional metadata */
-    metadata?: Record<string, any>;
-}
-/**
- * Union type for all possible event data structures
- */
-export type OpalEventData = OpalErrorData | CardVerifiedEventData | AccountVerifiedEventData | Record<string, any>;
-/**
- * Legacy error interface for backward compatibility
- */
-export interface OpalError {
-    code: string;
-    message: string;
-    type: 'api_error' | 'connection_error' | 'validation_error';
-}
-/**
- * Configuration object for the useOpal hook
- */
-export interface OpalConfig {
-    /** Environment to connect to (default: 'production') */
-    env?: OpalEnvironment;
-    /** Called when Opal opens */
-    onOpen?: () => void;
-    /** Called when Opal closes */
-    onExit?: (data?: any) => void;
-    /** Called for all Opal events with properly typed event object */
-    onEvent?: (event: OpalEvent) => void;
-    /** Called when an error occurs */
-    onError?: (error: OpalErrorData) => void;
-    /** Called on successful completion */
-    onSuccess?: (data: OpalSuccessData) => void;
-}
-/**
- * Success data structure for completed Opal sessions
- */
-export interface OpalSuccessData {
-    /** The session ID of the completed session */
-    sessionId: string;
-    /** Additional metadata from the session */
-    metadata?: Record<string, any>;
-}
-/**
- * Options for opening an Opal session
- */
-export interface OpalOpenOptions {
-    /** The Opal token (otkn_*) obtained from POST /opal/token */
-    token: string;
-}
-/**
- * Legacy message interface - use OpalEvent instead
- * @deprecated Use OpalEvent for better type safety
- */
-export interface OpalMessage {
-    type: string;
-    mode: string;
-    object: string;
-    action: string;
-    timestamp: string;
-}
-/**
- * Return type for the useOpal hook
- */
-export interface UseOpalReturn {
-    /** Opens Opal with the provided token and options */
-    open: (options: OpalOpenOptions) => void;
-    /** Closes the current Opal session */
-    close: () => void;
-    /** Whether Opal is loaded and ready for interaction */
-    isReady: boolean;
-    /** Whether Opal is currently open */
-    isOpen: boolean;
-    /** Current error state, if any */
-    error: OpalError | OpalErrorData | null;
-}
-/**
- * Props for the OpalIframe component
- */
-export interface OpalIframeProps {
-    /** The Opal token */
-    token: string;
-    /** The full Opal URL with token */
-    opalUrl: string;
-    /** Callback for handling iframe messages */
-    onMessage: (message: OpalEvent) => void;
-    /** Callback for when the iframe should be closed */
-    onClose: () => void;
-    /** Optional styles for the iframe container */
-    style?: React.CSSProperties;
-}
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,KAAK,GAAG,SAAS,GAAG,YAAY,CAAC;AAGzE,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,cAAc,GAAG,sBAAsB,GAAG,MAAM,CAAC;AAGjF,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;AAG/E,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,WAAW,GAAG,MAAM,CAAC;AAGnG,MAAM,MAAM,aAAa,GACrB,sBAAsB,GACtB,sBAAsB,GACtB,qBAAqB,GACrB,8BAA8B,GAC9B,8BAA8B,GAC9B,4BAA4B,GAC5B,sCAAsC,GACtC,sCAAsC,GACtC,uCAAuC,GACvC,MAAM,CAAC;AAEX;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,+DAA+D;IAC/D,IAAI,EAAE,aAAa,CAAC;IACpB,4EAA4E;IAC5E,IAAI,EAAE,QAAQ,CAAC;IACf,mEAAmE;IACnE,MAAM,EAAE,eAAe,CAAC;IACxB,wEAAwE;IACxE,MAAM,EAAE,eAAe,CAAC;IACxB,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAC;IAClB,gFAAgF;IAChF,IAAI,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,sDAAsD;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mCAAmC;IACnC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,0CAA0C;IAC1C,OAAO,EAAE,MAAM,CAAC;IAChB,sDAAsD;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,oBAAoB,CAAC,EAAE;QACrB,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,EAAE,MAAM,CAAC;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;IACF,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,aAAa,GACb,qBAAqB,GACrB,wBAAwB,GACxB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAExB;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,WAAW,GAAG,kBAAkB,GAAG,kBAAkB,CAAC;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,wDAAwD;IACxD,GAAG,CAAC,EAAE,eAAe,CAAC;IACtB,6BAA6B;IAC7B,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;IACpB,8BAA8B;IAC9B,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;IAC9B,kEAAkE;IAClE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;IACrC,kCAAkC;IAClC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAC;IACzC,sCAAsC;IACtC,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,8CAA8C;IAC9C,SAAS,EAAE,MAAM,CAAC;IAClB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,6DAA6D;IAC7D,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,qDAAqD;IACrD,IAAI,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,CAAC;IACzC,sCAAsC;IACtC,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,uDAAuD;IACvD,OAAO,EAAE,OAAO,CAAC;IACjB,qCAAqC;IACrC,MAAM,EAAE,OAAO,CAAC;IAChB,kCAAkC;IAClC,KAAK,EAAE,SAAS,GAAG,aAAa,GAAG,IAAI,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,qBAAqB;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,4CAA4C;IAC5C,SAAS,EAAE,CAAC,OAAO,EAAE,SAAS,KAAK,IAAI,CAAC;IACxC,oDAAoD;IACpD,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,+CAA+C;IAC/C,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;CAC7B"}