@main12/auth-login 0.1.0 → 0.1.2

package/README.md

@@ -1,218 +1,254 @@
-# Payload Plugin Template
+# @main12/auth-login
 
-A template repo to create a [Payload CMS](https://payloadcms.com) plugin.
+**Payload CMS authentication plugin** — login, signup, OTP, forgot password, branded emails, and "Powered by Main 12" footer. Install once, configure your project name and logo, done.
 
-Payload is built with a robust infrastructure intended to support Plugins with ease. This provides a simple, modular, and reusable way for developers to extend the core capabilities of Payload.
-
-To build your own Payload plugin, all you need is:
+```ts
+// payload.config.ts
+import { authLoginPlugin } from '@main12/auth-login'
 
-- An understanding of the basic Payload concepts
-- And some JavaScript/Typescript experience
+plugins: [
+  authLoginPlugin({
+    projectName: 'My SaaS',
+    domain: 'https://myapp.com',
+    style: 'hero-ui',        // 'tailwind' (default) | 'hero-ui'
+  }),
+]
+```
 
-## Background
+---
 
-Here is a short recap on how to integrate plugins with Payload, to learn more visit the [plugin overview page](https://payloadcms.com/docs/plugins/overview).
+## Features
 
-### How to install a plugin
+- **5 auth pages** — login (multi-step), signup, forgot password, verify OTP, set password
+- **Multi-style** — `tailwind` (zero UI deps) or `hero-ui` (HeroUI + framer-motion). Set once in config
+- **5 API endpoints** — `check-email`, `otp/send`, `otp/verify`, `set-password`, `signup`
+- **OTP engine** — SHA-256 hashing + `timingSafeEqual` comparison, 10-min expiry, 3 attempts
+- **Email templates** — welcome, OTP login, password reset, password changed (EN/ES)
+- **Powered by Main 12** — bundled inline SVG, linked to main12.com by default
+- **Zero runtime deps** (Tailwind mode) — Next.js + React are peer dependencies
 
-To install any plugin, simply add it to your payload.config() in the Plugin array.
+---
 
-```ts
-import myPlugin from 'my-plugin'
+## Installation
 
-export const config = buildConfig({
-  plugins: [
-    // You can pass options to the plugin
-    myPlugin({
-      enabled: true,
-    }),
-  ],
-})
+```bash
+pnpm add @main12/auth-login
 ```
 
-### Initialization
-
-The initialization process goes in the following order:
+### Tailwind mode (default, zero UI deps)
 
-1. Incoming config is validated
-2. **Plugins execute**
-3. Default options are integrated
-4. Sanitization cleans and validates data
-5. Final config gets initialized
+No extra dependencies needed.
 
-## Building the Plugin
+### HeroUI mode
 
-When you build a plugin, you are purely building a feature for your project and then abstracting it outside of the project.
+```bash
+pnpm add @heroui/react framer-motion @iconify/react
+```
 
-### Template Files
+---
 
-In the Payload [plugin template](https://github.com/payloadcms/payload/tree/main/templates/plugin), you will see a common file structure that is used across all plugins:
+## Quick Start
 
-1. root folder
-2. /src folder
-3. /dev folder
+### 1. Add the plugin to your Payload config
 
-#### Root
+```ts
+import { authLoginPlugin } from '@main12/auth-login'
 
-In the root folder, you will see various files that relate to the configuration of the plugin. We set up our environment in a similar manner in Payload core and across other projects, so hopefully these will look familiar:
+export default buildConfig({
+  plugins: [
+    authLoginPlugin({
+      projectName: 'My App',
+      domain: 'https://myapp.com',
+      contactEmail: 'support@myapp.com',
+      style: 'tailwind',   // or 'hero-ui'
+    }),
+  ],
+  // ... rest of your config
+})
+```
 
-- **README**.md\* - This contains instructions on how to use the template. When you are ready, update this to contain instructions on how to use your Plugin.
-- **package**.json\* - Contains necessary scripts and dependencies. Overwrite the metadata in this file to describe your Plugin.
-- .**eslint**.config.js - Eslint configuration for reporting on problematic patterns.
-- .**gitignore** - List specific untracked files to omit from Git.
-- .**prettierrc**.json - Configuration for Prettier code formatting.
-- **tsconfig**.json - Configures the compiler options for TypeScript
-- .**swcrc** - Configuration for SWC, a fast compiler that transpiles and bundles TypeScript.
-- **vitest**.config.js - Config file for Vitest, defining how tests are run and how modules are resolved
+### 2. Add auth pages to your app
 
-**IMPORTANT\***: You will need to modify these files.
+Create one-line route files under `src/app/(frontend)/(auth)/`:
 
-#### Dev
+```tsx
+// login/page.tsx
+export { LoginPage as default } from '@main12/auth-login/client'
 
-In the dev folder, you’ll find a basic payload project, created with `npx create-payload-app` and the blank template.
+// signup/page.tsx
+export { SignupPage as default } from '@main12/auth-login/client'
 
-**IMPORTANT**: Make a copy of the `.env.example` file and rename it to `.env`. Update the `DATABASE_URL` to match the database you are using and your plugin name. Update `PAYLOAD_SECRET` to a unique string.
-**You will not be able to run `pnpm/yarn dev` until you have created this `.env` file.**
+// forgot-password/page.tsx
+export { ForgotPasswordPage as default } from '@main12/auth-login/client'
 
-`myPlugin` has already been added to the `payload.config()` file in this project.
+// verify-otp/page.tsx
+export { VerifyOtpPage as default } from '@main12/auth-login/client'
 
-```ts
-plugins: [
-  myPlugin({
-    collections: {
-      posts: true,
-    },
-  }),
-]
+// set-password/page.tsx
+export { SetPasswordPage as default } from '@main12/auth-login/client'
 ```
 
-Later when you rename the plugin or add additional options, **make sure to update it here**.
+### 3. Wire up the login action
+
+The plugin needs a `login` function. Pass yours from Payload's `useAuth()`:
+
+```tsx
+// login/page.tsx
+'use client'
+import { LoginPage } from '@main12/auth-login/client'
+import { useAuth } from '@/providers/Auth'
+import AppLogo from '@/components/Logo/AppLogo'
+
+export default function Page() {
+  const { login } = useAuth()
+  return (
+    <LoginPage
+      logo={<AppLogo width={180} height={42} />}
+      onPasswordLogin={login}
+      redirectTo="/dashboard"
+      poweredBy={{ enabled: true }}
+    />
+  )
+}
+```
 
-You may wish to add collections or expand the test project depending on the purpose of your plugin. Just make sure to keep this dev environment as simplified as possible - users should be able to install your plugin without additional configuration required.
+---
 
-When you’re ready to start development, initiate the project with `pnpm/npm/yarn dev` and pull up [http://localhost:3000](http://localhost:3000) in your browser.
+## Configuration Options
 
-#### Src
+```ts
+authLoginPlugin({
+  // === Branding ===
+  projectName: 'My App',          // Used in email subjects and footers
+  contactEmail: 'hi@myapp.com',   // Email footer contact
+  domain: 'https://myapp.com',    // Links in emails
 
-Now that we have our environment setup and we have a dev project ready to - it’s time to build the plugin!
+  // === Style ===
+  style: 'tailwind',              // 'tailwind' | 'hero-ui'
 
-**index.ts**
+  // === Enable/Disable ===
+  enabled: true,                  // Set false to disable the plugin
+})
+```
 
-The essence of a Payload plugin is simply to extend the payload config - and that is exactly what we are doing in this file.
+Each page component also accepts these props:
 
 ```ts
-export const myPlugin =
-  (pluginOptions: MyPluginConfig) =>
-  (config: Config): Config => {
-    // do cool stuff with the config here
-
-    return config
-  }
+<LoginPage
+  logo={...}                    // React node — your brand logo
+  onPasswordLogin={login}       // Required — Payload's login function
+  redirectTo="/dashboard"       // Where to go after login
+  showGoogleOAuth={true}        // Show "Continue with Google" button
+  signupUrl="/signup"           // Link to signup page
+  poweredBy={{                  // Powered by logo config
+    enabled: true,
+    logoUrl: '/custom-logo.png',  // Override the default Main12 logo
+    linkUrl: 'https://your-site.com',
+    width: 28,
+    height: 28,
+  }}
+/>
 ```
 
-First, we receive the existing payload config along with any plugin options.
-
-From here, you can extend the config as you wish.
+---
 
-Finally, you return the config and that is it!
+## Using Hooks & Services Directly
 
-##### Spread Syntax
+Don't want the pre-built pages? Use the hooks and services to build your own:
 
-Spread syntax (or the spread operator) is a feature in JavaScript that uses the dot notation **(...)** to spread elements from arrays, strings, or objects into various contexts.
+```tsx
+import { useLoginFlow, useVerifyOtpFlow, checkEmail, sendOtp } from '@main12/auth-login/client'
 
-We are going to use spread syntax to allow us to add data to existing arrays without losing the existing data. It is crucial to spread the existing data correctly – else this can cause adverse behavior and conflicts with Payload config and other plugins.
-
-Let’s say you want to build a plugin that adds a new collection:
-
-```ts
-config.collections = [
-  ...(config.collections || []),
-  // Add additional collections here
-]
+function MyCustomLogin() {
+  const { email, handleEmailSubmit, ... } = useLoginFlow({
+    redirectTo: '/dashboard',
+    onPasswordLogin: login,
+  })
+  // Build your own UI with these values
+}
 ```
 
-First we spread the `config.collections` to ensure that we don’t lose the existing collections, then you can add any additional collections just as you would in a regular payload config.
+### Exported Hooks
 
-This same logic is applied to other properties like admin, hooks, globals:
+| Hook | Purpose |
+|------|---------|
+| `useLoginFlow` | Multi-step login state machine (email → password/OTP) |
+| `useVerifyOtpFlow` | OTP input, verify, resend with cooldown |
+| `useForgotPasswordFlow` | Email → check → send OTP |
+| `useSetPasswordFlow` | Set password with strength indicator |
 
-```ts
-config.globals = [
-  ...(config.globals || []),
-  // Add additional globals here
-]
+### Exported Services
 
-config.hooks = {
-  ...(incomingConfig.hooks || {}),
-  // Add additional hooks here
-}
-```
+| Function | Description |
+|----------|-------------|
+| `checkEmail(email)` | Check if user exists and has password |
+| `sendOtp(email, purpose)` | Send OTP to email |
+| `verifyOtp(email, otp)` | Verify OTP code |
+| `setUserPassword(password, confirm)` | Set/update password |
+| `signup(name, email)` | Create new user |
+| `initiateGoogleLogin(redirect)` | Redirect to Google OAuth |
 
-Some properties will be slightly different to extend, for instance the onInit property:
+---
 
-```ts
-import { onInitExtension } from './onInitExtension' // example file
+## API Endpoints
 
-config.onInit = async (payload) => {
-  if (incomingConfig.onInit) await incomingConfig.onInit(payload)
-  // Add additional onInit code by defining an onInitExtension function
-  onInitExtension(pluginOptions, payload)
-}
-```
+Registered automatically by the plugin:
 
-If you wish to add to the onInit, you must include the **async/await**. We don’t use spread syntax in this case, instead you must await the existing `onInit` before running additional functionality.
+| Method | Path | Description |
+|--------|------|-------------|
+| POST | `/api/auth/check-email` | Check if email is registered |
+| POST | `/api/auth/otp/send` | Generate + send OTP |
+| POST | `/api/auth/otp/verify` | Verify OTP + login |
+| POST | `/api/auth/set-password` | Set/update password |
+| POST | `/api/auth/signup` | Create account |
 
-In the template, we have stubbed out some addition `onInit` actions that seeds in a document to the `plugin-collection`, you can use this as a base point to add more actions - and if not needed, feel free to delete it.
+---
 
-##### Types.ts
+## Email Templates
 
-If your plugin has options, you should define and provide types for these options.
+Four HTML email templates in EN/ES, using the host project's Payload email adapter:
 
-```ts
-export type MyPluginConfig = {
-  /**
-   * List of collections to add a custom field
-   */
-  collections?: Partial<Record<CollectionSlug, true>>
-  /**
-   * Disable the plugin
-   */
-  disabled?: boolean
-}
-```
+- **Welcome** — sent on signup
+- **OTP** — 6-digit code for login or password reset
+- **Password Reset** — OTP email for forgot password flow
+- **Password Changed** — confirmation after password update
 
-If possible, include JSDoc comments to describe the options and their types. This allows a developer to see details about the options in their editor.
+Override translations or template functions via the `emails` option (Phase 2).
 
-##### Testing
+---
 
-Having a test suite for your plugin is essential to ensure quality and stability. **Vitest** is a fast, modern testing framework that works seamlessly with Vite and supports TypeScript out of the box.
+## Dev Testing
 
-Vitest organizes tests into test suites and cases, similar to other testing frameworks. We recommend creating individual tests based on the expected behavior of your plugin from start to finish.
+This repo ships with a dev harness. To test locally:
 
-Writing tests with Vitest is very straightforward, and you can learn more about how it works in the [Vitest documentation.](https://vitest.dev/)
+```bash
+cd auth-login-plugin
+pnpm install
+pnpm dev
+```
 
-For this template, we stubbed out `int.spec.ts` in the `dev` folder where you can write your tests.
+Visits:
+- `http://localhost:3000/login` — multi-step login
+- `http://localhost:3000/signup` — create account
+- `http://localhost:3000/forgot-password` — password reset
+- `http://localhost:3000/admin` — Payload admin panel
 
-```ts
-describe('Plugin tests', () => {
-  // Create tests to ensure expected behavior from the plugin
-  it('some condition that must be met', () => {
-   // Write your test logic here
-   expect(...)
-  })
-})
-```
+The dev config uses SQLite (no external DB needed) with a Users collection pre-configured.
+
+---
 
-## Best practices
+## Requirements
 
-With this tutorial and the plugin template, you should have everything you need to start building your own plugin.
-In addition to the setup, here are other best practices aim we follow:
+| Dependency | Version | Required |
+|------------|---------|----------|
+| Payload CMS | `^3.82.0` | ✅ |
+| Next.js | `^16.0.0` | ✅ |
+| React | `^19.0.0` | ✅ |
+| HeroUI | `^2.x` | Only for `style: 'hero-ui'` |
+| Framer Motion | `^12.x` | Only for `style: 'hero-ui'` |
 
-- **Providing an enable / disable option:** For a better user experience, provide a way to disable the plugin without uninstalling it. This is especially important if your plugin adds additional webpack aliases, this will allow you to still let the webpack run to prevent errors.
-- **Include tests in your GitHub CI workflow**: If you’ve configured tests for your package, integrate them into your workflow to run the tests each time you commit to the plugin repository. Learn more about [how to configure tests into your GitHub CI workflow.](https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs)
-- **Publish your finished plugin to NPM**: The best way to share and allow others to use your plugin once it is complete is to publish an NPM package. This process is straightforward and well documented, find out more [creating and publishing a NPM package here.](https://docs.npmjs.com/creating-and-publishing-scoped-public-packages/).
-- **Add payload-plugin topic tag**: Apply the tag **payload-plugin **to your GitHub repository. This will boost the visibility of your plugin and ensure it gets listed with [existing payload plugins](https://github.com/topics/payload-plugin).
-- **Use [Semantic Versioning](https://semver.org/) (SemVar)** - With the SemVar system you release version numbers that reflect the nature of changes (major, minor, patch). Ensure all major versions reference their Payload compatibility.
+---
 
-# Questions
+## License
 
-Please contact [Payload](mailto:dev@payloadcms.com) with any questions about using this plugin template.
+MIT © Main 12

package/dist/components/pages/ForgotPasswordPage.d.ts

@@ -2,4 +2,4 @@ import type { AuthLayoutConfig } from '../AuthLayout.js';
 export interface ForgotPasswordPageProps extends AuthLayoutConfig {
     loginUrl?: string;
 }
-export default function ForgotPasswordPage({ loginUrl, logo, poweredBy, cardClassName, backgroundClass, }: ForgotPasswordPageProps): import("react/jsx-runtime").JSX.Element;
+export default function ForgotPasswordPage(props: ForgotPasswordPageProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/pages/ForgotPasswordPage.js

@@ -1,45 +1,12 @@
 'use client';
-import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-import React from 'react';
-import { Button, Input } from '../ui/index.js';
-import { useForgotPasswordFlow } from '../../auth/application/hooks/useForgotPasswordFlow.js';
-import { AuthLayout } from '../AuthLayout.js';
-export default function ForgotPasswordPage({ loginUrl = '/login', logo, poweredBy, cardClassName, backgroundClass }) {
-    const { email, error, isLoading, setEmail, handleSubmit } = useForgotPasswordFlow();
-    return /*#__PURE__*/ _jsx(AuthLayout, {
-        logo: logo,
-        title: "Forgot Password",
-        subtitle: "Enter your email and we'll send you a reset code",
-        poweredBy: poweredBy,
-        cardClassName: cardClassName,
-        backgroundClass: backgroundClass,
-        footer: /*#__PURE__*/ _jsx("a", {
-            href: loginUrl,
-            className: "text-sm text-gray-600 hover:text-gray-900 inline-flex items-center gap-1",
-            children: "← Back to Login"
-        }),
-        children: /*#__PURE__*/ _jsxs("form", {
-            onSubmit: handleSubmit,
-            className: "space-y-4",
-            children: [
-                error && /*#__PURE__*/ _jsx("div", {
-                    className: "bg-red-50 text-red-600 border border-red-200 rounded-lg p-3 text-sm animate-[fadeIn_0.2s_ease-out]",
-                    children: error
-                }),
-                /*#__PURE__*/ _jsx(Input, {
-                    type: "email",
-                    label: "Email",
-                    value: email,
-                    onChange: (e)=>setEmail(e.target.value),
-                    isRequired: true
-                }),
-                /*#__PURE__*/ _jsx(Button, {
-                    type: "submit",
-                    variant: "primary",
-                    isLoading: isLoading,
-                    children: "Send Reset Code"
-                })
-            ]
-        })
+import { jsx as _jsx } from "react/jsx-runtime";
+import { pluginConfig } from '../../config.js';
+import ForgotPasswordPageTailwind from './ForgotPasswordPageTailwind.js';
+import ForgotPasswordPageHero from './ForgotPasswordPageHero.js';
+export default function ForgotPasswordPage(props) {
+    return pluginConfig.style === 'hero-ui' ? /*#__PURE__*/ _jsx(ForgotPasswordPageHero, {
+        ...props
+    }) : /*#__PURE__*/ _jsx(ForgotPasswordPageTailwind, {
+        ...props
     });
 }

package/dist/components/pages/ForgotPasswordPageHero.d.ts

@@ -0,0 +1,5 @@
+import type { AuthLayoutConfig } from '../AuthLayout.js';
+export interface ForgotPasswordPageHeroProps extends AuthLayoutConfig {
+    loginUrl?: string;
+}
+export default function ForgotPasswordPageHero({ loginUrl, logo, poweredBy, cardClassName, backgroundClass }: ForgotPasswordPageHeroProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/pages/ForgotPasswordPageHero.js

@@ -0,0 +1,69 @@
+'use client';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import React from 'react';
+import { Button, Input } from '@heroui/react';
+import { Icon } from '@iconify/react';
+import { motion } from 'framer-motion';
+import { useForgotPasswordFlow } from '../../auth/application/hooks/useForgotPasswordFlow.js';
+import { AuthLayout } from '../AuthLayout.js';
+export default function ForgotPasswordPageHero({ loginUrl = '/login', logo, poweredBy, cardClassName, backgroundClass }) {
+    const { email, error, isLoading, setEmail, handleSubmit } = useForgotPasswordFlow();
+    return /*#__PURE__*/ _jsx(AuthLayout, {
+        logo: logo,
+        title: "Forgot Password",
+        subtitle: "Enter your email and we'll send you a reset code",
+        poweredBy: poweredBy,
+        cardClassName: cardClassName,
+        backgroundClass: backgroundClass,
+        footer: /*#__PURE__*/ _jsxs("a", {
+            href: loginUrl,
+            className: "text-sm text-gray-600 hover:text-gray-900 inline-flex items-center gap-1",
+            children: [
+                /*#__PURE__*/ _jsx(Icon, {
+                    icon: "lucide:arrow-left",
+                    width: 16
+                }),
+                "Back to Login"
+            ]
+        }),
+        children: /*#__PURE__*/ _jsxs("form", {
+            onSubmit: handleSubmit,
+            className: "space-y-4",
+            children: [
+                error && /*#__PURE__*/ _jsx(motion.div, {
+                    className: "bg-red-50 text-red-600 border border-red-200 rounded-lg p-3 text-sm",
+                    initial: {
+                        opacity: 0
+                    },
+                    animate: {
+                        opacity: 1
+                    },
+                    children: error
+                }),
+                /*#__PURE__*/ _jsx(Input, {
+                    type: "email",
+                    label: "Email",
+                    value: email,
+                    onChange: (e)=>setEmail(e.target.value),
+                    variant: "bordered",
+                    size: "lg",
+                    isRequired: true,
+                    classNames: {
+                        input: 'text-gray-900',
+                        label: 'text-gray-600',
+                        inputWrapper: 'border-gray-300 bg-white'
+                    }
+                }),
+                /*#__PURE__*/ _jsx(Button, {
+                    type: "submit",
+                    fullWidth: true,
+                    size: "lg",
+                    color: "primary",
+                    isLoading: isLoading,
+                    className: "h-12 font-semibold",
+                    children: "Send Reset Code"
+                })
+            ]
+        })
+    });
+}

package/dist/components/pages/ForgotPasswordPageTailwind.d.ts

@@ -0,0 +1,5 @@
+import type { AuthLayoutConfig } from '../AuthLayout.js';
+export interface ForgotPasswordPageProps extends AuthLayoutConfig {
+    loginUrl?: string;
+}
+export default function ForgotPasswordPage({ loginUrl, logo, poweredBy, cardClassName, backgroundClass, }: ForgotPasswordPageProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/pages/ForgotPasswordPageTailwind.js

@@ -0,0 +1,45 @@
+'use client';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import React from 'react';
+import { Button, Input } from '../ui/index.js';
+import { useForgotPasswordFlow } from '../../auth/application/hooks/useForgotPasswordFlow.js';
+import { AuthLayout } from '../AuthLayout.js';
+export default function ForgotPasswordPage({ loginUrl = '/login', logo, poweredBy, cardClassName, backgroundClass }) {
+    const { email, error, isLoading, setEmail, handleSubmit } = useForgotPasswordFlow();
+    return /*#__PURE__*/ _jsx(AuthLayout, {
+        logo: logo,
+        title: "Forgot Password",
+        subtitle: "Enter your email and we'll send you a reset code",
+        poweredBy: poweredBy,
+        cardClassName: cardClassName,
+        backgroundClass: backgroundClass,
+        footer: /*#__PURE__*/ _jsx("a", {
+            href: loginUrl,
+            className: "text-sm text-gray-600 hover:text-gray-900 inline-flex items-center gap-1",
+            children: "← Back to Login"
+        }),
+        children: /*#__PURE__*/ _jsxs("form", {
+            onSubmit: handleSubmit,
+            className: "space-y-4",
+            children: [
+                error && /*#__PURE__*/ _jsx("div", {
+                    className: "bg-red-50 text-red-600 border border-red-200 rounded-lg p-3 text-sm animate-[fadeIn_0.2s_ease-out]",
+                    children: error
+                }),
+                /*#__PURE__*/ _jsx(Input, {
+                    type: "email",
+                    label: "Email",
+                    value: email,
+                    onChange: (e)=>setEmail(e.target.value),
+                    isRequired: true
+                }),
+                /*#__PURE__*/ _jsx(Button, {
+                    type: "submit",
+                    variant: "primary",
+                    isLoading: isLoading,
+                    children: "Send Reset Code"
+                })
+            ]
+        })
+    });
+}