Official Angular client library for StoneScriptPHP backend framework
Note: While published as @progalaxyelabs/ngx-stonescriptphp-client, this is the official client for StoneScriptPHP. Future versions will migrate to the @stonescriptphp namespace.
Fully compatible with StoneScriptPHP Framework v2.1.x authentication!
- ✅ Cookie-based auth: Secure httpOnly cookies + CSRF (StoneScriptPHP v2.1.x default)
- ✅ Body-based auth: Legacy mode for custom backends
- ✅ Configurable: Choose your auth strategy via environment config
- ✅ All HTTP methods: GET, POST, PUT, PATCH, DELETE with automatic token refresh
See Configuration section below for setup details.
📖 Documentation: CHANGELOG | Auth Compatibility
The Angular HTTP client library for StoneScriptPHP - a modern PHP backend framework that auto-generates TypeScript clients from your backend DTOs and contracts.
When you build APIs with StoneScriptPHP, you define:
- Request DTOs (TypeScript interfaces)
- Response DTOs (TypeScript interfaces)
- Route contracts (interfaces)
This library provides the HTTP client that consumes those contracts, giving you 100% type-safe API calls with zero manual typing.
- ✅ Type-safe HTTP calls - Full TypeScript support from backend DTOs
- ✅ Auto-generated clients - StoneScriptPHP generates TypeScript from PHP
- ✅ RxJS observables - Native Angular integration
- ✅ Error handling - Consistent error responses
- ✅ Interceptors ready - Add auth, logging, retry logic
- ✅ Angular 19+ & 20+ - Modern Angular standalone components
npm install @progalaxyelabs/ngx-stonescriptphp-clientIn your StoneScriptPHP project:
php stone generate typescript-clientThis generates TypeScript interfaces from your PHP DTOs.
import { Component } from '@angular/core';
import { HttpClient } from '@angular/common/http';
import { Observable } from 'rxjs';
// Auto-generated from StoneScriptPHP backend
interface ProductRequest {
name: string;
price: number;
}
interface ProductResponse {
productId: number;
status: string;
}
@Component({
selector: 'app-products',
standalone: true,
template: `<button (click)="createProduct()">Create Product</button>`
})
export class ProductsComponent {
constructor(private http: HttpClient) {}
createProduct(): void {
const request: ProductRequest = {
name: 'Widget',
price: 99.99
};
this.http.post<ProductResponse>('http://localhost:9100/products', request)
.subscribe(response => {
console.log('Product created:', response.productId);
});
}
}StoneScriptPHP follows a contract-first approach:
PHP Backend (StoneScriptPHP) Angular Frontend
┌─────────────────────────┐ ┌──────────────────────┐
│ ProductRequest DTO │ ──────> │ ProductRequest.ts │
│ ProductResponse DTO │ ──────> │ ProductResponse.ts │
│ IProductRoute contract │ ──────> │ Type-safe HTTP calls │
└─────────────────────────┘ └──────────────────────┘
- Define DTOs in PHP
- Run
php stone generate typescript-client - Import generated TypeScript interfaces in Angular
- Make type-safe HTTP calls
Choose your authentication strategy based on your backend:
// environment.ts
export const environment = {
production: false,
apiServer: {
host: 'http://localhost:8000/'
},
auth: {
mode: 'cookie', // Default mode
refreshEndpoint: '/auth/refresh', // Default endpoint
useCsrf: true, // Default for cookie mode
refreshTokenCookieName: 'refresh_token', // Default
csrfTokenCookieName: 'csrf_token', // Default
csrfHeaderName: 'X-CSRF-Token' // Default
}
}Features:
- Secure httpOnly cookies prevent XSS attacks
- CSRF token protection
- Token rotation on refresh
- Works with StoneScriptPHP
AuthRoutes::register($router)
// environment.ts
export const environment = {
production: false,
apiServer: {
host: 'http://localhost:8000/'
},
auth: {
mode: 'body',
refreshEndpoint: '/user/refresh_access',
useCsrf: false
}
}Use when:
- Your backend accepts tokens in request body
- Custom authentication implementation
- Migrating from older systems
// environment.ts
export const environment = {
production: false,
apiServer: {
host: 'http://localhost:8000/'
},
auth: {
mode: 'none'
}
}Use when:
- You handle token refresh manually
- No authentication needed
- Custom auth logic
import { HttpInterceptor, HttpRequest, HttpHandler } from '@angular/common/http';
export class AuthInterceptor implements HttpInterceptor {
intercept(req: HttpRequest<any>, next: HttpHandler) {
const authReq = req.clone({
headers: req.headers.set('Authorization', 'Bearer ' + getToken())
});
return next.handle(authReq);
}
}this.http.post<ProductResponse>('/products', request)
.pipe(
catchError(error => {
console.error('API Error:', error);
return throwError(() => error);
})
)
.subscribe(response => {
// Handle success
});StoneScriptPHP responses follow this structure:
{
"status": "ok" | "error",
"message": "Success message",
"data": { /* Your DTO */ }
}- Angular >= 19.0.0 or 20.0.0
- RxJS >= 7.8.0
- TypeScript >= 5.8.0
- Framework Docs: stonescriptphp.org
- Getting Started: stonescriptphp.org/docs/getting-started
- TypeScript Client Guide: stonescriptphp.org/docs/typescript-client
Check out the StoneScriptPHP examples repository for full-stack example apps.
This is part of the StoneScriptPHP ecosystem. Contributions welcome!
- Report issues: GitHub Issues
- Framework repo: StoneScriptPHP
MIT
- StoneScriptPHP - The PHP backend framework
- sunbird-garden - Reference implementation
Made with ❤️ by the StoneScriptPHP team