@speclynx/apidom-reference 2.4.0 → 2.5.1

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 (37) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/README.md +23 -1
  3. package/dist/apidom-reference.browser.js +3218 -577
  4. package/dist/apidom-reference.browser.min.js +1 -1
  5. package/package.json +31 -24
  6. package/src/configuration/saturated.cjs +11 -10
  7. package/src/configuration/saturated.mjs +2 -1
  8. package/src/dereference/strategies/arazzo-1/index.cjs +101 -0
  9. package/src/dereference/strategies/arazzo-1/index.mjs +91 -0
  10. package/src/dereference/strategies/arazzo-1/selectors/$anchor.cjs +12 -0
  11. package/src/dereference/strategies/arazzo-1/selectors/$anchor.mjs +1 -0
  12. package/src/dereference/strategies/arazzo-1/selectors/uri.cjs +8 -0
  13. package/src/dereference/strategies/arazzo-1/selectors/uri.mjs +1 -0
  14. package/src/dereference/strategies/arazzo-1/util.cjs +37 -0
  15. package/src/dereference/strategies/arazzo-1/util.mjs +29 -0
  16. package/src/dereference/strategies/arazzo-1/visitor.cjs +411 -0
  17. package/src/dereference/strategies/arazzo-1/visitor.mjs +405 -0
  18. package/src/dereference/strategies/asyncapi-2/index.cjs +1 -1
  19. package/src/dereference/strategies/asyncapi-2/index.mjs +1 -1
  20. package/src/dereference/strategies/asyncapi-2/visitor.cjs +1 -1
  21. package/src/dereference/strategies/asyncapi-2/visitor.mjs +2 -2
  22. package/src/dereference/strategies/openapi-2/index.cjs +1 -1
  23. package/src/dereference/strategies/openapi-2/index.mjs +1 -1
  24. package/src/dereference/strategies/openapi-3-0/index.cjs +1 -1
  25. package/src/dereference/strategies/openapi-3-0/index.mjs +1 -1
  26. package/src/dereference/strategies/openapi-3-1/selectors/$anchor.cjs +2 -2
  27. package/src/dereference/strategies/openapi-3-1/selectors/$anchor.mjs +2 -2
  28. package/src/dereference/strategies/openapi-3-1/selectors/uri.cjs +3 -3
  29. package/src/dereference/strategies/openapi-3-1/selectors/uri.mjs +3 -3
  30. package/src/dereference/strategies/openapi-3-1/visitor.cjs +3 -3
  31. package/src/dereference/strategies/openapi-3-1/visitor.mjs +4 -4
  32. package/types/dereference/strategies/arazzo-1/index.d.ts +32 -0
  33. package/types/dereference/strategies/arazzo-1/selectors/$anchor.d.ts +1 -0
  34. package/types/dereference/strategies/arazzo-1/selectors/uri.d.ts +1 -0
  35. package/types/dereference/strategies/arazzo-1/util.d.ts +13 -0
  36. package/types/dereference/strategies/arazzo-1/visitor.d.ts +32 -0
  37. package/types/dereference/strategies/openapi-3-1/util.d.ts +3 -3
@@ -0,0 +1,32 @@
1
+ import { Element } from '@speclynx/apidom-datamodel';
2
+ import DereferenceStrategy, { DereferenceStrategyOptions } from '../DereferenceStrategy.ts';
3
+ import File from '../../../File.ts';
4
+ import Arazzo1DereferenceVisitor from './visitor.ts';
5
+ import type { ReferenceOptions } from '../../../options/index.ts';
6
+ export type { default as DereferenceStrategy, DereferenceStrategyOptions, } from '../DereferenceStrategy.ts';
7
+ export type { default as File, FileOptions } from '../../../File.ts';
8
+ export type { default as Reference, ReferenceOptions } from '../../../Reference.ts';
9
+ export type { default as ReferenceSet, ReferenceSetOptions } from '../../../ReferenceSet.ts';
10
+ export type { Arazzo1DereferenceVisitorOptions } from './visitor.ts';
11
+ export type { ReferenceOptions as ApiDOMReferenceOptions, ReferenceBundleOptions as ApiDOMReferenceBundleOptions, ReferenceDereferenceOptions as ApiDOMReferenceDereferenceOptions, ReferenceParseOptions as ApiDOMReferenceParseOptions, ReferenceResolveOptions as ApiDOMReferenceResolveOptions, } from '../../../options/index.ts';
12
+ export type { default as Parser, ParserOptions } from '../../../parse/parsers/Parser.ts';
13
+ export type { default as Resolver, ResolverOptions } from '../../../resolve/resolvers/Resolver.ts';
14
+ export type { default as ResolveStrategy, ResolveStrategyOptions, } from '../../../resolve/strategies/ResolveStrategy.ts';
15
+ export type { default as BundleStrategy, BundleStrategyOptions, } from '../../../bundle/strategies/BundleStrategy.ts';
16
+ export type { AncestorLineage } from '../../util.ts';
17
+ /**
18
+ * @public
19
+ */
20
+ export interface Arazzo1DereferenceStrategyOptions extends Omit<DereferenceStrategyOptions, 'name'> {
21
+ }
22
+ /**
23
+ * @public
24
+ */
25
+ declare class Arazzo1DereferenceStrategy extends DereferenceStrategy {
26
+ constructor(options?: Arazzo1DereferenceStrategyOptions);
27
+ canDereference(file: File): boolean;
28
+ dereference(file: File, options: ReferenceOptions): Promise<Element>;
29
+ }
30
+ export { Arazzo1DereferenceVisitor };
31
+ export { resolveSchema$refField, resolveSchema$idField, maybeRefractToJSONSchemaElement, } from './util.ts';
32
+ export default Arazzo1DereferenceStrategy;
@@ -0,0 +1 @@
1
+ export { isAnchor, uriToAnchor, parse, evaluate, EvaluationJsonSchema$anchorError, InvalidJsonSchema$anchorError, JsonSchema$anchorError, } from '../../openapi-3-1/selectors/$anchor.ts';
@@ -0,0 +1 @@
1
+ export { evaluate, EvaluationJsonSchemaUriError, JsonSchemaUriError, } from '../../openapi-3-1/selectors/uri.ts';
@@ -0,0 +1,13 @@
1
+ import { Element } from '@speclynx/apidom-datamodel';
2
+ export { resolveSchema$refField, resolveSchema$idField } from '../openapi-3-1/util.ts';
3
+ /**
4
+ * Cached version of JSONSchemaElement.refract.
5
+ */
6
+ export declare const refractToJSONSchemaElement: {
7
+ <T extends Element>(element: T): any;
8
+ cache: WeakMap<WeakKey, any>;
9
+ };
10
+ /**
11
+ * @public
12
+ */
13
+ export declare const maybeRefractToJSONSchemaElement: <T extends Element>(element: T) => any;
@@ -0,0 +1,32 @@
1
+ import { Element, Namespace } from '@speclynx/apidom-datamodel';
2
+ import { Path } from '@speclynx/apidom-traverse';
3
+ import Reference from '../../../Reference.ts';
4
+ import { AncestorLineage } from '../../util.ts';
5
+ import type { ReferenceOptions } from '../../../options/index.ts';
6
+ /**
7
+ * @public
8
+ */
9
+ export interface Arazzo1DereferenceVisitorOptions {
10
+ readonly namespace: Namespace;
11
+ readonly reference: Reference;
12
+ readonly options: ReferenceOptions;
13
+ readonly indirections?: Element[];
14
+ readonly ancestors?: AncestorLineage<Element>;
15
+ }
16
+ /**
17
+ * @public
18
+ */
19
+ declare class Arazzo1DereferenceVisitor {
20
+ protected readonly indirections: Element[];
21
+ protected readonly namespace: Namespace;
22
+ protected readonly reference: Reference;
23
+ protected readonly options: ReferenceOptions;
24
+ protected readonly ancestors: AncestorLineage<Element>;
25
+ constructor({ reference, namespace, options, indirections, ancestors, }: Arazzo1DereferenceVisitorOptions);
26
+ protected toBaseURI(uri: string): string;
27
+ protected toReference(uri: string): Promise<Reference>;
28
+ protected toAncestorLineage(path: Path<Element>): [AncestorLineage<Element>, Set<Element>];
29
+ ReusableElement(path: Path<Element>): void;
30
+ JSONSchemaElement(path: Path<Element>): Promise<void>;
31
+ }
32
+ export default Arazzo1DereferenceVisitor;
@@ -1,13 +1,13 @@
1
1
  import { Element } from '@speclynx/apidom-datamodel';
2
- import { SchemaElement } from '@speclynx/apidom-ns-openapi-3-1';
2
+ import { JSONSchemaElement } from '@speclynx/apidom-ns-json-schema-2020-12';
3
3
  /**
4
4
  * @public
5
5
  */
6
- export declare const resolveSchema$refField: (retrievalURI: string, schemaElement: SchemaElement) => string | undefined;
6
+ export declare const resolveSchema$refField: (retrievalURI: string, schemaElement: JSONSchemaElement) => string | undefined;
7
7
  /**
8
8
  * @public
9
9
  */
10
- export declare const resolveSchema$idField: (retrievalURI: string, schemaElement: SchemaElement) => string | undefined;
10
+ export declare const resolveSchema$idField: (retrievalURI: string, schemaElement: JSONSchemaElement) => string | undefined;
11
11
  /**
12
12
  * Cached version of SchemaElement.refract.
13
13
  */