doct-ui-auth-kit 1.0.12 → 1.0.13

package/dist/components/common/enterprise-header.d.ts

@@ -0,0 +1,22 @@
+/** Default destination when no explicit `onClick` or `href` is provided. */
+export declare const DEFAULT_ENTERPRISE_LOGIN_URL = "https://docthub.com/";
+export interface EnterpriseHeaderProps {
+    /**
+     * Custom click handler. Takes precedence over `href`. Use this when you
+     * want to navigate within a SPA router instead of doing a full page load.
+     */
+    onClick?: () => void;
+    /**
+     * Override the default redirect URL. Ignored when `onClick` is provided.
+     * Defaults to `https://docthub.com/`.
+     */
+    href?: string;
+}
+/**
+ * Header CTA that takes the user to the enterprise login surface.
+ * Hidden on small screens (sm:flex).
+ *
+ * Provide `onClick` for SPA navigation, or `href` for a plain anchor. Without
+ * either, the button redirects to the default `docthub.com` enterprise URL.
+ */
+export declare function EnterpriseHeader({ onClick, href, }?: EnterpriseHeaderProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/common/index.d.ts

@@ -0,0 +1,3 @@
+export { BackButton, type BackButtonProps } from './back-button';
+export { DefaultFooter } from './default-footer';
+export { DEFAULT_ENTERPRISE_LOGIN_URL, EnterpriseHeader, type EnterpriseHeaderProps, } from './enterprise-header';

package/dist/core/auth-flow.d.ts

@@ -0,0 +1,35 @@
+import type { AuthFlowRouter, AuthFlowRoutes, OtpValidateFn } from '@/types';
+/** Props for the `AuthFlow` orchestrator. */
+export interface AuthFlowProps {
+    /**
+     * Optional router adapter. When supplied alongside `routes`, the SDK
+     * keeps `state.step` and the URL in sync (forward, back/forward, deep
+     * links). Omit both to render as a single-screen flow with no URL.
+     */
+    router?: AuthFlowRouter;
+    /**
+     * Optional map of `AuthStep → URL path`. Steps omitted from the map
+     * render without changing the URL.
+     */
+    routes?: AuthFlowRoutes;
+    /**
+     * Optional consumer-supplied OTP validator. Runs after the built-in
+     * 6-digit check and before the kit fires `verifyOtp` — return `true` to
+     * accept, or a string message to surface as the field error.
+     */
+    validateOtp?: OtpValidateFn;
+    /**
+     * Optional override for the Enterprise Login CTA in the method-select
+     * header. When provided, replaces the default redirect to docthub.com.
+     */
+    onEnterpriseLogin?: () => void;
+}
+/**
+ * Auth flow orchestrator ("auto" mode): renders the correct page component based on the current flow state.
+ * Consumer wraps with `SSOAuthProvider` and drops `AuthFlow` in — the SDK handles all transitions.
+ *
+ * Pass `router` + `routes` to make the flow URL-aware: each step gets its
+ * own URL, browser back/forward Just Works, and deep-linkable steps
+ * (METHOD_SELECT / PHONE_ENTRY / EMAIL_ENTRY) can be opened directly.
+ */
+export declare function AuthFlow({ router, routes, validateOtp, onEnterpriseLogin, }?: AuthFlowProps): import("react/jsx-runtime").JSX.Element | null;

package/dist/core/use-auth-flow-router-sync.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Two-way sync between the auth flow state machine and a consumer-provided
+ * URL router adapter. Mounted by `<AuthFlow router routes>` when both are
+ * supplied. Without them, AuthFlow runs as a single-screen flow (no URL).
+ *
+ * Sync rules:
+ * - State → URL: when `state.step` changes, navigate to its mapped path.
+ *   First sync uses `replace` (no history entry); subsequent forward
+ *   transitions use `push`. Backward transitions (UI back button, reset)
+ *   use `replace` so the kit doesn't pile new entries on top of stale ones
+ *   — that pile-up is what makes the browser back button feel "stuck"
+ *   bouncing between two URLs.
+ * - URL → State: subscribe to history changes (back/forward). When the URL
+ *   moves to a routed step that's safe to deep-link into (METHOD_SELECT /
+ *   PHONE_ENTRY / EMAIL_ENTRY), dispatch the corresponding action. We mark
+ *   the dispatch so the next State → URL pass skips its push (the URL is
+ *   already where it needs to be — pushing would add a redundant entry
+ *   that breaks subsequent back navigation).
+ * - Deep-link guard: stateful steps (OTP, SIGNUP_DETAILS, REPEAT_LOGIN)
+ *   cannot be entered cold from a URL — the SDK snaps the URL back to the
+ *   current state's path instead.
+ */
+import type { AuthFlowRouter, AuthFlowRoutes } from '@/types';
+/**
+ * Wires `router` to the auth flow state machine. No-op when either
+ * `router` or `routes` is missing.
+ */
+export declare function useAuthFlowRouterSync(router: AuthFlowRouter | undefined, routes: AuthFlowRoutes | undefined): void;

package/dist/hooks/use-otp-verification.d.ts

@@ -0,0 +1,15 @@
+import type { OtpVerificationMode, UseOtpVerificationOptions, UseOtpVerificationReturn } from '@/types';
+export type { OtpFormValues, OtpValidateFn, OtpVerificationMode, UseOtpVerificationOptions, UseOtpVerificationReturn, } from '@/types';
+/** Instruction line below recipient (Figma: "Kindly check your Email Inbox."). */
+export declare const DEFAULT_OTP_INSTRUCTIONS: Record<OtpVerificationMode, string>;
+export declare const DEFAULT_OTP_TITLES: Record<OtpVerificationMode, string>;
+/** Re-export for consumers who import from hooks. */
+export { getResendCooldownSeconds, OTP_LENGTH, RESEND_COOLDOWN_EMAIL_SECONDS, RESEND_COOLDOWN_PHONE_SECONDS, } from '@/validations';
+/**
+ * Form state, resend countdown, and validation for OTP verification.
+ *
+ * **Resend cooldown:** mode-dependent timer (60s phone / 120s email) blocks re-sends until elapsed.
+ * **Dual submission:** `submitApi` (async, hook owns flow) vs `onSubmit` (sync, caller owns flow).
+ * **Validation:** otpFormSchema ensures all 6 digits are present before submission.
+ */
+export declare function useOtpVerification({ mode, onSubmit, onResendCode, submitApi, onSuccess, onError, validate, }: UseOtpVerificationOptions): UseOtpVerificationReturn;