Add initialization helper and update default context

Author: Bruno Castro

src/_boot/index.ts

@@ -1,19 +1,24 @@
-import { server } from '@/_boot/server';
-import { appModules } from '@/_boot/appModules';
+import { server, ServerConfig, ServerRegistry } from '@/_boot/server';
+import { appModules, AppModulesConfig, AppModulesRegistry } from '@/_boot/appModules';
 import { asValue } from 'awilix';
-import { database } from '@/_boot/database';
-import { repl } from '@/_boot/repl';
+import { database, DatabaseConfig, DatabaseRegistry } from '@/_boot/database';
+import { repl, REPLConfig } from '@/_boot/repl';
 import { withContext } from '@/context';
 import { Configuration } from '@/config';
 import { Logger } from 'pino';
-import { pubSub } from '@/_boot/pubSub';
-import { MessageBundle } from '@/messages';
-import { swagger } from '@/_boot/swagger';
+import { pubSub, PubSubRegistry } from '@/_boot/pubSub';
+import { swagger, SwaggerConfig } from '@/_boot/swagger';
+import { EnvironmentConfig } from '@/_lib/Environment';
+import { ContextApp } from '@/_lib/Context';
+import { Container, Initialize } from '@/container';
 
-const main = withContext(async ({ app, container, config, bootstrap, logger, messageBundle }) => {
+type MainConfig = ServerConfig & DatabaseConfig & EnvironmentConfig & REPLConfig & SwaggerConfig & AppModulesConfig;
+
+const main = withContext(async ({ app, container, config, bootstrap, logger, initialize }) => {
   container.register({
     app: asValue(app),
-    messageBundle: asValue(messageBundle),
+    initialize: asValue(initialize),
+    container: asValue(container),
     logger: asValue(logger),
     startedAt: asValue(new Date()),
     config: asValue(config),
@@ -23,12 +28,16 @@ const main = withContext(async ({ app, container, config, bootstrap, logger, mes
 });
 
 type MainRegistry = {
-  app: any;
-  messageBundle: MessageBundle;
+  app: ContextApp;
+  container: Container;
+  initialize: Initialize;
   startedAt: Date;
   logger: Logger;
   config: Configuration;
-};
+} & DatabaseRegistry &
+  ServerRegistry &
+  PubSubRegistry &
+  AppModulesRegistry;
 
 export { main };
-export type { MainRegistry };
+export type { MainConfig, MainRegistry };

src/_lib/Context.ts

@@ -9,8 +9,10 @@ type Module<T extends Record<string | symbol, any>, F extends BootFn<T> = BootFn
   fn: F;
 };
 
+type ContextApp = Omit<Application, 'start' | 'onBooting'>;
+
 type Context<T extends Record<string | symbol, any>> = {
-  app: Omit<Application, 'start' | 'onBooting'>;
+  app: ContextApp;
   bootstrap: <M extends Module<T>[]>(...modules: M) => Promise<void>;
 } & T;
 
@@ -109,3 +111,4 @@ const makeContext = <T extends Record<string | symbol, any>>(
 };
 
 export { makeContext };
+export type { ContextApp };

src/_lib/Initialize.ts

@@ -0,0 +1,23 @@
+type InitFn<R, T, OPTS = void> = (deps: R, opts?: OPTS) => T;
+type BuilderFn<R, OPTS = void> = <T>(fn: InitFn<R, T, OPTS>) => T;
+type ThenArg<T extends (...args: any[]) => Promise<any>> = ReturnType<T> extends PromiseLike<infer U>
+  ? U
+  : ReturnType<T>;
+
+type Initialize<R, OPTS = void> = <T extends Array<InitFn<R, unknown, OPTS>>>(
+  ...fns: T
+) => Promise<{ [i in keyof T]: T[i] extends (...args) => any ? ThenArg<T[i]> : T[i] }>;
+
+const makeInitialize =
+  <R extends Record<string, any>, OPTS = void>(builderFn: BuilderFn<R, OPTS>): Initialize<R, OPTS> =>
+  <T extends Array<InitFn<R, unknown, OPTS>>>(
+    ...fns: T
+  ): Promise<{ [i in keyof T]: T[i] extends (...args) => any ? ThenArg<T[i]> : T[i] }> =>
+    fns.reduce(
+      (chain, fn) =>
+        chain.then((results) => Promise.resolve(builderFn(fn)).then((result) => Promise.resolve([...results, result]))),
+      Promise.resolve<any[]>([])
+    ) as any;
+
+export { makeInitialize };
+export type { Initialize };

src/config.ts

@@ -1,11 +1,7 @@
-import { REPLConfig } from '@/_boot/repl';
+import { MainConfig } from '@/_boot';
 import { environment, EnvironmentConfig, envNumber, envString } from '@/_lib/Environment';
-import { ServerConfig } from '@/_boot/server';
-import { DatabaseConfig } from '@/_boot/database';
-import { SwaggerConfig } from '@/_boot/swagger';
-import { AppModulesConfig } from '@/_boot/appModules';
 
-type Configuration = ServerConfig & DatabaseConfig & EnvironmentConfig & REPLConfig & SwaggerConfig & AppModulesConfig;
+type Configuration = MainConfig & EnvironmentConfig;
 
 const config: Configuration = {
   appName: 'node-api-boilerplate',

src/container.ts

@@ -1,15 +1,14 @@
-import { createContainer } from 'awilix';
+import { BuildResolverOptions, createContainer } from 'awilix';
 import { MainRegistry } from '@/_boot';
-import { DatabaseRegistry } from '@/_boot/database';
-import { ServerRegistry } from '@/_boot/server';
-import { PubSubRegistry } from '@/_boot/pubSub';
-import { AppModulesRegistry } from '@/_boot/appModules';
+import { makeInitialize } from '@/_lib/Initialize';
 
-type Registry = MainRegistry & DatabaseRegistry & ServerRegistry & PubSubRegistry & AppModulesRegistry;
+type Registry = MainRegistry;
 
 const container = createContainer<Registry>();
+const initialize = makeInitialize<Registry, BuildResolverOptions<any>>(container.build);
 
 type Container = typeof container;
+type Initialize = typeof initialize;
 
-export { container };
-export type { Container, Registry };
+export { container, initialize };
+export type { Container, Registry, Initialize };

src/context.ts

@@ -1,9 +1,8 @@
 import { makeContext } from '@/_lib/Context';
-import { container } from '@/container';
+import { container, initialize } from '@/container';
 import { config } from '@/config';
 import { logger } from '@/_lib/logger';
-import { messageBundle } from '@/messages';
 
-const { withContext, makeModule } = makeContext({ config, container, logger, messageBundle }, { logger });
+const { withContext, makeModule } = makeContext({ config, container, logger, initialize }, { logger });
 
 export { withContext, makeModule };

tsconfig.json

@@ -14,7 +14,7 @@
     "moduleResolution": "node",
     "baseUrl": "./src",
     "paths": {
-      "@/*": ["*"],
+      "@/*": ["*"]
     },
     "typeRoots": ["node_modules/@types"],
     "esModuleInterop": true,