@lalternative/auth 0.9.5 → 0.10.0

package/dist/{types-B7Ranu_a.d.ts → types-BbTfkT5F.d.ts}

@@ -41,7 +41,7 @@ interface PlatformSession {
     user: PlatformUser;
     session: PlatformSessionData;
 }
-type PlatformAuthMailerType = "email-verification" | "forget-password" | "sign-in" | "change-email";
+type PlatformAuthMailerType = "email-verification" | "forget-password" | "sign-in" | "change-email" | "magic-link";
 interface PlatformAuthMailerArgs {
     /** Recipient address */
     to: string;
@@ -51,10 +51,37 @@ interface PlatformAuthMailerArgs {
     html: string;
     /** Better Auth verification kind */
     type: PlatformAuthMailerType;
-    /** The OTP value, in case the consumer wants to render its own template */
-    otp: string;
+    /**
+     * The OTP value, in case the consumer wants to render its own template.
+     * Absent on `magic-link`, which carries a URL rather than a code.
+     */
+    otp?: string;
+    /**
+     * The sign-in URL, on `magic-link` only. Already signed and pointed at the
+     * app's callback — send it as given.
+     */
+    url?: string;
 }
 type PlatformAuthMailer = (args: PlatformAuthMailerArgs) => Promise<void>;
+interface MagicLinkConfig {
+    /** Seconds until the emailed link stops working. Defaults to 300 (5 min). */
+    expiresIn?: number;
+    /**
+     * Whether an unknown address may create an account by following the link.
+     * Off by default, and deliberately so: `createPlatformAuth` requires a
+     * verified email and can be put behind an invite-only beta, both of which a
+     * self-signing-up magic link would walk straight past. Turn it on only for
+     * an app whose sign-up is open anyway.
+     */
+    allowSignUp?: boolean;
+    /** Subject line. Defaults to `Your sign-in link - ${appName}`. */
+    subject?: string;
+    /**
+     * Override the email HTML renderer. Receives the signed sign-in URL and the
+     * recipient. When omitted, the platform's default template is used.
+     */
+    render?: (url: string, email: string) => string;
+}
 interface PlatformAuthConfig {
     /** PostgreSQL connection pool or connection string */
     database: BetterAuthOptions["database"];
@@ -93,6 +120,12 @@ interface PlatformAuthConfig {
      * default branded template is used.
      */
     renderOtpEmail?: (otp: string, type: PlatformAuthMailerType) => string;
+    /**
+     * Passwordless sign-in by emailed link. Omit to leave it off — the endpoint
+     * is only mounted when this is given, so an app that does not render the
+     * form does not expose the route either.
+     */
+    magicLink?: MagicLinkConfig;
     /**
      * Better Auth database hooks, passed through unchanged.
      *
@@ -271,6 +304,21 @@ interface AuthClientSurface {
         }): Promise<AuthClientResult>;
     };
 }
+/**
+ * The magic-link half of the client surface, kept apart from
+ * {@link AuthClientSurface}: the plugin is opt-in server-side, so only the
+ * screens that offer the flow require a client carrying it.
+ */
+interface MagicLinkClientSurface {
+    signIn: {
+        magicLink(input: {
+            email: string;
+            callbackURL?: string;
+            newUserCallbackURL?: string;
+            errorCallbackURL?: string;
+        }): Promise<AuthClientResult>;
+    };
+}
 interface AuthThemeProps {
     /** Replaces the submit button's `bg-primary text-primary-foreground` */
     submitClassName?: string;
@@ -395,6 +443,38 @@ interface ForgotPasswordFormProps extends AuthThemeProps, AuthNavProps {
     /** Auth client instance, e.g. from createPlatformAuthClient */
     authClient: AuthClientSurface;
 }
+interface MagicLinkFormLabels {
+    title?: string;
+    subtitle?: string;
+    emailPlaceholder?: string;
+    submit?: string;
+    submitPending?: string;
+    sent?: string;
+    resend?: string;
+    usePassword?: string;
+    login?: string;
+    emailRequired?: string;
+    sendFailed?: string;
+}
+interface MagicLinkFormProps extends AuthThemeProps, AuthNavProps, AuthInviteProps {
+    /** Callback once the link is on its way, receives the address it went to */
+    onSuccess?: (email: string) => void;
+    /** Error raised outside the form, rendered in the same banner */
+    error?: string;
+    /** Link to the password sign-in page */
+    loginUrl?: string;
+    /** Where Better Auth sends the browser once the link is followed */
+    callbackUrl?: string;
+    /**
+     * Where an existing account lands, when a first-time visitor should land
+     * elsewhere — an onboarding step, say. Defaults to `callbackUrl`.
+     */
+    newUserCallbackUrl?: string;
+    /** Copy overrides; anything omitted keeps the French default */
+    labels?: MagicLinkFormLabels;
+    /** Auth client instance, e.g. from createPlatformAuthClient */
+    authClient: MagicLinkClientSurface;
+}
 interface ResetPasswordFormLabels {
     title?: string;
     subtitle?: string;
@@ -450,4 +530,4 @@ interface AuthLayoutProps extends AuthHeadingProps {
     footer?: React.ReactNode;
 }
 
-export type { AuthLayoutProps as A, ForgotPasswordFormProps as F, InvitationNoticeProps as I, LoginFormProps as L, PlatformAuthClientConfig as P, RegisterFormProps as R, VerifyEmailFormProps as V, ResetPasswordFormProps as a, AuthClientResult as b, LinkComponent as c, AuthClientSurface as d, AuthInviteProps as e, AuthNavProps as f, AuthThemeProps as g, InvitationFailure as h, LoginFormLabels as i, PlatformAuthConfig as j, PlatformAuthMailer as k, PlatformAuthMailerArgs as l, PlatformAuthMailerType as m, PlatformSession as n, PlatformSessionData as o, PlatformUser as p, RegisterFormLabels as q };
+export type { AuthLayoutProps as A, ForgotPasswordFormProps as F, InvitationNoticeProps as I, LoginFormProps as L, MagicLinkFormProps as M, PlatformAuthClientConfig as P, RegisterFormProps as R, VerifyEmailFormProps as V, ResetPasswordFormProps as a, AuthClientResult as b, LinkComponent as c, AuthClientSurface as d, AuthInviteProps as e, AuthNavProps as f, AuthThemeProps as g, InvitationFailure as h, LoginFormLabels as i, MagicLinkClientSurface as j, MagicLinkConfig as k, MagicLinkFormLabels as l, PlatformAuthConfig as m, PlatformAuthMailer as n, PlatformAuthMailerArgs as o, PlatformAuthMailerType as p, PlatformSession as q, PlatformSessionData as r, PlatformUser as s, RegisterFormLabels as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lalternative/auth",
-  "version": "0.9.5",
+  "version": "0.10.0",
   "description": "Shared Better Auth wrapper for L'Alternative apps (server + React client + auth UI)",
   "type": "module",
   "main": "./dist/index.js",
@@ -22,6 +22,14 @@
   "files": [
     "dist"
   ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "pnpm build",
+    "test": "node --experimental-strip-types --test \"src/**/*.test.ts\"",
+    "playground": "vite --config playground/vite.config.ts"
+  },
   "peerDependencies": {
     "better-auth": ">=1.4.0",
     "react": ">=18.0.0",
@@ -49,12 +57,5 @@
     "type": "git",
     "url": "https://github.com/lalternative/packages.git",
     "directory": "auth"
-  },
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "typecheck": "tsc --noEmit",
-    "test": "node --experimental-strip-types --test \"src/**/*.test.ts\"",
-    "playground": "vite --config playground/vite.config.ts"
   }
-}
+}