@speclynx/apidom-ns-json-schema-draft-6 4.0.2 → 4.0.3

package/src/index.cjs

@@ -0,0 +1,46 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
+exports.__esModule = true;
+exports.specificationObj = exports.refractorPluginReplaceEmptyElement = exports.refractLinkDescription = exports.refractJSONSchema = exports.refract = exports.mediaTypes = exports.isMediaElement = exports.isLinkDescriptionElement = exports.isJSONSchemaElement = exports.isJSONReferenceLikeElement = exports.isJSONReferenceElement = exports.isBooleanJSONSchemaElement = exports.default = exports.Visitor = exports.SpecificationVisitor = exports.PatternedFieldsVisitor = exports.ParentSchemaAwareVisitor = exports.MediaElement = exports.MapVisitor = exports.LinkDescriptionVisitor = exports.LinkDescriptionElement = exports.JSONSchemaVisitor = exports.JSONSchemaElement = exports.JSONSchemaDraft6MediaTypes = exports.JSONReferenceElement = exports.ItemsVisitor = exports.FixedFieldsVisitor = exports.FallbackVisitor = exports.AlternatingVisitor = void 0;
+var _mediaTypes = _interopRequireWildcard(require("./media-types.cjs"));
+exports.mediaTypes = _mediaTypes.default;
+exports.JSONSchemaDraft6MediaTypes = _mediaTypes.JSONSchemaDraft6MediaTypes;
+var _namespace = _interopRequireDefault(require("./namespace.cjs"));
+exports.default = _namespace.default;
+var _replaceEmptyElement = _interopRequireDefault(require("./refractor/plugins/replace-empty-element.cjs"));
+exports.refractorPluginReplaceEmptyElement = _replaceEmptyElement.default;
+var _index = _interopRequireWildcard(require("./refractor/index.cjs"));
+exports.refract = _index.default;
+exports.refractJSONSchema = _index.refractJSONSchema;
+exports.refractLinkDescription = _index.refractLinkDescription;
+var _specification = _interopRequireDefault(require("./refractor/specification.cjs"));
+exports.specificationObj = _specification.default;
+var _predicates = require("./predicates.cjs");
+exports.isBooleanJSONSchemaElement = _predicates.isBooleanJSONSchemaElement;
+exports.isJSONReferenceElement = _predicates.isJSONReferenceElement;
+exports.isJSONSchemaElement = _predicates.isJSONSchemaElement;
+exports.isLinkDescriptionElement = _predicates.isLinkDescriptionElement;
+exports.isMediaElement = _predicates.isMediaElement;
+var _apidomNsJsonSchemaDraft = require("@speclynx/apidom-ns-json-schema-draft-4");
+exports.isJSONReferenceLikeElement = _apidomNsJsonSchemaDraft.isJSONReferenceLikeElement;
+exports.SpecificationVisitor = _apidomNsJsonSchemaDraft.SpecificationVisitor;
+exports.FallbackVisitor = _apidomNsJsonSchemaDraft.FallbackVisitor;
+exports.FixedFieldsVisitor = _apidomNsJsonSchemaDraft.FixedFieldsVisitor;
+exports.PatternedFieldsVisitor = _apidomNsJsonSchemaDraft.PatternedFieldsVisitor;
+exports.MapVisitor = _apidomNsJsonSchemaDraft.MapVisitor;
+exports.AlternatingVisitor = _apidomNsJsonSchemaDraft.AlternatingVisitor;
+exports.ParentSchemaAwareVisitor = _apidomNsJsonSchemaDraft.ParentSchemaAwareVisitor;
+exports.Visitor = _apidomNsJsonSchemaDraft.Visitor;
+var _index2 = _interopRequireDefault(require("./refractor/visitors/json-schema/link-description/index.cjs"));
+exports.LinkDescriptionVisitor = _index2.default;
+var _index3 = _interopRequireDefault(require("./refractor/visitors/json-schema/index.cjs"));
+exports.JSONSchemaVisitor = _index3.default;
+var _ItemsVisitor = _interopRequireDefault(require("./refractor/visitors/json-schema/ItemsVisitor.cjs"));
+exports.ItemsVisitor = _ItemsVisitor.default;
+var _inspect = require("./refractor/inspect.cjs");
+exports.JSONSchemaElement = _inspect.JSONSchemaElement;
+exports.JSONReferenceElement = _inspect.JSONReferenceElement;
+exports.MediaElement = _inspect.MediaElement;
+exports.LinkDescriptionElement = _inspect.LinkDescriptionElement;

package/src/index.mjs

@@ -0,0 +1,14 @@
+export { default as mediaTypes, JSONSchemaDraft6MediaTypes } from "./media-types.mjs";
+export { default } from "./namespace.mjs";
+export { default as refractorPluginReplaceEmptyElement } from "./refractor/plugins/replace-empty-element.mjs";
+export { default as refract, refractJSONSchema, refractLinkDescription } from "./refractor/index.mjs";
+export { default as specificationObj } from "./refractor/specification.mjs";
+export { isBooleanJSONSchemaElement, isJSONReferenceElement, isJSONSchemaElement, isLinkDescriptionElement, isMediaElement } from "./predicates.mjs";
+export { isJSONReferenceLikeElement, SpecificationVisitor, FallbackVisitor, FixedFieldsVisitor, PatternedFieldsVisitor, MapVisitor, AlternatingVisitor, ParentSchemaAwareVisitor, Visitor } from '@speclynx/apidom-ns-json-schema-draft-4';
+export { default as LinkDescriptionVisitor } from "./refractor/visitors/json-schema/link-description/index.mjs";
+export { default as JSONSchemaVisitor } from "./refractor/visitors/json-schema/index.mjs";
+export { default as ItemsVisitor } from "./refractor/visitors/json-schema/ItemsVisitor.mjs";
+/**
+ * JSON Schema Draft 6 specification elements.
+ */
+export { JSONSchemaElement, JSONReferenceElement, MediaElement, LinkDescriptionElement } from "./refractor/inspect.mjs";

package/src/index.ts

@@ -0,0 +1,85 @@
+export { default as mediaTypes, JSONSchemaDraft6MediaTypes } from './media-types.ts';
+export type { Format } from './media-types.ts';
+
+export { default } from './namespace.ts';
+
+export { default as refractorPluginReplaceEmptyElement } from './refractor/plugins/replace-empty-element.ts';
+
+export {
+  default as refract,
+  refractJSONSchema,
+  refractLinkDescription,
+} from './refractor/index.ts';
+export type { RefractorOptions, RefractorPlugin } from './refractor/index.ts';
+export type { Toolbox } from './refractor/toolbox.ts';
+export { default as specificationObj } from './refractor/specification.ts';
+
+export {
+  isBooleanJSONSchemaElement,
+  isJSONReferenceElement,
+  isJSONSchemaElement,
+  isLinkDescriptionElement,
+  isMediaElement,
+} from './predicates.ts';
+
+export {
+  isJSONReferenceLikeElement,
+  SpecificationVisitor,
+  FallbackVisitor,
+  FixedFieldsVisitor,
+  PatternedFieldsVisitor,
+  MapVisitor,
+  AlternatingVisitor,
+  ParentSchemaAwareVisitor,
+  Visitor,
+} from '@speclynx/apidom-ns-json-schema-draft-4';
+export type {
+  SpecificationVisitorOptions,
+  FallbackVisitorOptions,
+  FixedFieldsVisitorOptions,
+  PatternedFieldsVisitorOptions,
+  MapVisitorOptions,
+  AlternatingVisitorOptions,
+  ParentSchemaAwareVisitorOptions,
+  VisitorOptions,
+  AllOfVisitor,
+  AllOfVisitorOptions,
+  AnyOfVisitor,
+  AnyOfVisitorOptions,
+  DefinitionsVisitor,
+  DefinitionsVisitorOptions,
+  DependenciesVisitor,
+  DependenciesVisitorOptions,
+  OneOfVisitor,
+  OneOfVisitorOptions,
+  PatternPropertiesVisitor,
+  PatternPropertiesVisitorOptions,
+  PropertiesVisitor,
+  PropertiesVisitorOptions,
+  SchemaOrReferenceVisitor,
+  SchemaOrReferenceVisitorOptions,
+  SpecPath,
+  ItemsVisitor as JSONSchemaDraft4ItemsVisitor,
+} from '@speclynx/apidom-ns-json-schema-draft-4';
+
+export { default as LinkDescriptionVisitor } from './refractor/visitors/json-schema/link-description/index.ts';
+export type { LinkDescriptionVisitorOptions } from './refractor/visitors/json-schema/link-description/index.ts';
+export { default as JSONSchemaVisitor } from './refractor/visitors/json-schema/index.ts';
+export type { JSONSchemaVisitorOptions } from './refractor/visitors/json-schema/index.ts';
+export type {
+  default as ExamplesVisitor,
+  ExamplesVisitorOptions,
+} from './refractor/visitors/json-schema/ExamplesVisitor.ts';
+export { default as ItemsVisitor } from './refractor/visitors/json-schema/ItemsVisitor.ts';
+export type { ItemsVisitorOptions } from './refractor/visitors/json-schema/ItemsVisitor.ts';
+
+/**
+ * JSON Schema Draft 6 specification elements.
+ */
+export {
+  JSONSchemaElement,
+  JSONReferenceElement,
+  MediaElement,
+  LinkDescriptionElement,
+} from './refractor/inspect.ts';
+export type { FixedField } from './refractor/inspect.ts';

package/src/media-types.cjs

@@ -0,0 +1,34 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = exports.JSONSchemaDraft6MediaTypes = void 0;
+var _ramda = require("ramda");
+var _apidomCore = require("@speclynx/apidom-core");
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class JSONSchemaDraft6MediaTypes extends _apidomCore.MediaTypes {
+  filterByFormat(format = 'generic') {
+    const effectiveFormat = format === 'generic' ? 'schema;version' : format;
+    return this.filter(mediaType => mediaType.includes(effectiveFormat));
+  }
+  findBy(version = 'draft-06', format = 'generic') {
+    const search = format === 'generic' ? `schema;version=${version}` : `schema+${format};version=${version}`;
+    const found = this.find(mediaType => mediaType.includes(search));
+    return found || this.unknownMediaType;
+  }
+  latest(format = 'generic') {
+    return (0, _ramda.last)(this.filterByFormat(format));
+  }
+}
+
+/**
+ * @public
+ */
+exports.JSONSchemaDraft6MediaTypes = JSONSchemaDraft6MediaTypes;
+const mediaTypes = new JSONSchemaDraft6MediaTypes('application/schema;version=draft-06', 'application/schema+json;version=draft-06', 'application/schema+yaml;version=draft-06');
+var _default = exports.default = mediaTypes;

package/src/media-types.mjs

@@ -0,0 +1,30 @@
+import { last } from 'ramda';
+import { MediaTypes } from '@speclynx/apidom-core';
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+export class JSONSchemaDraft6MediaTypes extends MediaTypes {
+  filterByFormat(format = 'generic') {
+    const effectiveFormat = format === 'generic' ? 'schema;version' : format;
+    return this.filter(mediaType => mediaType.includes(effectiveFormat));
+  }
+  findBy(version = 'draft-06', format = 'generic') {
+    const search = format === 'generic' ? `schema;version=${version}` : `schema+${format};version=${version}`;
+    const found = this.find(mediaType => mediaType.includes(search));
+    return found || this.unknownMediaType;
+  }
+  latest(format = 'generic') {
+    return last(this.filterByFormat(format));
+  }
+}
+
+/**
+ * @public
+ */
+const mediaTypes = new JSONSchemaDraft6MediaTypes('application/schema;version=draft-06', 'application/schema+json;version=draft-06', 'application/schema+yaml;version=draft-06');
+export default mediaTypes;

package/src/media-types.ts

@@ -0,0 +1,40 @@
+import { last } from 'ramda';
+import { MediaTypes } from '@speclynx/apidom-core';
+
+/**
+ * @public
+ */
+export type Format = 'generic' | 'json' | 'yaml';
+
+/**
+ * @public
+ */
+export class JSONSchemaDraft6MediaTypes extends MediaTypes<string> {
+  filterByFormat(format: Format = 'generic') {
+    const effectiveFormat = format === 'generic' ? 'schema;version' : format;
+    return this.filter((mediaType) => mediaType.includes(effectiveFormat));
+  }
+
+  findBy(version = 'draft-06', format: Format = 'generic') {
+    const search =
+      format === 'generic' ? `schema;version=${version}` : `schema+${format};version=${version}`;
+    const found = this.find((mediaType) => mediaType.includes(search));
+
+    return found || this.unknownMediaType;
+  }
+
+  latest(format: Format = 'generic') {
+    return last(this.filterByFormat(format)) as string;
+  }
+}
+
+/**
+ * @public
+ */
+const mediaTypes = new JSONSchemaDraft6MediaTypes(
+  'application/schema;version=draft-06',
+  'application/schema+json;version=draft-06',
+  'application/schema+yaml;version=draft-06',
+);
+
+export default mediaTypes;

package/src/namespace.cjs

@@ -0,0 +1,24 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomNsJsonSchemaDraft = require("@speclynx/apidom-ns-json-schema-draft-4");
+var _JSONSchema = _interopRequireDefault(require("./elements/JSONSchema.cjs"));
+var _LinkDescription = _interopRequireDefault(require("./elements/LinkDescription.cjs"));
+/**
+ * @public
+ */
+const jsonSchemaDraft6 = {
+  namespace: options => {
+    const {
+      base
+    } = options;
+    base.register('jSONSchemaDraft6', _JSONSchema.default);
+    base.register('jSONReference', _apidomNsJsonSchemaDraft.JSONReferenceElement);
+    base.register('media', _apidomNsJsonSchemaDraft.MediaElement);
+    base.register('linkDescription', _LinkDescription.default);
+    return base;
+  }
+};
+var _default = exports.default = jsonSchemaDraft6;

package/src/namespace.mjs

@@ -0,0 +1,19 @@
+import { JSONReferenceElement, MediaElement } from '@speclynx/apidom-ns-json-schema-draft-4';
+import JSONSchemaElement from "./elements/JSONSchema.mjs";
+import LinkDescriptionElement from "./elements/LinkDescription.mjs";
+/**
+ * @public
+ */
+const jsonSchemaDraft6 = {
+  namespace: options => {
+    const {
+      base
+    } = options;
+    base.register('jSONSchemaDraft6', JSONSchemaElement);
+    base.register('jSONReference', JSONReferenceElement);
+    base.register('media', MediaElement);
+    base.register('linkDescription', LinkDescriptionElement);
+    return base;
+  }
+};
+export default jsonSchemaDraft6;

package/src/namespace.ts

@@ -0,0 +1,23 @@
+import { NamespacePlugin } from '@speclynx/apidom-datamodel';
+import { JSONReferenceElement, MediaElement } from '@speclynx/apidom-ns-json-schema-draft-4';
+
+import JSONSchemaElement from './elements/JSONSchema.ts';
+import LinkDescriptionElement from './elements/LinkDescription.ts';
+
+/**
+ * @public
+ */
+const jsonSchemaDraft6: NamespacePlugin = {
+  namespace: (options) => {
+    const { base } = options;
+
+    base.register('jSONSchemaDraft6', JSONSchemaElement);
+    base.register('jSONReference', JSONReferenceElement);
+    base.register('media', MediaElement);
+    base.register('linkDescription', LinkDescriptionElement);
+
+    return base;
+  },
+};
+
+export default jsonSchemaDraft6;

package/src/predicates.cjs

@@ -0,0 +1,30 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.isMediaElement = exports.isLinkDescriptionElement = exports.isJSONSchemaElement = exports.isJSONReferenceElement = exports.isBooleanJSONSchemaElement = void 0;
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _JSONSchema = _interopRequireDefault(require("./elements/JSONSchema.cjs"));
+var _LinkDescription = _interopRequireDefault(require("./elements/LinkDescription.cjs"));
+var _apidomNsJsonSchemaDraft = require("@speclynx/apidom-ns-json-schema-draft-4");
+exports.isJSONReferenceElement = _apidomNsJsonSchemaDraft.isJSONReferenceElement;
+exports.isMediaElement = _apidomNsJsonSchemaDraft.isMediaElement;
+/**
+ * @public
+ */
+const isBooleanJSONSchemaElement = element => {
+  return (0, _apidomDatamodel.isBooleanElement)(element) && (0, _apidomDatamodel.includesClasses)(element, ['boolean-json-schema']);
+};
+
+/**
+ * @public
+ */
+exports.isBooleanJSONSchemaElement = isBooleanJSONSchemaElement;
+const isJSONSchemaElement = element => element instanceof _JSONSchema.default;
+
+/**
+ * @public
+ */
+exports.isJSONSchemaElement = isJSONSchemaElement;
+const isLinkDescriptionElement = element => element instanceof _LinkDescription.default;
+exports.isLinkDescriptionElement = isLinkDescriptionElement;

package/src/predicates.mjs

@@ -0,0 +1,21 @@
+import { isBooleanElement, includesClasses } from '@speclynx/apidom-datamodel';
+import JSONSchemaElement from "./elements/JSONSchema.mjs";
+import LinkDescriptionElement from "./elements/LinkDescription.mjs";
+export { isJSONReferenceElement, isMediaElement } from '@speclynx/apidom-ns-json-schema-draft-4';
+
+/**
+ * @public
+ */
+export const isBooleanJSONSchemaElement = element => {
+  return isBooleanElement(element) && includesClasses(element, ['boolean-json-schema']);
+};
+
+/**
+ * @public
+ */
+export const isJSONSchemaElement = element => element instanceof JSONSchemaElement;
+
+/**
+ * @public
+ */
+export const isLinkDescriptionElement = element => element instanceof LinkDescriptionElement;

package/src/predicates.ts

@@ -0,0 +1,25 @@
+import { isBooleanElement, BooleanElement, includesClasses } from '@speclynx/apidom-datamodel';
+
+import JSONSchemaElement from './elements/JSONSchema.ts';
+import LinkDescriptionElement from './elements/LinkDescription.ts';
+
+export { isJSONReferenceElement, isMediaElement } from '@speclynx/apidom-ns-json-schema-draft-4';
+
+/**
+ * @public
+ */
+export const isBooleanJSONSchemaElement = (element: unknown): element is BooleanElement => {
+  return isBooleanElement(element) && includesClasses(element, ['boolean-json-schema']);
+};
+
+/**
+ * @public
+ */
+export const isJSONSchemaElement = (element: unknown): element is JSONSchemaElement =>
+  element instanceof JSONSchemaElement;
+
+/**
+ * @public
+ */
+export const isLinkDescriptionElement = (element: unknown): element is LinkDescriptionElement =>
+  element instanceof LinkDescriptionElement;

package/src/refractor/index.cjs

@@ -0,0 +1,76 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.refractLinkDescription = exports.refractJSONSchema = exports.default = void 0;
+var _apidomCore = require("@speclynx/apidom-core");
+var _apidomTraverse = require("@speclynx/apidom-traverse");
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _ramda = require("ramda");
+var _specification = _interopRequireDefault(require("./specification.cjs"));
+var _toolbox = _interopRequireDefault(require("./toolbox.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+const refract = (value, {
+  element = 'jSONSchemaDraft6',
+  plugins = [],
+  specificationObj = _specification.default,
+  consume = false
+} = {}) => {
+  const genericElement = (0, _apidomDatamodel.refract)(value);
+  const resolvedSpec = (0, _apidomCore.resolveSpecification)(specificationObj);
+  const elementMap = resolvedSpec.elementMap;
+  const specPath = elementMap[element];
+  if (!specPath) {
+    throw new Error(`Unknown element type: "${element}"`);
+  }
+
+  /**
+   * This is where generic ApiDOM becomes semantic (namespace applied).
+   * We don't allow consumers to hook into this translation.
+   * Though we allow consumers to define their own plugins on already transformed ApiDOM.
+   */
+  const RootVisitorClass = (0, _ramda.path)(specPath, resolvedSpec);
+  const rootVisitor = new RootVisitorClass({
+    specObj: resolvedSpec,
+    consume
+  });
+  (0, _apidomTraverse.traverse)(genericElement, rootVisitor);
+
+  /**
+   * Running plugins visitors means extra single traversal === performance hit.
+   */
+  return (0, _apidomCore.dispatchRefractorPlugins)(rootVisitor.element, plugins, {
+    toolboxCreator: _toolbox.default
+  });
+};
+
+/**
+ * Refracts a value into a JSONSchemaElement.
+ * @public
+ */
+const refractJSONSchema = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'jSONSchemaDraft6'
+});
+
+/**
+ * Refracts a value into a LinkDescriptionElement.
+ * @public
+ */
+exports.refractJSONSchema = refractJSONSchema;
+const refractLinkDescription = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'linkDescription'
+});
+exports.refractLinkDescription = refractLinkDescription;
+var _default = exports.default = refract;

package/src/refractor/index.mjs

@@ -0,0 +1,67 @@
+import { resolveSpecification, dispatchRefractorPlugins } from '@speclynx/apidom-core';
+import { traverse } from '@speclynx/apidom-traverse';
+import { refract as baseRefract } from '@speclynx/apidom-datamodel';
+import { path } from 'ramda';
+import specification from "./specification.mjs";
+import createToolbox from "./toolbox.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+const refract = (value, {
+  element = 'jSONSchemaDraft6',
+  plugins = [],
+  specificationObj = specification,
+  consume = false
+} = {}) => {
+  const genericElement = baseRefract(value);
+  const resolvedSpec = resolveSpecification(specificationObj);
+  const elementMap = resolvedSpec.elementMap;
+  const specPath = elementMap[element];
+  if (!specPath) {
+    throw new Error(`Unknown element type: "${element}"`);
+  }
+
+  /**
+   * This is where generic ApiDOM becomes semantic (namespace applied).
+   * We don't allow consumers to hook into this translation.
+   * Though we allow consumers to define their own plugins on already transformed ApiDOM.
+   */
+  const RootVisitorClass = path(specPath, resolvedSpec);
+  const rootVisitor = new RootVisitorClass({
+    specObj: resolvedSpec,
+    consume
+  });
+  traverse(genericElement, rootVisitor);
+
+  /**
+   * Running plugins visitors means extra single traversal === performance hit.
+   */
+  return dispatchRefractorPlugins(rootVisitor.element, plugins, {
+    toolboxCreator: createToolbox
+  });
+};
+
+/**
+ * Refracts a value into a JSONSchemaElement.
+ * @public
+ */
+export const refractJSONSchema = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'jSONSchemaDraft6'
+});
+
+/**
+ * Refracts a value into a LinkDescriptionElement.
+ * @public
+ */
+export const refractLinkDescription = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'linkDescription'
+});
+export default refract;

package/src/refractor/index.ts

@@ -0,0 +1,90 @@
+import { resolveSpecification, dispatchRefractorPlugins } from '@speclynx/apidom-core';
+import { traverse } from '@speclynx/apidom-traverse';
+import { Element, refract as baseRefract } from '@speclynx/apidom-datamodel';
+import { path } from 'ramda';
+import { Visitor as VisitorClass } from '@speclynx/apidom-ns-json-schema-draft-4';
+
+import specification from './specification.ts';
+import createToolbox, { type Toolbox } from './toolbox.ts';
+import type JSONSchemaElement from '../elements/JSONSchema.ts';
+import type LinkDescriptionElement from '../elements/LinkDescription.ts';
+
+/**
+ * @public
+ */
+export type RefractorPlugin = (toolbox: Toolbox) => {
+  visitor?: object;
+  pre?: () => void;
+  post?: () => void;
+};
+
+/**
+ * @public
+ */
+export interface RefractorOptions {
+  readonly element?: string;
+  readonly plugins?: RefractorPlugin[];
+  readonly specificationObj?: typeof specification;
+  readonly consume?: boolean;
+}
+
+/**
+ * @public
+ */
+const refract = <T extends Element>(
+  value: unknown,
+  {
+    element = 'jSONSchemaDraft6',
+    plugins = [],
+    specificationObj = specification,
+    consume = false,
+  }: RefractorOptions = {},
+): T => {
+  const genericElement = baseRefract(value);
+  const resolvedSpec = resolveSpecification(specificationObj);
+  const elementMap = resolvedSpec.elementMap as Record<string, string[]>;
+  const specPath = elementMap[element];
+
+  if (!specPath) {
+    throw new Error(`Unknown element type: "${element}"`);
+  }
+
+  /**
+   * This is where generic ApiDOM becomes semantic (namespace applied).
+   * We don't allow consumers to hook into this translation.
+   * Though we allow consumers to define their own plugins on already transformed ApiDOM.
+   */
+  const RootVisitorClass = path(specPath, resolvedSpec) as new (
+    options: Record<string, unknown>,
+  ) => InstanceType<typeof VisitorClass>;
+  const rootVisitor = new RootVisitorClass({ specObj: resolvedSpec, consume });
+
+  traverse(genericElement, rootVisitor);
+
+  /**
+   * Running plugins visitors means extra single traversal === performance hit.
+   */
+  return dispatchRefractorPlugins(rootVisitor.element, plugins, {
+    toolboxCreator: createToolbox,
+  }) as T;
+};
+
+/**
+ * Refracts a value into a JSONSchemaElement.
+ * @public
+ */
+export const refractJSONSchema = <T extends Element = JSONSchemaElement>(
+  value: unknown,
+  options: Omit<RefractorOptions, 'element'> = {},
+): T => refract(value, { ...options, element: 'jSONSchemaDraft6' });
+
+/**
+ * Refracts a value into a LinkDescriptionElement.
+ * @public
+ */
+export const refractLinkDescription = <T extends Element = LinkDescriptionElement>(
+  value: unknown,
+  options: Omit<RefractorOptions, 'element'> = {},
+): T => refract(value, { ...options, element: 'linkDescription' });
+
+export default refract;