@achinet/nestjs-async 0.2.0 → 0.3.0

package/sample/constants.ts

@@ -1,12 +0,0 @@
-export const DOC_RELATIVE_PATH = '/async-api';
-export const BOOTSTRAP = 'Bootstrap';
-export const PORT = 4001;
-export const HOST = '0.0.0.0';
-export const SERVER = {
-  europe: 'europe',
-  asia: 'asia',
-  northAmerica: 'north-america',
-  southAmerica: 'south-america',
-  africa: 'africa',
-  australia: 'australia',
-};

package/sample/felines/class/cat.class.ts

@@ -1,9 +0,0 @@
-import { ApiProperty } from '@nestjs/swagger';
-import { Feline } from './feline.class';
-
-export class Cat extends Feline {
-  @ApiProperty({
-    example: 'Maine Coon',
-  })
-  breed: string;
-}

package/sample/felines/class/feline.class.ts

@@ -1,29 +0,0 @@
-enum PawsEnum {
-  left = 'left',
-  right = 'right',
-}
-
-enum GendersEnum {
-  male = 'male',
-  female = 'female',
-}
-
-export abstract class Feline {
-  id: number;
-
-  name: string;
-
-  age: number;
-
-  gender: GendersEnum;
-
-  dominantPaw: PawsEnum;
-
-  tags: string[];
-
-  birthDatetime: Date;
-
-  constructor(initializer: Record<string, unknown>) {
-    Object.assign(this, initializer);
-  }
-}

package/sample/felines/class/index.ts

@@ -1,5 +0,0 @@
-export * from './feline.class';
-export * from './cat.class';
-export * from './lion.class';
-export * from './tiger.class';
-export * from './message.class';

package/sample/felines/class/lion.class.ts

@@ -1,5 +0,0 @@
-import { Feline } from './feline.class';
-
-export class Lion extends Feline {
-  roarVolume: number;
-}

package/sample/felines/class/message.class.ts

@@ -1,17 +0,0 @@
-import { ApiProperty } from '@nestjs/swagger';
-
-export abstract class Message<T extends Record<string, any>> {
-  @ApiProperty({ format: 'uuid' })
-  correlationId: string;
-
-  @ApiProperty({ format: 'x.y.z', example: '1.0.1' })
-  version: string;
-
-  timestamp: Date;
-
-  abstract payload: T;
-
-  constructor(partialData: Partial<Message<T>>) {
-    Object.assign(this, partialData);
-  }
-}

package/sample/felines/class/tiger.class.ts

@@ -1,5 +0,0 @@
-import { Feline } from './feline.class';
-
-export class Tiger extends Feline {
-  numberOfStripes: number;
-}

package/sample/felines/dto/create-feline.dto.ts

@@ -1,13 +0,0 @@
-import { ApiProperty, getSchemaPath } from '@nestjs/swagger';
-import { Cat, Feline, Lion, Message, Tiger } from '../class';
-
-export class CreateFelineDto extends Message<Feline> {
-  @ApiProperty({
-    oneOf: [
-      { $ref: getSchemaPath(Cat) },
-      { $ref: getSchemaPath(Lion) },
-      { $ref: getSchemaPath(Tiger) },
-    ],
-  })
-  payload: Feline;
-}

package/sample/felines/dto/index.ts

@@ -1,2 +0,0 @@
-export * from '../class/message.class';
-export * from './create-feline.dto';

package/sample/felines/dto/journaling-data.dto.ts

@@ -1,5 +0,0 @@
-import { Message } from '../class';
-
-export class JournalingDataDto extends Message<Record<string, unknown>> {
-  payload: Record<string, unknown>;
-}

package/sample/felines/felines.constants.ts

@@ -1 +0,0 @@
-export const FELINES_MS = 'FELINES_MS';

package/sample/felines/felines.controller.ts

@@ -1,76 +0,0 @@
-import { Controller, Get, Inject, Logger } from '@nestjs/common';
-import { ClientProxy, EventPattern } from '@nestjs/microservices';
-import { CreateFelineDto } from './dto';
-import { AsyncApiPub, AsyncApiSub } from '../../src';
-import { Cat, Feline } from '../../sample/felines/class';
-import { JournalingDataDto } from '../../sample/felines/dto/journaling-data.dto';
-import { FELINES_MS } from '../../sample/felines/felines.constants';
-import { FelinesService } from '../../sample/felines/felines.service';
-import { FelineRto } from '../../sample/felines/rto';
-
-const EventPatternsMS = {
-  createFeline: 'ms/create/feline',
-  journal: 'ms/journal',
-};
-
-/**
- * How to use AsyncApi in a microservices
- */
-@Controller()
-export class FelinesController {
-  private logger: Logger = new Logger(FelinesController.name);
-
-  constructor(
-    @Inject(FELINES_MS)
-    private readonly client: ClientProxy,
-    private readonly felinesService: FelinesService,
-  ) {}
-
-  @AsyncApiSub({
-    channel: EventPatternsMS.journal,
-    message: {
-      payload: JournalingDataDto,
-    },
-  })
-  @EventPattern(EventPatternsMS.journal)
-  async journal(dataForJournaling: JournalingDataDto) {
-    const dataForJournalingString = JSON.stringify(dataForJournaling, null, 4);
-    this.logger.log(`journaling:\n${dataForJournalingString}`);
-  }
-
-  @AsyncApiPub({
-    channel: EventPatternsMS.createFeline,
-    message: {
-      payload: CreateFelineDto,
-    },
-  })
-  @AsyncApiSub({
-    channel: EventPatternsMS.createFeline,
-    message: {
-      payload: FelineRto,
-    },
-  })
-  @EventPattern(EventPatternsMS.createFeline)
-  async createFeline(createFelineDto: CreateFelineDto) {
-    const feline = await this.felinesService.create(createFelineDto);
-    this.logger.debug(`feline created:\n${JSON.stringify(feline)}`);
-    this.publishCreatedFeline(feline);
-  }
-
-  publishCreatedFeline(feline: Feline) {
-    const felineRto = new FelineRto({ payload: feline });
-    return this.client.emit(EventPatternsMS.journal, felineRto);
-  }
-
-  @Get()
-  async do() {
-    const cat = new Cat({
-      id: 123,
-      name: 'demo',
-    });
-
-    const felineRto = new CreateFelineDto({ payload: cat });
-
-    await this.createFeline(felineRto);
-  }
-}

package/sample/felines/felines.gateway.ts

@@ -1,76 +0,0 @@
-import { Logger } from '@nestjs/common';
-import {
-  ConnectedSocket,
-  MessageBody,
-  OnGatewayDisconnect,
-  OnGatewayInit,
-  SubscribeMessage,
-  WebSocketGateway,
-  WebSocketServer,
-} from '@nestjs/websockets';
-import { Namespace, Server } from 'socket.io';
-import { Socket } from 'socket.io-client';
-import { FelinesService } from './/felines.service';
-import { CreateFelineDto } from './dto';
-import { FelineExtendedRto, FelineRto } from './rto';
-import { AsyncApiPub, AsyncApiSub } from '../../src';
-
-const EventPatternsWS = {
-  createFeline: 'ws/create/feline',
-};
-
-/**
- * How to use AsyncApi in a websockets
- */
-@WebSocketGateway({ transports: ['websocket'], namespace: 'ws' })
-export class FelinesGateway implements OnGatewayInit, OnGatewayDisconnect {
-  @WebSocketServer()
-  private readonly server: Server;
-  private readonly logger: Logger = new Logger(FelinesGateway.name);
-
-  constructor(private readonly felinesService: FelinesService) {}
-
-  afterInit(nsp: Namespace) {
-    this.logger.log(`Gateway server init: ${nsp?.name}`);
-  }
-
-  handleDisconnect(client: Socket) {
-    this.logger.log(`Client disconnected: ${client.id}`);
-  }
-
-  @SubscribeMessage(EventPatternsWS.createFeline)
-  @AsyncApiPub({
-    channel: EventPatternsWS.createFeline,
-    message: {
-      payload: CreateFelineDto,
-    },
-  })
-  async createFeline(
-    @ConnectedSocket() client: Socket,
-    @MessageBody() createFelineDto: CreateFelineDto,
-  ) {
-    this.logger.log(
-      `data from client ${client.id} : ${JSON.stringify(createFelineDto)}`,
-    );
-
-    const feline = await this.felinesService.create(createFelineDto);
-    await this.emitCreatedFeline(new FelineRto({ payload: feline }));
-  }
-
-  @AsyncApiSub({
-    channel: EventPatternsWS.createFeline,
-    message: [
-      {
-        name: 'oneOf demo #1',
-        payload: FelineRto,
-      },
-      {
-        name: 'oneOf demo #2',
-        payload: FelineExtendedRto,
-      },
-    ],
-  })
-  async emitCreatedFeline(felineRto: FelineRto) {
-    this.server.emit(EventPatternsWS.createFeline, felineRto);
-  }
-}

package/sample/felines/felines.module.ts

@@ -1,15 +0,0 @@
-import { Module } from '@nestjs/common';
-import { ClientsModule, Transport } from '@nestjs/microservices';
-import { FELINES_MS } from './felines.constants';
-import { FelinesController } from './felines.controller';
-import { FelinesGateway } from './felines.gateway';
-import { FelinesService } from './felines.service';
-
-@Module({
-  imports: [
-    ClientsModule.register([{ name: FELINES_MS, transport: Transport.TCP }]),
-  ],
-  providers: [FelinesService, FelinesGateway],
-  controllers: [FelinesController],
-})
-export class FelinesModule {}

package/sample/felines/felines.service.ts

@@ -1,24 +0,0 @@
-import { Injectable } from '@nestjs/common';
-import { Feline } from './class';
-import { CreateFelineDto } from './dto';
-
-@Injectable()
-export class FelinesService {
-  private readonly felines: Feline[] = [];
-
-  async get(id: number): Promise<Feline> {
-    return this.felines[id];
-  }
-
-  async delete(id: number): Promise<boolean> {
-    const felineToDelete = this.get(id);
-    delete this.felines[id];
-    return !!felineToDelete;
-  }
-
-  async create(createFelineDto: CreateFelineDto): Promise<Feline> {
-    const feline = createFelineDto.payload;
-    this.felines.push(feline);
-    return feline;
-  }
-}

package/sample/felines/rto/feline.rto.ts

@@ -1,17 +0,0 @@
-import { ApiProperty, getSchemaPath } from '@nestjs/swagger';
-import { Cat, Feline, Lion, Message, Tiger } from '../class';
-
-export class FelineRto extends Message<Feline> {
-  @ApiProperty({
-    oneOf: [
-      { $ref: getSchemaPath(Cat) },
-      { $ref: getSchemaPath(Lion) },
-      { $ref: getSchemaPath(Tiger) },
-    ],
-  })
-  payload: Feline;
-}
-
-export class FelineExtendedRto extends FelineRto {
-  extra: string;
-}

package/sample/felines/rto/index.ts

@@ -1 +0,0 @@
-export * from './feline.rto';

package/sample/index.ts

@@ -1,3 +0,0 @@
-export * from './app.module';
-export * from './common';
-export * from './constants';

package/sample/main.ts

@@ -1,34 +0,0 @@
-import { INestApplication, Logger } from '@nestjs/common';
-import { NestFactory } from '@nestjs/core';
-import { MicroserviceOptions, Transport } from '@nestjs/microservices';
-import { ExpressAdapter } from '@nestjs/platform-express';
-import { FastifyAdapter } from '@nestjs/platform-fastify';
-import { AppModule } from './app.module';
-import { makeAsyncapiDocument } from './common';
-import { BOOTSTRAP, DOC_RELATIVE_PATH, HOST, PORT } from './constants';
-import { AsyncApiModule } from '../src';
-
-const USE_FASTIFY = false;
-
-const adapter = USE_FASTIFY
-  ? new FastifyAdapter({
-      ignoreTrailingSlash: false,
-    })
-  : new ExpressAdapter();
-
-async function bootstrap(): Promise<void> {
-  const app = await NestFactory.create<INestApplication>(AppModule, adapter, {});
-  const asyncapiDocument = await makeAsyncapiDocument(app);
-  await AsyncApiModule.setup(DOC_RELATIVE_PATH, app, asyncapiDocument);
-
-  app.connectMicroservice<MicroserviceOptions>({ transport: Transport.TCP });
-
-  await app.startAllMicroservices();
-  await app.listen(PORT, HOST);
-
-  const baseUrl = `http://${HOST}:${PORT}`;
-  const docUrl = baseUrl + DOC_RELATIVE_PATH;
-  Logger.log(`Server started at ${baseUrl}; AsyncApi at ${docUrl};`, BOOTSTRAP);
-}
-
-bootstrap();

package/src/asyncapi-document.builder.ts

@@ -1,172 +0,0 @@
-import {
-  ExternalDocumentationObject,
-  SecuritySchemeObject,
-  TagObject,
-} from '@nestjs/swagger/dist/interfaces/open-api-spec.interface';
-import { isUndefined, negate, pickBy } from 'lodash';
-import { AsyncApiDocument, AsyncSecuritySchemeObject, AsyncServerObject } from './interface';
-
-export class AsyncApiDocumentBuilder {
-  private readonly buildDocumentBase = (): Omit<AsyncApiDocument, 'channels'> => ({
-    asyncapi: '2.5.0',
-    info: {
-      title: '',
-      description: '',
-      version: '1.0.0',
-      contact: {},
-    },
-    tags: [],
-    servers: {},
-    components: {},
-  });
-
-  private readonly document: Omit<AsyncApiDocument, 'channels'> = this.buildDocumentBase();
-
-  public setTitle(title: string): this {
-    this.document.info.title = title;
-    return this;
-  }
-
-  public setDescription(description: string): this {
-    this.document.info.description = description;
-    return this;
-  }
-
-  public setVersion(version: string): this {
-    this.document.info.version = version;
-    return this;
-  }
-
-  public setTermsOfService(termsOfService: string): this {
-    this.document.info.termsOfService = termsOfService;
-    return this;
-  }
-
-  public setContact(name: string, url: string, email: string): this {
-    this.document.info.contact = { name, url, email };
-    return this;
-  }
-
-  public setLicense(name: string, url: string): this {
-    this.document.info.license = { name, url };
-    return this;
-  }
-
-  public addServer(name: string, server: AsyncServerObject): this {
-    this.document.servers![name] = server;
-    return this;
-  }
-
-  public addServers(servers: { name: string; server: AsyncServerObject }[]): this {
-    for (const { name, server } of servers) {
-      this.addServer(name, server);
-    }
-
-    return this;
-  }
-
-  public setExternalDoc(description: string, url: string): this {
-    this.document.externalDocs = { description, url };
-    return this;
-  }
-
-  public setDefaultContentType(contentType: string) {
-    this.document.defaultContentType = contentType;
-    return this;
-  }
-
-  public addTag(name: string, description = '', externalDocs?: ExternalDocumentationObject): this {
-    this.document.tags = this.document.tags!.concat(
-      pickBy(
-        {
-          name,
-          description,
-          externalDocs,
-        },
-        negate(isUndefined),
-      ) as TagObject,
-    );
-    return this;
-  }
-
-  public addSecurity(name: string, options: AsyncSecuritySchemeObject): this {
-    this.document.components!.securitySchemes = {
-      ...(this.document.components!.securitySchemes || {}),
-      [name]: options,
-    };
-    return this;
-  }
-
-  public addBearerAuth(
-    options: SecuritySchemeObject = {
-      type: 'http',
-    },
-    name = 'bearer',
-  ): this {
-    this.addSecurity(name, {
-      scheme: 'bearer',
-      bearerFormat: 'JWT',
-      ...options,
-    });
-    return this;
-  }
-
-  public addOAuth2(
-    options: SecuritySchemeObject = {
-      type: 'oauth2',
-    },
-    name = 'oauth2',
-  ): this {
-    this.addSecurity(name, {
-      flows: {},
-      ...options,
-    });
-    return this;
-  }
-
-  public addApiKey(
-    options: SecuritySchemeObject = {
-      type: 'apiKey',
-    },
-    name = 'api_key',
-  ): this {
-    this.addSecurity(name, {
-      in: 'header',
-      name,
-      ...options,
-    });
-    return this;
-  }
-
-  public addBasicAuth(
-    options: SecuritySchemeObject = {
-      type: 'http',
-    },
-    name = 'basic',
-  ): this {
-    this.addSecurity(name, {
-      scheme: 'basic',
-      ...options,
-    });
-    return this;
-  }
-
-  public addCookieAuth(
-    cookieName = 'connect.sid',
-    options: SecuritySchemeObject = {
-      type: 'apiKey',
-    },
-    securityName = 'cookie',
-  ): this {
-    this.addSecurity(securityName, {
-      in: 'cookie',
-      name: cookieName,
-      ...options,
-    });
-    return this;
-  }
-
-  public build(): Omit<AsyncApiDocument, 'components' | 'channels'> {
-    return this.document;
-  }
-}

package/src/asyncapi.constants.ts

@@ -1,8 +0,0 @@
-const DECORATORS_PREFIX = 'asyncapi';
-
-export const DECORATORS = {
-  AsyncApiClass: `${DECORATORS_PREFIX}/class`,
-  AsyncApiOperation: `${DECORATORS_PREFIX}/operation`,
-  AsyncApiPub: `${DECORATORS_PREFIX}/pub`,
-  AsyncApiSub: `${DECORATORS_PREFIX}/sub`,
-};

package/src/asyncapi.module.ts

@@ -1,65 +0,0 @@
-import { INestApplication, INestApplicationContext, Logger } from '@nestjs/common';
-import { validatePath } from '@nestjs/swagger/dist/utils/validate-path.util';
-import jsyaml from 'js-yaml';
-import { AsyncApiDocument, AsyncApiDocumentOptions, AsyncApiTemplateOptions } from './interface';
-import { AsyncapiGenerator, AsyncapiScanner } from './services';
-
-export class AsyncApiModule {
-  private static readonly logger = new Logger(AsyncApiModule.name);
-
-  public static createDocument(
-    app: INestApplicationContext,
-    config: Omit<AsyncApiDocument, 'channels'>,
-    options: AsyncApiDocumentOptions = {},
-  ): AsyncApiDocument {
-    const asyncapiScanner = new AsyncapiScanner();
-    const document = asyncapiScanner.scanApplication(app, options);
-
-    document.components = {
-      ...(config.components || {}),
-      ...document.components,
-    };
-
-    return {
-      ...config,
-      ...document,
-    };
-  }
-
-  static async composeHtml(contract: AsyncApiDocument, templateOptions?: AsyncApiTemplateOptions) {
-    const generator = new AsyncapiGenerator(templateOptions);
-    return generator.generate(contract).catch((err) => {
-      this.logger.error(err);
-      throw err;
-    });
-  }
-
-  public static async setup(
-    path: string,
-    app: INestApplication,
-    document: AsyncApiDocument,
-    templateOptions?: AsyncApiTemplateOptions,
-  ) {
-    const httpAdapter = app.getHttpAdapter();
-    const finalPath = validatePath(path);
-
-    const html = await this.composeHtml(document, templateOptions);
-    const yamlDocument = jsyaml.dump(document);
-    const jsonDocument = JSON.stringify(document);
-
-    httpAdapter.get(finalPath, (req, res) => {
-      res.type('text/html');
-      res.send(html);
-    });
-
-    httpAdapter.get(`${finalPath}-json`, (req, res) => {
-      res.type('application/json');
-      res.send(jsonDocument);
-    });
-
-    httpAdapter.get(`${finalPath}-yaml`, (req, res) => {
-      res.type('text/yaml');
-      res.send(yamlDocument);
-    });
-  }
-}

package/src/binding/asyncapi.amqp.interfaces.ts

@@ -1,48 +0,0 @@
-/**
- * AMPQ binding
- * @see https://github.com/asyncapi/bindings/tree/master/amqp
- */
-
-/**
- * This object MUST NOT contain any properties. Its name is reserved for future use.
- */
-export interface AmqpServerBinding {}
-
-export interface AmqpChannelBinding {
-  is: string;
-  exchange?: {
-    name: string;
-    type: string;
-    durable?: boolean;
-    autoDelete?: boolean;
-    vhost?: string;
-  };
-  queue?: {
-    name: string;
-    durable?: boolean;
-    exclusive?: boolean;
-    autoDelete?: boolean;
-    vhost?: string;
-  };
-  bindingVersion?: string;
-}
-
-export interface AmqpOperationBinding {
-  expiration?: number;
-  userId?: string;
-  cc?: string[];
-  priority?: number;
-  deliveryMode?: number;
-  mandatory?: boolean;
-  bcc?: string[];
-  replyTo?: string;
-  timestamp?: boolean;
-  ack?: boolean;
-  bindingVersion?: string;
-}
-
-export interface AmqpMessageBinding {
-  contentEncoding?: string;
-  messageType?: string;
-  bindingVersion?: string;
-}