Merge pull request #194 from regulaforensics/new-openapi

UPDATED GENERATOR

Author: KirylKovaliov

.eslintignore

@@ -16,7 +16,7 @@ env:
   # List of paths (space separated) to ignore
   # Supports PATTERNS
   # EXCLUDE_PATHS: 'foo bar/baz file.txt dir/*.yml'
-  EXCLUDE_PATHS: 'examples'
+  EXCLUDE_PATHS: 'examples generator-templates'
   # List of rules (space separated) to ignore
   # EXCLUDE_RULES: 'generic.secrets.security.detected-aws-account-id.detected-aws-account-id'
   # See https://github.com/semgrep/semgrep-rules for rules registry

.eslintrc.cjs

@@ -1,12 +1,27 @@
 # Development
 
-Js client is written using typescript, mainly generated from [openapi spec](https://github.com/regulaforensics/DocumentReader-api-openapi). 
-Openapi-generator output used as implementation base(see packages `/src/api`, `/scr/models`). 
-All custom logic, on top of generated files, should be places in `/src/ext` folder.
+Models generation based on [openapi spec](https://github.com/regulaforensics/DocumentReader-api-openapi).
+
+## Generation
 
 To regenerate models from openapi definition, 
-clone [latest open api definitions](https://github.com/regulaforensics/DocumentReader-api-openapi)
-and use next command from the project root:
+clone [latest open api definitions](https://github.com/regulaforensics/DocumentReader-api-openapi) 
+and use next command from the project root.
 ```bash
 ./update-models.sh
 ```
+
+## Generator configuration Features
+
+1. The generator treats the discriminator value as a string, 
+but in our case it's numbers. To solve this problem, changes 
+have been made to the modelOneOf.mustache template.
+
+## Problem solving
+
+To solve new problems, use the generator 
+settings ([typescript](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/typescript-axios.md), 
+[common](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/customization.md)) 
+and [templates](https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator/src/main/resources/typescript-axios).
+
+**Do not edit the generated files! They will be overwritten after generation!**

.github/workflows/sast.yaml

@@ -0,0 +1,27 @@
+import globals from 'globals';
+import pluginJs from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import prettierRecommended from 'eslint-plugin-prettier/recommended';
+
+export default [
+    {
+        files: ['**/*.{js,mjs,cjs,ts}'],
+    },
+    {
+        languageOptions: {
+            globals: { ...globals.browser, ...globals.node },
+        },
+    },
+    pluginJs.configs.recommended,
+    ...tseslint.configs.recommended,
+    prettierRecommended,
+    {
+        ignores: ['dist/*', 'lib/*', '!.*'],
+    },
+    {
+        rules: {
+            '@typescript-eslint/no-explicit-any': 'off',
+            '@typescript-eslint/no-unused-vars': 'off',
+        },
+    },
+];

dev.md

@@ -3,7 +3,7 @@
   "type": "module",
   "dependencies": {
     "@regulaforensics/document-reader-webclient": "file:../../..",
-    "axios": "^1.8.3",
+    "axios": "^1.8.4",
     "qs": "^6.14.0"
   },
   "version": "0.0.0"

eslint.config.js

@@ -9,7 +9,7 @@
     "start": "node index.js"
   },
   "dependencies": {
-    "axios": "^1.8.3",
+    "axios": "^1.8.4",
     "body-parser": "^1.20.3",
     "cors": "^2.8.5",
     "express": "^5.0.1",

examples/auth/client/package-lock.json

@@ -54,20 +54,34 @@ If the instance has been launched successfully, use the following line command t
 API_BASE_PATH="http://127.0.0.1:8080" node .
 ```
 
+### Output
 
-
-### Output 
 This sample generates the following text output:
+
 ```text
-    ---------------------------------------------------------------------------
-                   Document Overall Status: 0
-                    Document Number Visual: OO0000000
-                       Document Number MRZ: OO0000000
-        Validity Of Document Number Visual: 0
-           Validity Of Document Number MRZ: 0
-              MRZ-Visual values comparison: 1
-    ---------------------------------------------------------------------------
+---------------------------------------------------------------
+Document name: Germany - ePassport (2017) Service
+---------------------------------------------------------------
+
+[Surname]
+  - Source: VISUAL
+    Value : MUSTERMANN
+---------------------------------------------------------------
+
+[Surname And Given Names]
+  - Source: VISUAL
+    Value : MUSTERMANN ERIKA
+---------------------------------------------------------------
+
+[Document Status]
+  - Source: MRZ
+    Value : SPECIMEN
+  - Source: VISUAL
+    Value : SPECIMEN
+
+...
 ```
+
 Also, it stores [portrait](portrait.jpg) and [document image](document-image.jpg) images in the current folder.
-You can modify [this example](/index.js)
+You can modify [this example](./index.js)
 and re-run it to get your own results.