mulguard 1.1.2 → 1.1.4

package/dist/mulguard.d.ts

@@ -287,4 +287,79 @@ export interface MulguardInstance {
         clearAll(): Promise<void>;
     };
 }
-export declare function mulguard(config: MulguardConfig): MulguardInstance;
+/**
+ * Create Mulguard instance with custom authentication actions
+ *
+ * @example
+ * ```typescript
+ * // lib/auth.ts
+ * import { mulguard } from 'mulguard'
+ *
+ * export const auth = mulguard({
+ *   session: {
+ *     cookieName: '__mulguard_session',
+ *     expiresIn: 60 * 60 * 24 * 7, // 7 days
+ *   },
+ *   actions: {
+ *     signIn: {
+ *       email: async (credentials) => {
+ *         // Your custom sign in logic
+ *         // Connect to your database, validate credentials, etc.
+ *         const user = await yourDb.findUser(credentials.email)
+ *         if (!user || !await verifyPassword(credentials.password, user.password)) {
+ *           return { success: false, error: 'Invalid credentials' }
+ *         }
+ *
+ *         const session = {
+ *           user,
+ *           expiresAt: new Date(Date.now() + 7 * 24 * 60 * 60 * 1000)
+ *         }
+ *
+ *         return { success: true, user, session }
+ *       }
+ *     },
+ *     signUp: async (data) => {
+ *       // Your custom sign up logic
+ *       const user = await yourDb.createUser(data)
+ *       return { success: true, user }
+ *     },
+ *     signOut: async () => {
+ *       // Your custom sign out logic
+ *       await yourDb.invalidateSession()
+ *       return { success: true }
+ *     },
+ *     getSession: async () => {
+ *       // Your custom session retrieval logic
+ *       return await yourDb.getSession()
+ *     }
+ *   }
+ * })
+ * ```
+ */
+/**
+ * Creates a Mulguard authentication instance.
+ *
+ * @template TUser - User type (extends base User)
+ * @template TSession - Session type (extends base Session)
+ * @param config - Mulguard configuration
+ * @returns Mulguard instance
+ *
+ * @example
+ * ```typescript
+ * const auth = mulguard({
+ *   actions: {
+ *     signIn: {
+ *       email: async (credentials) => {
+ *         // Your custom sign in logic
+ *         const user = await db.user.findUnique({ where: { email: credentials.email } })
+ *         if (!user || !await bcrypt.compare(credentials.password, user.password)) {
+ *           return { success: false, error: 'Invalid credentials' }
+ *         }
+ *         return { success: true, user, session: { user, expiresAt: new Date() } }
+ *       }
+ *     }
+ *   }
+ * })
+ * ```
+ */
+export declare function mulguard<TUser extends User = User, TSession extends Session<TUser> = Session<TUser>>(config: MulguardConfig<TUser, TSession>): MulguardInstance;

package/dist/server/helpers.d.ts

@@ -4,7 +4,7 @@ import { MulguardConfig } from '../core/types';
  * Create server-side auth helpers with pre-configured instance
  */
 export declare function createServerHelpers(_auth: MulguardInstance, _config: MulguardConfig): {
-    getSession: () => Promise<import('..').Session | null>;
-    requireAuth: (redirectTo?: string) => Promise<import('..').Session>;
-    requireRole: (role: string, redirectTo?: string) => Promise<import('..').Session>;
+    getSession: () => Promise<import('..').Session<import('..').User> | null>;
+    requireAuth: (redirectTo?: string) => Promise<import('..').Session<import('..').User>>;
+    requireRole: (role: string, redirectTo?: string) => Promise<import('..').Session<import('..').User>>;
 };

package/dist/server/utils.d.ts

@@ -3,8 +3,8 @@ import { MulguardInstance } from '../mulguard';
  * Create server-side helpers with pre-configured auth instance
  */
 export declare function createServerUtils(auth: MulguardInstance): {
-    getSession: () => Promise<import('..').Session | null>;
-    requireAuth: (redirectTo?: string) => Promise<import('..').Session>;
-    requireRole: (role: string, redirectTo?: string) => Promise<import('..').Session>;
+    getSession: () => Promise<import('..').Session<import('..').User> | null>;
+    requireAuth: (redirectTo?: string) => Promise<import('..').Session<import('..').User>>;
+    requireRole: (role: string, redirectTo?: string) => Promise<import('..').Session<import('..').User>>;
     getCurrentUser: () => Promise<import('..').User | null>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mulguard",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "Mulguard is a modern authentication backend-first library for Next.js",
   "main": "./dist/index/index.js",
   "module": "./dist/index/index.mjs",