@saihu/common 1.2.2 → 1.2.3

package/dist/index.d.ts

@@ -8,6 +8,7 @@ export * from './logger';
 export * from './messaging';
 export * from './decorators';
 export * from './errors';
+export * from './swagger';
 export { SaihuCommonModule } from './saihu-common.module';
 export { BaseService } from './services/base.service';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC"}

package/dist/index.js

@@ -25,6 +25,7 @@ __exportStar(require("./logger"), exports);
 __exportStar(require("./messaging"), exports);
 __exportStar(require("./decorators"), exports);
 __exportStar(require("./errors"), exports);
+__exportStar(require("./swagger"), exports);
 var saihu_common_module_1 = require("./saihu-common.module");
 Object.defineProperty(exports, "SaihuCommonModule", { enumerable: true, get: function () { return saihu_common_module_1.SaihuCommonModule; } });
 var base_service_1 = require("./services/base.service");

package/dist/swagger/index.d.ts

@@ -0,0 +1,2 @@
+export { setupSaihuSwagger } from './setup-swagger';
+//# sourceMappingURL=index.d.ts.map

package/dist/swagger/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/swagger/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/swagger/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupSaihuSwagger = void 0;
+var setup_swagger_1 = require("./setup-swagger");
+Object.defineProperty(exports, "setupSaihuSwagger", { enumerable: true, get: function () { return setup_swagger_1.setupSaihuSwagger; } });

package/dist/swagger/setup-swagger.d.ts

@@ -0,0 +1,4 @@
+import { INestApplication } from '@nestjs/common';
+import { DocumentBuilder } from '@nestjs/swagger';
+export declare function setupSaihuSwagger(app: INestApplication, config: Omit<DocumentBuilder, 'build'>, path?: string): void;
+//# sourceMappingURL=setup-swagger.d.ts.map

package/dist/swagger/setup-swagger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup-swagger.d.ts","sourceRoot":"","sources":["../../src/swagger/setup-swagger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,eAAe,EAAgC,MAAM,iBAAiB,CAAC;AAEhF,wBAAgB,iBAAiB,CAC/B,GAAG,EAAE,gBAAgB,EACrB,MAAM,EAAE,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,EACtC,IAAI,SAAQ,QAQb"}

package/dist/swagger/setup-swagger.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupSaihuSwagger = setupSaihuSwagger;
+const swagger_1 = require("@nestjs/swagger");
+function setupSaihuSwagger(app, config, path = 'api') {
+    const swaggerConfig = config.build();
+    const documentFactory = () => wrapResponsesInBaseDto(swagger_1.SwaggerModule.createDocument(app, swaggerConfig));
+    swagger_1.SwaggerModule.setup(path, app, documentFactory);
+}
+function wrapResponsesInBaseDto(document) {
+    var _a, _b, _c;
+    const ERROR_SCHEMA = {
+        type: 'object',
+        properties: {
+            code: { type: 'number', example: 400 },
+            msg: { type: 'string', example: 'Error message' },
+            data: { nullable: true, example: null },
+        },
+    };
+    for (const path of Object.values((_a = document.paths) !== null && _a !== void 0 ? _a : {})) {
+        for (const method of Object.values(path)) {
+            if (!(method === null || method === void 0 ? void 0 : method.responses))
+                continue;
+            for (const [statusCode, response] of Object.entries(method.responses)) {
+                const schema = (_c = (_b = response === null || response === void 0 ? void 0 : response.content) === null || _b === void 0 ? void 0 : _b['application/json']) === null || _c === void 0 ? void 0 : _c.schema;
+                const isSuccess = statusCode.startsWith('2') || statusCode === 'default';
+                if (schema) {
+                    response.content['application/json'].schema = {
+                        type: 'object',
+                        properties: {
+                            code: {
+                                type: 'number',
+                                example: isSuccess ? 0 : Number(statusCode),
+                            },
+                            msg: {
+                                type: 'string',
+                                example: isSuccess ? 'success' : 'Error message',
+                            },
+                            data: isSuccess ? schema : { nullable: true, example: null },
+                        },
+                    };
+                }
+                else if (!isSuccess) {
+                    if (!response.content) {
+                        response.content = {};
+                    }
+                    if (!response.content['application/json']) {
+                        response.content['application/json'] = {};
+                    }
+                    response.content['application/json'].schema = ERROR_SCHEMA;
+                }
+            }
+        }
+    }
+    return document;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saihu/common",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "Common utilities for NestJS applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -20,6 +20,7 @@
   "license": "MIT",
   "peerDependencies": {
     "@nestjs/common": "^10.0.0 || ^11.0.0",
+    "@nestjs/swagger": "^7.0.0 || ^11.0.0",
     "rxjs": "^7.0.0"
   },
   "devDependencies": {