doct-ui-auth-kit 1.0.3 → 1.0.4

package/dist/types/signup-form.d.ts

@@ -0,0 +1,41 @@
+import type { UseFormReturn } from 'react-hook-form';
+import type { z } from 'zod';
+import type { signupEmailFormSchema, signupForeignFormSchema, signupPhoneFormSchema } from '@/validations';
+/** Signup mode: phone, email as second field, or foreign (full name + email + phone). */
+export type SignupEntryMode = 'phone' | 'email' | 'foreign';
+export type SignupPhoneFormValues = z.infer<typeof signupPhoneFormSchema>;
+export type SignupEmailFormValues = z.infer<typeof signupEmailFormSchema>;
+export type SignupForeignFormValues = z.infer<typeof signupForeignFormSchema>;
+export type SignupFormValues = SignupPhoneFormValues | SignupEmailFormValues | SignupForeignFormValues;
+/** Payload when signup form is valid. */
+export type SignupSubmitData = {
+    fullName: string;
+    phone?: string;
+    email?: string;
+};
+export interface UseSignupFormOptions {
+    /** Mode: phone, email as second field, or foreign (name + email + phone) */
+    mode: SignupEntryMode;
+    /** For foreign mode: pre-fill phone when user already entered it. */
+    defaultPhone?: string;
+    /** Sync callback with valid data. Use when parent owns API (e.g. AuthFlow). Ignored when submitApi is provided. */
+    onSubmit?: ((data: SignupSubmitData) => void) | undefined;
+    /** When provided, hook runs: validate → submitApi(data) → onSuccess(). Consumer passes redirect in onSuccess. */
+    submitApi?: (data: SignupSubmitData) => Promise<void>;
+    /** Called after submitApi succeeds (e.g. router.push('/otp') or next step). */
+    onSuccess?: () => void;
+    /** Called when submitApi rejects or throws. */
+    onError?: (error: unknown) => void;
+}
+export interface UseSignupFormReturn {
+    methods: UseFormReturn<SignupFormValues>;
+    handleSubmit: (data: SignupFormValues) => void;
+    /** True when mode is 'phone', false when mode is 'email'. For 'foreign' same as (mode === 'phone') for layout. */
+    isPhone: boolean;
+    /** True when mode is 'foreign' (full name + email + phone). */
+    isForeign: boolean;
+    /** True when current form values pass validation (for disabling Continue – edge cases 9, 16, 19). */
+    isFormValid: (data: SignupFormValues) => boolean;
+    /** True while submitApi is in flight. */
+    isSubmitting: boolean;
+}

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

@@ -0,0 +1,33 @@
+/**
+ * SSO session and token storage types.
+ */
+/** How/where the SSO token is stored for cross-app access. */
+export interface TokenStorageStrategy {
+    get(): string | null;
+    set(token: string, expiresAt: number): void;
+    remove(): void;
+}
+/** Minimal request config type for the interceptor (no axios import). */
+export interface AxiosRequestConfig {
+    headers?: Record<string, string> | {
+        [key: string]: string;
+    };
+    withCredentials?: boolean;
+}
+/**
+ * Axios instance shape needed to attach auth interceptors (avoids hard axios dependency).
+ * Use createAxiosAuthInterceptors with your axios instance.
+ */
+export interface AxiosAuthInterceptorInstance {
+    interceptors: {
+        request: {
+            use(onFulfilled?: (config: AxiosRequestConfig) => AxiosRequestConfig | Promise<AxiosRequestConfig>, onRejected?: (err: unknown) => unknown): number;
+        };
+        response: {
+            use(onFulfilled?: (res: unknown) => unknown, onRejected?: (err: unknown) => unknown): number;
+        };
+    };
+    defaults: {
+        withCredentials?: boolean;
+    };
+}

package/dist/utils/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Reusable utilities used in 2+ places across the auth SDK.
+ */
+export { setFormErrorsFromZod } from './set-form-errors-from-zod';

package/dist/utils/set-form-errors-from-zod.d.ts

@@ -0,0 +1,11 @@
+import type { ZodError } from 'zod';
+/**
+ * Applies Zod validation errors to a React Hook Form setError function.
+ * Used by form submit handlers to display field-level errors from schema validation.
+ *
+ * @param error - The ZodError from schema.safeParse when validation fails
+ * @param setError - RHF's setError (e.g. methods.setError)
+ */
+export declare function setFormErrorsFromZod(error: ZodError, setError: (path: string, opts: {
+    message: string;
+}) => void): void;

package/dist/validations/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Central export for all validation schemas and helpers.
+ * Import from here: import { signupSchemas, loginSchemas, otpFormSchema } from '@/validations';
+ */
+export type { OtpVerificationMode } from './schemas';
+export { capitalizeWords, emailSchema, fullNameSchema, getResendCooldownSeconds, loginEmailFormSchema, loginPhoneFormSchema, loginSchemas, OTP_LENGTH, otpFormSchema, phoneSchema, RESEND_COOLDOWN_EMAIL_SECONDS, RESEND_COOLDOWN_PHONE_SECONDS, signupEmailFormSchema, signupForeignFormSchema, signupPhoneFormSchema, signupSchemas, } from './schemas';

package/dist/validations/schemas.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Centralized Zod schemas for auth forms (signup, login, OTP).
+ * Single source of truth for validation rules per PRODUCT_PROTOCOLS.
+ */
+import { z } from 'zod';
+/** Capitalize first letter of each word (PRODUCT_PROTOCOLS #25 – Naming conventions). */
+export declare function capitalizeWords(value: string): string;
+/**
+ * Full name: min 3 chars, trim, capitalize each word (Protocol #1, #25; Edge case 9).
+ */
+export declare const fullNameSchema: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+/**
+ * Phone: digits only, length between 7 and 15.
+ */
+export declare const phoneSchema: z.ZodString;
+/**
+ * Email: trim and lowercase before save (Edge case 10).
+ */
+export declare const emailSchema: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+export declare const signupPhoneFormSchema: z.ZodObject<{
+    fullName: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    phone: z.ZodString;
+}, z.core.$strip>;
+export declare const signupEmailFormSchema: z.ZodObject<{
+    fullName: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    email: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+}, z.core.$strip>;
+export declare const signupForeignFormSchema: z.ZodObject<{
+    fullName: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    email: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    phone: z.ZodString;
+}, z.core.$strip>;
+export declare const signupSchemas: {
+    readonly phone: z.ZodObject<{
+        fullName: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+        phone: z.ZodString;
+    }, z.core.$strip>;
+    readonly email: z.ZodObject<{
+        fullName: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+        email: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    }, z.core.$strip>;
+    readonly foreign: z.ZodObject<{
+        fullName: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+        email: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+        phone: z.ZodString;
+    }, z.core.$strip>;
+};
+/**
+ * Phone validation per PRODUCT_PROTOCOLS #2, #5 and edge cases 3–5.
+ */
+export declare const loginPhoneFormSchema: z.ZodObject<{
+    phone: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Email validation: trim and lowercase per edge case 10.
+ */
+export declare const loginEmailFormSchema: z.ZodObject<{
+    email: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+}, z.core.$strip>;
+export declare const loginSchemas: {
+    readonly phone: z.ZodObject<{
+        phone: z.ZodString;
+    }, z.core.$strip>;
+    readonly email: z.ZodObject<{
+        email: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    }, z.core.$strip>;
+};
+export declare const OTP_LENGTH = 6;
+/** Resend cooldown: 60s for phone OTP, 2 min for email OTP (per design). */
+export declare const RESEND_COOLDOWN_PHONE_SECONDS = 60;
+export declare const RESEND_COOLDOWN_EMAIL_SECONDS = 120;
+export type OtpVerificationMode = 'phone' | 'email';
+export declare function getResendCooldownSeconds(mode: OtpVerificationMode): number;
+export declare const otpFormSchema: z.ZodObject<{
+    otp: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;

package/package.json

@@ -1,104 +1,105 @@
-{
-  "name": "doct-ui-auth-kit",
-  "version": "1.0.3",
-  "description": "Composable React auth SDK – layouts, login/signup/OTP pages, SSO provider, and auth flow hooks for Docthub",
-  "type": "module",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "files": ["dist", "README.md"],
-  "keywords": [
-    "react",
-    "auth",
-    "sdk",
-    "docthub",
-    "login",
-    "signup",
-    "sso",
-    "otp"
-  ],
-  "license": "UNLICENSED",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/docthub/doct-ui-auth-kit"
-  },
-  "scripts": {
-    "dev": "vite",
-    "build": "tsc -b && vite build && tsc -p tsconfig.build.json",
-    "prepublishOnly": "npm run build",
-    "lint": "biome lint .",
-    "preview": "vite preview",
-    "format": "biome format --write .",
-    "lint:biome": "biome lint .",
-    "check": "biome check .",
-    "check:fix": "biome check --write .",
-    "type-check": "tsc --noEmit",
-    "prepare": "husky",
-    "storybook": "storybook dev -p 6006",
-    "build-storybook": "storybook build"
-  },
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
-    },
-    "./style.css": "./dist/style.css",
-    "./pages": {
-      "types": "./dist/pages/index.d.ts",
-      "import": "./dist/pages.js"
-    }
-  },
-  "peerDependencies": {
-    "react": "^19.0.0",
-    "react-dom": "^19.0.0",
-    "docthub-core-components": "^2.54.0",
-    "react-hook-form": "^7.50.0",
-    "zod": "^4.0.0"
-  },
-  "dependencies": {
-    "clsx": "^2.1.1",
-    "dayjs": "^1.11.19",
-    "docthub-core-components": "^2.54.0",
-    "react": "^19.2.0",
-    "react-dom": "^19.2.0",
-    "react-hook-form": "^7.71.1",
-    "react-icons": "^5.5.0",
-    "react-phone-number-input": "^3.4.14",
-    "zod": "^4.3.6"
-  },
-  "devDependencies": {
-    "@biomejs/biome": "^2.3.14",
-    "@chromatic-com/storybook": "^5.0.0",
-    "@eslint/js": "^9.39.1",
-    "@storybook/addon-a11y": "^10.2.6",
-    "@storybook/addon-docs": "^10.2.6",
-    "@storybook/addon-onboarding": "^10.2.6",
-    "@storybook/addon-vitest": "^10.2.6",
-    "@storybook/react-vite": "^10.2.6",
-    "@types/node": "^24.10.1",
-    "@types/react": "^19.2.5",
-    "@types/react-dom": "^19.2.3",
-    "@vitejs/plugin-react": "^5.1.1",
-    "@vitest/browser-playwright": "^4.0.18",
-    "@vitest/coverage-v8": "^4.0.18",
-    "autoprefixer": "^10.4.24",
-    "babel-plugin-react-compiler": "^1.0.0",
-    "eslint": "^9.39.1",
-    "eslint-plugin-react-hooks": "^7.0.1",
-    "eslint-plugin-react-refresh": "^0.4.24",
-    "glob": "^13.0.1",
-    "globals": "^16.5.0",
-    "husky": "^9.1.7",
-    "lint-staged": "^16.2.7",
-    "playwright": "^1.58.1",
-    "postcss": "^8.5.6",
-    "storybook": "^10.2.6",
-    "tailwind-merge": "^3.0.1",
-    "tailwindcss": "^3.4.16",
-    "tailwindcss-animate": "^1.0.7",
-    "typescript": "~5.6.2",
-    "typescript-eslint": "^8.46.4",
-    "vite": "^7.2.4",
-    "vitest": "^4.0.18",
-    "vite-plugin-dts": "^4.5.0"
-  }
-}
+{
+  "name": "doct-ui-auth-kit",
+  "version": "1.0.4",
+  "description": "Composable React auth SDK – layouts, login/signup/OTP pages, SSO provider, and auth flow hooks for Docthub",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": ["dist", "README.md"],
+  "keywords": [
+    "react",
+    "auth",
+    "sdk",
+    "docthub",
+    "login",
+    "signup",
+    "sso",
+    "otp"
+  ],
+  "license": "UNLICENSED",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/docthub/doct-ui-auth-kit"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc -b && vite build && tsc -p tsconfig.build.json",
+    "prepublishOnly": "npm run build",
+    "lint": "biome lint .",
+    "preview": "vite preview",
+    "format": "biome format --write .",
+    "lint:biome": "biome lint .",
+    "check": "biome check .",
+    "check:fix": "biome check --write .",
+    "type-check": "tsc --noEmit",
+    "prepare": "husky",
+    "storybook": "storybook dev -p 6006",
+    "build-storybook": "storybook build"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./style.css": "./dist/style.css",
+    "./pages": {
+      "types": "./dist/pages/index.d.ts",
+      "import": "./dist/pages.js"
+    }
+  },
+  "peerDependencies": {
+    "docthub-core-components": "^2.54.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "react-hook-form": "^7.50.0",
+    "zod": "^4.0.0"
+  },
+  "dependencies": {
+    "clsx": "^2.1.1",
+    "dayjs": "^1.11.19",
+    "docthub-core-components": "^2.54.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "react-hook-form": "^7.50.0",
+    "react-icons": "^5.5.0",
+    "react-phone-number-input": "^3.4.14",
+    "react-router-dom": "^7.13.0",
+    "zod": "^4.0.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.3.14",
+    "@chromatic-com/storybook": "^5.0.0",
+    "@eslint/js": "^9.39.1",
+    "@storybook/addon-a11y": "^10.2.6",
+    "@storybook/addon-docs": "^10.2.6",
+    "@storybook/addon-onboarding": "^10.2.6",
+    "@storybook/addon-vitest": "^10.2.6",
+    "@storybook/react-vite": "^10.2.6",
+    "@types/node": "^24.10.1",
+    "@types/react": "^19.2.5",
+    "@types/react-dom": "^19.2.3",
+    "@vitejs/plugin-react": "^5.1.1",
+    "@vitest/browser-playwright": "^4.0.18",
+    "@vitest/coverage-v8": "^4.0.18",
+    "autoprefixer": "^10.4.24",
+    "babel-plugin-react-compiler": "^1.0.0",
+    "eslint": "^9.39.1",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "eslint-plugin-react-refresh": "^0.4.24",
+    "glob": "^13.0.1",
+    "globals": "^16.5.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.2.7",
+    "playwright": "^1.58.1",
+    "postcss": "^8.5.6",
+    "storybook": "^10.2.6",
+    "tailwind-merge": "^3.0.1",
+    "tailwindcss": "^3.4.16",
+    "tailwindcss-animate": "^1.0.7",
+    "typescript": "~5.6.2",
+    "typescript-eslint": "^8.46.4",
+    "vite": "^7.2.4",
+    "vite-plugin-dts": "^4.5.0",
+    "vitest": "^4.0.18"
+  }
+}