@api-client/core 0.19.10 → 0.19.12

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 (466) hide show
  1. package/LICENSE.md +9 -63
  2. package/bin/test.ts +1 -12
  3. package/build/src/browser.d.ts +3 -16
  4. package/build/src/browser.d.ts.map +1 -1
  5. package/build/src/browser.js +2 -17
  6. package/build/src/browser.js.map +1 -1
  7. package/build/src/events/EventTypes.d.ts +0 -6
  8. package/build/src/events/EventTypes.d.ts.map +1 -1
  9. package/build/src/events/EventTypes.js +0 -2
  10. package/build/src/events/EventTypes.js.map +1 -1
  11. package/build/src/events/Events.d.ts +0 -2
  12. package/build/src/events/Events.d.ts.map +1 -1
  13. package/build/src/events/Events.js +0 -2
  14. package/build/src/events/Events.js.map +1 -1
  15. package/build/src/index.d.ts +3 -16
  16. package/build/src/index.d.ts.map +1 -1
  17. package/build/src/index.js +2 -17
  18. package/build/src/index.js.map +1 -1
  19. package/build/src/modeling/ApiValidation.d.ts +26 -0
  20. package/build/src/modeling/ApiValidation.d.ts.map +1 -0
  21. package/build/src/modeling/ApiValidation.js +73 -0
  22. package/build/src/modeling/ApiValidation.js.map +1 -0
  23. package/build/src/modeling/Bindings.d.ts +3 -3
  24. package/build/src/modeling/Bindings.d.ts.map +1 -1
  25. package/build/src/modeling/Bindings.js.map +1 -1
  26. package/build/src/modeling/DomainAssociation.d.ts +5 -5
  27. package/build/src/modeling/DomainAssociation.d.ts.map +1 -1
  28. package/build/src/modeling/DomainAssociation.js.map +1 -1
  29. package/build/src/modeling/DomainEntity.d.ts +2 -3
  30. package/build/src/modeling/DomainEntity.d.ts.map +1 -1
  31. package/build/src/modeling/DomainEntity.js +1 -1
  32. package/build/src/modeling/DomainEntity.js.map +1 -1
  33. package/build/src/modeling/DomainProperty.d.ts +2 -3
  34. package/build/src/modeling/DomainProperty.d.ts.map +1 -1
  35. package/build/src/modeling/DomainProperty.js +1 -1
  36. package/build/src/modeling/DomainProperty.js.map +1 -1
  37. package/build/src/modeling/DomainValidation.d.ts +10 -4
  38. package/build/src/modeling/DomainValidation.d.ts.map +1 -1
  39. package/build/src/modeling/DomainValidation.js +55 -72
  40. package/build/src/modeling/DomainValidation.js.map +1 -1
  41. package/build/src/modeling/ai/types.d.ts +2 -2
  42. package/build/src/modeling/ai/types.d.ts.map +1 -1
  43. package/build/src/modeling/ai/types.js.map +1 -1
  44. package/build/src/{amf → modeling/amf}/DataValueGenerator.d.ts +1 -1
  45. package/build/src/modeling/amf/DataValueGenerator.d.ts.map +1 -0
  46. package/build/src/{amf → modeling/amf}/DataValueGenerator.js +2 -3
  47. package/build/src/modeling/amf/DataValueGenerator.js.map +1 -0
  48. package/build/src/modeling/amf/ShapeGenerator.d.ts +20 -20
  49. package/build/src/modeling/amf/ShapeGenerator.d.ts.map +1 -1
  50. package/build/src/modeling/amf/ShapeGenerator.js +16 -18
  51. package/build/src/modeling/amf/ShapeGenerator.js.map +1 -1
  52. package/build/src/modeling/amf/core_types.d.ts +9 -0
  53. package/build/src/modeling/amf/core_types.d.ts.map +1 -0
  54. package/build/src/modeling/amf/core_types.js +45 -0
  55. package/build/src/modeling/amf/core_types.js.map +1 -0
  56. package/build/src/modeling/validation/api_model_rules.d.ts +1 -2
  57. package/build/src/modeling/validation/api_model_rules.d.ts.map +1 -1
  58. package/build/src/modeling/validation/api_model_rules.js +0 -26
  59. package/build/src/modeling/validation/api_model_rules.js.map +1 -1
  60. package/build/src/modeling/validation/association_validation.d.ts +4 -4
  61. package/build/src/modeling/validation/association_validation.d.ts.map +1 -1
  62. package/build/src/modeling/validation/association_validation.js.map +1 -1
  63. package/build/src/modeling/validation/entity_validation.d.ts +6 -6
  64. package/build/src/modeling/validation/entity_validation.d.ts.map +1 -1
  65. package/build/src/modeling/validation/entity_validation.js.map +1 -1
  66. package/build/src/modeling/validation/property_validation.d.ts +3 -3
  67. package/build/src/modeling/validation/property_validation.d.ts.map +1 -1
  68. package/build/src/modeling/validation/property_validation.js.map +1 -1
  69. package/build/src/modeling/validation/rules.d.ts +2 -2
  70. package/build/src/modeling/validation/rules.d.ts.map +1 -1
  71. package/build/src/modeling/validation/rules.js.map +1 -1
  72. package/build/src/modeling/validation/semantic_validation.d.ts +2 -2
  73. package/build/src/modeling/validation/semantic_validation.d.ts.map +1 -1
  74. package/build/src/modeling/validation/semantic_validation.js.map +1 -1
  75. package/build/src/models/http-flows/LegacyTranslator.js +1 -1
  76. package/build/src/models/http-flows/LegacyTranslator.js.map +1 -1
  77. package/build/src/runtime/http-runner/HttpFlows.js +1 -1
  78. package/build/src/runtime/http-runner/HttpFlows.js.map +1 -1
  79. package/build/tsconfig.tsbuildinfo +1 -1
  80. package/eslint.config.js +0 -1
  81. package/package.json +11 -14
  82. package/src/events/EventTypes.ts +0 -2
  83. package/src/events/Events.ts +0 -2
  84. package/src/modeling/ApiValidation.ts +86 -0
  85. package/src/modeling/Bindings.ts +3 -3
  86. package/src/modeling/DomainAssociation.ts +5 -5
  87. package/src/modeling/DomainEntity.ts +3 -4
  88. package/src/modeling/DomainProperty.ts +3 -4
  89. package/src/modeling/DomainValidation.ts +57 -74
  90. package/src/modeling/ai/types.ts +2 -2
  91. package/src/{amf → modeling/amf}/DataValueGenerator.ts +3 -4
  92. package/src/modeling/amf/ShapeGenerator.ts +45 -61
  93. package/src/modeling/amf/core_types.ts +47 -0
  94. package/src/modeling/validation/api_model_rules.ts +1 -31
  95. package/src/modeling/validation/association_validation.ts +6 -6
  96. package/src/modeling/validation/entity_validation.ts +11 -11
  97. package/src/modeling/validation/property_validation.ts +4 -4
  98. package/src/modeling/validation/rules.ts +6 -3
  99. package/src/modeling/validation/semantic_validation.ts +11 -11
  100. package/src/models/http-flows/LegacyTranslator.ts +1 -1
  101. package/src/runtime/http-runner/HttpFlows.ts +1 -1
  102. package/tests/unit/{amf → modeling/amf}/data_value_generator.spec.ts +2 -2
  103. package/tests/unit/modeling/amf/shape_generator.spec.ts +146 -167
  104. package/tests/unit/modeling/domain_asociation.spec.ts +13 -13
  105. package/tests/unit/modeling/domain_validation.spec.ts +7 -13
  106. package/tests/unit/modeling/validation/api_model_rules.spec.ts +11 -9
  107. package/tests/unit/runtime/runners/http_assertion_runner.spec.ts +1 -1
  108. package/tests/unit/runtime/runners/http_flow_runner.spec.ts +1 -1
  109. package/tests/unit/runtime/runners/project_runner.spec.ts +1 -1
  110. package/tests/unit/runtime/runners/request_runner.spec.ts +1 -1
  111. package/tests/unit/runtime/runners/serial_runner.spec.ts +1 -1
  112. package/build/src/amf/AmfMixin.d.ts +0 -396
  113. package/build/src/amf/AmfMixin.d.ts.map +0 -1
  114. package/build/src/amf/AmfMixin.js +0 -1138
  115. package/build/src/amf/AmfMixin.js.map +0 -1
  116. package/build/src/amf/AmfSerializer.d.ts +0 -137
  117. package/build/src/amf/AmfSerializer.d.ts.map +0 -1
  118. package/build/src/amf/AmfSerializer.js +0 -1947
  119. package/build/src/amf/AmfSerializer.js.map +0 -1
  120. package/build/src/amf/AmfTypes.d.ts +0 -25
  121. package/build/src/amf/AmfTypes.d.ts.map +0 -1
  122. package/build/src/amf/AmfTypes.js +0 -143
  123. package/build/src/amf/AmfTypes.js.map +0 -1
  124. package/build/src/amf/ApiExampleGenerator.d.ts +0 -40
  125. package/build/src/amf/ApiExampleGenerator.d.ts.map +0 -1
  126. package/build/src/amf/ApiExampleGenerator.js +0 -112
  127. package/build/src/amf/ApiExampleGenerator.js.map +0 -1
  128. package/build/src/amf/ApiMonacoSchemaGenerator.d.ts +0 -68
  129. package/build/src/amf/ApiMonacoSchemaGenerator.d.ts.map +0 -1
  130. package/build/src/amf/ApiMonacoSchemaGenerator.js +0 -248
  131. package/build/src/amf/ApiMonacoSchemaGenerator.js.map +0 -1
  132. package/build/src/amf/ApiSchemaGenerator.d.ts +0 -56
  133. package/build/src/amf/ApiSchemaGenerator.d.ts.map +0 -1
  134. package/build/src/amf/ApiSchemaGenerator.js +0 -94
  135. package/build/src/amf/ApiSchemaGenerator.js.map +0 -1
  136. package/build/src/amf/ApiSchemaValues.d.ts +0 -111
  137. package/build/src/amf/ApiSchemaValues.d.ts.map +0 -1
  138. package/build/src/amf/ApiSchemaValues.js +0 -463
  139. package/build/src/amf/ApiSchemaValues.js.map +0 -1
  140. package/build/src/amf/DataValueGenerator.d.ts.map +0 -1
  141. package/build/src/amf/DataValueGenerator.js.map +0 -1
  142. package/build/src/amf/Parsing.d.ts +0 -48
  143. package/build/src/amf/Parsing.d.ts.map +0 -1
  144. package/build/src/amf/Parsing.js +0 -2
  145. package/build/src/amf/Parsing.js.map +0 -1
  146. package/build/src/amf/Utils.d.ts +0 -37
  147. package/build/src/amf/Utils.d.ts.map +0 -1
  148. package/build/src/amf/Utils.js +0 -169
  149. package/build/src/amf/Utils.js.map +0 -1
  150. package/build/src/amf/data-node/DataNodeBase.d.ts +0 -34
  151. package/build/src/amf/data-node/DataNodeBase.d.ts.map +0 -1
  152. package/build/src/amf/data-node/DataNodeBase.js +0 -77
  153. package/build/src/amf/data-node/DataNodeBase.js.map +0 -1
  154. package/build/src/amf/data-node/JsonDataNodeGenerator.d.ts +0 -15
  155. package/build/src/amf/data-node/JsonDataNodeGenerator.d.ts.map +0 -1
  156. package/build/src/amf/data-node/JsonDataNodeGenerator.js +0 -23
  157. package/build/src/amf/data-node/JsonDataNodeGenerator.js.map +0 -1
  158. package/build/src/amf/data-node/UrlEncodedDataNodeGenerator.d.ts +0 -14
  159. package/build/src/amf/data-node/UrlEncodedDataNodeGenerator.d.ts.map +0 -1
  160. package/build/src/amf/data-node/UrlEncodedDataNodeGenerator.js +0 -48
  161. package/build/src/amf/data-node/UrlEncodedDataNodeGenerator.js.map +0 -1
  162. package/build/src/amf/data-node/XmlDataNodeGenerator.d.ts +0 -22
  163. package/build/src/amf/data-node/XmlDataNodeGenerator.d.ts.map +0 -1
  164. package/build/src/amf/data-node/XmlDataNodeGenerator.js +0 -34
  165. package/build/src/amf/data-node/XmlDataNodeGenerator.js.map +0 -1
  166. package/build/src/amf/definitions/Amf.d.ts +0 -363
  167. package/build/src/amf/definitions/Amf.d.ts.map +0 -1
  168. package/build/src/amf/definitions/Amf.js +0 -3
  169. package/build/src/amf/definitions/Amf.js.map +0 -1
  170. package/build/src/amf/definitions/Api.d.ts +0 -383
  171. package/build/src/amf/definitions/Api.d.ts.map +0 -1
  172. package/build/src/amf/definitions/Api.js +0 -2
  173. package/build/src/amf/definitions/Api.js.map +0 -1
  174. package/build/src/amf/definitions/Base.d.ts +0 -12
  175. package/build/src/amf/definitions/Base.d.ts.map +0 -1
  176. package/build/src/amf/definitions/Base.js +0 -2
  177. package/build/src/amf/definitions/Base.js.map +0 -1
  178. package/build/src/amf/definitions/Namespace.d.ts +0 -327
  179. package/build/src/amf/definitions/Namespace.d.ts.map +0 -1
  180. package/build/src/amf/definitions/Namespace.js +0 -346
  181. package/build/src/amf/definitions/Namespace.js.map +0 -1
  182. package/build/src/amf/definitions/Shapes.d.ts +0 -312
  183. package/build/src/amf/definitions/Shapes.d.ts.map +0 -1
  184. package/build/src/amf/definitions/Shapes.js +0 -87
  185. package/build/src/amf/definitions/Shapes.js.map +0 -1
  186. package/build/src/amf/models/AmfDataNode.d.ts +0 -67
  187. package/build/src/amf/models/AmfDataNode.d.ts.map +0 -1
  188. package/build/src/amf/models/AmfDataNode.js +0 -192
  189. package/build/src/amf/models/AmfDataNode.js.map +0 -1
  190. package/build/src/amf/shape/ShapeBase.d.ts +0 -74
  191. package/build/src/amf/shape/ShapeBase.d.ts.map +0 -1
  192. package/build/src/amf/shape/ShapeBase.js +0 -93
  193. package/build/src/amf/shape/ShapeBase.js.map +0 -1
  194. package/build/src/amf/shape/ShapeJsonSchemaGenerator.d.ts +0 -47
  195. package/build/src/amf/shape/ShapeJsonSchemaGenerator.d.ts.map +0 -1
  196. package/build/src/amf/shape/ShapeJsonSchemaGenerator.js +0 -420
  197. package/build/src/amf/shape/ShapeJsonSchemaGenerator.js.map +0 -1
  198. package/build/src/amf/shape/ShapeXmlSchemaGenerator.d.ts +0 -85
  199. package/build/src/amf/shape/ShapeXmlSchemaGenerator.d.ts.map +0 -1
  200. package/build/src/amf/shape/ShapeXmlSchemaGenerator.js +0 -852
  201. package/build/src/amf/shape/ShapeXmlSchemaGenerator.js.map +0 -1
  202. package/build/src/events/amf/AmfEventTypes.d.ts +0 -7
  203. package/build/src/events/amf/AmfEventTypes.d.ts.map +0 -1
  204. package/build/src/events/amf/AmfEventTypes.js +0 -7
  205. package/build/src/events/amf/AmfEventTypes.js.map +0 -1
  206. package/build/src/events/amf/AmfEvents.d.ts +0 -34
  207. package/build/src/events/amf/AmfEvents.d.ts.map +0 -1
  208. package/build/src/events/amf/AmfEvents.js +0 -63
  209. package/build/src/events/amf/AmfEvents.js.map +0 -1
  210. package/build/src/mocking/RandExp.d.ts +0 -55
  211. package/build/src/mocking/RandExp.d.ts.map +0 -1
  212. package/build/src/mocking/RandExp.js +0 -302
  213. package/build/src/mocking/RandExp.js.map +0 -1
  214. package/build/src/mocking/lib/ret.d.ts +0 -16
  215. package/build/src/mocking/lib/ret.d.ts.map +0 -1
  216. package/build/src/mocking/lib/ret.js +0 -284
  217. package/build/src/mocking/lib/ret.js.map +0 -1
  218. package/data/apis/APIC-187/APIC-187.raml +0 -21
  219. package/data/apis/APIC-187/dataType.raml +0 -132
  220. package/data/apis/APIC-187/example.raml +0 -84
  221. package/data/apis/APIC-188/APIC-188.raml +0 -21
  222. package/data/apis/APIC-188/dataType.raml +0 -132
  223. package/data/apis/APIC-188/example.raml +0 -84
  224. package/data/apis/APIC-233/APIC-233.raml +0 -15
  225. package/data/apis/APIC-391/APIC-391.raml +0 -44
  226. package/data/apis/APIC-391/examples/post-body-request-example.raml +0 -7
  227. package/data/apis/APIC-483/APIC-483.raml +0 -16
  228. package/data/apis/APIC-483/example/list-of-bank-succ.json +0 -32
  229. package/data/apis/APIC-483/schema/response-retrieve-list-bank.json +0 -68
  230. package/data/apis/APIC-487/APIC-487.raml +0 -36
  231. package/data/apis/APIC-655/APIC-655.raml +0 -44
  232. package/data/apis/APIC-655/delivery.json +0 -12
  233. package/data/apis/APIC-689/APIC-689.raml +0 -20
  234. package/data/apis/APIC-690/APIC-690.raml +0 -17
  235. package/data/apis/APIC-690/datatypes/Address.raml +0 -10
  236. package/data/apis/APIC-690/datatypes/Customer.raml +0 -17
  237. package/data/apis/APIC-690/examples/CustomerExample2.raml +0 -17
  238. package/data/apis/APIC-690/examples/CustomersExample.raml +0 -34
  239. package/data/apis/SE-10469/Purchase-Order-oagis-id-dd32f9c6c01048a19e15c423c9c741ae.json +0 -1383
  240. package/data/apis/SE-10469/SE-10469.raml +0 -11
  241. package/data/apis/SE-13092/Examples/PersonExample.raml +0 -7
  242. package/data/apis/SE-13092/SE-13092.raml +0 -37
  243. package/data/apis/SE-13092/datatypes/Address.raml +0 -5
  244. package/data/apis/SE-13092/datatypes/InlineType.raml +0 -5
  245. package/data/apis/SE-13092/datatypes/Person.raml +0 -15
  246. package/data/apis/SE-22063/SE-22063.raml +0 -14
  247. package/data/apis/SE-22063/stock.raml +0 -41
  248. package/data/apis/amf-helper-api/amf-helper-api.raml +0 -1024
  249. package/data/apis/amf-helper-api/examples/comment-example.json +0 -42
  250. package/data/apis/amf-helper-api/examples/commentCreateRequest-example.json +0 -7
  251. package/data/apis/amf-helper-api/examples/commentList-example.json +0 -48
  252. package/data/apis/amf-helper-api/examples/person.json +0 -14
  253. package/data/apis/amf-helper-api/examples/person.raml +0 -13
  254. package/data/apis/amf-helper-api/examples/person.xml +0 -14
  255. package/data/apis/amf-helper-api/libraries/comment-lib.raml +0 -143
  256. package/data/apis/amf-helper-api/library.raml +0 -7
  257. package/data/apis/amf-helper-api/schemas/person.json +0 -104
  258. package/data/apis/amf-helper-api/schemas/person.xsd +0 -26
  259. package/data/apis/amf-helper-api/traits/file.raml +0 -33
  260. package/data/apis/amf-helper-api/traits/pagination.raml +0 -80
  261. package/data/apis/amf-helper-api/traits/results.raml +0 -19
  262. package/data/apis/amf-helper-api/traits/visibility.raml +0 -14
  263. package/data/apis/amf-helper-api/types/app-person.raml +0 -101
  264. package/data/apis/amf-helper-api/types/dimensions.raml +0 -24
  265. package/data/apis/amf-helper-api/types/external-type.raml +0 -7
  266. package/data/apis/amf-helper-api/types/image.raml +0 -23
  267. package/data/apis/amf-helper-api/types/product.raml +0 -52
  268. package/data/apis/amf-helper-api/types/resource.raml +0 -11
  269. package/data/apis/amf-helper-api/types/standard-request.raml +0 -50
  270. package/data/apis/amf-helper-api/types/user.raml +0 -37
  271. package/data/apis/arc-demo-api/arc-demo-api.raml +0 -468
  272. package/data/apis/arc-demo-api/examples/e400.xml +0 -4
  273. package/data/apis/arc-demo-api/examples/e401.xml +0 -4
  274. package/data/apis/arc-demo-api/examples/e404.xml +0 -4
  275. package/data/apis/arc-demo-api/examples/image.xml +0 -5
  276. package/data/apis/arc-demo-api/examples/messages-example.json +0 -22
  277. package/data/apis/arc-demo-api/examples/messages-sent-example.json +0 -15
  278. package/data/apis/arc-demo-api/examples/person.json +0 -14
  279. package/data/apis/arc-demo-api/examples/person.url.encoded +0 -1
  280. package/data/apis/arc-demo-api/examples/person.xml +0 -14
  281. package/data/apis/arc-demo-api/examples/product.xml +0 -9
  282. package/data/apis/arc-demo-api/library.raml +0 -36
  283. package/data/apis/arc-demo-api/resourceTypes/app-person.raml +0 -49
  284. package/data/apis/arc-demo-api/resourceTypes/example-types.raml +0 -45
  285. package/data/apis/arc-demo-api/resourceTypes/image.raml +0 -23
  286. package/data/apis/arc-demo-api/resourceTypes/message-sent-type.raml +0 -23
  287. package/data/apis/arc-demo-api/resourceTypes/message-type.raml +0 -33
  288. package/data/apis/arc-demo-api/resourceTypes/product.raml +0 -52
  289. package/data/apis/arc-demo-api/resourceTypes/resource.raml +0 -11
  290. package/data/apis/arc-demo-api/schemas/error-response.xsd +0 -11
  291. package/data/apis/arc-demo-api/schemas/image.xsd +0 -11
  292. package/data/apis/arc-demo-api/schemas/person.json +0 -104
  293. package/data/apis/arc-demo-api/schemas/person.xsd +0 -26
  294. package/data/apis/arc-demo-api/schemas/product.xsd +0 -17
  295. package/data/apis/arc-demo-api/securitySchemes/basic.raml +0 -5
  296. package/data/apis/arc-demo-api/securitySchemes/oauth_2_0.raml +0 -29
  297. package/data/apis/arc-demo-api/securitySchemes/x-custom.raml +0 -26
  298. package/data/apis/arc-demo-api/traits/adminable.raml +0 -23
  299. package/data/apis/arc-demo-api/traits/pagination.raml +0 -83
  300. package/data/apis/arc-demo-api/traits/rate-limited.raml +0 -9
  301. package/data/apis/async-api/async-api.yaml +0 -96
  302. package/data/apis/example-generator-api/contact-email-example.raml +0 -6
  303. package/data/apis/example-generator-api/contact-example.raml +0 -5
  304. package/data/apis/example-generator-api/contact-fax-example.raml +0 -5
  305. package/data/apis/example-generator-api/contact-website-example.raml +0 -2
  306. package/data/apis/example-generator-api/example-1.raml +0 -6
  307. package/data/apis/example-generator-api/example-2.raml +0 -9
  308. package/data/apis/example-generator-api/example-3.raml +0 -4
  309. package/data/apis/example-generator-api/example-4.raml +0 -2
  310. package/data/apis/example-generator-api/example-5.raml +0 -4
  311. package/data/apis/example-generator-api/example-6.raml +0 -2
  312. package/data/apis/example-generator-api/example-7.raml +0 -5
  313. package/data/apis/example-generator-api/example-generator-api.raml +0 -423
  314. package/data/apis/example-generator-api/example.json +0 -14
  315. package/data/apis/example-generator-api/example.xml +0 -15
  316. package/data/apis/example-generator-api/example.xsd +0 -26
  317. package/data/apis/example-generator-api/examples/employee.raml +0 -7
  318. package/data/apis/example-generator-api/examples/employees.raml +0 -7
  319. package/data/apis/example-generator-api/linked-named-example.raml +0 -21
  320. package/data/apis/example-generator-api/named-example-with-link.raml +0 -5
  321. package/data/apis/example-generator-api/named-example.raml +0 -9
  322. package/data/apis/example-generator-api/user-json-example.raml +0 -17
  323. package/data/apis/example-generator-api/user-raml-example.raml +0 -37
  324. package/data/apis/example-generator-api/user.json +0 -8
  325. package/data/apis/example-generator-api/user.raml +0 -18
  326. package/data/apis/example-generator-api/users-json-example.raml +0 -17
  327. package/data/apis/example-generator-api/users-raml-example.raml +0 -32
  328. package/data/apis/example-generator-api/users.json +0 -8
  329. package/data/apis/expanded-api/expanded-api.raml +0 -8
  330. package/data/apis/flattened-api/flattened-api.raml +0 -8
  331. package/data/apis/multiple-servers/multiple-servers.yaml +0 -112
  332. package/data/apis/oas-3-api/oas-3-api.yaml +0 -356
  333. package/data/apis/oas-date/oas-date.yaml +0 -28
  334. package/data/apis/oas-types/oas-types.yaml +0 -159
  335. package/data/apis/oas-unions/oas-unions.yaml +0 -75
  336. package/data/apis/petstore/petstore.yaml +0 -954
  337. package/data/apis/raml-date/raml-date.raml +0 -28
  338. package/data/apis/recursive/recursive.raml +0 -14
  339. package/data/apis/schema-api/examples/person.json +0 -14
  340. package/data/apis/schema-api/examples/person.raml +0 -14
  341. package/data/apis/schema-api/examples/person.url.encoded +0 -1
  342. package/data/apis/schema-api/examples/person.xml +0 -14
  343. package/data/apis/schema-api/library/demo-types.raml +0 -43
  344. package/data/apis/schema-api/schema-api.raml +0 -656
  345. package/data/apis/schema-api/schemas/person.json +0 -104
  346. package/data/apis/schema-api/schemas/person.xsd +0 -26
  347. package/data/apis/schema-api/types/DemoPerson.raml +0 -67
  348. package/data/apis/secured-api/oauth-2-custom-settings.raml +0 -143
  349. package/data/apis/secured-api/oauth2-header-delivery.raml +0 -13
  350. package/data/apis/secured-api/oauth2-no-delivery.raml +0 -8
  351. package/data/apis/secured-api/oauth2-no-grants.raml +0 -12
  352. package/data/apis/secured-api/oauth2-pkce.raml +0 -13
  353. package/data/apis/secured-api/oauth2-query-delivery.raml +0 -13
  354. package/data/apis/secured-api/oauth_1_0.raml +0 -8
  355. package/data/apis/secured-api/oauth_1_0_no-settings.raml +0 -3
  356. package/data/apis/secured-api/oauth_1_0_no-signature.raml +0 -7
  357. package/data/apis/secured-api/oauth_1_0_signature.raml +0 -8
  358. package/data/apis/secured-api/passthrough-querystring.raml +0 -16
  359. package/data/apis/secured-api/passthrough.raml +0 -24
  360. package/data/apis/secured-api/secured-api.raml +0 -231
  361. package/data/apis/secured-api/x-custom.raml +0 -33
  362. package/data/apis/secured-api/x-other.raml +0 -29
  363. package/data/apis/secured-api/x-query-string.raml +0 -16
  364. package/data/apis/tracked-examples/datatypes/employee.raml +0 -5
  365. package/data/apis/tracked-examples/examples/employee.raml +0 -4
  366. package/data/apis/tracked-examples/examples/employees.raml +0 -8
  367. package/data/apis/tracked-examples/tracked-to-linked.raml +0 -28
  368. package/data/model.js +0 -129
  369. package/data/models/APIC-187.json +0 -11416
  370. package/data/models/APIC-188.json +0 -11416
  371. package/data/models/APIC-233.json +0 -539
  372. package/data/models/APIC-391.json +0 -1903
  373. package/data/models/APIC-483.json +0 -3110
  374. package/data/models/APIC-487.json +0 -1225
  375. package/data/models/APIC-655.json +0 -3145
  376. package/data/models/APIC-689.json +0 -797
  377. package/data/models/APIC-690.json +0 -5992
  378. package/data/models/SE-10469.json +0 -22898
  379. package/data/models/SE-13092.json +0 -2769
  380. package/data/models/SE-22063.json +0 -2314
  381. package/data/models/amf-helper-api.json +0 -84457
  382. package/data/models/arc-demo-api.json +0 -52041
  383. package/data/models/async-api.json +0 -3227
  384. package/data/models/example-generator-api.json +0 -45209
  385. package/data/models/expanded-api.json +0 -251
  386. package/data/models/flattened-api.json +0 -251
  387. package/data/models/multiple-servers.json +0 -2769
  388. package/data/models/oas-3-api.json +0 -10590
  389. package/data/models/oas-date.json +0 -637
  390. package/data/models/oas-types.json +0 -5352
  391. package/data/models/oas-unions.json +0 -1935
  392. package/data/models/petstore.json +0 -27712
  393. package/data/models/raml-date.json +0 -1114
  394. package/data/models/recursive.json +0 -610
  395. package/data/models/schema-api.json +0 -35527
  396. package/data/models/secured-api.json +0 -21071
  397. package/data/models/tracked-to-linked.json +0 -1914
  398. package/src/amf/AmfMixin.ts +0 -1726
  399. package/src/amf/AmfSerializer.ts +0 -2358
  400. package/src/amf/AmfTypes.ts +0 -147
  401. package/src/amf/ApiExampleGenerator.ts +0 -122
  402. package/src/amf/ApiMonacoSchemaGenerator.ts +0 -332
  403. package/src/amf/ApiSchemaGenerator.ts +0 -115
  404. package/src/amf/ApiSchemaValues.ts +0 -509
  405. package/src/amf/Parsing.ts +0 -50
  406. package/src/amf/Utils.ts +0 -172
  407. package/src/amf/data-node/DataNodeBase.ts +0 -83
  408. package/src/amf/data-node/JsonDataNodeGenerator.ts +0 -24
  409. package/src/amf/data-node/README.md +0 -3
  410. package/src/amf/data-node/UrlEncodedDataNodeGenerator.ts +0 -49
  411. package/src/amf/data-node/XmlDataNodeGenerator.ts +0 -46
  412. package/src/amf/definitions/Amf.ts +0 -440
  413. package/src/amf/definitions/Api.ts +0 -445
  414. package/src/amf/definitions/Base.ts +0 -13
  415. package/src/amf/definitions/Namespace.ts +0 -357
  416. package/src/amf/definitions/Shapes.ts +0 -438
  417. package/src/amf/models/AmfDataNode.ts +0 -210
  418. package/src/amf/shape/README.md +0 -4
  419. package/src/amf/shape/ShapeBase.ts +0 -174
  420. package/src/amf/shape/ShapeJsonSchemaGenerator.ts +0 -457
  421. package/src/amf/shape/ShapeXmlSchemaGenerator.ts +0 -933
  422. package/src/events/amf/AmfEventTypes.ts +0 -6
  423. package/src/events/amf/AmfEvents.ts +0 -78
  424. package/src/mocking/RandExp.ts +0 -335
  425. package/src/mocking/lib/ret.ts +0 -279
  426. package/tests/unit/amf/APIC-187.spec.ts +0 -41
  427. package/tests/unit/amf/APIC-188.spec.ts +0 -30
  428. package/tests/unit/amf/APIC-233.spec.ts +0 -32
  429. package/tests/unit/amf/APIC-391.spec.ts +0 -39
  430. package/tests/unit/amf/APIC-487.spec.ts +0 -44
  431. package/tests/unit/amf/APIC-655.spec.ts +0 -41
  432. package/tests/unit/amf/APIC-689.spec.ts +0 -28
  433. package/tests/unit/amf/APIC-690.spec.ts +0 -93
  434. package/tests/unit/amf/AmfLoader.ts +0 -538
  435. package/tests/unit/amf/AmfMixin.spec.ts +0 -1707
  436. package/tests/unit/amf/ApiExampleGenerator.spec.ts +0 -250
  437. package/tests/unit/amf/ApiMonacoSchemaGenerator.spec.ts +0 -183
  438. package/tests/unit/amf/ApiSchemaValues.spec.ts +0 -602
  439. package/tests/unit/amf/Namepsace.spec.ts +0 -494
  440. package/tests/unit/amf/SE-10469.spec.ts +0 -35
  441. package/tests/unit/amf/SE-13092.spec.ts +0 -64
  442. package/tests/unit/amf/SE-22063.spec.ts +0 -45
  443. package/tests/unit/amf/raml-examples.spec.ts +0 -43
  444. package/tests/unit/amf/schema_gen_array.spec.ts +0 -199
  445. package/tests/unit/amf/schema_gen_oas.spec.ts +0 -140
  446. package/tests/unit/amf/schema_gen_object.spec.ts +0 -279
  447. package/tests/unit/amf/schema_gen_scalar.spec.ts +0 -143
  448. package/tests/unit/amf/schema_gen_union.spec.ts +0 -401
  449. package/tests/unit/amf/schema_gen_unknown.spec.ts +0 -42
  450. package/tests/unit/amf/schema_gen_xml.spec.ts +0 -726
  451. package/tests/unit/amf/serializer/APIC-483.spec.ts +0 -36
  452. package/tests/unit/amf/serializer/Anotations.spec.ts +0 -50
  453. package/tests/unit/amf/serializer/Api.spec.ts +0 -210
  454. package/tests/unit/amf/serializer/Documentation.spec.ts +0 -52
  455. package/tests/unit/amf/serializer/Endpoints.spec.ts +0 -172
  456. package/tests/unit/amf/serializer/Operations.spec.ts +0 -330
  457. package/tests/unit/amf/serializer/Parameters.spec.ts +0 -149
  458. package/tests/unit/amf/serializer/PayloadExamples.spec.ts +0 -152
  459. package/tests/unit/amf/serializer/Security.spec.ts +0 -626
  460. package/tests/unit/amf/serializer/Server.spec.ts +0 -78
  461. package/tests/unit/amf/serializer/Shapes.spec.ts +0 -304
  462. package/tests/unit/amf/serializer/SourceMaps.spec.ts +0 -52
  463. package/tests/unit/amf/shapes/ShapeXmlSchemaGenerator.spec.ts +0 -28
  464. package/tests/unit/amf/tracked-to-linked.spec.ts +0 -90
  465. package/tests/unit/amf/xml-data-processing.spec.ts +0 -217
  466. package/tests/unit/events/amf.spec.ts +0 -151
@@ -1,199 +0,0 @@
1
- import { test } from '@japa/runner'
2
- import { DOMParser } from '@xmldom/xmldom'
3
- import { AmfNamespace as ns } from '../../../src/amf/definitions/Namespace.js'
4
- import { ApiSchemaGenerator, ISchemaExample } from '../../../src/amf/ApiSchemaGenerator.js'
5
- import { AmfLoader } from './AmfLoader.js'
6
- import { IAmfDocument } from '../../../src/amf/definitions/Amf.js'
7
-
8
- const loader = new AmfLoader()
9
- const jsonMime = 'application/json'
10
- const xmlMime = 'application/xml'
11
-
12
- test.group(`array values / ${jsonMime}`, (group) => {
13
- let model: IAmfDocument
14
-
15
- group.setup(async () => {
16
- model = await loader.getGraph('schema-api')
17
- })
18
-
19
- test('generates a valid schema', async ({ assert }) => {
20
- const shape = loader.getShape(model, 'ObjectWithArray')
21
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime)
22
- assert.typeOf(result, 'string', 'is a string')
23
- const parsed = JSON.parse(String(result))
24
- assert.typeOf(parsed, 'object', 'result is an object')
25
- })
26
-
27
- test('has only required fields', async ({ assert }) => {
28
- const shape = loader.getShape(model, 'ObjectWithArray')
29
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime)
30
- assert.typeOf(result, 'string', 'is a string')
31
- const parsed = JSON.parse(String(result))
32
- assert.typeOf(parsed.tags, 'array', 'tags is set')
33
- assert.typeOf(parsed.exampleValue, 'array', 'exampleValue is set')
34
- assert.typeOf(parsed.examplesValue, 'array', 'examplesValue is set')
35
- assert.typeOf(parsed.defaultValue, 'array', 'defaultValue is set')
36
- })
37
-
38
- test('has only default values', async ({ assert }) => {
39
- const shape = loader.getShape(model, 'ObjectWithArray')
40
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime)
41
- assert.typeOf(result, 'string', 'is a string')
42
- const parsed = JSON.parse(String(result))
43
- assert.typeOf(parsed.tags, 'array', 'tags is set')
44
- assert.typeOf(parsed.tags[0], 'string', 'tags have correct type')
45
- assert.typeOf(parsed.exampleValue, 'array', 'exampleValue is set')
46
- assert.typeOf(parsed.exampleValue[0], 'number', 'exampleValue is set')
47
- assert.deepEqual(parsed.defaultValue, ['A tag'], 'defaultValue is set')
48
- })
49
-
50
- test('has default values and examples', async ({ assert }) => {
51
- const shape = loader.getShape(model, 'ObjectWithArray')
52
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime, {
53
- renderExamples: true,
54
- })
55
- assert.typeOf(result, 'string', 'is a string')
56
- const parsed = JSON.parse(String(result))
57
- assert.typeOf(parsed.tags, 'array', 'tags is set')
58
- assert.typeOf(parsed.tags[0], 'string', 'tags have correct type')
59
- assert.deepEqual(parsed.exampleValue, [123], 'exampleValue is set')
60
- assert.deepEqual(parsed.examplesValue, ['value 1'], 'examplesValue is set')
61
- assert.deepEqual(parsed.defaultValue, ['A tag'], 'defaultValue is set')
62
- })
63
-
64
- test('processes object items', async ({ assert }) => {
65
- const shape = loader.getShape(model, 'ObjectWithArrayObject')
66
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime, {
67
- renderExamples: true,
68
- renderMocked: true,
69
- })
70
- assert.typeOf(result, 'string', 'is a string')
71
- const parsed = JSON.parse(String(result))
72
- assert.typeOf(parsed, 'array', 'result is an array')
73
- const [schema] = parsed
74
- assert.isNotEmpty(schema.id, 'sets a string type (id)')
75
- assert.typeOf(schema.id, 'string', 'sets a string type (id)')
76
- assert.strictEqual(schema.name, 'Pawel Uchida-Psztyc', 'sets a string type (name)')
77
- assert.strictEqual(schema.sex, 'male', 'sets a string type (sex)')
78
- assert.strictEqual(schema.tosAccepted, false, 'sets a boolean type from examples')
79
- })
80
-
81
- test('generates the example', async ({ assert }) => {
82
- const shape = loader.getShape(model, 'ObjectWithArray')
83
- const result = ApiSchemaGenerator.asExample(shape, jsonMime) as ISchemaExample
84
- assert.typeOf(result, 'object', 'returns an object')
85
- assert.isTrue(result.strict, 'has the strict property')
86
- assert.deepEqual(result.types, [ns.aml.vocabularies.apiContract.Example], 'has the types property')
87
- assert.equal(result.mediaType, jsonMime, 'has the mediaType property')
88
- assert.typeOf(result.renderValue, 'string', 'has the renderValue')
89
- const parsed = JSON.parse(result.renderValue as string)
90
- assert.typeOf(parsed, 'object', 'result is an object')
91
- })
92
- })
93
-
94
- test.group(`array values / ${xmlMime}`, (group) => {
95
- let model: IAmfDocument
96
-
97
- group.setup(async () => {
98
- model = await loader.getGraph('schema-api')
99
- })
100
- test('has only required fields', async ({ assert }) => {
101
- const shape = loader.getShape(model, 'ObjectWithArray')
102
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
103
- renderMocked: true,
104
- })
105
- const parser = new DOMParser()
106
- const schema = parser.parseFromString(String(result), xmlMime)
107
-
108
- const tags = schema.getElementsByTagName('tags')[0]
109
- assert.ok(tags, 'has array element')
110
- assert.isNotEmpty(tags.textContent!.trim(), 'has auto-generated array item (tags)')
111
-
112
- const exampleValue = schema.getElementsByTagName('exampleValue')[0]
113
- assert.ok(exampleValue, 'has exampleValue array')
114
- // this is a required field with integer value. This automatically adds number value to the schema.
115
- assert.match(exampleValue.textContent!.trim(), /^\d+$/, 'has default generated value (exampleValue)')
116
-
117
- const examplesValue = schema.getElementsByTagName('examplesValue')[0]
118
- assert.ok(examplesValue, 'has examplesValue array')
119
- assert.isNotEmpty(examplesValue.textContent!.trim(), 'has generated array item (examplesValue)')
120
-
121
- const defaultValue = schema.getElementsByTagName('defaultValue')[0]
122
- assert.ok(defaultValue, 'has defaultValue array')
123
- assert.strictEqual(defaultValue.textContent!.trim(), 'A tag', 'has a default value (defaultValue)')
124
- })
125
-
126
- test('has default values, mocked values, and examples', async ({ assert }) => {
127
- const shape = loader.getShape(model, 'ObjectWithArray')
128
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
129
- renderExamples: true,
130
- renderMocked: true,
131
- })
132
- const parser = new DOMParser()
133
- const schema = parser.parseFromString(String(result), xmlMime)
134
-
135
- const tags = schema.getElementsByTagName('tags')[0]
136
- assert.ok(tags, 'has tags array')
137
- assert.isNotEmpty(tags.textContent!.trim(), 'has auto-generated array item (tags)')
138
-
139
- const exampleValue = schema.getElementsByTagName('exampleValue')[0]
140
- assert.ok(exampleValue, 'has exampleValue array')
141
- assert.strictEqual(exampleValue.textContent!.trim(), '123', 'has example value (exampleValue)')
142
-
143
- const examplesValue = schema.getElementsByTagName('examplesValue')
144
- assert.lengthOf(examplesValue, 1, 'has the examplesValue array')
145
- assert.strictEqual(examplesValue[0].textContent!.trim(), 'value 1', 'has example value (examplesValue[0])')
146
- // assert.strictEqual(examplesValue[1].textContent!.trim(), 'value 2', 'has example value (examplesValue[1])');
147
-
148
- const defaultValue = schema.getElementsByTagName('defaultValue')[0]
149
- assert.ok(defaultValue, 'has defaultValue array')
150
- assert.strictEqual(defaultValue.textContent!.trim(), 'A tag', 'has a default value (defaultValue)')
151
- })
152
-
153
- test('processes object items without wrapping', async ({ assert }) => {
154
- const shape = loader.getShape(model, 'ObjectWithArrayObject')
155
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
156
- renderExamples: true,
157
- })
158
- const parser = new DOMParser()
159
- // array items not wrapped comes without parent.
160
- const wrapped = `<parent-wrapper>${result}</parent-wrapper>`
161
- const schema = parser.parseFromString(wrapped, xmlMime)
162
-
163
- const parent = schema.getElementsByTagName('ObjectWithArrayObject')[0]
164
- assert.ok(parent, 'has ObjectWithArrayObject object')
165
-
166
- assert.strictEqual(
167
- schema.getElementsByTagName('name')[0].textContent!.trim(),
168
- 'Pawel Uchida-Psztyc',
169
- 'sets a string type (name)'
170
- )
171
- assert.strictEqual(schema.getElementsByTagName('sex')[0].textContent!.trim(), 'male', 'sets a string type (sex)')
172
- assert.strictEqual(
173
- schema.getElementsByTagName('tosAccepted')[0].textContent!.trim(),
174
- 'false',
175
- 'sets a boolean type from examples'
176
- )
177
- assert.isUndefined(schema.getElementsByTagName('newsletter')[0], 'has no optional value (newsletter)')
178
- assert.isUndefined(schema.getElementsByTagName('age')[0], 'has no optional value (age)')
179
- })
180
-
181
- test('generates the example', async ({ assert }) => {
182
- const shape = loader.getShape(model, 'ObjectWithArray')
183
- const result = ApiSchemaGenerator.asExample(shape, xmlMime, {
184
- renderMocked: true,
185
- }) as ISchemaExample
186
- assert.typeOf(result, 'object', 'returns an object')
187
- assert.isTrue(result.strict, 'has the strict property')
188
- assert.deepEqual(result.types, [ns.aml.vocabularies.apiContract.Example], 'has the types property')
189
- assert.equal(result.mediaType, xmlMime, 'has the mediaType property')
190
- assert.typeOf(result.renderValue, 'string', 'has the renderValue')
191
-
192
- const parser = new DOMParser()
193
- const schema = parser.parseFromString(result.renderValue as string, xmlMime)
194
-
195
- const tags = schema.getElementsByTagName('tags')
196
- assert.lengthOf(tags, 1, 'has only one <tags> element')
197
- assert.isNotEmpty(tags[0].textContent!.trim(), 'has generated array item (tags)')
198
- })
199
- })
@@ -1,140 +0,0 @@
1
- import { test } from '@japa/runner'
2
- import { DOMParser } from '@xmldom/xmldom'
3
- import { ApiSchemaGenerator } from '../../../src/amf/ApiSchemaGenerator.js'
4
- import { AmfLoader } from './AmfLoader.js'
5
- import { IAmfDocument } from '../../../src/amf/definitions/Amf.js'
6
-
7
- const loader = new AmfLoader()
8
- const jsonMime = 'application/json'
9
- const xmlMime = 'application/xml'
10
-
11
- test.group(`OAS union types / ${jsonMime}`, (group) => {
12
- let model: IAmfDocument
13
-
14
- group.setup(async () => {
15
- model = await loader.getGraph('oas-unions')
16
- })
17
- test('generates schema for a oneOf union', async ({ assert }) => {
18
- const shape = loader.getShape(model, 'OneOfSchema')
19
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime, {
20
- renderOptional: true,
21
- renderExamples: true,
22
- renderMocked: true,
23
- }) as string
24
- assert.typeOf(result, 'string', 'is a string')
25
- const value = JSON.parse(result)
26
- assert.typeOf(value.hunts, 'boolean')
27
- assert.typeOf(value.age, 'number')
28
- })
29
-
30
- test('generates schema for a allOf union', async ({ assert }) => {
31
- const shape = loader.getShape(model, 'AllOfSchema')
32
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime, {
33
- renderOptional: true,
34
- renderExamples: true,
35
- renderMocked: true,
36
- }) as string
37
-
38
- assert.typeOf(result, 'string', 'is a string')
39
- const value = JSON.parse(result)
40
- assert.typeOf(value.hunts, 'boolean')
41
- assert.typeOf(value.bark, 'boolean')
42
- assert.typeOf(value.age, 'number')
43
- assert.equal(value.breed, 'Dingo', 'has the example value')
44
- })
45
-
46
- test('generates schema for a anyOf union', async ({ assert }) => {
47
- const shape = loader.getShape(model, 'AnyOfSchema')
48
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime, {
49
- renderOptional: true,
50
- renderExamples: true,
51
- renderMocked: true,
52
- }) as string
53
- assert.typeOf(result, 'string', 'is a string')
54
- const value = JSON.parse(result)
55
- assert.typeOf(value.hunts, 'boolean')
56
- assert.typeOf(value.age, 'number')
57
- })
58
- })
59
-
60
- test.group(`OAS union types / ${xmlMime}`, (group) => {
61
- let model: IAmfDocument
62
-
63
- group.setup(async () => {
64
- model = await loader.getGraph('oas-unions')
65
- })
66
- test('generates schema for a oneOf union', async ({ assert }) => {
67
- const shape = loader.getShape(model, 'OneOfSchema')
68
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
69
- renderExamples: true,
70
- renderMocked: true,
71
- renderOptional: true,
72
- }) as string
73
- assert.typeOf(result, 'string', 'generates a string')
74
- assert.isNotEmpty(result, 'generates a value')
75
-
76
- const parser = new DOMParser()
77
- const schema = parser.parseFromString(result, xmlMime)
78
-
79
- const root = schema.getElementsByTagName('Cat')[0]
80
- assert.ok(root, 'has the Cat parent')
81
- const hunts = root.getElementsByTagName('hunts')[0]
82
- assert.ok(hunts, 'has the hunts node')
83
- assert.match(hunts.textContent!.trim(), /true|false/, 'hunts node has a generated value')
84
- const age = root.getElementsByTagName('age')[0]
85
- assert.ok(age, 'has the age node')
86
- assert.match(age.textContent!.trim(), /\d+/, 'age node has a generated value')
87
- })
88
-
89
- test('generates schema for a allOf union', async ({ assert }) => {
90
- const shape = loader.getShape(model, 'AllOfSchema')
91
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
92
- renderExamples: true,
93
- renderMocked: true,
94
- renderOptional: true,
95
- }) as string
96
- assert.typeOf(result, 'string', 'generates a string')
97
- assert.isNotEmpty(result, 'generates a value')
98
-
99
- const parser = new DOMParser()
100
- const schema = parser.parseFromString(result, xmlMime)
101
-
102
- const root = schema.getElementsByTagName('AllOfSchema')[0]
103
- assert.ok(root, 'has the AllOfSchema parent')
104
- const hunts = root.getElementsByTagName('hunts')[0]
105
- assert.ok(hunts, 'has the hunts node')
106
- assert.match(hunts.textContent!.trim(), /true|false/, 'hunts node has a generated value')
107
- const age = root.getElementsByTagName('age')[0]
108
- assert.ok(age, 'has the age node')
109
- assert.match(age.textContent!.trim(), /\d+/, 'age node has a generated value')
110
- const bark = root.getElementsByTagName('bark')[0]
111
- assert.ok(bark, 'has the bark node')
112
- assert.match(bark.textContent!.trim(), /true|false/, 'bark node has a generated value')
113
- const breed = root.getElementsByTagName('breed')[0]
114
- assert.ok(breed, 'has the breed node')
115
- assert.equal(breed.textContent!.trim(), 'Dingo', 'breed node has the example value')
116
- })
117
-
118
- test('generates schema for a anyOf union', async ({ assert }) => {
119
- const shape = loader.getShape(model, 'AnyOfSchema')
120
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
121
- renderExamples: true,
122
- renderMocked: true,
123
- renderOptional: true,
124
- }) as string
125
- assert.typeOf(result, 'string', 'generates a string')
126
- assert.isNotEmpty(result, 'generates a value')
127
-
128
- const parser = new DOMParser()
129
- const schema = parser.parseFromString(result, xmlMime)
130
-
131
- const root = schema.getElementsByTagName('Cat')[0]
132
- assert.ok(root, 'has the Cat parent')
133
- const hunts = root.getElementsByTagName('hunts')[0]
134
- assert.ok(hunts, 'has the hunts node')
135
- assert.match(hunts.textContent!.trim(), /true|false/, 'hunts node has a generated value')
136
- const age = root.getElementsByTagName('age')[0]
137
- assert.ok(age, 'has the age node')
138
- assert.match(age.textContent!.trim(), /\d+/, 'age node has a generated value')
139
- })
140
- })
@@ -1,279 +0,0 @@
1
- import { test } from '@japa/runner'
2
- import { DOMParser } from '@xmldom/xmldom'
3
- import { AmfNamespace as ns } from '../../../src/amf/definitions/Namespace.js'
4
- import { ApiSchemaGenerator, ISchemaExample } from '../../../src/amf/ApiSchemaGenerator.js'
5
- import { AmfLoader } from './AmfLoader.js'
6
- import { IAmfDocument } from '../../../src/amf/definitions/Amf.js'
7
-
8
- const loader = new AmfLoader()
9
- const jsonMime = 'application/json'
10
- const xmlMime = 'application/xml'
11
-
12
- test.group(`object values / ${jsonMime}`, (group) => {
13
- let model: IAmfDocument
14
-
15
- group.setup(async () => {
16
- model = await loader.getGraph('schema-api')
17
- })
18
-
19
- test('generates a schema for a simple object', async ({ assert }) => {
20
- const shape = loader.getShape(model, 'SimpleObject')
21
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime)
22
- assert.typeOf(result, 'string', 'is a string')
23
- const parsed = JSON.parse(String(result))
24
- assert.typeOf(parsed, 'object', 'represents an object')
25
- ;['id', 'name', 'sex', 'tosAccepted'].forEach((key) => assert.isDefined(parsed[key], `${key} property is set`))
26
- })
27
-
28
- test('has only required fields with default values or enums', async ({ assert }) => {
29
- const shape = loader.getShape(model, 'SimpleObject')
30
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime)
31
- assert.typeOf(result, 'string', 'is a string')
32
- const schema = JSON.parse(String(result))
33
-
34
- assert.typeOf(schema.id, 'string', 'sets a string type (id)')
35
- assert.typeOf(schema.name, 'string', 'sets a string type (name)')
36
- assert.strictEqual(schema.sex, 'male', 'sets a string type (sex)')
37
- assert.strictEqual(schema.tosAccepted, false, 'sets a boolean type from examples')
38
- assert.isUndefined(schema.newsletter, 'sets a boolean type from examples')
39
- assert.isUndefined(schema.age, 'sets a boolean type from examples')
40
- })
41
-
42
- test('has default values and examples', async ({ assert }) => {
43
- const shape = loader.getShape(model, 'SimpleObject')
44
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime, {
45
- renderExamples: true,
46
- })
47
- const schema = JSON.parse(String(result))
48
- assert.strictEqual(schema.name, 'Pawel Uchida-Psztyc', 'sets a string type (name)')
49
- assert.strictEqual(schema.sex, 'male', 'sets a string type (sex)')
50
- assert.strictEqual(schema.tosAccepted, false, 'sets a boolean type from examples')
51
- })
52
-
53
- test('has default values and examples with optional', async ({ assert }) => {
54
- const shape = loader.getShape(model, 'SimpleObject')
55
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime, {
56
- renderOptional: true,
57
- renderExamples: true,
58
- })
59
- const schema = JSON.parse(String(result))
60
-
61
- assert.strictEqual(schema.name, 'Pawel Uchida-Psztyc', 'sets a string type (name)')
62
- assert.strictEqual(schema.sex, 'male', 'sets a string type (sex)')
63
- assert.typeOf(schema.tosAccepted, 'boolean', 'sets a boolean type from examples')
64
- assert.strictEqual(schema.age, 21, 'has the age property')
65
- assert.typeOf(schema.newsletter, 'boolean', 'has the newsletter property')
66
- })
67
-
68
- test('gets the parent properties', async ({ assert }) => {
69
- const shape = loader.getShape(model, 'ObjectWithParent')
70
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime, {
71
- renderOptional: true,
72
- renderExamples: true,
73
- renderMocked: true,
74
- })
75
- const parsed = JSON.parse(String(result))
76
- assert.strictEqual(parsed.name, 'Pawel Uchida-Psztyc', 'has parent name')
77
- assert.strictEqual(parsed.age, 25, 'has child age')
78
- assert.typeOf(parsed.newsletter, 'boolean', 'has parent newsletter')
79
- assert.typeOf(parsed.tosAccepted, 'boolean', 'has parent tosAccepted')
80
- assert.match(parsed.addedProperty, /^[0-9]{2}:[0-9]{2}:[0-9]{2}$/, 'has child addedProperty')
81
- })
82
-
83
- test('renders object example value', async ({ assert }) => {
84
- const shape = loader.getShape(model, 'ObjectWithExample')
85
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime, {
86
- renderOptional: false,
87
- renderExamples: true,
88
- })
89
- const parsed = JSON.parse(String(result))
90
- assert.strictEqual(parsed.error, true, 'has schema.error')
91
- assert.strictEqual(parsed.message, 'Error message', 'has schema.message')
92
- assert.isUndefined(parsed.optional, 'has no optional property')
93
- })
94
-
95
- test('renders object with multiple level parents', async ({ assert }) => {
96
- const shape = loader.getShape(model, 'ChildLvl2')
97
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime)
98
- const parsed = JSON.parse(String(result))
99
- assert.typeOf(parsed.id, 'string', 'has top most property')
100
- assert.typeOf(parsed.ch1, 'boolean', 'has parent property')
101
- assert.typeOf(parsed.ch2, 'string', 'has own property')
102
- })
103
-
104
- test('generates the example', async ({ assert }) => {
105
- const shape = loader.getShape(model, 'SimpleObject')
106
- const result = ApiSchemaGenerator.asExample(shape, jsonMime) as ISchemaExample
107
- assert.typeOf(result, 'object', 'returns an object')
108
- assert.isTrue(result.strict, 'has the strict property')
109
- assert.deepEqual(result.types, [ns.aml.vocabularies.apiContract.Example], 'has the types property')
110
- assert.equal(result.mediaType, jsonMime, 'has the mediaType property')
111
- assert.typeOf(result.renderValue, 'string', 'has the renderValue')
112
- const parsed = JSON.parse(result.renderValue as string)
113
- assert.typeOf(parsed, 'object', 'represents an object')
114
- })
115
- })
116
-
117
- test.group(`object values / ${xmlMime}`, (group) => {
118
- let model: IAmfDocument
119
-
120
- group.setup(async () => {
121
- model = await loader.getGraph('schema-api')
122
- })
123
-
124
- test('has only required fields with default values or enums', async ({ assert }) => {
125
- const shape = loader.getShape(model, 'SimpleObject')
126
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
127
- renderMocked: true,
128
- })
129
- assert.typeOf(result, 'string', 'is a string')
130
- const parser = new DOMParser()
131
- const schema = parser.parseFromString(String(result), xmlMime)
132
-
133
- assert.ok(schema.getElementsByTagName('id')[0], 'sets a string type (id)')
134
- assert.ok(schema.getElementsByTagName('name')[0], 'has the name')
135
- assert.isNotEmpty(schema.getElementsByTagName('name')[0].textContent!.trim(), 'sets a string type (name)')
136
- assert.strictEqual(schema.getElementsByTagName('sex')[0].textContent!.trim(), 'male', 'sets a string type (sex)')
137
- assert.strictEqual(
138
- schema.getElementsByTagName('tosAccepted')[0].textContent!.trim(),
139
- 'false',
140
- 'sets a boolean type from examples'
141
- )
142
- assert.isUndefined(schema.getElementsByTagName('newsletter')[0], 'has no optional value (newsletter)')
143
- assert.isUndefined(schema.getElementsByTagName('age')[0], 'has no optional value (age)')
144
- })
145
-
146
- test('has default values and examples', async ({ assert }) => {
147
- const shape = loader.getShape(model, 'SimpleObject')
148
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
149
- renderExamples: true,
150
- })
151
- const parser = new DOMParser()
152
- const schema = parser.parseFromString(String(result), xmlMime)
153
-
154
- assert.strictEqual(
155
- schema.getElementsByTagName('name')[0].textContent!.trim(),
156
- 'Pawel Uchida-Psztyc',
157
- 'sets a string type (name)'
158
- )
159
- assert.strictEqual(schema.getElementsByTagName('sex')[0].textContent!.trim(), 'male', 'sets a string type (sex)')
160
- assert.strictEqual(
161
- schema.getElementsByTagName('tosAccepted')[0].textContent!.trim(),
162
- 'false',
163
- 'sets a boolean type from examples'
164
- )
165
- assert.isUndefined(schema.getElementsByTagName('newsletter')[0], 'has no optional value (newsletter)')
166
- assert.isUndefined(schema.getElementsByTagName('age')[0], 'has no optional value (age)')
167
- })
168
-
169
- test('has default values and examples with optional', async ({ assert }) => {
170
- const shape = loader.getShape(model, 'SimpleObject')
171
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
172
- renderOptional: true,
173
- renderExamples: true,
174
- })
175
- const parser = new DOMParser()
176
- const schema = parser.parseFromString(String(result), xmlMime)
177
-
178
- assert.strictEqual(
179
- schema.getElementsByTagName('name')[0].textContent!.trim(),
180
- 'Pawel Uchida-Psztyc',
181
- 'sets a string type (name)'
182
- )
183
- assert.strictEqual(schema.getElementsByTagName('sex')[0].textContent!.trim(), 'male', 'sets a string type (sex)')
184
- assert.strictEqual(
185
- schema.getElementsByTagName('tosAccepted')[0].textContent!.trim(),
186
- 'false',
187
- 'sets a boolean type from examples'
188
- )
189
- assert.strictEqual(schema.getElementsByTagName('age')[0].textContent!.trim(), '21', 'has the age property')
190
- assert.match(
191
- schema.getElementsByTagName('newsletter')[0].textContent!.trim(),
192
- /false|true/,
193
- 'has the newsletter property'
194
- )
195
- })
196
-
197
- test('gets the parent properties', async ({ assert }) => {
198
- const shape = loader.getShape(model, 'ObjectWithParent')
199
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
200
- renderOptional: true,
201
- renderExamples: true,
202
- renderMocked: true,
203
- })
204
- const parser = new DOMParser()
205
- const schema = parser.parseFromString(String(result), xmlMime)
206
-
207
- assert.strictEqual(
208
- schema.getElementsByTagName('name')[0].textContent!.trim(),
209
- 'Pawel Uchida-Psztyc',
210
- 'sets a string type (name)'
211
- )
212
- assert.strictEqual(schema.getElementsByTagName('sex')[0].textContent!.trim(), 'male', 'sets a string type (sex)')
213
- assert.strictEqual(
214
- schema.getElementsByTagName('tosAccepted')[0].textContent!.trim(),
215
- 'false',
216
- 'sets a boolean type from examples'
217
- )
218
- assert.strictEqual(schema.getElementsByTagName('age')[0].textContent!.trim(), '25', 'has the age property')
219
- assert.match(
220
- schema.getElementsByTagName('newsletter')[0].textContent!.trim(),
221
- /false|true/,
222
- 'has the newsletter property'
223
- )
224
- const addedProperty = schema.getElementsByTagName('addedProperty')[0].textContent!.trim()
225
- assert.match(addedProperty, /^[0-9]{2}:[0-9]{2}:[0-9]{2}$/, 'has child addedProperty')
226
- })
227
-
228
- test('renders object example value', async ({ assert }) => {
229
- const shape = loader.getShape(model, 'ObjectWithExample')
230
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
231
- renderOptional: false,
232
- renderExamples: true,
233
- })
234
- const parser = new DOMParser()
235
- const schema = parser.parseFromString(String(result), xmlMime)
236
-
237
- const root = schema.getElementsByTagName('ObjectWithExample')[0]
238
- assert.ok(root, 'has the root node')
239
- assert.strictEqual(root.getElementsByTagName('error')[0].textContent!.trim(), 'true', 'has schema.error')
240
- assert.strictEqual(
241
- root.getElementsByTagName('message')[0].textContent!.trim(),
242
- 'Error message',
243
- 'has schema.message'
244
- )
245
- assert.notOk(root.getElementsByTagName('optional')[0], 'has no optional property')
246
- })
247
-
248
- test('renders object with multiple level parents', async ({ assert }) => {
249
- const shape = loader.getShape(model, 'ChildLvl2')
250
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
251
- renderMocked: true,
252
- })
253
- const parser = new DOMParser()
254
- const schema = parser.parseFromString(String(result), xmlMime)
255
-
256
- const root = schema.getElementsByTagName('ChildLvl2')[0]
257
- assert.ok(root, 'has the root node')
258
- assert.isNotEmpty(root.getElementsByTagName('ch2')[0].textContent!.trim(), 'has own property')
259
- assert.match(root.getElementsByTagName('ch1')[0].textContent!.trim(), /false|true/, 'has parent property')
260
- assert.isNotEmpty(root.getElementsByTagName('id')[0].textContent!.trim(), 'has top most property')
261
- })
262
-
263
- test('generates the example', async ({ assert }) => {
264
- const shape = loader.getShape(model, 'SimpleObject')
265
- const result = ApiSchemaGenerator.asExample(shape, xmlMime) as ISchemaExample
266
- assert.typeOf(result, 'object', 'returns an object')
267
- assert.isTrue(result.strict, 'has the strict property')
268
- assert.deepEqual(result.types, [ns.aml.vocabularies.apiContract.Example], 'has the types property')
269
- assert.equal(result.mediaType, xmlMime, 'has the mediaType property')
270
- assert.typeOf(result.renderValue, 'string', 'has the renderValue')
271
- const parser = new DOMParser()
272
- const schema = parser.parseFromString(result.renderValue as string, xmlMime)
273
- assert.strictEqual(
274
- schema.getElementsByTagName('tosAccepted')[0].textContent!.trim(),
275
- 'false',
276
- 'sets a boolean type from examples'
277
- )
278
- })
279
- })