@pjts/swagger 0.0.61

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import { OpenAPIObject } from 'openapi3-ts';
+import { Description } from './openapi';
+export * from './openapi';
+export declare const buildSwaggerServer: (schema: OpenAPIObject, description?: Description) => {
+    start: (port: number) => Promise<void>;
+    stop: () => Promise<void>;
+};

package/dist/index.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildSwaggerServer = void 0;
+const tslib_1 = require("tslib");
+const express_1 = tslib_1.__importDefault(require("express"));
+const swagger_ui_express_1 = tslib_1.__importDefault(require("swagger-ui-express"));
+const core_1 = require("@pjts/core");
+tslib_1.__exportStar(require("./openapi"), exports);
+const buildSwaggerServer = (schema, description) => {
+    const app = (0, express_1.default)();
+    app.use('/docs', swagger_ui_express_1.default.serve, swagger_ui_express_1.default.setup({
+        ...schema,
+        info: description || schema.info,
+    }));
+    app.use('/raw', (_req, res) => {
+        res.status(200).send(schema);
+    });
+    let server;
+    return {
+        start: async (port) => {
+            server = app.listen(port, () => {
+                core_1.Logger.info('Swagger documentation running on port ' + port);
+            });
+        },
+        stop: async () => {
+            await server?.close();
+        },
+    };
+};
+exports.buildSwaggerServer = buildSwaggerServer;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,8DAA6B;AAC7B,oFAA0C;AAE1C,qCAAmC;AAInC,oDAAyB;AAElB,MAAM,kBAAkB,GAAG,CAAC,MAAqB,EAAE,WAAyB,EAAE,EAAE;IACrF,MAAM,GAAG,GAAG,IAAA,iBAAO,GAAE,CAAA;IACrB,GAAG,CAAC,GAAG,CACL,OAAO,EACP,4BAAS,CAAC,KAAK,EACf,4BAAS,CAAC,KAAK,CAAC;QACd,GAAG,MAAM;QACT,IAAI,EAAE,WAAW,IAAI,MAAM,CAAC,IAAI;KACjC,CAAC,CACH,CAAA;IAED,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;QAC5B,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAC9B,CAAC,CAAC,CAAA;IAEF,IAAI,MAAmB,CAAA;IACvB,OAAO;QACL,KAAK,EAAE,KAAK,EAAE,IAAY,EAAE,EAAE;YAC5B,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE;gBAC7B,aAAM,CAAC,IAAI,CAAC,wCAAwC,GAAG,IAAI,CAAC,CAAA;YAC9D,CAAC,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,EAAE,KAAK,IAAI,EAAE;YACf,MAAM,MAAM,EAAE,KAAK,EAAE,CAAA;QACvB,CAAC;KACF,CAAA;AACH,CAAC,CAAA;AA1BY,QAAA,kBAAkB,sBA0B9B"}

package/dist/openapi.d.ts

@@ -0,0 +1,9 @@
+import { OpenAPIObject } from 'openapi3-ts';
+import { AppModule } from '@pjts/core';
+export interface Description {
+    version: string;
+    description: string;
+    name: string;
+}
+export declare const collapsePrimitiveTypes: (schema: Record<string, any>) => {};
+export declare const buildOpenAPISchema: (appModules: AppModule<any>[], port: number, description: Description, prefix: string) => OpenAPIObject;

package/dist/openapi.js

@@ -0,0 +1,139 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildOpenAPISchema = exports.collapsePrimitiveTypes = void 0;
+const class_validator_jsonschema_1 = require("class-validator-jsonschema");
+const core_1 = require("@pjts/core");
+const normalizeUrl = (route) => {
+    return route
+        .split('/')
+        .map(chunk => {
+        if (!chunk.startsWith(':')) {
+            return chunk;
+        }
+        return '{' + chunk.slice(1) + '}';
+    })
+        .join('/');
+};
+const collapsePrimitiveTypes = (schema) => {
+    return Object.entries(schema).reduce((acc, [name, value]) => {
+        if (value.properties?.value && Object.keys(value.properties).length === 1) {
+            acc[name] = value.properties.value;
+        }
+        else {
+            acc[name] = value;
+        }
+        return acc;
+    }, {});
+};
+exports.collapsePrimitiveTypes = collapsePrimitiveTypes;
+const buildOpenAPISchema = (appModules, port, description, prefix) => {
+    const schemas = (0, class_validator_jsonschema_1.validationMetadatasToSchemas)();
+    const primitiveSchemas = (0, core_1.getOpenAPISchemas)();
+    const components = (0, exports.collapsePrimitiveTypes)({
+        ...primitiveSchemas,
+        ...schemas,
+    });
+    return {
+        openapi: '3.0.3',
+        info: {
+            title: description?.name || 'PJX',
+            description: description?.description || '-',
+            version: description?.version || '-',
+        },
+        servers: [
+            {
+                url: `http://localhost:${port}`,
+            },
+        ],
+        components: {
+            securitySchemes: {
+                bearerAuth: {
+                    name: 'authorization',
+                    type: 'apiKey',
+                    in: 'header',
+                    scheme: 'bearer',
+                    description: 'Bearer JWT',
+                },
+            },
+            schemas: components,
+        },
+        security: [
+            {
+                bearerAuth: [],
+            },
+        ],
+        paths: appModules.reduce((paths, appModule) => {
+            const moduleDescriptor = (0, core_1.getModuleDescriptor)(appModule);
+            moduleDescriptor.routes.forEach(route => {
+                route.endpoints.forEach(endpoint => {
+                    const bodyParams = endpoint.params.filter(param => param.source === 'body');
+                    const url = normalizeUrl((0, core_1.buildServerUrl)(moduleDescriptor, route, endpoint, prefix));
+                    paths[url] = {
+                        ...paths[url],
+                        [endpoint.httpMethod.toLowerCase()]: {
+                            description: route.name + '.' + endpoint.method,
+                            parameters: endpoint.params
+                                .filter(param => param.source !== 'headers' && param.source !== 'middleware')
+                                .map(param => {
+                                const subPath = Array.isArray(param.path) ? param.path : [param.path];
+                                return subPath.map(path => ({
+                                    name: path,
+                                    in: param.source === 'params' ? 'path' : param.source,
+                                    schema: param.source === 'body'
+                                        ? {
+                                            $ref: `#/components/schemas/${param.dto}`,
+                                        }
+                                        : undefined,
+                                }));
+                            })
+                                .flat(),
+                            responses: {
+                                [endpoint.status]: {
+                                    description: 'OK',
+                                },
+                                400: {
+                                    description: 'Bad Request',
+                                },
+                            },
+                            requestBody: bodyParams.length > 0
+                                ? {
+                                    content: {
+                                        'application/json': {
+                                            schema: {
+                                                type: 'object',
+                                                properties: bodyParams.reduce((acc, param) => {
+                                                    if (Array.isArray(param.path)) {
+                                                        param.path.forEach(subPath => {
+                                                            acc[subPath] = {
+                                                                $ref: `#/components/schemas/${param.dto}`,
+                                                            };
+                                                        });
+                                                    }
+                                                    else if (primitiveSchemas[param.dto]?.type !== 'object') {
+                                                        acc[param.path] = {
+                                                            type: primitiveSchemas[param.dto]?.type,
+                                                        };
+                                                    }
+                                                    else {
+                                                        acc[param.path] = {
+                                                            $ref: `#/components/schemas/${param.dto}`,
+                                                        };
+                                                    }
+                                                    return acc;
+                                                }, {}),
+                                            },
+                                        },
+                                    },
+                                }
+                                : undefined,
+                            tags: [route.name],
+                        },
+                    };
+                });
+            });
+            return paths;
+        }, {}),
+    };
+};
+exports.buildOpenAPISchema = buildOpenAPISchema;
+//# sourceMappingURL=openapi.js.map

package/dist/openapi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi.js","sourceRoot":"","sources":["../src/openapi.ts"],"names":[],"mappings":";;;AACA,2EAAyE;AACzE,qCAA8F;AAQ9F,MAAM,YAAY,GAAG,CAAC,KAAa,EAAE,EAAE;IACrC,OAAO,KAAK;SACT,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,KAAK,CAAC,EAAE;QACX,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC1B,OAAO,KAAK,CAAA;SACb;QACD,OAAO,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,CAAA;IACnC,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAA;AACd,CAAC,CAAA;AAEM,MAAM,sBAAsB,GAAG,CAAC,MAA2B,EAAE,EAAE;IACpE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE;QAC1D,IAAI,KAAK,CAAC,UAAU,EAAE,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;YACzE,GAAG,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,KAAK,CAAA;SACnC;aAAM;YACL,GAAG,CAAC,IAAI,CAAC,GAAG,KAAK,CAAA;SAClB;QACD,OAAO,GAAG,CAAA;IACZ,CAAC,EAAE,EAAE,CAAC,CAAA;AACR,CAAC,CAAA;AATY,QAAA,sBAAsB,0BASlC;AAEM,MAAM,kBAAkB,GAAG,CAChC,UAA4B,EAC5B,IAAY,EACZ,WAAwB,EACxB,MAAc,EACC,EAAE;IACjB,MAAM,OAAO,GAAG,IAAA,yDAA4B,GAAE,CAAA;IAC9C,MAAM,gBAAgB,GAAG,IAAA,wBAAiB,GAAE,CAAA;IAC5C,MAAM,UAAU,GAAG,IAAA,8BAAsB,EAAC;QACxC,GAAG,gBAAgB;QACnB,GAAG,OAAO;KACX,CAAC,CAAA;IAEF,OAAO;QACL,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE;YACJ,KAAK,EAAE,WAAW,EAAE,IAAI,IAAI,KAAK;YACjC,WAAW,EAAE,WAAW,EAAE,WAAW,IAAI,GAAG;YAC5C,OAAO,EAAE,WAAW,EAAE,OAAO,IAAI,GAAG;SACrC;QACD,OAAO,EAAE;YACP;gBACE,GAAG,EAAE,oBAAoB,IAAI,EAAE;aAChC;SACF;QACD,UAAU,EAAE;YACV,eAAe,EAAE;gBACf,UAAU,EAAE;oBACV,IAAI,EAAE,eAAe;oBACrB,IAAI,EAAE,QAAQ;oBACd,EAAE,EAAE,QAAQ;oBACZ,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,YAAY;iBAC1B;aACF;YACD,OAAO,EAAE,UAAgD;SAC1D;QACD,QAAQ,EAAE;YACR;gBACE,UAAU,EAAE,EAAE;aACf;SACF;QACD,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,KAAkB,EAAE,SAAS,EAAE,EAAE;YACzD,MAAM,gBAAgB,GAAG,IAAA,0BAAmB,EAAC,SAAS,CAAC,CAAA;YACvD,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBACtC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;oBACjC,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,MAAM,CAAC,CAAA;oBAC3E,MAAM,GAAG,GAAG,YAAY,CAAC,IAAA,qBAAc,EAAC,gBAAgB,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAA;oBACnF,KAAK,CAAC,GAAG,CAAC,GAAG;wBACX,GAAG,KAAK,CAAC,GAAG,CAAC;wBACb,CAAC,QAAQ,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE;4BACnC,WAAW,EAAE,KAAK,CAAC,IAAI,GAAG,GAAG,GAAG,QAAQ,CAAC,MAAM;4BAC/C,UAAU,EAAE,QAAQ,CAAC,MAAM;iCACxB,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,KAAK,YAAY,CAAC;iCAC5E,GAAG,CAAC,KAAK,CAAC,EAAE;gCACX,MAAM,OAAO,GAAa,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;gCAC/E,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;oCAC1B,IAAI,EAAE,IAAI;oCACV,EAAE,EAAE,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM;oCACrD,MAAM,EACJ,KAAK,CAAC,MAAM,KAAK,MAAM;wCACrB,CAAC,CAAC;4CACA,IAAI,EAAE,wBAAwB,KAAK,CAAC,GAAG,EAAE;yCAC1C;wCACD,CAAC,CAAC,SAAS;iCAChB,CAAC,CAAC,CAAA;4BACL,CAAC,CAAC;iCACD,IAAI,EAAE;4BACT,SAAS,EAAE;gCACT,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;oCACjB,WAAW,EAAE,IAAI;iCAClB;gCACD,GAAG,EAAE;oCACH,WAAW,EAAE,aAAa;iCAC3B;6BACF;4BACD,WAAW,EACT,UAAU,CAAC,MAAM,GAAG,CAAC;gCACnB,CAAC,CAAC;oCACA,OAAO,EAAE;wCACP,kBAAkB,EAAE;4CAClB,MAAM,EAAE;gDACN,IAAI,EAAE,QAAQ;gDACd,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;oDAC3C,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;wDAC7B,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;4DAC3B,GAAG,CAAC,OAAO,CAAC,GAAG;gEACb,IAAI,EAAE,wBAAwB,KAAK,CAAC,GAAG,EAAE;6DAC1C,CAAA;wDACH,CAAC,CAAC,CAAA;qDACH;yDAAM,IAAI,gBAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,KAAK,QAAQ,EAAE;wDACzD,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG;4DAChB,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI;yDACxC,CAAA;qDACF;yDAAM;wDACL,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG;4DAChB,IAAI,EAAE,wBAAwB,KAAK,CAAC,GAAG,EAAE;yDAC1C,CAAA;qDACF;oDACD,OAAO,GAAG,CAAA;gDACZ,CAAC,EAAE,EAAE,CAAC;6CACP;yCACF;qCACF;iCACF;gCACD,CAAC,CAAC,SAAS;4BACf,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;yBACnB;qBACF,CAAA;gBACH,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;YACF,OAAO,KAAK,CAAA;QACd,CAAC,EAAE,EAAE,CAAC;KACP,CAAA;AACH,CAAC,CAAA;AAlHY,QAAA,kBAAkB,sBAkH9B"}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@pjts/swagger",
+  "version": "0.0.61",
+  "description": "Piotr Józefów DDD utility package",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "author": "Piotr Józefów",
+  "license": "MIT",
+  "engines": {
+    "node": "^18.14.0"
+  },
+  "engineStrict": true,
+  "scripts": {
+    "lint": "eslint src/ --ext .js,.jsx,.ts,.tsx",
+    "test": "NODE_ENV=test jest --coverage=false --verbose",
+    "test:watch": "NODE_ENV=test jest --coverage=false --watchAll --testNamePattern=",
+    "test:coverage": "yarn test --collectCoverage",
+    "build": "rm -rf ./dist && tsc",
+    "package": "npm run build && npm publish --access=public",
+    "prepare": "npm install @pjts/core@latest & npm version patch"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.4.0",
+    "jest": "^29.4.2",
+    "prettier": "^2.8.4",
+    "ts-jest": "^29.0.5",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "@pjts/core": "^0.0.59",
+    "class-validator-jsonschema": "^5.0.0",
+    "express": "^4.18.2",
+    "openapi3-ts": "^3.1.2",
+    "swagger-ui-express": "^4.6.0"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  }
+}