Skip to content
This repository was archived by the owner on Nov 7, 2025. It is now read-only.

Commit a2b69b0

Browse files
committed
docs: update README
1 parent 1c031ee commit a2b69b0

1 file changed

Lines changed: 12 additions & 11 deletions

File tree

CHANGELOG.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,13 @@
11
# Changelog
22

3-
All notable changes to this project will be documented in this file.
4-
5-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7-
83
## [Unreleased]
94

10-
## [1.0.0] - 2025-01-05
5+
## [1.0.0] - 2025-07-05
116

127
### Added
138

149
#### Core Features
15-
- **OpenFGA Integration**: Complete integration with OpenFGA for fine-grained authorization in Laravel applications
10+
1611
- **Multi-connection Support**: Configure and use multiple OpenFGA instances simultaneously
1712
- **Eloquent Model Integration**: `HasAuthorization` trait for seamless model-based permissions
1813
- **Middleware Protection**: Route middleware for declarative authorization (`openfga`, `openfga.any`, `openfga.all`)
@@ -23,25 +18,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2318
- **OpenTelemetry Support**: Built-in observability with OpenTelemetry integration
2419

2520
#### Type Safety Enhancements
21+
2622
- **Strict typing throughout codebase**: All PHP files use `declare(strict_types=1)` for enhanced type safety
2723
- **Comprehensive generic annotations**: Detailed PHPDoc type annotations with generics for arrays, collections, and return types
2824
- **DTO (Data Transfer Object) pattern**: Introduced `PermissionCheckRequest` DTO for better type safety and structure
2925
- **Interface contracts**: Enhanced interfaces with strict type declarations and comprehensive documentation
3026

3127
#### PHP 8.3+ Features
28+
3229
- **Readonly classes**: Implemented readonly DTOs for immutable data structures
3330
- **Enhanced union types**: Leveraged union types for flexible parameter handling while maintaining type safety
3431
- **Override attributes**: Added `#[Override]` attributes for better inheritance safety
3532
- **Improved type declarations**: Utilized latest PHP 8.3 type system features for maximum safety
3633

3734
#### Developer Experience
35+
3836
- **Enhanced IDE support**: Comprehensive PHPDoc annotations enable better autocomplete and static analysis
3937
- **Type-safe method chaining**: Fluent APIs with proper return type annotations
4038
- **Comprehensive Example Application**: Full-featured example app demonstrating best practices
4139
- **Testing Utilities**: `FakesOpenFga` trait and test helpers for easy testing
4240
- **Docker Integration**: Optimized Docker setup for integration testing
4341

4442
#### Documentation
43+
4544
- **Complete API documentation**: All public methods fully documented with type information
4645
- **Example application**: Comprehensive example showing real-world usage patterns
4746
- **Migration guides**: Clear instructions for integrating into existing applications
@@ -50,33 +49,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
5049
### Technical Details
5150

5251
#### Static Analysis
52+
5353
- **PHPStan Level 2**: Configured for robust static analysis
5454
- **Psalm Level 6**: Type checking with Psalm for additional safety
5555
- **Rector support**: Automated code quality improvements and PHP version compliance
5656
- **PHP-CS-Fixer**: Enforced PSR-12 coding standards
5757

5858
#### Testing
59+
5960
- **Unit Tests**: Comprehensive unit test coverage with Pest PHP
6061
- **Integration Tests**: Full integration test suite with real OpenFGA instance
6162
- **Example Tests**: Complete test suite for the example application
6263
- **GitHub Actions**: Automated CI/CD pipeline for quality assurance
6364

6465
#### Performance
66+
6567
- **Efficient caching strategies**: Multi-tier caching with write-behind optimization
6668
- **Batch operations**: Support for batch permission checks and writes
6769
- **Connection pooling**: Efficient HTTP client management
6870
- **Lazy loading**: Deferred service provider for faster boot times
6971

7072
### Security
73+
7174
- **Secure by default**: No credentials in code, environment-based configuration
7275
- **Input validation**: Comprehensive validation of all authorization inputs
7376
- **Error handling**: Graceful degradation with proper error messages
7477

7578
### Compatibility
76-
- **Laravel**: 11.x and 12.x
79+
80+
- **Laravel**: 12.x
7781
- **PHP**: 8.3+
7882
- **OpenFGA**: 1.x
7983
- **PSR Standards**: PSR-4, PSR-12 compliant
80-
81-
[Unreleased]: https://github.com/evansims/openfga-laravel/compare/v1.0.0...HEAD
82-
[1.0.0]: https://github.com/evansims/openfga-laravel/releases/tag/v1.0.0

0 commit comments

Comments
 (0)