mastra 0.1.57-alpha.9 → 0.1.57-unstable.34

package/node_modules/express-jsdoc-swagger/README.md

@@ -0,0 +1,376 @@
+![npm](https://img.shields.io/npm/v/express-jsdoc-swagger)
+![Node.js Package](https://github.com/BRIKEV/express-jsdoc-swagger/workflows/Build/badge.svg)
+[![Known Vulnerabilities](https://snyk.io/test/github/BRIKEV/express-jsdoc-swagger/badge.svg)](https://snyk.io/test/github/BRIKEV/express-jsdoc-swagger)
+[![Maintainability](https://api.codeclimate.com/v1/badges/6d5565df0c9c10e75b59/maintainability)](https://codeclimate.com/github/BRIKEV/express-jsdoc-swagger/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/6d5565df0c9c10e75b59/test_coverage)](https://codeclimate.com/github/BRIKEV/express-jsdoc-swagger/test_coverage)
+![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)
+![npm](https://img.shields.io/npm/dm/express-jsdoc-swagger)
+
+# express-jsdoc-swagger
+
+With this library, you can document your express endpoints using swagger [OpenAPI 3 Specification](https://swagger.io/specification/) without writing YAML or JSON. You can write comments similar to `jsdoc` on each endpoint, and the dependecy is going to create the swagger UI.
+
+## Table of Contents
+
+1. [Prerequisites](#Prerequisites)
+2. [Installation](#Installation)
+3. [Basic Usage](#Basic-Usage)
+4. [Basic Examples](#Basic-Examples)
+	- [Advanced examples](https://github.com/BRIKEV/express-jsdoc-swagger/tree/master/examples)
+	- [Official docs](https://brikev.github.io/express-jsdoc-swagger-docs/#/)
+5. [Validator](#Validator)
+6. [VSCode extension](https://marketplace.visualstudio.com/items?itemName=brikev.express-jsdoc-swagger-snippets)
+
+## Prerequisites
+
+This library assumes you are using:
+
+1. [NodeJS](https://nodejs.org)
+2. [Express.js](http://www.expressjs.com)
+
+## Installation
+
+```
+npm i express-jsdoc-swagger
+```
+
+## Basic Usage
+
+```javascript
+// index.js file
+const express = require('express');
+const expressJSDocSwagger = require('express-jsdoc-swagger');
+
+const options = {
+  info: {
+    version: '1.0.0',
+    title: 'Albums store',
+    license: {
+      name: 'MIT',
+    },
+  },
+  security: {
+    BasicAuth: {
+      type: 'http',
+      scheme: 'basic',
+    },
+  },
+  // Base directory which we use to locate your JSDOC files
+  baseDir: __dirname,
+  // Glob pattern to find your jsdoc files (multiple patterns can be added in an array)
+  filesPattern: './**/*.js',
+  // URL where SwaggerUI will be rendered
+  swaggerUIPath: '/api-docs',
+  // Expose OpenAPI UI
+  exposeSwaggerUI: true,
+  // Expose Open API JSON Docs documentation in `apiDocsPath` path.
+  exposeApiDocs: false,
+  // Open API JSON Docs endpoint.
+  apiDocsPath: '/v3/api-docs',
+  // Set non-required fields as nullable by default
+  notRequiredAsNullable: false,
+  // You can customize your UI options.
+  // you can extend swagger-ui-express config. You can checkout an example of this
+  // in the `example/configuration/swaggerOptions.js`
+  swaggerUiOptions: {},
+  // multiple option in case you want more that one instance
+  multiple: true,
+};
+
+const app = express();
+const PORT = 3000;
+
+expressJSDocSwagger(app)(options);
+
+/**
+ * GET /api/v1
+ * @summary This is the summary of the endpoint
+ * @return {object} 200 - success response
+ */
+app.get('/api/v1', (req, res) => res.json({
+  success: true,
+}));
+
+app.listen(PORT, () => console.log(`Example app listening at http://localhost:${PORT}`));
+```
+
+## Basic Examples
+
+1. Basic configuration options.
+
+```javascript
+const options = {
+  info: {
+    version: '1.0.0',
+    title: 'Albums store',
+    license: {
+      name: 'MIT',
+    },
+  },
+  security: {
+    BasicAuth: {
+      type: 'http',
+      scheme: 'basic',
+    },
+  },
+  baseDir: __dirname,
+  // Glob pattern to find your jsdoc files (multiple patterns can be added in an array)
+  filesPattern: './**/*.js',
+};
+```
+
+2. Components definition
+
+```javascript
+/**
+ * A song type
+ * @typedef {object} Song
+ * @property {string} title.required - The title
+ * @property {string} artist - The artist
+ * @property {number} year - The year - double
+ */
+```
+
+3. Endpoint which returns a `Songs` model array in the response.
+
+```javascript
+/**
+ * GET /api/v1/albums
+ * @summary This is the summary of the endpoint
+ * @tags album
+ * @return {array<Song>} 200 - success response - application/json
+ */
+app.get('/api/v1/albums', (req, res) => (
+  res.json([{
+    title: 'abum 1',
+  }])
+));
+```
+
+3. Endpoint PUT with body and path params which returns a `Songs` model array in the response.
+
+```javascript
+/**
+ * PUT /api/v1/albums/{id}
+ * @summary Update album
+ * @tags album
+ * @param {string} name.path - name param description
+ * @param {Song} request.body.required - songs info
+ * @return {array<Song>} 200 - success response - application/json
+ */
+app.put('/api/v1/albums/:id', (req, res) => (
+  res.json([{
+    title: 'abum 1',
+  }])
+));
+```
+
+4. Basic endpoint definition with tags, params and basic authentication
+
+```javascript
+/**
+ * GET /api/v1/album
+ * @summary This is the summary of the endpoint
+ * @security BasicAuth
+ * @tags album
+ * @param {string} name.query.required - name param description
+ * @return {object} 200 - success response - application/json
+ * @return {object} 400 - Bad request response
+ */
+app.get('/api/v1/album', (req, res) => (
+  res.json({
+    title: 'abum 1',
+  })
+));
+```
+
+5. Basic endpoint definition with code example for response body
+
+```javascript
+/**
+ * GET /api/v1/albums
+ * @summary This is the summary of the endpoint
+ * @tags album
+ * @return {array<Song>} 200 - success response - application/json
+ * @example response - 200 - success response example
+ * [
+ *   {
+ *     "title": "Bury the light",
+ *     "artist": "Casey Edwards ft. Victor Borba",
+ *     "year": 2020
+ *   }
+ * ]
+ */
+app.get('/api/v1/albums', (req, res) => (
+  res.json([{
+    title: 'track 1',
+  }])
+));
+```
+
+You can find more examples [here](https://github.com/BRIKEV/express-jsdoc-swagger/tree/master/examples), or visit our [documentation](https://brikev.github.io/express-jsdoc-swagger-docs/#/).
+
+
+## Validator
+
+We developed a new package works as a validator of your API endpoints and the documentation you create with this package. This package is [express-oas-validator](https://github.com/BRIKEV/express-oas-validator).
+
+**Example**
+
+Install using the node package registry:
+
+```
+npm install --save express-oas-validator
+```
+
+We have to wait until we have the full swagger schema to initiate the validator.
+
+```js
+// validator.js
+const { init } = require('express-oas-validator');
+
+const validators = instance => new Promise((resolve, reject) => {
+  instance.on('finish', (swaggerDef) => {
+    const { validateRequest, validateResponse } = init(swaggerDef);
+    resolve({ validateRequest, validateResponse });
+  });
+
+  instance.on('error', (error) => {
+    reject(error);
+  });
+});
+
+module.exports = validators;
+
+```
+
+You can check out this also in our [example folder](https://github.com/BRIKEV/express-jsdoc-swagger/tree/master/examples/validator).
+
+```js
+// index.js
+const express = require('express');
+const expressJSDocSwagger = require('express-jsdoc-swagger');
+const validator = require('./validator');
+
+const options = {
+  info: {
+    version: '1.0.0',
+    title: 'Albums store',
+    license: {
+      name: 'MIT',
+    },
+  },
+  filesPattern: './**.js',
+  baseDir: __dirname,
+};
+
+const app = express();
+const instance = expressJSDocSwagger(app)(options);
+
+const serverApp = async () => {
+  const { validateRequest, validateResponse } = await validator(instance);
+  app.use(express.urlencoded({ extended: true }));
+  app.use(express.json());
+  /**
+   * A song
+   * @typedef {object} Song
+   * @property {string} title.required - The title
+   * @property {string} artist - The artist
+   * @property {integer} year - The year
+   */
+
+  /**
+   * POST /api/v1/songs
+   * @param {Song} request.body.required - song info
+   * @return {object} 200 - song response
+   */
+  app.post('/api/v1/songs', validateRequest(), (req, res) => res.send('You save a song!'));
+
+  /**
+   * POST /api/v1/name
+   * @param {string} request.body.required - name body description
+   * @return {object} 200 - song response
+   */
+  app.post('/api/v1/name', (req, res, next) => {
+    try {
+      // Validate response
+      validateResponse('Error string', req);
+      return res.send('Hello World!');
+    } catch (error) {
+      return next(error);
+    }
+  });
+
+  /**
+   * GET /api/v1/authors
+   * @summary This is the summary or description of the endpoint
+   * @param {string} name.query.required - name param description - enum:type1,type2
+   * @param {array<string>} license.query - name param description
+   * @return {object} 200 - success response - application/json
+   */
+  app.get('/api/v1/authors', validateRequest({ headers: false }), (req, res) => (
+    res.json([{
+      title: 'album 1',
+    }])
+  ));
+
+  // eslint-disable-next-line no-unused-vars
+  app.use((err, req, res, next) => {
+    res.status(err.status).json(err);
+  });
+
+  return app;
+};
+
+const PORT = process.env.PORT || 4000;
+
+serverApp()
+  .then(app => 
+    app.listen(PORT, () =>
+      console.log(`Listening PORT: ${PORT}`)
+    ))
+  .catch((err) => {
+    console.error(err);
+    process.exit(1);
+  });
+```
+
+You can visit our [documentation](https://brikev.github.io/express-jsdoc-swagger-docs/#/validator).
+
+## Contributors ✨
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/bri06"><img src="https://avatars0.githubusercontent.com/u/24435223?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Briam Martinez Escobar</b></sub></a><br /><a href="https://github.com/BRIKEV/express-jsdoc-swagger/commits?author=bri06" title="Code">💻</a></td>
+    <td align="center"><a href="https://twitter.com/kjmesc"><img src="https://avatars2.githubusercontent.com/u/12685053?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Kevin Julián Martínez Escobar</b></sub></a><br /><a href="https://github.com/BRIKEV/express-jsdoc-swagger/commits?author=kevinccbsg" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/hoonga"><img src="https://avatars3.githubusercontent.com/u/10708927?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Heung-yeon Oh</b></sub></a><br /><a href="https://github.com/BRIKEV/express-jsdoc-swagger/commits?author=hoonga" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/LonelyPrincess"><img src="https://avatars1.githubusercontent.com/u/17673317?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sara Hernández</b></sub></a><br /><a href="https://github.com/BRIKEV/express-jsdoc-swagger/commits?author=LonelyPrincess" title="Code">💻</a></td>
+    <td align="center"><a href="http://servatj.me"><img src="https://avatars0.githubusercontent.com/u/3521485?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Josep Servat</b></sub></a><br /><a href="https://github.com/BRIKEV/express-jsdoc-swagger/commits?author=servatj" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/thuydx55"><img src="https://avatars2.githubusercontent.com/u/1469984?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nick Dong</b></sub></a><br /><a href="https://github.com/BRIKEV/express-jsdoc-swagger/commits?author=thuydx55" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/Stosiu"><img src="https://avatars1.githubusercontent.com/u/10252063?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Aleksander Stós</b></sub></a><br /><a href="https://github.com/BRIKEV/express-jsdoc-swagger/commits?author=Stosiu" title="Code">💻</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/kdankert"><img src="https://avatars0.githubusercontent.com/u/46489624?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Kjell Dankert</b></sub></a><br /><a href="https://github.com/BRIKEV/express-jsdoc-swagger/commits?author=kdankert" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/juliendu11"><img src="https://avatars0.githubusercontent.com/u/18739442?v=4?s=100" width="100px;" alt=""/><br /><sub><b>juliendu11</b></sub></a><br /><a href="https://github.com/BRIKEV/express-jsdoc-swagger/commits?author=juliendu11" title="Code">💻</a></td>
+    <td align="center"><a href="https://me.io"><img src="https://avatars.githubusercontent.com/u/45731?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Mohamed Meabed</b></sub></a><br /><a href="https://github.com/BRIKEV/express-jsdoc-swagger/commits?author=meabed" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/ofarukaydin"><img src="https://avatars.githubusercontent.com/u/32788963?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Faruk Aydın</b></sub></a><br /><a href="https://github.com/BRIKEV/express-jsdoc-swagger/commits?author=ofarukaydin" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/dahlmo"><img src="https://avatars.githubusercontent.com/u/23076026?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dahlmo</b></sub></a><br /><a href="https://github.com/BRIKEV/express-jsdoc-swagger/commits?author=dahlmo" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/gandazgul"><img src="https://avatars.githubusercontent.com/u/108850?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Carlos Ravelo</b></sub></a><br /><a href="https://github.com/BRIKEV/express-jsdoc-swagger/commits?author=gandazgul" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/paulish"><img src="https://avatars.githubusercontent.com/u/1762032?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Paul Ishenin</b></sub></a><br /><a href="https://github.com/BRIKEV/express-jsdoc-swagger/commits?author=paulish" title="Code">💻</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/sbingner"><img src="https://avatars.githubusercontent.com/u/354533?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sam Bingner</b></sub></a><br /><a href="https://github.com/BRIKEV/express-jsdoc-swagger/commits?author=sbingner" title="Code">💻</a></td>
+    <td align="center"><a href="https://stackoverflow.com/users/5059657/alexander-staroselsky"><img src="https://avatars.githubusercontent.com/u/34102969?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Alexander Staroselsky</b></sub></a><br /><a href="https://github.com/BRIKEV/express-jsdoc-swagger/commits?author=alexstaroselsky" title="Code">💻</a></td>
+    <td align="center"><a href="http://joelabrahamsson.com"><img src="https://avatars.githubusercontent.com/u/218986?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Joel Abrahamsson</b></sub></a><br /><a href="https://github.com/BRIKEV/express-jsdoc-swagger/commits?author=joelabrahamsson" title="Code">💻</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

package/node_modules/express-jsdoc-swagger/commitlint.config.js

@@ -0,0 +1,24 @@
+/* Examples
+  * chore: run tests on travis ci
+  * fix(server): send cors headers
+  * feat(blog): add comment section
+ */
+/* Common Errors
+  * subject must not be sentence-case, start-case, pascal-case, upper-case [subject-case]
+  * type must be lower-case [type-case]
+  * type must be one of
+  *   [build, chore, ci, docs, feat, fix, improvement, perf, refactor, revert, style, test]
+ */
+/*
+  * docs - Add or edit documentation.
+  * feat - Implementation of new feature.
+  * improvement - Enhancements on existing features.
+  * fix - Changes that solve existing bugs in the application.
+  * perf - Changes to improve the application's performance.
+  * refactor - Code enhancements that do not alter the functionality.
+  * style - Fix front end styles
+  * test - Add or edit tests
+ */
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+};

package/node_modules/express-jsdoc-swagger/config/default.js

@@ -0,0 +1,18 @@
+const expressJSDocSwaggerOptions = {
+  // Absolute path of the application
+  baseDir: __dirname,
+  // Glob pattern to find your jsdoc files (multiple patterns can be added in an array)
+  filesPattern: './**/*.js',
+  // URL where SwaggerUI will be rendered
+  swaggerUIPath: '/api-docs',
+  // Expose OpenAPI UI
+  exposeSwaggerUI: true,
+  // Expose Open API JSON Docs documentation in `apiDocsPath` path.
+  exposeApiDocs: false,
+  // Open API JSON Docs endpoint.
+  apiDocsPath: '/v3/api-docs',
+  // Set non-required fields as nullable by default
+  notRequiredAsNullable: false,
+};
+
+module.exports = expressJSDocSwaggerOptions;

package/node_modules/express-jsdoc-swagger/config/swaggerEvents.js

@@ -0,0 +1,5 @@
+const swaggerEvents = options => ({
+  multiple: options.multiple !== undefined ? options.multiple : false,
+});
+
+module.exports = swaggerEvents;

package/node_modules/express-jsdoc-swagger/consumers/getOnlyComments.js

@@ -0,0 +1,21 @@
+const getComments = require('./utils/getComments');
+
+const flat = array => [].concat(...array);
+
+const trimComment = comment => comment.trim();
+
+const removeSimpleComments = comment => (comment[0] === '/' && comment[1] !== '/');
+
+const processComments = comment => {
+  const trimedComments = trimComment(comment);
+  return getComments(trimedComments);
+};
+
+const getOnlyComments = (files = []) => {
+  if (!Array.isArray(files)) return [];
+  const comments = files
+    .map(processComments);
+  return flat(comments).filter(removeSimpleComments);
+};
+
+module.exports = getOnlyComments;

package/node_modules/express-jsdoc-swagger/consumers/globFilesMatches.js

@@ -0,0 +1,50 @@
+const glob = require('glob');
+const path = require('path');
+
+const DEFAULT_EXCLUDED_FOLDER = 'node_modules';
+const DEFAULT_GLOB_OPTIONS = { ignore: '**/node_modules/**' };
+
+const globFilesMatches = (baseDir, filesPattern, excludedFolder = DEFAULT_EXCLUDED_FOLDER) => (
+  new Promise((resolve, reject) => {
+    if (!baseDir || !filesPattern) {
+      const error = new Error('baseDir and filePath are required');
+      return reject(error);
+    }
+
+    if (!Array.isArray(filesPattern) && typeof filesPattern !== 'string') {
+      const error = new Error('files pattern has to be a type of string');
+      return reject(error);
+    }
+
+    if (Array.isArray(filesPattern)) {
+      if (filesPattern.length === 0) {
+        const error = new Error('if you submit an array of filesPattern it must contain at least one pattern');
+        return reject(error);
+      }
+
+      if (filesPattern.some(pattern => typeof pattern !== 'string')) {
+        const error = new Error('all file patterns have to be strings');
+        return reject(error);
+      }
+    }
+
+    try {
+      let files;
+      if (!Array.isArray(filesPattern)) {
+        files = glob.sync(path.resolve(baseDir, filesPattern), DEFAULT_GLOB_OPTIONS);
+      } else {
+        files = filesPattern
+          .map(pattern => glob.sync(path.resolve(baseDir, pattern), DEFAULT_EXCLUDED_FOLDER))
+          .reduce((memo, it) => memo.concat(it), [])
+          .filter((value, index, self) => self.indexOf(value) === index);
+      }
+
+      const filteredFiles = files.filter(file => !file.includes(excludedFolder));
+      return resolve(filteredFiles);
+    } catch (error) {
+      return reject(error);
+    }
+  })
+);
+
+module.exports = globFilesMatches;

package/node_modules/express-jsdoc-swagger/consumers/jsdocInfo.js

@@ -0,0 +1,20 @@
+const doctrine = require('doctrine');
+
+const jsdocInfo = (options = { unwrap: true }) => comments => {
+  if (!comments || !Array.isArray(comments)) return [];
+  return comments.map(comment => {
+    const parsedValue = doctrine.parse(comment, options);
+    const tags = parsedValue.tags.map(tag => ({
+      ...tag,
+      description: tag.description ? tag.description.replace('\n/', '').replace(/\/$/, '') : tag.description,
+    }));
+    const description = parsedValue.description.replace('/**\n', '').replace('\n/', '');
+    return {
+      ...parsedValue,
+      tags,
+      description,
+    };
+  });
+};
+
+module.exports = jsdocInfo;

package/node_modules/express-jsdoc-swagger/consumers/readFiles.js

@@ -0,0 +1,9 @@
+const readFile = require('./utils/readFile');
+
+const readFiles = files => {
+  if (!files || !Array.isArray(files)) return Promise.resolve([]);
+  const filesInfo = files.map(file => readFile(file));
+  return Promise.all(filesInfo);
+};
+
+module.exports = readFiles;

package/node_modules/express-jsdoc-swagger/consumers/utils/getComments.js

@@ -0,0 +1,13 @@
+const COMMENTS_PATTERN = /((\/\*\*+[\s\S]*?\*\/)|(\/\*+.*\*\/)|^\/\/.*?[\r\n])[\r\n]*/gm;
+const BREAK_LINE = /\n/g;
+
+const getComments = text => {
+  const comments = text.match(COMMENTS_PATTERN);
+  if (comments) {
+    const filterComments = comments.filter(comment => comment.match(BREAK_LINE));
+    return filterComments.map(comment => comment.trim());
+  }
+  return [];
+};
+
+module.exports = getComments;

package/node_modules/express-jsdoc-swagger/consumers/utils/readFile.js

@@ -0,0 +1,15 @@
+const fs = require('fs');
+
+const readFile = path => (
+  new Promise((resolve, reject) => {
+    let data = '';
+    const readStream = fs.createReadStream(path, 'utf8');
+    readStream.on('data', chunk => {
+      data += chunk;
+    })
+      .on('end', () => resolve(data))
+      .on('error', error => reject(error));
+  })
+);
+
+module.exports = readFile;

package/node_modules/express-jsdoc-swagger/index.d.ts

@@ -0,0 +1,65 @@
+// Type definitions for express-jsdoc-swagger
+// Project: https://github.com/BRIKEV/express-jsdoc-swagger
+// Definitions by: Kevin MArtínez <https://github.com/kevinccbsg>
+// Definitions: https://github.com/BRIKEV/express-jsdoc-swagger/index.d.ts
+// TypeScript Version: 3.9.7
+
+import { EventEmitter } from "events";
+import express from "express";
+import { SwaggerUiOptions } from "swagger-ui-express";
+
+interface ContactObject {
+  name: string;
+  url?: string;
+  email?: string;
+}
+
+interface LicenseObject {
+  name: string;
+  url?: string;
+  email?: string;
+}
+
+interface InfoObject {
+  title: string;
+  version: string;
+  description?: string;
+  termsOfService?: string;
+  contact?: ContactObject;
+  license?: LicenseObject;
+}
+
+interface SecurityObject {
+  type: string;
+  scheme: string;
+}
+
+interface Security {
+  [key: string]: SecurityObject;
+}
+
+interface Servers {
+  url: string;
+  description: string;
+  variables?: object;
+}
+
+interface Options {
+  info: InfoObject;
+  baseDir: string;
+  filesPattern: string | string[];
+  security?: Security;
+  servers?: string[] | Servers[];
+  exposeSwaggerUI?: boolean;
+  swaggerUIPath?: string;
+  exposeApiDocs?: boolean;
+  apiDocsPath?: string;
+  swaggerUiOptions?: SwaggerUiOptions;
+  notRequiredAsNullable?: boolean;
+}
+
+type UserSwagger = Record<string, unknown>;
+
+type EventEmiterHandler = (options: Options, userSwagger?: UserSwagger) => EventEmitter;
+
+export default function expressJSDocSwagger(app: express.Application): EventEmiterHandler;