doct-ui-auth-kit 1.0.12 → 1.0.14

package/dist/core/sso-session.d.ts

@@ -0,0 +1,35 @@
+/**
+ * SSO session management: token persistence strategies.
+ * - `localStorageTokenStorage`: single-origin, suitable for dev.
+ * - `serverCookieTokenStorage`: HttpOnly cookie-based, for production SSO.
+ * - `createAxiosAuthInterceptors`: attaches withCredentials + 401 handling to an axios instance.
+ */
+import type { AxiosAuthInterceptorInstance, TokenStorageStrategy } from '../types';
+export type { AxiosAuthInterceptorInstance, AxiosRequestConfig, TokenStorageStrategy, } from '../types';
+/**
+ * Token storage using localStorage (single-origin).
+ * Suitable for dev or when all Docthub apps share the same origin.
+ */
+export declare function localStorageTokenStorage(): TokenStorageStrategy;
+/**
+ * Token storage when the token lives in a server-set cookie (e.g. HttpOnly).
+ * The client never reads or writes the token; the server sets the cookie on
+ * login and reads it from the request. Use with validateSessionFromCookie
+ * in your adapter and createAxiosAuthInterceptors (withCredentials) so the
+ * cookie is sent on every request.
+ */
+export declare function serverCookieTokenStorage(): TokenStorageStrategy;
+/**
+ * Attaches request and response interceptors to an axios instance for SSO auth
+ * when using server-side cookies (e.g. serverCookieTokenStorage):
+ * - Request: sets withCredentials so the browser sends cookies on every request.
+ * - Response: on 401, calls onUnauthorized (e.g. redirect to login).
+ *
+ * @param axiosInstance - Your axios instance (e.g. axios.create({ baseURL: '...' }))
+ * @param onUnauthorized - Optional callback when a response has status 401
+ */
+export declare function createAxiosAuthInterceptors(axiosInstance: AxiosAuthInterceptorInstance, onUnauthorized?: () => void): void;
+/**
+ * useAuthSession hook is implemented in auth-context (uses AuthFlowContext).
+ * Re-exported from core index for consumer convenience.
+ */

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/core/use-auth-flow.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Auth flow state machine: reducer and state type.
+ * Side effects (API calls, token persistence) are performed by the provider; this module is pure.
+ */
+import type { AuthFlowAction, AuthFlowState, AuthStep } from '../types';
+export type { AuthFlowAction, AuthFlowState, IdentifierType } from '../types';
+export declare const INITIAL_STEP: AuthStep;
+export declare function getInitialAuthFlowState(): AuthFlowState;
+export declare function authFlowReducer(state: AuthFlowState, action: AuthFlowAction): AuthFlowState;

package/dist/hooks/index.d.ts

@@ -0,0 +1,5 @@
+export { type EmailFormValues, type LoginEntryFormValues, type LoginEntryMode, type PhoneFormValues, type UseLoginEntryFormOptions, type UseLoginEntryFormReturn, useLoginEntryForm, } from './use-login-entry-form';
+export { type MainAuthPageHandlers, type MainLoginAppleProviderConfig, type MainLoginGoogleProviderConfig, type MainLoginPageProvidersConfig, type UseMainAuthPageHandlersOptions, useMainAuthPageHandlers, } from './use-main-auth-page-handlers';
+export { DEFAULT_OTP_TITLES, OTP_LENGTH, type OtpFormValues, type OtpVerificationMode, RESEND_COOLDOWN_EMAIL_SECONDS, RESEND_COOLDOWN_PHONE_SECONDS, type UseOtpVerificationOptions, type UseOtpVerificationReturn, useOtpVerification, } from './use-otp-verification';
+export { type UseRepeatLoginOptions, type UseRepeatLoginReturn, useRepeatLogin, } from './use-repeat-login';
+export { type SignupEmailFormValues, type SignupEntryMode, type SignupFormValues, type SignupPhoneFormValues, type UseSignupFormOptions, type UseSignupFormReturn, useSignupForm, } from './use-signup-form';

package/dist/hooks/use-login-entry-form.d.ts

@@ -0,0 +1,12 @@
+import type { UseLoginEntryFormOptions, UseLoginEntryFormReturn } from '../types';
+export type { EmailFormValues, LoginEntryFormValues, LoginEntryMode, LoginEntrySubmitData, LoginEntrySuccessParams, PhoneFormValues, UseLoginEntryFormOptions, UseLoginEntryFormReturn, } from '../types';
+/**
+ * Form state and validation for the login entry screen (phone or email).
+ *
+ * **Dual submission pattern:**
+ * - `submitApi` (async): hook owns the flow — validate → submitApi(data) → onSuccess(). Future SSO API integration plugs in here.
+ * - `onSubmit` (sync): caller owns the flow — hook validates then hands data back (used by AuthFlow).
+ *
+ * **Validation flow:** RHF form data → Zod schema (loginSchemas[mode]) → setFormErrorsFromZod → field-level errors.
+ */
+export declare function useLoginEntryForm({ mode, onSubmit, submitApi, onSuccess, onError, }: UseLoginEntryFormOptions): UseLoginEntryFormReturn;

package/dist/hooks/use-main-auth-page-handlers.d.ts

@@ -0,0 +1,9 @@
+import type { MainAuthPageHandlers, UseMainAuthPageHandlersOptions } from '../types';
+export type { MainAuthPageHandlers, MainLoginAppleProviderConfig, MainLoginGoogleProviderConfig, MainLoginPageProvidersConfig, UseMainAuthPageHandlersOptions, } from '../types';
+/**
+ * Centralizes Google/Apple OAuth and auth-method CTA handlers for the main login page.
+ * When `providers.google` / `providers.apple` are configured, the SDK runs the OAuth flow internally
+ * and calls `onCredential`; otherwise falls back to consumer-supplied overrides or no-op defaults.
+ * Consumer apps pass callbacks (e.g. `onContinueWithMobile`) to wire navigation.
+ */
+export declare function useMainAuthPageHandlers(options?: Readonly<UseMainAuthPageHandlersOptions>): MainAuthPageHandlers;

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;

package/dist/hooks/use-repeat-login.d.ts

@@ -0,0 +1,9 @@
+import type { UseRepeatLoginOptions, UseRepeatLoginReturn } from '../types';
+export type { UseRepeatLoginOptions, UseRepeatLoginReturn } from '../types';
+/**
+ * Business logic for repeat login (device-based returning-user detection).
+ *
+ * **Dual submission:** `continueApi` (async, hook owns flow) vs `onContinueWithLastMethod` (sync, caller owns flow).
+ * Last-used method is read from localStorage by the provider and passed down as a prop.
+ */
+export declare function useRepeatLogin(options?: UseRepeatLoginOptions): UseRepeatLoginReturn;

package/dist/hooks/use-signup-form.d.ts

@@ -0,0 +1,12 @@
+import type { UseSignupFormOptions, UseSignupFormReturn } from '../types';
+export type { SignupEmailFormValues, SignupEntryMode, SignupForeignFormValues, SignupFormValues, SignupPhoneFormValues, SignupSubmitData, UseSignupFormOptions, UseSignupFormReturn, } from '../types';
+/**
+ * Form state and validation for the signup screen (full name + phone or email, or foreign: all three).
+ *
+ * **Dual submission pattern:**
+ * - `submitApi` (async): hook owns the flow — validate → submitApi(data) → onSuccess(). Future SSO profile completion plugs in here.
+ * - `onSubmit` (sync): caller owns the flow — hook validates then hands data back (used by AuthFlow).
+ *
+ * **Validation flow:** RHF form data → Zod schema (signupSchemas[mode]) → setFormErrorsFromZod → field-level errors.
+ */
+export declare function useSignupForm({ mode, defaultPhone, onSubmit, submitApi, onSuccess, onError, }: UseSignupFormOptions): UseSignupFormReturn;

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Auth SDK UI Kit – library entry point.
+ * Consumers can import components, layouts (composition + preset), hooks, core (SSO provider, flow, session), and auth methods.
+ *
+ * Import the kit styles once globally in your app (e.g. in main.tsx):
+ * `import 'doct-ui-auth-kit/style.css';`
+ *
+ * @example
+ * ```ts
+ * import {
+ *   SSOAuthProvider,
+ *   AuthFlow,
+ *   useAuthFlow,
+ *   useAuthSession,
+ *   MainLayout,
+ *   AuthLayout,
+ *   ImageSlider,
+ *   AuthLayoutWrapper,
+ *   LoginEntry,
+ *   OtpVerification,
+ *   useGoogleAuth,
+ * } from 'doct-ui-auth-kit';
+ * ```
+ */
+import './index.css';
+export { createHttpAuthAdapter } from './adapters';
+export { Auth } from './auth';
+export type { UseAppleSignInOptions, UseGoogleAuthOptions, UseGoogleAuthReturn, } from './auth-methods';
+export { useAppleSignIn, useGoogleAuth } from './auth-methods';
+export type { BackButtonProps } from './components/common';
+export { BackButton, DefaultFooter, EnterpriseHeader, } from './components/common';
+export type { AuthLayoutPresetProps, AuthLayoutType, AuthLayoutWrapperProps, } from './components/layout';
+export { AuthLayout, AuthLayoutPreset, AuthLayoutWrapper, ImageSlider, MainLayout, } from './components/layout';
+export * from './core';
+export * from './hooks';
+export type { LoginEntryPageProps, LoginEntryProps, MainLoginPageProps, MainLoginPageProvidersConfig, OtpVerificationPageProps, OtpVerificationProps, RepeatLoginPageProps, RepeatLoginProps, SignupPageFullProps, SignupPageProps, } from './pages/index';
+export { LoginEntry, LoginEntryPage, MainLogin, MainLoginPage, OtpVerification, OtpVerificationPage, RepeatLogin, RepeatLoginPage, Signup, SignupPage, } from './pages/index';
+export * from './types';