@let-aurn/swagger-client 0.3.0 → 0.3.2

package/README.md

@@ -73,7 +73,12 @@ error. This setting affects endpoint names only, not request URLs.
 
 ## Angular
 
+Use `provideSwaggerClient` to register the client as
+`EnvironmentProviders` without spreading a provider array:
+
 ```ts
+import { provideSwaggerClient } from './api/generated/swagger-client';
+
 bootstrapApplication(AppComponent, {
   providers: [
     provideHttpClient(),
@@ -84,6 +89,11 @@ bootstrapApplication(AppComponent, {
 });
 ```
 
+Starting with version `0.3.1`, `provideSwaggerClient(config)` returns
+`EnvironmentProviders` for application or route configuration. Remove any spread
+operator (`...`) when registering it. Version `0.3.0` retains the `Provider[]`
+implementation.
+
 ### Custom HTTP adapters
 
 Implement `SwaggerHttpClient` and pass the adapter class to `provideSwaggerClient`.

package/dist/generators/angular-client.js

@@ -4,12 +4,13 @@ export function emitAngularClient(options = {}) {
 /* eslint-disable */
 // This file was generated by @let-aurn/swagger-client.
 import { HttpClient, HttpHeaders, HttpParams } from '@angular/common/http';
-import { Inject, Injectable, InjectionToken, Provider, Type } from '@angular/core';
+import { EnvironmentProviders, Inject, Injectable, InjectionToken, makeEnvironmentProviders, Type } from '@angular/core';
 import { Observable } from 'rxjs';
 import type {
   AnyApiEndpoint,
   BodyVariablesOf,
   HeaderVariablesOf,
+  HttpMethod,
   PathVariablesOf,
   QueryVariablesOf,
   ResponseOf
@@ -27,7 +28,7 @@ export interface SwaggerClientConfig {
  * Describes an HTTP request produced by the generated swagger client.
  */
 export interface SwaggerHttpRequest {
-  method: string;
+  method: HttpMethod;
   url: string;
   headers?: Record<string, string>;
   query?: Record<string, unknown>;
@@ -130,17 +131,17 @@ export class SwaggerClientService {
 }
 
 /**
- * Provides the generated Angular swagger client and its HTTP adapter.
+ * Provides the generated Angular swagger client and its HTTP adapter in an environment injector.
  *
  * @param config The swagger client runtime configuration.
- * @returns Angular providers for the generated client.
+ * @returns Environment providers for application or route configuration.
  */
-export function provideSwaggerClient(config: SwaggerClientConfig): Provider[] {
-  return [
+export function provideSwaggerClient(config: SwaggerClientConfig): EnvironmentProviders {
+  return makeEnvironmentProviders([
     { provide: SWAGGER_CLIENT_CONFIG, useValue: config },
     { provide: SWAGGER_HTTP_CLIENT, useClass: config.httpClient ?? AngularSwaggerHttpClient },
     SwaggerClientService
-  ];
+  ]);
 }
 
 function buildRequest<TEndpoint extends AnyApiEndpoint>(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@let-aurn/swagger-client",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "Generate typed Angular and React clients from OpenAPI JSON files.",
   "type": "module",
   "bin": {