chore: refactoring & better lib incapsulation

flamewow · flamewow · commit 3242c1cb5f3e · 2022-12-03T10:40:16.000+02:00
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -27,8 +27,11 @@
     "@typescript-eslint/explicit-function-return-type": "off",
     "@typescript-eslint/explicit-module-boundary-types": "off",
     "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/no-use-before-define": "off",
-    "@typescript-eslint/no-unused-vars": 1,
+    "@typescript-eslint/no-use-before-define": "warn",
+    "@typescript-eslint/no-unused-vars": [
+      "error", {
+        "args": "none"
+      }],
     "@typescript-eslint/ban-types": "off",
     "@typescript-eslint/no-empty-interface": "off",
     "max-len": [
diff --git a/lib/asyncapi-document.builder.ts b/lib/asyncapi-document.builder.ts
@@ -1,4 +1,3 @@
-import { Logger } from '@nestjs/common';
 import {
   ExternalDocumentationObject,
   SecuritySchemeObject,
@@ -12,8 +11,6 @@ import {
 } from './interfaces';
 
 export class AsyncApiDocumentBuilder {
-  private readonly logger = new Logger(AsyncApiDocumentBuilder.name);
-
   private readonly buildDocumentBase = (): Omit<
     AsyncAPIObject,
     'channels'
diff --git a/lib/asyncapi.module.ts b/lib/asyncapi.module.ts
@@ -6,9 +6,9 @@ import {
 import { SwaggerDocumentOptions } from '@nestjs/swagger';
 import { validatePath } from '@nestjs/swagger/dist/utils/validate-path.util';
 import jsyaml from 'js-yaml';
-import { AsyncapiScanner } from './asyncapi.scanner';
 import { AsyncApiTemplateOptions } from './interfaces';
 import { AsyncapiGenerator } from './services';
+import { AsyncapiScanner } from './services/asyncapi.scanner';
 import { AsyncAPIObject } from './index';
 
 export interface AsyncApiDocumentOptions extends SwaggerDocumentOptions {}
@@ -41,9 +41,9 @@ export class AsyncApiModule {
     templateOptions?: AsyncApiTemplateOptions,
   ) {
     const generator = new AsyncapiGenerator(templateOptions);
-    return await generator.generate(contract).catch((e) => {
-      this.logger.error(e);
-      throw e;
+    return await generator.generate(contract).catch((err) => {
+      this.logger.error(err);
+      throw err;
     });
   }
 
diff --git a/lib/constants.ts b/lib/constants.ts
@@ -1,6 +1,7 @@
 export const DECORATORS_PREFIX = 'asyncapi';
+
 export const DECORATORS = {
-  ASYNCAPI_SERVICE: `${DECORATORS_PREFIX}/service`,
-  ASYNCAPI_PUB: `${DECORATORS_PREFIX}/pub`,
-  ASYNCAPI_SUB: `${DECORATORS_PREFIX}/sub`,
+  AsyncapiService: `${DECORATORS_PREFIX}/service`,
+  AsyncapiPub: `${DECORATORS_PREFIX}/pub`,
+  AsyncapiSub: `${DECORATORS_PREFIX}/sub`,
 };
diff --git a/lib/decorators/asyncapi-operation.decorator.ts b/lib/decorators/asyncapi-operation.decorator.ts
@@ -26,11 +26,11 @@ export interface AsyncOperationOptions
 export function AsyncApiPub(
   ...options: AsyncOperationOptions[]
 ): MethodDecorator & ClassDecorator {
-  return createMixedDecorator(DECORATORS.ASYNCAPI_PUB, options);
+  return createMixedDecorator(DECORATORS.AsyncapiPub, options);
 }
 
 export function AsyncApiSub(
   ...options: AsyncOperationOptions[]
 ): MethodDecorator & ClassDecorator {
-  return createMixedDecorator(DECORATORS.ASYNCAPI_SUB, options);
+  return createMixedDecorator(DECORATORS.AsyncapiSub, options);
 }
diff --git a/lib/decorators/asyncapi-service.decorator.ts b/lib/decorators/asyncapi-service.decorator.ts
@@ -15,5 +15,5 @@ export interface AsyncApiServiceOptions {
 }
 
 export function AsyncApiService(options?: AsyncApiServiceOptions) {
-  return createMixedDecorator(DECORATORS.ASYNCAPI_SERVICE, options);
+  return createMixedDecorator(DECORATORS.AsyncapiService, options);
 }
diff --git a/lib/explorers/asyncapi-operation.explorer.ts b/lib/explorers/asyncapi-operation.explorer.ts
@@ -1,72 +1,69 @@
 import { Type } from '@nestjs/common';
 import { SchemaObject } from '@nestjs/swagger/dist/interfaces/open-api-spec.interface';
-import { DECORATORS } from '..';
+import { DECORATORS } from '../constants';
 import { OperationObjectFactory } from '../services';
 
 const operationObjectFactory = new OperationObjectFactory();
 
-export const exploreAsyncapiOperationMetadata = (
-  schemas: Record<string, SchemaObject>,
-  _schemaRefsStack: [],
-  instance: object,
-  prototype: Type<unknown>,
-  method: object,
-) => {
-  const pubObject = exploreAsyncapiPubMetadata(
-    schemas,
-    instance,
-    prototype,
-    method,
-  );
-  const subObject = exploreAsyncapiSubMetadata(
-    schemas,
-    instance,
-    prototype,
-    method,
-  );
+enum AsyncapiMetadataType {
+  pub = 'pub',
+  sub = 'sub',
+}
 
-  return { ...pubObject, ...subObject };
+const typeDecoratorsMap = {
+  [AsyncapiMetadataType.pub]: DECORATORS.AsyncapiPub,
+  [AsyncapiMetadataType.sub]: DECORATORS.AsyncapiSub,
 };
 
-export const exploreAsyncapiPubMetadata = (
+export const exploreAsyncapiMetadata = (
+  type: AsyncapiMetadataType,
   schemas: Record<string, SchemaObject>,
   _instance: object,
   _prototype: Type<unknown>,
   method: object,
 ) => {
-  const metadata = Reflect.getMetadata(DECORATORS.ASYNCAPI_PUB, method);
+  const metadata = Reflect.getMetadata(typeDecoratorsMap[type], method);
 
   if (!metadata) {
     return;
   }
 
   return metadata.map((option) => ({
     channel: option.channel,
-    pub: {
+    [type]: {
       ...option,
       ...operationObjectFactory.create(option, ['application/json'], schemas),
       channel: undefined,
     },
   }));
 };
-export const exploreAsyncapiSubMetadata = (
+
+export function exploreAsyncapiPubMetadata(
   schemas: Record<string, SchemaObject>,
   _instance: object,
   _prototype: Type<unknown>,
   method: object,
-) => {
-  const metadata = Reflect.getMetadata(DECORATORS.ASYNCAPI_SUB, method);
-
-  if (!metadata) {
-    return;
-  }
+) {
+  return exploreAsyncapiMetadata(
+    AsyncapiMetadataType.pub,
+    schemas,
+    _instance,
+    _prototype,
+    method,
+  );
+}
 
-  return metadata.map((option) => ({
-    channel: option.channel,
-    sub: {
-      ...option,
-      ...operationObjectFactory.create(option, ['application/json'], schemas),
-      channel: undefined,
-    },
-  }));
-};
+export function exploreAsyncapiSubMetadata(
+  schemas: Record<string, SchemaObject>,
+  _instance: object,
+  _prototype: Type<unknown>,
+  method: object,
+) {
+  return exploreAsyncapiMetadata(
+    AsyncapiMetadataType.sub,
+    schemas,
+    _instance,
+    _prototype,
+    method,
+  );
+}
diff --git a/lib/explorers/asyncapi-service.explorer.ts b/lib/explorers/asyncapi-service.explorer.ts
@@ -1,6 +1,6 @@
 import { Type } from '@nestjs/common';
-import { DECORATORS } from '..';
+import { DECORATORS } from '../constants';
 
 export const exploreAsyncapiServiceMetadata = (metatype: Type<unknown>) => {
-  return Reflect.getMetadata(DECORATORS.ASYNCAPI_SERVICE, metatype);
+  return Reflect.getMetadata(DECORATORS.AsyncapiService, metatype);
 };
diff --git a/lib/index.ts b/lib/index.ts
@@ -2,6 +2,4 @@ export * from './asyncapi-document.builder';
 export * from './interfaces';
 export * from './binding-interfaces';
 export * from './asyncapi.module';
-export * from './asyncapi.explorer';
 export * from './decorators';
-export * from './constants';
diff --git a/lib/interfaces/asyncapi-common.interfaces.ts b/lib/interfaces/asyncapi-common.interfaces.ts
@@ -28,18 +28,6 @@ export interface AsyncAPIObject {
   defaultContentType?: string;
 }
 
-export interface AsyncAPIObject {
-  asyncapi: string;
-  id?: string;
-  info: InfoObject;
-  servers?: Record<string, AsyncServerObject>;
-  channels: AsyncChannelsObject;
-  components?: AsyncComponentsObject;
-  tags?: AsyncTagObject[];
-  externalDocs?: ExternalDocumentationObject;
-  defaultContentType?: string;
-}
-
 export type AsyncChannelsObject = Record<string, AsyncChannelObject>;
 export interface AsyncChannelObject {
   description?: string;
diff --git a/lib/interfaces/asyncapi-template-options.interface.ts b/lib/interfaces/asyncapi-template-options.interface.ts
@@ -2,7 +2,9 @@
 export interface AsyncApiTemplateOptions {
   /** @default byTagsNoRoot **/
   sidebarOrganization?: 'byTags' | 'byTagsNoRoot';
-  /** @example /docs **/
+  /**
+   * @example /docs
+   **/
   baseHref?: string;
   /** @default true **/
   singleFile?: boolean;
diff --git a/lib/interfaces/denormalized-doc.interface.ts b/lib/interfaces/denormalized-doc.interface.ts
@@ -1,4 +1,4 @@
-import { AsyncAPIObject, AsyncChannelObject, AsyncOperationObject } from '..';
+import { AsyncAPIObject, AsyncChannelObject, AsyncOperationObject } from '#lib';
 
 export interface DenormalizedDoc extends Partial<AsyncAPIObject> {
   root?: { name: string } & AsyncChannelObject;
diff --git a/lib/services/asyncapi.explorer.ts b/lib/services/asyncapi.explorer.ts
@@ -3,13 +3,13 @@ import { MetadataScanner } from '@nestjs/core';
 import { InstanceWrapper } from '@nestjs/core/injector/instance-wrapper';
 import { SchemaObject } from '@nestjs/swagger/dist/interfaces/open-api-spec.interface';
 import { flatten } from 'lodash';
+import { DECORATORS } from '../constants';
 import {
   exploreAsyncapiPubMetadata,
   exploreAsyncapiServiceMetadata,
   exploreAsyncapiSubMetadata,
-} from './explorers';
-import { DenormalizedDoc, DenormalizedDocResolvers } from './interfaces';
-import { DECORATORS } from './index';
+} from '../explorers';
+import { DenormalizedDoc, DenormalizedDocResolvers } from '../interfaces';
 
 export class AsyncApiExplorer {
   private readonly metadataScanner = new MetadataScanner();
@@ -33,7 +33,7 @@ export class AsyncApiExplorer {
       !instance ||
       !metatype ||
       !Reflect.getMetadataKeys(metatype).find(
-        (x) => x === DECORATORS.ASYNCAPI_SERVICE,
+        (x) => x === DECORATORS.AsyncapiService,
       )
     ) {
       return [];
diff --git a/lib/services/asyncapi.generator.ts b/lib/services/asyncapi.generator.ts
diff --git a/lib/services/asyncapi.scanner.ts b/lib/services/asyncapi.scanner.ts
@@ -10,10 +10,10 @@ import { SchemaObjectFactory } from '@nestjs/swagger/dist/services/schema-object
 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 { AsyncApiDocumentOptions } from './asyncapi.module';
+import { AsyncApiDocumentOptions } from '../asyncapi.module';
+import { AsyncAPIObject, DenormalizedDoc } from '../interfaces';
+import { AsyncApiExplorer } from '../services/asyncapi.explorer';
 import { AsyncapiTransformer } from './asyncapi.transformer';
-import { DenormalizedDoc } from './interfaces';
-import { AsyncApiExplorer, AsyncAPIObject } from './index';
 
 export class AsyncapiScanner {
   private readonly transformer = new AsyncapiTransformer();
diff --git a/lib/services/asyncapi.transformer.ts b/lib/services/asyncapi.transformer.ts
@@ -1,5 +1,5 @@
-import { DenormalizedDoc } from './interfaces';
-import { AsyncChannelObject, AsyncChannelsObject } from './index';
+import { DenormalizedDoc } from '../interfaces';
+import { AsyncChannelObject, AsyncChannelsObject } from '#lib';
 
 export class AsyncapiTransformer {
   public normalizeChannels(
diff --git a/lib/services/index.ts b/lib/services/index.ts
@@ -1,2 +1,5 @@
-export * from './asyncapi-generator';
+export * from './asyncapi.generator';
 export * from './operation-object.factory';
+export * from './asyncapi.explorer';
+export * from './asyncapi.scanner';
+export * from './asyncapi.scanner';
diff --git a/misc/references/ref.html b/misc/references/ref.html
diff --git a/misc/references/ref.json b/misc/references/ref.json
diff --git a/misc/references/ref.yaml b/misc/references/ref.yaml
diff --git a/package.json b/package.json
@@ -84,7 +84,7 @@
     "build": "rimraf dist && tsc -p tsconfig.build.json",
     "prepare": "husky install",
     "format": "prettier --write \"lib/**/*.{js,ts,json}\"  \"e2e/**/*.{js,ts,json}\"",
-    "lint": "eslint --fix \"lib/**/*.{js,ts}\"  \"sample/**/*.{js,ts}\" \"test/**/*.{js,ts}\"",
+    "lint": "eslint --fix \"lib/**/*.ts\"  \"sample/**/*.ts\" \"test/**/*.ts\"",
     "pre-commit": "lint-staged",
     "prestart": "npm install && npm run build",
     "---execution---": "",
diff --git a/sample/cats/cats.enums.ts b/sample/cats/cats.enums.ts
@@ -0,0 +1,5 @@
+export enum LettersEnum {
+  A = 'A',
+  B = 'B',
+  C = 'C',
+}
diff --git a/sample/cats/classes/cat.class.ts b/sample/cats/classes/cat.class.ts
@@ -1,5 +1,5 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { LettersEnum } from '../dto/pagination-query.dto';
+import { LettersEnum } from '#sample/cats/cats.enums';
 
 export class Cat {
   @ApiProperty({ example: 'Kitty', description: 'The name of the Cat' })
diff --git a/sample/cats/dto/create-cat.dto.ts b/sample/cats/dto/create-cat.dto.ts
@@ -1,6 +1,6 @@
 import { ApiProperty } from '@nestjs/swagger';
+import { LettersEnum } from '../cats.enums';
 import { BreadCoonDto } from './bread-cat.dto';
-import { LettersEnum } from './pagination-query.dto';
 import { TagDto } from './tag.dto';
 
 export class CreateCatDto {
diff --git a/sample/cats/dto/pagination-query.dto.ts b/sample/cats/dto/pagination-query.dto.ts
diff --git a/sample/common.ts b/sample/common.ts
diff --git a/sample/constants.ts b/sample/constants.ts
diff --git a/sample/main.ts b/sample/main.ts
diff --git a/test/express.e2e-spec.ts b/test/express.e2e-spec.ts
diff --git a/test/fastify.e2e-spec.ts b/test/fastify.e2e-spec.ts

Original file line number	Diff line number	Diff line change
`@@ -26,11 +26,11 @@ export interface AsyncOperationOptions`
`26`	`26`	`export function AsyncApiPub(`
`27`	`27`	`...options: AsyncOperationOptions[]`
`28`	`28`	`): MethodDecorator & ClassDecorator {`
`29`		`- return createMixedDecorator(DECORATORS.ASYNCAPI_PUB, options);`
	`29`	`+ return createMixedDecorator(DECORATORS.AsyncapiPub, options);`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`export function AsyncApiSub(`
`33`	`33`	`...options: AsyncOperationOptions[]`
`34`	`34`	`): MethodDecorator & ClassDecorator {`
`35`		`- return createMixedDecorator(DECORATORS.ASYNCAPI_SUB, options);`
	`35`	`+ return createMixedDecorator(DECORATORS.AsyncapiSub, options);`
`36`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,5 +15,5 @@ export interface AsyncApiServiceOptions {`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`export function AsyncApiService(options?: AsyncApiServiceOptions) {`
`18`		`- return createMixedDecorator(DECORATORS.ASYNCAPI_SERVICE, options);`
	`18`	`+ return createMixedDecorator(DECORATORS.AsyncapiService, options);`
`19`	`19`	`}`