@metagptx/web-sdk 0.0.7 → 0.0.8

package/README.md

@@ -39,6 +39,64 @@ The SDK provides four main modules:
 
 Handles user authentication and session management.
 
+#### Authentication Callback Setup
+
+When using this SDK, your project needs to implement an `/auth/callback` route and page. This callback page is used to handle the authentication flow after a successful login.
+
+**Required Setup:**
+
+1. Create an `/auth/callback` route in your application
+2. In the callback page, read the `token` parameter from the URL query string
+3. Call `client.auth.login()` to save the token to localStorage
+
+**Example Implementation:**
+
+```tsx
+// In your /auth/callback page component
+import { useEffect } from 'react';
+
+function AuthCallbackPage() {
+  useEffect(() => {
+    // This will automatically read the token from URL query string
+    // and save it to localStorage
+    client.auth.login().then((token) => {
+      if (token) {
+        // Token saved successfully, redirect to your app
+        window.location.href = '/dashboard'; // or your desired route
+      } else {
+        // No token found, handle error
+        console.error('No token found in URL');
+      }
+    });
+  }, []);
+
+  return <div>Processing authentication...</div>;
+}
+```
+
+**How it works:**
+- After successful authentication, the user will be redirected to `/auth/callback?token=xxx`
+- The `auth.login()` method reads the token from the URL and stores it in localStorage
+- Once the token is saved, redirect the user to your application
+
+#### `auth.login()`
+
+Read the token from the URL query string and save it to localStorage.
+
+**HTTP Details:**
+- **Method:** Client-side only (no HTTP request)
+- **Parameters:** None (automatically reads `token` from URL query string)
+
+**Returns:** The token value if found, or null if not found.
+
+**Example:**
+```typescript
+const token = await client.auth.login();
+if (token) {
+  console.log('Token saved to localStorage');
+}
+```
+
 #### `auth.me()`
 
 Get current user information.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@metagptx/web-sdk",
   "type": "module",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "packageManager": "pnpm@10.15.0+sha512.486ebc259d3e999a4e8691ce03b5cac4a71cbeca39372a9b762cb500cfdf0873e2cb16abe3d951b1ee2cf012503f027b98b6584e4df22524e0c7450d9ec7aa7b",
   "description": "TypeScript SDK for interacting with FuncSea API",
   "author": "MetaGPTX",