IT Lab Internal Services

Diese Library funktioniert nur mit NestJs

Internal module

Axios is richly featured HTTP client package that is widely used. This package wraps Axios and exposes it via the built-in InternalModule. The InternalModule exports the CommentService, ContentService & SearchService classes, which exposes methods to perform HTTP requests to IT Labs internal services.

Installation

To begin using it, we first install the required dependency.

yarn add itlab-internal-services

Getting started

Once the installation process is complete, to use the InternalServices, first import InternalModule.

@Module({
  imports: [InternalModule],
  providers: [NewsService],
})
export class NewsModule {}

Next, inject CommentService, ContentService or SearchService using normal constructor injection.

Hint InternalModule, CommentService, ContentService & SearchService are imported from itlab-internal-services package.

@Injectable()
export class NewsService {
  constructor(
    private readonly commentService: CommentService,
    private readonly contentService: ContentService,
    private readonly searchService: SearchService,
  ) {}
}

Comment Service

async post(targetId: string, authorId: string, comment: Comment): Promise<Comment>

async delete(targetId: string): Promise<void>

Content Service

async verify(content: Content): Promise<void>

async post(targetId: string, content: Content): Promise<void>

async delete(targetId: string): Promise<void>

Pipes

@Controller("news")
export class NewsController {

  @ApiTarget("target")
  @Get(":target")
  getNews(@Target("target") target: string) {}

}

@Controller("news")
export class NewsController {

  @ApiHid("hid")
  @Get(":hid")
  getNews(@Hid("hid") hid: string) {}

}

@Controller("news")
export class NewsController {

  @ApiId("id")
  @Get(":id")
  getNews(@Id("id") id: string) {}

}

Guards

@Internal()
@Controller()
export class NewsController {}

@Jwt()
@Controller()
export class NewsController {
  @Get("")
  getNews(@Account() account: LAccount) {}

  @Get("")
  getNews(@AccountId() accountId: string) {}

  @Perms("perms.get", "perms.list")
  @Get("")
  getNews(@AccountId() accountId: string, @AccountPerms() accountPerms: string[]) {}
}

Configuration

To configure the underlying service instance, pass an optional options object to the register() method of InternalModule when importing it. This options object will be passed directly to the underlying service constructor.

@Module({
  imports: [
    InternalModule.register({
      target: Targets.NEWSROOM,
      token: 'itlab token',
      jwt_secret: 'secret',
    }),
  ],
  providers: [NewsService],
})
export class NewsModule {}

Async configuration

When you need to pass module options asynchronously instead of statically, use the registerAsync() method. As with most dynamic modules, this package provides several techniques to deal with async configuration.

One technique is to use a factory function:

InternalModule.registerAsync({
  useFactory: () => ({
    target: Targets.NEWSROOM,
    token: 'itlab token',
    jwt_secret: 'secret',
  }),
});

Like other factory providers, our factory function can be async and can inject dependencies through inject.

InternalModule.registerAsync({
  imports: [ConfigModule],
  useFactory: (configService: ConfigService) => ({
    target: Targets.NEWSROOM,
    token: configService.get<string>('K8S_TOKEN'),
    jwt_secret: configService.get<string>('JWT_SECRET'),
  }),
  inject: [ConfigService],
});

Alternatively, you can configure the InternalModule using a class instead of a factory, as shown below.

InternalModule.registerAsync({
  useClass: InternalConfigService,
});

The construction above instantiates InternalConfigService inside InternalModule, using it to create an options object. Note that in this example, the InternalConfigService has to implement InternalModuleOptionsFactory interface as shown below. The InternalModule will call the createInternalOptions() method on the instantiated object of the supplied class.

@Injectable()
class InternalConfigService implements InternalModuleOptionsFactory {
  createInternalOptions(): InternalModuleOptions {
    return {
      target: Targets.NEWSROOM,
      token: 'itlab token',
      jwt_secret: 'secret',
    };
  }
}

If you want to reuse an existing options provider instead of creating a private copy inside the InternalModule, use the useExisting syntax.

InternalModule.registerAsync({
  imports: [ConfigModule],
  useExisting: InternalConfigService,
});