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

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

@@ -0,0 +1,200 @@
+"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 _Media = _interopRequireDefault(require("../../elements/Media.cjs"));
+var _visitor = require("../../traversal/visitor.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, _apidomCore.isStringElement)(element) && (0, _apidomCore.includesClasses)(['yaml-e-node', 'yaml-e-scalar'], element);
+const schema = {
+  JSONSchemaDraft4Element: {
+    additionalItems(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    items(...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;
+    },
+    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;
+    },
+    not(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    definitions(...args) {
+      const element = new _apidomCore.ObjectElement(...args);
+      element.classes.push('json-schema-definitions');
+      return element;
+    },
+    links(...args) {
+      const element = new _apidomCore.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, _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 = () => () => ({
+  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,194 @@
+import { ArrayElement, ObjectElement, isArrayElement, isElement, isMemberElement, isStringElement, includesClasses, cloneDeep, toValue } from '@speclynx/apidom-core';
+
+/**
+ * JSON Schema Draft 4 specification elements.
+ */
+import JSONSchemaElement from "../../elements/JSONSchema.mjs";
+import LinkDescriptionElement from "../../elements/LinkDescription.mjs";
+import MediaElement from "../../elements/Media.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-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(['yaml-e-node', 'yaml-e-scalar'], element);
+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); // @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 = () => () => ({
+  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;

package/src/refractor/predicates.cjs

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

package/src/refractor/predicates.mjs

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

package/src/refractor/registration.cjs

@@ -0,0 +1,19 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+var _JSONSchema = _interopRequireDefault(require("../elements/JSONSchema.cjs"));
+exports.JSONSchemaElement = _JSONSchema.default;
+var _JSONReference = _interopRequireDefault(require("../elements/JSONReference.cjs"));
+exports.JSONReferenceElement = _JSONReference.default;
+var _Media = _interopRequireDefault(require("../elements/Media.cjs"));
+exports.MediaElement = _Media.default;
+var _LinkDescription = _interopRequireDefault(require("../elements/LinkDescription.cjs"));
+exports.LinkDescriptionElement = _LinkDescription.default;
+var _index = require("./index.cjs");
+// register refractors specific to element types
+
+_JSONSchema.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'JSONSchema', '$visitor']);
+_JSONReference.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'JSONReference', '$visitor']);
+_Media.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'Media', '$visitor']);
+_LinkDescription.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'LinkDescription', '$visitor']);

package/src/refractor/registration.mjs

@@ -0,0 +1,10 @@
+import JSONSchemaElement from "../elements/JSONSchema.mjs";
+import JSONReferenceElement from "../elements/JSONReference.mjs";
+import MediaElement from "../elements/Media.mjs";
+import LinkDescriptionElement from "../elements/LinkDescription.mjs";
+import { createRefractor } from "./index.mjs"; // register refractors specific to element types
+JSONSchemaElement.refract = createRefractor(['visitors', 'document', 'objects', 'JSONSchema', '$visitor']);
+JSONReferenceElement.refract = createRefractor(['visitors', 'document', 'objects', 'JSONReference', '$visitor']);
+MediaElement.refract = createRefractor(['visitors', 'document', 'objects', 'Media', '$visitor']);
+LinkDescriptionElement.refract = createRefractor(['visitors', 'document', 'objects', 'LinkDescription', '$visitor']);
+export { JSONSchemaElement, JSONReferenceElement, MediaElement, LinkDescriptionElement };

package/src/refractor/specification.cjs

@@ -0,0 +1,182 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _FallbackVisitor = _interopRequireDefault(require("./visitors/FallbackVisitor.cjs"));
+var _index = _interopRequireDefault(require("./visitors/json-schema/index.cjs"));
+var _ItemsVisitor = _interopRequireDefault(require("./visitors/json-schema/ItemsVisitor.cjs"));
+var _RequiredVisitor = _interopRequireDefault(require("./visitors/json-schema/RequiredVisitor.cjs"));
+var _PropertiesVisitor = _interopRequireDefault(require("./visitors/json-schema/PropertiesVisitor.cjs"));
+var _PatternPropertiesVisitor = _interopRequireDefault(require("./visitors/json-schema/PatternPropertiesVisitor.cjs"));
+var _DependenciesVisitor = _interopRequireDefault(require("./visitors/json-schema/DependenciesVisitor.cjs"));
+var _EnumVisitor = _interopRequireDefault(require("./visitors/json-schema/EnumVisitor.cjs"));
+var _TypeVisitor = _interopRequireDefault(require("./visitors/json-schema/TypeVisitor.cjs"));
+var _AllOfVisitor = _interopRequireDefault(require("./visitors/json-schema/AllOfVisitor.cjs"));
+var _AnyOfVisitor = _interopRequireDefault(require("./visitors/json-schema/AnyOfVisitor.cjs"));
+var _OneOfVisitor = _interopRequireDefault(require("./visitors/json-schema/OneOfVisitor.cjs"));
+var _DefinitionsVisitor = _interopRequireDefault(require("./visitors/json-schema/DefinitionsVisitor.cjs"));
+var _LinksVisitor = _interopRequireDefault(require("./visitors/json-schema/LinksVisitor.cjs"));
+var _index2 = _interopRequireDefault(require("./visitors/json-schema/json-reference/index.cjs"));
+var _$RefVisitor = _interopRequireDefault(require("./visitors/json-schema/json-reference/$RefVisitor.cjs"));
+var _JSONSchemaOrJSONReferenceVisitor = _interopRequireDefault(require("./visitors/json-schema/JSONSchemaOrJSONReferenceVisitor.cjs"));
+var _index3 = _interopRequireDefault(require("./visitors/json-schema/media/index.cjs"));
+var _index4 = _interopRequireDefault(require("./visitors/json-schema/link-description/index.cjs"));
+/**
+ * Specification object allows us to have complete control over visitors
+ * when traversing the ApiDOM.
+ * Specification also allows us to create amended refractors from
+ * existing ones by manipulating it.
+ *
+ * Note: Specification object allows to use absolute internal JSON pointers.
+ * @public
+ */
+const specification = {
+  visitors: {
+    value: _FallbackVisitor.default,
+    JSONSchemaOrJSONReferenceVisitor: _JSONSchemaOrJSONReferenceVisitor.default,
+    document: {
+      objects: {
+        JSONSchema: {
+          $visitor: _index.default,
+          fixedFields: {
+            // core vocabulary
+            id: {
+              $ref: '#/visitors/value'
+            },
+            $schema: {
+              $ref: '#/visitors/value'
+            },
+            // validation vocabulary
+            // validation keywords for numeric instances (number and integer)
+            multipleOf: {
+              $ref: '#/visitors/value'
+            },
+            maximum: {
+              $ref: '#/visitors/value'
+            },
+            exclusiveMaximum: {
+              $ref: '#/visitors/value'
+            },
+            minimum: {
+              $ref: '#/visitors/value'
+            },
+            exclusiveMinimum: {
+              $ref: '#/visitors/value'
+            },
+            // validation keywords for strings
+            maxLength: {
+              $ref: '#/visitors/value'
+            },
+            minLength: {
+              $ref: '#/visitors/value'
+            },
+            pattern: {
+              $ref: '#/visitors/value'
+            },
+            // validation keywords for arrays
+            additionalItems: _JSONSchemaOrJSONReferenceVisitor.default,
+            items: _ItemsVisitor.default,
+            maxItems: {
+              $ref: '#/visitors/value'
+            },
+            minItems: {
+              $ref: '#/visitors/value'
+            },
+            uniqueItems: {
+              $ref: '#/visitors/value'
+            },
+            // validation keywords for objects
+            maxProperties: {
+              $ref: '#/visitors/value'
+            },
+            minProperties: {
+              $ref: '#/visitors/value'
+            },
+            required: _RequiredVisitor.default,
+            properties: _PropertiesVisitor.default,
+            additionalProperties: _JSONSchemaOrJSONReferenceVisitor.default,
+            patternProperties: _PatternPropertiesVisitor.default,
+            dependencies: _DependenciesVisitor.default,
+            // validation keywords for any instance type
+            enum: _EnumVisitor.default,
+            type: _TypeVisitor.default,
+            allOf: _AllOfVisitor.default,
+            anyOf: _AnyOfVisitor.default,
+            oneOf: _OneOfVisitor.default,
+            not: _JSONSchemaOrJSONReferenceVisitor.default,
+            definitions: _DefinitionsVisitor.default,
+            // metadata keywords
+            title: {
+              $ref: '#/visitors/value'
+            },
+            description: {
+              $ref: '#/visitors/value'
+            },
+            default: {
+              $ref: '#/visitors/value'
+            },
+            // semantic validation with "format"
+            format: {
+              $ref: '#/visitors/value'
+            },
+            // JSON Hyper-Schema
+            base: {
+              $ref: '#/visitors/value'
+            },
+            links: _LinksVisitor.default,
+            media: {
+              $ref: '#/visitors/document/objects/Media'
+            },
+            readOnly: {
+              $ref: '#/visitors/value'
+            }
+          }
+        },
+        JSONReference: {
+          $visitor: _index2.default,
+          fixedFields: {
+            $ref: _$RefVisitor.default
+          }
+        },
+        Media: {
+          $visitor: _index3.default,
+          fixedFields: {
+            binaryEncoding: {
+              $ref: '#/visitors/value'
+            },
+            type: {
+              $ref: '#/visitors/value'
+            }
+          }
+        },
+        LinkDescription: {
+          $visitor: _index4.default,
+          fixedFields: {
+            href: {
+              $ref: '#/visitors/value'
+            },
+            rel: {
+              $ref: '#/visitors/value'
+            },
+            title: {
+              $ref: '#/visitors/value'
+            },
+            targetSchema: _JSONSchemaOrJSONReferenceVisitor.default,
+            mediaType: {
+              $ref: '#/visitors/value'
+            },
+            method: {
+              $ref: '#/visitors/value'
+            },
+            encType: {
+              $ref: '#/visitors/value'
+            },
+            schema: _JSONSchemaOrJSONReferenceVisitor.default
+          }
+        }
+      }
+    }
+  }
+};
+var _default = exports.default = specification;