@nest-omni/core 1.0.6 → 1.0.8

package/src/setup/bootstrap.setup.ts

@@ -1,139 +0,0 @@
-import { NestFactory, Reflector } from '@nestjs/core';
-import type { NestExpressApplication } from '@nestjs/platform-express';
-import { initializeTransactionalContext } from 'typeorm-transactional';
-import agent from 'skywalking-backend-js';
-import { Logger, LoggerErrorInterceptor } from 'nestjs-pino';
-import * as session from 'express-session';
-import { join } from 'path';
-import {
-  ApiConfigService,
-  HttpExceptionFilter,
-  OmniAuthMiddleware,
-  PowerByMiddleware,
-  QueryFailedFilter,
-  RequestIdMiddleware,
-  ServiceRegistryModule,
-  TranslationInterceptor,
-} from '../';
-import { HttpException, HttpStatus } from '@nestjs/common';
-import { SentryInterceptor } from '@ntegral/nestjs-sentry';
-import { I18nValidationPipe } from 'nestjs-i18n';
-import { CrudConfigService } from '@dataui/crud';
-import { AuthUserInterceptor } from '../interceptors/auth-user.interceptor';
-import { ClsMiddleware } from 'nestjs-cls';
-
-CrudConfigService.load({
-  auth: {
-    property: 'user',
-  },
-  params: {
-    id: {
-      field: 'id',
-      type: 'string',
-      primary: true,
-    },
-  },
-  query: {
-    limit: 10,
-    alwaysPaginate: true,
-  },
-  routes: {
-    updateOneBase: {
-      allowParamsOverride: false,
-    },
-    deleteOneBase: {
-      returnDeleted: false,
-    },
-    createOneBase: {
-      returnShallow: false,
-    },
-  },
-});
-
-export async function bootstrapSetup(AppModule, SetupSwagger) {
-  initializeTransactionalContext();
-  const app = await NestFactory.create<NestExpressApplication>(AppModule, {
-    bufferLogs: true,
-  });
-  const configService = app.select(ServiceRegistryModule).get(ApiConfigService);
-
-  app.useLogger(app.get(Logger));
-  app.flushLogs();
-  app.enableShutdownHooks();
-  app.enableVersioning();
-  app.enable('trust proxy');
-
-  const reflector = app.get(Reflector);
-
-  app.useGlobalFilters(
-    new HttpExceptionFilter(),
-    new QueryFailedFilter(reflector),
-  );
-
-  app.use(
-    new ClsMiddleware({}).use,
-    RequestIdMiddleware(),
-    PowerByMiddleware(),
-    OmniAuthMiddleware(),
-  );
-
-  app.useStaticAssets('public', { prefix: '/' });
-
-  app.useGlobalInterceptors(
-    new AuthUserInterceptor(),
-    new TranslationInterceptor(),
-    new LoggerErrorInterceptor(),
-    new SentryInterceptor({
-      filters: [
-        {
-          type: HttpException,
-          filter: (exception: HttpException) => {
-            const status = exception.getStatus();
-            if (status === 401 || status === 404) {
-              return true;
-            }
-
-            return 200 > status;
-          },
-        },
-      ],
-    }),
-  );
-
-  app.useGlobalPipes(
-    new I18nValidationPipe({
-      whitelist: true,
-      errorHttpStatusCode: HttpStatus.UNPROCESSABLE_ENTITY,
-      transform: true,
-      stopAtFirstError: true,
-      validationError: { target: false, value: false },
-    }),
-  );
-
-  if (configService.skywalkingEnabled) {
-    agent.start();
-  }
-
-  if (configService.documentationEnabled && SetupSwagger) {
-    SetupSwagger(app, configService.documentationPath);
-  }
-
-  if (configService.viewsEnabled) {
-    app.setBaseViewsDir(join(__dirname, 'views'));
-    app.setViewEngine('ejs');
-  }
-
-  if (configService.sessionEnabled) {
-    app.use(session(configService.sessionConfig));
-  }
-
-  if (configService.corsEnabled) {
-    app.enableCors(configService.corsConfig);
-  }
-
-  const port = configService.appConfig.port;
-  await app.listen(port);
-
-  console.info(`server running on ${await app.getUrl()}`);
-  return app;
-}

package/src/setup/index.ts

@@ -1 +0,0 @@
-export * from './bootstrap.setup';

package/src/setup/microservices.setup.js

@@ -1,55 +0,0 @@
-"use strict";
-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 });
-exports.microserviceSetup = void 0;
-const common_1 = require("@nestjs/common");
-const microservices_1 = require("@nestjs/microservices");
-const core_1 = require("@nestcloud/core");
-const path_1 = require("path");
-const common_2 = require("@omni/common");
-function microserviceSetup(app, protoPath, options) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const { hostname = '0.0.0.0', enableMqtt, enableNats } = options;
-        common_2.AppUtils.killAppWithGrace(app);
-        app.connectMicroservice({
-            transport: microservices_1.Transport.GRPC,
-            options: {
-                url: `${hostname}:${core_1.NestCloud.global.boot.get('service.port')}`,
-                package: core_1.NestCloud.global.boot.get('service.name'),
-                protoPath: (0, path_1.join)(process.cwd(), `/dist/libs/proto-schema/${protoPath}`),
-            },
-        });
-        if (enableMqtt) {
-            app.connectMicroservice({
-                transport: microservices_1.Transport.MQTT,
-                options: {
-                    url: core_1.NestCloud.global.boot.get('mqtt.url'),
-                    clientId: core_1.NestCloud.global.boot.get('service.name') +
-                        Math.random().toString(16).substr(2, 8),
-                },
-            });
-        }
-        if (enableNats) {
-            app.connectMicroservice({
-                transport: microservices_1.Transport.NATS,
-                options: {
-                    url: core_1.NestCloud.global.boot.get('nats.url'),
-                    queue: 'd4_srv_queue',
-                },
-            });
-        }
-        yield app.startAllMicroservicesAsync();
-        common_1.Logger.log(`GRPC ${core_1.NestCloud.global.boot.get('service.name')} running on port: ${core_1.NestCloud.global.boot.get('service.port')}`, 'Bootstrap');
-        yield app.listen(null);
-        common_1.Logger.log(`REST ${core_1.NestCloud.global.boot.get('service.name')} running on: ${yield app.getUrl()}`, 'Bootstrap');
-    });
-}
-exports.microserviceSetup = microserviceSetup;

package/src/setup-swagger.ts

@@ -1,67 +0,0 @@
-import type { INestApplication } from '@nestjs/common';
-import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
-
-export function setupSwagger(app: INestApplication): void {
-  const documentBuilder = new DocumentBuilder()
-    .setTitle('API')
-    .setDescription(
-      `### REST
-
-Routes is following REST standard (Richardson level 3)
-
-<details><summary>Detailed specification</summary>
-<p>
-
-**List:**
-  - \`GET /<resource>/\`
-    - Get the list of **<resource>** as admin
-  - \`GET /user/<user_id>/<resource>/\`
-    - Get the list of **<resource>** for a given **<user_id>**
-    - Output a **403** if logged user is not **<user_id>**
-
-**Detail:**
-  - \`GET /<resource>/<resource_id>\`
-    - Get the detail for **<resource>** of id **<resource_id>**
-    - Output a **404** if not found
-  - \`GET /user/<user_id>/<resource>/<resource_id>\`
-    - Get the list of **<resource>** for a given **user_id**
-    - Output a **404** if not found
-    - Output a **403** if:
-      - Logged user is not **<user_id>**
-      - The **<user_id>** have no access to **<resource_id>**
-
-**Creation / Edition / Replacement / Suppression:**
-  - \`<METHOD>\` is:
-    - **POST** for creation
-    - **PATCH** for update (one or more fields)
-    - **PUT** for replacement (all fields, not used)
-    - **DELETE** for suppression (all fields, not used)
-  - \`<METHOD> /<resource>/<resource_id>\`
-    - Create **<resource>** with id **<resource_id>** as admin
-    - Output a **400** if **<resource_id>** conflicts with existing **<resource>**
-  - \`<METHOD> /user/<user_id>/<resource>/<resource_id>\`
-    - Create **<resource>** with id **<resource_id>** as a given **user_id**
-    - Output a **409** if **<resource_id>** conflicts with existing **<resource>**
-    - Output a **403** if:
-      - Logged user is not **<user_id>**
-      - The **<user_id>** have no access to **<resource_id>**
-</p>
-</details>`,
-    )
-    .addBearerAuth();
-
-  if (process.env.API_VERSION) {
-    documentBuilder.setVersion(process.env.API_VERSION);
-  }
-
-  const document = SwaggerModule.createDocument(app, documentBuilder.build());
-  SwaggerModule.setup('documentation', app, document, {
-    swaggerOptions: {
-      persistAuthorization: true,
-    },
-  });
-
-  console.info(
-    `Documentation: http://localhost:${process.env.PORT}/documentation`,
-  );
-}

package/src/shared/index.ts

@@ -1,2 +0,0 @@
-export * from './serviceRegistryModule';
-export * from './services';

package/src/shared/serviceRegistryModule.js

@@ -1,176 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-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 __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-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 });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ServiceRegistryModule = void 0;
-const path = __importStar(require("path"));
-const process = __importStar(require("process"));
-const typeorm_1 = require("typeorm");
-const bull_1 = require("@nestjs/bull");
-const nestjs_pino_1 = require("nestjs-pino");
-const config_1 = require("@nestjs/config");
-const common_1 = require("@nestjs/common");
-const typeorm_2 = require("@nestjs/typeorm");
-const schedule_1 = require("@nestjs/schedule");
-const nestjs_sentry_1 = require("@ntegral/nestjs-sentry");
-const cache_manager_1 = require("@nestjs/cache-manager");
-const typeorm_transactional_1 = require("typeorm-transactional");
-const nestjs_i18n_1 = require("nestjs-i18n");
-const health_checker_module_1 = require("../health-checker/health-checker.module");
-const services_1 = require("./services");
-const fs_1 = require("fs");
-const providers = [
-    services_1.ApiConfigService,
-    services_1.ValidatorService,
-    services_1.AwsS3Service,
-    services_1.GeneratorService,
-    services_1.TranslationService,
-];
-services_1.ApiConfigService.rootPath =
-    process.env.NODE_ENV === 'test' ? process.cwd() : __dirname;
-const envFilePath = path.join(services_1.ApiConfigService.rootPath, 'config', `${process.env.NODE_ENV || ''}.env`);
-if (!(0, fs_1.existsSync)(envFilePath)) {
-    throw new Error(`*.env file not found in ${envFilePath}`);
-}
-const modules = [
-    config_1.ConfigModule.forRoot({
-        isGlobal: true,
-        expandVariables: true,
-        envFilePath: envFilePath,
-    }),
-    nestjs_sentry_1.SentryModule.forRootAsync({
-        inject: [services_1.ApiConfigService],
-        useFactory(configService) {
-            return configService.sentryConfig;
-        },
-    }),
-    nestjs_pino_1.LoggerModule.forRootAsync({
-        inject: [services_1.ApiConfigService],
-        useFactory: (config) => config.pinoConfig,
-    }),
-    typeorm_2.TypeOrmModule.forRootAsync({
-        inject: [services_1.ApiConfigService],
-        useFactory: (config) => config.typeormConfig,
-        dataSourceFactory: (options) => __awaiter(void 0, void 0, void 0, function* () {
-            return (0, typeorm_transactional_1.addTransactionalDataSource)(new typeorm_1.DataSource(options));
-        }),
-    }),
-    nestjs_i18n_1.I18nModule.forRootAsync({
-        inject: [services_1.ApiConfigService],
-        useFactory: (config) => ({
-            fallbackLanguage: config.fallbackLanguage,
-            loaderOptions: {
-                path: path.join(__dirname, '/i18n/'),
-                watch: config.isDev,
-            },
-            logging: config.isDev,
-        }),
-        resolvers: [new nestjs_i18n_1.QueryResolver(['lang']), nestjs_i18n_1.AcceptLanguageResolver],
-    }),
-    health_checker_module_1.HealthCheckerModule,
-];
-if (services_1.ApiConfigService.toBoolean(process.env.BULL_ENABLED)) {
-    modules.push(bull_1.BullModule.forRootAsync({
-        inject: [services_1.ApiConfigService],
-        useFactory: (config) => config.bullConfig,
-    }));
-}
-if (services_1.ApiConfigService.toBoolean(process.env.CACHE_ENABLED)) {
-    modules.push(cache_manager_1.CacheModule.registerAsync({
-        inject: [services_1.ApiConfigService],
-        useFactory: (config) => config.cacheConfig(),
-    }));
-}
-if (services_1.ApiConfigService.toBoolean(process.env.SCHEDULE_ENABLED)) {
-    modules.push(schedule_1.ScheduleModule.forRoot());
-}
-let ServiceRegistryModule = (() => {
-    let _classDecorators = [(0, common_1.Global)(), (0, common_1.Module)({
-            providers,
-            imports: modules,
-            exports: [...providers, ...modules],
-        })];
-    let _classDescriptor;
-    let _classExtraInitializers = [];
-    let _classThis;
-    var ServiceRegistryModule = _classThis = class {
-    };
-    __setFunctionName(_classThis, "ServiceRegistryModule");
-    (() => {
-        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);
-        ServiceRegistryModule = _classThis = _classDescriptor.value;
-        if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
-        __runInitializers(_classThis, _classExtraInitializers);
-    })();
-    return ServiceRegistryModule = _classThis;
-})();
-exports.ServiceRegistryModule = ServiceRegistryModule;

package/src/shared/serviceRegistryModule.ts

@@ -1,110 +0,0 @@
-import * as path from 'path';
-import * as process from 'process';
-import { DataSource } from 'typeorm';
-import { BullModule } from '@nestjs/bull';
-import { LoggerModule } from 'nestjs-pino';
-import { ConfigModule } from '@nestjs/config';
-import type { Provider } from '@nestjs/common';
-import { Global, Module } from '@nestjs/common';
-import { TypeOrmModule } from '@nestjs/typeorm';
-import { ScheduleModule } from '@nestjs/schedule';
-import { SentryModule } from '@ntegral/nestjs-sentry';
-import { CacheModule } from '@nestjs/cache-manager';
-import { addTransactionalDataSource } from 'typeorm-transactional';
-import { AcceptLanguageResolver, I18nModule, QueryResolver } from 'nestjs-i18n';
-import { HealthCheckerModule } from '../health-checker/health-checker.module';
-import {
-  ApiConfigService,
-  AwsS3Service,
-  GeneratorService,
-  TranslationService,
-  ValidatorService,
-} from './services';
-import { existsSync } from 'fs';
-
-const providers: Provider[] = [
-  ApiConfigService,
-  ValidatorService,
-  AwsS3Service,
-  GeneratorService,
-  TranslationService,
-];
-
-ApiConfigService.rootPath =
-  process.env.NODE_ENV === 'test' ? process.cwd() : __dirname;
-const envFilePath = path.join(
-  ApiConfigService.rootPath,
-  'config',
-  `${process.env.NODE_ENV || ''}.env`,
-);
-if (!existsSync(envFilePath)) {
-  throw new Error(`*.env file not found in ${envFilePath}`);
-}
-
-const modules = [
-  ConfigModule.forRoot({
-    isGlobal: true,
-    expandVariables: true,
-    envFilePath: envFilePath,
-  }),
-  SentryModule.forRootAsync({
-    inject: [ApiConfigService],
-    useFactory(configService: ApiConfigService) {
-      return configService.sentryConfig;
-    },
-  }),
-  LoggerModule.forRootAsync({
-    inject: [ApiConfigService],
-    useFactory: (config: ApiConfigService) => config.pinoConfig,
-  }),
-  TypeOrmModule.forRootAsync({
-    inject: [ApiConfigService],
-    useFactory: (config: ApiConfigService) => config.typeormConfig,
-    dataSourceFactory: async (options) => {
-      return addTransactionalDataSource(new DataSource(options));
-    },
-  }),
-  I18nModule.forRootAsync({
-    inject: [ApiConfigService],
-    useFactory: (config: ApiConfigService) => ({
-      fallbackLanguage: config.fallbackLanguage,
-      loaderOptions: {
-        path: path.join(__dirname, '/i18n/'),
-        watch: config.isDev,
-      },
-      logging: config.isDev,
-    }),
-    resolvers: [new QueryResolver(['lang']), AcceptLanguageResolver],
-  }),
-  HealthCheckerModule,
-];
-
-if (ApiConfigService.toBoolean(process.env.BULL_ENABLED)) {
-  modules.push(
-    BullModule.forRootAsync({
-      inject: [ApiConfigService],
-      useFactory: (config: ApiConfigService) => config.bullConfig,
-    }),
-  );
-}
-
-if (ApiConfigService.toBoolean(process.env.CACHE_ENABLED)) {
-  modules.push(
-    CacheModule.registerAsync({
-      inject: [ApiConfigService],
-      useFactory: (config: ApiConfigService) => config.cacheConfig(),
-    }),
-  );
-}
-
-if (ApiConfigService.toBoolean(process.env.SCHEDULE_ENABLED)) {
-  modules.push(ScheduleModule.forRoot());
-}
-
-@Global()
-@Module({
-  providers,
-  imports: modules,
-  exports: [...providers, ...modules],
-})
-export class ServiceRegistryModule {}