Mocks server plugin allowing to create routes and collections from OpenApi definitions. 

Mocks server plugin allowing to create routes and collections from OpenApi definitions

javierbrea

@mocks-server/plugin-openapi

var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {

    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

    return new (P || (P = Promise))(function (resolve, reject) {

        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }

        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }

        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }

        step((generator = generator.apply(thisArg, _arguments || [])).next());

Object.defineProperty(exports, "__esModule", { value: true });

const COLLECTION_NAMESPACE = "collection";

        description: "Id for the collection created from OpenAPI definitions",

        description: "Id of the collection to extend from",

function getRoutesCollection(routes, collectionOptions) {

    return routes.reduce((collection, route) => {

        if (route.variants && route.variants.length) {

            collection.routes.push(`${route.id}:${route.variants[0].id}`);

        from: collectionOptions.from || null,

    constructor({ logger, alerts, mock, files, config }) {

        Object.defineProperty(this, "_config", {

        Object.defineProperty(this, "_logger", {

        Object.defineProperty(this, "_alerts", {

        Object.defineProperty(this, "_files", {

        Object.defineProperty(this, "_loadRoutes", {

        Object.defineProperty(this, "_loadCollections", {

        Object.defineProperty(this, "_documentsAlerts", {

        Object.defineProperty(this, "_collectionIdOption", {

        Object.defineProperty(this, "_collectionFromOption", {

        if (!this._collectionIdOption.value) {

            id: this._collectionIdOption.value,

        if (this._collectionFromOption.value) {

            options.from = this._collectionFromOption.value;

    _getRoutesAndCollectionsFromFilesContents(filesContents) {

        return __awaiter(this, void 0, void 0, function* () {

            const openApiRoutesAndCollections = yield Promise.all(filesContents

                const fileContent = fileDetails.content;

                return fileContent.map((openAPIDefinition) => {

                    this._logger.debug(`Creating routes from openApi definition: '${JSON.stringify(openAPIDefinition)}'`);

                    return (0, OpenApi_1.openApiRoutes)(openAPIDefinition, {

                        defaultLocation: fileDetails.path,

                        logger: this._logger,

                        alerts: this._documentsAlerts,

                    }).then((routes) => {

                            collection: getRoutesCollection(routes, openAPIDefinition.collection),

            return openApiRoutesAndCollections.reduce((allRoutesAndCollections, definitionRoutesAndCollections) => {

                allRoutesAndCollections.routes = allRoutesAndCollections.routes.concat(definitionRoutesAndCollections.routes);

                if (definitionRoutesAndCollections.collection) {

                    allRoutesAndCollections.collections = allRoutesAndCollections.collections.concat(definitionRoutesAndCollections.collection);

                return allRoutesAndCollections;

            }, { routes: [], collections: [] });

                this._documentsAlerts.clean();

                const { routes, collections } = yield this._getRoutesAndCollectionsFromFilesContents(filesContents);

                const folderTrace = `from OpenAPI definitions found in folder '${this._files.path}/${DEFAULT_FOLDER}'`;

                this._logger.debug(`Routes to load from openApi definitions: '${JSON.stringify(routes)}'`);

                this._logger.verbose(`Loading ${routes.length} routes ${folderTrace}`);

                this._loadRoutes(routes);

                this._logger.debug(`Collections created from OpenAPI definitions: '${JSON.stringify(collections)}'`);

                if (this._defaultCollectionOptions) {

                    const defaultCollection = getRoutesCollection(routes, this._defaultCollectionOptions);

                    this._logger.debug(`Collection created from all OpenAPI definitions: '${JSON.stringify(defaultCollection)}'`);

                    collectionsToLoad = collections.concat([defaultCollection]);

                    collectionsToLoad = collections;

                this._logger.verbose(`Loading ${collectionsToLoad.length} collections ${folderTrace}`);

                this._loadCollections(collectionsToLoad);

  "name": "@mocks-server/plugin-openapi",

  "description": "Mocks server plugin allowing to create routes and collections from OpenApi definitions",

    "url": "https://github.com/mocks-server/main.git",

    "directory": "packages/plugin-openapi"

  "homepage": "https://www.mocks-server.org",

    "@mocks-server/config": "2.0.0-beta.2",

    "@mocks-server/core": "5.0.0-beta.2",

    "@mocks-server/logger": "2.0.0-beta.1",

    "@mocks-server/nested-collections": "3.0.0-beta.1"

    "@mocks-server/config": "2.0.0-beta.3",

    "@mocks-server/core": "5.0.0-beta.3",

    "@mocks-server/logger": "2.0.0-beta.2",

    "@mocks-server/nested-collections": "3.0.0-beta.2"

  "readme": "<p align=\"center\"><a href=\"https://mocks-server.org\" target=\"_blank\" rel=\"noopener noreferrer\"><img width=\"120\" src=\"https://www.mocks-server.org/img/logo_120.png\" alt=\"Mocks Server logo\"></a></p>\n\n<p align=\"center\">\n  <a href=\"https://github.com/mocks-server/main/actions?query=workflow%3Abuild+branch%3Amaster\"><img src=\"https://github.com/mocks-server/main/workflows/build/badge.svg?branch=master\" alt=\"Build Status\"></a>\n  <a href=\"https://codecov.io/gh/mocks-server/main\"><img src=\"https://codecov.io/gh/mocks-server/main/branch/master/graph/badge.svg?token=2S8ZR55AJV\" alt=\"Coverage\"></a>\n  <a href=\"https://sonarcloud.io/project/overview?id=mocks-server_main_plugin-openapi\"><img src=\"https://sonarcloud.io/api/project_badges/measure?project=mocks-server_main_plugin-openapi&metric=alert_status\" alt=\"Quality Gate\"></a>\n  <a href=\"https://www.npmjs.com/package/@mocks-server/plugin-openapi\"><img src=\"https://img.shields.io/npm/dm/@mocks-server/plugin-openapi.svg\" alt=\"Downloads\"></a>\n  <a href=\"https://renovatebot.com\"><img src=\"https://img.shields.io/badge/renovate-enabled-brightgreen.svg\" alt=\"Renovate\"></a>\n  <a href=\"https://github.com/mocks-server/main/blob/master/packages/plugin-openapi/LICENSE\"><img src=\"https://img.shields.io/npm/l/@mocks-server/plugin-openapi.svg\" alt=\"License\"></a>\n</p>\n\n---\n\n# Mocks Server Plugin OpenApi\n\n[Mocks Server][website-url] plugin enabling to create routes and collections from OpenApi definitions.\n\n## Usage\n\nThis plugin is included in the main distribution of the Mocks Server project, so you can refer to the [official documentation website][website-url].\n\n## Options\n\n* __`plugins.openapi.collection.id`__ _(String | Null)_: Id for the collection to be created with __all routes from all OpenAPI documents__. Default is \"openapi\". When it is set to `null`, no collection will be created.\n* __`plugins.openapi.collection.from`__ _(String)_: When provided, the created collection will extend from this one.\n\nRead more about [how to set options in Mocks Server here](https://www.mocks-server.org/docs/configuration/how-to-change-settings).\n\n## Contributing\n\nContributors are welcome.\nPlease read the [contributing guidelines](../../.github/CONTRIBUTING.md) and [code of conduct](../../.github/CODE_OF_CONDUCT.md).\n\n[website-url]: https://www.mocks-server.org\n"

		@@ -121,2 +121,14 @@ "use strict";
		}
		get _defaultCollectionOptions() {
		if (!this._collectionIdOption.value) {
		return null;
		}
		const options = {
		id: this._collectionIdOption.value,
		};
		if (this._collectionFromOption.value) {
		options.from = this._collectionFromOption.value;
		}
		return options;
		}
		_getRoutesAndCollectionsFromFilesContents(filesContents) {
		@@ -151,14 +163,2 @@ return __awaiter(this, void 0, void 0, function* () {
		}
		get _defaultCollectionOptions() {
		if (!this._collectionIdOption.value) {
		return null;
		}
		const options = {
		id: this._collectionIdOption.value,
		};
		if (this._collectionFromOption.value) {
		options.from = this._collectionFromOption.value;
		}
		return options;
		}
		_onLoadFiles(filesContents) {
		@@ -165,0 +165,0 @@ return __awaiter(this, void 0, void 0, function* () {

		{
		"name": "@mocks-server/plugin-openapi",
		"version": "3.0.0-beta.3",
		"version": "3.0.0-beta.4",
		"description": "Mocks server plugin allowing to create routes and collections from OpenApi definitions",
		@@ -31,3 +31,3 @@ "keywords": [
		"peerDependencies": {
		"@mocks-server/core": "5.0.0-beta.2"
		"@mocks-server/core": "5.0.0-beta.3"
		},
		@@ -39,6 +39,6 @@ "dependencies": {
		"devDependencies": {
		"@mocks-server/config": "2.0.0-beta.2",
		"@mocks-server/core": "5.0.0-beta.2",
		"@mocks-server/logger": "2.0.0-beta.1",
		"@mocks-server/nested-collections": "3.0.0-beta.1"
		"@mocks-server/config": "2.0.0-beta.3",
		"@mocks-server/core": "5.0.0-beta.3",
		"@mocks-server/logger": "2.0.0-beta.2",
		"@mocks-server/nested-collections": "3.0.0-beta.2"
		},
		@@ -45,0 +45,0 @@ "engines": {