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

package/src/media-types.mjs

@@ -0,0 +1,30 @@
+import { last } from 'ramda';
+import { MediaTypes } from '@speclynx/apidom-core';
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+export class JSONSchemaDraft7MediaTypes extends MediaTypes {
+  filterByFormat(format = 'generic') {
+    const effectiveFormat = format === 'generic' ? 'schema;version' : format;
+    return this.filter(mediaType => mediaType.includes(effectiveFormat));
+  }
+  findBy(version = 'draft-07', 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 JSONSchemaDraft7MediaTypes('application/schema;version=draft-07', 'application/schema+json;version=draft-07', 'application/schema+yaml;version=draft-07');
+export default mediaTypes;

package/src/namespace.cjs

@@ -0,0 +1,23 @@
+"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-6");
+var _JSONSchema = _interopRequireDefault(require("./elements/JSONSchema.cjs"));
+var _LinkDescription = _interopRequireDefault(require("./elements/LinkDescription.cjs"));
+/**
+ * @public
+ */
+const jsonSchemaDraft7 = {
+  namespace: options => {
+    const {
+      base
+    } = options;
+    base.register('jSONSchemaDraft7', _JSONSchema.default);
+    base.register('jSONReference', _apidomNsJsonSchemaDraft.JSONReferenceElement);
+    base.register('linkDescription', _LinkDescription.default);
+    return base;
+  }
+};
+var _default = exports.default = jsonSchemaDraft7;

package/src/namespace.mjs

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

package/src/predicates.cjs

@@ -0,0 +1,31 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.isLinkDescriptionElement = exports.isJSONSchemaElement = exports.isJSONReferenceElement = void 0;
+var _apidomCore = require("@speclynx/apidom-core");
+var _JSONSchema = _interopRequireDefault(require("./elements/JSONSchema.cjs"));
+var _LinkDescription = _interopRequireDefault(require("./elements/LinkDescription.cjs"));
+var _apidomNsJsonSchemaDraft = require("@speclynx/apidom-ns-json-schema-draft-6");
+exports.isJSONReferenceElement = _apidomNsJsonSchemaDraft.isJSONReferenceElement;
+/**
+ * @public
+ */
+const isJSONSchemaElement = exports.isJSONSchemaElement = (0, _apidomCore.createPredicate)(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof _JSONSchema.default || hasBasicElementProps(element) && isElementType('JSONSchemaDraft7', 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,26 @@
+import { createPredicate } from '@speclynx/apidom-core';
+import JSONSchemaElement from "./elements/JSONSchema.mjs";
+import LinkDescriptionElement from "./elements/LinkDescription.mjs";
+export { isJSONReferenceElement } from '@speclynx/apidom-ns-json-schema-draft-6';
+
+/**
+ * @public
+ */
+export const isJSONSchemaElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof JSONSchemaElement || hasBasicElementProps(element) && isElementType('JSONSchemaDraft7', 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,54 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = exports.createRefractor = void 0;
+var _ramda = require("ramda");
+var _apidomCore = require("@speclynx/apidom-core");
+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);
+
+  /**
+   * Run plugins only when necessary.
+   * 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,48 @@
+import { path } from 'ramda';
+import { visit, dereference, refract as baseRefract, dispatchRefractorPlugins } from '@speclynx/apidom-core';
+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);
+
+  /**
+   * Run plugins only when necessary.
+   * 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;

package/src/refractor/plugins/replace-empty-element.cjs

@@ -0,0 +1,233 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomCore = require("@speclynx/apidom-core");
+var _JSONSchema = _interopRequireDefault(require("../../elements/JSONSchema.cjs"));
+var _LinkDescription = _interopRequireDefault(require("../../elements/LinkDescription.cjs"));
+var _visitor = require("../../traversal/visitor.cjs");
+/**
+ * JSON Schema Draft 7 specification elements.
+ */
+
+/**
+ * This plugin is specific to YAML 1.2 format, which allows defining key-value pairs
+ * with empty key, empty value, or both. If the value is not provided in YAML format,
+ * this plugin compensates for this missing value with the most appropriate semantic element type.
+ *
+ * https://yaml.org/spec/1.2.2/#72-empty-nodes
+ *
+ * @example
+ *
+ * ```yaml
+ * $schema: http://json-schema.org/draft-07/schema#
+ * items:
+ * ```
+ * Refracting result without this plugin:
+ *
+ *  (JSONSchemaElement
+ *    (MemberElement
+ *      (StringElement)
+ *      (StringElement))
+ *    (MemberElement
+ *      (StringElement)
+ *      (StringElement))
+ *
+ * Refracting result with this plugin:
+ *
+ *  (JSONSchemaElement
+ *    (MemberElement
+ *      (StringElement)
+ *      (StringElement))
+ *    (MemberElement
+ *      (StringElement)
+ *      (JSONSchemaElement))
+ */
+
+const isEmptyElement = element => (0, _apidomCore.isStringElement)(element) && (0, _apidomCore.includesClasses)(['yaml-e-node', 'yaml-e-scalar'], element);
+const schema = {
+  JSONSchemaDraft7Element: {
+    additionalItems(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    items(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    contains(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    required(...args) {
+      const element = new _apidomCore.ArrayElement(...args);
+      element.classes.push('json-schema-required');
+      return element;
+    },
+    properties(...args) {
+      const element = new _apidomCore.ObjectElement(...args);
+      element.classes.push('json-schema-properties');
+      return element;
+    },
+    additionalProperties(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    patternProperties(...args) {
+      const element = new _apidomCore.ObjectElement(...args);
+      element.classes.push('json-schema-patternProperties');
+      return element;
+    },
+    dependencies(...args) {
+      const element = new _apidomCore.ObjectElement(...args);
+      element.classes.push('json-schema-dependencies');
+      return element;
+    },
+    propertyNames(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    enum(...args) {
+      const element = new _apidomCore.ArrayElement(...args);
+      element.classes.push('json-schema-enum');
+      return element;
+    },
+    allOf(...args) {
+      const element = new _apidomCore.ArrayElement(...args);
+      element.classes.push('json-schema-allOf');
+      return element;
+    },
+    anyOf(...args) {
+      const element = new _apidomCore.ArrayElement(...args);
+      element.classes.push('json-schema-anyOf');
+      return element;
+    },
+    oneOf(...args) {
+      const element = new _apidomCore.ArrayElement(...args);
+      element.classes.push('json-schema-oneOf');
+      return element;
+    },
+    if(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    then(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    else(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    not(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    definitions(...args) {
+      const element = new _apidomCore.ObjectElement(...args);
+      element.classes.push('json-schema-definitions');
+      return element;
+    },
+    examples(...args) {
+      const element = new _apidomCore.ArrayElement(...args);
+      element.classes.push('json-schema-examples');
+      return element;
+    },
+    links(...args) {
+      const element = new _apidomCore.ArrayElement(...args);
+      element.classes.push('json-schema-links');
+      return element;
+    }
+  },
+  LinkDescriptionElement: {
+    hrefSchema(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    targetSchema(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    submissionSchema(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    templatePointers(...args) {
+      return new _apidomCore.ObjectElement(...args);
+    },
+    templateRequired(...args) {
+      return new _apidomCore.ArrayElement(...args);
+    },
+    targetHints(...args) {
+      return new _apidomCore.ObjectElement(...args);
+    },
+    headerSchema(...args) {
+      return new _JSONSchema.default(...args);
+    }
+  },
+  'json-schema-properties': {
+    '[key: *]': function key(...args) {
+      return new _JSONSchema.default(...args);
+    }
+  },
+  'json-schema-patternProperties': {
+    '[key: *]': function key(...args) {
+      return new _JSONSchema.default(...args);
+    }
+  },
+  'json-schema-dependencies': {
+    '[key: *]': function key(...args) {
+      return new _JSONSchema.default(...args);
+    }
+  },
+  'json-schema-allOf': {
+    '<*>': function asterisk(...args) {
+      return new _JSONSchema.default(...args);
+    }
+  },
+  'json-schema-anyOf': {
+    '<*>': function asterisk(...args) {
+      return new _JSONSchema.default(...args);
+    }
+  },
+  'json-schema-oneOf': {
+    '<*>': function asterisk(...args) {
+      return new _JSONSchema.default(...args);
+    }
+  },
+  'json-schema-definitions': {
+    '[key: *]': function key(...args) {
+      return new _JSONSchema.default(...args);
+    }
+  },
+  'json-schema-links': {
+    '<*>': function asterisk(...args) {
+      return new _LinkDescription.default(...args);
+    }
+  }
+};
+const findElementFactory = (ancestor, keyName) => {
+  const elementType = (0, _visitor.getNodeType)(ancestor); // @ts-ignore
+  const keyMapping = schema[elementType] || schema[(0, _apidomCore.toValue)(ancestor.classes.first)];
+  return typeof keyMapping === 'undefined' ? undefined : Object.hasOwn(keyMapping, '[key: *]') ? keyMapping['[key: *]'] : keyMapping[keyName];
+};
+
+/**
+ * @public
+ */
+const plugin = () => () => {
+  return {
+    visitor: {
+      StringElement(element, key, parent, path, ancestors) {
+        if (!isEmptyElement(element)) return undefined;
+        const lineage = [...ancestors, parent].filter(_apidomCore.isElement);
+        const parentElement = lineage.at(-1);
+        let elementFactory;
+        let context;
+        if ((0, _apidomCore.isArrayElement)(parentElement)) {
+          context = element;
+          elementFactory = findElementFactory(parentElement, '<*>');
+        } else if ((0, _apidomCore.isMemberElement)(parentElement)) {
+          context = lineage.at(-2);
+          elementFactory = findElementFactory(context, (0, _apidomCore.toValue)(parentElement.key));
+        }
+
+        // no element factory found
+        if (typeof elementFactory !== 'function') return undefined;
+        return elementFactory.call({
+          context
+        }, undefined, (0, _apidomCore.cloneDeep)(element.meta), (0, _apidomCore.cloneDeep)(element.attributes));
+      }
+    }
+  };
+};
+var _default = exports.default = plugin;

package/src/refractor/plugins/replace-empty-element.mjs

@@ -0,0 +1,226 @@
+import { ArrayElement, ObjectElement, isStringElement, isArrayElement, isElement, isMemberElement, includesClasses, cloneDeep, toValue } from '@speclynx/apidom-core';
+/**
+ * JSON Schema Draft 7 specification elements.
+ */
+import JSONSchemaElement from "../../elements/JSONSchema.mjs";
+import LinkDescriptionElement from "../../elements/LinkDescription.mjs";
+import { getNodeType } from "../../traversal/visitor.mjs";
+/**
+ * This plugin is specific to YAML 1.2 format, which allows defining key-value pairs
+ * with empty key, empty value, or both. If the value is not provided in YAML format,
+ * this plugin compensates for this missing value with the most appropriate semantic element type.
+ *
+ * https://yaml.org/spec/1.2.2/#72-empty-nodes
+ *
+ * @example
+ *
+ * ```yaml
+ * $schema: http://json-schema.org/draft-07/schema#
+ * items:
+ * ```
+ * Refracting result without this plugin:
+ *
+ *  (JSONSchemaElement
+ *    (MemberElement
+ *      (StringElement)
+ *      (StringElement))
+ *    (MemberElement
+ *      (StringElement)
+ *      (StringElement))
+ *
+ * Refracting result with this plugin:
+ *
+ *  (JSONSchemaElement
+ *    (MemberElement
+ *      (StringElement)
+ *      (StringElement))
+ *    (MemberElement
+ *      (StringElement)
+ *      (JSONSchemaElement))
+ */
+const isEmptyElement = element => isStringElement(element) && includesClasses(['yaml-e-node', 'yaml-e-scalar'], element);
+const schema = {
+  JSONSchemaDraft7Element: {
+    additionalItems(...args) {
+      return new JSONSchemaElement(...args);
+    },
+    items(...args) {
+      return new JSONSchemaElement(...args);
+    },
+    contains(...args) {
+      return new JSONSchemaElement(...args);
+    },
+    required(...args) {
+      const element = new ArrayElement(...args);
+      element.classes.push('json-schema-required');
+      return element;
+    },
+    properties(...args) {
+      const element = new ObjectElement(...args);
+      element.classes.push('json-schema-properties');
+      return element;
+    },
+    additionalProperties(...args) {
+      return new JSONSchemaElement(...args);
+    },
+    patternProperties(...args) {
+      const element = new ObjectElement(...args);
+      element.classes.push('json-schema-patternProperties');
+      return element;
+    },
+    dependencies(...args) {
+      const element = new ObjectElement(...args);
+      element.classes.push('json-schema-dependencies');
+      return element;
+    },
+    propertyNames(...args) {
+      return new JSONSchemaElement(...args);
+    },
+    enum(...args) {
+      const element = new ArrayElement(...args);
+      element.classes.push('json-schema-enum');
+      return element;
+    },
+    allOf(...args) {
+      const element = new ArrayElement(...args);
+      element.classes.push('json-schema-allOf');
+      return element;
+    },
+    anyOf(...args) {
+      const element = new ArrayElement(...args);
+      element.classes.push('json-schema-anyOf');
+      return element;
+    },
+    oneOf(...args) {
+      const element = new ArrayElement(...args);
+      element.classes.push('json-schema-oneOf');
+      return element;
+    },
+    if(...args) {
+      return new JSONSchemaElement(...args);
+    },
+    then(...args) {
+      return new JSONSchemaElement(...args);
+    },
+    else(...args) {
+      return new JSONSchemaElement(...args);
+    },
+    not(...args) {
+      return new JSONSchemaElement(...args);
+    },
+    definitions(...args) {
+      const element = new ObjectElement(...args);
+      element.classes.push('json-schema-definitions');
+      return element;
+    },
+    examples(...args) {
+      const element = new ArrayElement(...args);
+      element.classes.push('json-schema-examples');
+      return element;
+    },
+    links(...args) {
+      const element = new ArrayElement(...args);
+      element.classes.push('json-schema-links');
+      return element;
+    }
+  },
+  LinkDescriptionElement: {
+    hrefSchema(...args) {
+      return new JSONSchemaElement(...args);
+    },
+    targetSchema(...args) {
+      return new JSONSchemaElement(...args);
+    },
+    submissionSchema(...args) {
+      return new JSONSchemaElement(...args);
+    },
+    templatePointers(...args) {
+      return new ObjectElement(...args);
+    },
+    templateRequired(...args) {
+      return new ArrayElement(...args);
+    },
+    targetHints(...args) {
+      return new ObjectElement(...args);
+    },
+    headerSchema(...args) {
+      return new JSONSchemaElement(...args);
+    }
+  },
+  'json-schema-properties': {
+    '[key: *]': function key(...args) {
+      return new JSONSchemaElement(...args);
+    }
+  },
+  'json-schema-patternProperties': {
+    '[key: *]': function key(...args) {
+      return new JSONSchemaElement(...args);
+    }
+  },
+  'json-schema-dependencies': {
+    '[key: *]': function key(...args) {
+      return new JSONSchemaElement(...args);
+    }
+  },
+  'json-schema-allOf': {
+    '<*>': function asterisk(...args) {
+      return new JSONSchemaElement(...args);
+    }
+  },
+  'json-schema-anyOf': {
+    '<*>': function asterisk(...args) {
+      return new JSONSchemaElement(...args);
+    }
+  },
+  'json-schema-oneOf': {
+    '<*>': function asterisk(...args) {
+      return new JSONSchemaElement(...args);
+    }
+  },
+  'json-schema-definitions': {
+    '[key: *]': function key(...args) {
+      return new JSONSchemaElement(...args);
+    }
+  },
+  'json-schema-links': {
+    '<*>': function asterisk(...args) {
+      return new LinkDescriptionElement(...args);
+    }
+  }
+};
+const findElementFactory = (ancestor, keyName) => {
+  const elementType = getNodeType(ancestor); // @ts-ignore
+  const keyMapping = schema[elementType] || schema[toValue(ancestor.classes.first)];
+  return typeof keyMapping === 'undefined' ? undefined : Object.hasOwn(keyMapping, '[key: *]') ? keyMapping['[key: *]'] : keyMapping[keyName];
+};
+
+/**
+ * @public
+ */
+const plugin = () => () => {
+  return {
+    visitor: {
+      StringElement(element, key, parent, path, ancestors) {
+        if (!isEmptyElement(element)) return undefined;
+        const lineage = [...ancestors, parent].filter(isElement);
+        const parentElement = lineage.at(-1);
+        let elementFactory;
+        let context;
+        if (isArrayElement(parentElement)) {
+          context = element;
+          elementFactory = findElementFactory(parentElement, '<*>');
+        } else if (isMemberElement(parentElement)) {
+          context = lineage.at(-2);
+          elementFactory = findElementFactory(context, toValue(parentElement.key));
+        }
+
+        // no element factory found
+        if (typeof elementFactory !== 'function') return undefined;
+        return elementFactory.call({
+          context
+        }, undefined, cloneDeep(element.meta), cloneDeep(element.attributes));
+      }
+    }
+  };
+};
+export default plugin;