@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,852 +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
- /**
6
- * Normalizes given name to a value that can be accepted by `createElement`
7
- * function on a document object.
8
- * @param name A name to process
9
- * @returns The normalized name
10
- */
11
- export const normalizeXmlTagName = (name) => name.replace(/[^a-zA-Z0-9-_.]/g, '');
12
- const UNKNOWN_TYPE = 'unknown-type';
13
- export function shapeToXmlTagName(shape) {
14
- const { name, inherits = [], xmlSerialization } = shape;
15
- let label = xmlSerialization && xmlSerialization.name ? xmlSerialization.name : name || UNKNOWN_TYPE;
16
- if (label === 'schema' && inherits.length) {
17
- const n = inherits.find((i) => i.name && i.name !== 'schema');
18
- if (n) {
19
- label = n.name === 'type' ? n.displayName || n.name : n.name;
20
- }
21
- }
22
- return normalizeXmlTagName(String(label));
23
- }
24
- export class ShapeXmlSchemaGenerator extends ShapeBase {
25
- /**
26
- * Generates a XML example from the structured value.
27
- *
28
- * @param schema The Shape definition
29
- */
30
- generate(schema) {
31
- let result;
32
- if (schema.types.includes(ns.w3.shacl.PropertyShape)) {
33
- result = this._propertyShapeObject(schema);
34
- }
35
- else {
36
- result = this.processNode(schema, {}, true);
37
- }
38
- return result;
39
- }
40
- /**
41
- * Processes the Shape definition and returns a JavaScript object or array.
42
- */
43
- processNode(schema, options = {}, isRoot = false) {
44
- const { types } = schema;
45
- if (types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
46
- return this._scalarShapeObject(schema, options);
47
- }
48
- if (types.includes(ns.w3.shacl.NodeShape)) {
49
- return this._nodeShapeObject(schema, options);
50
- }
51
- if (types.includes(ns.aml.vocabularies.shapes.UnionShape)) {
52
- return this._unionShapeObject(schema);
53
- }
54
- if (types.includes(ns.aml.vocabularies.shapes.FileShape)) {
55
- return this._fileShapeObject();
56
- }
57
- if (types.includes(ns.aml.vocabularies.shapes.SchemaShape)) {
58
- return this._schemaShapeObject();
59
- }
60
- if (types.includes(ns.aml.vocabularies.shapes.TupleShape)) {
61
- return this._tupleShapeObject();
62
- }
63
- if (types.includes(ns.aml.vocabularies.shapes.ArrayShape) ||
64
- types.includes(ns.aml.vocabularies.shapes.MatrixShape)) {
65
- return this._arrayShapeObject(schema, options, isRoot);
66
- }
67
- return this._anyShapeObject(schema);
68
- }
69
- /**
70
- * Serializes generated JS value according to the mime type.
71
- */
72
- serialize(value) {
73
- return value;
74
- }
75
- /**
76
- * Picks the union member to render.
77
- */
78
- _readCurrentUnion(anyOf) {
79
- const { selectedUnions } = this.opts;
80
- return getUnionMember(anyOf, selectedUnions);
81
- }
82
- _collectProperties(schema) {
83
- const { selectedUnions } = this.opts;
84
- return collectNodeProperties(schema, selectedUnions);
85
- }
86
- _nodeShapeObject(schema, options = {}) {
87
- const label = options.forceName || shapeToXmlTagName(schema);
88
- const parts = [];
89
- const currentIndent = options.indent || 0;
90
- const exampleValue = this._collectExamples(schema, {
91
- tagFill: new Array(currentIndent * 2 + 0).fill(' ').join(''),
92
- indent: currentIndent + 1,
93
- nodeName: label,
94
- });
95
- if (exampleValue) {
96
- return exampleValue;
97
- }
98
- const attributes = [];
99
- const properties = this._collectProperties(schema);
100
- properties.forEach((property) => {
101
- const { range, minCount = 0 } = property;
102
- if ((minCount === 0 && !this.opts.renderOptional) || !range) {
103
- return;
104
- }
105
- const anyRange = range;
106
- if (anyRange.xmlSerialization) {
107
- // Adds to the parent attributes list.
108
- // When a non-scalar shape has `attribute` serialization this is an API spec error.
109
- // Ignore such situation.
110
- if (anyRange.xmlSerialization.attribute && anyRange.types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
111
- let aLabel = normalizeXmlTagName(anyRange.xmlSerialization.name
112
- ? anyRange.xmlSerialization.name
113
- : property.name || anyRange.name || UNKNOWN_TYPE);
114
- if (anyRange.xmlSerialization.prefix) {
115
- aLabel = `${anyRange.xmlSerialization.prefix}:${aLabel}`;
116
- }
117
- const value = this._scalarValue(anyRange);
118
- attributes.push(`${aLabel}="${value}"`);
119
- return;
120
- }
121
- }
122
- const value = this._propertyShapeObject(property, { indent: currentIndent });
123
- if (typeof value !== 'undefined') {
124
- const offset = options.noWrap ? 0 : 2;
125
- const fill = new Array(currentIndent * 2 + offset).fill(' ').join('');
126
- parts.push(formatXmlValue(fill, value));
127
- }
128
- });
129
- if (options.noWrap) {
130
- return parts.join('\n');
131
- }
132
- let opening = `<${label}`;
133
- if (attributes.length) {
134
- opening += ' ';
135
- opening += attributes.join(' ');
136
- }
137
- parts.unshift(`${opening}>`);
138
- const fill = new Array(currentIndent * 2).fill(' ').join('');
139
- parts.push(`${fill}</${label}>`);
140
- return parts.join('\n');
141
- }
142
- _scalarShapeObject(schema, options = {}) {
143
- const { xmlSerialization, defaultValue } = schema;
144
- let content;
145
- if (defaultValue) {
146
- const gen = new XmlDataNodeGenerator();
147
- content = gen.processNode(defaultValue);
148
- }
149
- else {
150
- content = this._scalarValue(schema);
151
- }
152
- let label = options.forceName || shapeToXmlTagName(schema);
153
- const attributes = [];
154
- const parts = [];
155
- if (xmlSerialization) {
156
- const { namespace, prefix } = xmlSerialization;
157
- if (namespace) {
158
- const attrName = prefix ? `xmlns:${prefix}` : 'xmlns';
159
- attributes.push(`${attrName}="${namespace}"`);
160
- }
161
- if (prefix) {
162
- label = `${prefix}:${label}`;
163
- }
164
- }
165
- let opening = `<${label}`;
166
- if (attributes.length) {
167
- opening += ' ';
168
- opening += attributes.join(' ');
169
- }
170
- opening += '>';
171
- parts.push(opening);
172
- parts.push(content);
173
- parts.push(`</${label}>`);
174
- return parts.join('');
175
- }
176
- _nilShapeObject(schema, options = {}) {
177
- const { xmlSerialization } = schema;
178
- const content = '';
179
- let label = options.forceName || shapeToXmlTagName(schema);
180
- const attributes = [];
181
- const parts = [];
182
- if (xmlSerialization) {
183
- const { namespace, prefix } = xmlSerialization;
184
- if (namespace) {
185
- const attrName = prefix ? `xmlns:${prefix}` : 'xmlns';
186
- attributes.push(`${attrName}="${namespace}"`);
187
- }
188
- if (prefix) {
189
- label = `${prefix}:${label}`;
190
- }
191
- }
192
- let opening = `<${label}`;
193
- if (attributes.length) {
194
- opening += ' ';
195
- opening += attributes.join(' ');
196
- }
197
- opening += '>';
198
- parts.push(opening);
199
- parts.push(content);
200
- parts.push(`</${label}>`);
201
- return parts.join('');
202
- }
203
- /**
204
- * @returns The value for the property or undefined when cannot generate the value.
205
- */
206
- _propertyShapeObject(schema, options = {}) {
207
- const { range, minCount = 0 } = schema;
208
- if ((minCount === 0 && !this.opts.renderOptional) || !range) {
209
- return undefined;
210
- }
211
- const { types } = range;
212
- if (types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
213
- return this._scalarShapeObject(range, { ...options });
214
- }
215
- if (types.includes(ns.aml.vocabularies.shapes.NilShape)) {
216
- const name = shapeToXmlTagName(schema);
217
- return this._nilShapeObject(range, { ...options, forceName: name });
218
- }
219
- if (types.includes(ns.aml.vocabularies.shapes.RecursiveShape)) {
220
- return undefined;
221
- }
222
- if (types.includes(ns.w3.shacl.NodeShape)) {
223
- return this._nodePropertyObject(schema, options);
224
- }
225
- if (types.includes(ns.aml.vocabularies.shapes.ArrayShape) ||
226
- types.includes(ns.aml.vocabularies.shapes.MatrixShape)) {
227
- return this._nodePropertyArray(schema, options);
228
- }
229
- const name = shapeToXmlTagName(schema);
230
- return this.processNode(range, { ...options, forceName: name });
231
- }
232
- _collectExamples(schema, opts = {}) {
233
- if (!this.opts.renderExamples) {
234
- return undefined;
235
- }
236
- const { isWrapped, nodeName, tagFill = '', indent = 0 } = opts;
237
- let { examples = [] } = schema;
238
- const { inherits } = schema;
239
- if (Array.isArray(inherits) && inherits.length) {
240
- inherits.forEach((parent) => {
241
- let node = parent;
242
- if (node.types.includes(ns.aml.vocabularies.shapes.UnionShape)) {
243
- const union = node;
244
- const { anyOf = [] } = union;
245
- node = this._readCurrentUnion(anyOf);
246
- }
247
- const anyShape = node;
248
- if (Array.isArray(anyShape.examples) && anyShape.examples.length) {
249
- examples = examples.concat(anyShape.examples);
250
- }
251
- });
252
- }
253
- const validExamples = examples.filter((item) => !!item.structuredValue);
254
- if (!validExamples.length) {
255
- return undefined;
256
- }
257
- const parts = [];
258
- if (isWrapped) {
259
- parts.push(`${tagFill}<${nodeName}>`);
260
- }
261
- const generator = new XmlDataNodeGenerator();
262
- validExamples.forEach((item) => {
263
- const value = generator.generate(item.structuredValue, nodeName, {
264
- indent: indent + 1,
265
- });
266
- if (value !== undefined) {
267
- parts.push(value);
268
- }
269
- });
270
- if (isWrapped) {
271
- parts.push(`${tagFill}</${nodeName}>`);
272
- }
273
- return parts.join('\n');
274
- }
275
- _createTabs(indent = 0, offset = 0) {
276
- return new Array(indent * 2 + offset).fill(' ').join('');
277
- }
278
- _nodePropertyObject(schema, options = {}) {
279
- const parts = [];
280
- const name = normalizeXmlTagName(String(schema.name));
281
- const { indent = 0 } = options;
282
- const baseTabs = this._createTabs(indent);
283
- let value;
284
- const range = schema.range;
285
- const exampleValue = this._collectExamples(range, {
286
- tagFill: baseTabs,
287
- indent: indent + 1,
288
- nodeName: name,
289
- });
290
- const attributes = [];
291
- if (exampleValue) {
292
- value = exampleValue;
293
- }
294
- else {
295
- const propertyParts = [];
296
- const properties = this._collectProperties(range);
297
- properties.forEach((property) => {
298
- const { range, minCount = 0 } = property;
299
- if (minCount === 0 && !this.opts.renderOptional) {
300
- return;
301
- }
302
- const anyRange = range;
303
- if (anyRange.xmlSerialization) {
304
- const { prefix, attribute } = anyRange.xmlSerialization;
305
- if (attribute && anyRange.types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
306
- let aLabel = normalizeXmlTagName(anyRange.xmlSerialization.name
307
- ? anyRange.xmlSerialization.name
308
- : property.name || anyRange.name || UNKNOWN_TYPE);
309
- if (prefix) {
310
- aLabel = `${prefix}:${aLabel}`;
311
- }
312
- const value = this._scalarValue(anyRange);
313
- attributes.push(`${aLabel}="${value}"`);
314
- return;
315
- }
316
- }
317
- const value = this._propertyShapeObject(property, { indent });
318
- if (value !== undefined) {
319
- const fill = this._createTabs(indent, 2);
320
- propertyParts.push(formatXmlValue(fill, value));
321
- }
322
- });
323
- value = propertyParts.join('\n');
324
- }
325
- let opening = `${baseTabs}<${name}`;
326
- if (attributes.length) {
327
- opening += ' ';
328
- opening += attributes.join(' ');
329
- }
330
- parts.unshift(`${opening}>`);
331
- parts.push(value);
332
- parts.push(`${baseTabs}</${name}>`);
333
- return parts.join('\n');
334
- }
335
- _nodePropertyArray(schema, options = {}) {
336
- const range = schema.range;
337
- const parts = [];
338
- let name;
339
- if (range.xmlSerialization && range.xmlSerialization.name) {
340
- name = normalizeXmlTagName(range.xmlSerialization.name);
341
- }
342
- else {
343
- name = normalizeXmlTagName(String(schema.name));
344
- }
345
- const { indent = 0 } = options;
346
- const isScalarItems = !!range.items && range.items.types.includes(ns.aml.vocabularies.shapes.ScalarShape);
347
- const baseTabs = this._createTabs(indent);
348
- if (!isScalarItems) {
349
- parts.push(`${baseTabs}<${name}>`);
350
- }
351
- const result = this._arrayShapeObject(range, { ...options, indent });
352
- parts.push(result);
353
- if (!isScalarItems) {
354
- parts.push(`${baseTabs}</${name}>`);
355
- }
356
- return parts.join('\n');
357
- }
358
- _arrayShapeObject(schema, options = {}, isRoot = false) {
359
- const { items } = schema;
360
- const isScalarItems = !!items && items.types.includes(ns.aml.vocabularies.shapes.ScalarShape);
361
- // the name is either from the XML serialization info, or the parent property.
362
- // IT IS NOT THE `item`'s name unless its a scalar.
363
- let nodeName;
364
- // if (isScalarItems && schema.name) {
365
- // nodeName = normalizeXmlTagName(schema.name);
366
- // } else if (!isScalarItems && items?.name) {
367
- // nodeName = normalizeXmlTagName(items.name);
368
- // }
369
- if (isRoot && schema.xmlSerialization && schema.xmlSerialization.name) {
370
- nodeName = normalizeXmlTagName(schema.xmlSerialization.name);
371
- }
372
- else if (isRoot && schema.name) {
373
- nodeName = normalizeXmlTagName(schema.name);
374
- }
375
- else if (!isScalarItems && items?.name) {
376
- nodeName = normalizeXmlTagName(items.name);
377
- }
378
- else if (schema.name) {
379
- nodeName = normalizeXmlTagName(schema.name);
380
- }
381
- // wrapping can only be defined on the array shape and it "wraps" the generated
382
- // content into an element that has the same name as the items
383
- let hasWrapped = false;
384
- if (schema.xmlSerialization && typeof schema.xmlSerialization.wrapped === 'boolean') {
385
- hasWrapped = true;
386
- }
387
- const isWrapped = !!schema.xmlSerialization && !!schema.xmlSerialization.wrapped;
388
- const currentIndent = options.indent || 0;
389
- const tagFill = new Array(currentIndent * 2 + 0).fill(' ').join('');
390
- const valueFill = new Array(currentIndent * 2 + (isWrapped ? 2 : 0)).fill(' ').join('');
391
- // let's start with examples
392
- if (this.opts.renderExamples) {
393
- const { examples = [] } = schema;
394
- const validExamples = examples.filter((item) => !!item.structuredValue);
395
- if (validExamples.length) {
396
- const parts = [];
397
- const generator = new XmlDataNodeGenerator();
398
- // scalar items are always wrapped with it's own range
399
- if (isScalarItems && !isWrapped) {
400
- const [example] = validExamples;
401
- if (!nodeName && items?.name) {
402
- nodeName = normalizeXmlTagName(items.name);
403
- }
404
- const value = generator.generate(example.structuredValue, nodeName, {
405
- indent: currentIndent,
406
- });
407
- if (value !== undefined) {
408
- parts.push(value);
409
- }
410
- }
411
- else if (isScalarItems && isWrapped) {
412
- const [example] = validExamples;
413
- const value = generator.generate(example.structuredValue, nodeName, {
414
- indent: currentIndent,
415
- });
416
- parts.push(`${tagFill}<${nodeName}>`);
417
- if (value !== undefined) {
418
- parts.push(value);
419
- }
420
- parts.push(`${tagFill}</${nodeName}>`);
421
- }
422
- else if (isWrapped) {
423
- // when wrapped we wrap each example into the "name", else we render all examples under the "name".
424
- validExamples.forEach((item) => {
425
- parts.push(`${tagFill}<${nodeName}>`);
426
- const value = generator.generate(item.structuredValue, /* nodeName */ undefined, {
427
- indent: currentIndent + 2,
428
- });
429
- if (value !== undefined) {
430
- parts.push(value);
431
- }
432
- parts.push(`${tagFill}</${nodeName}>`);
433
- });
434
- }
435
- else {
436
- validExamples.forEach((item) => {
437
- const value = generator.generate(item.structuredValue, /* nodeName */ undefined, {
438
- indent: currentIndent,
439
- });
440
- if (value !== undefined) {
441
- parts.push(value);
442
- }
443
- });
444
- }
445
- return parts.join('\n');
446
- }
447
- }
448
- if (isScalarItems && schema.defaultValue) {
449
- const gen = new XmlDataNodeGenerator();
450
- const value = gen.generate(schema.defaultValue);
451
- if (!nodeName && items?.name) {
452
- nodeName = normalizeXmlTagName(items.name);
453
- }
454
- return `<${nodeName}>${value?.trim()}</${nodeName}>`;
455
- }
456
- if (items) {
457
- const parts = [];
458
- if (isWrapped && isScalarItems) {
459
- parts.push(`${tagFill}<${nodeName}>`);
460
- }
461
- const init = {
462
- indent: currentIndent + 1,
463
- };
464
- if (nodeName) {
465
- init.forceName = nodeName;
466
- }
467
- if (!isRoot && (!hasWrapped || (hasWrapped && !isWrapped))) {
468
- init.noWrap = true;
469
- }
470
- const value = this.processNode(items, init);
471
- if (value !== undefined) {
472
- parts.push(`${valueFill}${value}`);
473
- }
474
- if (isWrapped && isScalarItems) {
475
- parts.push(`${tagFill}</${nodeName}>`);
476
- }
477
- return parts.join('\n');
478
- }
479
- return '';
480
- // const isScalarItems = !!items && items.types.includes(ns.aml.vocabularies.shapes.ScalarShape);
481
- // if (items) {
482
- // if (items.types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
483
- // return this._scalarItems(schema as IArrayShape<IScalarShape>, options);
484
- // }
485
- // if (items.types.includes(ns.w3.shacl.NodeShape)) {
486
- // return this._nodeItems(schema as IArrayShape<INodeShape>, options);
487
- // }
488
- // }
489
- // let label = shapeToXmlTagName(schema);
490
- // if (label === UNKNOWN_TYPE && isScalarItems) {
491
- // // label = shapeToXmlTagName(items as IScalarShape);
492
- // }
493
- // const currentIndent = (options.indent || 0);
494
- // const rootFill = new Array(currentIndent*2).fill(' ').join('');
495
- // const parts = [
496
- // `${rootFill}<${label}>`
497
- // ];
498
- // let nodeName = label;
499
- // const anyItems = items as IAnyShape;
500
- // if (anyItems.xmlSerialization && anyItems.xmlSerialization.name) {
501
- // nodeName = normalizeXmlTagName(anyItems.xmlSerialization.name);
502
- // }
503
- // // Note about wrapping.
504
- // // XML array values are not wrapped by default. This means that by default
505
- // // it produces a value like this:
506
- // // <ParentArray>
507
- // // <arrayMemberProperty></arrayMemberProperty>
508
- // // </ParentArray>
509
- // //
510
- // // When the object is marked as wrapped then the object is rendered as follows
511
- // //
512
- // // <ParentArray>
513
- // // <MemberObject>
514
- // // <arrayMemberProperty></arrayMemberProperty>
515
- // // <MemberObject>
516
- // // </ParentArray>
517
- // const isWrapped = xmlSerialization && !!xmlSerialization.wrapped;
518
- // const defaultValue = schema.defaultValue || items && items.defaultValue;
519
- // let itemName;
520
- // if (isWrapped) {
521
- // try {
522
- // itemName = shapeToXmlTagName(items as IAnyShape);
523
- // } catch (e) {
524
- // itemName = 'UNKNOWN-NAME'
525
- // }
526
- // }
527
- // let { examples=[] } = schema;
528
- // if (Array.isArray(anyItems.examples)) {
529
- // examples = examples.concat(anyItems.examples);
530
- // }
531
- // if (this.opts.renderExamples && examples && examples.length) {
532
- // const example = examples.find((item) => !!item.structuredValue);
533
- // const value = this._exampleToObject(example);
534
- // if (typeof value !== 'undefined') {
535
- // const tagFill = new Array(currentIndent * 2 + 2).fill(' ').join('');
536
- // const valueFill = new Array(currentIndent * 2 + 4).fill(' ').join('');
537
- // parts.push(`${tagFill}<${nodeName}>`);
538
- // parts.push(`${valueFill}${value}`);
539
- // parts.push(`${tagFill}</${nodeName}>`);
540
- // }
541
- // } else if (defaultValue) {
542
- // const gen = new XmlDataNodeGenerator();
543
- // const value = gen.generate(defaultValue);
544
- // if (value) {
545
- // const tagFill = new Array(currentIndent * 2 + 2).fill(' ').join('');
546
- // const valueFill = new Array(currentIndent * 2 + 4).fill(' ').join('');
547
- // parts.push(`${tagFill}<${nodeName}>`);
548
- // parts.push(`${valueFill}${value.trim()}`);
549
- // parts.push(`${tagFill}</${nodeName}>`);
550
- // }
551
- // } else if (items && items.types.includes(ns.w3.shacl.NodeShape)) {
552
- // const typed = items as INodeShape;
553
- // const tagFill = new Array(currentIndent * 2 + 2).fill(' ').join('');
554
- // const valueFill = isWrapped ? new Array(currentIndent * 2 + 4).fill(' ').join('') : tagFill;
555
- // if (isWrapped) {
556
- // parts.push(`${tagFill}<${itemName}>`);
557
- // }
558
- // const properties = this._collectProperties(typed);
559
- // properties.forEach((prop) => {
560
- // const value = this._propertyShapeObject(prop);
561
- // if (value) {
562
- // parts.push(`${valueFill}${value}`);
563
- // }
564
- // });
565
- // if (isWrapped) {
566
- // parts.push(`${tagFill}</${itemName}>`);
567
- // }
568
- // } else if (items) {
569
- // let name = shapeToXmlTagName(items as IAnyShape);
570
- // if (name === UNKNOWN_TYPE) {
571
- // name = label;
572
- // }
573
- // const opts = {
574
- // forceName: name,
575
- // indent: currentIndent + 1,
576
- // };
577
- // const value = items && this.processNode(items, opts);
578
- // if (typeof value !== 'undefined') {
579
- // const fill = new Array(currentIndent * 2 + 2).fill(' ').join('');
580
- // parts.push(`${fill}${value}`);
581
- // }
582
- // }
583
- // parts.push(`${rootFill}</${label}>`);
584
- // return parts.join('\n');
585
- }
586
- /**
587
- * Creates an example from an array shape when the items is the scalar shape.
588
- * Note, it assumes the previous step tested whether the `items` is scalar.
589
- *
590
- * @param schema The array schema
591
- * @param options Processing options.
592
- */
593
- _scalarItems(schema, options = {}) {
594
- const items = schema.items;
595
- const currentIndent = options.indent || 0;
596
- const tagFill = new Array(currentIndent * 2).fill(' ').join('');
597
- let nodeName = '';
598
- if (items.xmlSerialization && items.xmlSerialization.name) {
599
- nodeName = normalizeXmlTagName(items.xmlSerialization.name);
600
- }
601
- else {
602
- nodeName = shapeToXmlTagName(schema.name ? schema : items);
603
- }
604
- // let's start with examples
605
- if (this.opts.renderExamples) {
606
- let { examples = [] } = schema;
607
- if (Array.isArray(items.examples)) {
608
- examples = examples.concat(items.examples);
609
- }
610
- const validExamples = examples.filter((item) => !!item.structuredValue);
611
- if (validExamples.length) {
612
- const parts = [];
613
- const generator = new XmlDataNodeGenerator();
614
- validExamples.forEach((item) => {
615
- const value = generator.generate(item.structuredValue, nodeName);
616
- if (value !== undefined) {
617
- parts.push(`${tagFill}${value}`);
618
- }
619
- });
620
- return parts.join('\n');
621
- }
622
- }
623
- // then the default value
624
- if (schema.defaultValue) {
625
- const generator = new XmlDataNodeGenerator();
626
- const value = generator.generate(schema.defaultValue, nodeName);
627
- if (value !== undefined) {
628
- return `${tagFill}${value}`;
629
- }
630
- }
631
- // finally we generate stuff.
632
- const opts = {
633
- indent: currentIndent + 1,
634
- forceName: nodeName,
635
- };
636
- const value = this.processNode(items, opts);
637
- return `${tagFill}${value}`;
638
- }
639
- /**
640
- * Renders a NodeShape as an array item.
641
- *
642
- * @param schema The array shape with item that is NodeShape.
643
- * @param options Rendering options.
644
- */
645
- _nodeItems(schema, options = {}) {
646
- const items = schema.items;
647
- const currentIndent = options.indent || 0;
648
- const tagFill = new Array(currentIndent * 2).fill(' ').join('');
649
- const isWrapped = schema.xmlSerialization && !!schema.xmlSerialization.wrapped;
650
- const defaultValue = schema.defaultValue || items.defaultValue;
651
- let nodeName = '';
652
- if (items.xmlSerialization && items.xmlSerialization.name) {
653
- nodeName = normalizeXmlTagName(items.xmlSerialization.name);
654
- }
655
- else {
656
- nodeName = shapeToXmlTagName(schema.name ? schema : items);
657
- }
658
- const valueFill = isWrapped ? new Array(currentIndent * 2 + 2).fill(' ').join('') : tagFill;
659
- const parts = [];
660
- if (isWrapped) {
661
- parts.push(`${tagFill}<${nodeName}>`);
662
- }
663
- let rendered = false;
664
- // let's start with examples
665
- if (this.opts.renderExamples) {
666
- let { examples = [] } = schema;
667
- if (Array.isArray(items.examples)) {
668
- examples = examples.concat(items.examples);
669
- }
670
- const validExamples = examples.filter((item) => !!item.structuredValue);
671
- if (validExamples.length) {
672
- const parts = [];
673
- const generator = new XmlDataNodeGenerator();
674
- validExamples.forEach((item) => {
675
- const value = generator.generate(item.structuredValue, nodeName);
676
- if (value !== undefined) {
677
- parts.push(`${tagFill}${value}`);
678
- }
679
- });
680
- rendered = true;
681
- }
682
- }
683
- if (!rendered && defaultValue) {
684
- const generator = new XmlDataNodeGenerator();
685
- const value = generator.generate(defaultValue, nodeName);
686
- if (value !== undefined) {
687
- parts.push(`${tagFill}${value}`);
688
- rendered = true;
689
- }
690
- }
691
- if (!rendered) {
692
- const properties = this._collectProperties(items);
693
- properties.forEach((prop) => {
694
- const value = this._propertyShapeObject(prop);
695
- if (value) {
696
- parts.push(`${valueFill}${value}`);
697
- }
698
- });
699
- }
700
- if (isWrapped) {
701
- parts.push(`${tagFill}</${nodeName}>`);
702
- }
703
- return parts.join('\n');
704
- }
705
- /**
706
- * @param example The example to turn into a JS object
707
- */
708
- _exampleToObject(example) {
709
- if (example && example.structuredValue) {
710
- const generator = new XmlDataNodeGenerator();
711
- return generator.generate(example.structuredValue);
712
- }
713
- return undefined;
714
- }
715
- _unionShapeObject(schema, options = {}) {
716
- let { anyOf = [], examples = [] } = schema;
717
- if (Array.isArray(schema.inherits) && schema.inherits) {
718
- schema.inherits.forEach((parent) => {
719
- const anyParent = parent;
720
- if (Array.isArray(anyParent.examples) && anyParent.examples.length) {
721
- examples = examples.concat(anyParent.examples);
722
- }
723
- const typed = parent;
724
- if (Array.isArray(typed.anyOf) && typed.anyOf.length) {
725
- anyOf = anyOf.concat(typed.anyOf);
726
- }
727
- });
728
- }
729
- if (Array.isArray(anyOf) && anyOf.length) {
730
- if (this._isNotRequiredUnion(anyOf)) {
731
- // This generates schema for required values.
732
- // This implicitly mean that the property is not required therefore the value should
733
- // not be generated.
734
- return undefined;
735
- }
736
- const example = examples.find((item) => !!item.structuredValue);
737
- const value = this._exampleToObject(example);
738
- if (value !== undefined) {
739
- const label = shapeToXmlTagName(schema);
740
- const currentIndent = options.indent || 0;
741
- const rootFill = new Array(currentIndent * 2).fill(' ').join('');
742
- const valueFill = new Array(currentIndent * 2 + 2).fill(' ').join('');
743
- const parts = [];
744
- parts.push(`${rootFill}<${label}>`);
745
- const formatted = String(value)
746
- .split('\n')
747
- .filter((i) => !!i)
748
- .map((i) => `${valueFill}${i}`)
749
- .join('\n');
750
- parts.push(`${formatted}`);
751
- parts.push(`${rootFill}</${label}>`);
752
- return parts.join('\n');
753
- }
754
- if (schema.defaultValue) {
755
- return this._unionDefaultValue(schema, schema.defaultValue);
756
- }
757
- const member = this._readCurrentUnion(anyOf);
758
- if (member) {
759
- return this.processNode(member, { ...options, forceName: schema.name });
760
- }
761
- }
762
- return undefined;
763
- }
764
- /**
765
- * @param schema The schema with unions
766
- * @param defaultValue The definition of a default value.
767
- */
768
- _unionDefaultValue(schema, defaultValue, options = {}) {
769
- const gen = new XmlDataNodeGenerator();
770
- const value = gen.generate(defaultValue);
771
- const anySchema = schema;
772
- const label = shapeToXmlTagName(anySchema);
773
- const currentIndent = options.indent || 0;
774
- const rootFill = new Array(currentIndent * 2).fill(' ').join('');
775
- const parts = [`${rootFill}<${label}>`];
776
- const valueFill = new Array(currentIndent * 2 + 2).fill(' ').join('');
777
- parts.push(`${valueFill}${String(value).trim()}`);
778
- parts.push(`${rootFill}</${label}>`);
779
- return parts.join('\n');
780
- }
781
- _fileShapeObject() {
782
- return undefined;
783
- }
784
- _schemaShapeObject() {
785
- return undefined;
786
- }
787
- _tupleShapeObject() {
788
- return undefined;
789
- }
790
- _anyShapeObject(schema) {
791
- const { and = [], xone = [], or = [] } = schema;
792
- if (and.length) {
793
- // we combine all properties together under `schema` with changed properties
794
- const copy = structuredClone(schema);
795
- copy.and = [];
796
- copy.properties = [];
797
- and.forEach((item) => {
798
- const { types } = item;
799
- if (types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
800
- const typed = item;
801
- copy.properties.push(typed);
802
- }
803
- else if (types.includes(ns.w3.shacl.NodeShape)) {
804
- const typed = item;
805
- typed.properties.forEach((i) => copy.properties.push(i));
806
- }
807
- else if (types.includes(ns.aml.vocabularies.shapes.ArrayShape) ||
808
- types.includes(ns.aml.vocabularies.shapes.MatrixShape)) {
809
- const typed = item;
810
- if (typed.items) {
811
- copy.properties.push(typed.items);
812
- }
813
- }
814
- });
815
- return this._nodeShapeObject(copy);
816
- }
817
- if (xone.length) {
818
- const { selectedUnions = [] } = this.opts;
819
- let selected = xone.find((i) => selectedUnions.includes(i.id));
820
- if (!selected) {
821
- // select firs available
822
- selected = xone[0];
823
- }
824
- return this.processNode(selected);
825
- }
826
- if (or.length) {
827
- const { selectedUnions = [] } = this.opts;
828
- let selected = or.find((i) => selectedUnions.includes(i.id));
829
- if (!selected) {
830
- // select firs available
831
- selected = or[0];
832
- }
833
- return this.processNode(selected);
834
- }
835
- const { examples = [] } = schema;
836
- const label = shapeToXmlTagName(schema);
837
- if (this.opts.renderExamples && examples && examples.length) {
838
- const example = examples.find((item) => !!item.structuredValue);
839
- const value = this._exampleToObject(example);
840
- const parts = [];
841
- if (typeof value !== 'undefined') {
842
- const valueFill = ` `;
843
- parts.push(`<${label}>`);
844
- parts.push(`${valueFill}${value}`);
845
- parts.push(`</${label}>`);
846
- }
847
- return parts.join('\n');
848
- }
849
- return this._scalarShapeObject(schema);
850
- }
851
- }
852
- //# sourceMappingURL=ShapeXmlSchemaGenerator.js.map