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

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

@@ -0,0 +1,208 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _apidomCore = require("@speclynx/apidom-core");
+var _apidomTraverse = require("@speclynx/apidom-traverse");
+var _JSONSchema = _interopRequireDefault(require("../../elements/JSONSchema.cjs"));
+var _LinkDescription = _interopRequireDefault(require("../../elements/LinkDescription.cjs"));
+var _Media = _interopRequireDefault(require("../../elements/Media.cjs"));
+/**
+ * JSON Schema Draft 4 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-04/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, _apidomDatamodel.isStringElement)(element) && (0, _apidomDatamodel.includesClasses)(element, ['yaml-e-node', 'yaml-e-scalar']);
+const schema = {
+  JSONSchemaDraft4Element: {
+    additionalItems(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    items(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    required(...args) {
+      const element = new _apidomDatamodel.ArrayElement(...args);
+      element.classes.push('json-schema-required');
+      return element;
+    },
+    properties(...args) {
+      const element = new _apidomDatamodel.ObjectElement(...args);
+      element.classes.push('json-schema-properties');
+      return element;
+    },
+    additionalProperties(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    patternProperties(...args) {
+      const element = new _apidomDatamodel.ObjectElement(...args);
+      element.classes.push('json-schema-patternProperties');
+      return element;
+    },
+    dependencies(...args) {
+      const element = new _apidomDatamodel.ObjectElement(...args);
+      element.classes.push('json-schema-dependencies');
+      return element;
+    },
+    enum(...args) {
+      const element = new _apidomDatamodel.ArrayElement(...args);
+      element.classes.push('json-schema-enum');
+      return element;
+    },
+    allOf(...args) {
+      const element = new _apidomDatamodel.ArrayElement(...args);
+      element.classes.push('json-schema-allOf');
+      return element;
+    },
+    anyOf(...args) {
+      const element = new _apidomDatamodel.ArrayElement(...args);
+      element.classes.push('json-schema-anyOf');
+      return element;
+    },
+    oneOf(...args) {
+      const element = new _apidomDatamodel.ArrayElement(...args);
+      element.classes.push('json-schema-oneOf');
+      return element;
+    },
+    not(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    definitions(...args) {
+      const element = new _apidomDatamodel.ObjectElement(...args);
+      element.classes.push('json-schema-definitions');
+      return element;
+    },
+    links(...args) {
+      const element = new _apidomDatamodel.ArrayElement(...args);
+      element.classes.push('json-schema-links');
+      return element;
+    },
+    media(...args) {
+      return new _Media.default(...args);
+    }
+  },
+  LinkDescriptionElement: {
+    targetSchema(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    schema(...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, _apidomTraverse.getNodeType)(ancestor);
+  const classType = ancestor.isMetaEmpty ? undefined : ancestor.classes.at(0); // @ts-ignore
+  const keyMapping = schema[elementType] || schema[classType];
+  return typeof keyMapping === 'undefined' ? undefined : Object.hasOwn(keyMapping, '[key: *]') ? keyMapping['[key: *]'] : keyMapping[keyName];
+};
+
+/**
+ * @public
+ */
+const plugin = () => () => ({
+  visitor: {
+    StringElement(path) {
+      const element = path.node;
+      if (!isEmptyElement(element)) return;
+
+      // getAncestorNodes() returns [parent, grandparent, ..., root], so reverse to get [root, ..., parent]
+      const lineage = path.getAncestorNodes().reverse().filter(_apidomDatamodel.isElement);
+      const parentElement = lineage.at(-1);
+      let elementFactory;
+      let context;
+      if ((0, _apidomDatamodel.isArrayElement)(parentElement)) {
+        context = element;
+        elementFactory = findElementFactory(parentElement, '<*>');
+      } else if ((0, _apidomDatamodel.isMemberElement)(parentElement)) {
+        context = lineage.at(-2);
+        elementFactory = findElementFactory(context, (0, _apidomCore.toValue)(parentElement.key));
+      }
+
+      // no element factory found
+      if (typeof elementFactory !== 'function') return;
+      const replacement = elementFactory.call({
+        context
+      }, undefined, element.isMetaEmpty ? undefined : element.meta.cloneDeep(), element.isAttributesEmpty ? undefined : (0, _apidomDatamodel.cloneDeep)(element.attributes));
+      _apidomDatamodel.SourceMapElement.transfer(element, replacement);
+      _apidomDatamodel.StyleElement.transfer(element, replacement);
+      path.replaceWith(replacement);
+    }
+  }
+});
+var _default = exports.default = plugin;

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

@@ -0,0 +1,202 @@
+import { ArrayElement, ObjectElement, isArrayElement, isElement, isMemberElement, isStringElement, includesClasses, cloneDeep, SourceMapElement, StyleElement } from '@speclynx/apidom-datamodel';
+import { toValue } from '@speclynx/apidom-core';
+import { getNodeType } from '@speclynx/apidom-traverse';
+
+/**
+ * JSON Schema Draft 4 specification elements.
+ */
+import JSONSchemaElement from "../../elements/JSONSchema.mjs";
+import LinkDescriptionElement from "../../elements/LinkDescription.mjs";
+import MediaElement from "../../elements/Media.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-04/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(element, ['yaml-e-node', 'yaml-e-scalar']);
+const schema = {
+  JSONSchemaDraft4Element: {
+    additionalItems(...args) {
+      return new JSONSchemaElement(...args);
+    },
+    items(...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;
+    },
+    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;
+    },
+    not(...args) {
+      return new JSONSchemaElement(...args);
+    },
+    definitions(...args) {
+      const element = new ObjectElement(...args);
+      element.classes.push('json-schema-definitions');
+      return element;
+    },
+    links(...args) {
+      const element = new ArrayElement(...args);
+      element.classes.push('json-schema-links');
+      return element;
+    },
+    media(...args) {
+      return new MediaElement(...args);
+    }
+  },
+  LinkDescriptionElement: {
+    targetSchema(...args) {
+      return new JSONSchemaElement(...args);
+    },
+    schema(...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);
+  const classType = ancestor.isMetaEmpty ? undefined : ancestor.classes.at(0); // @ts-ignore
+  const keyMapping = schema[elementType] || schema[classType];
+  return typeof keyMapping === 'undefined' ? undefined : Object.hasOwn(keyMapping, '[key: *]') ? keyMapping['[key: *]'] : keyMapping[keyName];
+};
+
+/**
+ * @public
+ */
+const plugin = () => () => ({
+  visitor: {
+    StringElement(path) {
+      const element = path.node;
+      if (!isEmptyElement(element)) return;
+
+      // getAncestorNodes() returns [parent, grandparent, ..., root], so reverse to get [root, ..., parent]
+      const lineage = path.getAncestorNodes().reverse().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;
+      const replacement = elementFactory.call({
+        context
+      }, undefined, element.isMetaEmpty ? undefined : element.meta.cloneDeep(), element.isAttributesEmpty ? undefined : cloneDeep(element.attributes));
+      SourceMapElement.transfer(element, replacement);
+      StyleElement.transfer(element, replacement);
+      path.replaceWith(replacement);
+    }
+  }
+});
+export default plugin;

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

@@ -0,0 +1,233 @@
+import {
+  ArrayElement,
+  ObjectElement,
+  StringElement,
+  isArrayElement,
+  isElement,
+  isMemberElement,
+  isStringElement,
+  includesClasses,
+  cloneDeep,
+  SourceMapElement,
+  StyleElement,
+} from '@speclynx/apidom-datamodel';
+import { toValue } from '@speclynx/apidom-core';
+import { Path, getNodeType } from '@speclynx/apidom-traverse';
+
+/**
+ * JSON Schema Draft 4 specification elements.
+ */
+import JSONSchemaElement from '../../elements/JSONSchema.ts';
+import LinkDescriptionElement from '../../elements/LinkDescription.ts';
+import MediaElement from '../../elements/Media.ts';
+
+/**
+ * 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-04/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: any) =>
+  isStringElement(element) && includesClasses(element, ['yaml-e-node', 'yaml-e-scalar']);
+
+const schema = {
+  JSONSchemaDraft4Element: {
+    additionalItems(...args: any[]) {
+      return new JSONSchemaElement(...args);
+    },
+    items(...args: any[]) {
+      return new JSONSchemaElement(...args);
+    },
+    required(...args: any[]) {
+      const element = new ArrayElement(...args);
+      element.classes.push('json-schema-required');
+      return element;
+    },
+    properties(...args: any[]) {
+      const element = new ObjectElement(...args);
+      element.classes.push('json-schema-properties');
+      return element;
+    },
+    additionalProperties(...args: any[]) {
+      return new JSONSchemaElement(...args);
+    },
+    patternProperties(...args: any[]) {
+      const element = new ObjectElement(...args);
+      element.classes.push('json-schema-patternProperties');
+      return element;
+    },
+    dependencies(...args: any[]) {
+      const element = new ObjectElement(...args);
+      element.classes.push('json-schema-dependencies');
+      return element;
+    },
+    enum(...args: any[]) {
+      const element = new ArrayElement(...args);
+      element.classes.push('json-schema-enum');
+      return element;
+    },
+    allOf(...args: any[]) {
+      const element = new ArrayElement(...args);
+      element.classes.push('json-schema-allOf');
+      return element;
+    },
+    anyOf(...args: any[]) {
+      const element = new ArrayElement(...args);
+      element.classes.push('json-schema-anyOf');
+      return element;
+    },
+    oneOf(...args: any[]) {
+      const element = new ArrayElement(...args);
+      element.classes.push('json-schema-oneOf');
+      return element;
+    },
+    not(...args: any[]) {
+      return new JSONSchemaElement(...args);
+    },
+    definitions(...args: any[]) {
+      const element = new ObjectElement(...args);
+      element.classes.push('json-schema-definitions');
+      return element;
+    },
+    links(...args: any[]) {
+      const element = new ArrayElement(...args);
+      element.classes.push('json-schema-links');
+      return element;
+    },
+    media(...args: any[]) {
+      return new MediaElement(...args);
+    },
+  },
+  LinkDescriptionElement: {
+    targetSchema(...args: any[]) {
+      return new JSONSchemaElement(...args);
+    },
+    schema(...args: any[]) {
+      return new JSONSchemaElement(...args);
+    },
+  },
+  'json-schema-properties': {
+    '[key: *]': function key(...args: any[]) {
+      return new JSONSchemaElement(...args);
+    },
+  },
+  'json-schema-patternProperties': {
+    '[key: *]': function key(...args: any[]) {
+      return new JSONSchemaElement(...args);
+    },
+  },
+  'json-schema-dependencies': {
+    '[key: *]': function key(...args: any[]) {
+      return new JSONSchemaElement(...args);
+    },
+  },
+  'json-schema-allOf': {
+    '<*>': function asterisk(...args: any[]) {
+      return new JSONSchemaElement(...args);
+    },
+  },
+  'json-schema-anyOf': {
+    '<*>': function asterisk(...args: any[]) {
+      return new JSONSchemaElement(...args);
+    },
+  },
+  'json-schema-oneOf': {
+    '<*>': function asterisk(...args: any[]) {
+      return new JSONSchemaElement(...args);
+    },
+  },
+  'json-schema-definitions': {
+    '[key: *]': function key(...args: any[]) {
+      return new JSONSchemaElement(...args);
+    },
+  },
+  'json-schema-links': {
+    '<*>': function asterisk(...args: any[]) {
+      return new LinkDescriptionElement(...args);
+    },
+  },
+};
+
+const findElementFactory = (ancestor: any, keyName: string) => {
+  const elementType = getNodeType(ancestor);
+  const classType = ancestor.isMetaEmpty ? undefined : ancestor.classes.at(0); // @ts-ignore
+  const keyMapping = schema[elementType] || schema[classType];
+
+  return typeof keyMapping === 'undefined'
+    ? undefined
+    : Object.hasOwn(keyMapping, '[key: *]')
+      ? keyMapping['[key: *]']
+      : keyMapping[keyName];
+};
+
+/**
+ * @public
+ */
+const plugin = () => () => ({
+  visitor: {
+    StringElement(path: Path<StringElement>) {
+      const element = path.node;
+
+      if (!isEmptyElement(element)) return;
+
+      // getAncestorNodes() returns [parent, grandparent, ..., root], so reverse to get [root, ..., parent]
+      const lineage = path.getAncestorNodes().reverse().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) as string);
+      }
+
+      // no element factory found
+      if (typeof elementFactory !== 'function') return;
+
+      const replacement = elementFactory.call(
+        { context },
+        undefined,
+        element.isMetaEmpty ? undefined : element.meta.cloneDeep(),
+        element.isAttributesEmpty ? undefined : cloneDeep(element.attributes),
+      );
+
+      SourceMapElement.transfer(element, replacement);
+      StyleElement.transfer(element, replacement);
+
+      path.replaceWith(replacement);
+    },
+  },
+});
+
+export default plugin;

package/src/refractor/predicates.cjs

@@ -0,0 +1,16 @@
+"use strict";
+
+exports.__esModule = true;
+exports.isJSONReferenceLikeElement = void 0;
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+const isJSONReferenceLikeElement = element => {
+  return (0, _apidomDatamodel.isObjectElement)(element) && element.hasKey('$ref');
+};
+exports.isJSONReferenceLikeElement = isJSONReferenceLikeElement;

package/src/refractor/predicates.mjs

@@ -0,0 +1,12 @@
+import { isObjectElement } from '@speclynx/apidom-datamodel';
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+export const isJSONReferenceLikeElement = element => {
+  return isObjectElement(element) && element.hasKey('$ref');
+};

package/src/refractor/predicates.ts

@@ -0,0 +1,17 @@
+import { isObjectElement, ObjectElement } from '@speclynx/apidom-datamodel';
+
+/**
+ * @public
+ */
+export interface JSONReferenceLikeElement extends ObjectElement {
+  hasKey: (value: '$ref') => true;
+}
+
+/**
+ * @public
+ */
+export const isJSONReferenceLikeElement = (
+  element: unknown,
+): element is JSONReferenceLikeElement => {
+  return isObjectElement(element) && element.hasKey('$ref');
+};