@nocobase/plugin-mcp-server 2.1.0-alpha.16 → 2.1.0-alpha.17

package/dist/node_modules/@apidevtools/swagger-parser/README.md

@@ -1,5 +1,4 @@
-Swagger 2.0 and OpenAPI 3.0 parser/validator
-============================
+# Swagger 2.0 and OpenAPI 3.0 parser/validator
 
 [![Build Status](https://github.com/APIDevTools/swagger-parser/workflows/CI-CD/badge.svg?branch=master)](https://github.com/APIDevTools/swagger-parser/actions)
 [![Coverage Status](https://coveralls.io/repos/github/APIDevTools/swagger-parser/badge.svg?branch=master)](https://coveralls.io/github/APIDevTools/swagger-parser)
@@ -8,44 +7,34 @@ Swagger 2.0 and OpenAPI 3.0 parser/validator
 [![npm](https://img.shields.io/npm/v/@apidevtools/swagger-parser.svg)](https://www.npmjs.com/package/@apidevtools/swagger-parser)
 [![Dependencies](https://david-dm.org/APIDevTools/swagger-parser.svg)](https://david-dm.org/APIDevTools/swagger-parser)
 [![License](https://img.shields.io/npm/l/@apidevtools/swagger-parser.svg)](LICENSE)
-[![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen)](https://plant.treeware.earth/APIDevTools/swagger-parser)
+[![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen)](https://shop.protect.earth/)
 
-[![OS and Browser Compatibility](https://apitools.dev/img/badges/ci-badges-with-ie.svg)](https://github.com/APIDevTools/swagger-parser/actions)
+[![OS and Browser Compatibility](https://apidevtools.com/img/badges/ci-badges-with-ie.svg)](https://github.com/APIDevTools/swagger-parser/actions)
 
-[![Online Demo](https://apitools.dev/swagger-parser/online/img/demo.svg)](https://apitools.dev/swagger-parser/online/)
+## Features
 
-
-
-Features
---------------------------
 - Parses Swagger specs in **JSON** or **YAML** format
 - Validates against the [Swagger 2.0 schema](https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v2.0/schema.json) or [OpenAPI 3.0 Schema](https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v3.0/schema.json)
-- [Resolves](https://apitools.dev/swagger-parser/docs/swagger-parser.html#resolveapi-options-callback) all `$ref` pointers, including external files and URLs
-- Can [bundle](https://apitools.dev/swagger-parser/docs/swagger-parser.html#bundleapi-options-callback) all your Swagger files into a single file that only has _internal_ `$ref` pointers
-- Can [dereference](https://apitools.dev/swagger-parser/docs/swagger-parser.html#dereferenceapi-options-callback) all `$ref` pointers, giving you a normal JavaScript object that's easy to work with
+- [Resolves](https://apidevtools.com/swagger-parser/docs/swagger-parser.html#resolveapi-options-callback) all `$ref` pointers, including external files and URLs
+- Can [bundle](https://apidevtools.com/swagger-parser/docs/swagger-parser.html#bundleapi-options-callback) all your Swagger files into a single file that only has _internal_ `$ref` pointers
+- Can [dereference](https://apidevtools.com/swagger-parser/docs/swagger-parser.html#dereferenceapi-options-callback) all `$ref` pointers, giving you a normal JavaScript object that's easy to work with
 - **[Tested](https://github.com/APIDevTools/swagger-parser/actions)** in Node.js and all modern web browsers on Mac, Windows, and Linux
 - Tested on **[over 1,500 real-world APIs](https://apis.guru/browse-apis/)** from Google, Microsoft, Facebook, Spotify, etc.
-- Supports [circular references](https://apitools.dev/swagger-parser/docs/#circular-refs), nested references, back-references, and cross-references
+- Supports [circular references](https://apidevtools.com/swagger-parser/docs/#circular-refs), nested references, back-references, and cross-references
 - Maintains object reference equality — `$ref` pointers to the same value always resolve to the same object instance
 
+## Related Projects
 
-
-Related Projects
---------------------------
 - [Swagger CLI](https://github.com/APIDevTools/swagger-cli)
 - [Swagger Express Middleware](https://github.com/APIDevTools/swagger-express-middleware)
 
-
-
-Example
---------------------------
+## Example
 
 ```javascript
 SwaggerParser.validate(myAPI, (err, api) => {
   if (err) {
     console.error(err);
-  }
-  else {
+  } else {
     console.log("API name: %s, Version: %s", api.info.title, api.info.version);
   }
 });
@@ -57,28 +46,23 @@ Or use `async`/`await` or [Promise](http://javascriptplayground.com/blog/2015/02
 try {
   let api = await SwaggerParser.validate(myAPI);
   console.log("API name: %s, Version: %s", api.info.title, api.info.version);
-}
-catch(err) {
+} catch (err) {
   console.error(err);
 }
 ```
 
-For more detailed examples, please see the [API Documentation](https://apitools.dev/swagger-parser/docs/)
-
+For more detailed examples, please see the [API Documentation](https://apidevtools.com/swagger-parser/docs/)
 
+## Installation
 
-Installation
---------------------------
 Install using [npm](https://docs.npmjs.com/about-npm/):
 
 ```bash
 npm install @apidevtools/swagger-parser
 ```
 
+## Usage
 
-
-Usage
---------------------------
 When using Swagger Parser in Node.js apps, you'll probably want to use **CommonJS** syntax:
 
 ```javascript
@@ -88,59 +72,51 @@ const SwaggerParser = require("@apidevtools/swagger-parser");
 When using a transpiler such as [Babel](https://babeljs.io/) or [TypeScript](https://www.typescriptlang.org/), or a bundler such as [Webpack](https://webpack.js.org/) or [Rollup](https://rollupjs.org/), you can use **ECMAScript modules** syntax instead:
 
 ```javascript
-import * as SwaggerParser from '@apidevtools/swagger-parser';
+import * as SwaggerParser from "@apidevtools/swagger-parser";
 ```
 
+## Browser support
 
-
-Browser support
---------------------------
-Swagger Parser supports recent versions of every major web browser.  Older browsers may require [Babel](https://babeljs.io/) and/or [polyfills](https://babeljs.io/docs/en/next/babel-polyfill).
+Swagger Parser supports recent versions of every major web browser. Older browsers may require [Babel](https://babeljs.io/) and/or [polyfills](https://babeljs.io/docs/en/next/babel-polyfill).
 
 To use Swagger Parser in a browser, you'll need to use a bundling tool such as [Webpack](https://webpack.js.org/), [Rollup](https://rollupjs.org/), [Parcel](https://parceljs.org/), or [Browserify](http://browserify.org/). Some bundlers may require a bit of configuration, such as setting `browser: true` in [rollup-plugin-resolve](https://github.com/rollup/rollup-plugin-node-resolve).
 
+## API Documentation
 
+Full API documentation is available [right here](https://apidevtools.com/swagger-parser/docs/)
 
-API Documentation
---------------------------
-Full API documentation is available [right here](https://apitools.dev/swagger-parser/docs/)
+## Security
 
+The library, by default, attempts to resolve any files referenced using `$ref`, without considering file extensions or the location of the files. This can result in Local File Inclusion (LFI), thus, potentially sensitive information disclosure. Developers must be cautious when working with documents from untrusted sources. See [here](SECURITY.md) for more details and information on how to mitigate LFI.
 
+## Contributing
 
-Contributing
---------------------------
-I welcome any contributions, enhancements, and bug-fixes.  [Open an issue](https://github.com/APIDevTools/swagger-parser/issues) on GitHub and [submit a pull request](https://github.com/APIDevTools/swagger-parser/pulls).
+I welcome any contributions, enhancements, and bug-fixes. [Open an issue](https://github.com/APIDevTools/swagger-parser/issues) on GitHub and [submit a pull request](https://github.com/APIDevTools/swagger-parser/pulls).
 
-#### Building/Testing
-To build/test the project locally on your computer:
+To test the project locally on your computer:
 
-1. __Clone this repo__<br>
-`git clone https://github.com/APIDevTools/swagger-parser.git`
+1. **Clone this repo**<br>
+   `git clone https://github.com/APIDevTools/swagger-parser.git`
 
-2. __Install dependencies__<br>
-`npm install`
+2. **Install dependencies**<br>
+   `npm install`
 
-3. __Run the build script__<br>
-`npm run build`
+3. **Run the tests**<br>
+   `npm test`
 
-4. __Run the tests__<br>
-`npm test`
+4. **Check the code coverage**<br>
+   `npm run coverage`
 
-5. __Check the code coverage__<br>
-`npm run coverage`
+## License
 
-License
---------------------------
 Swagger Parser is 100% free and open-source, under the [MIT license](LICENSE). Use it however you want.
 
-This package is [Treeware](http://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/APIDevTools/swagger-parser) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
-
+This package is [Treeware](http://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://shop.protect.earth) to thank us for our work.
 
+## Big Thanks To
 
-Big Thanks To
---------------------------
 Thanks to these awesome companies for their support of Open Source developers ❤
 
-[![GitHub](https://apitools.dev/img/badges/github.svg)](https://github.com/open-source)
-[![NPM](https://apitools.dev/img/badges/npm.svg)](https://www.npmjs.com/)
-[![Coveralls](https://apitools.dev/img/badges/coveralls.svg)](https://coveralls.io)
+[![GitHub](https://apidevtools.com/img/badges/github.svg)](https://github.com/open-source)
+[![NPM](https://apidevtools.com/img/badges/npm.svg)](https://www.npmjs.com/)
+[![Coveralls](https://apidevtools.com/img/badges/coveralls.svg)](https://coveralls.io)