@nest-yalc-2/app 1.3.3

package/src/app-bootstrap.helper.ts

@@ -0,0 +1,263 @@
+import { SystemExceptionFilter } from '@nest-yalc-2/errors/filters/index.js';
+import {
+  BadRequestException,
+  ExceptionFilter,
+  NestApplicationOptions,
+  ValidationPipe,
+  ValidationPipeOptions,
+} from '@nestjs/common';
+import { NestFactory } from '@nestjs/core';
+// import { GqlExceptionFilter } from '@nestjs/graphql';
+import {
+  FastifyAdapter,
+  NestFastifyApplication,
+} from '@nestjs/platform-fastify';
+import fastifyCookie from '@fastify/cookie';
+import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
+import { fastify, FastifyInstance } from 'fastify';
+import { envIsTrue } from '@nest-yalc-2/utils/env.helper.js';
+import { useContainer } from 'class-validator';
+import clc from 'cli-color';
+import {
+  BaseAppBootstrap,
+  IGlobalOptions,
+} from './app-bootstrap-base.helper.js';
+import { getEnvLoggerLevels } from '@nest-yalc-2/logger/logger.helper.js';
+import { UnwrapResultInterceptor } from './unwrap-result.interceptor.js';
+
+export interface ICreateOptions {
+  enableSwagger?: boolean;
+  /**
+   * Path segment (without leading slash) where Swagger UI/JSON is exposed.
+   * Defaults to "api".
+   */
+  swaggerPath?: string;
+  filters?: ExceptionFilter[];
+  validationPipeOptions?: ValidationPipeOptions;
+  /**
+   * On some cases we do want to manually override the apiPrefix of the service conf
+   */
+  apiPrefix?: string;
+}
+
+export interface INestCreateOptions
+  extends ICreateOptions, NestApplicationOptions {}
+
+export class AppBootstrap<
+  TGlobalOptions extends IGlobalOptions = IGlobalOptions,
+> extends BaseAppBootstrap<NestFastifyApplication> {
+  private fastifyInstance?: FastifyInstance;
+  protected isSwaggerEnabled: boolean = false;
+  protected swaggerPath = 'api';
+
+  constructor(appAlias: string, module: any, options?: TGlobalOptions) {
+    super(appAlias, module, { globalsOptions: options });
+  }
+
+  async startServer(options?: {
+    createOptions?: INestCreateOptions;
+    fastifyInstance?: FastifyInstance;
+  }) {
+    await this.initApp(options);
+
+    if (envIsTrue(process.env.APP_DRY_RUN) === true) {
+      await this.closeApp();
+      process.exit(0);
+    }
+
+    // no need to wait here
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    this.listen();
+
+    return this;
+  }
+
+  async initApp(options?: {
+    createOptions?: INestCreateOptions;
+    fastifyInstance?: FastifyInstance;
+  }) {
+    await this.createApp({
+      fastifyInstance: this.fastifyInstance,
+      createOptions: options?.createOptions,
+    });
+
+    return this.initSetup({
+      fastifyInstance: this.fastifyInstance,
+      createOptions: options?.createOptions,
+    });
+  }
+
+  async initSetup(options?: {
+    createOptions?: ICreateOptions;
+    fastifyInstance?: FastifyInstance;
+  }) {
+    try {
+      await this.applyBootstrapGlobals(options?.createOptions);
+
+      await this.getApp().init();
+    } catch (err) {
+      console.error('App init failed:', err);
+      this.closeCleanup();
+      throw new Error('Process aborted');
+    }
+
+    if (envIsTrue(process.env.APP_DRY_RUN) === true) {
+      this.loggerService?.log('Dry run, exiting...');
+      await this.closeApp();
+      process.exit(0);
+    }
+
+    return this;
+  }
+
+  async createApp(options?: {
+    createOptions?: INestCreateOptions;
+    fastifyInstance?: FastifyInstance;
+  }) {
+    this.fastifyInstance = options?.fastifyInstance ?? fastify();
+
+    let app;
+    try {
+      app = await NestFactory.create<NestFastifyApplication>(
+        this.module,
+        new FastifyAdapter(this.fastifyInstance as any),
+        {
+          bufferLogs: false,
+          abortOnError: options?.createOptions?.abortOnError ?? false,
+          logger: getEnvLoggerLevels(),
+          ...(options?.createOptions ?? {}),
+        },
+      );
+    } catch (err) {
+      this.closeCleanup();
+      // eslint-disable-next-line no-console
+      console.error(clc.red('Failed to create app'), clc.red(err));
+      throw new Error('Process aborted');
+    }
+
+    return this.setApp(app);
+  }
+
+  getFastifyInstance() {
+    return this.fastifyInstance;
+  }
+
+  setSwaggerEnabled(enabled: boolean) {
+    this.isSwaggerEnabled = enabled;
+  }
+
+  async applyBootstrapGlobals(options?: ICreateOptions) {
+    await super.applyBootstrapGlobals(options);
+
+    this.getApp().useGlobalPipes(
+      new ValidationPipe({
+        transform: true,
+        transformOptions: { enableImplicitConversion: false },
+        validateCustomDecorators: true,
+        exceptionFactory: (errors) => {
+          const errorMessages: { [key: string]: any } = {};
+          errors.forEach((error) => {
+            errorMessages[error.property] = error;
+          });
+          return new BadRequestException(errorMessages);
+        },
+        ...(options?.validationPipeOptions ?? {}),
+      }),
+    );
+
+    this.getApp().setGlobalPrefix(
+      options?.apiPrefix ?? (this.getConf()?.apiPrefix || ''),
+    );
+
+    await this.getApp().register(fastifyCookie as any, {});
+
+    this.getApp().useGlobalInterceptors(new UnwrapResultInterceptor());
+
+    /**
+     * @todo refactor using a factory function to share with all services
+     */
+    const filters = [
+      new SystemExceptionFilter(this.loggerService),
+      ...(options?.filters ?? []),
+    ];
+    this.getApp().useGlobalFilters(...filters);
+
+    if (options?.enableSwagger) {
+      const swaggerPath = sanitizeSwaggerPath(options.swaggerPath);
+      this.swaggerPath = swaggerPath;
+      this.setSwaggerEnabled(true);
+      const document = SwaggerModule.createDocument(
+        this.getApp(),
+        this.buildSwaggerConfig().build(),
+      );
+      SwaggerModule.setup(swaggerPath, this.getApp(), document, {
+        jsonDocumentUrl: `/${swaggerPath}/json`,
+        useGlobalPrefix: true,
+      });
+    }
+
+    useContainer(this.getApp().select(this.getModule()), {
+      fallbackOnErrors: true,
+    });
+
+    return this;
+  }
+
+  buildSwaggerConfig() {
+    return new DocumentBuilder()
+      .setTitle(this.appAlias)
+      .setDescription(`${this.appAlias} rest api`);
+  }
+
+  async listen(callback?: {
+    (port: number, host: string, domain: string): void;
+  }) {
+    const port = this.getConf()?.port || 0;
+    const host = this.getConf()?.host || '0.0.0.0';
+    let apiPrefix = this.getConf()?.apiPrefix;
+    apiPrefix = apiPrefix ? `/${apiPrefix}` : '';
+    const domain = this.getConf()?.domain || 'localhost';
+    await this.getApp().listen(port, host, async (_err, address) => {
+      // eslint-disable-next-line no-console
+      console.debug(`Server ${this.appAlias} listening on
+        http://localhost:${port}${apiPrefix}/
+        http://127.0.0.1:${port}${apiPrefix}/
+        http://${domain}:${port}${apiPrefix}/
+        ${address}`);
+
+      // // eslint-disable-next-line no-console
+      // console.debug(`GraphQL ${this.appAlias} listening on
+      //   http://localhost:${port}${apiPrefix}/graphql
+      //   http://127.0.0.1:${port}${apiPrefix}/graphql
+      //   http://${domain}:${port}${apiPrefix}/graphql`);
+
+      if (this.isSwaggerEnabled) {
+        // eslint-disable-next-line no-console
+        console.debug(`Swagger ${this.appAlias} listening on
+        http://localhost:${port}${apiPrefix}/${this.swaggerPath}
+        http://127.0.0.1:${port}${apiPrefix}/${this.swaggerPath}
+        http://${domain}:${port}${apiPrefix}/${this.swaggerPath}
+        ${address}/${this.swaggerPath}
+        JSON: http://localhost:${port}${apiPrefix}/${this.swaggerPath}/json`);
+      }
+
+      callback?.(port, host, domain);
+    });
+
+    /**
+     * Hot reload @see https://docs.nestjs.com/recipes/hot-reload#hot-module-replacement-1
+     */
+    const hmr = typeof module !== 'undefined' ? (module as any).hot : undefined;
+    if (hmr) {
+      // eslint-disable-next-line no-console
+      console.debug('Hot reload enabled. Reloading...');
+      hmr.accept();
+      hmr.dispose(() => this.closeApp());
+    }
+  }
+}
+
+function sanitizeSwaggerPath(path?: string): string {
+  const normalized = (path ?? 'api').replace(/^\/+/, '').replace(/\/+$/, '');
+  return normalized || 'api';
+}

package/src/app-config.service.d.ts

@@ -0,0 +1,14 @@
+import { Provider } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+export declare class AppConfigService<T = any> {
+    readonly service: ConfigService;
+    protected readonly appAlias: string;
+    protected _config: T;
+    constructor(service: ConfigService, appAlias: string);
+    get values(): T;
+    get(): T;
+}
+export declare function createAppConfigProvider(appAlias: string): Provider;
+export declare function getAppConfigToken(appAlias: string): string;
+export declare function getAppEventToken(appAlias: string): string;
+export declare function getAppLoggerToken(appAlias: string): string;

package/src/app-config.service.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppConfigService = void 0;
+exports.createAppConfigProvider = createAppConfigProvider;
+exports.getAppConfigToken = getAppConfigToken;
+exports.getAppEventToken = getAppEventToken;
+exports.getAppLoggerToken = getAppLoggerToken;
+const config_1 = require("@nestjs/config");
+class AppConfigService {
+    constructor(service, appAlias) {
+        this.service = service;
+        this.appAlias = appAlias;
+        const config = this.service.get(this.appAlias);
+        if (!config) {
+            throw new Error(`AppConfigService: No config found for app alias '${this.appAlias}'`);
+        }
+        this._config = config;
+    }
+    get values() {
+        return this._config;
+    }
+    get() {
+        return this.values;
+    }
+}
+exports.AppConfigService = AppConfigService;
+function createAppConfigProvider(appAlias) {
+    return {
+        provide: getAppConfigToken(appAlias),
+        useFactory: (config) => {
+            return new AppConfigService(config, appAlias);
+        },
+        inject: [config_1.ConfigService],
+    };
+}
+function getAppConfigToken(appAlias) {
+    return `${appAlias}Config`;
+}
+function getAppEventToken(appAlias) {
+    return `${appAlias}Event`;
+}
+function getAppLoggerToken(appAlias) {
+    return `${appAlias}Logger`;
+}
+//# sourceMappingURL=app-config.service.js.map

package/src/app-config.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-config.service.js","sourceRoot":"","sources":["app-config.service.ts"],"names":[],"mappings":";;;AAwCA,0DAQC;AAED,8CAEC;AAED,4CAEC;AAED,8CAEC;AA3DD,2CAA+C;AAO/C,MAAa,gBAAgB;IAG3B,YACkB,OAAsB,EACnB,QAAgB;QADnB,YAAO,GAAP,OAAO,CAAe;QACnB,aAAQ,GAAR,QAAQ,CAAQ;QAEnC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAI,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CACb,oDAAoD,IAAI,CAAC,QAAQ,GAAG,CACrE,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAKD,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAKD,GAAG;QACD,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF;AA9BD,4CA8BC;AAED,SAAgB,uBAAuB,CAAC,QAAgB;IACtD,OAAO;QACL,OAAO,EAAE,iBAAiB,CAAC,QAAQ,CAAC;QACpC,UAAU,EAAE,CAAC,MAAqB,EAAoB,EAAE;YACtD,OAAO,IAAI,gBAAgB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAChD,CAAC;QACD,MAAM,EAAE,CAAC,sBAAa,CAAC;KACxB,CAAC;AACJ,CAAC;AAED,SAAgB,iBAAiB,CAAC,QAAgB;IAChD,OAAO,GAAG,QAAQ,QAAQ,CAAC;AAC7B,CAAC;AAED,SAAgB,gBAAgB,CAAC,QAAgB;IAC/C,OAAO,GAAG,QAAQ,OAAO,CAAC;AAC5B,CAAC;AAED,SAAgB,iBAAiB,CAAC,QAAgB;IAChD,OAAO,GAAG,QAAQ,QAAQ,CAAC;AAC7B,CAAC"}

package/src/app-config.service.ts

@@ -0,0 +1,61 @@
+import { Provider } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+
+/**
+ * This service is used to access the app config registered with a specific app alias.
+ * This is useful when you want to access the config of the current app with the dependency injection and
+ * without specifying the app alias.
+ */
+export class AppConfigService<T = any> {
+  protected _config: T;
+
+  constructor(
+    public readonly service: ConfigService,
+    protected readonly appAlias: string,
+  ) {
+    const config = this.service.get<T>(this.appAlias);
+    if (!config) {
+      throw new Error(
+        `AppConfigService: No config found for app alias '${this.appAlias}'`,
+      );
+    }
+
+    this._config = config;
+  }
+
+  /**
+   * Type-safe access to the app config values of the current app.
+   */
+  get values(): T {
+    return this._config;
+  }
+
+  /**
+   * @deprecated - use .values instead
+   */
+  get(): T {
+    return this.values;
+  }
+}
+
+export function createAppConfigProvider(appAlias: string): Provider {
+  return {
+    provide: getAppConfigToken(appAlias),
+    useFactory: (config: ConfigService): AppConfigService => {
+      return new AppConfigService(config, appAlias);
+    },
+    inject: [ConfigService],
+  };
+}
+
+export function getAppConfigToken(appAlias: string): string {
+  return `${appAlias}Config`;
+}
+
+export function getAppEventToken(appAlias: string): string {
+  return `${appAlias}Event`;
+}
+
+export function getAppLoggerToken(appAlias: string): string {
+  return `${appAlias}Logger`;
+}

package/src/app-context.module.d.ts

@@ -0,0 +1,2 @@
+export declare class AppContextModule {
+}

package/src/app-context.module.js

@@ -0,0 +1,19 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppContextModule = void 0;
+const common_1 = require("@nestjs/common");
+const app_context_service_js_1 = require("./app-context.service.js");
+let AppContextModule = class AppContextModule {
+};
+exports.AppContextModule = AppContextModule;
+exports.AppContextModule = AppContextModule = __decorate([
+    (0, common_1.Global)(),
+    (0, common_1.Module)({ providers: [app_context_service_js_1.AppContextService], exports: [app_context_service_js_1.AppContextService] })
+], AppContextModule);
+//# sourceMappingURL=app-context.module.js.map

package/src/app-context.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-context.module.js","sourceRoot":"","sources":["app-context.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAgD;AAChD,qEAA6D;AAItD,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;CAAG,CAAA;AAAnB,4CAAgB;2BAAhB,gBAAgB;IAF5B,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC,EAAE,SAAS,EAAE,CAAC,0CAAiB,CAAC,EAAE,OAAO,EAAE,CAAC,0CAAiB,CAAC,EAAE,CAAC;GAC5D,gBAAgB,CAAG"}

package/src/app-context.module.ts

@@ -0,0 +1,6 @@
+import { Global, Module } from '@nestjs/common';
+import { AppContextService } from './app-context.service.js';
+
+@Global()
+@Module({ providers: [AppContextService], exports: [AppContextService] })
+export class AppContextModule {}

package/src/app-context.service.d.ts

@@ -0,0 +1,7 @@
+import { GraphQLSchema } from 'graphql';
+export declare class AppContextService {
+    initializedApps: Set<string>;
+    private graphQLSchema;
+    setSchema(schema: GraphQLSchema): void;
+    get schema(): GraphQLSchema;
+}

package/src/app-context.service.js

@@ -0,0 +1,26 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppContextService = void 0;
+const common_1 = require("@nestjs/common");
+let AppContextService = class AppContextService {
+    constructor() {
+        this.initializedApps = new Set();
+    }
+    setSchema(schema) {
+        this.graphQLSchema = schema;
+    }
+    get schema() {
+        return this.graphQLSchema;
+    }
+};
+exports.AppContextService = AppContextService;
+exports.AppContextService = AppContextService = __decorate([
+    (0, common_1.Injectable)()
+], AppContextService);
+//# sourceMappingURL=app-context.service.js.map

package/src/app-context.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-context.service.js","sourceRoot":"","sources":["app-context.service.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAA4C;AAIrC,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;IAAvB;QACE,oBAAe,GAAG,IAAI,GAAG,EAAU,CAAC;IAU7C,CAAC;IAPQ,SAAS,CAAC,MAAqB;QACpC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC;IAC9B,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;CACF,CAAA;AAXY,8CAAiB;4BAAjB,iBAAiB;IAD7B,IAAA,mBAAU,GAAE;GACA,iBAAiB,CAW7B"}

package/src/app-context.service.ts

@@ -0,0 +1,16 @@
+import { Injectable } from '@nestjs/common';
+import { GraphQLSchema } from 'graphql';
+
+@Injectable()
+export class AppContextService {
+  public initializedApps = new Set<string>();
+  private graphQLSchema!: GraphQLSchema;
+
+  public setSchema(schema: GraphQLSchema) {
+    this.graphQLSchema = schema;
+  }
+
+  public get schema() {
+    return this.graphQLSchema;
+  }
+}

package/src/app-imports.factory.d.ts

@@ -0,0 +1,19 @@
+import { ModuleMetadata } from '@nestjs/common';
+import { BuildSchemaOptions } from '@nestjs/graphql';
+import { ClassType } from '@nest-yalc-2/types/globals.d.js';
+import { ApolloFederationDriverConfig } from '@nestjs/apollo';
+type ApolloServerPlugin = NonNullable<ApolloFederationDriverConfig['plugins']>[number];
+export interface IAppImportsFactory {
+    envPath?: string | string[];
+    setupEvents?: boolean;
+    setupJwt?: boolean;
+    keepDBConnectionAlive?: boolean;
+    operationPrefix?: string;
+    buildSchemaOptions?: BuildSchemaOptions;
+    gqlPlugin?: ClassType<ApolloServerPlugin>[];
+    disablePlayground?: boolean;
+}
+type PickModuleMetadata = 'imports' | 'providers' | 'exports';
+export type AppModuleMetadata = Required<Pick<ModuleMetadata, PickModuleMetadata>>;
+export declare function AppDependencyFactory(_context: string, confs: any[], dbConnNames: string[], gqlModules: any[], options?: IAppImportsFactory): AppModuleMetadata;
+export {};