doct-ui-auth-kit 1.0.12 → 1.0.13

package/dist/types/pages/main-login.d.ts

@@ -0,0 +1,51 @@
+/** Handlers exposed by the main auth page (method select). */
+export interface MainAuthPageHandlers {
+    /** Called when the user selects "Continue with Mobile". */
+    onContinueWithMobile: () => void;
+    /** Called when the user selects "Continue with Email". */
+    onContinueWithEmail: () => void;
+    /** Called when the user selects "Continue with Google". */
+    onContinueWithGoogle: () => void;
+    /** Called when the user selects "Continue with Apple". */
+    onContinueWithApple: () => void;
+}
+/** Config for lib-handled Google sign-in. When set, the lib runs the OAuth flow and calls onCredential. */
+export interface MainLoginGoogleProviderConfig {
+    /** Google OAuth 2.0 client ID. */
+    clientId: string;
+    /** Called with ID token (One Tap) or auth code (button popup). Send to your backend to verify. */
+    onCredential: (credential: string) => void;
+    /** Enable Google One Tap prompt for automatic sign-in. */
+    enableOneTap?: boolean;
+}
+/** Config for lib-handled Apple sign-in (stub). When set, the lib will run the flow and call onCredential when implemented. */
+export interface MainLoginAppleProviderConfig {
+    /** Apple Services ID (client ID) configured in the Apple Developer portal. */
+    clientId: string;
+    /** OAuth redirect URI registered with Apple for the sign-in flow. */
+    redirectUri: string;
+    /** Called with the Apple identity token after a successful sign-in. Send to your backend to verify. */
+    onCredential: (credential: string) => void;
+}
+/** Optional provider config so the lib handles Google/Apple API calls. */
+export interface MainLoginPageProvidersConfig {
+    /** Google sign-in configuration. When set, the lib handles the Google OAuth flow. */
+    google?: MainLoginGoogleProviderConfig;
+    /** Apple sign-in configuration. When set, the lib handles the Apple OAuth flow. */
+    apple?: MainLoginAppleProviderConfig;
+}
+/** Options for useMainAuthPageHandlers: optional callback overrides + optional provider config for lib-handled OAuth. */
+export type UseMainAuthPageHandlersOptions = Partial<MainAuthPageHandlers> & {
+    providers?: MainLoginPageProvidersConfig;
+    /**
+     * Custom handler for the "Enterprise Login" header CTA. When omitted,
+     * the header redirects to the default enterprise URL
+     * (`DEFAULT_ENTERPRISE_LOGIN_URL`).
+     */
+    onEnterpriseLogin?: () => void;
+    /**
+     * Override the default enterprise redirect URL. Ignored when
+     * `onEnterpriseLogin` is provided. Defaults to `https://docthub.com/`.
+     */
+    enterpriseLoginUrl?: string;
+};

package/dist/types/pages/otp-verification.d.ts

@@ -0,0 +1,53 @@
+import type { UseFormReturn } from 'react-hook-form';
+import type { z } from 'zod';
+import type { OtpVerificationMode, otpFormSchema } from '@/validations';
+export type { OtpVerificationMode };
+/** Form values for the OTP verification form, inferred from the Zod schema. */
+export type OtpFormValues = z.infer<typeof otpFormSchema>;
+/**
+ * Consumer-provided custom validator for OTP. Runs after the built-in
+ * 6-digit check passes. Return `true` to accept, or a string message to
+ * surface as the field error (and block submission). May be async so
+ * callers can hit a backend pre-check before the full verify call.
+ */
+export type OtpValidateFn = (otp: string) => string | true | Promise<string | true>;
+/** Options for the `useOtpVerification` hook controlling mode, submission, and callbacks. */
+export interface UseOtpVerificationOptions {
+    /** OTP mode: phone (60s cooldown) or email (2 min cooldown). */
+    mode: OtpVerificationMode;
+    /** Sync callback with OTP string. Use when parent owns API (e.g. AuthFlow). Ignored when submitApi is provided. */
+    onSubmit?: ((otp: string) => void) | undefined;
+    /** Called when the user requests a new OTP code (resend). Ignored when submitApi is provided. */
+    onResendCode?: (() => void) | undefined;
+    /** When provided, hook runs: validate → submitApi(otp) → onSuccess(). Consumer passes redirect in onSuccess. */
+    submitApi?: ((otp: string) => Promise<void>) | undefined;
+    /** Called after submitApi resolves (e.g. router.push('/dashboard')). */
+    onSuccess?: (() => void) | undefined;
+    /** Called when submitApi rejects or throws. */
+    onError?: ((error: unknown) => void) | undefined;
+    /**
+     * Optional custom OTP validator. Runs after the built-in digit check.
+     * Return `true` to accept, or a string to surface as the field error
+     * and block submission.
+     */
+    validate?: OtpValidateFn | undefined;
+}
+/** Return value of the `useOtpVerification` hook, providing form state and resend controls. */
+export interface UseOtpVerificationReturn {
+    /** react-hook-form methods bound to the OTP form. */
+    methods: UseFormReturn<OtpFormValues>;
+    /** Submit handler to pass to the form's `onSubmit`. Validates and dispatches the OTP. */
+    handleSubmit: (data: OtpFormValues) => void;
+    /** True when current form values pass validation (for disabling Submit until valid – edge case 6). */
+    isFormValid: (data: OtpFormValues) => boolean;
+    /** Triggers a resend of the OTP code and resets the cooldown timer. */
+    handleResend: () => void;
+    /** Seconds remaining before the user can request another OTP code. */
+    resendSecondsLeft: number;
+    /** True when the resend cooldown has elapsed and the user may request a new code. */
+    canResend: boolean;
+    /** Human-readable countdown string (e.g. `"00:45"`) for display next to the resend button. */
+    timerText: string;
+    /** True while submitApi is in flight. */
+    isSubmitting: boolean;
+}

package/dist/types/pages/pages.d.ts

@@ -0,0 +1,146 @@
+/**
+ * Props and public types for auth page components.
+ */
+import type { UserType } from '../auth/auth-types';
+import type { IdentifierType } from '../auth/flow';
+import type { LoginEntryMode } from './login-form';
+import type { UseMainAuthPageHandlersOptions } from './main-login';
+import type { OtpValidateFn, OtpVerificationMode } from './otp-verification';
+/** Props for MainLoginPage and MainLogin components. */
+export type MainLoginPageProps = UseMainAuthPageHandlersOptions;
+/** Props for LoginEntry (inner form without layout). */
+export interface LoginEntryProps {
+    /** Mode: phone number or email input */
+    mode: LoginEntryMode;
+    /** Override title (consumers render via AuthLayout.Title) */
+    title?: string;
+    /** Override subtitle (consumers render via AuthLayout.Description) */
+    subtitle?: string;
+    /** Handler when back button is clicked (consumers render back button in AuthLayout.Logo) */
+    onBack?: () => void;
+    /**
+     * Sync callback with valid data. Use when parent owns API (e.g. AuthFlow).
+     * Ignored when submitApi is provided.
+     */
+    onSubmit?: ((data: {
+        phone?: string;
+        email?: string;
+        countryCode?: string;
+    }) => void) | undefined;
+    /**
+     * Async API call (e.g. send OTP). When provided, hook runs: validate → submitApi(data) → onSuccess().
+     * Consumer (e.g. Next.js) can pass redirect in onSuccess.
+     */
+    submitApi?: ((data: {
+        phone?: string;
+        email?: string;
+        countryCode?: string;
+    }) => Promise<void>) | undefined;
+    /** Called after submitApi succeeds; receives { mode, recipient } for OTP redirect/recipientDisplay. */
+    onSuccess?: ((params: {
+        mode: LoginEntryMode;
+        recipient: string;
+    }) => void) | undefined;
+    /** Called when submitApi fails. */
+    onError?: ((error: unknown) => void) | undefined;
+}
+/** Props for the full LoginEntryPage (adds optional layout overrides for story/viewport). */
+export interface LoginEntryPageProps extends LoginEntryProps {
+    /** Layout type. Default: 'withSlider' for desktop, use 'standalone' for mobile. */
+    layoutType?: 'withSlider' | 'standalone';
+    /** Layout variant. Default derived from layoutType if not set. */
+    variant?: 'desktop' | 'mobile';
+}
+/** Props for Signup (inner form without layout). */
+export interface SignupPageProps {
+    /** Indian: which field to collect. Foreign: use 'foreign' mode (name + email + phone). */
+    userType: UserType;
+    /** How user started (phone or email). */
+    loginMethod: IdentifierType;
+    /** Indian only: which field to collect (phone or email). */
+    signupCollectField: IdentifierType;
+    /** Foreign only: phone when user entered phone before signup details. */
+    pendingPhone?: string | undefined;
+    /** Sync callback with valid data. Use when parent owns API (e.g. AuthFlow). Ignored when submitApi is provided. */
+    onSubmit?: ((data: {
+        fullName: string;
+        phone?: string;
+        email?: string;
+        countryCode?: string;
+    }) => void) | undefined;
+    /** Async API (e.g. complete profile). When provided, hook runs: validate → submitApi(data) → onSuccess(). */
+    submitApi?: ((data: {
+        fullName: string;
+        phone?: string;
+        email?: string;
+        countryCode?: string;
+    }) => Promise<void>) | undefined;
+    /** Called after submitApi succeeds (e.g. router.push('/otp') or next step). */
+    onSuccess?: (() => void) | undefined;
+    /** Called when submitApi fails. */
+    onError?: ((error: unknown) => void) | undefined;
+}
+/** Props for the full SignupPage (adds optional layout overrides). */
+export interface SignupPageFullProps extends SignupPageProps {
+    layoutType?: 'withSlider' | 'standalone';
+    variant?: 'desktop' | 'mobile';
+}
+/** Props for OtpVerification (inner form without layout). */
+export interface OtpVerificationProps {
+    /** Mode: mobile (phone) or email OTP */
+    mode: OtpVerificationMode;
+    /** Title override. Default: "6 digit OTP has been sent to your Mobile" | "..." Email */
+    title?: string | undefined;
+    /** Masked phone (e.g. "+91 9825910X0X") or email (e.g. "j***@gmail.com") */
+    recipientDisplay: string;
+    /** When true, show instruction line ("Kindly check your Email Inbox."). Used for foreign user flow. */
+    isForeignUser?: boolean | undefined;
+    /** Handler when back is clicked */
+    onBack?: (() => void) | undefined;
+    /** Sync callback with OTP. Use when parent owns API (e.g. AuthFlow). Ignored when submitApi is provided. */
+    onSubmit?: ((otp: string) => void) | undefined;
+    /** Handler when user requests resend code */
+    onResendCode?: (() => void) | undefined;
+    /** Async API (e.g. verify OTP). When provided, hook runs: validate → submitApi(otp) → onSuccess(). */
+    submitApi?: ((otp: string) => Promise<void>) | undefined;
+    /** Called after submitApi succeeds (e.g. router.push('/dashboard')). */
+    onSuccess?: (() => void) | undefined;
+    /** Called when submitApi fails. */
+    onError?: ((error: unknown) => void) | undefined;
+    /**
+     * Optional custom OTP validator. Runs after the built-in 6-digit
+     * check; return `true` to accept or a string message to display as
+     * the field error (and block submission).
+     */
+    validate?: OtpValidateFn | undefined;
+}
+/** Props for the full OtpVerificationPage (adds optional layout overrides). */
+export interface OtpVerificationPageProps extends OtpVerificationProps {
+    layoutType?: 'withSlider' | 'standalone';
+    variant?: 'desktop' | 'mobile';
+}
+/** Props for RepeatLogin (inner component without layout). */
+export interface RepeatLoginProps {
+    /**
+     * Last used authentication method shown in the primary button label.
+     * Example: "Mobile", "Email".
+     *
+     * @default "Mobile"
+     */
+    lastUsedMethod?: string;
+    /** Sync handler for primary action. Use when caller owns API (e.g. AuthFlow). Ignored when continueApi is provided. */
+    onContinueWithLastMethod?: (() => void) | undefined;
+    /** Handler for the secondary action (choose another method). */
+    onUseAnotherMethod?: (() => void) | undefined;
+    /** Async API for continue (e.g. validate session). When provided, hook runs: continueApi() → onSuccess(). */
+    continueApi?: (() => Promise<void>) | undefined;
+    /** Called after continueApi succeeds (e.g. router.push('/dashboard')). */
+    onSuccess?: (() => void) | undefined;
+    /** Called when continueApi fails. */
+    onError?: ((error: unknown) => void) | undefined;
+}
+/** Props for the full RepeatLoginPage (adds optional layout overrides). */
+export interface RepeatLoginPageProps extends RepeatLoginProps {
+    layoutType?: 'withSlider' | 'standalone';
+    variant?: 'desktop' | 'mobile';
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doct-ui-auth-kit",
-  "version": "1.0.12",
+  "version": "1.0.13",
   "description": "Composable React auth SDK – layouts, login/signup/OTP pages, SSO provider, and auth flow hooks for Docthub",
   "type": "module",
   "main": "./dist/index.js",