@mpratyush54/sdk-angular
v1.0.3
Published
Platform Angular SDK - HTTP interceptor, error handler, bug reporter component
Downloads
43
Readme
@mpratyush54/sdk-angular
Official Angular SDK for Platform — HTTP metrics interceptor, global error handler, and a standalone bug-reporter component.
Requires Angular ≥ 16. Package: @mpratyush54/sdk-angular
Install
npm install @mpratyush54/sdk-angularQuick start (NgModule)
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { HttpClientModule } from '@angular/common/http';
import { PlatformModule } from '@mpratyush54/sdk-angular';
import { AppComponent } from './app.component';
@NgModule({
declarations: [AppComponent],
imports: [
BrowserModule,
HttpClientModule,
PlatformModule.forRoot({
apiBase: 'https://api.example.sslip.io',
token: 'sdk_live_…',
projectId: 'your-project-id',
environment: 'development',
appName: 'my-angular-app',
}),
],
bootstrap: [AppComponent],
})
export class AppModule {}In a template:
<platform-bug-reporter></platform-bug-reporter>Standalone / bootstrapApplication
import { bootstrapApplication } from '@angular/platform-browser';
import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http';
import { importProvidersFrom } from '@angular/core';
import { PlatformModule, BugReporterComponent } from '@mpratyush54/sdk-angular';
import { AppComponent } from './app.component';
bootstrapApplication(AppComponent, {
providers: [
provideHttpClient(withInterceptorsFromDi()),
importProvidersFrom(
PlatformModule.forRoot({
apiBase: environment.platformUrl,
token: environment.sdkToken,
projectId: environment.projectId,
environment: 'development',
}),
),
],
});Import BugReporterComponent into a standalone page and add <platform-bug-reporter> to the template.
What you get
| Piece | Behaviour |
|-------|-----------|
| PlatformHttpInterceptor | Times every HttpClient call → /api/sdk/api-metrics |
| PlatformErrorHandler | Replaces Angular ErrorHandler; reports uncaught errors |
| BugReporterComponent | Floating reporter; attaches console + recent network |
PlatformConfig
| Field | Required | Description |
|-------|----------|-------------|
| apiBase | yes | Platform API base URL |
| token | yes | SDK bearer token |
| projectId | yes | Project id for metrics / bugs |
| environment | no | Environment label |
| appName | no | App label |
Examples
| File | Topic |
|------|--------|
| examples/app.module.ts | Classic NgModule setup |
| examples/app.config.ts | Standalone providers |
| examples/usage.component.ts | HttpClient + bug reporter |
Cluster demo: examples/sdk-apps/angular-web.
Docs: Angular quickstart · API
License
MIT
