@api-client/core 0.19.9 → 0.19.11

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 (523) hide show
  1. package/LICENSE.md +9 -63
  2. package/Testing.md +1 -1
  3. package/bin/test.ts +1 -12
  4. package/build/src/browser.d.ts +0 -15
  5. package/build/src/browser.d.ts.map +1 -1
  6. package/build/src/browser.js +0 -17
  7. package/build/src/browser.js.map +1 -1
  8. package/build/src/decorators/observed.d.ts.map +1 -1
  9. package/build/src/decorators/observed.js +91 -0
  10. package/build/src/decorators/observed.js.map +1 -1
  11. package/build/src/events/EventTypes.d.ts +0 -6
  12. package/build/src/events/EventTypes.d.ts.map +1 -1
  13. package/build/src/events/EventTypes.js +0 -2
  14. package/build/src/events/EventTypes.js.map +1 -1
  15. package/build/src/events/Events.d.ts +0 -2
  16. package/build/src/events/Events.d.ts.map +1 -1
  17. package/build/src/events/Events.js +0 -2
  18. package/build/src/events/Events.js.map +1 -1
  19. package/build/src/index.d.ts +0 -15
  20. package/build/src/index.d.ts.map +1 -1
  21. package/build/src/index.js +0 -17
  22. package/build/src/index.js.map +1 -1
  23. package/build/src/modeling/ApiModel.d.ts +21 -7
  24. package/build/src/modeling/ApiModel.d.ts.map +1 -1
  25. package/build/src/modeling/ApiModel.js +70 -29
  26. package/build/src/modeling/ApiModel.js.map +1 -1
  27. package/build/src/modeling/Bindings.d.ts +3 -3
  28. package/build/src/modeling/Bindings.d.ts.map +1 -1
  29. package/build/src/modeling/Bindings.js.map +1 -1
  30. package/build/src/modeling/DomainAssociation.d.ts +5 -5
  31. package/build/src/modeling/DomainAssociation.d.ts.map +1 -1
  32. package/build/src/modeling/DomainAssociation.js.map +1 -1
  33. package/build/src/modeling/DomainEntity.d.ts +2 -3
  34. package/build/src/modeling/DomainEntity.d.ts.map +1 -1
  35. package/build/src/modeling/DomainEntity.js +1 -1
  36. package/build/src/modeling/DomainEntity.js.map +1 -1
  37. package/build/src/modeling/DomainProperty.d.ts +2 -3
  38. package/build/src/modeling/DomainProperty.d.ts.map +1 -1
  39. package/build/src/modeling/DomainProperty.js +1 -1
  40. package/build/src/modeling/DomainProperty.js.map +1 -1
  41. package/build/src/modeling/DomainValidation.d.ts +1 -1
  42. package/build/src/modeling/DomainValidation.d.ts.map +1 -1
  43. package/build/src/modeling/DomainValidation.js.map +1 -1
  44. package/build/src/modeling/ExposedEntity.d.ts +14 -0
  45. package/build/src/modeling/ExposedEntity.d.ts.map +1 -1
  46. package/build/src/modeling/ExposedEntity.js +59 -6
  47. package/build/src/modeling/ExposedEntity.js.map +1 -1
  48. package/build/src/modeling/actions/Action.d.ts +11 -1
  49. package/build/src/modeling/actions/Action.d.ts.map +1 -1
  50. package/build/src/modeling/actions/Action.js +21 -3
  51. package/build/src/modeling/actions/Action.js.map +1 -1
  52. package/build/src/modeling/actions/CreateAction.d.ts +2 -1
  53. package/build/src/modeling/actions/CreateAction.d.ts.map +1 -1
  54. package/build/src/modeling/actions/CreateAction.js +2 -2
  55. package/build/src/modeling/actions/CreateAction.js.map +1 -1
  56. package/build/src/modeling/actions/DeleteAction.d.ts +2 -1
  57. package/build/src/modeling/actions/DeleteAction.d.ts.map +1 -1
  58. package/build/src/modeling/actions/DeleteAction.js +2 -2
  59. package/build/src/modeling/actions/DeleteAction.js.map +1 -1
  60. package/build/src/modeling/actions/ListAction.d.ts +2 -1
  61. package/build/src/modeling/actions/ListAction.d.ts.map +1 -1
  62. package/build/src/modeling/actions/ListAction.js +2 -2
  63. package/build/src/modeling/actions/ListAction.js.map +1 -1
  64. package/build/src/modeling/actions/ReadAction.d.ts +2 -1
  65. package/build/src/modeling/actions/ReadAction.d.ts.map +1 -1
  66. package/build/src/modeling/actions/ReadAction.js +2 -2
  67. package/build/src/modeling/actions/ReadAction.js.map +1 -1
  68. package/build/src/modeling/actions/SearchAction.d.ts +2 -1
  69. package/build/src/modeling/actions/SearchAction.d.ts.map +1 -1
  70. package/build/src/modeling/actions/SearchAction.js +2 -2
  71. package/build/src/modeling/actions/SearchAction.js.map +1 -1
  72. package/build/src/modeling/actions/UpdateAction.d.ts +2 -1
  73. package/build/src/modeling/actions/UpdateAction.d.ts.map +1 -1
  74. package/build/src/modeling/actions/UpdateAction.js +2 -2
  75. package/build/src/modeling/actions/UpdateAction.js.map +1 -1
  76. package/build/src/modeling/actions/index.d.ts +2 -1
  77. package/build/src/modeling/actions/index.d.ts.map +1 -1
  78. package/build/src/modeling/actions/index.js +7 -7
  79. package/build/src/modeling/actions/index.js.map +1 -1
  80. package/build/src/modeling/ai/types.d.ts +2 -2
  81. package/build/src/modeling/ai/types.d.ts.map +1 -1
  82. package/build/src/modeling/ai/types.js.map +1 -1
  83. package/build/src/{amf → modeling/amf}/DataValueGenerator.d.ts +1 -1
  84. package/build/src/modeling/amf/DataValueGenerator.d.ts.map +1 -0
  85. package/build/src/{amf → modeling/amf}/DataValueGenerator.js +2 -3
  86. package/build/src/modeling/amf/DataValueGenerator.js.map +1 -0
  87. package/build/src/modeling/amf/ShapeGenerator.d.ts +20 -20
  88. package/build/src/modeling/amf/ShapeGenerator.d.ts.map +1 -1
  89. package/build/src/modeling/amf/ShapeGenerator.js +16 -18
  90. package/build/src/modeling/amf/ShapeGenerator.js.map +1 -1
  91. package/build/src/modeling/amf/core_types.d.ts +9 -0
  92. package/build/src/modeling/amf/core_types.d.ts.map +1 -0
  93. package/build/src/modeling/amf/core_types.js +45 -0
  94. package/build/src/modeling/amf/core_types.js.map +1 -0
  95. package/build/src/modeling/index.d.ts +1 -0
  96. package/build/src/modeling/index.d.ts.map +1 -1
  97. package/build/src/modeling/index.js +1 -0
  98. package/build/src/modeling/index.js.map +1 -1
  99. package/build/src/modeling/types.d.ts +67 -0
  100. package/build/src/modeling/types.d.ts.map +1 -1
  101. package/build/src/modeling/types.js.map +1 -1
  102. package/build/src/modeling/validation/api_model_rules.d.ts +15 -0
  103. package/build/src/modeling/validation/api_model_rules.d.ts.map +1 -0
  104. package/build/src/modeling/validation/api_model_rules.js +599 -0
  105. package/build/src/modeling/validation/api_model_rules.js.map +1 -0
  106. package/build/src/modeling/validation/association_validation.d.ts.map +1 -1
  107. package/build/src/modeling/validation/association_validation.js +1 -3
  108. package/build/src/modeling/validation/association_validation.js.map +1 -1
  109. package/build/src/models/http-flows/LegacyTranslator.js +1 -1
  110. package/build/src/models/http-flows/LegacyTranslator.js.map +1 -1
  111. package/build/src/runtime/http-runner/HttpFlows.js +1 -1
  112. package/build/src/runtime/http-runner/HttpFlows.js.map +1 -1
  113. package/build/tsconfig.tsbuildinfo +1 -1
  114. package/eslint.config.js +0 -2
  115. package/package.json +27 -135
  116. package/src/decorators/observed.ts +91 -0
  117. package/src/events/EventTypes.ts +0 -2
  118. package/src/events/Events.ts +0 -2
  119. package/src/modeling/ApiModel.ts +73 -33
  120. package/src/modeling/Bindings.ts +3 -3
  121. package/src/modeling/DomainAssociation.ts +5 -5
  122. package/src/modeling/DomainEntity.ts +3 -4
  123. package/src/modeling/DomainProperty.ts +3 -4
  124. package/src/modeling/DomainValidation.ts +1 -1
  125. package/src/modeling/ExposedEntity.ts +63 -9
  126. package/src/modeling/actions/Action.ts +25 -2
  127. package/src/modeling/actions/CreateAction.ts +3 -2
  128. package/src/modeling/actions/DeleteAction.ts +3 -2
  129. package/src/modeling/actions/ListAction.ts +3 -2
  130. package/src/modeling/actions/ReadAction.ts +3 -2
  131. package/src/modeling/actions/SearchAction.ts +3 -2
  132. package/src/modeling/actions/UpdateAction.ts +3 -2
  133. package/src/modeling/ai/types.ts +2 -2
  134. package/src/{amf → modeling/amf}/DataValueGenerator.ts +3 -4
  135. package/src/modeling/amf/ShapeGenerator.ts +45 -61
  136. package/src/modeling/amf/core_types.ts +47 -0
  137. package/src/modeling/types.ts +70 -0
  138. package/src/modeling/validation/api_model_rules.ts +640 -0
  139. package/src/modeling/validation/api_model_validation_rules.md +58 -0
  140. package/src/modeling/validation/association_validation.ts +1 -3
  141. package/src/models/http-flows/LegacyTranslator.ts +1 -1
  142. package/src/runtime/http-runner/HttpFlows.ts +1 -1
  143. package/tests/unit/modeling/actions/Action.spec.ts +40 -8
  144. package/tests/unit/modeling/actions/CreateAction.spec.ts +5 -5
  145. package/tests/unit/modeling/actions/DeleteAction.spec.ts +6 -6
  146. package/tests/unit/modeling/actions/ListAction.spec.ts +7 -7
  147. package/tests/unit/modeling/actions/ReadAction.spec.ts +6 -6
  148. package/tests/unit/modeling/actions/SearchAction.spec.ts +6 -6
  149. package/tests/unit/modeling/actions/UpdateAction.spec.ts +6 -6
  150. package/tests/unit/{amf → modeling/amf}/data_value_generator.spec.ts +2 -2
  151. package/tests/unit/modeling/amf/shape_generator.spec.ts +146 -167
  152. package/tests/unit/modeling/api_model.spec.ts +190 -13
  153. package/tests/unit/modeling/api_model_expose_entity.spec.ts +43 -19
  154. package/tests/unit/modeling/api_model_remove_entity.spec.ts +6 -6
  155. package/tests/unit/modeling/domain_asociation.spec.ts +13 -13
  156. package/tests/unit/modeling/exposed_entity.spec.ts +123 -3
  157. package/tests/unit/modeling/exposed_entity_actions.spec.ts +41 -18
  158. package/tests/unit/modeling/exposed_entity_setter_validation.spec.ts +1 -1
  159. package/tests/unit/modeling/rules/restoring_rules.spec.ts +9 -5
  160. package/tests/unit/modeling/validation/api_model_rules.spec.ts +324 -0
  161. package/tests/unit/runtime/runners/http_assertion_runner.spec.ts +1 -1
  162. package/tests/unit/runtime/runners/http_flow_runner.spec.ts +1 -1
  163. package/tests/unit/runtime/runners/project_runner.spec.ts +1 -1
  164. package/tests/unit/runtime/runners/request_runner.spec.ts +1 -1
  165. package/tests/unit/runtime/runners/serial_runner.spec.ts +1 -1
  166. package/tsconfig.browser.json +1 -1
  167. package/tsconfig.node.json +1 -1
  168. package/bin/test-web.ts +0 -6
  169. package/build/src/amf/AmfMixin.d.ts +0 -396
  170. package/build/src/amf/AmfMixin.d.ts.map +0 -1
  171. package/build/src/amf/AmfMixin.js +0 -1138
  172. package/build/src/amf/AmfMixin.js.map +0 -1
  173. package/build/src/amf/AmfSerializer.d.ts +0 -137
  174. package/build/src/amf/AmfSerializer.d.ts.map +0 -1
  175. package/build/src/amf/AmfSerializer.js +0 -1947
  176. package/build/src/amf/AmfSerializer.js.map +0 -1
  177. package/build/src/amf/AmfTypes.d.ts +0 -25
  178. package/build/src/amf/AmfTypes.d.ts.map +0 -1
  179. package/build/src/amf/AmfTypes.js +0 -143
  180. package/build/src/amf/AmfTypes.js.map +0 -1
  181. package/build/src/amf/ApiExampleGenerator.d.ts +0 -40
  182. package/build/src/amf/ApiExampleGenerator.d.ts.map +0 -1
  183. package/build/src/amf/ApiExampleGenerator.js +0 -112
  184. package/build/src/amf/ApiExampleGenerator.js.map +0 -1
  185. package/build/src/amf/ApiMonacoSchemaGenerator.d.ts +0 -68
  186. package/build/src/amf/ApiMonacoSchemaGenerator.d.ts.map +0 -1
  187. package/build/src/amf/ApiMonacoSchemaGenerator.js +0 -248
  188. package/build/src/amf/ApiMonacoSchemaGenerator.js.map +0 -1
  189. package/build/src/amf/ApiSchemaGenerator.d.ts +0 -56
  190. package/build/src/amf/ApiSchemaGenerator.d.ts.map +0 -1
  191. package/build/src/amf/ApiSchemaGenerator.js +0 -94
  192. package/build/src/amf/ApiSchemaGenerator.js.map +0 -1
  193. package/build/src/amf/ApiSchemaValues.d.ts +0 -111
  194. package/build/src/amf/ApiSchemaValues.d.ts.map +0 -1
  195. package/build/src/amf/ApiSchemaValues.js +0 -463
  196. package/build/src/amf/ApiSchemaValues.js.map +0 -1
  197. package/build/src/amf/DataValueGenerator.d.ts.map +0 -1
  198. package/build/src/amf/DataValueGenerator.js.map +0 -1
  199. package/build/src/amf/Parsing.d.ts +0 -48
  200. package/build/src/amf/Parsing.d.ts.map +0 -1
  201. package/build/src/amf/Parsing.js +0 -2
  202. package/build/src/amf/Parsing.js.map +0 -1
  203. package/build/src/amf/Utils.d.ts +0 -37
  204. package/build/src/amf/Utils.d.ts.map +0 -1
  205. package/build/src/amf/Utils.js +0 -169
  206. package/build/src/amf/Utils.js.map +0 -1
  207. package/build/src/amf/data-node/DataNodeBase.d.ts +0 -34
  208. package/build/src/amf/data-node/DataNodeBase.d.ts.map +0 -1
  209. package/build/src/amf/data-node/DataNodeBase.js +0 -77
  210. package/build/src/amf/data-node/DataNodeBase.js.map +0 -1
  211. package/build/src/amf/data-node/JsonDataNodeGenerator.d.ts +0 -15
  212. package/build/src/amf/data-node/JsonDataNodeGenerator.d.ts.map +0 -1
  213. package/build/src/amf/data-node/JsonDataNodeGenerator.js +0 -23
  214. package/build/src/amf/data-node/JsonDataNodeGenerator.js.map +0 -1
  215. package/build/src/amf/data-node/UrlEncodedDataNodeGenerator.d.ts +0 -14
  216. package/build/src/amf/data-node/UrlEncodedDataNodeGenerator.d.ts.map +0 -1
  217. package/build/src/amf/data-node/UrlEncodedDataNodeGenerator.js +0 -48
  218. package/build/src/amf/data-node/UrlEncodedDataNodeGenerator.js.map +0 -1
  219. package/build/src/amf/data-node/XmlDataNodeGenerator.d.ts +0 -22
  220. package/build/src/amf/data-node/XmlDataNodeGenerator.d.ts.map +0 -1
  221. package/build/src/amf/data-node/XmlDataNodeGenerator.js +0 -34
  222. package/build/src/amf/data-node/XmlDataNodeGenerator.js.map +0 -1
  223. package/build/src/amf/definitions/Amf.d.ts +0 -363
  224. package/build/src/amf/definitions/Amf.d.ts.map +0 -1
  225. package/build/src/amf/definitions/Amf.js +0 -3
  226. package/build/src/amf/definitions/Amf.js.map +0 -1
  227. package/build/src/amf/definitions/Api.d.ts +0 -383
  228. package/build/src/amf/definitions/Api.d.ts.map +0 -1
  229. package/build/src/amf/definitions/Api.js +0 -2
  230. package/build/src/amf/definitions/Api.js.map +0 -1
  231. package/build/src/amf/definitions/Base.d.ts +0 -12
  232. package/build/src/amf/definitions/Base.d.ts.map +0 -1
  233. package/build/src/amf/definitions/Base.js +0 -2
  234. package/build/src/amf/definitions/Base.js.map +0 -1
  235. package/build/src/amf/definitions/Namespace.d.ts +0 -327
  236. package/build/src/amf/definitions/Namespace.d.ts.map +0 -1
  237. package/build/src/amf/definitions/Namespace.js +0 -346
  238. package/build/src/amf/definitions/Namespace.js.map +0 -1
  239. package/build/src/amf/definitions/Shapes.d.ts +0 -312
  240. package/build/src/amf/definitions/Shapes.d.ts.map +0 -1
  241. package/build/src/amf/definitions/Shapes.js +0 -87
  242. package/build/src/amf/definitions/Shapes.js.map +0 -1
  243. package/build/src/amf/models/AmfDataNode.d.ts +0 -67
  244. package/build/src/amf/models/AmfDataNode.d.ts.map +0 -1
  245. package/build/src/amf/models/AmfDataNode.js +0 -192
  246. package/build/src/amf/models/AmfDataNode.js.map +0 -1
  247. package/build/src/amf/shape/ShapeBase.d.ts +0 -74
  248. package/build/src/amf/shape/ShapeBase.d.ts.map +0 -1
  249. package/build/src/amf/shape/ShapeBase.js +0 -93
  250. package/build/src/amf/shape/ShapeBase.js.map +0 -1
  251. package/build/src/amf/shape/ShapeJsonSchemaGenerator.d.ts +0 -47
  252. package/build/src/amf/shape/ShapeJsonSchemaGenerator.d.ts.map +0 -1
  253. package/build/src/amf/shape/ShapeJsonSchemaGenerator.js +0 -420
  254. package/build/src/amf/shape/ShapeJsonSchemaGenerator.js.map +0 -1
  255. package/build/src/amf/shape/ShapeXmlSchemaGenerator.d.ts +0 -85
  256. package/build/src/amf/shape/ShapeXmlSchemaGenerator.d.ts.map +0 -1
  257. package/build/src/amf/shape/ShapeXmlSchemaGenerator.js +0 -852
  258. package/build/src/amf/shape/ShapeXmlSchemaGenerator.js.map +0 -1
  259. package/build/src/events/amf/AmfEventTypes.d.ts +0 -7
  260. package/build/src/events/amf/AmfEventTypes.d.ts.map +0 -1
  261. package/build/src/events/amf/AmfEventTypes.js +0 -7
  262. package/build/src/events/amf/AmfEventTypes.js.map +0 -1
  263. package/build/src/events/amf/AmfEvents.d.ts +0 -34
  264. package/build/src/events/amf/AmfEvents.d.ts.map +0 -1
  265. package/build/src/events/amf/AmfEvents.js +0 -63
  266. package/build/src/events/amf/AmfEvents.js.map +0 -1
  267. package/build/src/mocking/RandExp.d.ts +0 -55
  268. package/build/src/mocking/RandExp.d.ts.map +0 -1
  269. package/build/src/mocking/RandExp.js +0 -302
  270. package/build/src/mocking/RandExp.js.map +0 -1
  271. package/build/src/mocking/lib/ret.d.ts +0 -16
  272. package/build/src/mocking/lib/ret.d.ts.map +0 -1
  273. package/build/src/mocking/lib/ret.js +0 -284
  274. package/build/src/mocking/lib/ret.js.map +0 -1
  275. package/data/apis/APIC-187/APIC-187.raml +0 -21
  276. package/data/apis/APIC-187/dataType.raml +0 -132
  277. package/data/apis/APIC-187/example.raml +0 -84
  278. package/data/apis/APIC-188/APIC-188.raml +0 -21
  279. package/data/apis/APIC-188/dataType.raml +0 -132
  280. package/data/apis/APIC-188/example.raml +0 -84
  281. package/data/apis/APIC-233/APIC-233.raml +0 -15
  282. package/data/apis/APIC-391/APIC-391.raml +0 -44
  283. package/data/apis/APIC-391/examples/post-body-request-example.raml +0 -7
  284. package/data/apis/APIC-483/APIC-483.raml +0 -16
  285. package/data/apis/APIC-483/example/list-of-bank-succ.json +0 -32
  286. package/data/apis/APIC-483/schema/response-retrieve-list-bank.json +0 -68
  287. package/data/apis/APIC-487/APIC-487.raml +0 -36
  288. package/data/apis/APIC-655/APIC-655.raml +0 -44
  289. package/data/apis/APIC-655/delivery.json +0 -12
  290. package/data/apis/APIC-689/APIC-689.raml +0 -20
  291. package/data/apis/APIC-690/APIC-690.raml +0 -17
  292. package/data/apis/APIC-690/datatypes/Address.raml +0 -10
  293. package/data/apis/APIC-690/datatypes/Customer.raml +0 -17
  294. package/data/apis/APIC-690/examples/CustomerExample2.raml +0 -17
  295. package/data/apis/APIC-690/examples/CustomersExample.raml +0 -34
  296. package/data/apis/SE-10469/Purchase-Order-oagis-id-dd32f9c6c01048a19e15c423c9c741ae.json +0 -1383
  297. package/data/apis/SE-10469/SE-10469.raml +0 -11
  298. package/data/apis/SE-13092/Examples/PersonExample.raml +0 -7
  299. package/data/apis/SE-13092/SE-13092.raml +0 -37
  300. package/data/apis/SE-13092/datatypes/Address.raml +0 -5
  301. package/data/apis/SE-13092/datatypes/InlineType.raml +0 -5
  302. package/data/apis/SE-13092/datatypes/Person.raml +0 -15
  303. package/data/apis/SE-22063/SE-22063.raml +0 -14
  304. package/data/apis/SE-22063/stock.raml +0 -41
  305. package/data/apis/amf-helper-api/amf-helper-api.raml +0 -1024
  306. package/data/apis/amf-helper-api/examples/comment-example.json +0 -42
  307. package/data/apis/amf-helper-api/examples/commentCreateRequest-example.json +0 -7
  308. package/data/apis/amf-helper-api/examples/commentList-example.json +0 -48
  309. package/data/apis/amf-helper-api/examples/person.json +0 -14
  310. package/data/apis/amf-helper-api/examples/person.raml +0 -13
  311. package/data/apis/amf-helper-api/examples/person.xml +0 -14
  312. package/data/apis/amf-helper-api/libraries/comment-lib.raml +0 -143
  313. package/data/apis/amf-helper-api/library.raml +0 -7
  314. package/data/apis/amf-helper-api/schemas/person.json +0 -104
  315. package/data/apis/amf-helper-api/schemas/person.xsd +0 -26
  316. package/data/apis/amf-helper-api/traits/file.raml +0 -33
  317. package/data/apis/amf-helper-api/traits/pagination.raml +0 -80
  318. package/data/apis/amf-helper-api/traits/results.raml +0 -19
  319. package/data/apis/amf-helper-api/traits/visibility.raml +0 -14
  320. package/data/apis/amf-helper-api/types/app-person.raml +0 -101
  321. package/data/apis/amf-helper-api/types/dimensions.raml +0 -24
  322. package/data/apis/amf-helper-api/types/external-type.raml +0 -7
  323. package/data/apis/amf-helper-api/types/image.raml +0 -23
  324. package/data/apis/amf-helper-api/types/product.raml +0 -52
  325. package/data/apis/amf-helper-api/types/resource.raml +0 -11
  326. package/data/apis/amf-helper-api/types/standard-request.raml +0 -50
  327. package/data/apis/amf-helper-api/types/user.raml +0 -37
  328. package/data/apis/arc-demo-api/arc-demo-api.raml +0 -468
  329. package/data/apis/arc-demo-api/examples/e400.xml +0 -4
  330. package/data/apis/arc-demo-api/examples/e401.xml +0 -4
  331. package/data/apis/arc-demo-api/examples/e404.xml +0 -4
  332. package/data/apis/arc-demo-api/examples/image.xml +0 -5
  333. package/data/apis/arc-demo-api/examples/messages-example.json +0 -22
  334. package/data/apis/arc-demo-api/examples/messages-sent-example.json +0 -15
  335. package/data/apis/arc-demo-api/examples/person.json +0 -14
  336. package/data/apis/arc-demo-api/examples/person.url.encoded +0 -1
  337. package/data/apis/arc-demo-api/examples/person.xml +0 -14
  338. package/data/apis/arc-demo-api/examples/product.xml +0 -9
  339. package/data/apis/arc-demo-api/library.raml +0 -36
  340. package/data/apis/arc-demo-api/resourceTypes/app-person.raml +0 -49
  341. package/data/apis/arc-demo-api/resourceTypes/example-types.raml +0 -45
  342. package/data/apis/arc-demo-api/resourceTypes/image.raml +0 -23
  343. package/data/apis/arc-demo-api/resourceTypes/message-sent-type.raml +0 -23
  344. package/data/apis/arc-demo-api/resourceTypes/message-type.raml +0 -33
  345. package/data/apis/arc-demo-api/resourceTypes/product.raml +0 -52
  346. package/data/apis/arc-demo-api/resourceTypes/resource.raml +0 -11
  347. package/data/apis/arc-demo-api/schemas/error-response.xsd +0 -11
  348. package/data/apis/arc-demo-api/schemas/image.xsd +0 -11
  349. package/data/apis/arc-demo-api/schemas/person.json +0 -104
  350. package/data/apis/arc-demo-api/schemas/person.xsd +0 -26
  351. package/data/apis/arc-demo-api/schemas/product.xsd +0 -17
  352. package/data/apis/arc-demo-api/securitySchemes/basic.raml +0 -5
  353. package/data/apis/arc-demo-api/securitySchemes/oauth_2_0.raml +0 -29
  354. package/data/apis/arc-demo-api/securitySchemes/x-custom.raml +0 -26
  355. package/data/apis/arc-demo-api/traits/adminable.raml +0 -23
  356. package/data/apis/arc-demo-api/traits/pagination.raml +0 -83
  357. package/data/apis/arc-demo-api/traits/rate-limited.raml +0 -9
  358. package/data/apis/async-api/async-api.yaml +0 -96
  359. package/data/apis/example-generator-api/contact-email-example.raml +0 -6
  360. package/data/apis/example-generator-api/contact-example.raml +0 -5
  361. package/data/apis/example-generator-api/contact-fax-example.raml +0 -5
  362. package/data/apis/example-generator-api/contact-website-example.raml +0 -2
  363. package/data/apis/example-generator-api/example-1.raml +0 -6
  364. package/data/apis/example-generator-api/example-2.raml +0 -9
  365. package/data/apis/example-generator-api/example-3.raml +0 -4
  366. package/data/apis/example-generator-api/example-4.raml +0 -2
  367. package/data/apis/example-generator-api/example-5.raml +0 -4
  368. package/data/apis/example-generator-api/example-6.raml +0 -2
  369. package/data/apis/example-generator-api/example-7.raml +0 -5
  370. package/data/apis/example-generator-api/example-generator-api.raml +0 -423
  371. package/data/apis/example-generator-api/example.json +0 -14
  372. package/data/apis/example-generator-api/example.xml +0 -15
  373. package/data/apis/example-generator-api/example.xsd +0 -26
  374. package/data/apis/example-generator-api/examples/employee.raml +0 -7
  375. package/data/apis/example-generator-api/examples/employees.raml +0 -7
  376. package/data/apis/example-generator-api/linked-named-example.raml +0 -21
  377. package/data/apis/example-generator-api/named-example-with-link.raml +0 -5
  378. package/data/apis/example-generator-api/named-example.raml +0 -9
  379. package/data/apis/example-generator-api/user-json-example.raml +0 -17
  380. package/data/apis/example-generator-api/user-raml-example.raml +0 -37
  381. package/data/apis/example-generator-api/user.json +0 -8
  382. package/data/apis/example-generator-api/user.raml +0 -18
  383. package/data/apis/example-generator-api/users-json-example.raml +0 -17
  384. package/data/apis/example-generator-api/users-raml-example.raml +0 -32
  385. package/data/apis/example-generator-api/users.json +0 -8
  386. package/data/apis/expanded-api/expanded-api.raml +0 -8
  387. package/data/apis/flattened-api/flattened-api.raml +0 -8
  388. package/data/apis/multiple-servers/multiple-servers.yaml +0 -112
  389. package/data/apis/oas-3-api/oas-3-api.yaml +0 -356
  390. package/data/apis/oas-date/oas-date.yaml +0 -28
  391. package/data/apis/oas-types/oas-types.yaml +0 -159
  392. package/data/apis/oas-unions/oas-unions.yaml +0 -75
  393. package/data/apis/petstore/petstore.yaml +0 -954
  394. package/data/apis/raml-date/raml-date.raml +0 -28
  395. package/data/apis/recursive/recursive.raml +0 -14
  396. package/data/apis/schema-api/examples/person.json +0 -14
  397. package/data/apis/schema-api/examples/person.raml +0 -14
  398. package/data/apis/schema-api/examples/person.url.encoded +0 -1
  399. package/data/apis/schema-api/examples/person.xml +0 -14
  400. package/data/apis/schema-api/library/demo-types.raml +0 -43
  401. package/data/apis/schema-api/schema-api.raml +0 -656
  402. package/data/apis/schema-api/schemas/person.json +0 -104
  403. package/data/apis/schema-api/schemas/person.xsd +0 -26
  404. package/data/apis/schema-api/types/DemoPerson.raml +0 -67
  405. package/data/apis/secured-api/oauth-2-custom-settings.raml +0 -143
  406. package/data/apis/secured-api/oauth2-header-delivery.raml +0 -13
  407. package/data/apis/secured-api/oauth2-no-delivery.raml +0 -8
  408. package/data/apis/secured-api/oauth2-no-grants.raml +0 -12
  409. package/data/apis/secured-api/oauth2-pkce.raml +0 -13
  410. package/data/apis/secured-api/oauth2-query-delivery.raml +0 -13
  411. package/data/apis/secured-api/oauth_1_0.raml +0 -8
  412. package/data/apis/secured-api/oauth_1_0_no-settings.raml +0 -3
  413. package/data/apis/secured-api/oauth_1_0_no-signature.raml +0 -7
  414. package/data/apis/secured-api/oauth_1_0_signature.raml +0 -8
  415. package/data/apis/secured-api/passthrough-querystring.raml +0 -16
  416. package/data/apis/secured-api/passthrough.raml +0 -24
  417. package/data/apis/secured-api/secured-api.raml +0 -231
  418. package/data/apis/secured-api/x-custom.raml +0 -33
  419. package/data/apis/secured-api/x-other.raml +0 -29
  420. package/data/apis/secured-api/x-query-string.raml +0 -16
  421. package/data/apis/tracked-examples/datatypes/employee.raml +0 -5
  422. package/data/apis/tracked-examples/examples/employee.raml +0 -4
  423. package/data/apis/tracked-examples/examples/employees.raml +0 -8
  424. package/data/apis/tracked-examples/tracked-to-linked.raml +0 -28
  425. package/data/model.js +0 -129
  426. package/data/models/APIC-187.json +0 -11416
  427. package/data/models/APIC-188.json +0 -11416
  428. package/data/models/APIC-233.json +0 -539
  429. package/data/models/APIC-391.json +0 -1903
  430. package/data/models/APIC-483.json +0 -3110
  431. package/data/models/APIC-487.json +0 -1225
  432. package/data/models/APIC-655.json +0 -3145
  433. package/data/models/APIC-689.json +0 -797
  434. package/data/models/APIC-690.json +0 -5992
  435. package/data/models/SE-10469.json +0 -22898
  436. package/data/models/SE-13092.json +0 -2769
  437. package/data/models/SE-22063.json +0 -2314
  438. package/data/models/amf-helper-api.json +0 -84457
  439. package/data/models/arc-demo-api.json +0 -52041
  440. package/data/models/async-api.json +0 -3227
  441. package/data/models/example-generator-api.json +0 -45209
  442. package/data/models/expanded-api.json +0 -251
  443. package/data/models/flattened-api.json +0 -251
  444. package/data/models/multiple-servers.json +0 -2769
  445. package/data/models/oas-3-api.json +0 -10590
  446. package/data/models/oas-date.json +0 -637
  447. package/data/models/oas-types.json +0 -5352
  448. package/data/models/oas-unions.json +0 -1935
  449. package/data/models/petstore.json +0 -27712
  450. package/data/models/raml-date.json +0 -1114
  451. package/data/models/recursive.json +0 -610
  452. package/data/models/schema-api.json +0 -35527
  453. package/data/models/secured-api.json +0 -21071
  454. package/data/models/tracked-to-linked.json +0 -1914
  455. package/src/amf/AmfMixin.ts +0 -1726
  456. package/src/amf/AmfSerializer.ts +0 -2358
  457. package/src/amf/AmfTypes.ts +0 -147
  458. package/src/amf/ApiExampleGenerator.ts +0 -122
  459. package/src/amf/ApiMonacoSchemaGenerator.ts +0 -332
  460. package/src/amf/ApiSchemaGenerator.ts +0 -115
  461. package/src/amf/ApiSchemaValues.ts +0 -509
  462. package/src/amf/Parsing.ts +0 -50
  463. package/src/amf/Utils.ts +0 -172
  464. package/src/amf/data-node/DataNodeBase.ts +0 -83
  465. package/src/amf/data-node/JsonDataNodeGenerator.ts +0 -24
  466. package/src/amf/data-node/README.md +0 -3
  467. package/src/amf/data-node/UrlEncodedDataNodeGenerator.ts +0 -49
  468. package/src/amf/data-node/XmlDataNodeGenerator.ts +0 -46
  469. package/src/amf/definitions/Amf.ts +0 -440
  470. package/src/amf/definitions/Api.ts +0 -445
  471. package/src/amf/definitions/Base.ts +0 -13
  472. package/src/amf/definitions/Namespace.ts +0 -357
  473. package/src/amf/definitions/Shapes.ts +0 -438
  474. package/src/amf/models/AmfDataNode.ts +0 -210
  475. package/src/amf/shape/README.md +0 -4
  476. package/src/amf/shape/ShapeBase.ts +0 -174
  477. package/src/amf/shape/ShapeJsonSchemaGenerator.ts +0 -457
  478. package/src/amf/shape/ShapeXmlSchemaGenerator.ts +0 -933
  479. package/src/events/amf/AmfEventTypes.ts +0 -6
  480. package/src/events/amf/AmfEvents.ts +0 -78
  481. package/src/mocking/RandExp.ts +0 -335
  482. package/src/mocking/lib/ret.ts +0 -279
  483. package/tests/unit/amf/APIC-187.spec.ts +0 -41
  484. package/tests/unit/amf/APIC-188.spec.ts +0 -30
  485. package/tests/unit/amf/APIC-233.spec.ts +0 -32
  486. package/tests/unit/amf/APIC-391.spec.ts +0 -39
  487. package/tests/unit/amf/APIC-487.spec.ts +0 -44
  488. package/tests/unit/amf/APIC-655.spec.ts +0 -41
  489. package/tests/unit/amf/APIC-689.spec.ts +0 -28
  490. package/tests/unit/amf/APIC-690.spec.ts +0 -93
  491. package/tests/unit/amf/AmfLoader.ts +0 -538
  492. package/tests/unit/amf/AmfMixin.spec.ts +0 -1707
  493. package/tests/unit/amf/ApiExampleGenerator.spec.ts +0 -250
  494. package/tests/unit/amf/ApiMonacoSchemaGenerator.spec.ts +0 -183
  495. package/tests/unit/amf/ApiSchemaValues.spec.ts +0 -602
  496. package/tests/unit/amf/Namepsace.spec.ts +0 -494
  497. package/tests/unit/amf/SE-10469.spec.ts +0 -35
  498. package/tests/unit/amf/SE-13092.spec.ts +0 -64
  499. package/tests/unit/amf/SE-22063.spec.ts +0 -45
  500. package/tests/unit/amf/raml-examples.spec.ts +0 -43
  501. package/tests/unit/amf/schema_gen_array.spec.ts +0 -199
  502. package/tests/unit/amf/schema_gen_oas.spec.ts +0 -140
  503. package/tests/unit/amf/schema_gen_object.spec.ts +0 -279
  504. package/tests/unit/amf/schema_gen_scalar.spec.ts +0 -143
  505. package/tests/unit/amf/schema_gen_union.spec.ts +0 -401
  506. package/tests/unit/amf/schema_gen_unknown.spec.ts +0 -42
  507. package/tests/unit/amf/schema_gen_xml.spec.ts +0 -726
  508. package/tests/unit/amf/serializer/APIC-483.spec.ts +0 -36
  509. package/tests/unit/amf/serializer/Anotations.spec.ts +0 -50
  510. package/tests/unit/amf/serializer/Api.spec.ts +0 -210
  511. package/tests/unit/amf/serializer/Documentation.spec.ts +0 -52
  512. package/tests/unit/amf/serializer/Endpoints.spec.ts +0 -172
  513. package/tests/unit/amf/serializer/Operations.spec.ts +0 -330
  514. package/tests/unit/amf/serializer/Parameters.spec.ts +0 -149
  515. package/tests/unit/amf/serializer/PayloadExamples.spec.ts +0 -152
  516. package/tests/unit/amf/serializer/Security.spec.ts +0 -626
  517. package/tests/unit/amf/serializer/Server.spec.ts +0 -78
  518. package/tests/unit/amf/serializer/Shapes.spec.ts +0 -304
  519. package/tests/unit/amf/serializer/SourceMaps.spec.ts +0 -52
  520. package/tests/unit/amf/shapes/ShapeXmlSchemaGenerator.spec.ts +0 -28
  521. package/tests/unit/amf/tracked-to-linked.spec.ts +0 -90
  522. package/tests/unit/amf/xml-data-processing.spec.ts +0 -217
  523. 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
- })