@incodetech/core 2.0.0-rc.0 → 2.0.0

package/dist/phoneManager-B6M30hKE.d.ts

@@ -1,397 +0,0 @@
-import { t as Manager } from "./Manager-C8PrhBOx.js";
-import { t as ActorRefFrom } from "./Actor-CI32dTbG.js";
-
-//#region src/modules/phone/types.d.ts
-
-/**
- * Configuration options for phone verification.
- *
- * @example Standard OTP verification
- * ```typescript
- * const config: PhoneConfig = {
- *   otpVerification: true,
- *   otpExpirationInMinutes: 5,
- *   prefill: false,
- * };
- * ```
- *
- * @example With all options
- * ```typescript
- * const config: PhoneConfig = {
- *   otpVerification: true,
- *   otpExpirationInMinutes: 10,
- *   prefill: true,
- *   isInstantVerify: false,
- *   optinEnabled: true,
- *   maxOtpAttempts: 3,
- * };
- * ```
- */
-type PhoneConfig = {
-  /**
-   * Whether to require OTP (SMS code) verification.
-   * If false, phone is verified immediately after submission.
-   */
-  otpVerification: boolean;
-  /**
-   * How long the OTP code remains valid, in minutes.
-   * After expiration, user must request a new code.
-   */
-  otpExpirationInMinutes: number;
-  /**
-   * Whether to pre-populate with user's previously stored phone number.
-   * Useful for returning users.
-   */
-  prefill: boolean;
-  /**
-   * Use carrier-based instant verification instead of OTP.
-   * Not available in all regions.
-   * @default false
-   */
-  isInstantVerify?: boolean;
-  /**
-   * Show a marketing opt-in checkbox in the UI.
-   * User's preference is sent with the phone submission.
-   * @default false
-   */
-  optinEnabled?: boolean;
-  /**
-   * Maximum number of OTP verification attempts before lockout.
-   * After exhausting attempts, user sees an error state.
-   * @default 3
-   */
-  maxOtpAttempts?: number;
-};
-//#endregion
-//#region src/modules/phone/phoneStateMachine.d.ts
-
-declare const phoneMachine: any;
-type PhoneMachine = typeof phoneMachine;
-//#endregion
-//#region src/modules/phone/phoneActor.d.ts
-type CreatePhoneActorOptions = {
-  config: PhoneConfig;
-};
-type PhoneActor = ActorRefFrom<PhoneMachine>;
-//#endregion
-//#region src/modules/phone/phoneManager.d.ts
-/** Phone manager is in initial state, waiting for `load()` to be called */
-type PhoneIdleState = {
-  status: 'idle';
-};
-/** Loading prefilled phone number from backend (if prefill is enabled) */
-type PhoneLoadingPrefillState = {
-  status: 'loadingPrefill';
-};
-/**
- * Fetching start info (`ipIsoCode`, `phonePrefix`) before the phone field is interactive.
- */
-type PhoneLoadingStartInfoState = {
-  status: 'loadingStartInfo';
-  prefilledPhone?: string;
-  otpVerification?: boolean;
-  optinEnabled?: boolean;
-};
-/**
- * Ready for phone input - use `setPhoneNumber()` and `submit()`
- * @property countryCode - ISO country code (e.g., 'US', 'MX')
- * @property phonePrefix - International dialing prefix (e.g., '+1', '+52')
- * @property prefilledPhone - Pre-populated phone number (if prefill enabled)
- * @property phoneError - Submission error message if the backend rejected the phone number
- * @property otpVerification - Whether OTP SMS verification is enabled (from module config). When omitted, treat as `false`.
- * @property optinEnabled - Whether marketing opt-in checkbox is shown (from module config). When omitted, treat as `false`.
- */
-type PhoneInputtingState = {
-  status: 'inputting';
-  countryCode: string;
-  phonePrefix: string;
-  prefilledPhone?: string;
-  phoneError?: string;
-  otpVerification?: boolean;
-  optinEnabled?: boolean;
-};
-/** Phone number is being submitted to the backend */
-type PhoneSubmittingState = {
-  status: 'submitting';
-};
-/** OTP is being sent to the phone number on resend */
-type PhoneResendingOtpState = {
-  status: 'resendingOtp';
-};
-/** OTP is being initialy sent to the phone number */
-type PhoneSendingInitialOtp = {
-  status: 'sendingInitialOtp';
-};
-/**
- * Waiting for OTP code - use `submitOtp()`, `resendOtp()`, or `back()`
- * @property resendTimer - Seconds remaining before resend is allowed
- * @property canResend - Whether the resend button should be enabled
- * @property attemptsRemaining - Number of OTP verification attempts left
- */
-type PhoneAwaitingOtpState = {
-  status: 'awaitingOtp';
-  resendTimer: number;
-  canResend: boolean;
-  attemptsRemaining: number;
-};
-/**
- * OTP code is being verified against the backend
- * @property resendTimer - Seconds remaining on resend cooldown (unchanged while verifying)
- * @property canResend - Whether resend is allowed (cooldown finished)
- */
-type PhoneVerifyingOtpState = {
-  status: 'verifyingOtp';
-  resendTimer: number;
-  canResend: boolean;
-};
-/**
- * OTP verification failed - user can retry with `submitOtp()`
- * @property error - Error message describing why verification failed
- * @property attemptsRemaining - Number of remaining attempts before lockout
- * @property resendTimer - Seconds remaining on resend cooldown (same as awaiting OTP)
- * @property canResend - Whether resend is allowed (cooldown finished)
- */
-type PhoneOtpErrorState = {
-  status: 'otpError';
-  otpError: string;
-  attemptsRemaining: number;
-  resendTimer: number;
-  canResend: boolean;
-};
-/** Phone verification completed successfully */
-type PhoneFinishedState = {
-  status: 'finished';
-};
-/**
- * Fatal error occurred - call `reset()` to start over
- * @property error - Error message describing what went wrong
- */
-type PhoneErrorState = {
-  status: 'error';
-  error: string;
-};
-/**
- * Union of all possible phone manager states.
- * Use discriminated union pattern to narrow the type:
- *
- * @example
- * ```typescript
- * const state = phoneManager.getState();
- * if (state.status === 'inputting') {
- *   // TypeScript knows state has countryCode, phonePrefix, etc.
- *   console.log(state.countryCode);
- * }
- * ```
- */
-type PhoneState = PhoneIdleState | PhoneLoadingPrefillState | PhoneLoadingStartInfoState | PhoneInputtingState | PhoneSubmittingState | PhoneResendingOtpState | PhoneSendingInitialOtp | PhoneAwaitingOtpState | PhoneVerifyingOtpState | PhoneOtpErrorState | PhoneFinishedState | PhoneErrorState;
-/**
- * Creates a phone verification manager for headless or UI-driven usage.
- *
- * The manager provides a state machine-based API for phone number verification
- * with optional OTP (one-time password) verification.
- *
- * @param options - Configuration options
- * @param options.config - Phone verification configuration
- * @param options.config.otpVerification - Whether to require OTP verification
- * @param options.config.otpExpirationInMinutes - How long the OTP is valid
- * @param options.config.prefill - Whether to fetch a pre-filled phone number
- * @param options.config.isInstantVerify - Use instant verification API
- * @param options.config.optinEnabled - Show marketing opt-in checkbox
- * @param options.config.maxOtpAttempts - Maximum OTP verification attempts (default: 3)
- *
- * @returns Phone manager with state, API methods, and subscription
- *
- * @example Headless usage
- * ```typescript
- * const manager = createPhoneManager({
- *   config: { otpVerification: true, otpExpirationInMinutes: 5, prefill: false },
- * });
- *
- * manager.subscribe((state) => console.log(state.status));
- * manager.load();
- * manager.setPhoneNumber('+14155551234', true);
- * manager.submit();
- * // ... wait for 'awaitingOtp' state ...
- * manager.submitOtp('ABC123');
- * manager.stop();
- * ```
- *
- * @example With React/Preact UI hook
- * ```tsx
- * const [state, manager] = useManager(() => createPhoneManager({ config }));
- *
- * if (state.status === 'inputting') {
- *   return <input onChange={(e) => manager.setPhoneNumber(e.target.value, true)} />;
- * }
- * ```
- */
-declare function createPhoneManager(options: CreatePhoneActorOptions): Manager<PhoneState> & {
-  /**
-   * Initializes the phone verification flow.
-   * Transitions from 'idle' to 'loadingPrefill' or 'inputting'.
-   * Must be called before any other method.
-   */
-  load(): void;
-  /**
-   * Sets the phone number for verification.
-   * Should be called when state is 'inputting'.
-   *
-   * @param phone - Full phone number with country code (e.g., '+14155551234')
-   * @param isValid - Whether the phone number passes validation
-   *
-   * @example
-   * ```typescript
-   * // Using libphonenumber-js for validation
-   * import { isValidPhoneNumber } from 'libphonenumber-js';
-   * const phone = '+14155551234';
-   * phoneManager.setPhoneNumber(phone, isValidPhoneNumber(phone));
-   * ```
-   */
-  setPhoneNumber(phone: string, isValid: boolean): void;
-  /**
-   * Sets the marketing opt-in preference.
-   * Only relevant if `config.optinEnabled` is true.
-   *
-   * @param granted - Whether the user consented to receive marketing messages
-   */
-  setOptInGranted(granted: boolean): void;
-  /**
-   * Submits the phone number for verification.
-   * Requires a valid phone number to be set via `setPhoneNumber()`.
-   * Transitions to 'submitting', then to 'sendingOtp' or 'success' (if no OTP).
-   */
-  submit(): void;
-  /**
-   * Sets the OTP code without submitting.
-   * Use this for controlled input components.
-   *
-   * @param code - The OTP code entered by the user
-   */
-  setOtpCode(code: string): void;
-  /**
-   * Sets and submits the OTP code in one call.
-   * Should be called when state is 'awaitingOtp' or 'otpError'.
-   *
-   * @param code - The complete OTP code (typically 6 alphanumeric characters)
-   *
-   * @example
-   * ```typescript
-   * // Submit OTP when user completes entry
-   * phoneManager.submitOtp('HH36LP');
-   * ```
-   */
-  submitOtp(code: string): void;
-  /**
-   * Requests a new OTP code to be sent.
-   * Only works when state is 'awaitingOtp' and `canResend` is true.
-   * Resets the resend timer.
-   */
-  resendOtp(): void;
-  /**
-   * Returns to the phone input screen from OTP entry.
-   * Allows the user to change their phone number.
-   * Transitions from 'awaitingOtp' or 'otpError' back to 'inputting'.
-   */
-  back(): void;
-  /**
-   * Resets the manager to initial state.
-   * Can be called from 'success' or 'error' states to start over.
-   * Clears all stored data including phone number and OTP.
-   */
-  reset(): void;
-};
-declare function createPhoneManagerFromActor(actor: PhoneActor): Manager<PhoneState> & {
-  /**
-   * Initializes the phone verification flow.
-   * Transitions from 'idle' to 'loadingPrefill' or 'inputting'.
-   * Must be called before any other method.
-   */
-  load(): void;
-  /**
-   * Sets the phone number for verification.
-   * Should be called when state is 'inputting'.
-   *
-   * @param phone - Full phone number with country code (e.g., '+14155551234')
-   * @param isValid - Whether the phone number passes validation
-   *
-   * @example
-   * ```typescript
-   * // Using libphonenumber-js for validation
-   * import { isValidPhoneNumber } from 'libphonenumber-js';
-   * const phone = '+14155551234';
-   * phoneManager.setPhoneNumber(phone, isValidPhoneNumber(phone));
-   * ```
-   */
-  setPhoneNumber(phone: string, isValid: boolean): void;
-  /**
-   * Sets the marketing opt-in preference.
-   * Only relevant if `config.optinEnabled` is true.
-   *
-   * @param granted - Whether the user consented to receive marketing messages
-   */
-  setOptInGranted(granted: boolean): void;
-  /**
-   * Submits the phone number for verification.
-   * Requires a valid phone number to be set via `setPhoneNumber()`.
-   * Transitions to 'submitting', then to 'sendingOtp' or 'success' (if no OTP).
-   */
-  submit(): void;
-  /**
-   * Sets the OTP code without submitting.
-   * Use this for controlled input components.
-   *
-   * @param code - The OTP code entered by the user
-   */
-  setOtpCode(code: string): void;
-  /**
-   * Sets and submits the OTP code in one call.
-   * Should be called when state is 'awaitingOtp' or 'otpError'.
-   *
-   * @param code - The complete OTP code (typically 6 alphanumeric characters)
-   *
-   * @example
-   * ```typescript
-   * // Submit OTP when user completes entry
-   * phoneManager.submitOtp('HH36LP');
-   * ```
-   */
-  submitOtp(code: string): void;
-  /**
-   * Requests a new OTP code to be sent.
-   * Only works when state is 'awaitingOtp' and `canResend` is true.
-   * Resets the resend timer.
-   */
-  resendOtp(): void;
-  /**
-   * Returns to the phone input screen from OTP entry.
-   * Allows the user to change their phone number.
-   * Transitions from 'awaitingOtp' or 'otpError' back to 'inputting'.
-   */
-  back(): void;
-  /**
-   * Resets the manager to initial state.
-   * Can be called from 'success' or 'error' states to start over.
-   * Clears all stored data including phone number and OTP.
-   */
-  reset(): void;
-};
-/**
- * Type representing a phone manager instance.
- * Includes state access, API methods, and lifecycle management.
- *
- * @property getState - Returns the current PhoneState
- * @property subscribe - Subscribes to state changes, returns unsubscribe function
- * @property stop - Stops the manager and cleans up resources
- * @property load - Initializes the verification flow
- * @property setPhoneNumber - Sets the phone number
- * @property setOptInGranted - Sets marketing opt-in preference
- * @property submit - Submits the phone number
- * @property setOtpCode - Sets OTP code without submitting
- * @property submitOtp - Sets and submits OTP code
- * @property resendOtp - Requests new OTP code
- * @property back - Returns to phone input from OTP screen
- * @property reset - Resets to initial state
- */
-type PhoneManager = ReturnType<typeof createPhoneManager>;
-//#endregion
-export { phoneMachine as a, createPhoneManagerFromActor as i, PhoneState as n, PhoneConfig as o, createPhoneManager as r, PhoneManager as t };

package/dist/phoneManager-DAJbGhlY.esm.js

@@ -1,256 +0,0 @@
-import { n as eventModuleNames, o as createManagerInstrumentation } from "./events-D6-e4vok.esm.js";
-import { c as createManager, s as createActor } from "./xstate.esm-B70JrNqo.esm.js";
-import { t as phoneMachine } from "./phoneStateMachine-CuPARRaT.esm.js";
-
-//#region src/modules/phone/phoneActor.ts
-function createPhoneActor(options) {
-	return createActor(phoneMachine, { input: { config: options.config } }).start();
-}
-
-//#endregion
-//#region src/modules/phone/phoneManager.ts
-/**
-* @module @incodetech/core/phone
-*
-* Phone verification module for the Incode Web SDK.
-* Supports both headless (programmatic) and UI-driven usage patterns.
-*
-* ## Headless Usage
-*
-* The phone manager can be used entirely without UI for backend integrations,
-* custom UI implementations, or automated workflows.
-*
-* @example Basic headless phone verification with OTP
-* ```typescript
-* import { createPhoneManager } from '@incodetech/core/phone';
-* import { setup } from '@incodetech/core';
-*
-* // 1. Configure the SDK (required before using any module)
-* setup({ apiURL: 'https://api.example.com', token: 'your-token' });
-*
-* // 2. Create the phone manager
-* const phoneManager = createPhoneManager({
-*   config: {
-*     otpVerification: true,
-*     otpExpirationInMinutes: 5,
-*     prefill: false,
-*     maxOtpAttempts: 3,
-*   },
-* });
-*
-* // 3. Subscribe to state changes (optional but recommended)
-* phoneManager.subscribe((state) => {
-*   console.log('Phone state:', state.status);
-*   if (state.status === 'finished') {
-*     console.log('Phone verified successfully!');
-*   }
-*   if (state.status === 'error') {
-*     console.error('Error:', state.error);
-*   }
-* });
-*
-* // 4. Start the flow
-* phoneManager.load();
-*
-* // 5. When state is 'inputting', set the phone number
-* phoneManager.setPhoneNumber('+14155551234', true);
-*
-* // 6. Submit the phone number
-* phoneManager.submit();
-*
-* // 7. When state is 'awaitingOtp', submit the OTP code
-* phoneManager.submitOtp('ABC123');
-*
-* // 8. Clean up when done
-* phoneManager.stop();
-* ```
-*
-* @example Polling-based headless usage
-* ```typescript
-* const phoneManager = createPhoneManager({ config });
-*
-* phoneManager.load();
-*
-* // Poll for state changes
-* const interval = setInterval(() => {
-*   const state = phoneManager.getState();
-*
-*   switch (state.status) {
-*     case 'inputting':
-*       phoneManager.setPhoneNumber('+14155551234', true);
-*       phoneManager.submit();
-*       break;
-*     case 'awaitingOtp':
-*       // Get OTP from user or external source
-*       phoneManager.submitOtp(otpCode);
-*       break;
-*     case 'finished':
-*       clearInterval(interval);
-*       phoneManager.stop();
-*       break;
-*     case 'error':
-*       clearInterval(interval);
-*       console.error(state.error);
-*       phoneManager.stop();
-*       break;
-*   }
-* }, 100);
-* ```
-*/
-function mapState(snapshot) {
-	const typedSnapshot = snapshot;
-	const { context } = typedSnapshot;
-	if (typedSnapshot.matches("idle")) return { status: "idle" };
-	if (typedSnapshot.matches("loadingPrefill")) return { status: "loadingPrefill" };
-	if (typedSnapshot.matches("loadingStartInfo")) return {
-		status: "loadingStartInfo",
-		prefilledPhone: context.prefilledPhone,
-		otpVerification: context.config.otpVerification,
-		optinEnabled: context.config.optinEnabled ?? false
-	};
-	if (typedSnapshot.matches("inputting")) return {
-		status: "inputting",
-		countryCode: context.countryCode,
-		phonePrefix: context.phonePrefix,
-		prefilledPhone: context.prefilledPhone,
-		phoneError: context.phoneError,
-		otpVerification: context.config.otpVerification,
-		optinEnabled: context.config.optinEnabled ?? false
-	};
-	if (typedSnapshot.matches("submitting")) return { status: "submitting" };
-	if (typedSnapshot.matches("resendingOtp")) return { status: "resendingOtp" };
-	if (typedSnapshot.matches("sendingInitialOtp")) return { status: "sendingInitialOtp" };
-	if (typedSnapshot.matches("awaitingOtp")) return {
-		status: "awaitingOtp",
-		resendTimer: context.resendTimer,
-		canResend: !context.resendTimerActive,
-		attemptsRemaining: context.attemptsRemaining
-	};
-	if (typedSnapshot.matches("verifyingOtp")) return {
-		status: "verifyingOtp",
-		resendTimer: context.resendTimer,
-		canResend: !context.resendTimerActive
-	};
-	if (typedSnapshot.matches("otpError")) return {
-		status: "otpError",
-		otpError: context.otpError ?? "otp.errorv2",
-		attemptsRemaining: context.attemptsRemaining,
-		resendTimer: context.resendTimer,
-		canResend: !context.resendTimerActive
-	};
-	if (typedSnapshot.matches("finished")) return { status: "finished" };
-	if (typedSnapshot.matches("error")) return {
-		status: "error",
-		error: context.error ?? "An error occurred"
-	};
-	return { status: "idle" };
-}
-function createApi({ actor, trackElementClicked }) {
-	return {
-		load() {
-			actor.send({ type: "LOAD" });
-		},
-		setPhoneNumber(phone, isValid) {
-			actor.send({
-				type: "PHONE_CHANGED",
-				phone,
-				isValid
-			});
-		},
-		setOptInGranted(granted) {
-			actor.send({
-				type: "OPT_IN_CHANGED",
-				granted
-			});
-		},
-		submit() {
-			trackElementClicked?.("submit");
-			actor.send({ type: "SUBMIT" });
-		},
-		setOtpCode(code) {
-			actor.send({
-				type: "OTP_CHANGED",
-				code
-			});
-		},
-		submitOtp(code) {
-			trackElementClicked?.("submitOtp");
-			actor.send({
-				type: "OTP_CHANGED",
-				code
-			});
-			actor.send({ type: "VERIFY_OTP" });
-		},
-		resendOtp() {
-			trackElementClicked?.("resendOtp");
-			actor.send({ type: "RESEND_OTP" });
-		},
-		back() {
-			trackElementClicked?.("back");
-			actor.send({ type: "BACK" });
-		},
-		reset() {
-			actor.send({ type: "RESET" });
-		}
-	};
-}
-/**
-* Creates a phone verification manager for headless or UI-driven usage.
-*
-* The manager provides a state machine-based API for phone number verification
-* with optional OTP (one-time password) verification.
-*
-* @param options - Configuration options
-* @param options.config - Phone verification configuration
-* @param options.config.otpVerification - Whether to require OTP verification
-* @param options.config.otpExpirationInMinutes - How long the OTP is valid
-* @param options.config.prefill - Whether to fetch a pre-filled phone number
-* @param options.config.isInstantVerify - Use instant verification API
-* @param options.config.optinEnabled - Show marketing opt-in checkbox
-* @param options.config.maxOtpAttempts - Maximum OTP verification attempts (default: 3)
-*
-* @returns Phone manager with state, API methods, and subscription
-*
-* @example Headless usage
-* ```typescript
-* const manager = createPhoneManager({
-*   config: { otpVerification: true, otpExpirationInMinutes: 5, prefill: false },
-* });
-*
-* manager.subscribe((state) => console.log(state.status));
-* manager.load();
-* manager.setPhoneNumber('+14155551234', true);
-* manager.submit();
-* // ... wait for 'awaitingOtp' state ...
-* manager.submitOtp('ABC123');
-* manager.stop();
-* ```
-*
-* @example With React/Preact UI hook
-* ```tsx
-* const [state, manager] = useManager(() => createPhoneManager({ config }));
-*
-* if (state.status === 'inputting') {
-*   return <input onChange={(e) => manager.setPhoneNumber(e.target.value, true)} />;
-* }
-* ```
-*/
-function createPhoneManager(options) {
-	return createManager({
-		actor: createPhoneActor(options),
-		mapState,
-		createApi,
-		instrumentation: createManagerInstrumentation(eventModuleNames.phone)
-	});
-}
-function createPhoneManagerFromActor(actor) {
-	return createManager({
-		actor,
-		mapState,
-		createApi,
-		instrumentation: createManagerInstrumentation(eventModuleNames.phone)
-	});
-}
-
-//#endregion
-export { createPhoneManagerFromActor as n, createPhoneManager as t };