@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,143 +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(`scalar 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 without a value', async ({ assert }) => {
20
- const shape = loader.getShape(model, 'ScalarType')
21
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime)
22
- assert.typeOf(result, 'string')
23
- })
24
-
25
- test('generates a schema without mocked value', async ({ assert }) => {
26
- const shape = loader.getShape(model, 'ScalarType')
27
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime, {
28
- renderMocked: true,
29
- })
30
- assert.typeOf(result, 'string', 'is a string')
31
- assert.isNotEmpty(result, 'has a value')
32
- })
33
-
34
- test('generates a schema with the default value', async ({ assert }) => {
35
- const shape = loader.getShape(model, 'ScalarWithTraits')
36
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime)
37
- assert.strictEqual(result, 'test')
38
- })
39
-
40
- test('generates a schema with the example value', async ({ assert }) => {
41
- const shape = loader.getShape(model, 'ScalarWithExample')
42
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime, {
43
- renderExamples: true,
44
- })
45
- assert.strictEqual(result, 'A string')
46
- })
47
-
48
- test('generates a schema with the first enum value', async ({ assert }) => {
49
- const shape = loader.getShape(model, 'ScalarWithEnum')
50
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime)
51
- assert.strictEqual(result, 'A')
52
- })
53
-
54
- // Apparently AMF does not move properties from the parent scalar shape
55
- test('generates a schema for a parent', async ({ assert }) => {
56
- const shape = loader.getShape(model, 'ScalarWithParent')
57
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime)
58
- assert.strictEqual(result, 'test')
59
- }).skip()
60
-
61
- test('generates the example', async ({ assert }) => {
62
- const shape = loader.getShape(model, 'ScalarWithExample')
63
- const result = ApiSchemaGenerator.asExample(shape, jsonMime, {
64
- renderExamples: true,
65
- }) as ISchemaExample
66
- assert.typeOf(result, 'object', 'returns an object')
67
- assert.isTrue(result.strict, 'has the strict property')
68
- assert.deepEqual(result.types, [ns.aml.vocabularies.apiContract.Example], 'has the types property')
69
- assert.equal(result.mediaType, jsonMime, 'has the mediaType property')
70
- assert.strictEqual(result.renderValue, 'A string', 'has the value')
71
- })
72
- })
73
-
74
- test.group(`scalar values / ${xmlMime}`, (group) => {
75
- let model: IAmfDocument
76
-
77
- group.setup(async () => {
78
- model = await loader.getGraph('schema-api')
79
- })
80
-
81
- test('generates a schema without a value', async ({ assert }) => {
82
- const shape = loader.getShape(model, 'ScalarType')
83
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime)
84
-
85
- const parser = new DOMParser()
86
- const doc = parser.parseFromString(result as string, 'application/xml')
87
- const node = doc.getElementsByTagName('ScalarType')[0]
88
- assert.ok(node, 'has the schema name')
89
- assert.equal((node.textContent as string).trim(), '')
90
- })
91
-
92
- test('generates a schema without a mocked value', async ({ assert }) => {
93
- const shape = loader.getShape(model, 'ScalarType')
94
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
95
- renderMocked: true,
96
- })
97
-
98
- const parser = new DOMParser()
99
- const doc = parser.parseFromString(result as string, 'application/xml')
100
- const node = doc.getElementsByTagName('ScalarType')[0]
101
- assert.ok(node, 'has the schema name')
102
- assert.isNotEmpty((node.textContent as string).trim())
103
- })
104
-
105
- test('generates a schema with the default value', async ({ assert }) => {
106
- const shape = loader.getShape(model, 'ScalarWithTraits')
107
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime)
108
- assert.strictEqual(result, '<ScalarWithTraits>test</ScalarWithTraits>')
109
- })
110
-
111
- test('generates a schema with the example value', async ({ assert }) => {
112
- const shape = loader.getShape(model, 'ScalarWithExample')
113
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
114
- renderExamples: true,
115
- })
116
- assert.strictEqual(result, '<ScalarWithExample>A string</ScalarWithExample>')
117
- })
118
-
119
- test('generates a schema with the first enum value', async ({ assert }) => {
120
- const shape = loader.getShape(model, 'ScalarWithEnum')
121
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime)
122
- assert.strictEqual(result, '<ScalarWithEnum>A</ScalarWithEnum>')
123
- })
124
-
125
- // Apparently AMF does not move properties from the parent scalar shape
126
- test('generates a schema for a parent', async ({ assert }) => {
127
- const shape = loader.getShape(model, 'ScalarWithParent')
128
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime)
129
- assert.strictEqual(result, '<ScalarWithParent>test</ScalarWithParent>')
130
- }).skip()
131
-
132
- test('generates the example', async ({ assert }) => {
133
- const shape = loader.getShape(model, 'ScalarWithExample')
134
- const result = ApiSchemaGenerator.asExample(shape, xmlMime, {
135
- renderExamples: true,
136
- }) as ISchemaExample
137
- assert.typeOf(result, 'object', 'returns an object')
138
- assert.isTrue(result.strict, 'has the strict property')
139
- assert.deepEqual(result.types, [ns.aml.vocabularies.apiContract.Example], 'has the types property')
140
- assert.equal(result.mediaType, xmlMime, 'has the mediaType property')
141
- assert.strictEqual(result.renderValue, '<ScalarWithExample>A string</ScalarWithExample>', 'has the value')
142
- })
143
- })
@@ -1,401 +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
- import { IApiUnionShape } from '../../../src/amf/definitions/Shapes.js'
7
-
8
- const loader = new AmfLoader()
9
- const jsonMime = 'application/json'
10
- const xmlMime = 'application/xml'
11
-
12
- test.group(`union values / ${jsonMime}`, (group) => {
13
- let model: IAmfDocument
14
-
15
- group.setup(async () => {
16
- model = await loader.getGraph('schema-api')
17
- })
18
- test('generates schema for a scalar union', async ({ assert }) => {
19
- const shape = loader.getShape(model, 'ScalarUnion')
20
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime, {
21
- renderMocked: true,
22
- })
23
- assert.typeOf(result, 'string', 'is a string')
24
- assert.isNotEmpty(result, 'the result has auto-generated value')
25
- })
26
-
27
- test('generates schema for a scalar union with a default number value', async ({ assert }) => {
28
- const shape = loader.getShape(model, 'ScalarUnionDefaultNumber')
29
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime)
30
- assert.typeOf(result, 'number', 'is a number')
31
- assert.strictEqual(result, 123456, 'the result is set')
32
- })
33
-
34
- test('generates schema for a scalar union with a default string value', async ({ assert }) => {
35
- const shape = loader.getShape(model, 'ScalarUnionDefaultString')
36
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime)
37
- assert.typeOf(result, 'string', 'is a string')
38
- assert.strictEqual(result, 'abc123', 'the result is set')
39
- })
40
-
41
- test('generates schema for a scalar union with a default boolean value (true)', async ({ assert }) => {
42
- const shape = loader.getShape(model, 'ScalarUnionDefaultBoolean')
43
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime)
44
- assert.typeOf(result, 'boolean', 'is a boolean')
45
- assert.strictEqual(result, true, 'the result is set')
46
- })
47
-
48
- test('generates schema for a scalar union with a default boolean value (false)', async ({ assert }) => {
49
- const shape = loader.getShape(model, 'ScalarUnionDefaultBoolean2')
50
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime)
51
- assert.strictEqual(result, false, 'the result is set')
52
- })
53
-
54
- test('ignores implicit not-required unions (union with nil)', async ({ assert }) => {
55
- const shape = loader.getShape(model, 'ScalarUnionDefaultNil')
56
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime)
57
- assert.isUndefined(result)
58
- })
59
-
60
- test('generates schema for required union an example value (number)', async ({ assert }) => {
61
- const shape = loader.getShape(model, 'ScalarUnionExampleNumber')
62
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime, {
63
- renderExamples: true,
64
- })
65
- assert.strictEqual(result, 987654, 'the result is a number')
66
- })
67
-
68
- test('generates schema for required union an example value (string)', async ({ assert }) => {
69
- const shape = loader.getShape(model, 'ScalarUnionExampleString')
70
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime, {
71
- renderExamples: true,
72
- })
73
- assert.strictEqual(result, '098poi', 'the result is a string')
74
- })
75
-
76
- test('generates a string value for scalar-object union', async ({ assert }) => {
77
- const shape = loader.getShape(model, 'ScalarObjectUnion')
78
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime, {
79
- renderMocked: true,
80
- })
81
- assert.typeOf(result, 'string', 'the result is a string')
82
- assert.isNotEmpty(result, 'has a value')
83
- })
84
-
85
- test('generates schema for scalar-object union with an example', async ({ assert }) => {
86
- const shape = loader.getShape(model, 'ScalarObjectUnionExample')
87
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime, {
88
- renderExamples: true,
89
- })
90
- assert.typeOf(result, 'string', 'the result is a string')
91
- const parsed = JSON.parse(String(result))
92
- assert.strictEqual(parsed.id, '128a654bc54d898e43f', 'example.id is set')
93
- assert.strictEqual(parsed.name, 'Pawel Uchida-Psztyc', 'example.name is set')
94
- assert.strictEqual(parsed.age, 30, 'example.age is set')
95
- assert.strictEqual(parsed.sex, 'male', 'example.sex is set')
96
- assert.strictEqual(parsed.newsletter, false, 'example.newsletter is set')
97
- assert.strictEqual(parsed.tosAccepted, true, 'example.tosAccepted is set')
98
- })
99
-
100
- test('generates schema for objects union', async ({ assert }) => {
101
- const shape = loader.getShape(model, 'ObjectUnions')
102
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime)
103
- assert.typeOf(result, 'string', 'the result is a string')
104
- const parsed = JSON.parse(String(result))
105
- assert.typeOf(parsed.name, 'string', 'schema.name is set')
106
- assert.isUndefined(parsed.age, 'optional item is not set (age)')
107
- assert.strictEqual(parsed.sex, 'male', 'schema.sex is set')
108
- assert.isUndefined(parsed.newsletter, 'optional item is not set (newsletter)')
109
- assert.typeOf(parsed.tosAccepted, 'boolean', 'schema.tosAccepted is set')
110
- })
111
-
112
- test('generates schema for a selected union', async ({ assert }) => {
113
- const shape = loader.getShape(model, 'ObjectUnions') as IApiUnionShape
114
- const id = shape.anyOf[1].id
115
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime, {
116
- selectedUnions: [id],
117
- renderMocked: true,
118
- })
119
- assert.typeOf(result, 'string', 'the result is a string')
120
- const parsed = JSON.parse(String(result))
121
- assert.typeOf(parsed.name, 'string', 'has parent name')
122
- assert.typeOf(parsed.age, 'number', 'has child age')
123
- assert.strictEqual(parsed.sex, 'male', 'has parent sex')
124
- assert.isUndefined(parsed.newsletter, 'has no optional parent newsletter')
125
- assert.typeOf(parsed.tosAccepted, 'boolean', 'has parent tosAccepted')
126
- assert.match(parsed.addedProperty, /^[0-9]{2}:[0-9]{2}:[0-9]{2}$/, 'has child addedProperty')
127
- })
128
-
129
- // examples are not correctly inherited with unions
130
- test('renders example from an union object', async ({ assert }) => {
131
- const shape = loader.getShape(model, 'ObjectUnionWithExample')
132
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime, {
133
- renderExamples: true,
134
- })
135
- assert.typeOf(result, 'string', 'the result is a string')
136
- const parsed = JSON.parse(String(result))
137
- assert.strictEqual(parsed.error, true, 'has schema.error')
138
- assert.strictEqual(parsed.message, 'Error message', 'has schema.message')
139
- assert.isUndefined(parsed.optional, 'has no optional property')
140
- }).skip()
141
-
142
- test('does not renders example from an union object when not configured', async ({ assert }) => {
143
- const shape = loader.getShape(model, 'ObjectUnionWithExample')
144
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime)
145
- assert.typeOf(result, 'string', 'the result is a string')
146
- const parsed = JSON.parse(String(result))
147
- assert.typeOf(parsed.error, 'boolean', 'has default schema.error')
148
- assert.typeOf(parsed.message, 'string', 'has generated schema.message')
149
- assert.isUndefined(parsed.optional, 'has no optional property')
150
- })
151
-
152
- test('marks scalar | nil union as optional', async ({ assert }) => {
153
- const shape = loader.getShape(model, 'ObjectScalarUnionNill')
154
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime)
155
- assert.equal(result, '{}', 'is a string')
156
- })
157
-
158
- // I am not sure how this should work.
159
- // In RAML spec it says that scalar + nil makes the scalar optional.
160
- // Should it be the same for an object?
161
- test('marks object | nil union as optional', async ({ assert }) => {
162
- const shape = loader.getShape(model, 'UnionNill')
163
- const result = ApiSchemaGenerator.asSchema(shape, jsonMime)
164
- assert.equal(result, '{}', 'is a string')
165
- }).skip()
166
- })
167
-
168
- test.group(`union values / ${xmlMime}`, (group) => {
169
- let model: IAmfDocument
170
-
171
- group.setup(async () => {
172
- model = await loader.getGraph('schema-api')
173
- })
174
- test('generates schema for a scalar union', async ({ assert }) => {
175
- const shape = loader.getShape(model, 'ScalarUnion')
176
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
177
- renderMocked: true,
178
- })
179
- const parser = new DOMParser()
180
- const schema = parser.parseFromString(String(result), xmlMime)
181
-
182
- const root = schema.getElementsByTagName('ScalarUnion')[0]
183
- assert.ok(root, 'has the root node')
184
- assert.isNotEmpty(root.textContent!.trim(), 'the root node is empty')
185
- })
186
-
187
- test('generates schema for a scalar union with a default number value', async ({ assert }) => {
188
- const shape = loader.getShape(model, 'ScalarUnionDefaultNumber')
189
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime)
190
- const parser = new DOMParser()
191
- const schema = parser.parseFromString(String(result), xmlMime)
192
-
193
- const root = schema.getElementsByTagName('ScalarUnionDefaultNumber')[0]
194
- assert.ok(root, 'has the root node')
195
- assert.equal(root.textContent!.trim(), '123456', 'the root node has a number value')
196
- })
197
-
198
- test('generates schema for a scalar union with a default string value', async ({ assert }) => {
199
- const shape = loader.getShape(model, 'ScalarUnionDefaultString')
200
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime)
201
- const parser = new DOMParser()
202
- const schema = parser.parseFromString(String(result), xmlMime)
203
-
204
- const root = schema.getElementsByTagName('ScalarUnionDefaultString')[0]
205
- assert.ok(root, 'has the root node')
206
- assert.equal(root.textContent!.trim(), 'abc123', 'the root node has a string value')
207
- })
208
-
209
- test('generates schema for a scalar union with a default boolean value', async ({ assert }) => {
210
- const shape = loader.getShape(model, 'ScalarUnionDefaultBoolean')
211
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime)
212
- const parser = new DOMParser()
213
- const schema = parser.parseFromString(String(result), xmlMime)
214
-
215
- const root = schema.getElementsByTagName('ScalarUnionDefaultBoolean')[0]
216
- assert.ok(root, 'has the root node')
217
- assert.equal(root.textContent!.trim(), 'true', 'the root node has a boolean value')
218
- })
219
-
220
- test('ignores implicit not-required unions (union with nil)', async ({ assert }) => {
221
- const shape = loader.getShape(model, 'ScalarUnionDefaultNil')
222
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime)
223
- assert.isUndefined(result)
224
- })
225
-
226
- test('generates schema for required union an example value (number)', async ({ assert }) => {
227
- const shape = loader.getShape(model, 'ScalarUnionExampleNumber')
228
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime)
229
- const parser = new DOMParser()
230
- const schema = parser.parseFromString(String(result), xmlMime)
231
-
232
- const root = schema.getElementsByTagName('ScalarUnionExampleNumber')[0]
233
- assert.ok(root, 'has the root node')
234
- assert.equal(root.textContent!.trim(), '987654', 'the root node has the example value')
235
- })
236
-
237
- test('generates schema for required union an example value (string)', async ({ assert }) => {
238
- const shape = loader.getShape(model, 'ScalarUnionExampleString')
239
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime)
240
- const parser = new DOMParser()
241
- const schema = parser.parseFromString(String(result), xmlMime)
242
-
243
- const root = schema.getElementsByTagName('ScalarUnionExampleString')[0]
244
- assert.ok(root, 'has the root node')
245
- assert.equal(root.textContent!.trim(), '098poi', 'the root node has the example value')
246
- })
247
-
248
- test('generates empty string for scalar-object union', async ({ assert }) => {
249
- const shape = loader.getShape(model, 'ScalarObjectUnion')
250
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime)
251
- const parser = new DOMParser()
252
- const schema = parser.parseFromString(String(result), xmlMime)
253
-
254
- const root = schema.getElementsByTagName('ScalarObjectUnion')[0]
255
- assert.ok(root, 'has the root node')
256
- assert.equal(root.textContent!.trim(), '', 'the root node is empty')
257
- })
258
-
259
- test('generates mocked string for scalar-object union', async ({ assert }) => {
260
- const shape = loader.getShape(model, 'ScalarObjectUnion')
261
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
262
- renderMocked: true,
263
- })
264
- const parser = new DOMParser()
265
- const schema = parser.parseFromString(String(result), xmlMime)
266
-
267
- const root = schema.getElementsByTagName('ScalarObjectUnion')[0]
268
- assert.ok(root, 'has the root node')
269
- assert.isNotEmpty(root.textContent!.trim(), 'the root node is not empty')
270
- })
271
-
272
- test('generates schema for scalar-object union with an example', async ({ assert }) => {
273
- const shape = loader.getShape(model, 'ScalarObjectUnionExample')
274
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime)
275
- const parser = new DOMParser()
276
- const schema = parser.parseFromString(String(result), xmlMime)
277
-
278
- const root = schema.getElementsByTagName('ScalarObjectUnionExample')[0]
279
- assert.ok(root, 'has the root node')
280
- assert.strictEqual(
281
- root.getElementsByTagName('id')[0].textContent!.trim(),
282
- '128a654bc54d898e43f',
283
- 'example.id is set'
284
- )
285
- assert.strictEqual(
286
- root.getElementsByTagName('name')[0].textContent!.trim(),
287
- 'Pawel Uchida-Psztyc',
288
- 'example.name is set'
289
- )
290
- assert.strictEqual(root.getElementsByTagName('age')[0].textContent!.trim(), '30', 'example.age is set')
291
- assert.strictEqual(root.getElementsByTagName('sex')[0].textContent!.trim(), 'male', 'example.sex is set')
292
- assert.strictEqual(
293
- root.getElementsByTagName('newsletter')[0].textContent!.trim(),
294
- 'false',
295
- 'example.newsletter is set'
296
- )
297
- assert.strictEqual(
298
- root.getElementsByTagName('tosAccepted')[0].textContent!.trim(),
299
- 'true',
300
- 'example.tosAccepted is set'
301
- )
302
- })
303
-
304
- test('generates schema for objects union', async ({ assert }) => {
305
- const shape = loader.getShape(model, 'ObjectUnions')
306
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
307
- renderMocked: true,
308
- })
309
- const parser = new DOMParser()
310
- const schema = parser.parseFromString(String(result), xmlMime)
311
-
312
- const root = schema.getElementsByTagName('ObjectUnions')[0]
313
- assert.ok(root, 'has the root node')
314
- assert.isNotEmpty(root.getElementsByTagName('id')[0].textContent!.trim(), 'example.id is set')
315
- assert.isNotEmpty(root.getElementsByTagName('name')[0].textContent!.trim(), 'example.name is set')
316
- assert.notOk(root.getElementsByTagName('age')[0], 'optional item is not set (age)')
317
- assert.strictEqual(root.getElementsByTagName('sex')[0].textContent!.trim(), 'male', 'example.sex is set')
318
- assert.notOk(root.getElementsByTagName('newsletter')[0], 'optional item is not set (newsletter)')
319
- assert.strictEqual(
320
- root.getElementsByTagName('tosAccepted')[0].textContent!.trim(),
321
- 'false',
322
- 'example.tosAccepted is set'
323
- )
324
- })
325
-
326
- test('generates schema for a selected union', async ({ assert }) => {
327
- const shape = loader.getShape(model, 'ObjectUnions') as IApiUnionShape
328
- // const typedUnion = (shape.inherits[0]);
329
- const id = shape.anyOf[1].id
330
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
331
- selectedUnions: [id],
332
- renderMocked: true,
333
- })
334
- const parser = new DOMParser()
335
- const schema = parser.parseFromString(String(result), xmlMime)
336
-
337
- const root = schema.getElementsByTagName('ObjectUnions')[0]
338
- assert.ok(root, 'has the root node')
339
- assert.isNotEmpty(root.getElementsByTagName('name')[0].textContent!.trim(), 'has parent name')
340
- assert.match(root.getElementsByTagName('age')[0].textContent!.trim(), /^\d+$/, 'has child age')
341
- assert.strictEqual(root.getElementsByTagName('sex')[0].textContent!.trim(), 'male', 'has parent sex')
342
- assert.notOk(root.getElementsByTagName('newsletter')[0], 'has no optional parent newsletter')
343
- assert.strictEqual(
344
- root.getElementsByTagName('tosAccepted')[0].textContent!.trim(),
345
- 'false',
346
- 'has parent tosAccepted'
347
- )
348
- const addedProperty = root.getElementsByTagName('addedProperty')[0].textContent!.trim()
349
- assert.match(addedProperty, /^[0-9]{2}:[0-9]{2}:[0-9]{2}$/, 'has child addedProperty')
350
- })
351
-
352
- // examples are not correctly inherited with unions
353
- test('renders example from an union object', async ({ assert }) => {
354
- const shape = loader.getShape(model, 'ObjectUnionWithExample')
355
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
356
- renderExamples: true,
357
- })
358
- const parser = new DOMParser()
359
- const schema = parser.parseFromString(String(result), xmlMime)
360
-
361
- const root = schema.getElementsByTagName('ObjectUnionWithExample')[0]
362
- assert.ok(root, 'has the root node')
363
- assert.strictEqual(root.getElementsByTagName('error')[0].textContent!.trim(), 'true', 'has schema.error')
364
- assert.strictEqual(
365
- root.getElementsByTagName('message')[0].textContent!.trim(),
366
- 'Error message',
367
- 'has schema.message'
368
- )
369
- assert.notOk(root.getElementsByTagName('optional')[0], 'has no optional property')
370
- }).skip()
371
-
372
- test('does not renders example from an union object when not configured', async ({ assert }) => {
373
- const shape = loader.getShape(model, 'ObjectUnionWithExample')
374
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime, {
375
- renderMocked: true,
376
- })
377
- const parser = new DOMParser()
378
- const schema = parser.parseFromString(String(result), xmlMime)
379
-
380
- const root = schema.getElementsByTagName('ObjectUnionWithExample')[0]
381
- assert.ok(root, 'has the root node')
382
- assert.match(root.getElementsByTagName('error')[0].textContent!.trim(), /false|true/, 'has default schema.error')
383
- assert.isNotEmpty(root.getElementsByTagName('message')[0].textContent!.trim(), 'has default schema.message')
384
- assert.notOk(root.getElementsByTagName('optional')[0], 'has no optional property')
385
- })
386
-
387
- test('marks scalar | nil union as optional', async ({ assert }) => {
388
- const shape = loader.getShape(model, 'ObjectScalarUnionNill')
389
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime)
390
- assert.equal(result, '<ObjectScalarUnionNill>\n</ObjectScalarUnionNill>', 'is a string')
391
- })
392
-
393
- // I am not sure how this should work.
394
- // In RAML spec it says that scalar + nil makes the scalar optional.
395
- // Should it be the same for an object?
396
- test('marks object | nil union as optional', async ({ assert }) => {
397
- const shape = loader.getShape(model, 'UnionNill')
398
- const result = ApiSchemaGenerator.asSchema(shape, xmlMime)
399
- assert.equal(result, '<UnionNill></UnionNill>', 'is a string')
400
- }).skip()
401
- })
@@ -1,42 +0,0 @@
1
- import { test } from '@japa/runner'
2
- import { ApiSchemaGenerator } from '../../../src/amf/ApiSchemaGenerator.js'
3
- import { AmfLoader } from './AmfLoader.js'
4
- import { IAmfDocument } from '../../../src/amf/definitions/Amf.js'
5
-
6
- const loader = new AmfLoader()
7
-
8
- test.group('unknown media type', (group) => {
9
- const unknownMime = 'any/text'
10
-
11
- let model: IAmfDocument
12
-
13
- group.setup(async () => {
14
- model = await loader.getGraph('schema-api')
15
- })
16
-
17
- test('does not set the generator property', async ({ assert }) => {
18
- const inst = new ApiSchemaGenerator(unknownMime)
19
- assert.isUndefined(inst.generator)
20
- })
21
-
22
- test('returns undefined on generate() ', async ({ assert }) => {
23
- const shape = loader.getShape(model, 'ScalarType')
24
- const inst = new ApiSchemaGenerator(unknownMime)
25
- const result = inst.generate(shape)
26
- assert.isUndefined(result)
27
- })
28
-
29
- test('returns undefined on toValue() ', async ({ assert }) => {
30
- const shape = loader.getShape(model, 'ScalarType')
31
- const inst = new ApiSchemaGenerator(unknownMime)
32
- const result = inst.generate(shape)
33
- assert.isUndefined(result)
34
- })
35
-
36
- test('returns undefined on toExample() ', async ({ assert }) => {
37
- const shape = loader.getShape(model, 'ScalarType')
38
- const inst = new ApiSchemaGenerator(unknownMime)
39
- const result = inst.toExample(shape)
40
- assert.isUndefined(result)
41
- })
42
- })