@toeichust/common 0.0.10 → 0.0.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1,5 @@
1
1
  export declare const SWAGGER_DOCS_PATH = "docs";
2
+ export declare const SWAGGER_AUTH_KEY = "BearerAuth";
3
+ export declare const SWAGGER_UI_CDN = "https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/4.15.5";
4
+ export declare const SWAGGER_CUSTOM_FAVICON = "https://avatars.githubusercontent.com/u/251744857?s=400&u=018acf9b463484b3c43dacc69db8320a0655afba&v=4";
5
+ export declare const SWAGGER_DESCRIPTION: string;
@@ -1,5 +1,27 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SWAGGER_DOCS_PATH = void 0;
3
+ exports.SWAGGER_DESCRIPTION = exports.SWAGGER_CUSTOM_FAVICON = exports.SWAGGER_UI_CDN = exports.SWAGGER_AUTH_KEY = exports.SWAGGER_DOCS_PATH = void 0;
4
4
  exports.SWAGGER_DOCS_PATH = 'docs';
5
+ exports.SWAGGER_AUTH_KEY = 'BearerAuth';
6
+ exports.SWAGGER_UI_CDN = 'https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/4.15.5';
7
+ exports.SWAGGER_CUSTOM_FAVICON = 'https://avatars.githubusercontent.com/u/251744857?s=400&u=018acf9b463484b3c43dacc69db8320a0655afba&v=4';
8
+ exports.SWAGGER_DESCRIPTION = `<table border="0">
9
+ <tr>
10
+ <td>
11
+ <h3>Giới thiệu</h3>
12
+ <ul>
13
+ <li>Đây là API cho <code>${process.env.npm_package_name || 'Tên mặc định'}</code></li>
14
+ <li><a href="https://github.com/ToeicHUST/${process.env.npm_package_name || 'Tên mặc định'}">Xem thông tin github</a></li>
15
+ </ul>
16
+ <h3>JSON và YAML docs:</h3>
17
+ <ul>
18
+ <li><a href="/${exports.SWAGGER_DOCS_PATH}/json">Xem thông tin json</a></li>
19
+ <li><a href="/${exports.SWAGGER_DOCS_PATH}/yaml">Xem thông tin yaml</a></li>
20
+ </ul>
21
+ </td>
22
+ <td valign="top">
23
+ <img src="${exports.SWAGGER_CUSTOM_FAVICON}" alt="toeicHUST" width="200"/>
24
+ </td>
25
+ </tr>
26
+ </table>`;
5
27
  //# sourceMappingURL=swagger.constant.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"swagger.constant.js","sourceRoot":"","sources":["../../src/constants/swagger.constant.ts"],"names":[],"mappings":";;;AAAa,QAAA,iBAAiB,GAAG,MAAM,CAAC"}
1
+ {"version":3,"file":"swagger.constant.js","sourceRoot":"","sources":["../../src/constants/swagger.constant.ts"],"names":[],"mappings":";;;AAAa,QAAA,iBAAiB,GAAG,MAAM,CAAC;AAC3B,QAAA,gBAAgB,GAAG,YAAY,CAAC;AAChC,QAAA,cAAc,GACzB,0DAA0D,CAAC;AAChD,QAAA,sBAAsB,GACjC,wGAAwG,CAAC;AAC9F,QAAA,mBAAmB,GAAG;;;;;mCAKA,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,cAAc;oDAC7B,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,cAAc;;;;wBAI1E,yBAAiB;wBACjB,yBAAiB;;;;kBAIvB,8BAAsB;;;SAG/B,CAAC"}
@@ -4,9 +4,8 @@ exports.logAppBootstrap = logAppBootstrap;
4
4
  const swagger_constant_1 = require("../constants/swagger.constant");
5
5
  function logAppBootstrap(port) {
6
6
  console.log(`ENVIRONMENT: ${process.env.ENVIRONMENT}`);
7
- console.log(`NAME: ${process.env.NAME}`);
7
+ console.log(`NAME: ${process.env.npm_package_name}`);
8
8
  console.log(`PORT: ${port}`);
9
9
  console.log(`Application is running on: http://toeicHUST.local:${port}/${swagger_constant_1.SWAGGER_DOCS_PATH}`);
10
- console.log(`DATABASE_URL: ${process.env.DATABASE_URL}`);
11
10
  }
12
11
  //# sourceMappingURL=bootstrap.helper.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"bootstrap.helper.js","sourceRoot":"","sources":["../../src/helpers/bootstrap.helper.ts"],"names":[],"mappings":";;AAEA,0CAYC;AAdD,oEAAmE;AAEnE,SAAgB,eAAe,CAAC,IAAqB;IAGnD,OAAO,CAAC,GAAG,CAAC,gBAAgB,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;IACvD,OAAO,CAAC,GAAG,CAAC,SAAS,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IACzC,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;IAC7B,OAAO,CAAC,GAAG,CACT,qDAAqD,IAAI,IAAI,oCAAiB,EAAE,CACjF,CAAC;IACF,OAAO,CAAC,GAAG,CAAC,iBAAiB,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC;AAG3D,CAAC"}
1
+ {"version":3,"file":"bootstrap.helper.js","sourceRoot":"","sources":["../../src/helpers/bootstrap.helper.ts"],"names":[],"mappings":";;AAEA,0CAWC;AAbD,oEAAmE;AAEnE,SAAgB,eAAe,CAAC,IAAqB;IAGnD,OAAO,CAAC,GAAG,CAAC,gBAAgB,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;IACvD,OAAO,CAAC,GAAG,CAAC,SAAS,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC,CAAC;IACrD,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;IAC7B,OAAO,CAAC,GAAG,CACT,qDAAqD,IAAI,IAAI,oCAAiB,EAAE,CACjF,CAAC;AAGJ,CAAC"}
@@ -1,5 +1,2 @@
1
1
  import { INestApplication } from '@nestjs/common';
2
- export interface SwaggerConfigOptions {
3
- name: string;
4
- }
5
- export declare function setupSwagger(app: INestApplication, options: SwaggerConfigOptions): void;
2
+ export declare function setupSwagger(app: INestApplication): void;
@@ -3,24 +3,47 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.setupSwagger = setupSwagger;
4
4
  const swagger_1 = require("@nestjs/swagger");
5
5
  const swagger_constant_1 = require("../constants/swagger.constant");
6
- function setupSwagger(app, options) {
6
+ function setupSwagger(app) {
7
7
  const swaggerConfig = new swagger_1.DocumentBuilder()
8
- .setTitle(options.name)
9
- .setDescription(`API documentation for ${options.name}`)
10
- .setVersion('1.0.0')
8
+ .setTitle(process.env.npm_package_name || 'Tên mặc định')
9
+ .setVersion(process.env.npm_package_version || '1.0.0')
11
10
  .setContact('vuvannghia.work@gmail.com', '', 'vuvannghia.work@gmail.com')
11
+ .setDescription(swagger_constant_1.SWAGGER_DESCRIPTION)
12
+ .addBearerAuth({
13
+ type: 'http',
14
+ scheme: 'bearer',
15
+ bearerFormat: 'JWT',
16
+ name: swagger_constant_1.SWAGGER_AUTH_KEY,
17
+ description: 'Nhập token của bạn vào đây',
18
+ in: 'header',
19
+ }, swagger_constant_1.SWAGGER_AUTH_KEY)
12
20
  .build();
13
- const document = swagger_1.SwaggerModule.createDocument(app, swaggerConfig);
14
- swagger_1.SwaggerModule.setup(swagger_constant_1.SWAGGER_DOCS_PATH, app, document, {
21
+ const documentFactory = () => swagger_1.SwaggerModule.createDocument(app, swaggerConfig);
22
+ const isProduction = process.env.NODE_ENV !== 'development';
23
+ const baseOptions = {
15
24
  jsonDocumentUrl: `${swagger_constant_1.SWAGGER_DOCS_PATH}/json`,
16
25
  yamlDocumentUrl: `${swagger_constant_1.SWAGGER_DOCS_PATH}/yaml`,
17
- customSiteTitle: options.name,
18
- customfavIcon: '/public/favicon.ico',
26
+ customSiteTitle: process.env.npm_package_name || 'Tên mặc định',
27
+ customfavIcon: `${swagger_constant_1.SWAGGER_CUSTOM_FAVICON}`,
19
28
  swaggerOptions: {
20
29
  persistAuthorization: true,
21
30
  tagsSorter: 'alpha',
22
31
  operationsSorter: 'alpha',
23
32
  },
24
- });
33
+ };
34
+ const swaggerConfigOptions = isProduction
35
+ ? {
36
+ ...baseOptions,
37
+ customJs: [
38
+ `${swagger_constant_1.SWAGGER_UI_CDN}/swagger-ui-bundle.min.js`,
39
+ `${swagger_constant_1.SWAGGER_UI_CDN}/swagger-ui-standalone-preset.min.js`,
40
+ ],
41
+ customCssUrl: [
42
+ `${swagger_constant_1.SWAGGER_UI_CDN}/swagger-ui.min.css`,
43
+ `${swagger_constant_1.SWAGGER_UI_CDN}/swagger-ui.css`,
44
+ ],
45
+ }
46
+ : baseOptions;
47
+ swagger_1.SwaggerModule.setup(swagger_constant_1.SWAGGER_DOCS_PATH, app, documentFactory, swaggerConfigOptions);
25
48
  }
26
49
  //# sourceMappingURL=swagger.helper.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"swagger.helper.js","sourceRoot":"","sources":["../../src/helpers/swagger.helper.ts"],"names":[],"mappings":";;AAQA,oCA0BC;AAjCD,6CAAiE;AACjE,oEAAmE;AAMnE,SAAgB,YAAY,CAC1B,GAAqB,EACrB,OAA6B;IAE7B,MAAM,aAAa,GAAG,IAAI,yBAAe,EAAE;SACxC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC;SACtB,cAAc,CAAC,yBAAyB,OAAO,CAAC,IAAI,EAAE,CAAC;SACvD,UAAU,CAAC,OAAO,CAAC;SACnB,UAAU,CAAC,2BAA2B,EAAE,EAAE,EAAE,2BAA2B,CAAC;SAExE,KAAK,EAAE,CAAC;IAEX,MAAM,QAAQ,GAAG,uBAAa,CAAC,cAAc,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IAElE,uBAAa,CAAC,KAAK,CAAC,oCAAiB,EAAE,GAAG,EAAE,QAAQ,EAAE;QACpD,eAAe,EAAE,GAAG,oCAAiB,OAAO;QAC5C,eAAe,EAAE,GAAG,oCAAiB,OAAO;QAC5C,eAAe,EAAE,OAAO,CAAC,IAAI;QAC7B,aAAa,EAAE,qBAAqB;QACpC,cAAc,EAAE;YACd,oBAAoB,EAAE,IAAI;YAC1B,UAAU,EAAE,OAAO;YACnB,gBAAgB,EAAE,OAAO;SAE1B;KACF,CAAC,CAAC;AACL,CAAC"}
1
+ {"version":3,"file":"swagger.helper.js","sourceRoot":"","sources":["../../src/helpers/swagger.helper.ts"],"names":[],"mappings":";;AAcA,oCA8DC;AA3ED,6CAAiE;AACjE,oEAMuC;AAMvC,SAAgB,YAAY,CAC1B,GAAqB;IAGrB,MAAM,aAAa,GAAG,IAAI,yBAAe,EAAE;SACxC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,cAAc,CAAC;SACxD,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,OAAO,CAAC;SACtD,UAAU,CAAC,2BAA2B,EAAE,EAAE,EAAE,2BAA2B,CAAC;SACxE,cAAc,CAAC,sCAAmB,CAAC;SACnC,aAAa,CACZ;QACE,IAAI,EAAE,MAAM;QACZ,MAAM,EAAE,QAAQ;QAChB,YAAY,EAAE,KAAK;QACnB,IAAI,EAAE,mCAAgB;QACtB,WAAW,EAAE,4BAA4B;QACzC,EAAE,EAAE,QAAQ;KACb,EACD,mCAAgB,CACjB;SACA,KAAK,EAAE,CAAC;IAEX,MAAM,eAAe,GAAG,GAAG,EAAE,CAC3B,uBAAa,CAAC,cAAc,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IAEnD,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,CAAC;IAG5D,MAAM,WAAW,GAAG;QAClB,eAAe,EAAE,GAAG,oCAAiB,OAAO;QAC5C,eAAe,EAAE,GAAG,oCAAiB,OAAO;QAC5C,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,cAAc;QAC/D,aAAa,EAAE,GAAG,yCAAsB,EAAE;QAC1C,cAAc,EAAE;YACd,oBAAoB,EAAE,IAAI;YAC1B,UAAU,EAAE,OAAO;YACnB,gBAAgB,EAAE,OAAO;SAE1B;KACF,CAAC;IAGF,MAAM,oBAAoB,GAAG,YAAY;QACvC,CAAC,CAAC;YACE,GAAG,WAAW;YACd,QAAQ,EAAE;gBACR,GAAG,iCAAc,2BAA2B;gBAC5C,GAAG,iCAAc,sCAAsC;aACxD;YACD,YAAY,EAAE;gBACZ,GAAG,iCAAc,qBAAqB;gBACtC,GAAG,iCAAc,iBAAiB;aACnC;SACF;QACH,CAAC,CAAC,WAAW,CAAC;IAEhB,uBAAa,CAAC,KAAK,CACjB,oCAAiB,EACjB,GAAG,EACH,eAAe,EACf,oBAAoB,CACrB,CAAC;AACJ,CAAC"}
package/dist/index.d.ts CHANGED
@@ -2,5 +2,3 @@ export * from './constants/swagger.constant';
2
2
  export * from './helpers/bootstrap.helper';
3
3
  export * from './helpers/swagger.helper';
4
4
  export * from './middlewares/logger.middleware';
5
- export * from './modules/base-app/base-app.controller';
6
- export * from './modules/base-app/base-app.module';
package/dist/index.js CHANGED
@@ -18,6 +18,4 @@ __exportStar(require("./constants/swagger.constant"), exports);
18
18
  __exportStar(require("./helpers/bootstrap.helper"), exports);
19
19
  __exportStar(require("./helpers/swagger.helper"), exports);
20
20
  __exportStar(require("./middlewares/logger.middleware"), exports);
21
- __exportStar(require("./modules/base-app/base-app.controller"), exports);
22
- __exportStar(require("./modules/base-app/base-app.module"), exports);
23
21
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAIA,+DAA6C;AAC7C,6DAA2C;AAC3C,2DAAyC;AACzC,kEAAgD;AAChD,yEAAuD;AACvD,qEAAmD"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAIA,+DAA6C;AAC7C,6DAA2C;AAC3C,2DAAyC;AACzC,kEAAgD"}