0
Fork 0
mirror of https://github.com/mastra-ai/mastra.git synced 2026-11-17 08:44:46 +00:00
mastra/README.md

105 lines
7 KiB

2025-08-18 00:44:08 -07:00
2024-08-22 16:17:59 +01:00
2024-08-22 16:17:59 +01:00
2024-08-22 16:17:59 +01:00
2024-08-22 16:17:59 +01:00
2024-08-22 16:17:59 +01:00
2024-08-22 16:17:59 +01:00
2024-08-22 16:17:59 +01:00
2024-08-22 16:17:59 +01:00
2024-11-21 10:16:04 -08:00
2024-11-21 10:16:04 -08:00
2024-11-21 10:16:04 -08:00
2024-10-21 04:08:10 -07:00
2024-09-05 12:31:55 -07:00
2024-09-05 12:31:55 -07:00
2024-09-05 12:31:55 -07:00
2024-09-05 12:31:55 -07:00
2024-09-05 12:31:55 -07:00
chore: Add docs styleguides (#13263) ## Description - Add docs styleguides - Add AGENTS.md files and point CLAUDE.md file to it - Add mastra-docs claude skill - Improve prompts on writing docs ## Related Issue(s) Fixes DEVED-110 ## Type of Change - [ ] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [X] Documentation update - [ ] Code refactoring - [ ] Performance improvement - [ ] Test update ## Checklist - [ ] I have made corresponding changes to the documentation (if applicable) - [ ] I have added tests that prove my fix is effective or that my feature works <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added comprehensive docs and styleguides (DOC, STYLEGUIDE, GUIDE_* , REFERENCE) and new AGENTS.md; reorganized docs content and contributor workflow. * Replaced extensive CLAUDE.md content with pointer to AGENTS.md; cleared docs changelog and removed some legacy guideline files. * Updated CLI/pr/changeset prompts and guidance to require multiple changesets for multi-package changes and warn against very long changesets. * **Community** * Updated Code of Conduct with expanded scope and clearer enforcement guidance. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-02-19 13:45:33 +01:00
2024-11-24 11:32:22 +01:00
2024-09-05 12:31:55 -07:00
2024-09-05 12:31:55 -07:00
feat: auth core, server RBAC, and adapter permission enforcement (#13163) ## Summary PR 1 of 3 from the `auth-rbac-cms` branch split. This PR adds all backend plumbing for auth/RBAC. PRs 2 (auth providers) and 3 (playground UI) depend on this and can land in parallel once this merges. - **New `@mastra/core/auth` export** — interfaces for RBAC, sessions, SSO, credentials, ACL, and user management, plus default implementations (static RBAC provider, cookie/memory session providers, built-in roles) - **Server auth handlers** — login, signup, logout, session management, and SSO flows with Zod-validated schemas - **Route-level permission enforcement** — `requiresPermission` on route configs with convention-based derivation from path/method (e.g. `GET /agents/:id` → `agents:read`) - **Server adapter RBAC middleware** (Hono, Express, Fastify, Koa) — resolves user permissions via RBAC provider, cookie auth fallthrough for session-based auth - **Authorization policy fix** — `isProtectedPath` now uses `isProtectedCustomRoute` instead of `!isCustomRoutePublic`, fixing a bug where studio UI couldn't load in production - **Deployer updates** — `MASTRA_PACKAGES_FILE` env var injection, dynamic CORS origin when auth configured - **Client SDK** — `getFullUrl` helper, `AuthCapabilities` type export ### Key behavioral changes | Change | Risk | Mitigation | |---|---|---| | `SimpleAuth<TUser>` → `SimpleAuth<TUser extends EEUser>` | Medium — requires `id` + `email` fields | Intentional; compile-time catch | | `isProtectedPath` logic change | Medium — authorization policy | New tests cover this; required for studio login in prod | | Cookie fallthrough in Hono auth middleware | Low | Falls back to 401 if no user found | | No RBAC → authenticated users get full access | Low — intentional | Auth-only mode preserved | | CORS dynamic origin when auth configured | Low | Only activates with auth config; user can override | ### Deviation from plan `deployers/cloud/package.json` — the plan called for adding `@mastra/auth-cloud` dependency, but that package is created in PR 2. Omitted here to avoid workspace resolution failure; PR 2 will add it. ### Fixed pre-existing test bug All 4 adapter RBAC tests had a failing test ("should derive permissions from route path/method when not explicitly set") that registered an API handler at `/agents/test` with no prefix. That's a frontend/SPA path — real API handlers are always under `/api/*`. Fixed the test to use `prefix: '/api'` so the route is at `/api/agents/test`, matching how routes are actually registered. Verified the bug exists on `auth-rbac-cms` with clean install + build. ## Test plan - [x] `pnpm build:packages` — 35/35 tasks pass - [x] Core auth tests (cookie.test.ts) — 16/16 pass - [x] Server tests (permissions, helpers, system) — 177/177 pass - [x] Hono RBAC tests — 21/21 pass - [x] Express RBAC tests — 15/15 pass - [x] Fastify RBAC tests — 15/15 pass - [x] Koa RBAC tests — 15/15 pass - [x] Client SDK tests (base.test.ts) — 5/5 pass - [ ] Verify no auth configured → all existing behavior identical (no 403s, no auth prompts) - [ ] Verify pre-commit hooks pass (eslint + prettier) 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Enterprise auth: SSO and credentials sign-in/sign-up, login/logout, cookie and in-memory sessions, auth capabilities and current-user endpoints. * RBAC: default roles, static RBAC provider, route-level permission enforcement and middleware across adapters. * Client: full-URL helper; system responses include isDev. * Deploy/build: bundling emits package metadata; deployers set runtime packages file and adjust CORS when auth is enabled. * **Bug Fixes** * Studio UI loads correctly in production. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: Shane Thomas <shane@codekarate.com> Co-authored-by: Mastra Code (anthropic/claude-opus-4-6) <noreply@mastra.ai> Co-authored-by: Abhi Aiyer <abhiaiyer91@gmail.com>
2026-03-03 13:49:10 -08:00
feat: auth core, server RBAC, and adapter permission enforcement (#13163) ## Summary PR 1 of 3 from the `auth-rbac-cms` branch split. This PR adds all backend plumbing for auth/RBAC. PRs 2 (auth providers) and 3 (playground UI) depend on this and can land in parallel once this merges. - **New `@mastra/core/auth` export** — interfaces for RBAC, sessions, SSO, credentials, ACL, and user management, plus default implementations (static RBAC provider, cookie/memory session providers, built-in roles) - **Server auth handlers** — login, signup, logout, session management, and SSO flows with Zod-validated schemas - **Route-level permission enforcement** — `requiresPermission` on route configs with convention-based derivation from path/method (e.g. `GET /agents/:id` → `agents:read`) - **Server adapter RBAC middleware** (Hono, Express, Fastify, Koa) — resolves user permissions via RBAC provider, cookie auth fallthrough for session-based auth - **Authorization policy fix** — `isProtectedPath` now uses `isProtectedCustomRoute` instead of `!isCustomRoutePublic`, fixing a bug where studio UI couldn't load in production - **Deployer updates** — `MASTRA_PACKAGES_FILE` env var injection, dynamic CORS origin when auth configured - **Client SDK** — `getFullUrl` helper, `AuthCapabilities` type export ### Key behavioral changes | Change | Risk | Mitigation | |---|---|---| | `SimpleAuth<TUser>` → `SimpleAuth<TUser extends EEUser>` | Medium — requires `id` + `email` fields | Intentional; compile-time catch | | `isProtectedPath` logic change | Medium — authorization policy | New tests cover this; required for studio login in prod | | Cookie fallthrough in Hono auth middleware | Low | Falls back to 401 if no user found | | No RBAC → authenticated users get full access | Low — intentional | Auth-only mode preserved | | CORS dynamic origin when auth configured | Low | Only activates with auth config; user can override | ### Deviation from plan `deployers/cloud/package.json` — the plan called for adding `@mastra/auth-cloud` dependency, but that package is created in PR 2. Omitted here to avoid workspace resolution failure; PR 2 will add it. ### Fixed pre-existing test bug All 4 adapter RBAC tests had a failing test ("should derive permissions from route path/method when not explicitly set") that registered an API handler at `/agents/test` with no prefix. That's a frontend/SPA path — real API handlers are always under `/api/*`. Fixed the test to use `prefix: '/api'` so the route is at `/api/agents/test`, matching how routes are actually registered. Verified the bug exists on `auth-rbac-cms` with clean install + build. ## Test plan - [x] `pnpm build:packages` — 35/35 tasks pass - [x] Core auth tests (cookie.test.ts) — 16/16 pass - [x] Server tests (permissions, helpers, system) — 177/177 pass - [x] Hono RBAC tests — 21/21 pass - [x] Express RBAC tests — 15/15 pass - [x] Fastify RBAC tests — 15/15 pass - [x] Koa RBAC tests — 15/15 pass - [x] Client SDK tests (base.test.ts) — 5/5 pass - [ ] Verify no auth configured → all existing behavior identical (no 403s, no auth prompts) - [ ] Verify pre-commit hooks pass (eslint + prettier) 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Enterprise auth: SSO and credentials sign-in/sign-up, login/logout, cookie and in-memory sessions, auth capabilities and current-user endpoints. * RBAC: default roles, static RBAC provider, route-level permission enforcement and middleware across adapters. * Client: full-URL helper; system responses include isDev. * Deploy/build: bundling emits package metadata; deployers set runtime packages file and adjust CORS when auth is enabled. * **Bug Fixes** * Studio UI loads correctly in production. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: Shane Thomas <shane@codekarate.com> Co-authored-by: Mastra Code (anthropic/claude-opus-4-6) <noreply@mastra.ai> Co-authored-by: Abhi Aiyer <abhiaiyer91@gmail.com>
2026-03-03 13:49:10 -08:00
chore: Add docs styleguides (#13263) ## Description - Add docs styleguides - Add AGENTS.md files and point CLAUDE.md file to it - Add mastra-docs claude skill - Improve prompts on writing docs ## Related Issue(s) Fixes DEVED-110 ## Type of Change - [ ] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [X] Documentation update - [ ] Code refactoring - [ ] Performance improvement - [ ] Test update ## Checklist - [ ] I have made corresponding changes to the documentation (if applicable) - [ ] I have added tests that prove my fix is effective or that my feature works <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added comprehensive docs and styleguides (DOC, STYLEGUIDE, GUIDE_* , REFERENCE) and new AGENTS.md; reorganized docs content and contributor workflow. * Replaced extensive CLAUDE.md content with pointer to AGENTS.md; cleared docs changelog and removed some legacy guideline files. * Updated CLI/pr/changeset prompts and guidance to require multiple changesets for multi-package changes and warn against very long changesets. * **Community** * Updated Code of Conduct with expanded scope and clearer enforcement guidance. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-02-19 13:45:33 +01:00