@mastra/client-js 1.2.0 → 1.2.1-alpha.0

package/dist/docs/{server/05-firebase.md → references/docs-server-auth-firebase.md}

@@ -1,5 +1,3 @@
-> Documentation for the MastraAuthFirebase class, which authenticates Mastra applications using Firebase Authentication.
-
 # MastraAuthFirebase Class
 
 The `MastraAuthFirebase` class provides authentication for Mastra using Firebase Authentication. It verifies incoming requests using Firebase ID tokens and integrates with the Mastra server using the `auth` option.
@@ -13,16 +11,14 @@ This example uses Firebase Authentication. Make sure to:
 3. Generate a service account key from Project Settings > Service Accounts
 4. Download the service account JSON file
 
-```env title=".env"
+```env
 FIREBASE_SERVICE_ACCOUNT=/path/to/your/service-account-key.json
 FIRESTORE_DATABASE_ID=(default)
 # Alternative environment variable names:
 # FIREBASE_DATABASE_ID=(default)
 ```
 
-> **Note:**
-
-Store your service account JSON file securely and never commit it to version control.
+> **Note:** Store your service account JSON file securely and never commit it to version control.
 
 ## Installation
 
@@ -38,7 +34,7 @@ npm install @mastra/auth-firebase@latest
 
 If you set the required environment variables (`FIREBASE_SERVICE_ACCOUNT` and `FIRESTORE_DATABASE_ID`), you can initialize `MastraAuthFirebase` without any constructor arguments. The class will automatically read these environment variables as configuration:
 
-```typescript {2,7} title="src/mastra/index.ts"
+```typescript
 import { Mastra } from "@mastra/core";
 import { MastraAuthFirebase } from "@mastra/auth-firebase";
 
@@ -52,7 +48,7 @@ export const mastra = new Mastra({
 
 ### Custom configuration
 
-```typescript {2,6-9} title="src/mastra/index.ts"
+```typescript
 import { Mastra } from "@mastra/core";
 import { MastraAuthFirebase } from "@mastra/auth-firebase";
 
@@ -75,15 +71,13 @@ The `MastraAuthFirebase` class can be configured through constructor options or
 - `FIREBASE_SERVICE_ACCOUNT`: Path to Firebase service account JSON file
 - `FIRESTORE_DATABASE_ID` or `FIREBASE_DATABASE_ID`: Firestore database ID
 
-> **Note:**
-
-When constructor options are not provided, the class automatically reads these environment variables. This means you can simply call `new MastraAuthFirebase()` without any arguments if your environment variables are properly configured.
+> **Note:** When constructor options are not provided, the class automatically reads these environment variables. This means you can simply call `new MastraAuthFirebase()` without any arguments if your environment variables are properly configured.
 
 ### User Authorization
 
 By default, `MastraAuthFirebase` uses Firestore to manage user access. It expects a collection named `user_access` with documents keyed by user UIDs. The presence of a document in this collection determines whether a user is authorized.
 
-```typescript title="firestore-structure.txt"
+```typescript
 user_access/
   {user_uid_1}/     // Document exists = user authorized
   {user_uid_2}/     // Document exists = user authorized
@@ -91,7 +85,7 @@ user_access/
 
 To customize user authorization, provide a custom `authorizeUser` function:
 
-```typescript title="src/mastra/auth.ts"
+```typescript
 import { MastraAuthFirebase } from "@mastra/auth-firebase";
 
 const firebaseAuth = new MastraAuthFirebase({
@@ -102,9 +96,7 @@ const firebaseAuth = new MastraAuthFirebase({
 });
 ```
 
-> **Note:**
-
-Visit [MastraAuthFirebase](https://mastra.ai/reference/auth/firebase) for all available configuration options.
+> **Info:** Visit [MastraAuthFirebase](https://mastra.ai/reference/auth/firebase) for all available configuration options.
 
 ## Client-side setup
 
@@ -114,7 +106,7 @@ When using Firebase auth, you'll need to initialize Firebase on the client side,
 
 First, initialize Firebase in your client application:
 
-```typescript title="lib/firebase.ts"
+```typescript
 import { initializeApp } from "firebase/app";
 import { getAuth, GoogleAuthProvider } from "firebase/auth";
 
@@ -133,7 +125,7 @@ export const googleProvider = new GoogleAuthProvider();
 
 Use Firebase authentication to sign in users and retrieve their ID tokens:
 
-```typescript title="lib/auth.ts"
+```typescript
 import { signInWithPopup, signOut, User } from "firebase/auth";
 import { auth, googleProvider } from "./firebase";
 
@@ -167,15 +159,13 @@ export const signOutUser = async () => {
 };
 ```
 
-> **Note:**
-
-Refer to the [Firebase documentation](https://firebase.google.com/docs/auth) for other authentication methods like email/password, phone authentication, and more.
+> **Note:** Refer to the [Firebase documentation](https://firebase.google.com/docs/auth) for other authentication methods like email/password, phone authentication, and more.
 
 ## Configuring `MastraClient`
 
 When `auth` is enabled, all requests made with `MastraClient` must include a valid Firebase ID token in the `Authorization` header:
 
-```typescript {6} title="lib/mastra/mastra-client.ts"
+```typescript
 import { MastraClient } from "@mastra/client-js";
 
 export const createMastraClient = (idToken: string) => {
@@ -188,99 +178,95 @@ export const createMastraClient = (idToken: string) => {
 };
 ```
 
-> **Note:**
-
-The ID token must be prefixed with `Bearer` in the Authorization header.
-
-Visit [Mastra Client SDK](https://mastra.ai/docs/server/mastra-client) for more configuration options.
+> **Info:** The ID token must be prefixed with `Bearer` in the Authorization header.
+>
+> Visit [Mastra Client SDK](https://mastra.ai/docs/server/mastra-client) for more configuration options.
 
 ### Making authenticated requests
 
 Once `MastraClient` is configured with the Firebase ID token, you can send authenticated requests:
 
-  **react:**
+**React**:
 
-    ```tsx title="src/components/test-agent.tsx"
-    "use client";
+```tsx
+"use client";
 
-    import { useAuthState } from 'react-firebase-hooks/auth';
-    import { MastraClient } from "@mastra/client-js";
-    import { auth } from '../lib/firebase';
-    import { getIdToken } from '../lib/auth';
+import { useAuthState } from 'react-firebase-hooks/auth';
+import { MastraClient } from "@mastra/client-js";
+import { auth } from '../lib/firebase';
+import { getIdToken } from '../lib/auth';
 
-    export const TestAgent = () => {
-      const [user] = useAuthState(auth);
+export const TestAgent = () => {
+  const [user] = useAuthState(auth);
 
-      async function handleClick() {
-        if (!user) return;
+  async function handleClick() {
+    if (!user) return;
 
-        const token = await getIdToken(user);
-        const client = createMastraClient(token);
+    const token = await getIdToken(user);
+    const client = createMastraClient(token);
 
-        const weatherAgent = client.getAgent("weatherAgent");
-        const response = await weatherAgent.generate("What's the weather like in New York");
+    const weatherAgent = client.getAgent("weatherAgent");
+    const response = await weatherAgent.generate("What's the weather like in New York");
 
-        console.log({ response });
-      }
+    console.log({ response });
+  }
 
-      return (
-        <button onClick={handleClick} disabled={!user}>
-          Test Agent
-        </button>
-      );
-    };
-    ```
-
-  
-  **nodejs:**
-
-    ```typescript title="server.js"
-    const express = require('express');
-    const admin = require('firebase-admin');
-    const { MastraClient } = require('@mastra/client-js');
-
-    // Initialize Firebase Admin
-    admin.initializeApp({
-      credential: admin.credential.cert({
-        // Your service account credentials
-      })
-    });
+  return (
+    <button onClick={handleClick} disabled={!user}>
+      Test Agent
+    </button>
+  );
+};
+```
 
-    const app = express();
-    app.use(express.json());
+**Node.js**:
 
-    app.post('/generate', async (req, res) => {
-      try {
-        const { idToken } = req.body;
+```typescript
+const express = require('express');
+const admin = require('firebase-admin');
+const { MastraClient } = require('@mastra/client-js');
 
-        // Verify the token
-        await admin.auth().verifyIdToken(idToken);
+// Initialize Firebase Admin
+admin.initializeApp({
+  credential: admin.credential.cert({
+    // Your service account credentials
+  })
+});
+
+const app = express();
+app.use(express.json());
 
-        const mastra = new MastraClient({
-          baseUrl: "http://localhost:4111",
-          headers: {
-            Authorization: `Bearer ${idToken}`
-          }
-        });
+app.post('/generate', async (req, res) => {
+  try {
+    const { idToken } = req.body;
 
-        const weatherAgent = mastra.getAgent("weatherAgent");
-        const response = await weatherAgent.generate("What's the weather like in Nairobi");
+    // Verify the token
+    await admin.auth().verifyIdToken(idToken);
 
-        res.json({ response: response.text });
-      } catch (error) {
-        res.status(401).json({ error: 'Unauthorized' });
+    const mastra = new MastraClient({
+      baseUrl: "http://localhost:4111",
+      headers: {
+        Authorization: `Bearer ${idToken}`
       }
     });
-    ```
-
-  
-  **curl:**
-
-    ```bash
-    curl -X POST http://localhost:4111/api/agents/weatherAgent/generate \
-      -H "Content-Type: application/json" \
-      -H "Authorization: Bearer <your-firebase-id-token>" \
-      -d '{
-        "messages": "Weather in London"
-      }'
-    ```
+
+    const weatherAgent = mastra.getAgent("weatherAgent");
+    const response = await weatherAgent.generate("What's the weather like in Nairobi");
+
+    res.json({ response: response.text });
+  } catch (error) {
+    res.status(401).json({ error: 'Unauthorized' });
+  }
+});
+```
+
+**cURL**:
+
+```bash
+curl -X POST http://localhost:4111/api/agents/weatherAgent/generate \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer <your-firebase-id-token>" \
+  -d '{
+    "messages": "Weather in London"
+  }'
+```

package/dist/docs/{server/02-jwt.md → references/docs-server-auth-jwt.md}

@@ -1,5 +1,3 @@
-> Documentation for the MastraJwtAuth class, which authenticates Mastra applications using JSON Web Tokens.
-
 # MastraJwtAuth Class
 
 The `MastraJwtAuth` class provides a lightweight authentication mechanism for Mastra using JSON Web Tokens (JWTs). It verifies incoming requests based on a shared secret and integrates with the Mastra server using the `auth` option.
@@ -8,13 +6,33 @@ The `MastraJwtAuth` class provides a lightweight authentication mechanism for Ma
 
 Before you can use the `MastraJwtAuth` class you have to install the `@mastra/auth` package.
 
-```bash npm2yarn
+**npm**:
+
+```bash
 npm install @mastra/auth@latest
 ```
 
+**pnpm**:
+
+```bash
+pnpm add @mastra/auth@latest
+```
+
+**Yarn**:
+
+```bash
+yarn add @mastra/auth@latest
+```
+
+**Bun**:
+
+```bash
+bun add @mastra/auth@latest
+```
+
 ## Usage example
 
-```typescript {2,6-8} title="src/mastra/index.ts"
+```typescript
 import { Mastra } from "@mastra/core";
 import { MastraJwtAuth } from "@mastra/auth";
 
@@ -27,15 +45,13 @@ export const mastra = new Mastra({
 });
 ```
 
-> **Note:**
-
-Visit [MastraJwtAuth](https://mastra.ai/reference/auth/jwt) for all available configuration options.
+> **Info:** Visit [MastraJwtAuth](https://mastra.ai/reference/auth/jwt) for all available configuration options.
 
 ## Configuring `MastraClient`
 
 When `auth` is enabled, all requests made with `MastraClient` must include a valid JWT in the `Authorization` header:
 
-```typescript {6} title="lib/mastra/mastra-client.ts"
+```typescript
 import { MastraClient } from "@mastra/client-js";
 
 export const mastraClient = new MastraClient({
@@ -46,45 +62,40 @@ export const mastraClient = new MastraClient({
 });
 ```
 
-> **Note:**
-
-Visit [Mastra Client SDK](https://mastra.ai/docs/server/mastra-client) for more configuration options.
+> **Info:** Visit [Mastra Client SDK](https://mastra.ai/docs/server/mastra-client) for more configuration options.
 
 ### Making authenticated requests
 
 Once `MastraClient` is configured, you can send authenticated requests from your frontend application, or use `curl` for quick local testing:
 
-  **react:**
-
-    ```tsx title="src/components/test-agent.tsx"
-    import { mastraClient } from "../../lib/mastra-client";
+**React**:
 
-    export const TestAgent = () => {
-      async function handleClick() {
-        const agent = mastraClient.getAgent("weatherAgent");
+```tsx
+import { mastraClient } from "../../lib/mastra-client";
 
-        const response = await agent.generate("Weather in London");
+export const TestAgent = () => {
+  async function handleClick() {
+    const agent = mastraClient.getAgent("weatherAgent");
 
-        console.log(response);
-      }
+    const response = await agent.generate("Weather in London");
 
-      return <button onClick={handleClick}>Test Agent</button>;
-    };
-    ```
+    console.log(response);
+  }
 
-  
-  **curl:**
+  return <button onClick={handleClick}>Test Agent</button>;
+};
+```
 
-    ```bash
-    curl -X POST http://localhost:4111/api/agents/weatherAgent/generate \
-      -H "Content-Type: application/json" \
-      -H "Authorization: Bearer <your-jwt>" \
-      -d '{
-        "messages": "Weather in London"
-      }'
-    ```
+**cURL**:
 
-  
+```bash
+curl -X POST http://localhost:4111/api/agents/weatherAgent/generate \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer <your-jwt>" \
+  -d '{
+    "messages": "Weather in London"
+  }'
+```
 
 ## Creating a JWT
 

package/dist/docs/{server/04-supabase.md → references/docs-server-auth-supabase.md}

@@ -1,5 +1,3 @@
-> Documentation for the MastraAuthSupabase class, which authenticates Mastra applications using Supabase Auth.
-
 # MastraAuthSupabase Class
 
 The `MastraAuthSupabase` class provides authentication for Mastra using Supabase Auth. It verifies incoming requests using Supabase's authentication system and integrates with the Mastra server using the `auth` option.
@@ -8,14 +6,12 @@ The `MastraAuthSupabase` class provides authentication for Mastra using Supabase
 
 This example uses Supabase Auth. Make sure to add your Supabase credentials to your `.env` file and ensure your Supabase project is properly configured.
 
-```env title=".env"
+```env
 SUPABASE_URL=https://your-project.supabase.co
 SUPABASE_ANON_KEY=your-anon-key
 ```
 
-> **Note:**
-
-Review your Supabase Row Level Security (RLS) settings to ensure proper data access controls.
+> **Note:** Review your Supabase Row Level Security (RLS) settings to ensure proper data access controls.
 
 ## Installation
 
@@ -27,7 +23,7 @@ npm install @mastra/auth-supabase@latest
 
 ## Usage example
 
-```typescript {2,6-9} title="src/mastra/index.ts"
+```typescript
 import { Mastra } from "@mastra/core";
 import { MastraAuthSupabase } from "@mastra/auth-supabase";
 
@@ -41,11 +37,9 @@ export const mastra = new Mastra({
 });
 ```
 
-> **Note:**
-
-The default `authorizeUser` method checks the `isAdmin` column in the `users` table in the `public` schema. To customize user authorization, provide a custom `authorizeUser` function when constructing the provider.
-
-Visit [MastraAuthSupabase](https://mastra.ai/reference/auth/supabase) for all available configuration options.
+> **Info:** The default `authorizeUser` method checks the `isAdmin` column in the `users` table in the `public` schema. To customize user authorization, provide a custom `authorizeUser` function when constructing the provider.
+>
+> Visit [MastraAuthSupabase](https://mastra.ai/reference/auth/supabase) for all available configuration options.
 
 ## Client-side setup
 
@@ -55,7 +49,7 @@ When using Supabase auth, you'll need to retrieve the access token from Supabase
 
 Use the Supabase client to authenticate users and retrieve their access token:
 
-```typescript title="lib/auth.ts"
+```typescript
 import { createClient } from "@supabase/supabase-js";
 
 const supabase = createClient("<supabase-url>", "<supabase-key>");
@@ -68,15 +62,13 @@ const authTokenResponse = await supabase.auth.signInWithPassword({
 const accessToken = authTokenResponse.data?.session?.access_token;
 ```
 
-> **Note:**
-
-Refer to the [Supabase documentation](https://supabase.com/docs/guides/auth) for other authentication methods like OAuth, magic links, and more.
+> **Note:** Refer to the [Supabase documentation](https://supabase.com/docs/guides/auth) for other authentication methods like OAuth, magic links, and more.
 
 ## Configuring `MastraClient`
 
 When `auth` is enabled, all requests made with `MastraClient` must include a valid Supabase access token in the `Authorization` header:
 
-```typescript {6} title="lib/mastra/mastra-client.ts"
+```typescript
 import { MastraClient } from "@mastra/client-js";
 
 export const mastraClient = new MastraClient({
@@ -87,42 +79,39 @@ export const mastraClient = new MastraClient({
 });
 ```
 
-> **Note:**
-
-The access token must be prefixed with `Bearer` in the Authorization header.
-
-Visit [Mastra Client SDK](https://mastra.ai/docs/server/mastra-client) for more configuration options.
+> **Info:** The access token must be prefixed with `Bearer` in the Authorization header.
+>
+> Visit [Mastra Client SDK](https://mastra.ai/docs/server/mastra-client) for more configuration options.
 
 ### Making authenticated requests
 
 Once `MastraClient` is configured with the Supabase access token, you can send authenticated requests:
 
-    **react:**
+**React**:
 
-      ```tsx title="src/components/test-agent.tsx"
-      import { mastraClient } from "../../lib/mastra-client";
+```tsx
+import { mastraClient } from "../../lib/mastra-client";
 
-      export const TestAgent = () => {
-        async function handleClick() {
-          const agent = mastraClient.getAgent("weatherAgent");
+export const TestAgent = () => {
+  async function handleClick() {
+    const agent = mastraClient.getAgent("weatherAgent");
 
-          const response = await agent.generate("What's the weather like in New York");
+    const response = await agent.generate("What's the weather like in New York");
 
-          console.log(response);
-        }
+    console.log(response);
+  }
 
-        return <button onClick={handleClick}>Test Agent</button>;
-      };
-      ```
+  return <button onClick={handleClick}>Test Agent</button>;
+};
+```
 
-  
-  **curl:**
+**cURL**:
 
-    ```bash
-    curl -X POST http://localhost:4111/api/agents/weatherAgent/generate \
-      -H "Content-Type: application/json" \
-      -H "Authorization: Bearer <your-supabase-access-token>" \
-      -d '{
-        "messages": "Weather in London"
-      }'
-    ```
+```bash
+curl -X POST http://localhost:4111/api/agents/weatherAgent/generate \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer <your-supabase-access-token>" \
+  -d '{
+    "messages": "Weather in London"
+  }'
+```