feat(angular): add util "provideApi" for standalone applications (Angular 17 and above)

Author: jase88

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptAngularClientCodegen.java

@@ -176,12 +176,27 @@ public String getHelp() {
     @Override
     public void processOpts() {
         super.processOpts();
+
+        // determine NG version
+        SemVer ngVersion;
+        if (additionalProperties.containsKey(NG_VERSION)) {
+            ngVersion = new SemVer(additionalProperties.get(NG_VERSION).toString());
+        } else {
+            ngVersion = new SemVer(this.ngVersion);
+            LOGGER.info("generating code for Angular {} ...", ngVersion);
+            LOGGER.info("  (you can select the angular version by setting the additionalProperties (--additional-properties in CLI) ngVersion)");
+        }
+        boolean ngVersionAtLeast_17 = ngVersion.atLeast("17.0.0");
+
         supportingFiles.add(
                 new SupportingFile("models.mustache", modelPackage().replace('.', File.separatorChar), "models.ts"));
         supportingFiles
                 .add(new SupportingFile("apis.mustache", apiPackage().replace('.', File.separatorChar), "api.ts"));
         supportingFiles.add(new SupportingFile("index.mustache", getIndexDirectory(), "index.ts"));
         supportingFiles.add(new SupportingFile("api.module.mustache", getIndexDirectory(), "api.module.ts"));
+        if (ngVersionAtLeast_17) {
+            supportingFiles.add(new SupportingFile("provide-api.mustache", getIndexDirectory(), "provide-api.ts"));
+        }
         supportingFiles.add(new SupportingFile("configuration.mustache", getIndexDirectory(), "configuration.ts"));
         supportingFiles.add(new SupportingFile("api.base.service.mustache", getIndexDirectory(), "api.base.service.ts"));
         supportingFiles.add(new SupportingFile("variables.mustache", getIndexDirectory(), "variables.ts"));
@@ -191,16 +206,6 @@ public void processOpts() {
         supportingFiles.add(new SupportingFile("git_push.sh.mustache", "", "git_push.sh"));
         supportingFiles.add(new SupportingFile("README.mustache", getIndexDirectory(), "README.md"));
 
-        // determine NG version
-        SemVer ngVersion;
-        if (additionalProperties.containsKey(NG_VERSION)) {
-            ngVersion = new SemVer(additionalProperties.get(NG_VERSION).toString());
-        } else {
-            ngVersion = new SemVer(this.ngVersion);
-            LOGGER.info("generating code for Angular {} ...", ngVersion);
-            LOGGER.info("  (you can select the angular version by setting the additionalProperties (--additional-properties in CLI) ngVersion)");
-        }
-
         if (!ngVersion.atLeast("9.0.0")) {
             throw new IllegalArgumentException("Invalid ngVersion: " + ngVersion + ". Only Angular v9+ is supported.");
         }
@@ -250,6 +255,7 @@ public void processOpts() {
         }
 
         additionalProperties.put(NG_VERSION, ngVersion);
+        additionalProperties.put("ngVersionAtLeast_17", ngVersionAtLeast_17);
 
         if (additionalProperties.containsKey(API_MODULE_PREFIX)) {
             String apiModulePrefix = additionalProperties.get(API_MODULE_PREFIX).toString();

modules/openapi-generator/src/main/resources/typescript-angular/index.mustache

@@ -5,4 +5,7 @@ export * from './model/models';
 export * from './variables';
 export * from './configuration';
 export * from './api.module';
+{{#ngVersionAtLeast_17}}
+export * from './provide-api';
+{{/ngVersionAtLeast_17}}
 export * from './param';

modules/openapi-generator/src/main/resources/typescript-angular/provide-api.mustache

@@ -0,0 +1,14 @@
+import { makeEnvironmentProviders } from "@angular/core";
+import { {{configurationClassName}}, {{configurationParametersInterfaceName}} } from './configuration';
+import { BASE_PATH } from './variables';
+
+export function provideApi(configOrBasePath: string | {{configurationParametersInterfaceName}}) {
+    return makeEnvironmentProviders([
+        typeof configOrBasePath === "string"
+            ? { provide: BASE_PATH, useValue: configOrBasePath }
+            : {
+                provide: {{configurationClassName}},
+                useValue: new {{configurationClassName}}({ ...configOrBasePath }),
+            },
+    ]);
+}

samples/client/others/typescript-angular/builds/composed-schemas-tagged-unions/.openapi-generator/FILES

@@ -21,4 +21,5 @@ model/petWithMappedDiscriminator.ts
 model/petWithSimpleDiscriminator.ts
 model/petWithoutDiscriminator.ts
 param.ts
+provide-api.ts
 variables.ts

samples/client/others/typescript-angular/builds/composed-schemas-tagged-unions/index.ts

@@ -3,4 +3,5 @@ export * from './model/models';
 export * from './variables';
 export * from './configuration';
 export * from './api.module';
+export * from './provide-api';
 export * from './param';

samples/client/others/typescript-angular/builds/composed-schemas-tagged-unions/provide-api.ts

@@ -0,0 +1,14 @@
+import { makeEnvironmentProviders } from "@angular/core";
+import { Configuration, ConfigurationParameters } from './configuration';
+import { BASE_PATH } from './variables';
+
+export function provideApi(configOrBasePath: string | ConfigurationParameters) {
+    return makeEnvironmentProviders([
+        typeof configOrBasePath === "string"
+            ? { provide: BASE_PATH, useValue: configOrBasePath }
+            : {
+                provide: Configuration,
+                useValue: new Configuration({ ...configOrBasePath }),
+            },
+    ]);
+}

samples/client/others/typescript-angular/builds/composed-schemas/.openapi-generator/FILES

@@ -21,4 +21,5 @@ model/petWithMappedDiscriminator.ts
 model/petWithSimpleDiscriminator.ts
 model/petWithoutDiscriminator.ts
 param.ts
+provide-api.ts
 variables.ts

samples/client/others/typescript-angular/builds/composed-schemas/index.ts

@@ -3,4 +3,5 @@ export * from './model/models';
 export * from './variables';
 export * from './configuration';
 export * from './api.module';
+export * from './provide-api';
 export * from './param';

samples/client/others/typescript-angular/builds/composed-schemas/provide-api.ts

@@ -0,0 +1,14 @@
+import { makeEnvironmentProviders } from "@angular/core";
+import { Configuration, ConfigurationParameters } from './configuration';
+import { BASE_PATH } from './variables';
+
+export function provideApi(configOrBasePath: string | ConfigurationParameters) {
+    return makeEnvironmentProviders([
+        typeof configOrBasePath === "string"
+            ? { provide: BASE_PATH, useValue: configOrBasePath }
+            : {
+                provide: Configuration,
+                useValue: new Configuration({ ...configOrBasePath }),
+            },
+    ]);
+}

samples/client/petstore/typescript-angular-v17-provided-in-root/builds/default/.openapi-generator/FILES

@@ -18,4 +18,5 @@ model/pet.ts
 model/tag.ts
 model/user.ts
 param.ts
+provide-api.ts
 variables.ts