@bigio/better-auth-electron 1.0.0 → 1.0.1

package/README.md

@@ -2,16 +2,24 @@
 
 > **Work In Progress:** This library is actively being developed. Detailed documentation and architecture diagrams are coming soon.
 
-**A type-safe, IPC-based Better Auth integration for Electron.**
+**A type-safe, IPC-Event based Better Auth integration for Electron.**
 
 Designed for production-grade applications, this library provides a secure, "batteries-included" solution to integrate [Better Auth](https://www.better-auth.com) into Electron apps without the headache of writing manual IPC bridges or handling complex OAuth window flows.
 
 ## Features
 
-- ** Strict Process Isolation:** Zero leakage of server secrets into the Renderer.
-- ** Type-Safe IPC:** Full type inference between Main and Renderer processes.
-- ** React 19 & Preact Compatible:** Solves "Invalid Hook Call" and duplicate instance issues.
-- ** Smart Session Handoff:** Seamlessly transfers authentication states from the web auth flow to the Electron app.
+- ** Native Secure Context & Origin Fix:**
+  Leverages `protocol.registerSchemesAsPrivileged` to treat your custom scheme as a secure context. This solves the infamous `Origin` header mismatch and enables `SameSite` cookies to work natively without hacks.
+
+- ** Secure PKCE Flow:**
+  Implements the standard **Proof Key for Code Exchange** protocol out-of-the-box. Ensures enterprise-grade security for your OAuth exchanges without exposing secrets.
+
+- ** Preact SSR Ready:**
+  Includes a dedicated, lightweight Preact entry point optimized for Server-Side Rendering (SSR) in login windows.
+  _(React 19 supported. Vue/Svelte support coming soon!)_
+
+- ** Zero-IPC Session Handoff:**
+  Uses secure custom protocol deep links to transfer authentication states. Full TypeScript inference via Better Auth plugins — **no fragile IPC bridges** or manual message handling required.
 
 ## Installation
 
@@ -68,8 +76,8 @@ const { windowInjection, whenReadyInjection } = mainInjection({
   PROVIDERS: ['github', 'google'],
   BETTER_AUTH_BASEURL: 'http://localhost:3002',
   FRONTEND_URL: 'http://localhost:3001/oauth',
-  // Use the classic 'onBeforeRequest' filter approach for auth code capture
-  OLD_SCHOOL_ONBEFORE_WAY: true,
+  // Use the classic 'onBeforeRequest' filter approach for auth code capture if true
+  OLD_SCHOOL_ONBEFORE_WAY: false,
 })
 
 function createWindow(): void {
@@ -77,12 +85,12 @@ function createWindow(): void {
     /* config */
   })
 
-  // Inject IPC handlers into the specific window instance
+  // Inject ipcRenderer event into the specific window instance
   windowInjection(mainWindow)
 }
 
 app.whenReady().then(() => {
-  // Register custom protocol schemes and deep link listeners
+  // Register custom protocol schemes
   whenReadyInjection()
   createWindow()
 })
@@ -142,7 +150,31 @@ const ElectronLoginButton = ({ provider }: { provider: string }) => {
 }
 ```
 
-### 5. Web/App Component Usage (`src/web/components/user-session.tsx`)
+### 5. Electron Renderer/Web Client (`src/renderer/lib/auth-client.ts`)
+
+This is the auth client running **inside your Electron app**. It listens for the custom protocol deep link to hydrate the session.
+
+> **Suggestion:** set `credentials: 'include'` to ensure the session cookie generated by the secure protocol is correctly persisted.
+
+```typescript
+import { createAuthClient } from 'better-auth/react'
+import { electronRendererPlugin } from '@bigio/better-auth-electron/renderer'
+
+export const authClient = createAuthClient({
+  baseURL: 'http://localhost:3002',
+  fetchOptions: {
+    // It ensures cookies are sent/received correctly in the custom scheme.
+    credentials: 'include',
+  },
+  plugins: [
+    electronRendererPlugin({
+      ELECTRON_SCHEME: 'bigio', // Must match Main process config
+    }),
+  ],
+})
+```
+
+### 6. Web/App Component Usage (`src/web/components/user-session.tsx`)
 
 The `useElectronOAuthSession` hook is the heart of the "Handoff" experience. It listens for the deep link callback and automatically verifies the session.
 
@@ -151,23 +183,13 @@ import { authClient } from '@/web/client'
 
 export function UserSessionStatus() {
   const {
-    // The validated session data (user, session token)
     data: useSessionData,
-
-    // Any error that occurred during the deep link handoff
     error,
-
-    // True when the initial check or handoff is in progress
     isPending,
-
-    // True when explicitly refetching the session state
     isRefetching,
-
-    // Function to manually re-trigger session validation
     refetch,
-
-    // Real-time status messages from the main process
-    // (e.g., "Verifying ticket...", "Session established")
+    // // The current status of the handoff process on the client side
+    // (e.g., 'idle' | 'succeed' | 'failed')
     oauthMessage
   } = authClient.bigio.useElectronOAuthSession()
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigio/better-auth-electron",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "author": "bigmusic",
   "license": "MIT",
   "private": false,