@achinet/nestjs-async 0.1.1 → 0.3.0

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

@@ -1,35 +0,0 @@
-/**
- * Kafka binding
- * @see https://github.com/asyncapi/bindings/tree/master/kafka
- */
-import { SchemaObject } from '@nestjs/swagger/dist/interfaces/open-api-spec.interface';
-
-export interface KafkaServerBinding {
-  schemaRegistryUrl: string;
-  schemaRegistryVendor: string;
-  /**
-   * x.y.z
-   */
-  bindingVersion: string;
-}
-
-export interface KafkaChannelBinding {
-  topic: string;
-  partitions: number;
-  replicas: number;
-  /**
-   * x.y.z
-   */
-  bindingVersion: string;
-}
-
-export interface KafkaOperationBinding {
-  groupId?: SchemaObject;
-  clientId?: SchemaObject;
-  bindingVersion?: string;
-}
-
-export interface KafkaMessageBinding {
-  key?: SchemaObject;
-  bindingVersion?: string;
-}

package/src/binding/index.ts

@@ -1,2 +0,0 @@
-export * from './asyncapi.amqp.interfaces';
-export * from './asyncapi.kafka.interfaces';

package/src/decorators/asyncapi-operation-for-meta-key.decorator.ts

@@ -1,58 +0,0 @@
-import { createMethodDecorator } from '@nestjs/swagger/dist/decorators/helpers';
-import {
-  AsyncApiOperationHeaders,
-  AsyncApiOperationOptions,
-  AsyncMessageObject,
-  AsyncOperationObject,
-} from '../interface';
-import { OneAsyncApiMessage } from '../interface/asyncapi-message.interface';
-
-function makeHeaders(headers?: AsyncApiOperationHeaders) {
-  return headers
-    ? {
-        type: 'object',
-        properties: Object.entries(headers)
-          .map(([key, value]) => ({
-            [key]: {
-              type: 'string',
-              ...value,
-            },
-          }))
-          .reduce((acc, j) => ({ ...acc, ...j }), {}),
-      }
-    : undefined;
-}
-
-function makeMessage(message: OneAsyncApiMessage, defaultName: string): AsyncMessageObject {
-  return {
-    ...message,
-    name: message.name || defaultName,
-    payload: {
-      type: message.payload,
-    },
-    headers: makeHeaders(message.headers),
-  };
-}
-
-export function AsyncApiOperationForMetaKey(metaKey: string, options: AsyncApiOperationOptions[]): MethodDecorator {
-  return (target, propertyKey: string | symbol, descriptor) => {
-    const methodName = `${target.constructor.name}#${String(propertyKey)}`;
-
-    const transformedOptions: AsyncOperationObject[] = options.map((i) => {
-      const message = Array.isArray(i.message)
-        ? {
-            oneOf: i.message.map((j, index) => makeMessage(j, `${methodName}#${index}`)),
-          }
-        : makeMessage(i.message, methodName);
-
-      const transformedOptionInstance = {
-        ...i,
-        message,
-      };
-
-      return transformedOptionInstance;
-    });
-
-    return createMethodDecorator(metaKey, transformedOptions)(target, propertyKey, descriptor);
-  };
-}

package/src/decorators/asyncapi-operation.decorator.ts

@@ -1,7 +0,0 @@
-import { DECORATORS } from '../asyncapi.constants';
-import { AsyncApiOperationOptions } from '../interface';
-import { AsyncApiOperationForMetaKey } from './asyncapi-operation-for-meta-key.decorator';
-
-export function AsyncApiOperation(...options: AsyncApiOperationOptions[]): MethodDecorator {
-  return AsyncApiOperationForMetaKey(DECORATORS.AsyncApiOperation, options);
-}

package/src/decorators/asyncapi-pub.decorator.ts

@@ -1,11 +0,0 @@
-import { DECORATORS } from '../asyncapi.constants';
-import { AsyncApiOperationOptions, AsyncApiSpecificOperationOptions } from '../interface';
-import { AsyncApiOperationForMetaKey } from './asyncapi-operation-for-meta-key.decorator';
-
-export function AsyncApiPub(...specificOperationOptions: AsyncApiSpecificOperationOptions[]) {
-  const options: AsyncApiOperationOptions[] = specificOperationOptions.map((i) => ({
-    ...i,
-    type: 'pub',
-  }));
-  return AsyncApiOperationForMetaKey(DECORATORS.AsyncApiPub, options);
-}

package/src/decorators/asyncapi-service.decorator.ts

@@ -1,9 +0,0 @@
-import { createMixedDecorator } from '@nestjs/swagger/dist/decorators/helpers';
-import { DECORATORS } from '../asyncapi.constants';
-
-/**
- * Mark class that has to be scanned for AsyncApi operations
- */
-export function AsyncApi() {
-  return createMixedDecorator(DECORATORS.AsyncApiClass, true);
-}

package/src/decorators/asyncapi-sub.decorator.ts

@@ -1,11 +0,0 @@
-import { DECORATORS } from '../asyncapi.constants';
-import { AsyncApiOperationOptions, AsyncApiSpecificOperationOptions } from '../interface';
-import { AsyncApiOperationForMetaKey } from './asyncapi-operation-for-meta-key.decorator';
-
-export function AsyncApiSub(...specificOperationOptions: AsyncApiSpecificOperationOptions[]) {
-  const options: AsyncApiOperationOptions[] = specificOperationOptions.map((i) => ({
-    ...i,
-    type: 'sub',
-  }));
-  return AsyncApiOperationForMetaKey(DECORATORS.AsyncApiSub, options);
-}

package/src/decorators/index.ts

@@ -1,4 +0,0 @@
-export * from './asyncapi-service.decorator';
-export * from './asyncapi-operation.decorator';
-export * from './asyncapi-sub.decorator';
-export * from './asyncapi-pub.decorator';

package/src/explorers/asyncapi-class.explorer.ts

@@ -1,26 +0,0 @@
-import { Type } from '@nestjs/common';
-import { CONTROLLER_WATERMARK } from '@nestjs/common/constants';
-import { DECORATORS } from '../asyncapi.constants';
-
-let GATEWAY_METADATA;
-try {
-  // eslint-disable-next-line
-  const wsConstants = require('@nestjs/websockets/constants');
-  GATEWAY_METADATA = wsConstants.GATEWAY_METADATA;
-} catch {
-  GATEWAY_METADATA = '__gateway__'; // in case @nestjs/websockets is not installed GATEWAY_METADATA value is irrelevant
-}
-
-export const asyncApiClassAnnotationLabels = [DECORATORS.AsyncApiClass, CONTROLLER_WATERMARK, GATEWAY_METADATA];
-
-export const exploreAsyncapiClassMetadata = (metatype: Type<unknown>) => {
-  return Reflect.getMetadata(DECORATORS.AsyncApiClass, metatype);
-};
-
-export const exploreControllerMetadata = (metatype: Type<unknown>) => {
-  return Reflect.getMetadata(CONTROLLER_WATERMARK, metatype);
-};
-
-export const exploreGatewayMetadata = (metatype: Type<unknown>) => {
-  return Reflect.getMetadata(GATEWAY_METADATA, metatype);
-};

package/src/explorers/asyncapi-operation.explorer.ts

@@ -1,40 +0,0 @@
-import { Type } from '@nestjs/common';
-import { SchemaObject } from '@nestjs/swagger/dist/interfaces/open-api-spec.interface';
-import { DECORATORS } from '../asyncapi.constants';
-import { AsyncApiOperationOptionsRaw } from '../interface';
-import { OperationObjectFactory } from '../services';
-
-const operationObjectFactory = new OperationObjectFactory();
-
-export const exploreAsyncApiOperationMetadata = (
-  schemas: Record<string, SchemaObject>,
-  _instance: object,
-  _prototype: Type<unknown>,
-  method: object,
-) => {
-  const metadataOperations: AsyncApiOperationOptionsRaw[] = Reflect.getMetadata(DECORATORS.AsyncApiOperation, method);
-  const metadataSubs: AsyncApiOperationOptionsRaw[] = Reflect.getMetadata(DECORATORS.AsyncApiSub, method);
-  const metadataPubs: AsyncApiOperationOptionsRaw[] = Reflect.getMetadata(DECORATORS.AsyncApiPub, method);
-
-  const metadataCombined = [
-    ...(metadataOperations ? Object.values(metadataOperations) : []),
-    ...(metadataSubs ? Object.values(metadataSubs) : []),
-    ...(metadataPubs ? Object.values(metadataPubs) : []),
-  ];
-
-  return metadataCombined.map((option: AsyncApiOperationOptionsRaw) => {
-    const { channel, type } = option;
-
-    const methodTypeData = {
-      ...option,
-      ...operationObjectFactory.create(option, ['application/json'], schemas),
-      channel: undefined,
-      type: undefined,
-    };
-
-    return {
-      channel,
-      [type]: methodTypeData,
-    };
-  });
-};

package/src/explorers/index.ts

@@ -1,2 +0,0 @@
-export * from './asyncapi-operation.explorer';
-export * from './asyncapi-class.explorer';

package/src/index.ts

@@ -1,4 +0,0 @@
-export * from './asyncapi-document.builder';
-export * from './interface';
-export * from './asyncapi.module';
-export * from './decorators';

package/src/interface/asyncapi-common.interfaces.ts

@@ -1,169 +0,0 @@
-import {
-  InfoObject,
-  ReferenceObject,
-  SchemaObject,
-  ServerVariableObject,
-} from '@nestjs/swagger/dist/interfaces/open-api-spec.interface';
-import {
-  AmqpChannelBinding,
-  AmqpMessageBinding,
-  AmqpOperationBinding,
-  AmqpServerBinding,
-  KafkaChannelBinding,
-  KafkaMessageBinding,
-  KafkaOperationBinding,
-  KafkaServerBinding,
-} from '../binding';
-import { AsyncOperationPayload } from './asyncapi-operation-payload.interface';
-import { AsyncServerObject } from './asyncapi-server.interface';
-
-export interface AsyncApiDocument {
-  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;
-  subscribe?: AsyncOperationObject;
-  publish?: AsyncOperationObject;
-  parameters?: Record<string, ParameterObject>;
-  bindings?: Record<string, KafkaChannelBinding | AmqpChannelBinding>;
-}
-
-export interface AsyncServerVariableObject extends ServerVariableObject {
-  examples?: string[];
-}
-
-export type SecurityObject = Record<string, string[]>;
-
-export interface AsyncComponentsObject {
-  schemas?: Record<string, SchemaObject>;
-  messages?: Record<string, AsyncMessageObject>;
-  securitySchemes?: Record<string, AsyncSecuritySchemeObject>;
-  parameters?: Record<string, ParameterObject>;
-  correlationIds?: Record<string, AsyncCorrelationObject>;
-  operationTraits?: Record<string, AsyncOperationTraitObject>;
-  messageTraits?: Record<string, AsyncMessageTraitObject>;
-  serverBindings?: Record<string, KafkaServerBinding | AmqpServerBinding>;
-  channelBindings?: Record<string, KafkaChannelBinding | AmqpChannelBinding>;
-  operationBindings?: Record<string, KafkaOperationBinding | AmqpOperationBinding>;
-  messageBindings?: Record<string, KafkaMessageBinding | AmqpMessageBinding>;
-}
-
-export interface AsyncMessageObject extends AsyncMessageTraitObject {
-  payload?: {
-    type?: AsyncOperationPayload;
-    $ref?: AsyncOperationPayload;
-  };
-}
-
-export type MessageType = AsyncMessageObject | ReferenceObject;
-export interface OneOfMessageType {
-  oneOf: MessageType[];
-}
-
-export type AsyncOperationMessage = OneOfMessageType | MessageType;
-
-export interface AsyncOperationObject {
-  channel: string;
-  operationId?: string;
-  summary?: string;
-  description?: string;
-  tags?: AsyncTagObject[];
-  externalDocs?: ExternalDocumentationObject;
-  bindings?: Record<string, KafkaOperationBinding | AmqpOperationBinding>;
-  traits?: Record<string, AsyncOperationTraitObject>;
-  message?: AsyncOperationMessage;
-}
-
-export interface AsyncOperationTraitObject {
-  operationId?: string;
-  summary?: string;
-  description?: string;
-  tags?: AsyncTagObject[];
-  externalDocs?: ExternalDocumentationObject;
-  bindings?: Record<string, KafkaOperationBinding | AmqpOperationBinding>;
-}
-
-export interface AsyncMessageTraitObject {
-  headers?: SchemaObject;
-  correlationId?: AsyncCorrelationObject;
-  schemaFormat?: string;
-  contentType?: string;
-  name?: string;
-  title?: string;
-  summary?: string;
-  description?: string;
-  tags?: AsyncTagObject[];
-  externalDocs?: ExternalDocumentationObject;
-  bindings?: Record<string, KafkaMessageBinding | AmqpMessageBinding>;
-}
-
-export interface AsyncCorrelationObject {
-  description?: string;
-  location: string;
-}
-
-export interface AsyncTagObject {
-  name: string;
-  description?: string;
-  externalDocs?: ExternalDocumentationObject;
-}
-
-export interface AsyncSecuritySchemeObject {
-  type: SecuritySchemeType;
-  description?: string;
-  name?: string;
-  in?: string;
-  scheme?: string;
-  bearerFormat?: string;
-  flows?: OAuthFlowsObject;
-  openIdConnectUrl?: string;
-}
-
-export declare type SecuritySchemeType =
-  | 'userPassword'
-  | 'apiKey'
-  | 'X509'
-  | 'symmetricEncryption'
-  | 'asymmetricEncryption'
-  | 'http'
-  | 'oauth2'
-  | 'openIdConnect';
-
-export interface OAuthFlowsObject {
-  implicit?: OAuthFlowObject;
-  password?: OAuthFlowObject;
-  clientCredentials?: OAuthFlowObject;
-  authorizationCode?: OAuthFlowObject;
-}
-
-export interface OAuthFlowObject {
-  authorizationUrl?: string;
-  tokenUrl?: string;
-  refreshUrl?: string;
-  scopes: ScopesObject;
-}
-
-export type ScopesObject = Record<string, unknown>;
-
-export type ParameterObject = BaseParameterObject;
-
-export interface BaseParameterObject {
-  description?: string;
-  schema?: SchemaObject | ReferenceObject;
-  location?: string;
-}
-
-export interface ExternalDocumentationObject {
-  description?: string;
-  url: string;
-}

package/src/interface/asyncapi-document-options.interface.ts

@@ -1,3 +0,0 @@
-import { SwaggerDocumentOptions } from '@nestjs/swagger';
-
-export interface AsyncApiDocumentOptions extends SwaggerDocumentOptions {}

package/src/interface/asyncapi-message.interface.ts

@@ -1,10 +0,0 @@
-import { AsyncApiOperationHeaders } from './asyncapi-operation-headers.interface';
-import { AsyncOperationPayload } from './asyncapi-operation-payload.interface';
-
-export interface OneAsyncApiMessage {
-  name?: string;
-  payload: AsyncOperationPayload;
-  headers?: AsyncApiOperationHeaders;
-}
-
-export type AsyncApiMessage = OneAsyncApiMessage | OneAsyncApiMessage[];

package/src/interface/asyncapi-operation-headers.interface.ts

@@ -1,6 +0,0 @@
-export interface AsyncApiOperationHeaders {
-  [key: string]: {
-    description: string;
-    [key: string]: unknown;
-  };
-}

package/src/interface/asyncapi-operation-options-raw.interface.ts

@@ -1,23 +0,0 @@
-import { AsyncOperationObject } from './asyncapi-common.interfaces';
-import { AsyncOperationPayload } from './asyncapi-operation-payload.interface';
-
-export interface RawAsyncApiMessage {
-  name?: string;
-  payload: {
-    type: AsyncOperationPayload;
-  };
-  headers?: {
-    type: 'object';
-    properties: {
-      [key: string]: {
-        description: string;
-        type: 'string';
-        [key: string]: unknown;
-      };
-    };
-  };
-}
-
-export interface AsyncApiOperationOptionsRaw extends AsyncOperationObject {
-  type: 'sub' | 'pub';
-}

package/src/interface/asyncapi-operation-options.interface.ts

@@ -1,10 +0,0 @@
-import { AsyncOperationObject } from './asyncapi-common.interfaces';
-import { AsyncApiMessage } from './asyncapi-message.interface';
-
-export interface AsyncApiSpecificOperationOptions extends Omit<AsyncOperationObject, 'message'> {
-  message: AsyncApiMessage;
-}
-
-export interface AsyncApiOperationOptions extends AsyncApiSpecificOperationOptions {
-  type: 'pub' | 'sub';
-}

package/src/interface/asyncapi-operation-payload.interface.ts

@@ -1,3 +0,0 @@
-import { Type } from '@nestjs/common';
-
-export type AsyncOperationPayload = Type<unknown> | Function | [Function] | string;

package/src/interface/asyncapi-server.interface.ts

@@ -1,11 +0,0 @@
-import { ServerObject } from '@nestjs/swagger/dist/interfaces/open-api-spec.interface';
-import { AmqpServerBinding, KafkaServerBinding } from '../binding';
-import { AsyncServerVariableObject, SecurityObject } from './asyncapi-common.interfaces';
-
-export interface AsyncServerObject extends Omit<ServerObject, 'variables'> {
-  variables?: Record<string, AsyncServerVariableObject>;
-  protocol: string;
-  protocolVersion?: string;
-  security?: SecurityObject[];
-  bindings?: Record<string, KafkaServerBinding | AmqpServerBinding>;
-}

package/src/interface/asyncapi-template-options.interface.ts

@@ -1,20 +0,0 @@
-/**
- * @see https://github.com/asyncapi/html-template#supported-parameters
- * */
-export interface AsyncApiTemplateOptions {
-  /** @default byTagsNoRoot * */
-  sidebarOrganization?: 'byTags' | 'byTagsNoRoot';
-  /**
-   * @example /docs
-   * */
-  baseHref?: string;
-  /** @default true * */
-  singleFile?: boolean;
-  /** @example asyncapi.html * */
-  outFilename?: string;
-  /**
-   * @description 	Generates output HTML as PDF
-   * @default false
-   */
-  pdf?: boolean;
-}

package/src/interface/denormalized-doc-resolvers.interface.ts

@@ -1,6 +0,0 @@
-export interface DenormalizedDocResolvers {
-  root: Function[];
-  security: Function[];
-  tags: Function[];
-  operations: Function[];
-}

package/src/interface/denormalized-doc.interface.ts

@@ -1,6 +0,0 @@
-import { AsyncApiDocument, AsyncChannelObject, AsyncOperationObject } from './asyncapi-common.interfaces';
-
-export interface DenormalizedDoc extends Partial<AsyncApiDocument> {
-  root?: { name: string } & AsyncChannelObject;
-  operations?: { pub: AsyncOperationObject; sub: AsyncOperationObject };
-}

package/src/interface/generator-options.interface.ts

@@ -1,21 +0,0 @@
-import { AsyncApiDocument } from './asyncapi-common.interfaces';
-import { AsyncApiTemplateOptions } from './asyncapi-template-options.interface';
-
-export interface GeneratorOptions {
-  templateName: string;
-  targetDir: string;
-  entrypoint?: string;
-  noOverwriteGlobs: string[];
-  disabledHooks: { [key: string]: string | boolean | string[] };
-  output: 'string' | 'fs';
-  forceWrite: boolean;
-  debug: boolean;
-  install: boolean;
-  templateConfig: Record<string, unknown>;
-  hooks: Record<string, unknown>;
-  templateParams: AsyncApiTemplateOptions;
-  generate: (document: AsyncApiDocument) => Promise<void>;
-  generateFromURL: (url: string) => Promise<void>;
-  generateFromFile: (path: string) => Promise<void>;
-  generateFromString: (yaml: string, args?: unknown) => Promise<string>;
-}

package/src/interface/index.ts

@@ -1,12 +0,0 @@
-export * from './asyncapi-common.interfaces';
-export * from './asyncapi-template-options.interface';
-export * from './asyncapi-operation-headers.interface';
-export * from './asyncapi-operation-payload.interface';
-export * from './asyncapi-operation-options.interface';
-export * from './asyncapi-document-options.interface';
-export * from './asyncapi-server.interface';
-export * from './denormalized-doc.interface';
-export * from './denormalized-doc-resolvers.interface';
-export * from './generator-options.interface';
-
-export * from './asyncapi-operation-options-raw.interface';

package/src/services/asyncapi.explorer.ts

@@ -1,112 +0,0 @@
-import { Type } from '@nestjs/common';
-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 {
-  asyncApiClassAnnotationLabels,
-  exploreAsyncapiClassMetadata,
-  exploreAsyncApiOperationMetadata,
-  exploreControllerMetadata,
-  exploreGatewayMetadata,
-} from '../explorers';
-import { DenormalizedDoc, DenormalizedDocResolvers } from '../interface';
-
-export class AsyncApiExplorer {
-  private readonly metadataScanner = new MetadataScanner();
-
-  private readonly schemas: SchemaObject[] = [];
-
-  private readonly schemaRefsStack: string[] = [];
-
-  private operationIdFactory = (controllerKey: string, methodKey: string) =>
-    controllerKey ? `${controllerKey}_${methodKey}` : methodKey;
-
-  public explorerAsyncapiServices(
-    wrapper: InstanceWrapper,
-    modulePath?: string,
-    globalPrefix?: string,
-    operationIdFactory?: (controllerKey: string, methodKey: string) => string,
-  ) {
-    if (operationIdFactory) {
-      this.operationIdFactory = operationIdFactory;
-    }
-
-    const { instance, metatype } = wrapper;
-    if (
-      !instance ||
-      !metatype ||
-      !Reflect.getMetadataKeys(metatype).find((label) => asyncApiClassAnnotationLabels.includes(label))
-    ) {
-      return [];
-    }
-
-    const prototype = Object.getPrototypeOf(instance);
-    const documentResolvers: DenormalizedDocResolvers = {
-      root: [exploreAsyncapiClassMetadata, exploreControllerMetadata, exploreGatewayMetadata],
-      security: [],
-      tags: [],
-      operations: [exploreAsyncApiOperationMetadata],
-    };
-
-    return this.generateDenormalizedDocument(
-      metatype as Type<unknown>,
-      prototype,
-      instance,
-      documentResolvers,
-      modulePath,
-      globalPrefix,
-    );
-  }
-
-  public getSchemas(): Record<string, SchemaObject> {
-    const ret = { ...this.schemas } as unknown as Record<string, SchemaObject>;
-    return ret;
-  }
-
-  private generateDenormalizedDocument(
-    metatype: Type<unknown>,
-    prototype: Type<unknown>,
-    instance: object,
-    documentResolvers: DenormalizedDocResolvers,
-    _modulePath?: string,
-    _globalPrefix?: string,
-  ): DenormalizedDoc[] {
-    const denormalizedAsyncapiServices = this.metadataScanner.scanFromPrototype<unknown, DenormalizedDoc[]>(
-      instance,
-      prototype,
-      (name) => {
-        const targetCallback = prototype[name];
-        const methodMetadata = documentResolvers.root.reduce((_metadata, fn) => {
-          const serviceMetadata = fn(metatype);
-
-          const channels = documentResolvers.operations.reduce((operationsParam, exploreOperationsMeta) => {
-            const operations = operationsParam;
-            const meta = exploreOperationsMeta(this.schemas, instance, prototype, targetCallback);
-            if (!meta) {
-              return operations;
-            }
-
-            meta.forEach((op) => {
-              // @eslint-disable-next-line
-              if (Object.prototype.hasOwnProperty.call(operations, op.channel)) {
-                operations[op.channel] = { ...operations[op.channel], ...op };
-              } else {
-                operations[op.channel] = op;
-              }
-            });
-            return operations;
-          }, {});
-
-          return Object.keys(channels).map((channel) => ({
-            root: { ...serviceMetadata, name: channel },
-            operations: channels[channel],
-          }));
-        }, []);
-        return methodMetadata;
-      },
-    );
-
-    return flatten(denormalizedAsyncapiServices);
-  }
-}