typescript-angular: add providedIn for Angular 9+

bin/configs/typescript-angular-v9-provided-in-any.yaml

@@ -0,0 +1,6 @@
+generatorName: typescript-angular
+outputDir: samples/client/petstore/typescript-angular-v9-provided-in-any/builds/default
+inputSpec: modules/openapi-generator/src/test/resources/2_0/petstore.yaml
+additionalProperties:
+  ngVersion: 9.0.0
+  providedIn: any

docs/generators/typescript-angular.md

@@ -25,7 +25,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |npmVersion|The version of your npm package. If not provided, using the version from the OpenAPI specification file.| |1.0.0|
 |nullSafeAdditionalProps|Set to make additional properties types declare that their indexer may return undefined| |false|
 |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
-|providedInRoot|Use this property to provide Injectables in root (it is only valid in angular version greater or equal to 6.0.0).| |false|
+|providedIn|Use this property to provide Injectables in wanted level (it is only valid in angular version greater or equal to 9.0.0).|<dl><dt>**root**</dt><dd>The application-level injector in most apps.</dd><dt>**none**</dt><dd>No providedIn (same as providedInRoot=false)</dd><dt>**any**</dt><dd>Provides a unique instance in each lazy loaded module while all eagerly loaded modules share one instance.</dd><dt>**platform**</dt><dd>A special singleton platform injector shared by all applications on the page.</dd></dl>|root|
+|providedInRoot|Use this property to provide Injectables in root (it is only valid in angular version greater or equal to 6.0.0). IMPORTANT: Deprecated for angular version greater or equal to 9.0.0, use **providedIn** instead.| |false|
 |queryParamObjectFormat|The format for query param objects: 'dot', 'json', 'key'.| |dot|
 |serviceFileSuffix|The suffix of the file of the generated service (service&lt;suffix&gt;.ts).| |.service|
 |serviceSuffix|The suffix of the generated service.| |Service|

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

@@ -41,6 +41,7 @@ public class TypeScriptAngularClientCodegen extends AbstractTypeScriptClientCode
     private static String FILE_NAME_SUFFIX_PATTERN = "^[a-zA-Z0-9.-]*$";
 
     public static enum QUERY_PARAM_OBJECT_FORMAT_TYPE {dot, json, key};
+    public static enum PROVIDED_IN_LEVEL {none, root, any, platform}; 
 
     private static final String DEFAULT_IMPORT_PREFIX = "./";
 
@@ -50,6 +51,7 @@ public static enum QUERY_PARAM_OBJECT_FORMAT_TYPE {dot, json, key};
     public static final String TAGGED_UNIONS = "taggedUnions";
     public static final String NG_VERSION = "ngVersion";
     public static final String PROVIDED_IN_ROOT = "providedInRoot";
+    public static final String PROVIDED_IN = "providedIn";
     public static final String ENFORCE_GENERIC_MODULE_WITH_PROVIDERS = "enforceGenericModuleWithProviders";
     public static final String API_MODULE_PREFIX = "apiModulePrefix";
     public static final String CONFIGURATION_PREFIX = "configurationPrefix";
@@ -72,6 +74,7 @@ public static enum QUERY_PARAM_OBJECT_FORMAT_TYPE {dot, json, key};
     protected String fileNaming = "camelCase";
     protected Boolean stringEnums = false;
     protected QUERY_PARAM_OBJECT_FORMAT_TYPE queryParamObjectFormat = QUERY_PARAM_OBJECT_FORMAT_TYPE.dot;
+    protected PROVIDED_IN_LEVEL providedIn = PROVIDED_IN_LEVEL.root;
 
     private boolean taggedUnions = false;
 
@@ -104,8 +107,17 @@ public TypeScriptAngularClientCodegen() {
                 "Use discriminators to create tagged unions instead of extending interfaces.",
                 this.taggedUnions));
         this.cliOptions.add(CliOption.newBoolean(PROVIDED_IN_ROOT,
-                "Use this property to provide Injectables in root (it is only valid in angular version greater or equal to 6.0.0).",
+                "Use this property to provide Injectables in root (it is only valid in angular version greater or equal to 6.0.0). IMPORTANT: Deprecated for angular version greater or equal to 9.0.0, use **providedIn** instead.",
                 false));
+        CliOption providedInCliOpt = new CliOption(PROVIDED_IN,
+                "Use this property to provide Injectables in wanted level (it is only valid in angular version greater or equal to 9.0.0).").defaultValue("root");
+        Map<String, String> providedInOptions = new HashMap<>();
+        providedInOptions.put(PROVIDED_IN_LEVEL.none.toString(), "No providedIn (same as providedInRoot=false)");
+        providedInOptions.put(PROVIDED_IN_LEVEL.root.toString(), "The application-level injector in most apps.");
+        providedInOptions.put(PROVIDED_IN_LEVEL.platform.toString(), "A special singleton platform injector shared by all applications on the page.");
+        providedInOptions.put(PROVIDED_IN_LEVEL.any.toString(), "Provides a unique instance in each lazy loaded module while all eagerly loaded modules share one instance.");
+        providedInCliOpt.setEnum(providedInOptions);
+        this.cliOptions.add(providedInCliOpt);
         this.cliOptions.add(new CliOption(NG_VERSION, "The version of Angular. (At least 6.0.0)").defaultValue(this.ngVersion));
         this.cliOptions.add(new CliOption(API_MODULE_PREFIX, "The prefix of the generated ApiModule."));
         this.cliOptions.add(new CliOption(CONFIGURATION_PREFIX, "The prefix of the generated Configuration."));
@@ -188,13 +200,28 @@ public void processOpts() {
             taggedUnions = Boolean.parseBoolean(additionalProperties.get(TAGGED_UNIONS).toString());
         }
 
-        if (!additionalProperties.containsKey(PROVIDED_IN_ROOT)) {
-            additionalProperties.put(PROVIDED_IN_ROOT, true);
+        if (ngVersion.atLeast("9.0.0") && additionalProperties.containsKey(PROVIDED_IN)) {
+            setProvidedIn(additionalProperties.get(PROVIDED_IN).toString());
         } else {
-            additionalProperties.put(PROVIDED_IN_ROOT, Boolean.parseBoolean(
-                additionalProperties.get(PROVIDED_IN_ROOT).toString()
-            ));
+            // Keep for backward compatibility
+            if (!additionalProperties.containsKey(PROVIDED_IN_ROOT)) {
+                additionalProperties.put(PROVIDED_IN_ROOT, true);
+            } else {
+                if (ngVersion.atLeast("9.0.0")) {
+                    LOGGER.warn("{} will be deprecated, use {} {} instead", PROVIDED_IN_ROOT, PROVIDED_IN, PROVIDED_IN_LEVEL.values());
+                }
+                additionalProperties.put(PROVIDED_IN_ROOT, Boolean.parseBoolean(
+                        additionalProperties.get(PROVIDED_IN_ROOT).toString()
+                        ));
+            }
+            if ((Boolean) additionalProperties.get(PROVIDED_IN_ROOT)) {
+                providedIn = PROVIDED_IN_LEVEL.root;
+            } else {
+                providedIn = PROVIDED_IN_LEVEL.none;
+            }
         }
+        additionalProperties.put("providedIn", providedIn);
+        additionalProperties.put("isProvidedInNone", getIsProvidedInNone());
 
         if (ngVersion.atLeast("9.0.0")) {                
             additionalProperties.put(ENFORCE_GENERIC_MODULE_WITH_PROVIDERS, true);
@@ -714,5 +741,29 @@ private String convertUsingFileNamingConvention(String originalName) {
         }
         return name;
     }
+
+    /**
+     * Set the Injectable level
+     * 
+     * @param level the wanted level
+     */
+    public void setProvidedIn (String level) {
+        try {
+            providedIn = PROVIDED_IN_LEVEL.valueOf(level);
+        } catch (IllegalArgumentException e) {
+            String values = Stream.of(PROVIDED_IN_LEVEL.values())
+                    .map(value -> "'" + value.name() + "'")
+                    .collect(Collectors.joining(", "));
 
+            String msg = String.format(Locale.ROOT, "Invalid providedIn level '%s'. Must be one of %s.", level, values);
+            throw new IllegalArgumentException(msg);
+        }
+    }
+
+    /**
+     * 
+     */
+    private boolean getIsProvidedInNone() {
+        return PROVIDED_IN_LEVEL.none.equals(providedIn);
+    }
 }

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

@@ -12,9 +12,9 @@ import { {{classname}} } from './{{importPath}}';
   imports:      [],
   declarations: [],
   exports:      [],
-  providers: [{{^providedInRoot}}
+  providers: [{{#isProvidedInNone}}
     {{#apiInfo}}{{#apis}}{{classname}}{{^-last}},
-    {{/-last}}{{/apis}}{{/apiInfo}} {{/providedInRoot}}]
+    {{/-last}}{{/apis}}{{/apiInfo}} {{/isProvidedInNone}}]
 })
 export class {{apiModuleClassName}} {
     public static forRoot(configurationFactory: () => {{configurationClassName}}): ModuleWithProviders{{#enforceGenericModuleWithProviders}}<{{apiModuleClassName}}>{{/enforceGenericModuleWithProviders}} {

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

@@ -43,14 +43,14 @@ export interface {{#prefixParameterInterfaces}}{{classname}}{{/prefixParameterIn
  * {{&description}}
  */
 {{/description}}
-{{^providedInRoot}}
+{{#isProvidedInNone}}
 @Injectable()
-{{/providedInRoot}}
-{{#providedInRoot}}
+{{/isProvidedInNone}}
+{{^isProvidedInNone}}
 @Injectable({
-  providedIn: 'root'
+  providedIn: '{{providedIn}}'
 })
-{{/providedInRoot}}
+{{/isProvidedInNone}}
 {{#withInterfaces}}
 export class {{classname}} implements {{classname}}Interface {
 {{/withInterfaces}}

modules/openapi-generator/src/test/java/org/openapitools/codegen/options/TypeScriptAngularClientOptionsProvider.java

@@ -34,8 +34,8 @@ public class TypeScriptAngularClientOptionsProvider implements OptionsProvider {
     public static final String ENSURE_UNIQUE_PARAMS_VALUE = "true";
     public static final String ENUM_PROPERTY_NAMING_VALUE = "PascalCase";
     public static final String MODEL_PROPERTY_NAMING_VALUE = "camelCase";
-    private static final String NMP_NAME = "npmName";
-    private static final String NMP_VERSION = "1.1.2";
+    private static final String NPM_NAME = "npmName";
+    private static final String NPM_VERSION = "1.1.2";
     private static final String NPM_REPOSITORY = "https://registry.npmjs.org";
     public static final String ALLOW_UNICODE_IDENTIFIERS_VALUE = "false";
     public static final String NG_VERSION = "2";
@@ -44,6 +44,7 @@ public class TypeScriptAngularClientOptionsProvider implements OptionsProvider {
     public static final String API_MODULE_PREFIX = "";
     public static final String CONFIGURATION_PREFIX = "";
     public static final String QUERY_PARAM_OBJECT_FORMAT_VALUE = "dot";
+    public static final String PROVIDED_IN_LEVEL = "root";
     public static String SERVICE_SUFFIX = "Service";
     public static String SERVICE_FILE_SUFFIX = ".service";
     public static String MODEL_SUFFIX = "";
@@ -66,12 +67,13 @@ public Map<String, String> createOptions() {
                 .put(AbstractTypeScriptClientCodegen.NULL_SAFE_ADDITIONAL_PROPS, NULL_SAFE_ADDITIONAL_PROPS_VALUE)
                 .put(CodegenConstants.ENUM_NAME_SUFFIX, ENUM_NAME_SUFFIX)
                 .put(TypeScriptAngularClientCodegen.STRING_ENUMS, STRING_ENUMS_VALUE)
-                .put(TypeScriptAngularClientCodegen.NPM_NAME, NMP_NAME)
-                .put(TypeScriptAngularClientCodegen.NPM_VERSION, NMP_VERSION)
+                .put(TypeScriptAngularClientCodegen.NPM_NAME, NPM_NAME)
+                .put(TypeScriptAngularClientCodegen.NPM_VERSION, NPM_VERSION)
                 .put(TypeScriptAngularClientCodegen.SNAPSHOT, Boolean.FALSE.toString())
                 .put(TypeScriptAngularClientCodegen.WITH_INTERFACES, Boolean.FALSE.toString())
                 .put(TypeScriptAngularClientCodegen.USE_SINGLE_REQUEST_PARAMETER, Boolean.FALSE.toString())
                 .put(TypeScriptAngularClientCodegen.PROVIDED_IN_ROOT, Boolean.FALSE.toString())
+                .put(TypeScriptAngularClientCodegen.PROVIDED_IN, PROVIDED_IN_LEVEL)
                 .put(TypeScriptAngularClientCodegen.TAGGED_UNIONS, Boolean.FALSE.toString())
                 .put(TypeScriptAngularClientCodegen.NPM_REPOSITORY, NPM_REPOSITORY)
                 .put(TypeScriptAngularClientCodegen.NG_VERSION, NG_VERSION)

samples/client/petstore/typescript-angular-v9-provided-in-any/builds/default/.gitignore

@@ -0,0 +1,4 @@
+wwwroot/*.js
+node_modules
+typings
+dist

samples/client/petstore/typescript-angular-v9-provided-in-any/builds/default/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

samples/client/petstore/typescript-angular-v9-provided-in-any/builds/default/.openapi-generator/FILES

@@ -0,0 +1,19 @@
+.gitignore
+README.md
+api.module.ts
+api/api.ts
+api/pet.service.ts
+api/store.service.ts
+api/user.service.ts
+configuration.ts
+encoder.ts
+git_push.sh
+index.ts
+model/apiResponse.ts
+model/category.ts
+model/models.ts
+model/order.ts
+model/pet.ts
+model/tag.ts
+model/user.ts
+variables.ts

samples/client/petstore/typescript-angular-v9-provided-in-any/builds/default/.openapi-generator/VERSION

@@ -0,0 +1 @@
+5.0.1-SNAPSHOT