Merge pull request #458 from acacode/next

Release 13.0.0

Author: js2me

.env.example

@@ -0,0 +1,3 @@
+TEST_FILE_NAME=github-swagger.ts
+TEST_SCHEMA_VERSION=v3
+TEST_WITH_DEBUG=true

.prettierignore renamed to .eslintignore

@@ -1,3 +1,16 @@
+.eslintrc
+node_modules
+.husky
+.vscode
+swagger-test-cli
+tests
+*.ejs
+*.eta
+.kube
+.idea
+*.json
+.eslintrc.js
+vite.config.ts
 tests/**/*.ts
 tests/**/schema.js
 tests/**/schema.ts
@@ -7,7 +20,6 @@ swagger-test-cli.*
 templates
 *.md
 .github
-node_modules
 .openapi-generator
 .vscode
 assets

.eslintrc.js

@@ -0,0 +1,29 @@
+module.exports = {
+    parserOptions: {
+        "ecmaVersion": "latest"
+    },
+    env: {
+        "node": true,
+        "es6": true
+    },
+    extends: [
+        'eslint:recommended',
+        'plugin:prettier/recommended',
+    ],
+    plugins: [
+        'prettier',
+    ],
+    rules: {
+        'prettier/prettier': [
+            'error',
+            {
+                endOfLine: 'auto',
+                printWidth: 80,
+                tabWidth: 2,
+                trailingComma: 'all',
+                semi: true,
+                singleQuote: true,
+            },
+        ],
+    },
+};

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    open-pull-requests-limit: 100
+    schedule:
+      interval: "daily"

.github/workflows/main.yml

@@ -1,37 +1,94 @@
-# This is a basic workflow to help you get started with Actions
+name: Builds, tests & co
 
-name: Run tests
-
-# Controls when the action will run. 
 on:
-  # Triggers the workflow on push or pull request events but only for the master branch
-  pull_request:
-    branches: [ master, next ]
-
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
+  - push
+  - pull_request
 
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-  # This workflow contains a single job called "build"
-  build:
-    # The type of runner that the job will run on
-    runs-on: ubuntu-latest
+  build-and-test:
     strategy:
+      fail-fast: false
       matrix:
-        node-version: [11.x, 13.x, 15.x]
+        os:
+          - macos-latest
+          - ubuntu-latest
+          - windows-latest
+        node-version:
+          - 16.x
+          - 18.x
 
-    name: Node.js (test-all) ${{ matrix.node-version }}
+    runs-on: ${{ matrix.os }}
 
-    # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v2
+      - name: Checkout tree
+        uses: actions/checkout@v3
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install npm packages
+        run: npm ci --ignore-scripts
+
+      - name: Run the tests
+        run: npm run test-all
+
+  dependabot-auto-approve:
+    name: Dependabot auto-approve
+
+    permissions:
+      pull-requests: write
+
+    needs:
+      - build-and-test
+
+    if: ${{ github.event_name == 'pull_request' && github.actor == 'dependabot[bot]' }}
+
+    runs-on: ubuntu-latest
 
-      # Runs a single command using the runners shell
-      - name: install deps
-        run: npm i
+    steps:
+      - name: Fetch Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v1
+
+      - name: Get the PR review decision
+        id: gh-pr-review
+        run: echo "decision=$(gh pr view --json reviewDecision --jq '. | .reviewDecision' "$PR_URL")" >>"$GITHUB_OUTPUT"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GITHUB_TOKEN: ${{ github.token }}
+
+      - name: Approve a PR
+        if: ${{ steps.gh-pr-review.outputs.decision != 'APPROVED' && steps.metadata.outputs.update-type == 'version-update:semver-patch' }}
+        run: gh pr review --approve "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GITHUB_TOKEN: ${{ github.token }}
+
+  dependabot-auto-merge:
+    name: Dependabot auto-merge
+
+    permissions:
+      contents: write
+      pull-requests: write
+
+    if: ${{ github.event_name == 'pull_request' && github.actor == 'dependabot[bot]' }}
+
+    needs:
+      - build-and-test
+      - dependabot-auto-approve
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Fetch Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v1
 
-      # Runs a set of commands using the runners shell
-      - name: test
-        run: npm run test-all-extended
+      - name: Merge Dependabot PR
+        if: ${{ steps.metadata.outputs.update-type == 'version-update:semver-patch' }}
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GITHUB_TOKEN: ${{ github.token }}

.gitignore

@@ -3,4 +3,5 @@ node_modules
 .idea
 swagger-test-cli.*
 swagger-test-cli
-dist
+dist
+.env

.husky/post-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+git update-index -g

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run lint:fix

.ncurc.json

@@ -0,0 +1,7 @@
+{
+  "upgrade": true,
+  "reject": [
+    "nanoid",
+    "eta"
+  ]
+}

.nvmrc

@@ -1 +1 @@
-16.16.0
+18.16.1

.prettierrc

@@ -4,14 +4,6 @@
   // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
-    {
-      "name": "Debug generate",
-      "type": "node",
-      "request": "launch",
-      "cwd": "${workspaceFolder}",
-      "runtimeExecutable": "npm",
-      "runtimeArgs": ["run-script", "generate:debug"]
-    },
     {
       "name": "Debug JSON CLI",
       "type": "node",
@@ -60,14 +52,6 @@
       "runtimeExecutable": "npm",
       "runtimeArgs": ["run-script", "test-all"]
     },
-    {
-      "name": "Debug test-all-extended",
-      "type": "node",
-      "request": "launch",
-      "cwd": "${workspaceFolder}",
-      "runtimeExecutable": "npm",
-      "runtimeArgs": ["run-script", "test-all-extended"]
-    },
     {
       "name": "Debug test:--extract-request-body",
       "type": "node",

.vscode/launch.json

@@ -1,5 +1,60 @@
 # next release  
 
+BREAKING_CHANGE: disable support NodeJS 14.x  
+BREAKING_CHANGE: change swagger-typescript-api NodeJS "generateApi" function return type  
+BREAKING_CHANGE: remove `rawModelTypes` from output api configuration  
+feat: `--custom-config <string>` option (#503)  
+feat: `--sort-routes` option, ability to sort routes;  
+fix: critical bugs based with extract types and enums  
+fix: sort types option (sort was not correctly work with nested or extracted types)  
+fix: problems based with extracting enums;  
+fix: nullable enum with integer values (#543)   
+fix: generation enum numbers as strings one (#534)  
+chore: refactoring the axios imports  
+fix: non-object custom spec extensions (#500)  
+fix(docs): input instead of output in readme  
+internal: remove redundant internal scripts  
+internal: change process with using custom templates  
+
+```diff
+interface GenerateApiOutput {
+...
+-  files: { name: string; content: string; declaration: { name: string; content: string } | null }[];
++  files: { fileName: string; fileContent: string; fileExtension: string }[];
+...
+}
+```
+
+internal: refactor schema parser code (preparing it for async code execution)  
+fix: problem with filtering primitive in complex types (#459)  
+feat: add discriminator property support (#456)  
+internal: prepare code + templates for async code execution (next plans)  
+fix: problems with dot in query params (hard fix) (#460)   
+feature: ability to send custom Ts output code translator to js. Example:  
+```ts
+ const { Translator } = require("swagger-typescript-api/src/translators/translator");
+ const { JavascriptTranslator } = require("swagger-typescript-api/src/translators/javascript");
+
+ class MyTranslator extends Translator { // or use extends JavascriptTranslator
+     translate({ fileName, fileExtension, fileContent }) {
+         // format ts\js code with using this codeFormatter (prettier + ts import fixer)
+         this.codeFormatter.format(fileContent)
+         // config of the code gen process
+         this.config.
+         // logger
+         this.logger.
+
+         return [
+             {
+                 fileName,
+                 fileExtension,
+                 fileContent,
+             }
+         ]
+     }
+ }
+```
+
 ## 12.0.4  
 
 fix: onCreateRoute skip behaviour  
@@ -484,7 +539,7 @@ Features:
     name?: string;
     path?: string;
   }) => string
-  formatTSContent: (content: string) => string;
+  formatTSContent: (content: string) => Promise<string>;
 
 
   // ...

CHANGELOG.md

@@ -106,7 +106,7 @@ const { generateApi, generateTemplates } = require('swagger-typescript-api');
 const path = require("path");
 const fs = require("fs");
 
-/* NOTE: all fields are optional expect one of `output`, `url`, `spec` */
+/* NOTE: all fields are optional expect one of `input`, `url`, `spec` */
 generateApi({
   name: "MySuperbApi.ts",
   // set to `false` to prevent the tool from writing to disk

README.md

@@ -1,7 +1,7 @@
-const root_command = Symbol("root");
-const skip_command = Symbol("skip");
+const root_command = Symbol('root');
+const skip_command = Symbol('skip');
 
-const reservedOptions = ["version", "help"];
+const reservedOptions = ['version', 'help'];
 
 module.exports = {
   root_command,