This simple minimal POC project, of how to use external packages in a nestjs package with a module and service exposed like @nestjs/jwt in a sub module json-web-token...confusing
I want to create a package, that have sub-modules, one of then use a external module and service, like @nestjs/jwt, but its is not easy peasy for me, I achieve that with the help of our friends @jmcdo29 and @Y Prospect from nestjs discord channel
in the end we want to our own nest js package, that consumes other external nest package like @nestjs/jwt
this is based on @jmcdo29 package https://github.com/rubiin/nestjs-easyconfig, just add a submodule and and external module @nestjs/jwt
thanks guys :)
- Publishing NestJS Packages with npm
- Dynamic modules
- Advanced NestJS: How to build completely dynamic NestJS modules
nestjs-easyconfig
# bootstrap app
$ nest new nestjs-easyconfig-consumer
$ cd nestjs-easyconfig-consumer/
$ npm install ../nestjs-easyconfigadd local package
"dependencies": {
"nestjs-easyconfig": "file:../nestjs-easyconfig",
},consume EasyconfigModule in consumer app
import { EasyconfigModule } from 'nestjs-easyconfig';
@Module({
imports: [
EasyconfigModule.register({ path: './config/.env' }),
],# create env file
$ mkdir config
$ code ./config/.envwith
ENV_VAR1=FOO
ENV_VAR2=BAR
done!
now consume EasyconfigModule in src/app.service.ts
import { Injectable } from '@nestjs/common';
import { EasyconfigService } from 'nestjs-easyconfig';
@Injectable()
export class AppService {
constructor(
private readonly easyconfigService: EasyconfigService,
) { }
getHello(): string {
const envVar = this.easyconfigService.get('ENV_VAR1');
return `Hello World! ${envVar}`;
}
}run it and got to http://localhost:3000
Done, we see Hello World! FOO
start change nestjs-easyconfig package from our guy @jmcdo29
# code or open a new code
$ cd ../nestjs-easyconfig
# deps
$ npm i @nestjs/jwtcreate module and service
# generate module and service
$ nest g module jsonWebToken
$ nest g service jsonWebTokenstart to change jsonWebTokenModule
src/json-web-token/json-web-token.module.ts
import { Module } from '@nestjs/common';
import { JsonWebTokenService } from './json-web-token.service';
import { JwtModule } from '@nestjs/jwt';
@Module({
// Y Prospect TIP :), without that it never works, respect Y Prospect
imports: [
JwtModule.register({
secret: 'just a stupid password',
signOptions: { expiresIn: '60s' },
}),
],
providers: [JsonWebTokenService],
exports: [JsonWebTokenService],
})
export class JsonWebTokenModule { }src/json-web-token/json-web-token.service.ts
import { Injectable } from '@nestjs/common';
import { JwtService } from '@nestjs/jwt';
@Injectable()
export class JsonWebTokenService {
constructor(
private readonly jwtService: JwtService,
) { }
getToken(user: any) {
const payload = { username: user.username, sub: user.userId };
return this.jwtService.sign(payload);
}
}add it to index.ts
export * from './easyconfig.module';
export * from './easyconfig.service';
export * from './json-web-token/json-web-token.module';
export * from './json-web-token/json-web-token.service';have sub-modules
done with package
src/app.module.ts and import JsonWebTokenModule
import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { EasyconfigModule, JsonWebTokenModule } from 'nestjs-easyconfig';
@Module({
imports: [
EasyconfigModule.register({ path: './config/.env' }),
// the trick is import the module, not the service here
JsonWebTokenModule,
],
controllers: [AppController],
providers: [AppService],
})
export class AppModule { }now use JsonWebTokenService in src/app.service.ts
import { Injectable } from '@nestjs/common';
import { EasyconfigService, JsonWebTokenService } from 'nestjs-easyconfig';
@Injectable()
export class AppService {
constructor(
private readonly easyconfigService: EasyconfigService,
private readonly jsonWebTokenService: JsonWebTokenService,
) { }
getHello(): string {
const envVar = this.easyconfigService.get('ENV_VAR1');
const token = this.jsonWebTokenService.getToken({ username: 'koakh', sub: 28 });
return `Hello World! ${envVar} ${token}`;
}
}run it, and browse http://localhost:3000
now we see the jwt too :)
Hello World! FOO eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImtvYWtoIiwiaWF0IjoxNTY4MzMxMzMzLCJleHAiOjE1NjgzMzEzOTN9.dHd-iEm3JfmJJCprN0hZMk0TQRjCH0iuQAMJx9kn5gQ
awesome
[Nest] 3778 - 2019-09-12 22:07:56 [ExceptionHandler] Nest cannot export a provider/module that is not a part of the currently processed module (EasyconfigModule). Please verify whether each exported unit is available in this particular context. +20ms
fix adding JsonWebTokenService to EasyconfigModule providers
export class EasyconfigModule {
providers: [
...
},
JsonWebTokenService,
};# don't forget to build module
$ npm run builddone now we have the error that gets us here
[Nest] 6038 - 2019-09-12 22:11:42 [ExceptionHandler] Nest can't resolve dependencies of the JsonWebTokenService (?). Please make sure that the argument at index [0] is available in the JsonWebTokenModule context. +40ms
the above error its the one that 'waste' some hours to find the simple way to do......simple after you know how to do it, always the same.......
# create auth module
$ nest g module auth
$ nest g service auth
$ nest g controller authsrc/auth/auth.module.ts
@Module({
imports: [
// the trick is import the module, not the service here
JsonWebTokenModule,
],
providers: [AuthService],
controllers: [AuthController],
})
export class AuthModule {}src/auth/auth.service.ts
@Injectable()
export class AuthService {
constructor(
private readonly jsonWebTokenService: JsonWebTokenService,
) { }
getHello(): string {
const token = this.jsonWebTokenService.getToken({ username: 'koakh', sub: 28 });
return `Hello World from AuthModule! ${token}`;
}
}add code to module, service and controller and test with
Hello World from AuthModule! eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImtvYWtoIiwiaWF0IjoxNjAxNjMzMjE4LCJleHAiOjE2MDE2MzMyNzh9.t2k-ihqZ5fzBzlJwOSJnQo1p5zdMVBGwkRpoMsVaI20
now try to remove dependencies from app.module.ts
if we comment JsonWebTokenModule in src/app.module.ts, the module that we use in submodule auth, we break it and get the error, with that we proof that we need to configure and imports the module in base root
[Nest] 16134 - 2019-09-14 14:31:59 [ExceptionHandler] Nest can't resolve dependencies of the AppService (EasyconfigService, ?). Please make sure that the argument at index [1] is available in the AppModule context. +2ms
@Module({
imports: [
EasyconfigModule.register({ path: './config/.env' }),
// the trick is import the module, not the service here
// JsonWebTokenModule, <<<<<<<<<<< COMMENTED to proof that we need that here
AuthModule,
],
controllers: [AppController],
providers: [AppService],
})it is required in src/auth/auth.module.ts at
@Module({
imports: [
// the trick is import the module, not the service here
JsonWebTokenModule, // <<<<<<<<<<< HERE
],
providers: [AuthService],
controllers: [AuthController],
})
export class AuthModule {}
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent