Merge pull request #7 from Karibash/feature/option-def-separate

Make the type definitions of settings be split and defined separately

Author: Karibash

.changeset/dull-ants-explode.md

@@ -0,0 +1,5 @@
+---
+"@nestjs-modular/inject": patch
+---
+
+Make the type definitions of settings be split and defined separately

examples/inject/src/modules/core/core.module.ts

@@ -1,25 +1,22 @@
 import { Global, Module } from '@nestjs/common';
-import { InjectModule } from '@nestjs-modular/inject';
+import { InjectConditions, InjectModule } from '@nestjs-modular/inject';
 import path from 'path';
 
 const isMock = process.env.APP_ENV === 'mock';
-const repositoryType = isMock ? 'mock' : 'inmemory';
+
+const repositories: InjectConditions = {
+  path: path.resolve(__dirname, `../../infrastructures/repositories/${isMock ? 'mock' : 'inmemory'}`),
+  includeFileNames: [/\.repository$/],
+  includeExportNames: [/RepositoryProvider$/],
+};
 
 @Global()
 @Module({
   imports: [
     InjectModule.forRootAsync({
       global: true,
-      providers: {
-        path: path.resolve(__dirname, `../../infrastructures/repositories/${repositoryType}`),
-        includeFileNames: [/\.repository$/],
-        includeExportNames: [/RepositoryProvider$/],
-      },
-      exports: {
-        path: path.resolve(__dirname, `../../infrastructures/repositories/${repositoryType}`),
-        includeFileNames: [/\.repository$/],
-        includeExportNames: [/RepositoryProvider$/],
-      },
+      providers: repositories,
+      exports: repositories,
     }),
   ],
 })

examples/inject/src/modules/tasks/tasks.module.ts

@@ -1,22 +1,20 @@
 import { Module } from '@nestjs/common';
-import { InjectModule } from '@nestjs-modular/inject';
+import { InjectConditions, InjectModule } from '@nestjs-modular/inject';
 import path from 'path';
 
 import { TasksController } from './tasks.controller';
 
+const useCases: InjectConditions = {
+  path: path.resolve(__dirname, './usecases'),
+  includeFileNames: [/\.usecase$/],
+  includeExportNames: [/UseCase$/],
+};
+
 @Module({
   imports: [
     InjectModule.forRootAsync({
-      providers: {
-        path: path.resolve(__dirname, './usecases'),
-        includeFileNames: [/\.usecase$/],
-        includeExportNames: [/UseCase$/],
-      },
-      exports: {
-        path: path.resolve(__dirname, './usecases'),
-        includeFileNames: [/\.usecase$/],
-        includeExportNames: [/UseCase$/],
-      },
+      providers: useCases,
+      exports: useCases,
     }),
   ],
   controllers: [

examples/inject/src/modules/users/users.module.ts

@@ -1,22 +1,20 @@
 import { Module } from '@nestjs/common';
-import { InjectModule } from '@nestjs-modular/inject';
+import { InjectConditions, InjectModule } from '@nestjs-modular/inject';
 import path from 'path';
 
 import { UsersController } from './users.controller';
 
+const useCases: InjectConditions = {
+  path: path.resolve(__dirname, './usecases'),
+  includeFileNames: [/\.usecase$/],
+  includeExportNames: [/UseCase$/],
+};
+
 @Module({
   imports: [
     InjectModule.forRootAsync({
-      providers: {
-        path: path.resolve(__dirname, './usecases'),
-        includeFileNames: [/\.usecase$/],
-        includeExportNames: [/UseCase$/],
-      },
-      exports: {
-        path: path.resolve(__dirname, './usecases'),
-        includeFileNames: [/\.usecase$/],
-        includeExportNames: [/UseCase$/],
-      },
+      providers: useCases,
+      exports: useCases,
     }),
   ],
   controllers: [

packages/inject/src/index.ts

@@ -21,7 +21,7 @@ const someTests = (value: string, terms: Array<string | RegExp>, _default: boole
   });
 };
 
-const getInjectables = async <T>(conditions?: InjectConditions<T[]>): Promise<T[]> => {
+const getInjectables = async <T>(conditions?: InjectOptions<T[]>): Promise<T[]> => {
   const mergedConditions = {
     injects: [],
     includeFileNames: [],
@@ -71,9 +71,7 @@ const getInjectables = async <T>(conditions?: InjectConditions<T[]>): Promise<T[
   return [...injectables, ...mergedConditions.injects];
 };
 
-export type InjectConditions<T> = {
-  injects?: T;
-} & {
+export type InjectConditions = {
   path: string;
   includeFileNames?: Array<string | RegExp>;
   excludeFileNames?: Array<string | RegExp>;
@@ -83,11 +81,15 @@ export type InjectConditions<T> = {
   excludeExportNames?: Array<string | RegExp>;
 };
 
+export type InjectOptions<T> = InjectConditions & {
+  injects?: T;
+};
+
 export type InjectModuleOptions = Pick<DynamicModule, 'global'> & {
-  imports?: InjectConditions<Exclude<ModuleMetadata['imports'], undefined>>;
-  controllers?: InjectConditions<Exclude<ModuleMetadata['controllers'], undefined>>;
-  providers?: InjectConditions<Exclude<ModuleMetadata['providers'], undefined>>;
-  exports?: InjectConditions<Exclude<ModuleMetadata['exports'], undefined>>;
+  imports?: InjectOptions<Exclude<ModuleMetadata['imports'], undefined>>;
+  controllers?: InjectOptions<Exclude<ModuleMetadata['controllers'], undefined>>;
+  providers?: InjectOptions<Exclude<ModuleMetadata['providers'], undefined>>;
+  exports?: InjectOptions<Exclude<ModuleMetadata['exports'], undefined>>;
 };
 
 @Module({})