@nest-omni/core 1.0.0

package/src/shared/services/api-config.service.js

@@ -0,0 +1,335 @@
+"use strict";
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+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());
+    });
+};
+var __setFunctionName = (this && this.__setFunctionName) || function (f, name, prefix) {
+    if (typeof name === "symbol") name = name.description ? "[".concat(name.description, "]") : "";
+    return Object.defineProperty(f, "name", { configurable: true, value: prefix ? "".concat(prefix, " ", name) : name });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiConfigService = void 0;
+const common_1 = require("@nestjs/common");
+const lodash_1 = require("lodash");
+const snake_naming_strategy_1 = require("../../snake-naming.strategy");
+const cache_manager_ioredis_yet_1 = require("cache-manager-ioredis-yet");
+const connect_redis_1 = __importDefault(require("connect-redis"));
+const ioredis_1 = __importDefault(require("ioredis"));
+let ApiConfigService = (() => {
+    let _classDecorators = [(0, common_1.Injectable)()];
+    let _classDescriptor;
+    let _classExtraInitializers = [];
+    let _classThis;
+    var ApiConfigService = _classThis = class {
+        constructor(configService) {
+            this.configService = configService;
+        }
+        static getRootPath() {
+            if (!ApiConfigService.rootPath) {
+                throw new Error(`rootPath is not set`);
+            }
+            return ApiConfigService.rootPath;
+        }
+        get isDev() {
+            return this.nodeEnv === 'dev';
+        }
+        get isProd() {
+            return this.nodeEnv === 'prod';
+        }
+        get isSit() {
+            return this.nodeEnv === 'sit';
+        }
+        get isUat() {
+            return this.nodeEnv === 'uat';
+        }
+        get isTest() {
+            return this.nodeEnv === 'test';
+        }
+        getNumber(key) {
+            const value = this.get(key);
+            try {
+                return Number(value);
+            }
+            catch (_a) {
+                throw new Error(key + ' environment variable is not a number');
+            }
+        }
+        getBoolean(key) {
+            const value = this.get(key);
+            return ApiConfigService.toBoolean(value);
+        }
+        static toBoolean(value) {
+            try {
+                return Boolean(JSON.parse(value));
+            }
+            catch (_a) {
+                throw new Error(value + ' is not a boolean');
+            }
+        }
+        getString(key) {
+            const value = this.get(key);
+            return value.replace(/\\n/g, '\n');
+        }
+        get nodeEnv() {
+            return this.getString('NODE_ENV');
+        }
+        get fallbackLanguage() {
+            return this.getString('FALLBACK_LANGUAGE');
+        }
+        get sentryConfig() {
+            return {
+                dsn: this.getString('SENTRY_DSN'),
+                debug: this.isDev,
+                environment: this.nodeEnv,
+                tracesSampleRate: 1.0,
+                release: '0.0.1',
+                logLevels: ['warn', 'error'],
+                close: {
+                    enabled: true,
+                    // Time in milliseconds to forcefully quit the application
+                    timeout: 10 * 1000,
+                },
+            };
+        }
+        get typeormConfig() {
+            return {
+                autoLoadEntities: true,
+                keepConnectionAlive: !this.isDev,
+                dropSchema: this.isTest,
+                type: 'mysql',
+                host: this.getString('DB_HOST'),
+                port: this.getNumber('DB_PORT'),
+                username: this.getString('DB_USERNAME'),
+                password: this.getString('DB_PASSWORD'),
+                database: this.getString('DB_DATABASE'),
+                subscribers: [],
+                synchronize: this.isDev,
+                migrationsRun: true,
+                logging: this.getBoolean('DB_LOG_ENABLED'),
+                maxQueryExecutionTime: 3000,
+                namingStrategy: new snake_naming_strategy_1.SnakeNamingStrategy(),
+            };
+        }
+        get awsS3Config() {
+            return {
+                bucketRegion: this.getString('AWS_S3_BUCKET_REGION'),
+                bucketApiVersion: this.getString('AWS_S3_API_VERSION'),
+                bucketName: this.getString('AWS_S3_BUCKET_NAME'),
+            };
+        }
+        get documentationEnabled() {
+            return this.getBoolean('SWAGGER_ENABLED');
+        }
+        get documentationPath() {
+            return this.getString('SWAGGER_PATH');
+        }
+        get skywalkingEnabled() {
+            return this.getBoolean('SW_ENABLED');
+        }
+        get viewsEnabled() {
+            return this.getBoolean('VIEWS_ENABLED');
+        }
+        get sessionEnabled() {
+            return this.getBoolean('SESSION_ENABLED');
+        }
+        get corsEnabled() {
+            try {
+                return this.getBoolean('CORS_ENABLED');
+            }
+            catch (error) {
+                return false;
+            }
+        }
+        get corsConfig() {
+            const allowedDomains = this.getString('CORS_ORIGIN').split(',');
+            return {
+                origin: (origin, callback) => {
+                    if (!origin ||
+                        allowedDomains.some((domain) => origin.endsWith(domain))) {
+                        callback(null, origin);
+                    }
+                    else {
+                        callback(new common_1.BadRequestException('Not allowed by CORS'));
+                    }
+                },
+                methods: this.getString('CORS_METHODS'),
+                allowedHeaders: this.getString('CORS_ALLOWED_HEADERS'),
+                exposedHeaders: this.getString('CORS_EXPOSED_HEADERS'),
+                credentials: this.getBoolean('CORS_CREDENTIALS'),
+                optionsSuccessStatus: 200,
+            };
+        }
+        get sessionConfig() {
+            const config = {
+                secret: this.getString('SESSION_KEY'),
+                resave: false,
+                saveUninitialized: false,
+            };
+            if (this.getBoolean('SESSION_REDIS_ENABLED')) {
+                config.store = new connect_redis_1.default({
+                    client: new ioredis_1.default(this.ioRedisConfig),
+                    prefix: this.getString('SESSION_REDIS_PREFIX'),
+                });
+            }
+            return config;
+        }
+        get natsEnabled() {
+            return this.getBoolean('NATS_ENABLED');
+        }
+        get natsConfig() {
+            return {
+                host: this.getString('NATS_HOST'),
+                port: this.getNumber('NATS_PORT'),
+            };
+        }
+        get authConfig() {
+            return {
+                privateKey: this.getString('JWT_PRIVATE_KEY'),
+                publicKey: this.getString('JWT_PUBLIC_KEY'),
+                jwtExpirationTime: this.getNumber('JWT_EXPIRATION_TIME'),
+            };
+        }
+        get appConfig() {
+            return {
+                port: this.getString('PORT'),
+            };
+        }
+        get apiKey() {
+            return this.getString('API_KEY');
+        }
+        get ioRedisConfig() {
+            return {
+                host: this.getString('REDIS_HOST'),
+                port: this.getNumber('REDIS_PORT'),
+                username: this.getString('REDIS_USERNAME'),
+                password: this.getString('REDIS_PASSWORD'),
+                db: this.getNumber('REDIS_DB'),
+            };
+        }
+        /**
+         * 是否使用Redis，用于health check
+         */
+        get isRedisEnabled() {
+            return (this.getBoolean('BULL_ENABLED') ||
+                this.getBoolean('CACHE_ENABLED') ||
+                (this.sessionEnabled && this.getBoolean('SESSION_REDIS_ENABLED')));
+        }
+        get bullConfig() {
+            return {
+                redis: this.ioRedisConfig,
+                prefix: this.getString('BULL_PREFIX'),
+            };
+        }
+        cacheConfig() {
+            return __awaiter(this, void 0, void 0, function* () {
+                return {
+                    isGlobal: true,
+                    store: yield (0, cache_manager_ioredis_yet_1.redisStore)(Object.assign(Object.assign({}, this.ioRedisConfig), { ttl: this.getNumber('CACHE_TTL') })),
+                };
+            });
+        }
+        get pinoConfig() {
+            const transport = this.isDev
+                ? {
+                    target: 'pino-pretty',
+                }
+                : null;
+            return {
+                pinoHttp: {
+                    genReqId: (req) => req.id,
+                    transport,
+                    level: this.isDev ? 'debug' : 'info',
+                    customLogLevel: function (res) {
+                        if (res.statusCode < 300) {
+                            return 'info';
+                        }
+                        else if (res.statusCode >= 300 && res.statusCode < 500) {
+                            return 'warn';
+                        }
+                        return 'error';
+                    },
+                    customProps: (req) => {
+                        return {
+                            env: this.nodeEnv,
+                            appName: this.getString('NAME'),
+                            user: req === null || req === void 0 ? void 0 : req.user,
+                            body: req === null || req === void 0 ? void 0 : req.body,
+                        };
+                    },
+                    redact: {
+                        paths: ['req.headers.authorization', 'req.headers.apikey'],
+                        remove: true,
+                    },
+                },
+            };
+        }
+        get axiosProxyConfig() {
+            if (!this.getBoolean('DIRECT_PROXY_ENABLED')) {
+                return false;
+            }
+            return {
+                host: this.getString('DIRECT_PROXY_HOST'),
+                port: this.getNumber('DIRECT_PROXY_PORT'),
+            };
+        }
+        get(key) {
+            const value = this.configService.get(key);
+            if ((0, lodash_1.isNil)(value)) {
+                throw new Error(key + ' environment variable does not set'); // probably we should call process.exit() too to avoid locking the service
+            }
+            return value;
+        }
+    };
+    __setFunctionName(_classThis, "ApiConfigService");
+    (() => {
+        const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
+        __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
+        ApiConfigService = _classThis = _classDescriptor.value;
+        if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        __runInitializers(_classThis, _classExtraInitializers);
+    })();
+    return ApiConfigService = _classThis;
+})();
+exports.ApiConfigService = ApiConfigService;

package/src/shared/services/api-config.service.ts

@@ -0,0 +1,319 @@
+import { BadRequestException, Injectable } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import type { TypeOrmModuleOptions } from '@nestjs/typeorm';
+import { isNil } from 'lodash';
+import { SnakeNamingStrategy } from '../../snake-naming.strategy';
+import { SentryModuleOptions } from '@ntegral/nestjs-sentry/lib/sentry.interfaces';
+import session from 'express-session';
+import { Params } from 'nestjs-pino';
+import { redisStore } from 'cache-manager-ioredis-yet';
+import { BullRootModuleOptions } from '@nestjs/bull/dist/interfaces/bull-module-options.interface';
+import RedisStore from 'connect-redis';
+import Redis from 'ioredis';
+import { AxiosProxyConfig } from 'axios';
+import { CorsOptions } from '@nestjs/common/interfaces/external/cors-options.interface';
+
+@Injectable()
+export class ApiConfigService {
+  static rootPath: string;
+
+  constructor(private configService: ConfigService) {}
+
+  static getRootPath(): string {
+    if (!ApiConfigService.rootPath) {
+      throw new Error(`rootPath is not set`);
+    }
+    return ApiConfigService.rootPath;
+  }
+
+  get isDev(): boolean {
+    return this.nodeEnv === 'dev';
+  }
+
+  get isProd(): boolean {
+    return this.nodeEnv === 'prod';
+  }
+
+  get isSit(): boolean {
+    return this.nodeEnv === 'sit';
+  }
+
+  get isUat(): boolean {
+    return this.nodeEnv === 'uat';
+  }
+
+  get isTest(): boolean {
+    return this.nodeEnv === 'test';
+  }
+
+  getNumber(key: string): number {
+    const value = this.get(key);
+
+    try {
+      return Number(value);
+    } catch {
+      throw new Error(key + ' environment variable is not a number');
+    }
+  }
+
+  getBoolean(key: string): boolean {
+    const value = this.get(key);
+
+    return ApiConfigService.toBoolean(value);
+  }
+
+  static toBoolean(value: string): boolean {
+    try {
+      return Boolean(JSON.parse(value));
+    } catch {
+      throw new Error(value + ' is not a boolean');
+    }
+  }
+
+  getString(key: string): string {
+    const value = this.get(key);
+
+    return value.replace(/\\n/g, '\n');
+  }
+
+  get nodeEnv(): string {
+    return this.getString('NODE_ENV');
+  }
+
+  get fallbackLanguage(): string {
+    return this.getString('FALLBACK_LANGUAGE');
+  }
+
+  get sentryConfig(): SentryModuleOptions {
+    return {
+      dsn: this.getString('SENTRY_DSN'),
+      debug: this.isDev,
+      environment: this.nodeEnv,
+      tracesSampleRate: 1.0,
+      release: '0.0.1', // must create a release in sentry.io dashboard
+      logLevels: ['warn', 'error'],
+      close: {
+        enabled: true,
+        // Time in milliseconds to forcefully quit the application
+        timeout: 10 * 1000,
+      },
+    };
+  }
+
+  get typeormConfig(): TypeOrmModuleOptions {
+    return {
+      autoLoadEntities: true,
+      keepConnectionAlive: !this.isDev,
+      dropSchema: this.isTest,
+      type: 'mysql',
+      host: this.getString('DB_HOST'),
+      port: this.getNumber('DB_PORT'),
+      username: this.getString('DB_USERNAME'),
+      password: this.getString('DB_PASSWORD'),
+      database: this.getString('DB_DATABASE'),
+      subscribers: [],
+      synchronize: this.isDev,
+      migrationsRun: true,
+      logging: this.getBoolean('DB_LOG_ENABLED'),
+      maxQueryExecutionTime: 3000,
+      namingStrategy: new SnakeNamingStrategy(),
+    };
+  }
+
+  get awsS3Config() {
+    return {
+      bucketRegion: this.getString('AWS_S3_BUCKET_REGION'),
+      bucketApiVersion: this.getString('AWS_S3_API_VERSION'),
+      bucketName: this.getString('AWS_S3_BUCKET_NAME'),
+    };
+  }
+
+  get documentationEnabled(): boolean {
+    return this.getBoolean('SWAGGER_ENABLED');
+  }
+
+  get documentationPath(): string {
+    return this.getString('SWAGGER_PATH');
+  }
+
+  get skywalkingEnabled(): boolean {
+    return this.getBoolean('SW_ENABLED');
+  }
+
+  get viewsEnabled(): boolean {
+    return this.getBoolean('VIEWS_ENABLED');
+  }
+
+  get sessionEnabled(): boolean {
+    return this.getBoolean('SESSION_ENABLED');
+  }
+
+  get corsEnabled(): boolean {
+    try {
+      return this.getBoolean('CORS_ENABLED');
+    } catch (error) {
+      return false;
+    }
+  }
+
+  get corsConfig(): CorsOptions {
+    const allowedDomains = this.getString('CORS_ORIGIN').split(',');
+    return {
+      origin: (origin, callback) => {
+        if (
+          !origin ||
+          allowedDomains.some((domain) => origin.endsWith(domain))
+        ) {
+          callback(null, origin);
+        } else {
+          callback(new BadRequestException('Not allowed by CORS'));
+        }
+      },
+      methods: this.getString('CORS_METHODS'),
+      allowedHeaders: this.getString('CORS_ALLOWED_HEADERS'),
+      exposedHeaders: this.getString('CORS_EXPOSED_HEADERS'),
+      credentials: this.getBoolean('CORS_CREDENTIALS'),
+      optionsSuccessStatus: 200,
+    };
+  }
+
+  get sessionConfig(): session.SessionOptions {
+    const config: session.SessionOptions = {
+      secret: this.getString('SESSION_KEY'),
+      resave: false,
+      saveUninitialized: false,
+    };
+
+    if (this.getBoolean('SESSION_REDIS_ENABLED')) {
+      config.store = new RedisStore({
+        client: new Redis(this.ioRedisConfig),
+        prefix: this.getString('SESSION_REDIS_PREFIX'),
+      });
+    }
+
+    return config;
+  }
+
+  get natsEnabled(): boolean {
+    return this.getBoolean('NATS_ENABLED');
+  }
+
+  get natsConfig() {
+    return {
+      host: this.getString('NATS_HOST'),
+      port: this.getNumber('NATS_PORT'),
+    };
+  }
+
+  get authConfig() {
+    return {
+      privateKey: this.getString('JWT_PRIVATE_KEY'),
+      publicKey: this.getString('JWT_PUBLIC_KEY'),
+      jwtExpirationTime: this.getNumber('JWT_EXPIRATION_TIME'),
+    };
+  }
+
+  get appConfig() {
+    return {
+      port: this.getString('PORT'),
+    };
+  }
+
+  get apiKey(): string {
+    return this.getString('API_KEY');
+  }
+
+  get ioRedisConfig() {
+    return {
+      host: this.getString('REDIS_HOST'),
+      port: this.getNumber('REDIS_PORT'),
+      username: this.getString('REDIS_USERNAME'),
+      password: this.getString('REDIS_PASSWORD'),
+      db: this.getNumber('REDIS_DB'),
+    };
+  }
+
+  /**
+   * 是否使用Redis，用于health check
+   */
+  get isRedisEnabled(): boolean {
+    return (
+      this.getBoolean('BULL_ENABLED') ||
+      this.getBoolean('CACHE_ENABLED') ||
+      (this.sessionEnabled && this.getBoolean('SESSION_REDIS_ENABLED'))
+    );
+  }
+
+  get bullConfig(): BullRootModuleOptions {
+    return {
+      redis: this.ioRedisConfig,
+      prefix: this.getString('BULL_PREFIX'),
+    };
+  }
+
+  async cacheConfig() {
+    return {
+      isGlobal: true,
+      store: await redisStore({
+        ...this.ioRedisConfig,
+        ttl: this.getNumber('CACHE_TTL'),
+      }),
+    };
+  }
+
+  get pinoConfig(): Params {
+    const transport = this.isDev
+      ? {
+          target: 'pino-pretty',
+        }
+      : null;
+
+    return {
+      pinoHttp: {
+        genReqId: (req: any) => req.id,
+        transport,
+        level: this.isDev ? 'debug' : 'info',
+        customLogLevel: function (res: any) {
+          if (res.statusCode < 300) {
+            return 'info';
+          } else if (res.statusCode >= 300 && res.statusCode < 500) {
+            return 'warn';
+          }
+          return 'error';
+        },
+        customProps: (req: any) => {
+          return {
+            env: this.nodeEnv,
+            appName: this.getString('NAME'),
+            user: req?.user,
+            body: req?.body,
+          };
+        },
+        redact: {
+          paths: ['req.headers.authorization', 'req.headers.apikey'],
+          remove: true,
+        },
+      },
+    };
+  }
+
+  get axiosProxyConfig(): AxiosProxyConfig | false {
+    if (!this.getBoolean('DIRECT_PROXY_ENABLED')) {
+      return false;
+    }
+    return {
+      host: this.getString('DIRECT_PROXY_HOST'),
+      port: this.getNumber('DIRECT_PROXY_PORT'),
+    };
+  }
+
+  private get(key: string): string {
+    const value = this.configService.get<string>(key);
+
+    if (isNil(value)) {
+      throw new Error(key + ' environment variable does not set'); // probably we should call process.exit() too to avoid locking the service
+    }
+
+    return value;
+  }
+}

package/src/shared/services/aws-s3.service.d.ts

@@ -0,0 +1,10 @@
+import type { IFile } from '../../interfaces';
+import { ApiConfigService } from './api-config.service';
+import { GeneratorService } from './generator.service';
+export declare class AwsS3Service {
+    configService: ApiConfigService;
+    generatorService: GeneratorService;
+    private readonly s3;
+    constructor(configService: ApiConfigService, generatorService: GeneratorService);
+    uploadImage(file: IFile): Promise<string>;
+}