@achinet/nestjs-async 0.1.1 → 0.3.0

package/src/services/asyncapi.generator.ts

@@ -1,45 +0,0 @@
-import fs from 'fs/promises';
-import jsyaml from 'js-yaml';
-import os from 'os';
-import path from 'path';
-import { AsyncApiDocument, AsyncApiTemplateOptions, GeneratorOptions } from '../interface';
-
-export class AsyncapiGenerator {
-  private readonly templateOptions?: AsyncApiTemplateOptions;
-
-  constructor(templateOptions?: AsyncApiTemplateOptions) {
-    this.templateOptions = templateOptions;
-  }
-
-  public async generate(contract: AsyncApiDocument): Promise<string> {
-    // Lazy-load @asyncapi/generator to avoid loading it at module initialization time.
-    // This allows tests and code that only use decorators to work without
-    // requiring the full generator dependency tree (which has nested semver issues in Jest).
-    const { default: Generator } = await import('@asyncapi/generator');
-
-    const yaml = jsyaml.dump(contract);
-    const tmpDir = path.join(os.tmpdir(), `asyncapi-${Date.now()}-${Math.random().toString(36).slice(2)}`);
-
-    const generator: GeneratorOptions = new Generator('@asyncapi/html-template', tmpDir, {
-      forceWrite: true,
-      templateParams: {
-        singleFile: true,
-        ...this.templateOptions,
-      },
-    });
-
-    await generator.generateFromString(yaml, {
-      resolve: {
-        file: false,
-      },
-    });
-
-    const htmlPath = path.join(tmpDir, 'index.html');
-    const html = await fs.readFile(htmlPath, 'utf-8');
-
-    // Clean up temp directory
-    await fs.rm(tmpDir, { recursive: true, force: true }).catch(() => {});
-
-    return html;
-  }
-}

package/src/services/asyncapi.scanner.ts

@@ -1,105 +0,0 @@
-import { INestApplicationContext, Type } from '@nestjs/common';
-import { MODULE_PATH } from '@nestjs/common/constants';
-import { Injectable, InjectionToken } from '@nestjs/common/interfaces';
-import { InstanceWrapper } from '@nestjs/core/injector/instance-wrapper';
-import { Module } from '@nestjs/core/injector/module';
-import { SchemaObject } from '@nestjs/swagger/dist/interfaces/open-api-spec.interface';
-import { ModelPropertiesAccessor } from '@nestjs/swagger/dist/services/model-properties-accessor';
-import { SchemaObjectFactory } from '@nestjs/swagger/dist/services/schema-object-factory';
-import { SwaggerTypesMapper } from '@nestjs/swagger/dist/services/swagger-types-mapper';
-import { stripLastSlash } from '@nestjs/swagger/dist/utils/strip-last-slash.util';
-import { flatten, isEmpty } from 'lodash';
-import { AsyncApiDocument, AsyncApiDocumentOptions, DenormalizedDoc } from '../interface';
-import { AsyncApiExplorer } from './asyncapi.explorer';
-import { AsyncapiTransformer } from './asyncapi.transformer';
-
-export class AsyncapiScanner {
-  private readonly transformer = new AsyncapiTransformer();
-
-  private readonly explorer = new AsyncApiExplorer();
-
-  private readonly modelPropertiesAccessor = new ModelPropertiesAccessor();
-
-  private readonly swaggerTypesMapper = new SwaggerTypesMapper();
-
-  private readonly schemaObjectFactory = new SchemaObjectFactory(this.modelPropertiesAccessor, this.swaggerTypesMapper);
-
-  public scanApplication(
-    app: INestApplicationContext,
-    options: AsyncApiDocumentOptions,
-  ): Omit<AsyncApiDocument, 'asyncapi' | 'info'> {
-    const {
-      deepScanRoutes,
-      include: includedModules = [],
-      extraModels = [],
-      ignoreGlobalPrefix = false,
-      operationIdFactory,
-    } = options;
-
-    const { container } = app as any;
-    const modules: Module[] = this.getModules(container.getModules(), includedModules);
-    const globalPrefix = !ignoreGlobalPrefix ? stripLastSlash(this.getGlobalPrefix(app)) : '';
-
-    const denormalizedChannels = modules.reduce((channels, { providers, metatype, imports, controllers }) => {
-      let allProviders = new Map([...providers, ...controllers]);
-
-      if (deepScanRoutes) {
-        // only load submodules routes if asked
-        const isGlobal = (module: Type<any>) => !container.isGlobalModule(module);
-
-        Array.from(imports.values())
-          .filter(isGlobal as any)
-          .map(({ providers: relatedProviders, controllers: relatedControllers }) => ({
-            relatedProviders,
-            relatedControllers,
-          }))
-          .forEach(({ relatedProviders, relatedControllers }) => {
-            allProviders = new Map([...allProviders, ...relatedProviders, ...relatedControllers]);
-          });
-      }
-      const path = metatype ? Reflect.getMetadata(MODULE_PATH, metatype) : undefined;
-
-      return [...channels, ...this.scanModuleProviders(allProviders, path, globalPrefix, operationIdFactory)];
-    }, []);
-
-    const schemas = this.explorer.getSchemas();
-    this.addExtraModels(schemas, extraModels);
-    const normalizedChannels = this.transformer.normalizeChannels(flatten(denormalizedChannels));
-    return {
-      ...normalizedChannels,
-      components: { schemas },
-    };
-  }
-
-  private scanModuleProviders(
-    providers: Map<InjectionToken, InstanceWrapper<Injectable>>,
-    modulePath?: string,
-    globalPrefix?: string,
-    operationIdFactory?: (controllerKey: string, methodKey: string) => string,
-  ): DenormalizedDoc[] {
-    const denormalizedArray = [...providers.values()].reduce((denormalized, prov) => {
-      const object = this.explorer.explorerAsyncapiServices(prov, modulePath, globalPrefix, operationIdFactory);
-      return [...denormalized, ...object];
-    }, []);
-
-    return flatten(denormalizedArray) as any;
-  }
-
-  private getModules(modulesContainer: Map<string, Module>, include: Function[]): Module[] {
-    if (!include || isEmpty(include)) {
-      return [...modulesContainer.values()];
-    }
-    return [...modulesContainer.values()].filter(({ metatype }) => include.some((item) => item === metatype));
-  }
-
-  private getGlobalPrefix(app: INestApplicationContext): string {
-    const internalConfigRef = (app as any).config;
-    return internalConfigRef?.getGlobalPrefix() || '';
-  }
-
-  private addExtraModels(schemas: Record<string, SchemaObject>, extraModels: Function[]) {
-    extraModels.forEach((item) => {
-      this.schemaObjectFactory.exploreModelSchema(item, schemas);
-    });
-  }
-}

package/src/services/asyncapi.transformer.ts

@@ -1,33 +0,0 @@
-import { AsyncChannelObject, AsyncChannelsObject, DenormalizedDoc } from '../interface';
-
-export class AsyncapiTransformer {
-  public normalizeChannels(denormalizedDocs: DenormalizedDoc[]): Record<'channels', AsyncChannelsObject> {
-    const flatChannels = denormalizedDocs.map((doc: DenormalizedDoc) => {
-      const key = doc.root?.name;
-      const value: AsyncChannelObject = {
-        description: doc.root?.description,
-        bindings: doc.root?.bindings,
-        parameters: doc.root?.parameters,
-        subscribe: doc.operations?.sub,
-        publish: doc.operations?.pub,
-      };
-      return { key, value };
-    });
-
-    const channels = flatChannels.reduce((acc, { key, value }) => {
-      // skip entries without a channel name
-      if (!key) return acc;
-
-      if (!acc[key]) {
-        acc[key] = value;
-      }
-
-      acc[key].publish = acc[key].publish ?? value.publish;
-      acc[key].subscribe = acc[key].subscribe ?? value.subscribe;
-
-      return acc;
-    }, {} as AsyncChannelsObject);
-
-    return { channels };
-  }
-}

package/src/services/index.ts

@@ -1,4 +0,0 @@
-export * from './asyncapi.generator';
-export * from './operation-object.factory';
-export * from './asyncapi.explorer';
-export * from './asyncapi.scanner';

package/src/services/operation-object.factory.ts

@@ -1,55 +0,0 @@
-import { SchemaObject } from '@nestjs/swagger/dist/interfaces/open-api-spec.interface';
-import { ModelPropertiesAccessor } from '@nestjs/swagger/dist/services/model-properties-accessor';
-import { SchemaObjectFactory } from '@nestjs/swagger/dist/services/schema-object-factory';
-import { SwaggerTypesMapper } from '@nestjs/swagger/dist/services/swagger-types-mapper';
-import { getSchemaPath } from '@nestjs/swagger/dist/utils';
-import { AsyncApiOperationOptionsRaw, AsyncMessageObject, AsyncOperationObject, OneOfMessageType } from '../interface';
-
-export class OperationObjectFactory {
-  private readonly modelPropertiesAccessor = new ModelPropertiesAccessor();
-
-  private readonly swaggerTypesMapper = new SwaggerTypesMapper();
-
-  private readonly schemaObjectFactory = new SchemaObjectFactory(this.modelPropertiesAccessor, this.swaggerTypesMapper);
-
-  create(
-    operation: AsyncApiOperationOptionsRaw,
-    produces: string[],
-    schemas: Record<string, SchemaObject>,
-  ): AsyncOperationObject {
-    const { message } = operation;
-    const { oneOf } = message as OneOfMessageType;
-
-    if (oneOf) {
-      return {
-        ...operation,
-        message: {
-          oneOf: oneOf.map((i) => ({
-            ...i,
-            payload: {
-              $ref: getSchemaPath(this.getDtoName(i as AsyncMessageObject, schemas)),
-            },
-          })),
-        },
-      };
-    }
-
-    return {
-      ...operation,
-      message: {
-        ...operation.message,
-        payload: {
-          $ref: getSchemaPath(this.getDtoName(message as AsyncMessageObject, schemas)),
-        },
-      },
-    };
-  }
-
-  private getDtoName(message: AsyncMessageObject, schemas: Record<string, SchemaObject>): string {
-    if (!message.payload || !message.payload.type) {
-      throw new Error('Async message payload or payload.type is undefined; ensure message.payload is provided.');
-    }
-    const messagePayloadType = message.payload.type as Function;
-    return this.schemaObjectFactory.exploreModelSchema(messagePayloadType, schemas);
-  }
-}

package/test/__mocks__/@asyncapi/generator.js

@@ -1,41 +0,0 @@
-/**
- * Mock for @asyncapi/generator to avoid ESM issues in Jest tests.
- */
-
-const fs = require('fs');
-const path = require('path');
-
-class MockGenerator {
-  constructor(templateName, targetDir, options = {}) {
-    this.templateName = templateName;
-    this.targetDir = targetDir;
-    this.options = options;
-  }
-
-  async generateFromString(yaml) {
-    const html = `<!DOCTYPE html>
-<html>
-<head>
-  <title>AsyncAPI Documentation</title>
-</head>
-<body>
-  <h1>AsyncAPI Documentation</h1>
-  <p>Mock HTML generated for testing</p>
-  <pre>${yaml.replace(/</g, '&lt;').replace(/>/g, '&gt;')}</pre>
-</body>
-</html>`;
-
-    // Create the target directory and write the file
-    fs.mkdirSync(this.targetDir, { recursive: true });
-    fs.writeFileSync(path.join(this.targetDir, 'index.html'), html, 'utf-8');
-
-    return html;
-  }
-
-  async generate(asyncapi) {
-    return this.generateFromString(JSON.stringify(asyncapi, null, 2));
-  }
-}
-
-module.exports = MockGenerator;
-module.exports.default = MockGenerator;

package/test/configs/jest-base.config.ts

@@ -1,19 +0,0 @@
-import { JestConfigWithTsJest } from 'ts-jest';
-
-export const baseConfig: JestConfigWithTsJest = {
-  moduleFileExtensions: ['js', 'json', 'ts'],
-  rootDir: '../../',
-  transform: {
-    '^.+\\.(t|j)s$': 'ts-jest',
-  },
-  collectCoverageFrom: ['**/*.(t|j)s'],
-  coverageDirectory: './coverage',
-  testEnvironment: 'node',
-  moduleNameMapper: {
-    '#lib(|/.*)$': '<rootDir>/lib/$1',
-    '#sample(|/.*)$': '<rootDir>/sample/$1',
-    '#test(|/.*)$': '<rootDir>/test/$1',
-  },
-};
-
-export default baseConfig;

package/test/configs/jest-e2e.config.js

@@ -1,7 +0,0 @@
-// Forzamos ts-node desde aquí antes de importar la config real
-require('ts-node').register({
-  transpileOnly: true,
-});
-
-// Si usas `export default` en tu config.ts:
-module.exports = require('./jest-e2e.config.ts').default;

package/test/configs/jest-e2e.config.ts

@@ -1,19 +0,0 @@
-import { JestConfigWithTsJest } from 'ts-jest';
-import { baseConfig } from './jest-base.config';
-
-export const e2eConfig: JestConfigWithTsJest = {
-  ...baseConfig,
-  testRegex: '.\\.e2e-spec\\.ts$',
-  transform: {
-    '^.+\\.(t|j)s$': [
-      'ts-jest',
-      {
-        astTransformers: {
-          before: ['test/configs/jest-swagger-plugin.js'],
-        },
-      },
-    ],
-  },
-};
-
-export default e2eConfig;

package/test/configs/jest-swagger-plugin.js

@@ -1,16 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const transformer = require('@nestjs/swagger/plugin');
-
-module.exports.name = 'nestjs-swagger-transformer';
-// you should change the version number anytime you change the configuration below - otherwise, jest will not detect changes
-module.exports.version = 1;
-
-module.exports.factory = (cs) => {
-  return transformer.before(
-    {
-      introspectComments: true,
-      dtoFileNameSuffix: ['.dto.ts', '.class.ts'],
-    },
-    cs.program, // "cs.tsCompiler.program" for older versions of Jest (<= v27)
-  );
-};

package/test/express.e2e-spec.ts

@@ -1,64 +0,0 @@
-import { NestFactory } from '@nestjs/core';
-import { ExpressAdapter, NestExpressApplication } from '@nestjs/platform-express';
-import * as fs from 'fs/promises';
-import jsyaml from 'js-yaml';
-import request from 'supertest';
-import { AsyncApiModule } from '../src';
-import { AppModule } from '../sample/app.module';
-import { makeAsyncapiDocument } from '../sample/common';
-import { DOC_RELATIVE_PATH } from '../sample/constants';
-
-describe('Express AsyncAPI', () => {
-  let app: NestExpressApplication;
-
-  beforeAll(async () => {
-    app = await NestFactory.create<NestExpressApplication>(AppModule, new ExpressAdapter(), { logger: false });
-    const asyncapiDocument = await makeAsyncapiDocument(app);
-    await AsyncApiModule.setup(DOC_RELATIVE_PATH, app, asyncapiDocument);
-
-    await app.init();
-  });
-
-  it('should serve doc html', async () => {
-    const { text } = await request(app.getHttpServer())
-      .get(DOC_RELATIVE_PATH)
-      .expect(200)
-      .expect('Content-Type', /text\/html/);
-    const htmlSample = await fs.readFile('./misc/references/ref.html', {
-      encoding: 'utf8',
-    });
-    expect(text).toEqual(htmlSample);
-  });
-
-  it('should serve doc json', async () => {
-    const { text } = await request(app.getHttpServer())
-      .get(`${DOC_RELATIVE_PATH}-json`)
-      .expect(200)
-      .expect('Content-Type', /application\/json/);
-
-    const jsonFetched = JSON.parse(text);
-    const jsonReferenceSample = JSON.parse(
-      await fs.readFile('./misc/references/ref.json', {
-        encoding: 'utf8',
-      }),
-    );
-
-    expect(jsonFetched).toEqual(jsonReferenceSample);
-  });
-
-  it('should serve doc yaml', async () => {
-    const { text } = await request(app.getHttpServer())
-      .get(`${DOC_RELATIVE_PATH}-yaml`)
-      .expect(200)
-      .expect('Content-Type', /text\/yaml/);
-
-    const yamlFetched = jsyaml.load(text);
-    const yamlReferenceSample = jsyaml.load(
-      await fs.readFile('./misc/references/ref.yaml', {
-        encoding: 'utf8',
-      }),
-    );
-
-    expect(yamlFetched).toEqual(yamlReferenceSample);
-  });
-});

package/test/fastify.e2e-spec.ts

@@ -1,65 +0,0 @@
-import { NestFactory } from '@nestjs/core';
-import { FastifyAdapter, NestFastifyApplication } from '@nestjs/platform-fastify';
-import fs from 'fs/promises';
-import jsyaml from 'js-yaml';
-import request from 'supertest';
-import { AsyncApiModule } from '../src';
-import { AppModule } from '../sample/app.module';
-import { makeAsyncapiDocument } from '../sample/common';
-import { DOC_RELATIVE_PATH } from '../sample/constants';
-
-describe('Fastify AsyncAPI', () => {
-  let app: NestFastifyApplication;
-
-  beforeAll(async () => {
-    app = await NestFactory.create<NestFastifyApplication>(AppModule, new FastifyAdapter(), { logger: false });
-    const asyncapiDocument = await makeAsyncapiDocument(app);
-    await AsyncApiModule.setup(DOC_RELATIVE_PATH, app, asyncapiDocument);
-
-    await app.init();
-    await app.getHttpAdapter().getInstance().ready();
-  });
-
-  it('should serve doc html', async () => {
-    const { text } = await request(app.getHttpServer())
-      .get(DOC_RELATIVE_PATH)
-      .expect(200)
-      .expect('Content-Type', /text\/html/);
-    const htmlSample = await fs.readFile('./misc/references/ref.html', {
-      encoding: 'utf8',
-    });
-    expect(text).toEqual(htmlSample);
-  });
-
-  it('should serve doc json', async () => {
-    const { text } = await request(app.getHttpServer())
-      .get(`${DOC_RELATIVE_PATH}-json`)
-      .expect(200)
-      .expect('Content-Type', /application\/json/);
-
-    const jsonFetched = JSON.parse(text);
-    const jsonReferenceSample = JSON.parse(
-      await fs.readFile('./misc/references/ref.json', {
-        encoding: 'utf8',
-      }),
-    );
-
-    expect(jsonFetched).toEqual(jsonReferenceSample);
-  });
-
-  it('should serve doc yaml', async () => {
-    const { text } = await request(app.getHttpServer())
-      .get(`${DOC_RELATIVE_PATH}-yaml`)
-      .expect(200)
-      .expect('Content-Type', /text\/yaml/);
-
-    const yamlFetched = jsyaml.load(text);
-    const yamlReferenceSample = jsyaml.load(
-      await fs.readFile('./misc/references/ref.yaml', {
-        encoding: 'utf8',
-      }),
-    );
-
-    expect(yamlFetched).toEqual(yamlReferenceSample);
-  });
-});

package/tsconfig.build.json

@@ -1,4 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
-}

package/tsconfig.json

@@ -1,8 +0,0 @@
-{
-  "extends": "@achinet/tsconfig/nestjs.json",
-  "compilerOptions": {
-    "outDir": "dist"
-  },
-  "exclude": ["node_modules", "dist"]
-}
-