[Typescript Fetch] New optional mode with redux saga & immutablejs (saga & records)

bin/configs/typescript-fetch-sagas-and-records.yaml

@@ -0,0 +1,16 @@
+generatorName: typescript-fetch
+outputDir: samples/client/petstore/typescript-fetch/builds/sagas-and-records
+inputSpec: modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing-saga-and-records.yaml
+additionalProperties:
+  npmVersion: 1.0.0
+  npmName: '@openapitools/typescript-fetch-petstore'
+  npmRepository: https://skimdb.npmjs.com/registry
+  useSingleRequestParameter: false
+  supportsES6: true
+  typescriptThreePlus: true
+  sagasAndRecords: true
+  detectPassthroughModelsWithSuffixAndField: 'Response.data'
+  inferUniqueIdFromNameSuffix: true
+  inferEntityFromUniqueIdWithName: id
+  packageAsSourceOnlyLibrary: false
+  snapshot: false

docs/generators/typescript-fetch.md

@@ -20,6 +20,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |nullSafeAdditionalProps|Set to make additional properties types declare that their indexer may return undefined| |false|
 |prefixParameterInterfaces|Setting this property to true will generate parameter interface declarations prefixed with API class name to avoid name conflicts.| |false|
 |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
+|sagasAndRecords|Setting this property to true will generate additional files for use with redux-saga and immutablejs.| |false|
 |snapshot|When setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm| |false|
 |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|

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

@@ -5457,13 +5457,9 @@ public void updateCodegenPropertyEnum(CodegenProperty var) {
 
         // handle default value for enum, e.g. available => StatusEnum.AVAILABLE
         if (var.defaultValue != null) {
+            final String enumDefaultValue = getEnumDefaultValue(var.defaultValue, dataType);
+
             String enumName = null;
-            final String enumDefaultValue;
-            if (isDataTypeString(dataType)) {
-                enumDefaultValue = toEnumValue(var.defaultValue, dataType);
-            } else {
-                enumDefaultValue = var.defaultValue;
-            }
             for (Map<String, Object> enumVar : enumVars) {
                 if (enumDefaultValue.equals(enumVar.get("value"))) {
                     enumName = (String) enumVar.get("name");
@@ -5476,6 +5472,16 @@ public void updateCodegenPropertyEnum(CodegenProperty var) {
         }
     }
 
+    protected String getEnumDefaultValue(String defaultValue, String dataType) {
+        final String enumDefaultValue;
+        if (isDataTypeString(dataType)) {
+            enumDefaultValue = toEnumValue(defaultValue, dataType);
+        } else {
+            enumDefaultValue = defaultValue;
+        }
+        return enumDefaultValue;
+    }
+
     protected List<Map<String, Object>> buildEnumVars(List<Object> values, String dataType) {
         List<Map<String, Object>> enumVars = new ArrayList<>();
         int truncateIdx = 0;

modules/openapi-generator/src/main/resources/typescript-fetch/ApiEntitiesRecord.mustache

@@ -0,0 +1,26 @@
+import {Map, Record, RecordOf} from 'immutable';
+
+import {
+{{#models}}
+{{#model}}
+{{#isEntity}}
+    {{classname}}RecordEntity,
+{{/isEntity}}
+{{/model}}
+{{/models}}
+} from "./models"
+
+export const ApiEntitiesRecordProps = {
+    recType: "ApiEntitiesRecord" as "ApiEntitiesRecord",
+{{#models}}
+{{#model}}
+{{#isEntity}}
+    {{#lambda.camelcase}}{{classname}}{{/lambda.camelcase}}: ({{classname}}RecordEntity(), Map<string, {{classname}}RecordEntity>()),
+{{/isEntity}}
+{{/model}}
+{{/models}}
+};
+
+export type ApiEntitiesRecordPropsType = typeof ApiEntitiesRecordProps;
+export const ApiEntitiesRecord = Record(ApiEntitiesRecordProps, ApiEntitiesRecordProps.recType);
+export type ApiEntitiesRecord = RecordOf<ApiEntitiesRecordPropsType>;

modules/openapi-generator/src/main/resources/typescript-fetch/ApiEntitiesReducer.mustache

@@ -0,0 +1,21 @@
+import {ApiEntitiesRecord} from "./ApiEntitiesRecord";
+import {ReducerBuilder} from "redux-ts-simple";
+import {normalizedEntities} from "./runtimeSagasAndRecords";
+
+export const ApiEntitiesReducer = new ReducerBuilder(ApiEntitiesRecord())
+    .on(normalizedEntities, (state, action): ApiEntitiesRecord => {
+        const {entities} = action.payload;
+        return state.withMutations(mutableState => {
+            for (const entityKey in entities) {
+                const entityMap = entities[entityKey];
+                const currentEntityMap = mutableState.get(entityKey as any);
+                if (currentEntityMap) {
+                    let mergedEntityMap = currentEntityMap.mergeDeep(entityMap);
+                    if (!mergedEntityMap.equals(currentEntityMap)) {
+                        mutableState.set(entityKey as any, mergedEntityMap);
+                    }
+                }
+            }
+        });
+    })
+    .build();

modules/openapi-generator/src/main/resources/typescript-fetch/ApiEntitiesSelectors.mustache

@@ -0,0 +1,5 @@
+export let getApiEntitiesState: (state: any) => any = (state: any) => state.app.apiEntities;
+
+export function setApiEntitiesStateGetter(getter: (state: any) => any) { // Use this to customize the location where you have placed your ApiEntitiesRecord in your project.
+    getApiEntitiesState = getter;
+}

modules/openapi-generator/src/main/resources/typescript-fetch/allSagas.mustache

@@ -0,0 +1,19 @@
+import {all, fork} from "redux-saga/effects";
+
+import {
+{{#apiInfo}}
+{{#apis}}
+    {{#lambda.camelcase}}{{classFilename}}{{/lambda.camelcase}}AllSagas,
+{{/apis}}
+{{/apiInfo}}
+} from "./";
+
+export function *allApiSagas() {
+    yield all([
+{{#apiInfo}}
+{{#apis}}
+        fork({{#lambda.camelcase}}{{classFilename}}{{/lambda.camelcase}}AllSagas),
+{{/apis}}
+{{/apiInfo}}
+    ]);
+}

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

@@ -1,7 +1,14 @@
+{{#useSagaAndRecords}}
+export * from './SagaApiManager'
+export * from './allSagas'
+{{/useSagaAndRecords}}
 {{#apiInfo}}
 {{#apis}}
 {{#operations}}
 export * from './{{ classFilename }}';
+{{#useSagaAndRecords}}
+export * from './{{{ classFilename }}}Sagas';
+{{/useSagaAndRecords}}
 {{/operations}}
 {{/apis}}
 {{/apiInfo}}

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

@@ -1,4 +1,10 @@
 export * from './runtime';
+{{#useSagaAndRecords}}
+export * from './runtimeSagasAndRecords';
+export * from './ApiEntitiesRecord';
+export * from './ApiEntitiesReducer';
+export * from './ApiEntitiesSelectors';
+{{/useSagaAndRecords}}
 {{#apiInfo}}
 {{#apis.0}}
 export * from './apis';

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

@@ -2,7 +2,13 @@
 {{#model}}
 {{^withoutRuntimeChecks}}
 export * from './{{{ classFilename }}}';
-{{/withoutRuntimeChecks}}{{#withoutRuntimeChecks}}
+{{#useSagaAndRecords}}
+{{^isEnum}}
+export * from './{{{ classFilename }}}Record';
+{{/isEnum}}
+{{/useSagaAndRecords}}
+{{/withoutRuntimeChecks}}
+{{#withoutRuntimeChecks}}
 {{#isEnum}}
 {{>modelEnumInterfaces}}
 {{/isEnum}}

modules/openapi-generator/src/main/resources/typescript-fetch/package.mustache

@@ -3,14 +3,27 @@
   "version": "{{npmVersion}}",
   "description": "OpenAPI client for {{npmName}}",
   "author": "OpenAPI-Generator",
+{{#packageAsSourceOnlyLibrary}}
+  "main": "./index.ts",
+{{/packageAsSourceOnlyLibrary}}
+{{^packageAsSourceOnlyLibrary}}
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",
   "scripts": {
-    "build": "tsc",
+    "build": "tsc"{{^sagasAndRecords}},
     "prepare": "npm run build"
+{{/sagasAndRecords}}
   },
+{{/packageAsSourceOnlyLibrary}}
   "devDependencies": {
-    "typescript": "^{{#typescriptThreePlus}}3.6{{/typescriptThreePlus}}{{^typescriptThreePlus}}2.4{{/typescriptThreePlus}}"
+{{#sagasAndRecords}}
+    "immutable": "^4.0.0-rc.12",
+    "normalizr": "^3.6.1",
+    "redux-saga": "^1.1.3",
+    "redux-ts-simple": "^3.2.0",
+    "reselect": "^4.0.0",
+{{/sagasAndRecords}}
+    "typescript": "^{{#typescriptThreePlus}}3.9.5{{/typescriptThreePlus}}{{^typescriptThreePlus}}2.4{{/typescriptThreePlus}}"
   }{{#npmRepository}},{{/npmRepository}}
 {{#npmRepository}}
   "publishConfig": {