Provide support for OpenAPI 3.1.0

.eslintrc

@@ -7,10 +7,12 @@
   },
   "globals": {
     "File": true,
-    "Blob": true
+    "Blob": true,
+    "globalThis": true
   },
   "parserOptions": {
     "sourceType": "module",
+    "ecmaVersion": 2020,
     "ecmaFeatures": {
       "impliedStrict": true
     }
@@ -32,6 +34,20 @@
         "ignorePackages": true
       }
     ],
+    "import/no-unresolved": [
+      2,
+      {
+        "ignore": [
+          "^@swagger-api/apidom-reference/configuration/empty$",
+          "^@swagger-api/apidom-reference/dereference/strategies/openapi-3-1$",
+          "^@swagger-api/apidom-reference/dereference/strategies/openapi-3-1/selectors/\\$anchor$",
+          "^@swagger-api/apidom-reference/dereference/strategies/openapi-3-1/selectors/uri$",
+          "^@swagger-api/apidom-reference/resolve/resolvers/file$",
+          "^@swagger-api/apidom-reference/resolve/strategies/openapi-3-1$",
+          "^@swagger-api/apidom-reference/parse/parsers/binary$"
+        ]
+      }
+    ],
     "prettier/prettier": "error",
     "no-param-reassign": 0, // needs to be eliminated in future
     "no-use-before-define": [2, "nofunc"] // needs to be eliminated in future

.github/workflows/nodejs.yml

@@ -23,6 +23,8 @@ jobs:
       uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}
+        registry-url: https://npm.pkg.github.com/
+        scope: "@swagger-api"
     - name: Cache Node Modules
       id: cache-node-modules
       uses: actions/cache@v3
@@ -32,6 +34,8 @@ jobs:
     - name: Install dependencies
       if: steps.cache-node-modules.outputs.cache-hit != 'true'
       run: npm ci
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     - name: Lint commit message
       if: github.ref != 'refs/heads/main' && github.actor != 'dependabot[bot]'
       run: git log -1 --pretty=format:"%s" | npx commitlint
@@ -57,38 +61,48 @@ jobs:
 
     steps:
     - uses: actions/checkout@v3
-    - name: Use Node.js 12.4.x
+    - name: Use Node.js 12.20.0
       uses: actions/setup-node@v3
       with:
-        node-version: 12.4.x
+        node-version: 12.20.0
+        registry-url: https://npm.pkg.github.com/
+        scope: "@swagger-api"
+
     - name: Cache Node Modules
       id: cache-node-modules
       uses: actions/cache@v3
       with:
         path: node_modules
         key: node-modules-${{ hashFiles('package-lock.json') }}
+
     - name: Install dependencies
       if: steps.cache-node-modules.outputs.cache-hit != 'true'
       run: npm ci
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
     - name: Download commonjs build artifacts
       uses: actions/download-artifact@v3
       with:
         name: commonjs
 
-    - name: Run commonjs build artifacts on Node.js 12.4.x
+    - name: Run commonjs build artifacts on Node.js 12.20.0
       run: node -p "require('./commonjs')"
 
     - name: Use Node 14.x
       uses: actions/setup-node@v3
       with:
         node-version: 14.x
+        registry-url: https://npm.pkg.github.com/
+        scope: "@swagger-api"
     - name: Run commonjs build artifacts on Node.js 14.x
       run: node -p "require('./commonjs')"
 
     - name: Use Node 16.x
       uses: actions/setup-node@v3
       with:
         node-version: 16.x
+        registry-url: https://npm.pkg.github.com/
+        scope: "@swagger-api"
     - name: Run commonjs build artifacts on Node.js 16.x
       run: node -p "require('./commonjs')"

.github/workflows/release.yml

@@ -3,34 +3,27 @@ on:
   workflow_dispatch:
     branches:
       - alpha
-
-  workflow_run:
-    workflows:
-      - "Node.js CI"
-    branches:
-      - master
-    types:
-      - completed
+
 jobs:
   release:
     name: Release
     runs-on: ubuntu-latest
-    if: ${{ github.event.workflow_run.conclusion == 'success' }}
     steps:
       - name: Checkout
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
           persist-credentials: false
-
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
           node-version: 16
-
+          registry-url: https://npm.pkg.github.com/
+          scope: "@swagger-api"
       - name: Install dependencies
         run: npm ci
-
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Semantic Release
         id: semantic
         uses: cycjimmy/[email protected]
@@ -41,7 +34,6 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.SWAGGER_BOT_GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-
       - name: Release published
         if: steps.semantic.outputs.new_release_published == 'true'
         run: |

.npmrc

@@ -0,0 +1 @@
+@swagger-api:registry=https://npm.pkg.github.com

.nvmrc

@@ -1 +1 @@
-14.17
+16.16

.releaserc

@@ -1,7 +1,8 @@
 {
   "release": {
     "branches": [
-      {"name": "master"}
+      {"name": "master"},
+      {"name": "alpha", "channel": "alpha", "prerelease": "alpha"}
     ],
     "tagFormat": "v${version}"
   },

README.md

@@ -16,16 +16,17 @@ For features known to be missing from 3.x please see the [Graveyard](docs/migrat
 For the older version of swagger-js, refer to the [*2.x branch*](https://github.com/swagger-api/swagger-js/tree/2.x).
 
 > *The npm package is called `swagger-client` and the GitHub repository is `swagger-js`.
-We'll be consolidating that soon. Just giving you the heads up. You may see references to both names.*
+We'll be consolidating that soon. Just giving you the heads-up. You may see references to both names.*
 
 ## Compatibility
 The OpenAPI Specification has undergone multiple revisions since initial creation in 2010. 
 Compatibility between Swagger Client and the OpenAPI Specification is as follows:
 
-Swagger Client Version | Release Date | OpenAPI Spec compatibility | Notes
------------------- | ------------ | -------------------------- | -----
-3.10.x | 2020-01-17 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3 | [tag v3.10.0](https://github.com/swagger-api/swagger-js/tree/v3.10.0)
-2.1.32 | 2017-01-12 | 1.0, 1.1, 1.2 | [tag v2.1.32](https://github.com/swagger-api/swagger-js/tree/v2.1.32). This [release](https://github.com/swagger-api/swagger-js/releases/tag/v2.1.32) is only available on GitHub.
+Swagger Client Version | Release Date | OpenAPI Spec compatibility             | Notes
+------------------ |--------------|----------------------------------------| -----
+3.19.x | 2023-01-23   | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0 | [tag v3.19.0-alpha.3](https://github.com/swagger-api/swagger-js/releases/tag/v3.19.0-alpha.3)
+3.10.x | 2020-01-17   | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3        | [tag v3.10.0](https://github.com/swagger-api/swagger-js/tree/v3.10.0)
+2.1.32 | 2017-01-12   | 1.0, 1.1, 1.2                          | [tag v2.1.32](https://github.com/swagger-api/swagger-js/tree/v2.1.32). This [release](https://github.com/swagger-api/swagger-js/releases/tag/v2.1.32) is only available on GitHub.
 
 ## Documentation
 
@@ -51,7 +52,7 @@ Swagger Client Version | Release Date | OpenAPI Spec compatibility | Notes
 
 ### Runtime 
 
-- Node.js `>=` 12.4.x
+- Node.js `>=`12.20.0
 - `swagger-client` works in the latest versions of Chrome, Safari, Firefox, and Edge.
 
 ## Security contact

babel.config.js

@@ -10,7 +10,7 @@ module.exports = {
             corejs: { version: 3 },
             useBuiltIns: false,
             targets: {
-              node: '12.4',
+              node: '12.20.0',
             },
             forceAllTransforms: false,
             ignoreBrowserslistConfig: true,

config/jest/jest.artifact-commonjs.config.js

@@ -4,4 +4,20 @@ module.exports = {
   rootDir: path.join(__dirname, '..', '..'),
   testEnvironment: 'node',
   testMatch: ['**/test/build-artifacts/commonjs.js'],
+  moduleNameMapper: {
+    /**
+     * This is here only until next version of Jest is released - 29.4.x.
+     * Jest doesn't support package.json imports fields now, so we have
+     * to provide this workaround.
+     *
+     * More information in https://github.com/facebook/jest/issues/12270.
+     *
+     */
+    '#buffer':
+      '<rootDir>/node_modules/@swagger-api/apidom-reference/cjs/util/polyfills/buffer/protocol-import.cjs',
+    '#fs':
+      '<rootDir>/node_modules/@swagger-api/apidom-reference/cjs/util/polyfills/fs/protocol-import.cjs',
+    '#util':
+      '<rootDir>/node_modules/@swagger-api/apidom-reference/cjs/util/polyfills/util/protocol-import.cjs',
+  },
 };

config/jest/jest.artifact-es.config.js

@@ -4,4 +4,20 @@ module.exports = {
   rootDir: path.join(__dirname, '..', '..'),
   testEnvironment: 'node',
   testMatch: ['**/test/build-artifacts/es.js'],
+  moduleNameMapper: {
+    /**
+     * This is here only until next version of Jest is released - 29.4.x.
+     * Jest doesn't support package.json imports fields now, so we have
+     * to provide this workaround.
+     *
+     * More information in https://github.com/facebook/jest/issues/12270.
+     *
+     */
+    '#buffer':
+      '<rootDir>/node_modules/@swagger-api/apidom-reference/cjs/util/polyfills/buffer/protocol-import.cjs',
+    '#fs':
+      '<rootDir>/node_modules/@swagger-api/apidom-reference/cjs/util/polyfills/fs/protocol-import.cjs',
+    '#util':
+      '<rootDir>/node_modules/@swagger-api/apidom-reference/cjs/util/polyfills/util/protocol-import.cjs',
+  },
 };

config/jest/jest.unit.config.js

@@ -8,12 +8,28 @@ module.exports = {
   moduleNameMapper: {
     'formdata-node/lib/cjs/fileFromPath.js':
       '<rootDir>/node_modules/formdata-node/lib/cjs/fileFromPath.js',
+    /**
+     * This is here only until next version of Jest is released - 29.4.x.
+     * Jest doesn't support package.json imports fields now, so we have
+     * to provide this workaround.
+     *
+     * More information in https://github.com/facebook/jest/issues/12270.
+     *
+     */
+    '#buffer':
+      '<rootDir>/node_modules/@swagger-api/apidom-reference/cjs/util/polyfills/buffer/protocol-import.cjs',
+    '#fs':
+      '<rootDir>/node_modules/@swagger-api/apidom-reference/cjs/util/polyfills/fs/protocol-import.cjs',
+    '#util':
+      '<rootDir>/node_modules/@swagger-api/apidom-reference/cjs/util/polyfills/util/protocol-import.cjs',
   },
   testPathIgnorePatterns: [
     '<rootDir>/node_modules/',
     '<rootDir>/test/data/',
     '<rootDir>/test/jest.setup.js',
     '<rootDir>/test/specmap/data/',
     '<rootDir>/test/build-artifacts/',
+    '/__fixtures__/',
+    '/__utils__/',
   ],
 };

config/jest/jest.unit.coverage.config.js

@@ -1,15 +1,15 @@
-const unitConfig = require('./jest.unit.config');
+const unitConfig = require('./jest.unit.config.js');
 
 module.exports = {
   ...unitConfig,
   collectCoverage: true,
   collectCoverageFrom: ['src/**/*.js'],
   coverageThreshold: {
     './src/': {
-      branches: 87,
+      branches: 86,
       functions: 91,
       lines: 90,
-      statements: 90,
+      statements: 89,
     },
   },
 };

config/webpack/browser.config.babel.js

@@ -50,7 +50,7 @@ const browser = {
     }),
     new DuplicatesPlugin({
       // emit compilation warning or error? (Default: `false`)
-      emitErrors: true,
+      emitErrors: false, // https://github.com/FormidableLabs/inspectpack/issues/181
       // display full duplicates information? (Default: `false`)
       verbose: true,
     }),
@@ -74,7 +74,7 @@ const browserMin = {
   devtool: 'source-map',
   performance: {
     hints: 'error',
-    maxEntrypointSize: 270000,
+    maxEntrypointSize: 500000,
     maxAssetSize: 1300000,
   },
   output: {

docs/development/scripts.md

@@ -13,7 +13,7 @@ Script name | Description
 --- | ---
 `build` | Build a new set of JS assets, and output them to `/dist` and `/browser`.
 `build:umd:browser` | Build `/dist/swagger-client.browser.*.js` files.
-`build:common` | Build `/lib` directory containing ES5 code with commonjs imports.
+`build:commonjs` | Build `/lib` directory containing ES5 code with commonjs imports.
 `build:es` | Build `/es` directory containing ES5 code with ES6 imports
 
 ### Testing
@@ -31,8 +31,5 @@ Script name | Description
 
 Script name | Description
 --- | ---
-`security-audit` | Runs npm security audit for production and development dependencies.
-`security-audit:dev` | Runs npm security audit for all development dependencies with `moderate` audit level. 
-`security-audit:prod` | Runs npm security audit for production dependencies with `low` audit level.
 `deps:license` | Generates attribution files for production and development dependencies
 

docs/development/setting-up.md

@@ -3,21 +3,46 @@
 ### Prerequisites
 
 - git, any version
-- NPM >=6.12.x
+- Node.js >=16.16
+- NPM >=8.11.0
 
 Generally, we recommend following guidelines from [Node.js Releases](https://nodejs.org/en/about/releases/) to only use `Current`, `Active LTS` or `Maintenance LTS` releases.
 
-Current Node.js:
-- Node.js 16.x
-- NPM >=7.10.x
+### Setting up
 
-Current Node.js Active LTS:
-- Node.js >=14.x
-- NPM >=6.14.x
+If you use [nvm](https://github.com/nvm-sh/nvm), running following command inside this repository will automatically pick the right Node.js version for you:
 
-Current Node.js Maintenance LTS:
-- Node.js >12.4
-- NPM >=6.12.x
+```sh
+ $ nvm use
+```
+
+This repository is using npm packages from https://www.npmjs.com/ and [GitHub packages registry](https://docs.github.com/en/packages/learn-github-packages/introduction-to-github-packages). 
+To successfully install npm packages that SwaggerEditor requires, you need to [Authenticate to GitHub Packages](https://docs.github.com/en/packages/learn-github-packages/introduction-to-github-packages).
+
+You can authenticate to GitHub Packages with npm by either editing your per-user *~/.npmrc*
+file to include your personal access token (classic) or by logging in to npm on the command line using your username and personal access token.
+
+To authenticate by adding your personal access token (classic) to your *~/.npmrc* file,
+edit the *~/.npmrc* file for your project to include the following line,
+replacing TOKEN with your personal access token. Create a new *~/.npmrc* file if one doesn't exist.
+You can find more information about authenticating to GitHub Packages in [GitHub documentation](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-to-github-packages).
+
+```
+//npm.pkg.github.com/:_authToken=TOKEN
+```
+
+
+Alternatively, to authenticate by logging in to npm, use the `npm login` command,
+replacing USERNAME with your GitHub username, TOKEN with your personal access token (classic),
+and PUBLIC-EMAIL-ADDRESS with your email address.
+
+```sh
+$ npm login --scope=@swagger-api --registry=https://npm.pkg.github.com
+
+> Username: USERNAME
+> Password: TOKEN
+> Email: PUBLIC-EMAIL-ADDRESS
+```
 
 ### Steps