@achinet/nestjs-async 0.0.1 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (246) hide show
  1. package/.eslintrc.js +31 -0
  2. package/CHANGELOG.md +6 -0
  3. package/dist/decorators/asyncapi-operation-for-meta-key.decorator.js +1 -2
  4. package/dist/decorators/asyncapi-operation-for-meta-key.decorator.js.map +1 -1
  5. package/dist/decorators/asyncapi-operation.decorator.js +1 -2
  6. package/dist/decorators/asyncapi-operation.decorator.js.map +1 -1
  7. package/dist/decorators/asyncapi-pub.decorator.js +1 -2
  8. package/dist/decorators/asyncapi-pub.decorator.js.map +1 -1
  9. package/dist/decorators/asyncapi-service.decorator.js +1 -2
  10. package/dist/decorators/asyncapi-service.decorator.js.map +1 -1
  11. package/dist/decorators/asyncapi-sub.decorator.js +1 -2
  12. package/dist/decorators/asyncapi-sub.decorator.js.map +1 -1
  13. package/dist/explorers/asyncapi-operation.explorer.d.ts +8 -8
  14. package/dist/sample/app.module.d.ts +2 -0
  15. package/dist/sample/app.module.js +20 -0
  16. package/dist/sample/app.module.js.map +1 -0
  17. package/dist/sample/common.d.ts +3 -0
  18. package/dist/sample/common.js +40 -0
  19. package/dist/sample/common.js.map +1 -0
  20. package/dist/sample/constants.d.ts +12 -0
  21. package/dist/sample/constants.js +16 -0
  22. package/dist/sample/constants.js.map +1 -0
  23. package/dist/sample/felines/class/cat.class.d.ts +4 -0
  24. package/dist/sample/felines/class/cat.class.js +24 -0
  25. package/dist/sample/felines/class/cat.class.js.map +1 -0
  26. package/dist/sample/felines/class/feline.class.d.ts +19 -0
  27. package/dist/sample/felines/class/feline.class.js +20 -0
  28. package/dist/sample/felines/class/feline.class.js.map +1 -0
  29. package/dist/sample/felines/class/index.d.ts +5 -0
  30. package/dist/sample/felines/class/index.js +22 -0
  31. package/dist/sample/felines/class/index.js.map +1 -0
  32. package/dist/sample/felines/class/lion.class.d.ts +4 -0
  33. package/dist/sample/felines/class/lion.class.js +8 -0
  34. package/dist/sample/felines/class/lion.class.js.map +1 -0
  35. package/dist/sample/felines/class/message.class.d.ts +7 -0
  36. package/dist/sample/felines/class/message.class.js +28 -0
  37. package/dist/sample/felines/class/message.class.js.map +1 -0
  38. package/dist/sample/felines/class/tiger.class.d.ts +4 -0
  39. package/dist/sample/felines/class/tiger.class.js +8 -0
  40. package/dist/sample/felines/class/tiger.class.js.map +1 -0
  41. package/dist/sample/felines/dto/create-feline.dto.d.ts +4 -0
  42. package/dist/sample/felines/dto/create-feline.dto.js +28 -0
  43. package/dist/sample/felines/dto/create-feline.dto.js.map +1 -0
  44. package/dist/sample/felines/dto/index.d.ts +2 -0
  45. package/dist/sample/felines/dto/index.js +19 -0
  46. package/dist/sample/felines/dto/index.js.map +1 -0
  47. package/dist/sample/felines/dto/journaling-data.dto.d.ts +4 -0
  48. package/dist/sample/felines/dto/journaling-data.dto.js +8 -0
  49. package/dist/sample/felines/dto/journaling-data.dto.js.map +1 -0
  50. package/dist/sample/felines/felines.constants.d.ts +1 -0
  51. package/dist/sample/felines/felines.constants.js +5 -0
  52. package/dist/sample/felines/felines.constants.js.map +1 -0
  53. package/dist/sample/felines/felines.controller.d.ts +15 -0
  54. package/dist/sample/felines/felines.controller.js +101 -0
  55. package/dist/sample/felines/felines.controller.js.map +1 -0
  56. package/dist/sample/felines/felines.gateway.d.ts +16 -0
  57. package/dist/sample/felines/felines.gateway.js +90 -0
  58. package/dist/sample/felines/felines.gateway.js.map +1 -0
  59. package/dist/sample/felines/felines.module.d.ts +2 -0
  60. package/dist/sample/felines/felines.module.js +28 -0
  61. package/dist/sample/felines/felines.module.js.map +1 -0
  62. package/dist/sample/felines/felines.service.d.ts +8 -0
  63. package/dist/sample/felines/felines.service.js +33 -0
  64. package/dist/sample/felines/felines.service.js.map +1 -0
  65. package/dist/sample/felines/rto/feline.rto.d.ts +7 -0
  66. package/dist/sample/felines/rto/feline.rto.js +31 -0
  67. package/dist/sample/felines/rto/feline.rto.js.map +1 -0
  68. package/dist/sample/felines/rto/index.d.ts +1 -0
  69. package/dist/sample/felines/rto/index.js +18 -0
  70. package/dist/sample/felines/rto/index.js.map +1 -0
  71. package/dist/sample/index.d.ts +3 -0
  72. package/dist/sample/index.js +20 -0
  73. package/dist/sample/index.js.map +1 -0
  74. package/dist/sample/main.d.ts +1 -0
  75. package/dist/sample/main.js +30 -0
  76. package/dist/sample/main.js.map +1 -0
  77. package/dist/src/asyncapi-document.builder.d.ts +27 -0
  78. package/dist/src/asyncapi-document.builder.js +110 -0
  79. package/dist/src/asyncapi-document.builder.js.map +1 -0
  80. package/dist/src/asyncapi.constants.d.ts +6 -0
  81. package/dist/src/asyncapi.constants.js +11 -0
  82. package/dist/src/asyncapi.constants.js.map +1 -0
  83. package/dist/src/asyncapi.module.d.ts +8 -0
  84. package/dist/src/asyncapi.module.js +47 -0
  85. package/dist/src/asyncapi.module.js.map +1 -0
  86. package/dist/src/binding/asyncapi.amqp.interfaces.d.ts +38 -0
  87. package/dist/src/binding/asyncapi.amqp.interfaces.js +3 -0
  88. package/dist/src/binding/asyncapi.amqp.interfaces.js.map +1 -0
  89. package/dist/src/binding/asyncapi.kafka.interfaces.d.ts +21 -0
  90. package/dist/src/binding/asyncapi.kafka.interfaces.js +3 -0
  91. package/dist/src/binding/asyncapi.kafka.interfaces.js.map +1 -0
  92. package/dist/src/binding/index.d.ts +2 -0
  93. package/dist/src/binding/index.js +19 -0
  94. package/dist/src/binding/index.js.map +1 -0
  95. package/dist/src/decorators/asyncapi-operation-for-meta-key.decorator.d.ts +2 -0
  96. package/dist/src/decorators/asyncapi-operation-for-meta-key.decorator.js +37 -0
  97. package/dist/src/decorators/asyncapi-operation-for-meta-key.decorator.js.map +1 -0
  98. package/dist/src/decorators/asyncapi-operation.decorator.d.ts +2 -0
  99. package/dist/src/decorators/asyncapi-operation.decorator.js +9 -0
  100. package/dist/src/decorators/asyncapi-operation.decorator.js.map +1 -0
  101. package/dist/src/decorators/asyncapi-pub.decorator.d.ts +2 -0
  102. package/dist/src/decorators/asyncapi-pub.decorator.js +10 -0
  103. package/dist/src/decorators/asyncapi-pub.decorator.js.map +1 -0
  104. package/dist/src/decorators/asyncapi-service.decorator.d.ts +1 -0
  105. package/dist/src/decorators/asyncapi-service.decorator.js +9 -0
  106. package/dist/src/decorators/asyncapi-service.decorator.js.map +1 -0
  107. package/dist/src/decorators/asyncapi-sub.decorator.d.ts +2 -0
  108. package/dist/src/decorators/asyncapi-sub.decorator.js +10 -0
  109. package/dist/src/decorators/asyncapi-sub.decorator.js.map +1 -0
  110. package/dist/src/decorators/index.d.ts +4 -0
  111. package/dist/src/decorators/index.js +21 -0
  112. package/dist/src/decorators/index.js.map +1 -0
  113. package/dist/src/explorers/asyncapi-class.explorer.d.ts +5 -0
  114. package/dist/src/explorers/asyncapi-class.explorer.js +27 -0
  115. package/dist/src/explorers/asyncapi-class.explorer.js.map +1 -0
  116. package/dist/src/explorers/asyncapi-operation.explorer.d.ts +17 -0
  117. package/dist/src/explorers/asyncapi-operation.explorer.js +26 -0
  118. package/dist/src/explorers/asyncapi-operation.explorer.js.map +1 -0
  119. package/dist/src/explorers/index.d.ts +2 -0
  120. package/dist/src/explorers/index.js +19 -0
  121. package/dist/src/explorers/index.js.map +1 -0
  122. package/dist/src/index.d.ts +4 -0
  123. package/dist/src/index.js +21 -0
  124. package/dist/src/index.js.map +1 -0
  125. package/dist/src/interface/asyncapi-common.interfaces.d.ts +126 -0
  126. package/dist/src/interface/asyncapi-common.interfaces.js +3 -0
  127. package/dist/src/interface/asyncapi-common.interfaces.js.map +1 -0
  128. package/dist/src/interface/asyncapi-document-options.interface.d.ts +3 -0
  129. package/dist/src/interface/asyncapi-document-options.interface.js +3 -0
  130. package/dist/src/interface/asyncapi-document-options.interface.js.map +1 -0
  131. package/dist/src/interface/asyncapi-message.interface.d.ts +8 -0
  132. package/dist/src/interface/asyncapi-message.interface.js +3 -0
  133. package/dist/src/interface/asyncapi-message.interface.js.map +1 -0
  134. package/dist/src/interface/asyncapi-operation-headers.interface.d.ts +6 -0
  135. package/dist/src/interface/asyncapi-operation-headers.interface.js +3 -0
  136. package/dist/src/interface/asyncapi-operation-headers.interface.js.map +1 -0
  137. package/dist/src/interface/asyncapi-operation-options-raw.interface.d.ts +21 -0
  138. package/dist/src/interface/asyncapi-operation-options-raw.interface.js +3 -0
  139. package/dist/src/interface/asyncapi-operation-options-raw.interface.js.map +1 -0
  140. package/dist/src/interface/asyncapi-operation-options.interface.d.ts +8 -0
  141. package/dist/src/interface/asyncapi-operation-options.interface.js +3 -0
  142. package/dist/src/interface/asyncapi-operation-options.interface.js.map +1 -0
  143. package/dist/src/interface/asyncapi-operation-payload.interface.d.ts +2 -0
  144. package/dist/src/interface/asyncapi-operation-payload.interface.js +3 -0
  145. package/dist/src/interface/asyncapi-operation-payload.interface.js.map +1 -0
  146. package/dist/src/interface/asyncapi-server.interface.d.ts +10 -0
  147. package/dist/src/interface/asyncapi-server.interface.js +3 -0
  148. package/dist/src/interface/asyncapi-server.interface.js.map +1 -0
  149. package/dist/src/interface/asyncapi-template-options.interface.d.ts +7 -0
  150. package/dist/src/interface/asyncapi-template-options.interface.js +3 -0
  151. package/dist/src/interface/asyncapi-template-options.interface.js.map +1 -0
  152. package/dist/src/interface/denormalized-doc-resolvers.interface.d.ts +6 -0
  153. package/dist/src/interface/denormalized-doc-resolvers.interface.js +3 -0
  154. package/dist/src/interface/denormalized-doc-resolvers.interface.js.map +1 -0
  155. package/dist/src/interface/denormalized-doc.interface.d.ts +10 -0
  156. package/dist/src/interface/denormalized-doc.interface.js +3 -0
  157. package/dist/src/interface/denormalized-doc.interface.js.map +1 -0
  158. package/dist/src/interface/generator-options.interface.d.ts +22 -0
  159. package/dist/src/interface/generator-options.interface.js +3 -0
  160. package/dist/src/interface/generator-options.interface.js.map +1 -0
  161. package/dist/src/interface/index.d.ts +11 -0
  162. package/dist/src/interface/index.js +28 -0
  163. package/dist/src/interface/index.js.map +1 -0
  164. package/dist/src/services/asyncapi.explorer.d.ts +12 -0
  165. package/dist/src/services/asyncapi.explorer.js +69 -0
  166. package/dist/src/services/asyncapi.explorer.js.map +1 -0
  167. package/dist/src/services/asyncapi.generator.d.ts +6 -0
  168. package/dist/src/services/asyncapi.generator.js +68 -0
  169. package/dist/src/services/asyncapi.generator.js.map +1 -0
  170. package/dist/src/services/asyncapi.scanner.d.ts +14 -0
  171. package/dist/src/services/asyncapi.scanner.js +71 -0
  172. package/dist/src/services/asyncapi.scanner.js.map +1 -0
  173. package/dist/src/services/asyncapi.transformer.d.ts +4 -0
  174. package/dist/src/services/asyncapi.transformer.js +33 -0
  175. package/dist/src/services/asyncapi.transformer.js.map +1 -0
  176. package/dist/src/services/index.d.ts +4 -0
  177. package/dist/src/services/index.js +21 -0
  178. package/dist/src/services/index.js.map +1 -0
  179. package/dist/src/services/operation-object.factory.d.ts +9 -0
  180. package/dist/src/services/operation-object.factory.js +37 -0
  181. package/dist/src/services/operation-object.factory.js.map +1 -0
  182. package/dist/test/configs/jest-base.config.d.ts +3 -0
  183. package/dist/test/configs/jest-base.config.js +20 -0
  184. package/dist/test/configs/jest-base.config.js.map +1 -0
  185. package/dist/test/configs/jest-e2e.config.d.ts +3 -0
  186. package/dist/test/configs/jest-e2e.config.js +16 -0
  187. package/dist/test/configs/jest-e2e.config.js.map +1 -0
  188. package/dist/test/express.e2e-spec.d.ts +1 -0
  189. package/dist/test/express.e2e-spec.js +89 -0
  190. package/dist/test/express.e2e-spec.js.map +1 -0
  191. package/dist/test/fastify.e2e-spec.d.ts +1 -0
  192. package/dist/test/fastify.e2e-spec.js +57 -0
  193. package/dist/test/fastify.e2e-spec.js.map +1 -0
  194. package/dist/tsconfig.tsbuildinfo +1 -1
  195. package/misc/references/ref.html +303 -0
  196. package/misc/references/ref.json +1 -0
  197. package/misc/references/ref.yaml +292 -0
  198. package/misc/take-snaphots.sh +8 -0
  199. package/package.json +18 -11
  200. package/sample/app.module.ts +7 -0
  201. package/sample/common.ts +49 -0
  202. package/sample/constants.ts +12 -0
  203. package/sample/felines/class/cat.class.ts +9 -0
  204. package/sample/felines/class/feline.class.ts +29 -0
  205. package/sample/felines/class/index.ts +5 -0
  206. package/sample/felines/class/lion.class.ts +5 -0
  207. package/sample/felines/class/message.class.ts +17 -0
  208. package/sample/felines/class/tiger.class.ts +5 -0
  209. package/sample/felines/dto/create-feline.dto.ts +13 -0
  210. package/sample/felines/dto/index.ts +2 -0
  211. package/sample/felines/dto/journaling-data.dto.ts +5 -0
  212. package/sample/felines/felines.constants.ts +1 -0
  213. package/sample/felines/felines.controller.ts +76 -0
  214. package/sample/felines/felines.gateway.ts +76 -0
  215. package/sample/felines/felines.module.ts +15 -0
  216. package/sample/felines/felines.service.ts +24 -0
  217. package/sample/felines/rto/feline.rto.ts +17 -0
  218. package/sample/felines/rto/index.ts +1 -0
  219. package/sample/index.ts +3 -0
  220. package/sample/main.ts +34 -0
  221. package/src/asyncapi-document.builder.ts +5 -19
  222. package/src/asyncapi.module.ts +5 -16
  223. package/src/decorators/asyncapi-operation-for-meta-key.decorator.ts +4 -16
  224. package/src/decorators/asyncapi-operation.decorator.ts +1 -3
  225. package/src/decorators/asyncapi-pub.decorator.ts +6 -13
  226. package/src/decorators/asyncapi-sub.decorator.ts +6 -13
  227. package/src/explorers/asyncapi-class.explorer.ts +2 -6
  228. package/src/explorers/asyncapi-operation.explorer.ts +3 -12
  229. package/src/interface/asyncapi-common.interfaces.ts +1 -4
  230. package/src/interface/asyncapi-operation-options.interface.ts +2 -4
  231. package/src/interface/asyncapi-operation-payload.interface.ts +1 -5
  232. package/src/interface/asyncapi-server.interface.ts +1 -4
  233. package/src/interface/asyncapi-template-options.interface.ts +5 -5
  234. package/src/interface/denormalized-doc.interface.ts +1 -5
  235. package/src/services/asyncapi.explorer.ts +25 -34
  236. package/src/services/asyncapi.generator.ts +28 -16
  237. package/src/services/asyncapi.scanner.ts +39 -89
  238. package/src/services/asyncapi.transformer.ts +2 -8
  239. package/src/services/index.ts +0 -1
  240. package/test/__mocks__/@asyncapi/generator.js +41 -0
  241. package/test/configs/jest-base.config.ts +19 -0
  242. package/test/configs/jest-e2e.config.js +7 -0
  243. package/test/configs/jest-e2e.config.ts +19 -0
  244. package/test/configs/jest-swagger-plugin.js +16 -0
  245. package/test/express.e2e-spec.ts +64 -0
  246. package/test/fastify.e2e-spec.ts +65 -0
@@ -0,0 +1,65 @@
1
+ import { NestFactory } from '@nestjs/core';
2
+ import { FastifyAdapter, NestFastifyApplication } from '@nestjs/platform-fastify';
3
+ import fs from 'fs/promises';
4
+ import jsyaml from 'js-yaml';
5
+ import request from 'supertest';
6
+ import { AsyncApiModule } from '../src';
7
+ import { AppModule } from '../sample/app.module';
8
+ import { makeAsyncapiDocument } from '../sample/common';
9
+ import { DOC_RELATIVE_PATH } from '../sample/constants';
10
+
11
+ describe('Fastify AsyncAPI', () => {
12
+ let app: NestFastifyApplication;
13
+
14
+ beforeAll(async () => {
15
+ app = await NestFactory.create<NestFastifyApplication>(AppModule, new FastifyAdapter(), { logger: false });
16
+ const asyncapiDocument = await makeAsyncapiDocument(app);
17
+ await AsyncApiModule.setup(DOC_RELATIVE_PATH, app, asyncapiDocument);
18
+
19
+ await app.init();
20
+ await app.getHttpAdapter().getInstance().ready();
21
+ });
22
+
23
+ it('should serve doc html', async () => {
24
+ const { text } = await request(app.getHttpServer())
25
+ .get(DOC_RELATIVE_PATH)
26
+ .expect(200)
27
+ .expect('Content-Type', /text\/html/);
28
+ const htmlSample = await fs.readFile('./misc/references/ref.html', {
29
+ encoding: 'utf8',
30
+ });
31
+ expect(text).toEqual(htmlSample);
32
+ });
33
+
34
+ it('should serve doc json', async () => {
35
+ const { text } = await request(app.getHttpServer())
36
+ .get(`${DOC_RELATIVE_PATH}-json`)
37
+ .expect(200)
38
+ .expect('Content-Type', /application\/json/);
39
+
40
+ const jsonFetched = JSON.parse(text);
41
+ const jsonReferenceSample = JSON.parse(
42
+ await fs.readFile('./misc/references/ref.json', {
43
+ encoding: 'utf8',
44
+ }),
45
+ );
46
+
47
+ expect(jsonFetched).toEqual(jsonReferenceSample);
48
+ });
49
+
50
+ it('should serve doc yaml', async () => {
51
+ const { text } = await request(app.getHttpServer())
52
+ .get(`${DOC_RELATIVE_PATH}-yaml`)
53
+ .expect(200)
54
+ .expect('Content-Type', /text\/yaml/);
55
+
56
+ const yamlFetched = jsyaml.load(text);
57
+ const yamlReferenceSample = jsyaml.load(
58
+ await fs.readFile('./misc/references/ref.yaml', {
59
+ encoding: 'utf8',
60
+ }),
61
+ );
62
+
63
+ expect(yamlFetched).toEqual(yamlReferenceSample);
64
+ });
65
+ });