@experteam-mx/ngx-services 20.1.5 → 20.1.7

package/README.md

@@ -1,24 +1,80 @@
-# NgxServices
+# @experteam-mx/ngx-services
 
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 18.2.0.
+Common Angular services used across Experteam applications.
 
-## Code scaffolding
+## Standalone setup (Angular v20+)
 
-Run `ng generate component component-name --project ngx-services` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project ngx-services`.
-> Note: Don't forget to add `--project ngx-services` or else it will be added to the default project in your `angular.json` file. 
+Use `provideNgxServices(environment)` in your `ApplicationConfig.providers`.
+
+```ts
+import { provideHttpClient, withInterceptors } from '@angular/common/http'
+import type { ApplicationConfig } from '@angular/core'
+import { provideRouter } from '@angular/router'
+import {
+	apiHeadersInterceptor,
+	apiTokenInterceptor,
+	httpCachingInterceptor,
+	provideNgxServices,
+	type Environment
+} from '@experteam-mx/ngx-services'
+import { environment } from '../environments/environment'
+import { routes } from './app.routes'
+
+const envs = {
+	...environment,
+	authCookie: 'token',
+	cacheTtl: 3000
+} as Environment
+
+export const appConfig: ApplicationConfig = {
+	providers: [
+		provideRouter(routes),
+		provideNgxServices(envs),
+		provideHttpClient(withInterceptors([
+			apiHeadersInterceptor,
+			apiTokenInterceptor,
+			httpCachingInterceptor
+		]))
+	]
+}
+```
+
+`provideNgxServices` registers `ENVIRONMENT_TOKEN`, which is required by the API services and some interceptors in this package.
+
+## NgModule compatibility
+
+`NgxServicesModule.forRoot(environment)` is still available for compatibility, but it is deprecated for new standalone applications and will be removed in `20.2.0`.
+
+```ts
+import { importProvidersFrom } from '@angular/core'
+import { NgxServicesModule } from '@experteam-mx/ngx-services'
+
+providers: [
+	importProvidersFrom([NgxServicesModule.forRoot(envs)])
+]
+```
+
+Prefer `provideNgxServices(envs)` for all new apps.
 
 ## Build
 
-Run `ng build ngx-services` to build the project. The build artifacts will be stored in the `dist/` directory.
+```bash
+ng build @experteam-mx/ngx-services
+```
 
-## Publishing
+Build output:
 
-After building your library with `ng build ngx-services`, go to the dist folder `cd dist/ngx-services` and run `npm publish`.
+`dist/experteam-mx/ngx-services`
 
-## Running unit tests
+## Publish
 
-Run `ng test ngx-services` to execute the unit tests via [Karma](https://karma-runner.github.io).
+```bash
+cd dist/experteam-mx/ngx-services
+npm publish
+```
 
-## Further help
+## Test
 
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
+```bash
+ng test @experteam-mx/ngx-services
+```