@speclynx/apidom-ns-json-schema-draft-4 1.12.1

package/src/elements/LinkDescription.mjs

@@ -0,0 +1,61 @@
+import { ObjectElement } from '@speclynx/apidom-core';
+/**
+ * URI: https://datatracker.ietf.org/doc/html/draft-wright-json-schema-hyperschema-00#section-5
+ * @public
+ */
+
+class LinkDescription extends ObjectElement {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'linkDescription';
+  }
+  get href() {
+    return this.get('href');
+  }
+  set href(href) {
+    this.set('href', href);
+  }
+  get rel() {
+    return this.get('rel');
+  }
+  set rel(rel) {
+    this.set('rel', rel);
+  }
+  get title() {
+    return this.get('title');
+  }
+  set title(title) {
+    this.set('title', title);
+  }
+  get targetSchema() {
+    return this.get('targetSchema');
+  }
+  set targetSchema(targetSchema) {
+    this.set('targetSchema', targetSchema);
+  }
+  get mediaType() {
+    return this.get('mediaType');
+  }
+  set mediaType(mediaType) {
+    this.set('mediaType', mediaType);
+  }
+  get method() {
+    return this.get('method');
+  }
+  set method(method) {
+    this.set('method', method);
+  }
+  get encType() {
+    return this.get('encType');
+  }
+  set encType(encType) {
+    this.set('encType', encType);
+  }
+  get schema() {
+    return this.get('schema');
+  }
+  set schema(schema) {
+    this.set('schema', schema);
+  }
+}
+export default LinkDescription;

package/src/elements/Media.cjs

@@ -0,0 +1,29 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomCore = require("@speclynx/apidom-core");
+/**
+ * URI: https://datatracker.ietf.org/doc/html/draft-wright-json-schema-hyperschema-00#section-4.3
+ * @public
+ */
+
+class Media extends _apidomCore.ObjectElement {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'media';
+  }
+  get binaryEncoding() {
+    return this.get('binaryEncoding');
+  }
+  set binaryEncoding(binaryEncoding) {
+    this.set('binaryEncoding', binaryEncoding);
+  }
+  get type() {
+    return this.get('type');
+  }
+  set type(type) {
+    this.set('type', type);
+  }
+}
+var _default = exports.default = Media;

package/src/elements/Media.mjs

@@ -0,0 +1,26 @@
+import { ObjectElement } from '@speclynx/apidom-core';
+
+/**
+ * URI: https://datatracker.ietf.org/doc/html/draft-wright-json-schema-hyperschema-00#section-4.3
+ * @public
+ */
+
+class Media extends ObjectElement {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'media';
+  }
+  get binaryEncoding() {
+    return this.get('binaryEncoding');
+  }
+  set binaryEncoding(binaryEncoding) {
+    this.set('binaryEncoding', binaryEncoding);
+  }
+  get type() {
+    return this.get('type');
+  }
+  set type(type) {
+    this.set('type', type);
+  }
+}
+export default Media;

package/src/index.cjs

@@ -0,0 +1,66 @@
+"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.refract = exports.mediaTypes = exports.keyMap = exports.isStringElement = exports.isRefElement = exports.isObjectElement = exports.isNumberElement = exports.isNullElement = exports.isMemberElement = exports.isMediaElement = exports.isLinkElement = exports.isLinkDescriptionElement = exports.isJSONSchemaElement = exports.isJSONReferenceLikeElement = exports.isJSONReferenceElement = exports.isElement = exports.isBooleanElement = exports.isArrayElement = exports.getNodeType = exports.default = exports.createRefractor = exports.Visitor = exports.SpecificationVisitor = exports.PatternedFieldsVisitor = exports.ParentSchemaAwareVisitor = exports.MediaElement = exports.MapVisitor = exports.LinkDescriptionVisitor = exports.LinkDescriptionElement = exports.JSONSchemaVisitor = exports.JSONSchemaElement = exports.JSONSchemaDraft4MediaTypes = exports.JSONReferenceElement = exports.ItemsVisitor = exports.FixedFieldsVisitor = exports.FallbackVisitor = exports.AlternatingVisitor = void 0;
+var _apidomCore = require("@speclynx/apidom-core");
+exports.isRefElement = _apidomCore.isRefElement;
+exports.isLinkElement = _apidomCore.isLinkElement;
+exports.isMemberElement = _apidomCore.isMemberElement;
+exports.isObjectElement = _apidomCore.isObjectElement;
+exports.isArrayElement = _apidomCore.isArrayElement;
+exports.isBooleanElement = _apidomCore.isBooleanElement;
+exports.isNullElement = _apidomCore.isNullElement;
+exports.isElement = _apidomCore.isElement;
+exports.isNumberElement = _apidomCore.isNumberElement;
+exports.isStringElement = _apidomCore.isStringElement;
+var _mediaTypes = _interopRequireWildcard(require("./media-types.cjs"));
+exports.mediaTypes = _mediaTypes.default;
+exports.JSONSchemaDraft4MediaTypes = _mediaTypes.JSONSchemaDraft4MediaTypes;
+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.createRefractor = _index.createRefractor;
+var _specification = _interopRequireDefault(require("./refractor/specification.cjs"));
+exports.specificationObj = _specification.default;
+var _predicates = require("./predicates.cjs");
+exports.isJSONReferenceElement = _predicates.isJSONReferenceElement;
+exports.isJSONSchemaElement = _predicates.isJSONSchemaElement;
+exports.isLinkDescriptionElement = _predicates.isLinkDescriptionElement;
+exports.isMediaElement = _predicates.isMediaElement;
+var _predicates2 = require("./refractor/predicates.cjs");
+exports.isJSONReferenceLikeElement = _predicates2.isJSONReferenceLikeElement;
+var _Visitor = _interopRequireDefault(require("./refractor/visitors/Visitor.cjs"));
+exports.Visitor = _Visitor.default;
+var _SpecificationVisitor = _interopRequireDefault(require("./refractor/visitors/SpecificationVisitor.cjs"));
+exports.SpecificationVisitor = _SpecificationVisitor.default;
+var _FallbackVisitor = _interopRequireDefault(require("./refractor/visitors/FallbackVisitor.cjs"));
+exports.FallbackVisitor = _FallbackVisitor.default;
+var _FixedFieldsVisitor = _interopRequireDefault(require("./refractor/visitors/generics/FixedFieldsVisitor.cjs"));
+exports.FixedFieldsVisitor = _FixedFieldsVisitor.default;
+var _PatternedFieldsVisitor = _interopRequireDefault(require("./refractor/visitors/generics/PatternedFieldsVisitor.cjs"));
+exports.PatternedFieldsVisitor = _PatternedFieldsVisitor.default;
+var _MapVisitor = _interopRequireDefault(require("./refractor/visitors/generics/MapVisitor.cjs"));
+exports.MapVisitor = _MapVisitor.default;
+var _AlternatingVisitor = _interopRequireDefault(require("./refractor/visitors/generics/AlternatingVisitor.cjs"));
+exports.AlternatingVisitor = _AlternatingVisitor.default;
+var _ParentSchemaAwareVisitor = _interopRequireDefault(require("./refractor/visitors/json-schema/ParentSchemaAwareVisitor.cjs"));
+exports.ParentSchemaAwareVisitor = _ParentSchemaAwareVisitor.default;
+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 _visitor = require("./traversal/visitor.cjs");
+exports.keyMap = _visitor.keyMap;
+exports.getNodeType = _visitor.getNodeType;
+var _registration = require("./refractor/registration.cjs");
+exports.JSONSchemaElement = _registration.JSONSchemaElement;
+exports.JSONReferenceElement = _registration.JSONReferenceElement;
+exports.MediaElement = _registration.MediaElement;
+exports.LinkDescriptionElement = _registration.LinkDescriptionElement;

package/src/index.mjs

@@ -0,0 +1,24 @@
+export { isRefElement, isLinkElement, isMemberElement, isObjectElement, isArrayElement, isBooleanElement, isNullElement, isElement, isNumberElement, isStringElement } from '@speclynx/apidom-core';
+export { default as mediaTypes, JSONSchemaDraft4MediaTypes } from "./media-types.mjs";
+export { default } from "./namespace.mjs";
+export { default as refractorPluginReplaceEmptyElement } from "./refractor/plugins/replace-empty-element.mjs";
+export { default as refract, createRefractor } from "./refractor/index.mjs";
+export { default as specificationObj } from "./refractor/specification.mjs";
+export { isJSONReferenceElement, isJSONSchemaElement, isLinkDescriptionElement, isMediaElement } from "./predicates.mjs";
+export { isJSONReferenceLikeElement } from "./refractor/predicates.mjs";
+export { default as Visitor } from "./refractor/visitors/Visitor.mjs";
+export { default as SpecificationVisitor } from "./refractor/visitors/SpecificationVisitor.mjs";
+export { default as FallbackVisitor } from "./refractor/visitors/FallbackVisitor.mjs";
+export { default as FixedFieldsVisitor } from "./refractor/visitors/generics/FixedFieldsVisitor.mjs";
+export { default as PatternedFieldsVisitor } from "./refractor/visitors/generics/PatternedFieldsVisitor.mjs";
+export { default as MapVisitor } from "./refractor/visitors/generics/MapVisitor.mjs";
+export { default as AlternatingVisitor } from "./refractor/visitors/generics/AlternatingVisitor.mjs";
+export { default as ParentSchemaAwareVisitor } from "./refractor/visitors/json-schema/ParentSchemaAwareVisitor.mjs";
+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";
+export { keyMap, getNodeType } from "./traversal/visitor.mjs";
+/**
+ * JSON Schema Draft 4 specification elements.
+ */
+export { JSONSchemaElement, JSONReferenceElement, MediaElement, LinkDescriptionElement } from "./refractor/registration.mjs";

package/src/media-types.cjs

@@ -0,0 +1,34 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = exports.JSONSchemaDraft4MediaTypes = void 0;
+var _ramda = require("ramda");
+var _apidomCore = require("@speclynx/apidom-core");
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class JSONSchemaDraft4MediaTypes extends _apidomCore.MediaTypes {
+  filterByFormat(format = 'generic') {
+    const effectiveFormat = format === 'generic' ? 'schema;version' : format;
+    return this.filter(mediaType => mediaType.includes(effectiveFormat));
+  }
+  findBy(version = 'draft-04', 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.JSONSchemaDraft4MediaTypes = JSONSchemaDraft4MediaTypes;
+const mediaTypes = new JSONSchemaDraft4MediaTypes('application/schema;version=draft-04', 'application/schema+json;version=draft-04', 'application/schema+yaml;version=draft-04');
+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 JSONSchemaDraft4MediaTypes extends MediaTypes {
+  filterByFormat(format = 'generic') {
+    const effectiveFormat = format === 'generic' ? 'schema;version' : format;
+    return this.filter(mediaType => mediaType.includes(effectiveFormat));
+  }
+  findBy(version = 'draft-04', 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 JSONSchemaDraft4MediaTypes('application/schema;version=draft-04', 'application/schema+json;version=draft-04', 'application/schema+yaml;version=draft-04');
+export default mediaTypes;

package/src/namespace.cjs

@@ -0,0 +1,25 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _JSONSchema = _interopRequireDefault(require("./elements/JSONSchema.cjs"));
+var _JSONReference = _interopRequireDefault(require("./elements/JSONReference.cjs"));
+var _Media = _interopRequireDefault(require("./elements/Media.cjs"));
+var _LinkDescription = _interopRequireDefault(require("./elements/LinkDescription.cjs"));
+/**
+ * @public
+ */
+const jsonSchemaDraft4 = {
+  namespace: options => {
+    const {
+      base
+    } = options;
+    base.register('jSONSchemaDraft4', _JSONSchema.default);
+    base.register('jSONReference', _JSONReference.default);
+    base.register('media', _Media.default);
+    base.register('linkDescription', _LinkDescription.default);
+    return base;
+  }
+};
+var _default = exports.default = jsonSchemaDraft4;

package/src/namespace.mjs

@@ -0,0 +1,20 @@
+import JSONSchemaElement from "./elements/JSONSchema.mjs";
+import JSONReferenceElement from "./elements/JSONReference.mjs";
+import MediaElement from "./elements/Media.mjs";
+import LinkDescriptionElement from "./elements/LinkDescription.mjs";
+/**
+ * @public
+ */
+const jsonSchemaDraft4 = {
+  namespace: options => {
+    const {
+      base
+    } = options;
+    base.register('jSONSchemaDraft4', JSONSchemaElement);
+    base.register('jSONReference', JSONReferenceElement);
+    base.register('media', MediaElement);
+    base.register('linkDescription', LinkDescriptionElement);
+    return base;
+  }
+};
+export default jsonSchemaDraft4;

package/src/predicates.cjs

@@ -0,0 +1,53 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.isMediaElement = exports.isLinkDescriptionElement = exports.isJSONSchemaElement = exports.isJSONReferenceElement = void 0;
+var _apidomCore = require("@speclynx/apidom-core");
+var _JSONSchema = _interopRequireDefault(require("./elements/JSONSchema.cjs"));
+var _JSONReference = _interopRequireDefault(require("./elements/JSONReference.cjs"));
+var _Media = _interopRequireDefault(require("./elements/Media.cjs"));
+var _LinkDescription = _interopRequireDefault(require("./elements/LinkDescription.cjs"));
+/**
+ * @public
+ */
+const isJSONSchemaElement = exports.isJSONSchemaElement = (0, _apidomCore.createPredicate)(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof _JSONSchema.default || hasBasicElementProps(element) && isElementType('JSONSchemaDraft4', element) && primitiveEq('object', element);
+});
+
+/**
+ * @public
+ */
+const isJSONReferenceElement = exports.isJSONReferenceElement = (0, _apidomCore.createPredicate)(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof _JSONReference.default || hasBasicElementProps(element) && isElementType('JSONReference', element) && primitiveEq('object', element);
+});
+
+/**
+ * @public
+ */
+const isMediaElement = exports.isMediaElement = (0, _apidomCore.createPredicate)(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof _Media.default || hasBasicElementProps(element) && isElementType('media', element) && primitiveEq('object', element);
+});
+
+/**
+ * @public
+ */
+const isLinkDescriptionElement = exports.isLinkDescriptionElement = (0, _apidomCore.createPredicate)(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof _LinkDescription.default || hasBasicElementProps(element) && isElementType('linkDescription', element) && primitiveEq('object', element);
+});

package/src/predicates.mjs

@@ -0,0 +1,48 @@
+import { createPredicate } from '@speclynx/apidom-core';
+import JSONSchemaElement from "./elements/JSONSchema.mjs";
+import JSONReferenceElement from "./elements/JSONReference.mjs";
+import MediaElement from "./elements/Media.mjs";
+import LinkDescriptionElement from "./elements/LinkDescription.mjs";
+/**
+ * @public
+ */
+export const isJSONSchemaElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof JSONSchemaElement || hasBasicElementProps(element) && isElementType('JSONSchemaDraft4', element) && primitiveEq('object', element);
+});
+
+/**
+ * @public
+ */
+export const isJSONReferenceElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof JSONReferenceElement || hasBasicElementProps(element) && isElementType('JSONReference', element) && primitiveEq('object', element);
+});
+
+/**
+ * @public
+ */
+export const isMediaElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof MediaElement || hasBasicElementProps(element) && isElementType('media', element) && primitiveEq('object', element);
+});
+
+/**
+ * @public
+ */
+export const isLinkDescriptionElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof LinkDescriptionElement || hasBasicElementProps(element) && isElementType('linkDescription', element) && primitiveEq('object', element);
+});

package/src/refractor/index.cjs

@@ -0,0 +1,53 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = exports.createRefractor = void 0;
+var _apidomCore = require("@speclynx/apidom-core");
+var _ramda = require("ramda");
+var _specification = _interopRequireDefault(require("./specification.cjs"));
+var _visitor = require("../traversal/visitor.cjs");
+var _toolbox = _interopRequireDefault(require("./toolbox.cjs"));
+/**
+ * @public
+ */
+const refract = (value, {
+  specPath = ['visitors', 'document', 'objects', 'JSONSchema', '$visitor'],
+  plugins = [],
+  specificationObj = _specification.default
+} = {}) => {
+  const element = (0, _apidomCore.refract)(value);
+  const resolvedSpec = (0, _apidomCore.dereference)(specificationObj);
+
+  /**
+   * 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 onw plugins on already transformed ApiDOM.
+   */
+  const RootVisitorClass = (0, _ramda.path)(specPath, resolvedSpec);
+  const rootVisitor = new RootVisitorClass({
+    specObj: resolvedSpec
+  });
+  (0, _apidomCore.visit)(element, rootVisitor);
+
+  /**
+   * Running plugins visitors means extra single traversal === performance hit.
+   */
+  return (0, _apidomCore.dispatchRefractorPlugins)(rootVisitor.element, plugins, {
+    toolboxCreator: _toolbox.default,
+    visitorOptions: {
+      keyMap: _visitor.keyMap,
+      nodeTypeGetter: _visitor.getNodeType
+    }
+  });
+};
+
+/**
+ * @public
+ */
+const createRefractor = specPath => (value, options = {}) => refract(value, {
+  specPath,
+  ...options
+});
+exports.createRefractor = createRefractor;
+var _default = exports.default = refract;

package/src/refractor/index.mjs

@@ -0,0 +1,47 @@
+import { visit, dereference, refract as baseRefract, dispatchRefractorPlugins } from '@speclynx/apidom-core';
+import { path } from 'ramda';
+import specification from "./specification.mjs";
+import { keyMap, getNodeType } from "../traversal/visitor.mjs";
+import createToolbox from "./toolbox.mjs";
+/**
+ * @public
+ */
+const refract = (value, {
+  specPath = ['visitors', 'document', 'objects', 'JSONSchema', '$visitor'],
+  plugins = [],
+  specificationObj = specification
+} = {}) => {
+  const element = baseRefract(value);
+  const resolvedSpec = dereference(specificationObj);
+
+  /**
+   * 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 onw plugins on already transformed ApiDOM.
+   */
+  const RootVisitorClass = path(specPath, resolvedSpec);
+  const rootVisitor = new RootVisitorClass({
+    specObj: resolvedSpec
+  });
+  visit(element, rootVisitor);
+
+  /**
+   * Running plugins visitors means extra single traversal === performance hit.
+   */
+  return dispatchRefractorPlugins(rootVisitor.element, plugins, {
+    toolboxCreator: createToolbox,
+    visitorOptions: {
+      keyMap,
+      nodeTypeGetter: getNodeType
+    }
+  });
+};
+
+/**
+ * @public
+ */
+export const createRefractor = specPath => (value, options = {}) => refract(value, {
+  specPath,
+  ...options
+});
+export default refract;