@speclynx/apidom-reference 6.2.0 → 7.0.0

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 (91) hide show
  1. package/CHANGELOG.md +49 -0
  2. package/README.md +45 -0
  3. package/dist/apidom-reference.browser.js +4701 -3478
  4. package/dist/apidom-reference.browser.min.js +1 -1
  5. package/package.json +29 -28
  6. package/src/File.cjs +5 -2
  7. package/src/File.mjs +5 -2
  8. package/src/bundle/strategies/arazzo-1/index.cjs +3 -2
  9. package/src/bundle/strategies/arazzo-1/index.mjs +3 -2
  10. package/src/bundle/strategies/asyncapi-2/index.cjs +3 -2
  11. package/src/bundle/strategies/asyncapi-2/index.mjs +3 -2
  12. package/src/bundle/strategies/openapi-2/index.cjs +3 -2
  13. package/src/bundle/strategies/openapi-2/index.mjs +3 -2
  14. package/src/bundle/strategies/openapi-3-0/index.cjs +3 -2
  15. package/src/bundle/strategies/openapi-3-0/index.mjs +3 -2
  16. package/src/bundle/strategies/openapi-3-1/index.cjs +3 -2
  17. package/src/bundle/strategies/openapi-3-1/index.mjs +3 -2
  18. package/src/dereference/strategies/DereferenceVisitor.cjs +588 -0
  19. package/src/dereference/strategies/DereferenceVisitor.mjs +580 -0
  20. package/src/dereference/strategies/arazzo-1/index.cjs +14 -39
  21. package/src/dereference/strategies/arazzo-1/index.mjs +15 -40
  22. package/src/dereference/strategies/arazzo-1/visitor.cjs +207 -331
  23. package/src/dereference/strategies/arazzo-1/visitor.mjs +215 -338
  24. package/src/dereference/strategies/asyncapi-2/index.cjs +11 -39
  25. package/src/dereference/strategies/asyncapi-2/index.mjs +11 -39
  26. package/src/dereference/strategies/asyncapi-2/visitor.cjs +133 -425
  27. package/src/dereference/strategies/asyncapi-2/visitor.mjs +137 -429
  28. package/src/dereference/strategies/openapi-2/index.cjs +12 -42
  29. package/src/dereference/strategies/openapi-2/index.mjs +12 -42
  30. package/src/dereference/strategies/openapi-2/visitor.cjs +168 -532
  31. package/src/dereference/strategies/openapi-2/visitor.mjs +172 -536
  32. package/src/dereference/strategies/openapi-3-0/index.cjs +12 -42
  33. package/src/dereference/strategies/openapi-3-0/index.mjs +12 -42
  34. package/src/dereference/strategies/openapi-3-0/visitor.cjs +194 -468
  35. package/src/dereference/strategies/openapi-3-0/visitor.mjs +199 -473
  36. package/src/dereference/strategies/openapi-3-1/index.cjs +16 -42
  37. package/src/dereference/strategies/openapi-3-1/index.mjs +16 -42
  38. package/src/dereference/strategies/openapi-3-1/visitor.cjs +350 -602
  39. package/src/dereference/strategies/openapi-3-1/visitor.mjs +357 -608
  40. package/src/dereference/strategies/overlay-1/index.cjs +3 -2
  41. package/src/dereference/strategies/overlay-1/index.mjs +3 -2
  42. package/src/index.cjs +0 -7
  43. package/src/index.mjs +0 -1
  44. package/src/parse/index.cjs +9 -1
  45. package/src/parse/index.mjs +9 -1
  46. package/src/parse/parsers/apidom-json/index.cjs +2 -1
  47. package/src/parse/parsers/apidom-json/index.mjs +2 -1
  48. package/src/parse/parsers/arazzo-json-1/index.cjs +2 -1
  49. package/src/parse/parsers/arazzo-json-1/index.mjs +2 -1
  50. package/src/parse/parsers/arazzo-yaml-1/index.cjs +2 -1
  51. package/src/parse/parsers/arazzo-yaml-1/index.mjs +2 -1
  52. package/src/parse/parsers/asyncapi-json-2/index.cjs +2 -1
  53. package/src/parse/parsers/asyncapi-json-2/index.mjs +2 -1
  54. package/src/parse/parsers/asyncapi-yaml-2/index.cjs +2 -1
  55. package/src/parse/parsers/asyncapi-yaml-2/index.mjs +2 -1
  56. package/src/parse/parsers/json/index.cjs +2 -1
  57. package/src/parse/parsers/json/index.mjs +2 -1
  58. package/src/parse/parsers/openapi-json-2/index.cjs +2 -1
  59. package/src/parse/parsers/openapi-json-2/index.mjs +2 -1
  60. package/src/parse/parsers/openapi-json-3-0/index.cjs +2 -1
  61. package/src/parse/parsers/openapi-json-3-0/index.mjs +2 -1
  62. package/src/parse/parsers/openapi-json-3-1/index.cjs +2 -1
  63. package/src/parse/parsers/openapi-json-3-1/index.mjs +2 -1
  64. package/src/parse/parsers/openapi-yaml-2/index.cjs +2 -1
  65. package/src/parse/parsers/openapi-yaml-2/index.mjs +2 -1
  66. package/src/parse/parsers/openapi-yaml-3-0/index.cjs +2 -1
  67. package/src/parse/parsers/openapi-yaml-3-0/index.mjs +2 -1
  68. package/src/parse/parsers/openapi-yaml-3-1/index.cjs +2 -1
  69. package/src/parse/parsers/openapi-yaml-3-1/index.mjs +2 -1
  70. package/src/parse/parsers/overlay-json-1/index.cjs +2 -1
  71. package/src/parse/parsers/overlay-json-1/index.mjs +2 -1
  72. package/src/parse/parsers/overlay-yaml-1/index.cjs +2 -1
  73. package/src/parse/parsers/overlay-yaml-1/index.mjs +2 -1
  74. package/src/parse/parsers/yaml-1-2/index.cjs +2 -1
  75. package/src/parse/parsers/yaml-1-2/index.mjs +2 -1
  76. package/types/apidom-reference.d.ts +0 -9
  77. package/types/dereference/strategies/DereferenceVisitor.d.ts +224 -0
  78. package/types/dereference/strategies/arazzo-1/index.d.ts +0 -1
  79. package/types/dereference/strategies/arazzo-1/visitor.d.ts +38 -38
  80. package/types/dereference/strategies/asyncapi-2/index.d.ts +0 -1
  81. package/types/dereference/strategies/asyncapi-2/visitor.d.ts +13 -29
  82. package/types/dereference/strategies/openapi-2/index.d.ts +0 -1
  83. package/types/dereference/strategies/openapi-2/visitor.d.ts +14 -29
  84. package/types/dereference/strategies/openapi-3-0/index.d.ts +0 -1
  85. package/types/dereference/strategies/openapi-3-0/visitor.d.ts +13 -28
  86. package/types/dereference/strategies/openapi-3-1/index.d.ts +0 -1
  87. package/types/dereference/strategies/openapi-3-1/visitor.d.ts +37 -33
  88. package/types/index.d.ts +0 -1
  89. package/src/dereference/util.cjs +0 -33
  90. package/src/dereference/util.mjs +0 -27
  91. package/types/dereference/util.d.ts +0 -9
@@ -1,6 +1,6 @@
1
- import { cloneDeep, isParseResultElement, includesClasses } from '@speclynx/apidom-datamodel';
2
- import { traverseAsync } from '@speclynx/apidom-traverse';
1
+ import { isParseResultElement, includesClasses } from '@speclynx/apidom-datamodel';
3
2
  import { isArazzoSpecification1Element, mediaTypes } from '@speclynx/apidom-ns-arazzo-1';
3
+ import { matches, selectBestMatch } from '@swaggerexpert/media-types';
4
4
  import DereferenceStrategy from "../DereferenceStrategy.mjs";
5
5
  import Reference from "../../../Reference.mjs";
6
6
  import ReferenceSet from "../../../ReferenceSet.mjs";
@@ -22,65 +22,41 @@ class Arazzo1DereferenceStrategy extends DereferenceStrategy {
22
22
  }
23
23
  canDereference(file) {
24
24
  // assert by media type
25
- if (file.mediaType !== 'text/plain') {
26
- return mediaTypes.includes(file.mediaType);
25
+ if (!matches('text/plain', file.mediaType)) {
26
+ return selectBestMatch(mediaTypes, file.mediaType) !== null;
27
27
  }
28
28
 
29
29
  // assert by inspecting ApiDOM
30
30
  return isArazzoSpecification1Element(file.parseResult?.result);
31
31
  }
32
32
  async dereference(file, options) {
33
- const immutableRefSet = options.dereference.refSet ?? new ReferenceSet();
34
- const mutableRefSet = new ReferenceSet();
35
- let refSet = immutableRefSet;
33
+ const refSet = options.dereference.refSet ?? new ReferenceSet();
36
34
  let reference;
37
- if (!immutableRefSet.has(file.uri)) {
35
+ if (!refSet.has(file.uri)) {
38
36
  reference = new Reference({
39
37
  uri: file.uri,
40
38
  value: file.parseResult
41
39
  });
42
- immutableRefSet.add(reference);
40
+ refSet.add(reference);
43
41
  } else {
44
42
  // pre-computed refSet was provided as configuration option
45
- reference = immutableRefSet.find(ref => ref.uri === file.uri);
43
+ reference = refSet.find(ref => ref.uri === file.uri);
46
44
  }
47
45
 
48
46
  /**
49
- * Clone refSet due the dereferencing process being mutable.
50
- * We don't want to mutate the original refSet and the references.
47
+ * With the immutable option the dereferenced element is a new tree,
48
+ * otherwise the dereferenced root is dereferenced in place.
51
49
  */
52
- if (options.dereference.immutable) {
53
- immutableRefSet.refs.map(ref => new Reference({
54
- ...ref,
55
- value: cloneDeep(ref.value)
56
- })).forEach(ref => mutableRefSet.add(ref));
57
- reference = mutableRefSet.find(ref => ref.uri === file.uri);
58
- refSet = mutableRefSet;
59
- }
60
- const shouldDetectCircular = ['error', 'replace'].includes(options.dereference.circular);
50
+ const root = refSet.rootRef.value;
61
51
  const visitor = new Arazzo1DereferenceVisitor({
62
52
  reference,
63
53
  options,
64
- ancestorSchema$ids: detachedRootSchema$ids(refSet.rootRef.value.result)
54
+ ancestorSchema$ids: detachedRootSchema$ids(root.result)
65
55
  });
66
- const dereferencedElement = await traverseAsync(refSet.rootRef.value, visitor, {
67
- mutable: true,
68
- ...(shouldDetectCircular && {
69
- skipVisited: 'skip'
70
- })
56
+ const dereferencedElement = await visitor.dereference(root, {
57
+ ancestorSchema$ids: detachedRootSchema$ids(root.result)
71
58
  });
72
59
 
73
- /**
74
- * If immutable option is set, replay refs from the refSet.
75
- * Replayed before source descriptions are dereferenced, so they can reuse the refs.
76
- */
77
- if (options.dereference.immutable) {
78
- mutableRefSet.refs.filter(ref => ref.uri.startsWith('immutable://')).map(ref => new Reference({
79
- ...ref,
80
- uri: ref.uri.replace(/^immutable:\/\//, '')
81
- })).forEach(ref => immutableRefSet.add(ref));
82
- }
83
-
84
60
  /**
85
61
  * Dereference source descriptions if option is enabled.
86
62
  */
@@ -100,9 +76,8 @@ class Arazzo1DereferenceStrategy extends DereferenceStrategy {
100
76
  * If provided as configuration option, then provider is responsible for cleanup.
101
77
  */
102
78
  if (options.dereference.refSet === null) {
103
- immutableRefSet.clean();
79
+ refSet.clean();
104
80
  }
105
- mutableRefSet.clean();
106
81
  return dereferencedElement;
107
82
  }
108
83
  }