@api-client/core 0.19.10 → 0.19.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (466) hide show
  1. package/LICENSE.md +9 -63
  2. package/bin/test.ts +1 -12
  3. package/build/src/browser.d.ts +3 -16
  4. package/build/src/browser.d.ts.map +1 -1
  5. package/build/src/browser.js +2 -17
  6. package/build/src/browser.js.map +1 -1
  7. package/build/src/events/EventTypes.d.ts +0 -6
  8. package/build/src/events/EventTypes.d.ts.map +1 -1
  9. package/build/src/events/EventTypes.js +0 -2
  10. package/build/src/events/EventTypes.js.map +1 -1
  11. package/build/src/events/Events.d.ts +0 -2
  12. package/build/src/events/Events.d.ts.map +1 -1
  13. package/build/src/events/Events.js +0 -2
  14. package/build/src/events/Events.js.map +1 -1
  15. package/build/src/index.d.ts +3 -16
  16. package/build/src/index.d.ts.map +1 -1
  17. package/build/src/index.js +2 -17
  18. package/build/src/index.js.map +1 -1
  19. package/build/src/modeling/ApiValidation.d.ts +26 -0
  20. package/build/src/modeling/ApiValidation.d.ts.map +1 -0
  21. package/build/src/modeling/ApiValidation.js +73 -0
  22. package/build/src/modeling/ApiValidation.js.map +1 -0
  23. package/build/src/modeling/Bindings.d.ts +3 -3
  24. package/build/src/modeling/Bindings.d.ts.map +1 -1
  25. package/build/src/modeling/Bindings.js.map +1 -1
  26. package/build/src/modeling/DomainAssociation.d.ts +5 -5
  27. package/build/src/modeling/DomainAssociation.d.ts.map +1 -1
  28. package/build/src/modeling/DomainAssociation.js.map +1 -1
  29. package/build/src/modeling/DomainEntity.d.ts +2 -3
  30. package/build/src/modeling/DomainEntity.d.ts.map +1 -1
  31. package/build/src/modeling/DomainEntity.js +1 -1
  32. package/build/src/modeling/DomainEntity.js.map +1 -1
  33. package/build/src/modeling/DomainProperty.d.ts +2 -3
  34. package/build/src/modeling/DomainProperty.d.ts.map +1 -1
  35. package/build/src/modeling/DomainProperty.js +1 -1
  36. package/build/src/modeling/DomainProperty.js.map +1 -1
  37. package/build/src/modeling/DomainValidation.d.ts +10 -4
  38. package/build/src/modeling/DomainValidation.d.ts.map +1 -1
  39. package/build/src/modeling/DomainValidation.js +55 -72
  40. package/build/src/modeling/DomainValidation.js.map +1 -1
  41. package/build/src/modeling/ai/types.d.ts +2 -2
  42. package/build/src/modeling/ai/types.d.ts.map +1 -1
  43. package/build/src/modeling/ai/types.js.map +1 -1
  44. package/build/src/{amf → modeling/amf}/DataValueGenerator.d.ts +1 -1
  45. package/build/src/modeling/amf/DataValueGenerator.d.ts.map +1 -0
  46. package/build/src/{amf → modeling/amf}/DataValueGenerator.js +2 -3
  47. package/build/src/modeling/amf/DataValueGenerator.js.map +1 -0
  48. package/build/src/modeling/amf/ShapeGenerator.d.ts +20 -20
  49. package/build/src/modeling/amf/ShapeGenerator.d.ts.map +1 -1
  50. package/build/src/modeling/amf/ShapeGenerator.js +16 -18
  51. package/build/src/modeling/amf/ShapeGenerator.js.map +1 -1
  52. package/build/src/modeling/amf/core_types.d.ts +9 -0
  53. package/build/src/modeling/amf/core_types.d.ts.map +1 -0
  54. package/build/src/modeling/amf/core_types.js +45 -0
  55. package/build/src/modeling/amf/core_types.js.map +1 -0
  56. package/build/src/modeling/validation/api_model_rules.d.ts +1 -2
  57. package/build/src/modeling/validation/api_model_rules.d.ts.map +1 -1
  58. package/build/src/modeling/validation/api_model_rules.js +0 -26
  59. package/build/src/modeling/validation/api_model_rules.js.map +1 -1
  60. package/build/src/modeling/validation/association_validation.d.ts +4 -4
  61. package/build/src/modeling/validation/association_validation.d.ts.map +1 -1
  62. package/build/src/modeling/validation/association_validation.js.map +1 -1
  63. package/build/src/modeling/validation/entity_validation.d.ts +6 -6
  64. package/build/src/modeling/validation/entity_validation.d.ts.map +1 -1
  65. package/build/src/modeling/validation/entity_validation.js.map +1 -1
  66. package/build/src/modeling/validation/property_validation.d.ts +3 -3
  67. package/build/src/modeling/validation/property_validation.d.ts.map +1 -1
  68. package/build/src/modeling/validation/property_validation.js.map +1 -1
  69. package/build/src/modeling/validation/rules.d.ts +2 -2
  70. package/build/src/modeling/validation/rules.d.ts.map +1 -1
  71. package/build/src/modeling/validation/rules.js.map +1 -1
  72. package/build/src/modeling/validation/semantic_validation.d.ts +2 -2
  73. package/build/src/modeling/validation/semantic_validation.d.ts.map +1 -1
  74. package/build/src/modeling/validation/semantic_validation.js.map +1 -1
  75. package/build/src/models/http-flows/LegacyTranslator.js +1 -1
  76. package/build/src/models/http-flows/LegacyTranslator.js.map +1 -1
  77. package/build/src/runtime/http-runner/HttpFlows.js +1 -1
  78. package/build/src/runtime/http-runner/HttpFlows.js.map +1 -1
  79. package/build/tsconfig.tsbuildinfo +1 -1
  80. package/eslint.config.js +0 -1
  81. package/package.json +11 -14
  82. package/src/events/EventTypes.ts +0 -2
  83. package/src/events/Events.ts +0 -2
  84. package/src/modeling/ApiValidation.ts +86 -0
  85. package/src/modeling/Bindings.ts +3 -3
  86. package/src/modeling/DomainAssociation.ts +5 -5
  87. package/src/modeling/DomainEntity.ts +3 -4
  88. package/src/modeling/DomainProperty.ts +3 -4
  89. package/src/modeling/DomainValidation.ts +57 -74
  90. package/src/modeling/ai/types.ts +2 -2
  91. package/src/{amf → modeling/amf}/DataValueGenerator.ts +3 -4
  92. package/src/modeling/amf/ShapeGenerator.ts +45 -61
  93. package/src/modeling/amf/core_types.ts +47 -0
  94. package/src/modeling/validation/api_model_rules.ts +1 -31
  95. package/src/modeling/validation/association_validation.ts +6 -6
  96. package/src/modeling/validation/entity_validation.ts +11 -11
  97. package/src/modeling/validation/property_validation.ts +4 -4
  98. package/src/modeling/validation/rules.ts +6 -3
  99. package/src/modeling/validation/semantic_validation.ts +11 -11
  100. package/src/models/http-flows/LegacyTranslator.ts +1 -1
  101. package/src/runtime/http-runner/HttpFlows.ts +1 -1
  102. package/tests/unit/{amf → modeling/amf}/data_value_generator.spec.ts +2 -2
  103. package/tests/unit/modeling/amf/shape_generator.spec.ts +146 -167
  104. package/tests/unit/modeling/domain_asociation.spec.ts +13 -13
  105. package/tests/unit/modeling/domain_validation.spec.ts +7 -13
  106. package/tests/unit/modeling/validation/api_model_rules.spec.ts +11 -9
  107. package/tests/unit/runtime/runners/http_assertion_runner.spec.ts +1 -1
  108. package/tests/unit/runtime/runners/http_flow_runner.spec.ts +1 -1
  109. package/tests/unit/runtime/runners/project_runner.spec.ts +1 -1
  110. package/tests/unit/runtime/runners/request_runner.spec.ts +1 -1
  111. package/tests/unit/runtime/runners/serial_runner.spec.ts +1 -1
  112. package/build/src/amf/AmfMixin.d.ts +0 -396
  113. package/build/src/amf/AmfMixin.d.ts.map +0 -1
  114. package/build/src/amf/AmfMixin.js +0 -1138
  115. package/build/src/amf/AmfMixin.js.map +0 -1
  116. package/build/src/amf/AmfSerializer.d.ts +0 -137
  117. package/build/src/amf/AmfSerializer.d.ts.map +0 -1
  118. package/build/src/amf/AmfSerializer.js +0 -1947
  119. package/build/src/amf/AmfSerializer.js.map +0 -1
  120. package/build/src/amf/AmfTypes.d.ts +0 -25
  121. package/build/src/amf/AmfTypes.d.ts.map +0 -1
  122. package/build/src/amf/AmfTypes.js +0 -143
  123. package/build/src/amf/AmfTypes.js.map +0 -1
  124. package/build/src/amf/ApiExampleGenerator.d.ts +0 -40
  125. package/build/src/amf/ApiExampleGenerator.d.ts.map +0 -1
  126. package/build/src/amf/ApiExampleGenerator.js +0 -112
  127. package/build/src/amf/ApiExampleGenerator.js.map +0 -1
  128. package/build/src/amf/ApiMonacoSchemaGenerator.d.ts +0 -68
  129. package/build/src/amf/ApiMonacoSchemaGenerator.d.ts.map +0 -1
  130. package/build/src/amf/ApiMonacoSchemaGenerator.js +0 -248
  131. package/build/src/amf/ApiMonacoSchemaGenerator.js.map +0 -1
  132. package/build/src/amf/ApiSchemaGenerator.d.ts +0 -56
  133. package/build/src/amf/ApiSchemaGenerator.d.ts.map +0 -1
  134. package/build/src/amf/ApiSchemaGenerator.js +0 -94
  135. package/build/src/amf/ApiSchemaGenerator.js.map +0 -1
  136. package/build/src/amf/ApiSchemaValues.d.ts +0 -111
  137. package/build/src/amf/ApiSchemaValues.d.ts.map +0 -1
  138. package/build/src/amf/ApiSchemaValues.js +0 -463
  139. package/build/src/amf/ApiSchemaValues.js.map +0 -1
  140. package/build/src/amf/DataValueGenerator.d.ts.map +0 -1
  141. package/build/src/amf/DataValueGenerator.js.map +0 -1
  142. package/build/src/amf/Parsing.d.ts +0 -48
  143. package/build/src/amf/Parsing.d.ts.map +0 -1
  144. package/build/src/amf/Parsing.js +0 -2
  145. package/build/src/amf/Parsing.js.map +0 -1
  146. package/build/src/amf/Utils.d.ts +0 -37
  147. package/build/src/amf/Utils.d.ts.map +0 -1
  148. package/build/src/amf/Utils.js +0 -169
  149. package/build/src/amf/Utils.js.map +0 -1
  150. package/build/src/amf/data-node/DataNodeBase.d.ts +0 -34
  151. package/build/src/amf/data-node/DataNodeBase.d.ts.map +0 -1
  152. package/build/src/amf/data-node/DataNodeBase.js +0 -77
  153. package/build/src/amf/data-node/DataNodeBase.js.map +0 -1
  154. package/build/src/amf/data-node/JsonDataNodeGenerator.d.ts +0 -15
  155. package/build/src/amf/data-node/JsonDataNodeGenerator.d.ts.map +0 -1
  156. package/build/src/amf/data-node/JsonDataNodeGenerator.js +0 -23
  157. package/build/src/amf/data-node/JsonDataNodeGenerator.js.map +0 -1
  158. package/build/src/amf/data-node/UrlEncodedDataNodeGenerator.d.ts +0 -14
  159. package/build/src/amf/data-node/UrlEncodedDataNodeGenerator.d.ts.map +0 -1
  160. package/build/src/amf/data-node/UrlEncodedDataNodeGenerator.js +0 -48
  161. package/build/src/amf/data-node/UrlEncodedDataNodeGenerator.js.map +0 -1
  162. package/build/src/amf/data-node/XmlDataNodeGenerator.d.ts +0 -22
  163. package/build/src/amf/data-node/XmlDataNodeGenerator.d.ts.map +0 -1
  164. package/build/src/amf/data-node/XmlDataNodeGenerator.js +0 -34
  165. package/build/src/amf/data-node/XmlDataNodeGenerator.js.map +0 -1
  166. package/build/src/amf/definitions/Amf.d.ts +0 -363
  167. package/build/src/amf/definitions/Amf.d.ts.map +0 -1
  168. package/build/src/amf/definitions/Amf.js +0 -3
  169. package/build/src/amf/definitions/Amf.js.map +0 -1
  170. package/build/src/amf/definitions/Api.d.ts +0 -383
  171. package/build/src/amf/definitions/Api.d.ts.map +0 -1
  172. package/build/src/amf/definitions/Api.js +0 -2
  173. package/build/src/amf/definitions/Api.js.map +0 -1
  174. package/build/src/amf/definitions/Base.d.ts +0 -12
  175. package/build/src/amf/definitions/Base.d.ts.map +0 -1
  176. package/build/src/amf/definitions/Base.js +0 -2
  177. package/build/src/amf/definitions/Base.js.map +0 -1
  178. package/build/src/amf/definitions/Namespace.d.ts +0 -327
  179. package/build/src/amf/definitions/Namespace.d.ts.map +0 -1
  180. package/build/src/amf/definitions/Namespace.js +0 -346
  181. package/build/src/amf/definitions/Namespace.js.map +0 -1
  182. package/build/src/amf/definitions/Shapes.d.ts +0 -312
  183. package/build/src/amf/definitions/Shapes.d.ts.map +0 -1
  184. package/build/src/amf/definitions/Shapes.js +0 -87
  185. package/build/src/amf/definitions/Shapes.js.map +0 -1
  186. package/build/src/amf/models/AmfDataNode.d.ts +0 -67
  187. package/build/src/amf/models/AmfDataNode.d.ts.map +0 -1
  188. package/build/src/amf/models/AmfDataNode.js +0 -192
  189. package/build/src/amf/models/AmfDataNode.js.map +0 -1
  190. package/build/src/amf/shape/ShapeBase.d.ts +0 -74
  191. package/build/src/amf/shape/ShapeBase.d.ts.map +0 -1
  192. package/build/src/amf/shape/ShapeBase.js +0 -93
  193. package/build/src/amf/shape/ShapeBase.js.map +0 -1
  194. package/build/src/amf/shape/ShapeJsonSchemaGenerator.d.ts +0 -47
  195. package/build/src/amf/shape/ShapeJsonSchemaGenerator.d.ts.map +0 -1
  196. package/build/src/amf/shape/ShapeJsonSchemaGenerator.js +0 -420
  197. package/build/src/amf/shape/ShapeJsonSchemaGenerator.js.map +0 -1
  198. package/build/src/amf/shape/ShapeXmlSchemaGenerator.d.ts +0 -85
  199. package/build/src/amf/shape/ShapeXmlSchemaGenerator.d.ts.map +0 -1
  200. package/build/src/amf/shape/ShapeXmlSchemaGenerator.js +0 -852
  201. package/build/src/amf/shape/ShapeXmlSchemaGenerator.js.map +0 -1
  202. package/build/src/events/amf/AmfEventTypes.d.ts +0 -7
  203. package/build/src/events/amf/AmfEventTypes.d.ts.map +0 -1
  204. package/build/src/events/amf/AmfEventTypes.js +0 -7
  205. package/build/src/events/amf/AmfEventTypes.js.map +0 -1
  206. package/build/src/events/amf/AmfEvents.d.ts +0 -34
  207. package/build/src/events/amf/AmfEvents.d.ts.map +0 -1
  208. package/build/src/events/amf/AmfEvents.js +0 -63
  209. package/build/src/events/amf/AmfEvents.js.map +0 -1
  210. package/build/src/mocking/RandExp.d.ts +0 -55
  211. package/build/src/mocking/RandExp.d.ts.map +0 -1
  212. package/build/src/mocking/RandExp.js +0 -302
  213. package/build/src/mocking/RandExp.js.map +0 -1
  214. package/build/src/mocking/lib/ret.d.ts +0 -16
  215. package/build/src/mocking/lib/ret.d.ts.map +0 -1
  216. package/build/src/mocking/lib/ret.js +0 -284
  217. package/build/src/mocking/lib/ret.js.map +0 -1
  218. package/data/apis/APIC-187/APIC-187.raml +0 -21
  219. package/data/apis/APIC-187/dataType.raml +0 -132
  220. package/data/apis/APIC-187/example.raml +0 -84
  221. package/data/apis/APIC-188/APIC-188.raml +0 -21
  222. package/data/apis/APIC-188/dataType.raml +0 -132
  223. package/data/apis/APIC-188/example.raml +0 -84
  224. package/data/apis/APIC-233/APIC-233.raml +0 -15
  225. package/data/apis/APIC-391/APIC-391.raml +0 -44
  226. package/data/apis/APIC-391/examples/post-body-request-example.raml +0 -7
  227. package/data/apis/APIC-483/APIC-483.raml +0 -16
  228. package/data/apis/APIC-483/example/list-of-bank-succ.json +0 -32
  229. package/data/apis/APIC-483/schema/response-retrieve-list-bank.json +0 -68
  230. package/data/apis/APIC-487/APIC-487.raml +0 -36
  231. package/data/apis/APIC-655/APIC-655.raml +0 -44
  232. package/data/apis/APIC-655/delivery.json +0 -12
  233. package/data/apis/APIC-689/APIC-689.raml +0 -20
  234. package/data/apis/APIC-690/APIC-690.raml +0 -17
  235. package/data/apis/APIC-690/datatypes/Address.raml +0 -10
  236. package/data/apis/APIC-690/datatypes/Customer.raml +0 -17
  237. package/data/apis/APIC-690/examples/CustomerExample2.raml +0 -17
  238. package/data/apis/APIC-690/examples/CustomersExample.raml +0 -34
  239. package/data/apis/SE-10469/Purchase-Order-oagis-id-dd32f9c6c01048a19e15c423c9c741ae.json +0 -1383
  240. package/data/apis/SE-10469/SE-10469.raml +0 -11
  241. package/data/apis/SE-13092/Examples/PersonExample.raml +0 -7
  242. package/data/apis/SE-13092/SE-13092.raml +0 -37
  243. package/data/apis/SE-13092/datatypes/Address.raml +0 -5
  244. package/data/apis/SE-13092/datatypes/InlineType.raml +0 -5
  245. package/data/apis/SE-13092/datatypes/Person.raml +0 -15
  246. package/data/apis/SE-22063/SE-22063.raml +0 -14
  247. package/data/apis/SE-22063/stock.raml +0 -41
  248. package/data/apis/amf-helper-api/amf-helper-api.raml +0 -1024
  249. package/data/apis/amf-helper-api/examples/comment-example.json +0 -42
  250. package/data/apis/amf-helper-api/examples/commentCreateRequest-example.json +0 -7
  251. package/data/apis/amf-helper-api/examples/commentList-example.json +0 -48
  252. package/data/apis/amf-helper-api/examples/person.json +0 -14
  253. package/data/apis/amf-helper-api/examples/person.raml +0 -13
  254. package/data/apis/amf-helper-api/examples/person.xml +0 -14
  255. package/data/apis/amf-helper-api/libraries/comment-lib.raml +0 -143
  256. package/data/apis/amf-helper-api/library.raml +0 -7
  257. package/data/apis/amf-helper-api/schemas/person.json +0 -104
  258. package/data/apis/amf-helper-api/schemas/person.xsd +0 -26
  259. package/data/apis/amf-helper-api/traits/file.raml +0 -33
  260. package/data/apis/amf-helper-api/traits/pagination.raml +0 -80
  261. package/data/apis/amf-helper-api/traits/results.raml +0 -19
  262. package/data/apis/amf-helper-api/traits/visibility.raml +0 -14
  263. package/data/apis/amf-helper-api/types/app-person.raml +0 -101
  264. package/data/apis/amf-helper-api/types/dimensions.raml +0 -24
  265. package/data/apis/amf-helper-api/types/external-type.raml +0 -7
  266. package/data/apis/amf-helper-api/types/image.raml +0 -23
  267. package/data/apis/amf-helper-api/types/product.raml +0 -52
  268. package/data/apis/amf-helper-api/types/resource.raml +0 -11
  269. package/data/apis/amf-helper-api/types/standard-request.raml +0 -50
  270. package/data/apis/amf-helper-api/types/user.raml +0 -37
  271. package/data/apis/arc-demo-api/arc-demo-api.raml +0 -468
  272. package/data/apis/arc-demo-api/examples/e400.xml +0 -4
  273. package/data/apis/arc-demo-api/examples/e401.xml +0 -4
  274. package/data/apis/arc-demo-api/examples/e404.xml +0 -4
  275. package/data/apis/arc-demo-api/examples/image.xml +0 -5
  276. package/data/apis/arc-demo-api/examples/messages-example.json +0 -22
  277. package/data/apis/arc-demo-api/examples/messages-sent-example.json +0 -15
  278. package/data/apis/arc-demo-api/examples/person.json +0 -14
  279. package/data/apis/arc-demo-api/examples/person.url.encoded +0 -1
  280. package/data/apis/arc-demo-api/examples/person.xml +0 -14
  281. package/data/apis/arc-demo-api/examples/product.xml +0 -9
  282. package/data/apis/arc-demo-api/library.raml +0 -36
  283. package/data/apis/arc-demo-api/resourceTypes/app-person.raml +0 -49
  284. package/data/apis/arc-demo-api/resourceTypes/example-types.raml +0 -45
  285. package/data/apis/arc-demo-api/resourceTypes/image.raml +0 -23
  286. package/data/apis/arc-demo-api/resourceTypes/message-sent-type.raml +0 -23
  287. package/data/apis/arc-demo-api/resourceTypes/message-type.raml +0 -33
  288. package/data/apis/arc-demo-api/resourceTypes/product.raml +0 -52
  289. package/data/apis/arc-demo-api/resourceTypes/resource.raml +0 -11
  290. package/data/apis/arc-demo-api/schemas/error-response.xsd +0 -11
  291. package/data/apis/arc-demo-api/schemas/image.xsd +0 -11
  292. package/data/apis/arc-demo-api/schemas/person.json +0 -104
  293. package/data/apis/arc-demo-api/schemas/person.xsd +0 -26
  294. package/data/apis/arc-demo-api/schemas/product.xsd +0 -17
  295. package/data/apis/arc-demo-api/securitySchemes/basic.raml +0 -5
  296. package/data/apis/arc-demo-api/securitySchemes/oauth_2_0.raml +0 -29
  297. package/data/apis/arc-demo-api/securitySchemes/x-custom.raml +0 -26
  298. package/data/apis/arc-demo-api/traits/adminable.raml +0 -23
  299. package/data/apis/arc-demo-api/traits/pagination.raml +0 -83
  300. package/data/apis/arc-demo-api/traits/rate-limited.raml +0 -9
  301. package/data/apis/async-api/async-api.yaml +0 -96
  302. package/data/apis/example-generator-api/contact-email-example.raml +0 -6
  303. package/data/apis/example-generator-api/contact-example.raml +0 -5
  304. package/data/apis/example-generator-api/contact-fax-example.raml +0 -5
  305. package/data/apis/example-generator-api/contact-website-example.raml +0 -2
  306. package/data/apis/example-generator-api/example-1.raml +0 -6
  307. package/data/apis/example-generator-api/example-2.raml +0 -9
  308. package/data/apis/example-generator-api/example-3.raml +0 -4
  309. package/data/apis/example-generator-api/example-4.raml +0 -2
  310. package/data/apis/example-generator-api/example-5.raml +0 -4
  311. package/data/apis/example-generator-api/example-6.raml +0 -2
  312. package/data/apis/example-generator-api/example-7.raml +0 -5
  313. package/data/apis/example-generator-api/example-generator-api.raml +0 -423
  314. package/data/apis/example-generator-api/example.json +0 -14
  315. package/data/apis/example-generator-api/example.xml +0 -15
  316. package/data/apis/example-generator-api/example.xsd +0 -26
  317. package/data/apis/example-generator-api/examples/employee.raml +0 -7
  318. package/data/apis/example-generator-api/examples/employees.raml +0 -7
  319. package/data/apis/example-generator-api/linked-named-example.raml +0 -21
  320. package/data/apis/example-generator-api/named-example-with-link.raml +0 -5
  321. package/data/apis/example-generator-api/named-example.raml +0 -9
  322. package/data/apis/example-generator-api/user-json-example.raml +0 -17
  323. package/data/apis/example-generator-api/user-raml-example.raml +0 -37
  324. package/data/apis/example-generator-api/user.json +0 -8
  325. package/data/apis/example-generator-api/user.raml +0 -18
  326. package/data/apis/example-generator-api/users-json-example.raml +0 -17
  327. package/data/apis/example-generator-api/users-raml-example.raml +0 -32
  328. package/data/apis/example-generator-api/users.json +0 -8
  329. package/data/apis/expanded-api/expanded-api.raml +0 -8
  330. package/data/apis/flattened-api/flattened-api.raml +0 -8
  331. package/data/apis/multiple-servers/multiple-servers.yaml +0 -112
  332. package/data/apis/oas-3-api/oas-3-api.yaml +0 -356
  333. package/data/apis/oas-date/oas-date.yaml +0 -28
  334. package/data/apis/oas-types/oas-types.yaml +0 -159
  335. package/data/apis/oas-unions/oas-unions.yaml +0 -75
  336. package/data/apis/petstore/petstore.yaml +0 -954
  337. package/data/apis/raml-date/raml-date.raml +0 -28
  338. package/data/apis/recursive/recursive.raml +0 -14
  339. package/data/apis/schema-api/examples/person.json +0 -14
  340. package/data/apis/schema-api/examples/person.raml +0 -14
  341. package/data/apis/schema-api/examples/person.url.encoded +0 -1
  342. package/data/apis/schema-api/examples/person.xml +0 -14
  343. package/data/apis/schema-api/library/demo-types.raml +0 -43
  344. package/data/apis/schema-api/schema-api.raml +0 -656
  345. package/data/apis/schema-api/schemas/person.json +0 -104
  346. package/data/apis/schema-api/schemas/person.xsd +0 -26
  347. package/data/apis/schema-api/types/DemoPerson.raml +0 -67
  348. package/data/apis/secured-api/oauth-2-custom-settings.raml +0 -143
  349. package/data/apis/secured-api/oauth2-header-delivery.raml +0 -13
  350. package/data/apis/secured-api/oauth2-no-delivery.raml +0 -8
  351. package/data/apis/secured-api/oauth2-no-grants.raml +0 -12
  352. package/data/apis/secured-api/oauth2-pkce.raml +0 -13
  353. package/data/apis/secured-api/oauth2-query-delivery.raml +0 -13
  354. package/data/apis/secured-api/oauth_1_0.raml +0 -8
  355. package/data/apis/secured-api/oauth_1_0_no-settings.raml +0 -3
  356. package/data/apis/secured-api/oauth_1_0_no-signature.raml +0 -7
  357. package/data/apis/secured-api/oauth_1_0_signature.raml +0 -8
  358. package/data/apis/secured-api/passthrough-querystring.raml +0 -16
  359. package/data/apis/secured-api/passthrough.raml +0 -24
  360. package/data/apis/secured-api/secured-api.raml +0 -231
  361. package/data/apis/secured-api/x-custom.raml +0 -33
  362. package/data/apis/secured-api/x-other.raml +0 -29
  363. package/data/apis/secured-api/x-query-string.raml +0 -16
  364. package/data/apis/tracked-examples/datatypes/employee.raml +0 -5
  365. package/data/apis/tracked-examples/examples/employee.raml +0 -4
  366. package/data/apis/tracked-examples/examples/employees.raml +0 -8
  367. package/data/apis/tracked-examples/tracked-to-linked.raml +0 -28
  368. package/data/model.js +0 -129
  369. package/data/models/APIC-187.json +0 -11416
  370. package/data/models/APIC-188.json +0 -11416
  371. package/data/models/APIC-233.json +0 -539
  372. package/data/models/APIC-391.json +0 -1903
  373. package/data/models/APIC-483.json +0 -3110
  374. package/data/models/APIC-487.json +0 -1225
  375. package/data/models/APIC-655.json +0 -3145
  376. package/data/models/APIC-689.json +0 -797
  377. package/data/models/APIC-690.json +0 -5992
  378. package/data/models/SE-10469.json +0 -22898
  379. package/data/models/SE-13092.json +0 -2769
  380. package/data/models/SE-22063.json +0 -2314
  381. package/data/models/amf-helper-api.json +0 -84457
  382. package/data/models/arc-demo-api.json +0 -52041
  383. package/data/models/async-api.json +0 -3227
  384. package/data/models/example-generator-api.json +0 -45209
  385. package/data/models/expanded-api.json +0 -251
  386. package/data/models/flattened-api.json +0 -251
  387. package/data/models/multiple-servers.json +0 -2769
  388. package/data/models/oas-3-api.json +0 -10590
  389. package/data/models/oas-date.json +0 -637
  390. package/data/models/oas-types.json +0 -5352
  391. package/data/models/oas-unions.json +0 -1935
  392. package/data/models/petstore.json +0 -27712
  393. package/data/models/raml-date.json +0 -1114
  394. package/data/models/recursive.json +0 -610
  395. package/data/models/schema-api.json +0 -35527
  396. package/data/models/secured-api.json +0 -21071
  397. package/data/models/tracked-to-linked.json +0 -1914
  398. package/src/amf/AmfMixin.ts +0 -1726
  399. package/src/amf/AmfSerializer.ts +0 -2358
  400. package/src/amf/AmfTypes.ts +0 -147
  401. package/src/amf/ApiExampleGenerator.ts +0 -122
  402. package/src/amf/ApiMonacoSchemaGenerator.ts +0 -332
  403. package/src/amf/ApiSchemaGenerator.ts +0 -115
  404. package/src/amf/ApiSchemaValues.ts +0 -509
  405. package/src/amf/Parsing.ts +0 -50
  406. package/src/amf/Utils.ts +0 -172
  407. package/src/amf/data-node/DataNodeBase.ts +0 -83
  408. package/src/amf/data-node/JsonDataNodeGenerator.ts +0 -24
  409. package/src/amf/data-node/README.md +0 -3
  410. package/src/amf/data-node/UrlEncodedDataNodeGenerator.ts +0 -49
  411. package/src/amf/data-node/XmlDataNodeGenerator.ts +0 -46
  412. package/src/amf/definitions/Amf.ts +0 -440
  413. package/src/amf/definitions/Api.ts +0 -445
  414. package/src/amf/definitions/Base.ts +0 -13
  415. package/src/amf/definitions/Namespace.ts +0 -357
  416. package/src/amf/definitions/Shapes.ts +0 -438
  417. package/src/amf/models/AmfDataNode.ts +0 -210
  418. package/src/amf/shape/README.md +0 -4
  419. package/src/amf/shape/ShapeBase.ts +0 -174
  420. package/src/amf/shape/ShapeJsonSchemaGenerator.ts +0 -457
  421. package/src/amf/shape/ShapeXmlSchemaGenerator.ts +0 -933
  422. package/src/events/amf/AmfEventTypes.ts +0 -6
  423. package/src/events/amf/AmfEvents.ts +0 -78
  424. package/src/mocking/RandExp.ts +0 -335
  425. package/src/mocking/lib/ret.ts +0 -279
  426. package/tests/unit/amf/APIC-187.spec.ts +0 -41
  427. package/tests/unit/amf/APIC-188.spec.ts +0 -30
  428. package/tests/unit/amf/APIC-233.spec.ts +0 -32
  429. package/tests/unit/amf/APIC-391.spec.ts +0 -39
  430. package/tests/unit/amf/APIC-487.spec.ts +0 -44
  431. package/tests/unit/amf/APIC-655.spec.ts +0 -41
  432. package/tests/unit/amf/APIC-689.spec.ts +0 -28
  433. package/tests/unit/amf/APIC-690.spec.ts +0 -93
  434. package/tests/unit/amf/AmfLoader.ts +0 -538
  435. package/tests/unit/amf/AmfMixin.spec.ts +0 -1707
  436. package/tests/unit/amf/ApiExampleGenerator.spec.ts +0 -250
  437. package/tests/unit/amf/ApiMonacoSchemaGenerator.spec.ts +0 -183
  438. package/tests/unit/amf/ApiSchemaValues.spec.ts +0 -602
  439. package/tests/unit/amf/Namepsace.spec.ts +0 -494
  440. package/tests/unit/amf/SE-10469.spec.ts +0 -35
  441. package/tests/unit/amf/SE-13092.spec.ts +0 -64
  442. package/tests/unit/amf/SE-22063.spec.ts +0 -45
  443. package/tests/unit/amf/raml-examples.spec.ts +0 -43
  444. package/tests/unit/amf/schema_gen_array.spec.ts +0 -199
  445. package/tests/unit/amf/schema_gen_oas.spec.ts +0 -140
  446. package/tests/unit/amf/schema_gen_object.spec.ts +0 -279
  447. package/tests/unit/amf/schema_gen_scalar.spec.ts +0 -143
  448. package/tests/unit/amf/schema_gen_union.spec.ts +0 -401
  449. package/tests/unit/amf/schema_gen_unknown.spec.ts +0 -42
  450. package/tests/unit/amf/schema_gen_xml.spec.ts +0 -726
  451. package/tests/unit/amf/serializer/APIC-483.spec.ts +0 -36
  452. package/tests/unit/amf/serializer/Anotations.spec.ts +0 -50
  453. package/tests/unit/amf/serializer/Api.spec.ts +0 -210
  454. package/tests/unit/amf/serializer/Documentation.spec.ts +0 -52
  455. package/tests/unit/amf/serializer/Endpoints.spec.ts +0 -172
  456. package/tests/unit/amf/serializer/Operations.spec.ts +0 -330
  457. package/tests/unit/amf/serializer/Parameters.spec.ts +0 -149
  458. package/tests/unit/amf/serializer/PayloadExamples.spec.ts +0 -152
  459. package/tests/unit/amf/serializer/Security.spec.ts +0 -626
  460. package/tests/unit/amf/serializer/Server.spec.ts +0 -78
  461. package/tests/unit/amf/serializer/Shapes.spec.ts +0 -304
  462. package/tests/unit/amf/serializer/SourceMaps.spec.ts +0 -52
  463. package/tests/unit/amf/shapes/ShapeXmlSchemaGenerator.spec.ts +0 -28
  464. package/tests/unit/amf/tracked-to-linked.spec.ts +0 -90
  465. package/tests/unit/amf/xml-data-processing.spec.ts +0 -217
  466. package/tests/unit/events/amf.spec.ts +0 -151
@@ -1,933 +0,0 @@
1
- import { AmfNamespace as ns } from '../definitions/Namespace.js'
2
- import { ShapeBase } from './ShapeBase.js'
3
- import { XmlDataNodeGenerator } from '../data-node/XmlDataNodeGenerator.js'
4
- import { collectNodeProperties, formatXmlValue, getUnionMember } from '../Utils.js'
5
- import {
6
- IApiAnyShape,
7
- IApiArrayShape,
8
- IApiDataExample,
9
- IApiDataNodeUnion,
10
- IApiNodeShape,
11
- IApiPropertyShape,
12
- IApiScalarShape,
13
- IShapeUnion,
14
- IApiUnionShape,
15
- } from '../definitions/Shapes.js'
16
-
17
- interface IProcessNodeOptions {
18
- forceName?: string
19
- indent?: number
20
- noWrap?: boolean
21
- }
22
-
23
- interface ICollectExamplesOptions {
24
- nodeName?: string
25
- indent?: number
26
- isWrapped?: boolean
27
- tagFill?: string
28
- }
29
-
30
- /**
31
- * Normalizes given name to a value that can be accepted by `createElement`
32
- * function on a document object.
33
- * @param name A name to process
34
- * @returns The normalized name
35
- */
36
- export const normalizeXmlTagName = (name: string): string => name.replace(/[^a-zA-Z0-9-_.]/g, '')
37
- const UNKNOWN_TYPE = 'unknown-type'
38
-
39
- export function shapeToXmlTagName(shape: IApiAnyShape): string {
40
- const { name, inherits = [], xmlSerialization } = shape
41
- let label: string | undefined =
42
- xmlSerialization && xmlSerialization.name ? xmlSerialization.name : name || UNKNOWN_TYPE
43
- if (label === 'schema' && inherits.length) {
44
- const n = inherits.find((i) => i.name && i.name !== 'schema')
45
- if (n) {
46
- label = n.name === 'type' ? n.displayName || n.name : n.name
47
- }
48
- }
49
- return normalizeXmlTagName(String(label))
50
- }
51
-
52
- export class ShapeXmlSchemaGenerator extends ShapeBase {
53
- /**
54
- * Generates a XML example from the structured value.
55
- *
56
- * @param schema The Shape definition
57
- */
58
- generate(schema: IShapeUnion | IApiPropertyShape<IShapeUnion>): string | undefined {
59
- let result: string | undefined
60
- if (schema.types.includes(ns.w3.shacl.PropertyShape)) {
61
- result = this._propertyShapeObject(schema as IApiPropertyShape<IShapeUnion>)
62
- } else {
63
- result = this.processNode(schema as IShapeUnion, {}, true)
64
- }
65
- return result
66
- }
67
-
68
- /**
69
- * Processes the Shape definition and returns a JavaScript object or array.
70
- */
71
- processNode(schema: IShapeUnion, options: IProcessNodeOptions = {}, isRoot = false): string | undefined {
72
- const { types } = schema
73
- if (types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
74
- return this._scalarShapeObject(schema as IApiScalarShape, options)
75
- }
76
- if (types.includes(ns.w3.shacl.NodeShape)) {
77
- return this._nodeShapeObject(schema as IApiNodeShape, options)
78
- }
79
- if (types.includes(ns.aml.vocabularies.shapes.UnionShape)) {
80
- return this._unionShapeObject(schema as IApiUnionShape)
81
- }
82
- if (types.includes(ns.aml.vocabularies.shapes.FileShape)) {
83
- return this._fileShapeObject()
84
- }
85
- if (types.includes(ns.aml.vocabularies.shapes.SchemaShape)) {
86
- return this._schemaShapeObject()
87
- }
88
- if (types.includes(ns.aml.vocabularies.shapes.TupleShape)) {
89
- return this._tupleShapeObject()
90
- }
91
- if (
92
- types.includes(ns.aml.vocabularies.shapes.ArrayShape) ||
93
- types.includes(ns.aml.vocabularies.shapes.MatrixShape)
94
- ) {
95
- return this._arrayShapeObject(schema as IApiArrayShape, options, isRoot)
96
- }
97
- return this._anyShapeObject(schema as IApiAnyShape)
98
- }
99
-
100
- /**
101
- * Serializes generated JS value according to the mime type.
102
- */
103
- serialize(value: unknown): string | undefined {
104
- return value as string
105
- }
106
-
107
- /**
108
- * Picks the union member to render.
109
- */
110
- protected _readCurrentUnion(anyOf: IShapeUnion[]): IShapeUnion {
111
- const { selectedUnions } = this.opts
112
- return getUnionMember(anyOf, selectedUnions)
113
- }
114
-
115
- protected _collectProperties(schema: IApiNodeShape): IApiPropertyShape[] {
116
- const { selectedUnions } = this.opts
117
- return collectNodeProperties(schema, selectedUnions)
118
- }
119
-
120
- protected _nodeShapeObject(schema: IApiNodeShape, options: IProcessNodeOptions = {}): string {
121
- const label = options.forceName || shapeToXmlTagName(schema)
122
- const parts: string[] = []
123
- const currentIndent = options.indent || 0
124
- const exampleValue = this._collectExamples(schema, {
125
- tagFill: new Array(currentIndent * 2 + 0).fill(' ').join(''),
126
- indent: currentIndent + 1,
127
- nodeName: label,
128
- })
129
- if (exampleValue) {
130
- return exampleValue
131
- }
132
- const attributes: string[] = []
133
- const properties = this._collectProperties(schema)
134
- properties.forEach((property) => {
135
- const { range, minCount = 0 } = property
136
- if ((minCount === 0 && !this.opts.renderOptional) || !range) {
137
- return
138
- }
139
- const anyRange = range as IApiAnyShape
140
- if (anyRange.xmlSerialization) {
141
- // Adds to the parent attributes list.
142
- // When a non-scalar shape has `attribute` serialization this is an API spec error.
143
- // Ignore such situation.
144
- if (anyRange.xmlSerialization.attribute && anyRange.types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
145
- let aLabel = normalizeXmlTagName(
146
- anyRange.xmlSerialization.name
147
- ? anyRange.xmlSerialization.name
148
- : property.name || anyRange.name || UNKNOWN_TYPE
149
- )
150
- if (anyRange.xmlSerialization.prefix) {
151
- aLabel = `${anyRange.xmlSerialization.prefix}:${aLabel}`
152
- }
153
- const value = this._scalarValue(anyRange)
154
- attributes.push(`${aLabel}="${value}"`)
155
- return
156
- }
157
- }
158
- const value = this._propertyShapeObject(property, { indent: currentIndent })
159
- if (typeof value !== 'undefined') {
160
- const offset = options.noWrap ? 0 : 2
161
- const fill = new Array(currentIndent * 2 + offset).fill(' ').join('')
162
- parts.push(formatXmlValue(fill, value))
163
- }
164
- })
165
- if (options.noWrap) {
166
- return parts.join('\n')
167
- }
168
-
169
- let opening = `<${label}`
170
- if (attributes.length) {
171
- opening += ' '
172
- opening += attributes.join(' ')
173
- }
174
- parts.unshift(`${opening}>`)
175
- const fill = new Array(currentIndent * 2).fill(' ').join('')
176
- parts.push(`${fill}</${label}>`)
177
- return parts.join('\n')
178
- }
179
-
180
- protected _scalarShapeObject(schema: IApiScalarShape, options: IProcessNodeOptions = {}): string {
181
- const { xmlSerialization, defaultValue } = schema
182
- let content
183
- if (defaultValue) {
184
- const gen = new XmlDataNodeGenerator()
185
- content = gen.processNode(defaultValue)
186
- } else {
187
- content = this._scalarValue(schema)
188
- }
189
- let label = options.forceName || shapeToXmlTagName(schema)
190
- const attributes = []
191
- const parts = []
192
- if (xmlSerialization) {
193
- const { namespace, prefix } = xmlSerialization
194
- if (namespace) {
195
- const attrName = prefix ? `xmlns:${prefix}` : 'xmlns'
196
- attributes.push(`${attrName}="${namespace}"`)
197
- }
198
- if (prefix) {
199
- label = `${prefix}:${label}`
200
- }
201
- }
202
- let opening = `<${label}`
203
- if (attributes.length) {
204
- opening += ' '
205
- opening += attributes.join(' ')
206
- }
207
- opening += '>'
208
- parts.push(opening)
209
- parts.push(content)
210
- parts.push(`</${label}>`)
211
-
212
- return parts.join('')
213
- }
214
-
215
- protected _nilShapeObject(schema: IApiScalarShape, options: IProcessNodeOptions = {}): string | undefined {
216
- const { xmlSerialization } = schema
217
- const content = ''
218
- let label = options.forceName || shapeToXmlTagName(schema)
219
- const attributes = []
220
- const parts = []
221
- if (xmlSerialization) {
222
- const { namespace, prefix } = xmlSerialization
223
- if (namespace) {
224
- const attrName = prefix ? `xmlns:${prefix}` : 'xmlns'
225
- attributes.push(`${attrName}="${namespace}"`)
226
- }
227
- if (prefix) {
228
- label = `${prefix}:${label}`
229
- }
230
- }
231
- let opening = `<${label}`
232
- if (attributes.length) {
233
- opening += ' '
234
- opening += attributes.join(' ')
235
- }
236
- opening += '>'
237
- parts.push(opening)
238
- parts.push(content)
239
- parts.push(`</${label}>`)
240
-
241
- return parts.join('')
242
- }
243
-
244
- /**
245
- * @returns The value for the property or undefined when cannot generate the value.
246
- */
247
- protected _propertyShapeObject(schema: IApiPropertyShape, options: IProcessNodeOptions = {}): string | undefined {
248
- const { range, minCount = 0 } = schema
249
- if ((minCount === 0 && !this.opts.renderOptional) || !range) {
250
- return undefined
251
- }
252
- const { types } = range
253
- if (types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
254
- return this._scalarShapeObject(range as IApiScalarShape, { ...options })
255
- }
256
- if (types.includes(ns.aml.vocabularies.shapes.NilShape)) {
257
- const name = shapeToXmlTagName(schema as IApiAnyShape)
258
- return this._nilShapeObject(range as IApiScalarShape, { ...options, forceName: name })
259
- }
260
- if (types.includes(ns.aml.vocabularies.shapes.RecursiveShape)) {
261
- return undefined
262
- }
263
- if (types.includes(ns.w3.shacl.NodeShape)) {
264
- return this._nodePropertyObject(schema as IApiPropertyShape<IApiNodeShape>, options)
265
- }
266
- if (
267
- types.includes(ns.aml.vocabularies.shapes.ArrayShape) ||
268
- types.includes(ns.aml.vocabularies.shapes.MatrixShape)
269
- ) {
270
- return this._nodePropertyArray(schema as IApiPropertyShape<IApiArrayShape>, options)
271
- }
272
- const name = shapeToXmlTagName(schema as IApiAnyShape)
273
- return this.processNode(range, { ...options, forceName: name })
274
- }
275
-
276
- protected _collectExamples(schema: IShapeUnion, opts: ICollectExamplesOptions = {}): string | undefined {
277
- if (!this.opts.renderExamples) {
278
- return undefined
279
- }
280
- const { isWrapped, nodeName, tagFill = '', indent = 0 } = opts
281
- let { examples = [] } = schema as IApiAnyShape
282
- const { inherits } = schema
283
- if (Array.isArray(inherits) && inherits.length) {
284
- inherits.forEach((parent) => {
285
- let node = parent
286
- if (node.types.includes(ns.aml.vocabularies.shapes.UnionShape)) {
287
- const union = node as IApiUnionShape
288
- const { anyOf = [] } = union
289
- node = this._readCurrentUnion(anyOf)
290
- }
291
- const anyShape = node as IApiAnyShape
292
- if (Array.isArray(anyShape.examples) && anyShape.examples.length) {
293
- examples = examples.concat(anyShape.examples)
294
- }
295
- })
296
- }
297
-
298
- const validExamples = examples.filter((item) => !!item.structuredValue)
299
- if (!validExamples.length) {
300
- return undefined
301
- }
302
-
303
- const parts: string[] = []
304
- if (isWrapped) {
305
- parts.push(`${tagFill}<${nodeName}>`)
306
- }
307
- const generator = new XmlDataNodeGenerator()
308
- validExamples.forEach((item) => {
309
- const value = generator.generate(item.structuredValue as IApiDataNodeUnion, nodeName, {
310
- indent: indent + 1,
311
- })
312
- if (value !== undefined) {
313
- parts.push(value as string)
314
- }
315
- })
316
- if (isWrapped) {
317
- parts.push(`${tagFill}</${nodeName}>`)
318
- }
319
-
320
- return parts.join('\n')
321
- }
322
-
323
- protected _createTabs(indent = 0, offset = 0): string {
324
- return new Array(indent * 2 + offset).fill(' ').join('')
325
- }
326
-
327
- protected _nodePropertyObject(schema: IApiPropertyShape<IApiNodeShape>, options: IProcessNodeOptions = {}): string {
328
- const parts: string[] = []
329
- const name = normalizeXmlTagName(String(schema.name))
330
- const { indent = 0 } = options
331
- const baseTabs = this._createTabs(indent)
332
- let value: string
333
- const range = schema.range as IApiNodeShape
334
- const exampleValue = this._collectExamples(range, {
335
- tagFill: baseTabs,
336
- indent: indent + 1,
337
- nodeName: name,
338
- })
339
- const attributes: string[] = []
340
- if (exampleValue) {
341
- value = exampleValue
342
- } else {
343
- const propertyParts: string[] = []
344
- const properties = this._collectProperties(range)
345
-
346
- properties.forEach((property) => {
347
- const { range, minCount = 0 } = property
348
- if (minCount === 0 && !this.opts.renderOptional) {
349
- return
350
- }
351
- const anyRange = range as IApiAnyShape
352
-
353
- if (anyRange.xmlSerialization) {
354
- const { prefix, attribute } = anyRange.xmlSerialization
355
- if (attribute && anyRange.types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
356
- let aLabel = normalizeXmlTagName(
357
- anyRange.xmlSerialization.name
358
- ? anyRange.xmlSerialization.name
359
- : property.name || anyRange.name || UNKNOWN_TYPE
360
- )
361
- if (prefix) {
362
- aLabel = `${prefix}:${aLabel}`
363
- }
364
- const value = this._scalarValue(anyRange)
365
- attributes.push(`${aLabel}="${value}"`)
366
- return
367
- }
368
- }
369
- const value = this._propertyShapeObject(property, { indent })
370
- if (value !== undefined) {
371
- const fill = this._createTabs(indent, 2)
372
- propertyParts.push(formatXmlValue(fill, value))
373
- }
374
- })
375
-
376
- value = propertyParts.join('\n')
377
- }
378
- let opening = `${baseTabs}<${name}`
379
- if (attributes.length) {
380
- opening += ' '
381
- opening += attributes.join(' ')
382
- }
383
- parts.unshift(`${opening}>`)
384
- parts.push(value)
385
- parts.push(`${baseTabs}</${name}>`)
386
- return parts.join('\n')
387
- }
388
-
389
- protected _nodePropertyArray(schema: IApiPropertyShape<IApiArrayShape>, options: IProcessNodeOptions = {}): string {
390
- const range = schema.range as IApiArrayShape
391
- const parts: string[] = []
392
- let name: string
393
- if (range.xmlSerialization && range.xmlSerialization.name) {
394
- name = normalizeXmlTagName(range.xmlSerialization.name)
395
- } else {
396
- name = normalizeXmlTagName(String(schema.name))
397
- }
398
- const { indent = 0 } = options
399
- const isScalarItems = !!range.items && range.items.types.includes(ns.aml.vocabularies.shapes.ScalarShape)
400
-
401
- const baseTabs = this._createTabs(indent)
402
- if (!isScalarItems) {
403
- parts.push(`${baseTabs}<${name}>`)
404
- }
405
-
406
- const result = this._arrayShapeObject(range, { ...options, indent })
407
- parts.push(result)
408
- if (!isScalarItems) {
409
- parts.push(`${baseTabs}</${name}>`)
410
- }
411
- return parts.join('\n')
412
- }
413
-
414
- protected _arrayShapeObject(schema: IApiArrayShape, options: IProcessNodeOptions = {}, isRoot = false): string {
415
- const { items } = schema
416
- const isScalarItems = !!items && items.types.includes(ns.aml.vocabularies.shapes.ScalarShape)
417
- // the name is either from the XML serialization info, or the parent property.
418
- // IT IS NOT THE `item`'s name unless its a scalar.
419
- let nodeName: string | undefined
420
-
421
- // if (isScalarItems && schema.name) {
422
- // nodeName = normalizeXmlTagName(schema.name);
423
- // } else if (!isScalarItems && items?.name) {
424
- // nodeName = normalizeXmlTagName(items.name);
425
- // }
426
-
427
- if (isRoot && schema.xmlSerialization && schema.xmlSerialization.name) {
428
- nodeName = normalizeXmlTagName(schema.xmlSerialization.name)
429
- } else if (isRoot && schema.name) {
430
- nodeName = normalizeXmlTagName(schema.name)
431
- } else if (!isScalarItems && items?.name) {
432
- nodeName = normalizeXmlTagName(items.name)
433
- } else if (schema.name) {
434
- nodeName = normalizeXmlTagName(schema.name)
435
- }
436
-
437
- // wrapping can only be defined on the array shape and it "wraps" the generated
438
- // content into an element that has the same name as the items
439
- let hasWrapped = false
440
- if (schema.xmlSerialization && typeof schema.xmlSerialization.wrapped === 'boolean') {
441
- hasWrapped = true
442
- }
443
- const isWrapped = !!schema.xmlSerialization && !!schema.xmlSerialization.wrapped
444
-
445
- const currentIndent = options.indent || 0
446
- const tagFill = new Array(currentIndent * 2 + 0).fill(' ').join('')
447
- const valueFill = new Array(currentIndent * 2 + (isWrapped ? 2 : 0)).fill(' ').join('')
448
- // let's start with examples
449
- if (this.opts.renderExamples) {
450
- const { examples = [] } = schema
451
- const validExamples = examples.filter((item) => !!item.structuredValue)
452
- if (validExamples.length) {
453
- const parts: string[] = []
454
- const generator = new XmlDataNodeGenerator()
455
-
456
- // scalar items are always wrapped with it's own range
457
- if (isScalarItems && !isWrapped) {
458
- const [example] = validExamples
459
- if (!nodeName && items?.name) {
460
- nodeName = normalizeXmlTagName(items.name)
461
- }
462
- const value = generator.generate(example.structuredValue as IApiDataNodeUnion, nodeName, {
463
- indent: currentIndent,
464
- })
465
- if (value !== undefined) {
466
- parts.push(value as string)
467
- }
468
- } else if (isScalarItems && isWrapped) {
469
- const [example] = validExamples
470
- const value = generator.generate(example.structuredValue as IApiDataNodeUnion, nodeName, {
471
- indent: currentIndent,
472
- })
473
- parts.push(`${tagFill}<${nodeName}>`)
474
- if (value !== undefined) {
475
- parts.push(value as string)
476
- }
477
- parts.push(`${tagFill}</${nodeName}>`)
478
- } else if (isWrapped) {
479
- // when wrapped we wrap each example into the "name", else we render all examples under the "name".
480
- validExamples.forEach((item) => {
481
- parts.push(`${tagFill}<${nodeName}>`)
482
- const value = generator.generate(item.structuredValue as IApiDataNodeUnion, /* nodeName */ undefined, {
483
- indent: currentIndent + 2,
484
- })
485
- if (value !== undefined) {
486
- parts.push(value as string)
487
- }
488
- parts.push(`${tagFill}</${nodeName}>`)
489
- })
490
- } else {
491
- validExamples.forEach((item) => {
492
- const value = generator.generate(item.structuredValue as IApiDataNodeUnion, /* nodeName */ undefined, {
493
- indent: currentIndent,
494
- })
495
- if (value !== undefined) {
496
- parts.push(value as string)
497
- }
498
- })
499
- }
500
- return parts.join('\n')
501
- }
502
- }
503
-
504
- if (isScalarItems && schema.defaultValue) {
505
- const gen = new XmlDataNodeGenerator()
506
- const value = gen.generate(schema.defaultValue) as string | undefined
507
- if (!nodeName && items?.name) {
508
- nodeName = normalizeXmlTagName(items.name)
509
- }
510
- return `<${nodeName}>${value?.trim()}</${nodeName}>`
511
- }
512
-
513
- if (items) {
514
- const parts: string[] = []
515
- if (isWrapped && isScalarItems) {
516
- parts.push(`${tagFill}<${nodeName}>`)
517
- }
518
- const init: IProcessNodeOptions = {
519
- indent: currentIndent + 1,
520
- }
521
- if (nodeName) {
522
- init.forceName = nodeName
523
- }
524
- if (!isRoot && (!hasWrapped || (hasWrapped && !isWrapped))) {
525
- init.noWrap = true
526
- }
527
- const value = this.processNode(items, init)
528
- if (value !== undefined) {
529
- parts.push(`${valueFill}${value}`)
530
- }
531
- if (isWrapped && isScalarItems) {
532
- parts.push(`${tagFill}</${nodeName}>`)
533
- }
534
- return parts.join('\n')
535
- }
536
-
537
- return ''
538
-
539
- // const isScalarItems = !!items && items.types.includes(ns.aml.vocabularies.shapes.ScalarShape);
540
- // if (items) {
541
- // if (items.types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
542
- // return this._scalarItems(schema as IArrayShape<IScalarShape>, options);
543
- // }
544
- // if (items.types.includes(ns.w3.shacl.NodeShape)) {
545
- // return this._nodeItems(schema as IArrayShape<INodeShape>, options);
546
- // }
547
- // }
548
-
549
- // let label = shapeToXmlTagName(schema);
550
- // if (label === UNKNOWN_TYPE && isScalarItems) {
551
- // // label = shapeToXmlTagName(items as IScalarShape);
552
- // }
553
-
554
- // const currentIndent = (options.indent || 0);
555
- // const rootFill = new Array(currentIndent*2).fill(' ').join('');
556
- // const parts = [
557
- // `${rootFill}<${label}>`
558
- // ];
559
- // let nodeName = label;
560
- // const anyItems = items as IAnyShape;
561
- // if (anyItems.xmlSerialization && anyItems.xmlSerialization.name) {
562
- // nodeName = normalizeXmlTagName(anyItems.xmlSerialization.name);
563
- // }
564
- // // Note about wrapping.
565
- // // XML array values are not wrapped by default. This means that by default
566
- // // it produces a value like this:
567
- // // <ParentArray>
568
- // // <arrayMemberProperty></arrayMemberProperty>
569
- // // </ParentArray>
570
- // //
571
- // // When the object is marked as wrapped then the object is rendered as follows
572
- // //
573
- // // <ParentArray>
574
- // // <MemberObject>
575
- // // <arrayMemberProperty></arrayMemberProperty>
576
- // // <MemberObject>
577
- // // </ParentArray>
578
- // const isWrapped = xmlSerialization && !!xmlSerialization.wrapped;
579
- // const defaultValue = schema.defaultValue || items && items.defaultValue;
580
- // let itemName;
581
- // if (isWrapped) {
582
- // try {
583
- // itemName = shapeToXmlTagName(items as IAnyShape);
584
- // } catch (e) {
585
- // itemName = 'UNKNOWN-NAME'
586
- // }
587
- // }
588
- // let { examples=[] } = schema;
589
- // if (Array.isArray(anyItems.examples)) {
590
- // examples = examples.concat(anyItems.examples);
591
- // }
592
- // if (this.opts.renderExamples && examples && examples.length) {
593
- // const example = examples.find((item) => !!item.structuredValue);
594
- // const value = this._exampleToObject(example);
595
- // if (typeof value !== 'undefined') {
596
- // const tagFill = new Array(currentIndent * 2 + 2).fill(' ').join('');
597
- // const valueFill = new Array(currentIndent * 2 + 4).fill(' ').join('');
598
- // parts.push(`${tagFill}<${nodeName}>`);
599
- // parts.push(`${valueFill}${value}`);
600
- // parts.push(`${tagFill}</${nodeName}>`);
601
- // }
602
- // } else if (defaultValue) {
603
- // const gen = new XmlDataNodeGenerator();
604
- // const value = gen.generate(defaultValue);
605
- // if (value) {
606
- // const tagFill = new Array(currentIndent * 2 + 2).fill(' ').join('');
607
- // const valueFill = new Array(currentIndent * 2 + 4).fill(' ').join('');
608
- // parts.push(`${tagFill}<${nodeName}>`);
609
- // parts.push(`${valueFill}${value.trim()}`);
610
- // parts.push(`${tagFill}</${nodeName}>`);
611
- // }
612
- // } else if (items && items.types.includes(ns.w3.shacl.NodeShape)) {
613
- // const typed = items as INodeShape;
614
- // const tagFill = new Array(currentIndent * 2 + 2).fill(' ').join('');
615
- // const valueFill = isWrapped ? new Array(currentIndent * 2 + 4).fill(' ').join('') : tagFill;
616
- // if (isWrapped) {
617
- // parts.push(`${tagFill}<${itemName}>`);
618
- // }
619
- // const properties = this._collectProperties(typed);
620
- // properties.forEach((prop) => {
621
- // const value = this._propertyShapeObject(prop);
622
- // if (value) {
623
- // parts.push(`${valueFill}${value}`);
624
- // }
625
- // });
626
- // if (isWrapped) {
627
- // parts.push(`${tagFill}</${itemName}>`);
628
- // }
629
- // } else if (items) {
630
- // let name = shapeToXmlTagName(items as IAnyShape);
631
- // if (name === UNKNOWN_TYPE) {
632
- // name = label;
633
- // }
634
- // const opts = {
635
- // forceName: name,
636
- // indent: currentIndent + 1,
637
- // };
638
- // const value = items && this.processNode(items, opts);
639
- // if (typeof value !== 'undefined') {
640
- // const fill = new Array(currentIndent * 2 + 2).fill(' ').join('');
641
- // parts.push(`${fill}${value}`);
642
- // }
643
- // }
644
-
645
- // parts.push(`${rootFill}</${label}>`);
646
- // return parts.join('\n');
647
- }
648
-
649
- /**
650
- * Creates an example from an array shape when the items is the scalar shape.
651
- * Note, it assumes the previous step tested whether the `items` is scalar.
652
- *
653
- * @param schema The array schema
654
- * @param options Processing options.
655
- */
656
- protected _scalarItems(schema: IApiArrayShape<IApiScalarShape>, options: IProcessNodeOptions = {}): string {
657
- const items = schema.items as IApiScalarShape
658
- const currentIndent = options.indent || 0
659
- const tagFill = new Array(currentIndent * 2).fill(' ').join('')
660
-
661
- let nodeName = ''
662
- if (items.xmlSerialization && items.xmlSerialization.name) {
663
- nodeName = normalizeXmlTagName(items.xmlSerialization.name)
664
- } else {
665
- nodeName = shapeToXmlTagName(schema.name ? schema : items)
666
- }
667
-
668
- // let's start with examples
669
- if (this.opts.renderExamples) {
670
- let { examples = [] } = schema
671
- if (Array.isArray(items.examples)) {
672
- examples = examples.concat(items.examples)
673
- }
674
- const validExamples = examples.filter((item) => !!item.structuredValue)
675
- if (validExamples.length) {
676
- const parts: string[] = []
677
- const generator = new XmlDataNodeGenerator()
678
- validExamples.forEach((item) => {
679
- const value = generator.generate(item.structuredValue as IApiDataNodeUnion, nodeName)
680
- if (value !== undefined) {
681
- parts.push(`${tagFill}${value}`)
682
- }
683
- })
684
- return parts.join('\n')
685
- }
686
- }
687
-
688
- // then the default value
689
- if (schema.defaultValue) {
690
- const generator = new XmlDataNodeGenerator()
691
- const value = generator.generate(schema.defaultValue, nodeName)
692
- if (value !== undefined) {
693
- return `${tagFill}${value}`
694
- }
695
- }
696
-
697
- // finally we generate stuff.
698
- const opts: IProcessNodeOptions = {
699
- indent: currentIndent + 1,
700
- forceName: nodeName,
701
- }
702
- const value = this.processNode(items, opts)
703
- return `${tagFill}${value}`
704
- }
705
-
706
- /**
707
- * Renders a NodeShape as an array item.
708
- *
709
- * @param schema The array shape with item that is NodeShape.
710
- * @param options Rendering options.
711
- */
712
- protected _nodeItems(schema: IApiArrayShape<IApiNodeShape>, options: IProcessNodeOptions = {}): string {
713
- const items = schema.items as IApiNodeShape
714
- const currentIndent = options.indent || 0
715
- const tagFill = new Array(currentIndent * 2).fill(' ').join('')
716
- const isWrapped = schema.xmlSerialization && !!schema.xmlSerialization.wrapped
717
- const defaultValue = schema.defaultValue || items.defaultValue
718
-
719
- let nodeName = ''
720
- if (items.xmlSerialization && items.xmlSerialization.name) {
721
- nodeName = normalizeXmlTagName(items.xmlSerialization.name)
722
- } else {
723
- nodeName = shapeToXmlTagName(schema.name ? schema : items)
724
- }
725
-
726
- const valueFill = isWrapped ? new Array(currentIndent * 2 + 2).fill(' ').join('') : tagFill
727
- const parts: string[] = []
728
- if (isWrapped) {
729
- parts.push(`${tagFill}<${nodeName}>`)
730
- }
731
-
732
- let rendered = false
733
-
734
- // let's start with examples
735
- if (this.opts.renderExamples) {
736
- let { examples = [] } = schema
737
- if (Array.isArray(items.examples)) {
738
- examples = examples.concat(items.examples)
739
- }
740
- const validExamples = examples.filter((item) => !!item.structuredValue)
741
- if (validExamples.length) {
742
- const parts: string[] = []
743
- const generator = new XmlDataNodeGenerator()
744
- validExamples.forEach((item) => {
745
- const value = generator.generate(item.structuredValue as IApiDataNodeUnion, nodeName)
746
- if (value !== undefined) {
747
- parts.push(`${tagFill}${value}`)
748
- }
749
- })
750
- rendered = true
751
- }
752
- }
753
-
754
- if (!rendered && defaultValue) {
755
- const generator = new XmlDataNodeGenerator()
756
- const value = generator.generate(defaultValue, nodeName)
757
- if (value !== undefined) {
758
- parts.push(`${tagFill}${value}`)
759
- rendered = true
760
- }
761
- }
762
- if (!rendered) {
763
- const properties = this._collectProperties(items)
764
- properties.forEach((prop) => {
765
- const value = this._propertyShapeObject(prop)
766
- if (value) {
767
- parts.push(`${valueFill}${value}`)
768
- }
769
- })
770
- }
771
- if (isWrapped) {
772
- parts.push(`${tagFill}</${nodeName}>`)
773
- }
774
- return parts.join('\n')
775
- }
776
-
777
- /**
778
- * @param example The example to turn into a JS object
779
- */
780
- protected _exampleToObject(example?: IApiDataExample): string | undefined {
781
- if (example && example.structuredValue) {
782
- const generator = new XmlDataNodeGenerator()
783
- return generator.generate(example.structuredValue) as string | undefined
784
- }
785
- return undefined
786
- }
787
-
788
- protected _unionShapeObject(schema: IApiUnionShape, options: IProcessNodeOptions = {}): string | undefined {
789
- let { anyOf = [], examples = [] } = schema
790
- if (Array.isArray(schema.inherits) && schema.inherits) {
791
- schema.inherits.forEach((parent) => {
792
- const anyParent = parent as IApiAnyShape
793
- if (Array.isArray(anyParent.examples) && anyParent.examples.length) {
794
- examples = examples.concat(anyParent.examples)
795
- }
796
- const typed = parent as IApiUnionShape
797
- if (Array.isArray(typed.anyOf) && typed.anyOf.length) {
798
- anyOf = anyOf.concat(typed.anyOf)
799
- }
800
- })
801
- }
802
- if (Array.isArray(anyOf) && anyOf.length) {
803
- if (this._isNotRequiredUnion(anyOf)) {
804
- // This generates schema for required values.
805
- // This implicitly mean that the property is not required therefore the value should
806
- // not be generated.
807
- return undefined
808
- }
809
- const example = examples.find((item) => !!item.structuredValue)
810
- const value = this._exampleToObject(example)
811
- if (value !== undefined) {
812
- const label = shapeToXmlTagName(schema)
813
- const currentIndent = options.indent || 0
814
- const rootFill = new Array(currentIndent * 2).fill(' ').join('')
815
- const valueFill = new Array(currentIndent * 2 + 2).fill(' ').join('')
816
- const parts = []
817
- parts.push(`${rootFill}<${label}>`)
818
- const formatted = String(value)
819
- .split('\n')
820
- .filter((i) => !!i)
821
- .map((i) => `${valueFill}${i}`)
822
- .join('\n')
823
- parts.push(`${formatted}`)
824
- parts.push(`${rootFill}</${label}>`)
825
- return parts.join('\n')
826
- }
827
- if (schema.defaultValue) {
828
- return this._unionDefaultValue(schema, schema.defaultValue)
829
- }
830
- const member = this._readCurrentUnion(anyOf)
831
- if (member) {
832
- return this.processNode(member, { ...options, forceName: schema.name })
833
- }
834
- }
835
- return undefined
836
- }
837
-
838
- /**
839
- * @param schema The schema with unions
840
- * @param defaultValue The definition of a default value.
841
- */
842
- protected _unionDefaultValue(
843
- schema: IShapeUnion,
844
- defaultValue: IApiDataNodeUnion,
845
- options: IProcessNodeOptions = {}
846
- ): string | undefined {
847
- const gen = new XmlDataNodeGenerator()
848
- const value = gen.generate(defaultValue)
849
- const anySchema = schema as IApiAnyShape
850
- const label = shapeToXmlTagName(anySchema)
851
- const currentIndent = options.indent || 0
852
- const rootFill = new Array(currentIndent * 2).fill(' ').join('')
853
- const parts = [`${rootFill}<${label}>`]
854
- const valueFill = new Array(currentIndent * 2 + 2).fill(' ').join('')
855
- parts.push(`${valueFill}${String(value).trim()}`)
856
- parts.push(`${rootFill}</${label}>`)
857
- return parts.join('\n')
858
- }
859
-
860
- protected _fileShapeObject(): string | undefined {
861
- return undefined
862
- }
863
-
864
- protected _schemaShapeObject(): string | undefined {
865
- return undefined
866
- }
867
-
868
- protected _tupleShapeObject(): string | undefined {
869
- return undefined
870
- }
871
-
872
- protected _anyShapeObject(schema: IApiAnyShape): string | undefined {
873
- const { and = [], xone = [], or = [] } = schema
874
- if (and.length) {
875
- // we combine all properties together under `schema` with changed properties
876
- const copy = structuredClone(schema) as IApiNodeShape
877
- copy.and = []
878
- copy.properties = []
879
- and.forEach((item) => {
880
- const { types } = item
881
- if (types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
882
- const typed = item as IApiScalarShape
883
- copy.properties.push(typed)
884
- } else if (types.includes(ns.w3.shacl.NodeShape)) {
885
- const typed = item as IApiNodeShape
886
- typed.properties.forEach((i) => copy.properties.push(i))
887
- } else if (
888
- types.includes(ns.aml.vocabularies.shapes.ArrayShape) ||
889
- types.includes(ns.aml.vocabularies.shapes.MatrixShape)
890
- ) {
891
- const typed = item as IApiArrayShape
892
- if (typed.items) {
893
- copy.properties.push(typed.items)
894
- }
895
- }
896
- })
897
- return this._nodeShapeObject(copy)
898
- }
899
- if (xone.length) {
900
- const { selectedUnions = [] } = this.opts
901
- let selected = xone.find((i) => selectedUnions.includes(i.id))
902
- if (!selected) {
903
- // select firs available
904
- selected = xone[0]
905
- }
906
- return this.processNode(selected)
907
- }
908
- if (or.length) {
909
- const { selectedUnions = [] } = this.opts
910
- let selected = or.find((i) => selectedUnions.includes(i.id))
911
- if (!selected) {
912
- // select firs available
913
- selected = or[0]
914
- }
915
- return this.processNode(selected)
916
- }
917
- const { examples = [] } = schema
918
- const label = shapeToXmlTagName(schema)
919
- if (this.opts.renderExamples && examples && examples.length) {
920
- const example = examples.find((item) => !!item.structuredValue)
921
- const value = this._exampleToObject(example)
922
- const parts = []
923
- if (typeof value !== 'undefined') {
924
- const valueFill = ` `
925
- parts.push(`<${label}>`)
926
- parts.push(`${valueFill}${value}`)
927
- parts.push(`</${label}>`)
928
- }
929
- return parts.join('\n')
930
- }
931
- return this._scalarShapeObject(schema)
932
- }
933
- }