Skip to content

Commit df3514e

Browse files
committed
chore: remove breaking changes section in README.md
1 parent 33dfbc8 commit df3514e

File tree

1 file changed

+0
-27
lines changed

1 file changed

+0
-27
lines changed

README.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -159,33 +159,6 @@ AshTypescript bridges the gap between Elixir and TypeScript by automatically gen
159159
- **Refactoring safety** - Rename fields in Elixir, get TypeScript errors immediately
160160
- **Living documentation** - Generated types serve as up-to-date API documentation
161161

162-
## 🚨 Breaking Changes
163-
164-
### Resource Extension Requirement (Security Enhancement)
165-
166-
**Important**: All resources accessible through TypeScript RPC must now explicitly use the `AshTypescript.Resource` extension:
167-
168-
```elixir
169-
defmodule MyApp.Todo do
170-
use Ash.Resource,
171-
domain: MyApp.Domain,
172-
extensions: [AshTypescript.Resource] # ← Required!
173-
174-
typescript do
175-
type_name "Todo"
176-
end
177-
end
178-
```
179-
180-
This applies to:
181-
- ✅ Resources with RPC actions
182-
- ✅ Resources accessed through relationships
183-
- ❌ Internal resources (not meant for frontend access)
184-
185-
**Migration**: Add the extension to all resources that should be accessible via RPC, then run `mix ash.codegen --dev`.
186-
187-
For detailed migration steps and error symptoms, see the [Getting Started Guide](documentation/tutorials/getting-started.md#troubleshooting).
188-
189162
## 🚀 Example Repository
190163

191164
Check out the **[AshTypescript Demo](https://github.com/ChristianAlexander/ash_typescript_demo)** by Christian Alexander featuring:

0 commit comments

Comments
 (0)