@achinet/nestjs-async 0.2.0 → 0.3.0

package/eslint.config.mjs

@@ -1,21 +0,0 @@
-import sharedConfig from '@achinet/eslint-config-custom';
-
-export default [
-  ...sharedConfig,
-  {
-    ignores: ['dist/**', 'node_modules/**'],
-  },
-  {
-    files: ['**/*.ts', '**/*.tsx'],
-    rules: {
-      'no-restricted-syntax': 'off',
-      '@typescript-eslint/no-unused-vars': [
-        'warn',
-        {
-          argsIgnorePattern: '^_',
-          varsIgnorePattern: '^_',
-        },
-      ],
-    },
-  },
-];

package/misc/references/ref.html

@@ -1,303 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>AsyncAPI Documentation</title>
-</head>
-<body>
-  <h1>AsyncAPI Documentation</h1>
-  <p>Mock HTML generated for testing</p>
-  <pre>asyncapi: 2.5.0
-info:
-  title: Feline
-  description: Feline server description here
-  version: '1.0'
-  contact: {}
-tags: []
-servers:
-  europe: &ref_0
-    url: ws://0.0.0.0:4001
-    protocol: socket.io
-    protocolVersion: '4'
-    description: &gt;-
-      Allows you to connect using the websocket protocol to our Socket.io
-      server.
-    security:
-      - user-password: []
-    variables:
-      port:
-        description: Secure connection (TLS) is available through port 443.
-        default: '443'
-    bindings: {}
-  asia: *ref_0
-  north-america: *ref_0
-  south-america: *ref_0
-  africa: *ref_0
-  australia: *ref_0
-components:
-  securitySchemes:
-    user-password:
-      type: userPassword
-  schemas:
-    Feline:
-      type: object
-      properties:
-        id:
-          type: number
-        name:
-          type: string
-        age:
-          type: number
-        gender:
-          enum: &ref_2
-            - male
-            - female
-          type: string
-        dominantPaw:
-          enum: &ref_3
-            - left
-            - right
-          type: string
-        tags:
-          type: array
-          items:
-            type: string
-        birthDatetime:
-          format: date-time
-          type: string
-      required:
-        - id
-        - name
-        - age
-        - gender
-        - dominantPaw
-        - tags
-        - birthDatetime
-    CreateFelineDto:
-      type: object
-      properties:
-        correlationId:
-          type: string
-          format: uuid
-        version:
-          type: string
-          format: x.y.z
-          example: 1.0.1
-        payload:
-          oneOf:
-            - $ref: '#/components/schemas/Cat'
-            - $ref: '#/components/schemas/Lion'
-            - $ref: '#/components/schemas/Tiger'
-          allOf:
-            - $ref: '#/components/schemas/Feline'
-        timestamp:
-          format: date-time
-          type: string
-      required:
-        - correlationId
-        - version
-        - payload
-        - timestamp
-    FelineRto:
-      type: object
-      properties:
-        correlationId:
-          type: string
-          format: uuid
-        version:
-          type: string
-          format: x.y.z
-          example: 1.0.1
-        payload:
-          oneOf: &ref_1
-            - $ref: '#/components/schemas/Cat'
-            - $ref: '#/components/schemas/Lion'
-            - $ref: '#/components/schemas/Tiger'
-          allOf:
-            - $ref: '#/components/schemas/Feline'
-        timestamp:
-          format: date-time
-          type: string
-      required:
-        - correlationId
-        - version
-        - payload
-        - timestamp
-    FelineExtendedRto:
-      type: object
-      properties:
-        correlationId:
-          type: string
-          format: uuid
-        version:
-          type: string
-          format: x.y.z
-          example: 1.0.1
-        payload:
-          oneOf: *ref_1
-          allOf:
-            - $ref: '#/components/schemas/Feline'
-        timestamp:
-          format: date-time
-          type: string
-      required:
-        - correlationId
-        - version
-        - payload
-        - timestamp
-    JournalingDataDto:
-      type: object
-      properties:
-        correlationId:
-          type: string
-          format: uuid
-        version:
-          type: string
-          format: x.y.z
-          example: 1.0.1
-        payload:
-          type: object
-        timestamp:
-          format: date-time
-          type: string
-      required:
-        - correlationId
-        - version
-        - payload
-        - timestamp
-    Cat:
-      type: object
-      properties:
-        breed:
-          type: string
-          example: Maine Coon
-        id:
-          type: number
-        name:
-          type: string
-        age:
-          type: number
-        gender:
-          enum: *ref_2
-          type: string
-        dominantPaw:
-          enum: *ref_3
-          type: string
-        tags:
-          type: array
-          items:
-            type: string
-        birthDatetime:
-          format: date-time
-          type: string
-      required:
-        - breed
-        - id
-        - name
-        - age
-        - gender
-        - dominantPaw
-        - tags
-        - birthDatetime
-    Lion:
-      type: object
-      properties:
-        id:
-          type: number
-        name:
-          type: string
-        age:
-          type: number
-        gender:
-          enum: *ref_2
-          type: string
-        dominantPaw:
-          enum: *ref_3
-          type: string
-        tags:
-          type: array
-          items:
-            type: string
-        birthDatetime:
-          format: date-time
-          type: string
-        roarVolume:
-          type: number
-      required:
-        - id
-        - name
-        - age
-        - gender
-        - dominantPaw
-        - tags
-        - birthDatetime
-        - roarVolume
-    Tiger:
-      type: object
-      properties:
-        id:
-          type: number
-        name:
-          type: string
-        age:
-          type: number
-        gender:
-          enum: *ref_2
-          type: string
-        dominantPaw:
-          enum: *ref_3
-          type: string
-        tags:
-          type: array
-          items:
-            type: string
-        birthDatetime:
-          format: date-time
-          type: string
-        numberOfStripes:
-          type: number
-      required:
-        - id
-        - name
-        - age
-        - gender
-        - dominantPaw
-        - tags
-        - birthDatetime
-        - numberOfStripes
-defaultContentType: application/json
-channels:
-  ws/create/feline:
-    subscribe:
-      message:
-        oneOf:
-          - name: 'oneOf demo #1'
-            payload:
-              $ref: '#/components/schemas/FelineRto'
-          - name: 'oneOf demo #2'
-            payload:
-              $ref: '#/components/schemas/FelineExtendedRto'
-    publish:
-      message:
-        payload:
-          $ref: '#/components/schemas/CreateFelineDto'
-        name: FelinesGateway#createFeline
-  ms/journal:
-    subscribe:
-      message:
-        payload:
-          $ref: '#/components/schemas/JournalingDataDto'
-        name: FelinesController#journal
-  ms/create/feline:
-    subscribe:
-      message:
-        payload:
-          $ref: '#/components/schemas/FelineRto'
-        name: FelinesController#createFeline
-    publish:
-      message:
-        payload:
-          $ref: '#/components/schemas/CreateFelineDto'
-        name: FelinesController#createFeline
-</pre>
-</body>
-</html>

package/misc/references/ref.json

@@ -1 +0,0 @@
-{"asyncapi":"2.5.0","info":{"title":"Feline","description":"Feline server description here","version":"1.0","contact":{}},"tags":[],"servers":{"europe":{"url":"ws://0.0.0.0:4001","protocol":"socket.io","protocolVersion":"4","description":"Allows you to connect using the websocket protocol to our Socket.io server.","security":[{"user-password":[]}],"variables":{"port":{"description":"Secure connection (TLS) is available through port 443.","default":"443"}},"bindings":{}},"asia":{"url":"ws://0.0.0.0:4001","protocol":"socket.io","protocolVersion":"4","description":"Allows you to connect using the websocket protocol to our Socket.io server.","security":[{"user-password":[]}],"variables":{"port":{"description":"Secure connection (TLS) is available through port 443.","default":"443"}},"bindings":{}},"north-america":{"url":"ws://0.0.0.0:4001","protocol":"socket.io","protocolVersion":"4","description":"Allows you to connect using the websocket protocol to our Socket.io server.","security":[{"user-password":[]}],"variables":{"port":{"description":"Secure connection (TLS) is available through port 443.","default":"443"}},"bindings":{}},"south-america":{"url":"ws://0.0.0.0:4001","protocol":"socket.io","protocolVersion":"4","description":"Allows you to connect using the websocket protocol to our Socket.io server.","security":[{"user-password":[]}],"variables":{"port":{"description":"Secure connection (TLS) is available through port 443.","default":"443"}},"bindings":{}},"africa":{"url":"ws://0.0.0.0:4001","protocol":"socket.io","protocolVersion":"4","description":"Allows you to connect using the websocket protocol to our Socket.io server.","security":[{"user-password":[]}],"variables":{"port":{"description":"Secure connection (TLS) is available through port 443.","default":"443"}},"bindings":{}},"australia":{"url":"ws://0.0.0.0:4001","protocol":"socket.io","protocolVersion":"4","description":"Allows you to connect using the websocket protocol to our Socket.io server.","security":[{"user-password":[]}],"variables":{"port":{"description":"Secure connection (TLS) is available through port 443.","default":"443"}},"bindings":{}}},"components":{"securitySchemes":{"user-password":{"type":"userPassword"}},"schemas":{"Feline":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"age":{"type":"number"},"gender":{"enum":["male","female"],"type":"string"},"dominantPaw":{"enum":["left","right"],"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"birthDatetime":{"format":"date-time","type":"string"}},"required":["id","name","age","gender","dominantPaw","tags","birthDatetime"]},"CreateFelineDto":{"type":"object","properties":{"correlationId":{"type":"string","format":"uuid"},"version":{"type":"string","format":"x.y.z","example":"1.0.1"},"payload":{"oneOf":[{"$ref":"#/components/schemas/Cat"},{"$ref":"#/components/schemas/Lion"},{"$ref":"#/components/schemas/Tiger"}],"allOf":[{"$ref":"#/components/schemas/Feline"}]},"timestamp":{"format":"date-time","type":"string"}},"required":["correlationId","version","payload","timestamp"]},"FelineRto":{"type":"object","properties":{"correlationId":{"type":"string","format":"uuid"},"version":{"type":"string","format":"x.y.z","example":"1.0.1"},"payload":{"oneOf":[{"$ref":"#/components/schemas/Cat"},{"$ref":"#/components/schemas/Lion"},{"$ref":"#/components/schemas/Tiger"}],"allOf":[{"$ref":"#/components/schemas/Feline"}]},"timestamp":{"format":"date-time","type":"string"}},"required":["correlationId","version","payload","timestamp"]},"FelineExtendedRto":{"type":"object","properties":{"correlationId":{"type":"string","format":"uuid"},"version":{"type":"string","format":"x.y.z","example":"1.0.1"},"payload":{"oneOf":[{"$ref":"#/components/schemas/Cat"},{"$ref":"#/components/schemas/Lion"},{"$ref":"#/components/schemas/Tiger"}],"allOf":[{"$ref":"#/components/schemas/Feline"}]},"timestamp":{"format":"date-time","type":"string"}},"required":["correlationId","version","payload","timestamp"]},"JournalingDataDto":{"type":"object","properties":{"correlationId":{"type":"string","format":"uuid"},"version":{"type":"string","format":"x.y.z","example":"1.0.1"},"payload":{"type":"object"},"timestamp":{"format":"date-time","type":"string"}},"required":["correlationId","version","payload","timestamp"]},"Cat":{"type":"object","properties":{"breed":{"type":"string","example":"Maine Coon"},"id":{"type":"number"},"name":{"type":"string"},"age":{"type":"number"},"gender":{"enum":["male","female"],"type":"string"},"dominantPaw":{"enum":["left","right"],"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"birthDatetime":{"format":"date-time","type":"string"}},"required":["breed","id","name","age","gender","dominantPaw","tags","birthDatetime"]},"Lion":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"age":{"type":"number"},"gender":{"enum":["male","female"],"type":"string"},"dominantPaw":{"enum":["left","right"],"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"birthDatetime":{"format":"date-time","type":"string"},"roarVolume":{"type":"number"}},"required":["id","name","age","gender","dominantPaw","tags","birthDatetime","roarVolume"]},"Tiger":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"age":{"type":"number"},"gender":{"enum":["male","female"],"type":"string"},"dominantPaw":{"enum":["left","right"],"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"birthDatetime":{"format":"date-time","type":"string"},"numberOfStripes":{"type":"number"}},"required":["id","name","age","gender","dominantPaw","tags","birthDatetime","numberOfStripes"]}}},"defaultContentType":"application/json","channels":{"ws/create/feline":{"subscribe":{"message":{"oneOf":[{"name":"oneOf demo #1","payload":{"$ref":"#/components/schemas/FelineRto"}},{"name":"oneOf demo #2","payload":{"$ref":"#/components/schemas/FelineExtendedRto"}}]}},"publish":{"message":{"payload":{"$ref":"#/components/schemas/CreateFelineDto"},"name":"FelinesGateway#createFeline"}}},"ms/journal":{"subscribe":{"message":{"payload":{"$ref":"#/components/schemas/JournalingDataDto"},"name":"FelinesController#journal"}}},"ms/create/feline":{"subscribe":{"message":{"payload":{"$ref":"#/components/schemas/FelineRto"},"name":"FelinesController#createFeline"}},"publish":{"message":{"payload":{"$ref":"#/components/schemas/CreateFelineDto"},"name":"FelinesController#createFeline"}}}}}

package/misc/references/ref.yaml

@@ -1,292 +0,0 @@
-asyncapi: 2.5.0
-info:
-  title: Feline
-  description: Feline server description here
-  version: '1.0'
-  contact: {}
-tags: []
-servers:
-  europe: &ref_0
-    url: ws://0.0.0.0:4001
-    protocol: socket.io
-    protocolVersion: '4'
-    description: >-
-      Allows you to connect using the websocket protocol to our Socket.io
-      server.
-    security:
-      - user-password: []
-    variables:
-      port:
-        description: Secure connection (TLS) is available through port 443.
-        default: '443'
-    bindings: {}
-  asia: *ref_0
-  north-america: *ref_0
-  south-america: *ref_0
-  africa: *ref_0
-  australia: *ref_0
-components:
-  securitySchemes:
-    user-password:
-      type: userPassword
-  schemas:
-    Feline:
-      type: object
-      properties:
-        id:
-          type: number
-        name:
-          type: string
-        age:
-          type: number
-        gender:
-          enum: &ref_2
-            - male
-            - female
-          type: string
-        dominantPaw:
-          enum: &ref_3
-            - left
-            - right
-          type: string
-        tags:
-          type: array
-          items:
-            type: string
-        birthDatetime:
-          format: date-time
-          type: string
-      required:
-        - id
-        - name
-        - age
-        - gender
-        - dominantPaw
-        - tags
-        - birthDatetime
-    CreateFelineDto:
-      type: object
-      properties:
-        correlationId:
-          type: string
-          format: uuid
-        version:
-          type: string
-          format: x.y.z
-          example: 1.0.1
-        payload:
-          oneOf:
-            - $ref: '#/components/schemas/Cat'
-            - $ref: '#/components/schemas/Lion'
-            - $ref: '#/components/schemas/Tiger'
-          allOf:
-            - $ref: '#/components/schemas/Feline'
-        timestamp:
-          format: date-time
-          type: string
-      required:
-        - correlationId
-        - version
-        - payload
-        - timestamp
-    FelineRto:
-      type: object
-      properties:
-        correlationId:
-          type: string
-          format: uuid
-        version:
-          type: string
-          format: x.y.z
-          example: 1.0.1
-        payload:
-          oneOf: &ref_1
-            - $ref: '#/components/schemas/Cat'
-            - $ref: '#/components/schemas/Lion'
-            - $ref: '#/components/schemas/Tiger'
-          allOf:
-            - $ref: '#/components/schemas/Feline'
-        timestamp:
-          format: date-time
-          type: string
-      required:
-        - correlationId
-        - version
-        - payload
-        - timestamp
-    FelineExtendedRto:
-      type: object
-      properties:
-        correlationId:
-          type: string
-          format: uuid
-        version:
-          type: string
-          format: x.y.z
-          example: 1.0.1
-        payload:
-          oneOf: *ref_1
-          allOf:
-            - $ref: '#/components/schemas/Feline'
-        timestamp:
-          format: date-time
-          type: string
-      required:
-        - correlationId
-        - version
-        - payload
-        - timestamp
-    JournalingDataDto:
-      type: object
-      properties:
-        correlationId:
-          type: string
-          format: uuid
-        version:
-          type: string
-          format: x.y.z
-          example: 1.0.1
-        payload:
-          type: object
-        timestamp:
-          format: date-time
-          type: string
-      required:
-        - correlationId
-        - version
-        - payload
-        - timestamp
-    Cat:
-      type: object
-      properties:
-        breed:
-          type: string
-          example: Maine Coon
-        id:
-          type: number
-        name:
-          type: string
-        age:
-          type: number
-        gender:
-          enum: *ref_2
-          type: string
-        dominantPaw:
-          enum: *ref_3
-          type: string
-        tags:
-          type: array
-          items:
-            type: string
-        birthDatetime:
-          format: date-time
-          type: string
-      required:
-        - breed
-        - id
-        - name
-        - age
-        - gender
-        - dominantPaw
-        - tags
-        - birthDatetime
-    Lion:
-      type: object
-      properties:
-        id:
-          type: number
-        name:
-          type: string
-        age:
-          type: number
-        gender:
-          enum: *ref_2
-          type: string
-        dominantPaw:
-          enum: *ref_3
-          type: string
-        tags:
-          type: array
-          items:
-            type: string
-        birthDatetime:
-          format: date-time
-          type: string
-        roarVolume:
-          type: number
-      required:
-        - id
-        - name
-        - age
-        - gender
-        - dominantPaw
-        - tags
-        - birthDatetime
-        - roarVolume
-    Tiger:
-      type: object
-      properties:
-        id:
-          type: number
-        name:
-          type: string
-        age:
-          type: number
-        gender:
-          enum: *ref_2
-          type: string
-        dominantPaw:
-          enum: *ref_3
-          type: string
-        tags:
-          type: array
-          items:
-            type: string
-        birthDatetime:
-          format: date-time
-          type: string
-        numberOfStripes:
-          type: number
-      required:
-        - id
-        - name
-        - age
-        - gender
-        - dominantPaw
-        - tags
-        - birthDatetime
-        - numberOfStripes
-defaultContentType: application/json
-channels:
-  ws/create/feline:
-    subscribe:
-      message:
-        oneOf:
-          - name: 'oneOf demo #1'
-            payload:
-              $ref: '#/components/schemas/FelineRto'
-          - name: 'oneOf demo #2'
-            payload:
-              $ref: '#/components/schemas/FelineExtendedRto'
-    publish:
-      message:
-        payload:
-          $ref: '#/components/schemas/CreateFelineDto'
-        name: FelinesGateway#createFeline
-  ms/journal:
-    subscribe:
-      message:
-        payload:
-          $ref: '#/components/schemas/JournalingDataDto'
-        name: FelinesController#journal
-  ms/create/feline:
-    subscribe:
-      message:
-        payload:
-          $ref: '#/components/schemas/FelineRto'
-        name: FelinesController#createFeline
-    publish:
-      message:
-        payload:
-          $ref: '#/components/schemas/CreateFelineDto'
-        name: FelinesController#createFeline

package/misc/take-snaphots.sh

@@ -1,8 +0,0 @@
-curl http://localhost:4001/async-api > misc/references/ref.html
-curl http://localhost:4001/async-api > docs/live-demo/index.html
-curl http://localhost:4001/async-api-json > misc/references/ref.json
-curl http://localhost:4001/async-api-yaml > misc/references/ref.yaml
-echo 'test snapshots were taken'
-
-
-

package/sample/app.module.ts

@@ -1,7 +0,0 @@
-import { Module } from '@nestjs/common';
-import { FelinesModule } from './felines/felines.module';
-
-@Module({
-  imports: [FelinesModule],
-})
-export class AppModule {}

package/sample/common.ts

@@ -1,49 +0,0 @@
-import { INestApplicationContext } from '@nestjs/common';
-import { HOST, PORT, SERVER } from './constants';
-import { Cat, Feline, Lion, Tiger } from './felines/class';
-import { FelinesModule } from './felines/felines.module';
-import {
-  AsyncApiDocument,
-  AsyncApiDocumentBuilder,
-  AsyncApiModule,
-  AsyncServerObject,
-} from '../src';
-
-export async function makeAsyncapiDocument(
-  app: INestApplicationContext,
-): Promise<AsyncApiDocument> {
-  const asyncApiServer: AsyncServerObject = {
-    url: `ws://${HOST}:${PORT}`,
-    protocol: 'socket.io',
-    protocolVersion: '4',
-    description:
-      'Allows you to connect using the websocket protocol to our Socket.io server.',
-    security: [{ 'user-password': [] }],
-    variables: {
-      port: {
-        description: 'Secure connection (TLS) is available through port 443.',
-        default: '443',
-      },
-    },
-    bindings: {},
-  };
-
-  const servers = Object.keys(SERVER).map((i) => ({
-    name: SERVER[i],
-    server: asyncApiServer,
-  }));
-
-  const asyncApiOptions = new AsyncApiDocumentBuilder()
-    .setTitle('Feline')
-    .setDescription('Feline server description here')
-    .setVersion('1.0')
-    .setDefaultContentType('application/json')
-    .addSecurity('user-password', { type: 'userPassword' })
-    .addServers(servers)
-    .build();
-
-  return AsyncApiModule.createDocument(app, asyncApiOptions, {
-    include: [FelinesModule],
-    extraModels: [Cat, Lion, Tiger, Feline],
-  });
-}